summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLoic Minier <lminier@src.gnome.org>2007-07-10 11:22:20 +0000
committerLoic Minier <lminier@src.gnome.org>2007-07-10 11:22:20 +0000
commit8ce2e122e372942036e96ed17e4af09a17135c8e (patch)
tree4b825dc642cb6eb9a060e54bf8d69288fbee4904
parent2e77ac4cd8639aaa9f4200e37f983a9c7c8fb2a5 (diff)
downloadpygtk-8ce2e122e372942036e96ed17e4af09a17135c8e.tar.gz
Move PYGTK_2_10_4 tag to the tags dir.git-migration-PYGTK_2_10_4
* Move PYGTK_2_10_4 tag to the tags dir. svn path=/tags/git-migration-PYGTK_2_10_4; revision=2839
-rw-r--r--AUTHORS15
-rw-r--r--COPYING504
-rw-r--r--ChangeLog2284
-rw-r--r--ChangeLog.pre-2-06521
-rw-r--r--ChangeLog.pre-2-63474
-rw-r--r--ChangeLog.pre-2-8912
-rw-r--r--MANIFEST.in11
-rw-r--r--MAPPING170
-rw-r--r--Makefile.am128
-rw-r--r--NEWS1086
-rw-r--r--PKG-INFO.in25
-rw-r--r--README129
-rw-r--r--THREADS119
-rw-r--r--TODO12
-rw-r--r--atk-types.defs403
-rw-r--r--atk.defs3018
-rw-r--r--atk.override690
-rw-r--r--atkmodule.c48
-rw-r--r--atkrectangle.override265
-rwxr-xr-xautogen.sh477
-rw-r--r--codegen/Makefile.am23
-rw-r--r--codegen/README.defs351
-rw-r--r--codegen/__init__.py15
-rw-r--r--codegen/argtypes.py1027
-rwxr-xr-xcodegen/code-coverage.py42
-rw-r--r--codegen/codegen.py1707
-rw-r--r--codegen/createdefs.py17
-rw-r--r--codegen/definitions.py547
-rw-r--r--codegen/defsconvert.py130
-rw-r--r--codegen/defsgen.py656
-rw-r--r--codegen/defsparser.py153
-rw-r--r--codegen/docextract.py185
-rwxr-xr-xcodegen/docextract_to_xml.py77
-rw-r--r--codegen/docgen.py751
-rwxr-xr-xcodegen/h2def.py536
-rwxr-xr-xcodegen/mergedefs.py26
-rwxr-xr-xcodegen/missingdefs.py17
-rwxr-xr-xcodegen/mkskel.py89
-rw-r--r--codegen/override.py281
-rw-r--r--codegen/pygtk-codegen-2.0.in11
-rw-r--r--codegen/reversewrapper.py851
-rwxr-xr-xcodegen/scanvirtuals.py54
-rw-r--r--codegen/scmexpr.py143
-rw-r--r--config.h.win326
-rw-r--r--configure.in322
-rw-r--r--docs/Makefile.am632
-rw-r--r--docs/random/missing-symbols33
-rw-r--r--docs/random/release-checklist30
-rw-r--r--docs/random/update-bindings5
-rw-r--r--docs/reference/ChangeLog2646
-rw-r--r--docs/reference/entities.docbook.in1
-rw-r--r--docs/reference/pygtk-atk-classes.xml34
-rw-r--r--docs/reference/pygtk-atk-constants.xml1464
-rw-r--r--docs/reference/pygtk-atkaction.xml283
-rw-r--r--docs/reference/pygtk-atkcomponent.xml568
-rw-r--r--docs/reference/pygtk-atkdocument.xml91
-rw-r--r--docs/reference/pygtk-atkeditabletext.xml281
-rw-r--r--docs/reference/pygtk-atkgobjectaccessible.xml134
-rw-r--r--docs/reference/pygtk-atkhyperlink.xml382
-rw-r--r--docs/reference/pygtk-atkhypertext.xml201
-rw-r--r--docs/reference/pygtk-atkimage.xml162
-rw-r--r--docs/reference/pygtk-atkimplementor.xml62
-rw-r--r--docs/reference/pygtk-atknoopobject.xml103
-rw-r--r--docs/reference/pygtk-atknoopobjectfactory.xml89
-rw-r--r--docs/reference/pygtk-atkobject.xml1110
-rw-r--r--docs/reference/pygtk-atkobjectfactory.xml136
-rw-r--r--docs/reference/pygtk-atkrectangle.xml134
-rw-r--r--docs/reference/pygtk-atkregistry.xml219
-rw-r--r--docs/reference/pygtk-atkrelation.xml298
-rw-r--r--docs/reference/pygtk-atkrelationset.xml263
-rw-r--r--docs/reference/pygtk-atkselection.xml322
-rw-r--r--docs/reference/pygtk-atkstateset.xml473
-rw-r--r--docs/reference/pygtk-atkstreamablecontent.xml141
-rw-r--r--docs/reference/pygtk-atktable.xml1338
-rw-r--r--docs/reference/pygtk-atktext.xml1275
-rw-r--r--docs/reference/pygtk-atkvalue.xml144
-rw-r--r--docs/reference/pygtk-gdk-classes.xml37
-rw-r--r--docs/reference/pygtk-gdk-constants.xml2715
-rw-r--r--docs/reference/pygtk-gdk-functions.xml1537
-rw-r--r--docs/reference/pygtk-gdkatom.xml182
-rw-r--r--docs/reference/pygtk-gdkcairocontext.xml260
-rw-r--r--docs/reference/pygtk-gdkcolor.xml210
-rw-r--r--docs/reference/pygtk-gdkcolormap.xml488
-rw-r--r--docs/reference/pygtk-gdkcursor.xml795
-rw-r--r--docs/reference/pygtk-gdkdevice.xml663
-rw-r--r--docs/reference/pygtk-gdkdisplay.xml1186
-rw-r--r--docs/reference/pygtk-gdkdisplaymanager.xml279
-rw-r--r--docs/reference/pygtk-gdkdragcontext.xml1146
-rw-r--r--docs/reference/pygtk-gdkdrawable.xml2171
-rw-r--r--docs/reference/pygtk-gdkevent.xml2454
-rw-r--r--docs/reference/pygtk-gdkfont.xml521
-rw-r--r--docs/reference/pygtk-gdkgc.xml1622
-rw-r--r--docs/reference/pygtk-gdkimage.xml281
-rw-r--r--docs/reference/pygtk-gdkkeymap.xml858
-rw-r--r--docs/reference/pygtk-gdkpangorenderer.xml404
-rw-r--r--docs/reference/pygtk-gdkpixbuf.xml2915
-rw-r--r--docs/reference/pygtk-gdkpixbufanimation.xml264
-rw-r--r--docs/reference/pygtk-gdkpixbufanimationiter.xml225
-rw-r--r--docs/reference/pygtk-gdkpixbufloader.xml666
-rw-r--r--docs/reference/pygtk-gdkpixmap.xml766
-rw-r--r--docs/reference/pygtk-gdkrectangle.xml240
-rw-r--r--docs/reference/pygtk-gdkregion.xml579
-rw-r--r--docs/reference/pygtk-gdkscreen.xml1028
-rw-r--r--docs/reference/pygtk-gdkvisual.xml716
-rw-r--r--docs/reference/pygtk-gdkwindow.xml4414
-rw-r--r--docs/reference/pygtk-glade-classes.xml11
-rw-r--r--docs/reference/pygtk-gladexml.xml541
-rw-r--r--docs/reference/pygtk-gobject-classes.xml20
-rw-r--r--docs/reference/pygtk-gobject-constants.xml495
-rw-r--r--docs/reference/pygtk-gobject-functions.xml1373
-rw-r--r--docs/reference/pygtk-gobject-gboxed.xml68
-rw-r--r--docs/reference/pygtk-gobject-ginterface.xml38
-rw-r--r--docs/reference/pygtk-gobject-gpointer.xml42
-rw-r--r--docs/reference/pygtk-gobject-maincontext.xml152
-rw-r--r--docs/reference/pygtk-gobject-mainloop.xml202
-rw-r--r--docs/reference/pygtk-gobject.xml867
-rw-r--r--docs/reference/pygtk-gtk-classes.xml192
-rw-r--r--docs/reference/pygtk-gtk-constants.xml4188
-rw-r--r--docs/reference/pygtk-gtk-functions.xml1386
-rw-r--r--docs/reference/pygtk-gtk-stock-items.xml1205
-rw-r--r--docs/reference/pygtk-gtkaboutdialog.xml1212
-rw-r--r--docs/reference/pygtk-gtkaccelgroup.xml855
-rw-r--r--docs/reference/pygtk-gtkaccellabel.xml379
-rw-r--r--docs/reference/pygtk-gtkaccelmap.xml688
-rw-r--r--docs/reference/pygtk-gtkaccessible.xml75
-rw-r--r--docs/reference/pygtk-gtkaction.xml1144
-rw-r--r--docs/reference/pygtk-gtkactiongroup.xml1054
-rw-r--r--docs/reference/pygtk-gtkadjustment.xml628
-rw-r--r--docs/reference/pygtk-gtkalignment.xml402
-rw-r--r--docs/reference/pygtk-gtkarrow.xml200
-rw-r--r--docs/reference/pygtk-gtkaspectframe.xml293
-rw-r--r--docs/reference/pygtk-gtkassistant.xml1179
-rw-r--r--docs/reference/pygtk-gtkbin.xml135
-rw-r--r--docs/reference/pygtk-gtkborder.xml99
-rw-r--r--docs/reference/pygtk-gtkbox.xml706
-rw-r--r--docs/reference/pygtk-gtkbutton.xml1207
-rw-r--r--docs/reference/pygtk-gtkbuttonbox.xml346
-rw-r--r--docs/reference/pygtk-gtkcalendar.xml991
-rw-r--r--docs/reference/pygtk-gtkcelleditable.xml220
-rw-r--r--docs/reference/pygtk-gtkcelllayout.xml385
-rw-r--r--docs/reference/pygtk-gtkcellrenderer.xml790
-rw-r--r--docs/reference/pygtk-gtkcellrendereraccel.xml296
-rw-r--r--docs/reference/pygtk-gtkcellrenderercombo.xml147
-rw-r--r--docs/reference/pygtk-gtkcellrendererpixbuf.xml164
-rw-r--r--docs/reference/pygtk-gtkcellrendererprogress.xml134
-rw-r--r--docs/reference/pygtk-gtkcellrendererspin.xml155
-rw-r--r--docs/reference/pygtk-gtkcellrenderertext.xml538
-rw-r--r--docs/reference/pygtk-gtkcellrenderertoggle.xml324
-rw-r--r--docs/reference/pygtk-gtkcellview.xml467
-rw-r--r--docs/reference/pygtk-gtkcheckbutton.xml165
-rw-r--r--docs/reference/pygtk-gtkcheckmenuitem.xml471
-rw-r--r--docs/reference/pygtk-gtkclipboard.xml1281
-rw-r--r--docs/reference/pygtk-gtkcolorbutton.xml459
-rw-r--r--docs/reference/pygtk-gtkcolorselection.xml661
-rw-r--r--docs/reference/pygtk-gtkcolorselectiondialog.xml165
-rw-r--r--docs/reference/pygtk-gtkcombo.xml435
-rw-r--r--docs/reference/pygtk-gtkcombobox.xml1286
-rw-r--r--docs/reference/pygtk-gtkcomboboxentry.xml344
-rw-r--r--docs/reference/pygtk-gtkcontainer.xml1830
-rw-r--r--docs/reference/pygtk-gtkcurve.xml423
-rw-r--r--docs/reference/pygtk-gtkdialog.xml914
-rw-r--r--docs/reference/pygtk-gtkdrawingarea.xml161
-rw-r--r--docs/reference/pygtk-gtkeditable.xml617
-rw-r--r--docs/reference/pygtk-gtkentry.xml1568
-rw-r--r--docs/reference/pygtk-gtkentrycompletion.xml1148
-rw-r--r--docs/reference/pygtk-gtkeventbox.xml283
-rw-r--r--docs/reference/pygtk-gtkexpander.xml713
-rw-r--r--docs/reference/pygtk-gtkfilechooser.xml2415
-rw-r--r--docs/reference/pygtk-gtkfilechooserbutton.xml448
-rw-r--r--docs/reference/pygtk-gtkfilechooserdialog.xml167
-rw-r--r--docs/reference/pygtk-gtkfilechooserwidget.xml137
-rw-r--r--docs/reference/pygtk-gtkfilefilter.xml530
-rw-r--r--docs/reference/pygtk-gtkfileselection.xml538
-rw-r--r--docs/reference/pygtk-gtkfixed.xml318
-rw-r--r--docs/reference/pygtk-gtkfontbutton.xml598
-rw-r--r--docs/reference/pygtk-gtkfontselection.xml277
-rw-r--r--docs/reference/pygtk-gtkfontselectiondialog.xml318
-rw-r--r--docs/reference/pygtk-gtkframe.xml402
-rw-r--r--docs/reference/pygtk-gtkgammacurve.xml180
-rw-r--r--docs/reference/pygtk-gtkhandlebox.xml474
-rw-r--r--docs/reference/pygtk-gtkhbox.xml124
-rw-r--r--docs/reference/pygtk-gtkhbuttonbox.xml122
-rw-r--r--docs/reference/pygtk-gtkhpaned.xml108
-rw-r--r--docs/reference/pygtk-gtkhruler.xml106
-rw-r--r--docs/reference/pygtk-gtkhscale.xml117
-rw-r--r--docs/reference/pygtk-gtkhscrollbar.xml119
-rw-r--r--docs/reference/pygtk-gtkhseparator.xml102
-rw-r--r--docs/reference/pygtk-gtkiconfactory.xml269
-rw-r--r--docs/reference/pygtk-gtkiconinfo.xml391
-rw-r--r--docs/reference/pygtk-gtkiconset.xml282
-rw-r--r--docs/reference/pygtk-gtkiconsource.xml976
-rw-r--r--docs/reference/pygtk-gtkicontheme.xml892
-rw-r--r--docs/reference/pygtk-gtkiconview.xml2408
-rw-r--r--docs/reference/pygtk-gtkimage.xml1163
-rw-r--r--docs/reference/pygtk-gtkimagemenuitem.xml212
-rw-r--r--docs/reference/pygtk-gtkimcontext.xml771
-rw-r--r--docs/reference/pygtk-gtkimcontextsimple.xml133
-rw-r--r--docs/reference/pygtk-gtkimmulticontext.xml117
-rw-r--r--docs/reference/pygtk-gtkinputdialog.xml245
-rw-r--r--docs/reference/pygtk-gtkinvisible.xml178
-rw-r--r--docs/reference/pygtk-gtkitem.xml280
-rw-r--r--docs/reference/pygtk-gtkitemfactory.xml676
-rw-r--r--docs/reference/pygtk-gtklabel.xml1745
-rw-r--r--docs/reference/pygtk-gtklayout.xml603
-rw-r--r--docs/reference/pygtk-gtklinkbutton.xml292
-rw-r--r--docs/reference/pygtk-gtkliststore.xml860
-rw-r--r--docs/reference/pygtk-gtkmenu.xml1007
-rw-r--r--docs/reference/pygtk-gtkmenubar.xml301
-rw-r--r--docs/reference/pygtk-gtkmenuitem.xml698
-rw-r--r--docs/reference/pygtk-gtkmenushell.xml829
-rw-r--r--docs/reference/pygtk-gtkmenutoolbutton.xml363
-rw-r--r--docs/reference/pygtk-gtkmessagedialog.xml469
-rw-r--r--docs/reference/pygtk-gtkmisc.xml246
-rw-r--r--docs/reference/pygtk-gtknotebook.xml2455
-rw-r--r--docs/reference/pygtk-gtkobject.xml673
-rw-r--r--docs/reference/pygtk-gtkoptionmenu.xml370
-rw-r--r--docs/reference/pygtk-gtkpagesetup.xml817
-rw-r--r--docs/reference/pygtk-gtkpagesetupunixdialog.xml260
-rw-r--r--docs/reference/pygtk-gtkpaned.xml970
-rw-r--r--docs/reference/pygtk-gtkpapersize.xml686
-rw-r--r--docs/reference/pygtk-gtkplug.xml303
-rw-r--r--docs/reference/pygtk-gtkprintcontext.xml428
-rw-r--r--docs/reference/pygtk-gtkprinter.xml671
-rw-r--r--docs/reference/pygtk-gtkprintjob.xml548
-rw-r--r--docs/reference/pygtk-gtkprintoperation.xml1709
-rw-r--r--docs/reference/pygtk-gtkprintoperationpreview.xml236
-rw-r--r--docs/reference/pygtk-gtkprintsettings.xml1954
-rw-r--r--docs/reference/pygtk-gtkprintunixdialog.xml467
-rw-r--r--docs/reference/pygtk-gtkprogressbar.xml505
-rw-r--r--docs/reference/pygtk-gtkradioaction.xml341
-rw-r--r--docs/reference/pygtk-gtkradiobutton.xml323
-rw-r--r--docs/reference/pygtk-gtkradiomenuitem.xml294
-rw-r--r--docs/reference/pygtk-gtkradiotoolbutton.xml224
-rw-r--r--docs/reference/pygtk-gtkrange.xml790
-rw-r--r--docs/reference/pygtk-gtkrcstyle.xml979
-rw-r--r--docs/reference/pygtk-gtkrecentchooser.xml1273
-rw-r--r--docs/reference/pygtk-gtkrecentchooserdialog.xml197
-rw-r--r--docs/reference/pygtk-gtkrecentchoosermenu.xml224
-rw-r--r--docs/reference/pygtk-gtkrecentchooserwidget.xml139
-rw-r--r--docs/reference/pygtk-gtkrecentfilter.xml509
-rw-r--r--docs/reference/pygtk-gtkrecentinfo.xml681
-rw-r--r--docs/reference/pygtk-gtkrecentmanager.xml719
-rw-r--r--docs/reference/pygtk-gtkrequisition.xml125
-rw-r--r--docs/reference/pygtk-gtkruler.xml308
-rw-r--r--docs/reference/pygtk-gtkscale.xml455
-rw-r--r--docs/reference/pygtk-gtkscrollbar.xml160
-rw-r--r--docs/reference/pygtk-gtkscrolledwindow.xml1050
-rw-r--r--docs/reference/pygtk-gtkselectiondata.xml1027
-rw-r--r--docs/reference/pygtk-gtkseparator.xml69
-rw-r--r--docs/reference/pygtk-gtkseparatormenuitem.xml100
-rw-r--r--docs/reference/pygtk-gtkseparatortoolitem.xml212
-rw-r--r--docs/reference/pygtk-gtksettings.xml740
-rw-r--r--docs/reference/pygtk-gtksizegroup.xml349
-rw-r--r--docs/reference/pygtk-gtksocket.xml316
-rw-r--r--docs/reference/pygtk-gtkspinbutton.xml1250
-rw-r--r--docs/reference/pygtk-gtkstatusbar.xml506
-rw-r--r--docs/reference/pygtk-gtkstatusicon.xml1065
-rw-r--r--docs/reference/pygtk-gtkstyle.xml2948
-rw-r--r--docs/reference/pygtk-gtktable.xml761
-rw-r--r--docs/reference/pygtk-gtktearoffmenuitem.xml111
-rw-r--r--docs/reference/pygtk-gtktextattributes.xml353
-rw-r--r--docs/reference/pygtk-gtktextbuffer.xml3943
-rw-r--r--docs/reference/pygtk-gtktextchildanchor.xml142
-rw-r--r--docs/reference/pygtk-gtktextiter.xml3110
-rw-r--r--docs/reference/pygtk-gtktextmark.xml226
-rw-r--r--docs/reference/pygtk-gtktexttag.xml793
-rw-r--r--docs/reference/pygtk-gtktexttagtable.xml443
-rw-r--r--docs/reference/pygtk-gtktextview.xml3462
-rw-r--r--docs/reference/pygtk-gtktoggleaction.xml350
-rw-r--r--docs/reference/pygtk-gtktogglebutton.xml463
-rw-r--r--docs/reference/pygtk-gtktoggletoolbutton.xml266
-rw-r--r--docs/reference/pygtk-gtktoolbar.xml2570
-rw-r--r--docs/reference/pygtk-gtktoolbutton.xml736
-rw-r--r--docs/reference/pygtk-gtktoolitem.xml1167
-rw-r--r--docs/reference/pygtk-gtktooltips.xml343
-rw-r--r--docs/reference/pygtk-gtktreedragdest.xml135
-rw-r--r--docs/reference/pygtk-gtktreedragsource.xml158
-rw-r--r--docs/reference/pygtk-gtktreeiter.xml121
-rw-r--r--docs/reference/pygtk-gtktreemodel.xml1579
-rw-r--r--docs/reference/pygtk-gtktreemodelfilter.xml542
-rw-r--r--docs/reference/pygtk-gtktreemodelsort.xml425
-rw-r--r--docs/reference/pygtk-gtktreerowreference.xml234
-rw-r--r--docs/reference/pygtk-gtktreeselection.xml827
-rw-r--r--docs/reference/pygtk-gtktreesortable.xml402
-rw-r--r--docs/reference/pygtk-gtktreestore.xml878
-rw-r--r--docs/reference/pygtk-gtktreeview.xml4245
-rw-r--r--docs/reference/pygtk-gtktreeviewcolumn.xml1868
-rw-r--r--docs/reference/pygtk-gtkuimanager.xml1334
-rw-r--r--docs/reference/pygtk-gtkvbox.xml129
-rw-r--r--docs/reference/pygtk-gtkvbuttonbox.xml131
-rw-r--r--docs/reference/pygtk-gtkviewport.xml425
-rw-r--r--docs/reference/pygtk-gtkvpaned.xml109
-rw-r--r--docs/reference/pygtk-gtkvruler.xml108
-rw-r--r--docs/reference/pygtk-gtkvscale.xml119
-rw-r--r--docs/reference/pygtk-gtkvscrollbar.xml123
-rw-r--r--docs/reference/pygtk-gtkvseparator.xml93
-rw-r--r--docs/reference/pygtk-gtkwidget.xml9737
-rw-r--r--docs/reference/pygtk-gtkwindow.xml4223
-rw-r--r--docs/reference/pygtk-gtkwindowgroup.xml141
-rw-r--r--docs/reference/pygtk-hierarchy.xml230
-rw-r--r--docs/reference/pygtk-introduction.xml515
-rw-r--r--docs/reference/pygtk-pango-classes.xml33
-rw-r--r--docs/reference/pygtk-pango-constants.xml770
-rw-r--r--docs/reference/pygtk-pango-functions.xml248
-rw-r--r--docs/reference/pygtk-pango-markup.xml215
-rw-r--r--docs/reference/pygtk-pangoattribute.xml1797
-rw-r--r--docs/reference/pygtk-pangoattriter.xml250
-rw-r--r--docs/reference/pygtk-pangoattrlist.xml399
-rw-r--r--docs/reference/pygtk-pangocairo-classes.xml15
-rw-r--r--docs/reference/pygtk-pangocairo-constants.xml43
-rw-r--r--docs/reference/pygtk-pangocairo-functions.xml129
-rw-r--r--docs/reference/pygtk-pangocairocairocontext.xml408
-rw-r--r--docs/reference/pygtk-pangocairocairofontmap.xml217
-rw-r--r--docs/reference/pygtk-pangocolor.xml116
-rw-r--r--docs/reference/pygtk-pangocontext.xml448
-rw-r--r--docs/reference/pygtk-pangofont.xml352
-rw-r--r--docs/reference/pygtk-pangofontdescription.xml1154
-rw-r--r--docs/reference/pygtk-pangofontface.xml138
-rw-r--r--docs/reference/pygtk-pangofontfamily.xml148
-rw-r--r--docs/reference/pygtk-pangofontmap.xml215
-rw-r--r--docs/reference/pygtk-pangofontmetrics.xml164
-rw-r--r--docs/reference/pygtk-pangofontset.xml172
-rw-r--r--docs/reference/pygtk-pangofontsetsimple.xml149
-rw-r--r--docs/reference/pygtk-pangoglyphstring.xml274
-rw-r--r--docs/reference/pygtk-pangolanguage.xml277
-rw-r--r--docs/reference/pygtk-pangolayout.xml1312
-rw-r--r--docs/reference/pygtk-pangolayoutiter.xml473
-rw-r--r--docs/reference/pygtk-pangolayoutline.xml262
-rw-r--r--docs/reference/pygtk-pangorenderer.xml598
-rw-r--r--docs/reference/pygtk-pangotabarray.xml290
-rw-r--r--docs/reference/pygtk-pygtkgenericcellrenderer.xml112
-rw-r--r--docs/reference/pygtk-pygtkgenerictreemodel.xml279
-rw-r--r--docs/reference/pygtk-pygtktreemodelrow.xml189
-rw-r--r--docs/reference/pygtk-pygtktreemodelrowiter.xml102
-rw-r--r--docs/reference/pygtk-unixprint-classes.xml16
-rw-r--r--docs/reference/pygtk-unixprint-constants.xml67
-rw-r--r--docs/reference/pygtk-unixprint-functions.xml82
-rw-r--r--docs/reference/pygtk2-ref.xml42
-rw-r--r--examples/Makefile.am103
-rw-r--r--examples/atk/atk-demo.py29
-rw-r--r--examples/glade/README12
-rw-r--r--examples/glade/autoconnect.py20
-rw-r--r--examples/glade/glade-demo.py19
-rw-r--r--examples/glade/test.glade127
-rw-r--r--examples/glade/test2.glade27
-rw-r--r--examples/gobject/editable-interface.py30
-rw-r--r--examples/gobject/properties.py43
-rw-r--r--examples/gobject/signal.py28
-rw-r--r--examples/gtk/bin.py30
-rw-r--r--examples/gtk/filechooser.py35
-rw-r--r--examples/gtk/scrollable.py280
-rw-r--r--examples/gtk/sizegroup.py48
-rw-r--r--examples/gtk/testprint.py68
-rw-r--r--examples/gtk/uimanager.py127
-rw-r--r--examples/gtk/widget.py133
-rw-r--r--examples/ide/README7
-rw-r--r--examples/ide/break.xpm29
-rwxr-xr-xexamples/ide/browse.py119
-rw-r--r--examples/ide/continue.xpm27
-rw-r--r--examples/ide/dialogs.py58
-rw-r--r--examples/ide/edit.py284
-rw-r--r--examples/ide/edit.xpm38
-rwxr-xr-xexamples/ide/gtkcons.py330
-rwxr-xr-xexamples/ide/gtkdb.py434
-rwxr-xr-xexamples/ide/gtkprof.py133
-rw-r--r--examples/ide/minibreak.xpm19
-rw-r--r--examples/ide/next.xpm32
-rwxr-xr-xexamples/ide/pyide.py260
-rw-r--r--examples/ide/quit.xpm36
-rw-r--r--examples/ide/return.xpm35
-rw-r--r--examples/ide/run.xpm28
-rw-r--r--examples/ide/step.xpm35
-rw-r--r--examples/pango/pangocairo-simple.py66
-rw-r--r--examples/pango/utf8-demo.py68
-rw-r--r--examples/pygtk-demo/demos/__init__.py25
-rw-r--r--examples/pygtk-demo/demos/appwindow.py306
-rw-r--r--examples/pygtk-demo/demos/buttonbox.py88
-rw-r--r--examples/pygtk-demo/demos/changedisplay.py413
-rw-r--r--examples/pygtk-demo/demos/colorsel.py73
-rw-r--r--examples/pygtk-demo/demos/dialogs.py130
-rw-r--r--examples/pygtk-demo/demos/dnd.py205
-rw-r--r--examples/pygtk-demo/demos/dndpixmap.py259
-rw-r--r--examples/pygtk-demo/demos/editable_cells.py166
-rw-r--r--examples/pygtk-demo/demos/entry_completion.py76
-rw-r--r--examples/pygtk-demo/demos/expander.py47
-rw-r--r--examples/pygtk-demo/demos/hypertext.py184
-rw-r--r--examples/pygtk-demo/demos/images.py306
-rw-r--r--examples/pygtk-demo/demos/images/alphatest.pngbin26529 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/images/apple-red.pngbin3545 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/images/background.jpgbin22219 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/images/floppybuddy.gifbin5216 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/images/gnome-applets.pngbin3090 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/images/gnome-calendar.pngbin2755 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/images/gnome-foot.pngbin2916 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/images/gnome-gimp.pngbin3410 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/images/gnome-gmush.pngbin3244 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/images/gnome-gsame.pngbin4263 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/images/gnu-keys.pngbin3852 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/images/gtk-logo-rgb.gifbin6427 -> 0 bytes
-rw-r--r--examples/pygtk-demo/demos/list_store.py141
-rw-r--r--examples/pygtk-demo/demos/menu.py88
-rw-r--r--examples/pygtk-demo/demos/panes.py124
-rw-r--r--examples/pygtk-demo/demos/pixbufs.py200
-rw-r--r--examples/pygtk-demo/demos/print_editor.py450
-rw-r--r--examples/pygtk-demo/demos/sizegroup.py108
-rw-r--r--examples/pygtk-demo/demos/statusicon.py31
-rw-r--r--examples/pygtk-demo/demos/stock_browser.py270
-rw-r--r--examples/pygtk-demo/demos/textview.py498
-rw-r--r--examples/pygtk-demo/demos/tree_store.py334
-rw-r--r--examples/pygtk-demo/demos/treemodel.py120
-rw-r--r--examples/pygtk-demo/demos/ui_manager.py191
-rw-r--r--examples/pygtk-demo/pygtk-demo.in7
-rw-r--r--examples/pygtk-demo/pygtk-demo.py318
-rw-r--r--examples/simple/README5
-rw-r--r--examples/simple/dnd.py182
-rw-r--r--examples/simple/dndpixmap.py259
-rwxr-xr-xexamples/simple/hello.py31
-rwxr-xr-xexamples/simple/scribble.py78
-rwxr-xr-xexamples/simple/simple.py29
-rwxr-xr-xexamples/simple/tooltip.py43
-rw-r--r--gtk/Makefile.am191
-rw-r--r--gtk/__init__.py139
-rw-r--r--gtk/_lazyutils.py84
-rw-r--r--gtk/compat.py71
-rw-r--r--gtk/deprecation.py83
-rw-r--r--gtk/gdk-2.10.defs260
-rw-r--r--gtk/gdk-base-types.defs989
-rw-r--r--gtk/gdk-base.defs6809
-rw-r--r--gtk/gdk.override1493
-rw-r--r--gtk/gdkcairo.override249
-rw-r--r--gtk/gdkcolor.override201
-rw-r--r--gtk/gdkdraw.override464
-rw-r--r--gtk/gdkevent.override909
-rw-r--r--gtk/gdkgc.override625
-rw-r--r--gtk/gdkpixbuf.override767
-rw-r--r--gtk/gdkrectangle.override216
-rw-r--r--gtk/gdkwindow.override704
-rw-r--r--gtk/gtk-2.10-types.defs376
-rw-r--r--gtk/gtk-2.10.defs4122
-rw-r--r--gtk/gtk-base-types.defs2735
-rw-r--r--gtk/gtk-base.defs28041
-rw-r--r--gtk/gtk-extrafuncs.defs110
-rw-r--r--gtk/gtk-types.c1372
-rw-r--r--gtk/gtk.override8293
-rw-r--r--gtk/gtkclist.override359
-rw-r--r--gtk/gtkcontainer.override1084
-rw-r--r--gtk/gtkctree.override527
-rw-r--r--gtk/gtkiconview.override336
-rw-r--r--gtk/gtkmodule.c249
-rw-r--r--gtk/gtkobject-support.c138
-rw-r--r--gtk/gtkstyle.override277
-rw-r--r--gtk/gtktextview.override1600
-rw-r--r--gtk/gtktoolbar.override578
-rw-r--r--gtk/gtktreeview.override3322
-rw-r--r--gtk/gtkunixprint.defs408
-rw-r--r--gtk/gtkunixprint.override236
-rw-r--r--gtk/gtkunixprintmodule.c56
-rw-r--r--gtk/gtkwidget.override575
-rw-r--r--gtk/gtkwindow.override286
-rw-r--r--gtk/keysyms.py1499
-rw-r--r--gtk/libglade.defs196
-rw-r--r--gtk/libglade.override549
-rw-r--r--gtk/libglademodule.c48
-rw-r--r--gtk/pygtk-private.h75
-rw-r--r--gtk/pygtk.h85
-rw-r--r--gtk/pygtkcellrenderer.c328
-rw-r--r--gtk/pygtkcellrenderer.h44
-rw-r--r--gtk/pygtktreemodel.c803
-rw-r--r--gtk/pygtktreemodel.h50
-rw-r--r--ltihooks.py60
-rw-r--r--m4/jhflags.m421
-rw-r--r--m4/python.m462
-rw-r--r--pango-types.defs463
-rw-r--r--pango.defs3053
-rw-r--r--pango.override2023
-rw-r--r--pangocairo.defs162
-rw-r--r--pangocairo.override315
-rw-r--r--pangocairomodule.c70
-rw-r--r--pangomodule.c100
-rw-r--r--pygobject-2.0.pc.in20
-rw-r--r--pygtk-2.0.pc.in21
-rw-r--r--pygtk.spec.in127
-rw-r--r--pygtk_postinstall.py108
-rwxr-xr-xsetup.py320
-rw-r--r--tests/Makefile.am33
-rw-r--r--tests/common.py68
-rw-r--r--tests/leak.glade29
-rw-r--r--tests/runtests.py44
-rw-r--r--tests/test_actiongroup.py129
-rw-r--r--tests/test_api.py36
-rw-r--r--tests/test_container.py56
-rw-r--r--tests/test_conversion.py83
-rw-r--r--tests/test_dialog.py35
-rw-r--r--tests/test_enum.py229
-rw-r--r--tests/test_gdk.py73
-rw-r--r--tests/test_gdkevent.py22
-rw-r--r--tests/test_glade.py33
-rw-r--r--tests/test_liststore.py36
-rw-r--r--tests/test_pango.py9
-rw-r--r--tests/test_radiobutton.py98
-rw-r--r--tests/test_style.py29
-rw-r--r--tests/test_textview.py13
-rw-r--r--tests/test_treeview.py27
-rw-r--r--tests/testmodule.py7
504 files changed, 0 insertions, 314364 deletions
diff --git a/AUTHORS b/AUTHORS
deleted file mode 100644
index e0c43f6b..00000000
--- a/AUTHORS
+++ /dev/null
@@ -1,15 +0,0 @@
-Original Author
-===============
-James Henstridge <james@daa.com.au>
-
-The PyGTK Team (in alphabetical order)
-================================
-Gustavo J A M Carneiro <gustavo@users.sourceforge.net>
-Johan Dahlin <johan@gnome.org>
-John Finlay <finlay@moeraki.com>
-James Henstridge <james@daa.com.au>
-Xavier Ordoquy <xordoquy@wanadoo.fr>
-Christian Robottom Reis <kiko@async.com.br>
-
-There are many others who have contributed patches; we thank them,
-PyGTK is much better because of them.
diff --git a/COPYING b/COPYING
deleted file mode 100644
index b1e3f5a2..00000000
--- a/COPYING
+++ /dev/null
@@ -1,504 +0,0 @@
- GNU LESSER GENERAL PUBLIC LICENSE
- Version 2.1, February 1999
-
- Copyright (C) 1991, 1999 Free Software Foundation, Inc.
- 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-[This is the first released version of the Lesser GPL. It also counts
- as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
-
- Preamble
-
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-Licenses are intended to guarantee your freedom to share and change
-free software--to make sure the software is free for all its users.
-
- This license, the Lesser General Public License, applies to some
-specially designated software packages--typically libraries--of the
-Free Software Foundation and other authors who decide to use it. You
-can use it too, but we suggest you first think carefully about whether
-this license or the ordinary General Public License is the better
-strategy to use in any particular case, based on the explanations below.
-
- When we speak of free software, we are referring to freedom of use,
-not price. Our General Public Licenses are designed to make sure that
-you have the freedom to distribute copies of free software (and charge
-for this service if you wish); that you receive source code or can get
-it if you want it; that you can change the software and use pieces of
-it in new free programs; and that you are informed that you can do
-these things.
-
- To protect your rights, we need to make restrictions that forbid
-distributors to deny you these rights or to ask you to surrender these
-rights. These restrictions translate to certain responsibilities for
-you if you distribute copies of the library or if you modify it.
-
- For example, if you distribute copies of the library, whether gratis
-or for a fee, you must give the recipients all the rights that we gave
-you. You must make sure that they, too, receive or can get the source
-code. If you link other code with the library, you must provide
-complete object files to the recipients, so that they can relink them
-with the library after making changes to the library and recompiling
-it. And you must show them these terms so they know their rights.
-
- We protect your rights with a two-step method: (1) we copyright the
-library, and (2) we offer you this license, which gives you legal
-permission to copy, distribute and/or modify the library.
-
- To protect each distributor, we want to make it very clear that
-there is no warranty for the free library. Also, if the library is
-modified by someone else and passed on, the recipients should know
-that what they have is not the original version, so that the original
-author's reputation will not be affected by problems that might be
-introduced by others.
-
- Finally, software patents pose a constant threat to the existence of
-any free program. We wish to make sure that a company cannot
-effectively restrict the users of a free program by obtaining a
-restrictive license from a patent holder. Therefore, we insist that
-any patent license obtained for a version of the library must be
-consistent with the full freedom of use specified in this license.
-
- Most GNU software, including some libraries, is covered by the
-ordinary GNU General Public License. This license, the GNU Lesser
-General Public License, applies to certain designated libraries, and
-is quite different from the ordinary General Public License. We use
-this license for certain libraries in order to permit linking those
-libraries into non-free programs.
-
- When a program is linked with a library, whether statically or using
-a shared library, the combination of the two is legally speaking a
-combined work, a derivative of the original library. The ordinary
-General Public License therefore permits such linking only if the
-entire combination fits its criteria of freedom. The Lesser General
-Public License permits more lax criteria for linking other code with
-the library.
-
- We call this license the "Lesser" General Public License because it
-does Less to protect the user's freedom than the ordinary General
-Public License. It also provides other free software developers Less
-of an advantage over competing non-free programs. These disadvantages
-are the reason we use the ordinary General Public License for many
-libraries. However, the Lesser license provides advantages in certain
-special circumstances.
-
- For example, on rare occasions, there may be a special need to
-encourage the widest possible use of a certain library, so that it becomes
-a de-facto standard. To achieve this, non-free programs must be
-allowed to use the library. A more frequent case is that a free
-library does the same job as widely used non-free libraries. In this
-case, there is little to gain by limiting the free library to free
-software only, so we use the Lesser General Public License.
-
- In other cases, permission to use a particular library in non-free
-programs enables a greater number of people to use a large body of
-free software. For example, permission to use the GNU C Library in
-non-free programs enables many more people to use the whole GNU
-operating system, as well as its variant, the GNU/Linux operating
-system.
-
- Although the Lesser General Public License is Less protective of the
-users' freedom, it does ensure that the user of a program that is
-linked with the Library has the freedom and the wherewithal to run
-that program using a modified version of the Library.
-
- The precise terms and conditions for copying, distribution and
-modification follow. Pay close attention to the difference between a
-"work based on the library" and a "work that uses the library". The
-former contains code derived from the library, whereas the latter must
-be combined with the library in order to run.
-
- GNU LESSER GENERAL PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
- 0. This License Agreement applies to any software library or other
-program which contains a notice placed by the copyright holder or
-other authorized party saying it may be distributed under the terms of
-this Lesser General Public License (also called "this License").
-Each licensee is addressed as "you".
-
- A "library" means a collection of software functions and/or data
-prepared so as to be conveniently linked with application programs
-(which use some of those functions and data) to form executables.
-
- The "Library", below, refers to any such software library or work
-which has been distributed under these terms. A "work based on the
-Library" means either the Library or any derivative work under
-copyright law: that is to say, a work containing the Library or a
-portion of it, either verbatim or with modifications and/or translated
-straightforwardly into another language. (Hereinafter, translation is
-included without limitation in the term "modification".)
-
- "Source code" for a work means the preferred form of the work for
-making modifications to it. For a library, complete source code means
-all the source code for all modules it contains, plus any associated
-interface definition files, plus the scripts used to control compilation
-and installation of the library.
-
- Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running a program using the Library is not restricted, and output from
-such a program is covered only if its contents constitute a work based
-on the Library (independent of the use of the Library in a tool for
-writing it). Whether that is true depends on what the Library does
-and what the program that uses the Library does.
-
- 1. You may copy and distribute verbatim copies of the Library's
-complete source code as you receive it, in any medium, provided that
-you conspicuously and appropriately publish on each copy an
-appropriate copyright notice and disclaimer of warranty; keep intact
-all the notices that refer to this License and to the absence of any
-warranty; and distribute a copy of this License along with the
-Library.
-
- You may charge a fee for the physical act of transferring a copy,
-and you may at your option offer warranty protection in exchange for a
-fee.
-
- 2. You may modify your copy or copies of the Library or any portion
-of it, thus forming a work based on the Library, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
- a) The modified work must itself be a software library.
-
- b) You must cause the files modified to carry prominent notices
- stating that you changed the files and the date of any change.
-
- c) You must cause the whole of the work to be licensed at no
- charge to all third parties under the terms of this License.
-
- d) If a facility in the modified Library refers to a function or a
- table of data to be supplied by an application program that uses
- the facility, other than as an argument passed when the facility
- is invoked, then you must make a good faith effort to ensure that,
- in the event an application does not supply such function or
- table, the facility still operates, and performs whatever part of
- its purpose remains meaningful.
-
- (For example, a function in a library to compute square roots has
- a purpose that is entirely well-defined independent of the
- application. Therefore, Subsection 2d requires that any
- application-supplied function or table used by this function must
- be optional: if the application does not supply it, the square
- root function must still compute square roots.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Library,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Library, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Library.
-
-In addition, mere aggregation of another work not based on the Library
-with the Library (or with a work based on the Library) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
- 3. You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library. To do
-this, you must alter all the notices that refer to this License, so
-that they refer to the ordinary GNU General Public License, version 2,
-instead of to this License. (If a newer version than version 2 of the
-ordinary GNU General Public License has appeared, then you can specify
-that version instead if you wish.) Do not make any other change in
-these notices.
-
- Once this change is made in a given copy, it is irreversible for
-that copy, so the ordinary GNU General Public License applies to all
-subsequent copies and derivative works made from that copy.
-
- This option is useful when you wish to copy part of the code of
-the Library into a program that is not a library.
-
- 4. You may copy and distribute the Library (or a portion or
-derivative of it, under Section 2) in object code or executable form
-under the terms of Sections 1 and 2 above provided that you accompany
-it with the complete corresponding machine-readable source code, which
-must be distributed under the terms of Sections 1 and 2 above on a
-medium customarily used for software interchange.
-
- If distribution of object code is made by offering access to copy
-from a designated place, then offering equivalent access to copy the
-source code from the same place satisfies the requirement to
-distribute the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
- 5. A program that contains no derivative of any portion of the
-Library, but is designed to work with the Library by being compiled or
-linked with it, is called a "work that uses the Library". Such a
-work, in isolation, is not a derivative work of the Library, and
-therefore falls outside the scope of this License.
-
- However, linking a "work that uses the Library" with the Library
-creates an executable that is a derivative of the Library (because it
-contains portions of the Library), rather than a "work that uses the
-library". The executable is therefore covered by this License.
-Section 6 states terms for distribution of such executables.
-
- When a "work that uses the Library" uses material from a header file
-that is part of the Library, the object code for the work may be a
-derivative work of the Library even though the source code is not.
-Whether this is true is especially significant if the work can be
-linked without the Library, or if the work is itself a library. The
-threshold for this to be true is not precisely defined by law.
-
- If such an object file uses only numerical parameters, data
-structure layouts and accessors, and small macros and small inline
-functions (ten lines or less in length), then the use of the object
-file is unrestricted, regardless of whether it is legally a derivative
-work. (Executables containing this object code plus portions of the
-Library will still fall under Section 6.)
-
- Otherwise, if the work is a derivative of the Library, you may
-distribute the object code for the work under the terms of Section 6.
-Any executables containing that work also fall under Section 6,
-whether or not they are linked directly with the Library itself.
-
- 6. As an exception to the Sections above, you may also combine or
-link a "work that uses the Library" with the Library to produce a
-work containing portions of the Library, and distribute that work
-under terms of your choice, provided that the terms permit
-modification of the work for the customer's own use and reverse
-engineering for debugging such modifications.
-
- You must give prominent notice with each copy of the work that the
-Library is used in it and that the Library and its use are covered by
-this License. You must supply a copy of this License. If the work
-during execution displays copyright notices, you must include the
-copyright notice for the Library among them, as well as a reference
-directing the user to the copy of this License. Also, you must do one
-of these things:
-
- a) Accompany the work with the complete corresponding
- machine-readable source code for the Library including whatever
- changes were used in the work (which must be distributed under
- Sections 1 and 2 above); and, if the work is an executable linked
- with the Library, with the complete machine-readable "work that
- uses the Library", as object code and/or source code, so that the
- user can modify the Library and then relink to produce a modified
- executable containing the modified Library. (It is understood
- that the user who changes the contents of definitions files in the
- Library will not necessarily be able to recompile the application
- to use the modified definitions.)
-
- b) Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (1) uses at run time a
- copy of the library already present on the user's computer system,
- rather than copying library functions into the executable, and (2)
- will operate properly with a modified version of the library, if
- the user installs one, as long as the modified version is
- interface-compatible with the version that the work was made with.
-
- c) Accompany the work with a written offer, valid for at
- least three years, to give the same user the materials
- specified in Subsection 6a, above, for a charge no more
- than the cost of performing this distribution.
-
- d) If distribution of the work is made by offering access to copy
- from a designated place, offer equivalent access to copy the above
- specified materials from the same place.
-
- e) Verify that the user has already received a copy of these
- materials or that you have already sent this user a copy.
-
- For an executable, the required form of the "work that uses the
-Library" must include any data and utility programs needed for
-reproducing the executable from it. However, as a special exception,
-the materials to be distributed need not include anything that is
-normally distributed (in either source or binary form) with the major
-components (compiler, kernel, and so on) of the operating system on
-which the executable runs, unless that component itself accompanies
-the executable.
-
- It may happen that this requirement contradicts the license
-restrictions of other proprietary libraries that do not normally
-accompany the operating system. Such a contradiction means you cannot
-use both them and the Library together in an executable that you
-distribute.
-
- 7. You may place library facilities that are a work based on the
-Library side-by-side in a single library together with other library
-facilities not covered by this License, and distribute such a combined
-library, provided that the separate distribution of the work based on
-the Library and of the other library facilities is otherwise
-permitted, and provided that you do these two things:
-
- a) Accompany the combined library with a copy of the same work
- based on the Library, uncombined with any other library
- facilities. This must be distributed under the terms of the
- Sections above.
-
- b) Give prominent notice with the combined library of the fact
- that part of it is a work based on the Library, and explaining
- where to find the accompanying uncombined form of the same work.
-
- 8. You may not copy, modify, sublicense, link with, or distribute
-the Library except as expressly provided under this License. Any
-attempt otherwise to copy, modify, sublicense, link with, or
-distribute the Library is void, and will automatically terminate your
-rights under this License. However, parties who have received copies,
-or rights, from you under this License will not have their licenses
-terminated so long as such parties remain in full compliance.
-
- 9. You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Library or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Library (or any work based on the
-Library), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Library or works based on it.
-
- 10. Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the
-original licensor to copy, distribute, link with or modify the Library
-subject to these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties with
-this License.
-
- 11. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Library at all. For example, if a patent
-license would not permit royalty-free redistribution of the Library by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Library.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply,
-and the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
- 12. If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Library under this License may add
-an explicit geographical distribution limitation excluding those countries,
-so that distribution is permitted only in or among countries not thus
-excluded. In such case, this License incorporates the limitation as if
-written in the body of this License.
-
- 13. The Free Software Foundation may publish revised and/or new
-versions of the Lesser General Public License from time to time.
-Such new versions will be similar in spirit to the present version,
-but may differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Library
-specifies a version number of this License which applies to it and
-"any later version", you have the option of following the terms and
-conditions either of that version or of any later version published by
-the Free Software Foundation. If the Library does not specify a
-license version number, you may choose any version ever published by
-the Free Software Foundation.
-
- 14. If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these,
-write to the author to ask for permission. For software which is
-copyrighted by the Free Software Foundation, write to the Free
-Software Foundation; we sometimes make exceptions for this. Our
-decision will be guided by the two goals of preserving the free status
-of all derivatives of our free software and of promoting the sharing
-and reuse of software generally.
-
- NO WARRANTY
-
- 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
-WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
-EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
-OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
-KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
-LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
-THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
- 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
-AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
-FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
-CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
-LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
-FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Libraries
-
- If you develop a new library, and you want it to be of the greatest
-possible use to the public, we recommend making it free software that
-everyone can redistribute and change. You can do so by permitting
-redistribution under these terms (or, alternatively, under the terms of the
-ordinary General Public License).
-
- To apply these terms, attach the following notices to the library. It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
- <one line to give the library's name and a brief idea of what it does.>
- Copyright (C) <year> <name of author>
-
- This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Lesser General Public
- License as published by the Free Software Foundation; either
- version 2.1 of the License, or (at your option) any later version.
-
- This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public
- License along with this library; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-
-Also add information on how to contact you by electronic and paper mail.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the library, if
-necessary. Here is a sample; alter the names:
-
- Yoyodyne, Inc., hereby disclaims all copyright interest in the
- library `Frob' (a library for tweaking knobs) written by James Random Hacker.
-
- <signature of Ty Coon>, 1 April 1990
- Ty Coon, President of Vice
-
-That's all there is to it!
-
-
diff --git a/ChangeLog b/ChangeLog
deleted file mode 100644
index 440ed270..00000000
--- a/ChangeLog
+++ /dev/null
@@ -1,2284 +0,0 @@
-=== 2.10.4 ===
-2007-02-05 Johan Dahlin <jdahlin@async.com.br>
-
- * NEWS:
-
- 2.10.4
-
-2007-01-31 Gian Mario Tagliaretti <gianmt@gnome.org>
-
- * gtk/gtkcontainer.override: Fix a possible memory leak in
- gtk.Container.child_get() (Fixes bug #404076)
-
-2007-01-31 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtkcontainer.override (_wrap_gtk_container_class_list_child_properties): Undeprecate
-
-2007-01-20 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gdk.override (_wrap_gdk_display_close): Force keeping of a
- reference to the display GObject even when we close() it.
-
- * tests/test_gdk.py (GdkTest.testDisplay): Johan's unit test with
- minor modifications.
-
- * gtk/gdk.override (_wrap_gdk_display_close): Override and make it
- aware that calling gdk_display_close unrefs the GdkDisplay.
-
-2007-01-18 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gdk-base.defs: allow None
-
-2007-01-09 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * configure.ac: Turn the option --disable-docs into --enable-docs.
- * docs/Makefile.am: Treat --enable-docs like --enable-gtk-doc in
- gtk+, i.e. do not ever build docs unless requested, but always
- install them if they are found already built.
-
-2006-12-21 Sebastien Bacher <seb128@ubuntu.com>
-
- * codegen/Makefile.am: install createdefs.py, fix dsextras.py,
- patch by Michael Bienia (Fixes #385934)
-
-2006-12-14 Kjartan Maraas <kmaraas@gnome.org>
-
- * autogen.sh: Make it work with automake 1.10.
-
-2006-12-05 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * gtk/gdkevent.override (_wrap_gdk_event_tp_setattr): For the
- attribute "string", free the old string and g_strdup the new one;
- spotted by John Ehresman.
- Fixes bug #382428.
-
-2006-12-02 Manish Singh <yosh@gimp.org>
-
- * codegen/codegen.py: fix code for generating defines in override
- files, by using variables that actually exist in the context.
- Fixes bug #381389.
-
-2006-11-25 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtktreeview.override (pygtk_tree_foreach_marshal): Use
- pygtk_boxed_unref_shared to unref py_iter. We need this because
- the application may decided to keep a copy of the iterator passed
- in to a gtk_tree_model_foreach callback.
-
-2006-11-19 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * examples/Makefile.am (demo_PYTHON),
- * examples/pygtk-demo/demos/statusicon.py: Add a gtk.StatusIcon
- example by Nikos Kouremenos.
-
-2006-11-15 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/__init__.py: Do not rebind sys.path, restore the old one.
- Thanks to Jp Calderone for pointing out.
-
-2006-10-13 Paolo Borelli <pborelli@katamail.com>
-
- * gtk/gtktextview.override
- (pygtk_text_buffer_register_serialize_format_cb): set return
- value to NULL in the error codepath.
-
-2006-10-13 John Finlay <finlay@moeraki.com>
-
- * docs/Makefile.am (HTMLFILES): Remove
- html/pygtk-reference-copyright.html. Fixes #361906 (Marc-Andre Lureau)
-
-2006-10-05 Cedric Gustin <cedric.gustin@gmail.com>
-
- * setup.py: Initialize Templates and TemplateExtensions with
- py_ssize_t_clean=True (required by codegen.SourceWriter).
-
-2006-10-03 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * configure.in: Bump version.
-
-=== 2.10.3 ===
-2006-10-03 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * NEWS: Update.
-
- * Makefile.am:
- * atk.override:
- * atkrectangle.override:
- * codegen/argtypes.py:
- * codegen/codegen.py:
- * gtk/Makefile.am:
- * gtk/gdk.override:
- * gtk/gdkdraw.override:
- * gtk/gdkpixbuf.override:
- * gtk/gdkrectangle.override:
- * gtk/gtk-types.c: (pygtk_style_helper_getitem),
- (pygtk_style_helper_setitem), (pygtk_tree_model_row_getitem),
- (pygtk_tree_model_row_setitem):
- * gtk/gtk.override:
- * gtk/gtkcontainer.override:
- * gtk/gtktextview.override:
- * gtk/gtktreeview.override:
- * pango.override:
-
- Support Python 2.5 + 64-bit architectures (#337368).
-
-2006-10-03 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * gtk/gtktreeview.override (pygtk_tree_sortable_sort_cb): Fix a
- refcount problem accidentally introduced by me between 2.10.1 and
- 2.10.2 :P
-
-2006-10-03 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * configure.in: Post-release version bump.
-
-=== 2.10.2 ===
-2006-10-03 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * NEWS: Update.
-
- * tests/test_treeview.py: Add unit test for bug #347273.
-
-2006-09-21 Cedric Gustin <cedric.gustin@gmail.com>
-
- * pygtk_postinstall.py: Adapt the codegendir variable to the user
- platform. Copy style.css from pygobject docs to pygtk docs. Run
- fixxref on installed html files. Add functions to install
- shortcuts in the Start menu to the reference manual (currently
- disabled: see bug #353849).
- * setup.py: Changed the way the VERSION macro is defined on
- win32. Added 2.10 defs files for gdk and gtk when GTK+ 2.10 is
- detected. Added gtk.keysyms, gtk._lazyutils, dsextras_gen and
- codegen to the list of installed packages. Also install the html
- reference documentation and run fixxref on the html files.
-
-2006-09-16 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/pygtkcellrenderer.c (pygtk_generic_cell_renderer_activate):
- Same fix as below.
-
- * gtk/gtktreeview.override (pygtk_tree_selection_foreach_marshal):
- Use pygtk_boxed_unref_shared to fix a side-effect of fixing bug
- #347273.
- (pygtk_tree_sortable_sort_cb): Add a similar fix.
-
- * gtk/gtkobject-support.c (pygtk_boxed_unref_shared): Add a new
- pygtk private API to unref a boxed type with a shared pointer.
-
-2006-09-12 John Ehresman <jpe@wingware.com>
-
- * gtk/gtk.override (_wrap_gtk_clipboard_wait_for_rich_text):
- Declare variable at start of code block
-
-2006-09-04 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: post release version bump.
-
-=== 2.10.1 ===
-2006-09-04 Johan Dahlin <jdahlin@async.com.br>
-
-
- * gtk/gtkmodule.c (init_gtk): Require pygobject 2.12.0
-
- * configure.in: post release version bump.
-
-=== 2.10.0 ===
-2006-09-04 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Bump version and require GTK+ 2.10 for 2.10 API
-
- * README (http): Update
-
- * NEWS: Update
-
-2006-08-21 Johan Dahlin <jdahlin@async.com.br>
-
- * docs/Makefile.am: Get rid of build_stamp, include the generated html
- documentation in the tarball.
-
-2006-08-14 John Finlay <finlay@moeraki.com>
-
- * docs/Makefile.am (CSS_FILES):
- * docs/style.css:
- * configure.in (PYGOBJECT_PYGDOCS): Copy style.css from pygobject docs
- when installing docs. Fixes #351385 (Gian Mario Tagliaretti)
-
-2006-08-14 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/__init__.py (_init): issue a warning instead of printing
- to stdout, fixes #316877 regression. (Jeremey Katz)
-
-2006-08-12 John Finlay <finlay@moeraki.com>
-
- * docs/style.css: Add.
- * docs/Makefile.am: Add install of style.css
-
-2006-08-10 John Finlay <finlay@moeraki.com>
-
- * configure.in:
- * docs/Makefile.am:
- * docs/reference/entities.docbook.in:
- * docs/reference/pygtk2-ref.xml:
- Use builddate.xml for the builddate entity and have builddate.xml be
- updated when the docs are built not during configure time.
-
-2006-08-08 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Post release version bump
-
-=== 2.9.6 ===
-2006-08-08 Johan Dahlin <jdahlin@async.com.br>
-
- * README: Add PyGObject dependency
-
- * NEWS: Update
-
-2006-08-07 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/argtypes.py:
- * codegen/codegen.py:
- * codegen/reversewrapper.py:
- Introduce new ArgTypeError exceptions, use them everywhere to
- raise catch codegen errors. Bare except: clauses are gone now.
-
-2006-08-07 Johan Dahlin <jdahlin@async.com.br>
-
- * docs/Makefile.am ($(HTML_DATA)): Fix parallel build
- (#350225, Ed Catmur)
-
-2006-08-07 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/argtypes.py: Don't allow overwrite a argtype
- registration unless the new kwarg 'overwrite' is True.
- Fixes bug #350252.
-
-2006-08-07 Johan Dahlin <johan@gnome.org>
-
- * tests/test_treeview.py (TreeViewTest._test_default_attributes): Add
- a test for #350252
-
-2006-08-06 Johan Dahlin <johan@gnome.org>
-
- * docs/fixxref.py: Remove, it moved to PyGObject.
-
-2006-08-06 John Finlay <finlay@moeraki.com>
-
- * docs/fixxref.py (link_pat): Allow patterns that cross multiple lines.
-
-2006-08-06 Johan Dahlin <johan@gnome.org>
-
- * configure.in: Post release version bump
-
-=== PyGTK 2.9.5 ===
-2006-08-06 Johan Dahlin <johan@gnome.org>
-
- * NEWS: 2.9.5
-
-2006-08-05 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/Makefile.am (GDK_TYPES_DEFS): Always include 2.10 defs in
- EXTRA_DIST, fixes (#350008, Joseph Sacco)
-
- * gtk/__init__.py (ver): Make it possible to reload the gtk+ module,
- (#349026, Alexander Larsson)
-
- * tests/test_api.py (APITest.testGlade): Add a test
-
- * gtk/_lazyutils.py (LazyModule.__getattr__): Special case __members__
- to dir on the real module, fixes (#349892, John Finlay)
-
- * tests/test_api.py (APITest.testKeysyms):
- Add a test
-
-2006-08-05 John Finlay <finlay@moeraki.com>
-
- * gtk/gtkunixprint.override (pygtk_custom_destroy_notify): Add this
- back in.
-
-2006-08-04 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: post release version bump
-
-=== PyGTK 2.9.4 ===
-2006-08-04 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in:
- * docs/Makefile.am:
- * docs/reference/entities.docbook.in:
- * docs/reference/pygtk2-ref.xml:
- Clean up the build date/version mess I created.
- Now it's created during configure time and properly included in
- the docbook files. Also make sure distcheck passes
-
-2006-08-04 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * configure.in: Add hack to disable libtool checking for g++ and
- g77 (copied from libglade).
-
-2006-07-31 John Finlay <finlay@moeraki.com>
-
- * codegen/defsgen.py: Add new program to generate .defs files using
- the ctypes module to extract info from the GTK libraries.
-
-2006-07-30 John Finlay <finlay@moeraki.com>
-
- * gtk/gtkunixprint.override: Remove pygtk_custom_destroy_notify.
-
-2006-07-30 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/codegen.py (SourceWriter.write_class): Simplify code
- that generates the call to pygobject_register_class; Correct the
- fallback value of bases_str.
-
-2006-07-28 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * gtk/gtk.override (_wrap_gtk_print_context_get_cairo_context):
- Someone forgot to rename the override function when gtk+ API
- changed...
-
-2006-07-27 Rafael Ãvila de Espíndola <rafael.espindola@gmail.com>
-
- reviewed by: Johan Dahlin <jdahlin@async.com.br>
-
- * atkrectangle.override:
- * gtk/gdk.override:
- * gtk/gdkevent.override:
- * gtk/gdkgc.override:
- * gtk/gdkpixbuf.override:
- * gtk/gtk-types.c:
- * gtk/gtkcontainer.override:
- * gtk/gtkmodule.c:
- * gtk/gtktextview.override:
- * gtk/libglade.override:
-
- Do not exports internal symbols, fixes #347825
-
-2006-07-27 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_main): Copy paste some code from
- pygobject/gobject/pygmainloop written by Mark McLoughlin, to check
- for signals inside the gtk main loop.
-
- * gtk/gtkmodule.c (init_gtk): Remove the timer; no longer needed.
- Fixes bug #348937: 100ms timeouts in pygtk.
-
-2006-07-25 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtkmodule.c (init_gtk):
- * pangomodule.c (initpango): Check the required
- PyGObject version in runtime too.
-
-2006-07-24 John Finlay <finlay@moeraki.com>
-
- * atk.defs (atk_role_get_localized_name, atk_role_get_name): Define as
- functions.
-
- * pango.defs (pango_script_get_sample_language): Define as function.
-
- * gtk/gtkunixprint.defs (details_acquired)
- (gtk_print_capabilities_get_type, status_changed): Add.
-
- * gtk/gtk-base-types.defs (Editable): Add prerequisite.
-
- * pangocairo.override (*_get_type): ignore-glob
- (pango_cairo_update_context, pango_cairo_create_layout)
- (pango_cairo_update_layout, pango_cairo_show_glyph_string)
- (pango_cairo_show_layout_line, pango_cairo_show_layout)
- (pango_cairo_glyph_string_path, pango_cairo_layout_line_path)
- (pango_cairo_layout_path): ignore.
-
- * pangocairo.defs (pango_cairo_update_context)
- (pango_cairo_context_set_font_options)
- (pango_cairo_context_get_font_options)
- (pango_cairo_context_set_resolution)
- (pango_cairo_context_get_resolution, pango_cairo_create_layout)
- (pango_cairo_update_layout, pango_cairo_show_glyph_string)
- (pango_cairo_show_layout_line, pango_cairo_show_layout)
- (pango_cairo_glyph_string_path, pango_cairo_layout_line_path)
- (pango_cairo_layout_path): Add.
-
- * pango.override (*_get_type, *_ref, *_unref, *_free): ignore-glob
- (pango_default_break): ignore
-
- * pango.defs (pango_attr_shape_new_with_data, pango_default_break)
- (pango_context_get_font_map, pango_context_set_matrix)
- (pango_context_get_matrix, pango_itemize_with_base_dir)
- (pango_coverage_new, pango_glyph_item_split, pango_glyph_item_free)
- (pango_glyph_item_apply_attrs, pango_glyph_item_letter_space)
- (pango_item_get_type, pango_item_new, pango_item_copy)
- (pango_item_free, pango_item_split, pango_script_for_unichar)
- (pango_script_iter_new, pango_script_iter_get_range)
- (pango_script_iter_next, pango_script_iter_free)
- (pango_script_get_sample_language, pango_script_includes_script)
- (pango_matrix_get_type, pango_matrix_copy, pango_matrix_free)
- (pango_matrix_translate, pango_matrix_scale, pango_matrix_rotate)
- (pango_matrix_concat, pango_get_mirror_char, pango_unichar_direction)
- (pango_find_base_dir): Add. Add virtuals.
- (pango_font_metrics_new, pango_find_map, pango_map_get_engine)
- (pango_map_get_engines, pango_module_register): Add with ifdef
- PANGO_ENABLE_BACKEND
- (pango_split_file_list, pango_trim_string, pango_read_line)
- (pango_skip_space, pango_scan_word, pango_scan_string)
- (pango_scan_int, pango_config_key_get, pango_lookup_aliases)
- (pango_parse_style, pango_parse_variant, pango_parse_weight)
- (pango_parse_stretch, pango_get_sysconf_subdirectory)
- (pango_get_lib_subdirectory, pango_log2vis_get_embedding_levels)
- (pango_get_sample_string, pango_is_zero_width): Add with ifdef
- USE_PANGO_UTILS
-
- * pango-types.defs (WrapMode): Add PANGO_WRAP_WORD_CHAR. Reorganize.
-
-2006-07-23 John Finlay <finlay@moeraki.com>
-
- * atk.override (AtkObjectFactory__do_create_accessible)
- (AtkObjectFactory__proxy_do_create_accessible)
- (AtkUtil__do_add_global_event_listener)
- (AtkUtil__proxy_do_add_global_event_listener)
- (AtkUtil__do_remove_global_event_listener)
- (AtkUtil__proxy_do_remove_global_event_listener)
- (AtkUtil__do_add_key_event_listener)
- (AtkUtil__proxy_do_add_key_event_listener)
- (AtkUtil__do_remove_key_event_listener)
- (AtkUtil__proxy_do_remove_key_event_listener): Ignore.
-
- * codegen/reversewrapper.py (StringReturn): Add const-gchar* as a
- StringReturn match.
-
- * codegen/codegen.py (GInterfaceWrapper.write_virtuals): Don't write
- interface_init if no proxies.
-
- * atk.defs: Add get_type defs from atk-enum-types.h.
- Add virtuals for Action, Component, Document, EditableText, Hyperlink,
- Hypertext, Image, ObjectFactory, ImplementorIface, Object, Selection,
- StreamableContent, Table. Text, Util and Value.
-
- * gtk/Makefile.am (libglade.c, gtkunixprint.c): Add dependencies on
- gtk-types.defs and gdk-types.defs
-
- * codegen/reversewrapper.py (PangoFontDescriptionReturn)
- (PangoFontMetricsReturn, PangoLanguageReturn): Add
-
-2006-07-23 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/Makefile.am: Remove back the install-exec-hook that removes _gtk.la.
-
-2006-07-23 Johan Dahlin <johan@gnome.org>
-
- * Makefile.am:
- * gtk/Makefile.am:
- * gtk/__init__.py:
- * gtk/_gtk.py:
- * gtk/_lazyutils.py:
- * gtk/deprecation.py:
- * gtk/gtk.override:
- * gtk/gtkmodule.c: (init_gtk):
- * gtk/libglademodule.c: (initglade):
-
- Revert dynamic namespaces, it is not possible
- to solve it without breaking the ABI.
-
-2006-07-23 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/_gtk.py: Add _PyGtk_API alias from _gtkimpl, for
- compatibility reasons.
-
- * gtk/Makefile.am (install-exec-hook): Uninstall old _gtk.la, if
- installed, else it may conflict with _gtkimpl.la.
-
-2006-07-22 John Finlay <finlay@moeraki.com>
-
- * atk.defs (atk_implementor_ref_accessible): Attach as
- AtkImplementorIface method
-
- * atk-types.defs (AtkImplementorIface): Revert to registered name.
-
- * gtk/gtk-base-types.defs: Annotate interfaces with prerequisites
- and objects with interface implementations
-
- * gtk/gtk-2.10-types.defs: Annotate interfaces with prerequisites
- and objects with interface implementations. Reorganize.
-
- * codegen/reversewrapper.py (VoidReturn.write_conversion)
- (DoubleReturn.write_conversion, GBoxedReturn.write_conversion): Use
- failure_exception instead of failure_cleanup
- (GtkTreePathReturn): Add.
-
- * gtk/gdk-base.defs (get_display_name, get_n_screens, get_screen)
- (get_default_screen, closed): Add GdkDisplay virtual defs
- (create_gc, draw_rectangle, draw_arc, draw_polygon, draw_text)
- (draw_text_wc, draw_drawable, draw_points, draw_segments)
- (draw_lines, draw_glyphs, draw_image, get_depth, get_size)
- (set_colormap, get_colormap, get_visual, get_screen, get_image)
- (get_clip_region, get_visible_region, get_composite_drawable)
- (draw_pixbuf, draw_glyphs_transformed, draw_trapezoids)
- (ref_cairo_surface): Add GdkDrawable virtual defs
- (get_values, set_values, set_dashes): Add GdkGC virtual defs
- (direction_changed, keys_changed): Add GdkKeymap virtual defs
- (size_changed): Add GdkScreen virtual def
- (gdk_pixbuf_animation_ref, pixbuf_animation_unref): Add
- GdkPixbufAnimation method defs
- (non_anim_new, is_static_image, get_static_image, get_size)
- (get_iter): Add GdkPixbufAnimation method and virtual defs with
- GDK_PIXBUF_ENABLE_BACKEND ifdef
- (get_delay_time, get_pixbuf, on_currently_loading_frame, advance): Add
- GdkPixbufAnimationIter virtual defs with GDK_PIXBUF_ENABLE_BACKEND
- ifdef
- (pixbuf_error_quark, pixbuf_get_type, ref, unref)
- (pixbuf_new_from_file_at_scale, save_to_callbackv)
- (save_to_buffer, save_to_bufferv): Add misc GdkPixbuf method and
- function defs
- (is_scalable, is_disabled, set_disabled, get_license): Add
- GdkPixbufFormat methods defs
- (set_option): Add GdkPixbuf method def with GDK_PIXBUF_ENABLE_BACKEND
- ifdef
- (size_prepared, area_prepared, area_updated, closed): Add
- GdkPixbufLoader virtual defs
- (serialize, deserialize, from_pixbuf, pixbuf_from_pixdata)
- (to_csource): Add GdkPixdata method and function defs
-
- * gtk/gdk-2.10.defs (composited_changed): Add GdkScreen virtual def
-
- * gtk/gdk.override (gdk_pixbuf_from_pixdata, gdk_pixdata_*): Ignore
-
- * codegen/reversewrapper.py (GdkRegionPtrReturn): Add.
-
-2006-07-22 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * Makefile.am (SUBDIRS): Make --disable-docs really work.
-
-2006-07-22 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk-base.defs (gdk_pixbuf_simple_anim_add_frame)
- (pixbuf_simple_anim_new, pixbuf_simple_anim_iter_get_type)
- (pixbuf_simple_anim_get_type, gdk_pixbuf_flip): Add
-
- * gtk/gdk.override: Add #define for GDK_TYPE_PIXBUF_SIMPLE_ANIM_ITER.
-
- * gtk/gdk-base-types.defs (PixbufSimpleAnim)
- (PixbufSimpleAnimIter, PixbufRotation): Add.
-
-2006-07-20 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk-base.defs:
- Remove the leading gdk_ from a few functions.
-
-2006-07-20 John Finlay <finlay@moeraki.com>
-
- * docs/Makefile.am: Make builddate.xml dependent on REFERENCE_DEPS.
- Make version.xml dependent on config.h. Add builddate.xml to pdf and
- build-stamp dependencies. Clean pdf files.
-
-2006-07-20 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.ac:
- * docs/Makefile.am:
- * docs/reference/.cvsignore:
- * docs/reference/version.xml.in:
- Generate builddate.xml and version.xml at build time instead on
- configure time, add proper dependencies.
-
-2006-07-20 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * gtk/gtk-base.defs (lookup_icon, load_icon): Caller owns return.
- Fixes leaks.
-
-2006-07-20 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (GtkObject__do_set_arg, GtkObject__do_get_arg)
- (GtkObject__proxy_do_set_arg, GtkObject__proxy_do_get_arg): Ignore.
- #341633 (Johan Dahlin)
-
- * gtk/gtk-types.c (pygtk_tree_model_row_getitem)
- (pygtk_tree_model_row_setitem): Remove negative index readjustment
- code. #311852 (Baiju M)
-
- * codegen/codegen.py (Coverage.printstats): Fix typo.
- #341668 (Yevgen Muntyan)
-
-2006-07-19 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_store_insert): Fix typo
-
- * docs/Makefile.am: Use more portable date generator.
-
-2006-07-19 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtkmodule.c (init_gtkimpl): Don't register constants
- * codegen/codegen.py: Make enum/flags lazily created too.
-
- * gtk/__init__.py:
- * gtk/deprecation.py:
- Make functions lazily loaded.
- Make deprecation lazy too, to avoid refercing anything until it's called.
-
-2006-07-19 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * atk.override (_wrap_atk_editable_text_set_run_attributes): Don't
- ignore g_slist_append return value.
-
-2006-07-19 Rafael Espíndola <rafael.espindola@gmail.com>
-
- reviewed by: Gustavo Carneiro
-
- * codegen/codegen.py: Mark generated PyTypeObject structures with
- G_GNUC_INTERNAL to reduce the size of the PLT. Fixes #347825.
-
-2006-07-19 John Finlay <finlay@moeraki.com>
-
- * docs/fixxref.py: Add utility to fix links to pygobject docs.
-
- * docs/Makefile.am : Add reference/version.xml and
- reference/builddate.xml for auto generated version and build date for
- docs
-
- * docs/common.xsl:
- * docs/devhelp.xsl:
- * docs/html-style.xsl:
- * docs/html.xsl: Remove.
-
- * configure.in (AC_CONFIG_FILES): Add docs/reference/version.xml
-
-2006-07-18 Johan Dahlin <johan@gnome.org>
-
- * docs/Makefile.am (HTMLdir): Install book in $datadir/gtk-doc/html
-
-2006-07-18 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override (pygtk_cell_data_func_marshal)
- (pygtk_tree_selection_foreach_marshal, pygtk_tree_sortable_sort_cb)
- (pygtk_tree_foreach_marshal, pygtk_tree_model_filter_visible_cb)
- (pygtk_filter_modify_func_marshal)
- (pygtk_set_search_equal_func_marshal): Don't copy TreeIter when passing
- to callback. #347273 (Stefano Maggiolo)
- (_wrap_gtk_tree_selection_set_select_function): Optionally provide full
- info to callback. #340475 (Wouter Bolsterlee)
-
-2006-07-17 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override:
- (_wrap_gtk_tree_store_set_column_types): Add.
- (_wrap_gtk_tree_store_insert): Use gtk_tree_store_insert_with_valuesv.
-
- * gtk/_lazyutils.py (LazyNamespace.__getattribute__): Allow
- 'from gtk import *' to work
-
-2006-07-17 Johan Dahlin <johan@gnome.org>
-
- * configure.in:
- * docs/.cvsignore:
- * docs/Makefile.am:
- * docs/reference/pygtk2-ref.xml:
-
- Add non GObject parts of John Finlays reference manual
-
-2006-07-17 John Finlay <finlay@moeraki.com>
-
- * codegen/reversewrapper.py (GBoxedReturn.write_conversion): Specify
- code arg is None
-
- * gtk/gtk-2.10.defs: Add additional virtual defs.
-
- * gtk/gtk-base.defs: Add additional virtual defs.
-
-2006-07-14 John Finlay <finlay@moeraki.com>
-
- * Makefile.am (.defs.c): Allow libglade and gtkunixprint code
- generation in place.
-
-2006-07-13 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-2.10-types.defs (TargetList): Move from
- gtk/gtk-base-types.defs
-
- * gtk/gtk-base-types.defs (AccelMap): Add. #337011 (Sebastian Pölsterl)
- (TipsQuery, TargetList, TreePath, FileInfo, FilePath): Add.
-
- * gtk/gtk.override (_wrap_gtk_accel_map_foreach)
- (_wrap_gtk_accel_map_foreach_unfiltered): Add.
- Fixes #337011 (Sebastian Pölsterl)
- (GtkTipsQuery, GtkTargetList, GtkTreePath, GtkFileInfo, GtkFilePath):
- Ignore types.
-
- * codegen/codegen.py (SourceWriter.write_registers): Don't write
- registers for ignored types.
- (SourceWriter.write_type_declarations): Don't write type declarations
- for ignored types.
-
-2006-07-13 Johan Dahlin <jdahlin@async.com.br>
-
- * codegen/codegen.py:
- * codegen/defsparser.py:
- * configure.in:
- * gtk/Makefile.am:
- * gtk/__init__.py:
- * gtk/_gtk.py:
- * gtk/_lazyutils.py:
- * gtk/deprecation.py:
- * gtk/gtk.override:
- * gtk/gtkmodule.c: (init_gtkimpl):
- * gtk/libglade.override:
- * gtk/libglademodule.c: (init_glade):
- * gtk/pygtk.h:
- * tests/common.py:
- * tests/test_api.py:
- Only load types in gtk when they are used, fixes #346946
-
-2006-07-13 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * tests/test_container.py: New unit test to
- set/get_child_property, etc. by Lorenzo Gil Sanchez.
-
- * tests/Makefile.am (tests): Add test_container.py.
-
- * gtk/gtkcontainer.override
- (_wrap_GtkContainer__proxy_do_set_child_property): Add missing
- param.
-
- * gtk/gtkwidget.override (_wrap_gtk_widget_set_activate_signal)
- (_wrap_gtk_widget_get_activate_signal): Add getter and setter for
- GtkWidgetClass->activate_signal. Fixes #331445.
-
- * gtk/gtk.override (_wrap_gtk_action_set_menu_item_type): Add
- class method to change GtkActionClass->menu_item_type.
- (_wrap_gtk_action_set_tool_item_type): idem for tool_item_type.
- Fixes #331355.
-
- * gtk/gtk-base.defs: Declare the missing
- GtkAction.create_menu|tool_item virtuals.
-
- * examples/gtk/scrollable.py (Layout.do_size_allocate): Save the
- allocation (#341509, Muntyan).
-
- * gtk/gtk.override (_wrap_GtkEditable__do_insert_text): Impl.
- (_wrap_GtkEditable__do_get_selection_bounds): Impl.
-
- * gtk/gtk-base.defs (insert_text): Add direction information to
- the position parameter of gtk.Editbale.insert_text virtual.
-
- * codegen/defsparser.py (IncludeParser.include): Fix including
- absolute path names, #345073.
-
-2006-07-12 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * NEWS: I forgot one NEWS item in the release :P
-
- * configure.in: Post release version bump.
-
-=== 2.9.3 ===
-2006-07-12 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * NEWS: Update.
-
- * tests/Makefile.am: Copy a few more gtk module support files for
- running tests.
-
- * tests/common.py: Don't hide import errors.
-
-2006-07-13 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override: Ignore gtk_recent_chooser_set_show_numbers and
- gtk_recent_chooser_get_show_numbers,
- see http://article.gmane.org/gmane.comp.gnome.language-bindings/805
-
-2006-07-12 John Finlay <finlay@moeraki.com>
-
- * gtk/gtkunixprint.override (_wrap_gtk_enumerate_printers): Add.
-
-2006-07-11 John Finlay <finlay@moeraki.com>
-
- * gtk/gtkunixprint.defs (gtk_printer_accepts_pdf)
- (gtk_printer_accepts_ps, gtk_enumerate_printers): Add.
-
- * gtk/gdk-base.defs (gdk_set_pointer_hooks): Remove dup.
-
-2006-07-10 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-base.defs (gtk_binding_entry_add_signal): Remove dup.
-
- * gtk/gdk-base-types.defs (GdkColorspace): Remove duplicate.
-
- * gtk/gdk-base.defs (gdk_color_change): Change to function to resolve
- conflict with gdk_colormap_change.
- (gdk_colormap_change): Note as deprecated.
- (gdk_display_store_clipboard): Remove dup def
-
-2006-07-08 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk-base.defs (clipboard_get_for_display): Add
- "(caller-owns-return nil)"; Fixes #343960.
-
-2006-07-07 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk.override: Ignore-glob *_libgtk_only. Fixes #321476.
-
-2006-07-06 John Finlay <finlay@moeraki.com>
-
- * pango.override (_wrap_pango_attr_underline_color_new)
- (_wrap_pango_attr_strikethrough_color_new)
- (_wrap_pango_attr_size_new_absolute)
- (_wrap_pango_attr_letter_spacing_new): Add.
-
- * pango.defs (AttrSizeAbsolute, AttrUnderlineColor)
- (AttrStrikethroughColor, AttrLetterSpacing)
- (pango_font_description_set_absolute_size)
- (pango_font_description_get_size_is_absolute)
- (pango_font_get_font_map): Add.
-
- * gtk/gtk.override (_wrap_gtk_color_selection_palette_to_string):
- Allow colors to be a sequence.
-
- * atk.override (_wrap_atk_state_set_contains_states)
- (_wrap_atk_state_set_add_states): Fix reference leaks.
-
-2006-07-06 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * gtk/gtk.override (_wrap_gtk_color_selection_palette_to_string):
- Check that argument is a list of gdk.Color. Fixes #346745.
-
-2006-07-06 John Finlay <finlay@moeraki.com>
-
- * atk.override (atk_text_free_ranges): Ignore.
- (_wrap_atk_value_get_current_value)
- (_wrap_atk_value_get_maximum_value)
- (_wrap_atk_value_get_current_value)
- (_wrap_atk_value_set_current_value): Add.
-
- * atkmodule.c (initatk): Add call to _pyatk_register_boxed_types()
-
- * Makefile.am (ATK_OVERRIDES): Add atkrectangle.override
-
- * atkrectangle.override: Add.
-
- * atk.override (_wrap_atk_text_get_text_at_offset)
- (_wrap_atk_text_get_text_before_offset)
- (_wrap_atk_text_get_character_extents)
- (_wrap_atk_text_get_run_attributes)
- (_wrap_atk_text_get_default_attributes)
- (_wrap_atk_text_get_bounded_ranges, _wrap_atk_text_get_selection)
- (_wrap_atk_text_get_range_extents): Add,
-
- * atk.defs (atk_rectangle_new): Add.
-
-2006-07-05 John Finlay <finlay@moeraki.com>
-
- * atk.override (_wrap_atk_state_set_contains_states)
- (_wrap_atk_state_set_add_states):
- (_wrap_atk_table_get_selected_rows)
- (_wrap_atk_table_get_selected_columns):
- (_wrap_atk_text_get_text_after_offset): Add.
-
- * atk.defs (atk_relation_type_get_name): Define as function instead
- of method.
- (atk_state_type_get_name): Define as function instead of method.
- (atk_state_set_new): Fix typo.
-
- * atk.override (_wrap_atk_relation_get_target): Add.
- (_wrap_atk_relation_new): Raise ValueError if targets is zero length.
-
-2006-07-05 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/Makefile.am:
- * gtk/__init__.py:
- * gtk/_lazyutils.py:
- * tests/Makefile.am:
- * tests/test_api.py:
- Add infrastructure to handle lazy loading.
- Move keysyms to be loaded lazily.
- Add API tests to make sure keysyms works.
-
-2006-07-05 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/Makefile.am:
- * gtk/__init__.py:
- * gtk/deprecation.py:
- Move deprecation related classes to a separate python file
-
-2006-06-27 John Finlay <finlay@moeraki.com>
-
- * atk-types.defs: Update defs for atk-1.8
- * atk.defs: Update defs for atk-1.8
-
- * atk.override (_wrap_atk_component_get_size)
- (_wrap_atk_component_get_size, _wrap_atk_component_get_extents)
- (_wrap_atk_editable_text_set_run_attributes)
- (_wrap_atk_editable_text_insert_text)
- (_wrap_atk_image_get_image_position)
- (_wrap_atk_image_get_image_position): Add
-
-2006-06-27 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * gtk/gdk-2.10.defs, gtk/gdk-base.defs: It seems that all X11
- specific functions are available in gtk+ 2.8 too; moving them from
- gdk-2.10.defs to gdk-base.defs.
-
- * gtk/gdkcairo.override (_wrap_gdk_cairo_rectangle): Missing
- PyErr_Clear() when first protype parsing fails.
-
-2006-06-27 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-2.10.defs (GtkPrintOperationPreview, GtkRecentChooser):
- Add virtual defs for these interfaces.
-
-2006-06-25 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-2.10.defs (gtk_status_icon_set_from_pixbuf): Allow pixbuf
- to be None
- (gtk_status_icon_set_tooltip): Allow tooltip_text to be None
- (print_run_page_setup_dialog): Allow parent to be None.
-
- * gtk/gtk.override (_wrap_gtk_recent_manager_add_full): is_private
- should be a boolean.
-
- * gtk/gtk-2.10-types.defs: Add RecentChooser and
- PrintOperationPreview implements interface notations
-
-2006-06-25 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/argtypes.py (ArgMatcher.register_enum,
- (ArgMatcher.register_flag): Use IntArg to handle enums and flags
- with no typecode. This is to avoid the compiler warning
- "dereferencing type-punned pointer will break strict-aliasing
- rules" when converting enums or flags with no typecode.
- (EnumArg.enum): Typecast to gpointer, not gint*, to avoid gcc type
- punning warnings.
- (FlagsArg.flag): idem.
-
- * codegen/codegen.py (SourceWriter.write_enums): Typecast second
- argument of PyModule_AddIntConstant to
- (char*) to avoid const warning on python < 2.5.
-
-2006-06-25 John Finlay <finlay@moeraki.com>
-
- * gtk/gtkwidget.override (_wrap_gtk_widget_class_find_style_property):
- Add.
-
-2006-06-24 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_print_operation_get_error):
- g_clear_error() is called in pyg_error_check()
-
- * gtk/gtk-2.10.defs (gtk_print_settings_set): Allow value to be NULL.
-
-2006-06-24 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_print_operation_get_error):
- s/g_error_clear/g_clear_error/.
- (_wrap_gtk_print_operation_get_error): Return the exception value,
- not just error->message, so that the programmer can consult
- error.domain and error.code in addition to error.message.
-
-2006-06-24 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_print_operation_get_error): Return
- the error message if any.
-
-2006-06-22 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-2.10-types.defs (PrintOperationPreview): Identify as an
- interface.
-
- * gtk/gtk-2.10.defs (gtk_label_get_line_wrap_mode)
- (gtk_label_set_line_wrap_mode): Add
-
- * gtk/gtk.override (_wrap_gtk_notebook_set_window_creation_hook):
- Fix parse tuple format.
-
-2006-06-22 Frederic Peters <fpeters@0d.be>
-
- * gtk/gtkunixprint.override (_wrap_gtk_print_job_send): update to
- latest GTK+ API change. #345623
-
-2006-06-20 Elijah Newren <newren gmail com>
-
- * gtk/gtk-2.10.defs (get_print_to_file, set_print_to_file): remove
- these functions as the corresponding functions in gtk+ have
- recently been removed as well. #345447
-
-2006-06-15 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_notebook_set_window_creation_hook): Add.
-
- * gtk/gdk.override (_wrap_gdk_screen_set_font_options)
- (_wrap_gdk_screen_set_font_options): Add.
-
- * gtk/gtk-base.defs (accel_group_from_accel_closure): Remove duplicate.
-
- * gtk/gdk.override (gdk_atom_intern_static_string): Ignore
-
-2006-06-15 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * configure.in: Post-release version bump.
-
-=== 2.9.2 ===
-2006-06-15 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * examples/pygtk-demo/demos/print_editor.py: Update example to
- API changes a couple of weeks ago.
-
- * NEWS: Update.
-
- * gtk/gtk-2.10.defs (target_list_add_rich_text_targets): Remove
- "(of-object "GtkTargetList")", which is not valid for functions.
-
- * gtk/gtkunixprint.override (pygtk_print_job_complete_func_cb):
- PycairoSurface_FromSurface API breakage happened since pycairo
- 1.1.6, not 1.1.7. Fixes #344957.
-
-2006-06-14 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktextview.override (_wrap_gtk_text_buffer_serialize)
- (_wrap_gtk_text_buffer_register_deserialize_format)
- (_wrap_gtk_text_buffer_register_serialize_format)
- (_wrap_gtk_text_buffer_get_serialize_formats)
- (_wrap_gtk_text_buffer_get_serialize_formats): Add.
-
- * codegen/argtypes.py (arg): Match const-guint8* as UCharArg
-
- * gtk/gtktextview.override (_wrap_gtk_text_buffer_deserialize)
- (_wrap_gtk_text_buffer_deserialize): Add.
-
-2006-06-14 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * codegen/defsparser.py (IncludeParser.include): Fix a small typo
- that caused bug #344845.
-
-2006-06-14 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktextview.override
- (_wrap_gtk_text_buffer_get_copy_target_list) : Add,
-
- * gtk/gtk.override (_wrap_gtk_drag_dest_find_target)
- (_wrap_gtk_drag_dest_get_target_list)
- (_wrap_gtk_drag_dest_set_target_list, _wrap_gtk_drag_begin)
- (_wrap_gtk_drag_source_get_target_list)
- (_wrap_gtk_drag_source_set_target_list)
- (_wrap_gtk_target_list_add_text_targets)
- (_wrap_gtk_target_list_add_image_targets)
- (_wrap_gtk_target_list_add_uri_targets)
- (_wrap_gtk_target_list_add_rich_text_targets):
- Use pygtk_target_list_from_sequence and pygtk_target_list_to_list.
-
- * gtk/gtkobject-support.c (pygtk_target_list_from_sequence)
- (pygtk_target_list_to_list): Add.
-
-2006-06-13 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-2.10.defs (gtk_tree_view_set_search_entry): Allow entry arg
- to default to None.
-
- * gtk/gtktreeview.override
- (_wrap_gtk_tree_view_set_search_position_func): Add.
-
- * gtk/gtk-2.10.defs (gtk_target_list_add_rich_text_targets): Change
- to function.
-
- * gtk/gtk.override (_wrap_gtk_target_list_add_rich_text_targets): Add.
-
-2006-06-14 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * configure.in: Post-release version bump.
-
-=== 2.9.1 ===
-2006-06-14 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/defsparser.py (IncludeParser.include),
- * codegen/codegen.py (main): Add a -I option to specify a path to
- search for .defs files.
-
- * gtk/Makefile.am (CREATEDEFS): Use $(top_srcdir) to find
- createdefs.py.
- (gtk.c): gtk.c depends also on gdk-types.defs.
- (EXTRA_DIST): Add gtk-extrafuncs.defs.
-
- * codegen/Makefile.am (EXTRA_DIST): Add createdefs.py.
-
-2006-06-13 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtkmodule.c (pygtk_add_extra_constants): Don't add
- GTK_PAPER_* constants with gtk+ 2.8.
-
- * gtk/gtkunixprint.override (pygtk_print_job_complete_func_cb):
- Make it conditionally compile with both pycairo >= 1.1.7 and
- earlier versions.
-
- * configure.in: Explicitly require pycairo for module pangocairo.
- Minimum pycairo version changed back to 1.0.2.
-
- * NEWS: Updated.
-
- * gtk/gdkcairo.override (_wrap_gdk_cairo_rectangle): Make
- gdk.CairoContext.rectangle() also accept (x, y, width, height)
- parameters to avoid violating the Liskov substitution principle,
- since it redefines cairo.Context.rectangle() with a different
- signature.
-
-2006-06-13 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_menu_popup): Improve anti-leak code.
- (_wrap_gtk_init_check, _wrap_gtk_init_check): Ignore.
-
- * gtk/pygtk-private.h: Add. pygdk_atom_vector_from_sequence
-
- * gtk/gtkobject-support.c (pygdk_atom_vector_from_sequence): Add.
-
- * gtk/gtk.override (_wrap_gtk_targets_include_rich_text)
- (_wrap_gtk_targets_include_uri, _wrap_gtk_targets_include_text)
- (_wrap_gtk_targets_include_image): Add.
-
-2006-06-12 John Finlay <finlay@moeraki.com>
-
- * gtk/gtkstyle.override (_wrap_gtk_style_lookup_color): Add.
-
- * gtk/gtk-2.10-types.defs (enum TreeViewGridLines): Add.
-
- * gtk/gtk-2.10.defs (gtk_tree_view_set_enable_tree_lines)
- (gtk_tree_view_get_enable_tree_lines, gtk_tree_view_set_grid_lines)
- (gtk_tree_view_get_grid_lines, gtk_tree_view_grid_lines_get_type)
- (gtk_print_operation_action_get_type): Add.
-
- * gtk/gtk.override (_wrap_gtk_status_icon_position_menu)
- (_wrap_gtk_status_icon_position_menu): Add.
- (_wrap_gtk_menu_popup): Recode to support passing
- gtk.status_icon_position_menu as a position function while maintaining
- backward compatibility.
-
-2006-06-11 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_recent_manager_get_items)
- (_wrap_gtk_recent_manager_add_full): Add.
-
- * gtk/gtktreeview.override (gtk_tree_store_insert_with_values)
- (gtk_tree_store_insert_with_valuesv): Ignore
-
- * gtk/gtk.override (_wrap_gtk_size_group_get_widgets): Fix bug.
- (_wrap_gtk_recent_filter_add_custom)
- (_wrap_gtk_recent_filter_filter): Add.
-
- * gtk/gtk-2.10.defs (register_serialize_tagset)
- (register_deserialize_tagset): Allow NULL tagset_name arg.
-
- * gtk/gtk.override (_wrap_gtk_recent_chooser_dialog_new): Note as
- new-constructor.
- (_wrap_gtk_size_group_get_widgets): Add.
-
-2006-06-10 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-2.10.defs (gtk_recent_chooser_menu_new_for_manager)
- (recent_chooser_widget_new_for_manager): Use new object constructor.
-
-2006-06-11 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * configure.in: Check for the X11 GDK target.
-
- * gtk/gdk.override: Don't ignore gdk_x11_* any more.
-
- * gtk/gdk-2.10.defs: Add x11 specific functions, scanned from
- gdkx.h, corrected (function->method), and made conditionally
- compile only on the X11 GDK target.
-
- * gtk/gdk-base.defs: Removed x11 specific functions added by johan
- after 2.8 (re-added in gdk-2.10.defs).
-
-2006-06-10 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-2.10.defs (gtk_recent_chooser_menu_new_for_manager)
- (recent_chooser_widget_new_for_manager): : Set
- as constructor and allow manager param to default to None.
-
- * gtk/gtk.override (_wrap_gtk_recent_chooser_dialog_new)
- (_wrap_gtk_recent_info_get_application_info)
- (_wrap_gtk_recent_info_get_groups)
- (_wrap_gtk_recent_info_get_applications)
- (_wrap_gtk_recent_chooser_set_sort_func)
- (_wrap_gtk_recent_chooser_list_filters): Add.
- (gtk_print_error_quark, gtk_recent_chooser_error_quark)
- (gtk_recent_chooser_dialog_new_for_manager)
- (gtk_recent_chooser_menu_new)
- (gtk_recent_chooser_widget_new, gtk_recent_manager_error_quark): Ignore
-
-2006-06-09 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_recent_chooser_get_items)
- (_wrap_gtk_recent_chooser_get_uris): Add.
-
- * gtk/gtkiconview.override (_wrap_gtk_icon_view_selected_foreach):
- Fix leaks.
-
- * gtk/gtktextview.override (_wrap_gtk_text_tag_table_foreach):
- Fix leaks.
-
- * gtk/gtk.override (_wrap_gtk_print_settings_foreach)
- (_wrap_gtk_print_settings_set_page_ranges)
- (_wrap_gtk_print_settings_get_page_ranges): Add.
-
- * gtk/gtk-2.10.defs (gtk_button_set_image_position)
- (gtk_button_get_image_position, gtk_print_context_set_cairo_context)
- (gtk_print_operation_set_track_print_status)
- (gtk_print_operation_set_show_progress)
- (gtk_print_operation_set_allow_async)
- (gtk_print_operation_set_custom_tab_label)
- (gtk_print_operation_get_error, gtk_print_operation_cancel
- (gtk_status_icon_get_geometry): Add.
- (gtk_print_operation_set_default_page_setup)
- (gtk_print_operation_set_print_settings): Allow default NULL arg.
-
- * gtk/gtk-2.10-types.defs: Add PrintOperationPreview, RecentFilter,
- RecentInfo. Sync enums.
-
-2006-06-08 Frederic Peters <fpeters@0d.be>
-
- * configure.in, gtk/gtkunixprint.override: Updated pycairo dependencies
- from 0.5.0 to 1.1.7 since PycairoSurface_FromSurface signature changed.
-
- * gtk/gtk-2.10-types.defs, gtk/gtk-2.10.defs: Updated to new GTK+
- Printing API changes.
-
-2006-06-06 John Finlay <finlay@moeraki.com>
-
- * gtk/gtkunixprintmodule.c (initunixprint):
- Add pygtkunixprint_add_constants() call.
-
- * gtk/gtkunixprint.defs:
- * gtk/gtkunixprint.override: Add files for unixprint module.
-
- * gtk/Makefile.am: Add support for gtk.unixprint module.
-
- * configure.in: Add support for gtk.unixprint module.
-
-2006-06-06 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk-base.defs (set_mnemonic_widget): Allow widget to be null
-
-2006-06-05 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-2.10.defs (paper_size_new): Allow name to default to None.
-
- * gtk/gtkmodule.c (pygtk_add_extra_constants): Add GTK_PAPER_NAME
- constants.
-
-2006-06-04 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (gtk_paper_size_free): Ignore
-
- * gtk/gtk-2.10.defs (gtk_message_dialog_set_image): Add.
-
- * gtk/gtk.override (_wrap_gtk_link_button_set_uri_hook): Add.
-
- * gtk/gtk-2.10.defs (input_shape_combine_mask): Allow shape_mask
- to be None.
- (gtk_link_button_new_with_label): Set as constructor for GtkLinkButton.
- Allow label param to default to None.
-
-2006-06-04 Johan Dahlin <johan@gnome.org>
-
- * pango.override (_wrap_pango_tab_array_get_tabs): Fix two
- leaks found by coverity.
-
-2006-06-04 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-2.10.defs (drag_dest_set_track_motion)
- (drag_dest_get_track_motion): Change to methods of GtkWidget.
-
- * gtk/gtk.override (_wrap_gtk_clipboard_wait_for_rich_text)
- (_wrap_gtk_clipboard_request_rich_text): Add.
-
- * codegen/argtypes.py (AtomArg.write_return): Fix leak in GdkAtom
- return.
-
-2006-06-03 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-2.10.defs (gtk_assistant_set_page_header_image)
- (gtk_assistant_set_page_side_image): Allow
- pixbuf param to be None and optional.
- (gtk_entry_set_inner_border): Allow border param to be None.
-
-2006-06-01 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_assistant_set_forward_page_func): Add.
-
- * gtk/gdkevent.override (_wrap_gdk_event_tp_getattr): Output
- "selection" as a gdk.OWNER_CHANGE member.
-
-2006-06-01 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * gtk/gtk-2.10.defs: gtk_print_context_create_context renamed to
- gtk_print_context_create_pango_context;
- gtk_print_context_create_layout renamed to
- gtk_print_context_create_pango_layout;
- gtk_print_context_get_fontmap renamed to
- gtk_print_context_get_pango_fontmap; gtk_print_context_get_cairo
- renamed to gtk_print_context_get_cairo_context.
-
- * gtk/gtk.override
- (_wrap_GtkCellLayout__proxy_do_set_cell_data_func):
- s/Py_DECREF(py_ret)/Py_XDECREF(py_ret)/, thanks Paolo Borelli.
-
-2006-05-31 John Finlay <finlay@moeraki.com>
-
- * gtk/gdkdraw.override (_wrap_gdk_draw_layout_line): Add,
-
- * gtk/gdkcairo.override (_wrap_gdk_cairo_set_source_pixmap)
- (_wrap_gdk_cairo_region, _wrap_gdk_cairo_rectangle): Add as methods.
-
- * gtk/gdk-base.defs (shape_combine_region): shape_region may be None.
-
- * gtk/gdk.override (gdk_region_destroy): Ignore.
-
-2006-05-26 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-base.defs (set_cursor): Allow IconView.set_cursor method
- params 'cell' and 'start_editing' to be optional.
- Fixes #343039 (Ross Burton)
-
-2006-05-20 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.override (_wrap_GtkCellRenderer__do_get_size): Impl.
- Fixes #339431.
-
-2006-05-20 John Finlay <finlay@moeraki.com>
-
- * pangocairo.override (_wrap_context_set_font_options): Allow
- font_options param to be None.
-
-2006-05-20 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * examples/pygtk-demo/demos/print_editor.py (begin_print):
- s/set_nr_of_pages/set_n_pages/ (gtk api change).
-
-2006-05-18 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (clipboard_request_contents_cb)
- (clipboard_clear_func, clipboard_get_func)
- (clipboard_request_targets_cb, clipboard_request_image_cb): Fix
- reference leaks (#342114).
-
-2006-05-17 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * gtk/gtk.override (clipboard_request_text_cb): Fix reference
- leaks (#342114).
-
-2006-05-14 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtkcontainer.override
- (_wrap_GtkContainer__proxy_do_set_child_property)
- (_wrap_GtkContainer__proxy_do_get_child_property)
- (_wrap_GtkContainer__do_set_child_property)
- (_wrap_GtkContainer__do_get_child_property): Impl. Fixes #341641.
-
- * gtk/gtk.override (_wrap_GtkCellRenderer__proxy_do_get_size): Fix
- reference leak on 'self' and 'py_ret'.
- (_wrap_gtk_dialog_set_alternative_button_order): idem.
-
- * codegen/reversewrapper.py: Fix registration of StringReturn type
- handler; fixes #341634.
-
-2006-05-14 Murray Cumming <murrayc@murrayc.com>
-
- * gtk/gtk-2.10.defs: Updated to fix the build, because
- - gtk_print_operation_set_nr_of_pages() changed to gtk_print_operation_set_n_pages()
- - gtk_print_settings_get_num_copies() changed to gtk_print_settings_get_n_copies()
- - gtk_print_settings_set_num_copies() changed to gtk_print_settings_set_n_copies()
- - gtk_recent_manager_add_full() no longer has a GError* parameter.
-
-2006-05-10 Johan Dahlin <johan@gnome.org>
-
- * codegen/codegen.py: Refactor a big chunk into a class with methods.
-
- * Makefile.am:
- * gtk/Makefile.am: Use PYCAIRO_CFLAGS
-
- * configure.in: Make pycairo a required dependency, make sure
- the optional Gtk+ 2.10 dependency check work and only build
- pangocairo if pycairo found and libglade if gtk can be built
-
-2006-05-08 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * examples/pygtk-demo/demos/print_editor.py,
- * examples/Makefile.am: Add Print Editor demo, originally found in
- gtk+ sources and translated to Python.
-
- * gtk/gtk-2.10.defs: gtk.print_run_page_setup_dialog second
- argument can be None/NULL.
-
-2006-05-07 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.override (_wrap_add_log_handlers)
- (_wrap_remove_log_handlers): Try to use
- pyg_add_warning_redirection and pyg_disable_warning_redirections
- if available.
-
- * pangomodule.c (initpango): idem.
-
- * examples/gtk/testprint.py: Add a python print demonstration,
- based on testprint.c in gtk+ sources. It is missing a print
- dialog, though...
-
- * examples/Makefile.am (EXTRA_DIST): add gtk/testprint.py.
-
- * gtk/gtk.override: Include pycairo.
- (_wrap_gtk_print_context_get_cairo): Override to make
- gtk.PrintContext return a gtk.gdk.CairoContext object instead of a
- cairo.Context one.
-
- * configure.in: pycairo dependency no longer optional.
-
- * gtk/gtk-2.10-types.defs (PrintContext): Missing gtk.PrintContext.
-
- * gtk/gtk-2.10.defs: Make 'parent' parameter of
- gtk_print_operation_run optional and None acceptable.
-
- * gtk/gtk-2.10-types.defs: Declare type gtk.PageSetup.
- (PrintSettings): idem for gtk.PrintSettings.
- (PaperSize): Add boxed gtk.PaperSize.
-
- * gtk/gdk.override (_wrap_gdk_bitmap_create_from_data)
- (_wrap_gdk_pixmap_create_from_data): Override to fix a compilation
- warning and add bounds check on the data parameter.
-
- * gtk/gdkcairo.override: Add explicit braces to keep gcc happy.
-
- * gtk/Makefile.am: Make sure the defs are regenerated when
- configure runs, due to possible changes in gtk+ 2.10 detection.
- (gtk.c): Make gtk.c depend on gdk-types.defs to force it to be
- generated early.
- (.defs.c): Remove the recursive make invocation, no longer needed.
-
- * gtk/Makefile.am (defs_DATA): Install gdk.defs, gtk.defs,
- gdk-types.defs, and gtk-types.defs. Thanks Olav Vitters
- Fixes bug #340920.
-
-2006-05-06 Johan Dahlin <jdahlin@async.com.br>
-
- * codegen/createdefs.py:
- * configure.in:
- * gtk/Makefile.am:
- * gtk/gdk-2.10.defs:
- * gtk/gdk-base-types.defs:
- * gtk/gdk-base.defs:
- * gtk/gdk-types.defs:
- * gtk/gdk.defs:
- * gtk/gdk.override:
- * gtk/gtk-2.10-types.defs:
- * gtk/gtk-2.10.defs:
- * gtk/gtk-base-types.defs:
- * gtk/gtk-base.defs:
- * gtk/gtk-types.defs:
- * gtk/gtk.defs:
-
- Add conditional support for Gtk+ 2.10 add new api.
-
-2006-05-06 Johan Dahlin <jdahlin@async.com.br>
-
- * codegen/h2def.py (main): Add support for filtering out definies
- in existing files
-
- * gtk/gtk.override: Ignore a bunch of stuff
-
- * gtk/gtk.defs: Add deprecated, broken and unsupported API here,
- to make it easier to merge in the future
-
- * codegen/override.py (Overrides.__parse_override):
- * codegen/codegen.py (main):
- Add ignore-type statement in override
-
- * codegen/h2def.py: Refactor to use OOP, remove duplicated code
-
-2006-05-01 John Ehresman <jpe@wingware.com>
-
- * gtk/gdk-types.defs:
- * gtk/gdk.defs:
- * gtk/gdk.override
- * gtk/gtk.defs:
- * gtk/pygtk-private.h:
- GdkRegion wrapper
-
-2006-05-01 John Ehresman <jpe@wingware.com>
-
- * gtk/gtktreeview.override: Restore override for
- TreeView.get_visible_rect
-
-2006-05-01 Yevgen Muntyan <muntyan@tamu.edu>
-
- * codegen/reversewrapper.py (ReverseWrapper.generate): Missing ()
- in Py_BuildValue template string to force a tuple to be created
- even when number of retvals is one. Reviewed by Gustavo. Fixes
- Bug 340162 "Missing ()".
-
-2006-04-26 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gdk.override (_wrap_gdk_event_handler_set):
- * gtk/gdk.defs (event_handler_set):
- Wrap gdk_event_handler_set
-
- * gtk/Makefile.am:
- * gtk/gdk.override:
- * gtk/gdkcairo.override:
- * gtk/gdkcolor.override:
- * gtk/gdkdraw.override:
- * gtk/gdkevent.override:
- * gtk/gdkgc.override:
- * gtk/gdkpixbuf.override:
- * gtk/gdkrectangle.override:
- * gtk/gdkwindow.override:
- * gtk/gtktoolbar.override:
- Split out a few more files
-
-2006-04-23 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/codegen.py:
- * codegen/definitions.py: Add support for (unblock-threads #t) in
- functions and methods, which enables the generation of
- pyg_(begin|end)_allow_threads around the C call.
-
- * codegen/argtypes.py (ObjectArg.write_return): Follow up on
- #169204 to add support for const-Object as return type. This
- fixes a build problem in pygda.
-
-2006-04-18 John Ehresman <jpe@wingware.com>
-
- * setup.py: Remove support for building / installing gobject, pygtk.py,
- and dsextras.py
-
-2006-04-16 Richard Hult <richard@imendio.com>
-
- * gtk/gtkmodule.c:
- * gtk/gtk.override: Move locale.h include from gtkmodule.c here to
- fix the build.
-
-2006-04-13 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtkcontainer.override (pygtk_container_for_common):
- Set an exception and jump out (Coverity)
-
- * gtk/gtk.override (_wrap_gtk_stock_list_ids): Decref py_item
- after using it (Coverity)
-
-2006-04-06 Johan Dahlin <johan@gnome.org>
-
- * gtk/__init__.py (_init): Add log handlers here
- (threads_init): Deprecated gtk.threads_*, gtk.gdk.threads_* should
- be used instead, fixes #165927 (Steve Chaplin)
-
- * gtk/gtk.override (_wrap_remove_log_handlers): New function,
- makes it possible to remove the handlers pygtk installs.
- Fixes #323786
-
- * gtk/gtkmodule.c (init_gtk): Refactor, move init_check...
- (init_gtk): Move the log handlers to gtk.override
-
- * gtk/gtk.override (_wrap_gtk_init_check): ..to here
-
- * gtk/__init__.py: Refactor, call init_check() and print warning
- if DISPLAY is not set. Fixes #316877
-
-2006-04-05 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtktreeview.override
- (_wrap_gtk_tree_sortable_set_default_sort_func): Allow callback
- to be set to None, found by Patrick O'Brien
-
- * tests/test_liststore.py (ListStoreTest.testSetDefaultSortFunc):
- Add test
-
-2006-04-04 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Post release version bump
-
-=== 2.9.0 ===
-2006-04-04 Johan Dahlin <jdahlin@async.com.br>
-
- * NEWS: Update
-
-2006-04-04 John Ehresman <jpe@wingware.com>
-
- reviewed by: Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtktreeview.override:
- Make sure gtk.TreeView.cell_get_size() allows
- the usage of the in argument. Fixes #326357
-
-2006-04-03 Johan Dahlin <jdahlin@async.com.br>
-
- * codegen/codegen.py:
- Fit in 80 characters, do not use \
-
- * codegen/argtypes.py:
- * codegen/codegen.py:
- * codegen/definitions.py:
- * codegen/defsconvert.py:
- * codegen/defsparser.py:
- * codegen/docextract.py:
- * codegen/docextract_to_xml.py:
- * codegen/docgen.py:
- * codegen/h2def.py:
- * codegen/mkskel.py:
- * codegen/override.py:
- * codegen/reversewrapper.py:
- * examples/glade/autoconnect.py:
- * examples/gobject/editable-interface.py:
- * examples/gobject/signal.py:
- * examples/gtk/bin.py:
- * examples/gtk/filechooser.py:
- * examples/gtk/scrollable.py:
- * examples/gtk/sizegroup.py:
- * examples/gtk/uimanager.py:
- * examples/ide/edit.py:
- * examples/ide/gtkdb.py:
- * examples/ide/gtkprof.py:
- * examples/pango/pangocairo-simple.py:
- * examples/pango/utf8-demo.py:
- * examples/pygtk-demo/demos/changedisplay.py:
- * examples/pygtk-demo/demos/dnd.py:
- * examples/pygtk-demo/demos/dndpixmap.py:
- * examples/pygtk-demo/demos/entry_completion.py:
- * examples/pygtk-demo/demos/expander.py:
- * examples/pygtk-demo/demos/hypertext.py:
- * examples/pygtk-demo/demos/list_store.py:
- * examples/pygtk-demo/demos/textview.py:
- * examples/pygtk-demo/demos/tree_store.py:
- * examples/pygtk-demo/demos/treemodel.py:
- * examples/simple/dnd.py:
- * examples/simple/dndpixmap.py:
- * examples/simple/hello.py:
- * examples/simple/scribble.py:
- * examples/simple/simple.py:
- * examples/simple/tooltip.py:
- * gtk/__init__.py:
- * gtk/compat.py:
- * gtk/keysyms.py:
- * ltihooks.py:
- * setup.py:
- * tests/common.py:
- * tests/runtests.py:
- * tests/test_actiongroup.py:
- * tests/test_conversion.py:
- * tests/test_dialog.py:
- * tests/test_enum.py:
- * tests/test_gdkevent.py:
- * tests/test_liststore.py:
- * tests/test_radiobutton.py:
- * tests/test_style.py:
- * tests/testmodule.py:
-
- Run reindent.py on all python code.
-
-2006-04-02 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.defs (rotate_simple): Add gdk.Pixbuf.rotate_simple,
- fixes #314164 (Karel Vervaeke)
-
- * examples/pygtk-demo/demos/treemodel.py:
- Check for null, so it can be used with a model filter,
- fixes #311459 (Stephen Kennedy)
-
- * examples/gtk/widget.py: Remove tabs fixes #325320
- (Dieter Verfaillie)
-
-2006-04-02 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk-types.c (PyGdkWindow_PropertyGet): Change property size
- limit from 9999 to G_MAXLONG. Thanks Wander Boessenkool.
- Fixes #327778.
-
- * pango.override (_wrap_pango_layout_line_index_to_x): First
- keyword name should be index, not x_pos, as pointed out by John
- Finlay. Fixes #316581.
-
- * gtk/gtk.defs: Mark gtk_tree_row_reference_free as deprecated.
- Fixes #309811.
-
- * gtk/gtkcontainer.override
- (_wrap_gtk_container_class_list_child_properties): Deprecate in
- favour of gtk.Container.list_child_properties.
- (_wrap_gtk_container_list_child_properties): Add
- gtk.Container.list_child_properties as classmethod.
- (_wrap_gtk_container_class_install_child_property): Deprecate in
- favour of gtk.Container.install_child_property.
- (_wrap_gtk_container_install_child_property): Add
- gtk.Container.install_child_property as clasmethod. Fixes #308394.
-
- * gtk/gtktreeview.override: Remove gtk_tree_view_get_visible_rect
- duplicate override.
-
- * gtk/gtk.override: Make the "new-constructor
- GTK_TYPE_MESSAGE_DIALOG" declaration conditional on gtk+ >= 2.9,
- to match the contents of the constructor.
-
-2006-04-02 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.override (_wrap_gdk_draw_indexed_image):
- wrap, Fixes #333431 (Hamish Moffatt)
- * tests/test_gdk.py (GdkTest.testDrawIndexedImage): Add test
-
- * gtk/gtk.defs (spin): Set default value of increment to
- 1, fixes #325452 (Sebastian Rittau)
-
- * pango.override:
- * tests/Makefile.am:
- * tests/test_pango.py:
-
- Set default markup accel marker to \x00, add tests,
- Fixes #329658 (Johan Svedberg)
-
-2006-04-02 Ben Caradoc-Davies <ben@wintersun.org>
-
- reviewed by: Johan
-
- * examples/pygtk-demo/demos/pixbufs.py: Remove
- discontinuous motion, fixes #327931
-
-2006-04-02 Johan Dahlin <johan@gnome.org>
-
-
- * gtk/gtkmodule.c (init_gtk): GDK_PARENT_RELATIVE constant
-
- * gtk/gtk-types.c (pygtk_style_helper_setitem): Add support for
- GDK_PARENT_RELATIVE in style pixmaps.
-
- Fixes #320248 (Nikos Kouremenos)
-
-2006-04-01 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/override.py (Overrides.__parse_override): Check and
- abort if a function is being overridden more than once.
-
-2006-04-01 Rauli Ruohonen <raulir@iki.fi>
-
- * codegen/codegen.py (Wrapper.write_functions): Add missing 'data'
- parameter when calling self.write_function.
-
- * pangocairo.override: Wrap pango_cairo_context_set_font_options
- and pango_cairo_context_get_font_options. Fixes #328108.
-
- Reviewed by Gustavo Carneiro.
-
-2006-04-01 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/codegen.py (Wrapper.write_virtuals): Use
- PyObject_GetAttrString, not PyDict_GetItemString, fixes #327715.
-
- * gtk/pygtk.h, gtk/gtkmodule.c: Export pygtk_tree_path_to_pyobject
- and pygtk_tree_path_from_pyobject as public APIs. Fixes #318021.
-
- * codegen/argtypes.py: Add suppport for const object args.
- Patch by wollny@cbs.mpg.de, plus some additional changes for code
- style improvements and a bug fix. Fixes #169204.
-
- * gtk/gtkmodule.c (_pygtk_log_func): Call g_log_default_handler
- when python isn't initialized. Fixes #334188.
-
- * examples/Makefile.am (EXTRA_DIST): Ship new editable interface example.
-
- * examples/gobject/editable-interface.py: Add small example of
- overriding GtkEditable interface method and chaining to parent.
-
- * codegen/codegen.py: Bug 334986: "Make it possible to
- re-implement interfaces and chain to parent impl."
-
-2006-04-01 Johan Dahlin <johan@gnome.org>
-
- * codegen/h2def.py (proto_pat): Allow whitespace before
- last parenthesis. Fixes #317124
-
-2006-04-01 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.defs (GtkSpinButton.input, GtkEditable.do_insert_text)
- (GtkEditable.get_selection_bounds,
- GtkMenuItem.toggle_size_request): Add (direction ...) specifiers
- to these virtuals. Probably more of these are missing, though.
-
- * codegen/codegen.py,
- * codegen/definitions.py,
- * codegen/reversewrapper.py:
- Add support for int* and double* (and basic infrastructure to
- support other types in the future) parameters for "reverse
- wrappers". To use this feature one needs to help the
- codegenerator by adding (direction "out") or (direction "inout") to
- the parameter definitions as appropriate. Fixes #335964.
-
-2006-04-01 John Finlay <finlay@moerari.com>
-
- reviewed by: Johan
-
- * gtk/gdk.defs:
- * gtk/gtk.defs:
- * gtk/gtk.override:
- * gtk/gtktextview.override:
- * gtk/gtktreeview.override:
- * gtk/gtkwidget.override:
- Add missing bindings, fixes #316881
-
-2006-04-01 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.defs: Remove display_open_default_libgtk_only,
- it should not be wrapped.
- Fixes #321476
-
-2006-04-01 Marco Cabizza <marco87@gmail.com>
-
- reviewed by: Johan
-
- * gtk/gdk.defs:
- add gdk_screen_get_rgba_colormap and gdk_screen_get_rgba_visual,
- Fixes 328996
-
-2006-04-01 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtkmodule.c: (init_gtk):
- * pangomodule.c: (initpango):
- Set default encoding to utf-8 in pango instead of gtk.
- Fixes #328031
-
-2006-04-01 Johan Dahlin <johan@gnome.org>
-
- * Makefile.am:
- * configure.in:
- * dsextras.py:
- * gobject/Makefile.am:
- * gobject/gobjectmodule.c:
- * gobject/pygboxed.c:
- * gobject/pygenum.c:
- * gobject/pygflags.c:
- * gobject/pygiochannel.c:
- * gobject/pygmaincontext.c:
- * gobject/pygmainloop.c:
- * gobject/pygobject.c:
- * gobject/pygparamspec.c:
- * gobject/pygpointer.c:
- * gobject/pygsource.c:
- * gobject/pygtype.c:
- * gtk/Makefile.am:
- * pygtk.py:
- * tests/Makefile.am:
- Remove gobject and depend on pygobject 2.10.0
-
-2006-04-01 Johan Dahlin <jdahlin@async.com.br>
-
- * codegen/codegen.py: Mark function, methods and getsets as const.
-
-2006-04-01 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_message_dialog_new): Add missing
- "new-constructor GTK_TYPE_MESSAGE_DIALOG" codegen declaration.
-
- * codegen/codegen.py: Add support for docstrings in .defs. To use
- it, add (docstring "foo bar") to class, function or method
- definitions. Fixes bug #322843.
-
- * pangocairomodule.c (initpangocairo): Fix compiler warning.
-
- * m4/python.m4: Fix "underquoted definition of AM_CHECK_PYMOD" warning.
-
- * gtk/gtk.override (_wrap_gtk_message_dialog_new): On gtk+ 2.9,
- fix constructor to allow subclassing. Fixes bug #312056.
-
-2006-03-30 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Post release version bump
-
-=== PyGTK 2.8.5 ===
-2006-03-30 Johan Dahlin <jdahlin@async.com.br>
-
- * NEWS: Update.
-
-2006-02-27 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * tests/test_dialog.py (MessageDialogTest.testDialogLeak): Add
- test for bug #332771.
-
- * tests/test_actiongroup.py (ActionGroupTest.timeout_cb): Use
- self.assertEqual instead of plain assert.
-
- * gtk/gtk.override (gtk_dialog_new_with_buttons): Remove one too
- many g_object_ref. Fixes Bug 332771: "gtk.Dialog leak".
-
-2006-02-20 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * gtk/gdkcairo.override: Don't raise an exception if pangocairo
- import fails, since in this case python itself had already raised
- another exception with more information.
-
-2006-02-14 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtkclist.override (_wrap_gtk_clist_new_with_titles): Fix typos,
- found by Padraig Brady
-
-2006-02-06 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/__init__.py (_is_pydoc): Do not print the deprecation warning
- if we're running under pydoc.
-
-2006-01-26 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * examples/pygtk-demo/demos/pixbufs.py (PixbufsDemo.expose_cb):
- Remove the "FIXME: draw_rgb_image_dithalign seems not to be
- available" comment.
-
- * gtk/gdk.override (_wrap_gdk_draw_rgb_image): Add comment
- explaining why we always call gdk_draw_rgb_image_dithalign instead
- of gdk_draw_rgb_image.
- (_wrap_gdk_draw_gray_image): idem.
-
-2006-01-21 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.defs (cell_view_new_with_text): Add
- caller-owns-return to fix a reference leak.
- (cell_view_new_with_markup): idem.
- (cell_view_new_with_pixbuf): idem.
- (combo_box_new_text): idem.
- (combo_box_entry_new_with_model): idem.
- (combo_box_entry_new_text): idem.
- (expander_new_with_mnemonic): idem.
- (file_chooser_button_new_with_backend): idem.
- (file_chooser_button_new_with_dialog): idem.
- (file_chooser_widget_new_with_backend): idem.
- (gtk_font_button_new_with_font): idem.
- (icon_set_new): idem.
- (gtk_icon_view_new_with_model): idem.
- (gtk_menu_tool_button_new_from_stock): idem.
- (toggle_tool_button_new_from_stock): idem.
- (tool_button_new_from_stock): idem.
-
- * gtk/gdk.defs (pixbuf_loader_new_with_mime_type): Add
- caller-owns-return to fix a reference leak.
-
-2006-01-20 John Ehresman <jpe@wingware.com>
-
- * gtk/gdk.override (_wrap_gdk_window_new): Bump ref count
- on x11 so destroy() works as expected
-
- * tests/test_gdk.py: test for the above
-
-2006-01-19 Johan Dahlin <jdahlin@async.com.br>
-
- * examples/Makefile.am:
- Install examples
-
- * examples/gtk/widget.py:
- Call unrealize too
-
- * examples/gtk/scrollable.py:
- Add example of a scrollable widget
-
-2006-01-15 Christopher Aillon <caillon@redhat.com>
-
- * gobject/gobjectmodule.c (pyg_strv_to_gvalue):
- Don't call g_value_init since the other *_to_gvalue
- methods expect an already inited GValue
-
-2006-01-11 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Post release version bump
-
-=== PyGTK 2.8.4 ===
-2006-01-11 Johan Dahlin <jdahlin@async.com.br>
-
- * NEWS: Update.
-
- * Makefile.am: Only install pygtk.pth if we're building gobject.
-
-2006-01-10 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk-types.defs (IconView): should implement gtk.CellLayout
-
-2006-01-09 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * Makefile.am,
- * configure.in,
- * gtk/Makefile.am,
- * tests/Makefile.am: Fix pygobject check; Add external pygobject
- include dir to include path instead of the internal one if
- compiling with pygobject 2.9.
-
- * Makefile.am: Don't build or install gobject bindings if
- pygobject >= 2.9 was found.
-
- * configure.in: Check for pygobject 2.9; create an AM conditional
- based on it.
-
-=== PyGTK 2.8.3 ===
-2006-01-04 Cedric Gustin <cedric.gustin@gmail.com>
-
- * dsextras.py (Template.generate): Pass GLOBAL_MACROS (in
- particular HAVE_PYCAIRO) to codegen DefsParser.
- * setup.py: If pangocairo is enabled, add pycairo to the list of
- packages required to build the GTK+ module. Also set HAVE_PYCAIRO.
-
-2005-12-24 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/pygflags.c (pyg_flags_add): Tolerate module == NULL,
- which may happen when called from pyg_flags_from_gtype if a
- wrapper for the GFlags was not registered.
-
-2005-11-15 Johan Dahlin <johan@gnome.org>
-
- * gobject/pygobject.c (pygobject_new_with_interfaces): We always
- need to free interfaces since its a null terminated array.
-
-2005-11-13 Johan Dahlin <johan@gnome.org>
-
- * gobject/gobjectmodule.c (pyg_type_register): Remove deprecation
- warning.
-
-2005-11-13 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.defs (gtk_image_new_from_stock)
- (gtk_image_new_from_icon_set, image_new_from_animation)
- (gtk_image_new_from_icon_name)
- (gtk_radio_menu_item_new_from_widget)
- (gtk_radio_menu_item_new_with_mnemonic_from_widget)
- (gtk_radio_menu_item_new_with_label_from_widget): Add missing
- "(caller-owns-return #t)" -- fixes mem leaks.
-
-2005-11-12 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_animation_iter_advance):
- Missing g_object_unref(ret), since caller owns the return value.
-
-2005-11-11 Johan Dahlin <jdahlin@async.com.br>
-
- * examples/gtk/sizegroup.py: New example.
-
-2005-11-09 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * gobject/pygobject.c (CHECK_GOBJECT): Use %p formatter instead of 0x%x.
-
- * gobject/pygobject-private.h (pyg_gil_state_ensure)
- (pyg_gil_state_release): Sync these macro definitions with the
- version in pygobject.h, i.e. don't call pygobject API
- replacements, call the Python API directly.
-
- * tests/Makefile.am (tests): Add test_glade.py.
-
- * tests/test_glade.py: Add this file which was missing from CVS.
-
- * gtk/gtk.defs (gtk_widget_render_icon): Add missing
- "(caller-owns-return #t)" to plug a leak.
-
-2005-11-03 Manish Singh <yosh@gimp.org>
-
- reviewed by: Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (pyg_integer_richcompare):
- * gobject/pygenum.c: (pyg_enum_richcompare):
- * gobject/pygflags.c: (pyg_flags_richcompare):
- * gobject/pygobject-private.h:
- Prepare for Python 2.5 richcompare changes, fixes #320455.
-
-2005-11-02 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/__init__.py: Remove '' from sys.path if it was added by
- PySys_SetArgv in init_gtk.
-
-2005-10-15 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtkobject-support.c (pygtk_custom_destroy_notify): Add
- g_return_if_fail to catch user_data == NULL.
-
- * gtk/gtktreeview.override (pygtk_set_search_equal_func_marshal):
- Add some NULL parameter checks. Use PyObject_IsTrue instead of
- comparing agains PyTrue.
-
-2005-10-14 Johan Dahlin <jdahlin@async.com.br>
-
- * tests/Makefile.am (tests):
- * tests/test_gdk.py: Add test
-
- * gtk/gdk.defs (pixmap_create_from_data)
- (bitmap_create_from_data): use guchar* instead of gchar,
- fixes #318874 (Bob Gibbs)
-
-2005-10-09 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: post release version bump
-
-=== PyGTK 2.8.2 ===
-2005-10-04 Johan Dahlin <jdahlin@async.com.br>
-
- * NEWS: Update
-
-2005-10-09 Johan Dahlin <johan@gnome.org>
-
- * gobject/pygiochannel.c: (pyg_iowatch_marshal):
- Use GIL state instead of block/unblock. Fixes crasher found
- by Ole Andre Valda Ravnås.
-
-2005-10-04 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: post release version bump
-
-=== PyGTK 2.8.1 ===
-2005-10-04 Johan Dahlin <jdahlin@async.com.br>
-
- * NEWS: Update
-
-2005-10-03 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/pygobject.c: (PyGProps_length):
- * gtk/gdk.defs:
- * gtk/gdk.override:
- * gtk/gtk.defs:
- * gtk/gtk.override:
- Fix gcc 4.0 warnings.
-
-2005-10-02 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * tests/test_properties.py (PropertyObject.__gproperties__)
- (PropertyObject.do_get_property, PropertyObject.do_set_property)
- (TestProperties.testUint64): Add guint64 property test case, by
- Johan Dahlin.
-
- * gobject/pygtype.c (pyg_value_from_pyobject): Accept conversion
- from PyInt (not just PyLong) to guint64.
- (_wrap_g_type_wrapper__get_children): Fix sign/unsigned warning.
- (_wrap_g_type_wrapper__get_interfaces): idem.
- (pyg_value_from_pyobject): idem.
-
-2005-10-01 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * tests/test_subtype.py (TestSubType.testGObjectNewError): Add new
- test for the bug below.
-
- * gobject/gobjectmodule.c (pyg_object_new): don't unref/sink obj
- if it is NULL.
-
-2005-09-29 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (pyg_type_name), (pyg_type_from_name),
- (pyg_type_parent), (pyg_type_is_a), (pyg_type_children),
- (pyg_type_interfaces): Undeprecate for now.
-
-2005-09-28 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * tests/Makefile.am (tests): Add test_textview.py.
-
- * tests/test_textview.py: Test gtk.TextView.get_default_attributes().
-
- * gtk/gtktextview.override
- (_wrap_gtk_text_view_get_default_attributes): Override to
- workaround gtk bug #317455.
-
- * pangomodule.c (initpango): Fix values of pango.SCALE_X_LARGE and
- pango.SCALE_XX_LARGE.
-
-2005-09-25 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * tests/Makefile.am (EXTRA_DIST): Add leak.glade.
-
- * tests/test_glade.py: Test case for the leak below.
-
- * gtk/libglade.override (connect_many): Fix a reference leak in 'tuple'.
-
-2005-09-22 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (pyg_type_from_name):
- * gobject/pygobject.c: (pygobject_connect),
- (pygobject_connect_after), (pygobject_connect_object),
- (pygobject_connect_object_after), (pygobject_emit),
- (pygobject_stop_emission):
- Include the object and the name of the signal in TypeErrors
-
-2005-09-20 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.defs (Entry.set_completion): Add null-ok
-
-2005-09-16 John Ehresman <jpe@wingware.com>
-
- * gtk/gdk.override (_wrap_gdk_event_tp_setattr): Allow subwindow
- to be set for enter & leave notify events.
-
-2005-09-16 John Ehresman <jpe@wingware.com>
-
- * gobjectmodule.c (initgobject): Add gobject.Warning Warning subclass
- and redirect all g_log messages for the "GLib", "Glib-GObject", and
- "GThread" domains to the python warning system
-
- * pangomodule.c (initpango): Add pango.Warning Warning subclass
- and redirect all g_log messages for the "Pango" domain to the
- python warning system
-
- * gtkmodule.c (initgtk): Move gtk Warning subclass from the gdk
- module to the gtk module and added redirections for g_log messages
- for the "Gdk" and "GdkPixbuf" domains to the python warning system
-
- * gtk/__init__.py: Set gdk.Warning = gtk.Warning for backward
- compatibility
-
-2005-09-13 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gdk.defs:
- * gtk/gtk.defs:
- * gtk/gtk.override:
- * gtk/gtktextview.override:
- * gtk/gtktreeview.override:
- * gtk/gtkwidget.override:
-
- Revert Johns latest commit.
-
-2005-09-13 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/gobjectmodule.c (add_properties): Append extra
- information to the exception value strings to help contextualize
- any errors that occur while registering properties.
-
-2005-09-06 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk.defs (set_urgency_hint): Add.
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_view_get_visible_range):
- Add.
-
- * gtk/gtk.defs (set_drag_dest_item): Allow path to be None.
- (get_visible_range): Add.
-
-2005-09-05 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs (set_cursor): Allow cell to be None
-
- * gtk/gtkwidget.override (_wrap_gtk_drag_source_set_icon_name1): Add.
-
- * gtk/gtk.defs (gtk_drag_source_set_icon_name): Add as a widget method
- and deprecate function gtk.drag_source_set_icon_name.
-
- * gtk/gdk.defs (set_icon_name): Add.
-
- * gtk/gtktextview.override (_wrap_gtk_text_view_get_iter_at_position):
- Add.
-
- * gtk/gtk.override (_wrap_gtk_clipboard_request_image): Add.
-
- * gtk/gtk.defs (gtk_alternative_dialog_button_order)
- (gtk_clipboard_request_image, gtk_clipboard_wait_for_image)
- (gtk_clipboard_set_image, gtk_clipboard_wait_is_image_available)
- (drag_source_add_iamge_targets, drag_source_add_uri_targets):
- Add defs.
-
-2005-09-02 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/pygparamspec.c (pyg_param_spec_getattr): Sort all attributes
- alphabetically, like python does. Set default value to None
- (pyg_param_spec_getattr): Add default_values fallback, for backwards
- compatibility.
-
-2005-09-02 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/gobjectmodule.c (_wrap_pyg_type_register): Don't crash
- when registering non-types.
-
- * tests/test_subtype.py: Test registering non-types raises
- TypeError.
-
- Fixes #315100: "gobject.type_register crashes if parameter is not
- a type."
-
-2005-09-02 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (pyg_signal_list_names):
- Also include interfaces, fixes #315038
-
-2005-09-02 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: post release version bump
-
- * Changelog.pre-2-8: Move old changelog
-
diff --git a/ChangeLog.pre-2-0 b/ChangeLog.pre-2-0
deleted file mode 100644
index fe01f992..00000000
--- a/ChangeLog.pre-2-0
+++ /dev/null
@@ -1,6521 +0,0 @@
-2003-09-01 James Henstridge <james@daa.com.au>
-
- * configure.in: increment version number.
-
- * NEWS: add news items.
-
-2003-08-31 James Henstridge <james@daa.com.au>
-
- * gtk/gtktreeview.override (pygtk_cell_data_func_marshal): get rid
- of the last argument in the cunote->data==NULL case.
- PyEval_CallFunction() was ignoring it anyway. Fixes bug #121100.
-
-2003-08-26 James Henstridge <james@daa.com.au>
-
- * PKG-INFO.in (Classifier): add PKG-INFO file for submission to
- Python package index.
-
-2003-08-25 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktextview.override
- (_wrap_gtk_text_view_set_border_window_size): Add missing break to
- switch (bug #120669). Patch by Doug Quale.
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_loader_write) Allow count to
- override buf_len if in range 0 to buf_len (bug #120680).
-
-2003-08-24 James Henstridge <james@daa.com.au>
-
- * NEWS: add news items.
-
- * configure.in: update version number.
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_store_new): Fix typo
- found by John Finlay (bug #120517).
-
- * gtk/gtk.defs (pack_start_defaults): mark deprecated in favour of
- pack_start. Fixes bug #118715.
- (pack_end_defaults): similar here.
- (attach_defaults): similar here.
-
- * gtk/libglade.override (_wrap_glade_set_custom_handler): wrap
- glade_set_custom_handler in a more direct way. Implementation
- based on the one in bug #119138.
- (_wrap_glade_set_custom_widget_callbacks): deprecate this
- function, and make it coexist better with the new one.
-
-2003-08-15 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtktreeview.override (_wrap_gtk_list_store_remove): Move to
- autogenerated, since it need to return a GtkTreeIter.
-
-2003-08-02 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.override (_wrap_gdk_pixbuf__get_pixel_array): fix up
- order of dimensions in pixel array (bug #118839).
-
- * atk.override (NO_IMPORT_PYGOBJECT): define NO_IMPORT_PYGOBJECT
- to get rid of multiple definitions of symbols. Patch from Naofumi
- Yasufuku <naofumi@yasufuku.net> (bug #118835).
-
- * Makefile.am, gtk/Makefile.am (common_ldflags): switch the
- -no-undefined switch back to being win32 only. In particular,
- caused breakage on OS X.
-
-2003-07-31 James Henstridge <james@daa.com.au>
-
- * NEWS: add some news items.
-
- * configure.in: increment version number.
-
- * pygobject.c (pygobject_handler_is_connected): add wrapper (from
- bug #118676).
-
- * pygtype.c (pyg_object_descr_doc_get): add a call to
- PyType_Ready() to make sure the type is initialised (bug #118699).
-
-2003-07-26 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.override: apply Elliot Lee's threading patch. Still
- need to fix the remaining threading problems.
-
-2003-07-25 James Henstridge <james@daa.com.au>
-
- * gtk/gtktreeview.override
- (_wrap_gtk_tree_view_get_dest_row_at_pos): add wrapper (bug #116133).
-
- * gtk/gtk.override (ignore): ignore some gtk_rc_* functions.
-
-2003-07-24 James Henstridge <james@daa.com.au>
-
- * gtk/pygtk.h (init_pygtk): same here.
-
- * pygobject.h (init_pygobject): convert fatal errors to normal
- exceptions.
-
- * gtk/gtkglmodule.c (initgl): same here.
-
- * gtk/libglademodule.c (initglade): same here.
-
- * gtk/gtkmodule.c (init_gtk): same here.
-
- * atkmodule.c (initatk): same here.
-
- * pangomodule.c (initpango): same here.
-
- * gobjectmodule.c (initgobject): don't cause fatal errors if an
- exception on init.
-
- * codegen/codegen.py (write_source): print an error message if it
- isn't possible to import a particular name from the module.
-
- * autogen.sh (DIE): require Automake 1.7.
-
- * configure.in (AC_ARG_ENABLE): enable thread support by default.
-
-2003-07-23 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_dialog_add_buttons): add
- add_buttons() method (bug #109620).
-
-2003-07-23 Ian McKellar <yakk@yakk.net>
-
- * gtk/Makefile.am: build fix
-
-2003-07-22 James Henstridge <james@daa.com.au>
-
- * codegen/scmexpr.py (parse): print a real error if we find a
- string or identifier outside of a s-expression (bug #104311).
-
- * gtk/gtktreeview.override: wrappers for tree model drag
- source/dest functions from Emmanuele Bassi (bug #116133).
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_model_rows_reordered):
- add wrapper (from Arjan J. Molenaar, bug #116005).
-
- * gtk/Makefile.am: fix a bug I introduced into the makefile
- yesterday, and fix dependencies for gtk.c.
-
-2003-07-20 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk.override (gdk_window_new) Wrap gdk_window_new as a
- constructor for gtk.gdk.Window(). Fixes #117860.
-
-2003-07-20 James Henstridge <james@daa.com.au>
-
- * gtk/Makefile.am: same here.
-
- * Makefile.am: change *module.so to *.so. Seems to be the
- preferred extension these days ...
-
-2003-07-12 John Finlay <finlay@moeraki.com>
-
- * pango.override (_wrap_PANGO_ASCENT, _wrap_PANGO_DESCENT)
- (_wrap_PANGO_LBEARING, _wrap_PANGO_RBEARING)
- Add these function overrides. Fixes #116920.
-
- * pango.defs (PIXELS, ASCENT, DESCENT, LBEARING, RBEARING)
- Add defs for these. Fixes #116920.
-
- * pangomodule.c (initpango) Add pango.SCALE constant. Fixes #116920.
-
- * pango.override (PangoAttrIterator) Add this type and its methods.
-
-2003-07-11 John Finlay <finlay@moeraki.com>
-
- * pango.override (pypango_attr_new) Add start and end args to specify
- start_index and end_index values.
- (pypango_attr_copy) Specify copying start_index and end_index.
- (_wrap_pango_attr_*_new) Allow the pango.Attr* functions to optionally
- specify start_index and end_index values. Fixes #116776.
-
- * pango.override (pypango_attr_tp_getattr)
- (pypango_attr_get_type) Add these to provide pango.Attribute type
- information and access to attribute type specific data. Fixes #116691.
-
- * pango.defs (pango_color_parse) Make this a constructor for
- pango.Color. Fixes #116662.
-
- * pango.override (_wrap_pango_color_parse) Add constructor wrapper.
- Fixes #116662.
-
- * gtk/gtk.defs (gtk_tree_model_sort_convert_iter_to_child_iter)
- Allow sort_iter to be NULL. Fixes #113097
- (gtk_tree_model_sort_convert_child_iter_to_iter)
- Allow child_iter to be NULL. Fixes #113097
-
- * gtk/gtktreeview.override
- (_wrap_gtk_tree_model_sort_convert_iter_to_child_iter)
- Allow the child_iter to be NULL and return the converted iter but
- allow child_iter to be passed in for backward compatibility.
- Fixes #113097
- (_wrap_gtk_tree_model_sort_convert_child_iter_to_iter)
- Allow the sort_iter to be NULL and return the converted iter but
- allow sort_iter to be passed in for backward compatibility.
- Fixes #113097
-
-2003-07-03 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs (GtkWindow.set_icon): allow passing None as the
- icon (fixes bug #116072).
- (GtkTreeViewColumn.set_widget): allow passing None for the column
- header widget (fixes bug #115027).
-
- * gobjectmodule.c (pyg_error_check): change first block threads
- instead of unblocking them here. (Looks like John forgot to check
- this part in).
-
-2003-05-03 Naofumi Yasufuku <naofumi@yasufuku.net>
-
- Bug #110619:
-
- * dsextras.py (InstallLib.prepare): Fixed self.prefix
- initialization for win32.
- (BuildExt.init_extra_compile_args, BuildExt.build_extensions)
- (BuildExt.build_extension): On win32, add MinGW GCC option for
- MSVC compatible struct packing (gcc2: -fnative-struct, gcc3:
- -mms-bitfields).
- (BuildExt.modify_compiler, BuildExt.build_extensions): On win32,
- remove '-static' linker option to prevent MinGW ld from trying to
- link with MSVC import libraries.
-
- * setup.py: Changed list_files('codegen/*.py') to
- list_files(os.path.join('codegen', '*.py')) for win32.
- Fixed pygtk.h installation directory.
-
-2003-07-02 James Henstridge <james@daa.com.au>
-
- * dsextras.py (pkgc_version_check): remove "self.", fixing bug
- 111002 (pointed out by Seth Nickell).
-
-2003-07-01 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_button_box_get_child_size)
- (_wrap_gtk_button_box_get_child_ipadding): Add deprecation warnings.
- Fixes #110663.
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_animation_get_iter)
- (_wrap_gdk_pixbuf_animation_iter_advance): Add methods. Fixes #114616.
-
- * gtk/gdk.defs (gdk_pixmap_create_from_data): Allow NULL window arg.
- Fixes #114661.
-
- * gtk/gdk.defs (gdk_rectangle_new): Add GdkRectangle constructor.
- Partial fix for #114743.
-
- * gtk/gdk.override (_wrap_gdk_rectangle_union)
- (_wrap_gdk_rectangle_intersect): Add keyword args and allow 4-tuple as
- rectangle spec. Fixes #114743.
-
- * gtk/gdk.override (_wrap_gdk_window_get_frame_extents): Return a
- GdkRectangle. Fixes #114817.
-
- * gtk/gdk.override (gdk_window_get_decorations): Add method.
- Fixes #114821.
-
- * gtk/gdk.defs (gdk_window_shape_combine_mask): shape_mask can be NULL.
- Fixes #114952.
-
- * gtk/gdk.override (_wrap_gdk_window_get_toplevels)
- (_wrap_gdk_list_visuals): Add functions. Fixes #115046.
-
- * gtk/gtktextview.override (_wrap_gtk_text_buffer_set_text)
- (_wrap_gtk_text_buffer_insert)
- (_wrap_gtk_text_buffer_insert_at_cursor)
- (_wrap_gtk_text_buffer_insert_interactive)
- (_wrap_gtk_text_buffer_insert_interactive_at_cursor):
- Raise a ValueError exception if specified length greater than text
- length. Fixes #115154.
-
- * gtk/gtk.override (_wrap_gtk_accelerator_parse): Add function.
- Fixes #115191.
-
- * gtk/gtk.override (_wrap_gtk_accel_map_lookup_entry): Add function.
- Fixes #115194.
-
- * gtk/gtk.override (_wrap_gtk_accel_map_load_fd)
- (_wrap_gtk_accel_map_save_fd): Allow fd arg to be a Python file object.
- Fixes #115198.
-
- * gtk/gtk.override (_wrap_gtk_color_selection_palette_from_string)
- (_wrap_gtk_color_selection_palette_to_string): Add first and fix
- second. Fixes #115206.
-
- * gtk/gdk.defs (keyboard_ungrab) (rgb_get_colormap) (rgb_get_cmap):
- Add first two defs and add deprecation to last def. Fixes #115502.
-
-2003-06-30 John Finlay <finlay@moeraki.com>
-
- * gobjectmodule.c (pyg_error_check) Replace first pyg_unblock_threads
- with pyg_block_threads. Fixes #116284.
-
-2003-06-30 James Henstridge <james@daa.com.au>
-
- * gtk/pygtkcellrenderer.c: same here.
-
- * gtk/pygtktreemodel.c: don't explicitly import pygobject.h, so
- that it gets included correctly by pygtk-private.h. This should
- fix the Mac OS X build issues.
-
-2003-06-27 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk.defs (gdk_draw_layout_with_colors): Add deprecation warning.
- Fixes 113954.
-
- * gtk/gdk.defs (pixmap_new): Fix typo. Fixes #114659.
-
- * gtk/gdk.override (_wrap_gdk_draw_layout): Add optional args
- background and foreground (GdkColor) default to NULL. Fixes 113954.
-
-2003-06-26 James Henstridge <james@daa.com.au>
-
- * (lots of stuff): add copyright notices, and update to LGPL 2.1.
-
-2003-06-23 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * codegen/defsparser.py (DefsParser.ifdef): for some reason, the
- list of arguments received now includes an extra empty string at
- the beginning, so I corrected the indexes.
-
-2003-06-18 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.override (_wrap_gdk_drawable__get_handle): fix bug
- 114619 (the #define we were using was private).
-
-2003-06-12 Joe Shaw <joe@ximian.com>
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_loader_write): Fix an invalid
- python format string.
-
-2003-06-06 Johan Dahlin <jdahlin@async.com.br>
-
- * gobjectmodule.c (get_handler_priority): Fix bogus strcmp. Thanks to
- John Ehresman for spotting this. Fixes #110489
-
-2003-06-05 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gdk.override (_wrap_gdk_colormap_alloc_color): Allow
- allocating a color using an unallocated gdk.Color. Patch by John
- Finlay, fixes #113858
-
- * gtk/gtk.defs (iter_children): Allow null for parent. Fixes #113577
-
- * gtk/libglade.defs (set_custom_widget_callbacks): Added
-
- * gtk/libglade.override (_wrap_glade_set_custom_widget_callbacks)
- (_wrap_glade_set_custom_widget_callbacks): Impl. Patch by Ross
- Burton. Fixes #113271
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_loader_write): Make last
- argument optional.
- (_wrap_gdk_pixbuf_loader_new_with_type): Make first argument
- optional, so we can open without specifying a type. Fixes #114206.
- (_wrap_gdk_gc_set_values, _wrap_gdk_gc_set_values): Impl. Patch by
- John Finlay, fixes #114449
-
- * gtk/gdk-types.defs (Drawable): Add xid and handle attributes.
-
- * gtk/gdk.override (_wrap_gdk_drawable__get_xid)
- (_wrap_gdk_drawable__get_xid): Implement for X11 and win32. Patch
- by jkluebs@luebsphoto.com, fixes #109105
-
- * gtk/gtk.override (_wrap_gtk_adjustment_set_all): Undeprecate,
- add keywords. Based upon patch by kohler@icir.org, fixes #105220
-
- * gtk/gtk-extrafuncs.defs (set_all): Undeprecate.
-
- * gtk/gtk*.override: New files, splitted out from gtk.override
- Fixes #103613
-
- * gtk/Makefile.am (EXTRA_DIST): Add *.override here
-
- * codegen/override.py (Overrides.__parse_override): Added
- "include" keyword, to be able to include files in override files.
- Fixes #103611
-
-2003-06-02 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.override (_wrap_gdk_property_change): use short and long
- instead of gint16 and gint32, so we don't break on 64 bit
- platforms (Xlib uses those types, even though they don't match the
- sizes).
- If format==32 test if the type is ATOM or ATOM_PAIR, and if so
- marshal the data into a (GdkAtom *) array instead of (long *).
- Based on patch in bug 113860.
- (_wrap_gdk_property_get): make similar changes to property_get.
- (_wrap_gdk_property_get): the returned length is the length in
- bytes, not number of elements.
-
-2003-05-30 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.defs (set_transient_for, set_default, set_focus): Accept
- None as argument. Patch by John Finlay, fixes #113675
-
- * gtk/gtk.override (_wrap_gtk_window_get_frame_dimensions):
- Impl. Patch by John Finlay, fixes #113568
- (_wrap_gtk_widget_get_size_request): Impl. Patch by John Finlay,
- fixes #113572
- (_wrap_gtk_window_set_icon_list, _wrap_gtk_window_get_icon_list)
- (_wrap_gtk_window_set_default_icon_list)
- (_wrap_gtk_window_get_default_icon_list): Impl. Patch by John
- Finlay, fixes # 113576
- (pygtk_container_for_common_marshal, pygtk_container_for_common)
- (_wrap_gtk_label_get): Implement, share code with
- GtkContainer.foreach, patch by Rui Lopes, fixes #113597
-
- * gtk/gtk.defs (convert_path_to_child_path): Rename first argument
- to sorted_path. Thanks to John Finlay, fixes #113102
-
- * gtk/gtk.override (_wrap_gtk_text_tag_table_add): Raise
- ValueError if the tag exists. Patch by
- John Finlay, fixes #112796
- (_wrap_gtk_text_view_set_border_window_size): Raise exceptions if
- size is under 0 or a wrong type is specified. Patch by John
- Finlay, fixes #112880
- (_wrap_gtk_text_tag_table_remove): Raise ValueError if the tag
- doesn't exist. Patch by John Finlay, fixes #112797
- (_wrap_gtk_tooltips_data_get): Impl. Patch by John Finlay, fixes
- #112952
-
- * gtk/gdk.defs (set_icon_stock): Fix typo. Thanks to John
- Finlay. fixes #113928
-
- * gtk/gdk.override (_wrap_gdk_devices_list): Impl. Patch by John
- Finlay, fixes #113919
-
- * gtk/gtk.override (_wrap_gtk_text_buffer_set_text)
- (_wrap_gtk_text_buffer_insert)
- (_wrap_gtk_text_buffer_insert_at_cursor)
- (_wrap_gtk_text_buffer_insert_interactive)
- (_wrap_gtk_text_buffer_insert_interactive_at_cursor):
-
- * gtk/gdk.defs (gc_new):
-
- * gtk/gdk.override (_wrap_gdk_gc_new2): Backwards compatibility,
- based on patch by Jonathan Blandford, fixes #113861
-
-2003-05-28 Johan Dahlin <jdahlin@async.com.br>
-
- * codegen/defsparser.py (DefsParser.__init__): Make the third
- argument optional. This broke distutils.
-
- * gobjectmodule.c, pygtype.c, gtk/gtk.override,
- gtk/pygtkcellrenderer.c, pygtktreemodel.c: Remove unnecessary
- calls to PyErr_Clear. It's not needed right after a
- PyErr_Print. Thanks to Rui Lopes for spotting this.
-
-2003-05-28 James Henstridge <james@daa.com.au>
-
- * codegen/defsparser.py (IncludeParser.include): simplify.
-
- * codegen/scmexpr.py (parse): set up so that it takes a filename
- as an argument. Also keep track of line numbers, so that more
- useful error messages can be provided.
-
-2003-05-26 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * codegen/codegen.py (main): Parse -Dkey[=val] options.
-
- * codegen/defsparser.py (DefsParser.__init__): Receive an
- aditional 'defines' parameter, with a dictionary of all
- -Dkey[=val] command-line options.
- (DefsParser.ifdef): Handle (ifdef 'FOO ... )
-
-2003-05-26 James Henstridge <james@daa.com.au>
-
- * codegen/scmexpr.py (parse): convert to a generator to allow
- incremental parsing of defs files.
-
-2003-05-23 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * codegen/defsparser.py (IncludeParser.include): Made
- pygtk-codegen able to read from stdin, by specifying a single dash
- (-) as file name.
-
-2003-05-07 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.override (_wrap_gtk_radio_button_set_group,
- _wrap_gtk_radio_button_set_group): Implement. Patch by John
- Finlay, fixes #112054 and #112058.
- (_wrap_gtk_ruler_get_range): Return a tuple of integers, not
- doubles. Patch by John Finlay, fixes #111716.
- (_wrap_gtk_image_get_pixmap, _wrap_gtk_image_get_image)
- (_wrap_gtk_image_get_stock, _wrap_gtk_image_get)
- (_wrap_gtk_image_get_pixbuf, _wrap_gtk_image_get_animation):
- Implement. Patch by John Finlay, fixes #111400.
- (_wrap_gtk_scrolled_window_get_policy): Implement. Patch by John
- Finlay, fixes #112247.
- (_wrap_gtk_text_buffer_get_iter_at_child_anchor): Implement, Patch
- by John Finlay, fixes #112524.
-
- * gtk/gtk.defs (GtkImage.render_icon, set_image,
- GtkStyle.render_icon): Allow None to be sent in. Patch by John
- Finlay, fixes #111389 and #111416.
-
-2003-04-29 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/Makefile.am (pygtk_PYTHON): Install dsextras.
-
-2003-04-27 Johan Dahlin <jdahlin@async.com.br>
-
- * setup.py (py_modules): Install dsextras.py
-
-2003-04-12 Naofumi Yasufuku <naofumi@yasufuku.net>
-
- * pango.defs (pango_context_get_metrics): Allow language parameter
- to be omitted to get the metrics for the entire font.
- (pango_itemize): Allow cached_iter parameter to be omitted.
- (pango_font_description_better_match): Allow old_match parameter
- to be omitted to determine if new_match is a match at all.
- (pango_font_get_metrics): Allow language parameter to be omitted
- to get the metrics for the entire font.
- (pango_layout_set_font_description): Allow 'None' desc parameter
- to unset the current font description.
- (pango_layout_set_tabs): Allow 'None' tabs parameter to reinstate
- the default tabs.
- (pango_language_matches): Changed to function. Allow 'None'
- language parameter which matches nothing but '*'.
- Fixes #109848
-
-2003-03-24 James Henstridge <james@daa.com.au>
-
- * pygobject-private.h: add missing "extern" keyword (from Glyph's
- patch).
-
-2003-03-23 James Henstridge <james@daa.com.au>
-
- * setup.py: increment version number.
-
- * NEWS: add news items.
-
- * configure.in (numpy check): fix up check for Numeric and
- increment version number.
-
-2003-03-21 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.override (_wrap_gtk_tree_store_new):
- (_wrap_gtk_list_store_new): This two are constructors, not normal
- function, therefor return -1 as error and 0 as success.
- Also a big tab/trailing whitespace cleanup. (so the patch is a lot
- larger than it should be)
-
-2003-03-19 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gdk.defs (get_option): Added.
-
-2003-03-13 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c: add doc comments.
-
- * pygobject.c: add doc comments.
-
- * pygboxed.c: add doc comments.
-
-2003-03-12 James Henstridge <james@daa.com.au>
-
- * pygtype.c: add some documentation.
-
-2003-03-11 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.defs (set_back_pixmap): allow passing None for the
- pixmap argument.
-
- * gtk/gtk.override (_wrap_gtk_main_iteration): return boolean
- (either Py_True or Py_False).
- (_wrap_gtk_main_iteration_do): same here.
- (_wrap_gtk_im_context_filter_keypress): and here.
- (_wrap_gtk_text_attributes__get_strikethrough): and here.
- (_wrap_gtk_text_attributes__get_draw_bg): and here.
-
- * gtk/gtk.override (_wrap_gtk_tree_model_tp_setitem): add a
- setitem routine for GtkTreeStore and GtkListStore.
- (_wrap_gtk_list_store_insert): add second argument to allow
- setting the values in the row when creating it.
- (_wrap_gtk_list_store_insert_before): same here.
- (_wrap_gtk_list_store_insert_after): and here.
- (_wrap_gtk_list_store_prepend): and here.
- (_wrap_gtk_list_store_append): and here.
- (_wrap_gtk_tree_store_insert): and here.
- (_wrap_gtk_tree_store_insert_before): and here.
- (_wrap_gtk_tree_store_insert_after): and here.
- (_wrap_gtk_tree_store_prepend): and here.
- (_wrap_gtk_tree_store_append): and here.
-
- * gtk/pygtk-private.h (_pygtk_tree_model_set_row): add prototype.
-
- * gtk/gtk-types.c (pygtk_tree_path_from_pyobject): support
- converting a path string to a GtkTreePath.
- (_pygtk_tree_model_set_row): new helper function to set a row from
- a sequence.
-
-2003-03-08 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gdk.defs (gdk_color_new): New placeholder function
- (gc_new): Set as constructor for GdkGC
-
- * gtk/gdk.override (_wrap_gdk_color_tp_setattr)
- (_wrap_gdk_color_new): Impl
-
-2003-03-06 James Henstridge <james@daa.com.au>
-
- * pygobject.c (pygobject_register_wrapper): the GObject should own
- a ref to the wrapper.
- (pygobject_new): get rid of the hasref code, and make sure that
- the GObject owns a ref to the wrapper if we create it.
- (pygobject_dealloc): get rid of the hasref code. If we get this
- far, the wrapper is dead.
- (pygobject_traverse): if the GObject's refcount == 1, then
- traverse to self.
- (pygobject_clear): clear self->obj and self->inst_dict.
- (pygobject_register_class): set tp_clear() so that things actually
- work. Without this, there was no tp_clear method for subclasses
- of GObject.
-
- * pygobject.h: remove hasref member, hopefully not needed if
- relying on cycle GC.
-
-2003-03-07 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.defs (gtk_label_new_with_mnemonic, gtk_label_new)
- (render_icon): Allow some parameters to be NULL.
-
- * gtk/gtk.override (_wrap_gtk_stock_lookup)
- (_wrap_gtk_stock_list_ids)
- (_wrap_gtk_tree_view_insert_column_with_data_func): Impl.
- (ignore-glob): Remove gtk_accelerator_*
-
- * examples/pygtk-demo/demos/stock_browser.py: Ported from C
-
-2003-03-04 Jon Trowbridge <trow@ximian.com>
-
- * gtk/gtkmodule.c (python_do_pending_calls): Block threads while
- we make our Py* calls. This prevents a 'no current thread' error
- if you try to kill a program by typing ctrl-c in the console it
- was launched from.
-
- * pygobject.c (pygobject_dealloc): Unblock threads before
- invalidating our closures, since this might trigger a destructor
- that needs to execute python code.
- (pygobject_clear): Ditto.
-
- * pygboxed.c (pyg_boxed_dealloc): Unblock threads before freeing
- the boxed type, since the destructor may need to execute python
- code.
- (pyg_boxed_new): Block threads while we make our Py* calls.
- (pyg_pointer_new): Block threads while we make our Py* calls.
-
- * gobjectmodule.c (pyg_object_set_property): We need to block
- threads before our call to pygobject_new.
- (pyg_object_get_property): Ditto.
-
-2003-03-02 Johan Dahlin <jdahlin@async.com.br>
-
- * gobjectmodule.c (pyg_io_add_watch): Fix function name in exception.
-
-2003-02-27 Johan Dahlin <jdahlin@async.com.br>
-
- * dsextras.py (getstatusoutput): Small typo.
-
- * setup.py: Cut the doclines, to make the windows installer happy
-
-2003-02-26 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gdk.defs (invalidate_rect): Null is okay here.
- Fixes #106295 (John Finlay).
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_new_from_xpm_data):
- Impl. Fixes #106292 (John Finlay)
-
- * pango.override (_wrap_pango_layout_set_text): Impl. Fixes
- #106280 (John Finlay)
-
- * gtk/gtk.override: Added get implements for all TextAttribute
- fields. Fixes #106279 (John Finlay).
-
- * gtk/gtk-types.defs (TextAttributes): Added fields.
-
- * setup.py, dsextras.py: Added win32 support and some
- rearrangements. Largely based upon patch by Cedric Gustin.
-
- * gtk/gdk.defs (pointer_grab, pointer_ungrab, keyboard_grab)
- (pointer_is_grabbed): Add.
-
- * gtk/gdk.defs: Add GDK_CURRENT_TIME as default value to all
- functions that require a time argument
-
-2003-02-24 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/libglade.override (_wrap_glade_bindtextdomain): Raise
- exception if bindtextdomain() returns NULL.
-
- * gtk/libglade.defs (textdomain): Wrap the textdomain() function.
-
-2003-02-14 James Henstridge <james@daa.com.au>
-
- * configure.in (export_dynamic): add guard around the
- export_dynamic flag from GTK_LIBS. (fixes bug 105728).
-
-=== PyGTK 1.99.15 ===
-
-2003-02-08 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in, setup.py: Upped version number
-
- * pygtk-2.0.pc.in (codegendir): Added.
-
- * setup.py: Added Numeric and gtkgl support (gtkgl untested).
-
- * dsextras.py: Updated.
-
- * gtk/libglade.override (connect_many): Add PyErr_Clear()
- here. Since PyMapping_GetItemString will raise an AttributeError
- if the handler can't be found.
-
-2003-01-31 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.override (_wrap_gdk_draw_rgb_image): add implementation.
- (_wrap_gdk_draw_rgb_32_image): add implementation.
- (_wrap_gdk_draw_gray_image): add
- (_wrap_gdk_draw_rgb_image, _wrap_gdk_draw_rgb_32_image): add xdith
- and ydith optional arguments, providing the functionality of the
- _dithalign variants.
-
-2003-01-30 Jon Trowbridge <trow@ximian.com>
-
- * gtk/gdk.override: Only call import_array if we HAVE_NUMPY.
-
-2003-01-30 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.override (_wrap_gdk_pixbuf__get_pixel_array): add
- wrapper that returns a NumPy array.
-
- * gtk/gdk-types.defs (Pixbuf): add a "pixel_array" member to
- pixbuf object.
-
- * configure.in (enable_numpy): get rid of code detecting which
- directory Numeric's arrayobject.h header is in. No point in
- supporting ancient versions ...
-
-2003-01-30 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk-types.defs (Layout): Wrap bin_window.
-
-2003-01-24 Johan Dahlin <jdahlin@async.com.br>
-
- * dsextras.py (InstallLib.add_template_option): Fix template bustage.
-
- * gtk/gtk.defs (set_from_image, set_from_file, set_from_pixbuf):
- Allow NULL here too. This definitly fixes #103559
-
-2003-01-23 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtkmodule.c (init_gtk): Added a timeout that calls
- python_do_pending_calls every 100 ms.
- (python_do_pending_calls): Call PyErr_CheckSignals, so Ctrl-C
- works as expected inside of gtk_main(). Fixes #72333
-
-2003-01-21 Johan Dahlin <jdahlin@async.com.br>
-
- * dsextras.py (Template.generate): Import codegen here instead,
- needs to be fixed in the future though.
-
- * Makefile.am (EXTRA_DIST): Added dsextras.py
-
- * gobjectmodule.c: Add GMainContext bindings and complete the
- GMainLoop bindings. Fixes #102362.
-
- * dsextras.py: Splitted out from setup.py. It should be reusable
- for gnome-python and other extensions that uses pygtk.
- Fixes #103615
-
- * gtk/gtk.override (quit_handler_marshal): Added to here, was
- generated before. This version handle threads better. Patch from
- John Finlay, Fixes #103851.
-
-2003-01-20 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gdk.override (_wrap_gdk_event_tp_getattr): Added correct
- __members__ to all different kind of GdkEvent's. This fixes the
- dir() output, also reported as #103979
-
-2003-01-19 Johan Dahlin <jdahlin@async.com.br>
-
- * pygtk.py (_get_available_versions): Check if a directory is
- empty before adding it to the path. Also added a few comments.
- Fixes #103876 (Ross Burton).
-
-2003-01-18 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.defs (drag_source_set_icon, set_from_pixmap): Null is
- okay here. Fixes #103559 (John Finlay)
-
- * gtk/gtk.defs (begins_tag, ends_tag, toggles_tag): Add default
- values. Fixes #103443 (John Finlay)
-
- * gtk/gdk.defs (bitmap_create_from_data): Change data parameter
- from const-gchar to const-guchar. Fixes #103616 (Eddie Kohler)
-
- * setup.py: use os.path.join in a few more places
-
- * pygobject-private.h: Add PyGMainLoop struct and type
-
- * gobjectmodule.c (_wrap_g_main_loop_new, _wrap_g_main_loop_quit)
- (_wrap_g_main_loop_is_running, _wrap_g_main_loop_run): Added
- GMainLoop wrapper.
- (initgobject): Register wrapper in gobject.MainLoop
-
- * setup.py: Check for the python version
- (Template.generate): Use codegen directly instead of os.system()
-
-2003-01-17 Jon Trowbridge <trow@ximian.com>
-
- * pygobject.c (pygobject_dealloc): In my fix for bug #102756 on
- 2003-01-08, I should have used calls to pyg_unblock_threads()/
- pyg_block_threads() instead of directly calling the
- Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS macros. The macros
- don't update our local thread lock counts, causing problems in
- cases where the finalization of one object triggers the
- finalization of another. (When I say "problems", I of course mean
- "horrible crashes".)
-
- * gtk/gtk-types.c (pygtk_style_helper_dealloc,
- pygtk_style_helper_setitem, pygtk_tree_model_row_dealloc,
- pygtk_tree_model_row_iter_dealloc): See above.
-
-2003-01-16 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/libglade.override (connect_many) Use PyObject_GetAttrString
- as a fallback. Remove warning.
- (_wrap_glade_xml_signal_autoconnect): Don't limit to PyDict_Type.
-
-2002-01-09 Joe Shaw <joe@ximian.com>
-
- * gtk/gtk.override (_wrap_gtk_icon_size_lookup): Wrap. The width
- and height are returned as a tuple.
-
-2003-01-09 Joe Shaw <joe@ximian.com>
-
- * gtk/gtk.override (_wrap_gtk_file_selection_get_selections):
- Added. Wraps the gtk_file_selection_get_selections() call which
- has a gchar ** return type, so it wasn't being wrapped.
-
-2003-01-08 Johan Dahlin <jdahlin@async.com.br>
-
- * setup.py: Make building with threading work (again).
-
-2003-01-08 Jon Trowbridge <trow@ximian.com>
-
- * pygobject.c (pygobject_dealloc): Wrap
- Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS around the call to
- g_object_unref. We need to do this because the object finalizers
- might trigger other code that has to acquire the interpreter lock,
- causing a deadlock. Fixes #102756.
-
- * gtk/gtk-types.c (pygtk_style_helper_dealloc): Wrap the call to
- g_object_unref in Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS.
- This should let us avoid other instances of bug #102756.
- (pygtk_style_helper_setitem): Ditto.
- (pygtk_tree_model_row_dealloc): Ditto.
- (pygtk_tree_model_row_iter_dealloc): Ditto.
-
- * gtk/gdk.override (pygdk_unblock_threads, pygdk_unblock_threads):
- Restored David I Lehn's patch (#98380). His patch was fine ---
- it just caused bug #102756 to emerge.
-
-2003-01-07 Johan Dahlin <jdahlin@async.com.br>
-
- * pygtk.py (_get_available_versions): Rewrite using glob.glob,
- with python2.2 glob uses fnmatch.filter with is an optimized
- version of what we did before. _get_available_versions is now
- roughly 5 times faster.
-
- * gtk/gdk.override (pygdk_block_threads, pygdk_unblock_threads):
- Reverted patch from David I Lehn (#98380) since it caused troubles
- for other people.
-
- * gtk/gtk.defs (gtk_text_tag_new): Add default paramter.
-
- * pangomodule.c (initpango): Added SCALE_* constants, patch by
- John Finlay, fixes #102731.
-
- * gtk/gtk.override (_wrap_gtk_text_buffer_create_tag): Modify to
- accept keyword parameters, largely based upon patch by John
- Finlay, fixes #102628
-
- * gtk/gtk.defs (GtkTextBuffer.get_slice): default last parameter
- to TRUE. #102607
- (GtkTextBuffer.get_text): ditto. #102607
- (GtkTextBuffer.create_mark): Default last param. to FALSE. #102627
-
- * setup.py, MANIFEST.in: Added distutils support
-
- * Makefile.am (EXTRA_DIST): Added setup.py and MANIFEST.in here.
-
- * .cvsignore: Add build/dist/MANIFEST here
-
-2003-01-06 Jon Trowbridge <trow@ximian.com>
-
- * gtk/pygtktreemodel.c (pygtk_generic_tree_model_get_path):
- pyg_unblock_threads was being called twice.
-
-2003-01-05 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/libglade.override: protect config.h by an ifdef.
-
-2003-01-01 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.override (_wrap_gtk_text_buffer_insert_at_cursor)
- (_wrap_gtk_text_buffer_insert_at_cursor)
- (_wrap_gtk_text_buffer_insert_interactive)
- (_wrap_gtk_text_buffer_insert_interactive_at_cursor): Wrap, so you
- don't have to specify the length of the string. For
- consistency. (It's not slower since Python does always store the
- length inside the PyStringObject struct). Patch (mostly) by
- John Finlay, fixes #102186.
- (_wrap_gtk_text_buffer_get_selection_bounds): Remove unused
- keyword argument and not up-to-date comment.
-
- * gtk/gtk.defs (GtkTreeView.scroll_to_cell): Add default values.
-
- * gtk/gtk.override (_wrap_gtk_tree_selection_get_selected): Check
- the mode before calling gtk_tree_selection_get_selected, this
- avoids an abort() in gtk+.
-
- * pygtk.py: Updated to fix #102180, so .require() can be called
- twice and won't do anything the second time (eg, not raise an
- error) based upon patch by warner-gnome.bugzilla@lothar.com
-
-2002-12-29 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.defs (set_cursor): Set default parameters.
-
-2002-12-28 Johan Dahlin <jdahlin@async.com.br>
-
- * gobjectmodule.c, gtk/gtk.override, gtk/pygtkcellrenderer.c,
- gtk/pygtktreemodel: Improve threading support by adding
- pyg_thread_block/unblock around all PyObject_Call* and
- g_object_refs.
- Based upon patch by Jon Trowbridge. Fixes #99102.
-
- * gtk/gdk-types.defs (ColorSpace): Add.
-
- * gtk/gdk.defs (GdkRectangle.intersect, GdkRectangle.union,
- gdk.atom_intern): Add
-
- * gtk/gdk.override (_wrap_gdk_rectangle_intersect): Impl.
- (_wrap_gdk_rectangle_union): Impl. (doesn't follow the GDK api to
- 100%, but this is much nicer from a python point of view)
-
-2002-12-28 Jeremy Katz <katzj@redhat.com>
-
- * codegen/codegen.py
- (GObjectWrapper.get_initial_constructor_substdict):
- GtkInvisible is a toplevel like GtkWindow and needs to be handled
- similarly for reference counting.
-
-2002-12-28 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.defs: Added -1 as default to second parameter, patch by
- John Finlay, fixes #102083.
-
-2002-12-28 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_text_buffer_set_text): get rid of
- len argument all together. The first argument knows its length.
-
-2002-12-27 James Henstridge <james@daa.com.au>
-
- * NEWS: add news items.
-
- * gtk/__init__.py: if True and False constants don't exist in
- __builtins__, add them. This way I can rely on them existing.
- Define gtk.TRUE and gtk.FALSE to True and False.
- (input_add_full): add extra compatibility name.
-
- * configure.in: increment version number.
-
-2002-12-26 James Henstridge <james@daa.com.au>
-
- * gtk/pygtktreemodel.c (pygtk_generic_tree_model_get_path): this
- should have been calling on_get_path(), rather than
- on_get_tree_path().
-
-2002-12-25 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs (GtkStyle.copy): caller owns return.
- (GtkRcStyle.copy): same.
- (GtkIconSet.copy): same.
- (GtkIconSource.copy): same.
- (GtkSelectionData.copy): same.
- (GtkStockItem.copy): same.
- (GtkBorder.copy): same.
- (GtkTextIter.copy): same.
- (GtkTextAttributes.copy): same.
- (GtkTreePath.copy): same.
- (GtkTreeIter.copy): same.
- (GtkRequisition.copy): same.
-
- * gtk/gtk.override (_wrap_gtk_layout_get_size): don't return NULL
- if user asks to register zero stock items.
-
-2002-12-24 James Henstridge <james@daa.com.au>
-
- * pygobject.c (pygobject_init): add abstract type check here too.
- (pygobject_init): make this code more similar to pyg_object_new,
- so that it is easier to fix bugs in the future.
- (pygobject_chain_from_overridden): check if
- g_signal_get_invocation_hint() returns NULL.
-
- * gobjectmodule.c (pyg_object_new): handle case of no keyword
- arguments.
- (pyg_object_new): refuse to instantiate an abstract type.
-
-2002-12-23 James Henstridge <james@daa.com.au>
-
- * autogen.sh (AUTOMAKE): use automake-1.7 in preference to 1.6.
-
- * configure.in (GLIB_LIBS): remove -export-dynamic from flags.
-
-2002-12-22 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.override
- (_wrap_gtk_text_view_get_location): Impl,
- patch from John Finlay, fixes 101714.
- (_wrap_gtk_text_view_get_line_at_y): Impl,
- patch from John Finlay, fixes 101716.
- (_wrap_gtk_text_view_get_line_yrange): Impl,
- patch from John Finlay, fixes 101720.
- (_wrap_gtk_text_view_get_iter_at_location): Impl,
- patch from John Finlay, fixes 101722.
-
- * examples/pygtk-demo/demos/editable_cells.py: New demo.
- * examples/pygtk-demo/pygtk-demo.py: Rearrange code a bit.
- * examples/pygtk-demo/demos/*.py: Clean up a bit.
-
- * gtk/gtk.override
- (_wrap_gtk_tree_view_insert_column_with_attributes): If the first
- argument (position) is -1, the column will be inserted at the end
- of the list, there for the new position will be columns - 1. If
- the columns isn't 1, it will be inserted at the requested
- position. This makes this function work again.
-
-
-2002-12-19 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gdk.override: Integrate patch by David I. Lehn, improves
- threading support, fixes #98380.
-
-2002-12-18 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.override (_wrap_gtk_text_buffer_get_selection_bounds):
- Impl, based upon patch by John Finlay, fixes #101499.
- (_wrap_gtk_text_view_get_visible_rect): Impl, patch by John
- Finlay, fixes #101503.
- (_wrap_gtk_tree_view_get_visible_rect): Impl, patch by John
- Finlay, fixes #101505.
- (_wrap_gtk_tree_view_column_cell_get_size): Impl.
-
-2002-12-17 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.defs (gtk_text_buffer_new): Add (default "NULL"), fixed
- #101490 (John Finlay).
-
- * gtk/gtk.override: ignore gtk_text_view_new.
-
- * gtk/gtk.defs (gtk_text_view_new_with_buffer): Add null-ok.
- Fixes #101489 (John Finlay).
-
-2002-12-11 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.override (_wrap_gtk_tree_view_get_cursor): Make the
- return value a bit more intelligent and only return what's requested.
- (_wrap_gtk_tree_view_get_cursor): Another try, this time, don't
- take any input arguments, always return a tuple with two items
- (which could be None)
- (_wrap_gtk_text_buffer_create_tag): Check if the tag exists before
- inserting into the tag table. Fixes #100668.
-
-2002-12-10 Johan Dahlin <jdahlin@telia.com>
-
- * pango.defs (pango_tab_array_new): Add, and make constructor of
- PangoTabArray.
-
-2002-12-08 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/__init__.py (threads_enter): point to gdk.threads_leave, not
- gdk.threads_enter! Fixes #100623. Thanks Jon Trowbridge.
-
- * gtk/gdk.override (_wrap_gdk_event_get_axis): Don't raise an
- exception when leaving this function, instead look in
- _PyGdkEvent_methods. (which raises an exception if it's not found)
- (_wrap_gdk_event_get_axis, _wrap_gdk_event_get_coords)
- (_wrap_gdk_event_get_root_coords): Impl.
-
-2002-12-05 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.override (_wrap_gtk_tree_selection_get_selected):
- Impl. Fixes #100389.
-
-2002-12-05 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs (create_pango_context): caller owns return.
- (create_pango_layout): caller owns return.
-
-2002-12-04 Johan Dahlin <jdahlin@async.com.br>
-
- * pygtk.py (_get_available_versions): s/os.path.exists/os.path.isdir/
-
- * gtk/gtk.override (_wrap_gtk_tree_store_set)
- (_wrap_gtk_tree_store_new, _wrap_gtk_list_store_new)
- (_wrap_gtk_list_store_set): Do an extra check for the number of
- arguments. Fixes #100349
-
- * pygtk-2.0.pc.in (Requires): Added gobject-2.0. Fixes #97727
-
- * gtk/gtk.override (_wrap_gtk_tree_view_get_cursor): Impl. Fixes
- #100077 (Dave Cook)
- (_wrap_gtk_tree_model_iter_nth_child): Allow argument to be None,
- fixes #99787. Thanks to Rob Melby for patch.
-
- * gtk/gdk.defs (keyval_name): add caller-owns-returns false, this
- prevents the code generator from freeing the return value. Fixes
- #100103 (Dave Cook)
-
- * gtk/gtk.override (_wrap_gtk_tree_view_get_cell_area)
- (_wrap_gtk_tree_view_get_cell_area)
- (_wrap_gtk_tree_view_get_background_area): Impl. Fixes #100301 (Dave Cook)
-
- * gtk/gtk.override (_wrap_gtk_tree_view_widget_to_tree_coords)
- (_wrap_gtk_tree_view_tree_to_widget_coords): Impl. Fixes #100302 (Dave Cook)
-
-2002-12-02 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.override (_wrap_gtk_tooltips__get_tips_data_list): Impl.
- (_wrap_gtk_tooltips__get_tips_data_list):
-
-2002-11-28 Johan Dahlin <jdahlin@async.com.br>
-
- * pygtk.py (_get_available_versions): If the directory doesn't
- exist skip it. If not, it breaks when doing os.listdir.
-
-2002-11-24 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_tree_model_tp_getitem): allow you to
- get a row object from a TreeIter as model[iter].
-
- * gtk/gtk-types.c (pygtk_tree_model_row_get_iter): allow getting
- an iter from a treemodel row object.
-
- * gtk/gdk.override (_wrap_gdk_pixmap_create_from_xpm_d): fix up
- ParseTuple call arguments (bug 99400).
-
- * gtk/gtk.defs (create_mark): allow None to be passed for
- mark_name argument (bug 99391).
-
-2002-11-20 Joe Shaw <joe@ximian.com>
-
- * gtk.override (_wrap_gtk_menu_attach_to_widget): Added. Fixes
- #97963.
-
- * pygtktreemodel.c: Add wrap all calls to PyObject_CallMethod() in
- pyg_block_threads() and pyg_unblock_threads(). Fixes #98344.
-
-2002-11-20 James Henstridge <james@daa.com.au>
-
- * codegen/argtypes.py (PyObjectArg): arg matcher for "PyObject*"
- args, from bug #98822.
-
-2002-11-19 James Henstridge <james@daa.com.au>
-
- * gtk/libglade.override (_wrap_glade_xml_get_widget_prefix): add
- wrapper.
-
- * gtk/gtkobject-support.c: get rid of pyg_handler_marshal and
- pyg_input_marshal, which were the last bits of code using the old
- GtkArg APIs in gtk.
-
- * gtk/gtk.override: remove wrappers for gtk_idle_add,
- gtk_timeout_add and gtk_input_add.
- (_wrap_gtk_quit_add): change so that it doesn't use
- pyg_handler_marshal.
-
- * gtk/__init__.py: set the TRUE and FALSE constants to True and
- False if possible. Fall back to 0/1 otherwise.
- (*): bind idle, timeout and input functions to gobject equivalents.
-
- * gobjectmodule.c (get_handler_priority): helper function to get
- priority value as a keyword argument.
- (pyg_idle_add): convert priority arg to an optional keyword
- argument.
- (pyg_timeout_add): and here.
- (pyg_io_add_watch): and here.
-
-2002-11-18 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_idle_add): add a wrapper for g_idle_add.
- (pyg_timeout_add): and a wrapper for g_timeout_add.
- (pyg_io_add_watch): and a wrapper for g_io_add_watch.
- (initgobject): add constants.
-
-2002-11-16 James Henstridge <james@daa.com.au>
-
- * pygobject.c (pygobject_connect_object): set up closure
- correctly. Fix from bug #96922.
- (pygobject_connect_object_after): and here.
-
- * gtk/gtk.override (_wrap_gtk_text_view_buffer_to_window_coords):
- (_wrap_gtk_text_view_window_to_buffer_coords): wrap functions.
-
- * pango.override: fix up calls to pyg_enum_get_value() so that it
- doesn't throw an exception when it shouldn't.
- (_wrap_pango_layout_get_pixel_extents): call get_pixel_extents()
- like it is supposed to. Fixes bug #93569.
-
- * pygtype.c (pyg_value_from_pyobject): if python object is None,
- set GValue to NULL for boxed, pointer and GObject types.
- (pyg_value_as_pyobject): convert G_TYPE_POINTER values to
- gobject.GPointer python objects.
- (pyg_value_as_pyobject): when converting G_TYPE_BOOLEAN values to
- python objects, return one of Py_True or Py_False, so that Python
- 2.3 will return an instance of bool.
-
- From patch on bug #96950
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_save): wrapper for
- GdkPixbuf.save()
-
- * codegen/argtypes.py (GdkRectanglePtrArg.write_param): handle
- GdkRectangle args with (null-ok) set.
-
- * gtk/gtk.defs (gtk.Style.paint_*): allow passing None for area,
- widget and detail arguments.
-
- * codegen/docgen.py (DocbookDocWriter.write_method): wrap
- <methodsynopsis> in a <programlisting> element.
- (DocbookDocWriter.write_constructor): same here.
- (DocbookDocWriter.write_params): wrap parameter description in a
- <simpara> element to conform to docbook DTD better.
- (DocbookDocWriter.write_params): add colon to end of terms, like
- in gtk-doc output.
-
- * docs/pygtk-docs.xsl: small changes to produce output more
- similar to new gtk-doc output.
-
-2002-11-15 James Henstridge <james@daa.com.au>
-
- * pango.defs (PangoContext.get_metrics): caller owns return value.
-
- * gtk/gtk.defs (GtkEntry.set_position): remove function, as it is
- deprecated and shadows the recommended API.
-
-2002-11-11 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/gtk.override: Ignore gtk_entry_select_region (It's deprecated,
- gtk_editable_select_region should be used instead). thanks
- Lars Wirzenius.
-
-2002-11-06 James Henstridge <james@daa.com.au>
-
- * codegen/argtypes.py (BoolArg.write_return): add bool arg that
- returns Py_True or Py_False (which are instances of the boolean
- type in Python 2.3). Partial fix for bug 95372.
-
-2002-11-04 Joe Shaw <joe@ximian.com>
-
- * gtk/pygtkcellrenderer.c (pygtk_generic_cell_renderer_get_size):
- Prevent NULL dereference by passing in local variables to
- PyArg_ParseTuple instead of our function arguments.
-
-2002-10-17 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/gtk.override: s/arg/argument/ in exception strings.
- (_wrap_gtk_box_query_child_packing): Use O! + PyGtkWidget_Type to
- PyArg_ParseTuple... and check so child actually is a child, to
- prevent returning uninitialized variables.
-
-2002-10-16 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/gtk.override (_wrap_gtk_container_child_set_property)
- (_wrap_gtk_container_child_get_property)
- (_wrap_gtk_container_child_set)
- (_wrap_gtk_container_child_get)
- (_wrap_gtk_container_add_with_properties)
- (_wrap_gtk_container_foreach): Impl.
-
-2002-09-05 Matt Wilson <msw@redhat.com>
-
- * gtk/gdk.defs (get_from_drawable): GdkPixbuf.get_from_drawable
- doesn't actually leak pixbuf, remove caller-owns-return.
-
-2002-09-02 Matt Wilson <msw@redhat.com>
-
- * gtk/gdk.defs (get_from_drawable, copy, add_alpha, scale_simple
- composite_color_simple): more caller-owns-return.
-
-2002-08-31 James Henstridge <james@daa.com.au>
-
- * codegen/docgen.py (DocbookDocWriter.write_params): separate out
- the code that writes the variable list.
-
-2002-08-30 Sander Vesik <sander.vesik@sun.com>
-
- * autogen.sh: use automake-1.6/aclocal-1.6 unless otherwise
- requested
-
-2002-08-30 Matt Wilson <msw@redhat.com>
-
- * gtk/gdk.defs (pixbuf_new_from_file, pixbuf_new_from_data
- pixbuf_new_from_xpm_data, pixbuf_new_from_inline):
- caller-owns-return, to avoid leaking pixbufs
-
-2002-08-26 Joe Shaw <joe@ximian.com>
-
- * codegen/argtypes.py: Add gsize and gssize as valid integer
- types.
-
-2002-08-26 James Henstridge <james@daa.com.au>
-
- * codegen/docgen.py (DocWriter.write_full_hierarchy): fix up
- misspelling.
-
- * pygtype.c (pyg_value_from_pyobject): fix typo from when I was
- applying Thomas's patch.
-
- * codegen/docgen.py (build_object_tree): show interfaces, boxes
- and pointers in class heirachy.
- (DocbookDocWriter.write_synopsis): show parent class for
- interfaces, boxes and pointers in class synopsis.
-
- * gtk/gtk-types.defs (CellEditable): CellEditable is an interface,
- not a GObject.
-
-2002-08-25 James Henstridge <james@daa.com.au>
-
- * codegen/docgen.py: lots of docbuild updates.
-
- * docs/pygtk-docs.xml: add driver file.
-
- * docs/build-docs.py: move file to docs directory.
-
- * NEWS: update news file.
-
- * configure.in: increment version number.
-
-2002-08-24 James Henstridge <james@daa.com.au>
-
- mingw32 patches from Cedric Gustin <cgustin@ibelgique.com>:
-
- * gtk/gtk.override: ignore more socket/plug functions on win32.
-
- * gtk/gdk.override: gdk_pixmap_lookup is not implemented on win32.
-
- * gtk/Makefile.am (common_ldflags): and here.
-
- * pango.override (PyPangoAttribute_Type): initialise tp_alloc and
- tp_new in the init() function, rather than in the structure
- definition itself.
-
- * Makefile.am (common_ldflags): pass -no-undefined if we are on
- windows.
-
- * configure.in: turn on win32 DLL support, and add OS_WIN32 and
- PLATFORM_WIN32 conditionals for use in makefiles.
-
-2002-08-21 Jon K Hellan <hellan@acm.org>
-
- * codegen/argtypes.py (arg): More char* variants.
-
-2002-08-20 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.defs (gtk.gdk.Window.set_title): fix up typo.
-
-2002-08-20 Johan Dahlin <jdahlin@telia.com>
-
- Patch from Arjan J. Molenaar:
- * gobjectmodule.c (pyg_type_register): Don't unref borrowed
- references.
-
-2002-08-19 James Henstridge <james@daa.com.au>
-
- * codegen/codegen.py
- (GObjectWrapper.get_initial_constructor_substdict): fix small
- typo.
-
- * gtk/gtk.override (_wrap_gtk_dialog_new_with_buttons): ref the
- widget after constructing it.
- (_wrap_gtk_message_dialog_new): same here.
-
- * codegen/codegen.py
- (GObjectWrapper.get_initial_constructor_substdict): add special
- case code to ref() GtkWindow instances in their constructor, as we
- don't own the initial reference (it is managed internally by
- gtk+). This fixes bug #90213.
-
-2002-08-18 James Henstridge <james@daa.com.au>
-
- * pygtk.spec.in: update spec file.
-
- * gtk/Makefile.am: same here.
-
- * Makefile.am: install in a gtk-2.0 subdir of site-packages.
-
- * pygtk.py: new file to help with pygtk version parallel install.
-
- * gobjectmodule.c (pyg_object_set_property): unref object_wrapper.
- (pyg_object_get_property): unref object_wrapper. (from patch by
- Arjan Molenaar on bug #71021).
-
- * gtk/gtk.defs (TreeView.set_cursor): allow column to be None
- (fixes bug #91043).
-
- * codegen/argtypes.py (ObjectArg.write_return): fix up generated
- code.
-
- * gtk/gtk.override (_wrap_gtk_clist_new_with_titles): don't need
- to manually sink.
- (_wrap_gtk_tree_view_column_new): same here.
- (_wrap_gtk_button_new): same here.
- (_wrap_gtk_toggle_button_new): same here.
- (_wrap_gtk_check_button_new): same here.
- (_wrap_gtk_radio_button_new): same here.
- (_wrap_gtk_list_item_new): same here.
- (_wrap_gtk_menu_item_new): same here.
- (_wrap_gtk_check_menu_item_new): same here.
- (_wrap_gtk_radio_menu_item_new): same here.
- (_wrap_gtk_image_menu_item_new): same here.
- (_wrap_gtk_ctree_new_with_titles): same here.
- (_wrap_gtk_dialog_new_with_buttons): same here.
- (_wrap_gtk_message_dialog_new): same here.
- (_wrap_gtk_progress_bar_new_with_adjustment): same here.
-
- * gtk/gtkmodule.c (sink_gtkobject): function to sink a GtkObject
- if it is floating.
- (init_gtk): register sink_gtkobject for sinking GtkObjects.
-
- * codegen/codegen.py
- (GObjectWrapper.get_initial_constructor_substdict): get rid of
- gtkobjectsink bit of code.
-
- * pygobject.c (pygobject_register_sinkfunc): new function to
- register a function to get rid of the floating reference from an
- object.
- (sink_object): run a sinkfunc for an object if it has been
- registered.
- (pygobject_new): call sink_object
- (pygobject_register_wrapper): call sink_object.
-
-Sat Aug 17 20:02:43 2002 Jonathan Blandford <jrb@gnome.org>
-
- * codegen/argtypes.py (TimeTArg.write_param): Add a time_t
- parameter type.
-
-2002-08-17 James Henstridge <james@daa.com.au>
-
- * pygtype.c (pyg_value_from_pyobject): allow None when converting
- to string GValue (bug picked up by Thomas Leonard.
-
- * gtk/gtk.defs (scroll_to_cell): allow column to be None (bug #90398).
-
-2002-08-16 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/gdk.defs: Add null-ok to GdkWindow.set_cursor.
- Fixes #88463.
-
-2002-07-23 James Henstridge <james@daa.com.au>
-
- * configure.in: updated version number.
-
-2002-07-20 James Henstridge <james@daa.com.au>
-
- * gtk/pygtkcellrenderer.c (pygtk_generic_cell_renderer_*): fix up
- arguments, and use "O" format code for PyObject_CallMethod --
- can't rely on "N" causing the argument to be unrefed.
-
- * gtk/gtk.override (_wrap_gtk_cell_renderer_get_size): cell_area
- is an argument; not a return.
-
- * gtk/gtk.override (GtkTreeModel.tp_as_number): add nonzero method
- to tree models, so that they evaluate to a truth value even if
- they have zero elements. (at request of msw).
-
- * gtk/gtk-extrafuncs.defs, gtk/gtk.override: add GenericCellRenderer.
-
- * gtk/pygtkcellrenderer.[ch]: add "generic" cell renderer code,
- based on jrb's work.
-
-2002-07-18 James Henstridge <james@daa.com.au>
-
- * gtk/Makefile.am (glademodule_la_LDFLAGS): fix up
- -export-symbols-regex flag.
- (glmodule_la_LDFLAGS): same here.
-
-2002-07-15 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-types.c (pygtk_tree_model_row_getsets): add next,
- parent, model and path attributes to row objects.
- (pygtk_tree_model_row_methods): add an iterchildren() method to
- row objects.
-
- * gtk/gtk.override (pygtk_register_classes): rather than #defines,
- set the tp_as_mapping and tp_iter members of GtkListStore, etc in
- the init func.
-
- * gtk/gtk.override (_wrap_gtk_list_store_tp_iter): iter(liststore)
- returns a gtk.TreeModelRowIter object.
-
- * gtk/gtk-types.c (PyGtkTreeModelRowIter_Type): new iterator type
- that returns a sequence of gtk.TreeModelRow objects for nodes
- under a particular parent node.
-
-2002-07-13 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (GtkListStore.tp_as_mapping): explicitly define
- this, as PyType_Ready doesn't seem to inherit special methods from
- secondary bases correctly.
- (GtkTreeStore.tp_as_mapping): same here.
-
- * gtk/gtk-types.c (PyGdkRectangle_to_value): fix up argument
- ordering bug.
-
- * gtk/gtk.override (_wrap_gtk_tree_model_tp_as_mapping): move
- these mapping behaviours to the GtkTreeModel wrapper.
-
- * gtk/gtk-types.c (PyGtkTreeModelRow_Type): rename from
- GtkListStoreRow, and extend so that it can handle setting cells
- for tree stores.
-
- * build-docs.py (dg): parse template dirs for additional
- documentation.
-
- * codegen/docgen.py (DocWriter.add_tmpldirs): add function to
- extract docs in the tmpl files.
-
- * gtk/gtk.override (_wrap_gtk_list_store_tp_getitem): allow
- subscripting of a GtkListStore to get row wrappers.
- (_wrap_gtk_tree_model_get_iter_from_string): add override.
-
- * gtk/gtk-types.c: add PyGtkListStoreRow type, that represents a
- row in a list store.
- (_pygtk_register_boxed_types): set the ob_type member.
-
-2002-07-12 James Henstridge <james@daa.com.au>
-
- These changes help with win32 compat.
-
- * pygboxed.c (PyGBoxed_Type): set tp_alloc and tp_new to NULL.
- (PyGPointer_Type): same here.
-
- * gobjectmodule.c (PyGInterface_Type): set tp_alloc and tp_new to
- NULL.
- (initgobject): set tp_new and tp_alloc for various types.
-
- * pygobject.c (PyGObject_Type): set tp_alloc and tp_new to NULL.
-
-2002-07-10 Murray Cumming <murrayc@usa.net>
-
- * codegen/docextract_to_xml.py: Used jamesh's new extract_tmpl()
- function to get the sgml tmpl files. This file is only used by
- gtkmm at the moment, not pygtk itself.
-
-2002-07-10 James Henstridge <james@daa.com.au>
-
- * configure.in: increment version number to 1.99.11.
-
- * codegen/argtypes.py (GdkNativeWindow): add arg type. This one
- also from Thomas Leonard.
-
- * gtk/gtk.defs (set_tip): allow tip_private to be NULL, and allow
- it to be omitted. Fix suggested by Thomas Leonard
- <tal00r@ecs.soton.ac.uk>
-
- * gtk/gtkmodule.c (init_gtk): make sure LC_NUMERIC is set to C
- after gtk_init_check().
-
- * codegen/h2def.py (clean_func): apply patch by David Lehn
- <dlehn@vt.edu> to correctly handle multi-line preprocessor
- macros. From bug #81771.
- (write_func): apply patch by Arjan Molenaar to write out
- is-constructor-of lines for function definitions that look like
- they might be constructors (doesn't catch every case, but is
- better than nothing). From bug #80914.
-
-2002-07-09 James Henstridge <james@daa.com.au>
-
- * codegen/docextract.py (extract_tmpl): function to extract docs
- from gtk-doc 'tmpl' files. Takes a list of tmpl/ directories as
- an argument. Doesn't recurse. Fixes bug 86860.
-
- Reworking of Arjan Molenaar's (arjanmolenaar@hetnet.nl) patch from
- bug 71435.
-
- * gtk/libglade.override (connect_one): watch the closure.
- (connect_many): watch the closure.
-
- * gtk/gtk.override (_wrap_gtk_toolbar_append_item): watch closure
- for signal.
- (_wrap_gtk_toolbar_prepend_item): same here.
- (_wrap_gtk_toolbar_insert_item): same here.
- (_wrap_gtk_toolbar_insert_stock): same here.
- (_wrap_gtk_toolbar_append_element): same here.
- (_wrap_gtk_toolbar_prepend_element): same here.
- (_wrap_gtk_toolbar_insert_element): same here.
-
- * pygobject.h (_PyGObject_Functions): add pygobject_watch_closure
- to the list of exported functions.
-
- * pygobject.c (pygobject_watch_closure): new function to watch a
- closure. We perform cyclic garbage collection on watched
- closures. The closure will automatically be unwatched when it
- gets invalidated.
- (pygobject_traverse): traverse watched closures as well.
- (pygobject_clear): invalidate all watched closures
- (pygobject_dealloc): invalidate watched closures on dealloc too.
- (PyGObject_Type): register the invalidate handler.
- (pygobject_connect): watch the closure we connect here.
- (pygobject_connect_after): same here..
- (pygobject_connect_object): same here.
- (pygobject_connect_object_after): same here.
-
- * pygtype.c (pyg_closure_new): clean up closure on invalidate,
- rather than finalize (on invalidate, we break references).
-
- * pygobject.h (PyGObject): add closures member to store references
- to PyGClosures.
-
-
- * gtk/gtk.override (_wrap_gtk_tree_model_iter_next): change so
- that it returns the next item, rather than modifying the iter.
- (_wrap_gtk_tree_model_iter_parent): add wrapper, so that we return
- the parent iter.
- (_wrap_gtk_tree_model_iter_nth_child): add wrapper.
-
-2002-07-08 James Henstridge <james@daa.com.au>
-
- * codegen/docextract.py (parse_tmpl): fix up simple loading of
- tmpl files.
-
- * pygobject.c (pygobject_connect): apply another memory leak fix
- from Arjan (from bug #87413).
- (pygobject_connect_after): equivalent fix here.
- (pygobject_connect_object): and here.
- (pygobject_connect_object_after): and here.
-
- * gtk/gtk-types.c (PyGdkRectangle_to_value): add custom boxed
- handlers for GDK_TYPE_RECTANGLE, so that 4-sequences can
- automatically be marshaled to GdkRectangle values.
-
-2002-07-07 James Henstridge <james@daa.com.au>
-
- * pygobject.c (pygobject_get_refcount): add __grefcount__ property.
-
- * gtk/gdk.override (_wrap_gdk_event_tp_getattr): return a boxed
- type for gdk.Event.area for expose events.
-
- * gtk/gtk.override (_wrap_gtk_widget_intersect): use
- pygdk_rectangle_from_pyobject.
-
- * codegen/argtypes.py (arg): register GdkRectanglePtrArg handler
- for "GtkAllocation*".
-
- * gtk/gtk.override (_wrap_gtk_paint_polygon): use
- pygdk_rectangle_from_pyboejct to read rectangle argument.
- (_wrap_gtk_widget_draw): remove overrides. Should be handled by
- code generator.
- (_wrap_gtk_widget_size_allocate): remove this override too.
-
- * codegen/argtypes.py (GtkTreePathArg.write_return): update to use
- this function.
- (ArgMatcher.register_boxed): short circuit if there is already a
- handler for the boxed type (helps with setting custom handlers for
- boxed types).
-
- * gtk/gtk-types.c (pygdk_rectangle_from_pyobject): new function to
- parse a GdkRectangle from a PyObject.
-
- * gtk/pygtktreemodel.c (pygtk_generic_tree_model_get_path): print
- a warning if the return value could not be converted to a
- GtkTreePath.
-
- * gtk/gtk.override (_wrap_gtk_tree_model_get_value): don't assume
- tree paths are tuples.
-
- * codegen/argtypes.py (GtkTreePathArg.write_param): fix up code
- generator to get rid of assumption that tree paths are tuples, and
- catch case where pygtk_tree_path_from_pyobject() returns NULL.
-
- * gtk/gtk-types.c (pygtk_tree_path_from_pyobject): change so that
- we treat an integer PyObject as a tree path with a single index.
-
- * pygtype.c (pyg_closure_marshal): apply patch from Arjan Molenaar
- <arjanmolenaar@hetnet.nl> that fixes a reference leak for the
- argument tuple passed to the callback.
- (pyg_signal_class_closure_marshal): apply similar fix here.
-
-Thu Jul 4 10:58:51 2002 Jonathan Blandford <jrb@gnome.org>
-
- * gtk/gtk-types.defs (TreeModelSort): We also implement
- GtkTreeSortable.
-
- * gtk/gtk.defs (gtk_tree_model_sort_new_with_model): get the right
- is-constructor-of value.
-
-2002-06-30 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (pygtk_menu_position): fix up menu position
- func (fixes bug #85994).
-
-2002-06-27 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs (check_version): caller does _not_ own the returned
- string. Bug found by Anders Carlsson.
-
-2002-06-24 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs (drag_source_set_icon_pixbuf): fix definition, as
- reported by Thomas Leonard <tal00r@ecs.soton.ac.uk>
-
-Sun Jun 23 11:10:30 2002 Jonathan Blandford <jrb@gnome.org>
-
- * pygboxed.c: Add GBoxed::copy
-
- * pygobject.c (pygobject_init): take kwargs so we can pass
- construct-only arguments to our initialization function.
-
-2002-06-23 James Henstridge <james@daa.com.au>
-
- * examples/simple/scribble.py: update example to work with current
- PyGTK.
-
- * gtk/gtk.override (_wrap_gtk_tree_sortable_get_sort_column_id):
- copy boxed arguments.
-
- * pygobject.h: fix up prototypes.
-
- * gobjectmodule.c (pyg_object_set_property): copy boxed arguments.
-
- * pygobject.c (pygobject_get_property): copy boxed arguments here.
- (pygobject_emit): same here.
- (pygobject_chain_from_overridden): same here.
-
- * pygtype.c (pyg_value_as_pyobject): add "copy_boxed" argument to
- this function.
- (pyg_closure_marshal): pass FALSE for copy_boxed argument.
- (pyg_signal_class_closure_marshal): same here.
-
-2002-06-19 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_ctree_insert_node): check the
- correct value when setting the sibling. Patch from Tim Waugh
- <twaugh@redhat.com>
-
-2002-06-18 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_tree_sortable_get_sort_column_id):
- implement GtkTreeSortable.get_sort_column_id
-
-2002-06-18 James Henstridge <james@daa.com.au>
-
- * gtk/gtkgl.override (_wrap_gtk_gl_area_share_new): constructors
- return ints.
-
- * gtk/gdk.override, gtk/gtk.override: ignore all _ref() or
- _unref() functions.
-
- * codegen/argtypes.py (BoxedArg.write_return): fix up handling of
- ownsreturn for Boxed return types.
-
-2002-06-17 Matt Wilson <msw@redhat.com>
-
- * pygtype.c (pyg_value_as_pyobject): if a value holds a PyObject*,
- the code that is getting the value is expecting a valid object.
- Translate NULL pointers to Py_None.
-
-2002-06-17 Johan Dahlin <jdahlin@telia.com>
-
- * pango.defs: added PangoLayout.set_text
-
-Mon Jun 17 09:52:45 2002 Jonathan Blandford <jrb@gnome.org>
-
- * gtk/gtk-types.defs: Add GtkRequisition
- * gtk/gtk.override: Add GtkRequisition
-
-2002-06-15 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_error_check): decref the exception instance
- after raising the error.
-
-Fri Jun 7 12:39:27 2002 Jonathan Blandford <jrb@redhat.com>
-
- * gtk/gtk.override (pygtk_tree_selection_foreach_marshal): fix
- GtkTreeSelection::get_selected()
-
-2002-06-09 James Henstridge <james@daa.com.au>
-
- * codegen/argtypes.py (BoxedArg.write_param): if the ptype is
- different to self.typecode, cast the event
-
- * gtk/gdk-types.defs (EventExpose): remove definition, as it
- breaks stuff.
-
-2002-06-04 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk-extrafuncs.defs (set_all): add GtkAdjustment.set_all
-
- * gtk/gtk.override (_wrap_gtk_adjustment_set_all): implement, for
- compatibility with PyGtk 0.6.x. Mark it as deprecated.
- (_wrap_gtk_adjustment__set_value)
- (_wrap_gtk_adjustment__set_lower)
- (_wrap_gtk_adjustment__set_upper)
- (_wrap_gtk_adjustment__set_step_increment)
- (_wrap_gtk_adjustment__set_page_increment)
- (_wrap_gtk_adjustment__set_page_size): implement setters for
- GtkAdjustment.{value, lower, upper, step_increment,
- page_increment, set_page_size}
-
-2002-06-03 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override
- (_wrap_gtk_tree_view_insert_column_with_attributes): implement
- (code mostly from jrb@redhat.com, minor fixups from me)
-
- * gtk/gdk-types.defs (EventExpose): added to make the code
- generator write GdkEventExpose * for
- _wrap_gtk_container_propagate_expose (gets rid of a warning)
-
-2002-05-31 Matt Wilson <msw@redhat.com>
-
- * examples/pygtk-demo/demos/list_store.py (fixed_toggled): the
- path argument must be a tuple. Ints are not automatically
- converted to tuples any more.
-
- * pygtype.c (pyg_value_as_pyobject): change the behavior of
- G_TYPE_UINT to match the code generator's output on 32 bit
- systems.
-
-2002-05-19 James Henstridge <james@daa.com.au>
-
- * gtk/Makefile.am (pygtk_PYTHON): install compat.py
-
-2002-05-18 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_editable_insert_text): add length
- and pos as keywords, allow user to override the length of text to
- be added (like other text insert functions)
-
-2002-05-16 James Henstridge <james@daa.com.au>
-
- * pygtype.c (pyg_value_from_pyobject): add support for
- G_TYPE_INTERFACE, provided the interface has a prereq on
- G_TYPE_OBJECT.
- (pyg_value_as_pyobject): same here.
-
-2002-05-14 James Henstridge <james@daa.com.au>
-
- * pygtype.c (pyg_value_from_pyobject): add handler for
- G_TYPE_PARAM (fix bug #81695).
- (pyg_value_as_pyobject): same in this function.
-
- * codegen/argtypes.py (ULongArg): use 'O!' format code, so we can
- reduce the size of the extra code we output.
- (Int64Arg): add arg handler (to solve bug #81694).
- (UInt64Arg): add arg handler (bug #81694 again).
- (ObjectArg.write_param): simplify output code using O! code for
- the normal and default value cases.
-
-2002-05-13 James Henstridge <james@daa.com.au>
-
- * configure.in: increment version number.
-
- * codegen/definitions.py (MethodDef.__init__): skip the
- caller_owns_return bit if no return value clause given.
- (FunctionDef.__init__): same here.
-
-2002-05-12 James Henstridge <james@daa.com.au>
-
- * codegen/argtypes.py (ObjectArg.write_return): add handler for
- ownsreturn case for GObjects.
- (BoxedArg.write_return): and for boxed types ...
- (GtkTreePathArg.write_return): handle ownsreturn.
-
-2002-05-10 James Henstridge <james@daa.com.au>
-
- * codegen/argtypes.py (StringArg.write_return): make this handler
- actually look at the ownsreturn argument. This fixes a crasher
- when reading string type attributes (it was freeing the struct
- member!).
-
-2002-05-09 James Henstridge <james@daa.com.au>
-
- * gtk/gtkgl.defs: get rid of gtk_gl and gdk_gl prefix on some
- functions.
-
- * codegen/codegen.py (Wrapper.write_function_wrapper): pass
- caller_owns_return as argument to write_return.
- (Wrapper.write_getsets): add extra arg to write_return() call.
-
- * codegen/argtypes.py (*.write_return): add an extra "ownsreturn"
- argument to all write_return functions.
-
- * codegen/definitions.py (MethodDef.__init__): read a
- caller_owns_return variable. It defaults to false if ommitted,
- unless we have a string return.
- (FunctionDef.__init__): same here, but also make
- caller_owns_return true for constructors.
-
-2002-05-08 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_tree_model_get_value): fix typo. I
- should test these things before committing.
-
-2002-05-05 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (gtk_tree_sortable_set_sort_func): implement.
- (gtk_tree_sortable_set_default_sort_func): implement.
-
- * gtk/compat.py: start of compatibility module.
-
- * gtk/gtk.override (_wrap_gtk_tree_model_foreach): fix up foreach
- handler.
- (_wrap_gtk_tree_model_get_iter): change to take a single argument
- as the path, as discussed in bug 75811.
-
-2002-05-04 James Henstridge <james@daa.com.au>
-
- * Makefile.am (EXTRA_DIST): add extra files to dist (from bug
- #79872).
-
- * gtk/gtk.defs (set_from_pixmap): allow NULL pointer passed for
- mask.
-
- * gtk/gtk.override (pygtk_tree_foreach_marshal): pass model, path
- and iter to the callback.
- (_wrap_gtk_tree_model_foreach): implement.
-
-2002-04-29 Matt Wilson <msw@redhat.com>
-
- * codegen/argtypes.py (ULongArg): implemented an argtype to handle
- guint32 (on 32 bit platformas) and gulong arguments such that
- large values (>MAX_INT on 32 bit platforms) don't overflow.
-
-2002-04-25 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (gtk_spin_button_new): s/gbutton/gdouble/ from Art Haas.
-
-2002-04-25 James Henstridge <james@daa.com.au>
-
- * codegen/argtypes.py (ArgMatcher.get): add hack to match
- GdkEvent* and use the GdkEvent handler.
-
- * gtk/gtk.override (_wrap_gtk_text_iter_get_char): remove wrapper,
- as arg type covers this case fine.
-
- * codegen/argtypes.py (GUniCharArg.write_return): add code for
- handling gunichar returns.
- (GUniCharArg.write_param): and support for gunichar parameters.
-
-2002-04-23 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-types.c: remove old commented out GdkGC implementation.
-
-2002-04-22 James Henstridge <james@daa.com.au>
-
- * gtk/Makefile.am (EXTRA_DIST): same here.
-
- * Makefile.am (EXTRA_DIST): include windows make stuff.
-
- * gtk/gdk.override (_wrap_gdk_gc_tp_setattr): don't allow setting
- attributes on GdkGC instances. Simplifies things a bit.
-
-2002-04-21 Hans Breuer <hans@breuer.org>
-
- * codegen/codegen.py : added parameter --errorfilename
- to allow redirection of stderr even with clumsy windoze
- shell
-
- * codegen/override.py : extended to allow 'sys.platform'
- specific ignores
-
- * examples/pygtk-demo/demos/colorsel.py : use
- color = gtk.gdk.color_parse("blue")
- to get the initial color
-
- * examples/pygtk-demo/demos/draw.py : (new file)
- demonstrating some simple drawing operations. It is
- using the gtk.GC interface additions below.
-
- * gtk/gdk.override : implement GdkGC.tp_getattr,
- GdkGC.tp_setattr and gdk_gc_set_dashes (ported from #if 0'ed
- code in gtk/gtk-types.c (should be removed there ?)
-
- * gtk/gtk.override : ignore-win32 GTK_TYPE_PLUG
- GTK_TYPE_SOCKET gtk_socket_new (the TYPE ignores do not work yet)
-
- * config.h.win32 makefile.msc pygtk/makefile.msc :
- new files to build pygtk on windoze using the established
- glib/build/win32 infrastructure
-
- * pygtk/gtk/gtk-fake-win32.c : (new file) implementing
- gtk_plug_get_type() and gtk_socket_get_type(). It could
- vanish if codegen/codegen.py has learned something like
- 'ignore-class-$(sys.platform) or my GtkPlug/GtkSocket
- patch gets accepted with Gtk.
-
- * gtk/gtkmodule.c : added a g_assert() to ensure importing
- pygobject did work.
-
-2002-04-21 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_drag_dest_find_target): implement.
- (_wrap_gtk_drag_dest_get_target_list): implement.
- (_wrap_gtk_drag_dest_set_target_list): implement.
-
-2002-04-20 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_container_get_children): implement.
- (_wrap_gtk_container_set_focus_chain): implement.
- (_wrap_gtk_container_get_focus_chain): implement.
-
-2002-04-19 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_text_buffer_insert_with_tags): implement.
- (_wrap_gtk_text_buffer_insert_with_tags_by_name): implement.
- (_wrap_gtk_text_child_anchor_get_widgets): implement.
- (_wrap_gtk_tree_view_column_get_cell_renderers): implement.
- (_wrap_gtk_tree_view_column_set_attributes): implement.
-
-2002-04-18 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_selection_data_get_targets): implement.
- (_wrap_gtk_tree_get_row_drag_data): implement.
- (_wrap_gtk_im_context_get_preedit_string): implement.
- (_wrap_gtk_im_context_filter_keypress): implement.
- (_wrap_gtk_im_context_get_surrounding): implement.
- (_wrap_gtk_paint_polygon): implement.
-
- * gtk/gtk-types.defs (CellEditable): add CellEditable interface.
-
- * codegen/h2def.py (strip_comments): add function to strip
- comments, and get rest of script to use it. This one doesn't use
- RE's, so it doesn't cause a stack overflow when parsing
- atkobject.h.
-
- * gtk/libglade.defs (get_toplevel_names): remove def, as it isn't
- in the libglade API anymore.
-
-2002-04-16 Matt Wilson <msw@redhat.com>
-
- * gtk/libglade.override (_wrap_glade_bindtextdomain): added
- wrapper which will allow user to bind a textdomain. Also sets the
- codeset to UTF-8 if bind_textdomain_codeset is available.
-
- * config.h.in: added HAVE_BIND_TEXTDOMAIN_CODESET
-
- * configure.in: check for bind_textdomain_codeset
-
- * gtk/libglade.defs (bindtextdomain): added extra function to
- implement gtk.glade.bindtextdomain
-
- * gtk/gtk.override
- (pygtk_cell_data_func_marshal,
- _wrap_gtk_tree_view_column_set_cell_data_func): added wrapper for
- GtkTreeViewColumn.set_cell_data_func from Jonathan Blandford
- <jrb@redhat.com>
-
-2002-04-17 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs, gdk/gdk.defs: updates to match final gtk 2.0 APIs.
-
-2002-04-15 James Henstridge <james@daa.com.au>
-
- * pango.override: add a PangoAttribute wrapper type, constructors
- for various attributes, and methods for inserting attributes in a
- PangoAttrList.
-
- * pango.defs, gtk/gdk.defs: add missing definitions.
-
-2002-04-12 Xavier Ordoquy <mcarkan@user.sourceforge.net>
-
- * configure.in:
- * gtk/Makefile.am:
- Added the gtk.gl module.
-
- * gtk/gtkgl.defs:
- * gtk/gtkgl.override:
- * gtk/gtkglmodule.c: (initgl):
- Updated the gtkgl module and changed the name to gtk.gl
-
- * examples/gl/dots.py:
- Updated example but still needs some work.
-
- * examples/gl/cone.py:
- * examples/gl/gears.py:
- Updated working examples.
-
-2002-04-10 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs: remove deprecation messages for many GtkList and
- GtkListItem methods, as they are still required for the non
- deprecated GtkCombo. GtkList's constructor is still marked
- deprecated.
-
- * gtk/gtk.override (_wrap_gtk_text_iter_get_char): don't raise an
- exception for unicode chars > 0xffff if we have 32 bit unicode
- chars in python.
-
-2002-04-08 James Henstridge <james@daa.com.au>
-
- * pango.override (_wrap_pango_glyph_string_get_logical_widths):
- add wrapper.
- (_wrap_pango_parse_markup): add wrapper.
-
-2002-03-28 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/gdk.defs: Add functions from gdkkeys.h
-
- * gtk/gdk-types.defs: Add GdkKeymap object
-
-2002-03-22 James Henstridge <james@daa.com.au>
-
- * gtk/libglade.override (connect_many): don't decref the return
- value of PyDict_GetItemString().
-
-2002-03-22 Johan Dahlin <jdahlin@telia.com>
-
- * codegen/codegen.py: move type_tmpl to Wrapper class, saves 100 loc
-
-2002-03-22 James Henstridge <james@daa.com.au>
-
- * codegen/codegen.py: code generator refactoring. Reduces file
- length by 500 lines, and fixes a few bugs in the process.
-
-2002-03-19 Matt Wilson <msw@redhat.com>
-
- * autogen.sh: allow override of autoconf and autoheader
-
- * gtk/gtk.defs (GtkTreeModel.get_iter_root): use the
- gtk_tree_model_get_iter_first code, get_iter_root is going to be
- deprecated.
- (GtkTreeModel.get_iter_first): added
-
- * gtk/gtk.override (_wrap_gtk_tree_model_get_iter_root): check the
- return value of gtk_tree_model_get_iter_root and return None if it
- failed. Rename to _wrap_gtk_tree_model_get_iter_first.
-
- * codegen/codegen.py (write_class, write_interface, write_boxed
- write_pointer): use overrides.is_already_included to prevent from
- having the same override code included twice in one file. This
- allows two methods to point to the same function.
-
- * codegen/override.py (Overrides.is_already_included): added a
- function that returns true if the override code has been emitted
- already.
-
-2002-03-11 Matt Wilson <msw@redhat.com>
-
- * gobjectmodule.c: remove pygobject_exception_notifiers and
- pyg_fatal_exceptions_notify.
-
-2002-03-18 James Henstridge <james@daa.com.au>
-
- * pango.defs: remove indic functions -- they are part of the
- semi-public engine API.
- Remove pango-module functions -- backend API.
-
- * pango.override (_wrap_pango_layout_move_cursor_visually): implement.
- (_wrap_pango_layout_xy_to_index): implement.
- (_wrap_pango_layout_get_extents): implement.
- (_wrap_pango_layout_get_pixel_extents): implement.
- (_wrap_pango_layout_get_size): implement.
- (_wrap_pango_layout_get_pixel_size): implement.
- (_wrap_pango_glyph_string_extents): implement.
- (_wrap_pango_glyph_string_extents_range): implement.
-
-2002-03-17 James Henstridge <james@daa.com.au>
-
- * pango.override (_wrap_pango_context_list_families): implement.
- (_wrap_pango_font_get_glyph_extents): implement.
- (_wrap_pango_font_family_list_faces): implement.
- (_wrap_pango_font_map_list_families): implement.
- (_wrap_pango_tab_array_get_tab): implement.
- (_wrap_pango_tab_array_get_tabs): implement.
- (_wrap_pango_layout_set_markup): implement.
- (_wrap_pango_layout_set_markup_with_accel): implement.
- (_wrap_pango_layout_index_to_pos): implement.
- (_wrap_pango_layout_get_cursor_pos): implement.
-
- * gtk/gtk.override (ignore): ignore the GtkMenu append, insert and
- prepend methods (they are deprecated and shadow the methods you
- should use ...).
- (_wrap_gtk_image_menu_item_new): add wrapper for GtkImageMenuItem
- constructor (from bug 71893).
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_get_pixels): implement
- get_pixels to return the pixels as a string.
-
- * codegen/argtypes.py (GdkRectangleArg.write_return): fix up
- problem with return type found by Peter Kese.
-
-2002-03-16 James Henstridge <james@daa.com.au>
-
- * pygtype.c (add_property_docs): fix up property listing.
-
- * gtk/libglade.override: add modulename directive.
-
- * gtk/gdk.override: add modulename directive.
-
- * gtk/gtk.override: add modulename directive.
-
- * atk.override: add modulename directive.
-
- * pango.override: add modulename directive.
-
- * codegen/codegen.py (write_class): if override.modulename is set,
- put it into the classname.
- (write_interface): same here.
- (write_boxed): same here.
- (write_pointer): same here.
-
- * codegen/override.py (Overrides.__parse_override): add support
- for a "modulename" directive for overrides files.
-
- * gtk/gtk-types.c (PyGtkStyleHelper_Type): add module name to type
- name, and remove the commented out obsolete GdkColormap
- implementation.
-
- * gtk/gtk.override (_wrap_gtk_widget_get_pointer): return a
- GdkRectangle instance.
-
- * gtk/gdk.override: implement setters for GdkRectangle attributes.
-
- * codegen/codegen.py (write_getsets): allow people to override the
- setter without having to override the getter too.
- (write_boxed_getsets): same here.
-
- * gtk/gdk.override: implement sequence behaviour for GdkRectangle
- wrapper.
-
- * gtk/gdk-types.defs (Rectangle): add a GdkRectangle boxed type
- definition.
-
- * pango.override (_wrap_pango_font_description_tp_compare):
- override the compare slot to use pango_font_description_equal.
- (_wrap_pango_font_description_tp_hash): and the hash function.
-
- * atk.override (_wrap_atk_relation_new): remove unused variable.
-
- * gtk/gtk-types.defs (Window): transient_parent field is a
- GtkWindow, rather than a GtkWidget.
-
- * gtk/gtk.override (_wrap_gtk_ctree_node_tp_getattr): same here.
-
- * gtk/gdk.override (_wrap_gdk_event_tp_getattr): change to
- "override-slot".
-
- * codegen/codegen.py (slots_list): a list of slots that we allow
- overriding of.
- (typetmpl): add extra substs for some slots.
- (write_class): add code that sets up the slot substitutions.
- (interfacetypetmpl): add slot substitutions.
- (boxedtmpl): add slot substitutions.
- (write_interface): add code to set slots.
- (write_interface): add code to set slots, and get rid of the old
- getattr handling.
-
- * codegen/override.py (Overrides.__parse_override): add support
- for an "override-slot" section to overrides file for overriding a
- slot in the PyTypeObject vtable.
-
- * gtk/gtk.override (_wrap_gtk_selection_data_get_text): add an
- override for this -- it was the only one correctly making use of
-
- * codegen/argtypes.py (UCharArg.write_param): unimplement.
- (guchar *) does not mean unicode, and often uchar returns are just
- date (eg. pixbuf data). gtk_selection_data_get_text is the
- exception.
-
-2002-03-15 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.override (_wrap_gdk_colormap_alloc_color): new function
- to allocate colours.
- (_wrap_gdk_color_alloc): new wrapper that shows a deprecation
- warning, and calls alloc_color.
-
-2002-03-10 James Henstridge <james@daa.com.au>
-
- * gtk/pygtktreemodel.c: apply Arjan Molenaar's patch to allow
- selectively making the model leak free (although prone to crashing
- if you aren't careful).
-
- * gtk/pygtktreemodel.h: add a leak_references member.
-
-2002-03-10 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/gtk-types.defs (Window): Add 33 new fields
-
-2002-03-10 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-types.c: remove commented out GtkStyle code, as the
- GObject based code now provides all the missing features.
-
- * gtk/gtk.override: implement getters (and some setters) for
- GtkStyle properties.
-
- * gtk/gtk-types.c (_pygtk_style_helper_new): upgrade the style
- helper code to work with gtk 2.0.
-
- * gtk/gtk-types.defs (Style): add public fields of the GtkStyle
- object.
-
- * codegen/codegen.py (write_getsets): allow adding setters for
- overriden properties (just do a string search for the setter
- function prototype).
- (write_boxed_getsets): same here.
-
-2002-02-19 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-types.defs (MessageDialog): add some fields for the
- label and icon. These are marked private, but they are very
- useful if you want to change the message in a dialog.
-
- * ChangeLog: spell Michele's name correctly (sorry!).
-
-2002-03-06 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/gtkmodule.c (init_gtk): If sys.argv is NULL, don't call
- PyList_Size and don't call PySys_SetArgv if argc and argv is NULL.
- Bug fix so non gtk stock icons is correctly skipped.
-
-2002-02-28 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/gdk.defs: Add functions from gdk-pixbuf-loader.h
-
- * gtk/gdk-types.defs: Add GdkPixbufLoader object
-
-2002-02-27 Matt Wilson <msw@redhat.com>
-
- * configure.in: increase micro version of package (1.99.8)
-
-2002-02-25 Johan Dahlin <jdahlin@telia.com>
-
- * examples/pygtk-demo/pygtk-demo.py: Use set_size_request instead of
- set_usize
-
- * gtk/gtk.override (_wrap_gtk_widget_translate_coordinates): Impl
- (_wrap_gtk_editable_get_selection_bounds): Impl
- (_wrap_gtk_entry_get_layout_offsets): Impl
-
- * gtk/gtk.defs: Add GtkTreeView.columns_autosize
- Remove GtkTreeViewColumn.cell_renderer/cell_focus/
- cell_draw_focus/cell_is_visible_cell_set_dirty
-
- * gtk/gtk-types.defs: Add a few fields
-
- * examples/pygtk-demo/demos/appwindow.py: clean up a bit and add
- broken stock icon registration
-
-2002-02-21 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/gtk.defs: Removed
- gtk_tree_view_column_cell_render,
- gtk_tree_view_column_cell_focus,
- gtk_tree_view_column_cell_draw_focus and
- gtk_tree_view_column_cell_set_dirty since they're now private
- in gtk+.
-
-2002-02-18 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs (create_item): remove defs for removed
- GtkItemFactory functions. Fixes bug #69815.
-
-2002-02-12 Johan Dahlin <jdahlin@telia.com>
-
- * gobjectmodule.c (initgobject): Fix a leak
-
- * gtk/gtkmodule.c (init_gtk): Fix another one
-
-2002-02-06 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_icon_set_get_sizes): added an
- override that will allow making an empty iconset, thus allowing
- you to add modified sources to it.
-
-2002-02-05 Johan Dahlin <jdahlin@telia.com>
-
- * examples/pygtk-demo/demos/list_store.py: add toggle for the check
- box column.
-
-2002-02-05 James Henstridge <james@daa.com.au>
-
- * codegen/codegen.py (register_types): register pointer types as
- well.
-
- * codegen/argtypes.py (PointerArg): handling for pointer arg
- types.
- (ArgMatcher.register_pointer): add function to register pointer
- types.
-
- * gtk/gtk.override (_wrap_gtk_ctree__get_selection): GtkCTreeNode
- is not a boxed type.
- (_wrap_gtk_ctree_base_nodes): same.
- (_wrap_gtk_ctree_insert_node): same.
- (_wrap_gtk_ctree_find_by_row_data): same.
- (_wrap_gtk_ctree_find_all_by_row_data): same.
- (_wrap_gtk_ctree_node_get_text): same.
- (_wrap_gtk_ctree_node_get_pixmap): same.
- (_wrap_gtk_ctree_node_get_pixtext): same.
- (_wrap_gtk_ctree_get_node_info): same.
- (_wrap_gtk_ctree_node_set_row_data): same.
- (_wrap_gtk_ctree_node_get_row_data): same here.
- (_wrap_gtk_ctree_getattr): same here.
-
- * codegen/codegen.py (write_source): register pointer types as
- pointers.
-
- * pango.override (_wrap_pango_font_description_new): ignore some
- private (well, pango module API) functions.
-
- * gtk/gtk-types.defs (CTreeNode): make this a pointer type.
-
- * codegen/codegen.py (write_pointer_method): new method to write
- methods for GPointer types.
- (write_pointer_constructor): new function for writing constructor
- for GPointer types.
- (write_pointer_getsets): new function for writing getters for
- pointer objects (this should be merged with the GObject and GBoxed
- versions ...).
- (write_pointer): add new function, which calls all the GPointer
- related functions.
- (write_source): write pointer types.
-
- * gobjectmodule.c (initgobject): actually ready the GPointer type.
-
- * gtk/gtk-types.defs (CTreeNode): get rid of fields here. They
- will be covered by the custom getattr() function, so no need to
- duplicate.
-
- * codegen/codegen.py (write_boxed_getsets): convert to use getsets
- for boxed objects.
- (write_boxed): use write_boxed_getsets() to write the getsets,
- while allowing boxed objects to specify a getattr() function.
-
-2002-02-04 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (initgobject): add GPointer to the module dict.
- (pygobject_api_functions): and to the API vtable.
-
- * pygobject.h (pyg_constant_strip_prefix): and add it to the
- public header.
-
- * pygobject-private.h (pyg_pointer_new): add stuff to private
- header ...
-
- * pygboxed.c (PyGPointer): add code to handle base GPointer type.
-
- * codegen/defsparser.py (DefsParser.__init__): add self.pointers
- attribute.
- (DefsParser.define_pointer): handle (define-pointer ...).
- (DefsParser.write_defs): handle pointer types.
-
- * codegen/definitions.py (PointerDef): new definition type for
- G_TYPE_POINTER subclasses.
-
-2002-02-04 Richard Hestilow <hestilow@ximian.com>
-
- * gtk/gtk.override (gtk_cell_renderer_get_size, get_fixed_size):
- Don't call pygobject_get, just pass in v->obj.
-
-2002-01-31 James Henstridge <james@daa.com.au>
-
- * configure.in: increment version number of package and
- requirements. Change -ansi to -std=c9x to work arround potential
- problems with gcc 2.95.x.
-
- * gtk/libglade.override (connect_one): fix up signature on
- function.
- (connect_many): same here.
-
-2002-01-28 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_type_register): same code here, if __doc__
- hasn't already been set.
- (initgobject): don't bother setting __doc__ on GObject here, as
- pygobject_register_class() does this for us.
-
- * pygobject.c (pygobject_register_class): need to set the __doc__
- descriptor on every class, otherwise it gets lost.
-
-2002-01-24 James Henstridge <james@daa.com.au>
-
- * examples/pygtk-demo/demos/colorsel.py:
- * examples/pygtk-demo/demos/dialogs.py:
- * examples/pygtk-demo/demos/panes.py:
- * examples/pygtk-demo/demos/sizegroup.py: add examples translated
- by Michele Campeotto.
-
- * gtk/gtk.override (_wrap_gtk_stock_add): add gtk.stock_add()
- function from Skip (bug 68363).
- (_wrap_gtk_layout_get_size): add gtk.Layout.get_size() routine --
- from Skip (bug 68930)
- (_wrap_gtk_frame_get_label): added function from Skip (bug 69024)
- (_wrap_gtk_misc_get_alignment): same here.
- (_wrap_gtk_ruler_get_range): same here.
-
- * examples/simple/simple.py: updated to use gobject.new().
-
- * examples/simple/hello.py: updated version from Steve
- George. (bug 67602)
-
- * pygtype.c (add_signal_docs): use g_string_append_printf().
- (add_property_docs): same here.
-
- * examples/simple/tooltip.py: updated version from Steve
- George. (bug 67581).
-
-2002-01-23 James Henstridge <james@daa.com.au>
-
- * pygtype.c (object_doc_descr_get): fill in __doc__ descriptor
- (add_property_docs): fix small bug.
- (add_signal_docs): only get the class for a type if it is a
- classed type.
-
- * gobjectmodule.c (initgobject): add __doc__ descriptor to GObject
- and GInterface. Add __gdoc__ as a synonym because type.__doc__
- masks our descriptor sometimes :(
-
- * pygtype.c (object_doc_descr_get): skeleton of the __doc__
- descriptor.
- (PyGObjectDoc_Type): type definition.
- (pyg_object_descr_doc_get): function to create and return the
- __doc__ descriptor (we only need one for all classes).
-
-2002-01-22 James Henstridge <james@daa.com.au>
-
- * pygobject.c: move GObject wrapper stuff here.
-
-2002-01-22 Johan Dahlin <jdahlin@telia.com>
-
- * codegen/codegen.py: Fix comments so jed can highlight correctly.
-
- * codegen/argtypes.py: Add GdkRectangleArg and GdkRectanglePtrArg
-
- * gtk/gtkgl.override: call pyg_block_threads instead of old
- pygtk_block_threads.
-
- * gtk/gtk.override: Don't ignore gtk_paint*
-
- * gtk/gtk.defs: Remove Container.border_width
- (GtkIconSet.icon_set_new_from_pixbuf): Make constructor of
- GtkIconSet instead of gtk_icon_Set_new
- (GtkStyle.draw_oval) (GtkStyle.draw_cross) (GtkStyle.draw_ramp) Remove.
- (GtkStyle.draw_type): Add state_type parameter
-
- * gtk/gtk-types.defs (Widget): Add allocation field
- (Container): add fields.
-
- * gtk/gdk-types.defs: Remove GdkRectangle
-
-2002-01-22 James Henstridge <james@daa.com.au>
-
- * pygtype.c: move closure stuff here.
-
- * gobjectmodule.c (initgobject): don't create boxed_marshal hash
- table, and remove the type functions moved to pygtype.c.
-
- * pygtype.c: move GType stuff here from gobjectmodule.c.
- (pyg_register_boxed_custom): store the custom boxed marshal
- functions as GType data, rather than in a separate hash table.
-
-2002-01-21 James Henstridge <james@daa.com.au>
-
- * Makefile.am (gobjectmodule_la_SOURCES): list extra source files.
-
- * pygobject-private.h (pyg_boxed_new): new header for functions
- shared between files in gobjectmodule.
-
- * pygboxed.c (pyg_register_boxed): move GBoxed handling code here.
-
-2002-01-21 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_radio_button_get_group): implemented
- GtkRadioButton.get_group
-
-2002-01-16 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_toolbar_append_element): remove '!'
- signs that shouldn't have been there.
- (_wrap_gtk_toolbar_prepend_element): same here.
- (_wrap_gtk_toolbar_insert_element): and again.
-
-2002-01-14 James Henstridge <james@daa.com.au>
-
- * codegen/codegen.py (main): add a --load-types argument that runs
- a python script before commencing code generation. The idea is to
- allow loading of extra argument type handlers.
-
- * gtk/libglade.override (connect_one): s/ignore_glob/ignore-glob/
-
-2002-1-13 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/Makefile.am: Register gtk-types here, so XML.get_widget works.
-
-2002-01-12 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_type_from_object): convert None, int, long,
- float, str and object to GTypes.
-
- * gtk/gtkmodule.c (init_gtk): only raise a runtime error if we
- can't initialise gtk.
-
-2002-01-11 Matt Wilson <msw@redhat.com>
-
- * Makefile.am (EXTRA_DIST): added appwindow.py
-
- * examples/pygtk-demo/demos/appwindow.py: added demo
-
- * gtk/gtk.override (_wrap_gtk_toolbar_insert_stock): removed
- debugging code I didn't mean to check in.
-
- * gobjectmodule.c (pyg_closure_new): use PyTuple_SetItem to build
- the tuple if extra_args isn't one. It's faster than using
- abstractions and clarifies ownership rules, so we always incref
- extra_args even if we're about to wrap it in a tuple. Fixes
- crashes when passing callback functions into
- GtkToolbar.{append_item,prepend_item,insert_item,insert_stock,
- append_element}
-
-2002-01-11 Matt Wilson <msw@redhat.com>
-
- * codegen/argtypes.py (GtkTreePathArg.normal): added missing newline
-
- * gtk/gtk.defs (item_factory_path_from_widget): the return here
- should be gconst-gchar*. The header in gtk is wrong, filed
- #68527 against gtk.
-
- * gtk/gtk.override (pygtk_item_factory_cb): if the user passed
- data to GtkItemFactory.create_items, call the callable with the
- function data as the first parameter.
- (_wrap_gtk_item_factory_create_items): take an optional
- callback_data argument. Use PyGtkCustomNotify and
- g_object_weak_ref to free up the reference to the callable and
- data after the item factory is freed.
-
-2002-01-11 James Henstridge <james@daa.com.au>
-
- * codegen/h2def.py (find_obj_defs): handle typedef struct { ... }
- style type defs, as used in bonobo.
-
-2002-01-09 Matt Wilson <msw@redhat.com>
-
- * codegen/argtypes.py (GtkTreePathArg.freepath): added missing
- newline.
-
- * gtk/gtk.override (pygtk_tree_foreach_marshal,
- pygtk_tree_selection_marshal): handle exceptions raised in
- callback func.
-
-2002-01-08 James Henstridge <james@daa.com.au>
-
- * gtk/__init__.py (threads_*): provide these functions in the gtk
- namespace as well as gtk.gdk.
-
-2002-01-07 James Henstridge <james@daa.com.au>
-
- * examples/pygtk-demo/demos/itemfactory.py (main): the F10 key is
- used to start navigating the menu -- not alt.
-
- * gtk/gtk-types.c (PyGtkStyleHelper_Dealloc): use PyObject_DEL.
- (PyGtkStyle_Dealloc): same here.
- (PyGdkWindow_Dealloc): same here.
- (PyGdkGC_Dealloc): same here.
- (PyGdkColormap_Dealloc): same here.
- (pygdk_atom_dealloc): same here.
-
- * gobjectmodule.c (pyg_type_wrapper_dealloc): use PyObject_DEL to
- prevent segfaults with pymalloc.
- (pyg_param_spec_dealloc): same here.
-
- * gtk/gtkmodule.c (init_gtk): get rid of g_thread_init() call --
- this occurs in gobjectmodule now.
-
- * gtk/gdk.override (pygdk_unblock_threads): give the function the
- right name (duh).
-
- * configure.in (AM_PATH_GLIB_2_0): add $extra_mods
-
- * gobjectmodule.c (initgobject): initialise GThread if threading
- is enabled at compile time (this doesn't initialise GDK threading
- though -- you need to run gtk.gdk.threads_init for that).
-
- * gtk/gdk.override (_wrap_gdk_threads_enter): add overriden
- implementation that allows threads while waiting, so some other
- thread has a chance to give up the gdk lock.
-
- * gtk/gtkmodule.c (functions): remove stuff.
-
- * gtk/pygtk-private.h: remove definitions here as well.
-
- * gtk/pygtk.h (_PyGtk_FunctionStruct): remove destroy notify and
- thread block stuff.
-
- * gtk/gtkobject-support.c: remove pygtk_destroy_notify.
-
- * gtk/gtk.override (pygtk_tree_foreach_marshal): move this
- function here from gtkobject-support.c, and don't bother blocking
- threads.
- (_wrap_gtk_tree_selection_selected_foreach): same here -- don't
- need to unblock threads.
- (pygtk_tree_selection_marshal): move this function here from
- gtkobject-support.c. Convert to use pyg_block_threads.
- (_wrap_gtk_dialog_run): add overriden implementation that unblocks
- threads.
- (_wrap_gtk_main): use pyg_block_threads
- (_wrap_gtk_main_iteration): same.
- (_wrap_gtk_item_factory_create_items): same here.
- (_wrap_gtk_menu_popup): same here.
- (_wrap_gtk_clist_set_row_data): use pyg_destroy_notify
- (_wrap_gtk_timeout_add): same here.
- (_wrap_gtk_idle_add): same here.
- (_wrap_gtk_quit_add): same here.
- (_wrap_gtk_input_add_full): same here.
- (_wrap_gtk_ctree_node_set_row_data): same here.
-
- * gtk/gtkobject-support.c: remove PyGTK_BLOCK_THREADS and
- PyGTK_UNBLOCK_THREADS macros.
- (pygtk_destroy_notify): use pyg_block_threads.
- (pygtk_custom_destroy_notify): same.
- (pygtk_handler_marshal): same.
- (pygtk_input_marshal): same.
-
- * gtk/gdk.override (_wrap_gdk_threads_init): register gdk lock
- based recursive threads block/unblock functions. If threading was
- disabled at compile time, then this function will error out.
-
- * gtk/gdk.defs (threads_enter, threads_leave, threads_leave): add
- functions.
-
- * gobjectmodule.c (functions): add destroy_notify here as well.
-
- * pygobject.h: add destroy_notify to the PyGObject_Functions
- vtable.
-
- * gobjectmodule.c (pyg_set_thread_block_funcs): handler for
- registering thread block/unblock funcs.
- (pygobject_destroy_notify): block threads during DECREF call.
- (pyg_closure_destroy): block threads during closure DECREF.
- (pyg_closure_marshal): block threads when calling function.
- (pyg_signal_class_closure_marshal): block threads.
- (functions): add extra functions to vtable.
-
- * pygobject.h (struct _PyGObject_Functions): add thread
- block/unblock slots to the API table.
-
-2002-01-03 Matt Wilson <msw@redhat.com>
-
- * Makefile.am (EXTRA_DIST): add missing demo files
-
- * examples/pygtk-demo/demos/itemfactory.py: added demo
-
- * gtk/gtk.override (_wrap_gtk_item_factory_create_items): accept a
- sequence for the entries, not just a list.
-
-2002-01-03 Matt Wilson <msw@redhat.com>
-
- * examples/pygtk-demo/demos/list_store.py (create_model): remove
- -1 from store.set call.
-
- * gtk/gtk.defs (GtkMenuBar.append, GtkMenuBar.prepend,
- GtkMenuBar.insert): uncomment, just ignore these in gtk.override
-
- * gtk/gtk.override (ignore): ignore gtk_menu_bar_append,
- gtk_menu_bar_insert, and gtk_menu_bar_prepend.
-
- * gtk/gtkmodule.c (init_gtk): remove unused v variable.
-
- * gtk/gtk-types.defs (DialogFlags): s/define-enum/define-flags/
-
-2001-12-24 James Henstridge <james@daa.com.au>
-
- * Makefile.am (EXTRA_DIST): same here.
-
- * gtk/Makefile.am (EXTRA_DIST): include the defs files in the
- dist, or things don't work.
-
-2001-12-24 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/gtk.override: Remove window arg.
- (_wrap_gtk_item_factory_create_items): Change PyArg_ParseTuple
- format args a bit and reset cb and ent for every item.
-
-2001-12-24 James Henstridge <james@daa.com.au>
-
- * configure.in: define pygtk version and required package versions
- as m4 macros at the top of the file rather than shell variables.
- These can be put before the AC_INIT macro without problems.
- (AM_PATH_PYTHON): require python 2.2 final.
-
-2001-12-21 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.defs (gdk_colormap_change): comment out, as we have two
- GdkColormap.change's.
-
- * gtk/gtk.defs (append): this is a method of menu
- (prepend): same here.
- (insert): same here.
- (): now comment out the above three, as they shadow the methods
- their deprecation messages recommend using. (problem picked out
- by running xmllint over output docs).
-
- * codegen/docgen.py (DocbookDocWriter.__init__): add constructor
- with a use_xml parameter, which turns on DocBook/XML output.
- (DocbookDocWriter.create_filename): use ".xml" as extension if we
- are writing DocBook/XML.
- (DocbookDocWriter.output_toc): optionally write out the
- DocBook/XML doctype.
-
- * codegen/docgen.py (DocWriter.output_interface_docs): new
- function for outputting documentation about interfaces.
- (DocWriter.output_docs): output interface definitions.
- (DocbookDocWriter.write_heirachy): convert the list of interfaces
- the class implements into a list.
-
-2001-12-20 James Henstridge <james@daa.com.au>
-
- * build-docs.py: script to generate documentation.
-
- * codegen/docgen.py (DocWriter.add_sourcedirs): new function for
- scanning source dirs, pulled out of the constructor.
- (DocWriter.output_docs): sort object defs by python name rather
- than c anme.
-
- * codegen/docgen.py (DocWriter.__init__): don't actually load the
- defs and overrides file in the constructor.
- (DocWriter.add_docs): new method for parsing a (defs, overrides,
- modulename) triple, -- the aim being to include docs for multiple
- modules in one sgml document. Also, build up a map from C type
- names to python names.
- (DocbookDocWriter.__format_function): translate to python class
- names.
- (DocbookDocWriter.__format_symbol): same here.
- (DocbookDocWriter.create_constructor_prototype): and here.
- (DocbookDocWriter.write_heirachy): and here.
- (DocbookDocWriter.write_method): and here.
-
- * codegen/scmexpr.py (Parser.startParsing): allow passing a
- filename as the argument here.
-
- * codegen/override.py (Overrides.handle_file): don't make this
- method private.
-
- * codegen/docextract.py (extract): add second argument doc_dict,
- so that the function can be used to update an existing dictionary.
-
- * configure.in (minver): require 2.2c1
-
- * gobjectmodule.c (pygobject_chain_from_overridden): fix for
- updated API.
- (pygobject_methods): just call the method "chain".
-
-2001-12-19 James Henstridge <james@daa.com.au>
-
- * codegen/docgen.py (DocWriter.output_object_docs): fix for
- changes to the way parent types are listed in the defs format.
- (DocWriter.create_method_prototype): of_object is only a string
- now -- not a 2-tuple.
- (DocbookDocWriter.make_method_ref): same here.
- (DocbookDocWriter.__format_function): and here ...
- (DocbookDocWriter.__format_symbol): and here :)
- (DocbookDocWriter.write_method): again here.
-
-2001-12-18 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_value_from_pyobject): add support for
- int64/uint64. Fix up code for unsigned int/long to parse long
- ints if necessary.
- (pyg_value_as_pyobject): add support for int64/uint64, and get
- UINT/ULONG to return python long ints if necessary, rather than
- wrapping around.
-
- * Makefile.am (EXTRA_DIST): add new example to dist.
-
- * examples/gobject/properties.py: test program that implements a
- few properties.
-
- * gobjectmodule.c (add_properties): new function for parsing the
- __gproperties__ class attribute.
- (create_property): helper routine for creating and installing the
- new pspecs.
- (pyg_type_register): add code to call add_properties if a
- __gproperties__ attribute is found.
- (pyg_object_class_init): set set_property/get_property methods in
- vtable, and get rid of debug message.
- (initgobject): add G_PARAM_* constants.
-
-2001-12-17 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pygobject_chain_from_overridden): add chaining
- function. This will need to change when Tim makes the changes to
- the chaining API. This was just to test that things worked
- correctly (and they do). Possibly this should be renamed to just
- GObject.chain() or GObject._chain().
-
-2001-12-15 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (add_signals): put the class ref/unref in here,
- so it is only done once. The ref/unref is really needed for
- adding signals as well, so that we don't end up with dups.
-
-2001-12-14 Johan Dahlin <jdahlin@telia.com>
-
- * gobjectmodule.c (initgobject): Add gobject.glib_version.
-
- * configure.in (PYGTK_MINOR_VERSION): Add and define
- PYGTK_[MAJOR,MINOR,MACRO]_VERSION. Also add *_REQUIRED_VERSION
- for dependencies.
-
- * gtk/gtkmodule.c (init_gtk): remove gtk_major_version,
- gtk_minor_version and gtk_macro_version and replace them with
- gtk_version,
- Add pygtk_version.
-
-2001-12-14 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (override_signal): another helper function for
- overriding existing signals. Haven't done chaining support yet.
- (add_signals): if value in __gsignals__ dict is None or
- 'override', then call override_signal instead.
- (override_signal): add g_type_class_ref() calls so that parent
- signals are registered.
-
- * examples/gobject/signal.py: use __gsignals__ notation here.
-
- * gobjectmodule.c (create_signal, add_signals): helper routines
- for handling __gsignals__ attribute of classes.
- (pyg_type_register): add support for creating signals as part of
- type registration.
-
-2001-12-14 Johan Dahlin <jdahlin@telia.com>
-
- * gtk/gtk.override (_wrap_gtk_window_get_position):
- (_wrap_gtk_window_get_size):
- (_wrap_gtk_window_get_default_size): Impl.
-
- * gtk/gtk-types.defs (FileSelection): Added fields.
-
- * gtk/gtk.defs (gtk_pixmap_new): Fix deprecation warning. GtkPixbuf->GdkPixbuf
- * gtk/gtk.defs (set_usize): dito, set_default_size -> set_size_request
-
-2001-12-12 Matt Wilson <msw@redhat.com>
-
- * gobjectmodule.c (pyg_closure_marshal,
- pyg_signal_class_closure_marshal): always print and clear the
- exceptions in callback marshalers. People who want to catch these
- exceptions and make them fatal should use sys.excepthook.
- (pyg_fatal_exceptions_notify, pyg_fatal_exceptions_notify_add,
- pyg_fatal_exceptions_remove): remove now unused functions. Also
- remove them from the PyGObject_API.
-
- * gtk/pygtk.h (PyGtk_FatalExceptions): remove.
-
- * gtk/pygtk-private.h (PyGtk_FatalExceptions): remove.
-
- * gtk/gtkmodule.c (init_gtk): don't bother with
- PYGTK_FATAL_EXCEPTIONS.
- (pygtk_main_quit): remove unused code.
-
- * gtk/gtk.override (_wrap_gtk_item_factory_create_items,
- _wrap_gtk_menu_popup): likewise, always print and clear the
- exception.
-
-2001-12-11 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs: added deprecation messages
-
- * codegen/definitions.py (FunctionDef.write_defs,
- MethodDef.write_defs): write out deprecation messages if they
- exist
- (MethodDef.__init__, FunctionDef.__init__): parse deprecated tags
- in defs file, added some sanity checking and error reporting
-
- * codegen/codegen.py (write_method, write_constructor,
- write_function): write out deprecation warning messages.
-
-2001-12-11 James Henstridge <james@daa.com.au>
-
- * atk.defs: remove atk_attribute_get_name/value (again).
-
-2001-12-10 Matt Wilson <msw@redhat.com>
-
- * gtk/libglade.defs: added missing defs.
-
- * atk.defs: add missing defs.
-
-2001-12-09 James Henstridge <james@daa.com.au>
-
- * atk.defs (text_attribute_get_name): rename.
- (text_attribute_get_value): rename.
-
- * gtk/gtk.override (_wrap_gtk_input_add_full): use
- PyObject_AsFileDescriptor to convert the first arg to the fd.
-
-2001-12-07 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (GtkTable.get_row_spacing): one more missing defs
- entry.
-
-2001-12-07 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (ignore-glob): ignore all functions that start
- with _
-
- * codegen/definitions.py (FunctionDef.merge): if a cname changed
- from a method to a function, the merge would fail here. Handle
- the exception.
-
- * codegen/argtypes.py, codegen/codegen.py: don't use + for
- strings, use literal concatenation or """.
-
- * codegen/defsparser.py (DefsParser.printMissing): new function to
- support missingdefs.py
-
- * codegen/missingdefs.py: new program to help find things missing
- in .defs files
-
- * gtk/gtk.defs, gtk/gtk-types.defs: merged in missing entries in
- the defs file.
-
-2001-12-06 Matt Wilson <msw@redhat.com>
-
- * codegen/argtypes.py (BoxedArg, CustomBoxedArg): for null-ok
- functions, added "or None" to the error string.
-
- * gtk/gtk.defs (GtkTreeModel.iter_n_children,
- GtkTreeModel.iter_nth_child): add null-ok to the special cased
- iter parameters that mean 'root'. Reported by Robert Nikander.
-
-2001-12-05 Matt Wilson <msw@redhat.com>
-
- * codegen/codegen.py (write_function, write_method,
- write_boxed_method): output the args and kwargs to the wrapper
- function only if it takes arguments
-
-2001-12-05 Matt Wilson <msw@redhat.com>
-
- * codegen/argtypes.py (WrapperInfo): split get_varlist into
- get_varlist and get_kwlist to avoid unused kwlists when generating
- noarg functions.
-
- * codegen/codegen.py (write_boxed, write_functions, write_class,
- write_interface): check to see if override function wants no args,
- use METH_NOARGS if so. Also get the method flags from the various
- function writers so they can ask to have noargs placed in their
- flags
- (write_function, write_method, write_boxed_method): write out the
- parse args and keywords only if there are parameters to parse.
- Return METH_NOARGS if we don't accept arguments,
- METH_VARARGS|METH_KEYWORDS otherwise.
-
- * codegen/override.py (Overrides.is_overriden): keep a dictionary
- of overrides that have the 'noargs' key in them.
-
- * gtk/gtkgl.override, gtk/gtk.override, gtk/gdk.override): removed
- argument parsing from functions/methods that take no arguments,
- mark them as noarg
-
- * examples/pygtk-demo/demos/list_store.py (create_model): use new
- GtkListStore.set method.
-
-2001-12-04 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_list_store_set,
- _wrap_gtk_tree_store_set): added.
-
-2001-12-03 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_rc_set_default_files,
- _wrap_gtk_rc_get_default_files, _wrap_gtk_icon_set_get_sizes,
- _wrap_gtk_cell_renderer_get_size,
- _wrap_gtk_cell_renderer_get_fixed_size): added
-
- * codegen/argtypes.py (UCharArg.write_return): implemented.
-
- * codegen/codegen.py (exc_info): wrote a common function that
- returns a descriptive string when wrapper generation goes wrong.
- Modified codegen functions to call it on exception.
-
- * gtk/gtk.defs (rc_set_image_loader, ctree_node_from_cobject):
- removed
-
-2001-12-02 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_text_buffer_create_tag): fix up
- format string, from bug #65636 (Skip again).
-
- * gobjectmodule.c (pyg_type_wrapper_repr): fix up format string,
- from bug #65640 (from Skip).
-
- * codegen/argtypes.py (GTypeArg.write_return): use pyg_error_check
- to raise the exception. Now the domain and code elements of the
- GError are available.
- (GtkTreePathArg.write_param): add to codeafter in order to free
- the tree path we created, fixing a leak.
-
- * gobjectmodule.c (initgobject): create a gobject.GError
- exception.
- (pyg_error_check): function for converting a GError into a
- gobject.GError python exception.
-
-2001-12-01 James Henstridge <james@daa.com.au>
-
- * codegen/argtypes.py: change write_return methods to simply add a
- "ret" variable to the varlist of the appropriate return type, and
- add code for returning the correct value to codeafter code list.
- (GErrorArg.write_param): add error handling code to the codeafter
- code list.
-
- * codegen/codegen.py: s/extracode/codebefore/
- (*): get rid of the %(handlereturn)s stuff, and replace with "ret
- = functioncall" statements, followed by %(codeafter)s.
-
- * codegen/codegen.py: update to use WrapperInfo.
-
- * codegen/argtypes.py: lots of changes to add a WrapperInfo class,
- that replaces many of the arguments to the
- write_param/write_return methods of ArgTypes.
-
-2001-11-30 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pygobject_register_class): get rid of
- class_hash, and store the pointer to the python class with
- g_type_set_qdata().
- (pygobject_lookup_class): look up python class with
- g_type_get_qdata.
- (pyg_object_class_init): a class_init function for types defined
- in python. The python class is passed as the "class_data"
- argument. Currently empty, but will be used to install
- eg. get_property and set_property members.
- (pyg_type_register): store pointer to class like we do for types
- defined in C.
- (initgobject): move the quark initialisations above the
- registration of GObject.
-
-2001-11-29 Matt Wilson <msw@redhat.com>
-
- * gtk/libglade.defs (glade_xml_new): fname is actually required.
- Added default to NULL for all arguments that are null-ok.
-
- * gtk/libglademodule.c: added missing #include pygobject.h. Why
- does pygtk.h define NO_IMPORT_PYGOBJECT?
-
- * atk-types.defs: split atk types off into its own file
-
- * Makefile.am, gtk/Makefile.am: more Makefile cleanups
-
-2001-11-28 Matt Wilson <msw@redhat.com>
-
- * gtk/Makefile.am: removed disthook, marked autogenerated .c files
- as nodist sources.
-
- * Makefile.am: likewise. Use a suffix rule instead of a pattern
- rule for wider make compatibility.
-
- * gtk/gtk.override (_wrap_gtk_window_set_geometry_hints): added
- min_aspect and max_aspect to the kwlist so that the kwlist length
- matches the number of arguments in the argparse format string.
-
- * codegen/h2def.py (define_func): someone was thinking that a
- re.split looked like string.split. Also fix the argument munger
- that I broke the other day.
-
- * atk.override (_wrap_atk_relation_new): fixed the constructor so
- it actually works
-
- * gtk/Makefile.am ($(srcdir)/gtk.c): get the atk types
-
- * gtk/gtk.override: import atk.Object as PyAtkObject_Type
-
- * Makefile.am (EXTRA_DIST): added examples/atk/atk-demo.py
-
- * atk.defs (relation_new): mark as constructor of AtkRelation
- (atk_no_op_object_factory_new): mark as constructor of
- AtkNoOpObjectFactory
-
-2001-11-27 Matt Wilson <msw@redhat.com>
-
- * atk.defs, atk.override, atkmodule.c: added start of atk wrapper
-
- * gtk/Makefile.am (DISTCLEANFILES): remove generated files
- ($(srcdir)/gtk.c): modify targets to output generated files in the
- builddir, not the srcdir.
- ($(srcdir)/gdk.c): likewise.
- ($(srcdir)/libglade.c): likewise.
-
- * codegen/h2def.py (define_func): add check to workaround broken
- string.replace semantics on python 1.5
-
- * codegen/codegen.py (write_enums): if the enum or flag doesn't
- have a GType, just add those enum values listed in the defs file
- by hand.
-
- * codegen/argtypes.py (ArgMatcher.register_enum): if defs file
- doesn't specify a GType for the enum, use G_TYPE_NONE.
- (ArgMatcher.register_flag): likewise.
-
- * gobjectmodule.c (pyg_enum_get_value): allow enums to pass
- G_TYPE_NONE in as the type, disabling the string to value
- conversion.
- (pyg_flags_get_value): likewise.
- (pyg_constant_strip_prefix): new function to combine common
- codepath.
- (pyg_enum_add_constants): use pyg_constant_strip_prefix
- (pyg_flags_add_constants): likewise.
- (functions): make pyg_constant_strip_prefix available to users of
- pygobject
-
- * pygobject.h: added pyg_constant_strip_prefix wrapper
-
- * configure.in: added ATK test, subst for ATK_CFLAGS and ATK_LIBS.
-
- * Makefile.am (%.c): added generic codegen target for pango and
- atk. Added DISTCLEANFILES so that generated files will be
- removed. Added atk targets, cflags, ldflags.
-
-2001-11-26 Matt Wilson <msw@redhat.com>
-
- * configure.in: bump up required versions of gtk, pango, and glib.
-
-2001-11-26 Matt Wilson <msw@redhat.com>
-
- * configure.in: 1.99.5
-
-2001-11-20 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (GtkStyle.render_icon): change size argument type
- to GtkIconSize.
- (gtk_image_new_from_stock): likewise, change from constructor to
- function, rename to image_new_from_stock.
- (gtk_image_new_from_icon_set): likewise.
- (gtk_image_new_from_animation): change from constructor to
- function, rename to image_new_from_animation. Should these just
- go in as an overloaded constructor for GtkImage()?
- (icon_source_new): is-constructor-of GtkIconSource
- (icon_set_new): is-constructor-of GtkIconSet
-
-2001-11-19 Matt Wilson <msw@redhat.com>
-
- * codegen/codegen.py (attrchecktmpl): fix indention.
- (write_getsets): use the handler's error handling code snippits.
- (write_boxed_getattr): likewise.
-
- * gobjectmodule.c (pyg_fatal_exceptions_notify_{add,remove}):
- fixed think-o, don't store a pointer to the function pointer, just
- store the function pointer.
-
- * pango.defs (PangoContext.add_font_map): renamed to set_font_map
- (PangoFontMap.load_font): added context argument
-
-2001-11-17 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs: added GtkTreeView.get_columns,
- GtkTreeView.move_column_after, GtkTreeView.map_expanded_rows,
- GtkTreeView.row_expanded, GtkTreeView.get_cursor,
- GtkTreeView.get_bin_window, GtkTreeView.enable_model_drag_source,
- GtkTreeView.enable_model_drag_dest, GtkTreeView.set_enable_search,
- GtkTreeView.get_enable_search, GtkTreeView.get_search_column,
- GtkTreeView.set_search_column, GtkTreeView.get_search_equal_func,
- GtkTreeView.set_search_equal_func,
- GtkTreeView.set_destroy_count_func
-
-2001-11-17 Matt Wilson <msw@redhat.com>
-
- * codegen/codegen.py (write_*): pass in any error checking and
- handling code snippets into the return function writer. Only add
- keywords for arguments that are going to be parsed, Python 2.2 now
- checks to make sure the kwlist length equals the paramspec.
-
- * codegen/argtypes.py: remove GtkCTreeNode custom registration,
- it's a generic boxed type. Added a GErrorType requested in bug
- #63980. This requires inserting possible error checking in each
- type's write_return method.
-
- * gtk/gtk.defs (gtk_image_new_from_icon_set): changed size
- argument from char* to GtkIconSize
- (GtkIconSet.render_icon): likewise
-
- * gtk/gtk-types.defs (IconSet): added GtkIconSet boxed type
-
- * gtk/gtk.override (_wrap_gtk_tree_model_get_value): value is not
- parsed, remove it from the kwlist.
-
-2001-11-16 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_tree_view_get_path_at_pos): remove
- window argument
-
- * gtk/gtk.defs (GtkTreeView.get_path_at_pos): remove window argument
-
- * gobjectmodule.c (pyg_param_spec_getattr, pyg_param_spec_repr):
- s/g_param_get_{name,nick,blurb}/g_param_spec_get_{name,nick,blurb}/g
- (pyg_fatal_exceptions_notify_remove): use the right type.
-
- * gtk/pygtk.h (init_pygtk): need to cast to the right type for
- _PyGTK_API init.
-
-2001-11-15 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (GtkEditable.insert_text): note default for
- position to be 0.
-
- * gtk/gtkmodule.c (init_gtk): added gtk.major_version,
- gtk.minor_version, and gtk.micro_version. #59830.
-
-2001-11-15 Matt Wilson <msw@redhat.com>
-
- * gtk/pygtk.h (init_pygtk): cast void* to _PyGtk_FunctionStruct*
- when retrieving the API struct, #62872
-
- * pygobject.h: added PyGFatalExceptionFunc typedef, API wrapper
- for pyg_fatal_exceptions_{add,remove}.
-
- * gobjectmodule.c (pyg_boxed_new): return NULL on assertion
- failures, #62814
- (pyg_closure_new): actually assign swap_data to the closure.
- (pyg_fatal_exceptions_notify, pyg_fatal_exceptions_notify_add,
- pyg_fatal_exceptions_remove): added mechanism for gobjectmodule using
- modules to get a function called when a fatal exception happens in
- closures, etc.
- (pyg_closure_marshal, pyg_signal_class_closure_marshal): return
- NULL if a gobjectmodule using module registered a fatal exception
- function.
-
- * gtk/pygtk-private.h: added declarations for
- pygtk_custom_destroy_notify, pygtk_tree_selection_marshal,
- pygtk_tree_foreach_marshal. Added typedef for
- PyGtkCustomNotify. #62814
-
- * gtk/gtkmodule.c (init_gtk): register stock items, #62814. Set
- up fatal exception stuff if PYGTK_FATAL_EXCEPTIONS is set. This
- isn't 100% done yet, gtk mainloop specific functions still need
- work.
-
- * gtk/gtkobject-support.c (pygtk_tree_selection_marshal): added,
- #62814
- (pygtk_tree_foreach_marshal): added, #62814
- (pygtk_custom_destroy_notify): added, #62814
-
- * gtk/gtk.override (_wrap_gtk_tree_selection_set_select_function):
- added, #62814
- (_wrap_gtk_tree_selection_selected_foreach): added, #62814
- (_wrap_gtk_widget_path): added, #62393
- (_wrap_gtk_widget_class_path): added, #62393
-
- * gtk/gtk.defs (GtkWidget.set_size_request): added, #62474
- (GtkTreeSelection.get_mode): added, #62474
-
-2001-11-13 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs: removed GtkAccelGroup.accel_group_get_default,
- GtkAccelLabel.get_accel_object, GtkAccelLabel.set_accel_object,
- item_factory_parse_rc, item_factory_parse_rc_string,
- GtkWidget.remove_accelerators, GtkWidget.accelerator_signal,
- GtkWidget.lock_accelerators, GtkWidget.unlock_accelerators,
- GtkWidget.accelerators_locked to reflect Tim's accelerator API
- revamp checkin.
- (GtkTreeDragDest.row_drop_possible): modified arguments to match
- new API.
-
-2001-11-01 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (GtkSelectionData.tree_set_row_drag_data): renamed
- GtkSelectionData.data_set_tree_row, #60218
- (GtkSelectionData.tree_get_row_drag_data): renamed
- GtkSelectionData.data_get_tree_row, #60218
- (GtkFontSelection.get_preview_text): constify return arg
- (GtkFontSelectionDialog.get_preview_text): likewise.
- (GtkSelectionData.set_text): added len parameter
-
-2001-10-31 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (GtkTreeStore.clear): added
-
-2001-10-29 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs: remove gtk_cell_renderer_toggle_[gs]et_active.
-
-2001-10-26 Matt Wilson <msw@redhat.com>
-
- * configure.in (AC_INIT): increase version to 1.99.4
- (AM_PATH_GLIB_2_0): change minver to 1.3.10
- (PKG_CHECK_MODULES): change pango requirement to >= 0.21
- (AM_PATH_GTK_2_0): change minver to 1.3.10
-
-2001-10-25 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (PyGObject_Type): include the module name in the
- typename.
- (PyGInterface_Type): same here.
- (PyGBoxed_Type): same here.
- (pygobject_register_class): when working out what name to put into
- the module dictionary, strip off everything before the last dot,
- so the type name can include the module.
-
- * configure.in (minver): require python 2.2b1
-
- * gobjectmodule.c (initgobject): remove statements using
- tp_defined (they are no longer needed).
-
-2001-10-23 Matt Wilson <msw@redhat.com>
-
- * codegen/codegen.py (boxedgetattrtmpl, write_boxed_getattr): at
- the end of the getattr function, we must use Py_FindMethod. This
- fixes GtkSelectionData's methods, and DnD works again.
-
- * codegen/h2def.py (clean_func): deal with const return types when
- cleaning up function prototype
- (proto_pat): add '-' to the ret group so that const- will work in
- the return type
-
-2001-10-23 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_text_iter_forward_search): use new
- forward search API with flags enum in CVS.
- (_wrap_gtk_text_iter_backward_search): likewise.
- (_wrap_gtk_selection_data_set): use pygdk_atom_from_pyobject.
- (_wrap_gtk_selection_add_targets): likewise.
-
- * gtk/pygtk-private.h (pygdk_atom_from_pyobject): added
- declaration.
-
- * gtk/gtk.defs (GtkTextIter.forward_search): use new flags enum
- (GtkTextIter.backward_search): likewise.
-
- * gtk/gdk.override (_wrap_gdk_gc_new_with_values):
- s/GPOINTER_TO_INT/GDK_POINTER_TO_ATOM/
- (_wrap_gdk_property_get): use pygdk_atom_from_pyobject
- (_wrap_gdk_property_change): likewise.
-
- * codegen/argtypes.py (AtomArg.write_param): use
- pygdk_atom_from_pyobject when getting atom args
-
- * gtk/gtk-types.defs (TextSearchFlags): added new enum.
-
- * gtk/gtk-types.c (pygdk_atom_from_pyobject): implemented a
- function to get a GdkAtom from a Python object
- (PyGdkWindow_PropertyGet): use pygdk_atom_from_pyobject to get
- atoms from args, not this two-try ParseTuple.
- (PyGdkWindow_PropertyChange): likewise.
- (PyGdkWindow_PropertyDelete): likewise.
-
- * gtk/gdk-types.defs (Selection): removed, no longer an enum
- (Target): Likewise.
- (SelectionType): Likewise.
-
-2001-10-22 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk-types.c (pygdk_atom_number): remove numeric bits,
- GdkAtom is now opaque.
-
- * gtk/gtk.defs (GtkTreeModelSort.set_model): removed, is static now.
- (GtkTreeModelSort.convert_path): rename to
- GtkTreeMOdelSort.convert_path_to_child_path
-
-2001-10-19 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_tree_model_iter_children): override
- GtkTreeModel.iter_children(parent) to return a new iter, like
- GtkTreeModel.get_iter_root().
-
-2001-10-18 Matt Wilson <msw@redhat.com>
-
- * gtk/gdk.defs (pixbuf_new_from_inline): rename from
- pixbuf_new_from_stream to match gdk-pixbuf changes in CVS.
-
- * pygtk.spec.in (%files devel): get header from new location
-
- * Makefile.am (pkgincludedir): put pygobject.h in
- $(includedir)/pygtk-2.0, not $(includedir)/pygtk-2.0/pygtk
-
-2001-10-16 Matt Wilson <msw@redhat.com>
-
- * codegen/h2def.py (define_func): convert all argument type
- whitespace to '-'.
-
-2001-10-15 Matt Wilson <msw@redhat.com>
-
- * pygtk-2.0.pc.in (pygtkincludedir): move headers to a
- version-specific directory so we can have old pygtk-devel and
- pygtk2-devel installed at the same time.
-
- * Makefile.am (pkgincludedir): likewise
-
- * gtk/Makefile.am (pkgincludedir): likewise
-
- * pygtk.spec.in (%files devel): pick up the new header location
-
-2001-10-11 Matt Wilson <msw@redhat.com>
-
- * pygtk.spec.in (%files devel): fixed typo in devel filelist
- (header) added macro that tests to see if we have libglade2
- (%files libglade) make the filelist a condition of that
- (Name) changed name to 'pygtk2' to avoid name conflict with pygtk
-
-2001-10-11 Murray Cumming <murrayc@usa.net>
-
- * h2def.py: Now it doesn't stop when it finds a function parameter
- with a type but no name. The resulting define-* will be missing
- that parameter, but at least the rest will have succeeded.
-
-2001-10-10 Matt Wilson <msw@redhat.com>
-
- * gobjectmodule.c (pygobject_dealloc): also go set up the reflist
- if we're doing refcount debugging.
-
-2001-10-11 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pygobject_dealloc): if we are saving a
- reference to the wrapper during dealloc (which is probably bad),
- check if it is a heap type, and if so, incref its type, so that
- subtype_dealloc() doesn't decref the type out from under us. This
- problem was tracked down by Matt Wilson
-
-2001-10-09 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-extrafuncs.defs (GenericTreeModel): fix up c-name.
-
- * examples/pygtk-demo/demos/treemodel.py (MyTreeModel): subclass
- from gtk.GenericTreeModel.
-
- * pygtk.spec.in (Requires): add new files to spec file.
-
-2001-10-09 James Henstridge <james@daa.com.au>
-
- * pango-types.defs: move types.
-
- * gtk/Makefile.am: modify rules to take into account splitting out
- the type definitions. --register arguments now only parse the
- type defs and not the function defs, which should speed up the
- build a bit.
-
- * gtk/gdk-types.defs: same here.
-
- * gtk/gtk.defs: and include gtk-types.defs here.
-
- * gtk/gtk-types.defs: move
- define-{object,interface,enum,flags,boxed} defs to this file.
-
- * gtk/gtk-extrafuncs.defs (get_selection): and add it back here.
-
- * gtk/gtk.defs: remove gtk_list_get_selection function from this
- file.
-
- * gtk/gtk-extrafuncs.defs (pygtk_generic_tree_model_new): similar
- changes here.
-
- * gtk/pygtktreemodel.c: same changes here.
-
- * gtk/pygtktreemodel.h (pygtk_generic_tree_model_get_type): rename
- to PyGtkGenericTreeModel, so that short name doesn't collide with
- GtkTreeModel.
-
-2001-10-08 Matt Wilson <msw@redhat.com>
-
- * pygtk.spec.in: added specfile template
-
- * configure.in (AC_CONFIG_FILES): add pygtk.spec
-
- * Makefile.am (dist-hook): copy the spec file into the dist dest
- dir
-
- * gtk/gtk.defs (ColorSelectionDialog): added colorsel, ok_button,
- cancel_button, and help_button fields.
- (GtkList.get_selection): marked as a PyGTK extension.
-
-2001-10-08 James Henstridge <james@daa.com.au>
-
- * pango.defs (pango_font_metrics_new): comment out, as it is only
- for use by engines.
-
- * gtk/libglade.override: same here.
-
- * gtk/gdk.override: same here.
-
- * gtk/gtk.override: use import section here.
-
- * pango.override: use the new import stuff to get the reference to
- the GObject type.
-
- * codegen/codegen.py (write_source): write out code based on the
- import statements in the overrides file. Most modules have some
- code like this, and this helps reduce the boilerplate code that
- needs to be entered in.
-
- * codegen/override.py (Overrides.get_imports): add handlers for
- "import" sections of the overrides file, which are used to get
- references to the types in other modules.
-
-2001-10-06 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_list__get_selection): remove unused
- variable (the line number on the gcc warning matched exactly!)
-
- * codegen/codegen.py (write_source): reset line numbering after
- writing headers and init overrides.
- (main): add --outfilename argument, for specifying the final name
- of the file -- output is not written to this file. If argument is
- not passed, derive from defs filename.
-
- * codegen/override.py (Overrides.__parse_override): add #line
- outputs for headers and init type overrides.
-
- * codegen/codegen.py (main): pass the filename to overrides.
- (FileOutput): wrapper class for file objects to keep track of line
- numbers, so that #line statements can be written.
- (write_class): write out #line statements for overriden
- constructor and methods.
- (write_getsets): write #line's for getsets.
- (write_interface): write #line's for methods.
- (write_boxed): write #line's for constructor and methods.
-
- * codegen/override.py (Overrides.__init__): rewrite the code that
- reads in the overrides file, so it only splits on lines with only
- '%%' in them. Also keep track of line numbers, so we know where
- each section starts.
- (Overrides.__parse_override): save the start line for 'override'
- sections and 'override-attr' sections.
- (Overrides.getstartline): new function to retrieve the start line
- for a .overrides section.
- (Overrides.__init__): take the filename rather than file handle as
- argument.
-
-2001-10-05 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_list__get_selection): implemented
- function to return the selection.
- (_wrap_gtk_list_get_selection): use above to implement a method
- for getting the selection, like old pygtk.
-
- * gtk/gtk.defs (GtkList.get_selection): added function to be
- compatible with previous versions.
- (GtkList): added "selection" field
-
- * gobjectmodule.c (pyg_closure_new): too many tuples.
-
-2001-10-05 Matt Wilson <msw@redhat.com>
-
- * gobjectmodule.c (pygobject_emit): mask out
- G_SIGNAL_TYPE_STATIC_SCOPE to fix signal emission.
-
-2001-10-05 Johan Dahlin <zilch.am@home.se>
-
- * gobjectmodule.c (pyg_closure_new): Handle non-Tuple parameters.
-
- * gtk/gtk.override (_wrap_gtk_window_list_toplevels): Bound
- (_wrap_gtk_toolbar_insert_stock): Bound.
-
- * gtk/gtk.defs (binding_entry_clear): rename from
- gtk_bindings_entry_clear
- (color_selection_palette_from_string): rename from
- gtk_color_selection_palette_from_string
- (set_border_width): Added
- (set_resize_mode): Added
- (get_children): Added
- (children): Mark as deprecated
- (get_focus_chain): Added
- (get_focus_vadjustment): Added
- (get_focus_hadjustment): Added
- (gtk_container_add_child_arg_type): Removed
- (gtk_container_query_child_args): Removed
- (gtk_containerchild_getv): Removed
- (gtk_container_child_setv): Removed
- (gtk_container_add_with_args): Removed
- (gtk_container_addv): Removed
- (gtk_container_add_set): Removed
- (gtk_container_add_get): Removed
- (GtkContainer.child_set): Added
- (GtkContainer.child_get): Added
- (gtk_container_child_args_collect): Removed
- (gtk_container_child_arg_get_info): Removed
- (GtkDrawingArea.size): Mark as deprecated
- (GtkEditable.get_editable): Added
- (GtkEntry.new_with_max_length): Mark as deprecated
- (GtkEntry.get_visibility): Added
- (GtkEntry.get_invisible_char): Added
- (GtkEntry.get_max_length): Added
- (GtkFontSelection.get_font): Mark as deprecated
- (GtkFontSelectionDialog.get_font): Mark as deprecated
- (GtkFrame.get_label_widget): Added
- (GtkFrame.get_label_align): Added
- (GtkFrame.get_shadow_type): Added
- (GtkGC.gc_get): Added
- (gtk.gc_release): Rename from gtk_gc_release
- (GtkHandleBox.get_shadow_type): Added
- (GtkHandleBox.get_handle_position): Added
- (GtkHandleBox.get_snap_edge): Added
- (GtkHscale.new_with_range): Added
- (GtkLayout.freeze): Mark as deprecated
- (GtkLayout.thaw): Mark as deprecated
- (GtkListStore.new): Fix parameters
- (GtkListStore.newv): Added (needed?)
- (GtkListStore.set): Added
- (GtkListStore.clear): Added
- (gtk_init_abi_check): Remove
- (gtk_init_check_abi_check): Remove
- (gtk_exit): Remove
- (gtk.get_current_event_state): Added
- (GtkMenu.get_tearoff_state): Added
- (GtkMenu.get_title): Added
- (gtk_rc_*): Rename to rc_*
- (GtkToolbar.insert_stock): Added
- (GtkToolbar.set_icon_size): Added
- (GtkToolbar.unset_style): Added
- (GtkToolbar.unset_icon_size): Added
- (GtkToolbar.get_orientation): Added
- (GtkToolbar.get_style): Added
- (GtkToolbar.get_icon_size): Added
- (GtkToolbar.get_tooltips): Added
- (gtk_type_unique): Remove
- (gtk_type_class): Remove
- (gtk_type_new): Remove
- (gtk_enum_get_values): Remove
- (gtk_flags_get_values): Remove
- (gtk_enum_find_value): Remove
- (gtk_flags_find_value): Remove
- (GtkViewport.get_shadow_type): Added
- (GtkVscale.new_with_range): Added
-
-2001-10-05 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_dialog_new_with_buttons): fixed
- argument format string.
-
-2001-10-03 Matt Wilson <msw@redhat.com>
-
- * gtk/gdk.defs (Rectangle): added definition for GdkRectangle
-
-2001-10-04 Matthew Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_toolbar_append_item): make user_data
- optional
-
- * gtk/gtk.defs (GtkToolbar.append_item): make user_data optional
-
-2001-10-04 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_item_factory_create_items): fixed
- non-compiling function.
-
-2001-10-04 Johan Dahlin <zilch.am@home.se>
-
- * gtk/gtk.override (_wrap_gtk_item_factory_create_items): Modify
- ParseTuple to accept 6 argument, so we can use stock icons and gdkpixbufs.
- (_wrap_gtk_spin_button_get_range): Bound.
- (_wrap_gtk_spin_button_get_increments): Bound.
-
- * gtk/gtk.defs: rename gtk.gtk_* gtk.*.
-
-2001-10-04 James Henstridge <james@daa.com.au>
-
- * pygtk.spec: spec file changes.
-
- * gtk/gtk.defs (AccelGroup): this is an object now -- not a boxed.
-
-2001-10-03 Matt Wilson <msw@redhat.com>
-
- * gobjectmodule.c (pygobject_repr): tweak the repr such that
- calling it on an uninitialized PyGObject won't segfault. Also
- print the python class name.
-
-2001-10-02 Johan Dahlin <zilch.am@home.se>
-
- * gtk/gdk.override (_wrap_gdk_color_parse): Added.
-
- * gtk/gtk.override (_wrap_gtk_label_get_selection_bounds):
- (_wrap_gtk_label_get_layout_offsets):
- (_wrap_gtk_button_box_get_child_size):
- (_wrap_gtk_button_box_get_child_ipadding): Added.
-
- * gtk/gtk.defs
- GtkAccelGroup.activate, attach, detach, groups_activate, add,
- remove:
- s/GtkObject/GObject/
- (gtk_adjustment_new) (GtkAdjustment.clamp_page): s/gfloat/gdouble/
- (GtkAdjustment.get_value): Added
- (GtkBin.get_child): Added
- (GtkBox.get_homogeneous): Added
- (GtkCellRenderer.event): Removed
- (GtkCellRenderer.activate): Added
- (GtkCellRenderer.start_editing): Added
- (GtkCellRenderer.set_fixed_size): Added
- (GtkCellRenderer.get_fixed_size): Added
- (GtkCheckMenuItem.get_activate): Added
- (gtk_color_selection_get_type): Added
- (gtk_color_selection_new): Added
- Removed old functions from gtkbindings.h.
-
-2001-10-02 Matt Wilson <msw@redhat.com>
-
- * gtk/gdk.defs (gdk.screen_width): bound
- (gdk.screen_height): bound
- (gdk.screen_width_mm): bound
- (gdk.screen_height_mm): bound
- (gdk.flush): bound
- (gdk.beep): bound
- (gdk.set_double_click_time): bound
- (gdk.gdk_window_get_toplevels): renamed to window_get_toplevels
- (gdk.get_default_root_window): bound
- (gdk.gdk_color_parse): renamed to color_parse
- (gdk.gdk_drag_context_get_type): renamed to drag_context_get_type
- (gdk.gdk_drag_context_new): renamed to drag_context_new
- (gdk.gdk_gc_new): renamed to gc_new
- (gdk.gdk_image_new_bitmap): renamed to image_new_bitmap
- (gdk.gdk_device_get_type): renamed to device_get_type
- (gdk.gdk_devices_list): renamed to devices_list
- (gdk.device_free_history): renamed to device_free_history
- (gdk.gdk_rgb_xpixel_from_rgb): renamed to rgb_xpixel_from_rgb
- (gdk.gdk_rgb_gc_set_foreground): renamed to rgb_gc_set_foreground
- (gdk.rgb_gc_set_background): renamed to rgb_gc_set_background
-
- * gobjectmodule.c (pygobject_dealloc): remove debugging message
- James checked in.
-
- * gtk/gtk.override (_wrap_gtk_text_buffer_set_text): override
- GtkBuffer.set_text so that you don't have to pass in the length.
-
- * codegen/argtypes.py (FlagsArg.write_param): preserve flags that
- have a default value by short circuiting the conversion of NULL
- Python flags to 0.
-
- * gobjectmodule.c (pyg_object_new): rewrote function to use
- g_object_newv and instantiate the object after we check to make
- sure the class handles all the properties passed. This solves the
- problem of trying to destroy a GtkObject after creating it, which
- can be a little tricky.
-
-2001-10-02 Matt Wilson <msw@redhat.com>
-
- * gobjectmodule.c (pyg_object_new): added a new gobject.new
- function to create an object of any registered type with kwargs
- property setting.
-
-2001-10-02 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pygobject_new): fix bug where we were INCREFing
- the saved widget even in the hasref case (where we should be
- passing ownership of the last reference).
-
-2001-10-02 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_clist_new_with_titles): accept unicode
- objects as well.
- (_wrap_gtk_clist_prepend): likewise
- (_wrap_gtk_clist_append): likewise
- (_wrap_gtk_clist_insert): likewise
- (_wrap_gtk_combo_set_popdown_strings): likewise
- (_wrap_gtk_ctree_new_with_titles): likewise
- (_wrap_gtk_ctree_insert_node): likewise
-
-2001-10-02 Johan Dahlin <zilch.am@home.se>
-
- * gtk/gtk.defs: Added
- GtkAccelLabel: get_accel_object, set_accel_object.
- GtkButton: set_label, get_label, set_use_underline,
- get_use_underline, set_use_stock, get_use_stock.
- GtkLabel: get_attributes, set_label, get_label, set_use_markup,
- get_use_markup, set_use_underline, get_use_underline,
- get_justify
- GtkRadioButton: get_group
- GtkSpinButton: get_digits, get_increments, get_range,
- get_update_policy, get_numeric, get_wrap,
- get_snap_to_tickets, get_mode
-
-2001-10-01 Matt Wilson <msw@redhat.com>
-
- * codegen/codegen.py (write_boxed_getattr): added code to write
- out __members__ attribute so that dir(foo) works on boxed types
-
-2001-10-01 Matthew Wilson <msw@redhat.com>
-
- * examples/pygtk-demo/demos/treemodel.py
- (MyTreeModel.on_get_column_type): use gobject.TYPE_STRING instead
- of hard coded values
-
-2001-09-30 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pygobject_dealloc): use plain old
- PyObject_GC_Del, as the overridden tp_free seems to ignore the GC
- header.
- (pygobject_new): GC track wrappers created through pygobject_new.
-
- * configure.in: increment version number, and require gtk 1.3.9
- (we already required it before).
-
- * gobjectmodule.c (pygobject_new): initialise extra members.
- Problem found by msw.
-
-2001-09-29 Matthew Wilson <msw@redhat.com>
-
- * examples/pygtk-demo/demos/dnd.py: port to new namespace
-
-2001-09-29 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_param_spec_new): add a wrapper for a
- GParamSpec. Currently it only exposes the base parameter info;
- none of the extra info provided by derived param specs.
- (pyg_object_class_list_properties): return a list of GParamSpec
- objects, rather than just strings.
- (pyg_value_as_pyobject): catch NULL strings.
-
- * configure.in (minver): require 2.2a4.
-
- * gtk/pygtktreemodel.c (pygtk_tree_model_get_column_type): use
- pyg_type_from_object instead. Based on patch from Elliot.
-
- * gtk/gtk.override (_wrap_gtk_selection_data__get_data): convert
- getter to a function to match codegen changes.
-
- * : merge in python22-branch (see changelog entries below).
-
-2001-09-25 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pygobject_get_dict): getter for __dict__ on
- GObject wrappers.
- (PyGObject_Type): include getsets list.
-
- * codegen/codegen.py (write_getsets): change "struct getsets" to
- PyGetSetDef to match recent changes in python.
-
- * gtk/gdk.override (_wrap_gdk_device__get_axes): change to getter.
- (_wrap_gdk_device__get_keys): turn into a getter.
- (_wrap_gdk_drag_context__get_targets): same here.
-
- * gtk/gtk.override (_wrap_gtk_clist__get_selection): turn into a
- getter.
- (_wrap_gtk_ctree__get_selection): turn into a getter.
-
- * codegen/codegen.py (write_getsets): rename to write_getsets, and
- don't allow overriding the whole routine, as it is implemented as
- a number of smaller routines now.
- (gettertmpl): rename from getattrtmpl. Refactor for handling
- single attribute.
- (write_getsets): finish conversion over to using getsets.
- (write_class): call write_getsets instead.
- (typetmpl): substitute %(getsets)s rather than %(getattr)s.
-
-2001-09-23 James Henstridge <james@daa.com.au>
-
- * gtk/__init__.py: don't import ExtensionClass.
-
- * gobjectmodule.c (object_gc_free): new function to free an GC
- managed object.
- (PyGObject_Type): use object_gc_free for the tp_free slot.
-
- * codegen/codegen.py (write_class): don't write getattr routine.
- This is a temporary hack to see if things work.
-
- * gobjectmodule.c (pygobject_dealloc): handle case of destruction
- when self->obj == NULL.
-
- * gtk/gtk.override (_wrap_gtk_clist_new_with_titles): return an
- int.
- (_wrap_gtk_tree_view_get_path_at_pos): same here.
- (_wrap_gtk_button_new): same here.
- (_wrap_gtk_toggle_button_new): same here.
- (_wrap_gtk_check_button_new): same here.
- (_wrap_gtk_radio_button_new): same here.
- (_wrap_gtk_list_item_new): same here.
- (_wrap_gtk_menu_item_new): same here.
- (_wrap_gtk_check_menu_item_new): same here.
- (_wrap_gtk_radio_menu_item_new): same here.
- (_wrap_gtk_ctree_new_with_titles): same here.
- (_wrap_gtk_dialog_new_with_buttons): same here.
- (_wrap_gtk_message_dialog_new): same here.
- (_wrap_gtk_message_dialog_new): same here.
-
- * gtk/gdk.override (_wrap_gdk_cursor_new): return an int.
-
- * pango.override (_wrap_pango_font_description_new): constructors
- return ints.
-
- * codegen/codegen.py (write_constructor): small hack to convert
- "return NULL;" to "return -1;" in constructors, as they should
- return ints.
- (write_boxed_constructor): same here.
-
-2001-09-22 James Henstridge <james@daa.com.au>
-
- * gtk/pygtk.h: remove traces of ExtensionClass.
-
- * gtk/libglade.override: s/PyExtensionClass/PyTypeObject/.
-
- * gtk/gtk-types.c (_pygtk_register_boxed_types): get rid of
- mentions of ExtensionClass.
-
- * gtk/gdk.override: s/PyExtensionClass/PyTypeObject/.
-
- * gtk/gtk.override: s/PyExtensionClass/PyTypeObject/.
-
- * gobjectmodule.c (pygobject_traverse): implement a traverse
- function for PyGObject.
- (PyGObject_Type): add GC support.
- (object_free): use PyObject_GC_Del to delete the memory.
- (pygobject_dealloc): stop GC tracking the object here.
- (pygobject_register_class): set a few more type fields here.
- (pygobject_new): use PyObject_GC_New to allocate the object here.
- (pygobject_dealloc): readd the 1-1 object/wrapper hack. It should
- work as expected since adding GC support.
-
- * pango.override: s/PyExtensionClass/PyTypeObject/
-
- * codegen/codegen.py (consttmpl): constructor template returns an
- int.
- (noconstructor): return int rather than PyObject.
- (typetmpl): change def to be a PyTypeObject, with extra fields.
- (interfacetypetmpl): same here.
- (boxedconsttmpl): return int rather than pyobject.
- (boxedtmpl): change def to PyTypeObject.
- (write_class): put the constructor in the right place.
- (write_boxed): put the constructor in the right place.
- (write_source): don't include ExtensionClass.h, forward declare
- type objects as PyTypeObjects, rather than PyExtensionClasses.
-
- * gobjectmodule.c (pygobject_register_class): set type->ob_type.
- (pyg_register_boxed): same here.
- (pyg_register_interface): same here.
- (initgobject): set the ob_type member of PyGInterface_Type and
- PyGBoxed_Type.
- (pygobject__gobject_init__): add __gobject_init__ method, that
- just calls pygobject_init.
- (pygobject_methods): readd __gobject_init__ method.
-
-2001-09-21 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pygobject_register_class): convert to use
- PyTypeObjects instead of ExtensionClass.
- (pygobject_new): don't need to set inst_dict. Python takes care
- of that for us.
- (pyg_register_boxed): convert to 2.2.
- (pyg_boxed_new): convert to 2.2.
- (pyg_value_from_pyobject): get rid of ExtensionClass calls.
- (pygobject_init): convert to 2.2.
-
- * pygobject.h: don't include ExtensionClass.h
-
- * configure.in (AM_PATH_PYTHON): require python 2.2.
-
- * Makefile.am: remove ExtensionClass.
-
-2001-09-28 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (gtk_progress_bar_new_with_adjustment): mark as
- constructor
-
- * gtk/gtk.override (_wrap_gtk_progress_bar_new_with_adjustment):
- override constructor for ProgressBar to optionally take adjustment
-
-2001-09-27 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (GtkTreeView.set_cursor): added new parameters.
-
- * gtk/pygtk-private.h: removed old PyGtkCTreeNode code, move to
- generic generated code.
-
- * gtk/gtkmodule.c (_PyGtk_FunctionStruct): likewise
-
- * gtk/pygtk.h: likewise.
-
- * gtk/gtk-types.c: likewise.
-
- * gtk/gtk.override (_wrap_gtk_tree_store_get_root_iter): moved to
- gtk_tree_model_get_iter_root.
- (_wrap_gtk_ctree_node_from_cobject): removed
- (_wrap_gtk_ctree_node_getattr): moved gtk-types.c getattr code to
- generic boxed interface and placed here.
- (_wrap_gtk_ctree_*): migrated to generic PyGBoxed for GtkCTreeNodes
-
-2001-09-26 Matt Wilson <msw@redhat.com>
-
- * gtk/gtkmodule.c (_PyGtk_FunctionStruct): removed PyGtkCTreeNode
- functions
-
- * codegen/argtypes.py: remove GtkCTreeNode custom registration
-
- * gtk/gtk.defs (GtkContainer.queue_resize): remove, use
- gtk_widget_queue_resize instead of gtk_container_queue_resize
- (GtkContainer.child_composite_name): remove, this is private
- (GtkContainer.clear_resize_widgets): likewise
- (GtkTreeViewColumn.set_cell_renderer): remove, use
- GtkTreeViewColumn.pack_start instead
- (CTreeNode): added CTreeNode boxed definition
-
- * gtk/gtk.override (_wrap_gtk_tree_view_column_new): changed from
- gtk_tree_view_column_set_renderer to gtk_tree_view_column_pack_start.
-
-2001-09-25 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (get_has_resize_grip): bound
- (set_has_resize_grip): bound
-
-2001-09-24 Matt Wilson <msw@redhat.com>
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_render_pixmap_and_mask):
- implemented GdkPixbuf.render_pixmap_and_mask.
-
- * gtk/gdk.defs (GdkPixbuf.render_pixmap_and_mask): set
- alpha_threshold default to 127
-
- * gtk/gtk.override (ignore): added gtk_entry_new to the big list
- of ignores.
-
- * gtk/gtk.defs (gtk_entry_new_with_max_length): bound
- (GtkCList.set_pixmap): default mask to NULL
-
-2001-09-24 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (gtk_adjustment_new): added defaults to match
- previous version, changed step_increment to step_incr and
- page_increment to page_incr to match previous version.
- (gtk_table_new): added defaults to match previous version.
-
-2001-09-22 Matthew Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (ctree_node_from_cobject): added binding.
-
- * gtk/gtk.override (_wrap_gtk_ctree_node_from_cobject): added a
- function to turn a PyCObject into a PyCListNodeObject object.
- This is a hack until GtkCTreeNode becomes a boxed type.
-
-2001-09-21 Matthew Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_ctree_new_with_titles): use the same
- defaults as previous versions, make count and tree_column optional
- (_wrap_gtk_clist_new_with_titles): likewise
-
-2001-09-21 Matt Wilson <msw@redhat.com>
-
- * codegen/argtypes.py (BoxedArg.write_return): handle returning
- both a pointer to a boxed type and a boxed type itself
- (ArgMatcher.register_boxed): register both pointers to boxed types
- and boxed types themselves
-
- * gtk/gtk.defs (Style): add "black" and "white" fields. More to
- do here later.
-
- * gtk/gtk.override (_wrap_gtk_radio_button_new): use
- new_from_widget, not the group->group member when creating a new
- button in a group.
-
-2001-09-20 James Henstridge <james@daa.com.au>
-
- * pango.defs (FontMetrics): uncomment this now it has a boxed type.
-
- * gtk/Makefile.am (EXTRA_DIST): add gdk.override to dist.
-
- * configure.in: update version number.
-
- * pygobject.h (_PyGObject_Functions.newgobj): rename from new, so
- that the header is includable in C++ programs.
-
-2001-09-19 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (gtk_message_dialog_new): define defaults
-
- * gtk/gtk.override (_wrap_gtk_message_dialog_new): override this
- function so we can use "%s" as the format string and pass the
- entire last argument as a string securely.
-
-2001-09-19 James Henstridge <james@daa.com.au>
-
- * pango.defs: update for newer Pango API.
-
-2001-09-19 James Henstridge <james@daa.com.au>
-
- * pango.defs (FontDescription): remove fields from
- PangoFontDescription, as it is an opaque type now.
-
- * configure.in (ACLOCAL): require glib 1.3.8, pango 0.19 and gtk+
- 1.3.8.
-
-2001-09-18 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.override (_wrap_gtk_dialog_new_with_buttons): add a cast
- in pointer comparison to squelch compiler warning.
-
-2001-09-18 Matt Wilson <msw@redhat.com>
-
- * gtk/gtk.defs (gtk_dialog_new_with_buttons): note the defaults in
- the definition.
-
- * gtk/gtk.override (_wrap_gtk_dialog_new_with_buttons): implement
- a full-featured constructor for GtkDialog that will allow flags
- (as well as other parameters) to be passed in during object
- construction. The form is a bit different than the C version,
- which uses varargs. To pass a list of buttons at construction
- time, pass a tuple of text/id pairs as the 4th argument or in the
- buttons keyword.
-
- * gtk/gtk.defs (CTree): add selection to the fields
- (GtkCTree::insert_node): note the defaults in the definition.
- (GtkCTree::base_nodes): added base_nodes method back into GtkCTree
-
- * gtk/gtk.override (_wrap_gtk_ctree_insert_node): only require the
- first three parameters and use the defaults from previous versions
- for all the other values.
- (override-attr GtkCTree.selection): implementation for getting the
- selection of a CTree
- (_wrap_gtk_ctree_base_nodes): ported old base_nodes method to new
- binding.
-
- * gtk/gtk.defs (CList): add columns and selection to the fields
-
- * gtk/gtk.override (GtkCList.selection): implementation for
- getting the selection of a CList
-
-2001-09-18 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_object_class_list_properties): rename to
- gobject.list_properties.
-
-2001-09-18 Matt Wilson <msw@redhat.com>
-
- * examples/pygtk-demo/demos/treemodel.py: fixed to work with new
- namespace
-
- * gtk/gdk.defs (pixbuf_new_from_file): don't defined
- gdk_pixbuf_new_from_file as a constructor of GdkPixbuf. Define it
- as pixbuf_new_from_file to match pixbuf_new_from_stream.
-
- * gtk/gtk.defs (gtk_aspect_frame_new): add defaults to match old
- behavior
- (gtk_alignment_new): likewise
- (GtkCTree::construct): likewise
- (gtk_clist_new): likewise
- (gtk_clist_new_with_titles): likewise
- (gtk_ctree_new): likewise
- (gtk_ctree_new_with_titles): likewise
- (GtkImage::construct): use gtk_image_new to construct GtkImages -
- this allows us to use more than just pixmaps to create them.
- (gtk_image_new): new definition.
-
-2001-09-18 James Henstridge <james@daa.com.au>
-
- * pygobject.h (pyg_type_wrapper_new): export this function.
-
- * codegen/argtypes.py (GTypeArg.write_return): wrap GType return
- values as PyGTypeWrappers rather than ints.
-
- * codegen/codegen.py (write_source): pass the typecode macros to
- pygobject_register_class and pyg_register_interface rather than
- references to the get_type functions.
-
- * pygobject.h (_PyGObject_Functions): fix up prototypes.
-
- * gobjectmodule.c (check_bases): check if the base class is an
- extensionclass before poking around in class->bases.
- (pyg_type_*): don't bother storing the _get_type() function for
- lazy initialisation. Instead, just store the GType. Also, remove
- code for coercing them into numbers.
- (pygobject_register_class): take the type, rather that get_type
- routine as an argument.
- (pyg_register_interface): same here.
- (pyg_type_from_object): don't accept types that convert to ints as
- being equivalent to GTypes.
- (pyg_register_boxed): set the __gtype__ attribute to a
- PyGTypeWrapper.
- (pyg_type_register): set __gtype__ to a PyGTypeWrapper.
- (pyg_type_name): use pyg_type_from_name
- (pyg_type_from_name): return a PyGTypeWrapper object.
- (pyg_type_parent): update.
- (pyg_type_is_a): update.
- (pyg_type_children): update.
- (pyg_type_interfaces): update.
- (initgobject): set __gtype__ attributes to PyGTypeWrapper objects.
- (initgobject): make type constants PyGTypeWrapper objects.
-
-2001-09-17 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.override: don't #define these types to G_TYPE_INVALID,
- as they are now valid.
-
- * gtk/gdk.defs: remove the FrameAction enum -- it is private to
- the GIF loader module.
-
-2001-09-16 James Henstridge <james@daa.com.au>
-
- * gtk/Makefile.am (pygtk_PYTHON): install keysyms.py and not GDK.py
-
- * gtk/__init__.py: import keysyms, rather than GDK.py
-
- * gtk/gtk.defs: add missing enums.
-
- * gtk/gdk.defs: add missing enums.
-
- * gtk/GDK.py: remove this file.
-
- * gtk/keysyms.py: put all keysyms here.
-
-2001-09-15 James Henstridge <james@daa.com.au>
-
- * gtk/libglademodule.c (initglade): fix name of init function.
-
- * codegen/codegen.py (write_enums): don't write out the
- add_constants fucntion if there are no enums/flags.
-
- * gtk/libglade.override (connect_many): fix small bug in
- connection function.
-
- * gtk/Makefile.am (pygtk_PYTHON): don't install the GTK.py header.
- (glademodule_la_SOURCES): rename the libglade module to gtk.glade.
-
- * pygtk.spec: update spec file, and add -devel sub package.
-
- * configure.in: use AC_HELP_STRING to format help strings, update
- version number.
-
- * acinclude.m4: remove the AM_PATH_PYTHON macro, as it is in
- automake 1.5.
-
- * Makefile.am: require automake 1.5 to build.
-
-2001-09-15 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_enum_add_constants): allow '_' as start of
- constant name.
- (pyg_flags_add_constants): same here.
-
- * gtk/__init__.py (TRUE): don't import GTK.
-
- * gtk/gtkmodule.c (init_gtk): same here.
-
- * pangomodule.c (initpango): add constants to the pango module.
-
- * codegen/codegen.py (write_enums): new function that writes a
- function to add constants for all the enums and flags in the
- parser.
- (write_source): call write_enums().
-
- * gtk/gtkmodule.c (init_gtk): add test use of add_constants.
-
- * pygobject.h (_PyGObject_Functions): add new functions to header.
-
- * gobjectmodule.c (pyg_enum_add_constants): new function for
- adding constants to a module dictionary from a particular GType.
- (pyg_flags_add_constants): similar for flag types.
- (functions): add to export function vtable.
-
-2001-09-14 James Henstridge <james@daa.com.au>
-
- * pygtk-2.0.pc.in (defsdir): fix up defsdir definition.
-
- * Makefile.am (pkginclude_HEADERS): install ExtensionClass.h
- header (this can go when we switch over to python2.2 type/class
- stuff.
-
- * pygobject.h (pyg_register_boxed_custom): same change.
-
- * gobjectmodule.c (pyg_register_boxed_custom): rename from
- pyg_boxed_register to avoid confusion.
-
-2001-09-14 James Henstridge <james@daa.com.au>
-
- merge from short-class-names-branch
-
-2001-09-12 James Henstridge <james@daa.com.au>
-
- * codegen/codegen.py (write_class, write_interface): set the short
- name as the class name here.
-
- * gobjectmodule.c (pygobject_register_class): pass ec->tp_name as
- the name for the class passed to PyExtensionClass_Export*.
-
- * codegen/codegen.py (write_source): pass the C name to
- pygobject_register_class again.
-
-2001-09-11 James Henstridge <james@daa.com.au>
-
- * gtk/__init__.py (create_pixmap): few fixups to get things to
- import correctly.
-
- * gtk/gtkmodule.c (init_gtk): there is no _pygdk_register_boxed().
-
- * gtk/libglade.override (init): same here.
-
- * gtk/gtk.override (init): same here.
-
- * gtk/gdk.override (init): use short class names here.
-
- * gtk/gtkmodule.c (init_gtk): initialise both the gtk._gtk and
- gtk.gdk modules.
-
- * gtk/gtk.defs: don't include gdk.defs
-
- * gtk/gtk.override: remove all GDK override wrappers.
-
- * gtk/gdk.override: new file taking the overrides for GDK
- functions.
-
- * codegen/codegen.py (write_source): register only the short name
- of the GObject, interface or boxed type.
-
-2001-09-13 Johan Dahlin <zilch.am@home.se>
-
- * gtk/gtk.defs (CellRendererTextPixbuf): removed.
- (gtk_cell_renderer_text_pixbuf_get_type): removed.
- (gtk_cell_renderer_text_pixbuf_new): removed.
- (gtk_cell_renderer_text_iter_spew): removed.
- (row_changed): Renamed.
- (row_inserted): Renamed.
- (row_has_child_toggled): Renamed.
- (row_deleted): Renamed.
- (rows_reordered): Renamed, and fixed.
- (set_fixed_width): Renamed.
- (get_fixed_width): Added.
-
- * gobjectmodule.c (initgobject): Adjust
- g_boxed_type_register_static to compile under latest cvs.
-
-2001-09-10 Johan Dahlin <zilch.am@home.se>
-
- * autogen.sh: add check and usage for AUTOMAKE and ACLOCAL.
-
-2001-09-06 James Henstridge <james@daa.com.au>
-
- * gtk/GTK.py: fix up enums.
-
- * gobjectmodule.c (pyg_closure_marshal): if return_value is NULL,
- don't set it.
- (pyg_signal_class_closure_marshal): same here.
-
- * gtk/gtk.defs: various updates to make it compile.
-
- * gtk/gtk-types.c (pygdk_atom_str): fallback to returning the repr
- of the atom if we can't resolve its name, rather than returning
- NULL. Patch from Skip.
-
- * gobjectmodule.c (pyg_value_from_pyobject): look at the
- fundamental type in this function so we can use a switch statement
- that catches the fundamental types easily, reducing the number of
- type checks.
- (pyg_value_as_pyobject): similar here. Also handle boolean types
- using patch from Skip.
-
- * gtk/GDK.py: add extra constants from Skip.
-
-2001-08-23 James Henstridge <james@daa.com.au>
-
- * configure.in (build_libglade): add forth argument to
- PKG_CHECK_MODULES call so that configure doesn't die a horrible
- death when it can't find libglade.
-
-2001-08-22 James Henstridge <james@daa.com.au>
-
- * gtk/libglade.override: add signal connection function overrieds.
-
- * pygtk-2.0.pc.in: add a pkg-config data file that contains some
- information about how to link other wrapper modules, and where
- pygtk installs its defs files.
-
-2001-08-21 James Henstridge <james@daa.com.au>
-
- * configure.in (build_libglade): add checks for libglade.
-
- * gtk/libglade*: add the libglade module to the build
-
- * configure.in: update for autoconf 2.52
-
- * gtk/gtk.defs: make GtkAccelGroup a GObject rather than a boxed
- type. remove the gtk_tree_model_get_first function.
-
-2001-07-09 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (initgobject): add a gobject.TYPE_PYOBJECT
- constant for the PyObject boxed typecode.
-
-2001-07-08 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_signal_new): fix argument type for
- return_type.
- (initgobject): register a "PyObject" boxed type with glib..
- (pyg_value_from_pyobject): if the value holds a PY_TYPE_OBJECT,
- set the value directly.
- (pyg_value_as_pyobject): special case the PY_TYPE_OBJECT case
- again.
-
- * gtk/gdk.defs, gtk/gtk-extrafuncs.defs, gtk/gtk.defs: update to
- new format.
-
- * pango.defs: update to new format.
-
- * codegen/codegen.py: various fixes to make it work with the new
- defs format.
-
- * codegen/argtypes.py (ObjectArg.__init__): take the typecode as
- an argument, and use it to deduce the cast macro (s/_TYPE_/_/).
- (BoxedArg.__init__): take typecode as argument explicitly.
- (EnumArg.__init__): take typecode as argument explicitly.
- (FlagsArg.__init__): take typecode as argument explicitly.
- (ArgMatcher.register_enum): pass typecode argument.
- (ArgMatcher.register_flag): same here.
- (ArgMatcher.register_object): same here.
- (ArgMatcher.register_boxed): same here.
-
- * codegen/definitions.py (ObjectDef): update parser for new format.
- (InterfaceDef): same here.
- (EnumDef): same here.
- (BoxedDef): same here.
- (MethodDef): same here.
- (FunctionDef): same here.
-
- * codegen/defsparser.py (DefsParser): add define- prefix to the
- defs we look for.
-
- * codegen/defsconvert.py (convert): new program to convert v2 defs
- to v3 defs. It will probably only work with files in the style
- created by the h2def.py program.
-
-2001-07-07 James Henstridge <james@daa.com.au>
-
- * codegen/h2def.py (to_upper_str): add function to convert a type
- name to upper case with underscores using the same algorithm as
- gtk+ (with an extra rule to catch cases like GObject.
- (typecode): function to create a typecode like GTK_TYPE_WIDGET
- from the type name.
- (write_obj_defs): output v3 defs.
- (write_enum_defs): output v3 defs.
- (define_func): replace 'G_CONST_RETURN ' to 'const-' for return
- value.
- (write_func): output v3 defs.
-
- * codegen/scmexpr.py (parse): make the parser ignore single
- quotes, which are used in the new defs format.
-
-2001-07-03 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_list_store_new): fix up function
- call.
- (_wrap_gtk_tree_store_new): fix up function call.
-
- * configure.in (AC_OUTPUT): add pygtk-codegen-2.0 to list of files
- to be processed.
-
- * codegen/codegen.py (register_types): fix typo s/parser/defsparser/
-
- * gtk/Makefile.am ($(srcdir)/gtk.c): register types from
- pango.defs.
-
- * gtk/gtk.override (init): import the PangoContext and PangoLayout
- classes from the pango module.
-
-2001-07-02 James Henstridge <james@daa.com.au>
-
- * pango.defs: add is-constructor-of arguments to some defs, and
- add fields to some object and boxed defs.
-
- * pango.override: add more overrides.
-
- * pango.defs: add more boxed type defs.
-
- * gtk/gtk.defs (dequeue_resize_handler): remove removed function.
-
- * codegen/override.py (Overrides.__parse_override): fix bug here.
- string.find returns negative value on error -- not zero.
-
- * codegen/argtypes.py (GTypeArg.write_param): fix up arg handler.
-
- * Makefile.am (pangomodule_la_SOURCES): fix up makefile rules to
- build the pango module.
-
- * pango.override: changes so that it builds properly.
-
- * configure.in: add line to check for pango and set PANGO_CFLAGS
- and PANGO_LIBS.
-
- * Makefile.am (pangomodule_la_SOURCES): add rules to build pango
- module.
-
- * pango.defs:
- * pango.override:
- * pangomodule.c: new files for the pango wrapper module.
-
-2001-07-01 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_signal_list_names): function to list the
- signals of an object type. From patch by Skip Montanaro
- (pyg_object_class_list_properties): function to list the
- properties of a GObject. Also from Skip.
-
- * gtk/gtk.override (_wrap_gtk_list_store_new): fix to use
- gtk_list_store_newv.
- (_wrap_gtk_tree_store_new): similar fix here.
-
-2001-06-30 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-types.c: remove GdkDevice stuff from this file.
-
- * gtk/gtk.override: add attribute getters for some GdkDevice
- attributes, and overrides for some GdkDevice methods.
- (_wrap_gdk_event_getattr): change stuff for GdkDevices, as they
- are now GObjects.
-
- * gtk/gdk.defs (Device): add device boxed type here.
-
- * gtk/gtk.override (_wrap_gtk_selection_add_targets): fix up to
- use PyGBoxed version of GdkEvent.
-
- * gtk/gtk-types.c: remove GdkEvent stuff from here. Also delete
- the commented out GdkDragContext code, as the current GObject
- implementation has the same features now.
-
- * gtk/gtk.override (_wrap_gdk_event_getattr): implement the
- getattr method for GdkEvents.
-
- * gtk/gdk.defs (Event): add boxed type here.
-
- * gobjectmodule.c (initgobject): remove g_type_init() argument.
-
- * gtk/gdk.defs (Visual): make GdkVisual a boxed.
-
- * gtk/gtk.override (GdkDragContext.targets): override getter for
- this attribute.
- (_wrap_gtk_list_store_new): comment out most of this function as
- there is no way to construct a GtkListStore without C varargs as
- of the last GtkTree related commit.
-
- * gtk/gtk-types.c: remove uses of GtkSelectionData.
-
- * gtk/gtk.override (GtkSelectionData.data): override the data
- attribute for GtkSelectionData types.
- (_wrap_gtk_selection_data_set): override method.
-
- * gtk/gtk.defs (SelectionData): add GtkSelectionData boxed type
- here.
-
-2001-06-29 James Henstridge <james@daa.com.au>
-
- * codegen/codegen.py (write_getattr): add code to allow overriding
- the getter for a single attribute.
- (write_boxed_getattr): same here.
-
- * codegen/override.py (Overrides): add code to handle
- "override_attr" statements in an overrides file.
-
- * codegen/codegen.py (write_getattr): add support for overriding
- the complete getattr method for a GObject class.
- (write_boxed_getattr): similar change here.
-
- * configure.in: require 1.3.7 versions of glib and gtk+.
- (AC_ARG_ENABLE): fix --disable-thread argument. It was actually
- looking for --disable-numpy, which causes all kinds of weirdness.
-
- * gtk/gtk.override (_wrap_gdk_cursor_new): constructor for
- GdkCursor that handles both the standard and pixmap cases for
- cursors.
-
- * gtk/gtk-types.c: remove GdkCursor related stuff from this file.
-
- * gtk/gdk.defs (Cursor): add boxed type for cursor.
- (cursor_new): mark as constructor.
- (cursor_new_from_pixmap): mark this one as a constructor as well.
-
-2001-06-27 James Henstridge <james@daa.com.au>
-
- * codegen/argtypes.py (arg): don't register a boxed handler for
- GtkTextIter here.
-
- * gtk/gtk.override: add overrides for various GtkTextIter methods.
-
- * codegen/argtypes.py (BoxedArg.write_param): fix up variable type.
-
- * gtk/gtk.override (_wrap_gtk_text_iter_copy): implement text iter
- copy function, and ignore the gtk_text_iter_free function (it
- could cause troubles).
- (*): replace function calls using the old GtkTextIter wrapper.
-
- * gtk/gtk.defs: update defs for GtkTextIter.
- (TextIter): add text iter boxed type here.
-
- * examples/pygtk-demo/demos/toolbar.py (main): fix up toolbar
- constructor.
-
- * examples/pygtk-demo/demos/treemodel.py: add on_get_iter()
- method, and put tree view in a scrolled window.
-
- * gtk/pygtktreemodel.c (pygtk_tree_model_get_iter): add missing
- function to GtkTreeModel implementation.
-
- * codegen/argtypes.py (arg): remove registrations for `custom'
- boxed types for objects converted to PyGBoxed.
-
- * gtk/gtk.override: use PyGBoxed calls fro GtkTreeIters.
-
- * gtk/gtk-types.c: remove GtkTreeIter stuff from here.
-
- * gtk/gtk.defs (TreeIter): add boxed type here.
-
-2001-06-26 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-types.c: remove traces of GdkColor from this file.
-
- * gtk/gtk.override: convert occurences of PyGdkColor_* with
- correct PyGBoxed calls.
-
- * gtk/gdk.defs (Color): add GdkColor boxed type here.
-
-2001-06-25 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_binding_entry_add_signal): new
- function, based on implementation from Skip. Some small cleanups
- applied.
-
- * gtk/gtkobject-support.c: remove dead code for GtkArg handling,
- etc. (also tidied up references to it in other files).
-
-2001-06-24 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-types.c: removed all traces of GdkFont.
-
- * gtk/gdk.defs (Font): add boxed type for font.
-
- * gtk/gtk-types.c: removed all traces of GdkVisual.
-
- * gtk/gdk.defs (Visual): add boxed type for visual.
-
- * gtk/gtk-types.c: remove all traces of GtkAccelGroup from this
- file -- GtkAccelGroup is now generated code.
-
- * gtk/gtk.defs (AccelGroup): add boxed type here.
-
-2001-06-23 James Henstridge <james@daa.com.au>
-
- * codegen/codegen.py: generate wrappers for boxed types as well.
-
- * codegen/defsparser.py (DefsParser.boxed): handle (boxed ...)
- lines.
-
- * codegen/definitions.py (BoxedDef): add a class for holding a
- Boxed definition.
-
- * gobjectmodule.c (pyg_signal_new): more fixups to use
- pyg_type_from_object.
-
- * gtk/gtk.override (_wrap_gtk_accel_group_new): don't use
- PyGtkAccelGroup_New (not sure why I am fixing this -- will change
- soon anyway).
- (_wrap_gtk_tree_store_set_value): use pyg_type_from_object here.
- (_wrap_gtk_list_store_set_value): same here.
-
- * codegen/argtypes.py (CustomBoxedArg): rename from BoxedArg.
- (BoxedArg): new code for standardised PyGBoxed handling.
- (ArgMatcher.register_custom_boxed): rename from register_boxed
- (ArgMatcher.register_boxed): new function for PyGBoxed types.
- (arg): use ArgMatcher.register_boxed to register GtkAccelGroup.
-
- * pygobject.h (pyg_boxed_check): change macro to check against the
- typecode, rather than python wrapper type.
-
-2001-06-22 James Henstridge <james@daa.com.au>
-
- * codegen/argtypes.py (GTypeArg.write_param): new arg type for
- GType and GtkType args that uses pyg_type_from_object.
-
- * gobjectmodule.c (pyg_type_from_object): new function to get a
- type code from various types of python objects (currently, integer
- like objects, strings and other objects that have a __gtype__
- attribute).
- (pygobject__init__): use pyg_type_from_object to get the object
- type.
- (pyg_signal_new): same here.
-
-2001-06-21 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_boxed_getattro): allow getattr to work on
- PyGBoxed types (while not overloading tp_getattr). We fall back
- to tp_getattr if provided by the boxed type.
- (pyg_register_boxed): make sure tp_getattro is set correctly.
-
- * gtk/gtk-types.c (_pygtk_register_boxed_types): convert
- GtkAccelGroup to a PyGBoxed type.
-
- * gtk/gtkobject-support.c (pygtk_dict_as_container_args): comment
- out, as container args have been switched to properties now.
-
-2001-06-19 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_value_from_pyobject): handle PyGBoxed
- types.
- (pyg_value_as_pyobject): pass out PyGBoxed types if no custom
- handler is found, rather than straight CObjects. Will need to do
- something about cases where we want mutable values (ie. don't copy
- the boxed type).
-
- * configure.in: require glib/gtk+ 1.3.6
-
-2001-06-13 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs (Dialog): add fields that were missing (pointed out
- by Skip).
-
- * gtk/gtk.override: various updates to overrides file.
-
-2001-06-12 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_tree_view_get_path_at_pos): fix bug
- when no keyword arguments are passed in. Bug found by Skip
- Montanaro.
-
- * examples/pygtk-demo/pygtk-demo.py (create_list): correct signal
- name.
-
- * gtk/gtk.defs: update for changes made to gtk.
-
-2001-06-09 James Henstridge <james@daa.com.au>
-
- * codegen/codegen.py (write_interface): remove the constructor
- from interfaces. It is now provided by GInterface.
- (write_source): use pyg_register_interface to register interfaces.
-
- * gobjectmodule.c (PyGInterface_Type): add a GInterface class that
- is the base of all interfaces. It prevents subclassing of
- interface objects, etc.
-
-2001-06-08 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_register_boxed): function to register a new
- boxed type ExtensionClass.
- (pyg_boxed_new): new function to create wrapper instances for a
- particular boxed type (given its typecode).
-
-2001-06-07 James Henstridge <james@daa.com.au>
-
- * pygobject.h (pyg_boxed_get): add prototypes for a PyGBoxed type
- that will be used for all boxed types in pygtk (well, I can hope
- :)
-
- * gobjectmodule.c (pyg_register_interface): new function to
- register interfaces with. Makes sure I don't accidentally give
- the interface a parent class :). Also adds a __gtype__ class
- attribute similar to GObject classes. May also make interfaces
- subclasses of GInterface at some point.
-
-2001-05-29 James Henstridge <james@daa.com.au>
-
- * codegen/Makefile.am: install the code generator
-
- * gtk/Makefile.am: install the pygtk.h header
-
- * Makefile.am: install the pygobject.h header
-
- * gtk/gdk.defs, gtk/gtk.defs, gtk/gtk-types.c: changes to make
- things compile.
-
-2001-05-28 James Henstridge <james@daa.com.au>
-
- * codegen/codegen.py (write_source): add code to reorder object
- definitions if necessary. To catch ordering problems in .defs
- file.
-
-2001-05-27 James Henstridge <james@daa.com.au>
-
- * codegen/codegen.py (write_source): interfaces don't have
- parents.
-
- * codegen/definitions.py (InterfaceDef.write_defs): don't look for
- (parent ...) sections in interface definitions.
-
- * gtk/gtk.defs (Editable): interfaces don't have parents.
-
-2001-05-07 James Henstridge <james@daa.com.au>
-
- * examples/gobject/signal.py: register new types.
-
-2001-05-06 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pygobject__init__): make the __init__ function
- choose what GType to pass to g_object_new based on the __gtype__
- attribute.
- (pygobject_methods): make __gobject_init__ an alias for
- GObject.__init__.
- (pyg_type_register): new function for registering new GTypes.
- (pyg_type_register): register the type as "module+class" rather
- than "module.class", as the second form is considered bad (would
- like to use the second form though.
-
- * configure.in: require 1.3.5 versions of glib and gtk+.
-
-2001-05-05 James Henstridge <james@daa.com.au>
-
- * codegen/docgen.py (DocbookDocWriter.output_toc): Produce kind of
- nice docbook documentation. Example output available at
- http://www.gnome.org/~james/pygtk-docs/.
-
-2001-05-03 James Henstridge <james@daa.com.au>
-
- * codegen/docgen.py (DocWriter): handle output of constructor and
- method docs. Use overrides file so as not to output info about
- methods we don't actually wrap.
-
- * codegen/Makefile.am (noinst_PYTHON): update file list.
-
- * codegen/__init__.py (__all__): update module list.
-
- * codegen/mergedefs.py: same here.
-
- * codegen/docgen.py (DocWriter.__init__): same here.
-
- * codegen/codegen.py: import defsparser instead.
-
- * codegen/defsparser.py: rename from parser.py.
-
-2001-05-01 James Henstridge <james@daa.com.au>
-
- * autogen.sh: fix up autogen script to call autoheader
-
- * gtk/gtk.defs: remove colorsel palette manipulation functions.
-
-2001-05-01 Matthew Wilson <msw@redhat.com>
-
- * acinclude.m4 (AM_PATH_PYTHON_JH): only run the AC_PATH_PROGS
- check if we don't have a PYTHON environment variable set
-
- * autogen.sh: run autoheader
-
- * acinclude.m4 (AM_PATH_PYTHON_JH): s/AC_PATH_PROG/AC_PATH_PROGS/
- so we check for more than one python interpreter.
-
-2001-04-28 James Henstridge <james@daa.com.au>
-
- * Makefile.am, pygtk/Makefile.am: limit the symbols exported by
- the various modules to just their module init function.
-
- * gtk/Makefile.am (_gtkmodule_la_LDFLAGS): only export the
- init_gtk symbol.
-
- * examples/pygtk-demo/demos/toolbar.py (main): remove buttons that
- called set_space_size method.
-
- * gtk/__init__.py: remove __all__ definition. It causes problems
- with python 2.1.
-
- * gtk/gtk.override: updated GtkColorSelection method overrides
- (ignore): remove gtk_entry_new from ignore list, as other entry
- constructor is gone.
-
- * gtk/gtk.defs: updates to make it work with current gtk+
-
-2001-04-21 James Henstridge <james@daa.com.au>
-
- * codegen/docgen.py, codegen/docextract.py: start of automatic
- documentation generator.
-
-2001-04-08 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override: same here.
-
- * gtk/gtk-types.c (_pygtk_register_boxed_types): more fixups
-
- * gtk/gtkobject-support.c: lots of similar fixups.
-
- * codegen/argtypes.py (_enum_name): gdk type codes now seem to be
- named GDK_TYPE_... and not GTK_TYPE_GDK_...
-
-2001-04-07 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs: lots of defs file updates.
-
-2001-04-06 James Henstridge <james@daa.com.au>
-
- * codegen/h2def.py: add --onlyobjdefs flag to script.
-
-2001-03-30 James Henstridge <james@daa.com.au>
-
- * examples/pygtk-demo/demos/toolbar.py (main): toolbar demo.
-
- * examples/pygtk-demo/demos/buttonbox.py (main): add button box
- demo.
-
- * examples/pygtk-demo: moved rewritten testgtk demo here, and make
- changes to account for renamings in gtk.
-
- * gobjectmodule.c (pygobject_set_property): initialise the GValue
- to { 0, }, so set_property actually works.
- (pygobject_get_property): same here.
-
- * gtk/gtk.defs: updated enum/flag defs.
-
- * gtk/gdk.defs: updated enum/flag defs.
-
- * examples/gobject/signal.py (D.do_my_signal): add small example
- of overriding class closure for a signal introduced from python
- code.
-
- * codegen/h2def.py: add --onlyenums flag to only output enum defs.
-
-2001-03-27 James Henstridge <james@daa.com.au>
-
- * examples/gobject/signal.py: simple example program that adds a
- signal to a class, connects a handler to an instance of that
- class, and finally emits that signal. Messages are printed by
- both the signal handler and class method closure.
-
- * gobjectmodule.c (pyg_signal_class_closure_marshal): convert
- dashes in signal name to underscores. Why does g_siganl_name use
- dashes?
- (pyg_signal_class_closure_marshal): fix off by one error when
- setting up the python argument tuple. The first element was
- getting left uninitialised. Signals introduced in python now
- work.
-
- * gtk/gtk.defs (GtkFileSelection.get_filename): return value is
- const.
-
- * gtk/gtk.override (_wrap_gtk_list_store_set_value): change name.
- (_wrap_gtk_tree_store_insert): change name.
-
- * gtk/gtk.defs (GtkListStore.set_value): change from set_cell to
- set_value.
- (GtkListStore.set_value): same here.
-
- * gobjectmodule.c (pyg_signal_class_closure_get): new function to
- get the closure used as the `class closure' for signals. We only
- need one, as we can get all the information we need from the
- invocation hint.
- (pyg_signal_new): new function to create new signals. Doesn't
- work right yet.
-
-2001-03-26 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pygobject__class_init__): add some comments
- about creating new GTypes here.
-
- * gobjectmodule.c: add type info functions to module.
-
-2001-03-24 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-types.c (pygtk_text_iter_is_end): s/is_last/is_end/
-
- * gobjectmodule.c (pyg_closure_new):
- s/add_fnotify/add_finalize_notifier/
-
- * gtk/gdk.defs, gtk/gtk.defs, gtk/gtk.override: various changes to
- make it compile again.
-
-2001-03-18 James Henstridge <james@daa.com.au>
-
- * gtk/pygtktreemodel.c (pygtk_tree_model_class_init): signals are
- now created in the gtktreemodel.c, so we don't need to.
-
- * gtk/gtk.defs (Adjustment): make parent GtkObject, as GtkData is
- gone.
- (GtkText): remove from binding.
-
- * codegen/codegen.py (write_source): pass in the get_type function
- when registering classes.
- (gettypetmpl): remove template.
- (write_class): remove get_type method generator. Handled by __gtype__
-
- * gobjectmodule.c (initgobject): add argument to g_type_init call.
- (pyg_value_from_pyobject): use G_VALUE_HOLDS_* rather than
- G_IS_VALUE_*.
- (pyg_value_as_pyobject): same here.
- (pygobject_register_class): add an argument that takes the
- get_type function for the GObject. This is used to add a
- __gtype__ attribute to the class (the get_type function is not
- actually called until __gtype__ is accessed).
-
-2001-02-03 James Henstridge <james@daa.com.au>
-
- * gtk/pygtktreemodel.c (*): s/tree_node/user_data/
-
- * gtk/gtk-types.c (pygtk_text_iter_forward_to_line_end): rename
- function.
- (pygtk_tree_iter_compare): fix compare function.
- (pygtk_tree_iter_hash): fix hash function.
-
-2000-12-16 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-types.c (pygtk_text_iter_forward_to_delimiters): rename
- function.
-
-2000-12-14 James Henstridge <james@daa.com.au>
-
- * examples/testgtk/demos/menu.py (main): destroy window on
- button's clicked signal rather than destroy signal.
-
- * gtk/gtk.defs: remove gtk_object_default_construct and
- gtk_object_constructed.
-
- * gobjectmodule.c: change over to new notification functions.
-
- * gtk/gtk-types.c: rename functions.
-
- * gobjectmodule.c (pygobject_get_property):
- (pygobject_set_property): change function names to match changes
- in glib.
- (...connect|emit): use g_signal_parse_name instead of
- g_signal_lookup, so we can parse the detail out of the signal name
- string.
-
-2000-12-07 James Henstridge <james@daa.com.au>
-
- * examples/testgtk/demos/treemodel.py (MyTreeModel.on_get_path):
- fix small typo.
-
-2000-12-06 James Henstridge <james@daa.com.au>
-
- * gtk/pygtktreemodel.c: fix PyObject_CallMethod calls to add
- parentheses around argument type list.
- (pygtk_tree_model_get_flags): decref py_ret -- not Py_None
- (pygtk_tree_model_get_n_columns): same here.
- (pygtk_tree_model_get_column_type): same here.
- (*): conditionally print out debugging messages.
-
- * examples/testgtk/demos/treemodel.py: simple test of
- PyGtkTreeModel.
-
- * gtk/pygtktreemodel.c: set iter->tree_node to NULL when returning
- FALSE, as GTK sometimes ignores the return value :(
-
- * codegen/codegen.py (interfacetypetmpl): don't set the interface
- type as having an instance dictionary.
- (write_interface): actually use interfacetypetmpl when writing out
- the interface type def.
-
- * codegen/argtypes.py (_conv_special_cases): add a special case
- for the underscore version of PyGtkTreeModel.
-
- * gtk/gtk.override: include pygtktreemodel.h
-
- * gtk/__init__.py: don't error out if we can't import ltihooks.
-
- * gtk/gtk-extrafuncs.defs: include defs for PyGtkTreeModel type.
-
- * gtk/Makefile.am (_gtkmodule_la_SOURCES): compile PyGtkTreeModel
- into pygtk.
-
- * gtk/pygtktreemodel.c: fix errors.
-
- * gtk/pygtktreemodel.[ch]: check in initial leaky implementation
- of the GtkTreeModel for use from python. Can't test it right now
- because gtk head is broken.
-
-2000-11-29 James Henstridge <james@daa.com.au>
-
- * configure.in (enable_thread): update checks for glib/gtk+ to
- require at least 1.3.2.
-
- * codegen/h2def.py (write_enum_defs): Havoc's enum handling patch.
-
- * TODO: add todo item about creating real GObject subclasses, and
- add some info on the GInterface stuff.
-
- * examples/testgtk/testgtk.py (load_module): fix bug where
- mod.__file__ is the .pyc file rather than the .py file.
-
- * gtk/gtk.defs: change parent type for some classes to GtkDialog
- to match changes in gtk+.
-
- * gtk/Makefile.am (pysitedir, pyexecdir): fix up directory names.
- It wasn't installing these files in a gtk/ subdirectory :(
-
-2000-11-16 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs: make changes to make GtkEditable into an
- interface.
-
- * examples/testgtk/demos/__init__.py (demos): create the list of
- example modules on the fly, rather than having them hard coded
- into a list.
-
-2000-11-11 James Henstridge <james@daa.com.au>
-
- * examples/testgtk/testgtk.py: start of a revamped testgtk
- example, similar to the new one in gtk.
-
- * gtk/gtk-types.c (PyGdkEvent_New): guard against a NULL axes
- member in the GdkEvent structure.
-
- * gtk/gtk.override (_wrap_gtk_tree_view_get_path_at_pos):
- implementation of this function.
-
- * codegen/argtypes.py (GtkTreePathArg): add an arg matcher for
- GtkTreePath objects, that represents them as tuples of integers.
-
- * gtk/gtk-types.c (_pygtk_register_boxed_types): add marshalers
- for GtkTreeIter and GtkTreePath so they can be used from signal
- handlers now.
-
- * gtk/gtk.override, gtk/gtk.defs: make name change for
- GtkTreeStore constructor.
-
-2000-11-10 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override: ignore the gtk_tree_view_new function, so
- gtk_tree_view_new_with_model gets chosen as the constructor.
- (_wrap_gtk_tree_store_...): fix up the iterator creation methods
- so that they can take NULL arguments.
- (_wrap_gtk_tree_view_column_new): new implementation of this
- constructor. Map keyword arguments to column attributes.
-
- * gtk/gtk.defs (gtk_tree_view_new_with_model, GtkTreeView.set_model):
- Allow NULL to be passed in as the model argument.
-
- * gtk/gtk.override: add gtk_tree_model_get_{iter,path,value}
- functions.
- (_wrap_gtk_list_store_*): add constructor and set_cell
- implementations, and impls of the insertion functions that return
- the new GtkTreeIter, rather than treating it as an out argument.
- (_wrap_gtk_list_store_set_cell): allow string versions of type
- codes for convenience.
- (_wrap_gtk_list_store_insert): directly access column_headers
- structure member as the get_column_type method doesn't exist.
- (_wrap_gtk_tree_store_*): constructor, set_cell and tree iter
- creation methods added. Ignore [gs]et{,v}.
-
-2000-11-09 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.defs (ListStore, TreeStore): these implement the
- GtkTreeModel interface.
- (TreeModel): add interface definition here.
-
- * codegen/codegen.py (register_types): register interfaces into
- the argument type matcher.
- (write_source): write out interface source. Register interface
- class types before object types, as they may be used by objects.
- (write_source): set multiple base classes if an object implements
- an interface.
- (write_interface): function to write out the code for an
- interface. It is really a simplified version of write_class.
-
- * codegen/parser.py (DefsParser.interface): handle interface
- clauses.
-
- * codegen/definitions.py (InterfaceDef): add a class for interface
- definitions.
- (ObjectDef): add support for an implements keyword.
-
- * codegen/codegen.py (write_source): change code generator to pass
- bases in as a tuple rather than a single PyExtensionClass
- structure.
-
- * pygobject.h: change prototype.
-
- * gobjectmodule.c (pygobject_register_class): allow for registerin
- a type with multiple base classes.
-
-2000-11-08 James Henstridge <james@daa.com.au>
-
- * codegen/argtypes.py (_conv_special_cases): add a special case
- for converting GObject -> G_OBJECT.
-
- * gobjectmodule.c (pygobject_connect*): g_signal_connect_closure
- renaming.
-
- * codegen/argtypes.py (arg): add GtkTreeIter support.
-
- * gtk/gtk-types.c, gtk/pygtk.h, gtk/pygtk-private.h: add a
- skeleton for the GtkTreeIter wrapper.
-
-2000-11-04 James Henstridge <james@daa.com.au>
-
- * TODO: todo file with a few items needed for the gtk 2.0 based
- pygtk.
-
- * gtk/gtk.defs: add new GtkTree widget definitions.
- (GtkTreeViewColumn.get_justification): comment out as it doesn't
- exist.
-
-2000-11-02 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-types.c (_pygtk_register_boxed_types): small changes to
- handle GtkTextIter objects as arguments to signals, now that Havoc
- made the appropriate changes in gtk.
-
-2000-10-30 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pyg_closure_marshal): reorder parameters to
- make it work with latest glib.
- (pygobject_connect*): pass 0 for the new detail parameter. Don't
- know what it is for.
- (pygobject_emit): pass 0 for detail parameter.
- (pygobject_stop_emission): pass 0 for detail parameter.
-
- * gtk/gtkmodule.c (init_gtk): init as module gtk._gtk. Using just
- _gtk doesn't seem to work with python 2.0
-
-2000-10-29 James Henstridge <james@james.daa.com.au>
-
- * examples/ide/gtkcons.py: small changes to make example run.
-
- * gtk/gtk-types.c: add GtkTextIter.forward_search implementation.
-
- * gtk/gtk.override: more override functions.
-
- * gtk/gtkobject-support.c: remove some of the unused functions from
- this file.
-
-2000-10-28 James Henstridge <james@james.daa.com.au>
-
- * gtk/gtk.override: override the functions used to initialise
- GtkTextIter objects so that they return the iterator rather than
- setting up an static GtkTextIter structure.
-
- * gtk/gtk.defs (TextMark): add missing GtkTextMark object. Don't
- know why h2defs missed it.
- ("gtk-extrafuncs.defs"): include gtk-extrafuncs.defs.
-
- * codegen/argtypes.py: add GdkDevice and GtkTextIter to list of
- recognised boxed types.
-
- * gtk/gtk-types.c: add skeleton implementation of GtkTextIter.
-
- * gtk/pygtk.h, gtk/pygtk-private.h: add prototypes for GtkTextIter
- wrapper.
-
- * gtk/gtk.override: ref and sink GtkObjects which have their
- constructors listed in the overrides file. This should get rid of
- the last few warnings on exit related to reference counting.
-
- * codegen/codegen.py: use the keyword module to check for method
- and argument names that conflict with the python keywords. By
- using this module, we shouldn't have problems with new keywords in
- future versions of python.
-
-2000-10-27 James Henstridge <james@james.daa.com.au>
-
- * gobjectmodule.c (pygobject_emit): support for emiting signals on
- GObjects from python.
-
- * codegen/codegen.py (write_constructor): sink GtkObjects. This
- prevents us losing our reference to the object if it is sunk.
-
- * codegen/argtypes.py (ArgMatcher.object_is_a): function to check
- if one object type is another type.
-
- * codegen/codegen.py (register_types): pass the parent type when
- registering a new GObject type.
-
- * gtk/gtk-types.c (_pygtk_register_boxed_types): register
- marshalers for the various boxed types, so that they work as
- expected inside the signal handlers.
-
- * gobjectmodule.c (pygobject_repr): small change to match style of
- other repr functions in python.
-
- * gtk/gtkmodule.c (init_gtk): only call g_thread_init() if pygtk
- threading support is enabled.
-
- * configure.in (enable_thread): add configure checks so that
- threading support can be disabled even if python was compiled with
- it. It defaults to off for now because GSignal has some mutex
- deadlocks at the moment.
-
-2000-10-26 James Henstridge <james@daa.com.au>
-
- * gtk/gtkmodule.c (init_gtk): remove gtk_signal_set_funcs call.
-
- * gobjectmodule.c (pyg_value_from_pyobject): default to using
- CObject for unknown boxed values and pointer values.
- (pyg_value_as_pyobject): same here.
- (pygobject_connect*): Add signal connection functions.
-
- * gobjectmodule.c (pyg_boxed_register): new function for
- registering functions to marshal boxed GValues to/from their
- python wrappers.
- (pyg_value_from_pyobject): add boxed support.
- (pyg_value_as_pyobject): add boxed support.
- (pyg_closure_new): new function to create a python GClosure.
- (pyg_closure_destroy): cleanup function for a PyGClosure.
- (pyg_closure_marshal): marshaler for PyGClosure.
- (pyg_value_as_pyobject): add const to GValue argument.
-
- * pygobject.h: export a pyg_boxed_register function to register
- new boxed types for use with pyg_value_from_pyobject and
- pyg_value_as_pyobject.
-
-2000-10-25 James Henstridge <james@daa.com.au>
-
- * gtk/gtkmodule.c (init_gtk): set the default python character
- encoding to UTF-8.
-
- * gtk/gtk.defs: more setting constructors and default arguments.
-
- * gtk/gtk.defs: more updates.
-
- * gobjectmodule.c (pygobject_getattro): return NULL on error.
- This fixes the segfault :)
-
- * gtk/gtk.defs (Bin): add a field just to test pygobject_getattro.
- It isn't working quite properly at the moment though :(
-
- * gobjectmodule.c (check_bases): class->bases is a tuple -- not a
- list.
- (check_bases): check if class->bases != NULL before using it :(
-
- * gtk/gtk.defs: comment out new tree widget stuff at hp and owen's
- suggestion.
-
- * gtk/__init__.py: import gobject here as well to prevent weirdness.
-
- * gtk/gtk.defs: more updates, adding (is-constructor-of ...) and
- (default "...") clauses.
-
- * gtk/gtk.override (_wrap_gtk_button_new): handle the accel_group
- argument, and try to create a stock button if possible.
-
- * gtk/gtk.defs, gtk/gdk.defs: various small fixes.
-
- * gtk/gtk.override: fix lots of overrides to work with gtk 2.0
-
-2000-10-24 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.defs: remove unneeded gdk_input_* functions.
-
- * gtk/gtk.override: small updates.
-
- * gtk/gtk.defs: update with defs from all of gtk.
-
- * codegen/h2def.py (find_enum_defs): small fix to enums parsing.
-
- * gtk/gtk-types.c: add support for GdkDevice and convert function
- names to lowercase.
-
- * gtk/gtkmodule.c: add GdkDevice stuff to PyGtk_API.
-
- * gtk/pygtk.h, gtk/pygtk-private.h: add GdkDevice to list of boxed
- types.
-
-2000-10-23 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c: don't set the getattr method on objects if it
- isn't already set. Also, install a getattro handler that will
- perform the usual method/attribute lookup and then call the
- getattr method for all base classes to allow specifying of class
- specific attributes
-
-2000-07-03 James Henstridge <james@daa.com.au>
-
- * gtk/gtkmodule.c (init_gtk): actually initialise the gobject stuff
- for gtk._gtk.
-
- * pygobject.h (pygobject_check): call the correct ExtensionClass
- check macro.
- (init_pygobject): small fixup here.
-
- * codegen/codegen.py (noconstructor): handle the null constructor
- better.
- (consttmpl): use pygobject_register_wrapper.
- (getattrtmpl): make the getattr function raise an exception on
- unhandled attributes. I will use a tp_getattro function to bind
- all the getattr functions of base classes together.
-
- * gtk/gtk-types.c (_pygtk_register_boxed_types): commented out the
- object implementations for types that have been converted to
- GObjects.
-
- * gtk/gtkobject-support.c: commented out some of this code to get
- it to compile again. Also converted some functions over to GObject.
-
- * codegen/argtypes.py (EnumArg,FlagsArg): use the version from gobject.
-
- * gtk/gtkmodule.c: update
-
- * gtk/gtk.override: fix up the overrides for the new gdk.defs stuff.
- (GTK_TYPE_GDK_*): add some dummy defines to make things compile until
- the gdk-pixbuf enums are added to
-
- * codegen/argtypes.py (ObjectArg.write_param): use PyGObject
- rather than PyGtk_Object.
-
- * pygobject.h (pygobject_check): add check function. Just a wrapper
- around ExtensionClassSubclassInstance.
-
- * codegen/codegen.py: updated to use PyGObject rather than
- PyGtk_Object.
-
- * gtk/gtk.defs: removed most of the stuff here so I can test out
- the gdk stuff.
-
- * gtk/gdk.defs: updated to gdk-1.3. A lot of stuff in here.
-
- * codegen/h2def.py (verbose): remove the special case for GtkObject.
- (find_obj_defs): amend regexes so that GObject is considered a valid
- object name.
-
-2000-06-29 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c: use pygobject.h.
- (pygobject_[gs]et_param): free the GValue afterwards so as not to
- leak memory.
-
- * pygobject.h: header for modules that want to use GObject.
-
-2000-06-28 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c: add get_data / set_data methods.
- Add get_param / set_param methods.
- (pygobject__init__): simple init function for GObjects. Doesn't
- handle params yet.
- (pygobject_register_wrapper): don't ref the GObject -- it isn't like
- GtkObjects where we ref/sink them.
- (pygobject_queue_param_changed): add queue_param_changed method.
-
-2000-06-27 James Henstridge <james@daa.com.au>
-
- * gobjectmodule.c (pygobject_dealloc): start of gobject wrapper.
-
-2000-06-19 Frederic Gobry <frederic.gobry@epfl.ch>
-
- * gdkimlibmodule.c: do an actual call to create_from_array instead
- of create_from_data, and fixed broken test on alpha channel
-
-2000-04-15 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c: move gtk_set_locale here, and set LC_NUMERIC back to
- "C" after call. Python's numeric locale should be fixed on C.
-
-2000-04-07 James Henstridge <james@daa.com.au>
-
- * NEWS: added news items.
-
- * pygtk.spec, configure.in: updated version number.
-
- * configure.in (enable_numpy): added --disable-numpy argument that
- disables numeric python support even if numpy is found.
-
- * gtkmodule.c (PyGdkWindow_{Pointer,Keyboard}{Grab,Ungrab}): new
- GdkWindow methods.
-
- * gtk.py (rc_reparse_all): fix spelling mistake.
- (GtkTreeItem.__getattr__): fix bug reported by Aaron Digulla.
-
- * generate/gtklists.defs (gtk_clist_get_selectable): fix bug in
- return type.
-
-2000-04-06 James Henstridge <james@daa.com.au>
-
- * (lots of files): switch over to using libtool and automake-1.4a.
-
-2000-03-13 James Henstridge <james@daa.com.au>
-
- * pyglade/__init__.py: remove python-1.4 ni stuff, and put in a
- warning message that you should think of switching over to libglade.
-
- * pygtk.spec: incremented version number. Code gtk+ dependency into
- spec file. Made auxillary packages depend on the pygtk package of
- the same version.
-
- * configure.in: incremented version number. Incremented minimum
- required GTK+ so that when threading is compiled in we don't get
- problems caused by using old buggy versions of GTK+.
-
- * gtkmodule.c (PyGdkWindow_PropertyChange): fixed the 32 bit data
- part of the case statement correctly this time :)
-
-2000-03-08 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c (PyGdkWindow_PropertyChange): fixed up problem in
- property_change method that could cause a crash if data of
- size 16 or 32 was set.
- (PyGtkStyleHelper_SetItem): added missing return that could cause
- a fallthrough to the g_assert_not_reached() call when setting a
- bg_pixmap element on a GtkStyle.
-
-2000-03-03 James Henstridge <james@daa.com.au>
-
- The following is from Paul Clifford <paul@plasma.demon.co.uk>
-
- * libglade.py (GladeXML.signal_autoconnect): pass all the extra
- arguments to autoconnect.
-
- * libglademodule.c (connect_many): don't exit if the handler is
- a tuple instead of a function.
-
- The following fixes are from John Ehresman <jpe@archaeopteryx.com>
-
- * gtk.py (GtkWidget.set_scroll_adjustments): return the value to
- user.
-
- * gtkmodule.c (GtkArg_AsPyObject): check if GtkObject is not NULL.
- (_wrap_gtk_clist_get_pixmap, _gtk_clist_get_pixtext): check that
- returned pixmap is not NULL.
- (_wrap_gtk_ctree_node_get_pixmap, _gtk_ctree_node_get_pixtext): check
- that returned pixmap is not NULL.
-
- * gtk.py (GtkToolbar): wrap callbacks when inserting a toolbar item.
- (GtkNotebook.set_menu_label_text): fixed typo
- (GtkTreeItem.__getattr__): wrap subtree attribute.
-
-2000-03-01 Frederic Gobry <gobry@lith.di.epfl.ch>
-
- * gtkmodule.c (PyGtkSelectionData_GetAttr): added .length field,
- so that it is possible to check for invalid selection during
- copy/paste.
-
-2000-02-23 Frederic Gobry <gobry@lith.di.epfl.ch>
-
- * gtkmodule (GtkRet_FromPyObject): added missing break in switch.
-
-2000-02-21 James Henstridge <james@daa.com.au>
-
- * gtk.py (GtkTable.resize): added missing function. Patch from
- wrobell <wrobell@posexperts.com.pl>.
-
- * generate/gtkcontainers.defs (gtk_table_resize): added missing
- function.
-
-2000-02-20 James Henstridge <james@daa.com.au>
-
- * gtk.py (GtkCList.get_[hv]adjustment): apply fix from Martin
- Preishuber.
-
-2000-02-16 James Henstridge <james@daa.com.au>
-
- * configure.in, pygtk.spec: updated version to 0.6.4
-
-2000-01-27 Elliot Lee <sopwith@redhat.com>
- * gtk.py: s/sel/self/ in GtkSpinButton.get_adjustment()
-
-2000-01-26 James Henstridge <james@daa.com.au>
-
- * gtk.py (GtkObject.__hash__): use C level GtkObject for hash
- function.
- (GtkAccelGroup.__cmp__): use C level object for comparisons.
- (GtkAccelGroup.__hash__): use C level object for hashing.
-
- * gtkmodule.c: added hash functions for many object types.
-
-2000-01-25 Kelly Lynn Martin <kelly@poverty.bloomington.in.us>
-
- * gtk.py (gdk_beep): new wrapper
- * gtkmodule.c (_wrap_gdk_beep): new implementation
-
-2000-01-21 Matt Wilson <msw@redhat.com>
-
- * generate/generate.py: add a hack to allow a null-ok flag on the
- return type. This lets us create wrappers which return None if
- the C function returns NULL.
-
- * generate/gtklists.defs (gtk_ctree_node_nth): return None when
- gtk_ctree_node_nth returns NULL.
-
-2000-01-20 Matt Wilson <msw@redhat.com>
-
- * gtkmodule.c (PyGtk_New): disable object sinking for now, until
- we rework the .def file and generation routines to know which
- functions are creators.
-
-2000-01-20 Matt Wilson <msw@redhat.com>
-
- * gtk.py (GtkCList.row_move): s/soure_row/source_row/g typo
-
-2000-01-17 Matt Wilson <msw@redhat.com>
-
- * gtkmodule.c: following changes from ChiDeok Hwang
- <cdhwang@sr.hei.co.kr>
-
- * gtkmodule.c (_wrap_gtk_adjustment_set_all): parse the 6 optional
- arguments.
-
- * gtkmodule.c (_wrap_gtk_widget_draw,
- _wrap_gtk_widget_size_allocate, _wrap_gtk_widget_intersect,
- _wrap_gdk_color_alloc): fix PyArg_ParseTuple format strings to use
- shorts instead of ints where necessary.
-
- * gtkmodule.c (_wrap_gtk_toolbar_insert_item): check to make sure
- callback isn't Py_None before Py_INCREF()
-
- * gtkmodule.c (_wrap_gtk_toolbar_insert_item,
- _wrap_gtk_toolbar_append_item, _wrap_gtk_toolbar_prepend_item):
- fix broken ParseTuple specification strings.
-
- * gtkmodule.c (_wrap_gtk_clist_get_selection): use
- GPOINTER_TO_UINT to get row.
-
-2000-01-17 Matt Wilson <msw@redhat.com>
-
- * libglademodule.c (connect_one, _wrap_glade_xml_signal_connect):
- don't INCREF objects passed into Py_BuildValue as they are
- INCREF'ed for you automatically. Pass new PyObjects in with 'N'
- to consume the reference.
-
- * gtkmodule.c (PyGtk_New): sink the object upon creation. We
- don't want floating GtkObjects.
-
- * gtkmodule.c: general cleanups, testing for success of PyObject
- creation, reference count fixes. Several functions used
- Py_BuildValue with 'O' format strings. This increfs the object
- passed into the tuple where. When using Py*New in Py_BuildValue,
- use 'N' in the format string to consume the reference of the new
- object.
-
-2000-01-05 Matt Wilson <msw@redhat.com>
-
- * gdkimlibmodule.c, gtkglmodule.c, gtkmodule.c: Patch from ChiDeok
- Hwang <cdhwang@sr.hei.co.kr> to decref PyObjects retrieved by
- PySequence_GetItem.
-
-1999-12-18 Matt Wilson <msw@redhat.com>
-
- * gtkmodule.c (_wrap_gtk_clist_get_rows): removed function
-
- * generate/gtklists.defs (GtkCList): add field for rows
-
-1999-12-16 Matt Wilson <msw@redhat.com>
-
- * gtk.py (GtkCList.__getattr__): oops - left out the _gtk. part
-
-1999-12-15 Matt Wilson <msw@redhat.com>
-
- * gtk.py (GdkColor): added a function to create a GdkColor
- object. You should use this if you don't want to allocate a color
- before passing it into functions that don't need an allocated
- color.
-
- * gtkmodule.c (_wrap_gdk_color_new, PyGdkColor_GetAttr): add a
- functions to create and modify a GdkColor object.
-
-1999-12-15 Matt Wilson <msw@redhat.com>
-
- * gtk.py (GtkCList.__getattr__): added 'rows' attribute.
-
- * gtkmodule.c (_wrap_gtk_clist_get_rows): added wrapper to get
- number of rows in a clist
-
- * gtkmodule.c (PyGtkStyle_New): If the GtkStyle passed in is NULL,
- return a None object. This is a bit of a hack, but without it
- you'll fail NULL assertions when you attach to the style_set
- signal.
-
- * generate/gtkmisc.defs (gtk_pixmap_new): mask is null-ok.
-
- * generate/gtklists.defs (gtk_clist_set_pixmap): likewise.
-
- * pygtk.h (PyGdkBitmap_Check): define PyGdkBitmap_Check to be the
- same as PyGdkWindow_Check.
-
- * gtkmodule.c: -Wall cleanups
-
- * libglademodule.c (init_libglade): removed unused variable
-
- * gdkimlibmodule.c (_wrap_gdk_imlib_init): s/static/static int/
-
-1999-12-12 Matt Wilson <msw@redhat.com>
-
- * generate/generate.py (FunctionDefsParser.define_func): added new
- string_or_null type to check for NULL when passing strings back
-
-1999-09-30 James Henstridge <james@daa.com.au>
-
- * pygtk.spec: updated spec file.
-
- * NEWS: added news items
-
- * configure.in: updated version number.
-
- * libglademodule.c: don't segfault when a widget name does not exist.
-
-1999-09-28 James Henstridge <james@daa.com.au>
-
- * libglade.py: enable gnome functionality if it is available.
-
- * gtk.py (GtkEditable.__getattr__): added accessors to GtkEditable.
-
- * generate/gtkedit.defs (GtkEditable): added accessors for some
- fields of the GtkEditable.
-
- * gtkmodule.c: added _raise, lower and input_get_pointer methods to
- the GdkWindow wrapper.
-
- * gtk.py (GtkAspectFrame.__init__): fixed prototype for GtkAspectFrame
-
-1999-08-25 Matt Wilson <msw@redhat.com>
-
- * gtkmodule.c (_wrap_gdk_char_width): added wrapper for gdk_char_width
- * gtk.py (gdk_char_width): added wrapper for gdk_char_width
-
-1999-08-09 James Henstridge <james@daa.com.au>
-
- * pygtk.spec: updated spec file, and added subpackages pygtk-glarea
- and pygtk-libglade. Also incremented version number.
-
-1999-08-08 James Henstridge <james@daa.com.au>
-
- * NEWS: updated news file.
-
- * configure.in: increased version number to 0.6.2.
-
- * gdkimlibmodule.c (_wrap_gdk_imlib_image_get_array): make sure that
- the image data is not freed while the returned array is in use, so
- that we don't get into an inconsistent state.
-
- * gtk.py: added gdkrgb functions to this file.
-
- * gtkmodule.c: added the gdkrgb functions for drawing rgb and greyscale
- images.
- (gdk_draw_array): a new function that will draw a numpy array to a
- drawable with gdkrgb. It is written so that it can handle slicing
- on the first two axes -- it does not handle non contiguous data on
- the third axis.
-
-1999-08-04 Matt Wilson <msw@redhat.com>
-
- * GdkImlib.py (create_image_from_xpm): new wrapper for creating
- imlib images from xpm data
-
- * gdkimlibmodule.c (_wrap_gdk_imlib_create_image_from_xpm): New
- wrapper
-
-1999-08-03 James Henstridge <james@daa.com.au>
-
- * description.py (GdkWindow): added descriptions of the new routines.
-
- * gtkmodule.c (GdkWindow.property_{get,change,delete}): new functions
- for manipulating the properties on a window.
-
- * gtk.py (_window_foreign_new, _root_window): added wrappers for
- the new functions.
-
- * gtkmodule.c: added xid attribute to GdkWindow's, and added functions
- gdk_window_foreign_new and gdk_get_root_win. The second function is
- simply a wrapper that returns a GdkWindow for the root window.
-
-1999-08-02 James Henstridge <james@daa.com.au>
-
- * libglade.py: new file that wraps the _libglade module.
-
- * libglademodule.c: handle connecting to another object correctly.
-
- * gtkmodule.c: added support for passing an object for
- gtk_signal_connect_object type behaviour.
- (_wrap_gtk_signal_connect_object)
- (_wrap_gtk_signal_connect_object_after): new wrappers.
-
- * gtk.py (idle_add, timeout_add, quit_add): pass extra arguments to
- the callback.
-
- * libglademodule.c (_wrap_glade_xml_signal_connect): fixed a small
- problem with reference counting here.
-
- * gtkmodule.c: added support for passing arguments to timeout, quit
- and idle functions.
-
-1999-08-01 James Henstridge <james@daa.com.au>
-
- * pyglade/build.py (optionmenu_new): a small fix from David Cole.
-
- * configure.in: added tests to see if libglade is installed.
-
- * libglademodule.c: the rest of the libglade module
-
- * generate/libglade.defs: a .defs file for libglade.
-
-1999-07-31 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c: put in Paul Fisher's enhancements to the threading
- code. It should now work better with multiple threads calling
- GTK+ routines (remember to use threads_enter/threads_leave), and
- doesn't reintroduce the global interpreter lock problems that
- Duncan's original code worked around.
-
- * configure.in: added a check for the numpy header.
-
- * GdkImlib.py: added wrappers for the numpy routines.
-
- * gdkimlibmodule.c: added Travis Oliphant's Numeric python stuff to
- the imlib module.
-
-1999-07-20 Matt Wilson <msw@redhat.com>
-
- * gtk.py (gdk_flush): new wrapper
- * gtkmodule.c (_wrap_gdk_flush): new implementation
-
-1999-07-19 James Henstridge <james@daa.com.au>
-
- * gtk.py (GtkAdjustment.set_all): a wrapper for the new function.
-
- * gtkmodule.c (_wrap_gtk_adjustment_set_all): simple wrapper for
- setting values on an adjustment.
-
- * gtk.py (GtkCList.get_column_width): a wrapper for this new function.
-
- * gtkmodule.c (_wrap_gtk_clist_get_column_width): a function to get
- the column width for a column in a clist.
-
- * gtk.py (_filtprops): convert GtkAccelGroup and GdkImlibImage types
- back to the C equivalents. This makes adding GnomeCanvasImage items
- to the GnomeCanvas easier.
- (GtkCTree.node_get_selectable): added wrapper function.
-
-1999-07-18 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c (_wrap_gdk_threads_enter): don't use PyGTK_BLOCK_THREADS,
- since it should only be called outside the gtk main loop. Instead
- use Py_BEGIN_ALLOW_THREADS.
-
- * examples/gl/*: new examples of use of gtkgl.
-
- * gtkgl.py: renamed from GtkGL.py.
-
- * gtkglmodule.c (_wrap_gtk_gl_area_new, _wrap_gtk_gl_area_share_new):
- fixed small typo.
-
- * GtkGL.py: added constants.
-
-1999-07-15 James Henstridge <james@daa.com.au>
-
- * configure.in, Makefile.am: added tests for gtkglarea.
-
- * GtkGL.py: python wrapper for the GtkGLArea widget, and a few extra
- functions for use with the widget.
-
- * generate/gtkgl.defs, gtkglmodule.c: added wrapper for gtkglarea.
-
-1999-07-14 James Henstridge <james@daa.com.au>
-
- * gdkimlibmodule.c: modified to use the pygdkimlib.h header.
-
- * pygdkimlib.h: new file similar to pygtk.h, but for _gdkimlib module.
-
- * gdkimlibmodule.c: modified to use the pygtk.h header.
-
- * gtkmodule.c: modified file to use the pygtk.h header, and set
- up the _gtk._PyGtk_API object correctly.
-
- * pygtk.h: a new file with a similar use to the arrayobject.h in
- numeric python. I will convert over to using this in pygtk and
- gnome-python.
-
-1999-07-13 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c (_wrap_gdk_threads_enter): unblock threads when waiting
- for the GDK lock. This allows other threads to unlock it, and should
- prevent some deadlocks.
-
- * gtkmodule.c (gtk_main_iteration, gtk_events_pending): removed code
- to unlock gtk thread -- Owen fixed this properly in gtk.
-
-1999-07-12 James Henstridge <james@daa.com.au>
-
- * gtk.py: fixed a few bugs reported by Ville Lauriki.
-
- * generate/gtkmenus.defs (gtk_item_factory_add_foreign): fix a typo.
-
- * gtkmodule.c: fixed problems if gdk_atom_name returns NULL.
-
- (_wrap_gtk_main_iteration, _wrap_gtk_events_pending): added
- GDK_THREADS_LEAVE() and GDK_THREADS_ENTER() calls round these
- functions. Without this, it deadlocks if threads are enabled.
-
- * generate/gtklists.defs (GtkTreeItem): added wrapper for
- treeitem->subtree attribute.
-
- * pyglade/build.py (text_new): small fix.
-
-1999-05-19 James Henstridge <james@daa.com.au>
-
- * NEWS: added news about changes in this version.
-
- * configure.in, pygtk.spec: updated version number to 0.6.1.
-
-1999-05-13 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c (PyGtk_item_factory_cb): forgot to wrap the function
- call in PyGTK_{,UN}BLOCK_THREADS -- this was causing seg faults
- for people with threading built into their python.
- (PyGtk_MenuPosition): similar fix.
-
-1999-04-25 James Henstridge <james@daa.com.au>
-
- * gtk.py (GtkWidget.get_allocation): a wrapper for the new function.
-
- * gtkmodule.c: added a routine for getting the allocation of a widget.
-
-1999-04-22 James Henstridge <james@daa.com.au>
-
- * NEWS: added a summary of the new features.
-
- * pygtk.spec: upped version number.
-
- * configure.in: upped version number to 0.6.0. I think thread support
- is a big enough feature to bump it up to 0.6.
-
-1999-04-21 James Henstridge <james@daa.com.au>
-
- * gtk.py (create_bitmap_from_data): added new wrapper.
-
- * gtkmodule.c: added gdk_bitmap_create_from_data function. Also
- export PyGtk_BlockThreads and PyGtk_UnblockThreads through the
- _private dictionary, so they can be used from within other modules
- (gnome-python in particular).
-
-1999-04-20 James Henstridge <james@daa.com.au>
-
- * pygtk.spec: updated package version number.
-
- * configure.in: added a check for the python thread module. If it
- is found, then also link _gtkmodule to the gthread library.
- Incremented minimum GTK version to 1.2.1.
- Incremented version to 0.5.13.
-
- * gtkmodule.c: call g_thread_init if python was built with thread
- support. This is required to turn thread support on inside gdk/gtk.
-
- * gtk.py: added new functions.
- (GtkList.insert_items): this function wasn't looking at the internal
- GtkObject for the children to insert, so would fail.
-
- * generate/gtkbase.defs (gtk_widget_accelerators_locked): new func.
-
- * generate/gtkmenus.defs (gtk_item_factory_add_foreign): new func.
- (gtk_menu_get_accel_group): new func.
- (gtk_menu_reorder_child): new func.
- (gtk_menu_shell_deselect): new func.
-
- * gtkmodule.c (_wrap_gtk_combo_set_popdown_strings): accept any
- sequence for the second argument, rather than just lists.
- (_wrap_gtk_init): check the return value, and throw an exception
- when a connection to the X server could not be made, rather than
- exiting.
-
- * gtk.py: got rid of some warnings when pygtk is imported when
- DISPLAY is not set. Not completely necessary, but it doesn't hurt.
- (GtkObject.remove_data) fixed small bug pointed out by Duncan Grisby.
-
-1999-04-08 James Henstridge <james@daa.com.au>
-
- * gtk.py (threads_enter,threads_leave): export these two new functions.
-
- * gtkmodule.c: applied a modified version of Duncan Grisby's threading
- patch. The changes were mainly inlining some of the code with macros
- and making it so that the extra code was not added unless python
- was compiled with thread support. Also added wrappers for
- gdk_thread_enter and gdk_thread_leave.
-
- * gtk.py (GtkList.{,un}select_item): fixed small bug reported by
- Ben Darnell.
-
- * gtkmodule.c: fixed some small bugs in gtk_ctree stuff. Thanks go
- to Chi-Deok Hwang. Also fixed the bug in gtk_clist where I copy
- and pasted from.
-
- * gtk.py (GtkNotebook.set_tab_label_text): Small typo. Fix from
- Toby D. Reeves.
-
-1999-03-13 James Henstridge <james@daa.com.au>
-
- * examples/testgtk/testgtk.py: Applied some fixes from Chi-Deok Hwang
- to this example. Mainly clean ups needed because of me not changing
- testgtk with the rest of pygtk.
-
-1999-03-12 James Henstridge <james@daa.com.au>
-
- * configure.in, pygtk.spec: increased version number to 0.5.12.
-
- * gtkmodule.c: added optional support for not catching exceptions in
- callbacks. This way it should be a lot easier to debug a pygtk
- program with pdb.
-
- * gtkmodule.c, gtk.py: a few fixes for problems sent in by
- Chi-Deok Hwang. This includes a fix to GtkWidget.event(),
- assignments to GtkStyle attributes throwing exceptions,
- font loading getting reference counting correct and throwing
- exceptions for bad font names and allowing None to be passed
- as a colour to GnomeCanvasItem.set() (the fix is in pygtk).
-
- * generate/gtklists.defs (gtk_ctree_new): I had missed this
- function in previous releases.
-
-1999-02-24 James Henstridge <james@daa.com.au>
-
- * gtk.py: made changes to match those in the defs files and _gtk.
-
- * description.py (GdkGC.set_dashes): describe new GdkGC method.
-
- * generate/gtkcontainers.defs: removed gtk_window_set{focus,default},
- since these are internal to GtkWindow. Also added
- gtk_handle_box_set_handle_position and gtk_handle_box_set_snap_edge.
-
- * gtkmodule.c: added gtk_widget_get_child_requisition.
- (PyGdkGC_GetAttr): added method GdkGC.set_dashes to set the dash
- pattern for this GC.
-
-1999-02-23 James Henstridge <james@daa.com.au>
-
- * pyglade/build.py: added some code to get the option menu creation
- code working.
-
- * pyglade/xmlparse.py: check if xmllib is included in the standard
- python library, use it for the XML parser -- it is much more complete,
- and doesn't barf on some valid XML files like the old one does. If
- xmllib is not found, the old parser is used.
-
- * README, Makefile.am, pygtk.spec: added references to the MAPPING
- file.
-
- * MAPPING: new file describing the mapping of GTK+ onto python as
- pygtk does it.
-
-1999-02-22 James Henstridge <james@daa.com.au>
-
- * description.py (GdkCursor): added information about this type.
-
- * gtk.py: commented out the __getattr__, __setattr__ and __delattr__
- methods of GtkObject. There were too many things that broke because
- of these changes. If I can get these to work correctly in the
- future, I will consider re-enabling it, but not till then.
-
- * examples/testgtk/testgtk.py (create_cursor_test): added a cursor
- test to the python testgtk. It is adapted from the translation sent
- in by Osamu Tanimoto.
-
- * gtkmodule.c: fixed a bit of bad copy'n'paste in the GC part of the
- style wrapper code. Thanks go to Osamu Tanimoto <tanimoto@rios.co.jp>.
- (PyGdkCursor_GetAttr): now GdkCursor objects have a type attribute
- that returns the type number for the object, and a name attribute
- that gives a string representation of that type number.
-
-1999-02-20 James Henstridge <james@daa.com.au>
-
- * gtk.py (GtkTooltips.set_tip): made tip_private argument optional.
- (GtkObject.__[gs]etattr__, GtkObject.__delattr__): added some more
- fixes to this code so that it shouldn't throw exceptions as much
- when it shouldn't.
-
- * gtkmodule.c: PyGdkEvent_New wasn't interpreting GDK_BUTTON_RELEASE
- events correctly. Also some fix ups for gtk_menu_popup.
-
- * generate/gtkcontainers.defs (gtk_container_set_focus_child): allow
- null child argument.
-
-1999-02-19 James Henstridge <james@daa.com.au>
-
- * gtk.py: added __getattr__ and __setattr__ methods to GtkObject so
- that you can set data on a GtkObject directly in a persistent way
- (reference counting problems prevent pygtk from always passing the
- same python object to a callback). These functions ignore attributes
- starting with an underscore.
- Also modified all the other __getattr__ methods to call their
- parent class's __getattr__ method when they fail instead of
- raising an exception.
-
- * gtk.py: some changes to make use of the new null-ok flags.
-
- * generate/*.defs: added some null-ok tags where appropriate.
-
- * gtkmodule.c: removed gtk_frame_new, as the null-ok change in
- generate.py makes it unnecessary. Also gtk_spin_button_new_no_adj
- has been removed because it is no longer necessary.
-
- * generate/generate.py (FunctionDefsParser.define_func): altered the
- code generation routines so that they recognise the (null-ok) tag in
- the .defs file. This should give a lot more flexibility to the
- generator, and allow me to move some of the special case code in
- gtkmodule.c back to the .defs files. The null-ok tag is currently
- only recognised for string, object and boxed type arguments.
-
- * gtkmodule.c: fixes to the gtk_window_set_geometry_hints function to
- throw an exception for bad aspect values. Also let it understand
- integers for aspect values.
- Also fixed up gtk_menu_popup so that you could give None for a few
- more arguments.
-
-1999-02-16 James Henstridge <james@daa.com.au>
-
- * description.py: added documentation about GtkStyle changes to this
- pseudo module.
-
- * gtkmodule.c: added a new python type GtkStyleHelper that is used
- by python GtkStyle objects as a sequence type that alows us to write
- back to the arrays in the GtkStyle object. I have also made it
- possible to update the font and (black|white){,_gc}. I also added
- a GtkStyle.copy() method. This gives the user everything they need
- to alter styles inside their applications. I still believe that
- rc files are better, but there seem to be a lot of people who want
- this functionality.
-
- * gtkmodule.c (_wrap_gtk_window_set_geometry_hints): made changes so
- apect ratios can be set to integers. Also made it throw an exception
- for aspect ratios of zero, since this caused my X server to crash
- a few times.
-
-1999-02-15 James Henstridge <james@daa.com.au>
-
- * gtk.py (GtkPaned.set_position): added function.
-
- * generate/gtkcontainers.defs (gtk_paned_set_position): added new
- function
-
-1999-02-14 James Henstridge <james@daa.com.au>
-
- * gtk.py: added GtkWindow.set_geometry_hints to match below addition.
-
- * gtkmodule.c: added gtk_window_set_geometry_hints.
-
-1999-02-08 James Henstridge <james@daa.com.au>
-
- * description.py (GdkWindow.depth): documented presence of this
- attribute.
-
- * gtk.py (GtkFileSelection.complete): I had left out the argument in
- this prototype. Fixed now.
-
-1999-02-04 James Henstridge <james@daa.com.au>
-
- * gtk.py (create_pixmap_from_xpm,create_pixmap_from_xpm_d): altered
- these functions to use the gdk_pixmap_colormap_create variants if
- the first argument is a GtkWidget or GtkStyle. This means you
- don't have to realise the widget before creating pixmaps from it.
- (GtkCheckMenuItem.set_state, GtkToggleButton.set_state): removed
- these compatibility routines so they don't mask GtkWidget.set_state.
-
- * gtkmodule.c: moved gtk_item_factory_get_widget here so I can catch
- NULL returns and convert them to None returns. Also added the
- depth attribute to GdkWindow objects.
- Also added gdk_pixmap_colormap_create_* variants. These can be used
- if you only have a colormap reference, rather than a window.
-
- * GtkExtra.py: there were a couple of calls to
- GtkContainer.border_width which is deprecated.
-
- * examples/testgtk/testgtk.py: fixes to dnd code in this example. I
- hadn't looked at it since Owen made the dnd changes.
-
- * examples/simple/tooltip2.py: fixed small bug pointed out by Markus
- Oberhumer.
-
- * pyglade/build.py (clist_new): fixes to make it parse after clist
- changes.
-
-1999-02-02 James Henstridge <james@daa.com.au>
-
- * generate/gtklists.defs, gtk.py: added GtkCList.focus_row.
-
- * _gdkimlibmodule.c, GdkImlib.py: added push_visual and pop_visual,
- that can be used to easily set GTK to use the imlib visual/colormap
- combination.
-
- * gtkmodule.c: the PyObject -> GtkArg conversion routines were not
- catching some exceptions that they generated. This would cause
- wierd problems if you passed the wrong argument types to signal
- handlers. This was found by Chi-Deok Hwang <cdhwang@sr.hei.co.kr>
-
- * examples/simple/dnd.py, examples/simple/dndpixmaps.py: and example
- of drag and drop contributed by Chi-Deok Hwang <cdhwang@sr.hei.co.kr>
-
- * gtkmodule.c: added gtk_ctree_get_selection, that returns nodes
- rather than pointers.
-
- * gtk.py: made changes to reflect those below. Also added
- GtkWidget.get_colormap() (it was missing previously).
-
- * generate/gtkedit.defs (gtk_spin_button_update): added function.
-
- * generate/gtkmenus.defs (gtk_check_menu_item_set_active): function
- renaming.
- (gtk_menu_set_title): added function.
-
- * generate/gtkmisc.defs (gtk_toggle_button_[sg]et_active): added
- functions, and removed gtk_toggle_button_set_state.
-
-1999-01-27 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c: fixed some typos in _wrap_gtk_ctree_get_row_data and
- _wrap_gtk_ctree_base_nodes. This fix was sent to me by Jim
- Robinson <robinson@ipsg.mot.com>.
-
-1999-01-26 James Henstridge <james@daa.com.au>
-
- * gtk.py: fixed typo in GtkProgress.configure.
-
-1999-01-22 James Henstridge <james@daa.com.au>
-
- * gdkimlibmodule.c: (_wrap_gdk_imlib_create_image_from_data): function
- would raise an exception if there was a null in the data or alpha
- arguments. Also added some sanity checks on the lengths of data
- and alpha. This patch was submitted by Toby D. Reeves.
-
-1999-01-21 James Henstridge <james@daa.com.au>
-
- * examples/testgtk/testgtk.py (create_scrolled_windows): changed
- a call to GtkContainer.add to GtkScrolledWindow.add_with_viewport.
-
- * gtk.py (GtkPacker.add): Added defaults for the arguments.
-
-1999-01-11 James Henstridge <james@daa.com.au>
-
- * gtk.py (GtkProgress.get_current_percentage): fixed function call
-
- * gtk.py (GtkScrolledWindow): changed so it inherits from GtkBin
- instead of GtkContainer, to match changes in GTK.
-
- * GDK.py (DRAG_PROTO_ROOTWIN): Added the constant.
-
- * gtkmodule.c: forgot to include GTK_TYPE_DOUBLE in one of the GtkArg
- processing routines. Also fixed a problem for events with a NULL
- window.
-
-1998-12-24 James Henstridge <james@daa.com.au>
-
- * gdkimlibmodule.c(_wrap_gdk_imlib_get_rgb_height): I accidentally
- returned rgb_width instead of rgb_height. This bug report was from
- Osamu Tanimoto <tanimoto@rios.co.jp>.
-
-1998-12-22 James Henstridge <james@daa.com.au>
-
- * GtkExtra.py: modified the signal connect bit in the MenuFactory
- code so it is a bit more sane.
-
-1998-12-21 James Henstridge <james@daa.com.au>
-
- * pygtk.spec: updated version here as well.
-
- * README: updated required GTK version to 1.1.9
-
- * configure.in: Updated version for pygtk to 0.5.9, increased
- GTK version check to 1.1.9.
-
-1998-12-20 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c, generate/gtkmisc.defs: moved gtk_preview_draw_row here
- because python's string conversion routines do not like nuls in a
- string, but you quite often want them in image data.
-
-1998-12-17 James Henstridge <james@daa.com.au>
-
- * examples/*/*.py: changed calls to GtkLabel.set to GtkLabel.set_text.
-
- * gtk.py: made changes to reflect those below.
-
- * generate/gtkbase.defs (gtk_widget_set_app_paintable): added this
- stub.
-
- * generate/gtkmisc.defs (gtk_label_set_text): renamed gtk_label_set to
- this, added gtk_label_set_line_wrap.
-
- * generate/gtkdnd.defs: Added gtk_drag_source_unset.
-
- * generate/gtklists.defs: moved reordering function stubs from ctree
- to clist.
-
- * generate/gtkcontainers.defs: removed GtkDrawWindow. Added
- gtk_paned_pack[12]
-
- * GtkExtra.py (MenuFactory.create): wasn't passing extra arguments
- onto signal connect. Bug fix from Sam Tannous <stannous@cisco.com>
-
- * gtkmodule.c: Applied some fixes to the ctree code from
- A.Hartgers@phys.tue.nl
-
-1998-12-09 James Henstridge <james@daa.com.au>
-
- * gtk.py, generate/gtkmisc.defs, GTK.py: Added
- gtk_toolbar_set_space_style and the required enum.
-
-1998-12-08 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c: fixed up the toolbar functions, so they also use
- gtk_signal_connect_full, and now return the added child, like
- the C functions do.
-
- * examples/testgtk/testgtk.py: fixed up some stuff in the main
- function and clist test.
-
- * gtk.py, generate/gtkcontainers.defs: added
- gtk_window_set_transient_for and gtk_window_set_default_size.
-
- * gtkmodule.c: Changed to use _full functions instead of _interp
- functions. Also made gtk_signal_connect and friends use the
- gtk_signal_connect_full function rather than the default marshaller
- method.
-
-1998-12-07 James Henstridge <james@daa.com.au>
-
- * generate/gtkcontainers.defs (gtk_viewport_new): Accept NULL
- arguments for adjustments of a viewport. This is the correct
- fix for Michael's other patch.
-
- * examples/*/*.py: got rid of deprecation messages. Put scrolled
- windows round all clists.
-
- * pyglade/build.py: Fixes a bug in scrolledwindow_new pointed out
- by Michael Hudson. Also made some changes so that it doesn't use
- any deprecated functions.
-
- * gtkmodule.c: fixed two typos pointed out by Michael Hudson
-
-1998-12-05 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c, generate/*.defs, gtk.py: updated to latest CVS. This
- includes the function name changes Tim Janik introduced. I have
- added backward compatibility wrappers for the old functions in gtk.py,
- which also print out a deprecation message.
-
-1998-12-01 James Henstridge <james@daa.com.au>
-
- * gtk.py (GtkLayout): I had left a few remnants from when this class
- was in gnome.ui. This is now fixed.
-
-1998-11-29 James Henstridge <james@daa.com.au>
-
- * description.py: Added a description of the GtkCTreeNode type.
-
- * gtk.py (GtkCTree): Added the GtkCTree class to this layer.
- Hopefully I haven't made any mistakes.
-
-1998-11-28 James Henstridge <james@daa.com.au>
-
- * generate/gtklists.defs: added entries for GtkCTree.
-
- * gtkmodule.c: Added the GtkCTreeNode type. It exports some of the
- attributes of the GtkCTreeRow associated with the node. Specifically,
- the parent, next sibling links, and a list of children. This should
- be enough attributes to make the type useful.
- Also added extra functions for GtkCTree.
-
-1998-11-27 James Henstridge <james@daa.com.au>
-
- * generate/gtk*.defs: updated for GTK+-1.1.5.
-
- * gtkmodule.c: added the PyGtk_RegisterBoxed function, exported through
- the _private dictionary. This allows adding extra boxed types so they
- will be recognised in signal handlers and the like.
-
- * gtk.py: this file used to be Gtkinter.py. People should make this
- change in their programs. Also updated for changes to the API.
-
- * Gtkinter.py: new file. Simply does a "from gtk import *", so old
- programs will still run properly.
-
- * examples/*/*.py, pyglade/*.py, GdkImlib.py, GtkExtra.py: changed
- occurences of Gtkinter to gtk.
-
-1998-11-17 James Henstridge <james@daa.com.au>
-
- * GdkImlib.py: missed a closing parenthesis. This caused problems.
-
- * generate/gtk.defs(gtk_rc_add_*_style): removed these functions.
- They weren't exported by Gtkinter, and their declaration has changed
- in newer GTK+'s. Now pygtk should compile with both GTK+-1.1.3 and
- CVS GTK (tested for a 1998-11-16 checkout).
-
- * configure.in, NEWS: bumped version up to 0.5.5, and made new release.
-
- * generate/gtkmisc.defs, Gtkinter.py: added the GtkCalendar widget.
-
-1998-11-15 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c: added GdkCursor type.
-
- * gtkmodule.c(GdkWindow.set_cursor): function to set cursor for window
-
- * generate/gtk.defs (gtk_cursor_*): new functions to create cursors
-
- * gtkmodule.c(gtk_pixmap_create_from_xpm_d): new function to create
- a GdkPixmap from a list of strings (XPM data). This allows you to
- store pixmaps inline with your program for distribution.
-
- * gdkimlibmodule.c: export the GdkImlibImageType, and a _private
- dictionary that holds exported functions. I should be able to
- add the GdkImlibImage dependent functions to _gnomeui now.
-
- * GDK.py, GTK.py: updated with new constants.
-
- * examples/simple/*1.py: stopped importing _gtkbase, and don't call
- _gtk.pygtk_init().
-
- * pyglade/build.py: added menu widgets to the interface building code.
-
- * pygtk.spec: new file -- an RPM spec file for this package.
-
- * NEWS: add information about this new version.
-
-1998-11-15 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c: added GdkAtom handling. There is now a special type for
- GdkAtoms that can be cast to string and int with str() and int()
- respectively, and it supports coercions, so it should act like an
- int in most cases. Functions that take GdkAtom's as arguments
- actually take ints, so backward compatibility is kept, but functions
- that return GdkAtoms now return this special type.
-
- * gtkmodule.c, generate/gtkdnd.defs, Gtkinter.py: added the new DnD
- code, and support for selections. The gtk_selection_* functions have
- been mapped to GtkWidget.selection_*, and the gtk_drag_* functions
- have been mapped to GtkWidget.drag_*
-
- * GdkImlib.py: added function create_image_from_data, so you can
- create an image from raw RGB data. Also added the Image.get_pixmap
- method, which is like Image.make_pixmap, except it returns the
- GdkPixmap,GdkBitmap pair, instead of a GtkPixmap widget.
-
-1998-11-14 James Henstridge <james@daa.com.au>
-
- * generate/*.defs: changes to bring pygtk up to date with GTK+-1.1.3
-
-1998-11-13 James Henstridge <james@daa.com.au>
-
- * gtkmodule.c: added wrappers for GdkDragContext and GtkSelectionData.
- Also removed all the old DnD GdkEvent mappings, and added the
- GdkEventDND mapping. This should be enough to get the new Dnd signals
- working.
-
- * generate/gtkbase.defs, gtkmodule.c(_wrap_gtk_widget_dnd_*): removed
- the old gtk_widget_dnd_* functions from the bindings.
-
-1998-11-10 James Henstridge <james@daa.com.au>
-
- * build system: Converted over to using automake. Note thay some
- modifications have been made to the original version of automake,
- so you will need to apply my patches if you want to modify pygtk.
-
- * swigsrc/*: removed. I am now using some code generation tools
- that take .defs files as input.
-
- * gdkimlibmodule.c: got rid of all the swig stuff, and cleaned up the
- code a bit. This has reduced the source code size by half.
-
-1998-11-10 James Henstridge <james@daa.com.au>
-
- * ChangeLog: started change log. Old Changelog file has been moved
- to NEWS
-
- * NEWS: used to be Changelog
-
diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
deleted file mode 100644
index 4d6ed4c7..00000000
--- a/ChangeLog.pre-2-6
+++ /dev/null
@@ -1,3474 +0,0 @@
-2005-05-09 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Post release version bump
-
-=== PyGTK 2.6.2 ===
-2005-05-09 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/pygenum.c (pyg_enum_new): Complain if ret is NULL,
- Fixes #303524.
-
- * gobject/pygflags.c (pyg_flags_new): Change exception format to
- be consistent with the one in enum
-
- * gtk/gtk.override: Allow None to be passed in to:
- set_group for RadioAction.set_group(), RadioToolButton.set_group()
- and RadioMenuItem.set_group(). Fixes #170514
-
- * tests/test_radiobutton.py: Refactor and add unittests for
- RadioAction, RadioToolButton and RadioMenuItem.
-
-2005-05-09 Mark McLoughlin <mark@skynet.ie>
-
- Fix for bug #303573 - "exceptions raised in a child watch
- handler are silently swallowed"
-
- * gobject/gobjectmodule.c:
- (child_watch_func),
- (_pyg_spawn_async_callback): if PyObject_CallFunction()
- returns NULL, print a traceback of the exception.
-
- * tests/test_mainloop.py: add testcase.
-
- * tests/Makefile.am: add test_mainloop.py
-
- Reviewed by Johan Dahlin <johan@gnome.org>
-
-2005-05-03 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gdk.override (_wrap_gdk_event_tp_setattr): Fix setter for
- "window" attribute: don't unblock threads around g_bject_ref;
- g_object_unref previous event.window. Fixes #302622.
-
- * tests/Makefile.am (tests): Add test_gdkevent.py.
-
- * tests/test_gdkevent.py: Add a test for gtk.gdk.Event.window setter.
-
-2005-04-12 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * tests/runtests.py (program): Fix indentation and a "name
- 'program' is not defined" exception.
-
- * codegen/argtypes.py: Treat guint and gsize as python longs, with
- appropriate parameter conversion formats and return conversion
- functions. Also treat gssize as long long on LLP64 architectures
- (thanks jamesh). Correctly parse "long" parameters on LP64
- architectures. Fixes #300012: "Handling of guint, gsize, gssize,
- and glong in pygtk is broken".
-
-2005-03-27 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_dialog_set_alternative_button_order):
- Really check in the code. Fixes #171771 (Manish Singh)
-
-2005-03-20 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtktreeview.override (_wrap_gtk_list_store_insert):
- Regression, allow the second argument to be unspecified, fixes
- #171027 (Ulrik Svensson)
-
- * tests/test_liststore.py: Add 2 new tests
-
-2005-03-17 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtkmodule.c (init_gtk): Regression, don't crash if sys.argv
- isn't set.
-
-2005-03-16 Johan Dahlin <jdahlin@async.com.br>
-
- * tests/test_radiobutton.py (RadioButtonTest): New test.
-
- * tests: Renamed *.py to test_*.py
-
- * gtk/gtk.override: Allow argument to RadioButtion.set_radio_group
- to be empty, fixes #170514 (Lorenzo Gil Sanchez)
-
-2005-03-15 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Post release version bump
-
-=== PyGTK 2.6.1 ===
-2005-03-15 Johan Dahlin <jdahlin@async.com.br>
-
- * codegen/codegen.py: Check arguments if we have no arguments.
- Fixes bug #170266 (Doug Quale)
-
- * gtk/gdk.override:
- * gtk/gtktreeview.override: gcc4 patches stolen from redhat
-
- * NEWS: Updated
-
-2005-03-14 Anders Carlsson <andersca@imendio.com>
-
- * codegen/reversewrapper.py:
- Remove an extra * in the declaration and cast of GObject
- types.
-
-2005-03-14 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/pygparamspec.c (pyg_param_spec_getattr): In case the
- enum is not registered, set enum_class or flag_class to None
-
-2005-03-13 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_store_reorder): Ditto
-
-2005-03-13 Richard Hult <richard@imendio.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_list_store_reorder): You
- don't own a ref on the return value from PyList_GetItem so don't
- decrease the ref count.
-
-2005-03-10 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtktreeview.override:
- (_wrap_gtk_list_store_insert): Use
- gtk_list_store_insert_with_valuesv, improves performance
- when using a sorted list.
-
- * configure.in: Post release version bump
-
-=== PyGTK 2.6.0 ===
-2005-03-07 Johan Dahlin <jdahlin@async.com.br>
-
- * README: Remove ftp.gtk.org url
-
- * NEWS: Updated.
-
-2005-03-04 Manish Singh <yosh@gimp.org>
-
- * configure.in: document micro_version as micro version.
-
- * gtk/gtktreeview.override
- * gtk/libglade.override: get rid of a couple unnecessary G_OBJECT()
- casts.
-
-2005-02-23 Cedric Gustin <cedric.gustin@swing.be>
-
- * gobject/pygtype.c (add_property_docs): Use G_CONST_RETURN with a
- gchar* return value.
-
-2005-02-23 Johan Dahlin <johan@gnome.org>
-
- * configure.in: post release version bump
-
- * examples: Don't use gtk.TRUE/gtk.FALSE anymore.
-
-=== PyGTK 2.5.4 ===
-2005-02-23 Johan Dahlin <johan@gnome.org>
-
- * README, NEWS: Update
-
-2005-02-23 Cedric Gustin <cedric.gustin@swing.be>
-
- * setup.py: Move the install_template call for pygobject-2.0.pc.in
- to the right place in the script. Also define PLATFORM_WIN32 on
- win32. Fixes bug #150616.
- * codegen/codegen.py: Do not write the 'pygtk class init' function
- for objects whose type is explicitly ignored (like GtkPlug and
- GtkSocket on win32). Otherwise, it generates glib-warnings related
- to calls to g_object_set_qdata with a NULL 'node'.
- * gobject/pygtype.c: Do not use g_string_append_printf with a NULL
- argument, as it crashes on win32. Fixes bug #166546.
- * gtk/gtk.override: Add GtkSocket__proxy_do_plug_added,
- GtkSocket__proxy_do_plug_removed and GtkPlug__proxy_do_embedded to
- the ignore-win32 list.
-
-2005-02-15 Johan Dahlin <johan@gnome.org>
-
- * gtk/__init__.py: Deprecate gtk.TRUE and gtk.FALSE
-
-2005-02-17 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * examples/pygtk-demo/pygtk-demo.in: New, frontend script to
- launch pygtk demo.
-
- * examples/Makefile.am: Install the pygtk demo.
-
- * examples/pygtk-demo/demos/appwindow.py
- (ApplicationMainWindowDemo.activate_about)
- (ApplicationMainWindowDemo.__create_action_group): Popup a simple
- AboutDialog on Help->About.
-
-2005-02-15 Johan Dahlin <johan@gnome.org>
-
- * configure.in: Fix logic when displaying modules not built,
- Thanks to Abel Daniel for pointing out.
- * gtk/gtk.defs: Undeprecate gtk.icon_size_get_name and
- gtk.icon_size_lookup and remove broken methods.
-
-2005-02-13 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.defs: Reorder all the (define-virtual...) declarations,
- putting them right after the method declarations of the respective
- objects.
-
-2005-02-10 Mark McLoughlin <mark@skynet.ie>
-
- * gobject/pygmainloop.c: (pyg_restore_current_main_loop):
- don't pass a NULL value to PyThread_set_key_value() - causes
- an assertion failure with python 2.4.
-
-2005-02-09 Mark McLoughlin <mark@skynet.ie>
-
- Fix for bug #154779 - Python signal handlers don't
- get executed while you're sitting in the main loop.
-
- * gobject/pygmainloop.c:
- (pyg_save_current_main_loop),
- (pyg_restore_current_main_loop),
- (pyg_get_current_main_loop): functions for keeping
- track of the currently running main loop. A version
- using TLS and another using a global variable, depending
- on whether DISABLE_THREADING is defined
- (pyg_signal_watch_prepare), (pyg_signal_watch_check),
- (pyg_signal_watch_dispatch), (pyg_signal_watch_new):
- a GSource which runs the python signal handlers whenever
- the mainloop is interrupted by signal delivery.
- (pyg_main_loop_new), (pyg_main_loop_dealloc): add and
- remove the source.
- (_wrap_g_main_loop_run): push/pop the currently running
- main loop.
-
- * gobject/pygobject-private.h: add a pointer for the
- source to PyGMainLoop.
-
- * gobject/Makefile.am: add -DPLATFORM_WIN32 to cflags
- if building on Windows.
-
-2005-01-10 Johan Dahlin <johan@gnome.org>
-
- * configure.in: post release version bump
-
-=== PyGTK 2.5.3 ===
-2005-01-22 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtkmodule.c (init_gtk): Do some type checking on sys.argv
- before using it. Fixes #163209.
-
- * gtk/gdk.override: Override slots tp_getattro and tp_setattro of
- GdkGC instead of tp_setattr and tp_getattr. Fixes #159468.
-
- * codegen/codegen.py: Allow override of tp_getattro and
- tp_setattro (non-deprecated variants of tp_getattr and
- tp_setattr).
-
- * gobject/pygflags.c (pyg_flags_new): Check that __gtype__ is
- PyGTypeWrapper_Type, not PyGEnum_Type.
- (pyg_flags_add): Set a custom __gtype__ for the new flags class.
- (pyg_flags_new): Remove "value out of range" check, it makes no
- sense in flags.
- (pyg_flags_new): Check for NULL return from PyDict_GetItem and set
- exception.
-
- * gobject/pygenum.c (pyg_enum_add): Set a custom __gtype__ for the
- new enum class.
- (pyg_enum_new): Check that __gtype__ is PyGTypeWrapper_Type, not
- PyGEnum_Type.
-
- * gobject/pygflags.c (pyg_flags_add): Idem.
-
- * gobject/pygenum.c (pyg_enum_add): Unset the flag
- Py_TPFLAGS_BASETYPE in newly created enum type. Set tp_new, which
- somehow was not being inherited.
-
- Fixes #154372.
-
-2005-01-22 Mark McLoughlin <mark@skynet.ie>
-
- * gobject/gobjectmodule.c (pyg_type_register): Fix reference leak
- to the module string; Appends the serial number to the type name,
- even if the module name can't be looked up. Fixes #164441.
-
-2005-01-18 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/reversewrapper.py (IntParam.convert_c2py): Don't bother
- checking if PyInt_FromLong fails.
- (DoubleParam.convert_c2py): Don't bother checking if
- PyFloat_FromDouble fails.
- (DoubleReturn.write_conversion): Check return value type.
- (IntReturn.write_conversion): idem.
- (StringReturn.write_conversion): idem.
- (VoidReturn.write_conversion): idem.
-
- * gtk/gtkmodule.c (init_gtk): On Python >= 2.4, don't call
- setlocale(LC_NUMERIC, "C"), as it breaks the locale module. Fixes
- #164451.
-
-2005-01-16 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/gobjectmodule.c (pyg_type_register): Use tp_base field
- of each base type to compare with PyGInterface_Type, instead of
- PyObject_IsSubclass, because we don't want a class defined as
- class Foo(GObject, SomeInterface) to be itself considered an
- interface when in turn it is subclassed.
- (pyg_type_register): Make "Interface type %s has no python
- implementation support" a warning instead of exception. This
- really isn't a fatal error and some programs seem to be using
- interfaces in weird ways.
-
- * codegen/reversewrapper.py (ReverseWrapper.generate): Rename
- variable PyGILState_STATE state to __py_state to avoid possible
- name collision with function parameters.
-
-2005-01-13 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk.override (_wrap_gdk_pixmap_colormap_create_from_xpm)
- (_wrap_gdk_pixmap_create_from_xpm_d)
- (_wrap_gdk_pixmap_colormap_create_from_xpm_d): Allow first arg
- to be a GdkDrawable. #159282
-
-2005-01-13 Johan Dahlin <johan@gnome.org>
-
- * gtk/Makefile.am: Allow it to be built using automake 1.8. Fixes
- bug 163932
-
- * codegen/codegen.py: Only declare the object when it's needed.
- Fixes some more compiler warnings.
-
-2005-01-10 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/codegen.py (Wrapper.write_virtuals): Don't raise
- exception if a do_xxx method is defined and the corresponding
- virtual is not supported, since we may have a signal with the same
- name and the user may be trying to override it.
- Fixes #163606: override size_allocate doesn't work.
-
- * gobject/pygobject.h, gobject/pygobject-private.h: Revert change
- from 2005-01-09 by me to define pyg_threads_enabled as
- PyEval_ThreadsInitialized() on Python 2.4 and define
- pyg_begin|end_allow_threads as Py_BEGIN|END_ALLOW_THREADS. Fixes
- #163612: segmentation fault on pygtk-demo.
-
-2005-01-10 Johan Dahlin <johan@gnome.org>
-
- * configure.in: post release version bump
- * docs/random/release-checklist:
- Update
-
-=== PyGTK 2.5.2 ===
-2005-01-10 Johan Dahlin <johan@gnome.org>
-
- * autogen.sh: Check for automake-1.9 aswell, fixes 162396
- (Raphael Kubo da Costa)
-
-2005-01-10 Johan Dahlin <johan@gnome.org>
-
- * .cvsignore:
- * Makefile.am:
- * configure.in:
- * gtk/Makefile.am:
- * pygtk-2.0.pc.in:
- * setup.py:
- * tests/common.py:
- * tests/testhelpermodule.c: Make the build of
- atk, pango and gtk conditional. Fixes bug #74144.
-
-2005-01-10 Johan Dahlin <johan@gnome.org>
-
- * tests/Makefile.am:
- * tests/common.py:
- * tests/runtests.py:
- * tests/test_thread.py: Make testsuite work and do things
- the way they were supposed to be done from the beginning.
-
-2005-01-10 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.override
- (_wrap_GtkCellLayout__proxy_do_set_cell_data_func): Implement
- proxy function for virtual 'set_cell_data_func' of interface
- GtkCellLayout.
-
-2005-01-09 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/pygtype.c (pyg_value_from_pyobject): Handle conversion
- of python sequence to G_TYPE_VALUE_ARRAY GValue.
- (pyg_param_gvalue_from_pyobject): idem.
- Patch by jylefort@brutele.be; Fixes #160452.
-
- * gtk/gdk.override (_wrap_gdk_pixmap_create_from_xpm):
- Accept GdkDrawable instead of GdkWindow as first argument. Fixes
- #159282.
-
-2005-01-09 Tim Evans <gjc@gnome.org>
-
- * gtk/gtk.defs (gtk_get_current_event): Add (caller-owns-return #t).
-
- * gtk/gtk.override (_wrap_gtk_get_current_event_state): Impl.
-
- Reviewed by Gustavo Carneiro. Fixes #159397.
-
-2005-01-09 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/pygtype.c (pyg_value_from_pyobject): Be consistent about
- not raising an exception on error return.
- Patch by jylefort@brutele.be, fixes #160595.
-
- * tests/Makefile.am (tests): Add test_subprocess.py.
-
- * tests/test_subprocess.py: Unit test for gobject.spawn_async and
- gobject.child_watch_add.
-
- * gobject/gobjectmodule.c (pyg_spawn_async): Add wrapper for
- g_spawn_async_with_pipes.
- (pyg_child_watch_add): Add wrapper for g_child_watch_add_full.
-
- * gobject/pygobject.h, gobject/pygobject-private.h: Define
- pyg_threads_enabled as PyEval_ThreadsInitialized() on Python 2.4,
- so that it is no longer required to call gobject.threads_init on
- that platform. Also define pyg_begin|end_allow_threads as
- Py_BEGIN|END_ALLOW_THREADS, since these functions are rarely
- invoked, thus represent a minimal overhead.
-
- * gobject/gobjectmodule.c (pyg_type_register): Return the type
- being registered, to make gobject.type_register usable as Python
- 2.4 @decorator.
-
- * codegen/codegen.py (Wrapper.write_constructor): Move writing of
- pygobject_no_constuctor to the new methods
- write_default_constructor (when no constructor is declared in the
- .defs) and write_noconstructor (when a constructor is declared but
- could not be generated).
- (GObjectWrapper.write_default_constructor): Override to return
- '0'. This makes the constructor for GObjects become
- GObject.__init__ by default, unless there is a constructor
- function in the .defs and it could not be generated for some
- reason.
-
- * gtk/pygtkcellrenderer.c (pygtk_generic_cell_renderer_new):
- Deprecate GtkGenericCellRenderer, since all virtual methods of
- GtkCellRenderer are now supported.
-
- * gtk/gtk.override (_wrap_GtkCellRenderer__proxy_do_get_size):
- Override, implementation copied from PyGtkGenericCellRenderer,
- with minor adjustments/fixes.
-
-2005-01-09 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/gobjectmodule.c (pyg_type_register): Look for
- GInterface's among tb_bases and register implementation support
- for them.
- (pyg_register_interface_info): Add. Registers a GInterfaceInfo*
- containing python proxy implementation with a GInterface GType.
-
- * gobject/pygobject.h (pyg_register_interface_info): Add.
-
- * gtk/gtk-types.defs (Editable): Add (vtable "GtkEditableClass"),
- because the GtkEditable vtable structure name is GtkEditableClass
- instead of GtkEditableIface.
-
- * codegen/definitions.py (InterfaceDef.__init__): Add/parse vtable
- attribute, to contain the C structure name of the virtual table of
- an interface. If not given, the vtable name defaults to (c_name +
- "Iface"). Add attribute interface_info, to hold the
- GInterfaceInfo variable for the interface.
-
- * codegen/reversewrapper.py (GEnumReturn.write_conversion): Add
- missing code=None parameter.
- (GFlagsReturn.write_conversion): idem.
-
- * codegen/codegen.py: Add global iproxies_coverage to track
- coverage statistics of interface proxies.
- (Wrapper.write_methods): Split out writing virtual method
- accessors to a separate method (write_virtual_accessors).
- (GInterfaceWrapper.write_virtual_accessors): Override to disable
- writing virtual accessors for interfaces.
- (GInterfaceWrapper.write_virtuals): Override to generate interface
- virtuals, interface_init function, and interface_info structure.
- (write_registers): Call pyg_register_interface_info for interfaces
- with some implementation support.
-
- * gtk/gtk.defs: Add (define-virtual ...) declarations for all
- interface virtual methods in gtk.
-
- Fixes #154974: Interface implementation support.
-
-2005-01-09 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/reversewrapper.py (GBoxedParam.convert_c2py): When the C
- type begins with const, force python wrapper to create a copy of
- the boxed value, and typecast to avoid const warning.
-
- * codegen/codegen.py (Wrapper.write_virtuals): In the generated
- class_init function, don't declare the variable 'klass' if it is
- not needed.
-
-2005-01-08 Adam Hooper <adamh@cvs.gnome.org>
-
- * tests/test_actiongroup.py:
-
- Add test script for bug #162874.
-
-2005-01-08 Adam Hooper <adamh@cvs.gnome.org>
-
- reviewed by: Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override: Py_DECREF action in
- gtk_action_group_add_*actions. This should disconnect all the
- groups from the callbacks when destroyed. Fixes bug 162874
-
-2005-01-08 Johan Dahlin <johan@gnome.org>
-
- * Makefile.am: Add pygtk_postinstall.py
- * docs/random/missing-symbols: Updated
- * gtk/__init__.py: Deprecate gtk.idle_add and friends.
- * gtk/gtk.defs: Merge in 2.6 api, for GtkLabel functions,
- thanks to Gian Mario Tagliaretti, fixes bug #163296
- * tests/test_thread.py: Don't use gtk.idle_add
-
-2005-01-08 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/reversewrapper.py (GFlagsReturn, GFlagsParam): Add type
- handlers for GFlags in reverse wrappers.
- (GtkTreePathParam): Add type handler for GtkTreePath* param.
-
-2005-01-08 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.override: Declare PyGdkDevice_Type, now needed for some
- virtual method.
-
- * gtk/gtk.defs: Add a bunch of virtual method declarations for all
- non-deprecated gtk widgets.
-
- * gobject/pygobject.h: Add pyg_register_class_init to the API
- vtable and as macro, and PyGClassInitFunc typedef.
-
- * gobject/gobjectmodule.c (initgobject): Create
- pygobject_class_init_key, a GQuark that indentifiers the
- class_init data for a GType class.
- (pyg_register_class_init): Add, registers a class intialization
- function of type "int (*PyGClassInitFunc) (gpointer gclass,
- PyTypeObject *pyclass);"
- (pyg_run_class_init): Add, runs a stack of class initialization
- functions for a newly registered GObject class.
- (pyg_type_register): Call pyg_run_class_init right after the type
- is registered.
- Add pyg_register_class_init to pygobject_api_functions.
-
- * codegen/scanvirtuals.py: An utility script to scan for virtual
- methods in header files. At the moment it is not very intelligent
- and doesn't distinguish between virtual methods and interface
- definitions.
-
- * codegen/defsparser.py (DefsParser.__init__): Initialize
- attribute 'virtuals', to hold list of object's virtual methods.
- (DefsParser.define_virtual): Adds a new virtual method.
- (DefsParser.find_virtuals): Returns list of virtual methods of an
- object.
-
- * codegen/definitions.py (ObjectDef.__init__): Add a
- class_init_func member variable. Rename class MethodDef to
- MethodDefBase, subclass MethodDefBase as MethodDef, move code that
- checks for presence of 'c_name' from MethodDefBase into MethodDef.
- (MethodDefBase.write_defs): Rename to _write_defs, and don't write
- the initial "(define-method ...".
- (MethodDef.write_defs): Write the "(define-method ..." here, then
- call _write_defs to write the remaining.
- (VirtualDef): New class to information of an object's virtual
- method. It inherits from MethodBaseDef.
-
- * codegen/codegen.py: Add class Coverage, to track and display
- coverage statistics. Add globals functions_coverage,
- methods_coverage, vproxies_coverage, and vaccessors_coverage.
- (Wrapper.virtual_accessor_tmpl): Add template for virtual method
- "accessor", which is a classmethod that calls a GObject virtual
- method for GType corresponding to the class of the method. This
- is used in virtual method implementations for chaining to parent
- classes.
- (Wrapper.write_class): Call self.write_virtuals() in the end, to
- write virtual method proxies.
- (Wrapper.write_function_wrapper): Don't overwrite
- subsdict['cname'] if it already has a value, since we need to pass
- a different function name when generating virtual method
- accessors.
- (Wrapper.write_methods): Update coverage statistics in
- methods_coverage.
- (Wrapper.write_methods): Generate virtual metho accessor
- functions, as classmethods.
- (Wrapper.write_virtuals): Generate virtual method proxies using
- the reverse wrapper generator. Also generates a class_init
- function to register the virtual proxies with the object class,
- but only for those virtuals that appear to be actually implemented
- in python code to avoid calling into python code for nothing.
- (Wrapper.write_functions): Update coverage statistics in
- functions_coverage.
- (write_registers): Generate code to call pyg_register_class_init
- if the object has a class init function.
- (main): Print all coverage statistics at the end of code generation.
-
- * codegen/argtypes.py (ArgMatcher.register_reverse)
- (ArgMatcher.register_reverse_ret, ArgMatcher.get_reverse)
- (ArgMatcher.get_reverse_ret): New APIs to register and lookup
- reverse wrappers type handlers.
-
- * codegen/Makefile.am (codegen_PYTHON): Add reversewrapper.py.
-
- * codegen/reversewrapper.py: New code to generate 'reverse
- wrappers', i.e. wrappers that are called from C, call into Python,
- and then return the python return value back to C.
-
- Fixes #145314: Overriding GTK+ virtual methods.
-
-2004-12-26 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk.override (_wrap_gdk_event_tp_setattr): Fix garbled code
- and allow message_type to be set. Fixes #162292.
- (Raphael Kubo da Costa)
-
-2004-12-23 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk.defs (render_to_drawable, render_to_drawable_alpha): Add
- drprecation warnings. Fixes #162097 (Steve Chaplin)
-
- * gtk/gtk.override (_wrap_gtk_dialog_set_alternative_button_order):
- Implement
-
-2004-12-23 Johan Dahlin <johan@gnome.org>
-
- * gtk/__init__.py: Improve deprecation warnings, to display correct
- lines (stacklevel should 2, not 1 which is default)
-
-2004-12-23 Johan Dahlin <johan@gnome.org>
-
- * configure.in: Post release version bump
-
-=== PyGtk 2.5.1 ===
-2004-12-23 Johan Dahlin <johan@gnome.org>
-
- * NEWS:
- * README: Updated
-
-2004-12-02 Cedric Gustin <cedric.gustin@swing.be>
-
- Reviewed by: Johan Dahlin <johan@gnome.org>
- Fixes #150616
-
- * dsextras.py: Added InstallData class. Changed template options
- to ${prefix}/include|lib|bin|share. Added get_m4_define function
- to parse pygtk version strings in configure.in.
-
- * setup.py: Added pygtk_postinstall bdist_wininst
- option. distutils now uses InstallData as install_data
- class. pygtk-2.0.pc and pygtk-codegen-2.0 are installed as data
- instead of lib/extensions. This fixes a bdist_wininst installer on
- win32.
-
- * pygtk_postinstall.py: Initial release.
-
-2004-12-23 Johan Dahlin <johan@gnome.org>
-
- * docs/random/release-checklist: New document
-
- * docs/random/missing-symbols: New document
-
- * examples/atk/atk-demo.py:
- * examples/ide/browse.py:
- * examples/ide/gtkcons.py:
- * examples/neil/notebook.py:
- * examples/pango/utf8-demo.py:
- * examples/pygtk-demo/demos/dnd.py:
- * examples/pygtk-demo/demos/editable_cells.py:
- * examples/pygtk-demo/demos/list_store.py:
- * examples/simple/dnd.py:
- * examples/simple/scribble.py:
-
- Use stock items and other fixes for examples.
- Fixes #156402 (Alan Horkan)
-
-2004-12-23 Johan Dahlin <johan@gnome.org>
-
- * autogen.sh: set srcdir to dirname $0, fixes out of source tree
- builds. Fixes #158360 (Marco Pesenti Gritti)
-
-2004-12-22 Johan Dahlin <johan@gnome.org>
-
- * PKG-INFO.in: Update
-
- * configure.in: Require glib/gtk+ 2.6, pango, atk 1.8, export
- PYGTK_[MAJOR,MINOR_MICRO]_VERSION
-
- * gtk/gtk.defs: Make it build again by removing removed functions
-
-2004-12-12 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/argtypes.py (arg): Add 'GTime' argtype matcher, which is
- defined as gint32 by glib, thus handled as a normal python int.
-
-2004-12-10 John Ehresman <jpe@wingide.com>
-
- * gobject/pygobject.h: Change PY_HEXVERSION to PY_VERSION_HEX
-
-2004-12-04 John Finlay <finlay@moeraki.com>
-
- * pango-types.defs (LayoutIter): Add.
-
- * pango.defs (pango_layout_iter_get_type): Add.
-
- * pango.override (_wrap_pango_layout_iter_get_line_yrange)
- (_wrap_pango_layout_iter_get_layout_extents)
- (_wrap_pango_layout_iter_get_run_extents)
- (_wrap_pango_layout_iter_get_line_extents)
- (_wrap_pango_layout_iter_get_cluster_extents)
- (_wrap_pango_layout_iter_get_char_extents): Implement.
-
-2004-12-04 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.defs: Remove gtk_file_chooser_button_[gs]et_active wrappers.
- (set_cell_data): Remove, also removed from gtk+.
-
-2004-11-29 Johan Dahlin <johan@gnome.org>
-
- * configure.in: Post release version bump
-
-=== PyGtk 2.5.0 ===
-2004-11-29 Johan Dahlin <johan@gnome.org>
-
- * NEWS: Update
-
-2004-11-23 Johan Dahlin <johan@gnome.org>
-
- * gobject/pygobject.c (pygobject_register_sinkfunc): Make sure
- type is a type and sinkfunc isn't NULL.
-
-2004-11-16 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_about_dialog_set_url_hook)
- (_wrap_gtk_about_dialog_set_email_hook)
- (_wrap_gtk_target_list_add_uri_targets)
- (_wrap_gtk_target_list_add_image_targets)
- (_wrap_gtk_target_list_add_text_targets): Implement.
-
- * gtk/gtk.defs (gtk_target_list_add_text_targets)
- (gtk_target_list_add_image_targets)
- (gtk_target_list_add_uri_targets): Define as functions.
-
-2004-11-15 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk.override (_wrap_gdk_display_store_clipboard): Implement.
-
- * gtk/gdk.defs (drag_drop_succeeded): Define as method of
- GdkDragContext.
-
- * gobject/pygflags.c (pyg_flags_repr): Print long int value if enum
- string not found. Fixes #158417. (modifed patch from Tim Evans)
-
- * gtk/gtk.defs (set_icon_name): Allow name to be NULL
-
- * gtk/gtktreeview.override
- (_wrap_gtk_tree_view_set_row_separator_func): Implement.
- (gtk_tree_view_get_row_separator_func): Ignore.
-
- * gtk/gdk.override Complete changes to return strings instead of
- atoms except for intern_atom.
-
-2004-11-14 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs (gtk_selection_data_targets_include_image): Add def.
-
- * configure.in Require GTK+ 2.5.5.
-
- * gtk/gtk.override (_wrap_gtk_message_dialog_new): Fix bug.
- (_wrap_gtk_message_dialog_format_secondary_text)
- (_wrap_gtk_message_dialog_format_secondary_markup): Implement.
-
- * gtk/gtk.defs (gtk_menu_tool_button_set_arrow_tooltip):
- Allow tip args to be NULL.
-
- * gtk/gtk.override (_wrap_gtk_menu_tool_button_new): Implement.
- (gtk_menu_tool_button_new_from_stock): Ignore
-
- * gtk/gtkwidget.override
- (_wrap_gtk_menu_get_for_attach_widget): Implement as method of Widget
- * gtk/gtk.defs (gtk_menu_get_for_attach_widget): Define as method
- of Widget.
-
- * pango-types.defs (EllipsizeMode): Add.
-
-2004-11-14 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * codegen/definitions.py (FunctionDef.write_defs): Write
- caller-owns-return.
- (MethodDef.write_defs): idem.
- (MethodDef.merge): Merge flags 'caller_owns_return' and
- 'vargargs'; if parameter parmerge is false, return right after
- copying old parameter list, to effectively avoid merging.
- (FunctionDef.merge): idem.
-
- * codegen/h2def.py (split_prefix_pat): Allow prefix to begin with
- more than one capital letter. Fixes splitting of GConfXxx names.
-
-2004-11-14 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_image_get_icon_name): Implement.
-
- * gtk/gtk.defs (gtk_image_new_from_icon_name): Change function
- name to gtk.image_new_from_icon_name.
-
-2004-11-13 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_icon_view_selected_foreach)
- (_wrap_gtk_icon_view_get_selected_items): Implement.
-
- * gtk/gtk.defs (set_model): Set arg optional default NULL.
-
- * gtk/gtk.override (_wrap_gtk_icon_theme_get_icon_sizes): Implement.
- (_wrap_gtk_icon_view_new): Implement.
- (gtk_file_chooser_button_new_with_dialog): Ignore.
- (_wrap_gtk_file_chooser_button_new) Fix bug and add variant.
-
-2004-11-12 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_file_chooser_button_new): Implement
- with optional backend arg.
- (gtk_file_chooser_button_new_with_backend): Ignore.
-
- * gobject/gobjectmodule.c (pyg_signal_list_ids)
- (pyg_signal_lookup, pyg_signal_name, pyg_signal_query): Add signal
- introspection functions
-
-2004-11-10 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_clipboard_set_can_store): Implement.
- (_wrap_gtk_combo_box_set_row_separator_func): Implement
- (gtk_combo_box_get_row_separator_func): Ignore.
-
-2004-11-09 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_cell_view_set_value)
- (_wrap_gtk_cell_view_set_values): Implement.
- (_wrap_gtk_cell_view_get_cell_renderers): Implement.
- (_wrap_gtk_cell_view_get_size_of_row): Implement.
-
- * gtk/gtk-types.defs (CellView): Implements GtkCellLayout
-
- * gtk/gtk.defs Add functions for CellRendererCombo and
- CellRendererProgress
-
- * gtk/gtk-types.defs Add CellRendererCombo and CellRendererProgress
-
- * gtk/gdk.defs (alternative_dialog_button_order): Add as method of
- GdkScreen
-
- * gtk/gtk.defs (alternative_dialog_button_order): Remove.
-
-2004-11-08 John Finlay <finlay@moeraki.com>
-
- * configure.in Require less onerous GTK+ 2.5.4 build dependencies
-
- * gtk/gtk.defs (set_logo_icon_name, set_logo)
- (set_translator_credits, set_website_label, set_website)
- (set_license, set_comments, set_copyright, set_version):
- Allow arg to be None.
-
-2004-11-07 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs (gtk_about_dialog_set_name) Allow name to be None
- to use default app name.
-
- * gobject/gobjectmodule.c (_pyg_strv_from_gvalue) Avoid segfault
- when argv is NULL.
-
- * gtk/gtk.override (_wrap__gtk_drag_source_set_target_list)
- (_wrap_gtk_drag_source_get_target_list) Implement. Fixes #157554.
-
- * gtk/gtk.defs (drag_source_set_target_list)
- (drag_source_get_target_list) Add. Fixes #157554.
-
- * gtk/gdk.override (_wrap_gdk_event_tp_setattr) Add missing return.
- Fixes #157571 with slightly modified patch from rubensr.
-
-2004-11-07 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.defs (drag_source_add_text_targets)
- (drag_dest_add_uri_targets, drag_dest_add_image_targets)
- (drag_dest_add_text_targets): Make methods of them, fixes #157554
-
- * gtk/gtk.override (_wrap_gtk_selection_data_get_uris)
- (_wrap_gtk_selection_data_set_uris): Impl.
-
-2004-11-07 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * codegen/definitions.py (FunctionDef.write_defs): write (varargs
- #t) when appropriate.
- (MethodDef.write_defs): idem.
- (FunctionDef.merge): Refactor/fix and add 'parmerge' argument.
-
- * codegen/defsparser.py (DefsParser.merge): Add parameter
- parmerge, to inidicate if we want parameter lists merging or not.
-
- * codegen/mergedefs.py: Parse command line options with optparse;
- accept option -p to indicate we want to update parameter lists of
- existing methods/functions; by default parameter lists are not merged.
-
- * codegen/h2def.py (proto_pat): Accept \s* between ( and start of
- argument list. Fixes parsing of
- libgnomeui-2.0/libgnomeui/gnome-scores.h, and others.
-
-2004-11-06 Hans Breuer <hans@breuer.org>
-
- * config.h.win32 makefile.msc gobject/makefile.msc
- gtk/makefile.msc : updated - pygtk is working fine
- with msvc (but requires -DDISABLE_THREADING), Thanks!
-
-2004-11-06 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_about_dialog_get_artists)
- (_wrap_gtk_about_dialog_set_artists)
- (_wrap_gtk_about_dialog_get_documenters)
- (_wrap_gtk_about_dialog_set_documenters)
- (_wrap_gtk_about_dialog_get_authors)
- (_wrap_gtk_about_dialog_set_authors): Impl.
-
-2004-11-06 Johan Dahlin <johan@gnome.org>
-
- * configure.in:
- * gtk/gdk.defs:
- * gtk/gtk-types.defs:
- * gtk/gtk.defs:
-
- Bump version to 2.5.0 and merge in gdk/gtk+ changes from cvs head.
-
- New gtk objects:
-
- GtkAboutDialog, GtkFileChooserButton, GtkIconView, GtkCellView,
- GtkMenuToolButton
-
- New gtk functions:
-
- gtk_about_dialog_get_artists
- gtk_about_dialog_get_authors
- gtk_about_dialog_get_comments
- gtk_about_dialog_get_copyright
- gtk_about_dialog_get_documenters
- gtk_about_dialog_get_license
- gtk_about_dialog_get_logo
- gtk_about_dialog_get_name
- gtk_about_dialog_get_translator_credits
- gtk_about_dialog_get_version
- gtk_about_dialog_get_website
- gtk_about_dialog_get_website_label
- gtk_about_dialog_new
- gtk_about_dialog_set_artists
- gtk_about_dialog_set_authors
- gtk_about_dialog_set_comments
- gtk_about_dialog_set_copyright
- gtk_about_dialog_set_documenters
- gtk_about_dialog_set_email_hook
- gtk_about_dialog_set_license
- gtk_about_dialog_set_logo
- gtk_about_dialog_set_name
- gtk_about_dialog_set_translator_credits
- gtk_about_dialog_set_url_hook
- gtk_about_dialog_set_version
- gtk_about_dialog_set_website
- gtk_about_dialog_set_website_label
- gtk_accelerator_get_label
- gtk_action_group_translate_string
- gtk_action_set_sensitive
- gtk_action_set_visible
- gtk_alternative_dialog_button_order
- gtk_cell_renderer_combo_new
- gtk_cell_renderer_progress_new
- gtk_cell_view_get_cell_renderers
- gtk_cell_view_get_size_of_row
- gtk_cell_view_new
- gtk_cell_view_new_with_markup
- gtk_cell_view_new_with_pixbuf
- gtk_cell_view_new_with_text
- gtk_cell_view_set_background_color
- gtk_cell_view_set_displayed_row
- gtk_cell_view_set_model
- gtk_cell_view_set_value
- gtk_cell_view_set_values
- gtk_clipboard_set_can_store
- gtk_clipboard_store
- gtk_clipboard_wait_is_target_available
- gtk_combo_box_get_active_text
- gtk_combo_box_get_column_span_column
- gtk_combo_box_get_focus_on_click
- gtk_combo_box_get_popup_accessible
- gtk_combo_box_get_row_separator_func
- gtk_combo_box_get_row_span_column
- gtk_combo_box_get_wrap_width
- gtk_combo_box_set_add_tearoffs
- gtk_combo_box_set_focus_on_click
- gtk_combo_box_set_row_separator_func
- gtk_dialog_set_alternative_button_order
- gtk_drag_dest_add_image_targets
- gtk_drag_dest_add_text_targets
- gtk_drag_dest_add_uri_targets
- gtk_drag_source_add_text_targets
- gtk_entry_completion_get_inline_completion
- gtk_entry_completion_get_popup_completion
- gtk_entry_completion_get_text_column
- gtk_entry_completion_insert_prefix
- gtk_entry_completion_set_inline_completion
- gtk_entry_completion_set_popup_completion
- gtk_file_chooser_button_get_active
- gtk_file_chooser_button_get_title
- gtk_file_chooser_button_get_width_chars
- gtk_file_chooser_button_new
- gtk_file_chooser_button_new_with_backend
- gtk_file_chooser_button_new_with_dialog
- gtk_file_chooser_button_set_active
- gtk_file_chooser_button_set_title
- gtk_file_chooser_button_set_width_chars
- gtk_file_chooser_get_show_hidden
- gtk_file_chooser_set_show_hidden
- gtk_icon_theme_get_icon_sizes
- gtk_icon_view_get_markup_column
- gtk_icon_view_get_model
- gtk_icon_view_get_orientation
- gtk_icon_view_get_path_at_pos
- gtk_icon_view_get_pixbuf_column
- gtk_icon_view_get_selected_items
- gtk_icon_view_get_selection_mode
- gtk_icon_view_get_text_column
- gtk_icon_view_item_activated
- gtk_icon_view_new
- gtk_icon_view_new_with_model
- gtk_icon_view_path_is_selected
- gtk_icon_view_selected_foreach
- gtk_icon_view_select_all
- gtk_icon_view_select_path
- gtk_icon_view_set_markup_column
- gtk_icon_view_set_model
- gtk_icon_view_set_orientation
- gtk_icon_view_set_pixbuf_column
- gtk_icon_view_set_selection_mode
- gtk_icon_view_set_text_column
- gtk_icon_view_unselect_all
- gtk_icon_view_unselect_path
- gtk_image_get_icon_name
- gtk_image_get_pixel_size
- gtk_image_new_from_icon_name
- gtk_image_set_from_icon_name
- gtk_image_set_pixel_size
- gtk_label_get_ellipsize
- gtk_label_get_width_chars
- gtk_label_set_ellipsize
- gtk_label_set_width_chars
- gtk_menu_get_for_attach_widget
- gtk_menu_tool_button_get_menu
- gtk_menu_tool_button_new
- gtk_menu_tool_button_new_from_stock
- gtk_menu_tool_button_set_menu
- gtk_message_dialog_format_secondary_markup
- gtk_message_dialog_format_secondary_text
- gtk_selection_data_get_pixbuf
- gtk_selection_data_get_uris
- gtk_selection_data_set_pixbuf
- gtk_selection_data_set_uris
- gtk_show_about_dialog
- gtk_target_list_add_image_targets
- gtk_target_list_add_text_targets
- gtk_target_list_add_uri_targets
- gtk_text_buffer_backspace
- gtk_tool_item_rebuild_menu
- gtk_tree_view_get_fixed_height_mode
- gtk_tree_view_get_hover_expand
- gtk_tree_view_get_hover_selection
- gtk_tree_view_get_row_separator_func
- gtk_tree_view_set_fixed_height_mode
- gtk_tree_view_set_hover_expand
- gtk_tree_view_set_hover_selection
- gtk_tree_view_set_row_separator_func
- gtk_window_get_focus_on_map
- gtk_window_get_icon_name
- gtk_window_set_default_icon_name
- gtk_window_set_focus_on_map
- gtk_window_set_icon_name
-
- New gdk functions:
-
- gdk_display_request_selection_notification
- gdk_display_store_clipboard
- gdk_display_supports_clipboard_persistence
- gdk_display_supports_selection_notification
- gdk_drag_drop_succeeded
- gdk_window_configure_finished
- gdk_window_enable_synchronized_configure
- gdk_window_set_focus_on_map
-
-
-2004-11-04 Johan Dahlin <johan@gnome.org>
-
- * configure.in: post release version bump
-
-=== PyGtk 2.4.0 ===
-2004-11-04 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_dialog_add_buttons): Use
- PyTuple_GetSlice and PyArg_ParseTuple here, so we can get the same
- behavior as in add_button. Reported by Maciej Katafiasz, fixes #156707
-
- * tests/test_dialog.py: Add test for it
-
- * examples/gtk/filechooser.py: Fix typo
-
- * examples/gtk/uimanager.py: Simplify
-
- * tests/Makefile.am:
- * tests/gtype.py:
- * tests/test-thread.c:
- * tests/test-thread.h:
- * tests/test-unknown.c:
- * tests/test-unknown.h:
- * tests/test_unknown.py:
- * tests/testhelpermodule.c:
-
- Add tests for dynamic/unknown objects and interfaces.
-
-2004-10-28 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs (gtk_combo_box_set_model)
- (gtk_entry_completion_set_model) Allow model to be None and to
- default to None similar to gtk_tree_view_set_model.
- Fixes #155247 (Olivier Aubert).
-
-2004-10-22 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.override (_wrap_gtk_alignment_new): Change all
- gtk.Alignment constructor parameter default values back to 0, as
- it was before pygtk 2.4.
-
-2004-10-21 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.override (_wrap_gtk_adjustment_new): Change all
- gtk.Adjustment constructor parameter default values back to 0, as
- it was before pygtk 2.4.
-
-2004-10-13 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gobject/pygobject.h: s/typename/typename_/, because typename is
- a C++ keyword.
- Add G_BEGIN_DECLS / G_END_DECLS.
- Fixes #155304: pygobject.h cannot be included in C++ programs.
-
-2004-10-05 Johan Dahlin <johan@gnome.org>
-
- * gtk/libglade.override (pyglade_xml_lookup_type): Fix silly silly
- bug. When using typedict for a glade.XML object, AttributeErrors
- set when calling PyMapping_GetItemString on a dictionary isn't
- reset.
-
- I wonder why nobody tried this before? Sigh. At least it's my
- fault, so I have no one else to blame, even though I'm trying hard
-
-2004-10-03 John Finlay <finlay@moeraki.com>
-
- * examples/pygtk-demo/demos/dnd.py Fix popup dest code and
- use gobject timeout functions.
-
-2004-10-03 Johan Dahlin <johan@gnome.org>
-
- * configure.in: Post release version bump
-
-=== PyGtk 2.4.0 ===
-2004-10-03 Johan Dahlin <johan@gnome.org>
-
- * NEWS: Update
-
-2004-10-01 John Finlay <finlay@moeraki.com>
-
- * examples/pygtk-demo/* Replace the pygtk-demo with the new
- version written by Maik Hertha. Fixes #138823.
-
-2004-09-27 John Ehresman <jpe@wingide.com>
-
- * gobject/gobjectmodule.c (pyg_enable_threads): Allow gtk_main to
- be invoked from a thread created by the threading module by
- requiring the GIL be held when pyg_enable_threads is invoked.
-
-=== PyGtk 2.3.97 ===
-2004-09-28 Johan Dahlin <johan@gnome.org>
-
- * NEWS: Update
-
- * gobject/gobjectmodule.c:
- * gobject/pygobject-private.h:
- * gobject/pygobject.h:
- * tests/test_thread.py:
- * tests/testhelpermodule.c:
-
- Apply slighly modified fix from bug 149845
- This is make threading usable for both users of the threading
- module and users that requires interaction with threads from
- other extension modules.
-
-2004-09-28 Johan Dahlin <johan@gnome.org>
-
- * tests/testhelpermodule.c:
- * tests/test_thread.py: Add thread stuff, that emits stuff from
- another thread and does some enum magic.
-
-2004-09-27 John Ehresman <jpe@wingide.com>
-
- * gobject/gobjectmodule.c: New functions exposed through
- _PyGObject_Functions to work around bugs in the PyGILState
- api's
- * gobject/pygobject.h: idem
- * gobject/pygobject-private.h: idem
- * gtk/gtk.override (_wrap_gtk_main): add pyg_enable_threads()
- call to ensure thread state for thread invoking this function
- is remembered. Only call pyg_enable_threads() here if threads
- were previously enabled
-
-2004-09-27 John Ehresman <jpe@wingide.com>
-
- * tests/common.py: catch ImportError if glade is not found
- and set glade to None
-
-2004-09-27 Johan Dahlin <johan@gnome.org>
-
- * tests/testhelper.c: Small c module to help testing
-
- * codegen/codegen.py: Revert parts of
- Gustavos changes, so the size of interfaces are correct.
-
- * tests/test_subtype.py: tests for this, use testhelper here
- aswell
-
-2004-09-26 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gobject/pygobject-private.h, gobject/pygobject.h: Make
- PyGClosure structure semi-public, for gnome-python.
-
-2004-09-25 Johan Dahlin <johan@gnome.org>
-
- * tests/test_signal.py: Move some tests from gtype and rename from
- signal.py
-
-2004-09-25 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * tests/gtype.py (GTypeTest.testGObjectInvalidSignalOverride): New
- test with test case in #153718.
-
- * gobject/gobjectmodule.c (pyg_type_register):
- PyDict_GetItemString returnes a borrowed reference, therefore
- remove Py_DECREF(gsignals) and Py_DECREF(gproperties) everywhere.
-
- Fixes bug 153718: exception in overriden gsignals causes ref count
- problems.
-
-2004-09-24 James Henstridge <james@jamesh.id.au>
-
- * gtk/gdk.override (_wrap_gdk_color_parse): initialise the
- GdkColor struct to zeroes, so we don't get a random value in the
- "pixel" field after parsing the colour string.
-
-2004-09-22 John Ehresman <jpe@wingide.com>
-
- * gtk/gdk.override: (_wrap_gdk_color_new): pass int variables
- to ParseTupleAndKeywords and then assign to GdkColor fields
-
-2004-09-17 Johan Dahlin <johan@gnome.org>
-
- * gobject/pygflags.c: Filter out 0 values
-
- * Makefile.am:
- * docs/Makefile.am: Revert documentation changes
-
-2004-08-28 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.override (_wrap_gtk_bin_tp_init): override, chain to parent type.
- (_wrap_gtk_item_tp_init): idem.
- (_wrap_gtk_box_tp_init): idem.
- (_wrap_gtk_button_box_tp_init): idem.
- (_wrap_gtk_separator_tp_init): idem.
- (_wrap_gtk_separator_tp_init): idem.
- Partially fixes #150698.
-
-2004-08-27 Xavier Ordoquy <xordoquy@linovia.com>
-
- * gtk/gtk.override: raise a TypeError if an action callback
- isn't callable.
-
-2004-08-24 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.defs: Clarify the DeprecationWarning messages in
- gtk.Progress methods.
-
-2004-08-22 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * examples/gtk/widget.py (PyGtkWidget.__init__): Call
- gtk.Widget.__init__ instead of __gobject_init__.
-
- * gtk/gtkwidget.override (_wrap_gtk_widget_new): Override, chain
- to parent type. Fixes bug #150698.
-
-Sun Aug 22 09:47:12 2004 Owen Taylor <otaylor@redhat.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_list_store_reorder): Don't
- access private 'length' field of GtkTreeStore, rather use
- gtk_tree_model_iter_n_children().
-
-2004-08-21 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_font_button_new) Fix property name.
-
-2004-08-19 John Finlay <finlay@moeraki.com>
-
- * examples/simple/dnd.py
- * examples/simple.scribble.py Update.
-
- * examples/ide/pyide.py
- * examples/ide/browse.py
- * examples/ide/edit.py
- * examples/ide/gtkcons.py
- * examples/ide/gtkdb.py
- * examples/ide/gtkprof.py
- Update ide example program files.
- * examples/ide/dialogs.py Add helper dialogs.
-
-2004-08-16 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * examples/pygtk-demo/demos/entrycompletion.py: Add
- GtkEntryCompletion example, by Fernando San Martín Woerner.
-
- * examples/Makefile.am (EXTRA_DIST): Add fsmw's entrycompletion.py
- example.
-
- * codegen/codegen.py (GObjectWrapper.get_initial_class_substdict)
- (GInterfaceWrapper.get_initial_class_substdict)
- (GBoxedWrapper.get_initial_class_substdict)
- (GPointerWrapper.get_initial_class_substdict): Refactor substdict
- code: move most common items to parent class, and just override a
- few in subclasses. Set default value for slot tp_flags.
-
- * gobject/pygobject.c (pygobject_register_class): Remove hardcoded
- ( and unnecessary ) initialization of slots tp_dealloc,
- tp_traverse, tp_clear, tp_flags, tp_weaklistoffset, and
- tp_dictoffset. They will naturally inherit from parent type if unset.
-
- * codegen/codegen.py
- (GObjectWrapper.write_property_based_constructor): honor flag
- caller-owns-return.
- (Wrapper): Allow override of tp_traverse, tp_clear, tp_dealloc, tp_flags.
- (Wrapper.write_class): Allow slots listed by
- get_initial_*_substdict to be overridden.
-
-2004-08-14 John Finlay <finlay@moeraki.com>
-
- * gobject/pygenum.c (pyg_enum_repr) Match enum values to avoid
- segfaults when enum minimum isn't 0 and values aren't a continuous
- sequence.
-
-Wed Aug 11 11:43:07 2004 Jonathan Blandford <jrb@redhat.com>
-
- * Makefile.am:
- * gtk/Makefile.am: use $(pyexecdir) instead of $(pythondir)
- as the module as a whole should be installed in the same place,
- #149849
-
-2004-08-10 Johan Dahlin <johan@gnome.org>
-
- * Makefile.am (dist-nodoc): New target
-
- * docs/ref: Adding Johns reference manual
-
- * docs/: (incomplete) buildsystem for documentation and removing
- old documentation
-
-2004-08-08 John Finlay <finlay@moeraki.com>
-
- * gobject/pygflags.c (pyg_flags_add) Return NULL when no stub.
-
-2004-08-06 Johan Dahlin <johan@gnome.org>
-
- * configure.in (ACLOCAL):
-
- * setup.py (MICRO_VERSION): Post release version bump
-
-
-=== PyGtk 2.3.96 ===
-2004-08-06 Johan Dahlin <johan@gnome.org>
- * NEWS: Update.
-
- * gobject/pygflags.c (pyg_flags_from_gtype): Don't comment out the
- fallback, it break the test. (Wow, the testsuite caught another bug!)
-
- * tests/enum.py: Additional tests.
-
- * gobject/pygenum.c (pyg_enum_repr): Don't use g_enum_get_value,
- use enum_class->values[n].value_name instead. Also check if the
- value is NULL or not. This makes gtk.icon_size_register work a
- little bit better.
-
- * codegen/codegen.py (Wrapper.write_methods): Use methflags
- argument for defines instead of discarding it
-
-2004-08-04 John Finlay <finlay@moeraki.com>
-
- * codegen/argtypes.py Return string instead of Atom.
-
- * gtk/gtk.override (_wrap_gtk_selection_data_get_targets)
- (_wrap_gtk_drag_dest_find_target)
- (_wrap_gtk_drag_dest_get_target_list)
- (_wrap_gtk_clipboard_wait_for_targets)
- (clipboard_request_targets_cb)
- Return string(s) instead of Atom(s).
-
- * gtk/gtkmodule.c (init_gtk) Add string instead of Atom using
- add_atom.
-
-2004-08-04 Johan Dahlin <johan@gnome.org>
-
- * tests/enum.py (EnumTest.testOutofBounds): New test.
-
- * gobject/pygflags.c (pyg_flags_from_gtype):
- * gobject/pygenum.c (pyg_enum_from_gtype): Don't segfault on
- unknown values.
-
-2004-08-04 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_stock_lookup)
- (_wrap_gtk_accelerator_parse) (gtk_accel_map_lookup_entry)
- Use flags instead of enum.
-
- gtk/gdk.override (_wrap_gdk_event_tp_getattr)
- Return flags instead of ints for event members.
- (_wrap_gdk_device_get_state) (_wrap_gdk_window_get_pointer)
- (_wrap_gdk_display_get_pointer) (_wrap_gdk_event_get_state)
- (_wrap_gdk_keymap_translate_keyboard_state)
- Return flags instead of ints
-
-2004-08-04 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * everywhere: s/PyGILState_Ensure/pyg_gil_state_ensure;
- s/PyGILState_Relase/pyg_gil_state_release;
- s/Py_BEGIN_ALLOW_THREADS/pyg_begin_allow_threads;
- s/Py_END_ALLOW_THREADS/pyg_end_allow_threads;
-
- * gobject/pygobject-private.h, gobject/pygobject.h: Add new macros
- pyg_threads_enabled, pyg_gil_state_ensure, pyg_gil_state_release,
- pyg_begin_allow_threads,
- pyg_end_allow_threads. pyg_threads_enabled indicates whether
- threads are currently enabled. The others just mimick the
- equivalent python functions, except that they do nothing when
- threads are not enabled.
-
- * gobject/pygobject.h: Add boolean flag to pygobject API structure
- indicating whether threading is activated; also add enable_threads
- api entry point.
-
- * gobject/gobjectmodule.c (pyg_enable_threads): New pygobject API
- function to activate pygtk thread awareness.
- (pyg_threads_init): gobject.threads_init(), calls pyg_enable_threads.
-
-2004-08-04 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_accel_map_lookup_entry):
- GdkModifierType is flags not an enum.
-
- * gobject/pygenum.c (pyg_enum_from_gtype): Don't crash if its not
- an enum
-
- * gobject/pygflags.c (pyg_flags_from_gtype): Don't crash if its
- not flags
-
-2004-08-03 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gobject/pygobject.c (pygobject_emit): Remove unused variable _save
-
- * gtk/gtkmodule.c (_pygtk_log_func): Aquire GIL.
-
-2004-08-03 Johan Dahlin <johan@gnome.org>
-
- * gobject/pygenum.c (pyg_enum_from_gtype): Create a new GType on
- the fly if there isn't one for the GType.
- (pyg_enum_add): Allow module to be NULL.
-
- * codegen/argtypes.py:
- * gobject/gobjectmodule.c: (pyg_source_remove):
- * gobject/pygmaincontext.c: (_wrap_g_main_context_iteration),
- (_wrap_g_main_context_pending):
- * gobject/pygmainloop.c: (_wrap_g_main_loop_is_running):
- * gobject/pygobject.c: (pygobject_handler_is_connected):
- * gobject/pygparamspec.c: (pyg_param_spec_getattr):
- * gobject/pygtype.c: (pyg_value_as_pyobject):
- * gtk/gdk.override:
- * gtk/gtk.override:
- * gtk/gtktextview.override:
- * gtk/gtkwidget.override:
- * pango.override: Add better support for boolean type now when
- we can require 2.3. Fixes bug 149121
-
-2004-08-03 Johan Dahlin <johan@gnome.org>
-
- * gtk/pygtktreemodel.c: Clean up most functions here to have only
- one return path.
-
- * gobject/pygobject.c (pygobject_emit): Protect g_value_unset by
- UNBLOCK/BLOCK_THREADS since it might call pygobject_free which
- will result in a deadlock.
-
- * gobject/gobjectmodule.c (pyg_thread_init): New function, move
- thread initalization stuff in here.
-
- * All over the place: Kill pyg_block/unblock_threads and use
- PyGILState and Py_BEGIN/END_ALLOW_THREADS.
-
- unblock [code] block calls are replaced by Py_BEGIN/END and
- block [code] unblock calls are replaced by PyGILState.
-
-2004-08-03 Xavier Ordoquy <xordoquy@linovia.com>
-
- * autogen.sh: Takes ACLOCAL_FLAGS into account.
- Fixes #149115 (Mariano Suárez-Alvarez)
-
-2004-08-02 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs (gtk_expander_new) (gtk_expander_new_with_mnemonic)
- label can be None - make label optional
- (gtk_expander_set_label) (gtk_expander_set_label_widget)
- label and label_widget can be None
-
-2004-08-02 Johan Dahlin <johan@gnome.org>
-
- * configure.in: Post release version bump
-
- * setup.py (MICRO_VERSION):
-
-=== PyGtk 2.3.95 ===
-2004-08-02 Johan Dahlin <johan@gnome.org>
-
- * NEWS: Update
-
- * gobject/gobjectmodule.c (initgobject): Call
- PyEval_InitThreads. Perhaps its something that always should be
- called.
-
- * README (Author): Add a requirements section
-
- * configure.in: Require Python 2.3
-
- * setup.py (version): Ditto
-
- * gobject/pygtype.c, gobject/pygobject.h: Remove 2.2 compat.
-
- * All over the place: Add support for PyGILState.
-
-2004-07-30 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_adjustment_new) Impl.
- Rearrange arg_names and prop_names so value is last.
- Fixes #148860 (Steve Chaplin).
-
-2004-07-29 John Ehresman <jpe@wingide.com>
-
- * setup.py: Remove --enable-threading from argv before calling
- distutils
-
-2004-07-29 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_action_get_proxies)
- slist should not be freed. Fixes 148801. (Abel Daniel)
-
-2004-07-29 John Ehresman <jpe@wingide.com>
-
- * setup.py: Add --disable-numeric option to disable numeric support
- even when the runtime check finds it
-
-2004-04-01 Scott Tai <scottt958@yahoo.com.tw>
-
- Reviewed by: Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.override: Remove ignore for win32, the functions are now
- implemented on win32 fixes bug 138804
-
-2004-06-14 Benjamin Otte <in7y118@public.uni-hamburg.de>
-
- Reviewed by: Johan Dahlin <johan@gnome.org>:
-
- * codegen/h2def.py (write_func): only remove the first occurence of
- the object name, we don't want to mess up the function name,
- fixes bug 144363
-
-2004-07-29 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_list_store_insert_before)
- (_wrap_gtk_list_store_insert_after) Allow sibling to be None.
- Fixes #148751 (Steve Chaplin)
-
- * gtk/pygtktreemodel.c Fix reference leaks. Fixes#148748. Thanks
- to Tim Evans.
-
-2004-07-29 Johan Dahlin <johan@gnome.org>
-
- * tests/gtype.py (GTypeTest.checkType): Use
- gobject.type_name,type_from_name for testing instead of GtkListStore.
-
-2004-07-28 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_view_get_cursor)
- (_wrap_gtk_tree_sortable_get_sort_column_id)
- (_wrap_gtk_tree_view_get_drag_dest_row)
- (_wrap_gtk_tree_view_get_dest_row_at_pos)
- Fix reference leaks.
-
- * gtk/gtk.override (_wrap_gtk_box_query_child_packing)
- (_wrap_gtk_notebook_query_tab_label_packing)
- (_wrap_gtk_tooltips__get_active_tips_data)
- (_wrap_gtk_tooltips__get_tips_data_list)
- (_wrap_gtk_image_get_pixmap) (_wrap_gtk_image_get_image)
- (_wrap_gtk_image_get_stock) (_wrap_gtk_image_get_icon_set)
- (_wrap_gtk_scrolled_window_get_policy)
- (_wrap_gtk_tooltips_data_get) (_wrap_gtk_accel_map_lookup_entry)
- Fix reference leaks.
-
- * pango.override (pypango_attr_iterator_get_font)
- Fix reference leaks.
-
-2004-07-28 Johan Dahlin <johan@gnome.org>
-
- * gobject/pygenum.c (pyg_enum_compare):
- * gobject/pygflags.c (pyg_flags_compare): Reverse operator, it was
- wrong before, spotted by Abel Daniel
-
- * tests/enum.py (FlagsTest.testComparision)
- (FlagsTest.testComparision): New tests
-
- * gobject/pygtype.c (pyg_type_from_object): If we're on python
- 2.3, also check for PyBool_Type. Fixes #148684 (Steve Chaplin)
-
- * tests/gtype.py (GTypeTest.testBoolType): New test
-
-2004-07-27 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-types.c (pygdk_atom_compare) Remove.
- (pygdk_atom_richcompare) Implement with comparison to strings.
- (PyGdkAtom_Type) Set tp_compare to 0 and tp_richcompare to
- pygdk_atom_richcompare.
- Allow an Atom to be compared with a string. Fixes #148564.
-
-2004-07-26 Johan Dahlin <johan@gnome.org>
-
- * acinclude.m4: Remove, replaced with:
-
- * m4/jhflags.m4: New file, includes compiler macros
-
- * m4/python.m4: New file, includes python macros
-
- * autogen.sh: Copy over autogen.sh from gnome-common.h
-
- * gtk/__init__.py: Readd _gobject, but warn if it's used
-
-2004-07-25 John Finlay <finlay@moeraki.com>
-
- * gtk/pygtktreemodel.c (pygtk_generic_tree_model_get_value)
- Skip pyg_value_from_pyobject() if return value is Py_None.
- Fixes #148230.
-
-2004-07-23 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (clipboard_request_text_cb) Fix bug when no text.
- (clipboard_request_targets_cb) Fix bug when no targets.
-
-2004-07-23 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.override (_wrap_gtk_list_item_new): Add deprecation warning.
-
- * codegen/codegen.py (write_property_based_constructor): Honor the
- "deprecated" option.
-
-2004-07-23 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_dialog_new_with_buttons)
- (_wrap_gtk_message_dialog_new)
- Use pyg_flags_get_value().
-
- * gtk/gtk-types.defs (TextSearchFlags) Fix typo.
-
- * gtk/gtktextview.override (_wrap_gtk_text_iter_forward_search)
- (_wrap_gtk_text_iter_backward_search)
- Use pyg_flags_get_value.
-
- * gtk/gtk-extrafuncs.defs (flags) (set_flags) (unset_flags)
- Use GtkWidgetFlags as args and return value.
-
-2004-07-22 Johan Dahlin <johan@gnome.org>
-
- * setup.py (MICRO_VERSION):
- * configure.in: Post release version bump
-
-=== PyGtk 2.3.94 ===
-2004-07-22 Johan Dahlin <johan@gnome.org>
-
- * NEWS: Update
-
-2004-07-21 Johan Dahlin <johan@gnome.org>
-
- * gobject/pygflags.c (pyg_flags_get_first_value_name)
- (pyg_flags_get_first_value_nick): Add, so Lorenzo can introspect
- flags properly too
- (pyg_flags_get_value_names, pyg_flags_get_value_nicks): Make this
- a little bit more useful. All values can still be fetch
- through __flags_values__
-
- * tests/enum.py: Improve and extend to test most enum/flags operations
-
-2004-07-20 John Finlay <finlay@moeraki.com>
-
- * codegen/codegen.py (write_enums) Fix bug causing segfault when
- loading pango module.
-
-2004-07-20 Lorenzo Gil Sanchez <lgs@sicem.biz>
-
- * gtk/gtk.override (_wrap_gtk_file_chooser_dialog_new): fixed a
- compilation error: 'window' variable should be 'parent'
-
-2004-07-20 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_file_chooser_dialog_new): Simplify,
- fix name in exceptions and remove warning.
-
- * gobject/pygenum.c (pyg_enum_from_gtype): Fall back to int for
- unregistered enums.
-
- * gobject/pygflags.c (pyg_flags_from_gtype): Ditto
-
- * gobject/gobjectmodule.c (initgobject): Rename back to MainLoop, MainContext
-
-2004-07-19 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/libglade.override (_wrap_glade_xml_new): Allow pydict to be unset.
-
-2004-07-19 Johan Dahlin <johan@gnome.org>
-
- * setup.py (MICRO_VERSION):
- * configure.in: Post release version bump
-
-=== PyGtk 2.3.93 ===
-2004-07-19 Johan Dahlin <johan@gnome.org>
-
- * NEWS: Update
-
- * gtk/gtk.override (_wrap_gtk_dialog_new_with_buttons): Return
- 1/0, instead of flagvalue/0 to avoid GObject complains.
- (_wrap_gtk_dialog_run): Simplify
-
- * gtk/libglade.override: Subclass GladeXML so we can wrap
- lookup_type. Add a new optional argument to GladeXML.__init__ that
- is a mapping object that will be used to translate types. Thanks
- to Gustavo for helping out. This should make kiko somewhat
- happy. Fixes bug 140071
-
- * tests/enum.py (EnumTest.testWindowGetState): Fix, a window is
- really WITHDRAWN if it's not SHOWN and not ICONIFIED...
-
- * tests/common.py: Add .. and ../gobject when distcheck isn't ran
-
- * gobject/pygenum.c: Use a dict instead of a tuple for
- __enum_values__, so we can handle negative enum values (eg: GDK_NOTHING)
-
- * gobject/pyflags.c: Ditto for __flag_values__
-
- * gobject/pygparamspec.c (pyg_param_spec_getattr): reference count fixing
-
- * gobject/Makefile.am:
- * setup.py:
- * makefile.msc: Update, why do I even bother to update 3 different
- build systems?
-
- * gobject/: Split out GParamSpec, GMainLoop, GMainContext and
- GPointer to separate files. Also remove *.h files and go back to
- the old scheme (everything in pygobject.h)
-
- * description.py: Remove, out of date since 0.6.x!
-
- * tests/Makefile.am, tests/common.py: Make distcheck pass
-
-2004-07-18 John Ehresman <jpe@wingide.com>
-
- * gobject/pygflags.c, gobject/pygenum.c, gobject/gobjectmodule.c
- (initgobject): Remove references to &PyInt_Type from static type
- struct initialization and manually set it before PyType_Ready calls
-
- * makefile.msc, gtk/makefile.msc, gobject/makefile.msc: VC++ makefile
- changes for new directory layout
-
-2004-07-18 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_action_group_add_radio_actions)
- (_wrap_gtk_action_group_add_toggle_actions)
- (_wrap_gtk_action_group_add_actions): Add optional user_data argument.
-
- * gobject/pygflags.c (pyg_flags_get_value_nicks)
- (pyg_flags_get_value_names): New getters
-
- * gobject/pygenum.c (pyg_enum_get_value_nick)
- (pyg_enum_get_value_name): New getters
-
- * gobject/gobjectmodule.c (pyg_param_spec_getattr): add enum_class
- and flags_class properties.
-
-2004-07-18 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.defs (gtk_combo_new): Add deprectation warning.
- (gtk_item_factory_new): idem.
- (gtk_list_item_new): idem.
- (gtk_list_item_new_with_label): idem.
- (gtk_option_menu_new): idem.
-
- * gtk/gtkclist.override (_wrap_gtk_clist_new_with_titles): Give
- deprecation warning.
-
- * gtk/gtkctree.override (_wrap_gtk_ctree_new_with_titles): Give
- deprecation warning.
-
- * gtk/gtk.defs (plug_new_for_display): Deprecate, since the
- regular gtk.Plug constructor can accept a GdkDisplay now.
-
- * gtk/gtk.override (_wrap_gtk_plug_new): Override constructor,
- convert to g_object_new based; Add optional parameter 'display',
- available since Gtk 2.2.
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_view_column_new):
- Convert constructor to property based.
-
- * gtk/gtk.defs (gtk_vscrollbar_new): Convert constructor to
- property based.
- (gtk_tree_view_new_with_model): idem.
- (gtk_text_view_new_with_buffer): idem.
-
- * gtk/gtk.override (_wrap_gtk_pixmap_new): Override
- _wrap_gtk_pixmap_new, construct with g_object_new.
-
-2004-07-17 Johan Dahlin <johan@gnome.org>
-
- * tests/enum.py: add, forgot it in last commit
-
- * gobject/: Move gobject source files in here.
-
-2004-07-17 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.override (_wrap_gtk_dialog_new_with_buttons): Don't pass
- 'parent' property if no parent is given or is None.
-
-2004-07-17 Johan Dahlin <johan@gnome.org>
-
- * codegen/codegen.py:
- * codegen/argtypes.py: Update for enums
-
- * pygtype.c (pyg_value_as_pyobject): Use new enum/flag functions
-
- * pygenum.[ch]: Handle GFlag
-
- * pygflags.[ch]: Handle GFlag
-
- * atk-types.defs: Fix gtype-id for all enums
-
- * gobjectmodule.c (initgobject): Clean up and add convinience macros
-
- * tests/enum.py: New file
-
- * tests/common.py: New file, also stole from gst-python
-
-2004-07-17 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.override (_wrap_gtk_table_new): Override to allow rows
- and columns default to 1, unlike the underlying gtk/C API which
- defaults to 0.
-
-2004-07-15 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_menu_item_new): Use AccelLabel instead
- of Label and dup MenuItem creation process.
- (_wrap_gtk_check_menu_item_new): idem
- (_wrap_gtk_radio_menu_item_new): idem.
- (_wrap_gtk_button_new): Set "use_underline" to TRUE when stock item
- (_wrap_gtk_check_button_new): Add optional argument
- 'use_underline', defaulting to TRUE.
- (_wrap_gtk_radio_button_new): idem.
- (_wrap_gtk_toggle_button_new): idem.
- (_wrap_gtk_message_dialog_new) Fix erroneous error message.
- #147421
-
-2004-07-15 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.override (_wrap_gtk_menu_item_new): add optional argument
- 'use_underline', defaulting to True.
- (_wrap_gtk_radio_check_menu_item_new): idem.
- (_wrap_gtk_radio_menu_item_new): idem.
- (_wrap_gtk_button_new): idem.
- Fixes #147421.
-
-2004-07-13 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.override (_wrap_gtk_button_new): Construct with
- g_object_new.
- (_wrap_gtk_toggle_button_new): idem.
- (_wrap_gtk_check_button_new): idem.
- (_wrap_gtk_radio_button_new): idem.
- (_wrap_gtk_menu_item_new): idem.
- (_wrap_gtk_check_menu_item_new): idem.
- (_wrap_gtk_radio_menu_item_new): idem.
- (_wrap_gtk_check_menu_item_new): idem.
- (_wrap_gtk_progress_bar_new_with_adjustment): idem.
- (_wrap_gtk_file_chooser_new): idem.
- (_wrap_gtk_color_button_new): idem.
- (_wrap_gtk_combo_box_new): idem.
- (_wrap_gtk_combo_box_entry_new): idem.
- (_wrap_gtk_file_chooser_widget_new): idem.
- (_wrap_gtk_font_button_new): idem.
- (_wrap_gtk_radio_tool_button_new): idem.
- (_wrap_gtk_toggle_tool__button_new): idem.
- (_wrap_gtk_tool_button_new): idem.
- (_wrap_gtk_entry_new): idem.
- (_wrap_gtk_dialog_new_with_buttons): idem.
-
- (_wrap_gtk_image_menu_item_new): Raise exception if attempted to
- subclass this object without calling __gobject_init__.
- (_wrap_gtk_message_dialog_new): idem.
-
-2004-07-12 John Finlay <finlay@moeraki.com>
-
- * gtk/gtkwindow.override (set_geometry_hints) Fix arg format string.
- Fixes #147458. Thanks to Theo Reed.
-
-2004-07-10 Johan Dahlin <johan@gnome.org>
-
- * tests/runtests.py: New script to run all tests in one take
-
- * tests/Makefile.am: autotoolify
-
- * tests/signal.py: New simple test taken from
- examples/gobject/signal.py
-
-2004-07-08 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.defs: Change to most constructors to property based.
-
- * codegen/codegen.py (GObjectWrapper.write_property_based_constructor):
- Handle propname != argname cases.
-
- * codegen/definitions.py (FunctionDef.__init__): Parse (argname
- "xxx") inside properties list, to support argname != propname.
- (Property.__init__): Accept new argname parameter.
-
-2004-07-07 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * codegen/definitions.py (FunctionDef.write_defs): Handle new
- properties syntax.
-
- * gtk/gdk.override (_wrap_gdk_colormap_alloc_color): Raise
- ValueError instead of TypeError if unable to parse colour
- specification.
- (_wrap_gdk_color_parse): idem. Fixes #144862.
-
-2004-07-04 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_model_rows_reordered)
- Allow None, () or "" for top level path.
-
-2004-07-04 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.defs (gtk_hbox_new): Change constructor to property based.
-
- * gobjectmodule.c (pyg_parse_constructor_args): Helper function
- invoked from the generated constructors.
-
- * codegen/codegen.py (Wrapper.write_constructor): Delegate to
- self.write_property_based_constructor() when appropriate.
- (GObjectWrapper.write_property_based_constructor): New constructor
- generator, that writes constructors that use g_object_newv and
- pass constructor arguments as properties.
-
- * codegen/definitions.py (Parameter): New Parameter class, to hold
- the items in (parameter ...). Emulates tuple for compatibility,
- but is more extensible.
- (Property): New property class, to hold (property ...) items.
- (FunctionDef.__init__): Parse (property ...), for new property
- based constructors.
-
-2004-07-04 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_store_new) Fix typo.
- (_wrap_gtk_tree_model_rows_reordered) Allow None for path and iter
- to allow reordering top level rows. Fixes #143834.
- John Ehresman's patch with mods.
-
-2004-07-04 John Ehresman <jpe@wingide.com>
-
- * tests directory: unit tests
-
-2004-07-04 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_store_new): Use
- g_object_newv to create instance, thus allowing subclassing
- without __gobject_init__.
-
- * gtk/gtkmodule.c (init_gtk): Register new warning category,
- GtkWarning. Register a log handler for Gtk warnings that issues a
- python warning using GtkWarning category.
-
-2004-07-04 John Ehresman <jpe@wingide.com>
-
- * codegen/argtypes.py (GUniCharArg): Use the converter function
- pyg_pyobj_to_unichar_conv to parse gunichar parameters, instead of
- templated code.
-
- * pygtype.c (pyg_pyobj_to_unichar_conv): impl.
-
- * pygobject.h, gobjectmodule.c: Add pyg_pyobj_to_unichar_conv to list of
- exported functions.
-
-2004-07-04 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gdk.override (_wrap_gdk_colormap_query_color): Implement
- gdk.Colormap.query_color.
-
- * gtk/gdk.defs (query_color): Add gdk.Colormap.query_color.
-
- * gtk/gtktreeview.override (pygtk_set_search_equal_func_marshal):
- Column is integer, not PyGObject! :-/
-
-2004-07-03 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs
- * gtk/gtk-extrafuncs.defs I goofed in placing the GenericTreeModel
- methods. Now they should be in the right place.
-
- * gtk/gtktreeview.override Ignore gtk_tree_view_get_search_equal_func.
-
- * gtk/pygtktreemodel.c
- * gtk/pygtktreemodel.h
- * gtk/gtk.defs
- Add stamp to GenericTreeModel to use in detecting valid TreeIters.
- Add invalidate_iters() method to allow custom tree models to
- manage TreeIters when not persistent.
- Add iter_is_valid() method to allow apps to determine if a TreeIter
- for a custom tree model is valid.
-
-2004-07-03 Ross Burton <ross@burtonini.com>
-
- * gtk/gdk.defs: Add gdk_pixbuf_new_subpixbuf.
-
-2004-07-03 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtktreeview.override (_wrap_gtk_list_store_new): Construct
- object with g_object_newv, then call
- gtk_list_store_set_column_types(). Fixes #123037.
- (_wrap_gtk_tree_view_set_search_equal_func): Impl. Most code is
- copy-paste from
- _wrap_gtk_tree_view_set_column_drag_function. Fixes #145342.
- (_wrap_gtk_tree_selection_get_selected_rows): Initialize model to
- NULL, to avoid crash when the tree is empty.
-
-2004-06-29 Lorenzo Gil Sanchez <lgs@cvs.gnome.org>
-
- * setup.py: changed the version to 2.3.93 so we can build it on Windows
- with correct version information.
-
-2004-06-28 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gdk.override (_wrap_gdk_window_set_user_data): Fixup and do
- some real testing of last changes, to make this really safe using
- a pair of mutual weak references between the widget and its
- window. Fixes #145091.
-
-2004-06-27 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * codegen/definitions.py
- (Definition.guess_return_value_ownership): new method (name to
- guess default value for caller_owns_return.
- (MethodDef.__init__): Call guess_return_value_ownership here.
- (FunctionDef.__init__): And here as well.
- (get_valid_scheme_definitions): new function to filter out invalid
- elements in a definition.
- (ObjectDef.__init__): Use get_valid_scheme_definitions here.
- (InterfaceDef.__init__): and here
- (EnumDef.__init__): here too
- (BoxedDef.__init__): and here
- (PointerDef.__init__): here as well
- (MethodDef.__init__): idem
- (FunctionDef.__init__): idem
- Paches by Scott Tsai, with a bit of refactoring by me.
-
- * gtk/gdk.override (_wrap_gdk_color_parse): Raise TypeError when
- color cannot be parsed. Fixes #144862.
-
- * gtk/gtk.override (_wrap_gtk_adjustment__set_value): Use
- pygtk_util_pyobject_as_double to convert the value.
- (_wrap_gtk_adjustment__set_lower): idem
- (_wrap_gtk_adjustment__set_upper): idem
- (_wrap_gtk_adjustment__set_step_increment): idem
- (_wrap_gtk_adjustment__set_page_increment): idem
- (_wrap_gtk_adjustment__set_page_size): idem
- (pygtk_util_pyobject_as_double): New utility function to convert
- any numeric object to C double.
-
- * gtk/gdk.override (_wrap_gdk_window_set_user_data): Raise
- TypeError instead of value error when user data is not of
- gtk.Widget type.
- (_wrap_gdk_window_set_user_data): Add weak reference to the widget
- for increased safety, just in case the widget is ever destroyed
- before the window, however unlikely that may be...
-
-2004-06-26 Lorenzo Gil Sanchez <lgs@cvs.gnome.org>
-
- * gtk/gdk.override (_wrap_gdk_window_set_user_data): only allow
- GtkWidgets to be the user data
- (_wrap_gdk_display_list_devices): only get GtkWidgets to be simetric
- with _wrap_gdk_window_set_user_data
-
- * gtk/gtk.defs : modified the parameters of some GtkNotebook methods
- so they can accept NULL arguments
-
- * gtk/gtk.override: removed the _wrap_gtk_notebook_insert_page and
- _wrap_gtk_notebook_set_tab_label since they are not needed anymore with
- the changes to gtk/gtk.defs
-
-2004-06-20 Scott Tsai <scottt958@yahoo.com.tw>
-
- * codegen/argtypes.py (ObjectArg.write_return): Check for NULL
- GObject before unreffing. Fixes Bug 137086 (gtk.gdk.window_lookup
- assertion). (reviewed by Gustavo Carneiro)
-
-2004-06-20 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtkmodule.c (init_gtk): Just like GtkWindow, register custom
- sink function for GtkInvisible type.
-
- * codegen/codegen.py
- (GObjectWrapper.get_initial_constructor_substdict): Removed
- special treatment of GtkInvisible, no longer needed.
-
- * gtk/gtkmodule.c (sink_gtkinvisible): Copy-paste from sink_gtkwindow.
-
- * pygobject.c (pygobject_new_with_interfaces): Add hack to
- workaround python tp_(get|set)attr slot inheritance bug. Fixes
- pygtk bug #144135 (gtk.gdk.GC attributes not working).
-
-2004-06-18 Lorenzo Gil Sanchez <lgs@cvs.gnome.org>
-
- * gtk/gdk.override (_wrap_gdk_window_get_user_data): finally I got it
- working with Gustavo's help
-
- * gtk/gdk.override (_wrap_gdk_window_get_user_data): make it compile
- again
-
- * gtk/gdk.defs (get_user_data): added so we can implement
- _wrap_gdk_window_get_user_data
-
- * gtk/gdk.override (_wrap_gdk_window_get_user_data): implemented so
- we can retrieve the GtkWidget of a GdkWindow. By the way, is it
- possible to know if a gpointer is a PyObject?
-
- * gtk/gtk.override (_wrap_gtk_notebook_insert_page): allow to insert
- pages without a tab_label widget (i.e None) so a default one is created
- by GTK+.
- (_wrap_gtk_notebook_set_tab_label): allow to set a None tab_label
- widget so a default one is created by GTK+
-
-2004-06-14 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_clipboard_set_with_data)
- (_wrap_gtk_drag_dest_set) (_wrap_gtk_drag_dest_find_target)
- (_wrap_gtk_drag_dest_set_target_list) (_wrap_gtk_drag_source_set)
- (_wrap_gtk_drag_begin) (_wrap_gtk_selection_add_targets)
- Avoid segfault if first item in a py_targets tuple is None by
- forcing first item to be a string.
- (_wrap_gtk_drag_dest_get_target_list) target_list should not
- be unreffed.
-
-2004-06-14 Lorenzo Gil Sanchez <lgs@cvs.gnome.org>
-
- * gtk/gtkwidget.override (_wrap_gtk_widget_hide_on_delete): added dummy
- args so you can do win.connect ('delete-event', win.hide_on_delete)
-
-2004-06-13 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtkmodule.c (sink_gtkobject, init_gtk): Add custom sink
- function, that increments reference count of newly created
- GtkWindow's. Solution provided by James Henstridge, code by Jon
- Trowbridge. Fixes "Bug 122569: gtk.Window derived class segfaults."
-
- * codegen/codegen.py
- (GObjectWrapper.get_initial_constructor_substdict): Special
- treatment for GtkWindow no longer necessary due to the custom sink
- function.
-
-2004-06-12 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_accel_groups_from_object): For Kiko.
-
-2004-06-11 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.override (pygdk_filter_func_marshal): Return a
- GdkEventType and not a PyObject. Fixes bug 143420 (Tim Evans).
-
-2004-06-09 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_action_group_add_radio_actions)
- Fix bug preventing callback being connected. Fixes #144022. Thanks
- to Steve Chaplin.
-
-2004-06-09 Lorenzo Gil Sanchez <lgs@cvs.gnome.org>
-
- * examples/gtk/widget.py (PyGtkWidget.do_size_request): change the
- allocation parameter to requisition so we have a more clear example.
-
-2004-06-07 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * examples/gtk/widget.py: Don't manually send configure events.
- Instead, override size-request, taking the exact size of the text
- and border width into consideration.
-
-2004-06-06 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.override (_wrap_gdk_event_tp_setattr): Add
- GDK_PROPERTY_NOTIFY attributes.
-
-2004-06-04 Johan Dahlin <johan@gnome.org>
-
- * gobjectmodule.c (pyg_param_spec_getattr): Add support for
- paramspec.default_value for GParamSpec types that support it
-
-2004-06-04 Lorenzo Gil Sanchez <lgst@cvs.gnome.org>
-
- * gobjectmodule.c (initgobject): added gobject.TYPE_UNICHAR
-
-2004-06-04 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtkwidget.override (_wrap_gtk_widget_class_install_style_property): Impl
-
- * gtk/gtkcontainer.override
- (_wrap_gtk_container_class_list_child_properties): Rename first
- kwlist argument to klass (from widget), class should be a
- GObjectClass and not a GtkWidgetClass
- (_wrap_gtk_container_class_install_child_property): Impl.
-
- * gtk/gtk.defs: Change a couple of methods to functions and set
- correct class
-
- * pygobject.h: Add pyg_param_spec_from_object
-
- * gobjectmodule.c (create_property): Don't install the property
- here, return it instead. And don't require a GObjectClass as argument
- (pyg_param_spec_from_object): New function
- (add_properties): Update to new create_property
- (pygobject_api_functions): Export pyg_param_spec_from_object
-
- * gtk/gtkcontainer.override
- (_wrap_gtk_container_class_list_child_properties): Implement for Lorenzo.
-
- * gtk/gdk.override (_wrap_gdk_event_tp_setattr): Fix up *_CHECK calls
-
- * examples/gtk/widget.py: Add a new example of subclassing a GtkWidget.
-
- * Makefile.am (EXTRA_DIST): Add widget.py
-
- * pygobject.c (pygobject_new): guard object_ref call
-
- * examples/gtk/uimanager.py: Some more polishing, it'll never be finished!
-
- * gtk/gtkwidget.override (_wrap_gtk_widget__set_allocation): Impl.
- (_wrap_gtk_widget__set_window): Impl.
-
- * gtk/gtkclist.override (_wrap_gtk_clist_new_with_titles): put
- all clist overrides here.
-
- * gtk/gtk.override (_wrap_gtk_paint_polygon): Move gtk_widgets_*
- ignore definitions to gtkwidget.override and clist_* to
- gtkclist.override
- (_wrap_gtk_action_group_add_actions): guard ref call
- (_wrap_gtk_action_group_add_toggle_actions): ditto
- (_wrap_gtk_action_group_add_radio_actions): ditto
-
- * gtk/gtk-types.c (_pygtk_style_helper_new): guard ref call.
-
- * gtk/gdk.override (_wrap_gdk_event_tp_setattr): Impl.
- (I'll have nightmares about this code)
- (_wrap_gdk_window_new): Clean up a little bit: Proper use of enums
- and set a boolean to b instead of i. Block unref calls for thread
- safety issues.
- (_wrap_gdk_window_set_user_data): Impl. This is also a hairy
- implementation: If it's a GtkWidget, get the GObject, otherwise
- put the real pyobject in there. Maybe we should just always put
- the widget in there.
- (_wrap_gdk_window_add_filter): Thread safety.
-
-2004-05-30 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_store_reorder) Fix
- bug I inserted in check for GtkTreeIter.
-
-2004-05-29 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override
- (_wrap_gtk_tree_view_set_column_drag_function) Add. Fixes #127504.
-
-2004-05-28 John Finlay <finlay@moeraki.com>
-
- * gtk/gtkcontainer.override (_wrap_gtk_container_child_set)
- (_wrap_gtk_container_child_get)
- (_wrap_gtk_container_add_with_properties) Check that at least
- one arg is passed to method to avoid segfault.
-
- * gtk/gtk.override (_wrap_gtk_entry_new)
- * gtk/gtk.defs (gtk_entry_new) (gtk_entry_new_with_max_length)
- Apply patch from Scott Tsai. Fixes #139190.
-
-2004-05-28 Johan Dahlin <johan@gnome.org>
-
- * examples/gtk/uimanager.py: Add a toolbar and fix shortcuts.
-
-2004-05-27 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override
- Ignore: gtk_tree_view_column_pack_start
- gtk_tree_view_column_pack_end
- gtk_tree_view_column_clear
- gtk_tree_view_column_set_attributes - these are now covered by the
- GtkCellLayout interface. Couldn't do the same for
- gtk_tree_view_column_add_attribute and
- gtk_tree_view_column_clear_attributes due to backward compatibility.
-
-2004-05-25 John Finlay <finlay@moeraki.com>
-
- * examples/gtk/filechooser.py Fix bug #140946.
-
-2004-05-24 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override
- (_wrap_gtk_tree_view_column_set_cell_data_func) Change this override
- to override gtk_cell_layout_set_cell_data_func - covers all objects
- that implement GtkCellLayout in GTK+ 2.4 including GtkTreeViewColumn..
- Ignore gtk_tree_view_column_set_cell_data_func.
-
-2004-05-24 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.override (_wrap_gdk_keymap_translate_keyboard_state):
- Remove double ;, fixes compilation with gcc 2.95.3 on FreeBSD.
-
-2004-05-22 Johan Dahlin <johan@gnome.org>
-
- * NEWS: Don't lie about the release date.
-
- * configure.in: post release version bump
-
-=== PyGtk 2.3.92 ===
-2004-05-22 Johan Dahlin <johan@gnome.org>
-
- * NEWS: Update
-
-2004-05-21 Johan Dahlin <johan@gnome.org>
-
- * gobjectmodule.c (initgobject): Add gobject.pygtk_version
- (_wrap_g_main_context_iteration): block/unblock
- (_wrap_g_main_loop_run): ditto
-
-2004-05-21 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk-types.c (_pygtk_tree_model_remove_row) Add function to
- help in row removal from sort and filter models using del
- (_pygtk_tree_model_set_row) Add support for TreeModelSort and
- TreeModelFilter setting row values.
-
- * gtk/pygtk-private.h (_pygtk_tree_model_remove_row) Add declaration.
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_model_tp_setitem) Use
- _pygtk_tree_model_remove_row() helper function.
- (_wrap_gtk_tree_model_filter_set_modify_func) Add.
- Add support to TreeModelSort and TreeModelFilter for Python mapping,
- number and iter protocols.
-
-2004-05-20 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs (gtk_tree_view_column_pack_start)
- (gtk_tree_view_column_pack_end) Allow expand param to default to TRUE.
-
-2004-05-18 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_list_store_remove) Remove
- this override - generated code is good.
-
- * pygobject.c (pygobject_new_with_interfaces) Add new type to the
- module dict as is done for built-in types.
-
- * codegen/argtypes.py Fix bug in non-null default parselist
- of ObjectArg. Add default handling for AtomArg.
-
- * gtk/gtk.defs (gtk_clipboard_get_for_display)
- (gtk_clipboard_get) Allow args to use default values.
-
-2004-05-16 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_selection_select_range)
- Raise TypeError if selection mode is not gtk.SELECTION_MULTIPLE
-
-2004-05-15 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_selection_select_all)
- Raise TypeError if selection mode is not gtk.SELECTION_MULTIPLE
-
-2004-05-13 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs (gtk_selection_data_set_text) Default the text len
- param to -1.
-
-2004-05-11 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override
- (_wrap_gtk_tree_view_column_set_cell_data_func) Allow func to
- be None to unset the function.
-
-2004-05-10 John Finlay <finlay@moeraki.com>
-
- * pygobject.c (pygobject_new) Bump refcount of types created by
- pygobject_new_with_interfaces. Fixes #141042
-
- * gtk/gtk.defs (gtk_notebook_append_page)
- (gtk_notebook_append_page_menu) (gtk_notebook_prepend_page)
- (gtk_notebook_prepend_page_menu) (gtk_notebook_insert_page)
- (gtk_notebook_insert_page_menu) These return gint in GTK+ 2.4.
-
-2004-05-07 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_model_get) Add.
-
-2004-05-03 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktextview.override (_wrap_gtk_text_iter_forward_find_char)
- (_wrap_gtk_text_iter_backward_find_char) Add.
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_store_reorder) Add.
- (_wrap_gtk_list_store_reorder) Throw exception if indices out of
- range.
-
- * gtk/gtk.override (gtk_accel_group_connect)
- (gtk_accel_group_disconnect) (gtk_clipboard_set_with_owner)
- (gtk_clist_set_compare_func) (gtk_color_selection_set_color)
- (gtk_color_selection_get_color) (gtk_ctree_set_drag_compare_func)
- Ignore these methods - either deprecated or not needed.
- (_wrap_gtk_menu_item_toggle_size_request) Add.
-
-2004-05-03 Johan Dahlin <johan@gnome.org>
-
- * codegen/codegen.py (Wrapper): Add support for tp_as_buffer.
-
-2004-04-25 John Finlay <finlay@moeraki.com>
-
- * pango.defs (pango_language_from_string) Rework as a constructor
- for pango.Language.
- (pango_language_matches) Rework this as a method for pango.Language.
- (pango_language_to_string) Add this as a method.
-
- * pango.override (_wrap_pango_language_from_string1)
- (_wrap_pango_language_matches1) Add these to support deprecated
- pango_language functions.
-
-2004-04-24 John Finlay <finlay@moeraki.com>
-
- * pango.override (_wrap_pango_attr_list_filter) Add.
- (pypango_attr_iterator_get_attrs) Fix memory leak.
-
- * pango.defs (pango_font_face_list_sizes) Add definition.
-
- * pango.override (_wrap_pango_font_face_list_sizes) Add.
-
- * pango.defs (pango_font_family_is_monospace) Add definition.
-
- * pango.override (_wrap_pango_font_family_is_monospace)
- Add two defines to avoid compilation warnings for this function.
-
- * pango.defs (pango_fontset_foreach) Add definition.
-
- * pango.override (_wrap_pango_fontset_foreach) Add.
-
- * pango-types.defs (PangoFontsetSimple) Add class.
-
- * pang_defs (pango_fontset_simple_new)
- (pango_fontset_simple_append) (pango_fontset_simple_size)
- Add methods for PangoFontsetSimple.
-
-2004-04-23 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk.defs (gdk_window_set_accept_focus) (gdk_window_get_group)
- Add definitions.
-
- * pango.defs (pango_attr_fallback_new) Add definition for AttrFallback.
-
- * pango.override (_wrap_pango_attr_fallback_new) Add.
- (pypango_attr_tp_getattr) Add get attribute processing for
- AttrFallback.
-
- * pango.defs (pango_attr_iterator_get_attrs) Add definition.
-
- * pango.override (pypango_attr_iterator_get_attrs) Add method.
-
-2004-04-22 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_get_file_info) Add.
-
- * gtk/gdk.defs (gtk_pixbuf_get_file_info) Add definition.
-
- * gtk/gdk.defs (gdk_pixbuf_loader_set_size)
- (gdk_pixbuf_loader_get_format)
- (gdk_pixbuf_loader_new_with_mime_type) Add definitions.
- (gdk_pixbuf_loader_new) Add deprecation warning
-
- * gtk/gdk.override (gdk_pixbuf_loader_get_format) Add.
-
- * gtk/gdk.override (gdk_query_depths) (gdk_query_visual_types)
- Add these functions.
-
- * gtk/gdk.override (gdk_window_at_pointer) Add.
-
- * gtk/gdk.override (gdk_window_at_pointer) Should return None if
- not on known window.
-
-2004-04-20 John Finlay <finlay@moeraki.com>
-
- * gtk/gdk.defs (gtk_colormap_get_screen) Add.
-
- * gtk/gdk.override (_wrap_gdk_cursor_new) Add 2 more ways of creating
- a cursor corresponding to gdk_cursor_new_from_pixbuf and
- gdk_cursor_new_for_display.
-
- * gtk/gdk.override (_wrap_gdk_display_get_maximal_cursor_size) Add.
-
- * gtk/gdk.defs (gdk_display_pointer_ungrab)
- (gdk_display_keyboard_ungrab) Let time_ param default to
- GDK_CURRENT_TIME.
-
- * gtk/gdk.defs (gdk_drawable_draw_pixbuf) Add default value of -1 for
- the width and height params.
- gc param can be NULL.
-
- * gtk/gdk.override (_wrap_gdk_event_get_state) Add.
-
- * gtk/gdk.override (_wrap_gdk_keyval_convert_case)
- (_wrap_gdk_keymap_get_entries_for_keyval)
- (_wrap_gdk_keymap_get_entries_for_keycode)
- (_wrap_gdk_keymap_lookup_key)
- (_wrap_gdk_keymap_translate_keyboard_state) Add.
-
-2004-04-19 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override
- (_wrap_gtk_tree_view_column_cell_get_position) Add.
-
- * gtk/gtk.defs (gtk_ui_manager_add_ui) Allow param action to be NULL.
-
- * gtk/gtkwidget.override (_wrap_gtk_widget_style_get_property)
- (_wrap_gtk_widget_class_list_style_properties) Add keyword arg
- processing.
-
- * gtk/gtk.override (_wrap_gtk_widget_list_mnemonic_labels) Add.
-
- * gtk/gdk.override (_wrap_gdk_event_tp_getattr) Add "group" attribute
- for GDK_KEY_PRESS and GDK_KEY_RELEASE event objects. Fix member list
- build value bug.
-
-2004-04-18 John Finlay <finlay@moeraki.com>
-
- * gtk/gtktreeview.override
- (_wrap_gtk_tree_model_filter_set_visible_func) Add.
- (_wrap_gtk_tree_model_filter_convert_child_iter_to_iter) Return the
- iter instead of passing it in. Throw exceptions on errors.
- (_wrap_gtk_tree_model_filter_convert_iter_to_child_iter) Return the
- child iter instead of passing it in.
-
- * gtk/gtktreeview.override (gtk_tree_row_reference_new_proxy)
- (gtk_tree_row_reference_inserted)
- (gtk_tree_row_reference_deleted)
- (gtk_tree_row_reference_reordered) Ignore these.
-
- * gtk/gtk.defs (gtk_tree_store_move_after)
- (gtk_tree_store_move_before) Allow position param to be NULL.
-
- * gtk/gtk.defs (gtk_tree_view_move_column_after) Allow base_column
- to be NULL.
-
-2004-04-18 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gobjectmodule.c (pyg_type_register): Make sure we have a unique
- GType name by appending -v<serial> to the name. Allows
- registering multiple python classes with the same name in the same
- module.
-
-2004-04-17 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs Add GtkToolItem constructor and method definitions.
-
- * gtk/gtk.defs (gtk_tool_item_set_proxy_menu_item) Allow menu_item
- to be NULL.
- (gtk_tool_item_set_tooltip) Allow parameters tip_text and tip_private
- to be NULL. Default these to NULL.
-
- * gtk/gtk.defs Make gtk_tooltips_get_info_from_tip_window a method
- of GtkWindow.
-
- * gtk/gtk.override (_wrap_gtk_tooltips_get_info_from_tip_window) Add.
-
- * codegen/argtypes.py (GtkTreePath) Remove extra older null assignment
- - the one assuming a tree path is a tuple.
-
- * gtk/gtk.defs (gtk_tree_model_filter_new) Allow root param to
- default to NULL.
-
-2004-04-16 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override Expanded gtk_draw_* since it excluded new
- gtk_draw_insertion_cursor function.
-
- * gtk/gtk.override Add definition of PyGdkDrawable_Type
-
- * gtk/gtk.defs (gtk_draw_insertion_cursor) area can be NULL.
- (gtk_text_buffer_paste_clipboard) override_location can be NULL.
-
- * gtk/gtktextview.override (_wrap_gtk_text_tag_table_foreach) Add.
-
- * gtk/gtk.override (_wrap_gtk_toggle_tool_button_new) Allow an
- optional stock_id parameter.
- (gtk_toggle_tool_button_new_from_stock) Ignore.
-
- * gtk/gtk.defs (gtk_toolbar_insert) (gtk_toolbar_get_item_index)
- (gtk_toolbar_get_n_items) (gtk_toolbar_get_nth_item)
- (gtk_toolbar_get_drop_index) (gtk_toolbar_set_drop_highlight_item)
- (gtk_toolbar_set_show_arrow) (gtk_toolbar_get_show_arrow)
- (gtk_toolbar_get_relief_style) Add new toolbar methods from GTK+ 2.4
-
- (gtk_toolbar_append_item) (gtk_toolbar_prepend_item)
- (gtk_toolbar_insert_item) (gtk_toolbar_insert_stock)
- (gtk_toolbar_append_space) (gtk_toolbar_prepend_space)
- (gtk_toolbar_insert_space) (gtk_toolbar_remove_space)
- (gtk_toolbar_append_element) (gtk_toolbar_prepend_element)
- (gtk_toolbar_insert_element) (gtk_toolbar_append_widget)
- (gtk_toolbar_prepend_widget) (gtk_toolbar_insert_widget)
- (gtk_toolbar_set_icon_size) (gtk_toolbar_unset_icon_size)
- Add deprecations for these old toolbar methods.
-
- * gtk/gtk.override (_wrap_gtk_toolbar_append_item)
- (_wrap_gtk_toolbar_prepend_item) (_wrap_gtk_toolbar_insert_item)
- (_wrap_gtk_toolbar_insert_stock) (_wrap_gtk_toolbar_append_element)
- (_wrap_gtk_toolbar_prepend_element) (_wrap_gtk_toolbar_insert_element)
- Add deprecation warnings.
-
- * gtk/gtk.defs (gtk_toolbar_set_drop_highlight_item) Allow
- tool_item parameter to be NULL
-
- * gtk/gtk.defs Add GtkToolButton constructor and method definitions.
-
- * gtk/gtk.override (_wrap_gtk_tool_button_new) Allow specifying
- stock_id or icon_widget - label combination.
-
-2004-04-16 Johan Dahlin <johan@gnome.org>
-
- * configure.in: Post release version bump
-
-=== PyGtk 2.3.91 ===
-2004-04-16 Johan Dahlin <johan@gnome.org>
-
- * NEWS: Update
-
-2004-04-15 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * pygboxed.c (PyGBoxed_Type, PyGPointer_Type): idem.
-
- * pygobject.c (PyGObject_Type): idem.
-
- * gobjectmodule.c (PyGInterface_Type): Typecast tp_free slot to
- 'freefunc' to avoid compiler warning.
-
- * pygobject.h: Conditionally make an alias for function type
- 'destructor' called 'freefunc', for backward compatibility with
- those poor souls still stuck with Python 2.2.
-
- * codegen/codegen.py (Wrapper): change typecast of tp_free slot
- from destructor to freefunc, for compatibility with Python 2.3.
-
-2004-04-15 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs Add defs for GtkRadioAction
-
- * gtk/gtk.override (_wrap_gtk_radio_action_set_group)
- (_wrap_gtk_radio_action_get_group) Add.
-
- * gtk/gtk.defs Add defs for GtkRadioToolButton
-
- * gtk/gtk.override (_wrap_gtk_radio_tool_button_new)
- (_wrap_gtk_radio_tool_button_set_group)
- (_wrap_gtk_radio_tool_button_get_group) Add.
-
- * gtk/gtk.override (_wrap_gtk_scale_get_layout_offsets) Add.
-
- * gtk/gtk.defs (gtk_selection_owner_set_for_display) Allow widget
- param to be NULL.
-
-2004-04-14 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_icon_size_lookup_for_settings) Add.
-
- * gtk/gtk.override (_wrap_gtk_icon_theme_get_search_path)
- (_wrap_gtk_icon_theme_set_search_path) Add.
-
- * gtk/gtk.override (_wrap_gtk_icon_theme_list_icons) Add.
-
- * gtk/gtk-types.defs (IconInfo) Add GtkIconInfo boxed type.
-
- * gtk/gtk.defs (gtk_icon_info_copy) Add (caller-owns-return #t)
-
- * gtk/gtk.override (_wrap_gtk_icon_info_get_embedded_rect) Add.
- (_wrap_gtk_icon_info_get_attach_points) Add.
-
- * gtk/gtk.defs (gtk_list_store_move_sfter) Allow position to be NULL
- (gtk_list_store_move_before) Allow position to be NULL
-
- * gtk/gtk.defs (gtk_menu_set_screen) Allow screen to be NULL.
-
-2004-04-13 Johan Dahlin <johan@gnome.org>
-
- * gobjectmodule.c (pyg_register_interface): Move quark_to_string
- to initgobject
-
- * codegen/codegen.py: Add support for tp_new
-
-2004-04-13 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_clipboard_wait_for_targets) Add.
-
- * gtk/gtk.override (_wrap_gtk_clipboard_request_contents)
- (_wrap_gtk_clipboard_request_text)
- (_wrap_gtk_clipboard_request_targets) Add.
-
- * gtk/gtk.defs More gtk_ function cleanup.
-
-2004-04-12 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_action_group_add_radio_actions) Fix
- bugs in connecting callback to first radio action.
-
-2004-04-12 Johan Dahlin <johan@gnome.org>
-
- * pygtk.spec.in: Update, with help of Jason Tackaberry and Thomas
- Vander Stichele
-
-2004-04-11 Johan Dahlin <johan@gnome.org>
-
- * NEWS: Add 2.3.90 stuff here, forgot to do it!
-
- * AUTHORS: Update, add the current active developers here
-
- * pygobject.c (pygobject_new_with_interfaces): New function.
- (pygobject_lookup_class): Modify so we're not traversing parents
- for unknown types but instead creating new types when they're not
- registered. We're also using pygobject_new_with_interfaces so
- interfaces gets attached correctly. Partial fix for bug 129032
-
- * gobjectmodule.c: Add quark and attach the PyTypeObject for
- GInterfaces.
-
- * pygobject-private.h: Make PyGInterface_Type and
- pyginterface_type_key public
-
-2004-04-10 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_action_group_add_toggle_actions) Make
- method more like C API - add is_active processing.
- (_wrap_gtk_action_group_add_radio_actions) Make method more like C API
- - remove per item callback processing, add value and on_change
- parameters and processing.
- Add Runtime exceptions.
-
- * gtk/gtk.defs (gtk_clipboard_set_text) Allow len param to default to
- -1 - calculates text length.
-
-2004-04-10 Johan Dahlin <johan@gnome.org>
-
- * gtk/__init__.py: Move GtkDeprecatedWarning ...
- Remove global module import and do it in the class _Deprecated and
- delete _Deprecated when done.
- (_Deprecated.__repr__): Add.
-
- * gtk/gtkmodule.c: ... here, and rename it to DeprecatedWarning
-
-2004-04-10 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * configure.in: Bump version up to 2.3.91.
-
- * examples/pygtk-demo/demos/images.py: Add 'Images' demo ported to
- python by Joey Tsai (see bug #100873).
-
- * Makefile.am (EXTRA_DIST): Add floppybuddy.gif and alphatest.png,
- copied from gtk+, for pygtk-demo.
-
-2004-04-09 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs (gtk_action_group_add_action_with_accel) The accelerator
- can be NULL to force stock accel usage.
-
-2004-04-09 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * pygtype.c (pyg_value_as_pyobject): Convert GValueArray to python
- list, not tuple, as per comment in bug 129966.
-
- * gobjectmodule.c (initgobject, _pyg_strv_from_gvalue)
- (_pyg_strv_to_gvalue): Register GValue<->PyObject conversion
- functions for boxed type G_TYPE_STRV. Code is taken from
- gnome-python (bonobomodule.c), except that conversion to python
- object creates python list instead of tuple, as per comment in bug
- 129966.
-
-2004-04-09 Johan Dahlin <johan@gnome.org>
-
- * gtk/__init__.py: Add deprecation warnings for all deprecated functions.
-
-2004-04-08 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_file_filter_filter) Add.
- (_wrap_gtk_file_filter_add_custom) Add.
-
- * gtk/gtk.override (_wrap_gtk_font_button_new) Add to allow optional
- fontname parameter.
-
- * gtk/gtk.override (_wrap_gtk_action_get_proxies) Add.
-
-2004-04-07 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_file_chooser_widget_new) Add to allow
- action and backend as optional parameters similar to
- _wrap_gtk_file_chooser_dialog_new.
-
-2004-04-07 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_color_button_get_color): Remove
- unused variable.
-
- * configure.in: Nicer error messages (pytk-2-2 branch instead of gnome-gtk-1-2)
-
- * codegen/codegen.py (Wrapper.write_methods): Use the methods name
- (instead of the "c" name) so we get a nicer output.
-
-2004-04-06 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_file_chooser_get_filenames)
- (_wrap_gtk_file_chooser_get_uris)
- (_wrap_gtk_file_chooser_list_filters)
- (_wrap_gtk_file_chooser_list_shortcut_folder_uris)
- (_wrap_gtk_file_chooser_list_shortcut_folders) Add.
-
- * gtk/gdk.defs (gdk_pixbuf_new_from_file_at_size) Add.
-
-2004-04-05 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.defs (gtk_entry_new_with_max_length): Remove deprecation flag
-
-2004-04-05 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_combo_box_entry_new) Allow a TreeModel
- and text column to be optionally specified when creating a
- ComboBoxEntry. Allow model parameter to be None.
- (_wrap_gtk_combo_box_new) Allow model parameter to be None.
-
- * gtk/gtk.override (_wrap_gtk_entry_completion_set_match_func) Add.
-
-2004-04-04 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.defs Removed gtk_ from various define-function definitions
- so that the function naming is consistent i.e. gtk.function instead
- of gtk.gtk_function: gtk_accel_map_add_entry,
- gtk_binding_parse_binding, gtk_combo_box_new_text,
- gtk_combo_box_entry_new_text, gtk_file_system_error_quark,
- gtk_file_paths_sort, gtk_file_paths_copy, gtk_file_paths_free,
- gtk_icon_theme_error_quark, gtk_icon_theme_get_default,
- gtk_icon_theme_get_for_screen, gtk_icon_theme_add_builtin_icon,
- gtk_preview_get_info, gtk_tooltips_data_get,
- gtk_tree_path_new_from_string, gtk_tree_path_new_from_indices and
- gtk_tree_path_new_first.
-
- * gtk/gtk.override (_wrap_gtk_tooltips_data_get1) Add deprecation
- warning for gtk.gtk_tooltips_data_get().
-
- * gtk/gtk.defs (gtk_cell_layout_pack_start)
- (gtk_cell_layout_pack_end) Allow the expand param to default to TRUE.
-
-2004-04-04 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gdk.override (_wrap_gdk_window_new): If compiling for win32
- platform, add a g_object_ref for the newly created GdkWindow.
- Thanks John Ehresman. Fixes #122755.
-
- * gtk/Makefile.am (_gtk_la_CFLAGS): Add -DPLATFORM_WIN32 depending
- on PLATFORM_WIN32 AM conditional.
-
-2004-04-04 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.defs (icon_set_new): Is not a constructor, patch from
- Scott Tsai, fixes bug 138576
-
-2004-04-03 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_color_button_new) Implement with
- gtk_color_button_new_with_color() to allow optionally specifying
- a GdkColor.
-
- * gtk/gtk.override (_wrap_gtk_color_button_get_color) Return a
- GdkColor instead of passing in a GdkColor to be filled in.
-
- * gtk/gtk-types.defs Added CellLayout interface and references to it
- for ComboBox, ComboBoxEntry, TreeViewColumn and EntryCompletion.
-
- * gtk/gtk.override (_wrap_gtk_combo_box_new) Allow a TreeModel to be
- optionally specified when creating a ComboBox.
- (_wrap_gtk_combo_box_get_active_iter) Return a TreeIter pointing at the
- active item or None if no active item.
-
- * gtk/gtk.override (_wrap_gtk_cell_layout_set_attributes) Added.
-
-2004-04-02 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * acconfig.h: This file is deprecated in newer automake. Removed.
-
-2004-04-02 Johan Dahlin <johan@gnome.org>
-
- * pygtk-2.0.pc.in (pyexecdir): Add
-
- * gtk/gtktreeview.override: Update ignore
-
- * gtk/gtk.override (_wrap_gtk_action_group_list_actions)
- (_wrap_gtk_action_group_add_toogle_actions)
- (_wrap_gtk_action_group_add_radio_actions): Impl.
- Update ignore
-
-2004-04-01 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_accel_group_connect_by_path) Add.
- (_wrap_gtk_file_chooser_dialog_new) Fix small bug.
-
-2004-03-31 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_alignment_get_padding) Add.
-
-=== PyGtk 2.3.90 ===
-
-2004-03-30 Johan Dahlin <johan@gnome.org>
-
- * examples/gtk/filechooser.py (response): Updated, call dialog.destroy()
-
- * examples/gtk/uimanager.py: New example
-
- * gtk/gtk.override (_wrap_gtk_ui_manager_add_ui_from_string):
- Override, get rid of second argument.
-
- * gtk/gtk.defs (gtk_ui_manager_new): is Constructor of
- GtkUIManager, not GtkUiManager.
-
- * gtk/gtk.override (_wrap_gtk_action_group_add_actions): Impl
-
-2004-03-28 Xavier Ordoquy <xordoquy@wanadoo.fr>
-
- * gtk/gtk-types.defs: Fixes #138476 . Added the Layout class
- (Patch from scottt)
-
-2004-03-29 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_file_chooser_dialog_new): Add
- backend as fifth argument
- (_wrap_gtk_progress_bar_new_with_adjustment): Fix constructor, it
- should return an int, not a PyObject.
-
- * gtk/gtk.defs: Remove GtkText, GtkTree and GtkTreeItem.
-
- * gtk/gtktreeview.override (_wrap_gtk_list_store_set): Impl.
-
- * gtk/gtk.override (_wrap_gtk_button_get_alignment): Impl.
- (_wrap_gtk_ui_manager_get_toplevels): Impl.
-
-2004-03-28 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_file_chooser_dialog_new): Impl,
- based on gtk_dialog_new
-
- * Makefile.am: Add example to EXTRA_DIST
-
- * examples/gtk/filechooser.py (filter): New example
-
-2004-03-28 Xavier Ordoquy <xordoquy@wanadoo.fr>
-
- * gtk/gtk.defs: Updated to match gtk 2.4 API.
-
-2004-03-28 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk-types.defs (TreeModelFilter): implements
- GtkTreeModel and GtkTreeDragSource
- (FileFilter): Add
- (FileChooserDialog): implements GtkFileChooser
- (FileChooser): Add.
-
- * gtk/gdk.defs, gtk/gdk.defs: Merge in some changes from 2.4.
-
- * gtk/gtk-types.defs: Gtk+ 2.4 API and remove GtkTextLayout (which
- was accidentally added)
-
- * configure.in: Require glib 2.4, gtk+ 2.4 and libglade 2.3.6.
-
- * codegen/h2def.py: Add a new option to be able to separate
- output of objects and functions
-
- * gtk/gtk-types.defs: Sort and remove ifdef HAVE_GTK24 for
- GtkTextSearchFlags
-
- * gtk/gtk.override: Remove unneedded ignore statement
-
- * gtk/pygtkcellrenderer.h: Cleanup
-
- * gtk/pygtktreemodel.h: Ditto
-
- * gtk/gtktreeview.override: Add a prototype for
- pygtk_cell_data_func_marshal
-
-2004-03-27 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.defs (widget_list_style_properties): This is a function,
- not a method.
-
- * pygobject-private.h, pygobject.h, gobjectmodule.c:
- Make PyGParamSpec_Type and pyg_param_spec_new part of the public API.
-
- * gtk/gtkwidget.override (_wrap_gtk_widget_style_get_property)
- (_wrap_gtk_widget_class_list_style_properties): Impl. Fixes
- bug 138104
-
- * setup.py: Removed installation of libglade and libxml2 DLLs on
- win32 (these are now part of the dropline installer).
- patch by Cedric Gustin, fixed bug 136731
-
- * gtk/gtk.override (_wrap_gtk_main_quit): Override, this does
- two things differently from the old (auto generated) version,
- first it checks if gtk_main_level() is non zero and raises a
- RuntimeError if it's not. It also allows arguments and completely
- ignores them, this is closer to the old 0.6.x behavior and
- suitable for usage like this: obj.connect(signal, gtk.main_quit),
- fixes bug 136705
-
- * gtk/gtkmodule.c (python_do_pending_calls): Check gtk_main_level
- before calling gtk_main_quit, since it might be called outside of
- a mainloop (eg, gtk.main_iteration). Avoids warnings on the console
- as found in example in bug 138163
-
-2004-03-25 Johan Dahlin <johan@gnome.org>
-
- * examples/glade/autoconnect.py: New small example
-
-2004-03-22 Xavier Ordoquy <xordoquy@wanadoo.fr>
-
- * gtk/gtk.defs: Removed the _gtk_* functions as the are private
- and not exported in the module.
-
-2004-03-22 Xavier Ordoquy <xordoquy@wanadoo.fr>
-
- * codegen/h2def.py: Added the interface detection (interface -*Iface-
- inheriting from GTypeInterface)
-
-2004-03-20 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtkmodule.c (init_gtk): Define constants for the predefined
- atoms listed in <gdk/gdkselection.h>. Fixes #137091 ("constants"
- for selection atoms).
-
- * gtk/gdk.override (_wrap_gdk_atom_intern): Override; return
- Py_None if gdk_atom_intern returns GDK_NONE. Fixes #137093
- "gtk.gdk.atom_intern always creates an atom".
- (headers): Add protype for have_numpy() to avoid later
- implicit declaration warning.
-
-2004-03-18 Xavier Ordoquy <xordoquy@wanadoo.fr>
-
- * codegen/h2def.py: Added the interface detection (class
- inheriting from GTypeInterface)
-
-2004-03-18 Xavier Ordoquy <xordoquy@wanadoo.fr>
-
- * gtk/gtk.defs: Cosmetic changes to match h2def output exactly
- in order to ease further merges.
-
-2004-03-12 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_accel_group_connect_group):
-
-2004-03-12 Xavier Ordoquy <xordoquy@wanadoo.fr>
-
- Fixes #136811 (h2def ignores some functions)
- * codegen/h2def.py: skips the extern "C"
-
-=== PyGTK 2.2.0 ===
-
-2004-03-11 Johan Dahlin <johan@gnome.org>
-
- * configure.in: Bump version
-
- * setup.py (MINOR_VERSION): Bump version
-
- * NEWS: Update
-
-2004-03-09 Xavier Ordoquy <xordoquy@wanadoo.fr>
-
- * codegen/code-coverage.py: utility to scan the unmatched symbols
- from the binded libraries. Written by James Henstridge (see bug
- #71465)
-
-2004-03-09 Xavier Ordoquy <xordoquy@wanadoo.fr>
-
- Fixes #136597 (gtkgl still referenced in build files)
- * gtk/.cvsignore:
- * gtk/makefile.msc:
- Removed references to gtkgl.
-
-2004-03-09 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.override (pygdk_filter_func_marshal): Impl.
- (_wrap_gdk_window_add_filter): Impl.
-
-2004-03-08 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * configure.in: Remove leftover definition of gtkgl_required_version.
-
- * gobjectmodule.c (pyg_enum_add_constants): Delegate to
- pyg_flags_add_constants if the GType is really a flags type
- instead of enum.
- (pyg_flags_add_constants): Delegate to pyg_enum_add_constants if
- the GType is really a enum type instead of flags. Based on John
- Ehresman's patch. Fixes (better) #136204 (GtkTextSearchFlags warning).
-
-2004-03-07 Hagen Moebius <hagen.moebius@starschiffchen.de>
-
- * codegen/docextract.py: avoid the non-uniform behavior of gtk-doc
- to have an imaginary "returns" parameter. it is converted into the
- <return>-tag.
-
-2004-03-07 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * examples/pygtk-demo/gtk-logo-rgb.gif,
- * Makefile.am (EXTRA_DIST): Add gtk-logo-rgb.gif, because of stock
- icon registration example.
-
- * examples/pygtk-demo/demos/appwindow.py: Fix stock icon
- registration.
-
-2004-03-06 John Ehresman <jpe@wingide.com>
-
- * gtk/gtktreeview.override (map_expanded_rows_cb)
- (_wrap_gtk_tree_view_map_expanded_rows): Wrapper for
- GtkTreeView.map_expanded_rows. Fixes #136309. Review and minor
- enhancement by Gustavo Carneiro.
-
- * gtk/pygtktreemodel.c (pygtk_generic_tree_model_iface_init)
- (pygtk_generic_tree_model_unref_node)
- (pygtk_generic_tree_model_ref_node): Add support for optional
- TreeModel ref_node & unref_node callbacks. Fixes #136312.
- Reviewed by Gustavo Carneiro.
-
- * gtk/gtktreeview.override (pygtk_cell_data_func_marshal): Fix
- reference problem on cunote->data. Fixes #136306
- ( pygtk_cell_data_func_marshal ref counting in 2.2.0rc1 ).
- Reviewed by Gustavo Caneiro.
-
-2004-03-06 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/makefile.msc: use PYGTK_CODEGEN_DEFINES here too.
-
- * gtk/gtk-types.defs: Make TextSearchFlags an enum or flags type,
- conditional on HAVE_GTK24 being defined. Fixes #136204.
-
- * gtk/Makefile.am (.defs.c): Pass $(PYGTK_CODEGEN_DEFINES) to code
- generator, for conditional compiling of GTK+ 2.4 features.
-
- * configure.in: Check for gtk+ >= 2.3.4 and, if found, define
- PYGTK_CODEGEN_DEFINES="-DHAVE_GTK24".
-
- * codegen/defsparser.py (DefsParser.ifndef): Implement (ifndef
- ...)
- (DefsParser.ifdef): args no longer includes the function name
- (ifdef) as first element of list, so needed to offset indices to
- make it work again.
- (DefsParser.ifndef): idem.
-
-2004-03-05 Johan Dahlin <johan@gnome.org>
-
- * codegen/codegen.py (Wrapper.write_constructor): Cleaning up
- write_source and starting to refactor Wrapper a little bit, to
- avoid so much code duplication
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_fill): This should fix both
- bug 136205 and bug 136205. We're now allowing both long and int
- and converts them properly.
-
-2004-03-04 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_get_pixels_array): New function
- (_wrap_gdk_pixbuf_get_pixels_array): Deprecate, in favor of
- .get_pixels_array(), based on Patch by Tim Evans, fixes bug 90255
-
- * pygobject.c (pygobject_chain_from_overridden):
- * pygtype.c (pyg_signal_class_closure_marshal): Fixes for bug
- 132704, Patch by John Ehresman.
-
- * gtk/gdk.override (have_numpy): New function, to initialize/check numpy
- (_wrap_gdk_pixbuf__get_pixel_array): Use it here
- (_wrap_gdk_pixbuf_new_from_array): and here
- Patch by Tim Evans, fixed bug 122786
-
-2004-03-03 Graham Carlyle <gcarlyle@cmedltd.com>
-
- * gobjectmodule.c (pyobject_free): block/unblock threads around
- Py_DECREF, because we may not hold the interpreter lock at this
- point. Fixes #135963 (gc of gtk.ListStore aborts intrepeter after
- gtk.threads_init() called). Reviewed by Gustavo Carneiro.
-
-2004-03-02 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.override (_wrap_gdk_event_tp_getattr): Add
- GdkEventKey.hardware_code. Fixes bug 129032, patch by Laur Ivan.
-
-2004-03-01 Johan Dahlin <johan@gnome.org>
-
- * codegen/codegen.py (Wrapper.write_methods): Check for defined
- methods in the override file.
- (Wrapper.write_functions): Ditto for functions
-
- * codegen/override.py (Overrides.__parse_override): Clean up a
- little and add some docstrings. Also add a new keyword, define
- (Overrides.get_functions, Overrides.get_defines_for)
- (Overrides.function, Overrides.define): New methods.
-
-2004-02-28 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.override (_wrap_gtk_accel_group_connect): Add wrapper
- for gtk_accel_group_connect.
-
-2004-02-24 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtkmodule.c, gtk/pygtk.h: Make pygdk_rectangle_from_pyobject
- a public API function. Fixes #135279.
-
-2004-02-24 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_stock_list_ids): Plug a leak.
-
- * pygobject.c (pygobject_chain_from_overridden): signa->signal
-
-2004-02-23 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gdk.defs (GdkDrawable.get_image): Add caller-owns-return, as
- suggested by John D. Hunter. Fixes #133681.
-
- * gtk/gtk.override (_wrap_gtk_menu_popup): accept large long
- integers for the 'time' argument.
-
-2004-02-23 Xavier Ordoquy <xordoquy@wanadoo.fr>
-
- * Makefile.am:
- * gtk/Makefile.am: applied patch from Naofumi Yasufuku. Fixes
- bug 121339 (dsextras.py installation directory).
-
-2004-02-22 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_new_from_array)
- (_wrap_gdk_pixbuf_new_from_array): apply Tim Evans' patch to
- create pixbuf from data (string) or from a Numeric Python array.
-
-2004-02-22 Xavier Ordoquy <xordoquy@wanadoo.fr>
-
- * codegen/h2def.py: don't expect a whitespace after the type name
- Fixes bug #128988, patch from Jon Willeke.
-
-2004-02-19 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtktreeview.override (pygtk_cell_data_func_marshal): Fix
- multiple python object reference leaks.
-
-2004-02-14 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * gtk/gtk.override (_wrap_gtk_binding_entry_remove): impl.
-
- * gtk/gtk.defs (binding_entry_remove): remove gtk_ prefix from
- function name.
-
-2004-02-10 Seth Nickell <seth@gnome.org>
-
- Reviewed by: random luser <kiko@async.com.br>
-
- * gtk/gdk.override:
-
- Change type of argument in signature for gdk.event_get_axis
- from "d" to "i" so that get_axis works
-
-2004-01-14 Johan Dahlin <johan@gnome.org>
-
- * gtk/pygtktreemodel.c (pygtk_generic_tree_model_iter_n_children):
- Allow iter to be set to NULL, based on patch by Don Allingham
- Fixes bug 125172
-
-2003-12-24 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * pygtype.c (pyg_value_as_pyobject): Add special handling for
- GValueArray, converting it to a tuple while calling
- pyg_value_as_pyobject recursively for each inner value.
-
-2003-12-23 James Henstridge <james@daa.com.au>
-
- * gtk/gtktreeview.override
- (pygtk_tree_selection_get_selected_rows): implement (fixes bug
- #111489).
-
- * codegen/h2def.py (clean_func): apply patch from Jon Willeke
- <willeke@users.sourceforge.net> to strip out eg. G_BEGIN_DECLS,
- which was tripping up some of the following regexps (fixes bug
- #129414).
-
- * pygobject.c (pygobject_get_property): explicitly check if the
- property is readable first, and raise an exception otherwise
- (pygobject_set_property): check if property is readable (fixes bug
- #121544).
-
-2003-12-22 James Henstridge <james@daa.com.au>
-
- * setup.py: distutils fixes from Alif Wahid
- <awah005@users.sourceforge.net> (bug #123014).
-
- * gtk/gdk.override (ignore-win32): ignore gdk_font_get_display.
-
- * gtk/gtk.override (ignore): ignore plug construct functions.
- (ignore-win32): ignore gtk_plug_new_for_display.
-
- * gtk/gdk.defs (pixmap_foreign_new_for_display): caller owns return.
- (pixmap_foreign_new): same here (bug #129754).
- (window_foreign_new): same here.
- (window_foreign_new_for_display): same here.
-
-2003-12-20 Gustavo J. A. M. Carneiro <gustavo@users.sourceforge.net>
-
- * codegen/codegen.py (Wrapper.get_initial_constructor_substdict):
- now receives the constructor FunctionDef as argument.
- (Wrapper.write_constructor): Pass the constructor
- get_initial_constructor_substdict.
- (GObjectWrapper.get_initial_constructor_substdict): Receive/pass
- constructor argument. If constructor's caller_owns_return flag is
- set to #f, add an extra g_object_ref(self->obj).
- (GBoxedWrapper.get_initial_constructor_sub): Receive/pass extra
- constructor argument.
- (GPointerWrapper.get_initial_constructor_substdict): idem.
-
-2003-12-17 James Henstridge <james@daa.com.au>
-
- * gtk/gtk-types.defs (TextSearchFlags): GtkTextSearchFlags is a
- flags value, rather than an enum.
-
-2003-12-16 James Henstridge <james@daa.com.au>
-
- * configure.in (CFLAGS): add -fno-strict-aliasing to CFLAGS if the
- compiler supports it. The Python API breaks some of the strict
- aliasing rules.
-
- * acinclude.m4 (JH_ADD_CFLAG): new macro to check whether the
- compiler supports a particular cflag.
-
- * codegen/codegen.py
- (GInterface.get_initial_class_substdict): GInterface wrappers
- should be sizeof(PyObject), since they are mixins.
-
-2003-12-19 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.defs (fill): Change to guint32. Patch by
- hyriand@thegraveyard.org. Fixes 121611.
-
- * gtk/pygtkcellrenderer.c
- (pygtk_generic_cell_renderer_start_editing): Allow return values
- that are NULL. Patch by Tim Evans, fixes #122786
-
- * gtk/gtktreeview.override (_wrap_gtk_tree_model_iter_children):
- Allow parent to be None. Patch by Benjamin CAMA, fixes #124593
-
- * gtk/gtk.defs: Allow all GdkColor arguments for
- gtk_widget_modify_* to be null. Patch by jkluebs@luebsphoto.com,
- fixes #127178
- (GtkTreeView.expand_row): Set return value to gboolean. Patch by
- Doug Quale, fixes #126406
-
-2003-12-18 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtk.defs (set_tip): Allow null for tip_text. Patch by John
- Ehresman, fixes #128623.
-
- * gtk/pygtktreemodel.c: handle None iterator values. Patch by John
- Ehresman, fixes #126479.
-
-2003-12-09 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtktreeview.override (_wrap_gtk_list_store_reorder): Impl.
-
-2003-12-05 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtktreeview.override (pygtk_tree_selection_foreach_marshal):
- Increase the ref count on Py_None (#128448, Vsevolod Fedorov)
-
- * gtk/gtk-types.c (pygtk_tree_model_row_get_parent): Swap parent
- and child argument. (#123605, patch by Steve Chaplin)
-
-2003-10-23 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtk.override (_wrap_gtk_item_factory_create_items): Use
- GdkPixbuf objects instead of raw strings, Thanks to Rob Melby for
- the patch, #123456
-
- * gtk/gtkwidget.override (_wrap_gtk_widget_size_request): pass
- back the values instead of pointers to them. Thanks to Rob Melby
- for the patch, #125272
-
-2003-09-17 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (_wrap_gtk_clipboard_set_with_data): wrap
- function.
-
-2003-09-16 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.override (_wrap_gdk_window_set_geometry_hints): add wrapper.
- (gdk_window_peek_children): ignore.
- (_wrap_gdk_window_set_icon_list): add wrapper.
- (_wrap_gdk_screen_get_setting): add wrapper (this one spews lots
- of warnings though. Not sure how to fix properly).
-
-2003-09-15 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.override (_wrap_gdk_display_get_window_at_pointer): add
- wrapper.
- (_wrap_gdk_drag_find_window_for_screen): add wrapper.
-
- * gtk/gtkgl*: remove files.
-
- * gtk/Makefile.am: remove gtkgl binding.
-
- * configure.in (build_gtkgl): remove gtkgl bindings.
-
-2003-09-04 James Henstridge <james@daa.com.au>
-
- * gtk/gtk.override (headers): add defs for GdkDisplay and GdkScreen
-
- * gtk/gtk.defs, gtk/gtk-types.defs: update for 2.2 APIs. Covers
- bug #113224, #113908, #117929 and #121031.
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_get_formats): implement
- function. Returns a list of dictionaries (bug #118253).
-
-2003-09-03 James Henstridge <james@daa.com.au>
-
- * gtk/gdk.override: add some overrides for GdkDisplay and GdkScreen.
-
- * gtk/Makefile.am (gtk_overrides): gtk.c doesn't depend on
- gdk.override.
-
- * gtk/gdk.override: hack so that GDK_DISPLAY() is the cast macro.
-
- * gtk/gdk.defs, gtk/gdk-types.defs: incorporate new 2.2 APIs.
-
- * configure.in: set version number to 2.1.0 so that it differs
- from the 2.0 branch.
-
-2003-09-02 James Henstridge <james@daa.com.au>
-
- * ChangeLog.pre-2-0: rename old change log.
-
diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
deleted file mode 100644
index 0a0041cb..00000000
--- a/ChangeLog.pre-2-8
+++ /dev/null
@@ -1,912 +0,0 @@
-=== PyGTK 2.8.0 ===
-2005-09-02 Johan Dahlin <jdahlin@async.com.br>
-
- * autogen.sh: Sync with gnome-common. Require automake 1.8.
- Fixes #314128 and #311958
-
- * Makefile.am:
- * gobject/makefile.msc:
- * gtk/Makefile.am:
- * gtk/makefile.msc:
- * makefile.msc:
- Remove old .msc files, which are outdated and unused.
-
-2005-08-30 Tim Evans <t.evans@aranz.com>
-
- * gtk/gtk.defs: Fix the start_editing virtual of GtkCellRenderer.
- Closes bug #314806. Review by Gustavo Carneiro.
-
- * codegen/reversewrapper.py (GdkRectanglePtrParam.convert_c2py):
- This conversion always produced bogus values and possibly even
- segfaults, due to 'f' formart char vs passing integer values.
- Fixed to use pyg_boxed_new instead.
- Fixes bug 314801: "bad conversion of GdkRectangle to PyObject in
- reversewrapper.py" Reviewed by Gustavo Carneiro.
-
-2005-08-29 John Ehresman <jpe@wingide.com>
-
- * gobject/pygobject.c (pygobjectmeta_register): Remove unneeded
- g_strdup.
-
-2005-08-26 Johan Dahlin <jdahlin@async.com.br>
-
- * atk-types.defs (ImplementorIface): Make it a type on dynamically
- created subclasses implementing the interface to possibly avoid
- MRO issues.
-
- * gobject/gobjectmodule.c (pyg_signal_list_ids): Refactor to
- allow us to list signals on interfaces.
-
- * tests/test_signal.py (TestList): Two new tests.
-
-2005-08-25 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/gobjectmodule.c (pyg_type_register): Don't g_free
- type_name parameter, otherwise it will cause a double-free elsewhere.
-
- * gobject/pygobject-private.h: Add const to char * parameter of
- pyg_type_register.
-
- * gobject/pygobject.c (pygobject_new_with_interfaces): Py_INCREF
- objects being added to a tuple in a couple of places, because
- PyTuple_SetItem steals a reference. Fix 'bases' and 'dict'
- reference leaks.
-
-2005-08-24 John Ehresman <jpe@wingide.com>
-
- * gobject/pygobject.c: In the meta-class __init__ method,
- register a class as a gtype iff __gsignals__, __gproperties__,
- or __gtype_name__ is defined in the leaf class's tp_dict.
-
-2005-08-24 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Post release version bump
-
-=== PyGTK 2.7.4 ===
-2005-08-24 Johan Dahlin <jdahlin@async.com.br>
-
- * NEWS: Update
-
- * README: Update
-
-2005-08-24 John Ehresman <jpe@wingide.com>
-
- * setup.py: Added sources so gobject module will compile, fixed
- enable/disable thread support, and changed default so thread
- support is enabled unless --disable-threading is specified
-
- * gobject/gobjectmodule.c, gobject/pygobject.c: Set
- PyGObject_MetaType.tp_base in module initialization to keep
- VC++ happy
-
-2005-08-24 Johan Dahlin <jdahlin@async.com.br>
-
- * tests/test_conversion.py (Tests.testUIntArg): Add test for
- Table.attach which takes uint arguments.
-
- * codegen/argtypes.py (UIntArg.write_param):
- One more take on fixing #300012, this time unsigned int conversion,
- patch by Gustavo.
-
-2005-08-18 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_selection_data_get_targets)
- (_wrap_gtk_drag_dest_get_target_list)
- (_wrap_gtk_drag_dest_set_target_list)
- (clipboard_request_contents_cb)
- (_wrap_gtk_clipboard_request_targets)
- (_wrap_gtk_drag_source_set_target_list)
- (_wrap_gtk_target_list_add_image_targets)
- (_wrap_gtk_target_list_add_uri_targets) :
- * gtk/gdk.override (_wrap_gdk_event_tp_getattr)
- (_wrap_gdk_gc_new_with_values, _wrap_gdk_property_get)
- (_wrap_gdk_property_change):
- * gtk/gtkmodule.c (add_atom): Fix memory leak with gdk_atom_name()
- Fixes #313861 (Christian Persch)
-
-2005-08-16 Stepan Kasal <kasal@ucw.cz>
-
- * pygobject-2.0.pc.in, pygtk-2.0.pc.in: Add datarootdir
- variable, for compatibility with future Autoconf releases.
- * codegen/pygtk-codegen-2.0.in: Likewise.
-
-2005-08-16 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtkcontainer.override: Override gtk.Container.do_forall.
- * examples/gtk/bin.py: Simple example how it should work.
-
-2005-08-12 Christopher Aillon <caillon@redhat.com>
-
- * gtk/gtk.defs:
- gtk.accelerator_get_default_mod_mask () returns a
- GtkModifierType, not a guint.
-
-2005-08-12 Christopher Aillon <caillon@redhat.com>
-
- * gobject/pygtype.c:
- pyg_flags_get_value () should accept longs as input
-
-2005-08-10 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Post release version bump
-
-=== PyGTK 2.7.3 ===
-2005-08-10 Johan Dahlin <jdahlin@async.com.br>
-
- * NEWS: Update
-
-2005-08-10 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gdk.override, gtk/gdk.defs: It was discovered by pycairo
- folks that cairo_surface_create_for_pixbuf doesn't work at all.
-
-2005-08-10 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtkcontainer.override (_wrap_gtk_container_nb_nonzero): Always
- return 1, so if hbox always returns true.
-
-2005-08-09 Andy Wingo <wingo@pobox.com>
-
- * gobject/pygobject.c (pygobject_new_with_interfaces): Use the
- generic setattr protocol instead of getting the module's
- dictionary and using setitem. Fixes bug #312999.
-
-2005-08-05 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/reversewrapper.py (GObjectReturn.write_conversion): Add
- type checking: raise exception and return NULL if the returned
- PyObject isn't a PyGObject.
- (ReverseWrapper.write_code): Add support for code that raises an
- exception in the failure code path.
-
-2005-08-02 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/Makefile.am
- * Makefile.am: Big makefile cleanup. Fix a couple of bugs
- meanwhile, most noticable, always install include *.defs in
- EXTRA_DIST and only install them when their target is built.
-
-2005-08-02 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Post release version bump
-
-=== PyGTK 2.7.2 ===
-2005-07-30 Johan Dahlin <jdahlin@async.com.br>
-
- * NEWS: Updated
-
-2005-08-02 Mark McLoughlin <mark@skynet.ie>
-
- Fixes bug #312337
-
- * gobject/gobjectmodule.c: (_wrap_pyg_type_register):
- Make the "already registered" warning a deprecation warning
- with a more detailed hint on what it means.
-
-2005-08-01 Manish Singh <yosh@gimp.org>
-
- * gobject/pygobject-private.h
- * gobject/pygmaincontext.c: Add a convenience function
- (pyg_main_context_new) to create a PyGMainContext from a
- GMainContext. Takes care of refing the supplied GMainContext
- as well.
-
- * gobject/gobjectmodule.c (pyg_main_context_default)
- * gobject/pygmainloop.c (_wrap_g_main_loop_get_context)
- * gobject/pygsource.c (pyg_source_get_context): use the new
- convenience function here. This fixes bug #312259.
-
-2005-07-31 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/gobjectmodule.c (pyg_object_new): Call
- pygobject_new_full instead of pygobject_new to disable sinking.
- Instead, call pygobject_sink after g_object_unref, so that the
- sink functions run with the expected reference count and do their
- work accordingly.
-
- * gobject/pygobject-private.h: New internal API pygobject_sink.
-
- * gobject/pygobject.c (pygobject_sink),
- (pygobject_register_wrapper, pygobject_new_full): sink_object
- renamed to pygobject_sink and made internal API.
-
- * tests/test_subtype.py: Add tests to check reference count of
- windows, with or without subclassing, from gobject.new or from
- constructor.
-
-2005-07-30 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gdk.override (_wrap_gdk_event_free): Deprecate
- gtk.gdk.Event.free and make it do nothing.
-
- * gobject/gobjectmodule.c (_wrap_pyg_type_register): Fix test to
- see if the class has already been registered. Don't issue a
- DeprecationWarning; instead, just issue a Warning when trying to
- register a class that is already registered.
-
-2005-07-30 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c (initgobject): Don't register PyObject
- unconditionally, fixes #303797 (Yevgen Muntyan)
-
-2005-07-30 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtk.override (_wrap_gtk_icon_source_free)
- (_wrap_gtk_requisition_free, _wrap_gtk_tree_iter_free)
- (_wrap_gtk_tree_row_reference_free, _wrap_gtk_border_free):
- Override free() methods of boxed types to make them do nothing and
- issue a deprecation warning.
- Fixes Bug 306095: In pygtk 2.6.x calling free() on GtkIconInfo
- object causes a double free or corruption error.
-
- * tests/test_subtype.py (TestSubType.testMassiveGtkSubclassing):
- Add new test that attempts to subclass every possible class in the
- gtk module, minus a couple of deprecated ones.
-
- * codegen/codegen.py (write_registers): Warn here about
- constructors that need to be updated.
-
- * gobject/gobjectmodule.c (pyg_type_register): Don't warn about
- needing to update a constructor to new API. Warn in the code
- generator instead.
-
- * gtk/gtk.override: Use the new new-constructor override command
- to declare custom constructors conforming to the new API, instead
- of init commands.
-
- * codegen/codegen.py (Wrapper.write_constructor): When writing an
- overridden constructor, check if it is declared to support the new
- API, in which case set self.objinfo.has_new_constructor_api to True.
- (GObjectWrapper.write_default_constructor): For GObjects with no
- constructor (abstract objects), inherit
- objinfo.has_new_constructor_api from the parent type, since
- tp_init is also inheritted (hence the need to reorder the classes).
-
- * codegen/override.py (Overrides.__parse_override): Add override
- command "new-constructor GType" to declare that a constructor
- conforms to the new API.
-
- * codegen/codegen.py (write_classes): Reorder classes to put
- parent types before their children.
-
- * gtk/gtkwidget.override, gtk/gtk.override: Don't override
- GtkMisc.tp_init, GtkBin.tp_init, GtkItem.tp_init, GtkBox.tp_init,
- GtkButtonBox.tp_init, and GtkWidget.tp_init just to chain to
- parent tp_init. At some point in pygtk 2.6 development this
- became redundant. Ignore gtk_widget_new so that a
- pygobject_no_constructor tp_init isn't generated for it.
-
- Fixes Bug 311309: subclassing gtk.Bin reports....
-
-2005-07-30 Johan Dahlin <jdahlin@async.com.br>
-
- * Makefile.am:
- * gtk/Makefile.am:
- Install defs files conditionally, fixes #312037
-
-2005-07-25 Johan Dahlin <jdahlin@async.com.br>
-
- * tests/test_subtype.py:
- * tests/testhelpermodule.c: (test_type_get_type),
- (_wrap_get_unknown), (_wrap_test_g_object_new), (inittesthelper):
- Clean up tests, we don't need a C binding to access tp_basicsize,
- clean up the C tests, quite a bit aswell.
-
-2005-07-22 Johan Dahlin <johan@gnome.org>
-
- * gtk/Makefile.am:
- * gtk/gtk-fake-win32.c:
- * gtk/gtk.override:
- * setup.py:
-
- GtkPlug & GtkSocket is now available on win32, so remove hacks.
-
-2005-07-22 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Post release version bump
-
-=== PyGTK 2.7.1 ===
-2005-07-22 Johan Dahlin <jdahlin@async.com.br>
-
- * NEWS:
- * README:
- * configure.in: Update requirements
-
- * tests/test_radiobutton.py (RadioToolButtonTest): Re-enable
-
- * tests/test_dialog.py (MessageDialogTest.testSubclass): Add tests, for
- #311226.
-
-2005-07-22 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/pygobject.c (pygobjectmeta_register): Don't
- automatically register gtype if neither one of __gtype_name__,
- __properties__, or __gsignals__ is defined in the class
- dictionary. Fixes #311226.
-
-2005-07-17 Johan Dahlin <johan@gnome.org>
-
- * gobject/pygobject.c: (pygobject_new_full), (pygobject_dealloc),
- (pygobject_clear):
- * gtk/gdk.override:
- * gtk/gtk-types.c: (_pygtk_style_helper_new),
- (pygtk_style_helper_dealloc), (pygtk_style_helper_setitem),
- (pygtk_tree_model_row_dealloc),
- (pygtk_tree_model_row_iter_dealloc):
- * gtk/gtk.override:
- * gtk/gtkwidget.override:
- We have atomic ref counting in glib now, remove block/unblocking
- around reference counting.
-
- * gobject/pygobject.h:
- * gobject/gobjectmodule.c (pyg_gil_state_ensure_py23)
- (pyg_gil_state_release_py23): Remove pre python 2.3.5 compatibility.
- Simplifies thread handling.
-
- * configure.in: Require glib/gtk+ 2.7.3
-
- * gtk/gtk.defs (get_model, set_do_overwrite_confirmation)
- (get_do_overwrite_confirmation, queue_resize, get_visible_range): Add
-
- * gtk/gtk-types.defs (FileChooserError): Add.
-
-2005-07-15 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (create_property):
- Allow enums to be specified in the constructor
- * gobject/pygparamspec.c: (pyg_param_spec_getattr):
- Return flags or enum object for pspec.default_value
- * tests/test_enum.py: Remove usage of assert statement,
- add default_value test, both for flags and enum
-
-2005-07-10 Johan Dahlin <johan@gnome.org>
-
- * configure.in: Post release version bump
-
-=== PyGTK 2.7.0 ===
-2005-07-10 Johan Dahlin <johan@gnome.org>
-
- * configure.in: Bump glib/gtk+ requirements
-
- * NEWS: Updated
-
- * README: Updated
-
-2005-07-10 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/pygiochannel.c (py_io_channel_win32_poll)
- (py_io_channel_win32_make_pollfd): Change to use the new PyGPollFD
- type instead of tuples.
-
- * gobject/pygsource.c (pyg_poll_fd_dealloc): Change DECREF to
- XDECREF on self->fd_obj. Moved PyGPollFD structure into
- pygobject-private.h, to make it accessible from pygiochannel.c.
-
-2005-07-10 Johan Dahlin <johan@gnome.org>
-
- * gtk/gtkwidget.override (_wrap_gtk_widget_set_set_scroll_adjustments_signal)
- (_wrap_gtk_widget_set_set_scroll_adjustments_signal): Impl.
- Patch by Gustavo, fixes #155679
-
- * tests/test_signal.py (TestOldStyleOverride):
- Add unittests. Lazy Gustavo.
-
- * gtk/gtkwidget.override (_wrap_gtk_widget_list_accel_closures):
- Remove until we decide what we should return.
-
- * gobject/pygobject.c: (PyGProps_setattro),
- (pygobject_set_property):
- * tests/test_properties.py:
- Raise an exception if a construct only property is set after
- construction time. Refactor property setting code and add some
- more tests.
-
-2005-07-10 Manish Singh <yosh@gimp.org>
-
- * gobject/pygobject-private.h
- * gobject/gobjectmodule.c
- * gobject/Makefile.am
- * gobject/pygsource.c: GSource wrapper, allows for pure python
- GSource implementations, as well as objectifying Idle and Timeout
- sources.
-
- * tests/Makefile.am
- * tests/test_source.py: Add test for the above.
-
- * gobject/gobjectmodule.c: timeout_add should take an explicit
- unsigned value. Also wrap g_get_current_time and g_main_depth.
-
- * gobject/pygiochannel.c (py_io_channel_write_chars): fix thread
- unblock/block logic.
-
-2005-07-10 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gdk.defs,
- * gtk/gdk.override (cairo_surface_create_for_pixbuf): Add utility
- function cairo_surface_create_for_pixbuf, copy-pasted from
- pycairo (cairo/cairogtkmodule.c).
-
- * codegen/override.py (Overrides),
- * codegen/codegen.py (Wrapper.get_methflags): Add support for
- static/classmethod and METH_O overrides.
-
-2005-07-09 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtkwidget.override (_wrap_gtk_widget_list_accel_closures): Impl.
-
- * gtk/gtk.defs: Remove gtk_ prefix on a couple of (unwrapped) functions
-
- * gtk/gtk-types.defs:
- (IconViewDropPosition, PackDirection): Add.
-
- * gtk/gtkiconview.override:
- (_wrap_gtk_icon_view_enable_model_drag_dest)
- (_wrap_gtk_icon_view_enable_model_drag_source)
- (_wrap_gtk_icon_view_get_dest_item_at_pos)
- (_wrap_gtk_icon_view_get_drag_dest_item)
- (_wrap_gtk_icon_view_get_cursor)
- (_wrap_gtk_icon_view_get_visible_range)
- (_wrap_gtk_icon_view_get_item_at_pos): Impl.
-
-2005-07-09 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * codegen/codegen.py:
- * codegen/definitions.py:
- * gobject/gobjectmodule.c: (pygobject_init_wrapper_set),
- (pygobject_init_wrapper_get), (pygobject__g_instance_init),
- (pyg_type_register), (pyg_object_new), (pygobject_constructv),
- (pygobject_construct), (pyg_set_object_has_new_constructor),
- (initgobject):
- * gobject/pygobject-private.h:
- * gobject/pygobject.c: (pygobject_new_full), (pygobject_new),
- (pygobject_init):
- * gobject/pygobject.h:
- * gtk/gtk.override:
- * tests/Makefile.am:
- * tests/runtests.py:
- * tests/test_properties.py:
- * tests/test_subtype.py:
- * tests/testhelpermodule.c: (py_label_get_type),
- (test_type_get_type), (_wrap_create_test_type),
- (_wrap_test_g_object_new):
- * tests/testmodule.py:
- Bug 161177: Allow creation of python classes from g_object_new.
-
-2005-07-09 Johan Dahlin <jdahlin@async.com.br>
-
- * gtk/gtkcontainer.override: Implement tp_iter and
- tp_as_sequence.sq_length.
-
-2005-07-09 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/pygobject.c: Correct ob_size and tp_basicsize mixup in
- PyGProps[Iter].
-
-2005-07-08 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in:
- * gtk/Makefile.am:
- * gtk/gdk-types.defs:
- * gtk/gdk.defs:
- * gtk/gdk.override:
- * gtk/gtk.defs:
- * pango-types.defs:
- * pango.defs:
- Merge new Gdk & Gtk API. pango.Renderer and functions/methods also
- added. Bump required glib,gtk & pango versions.
-
-2005-07-08 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (initgobject):
- * gobject/pygobject-private.h:
- * gobject/pygobject.c: (pyg_props_iter_dealloc),
- (pygobject_props_iter_next), (PyGProps_dealloc),
- (build_parameter_list), (PyGProps_getattro), (PyGProps_setattro),
- (pygobject_props_traverse), (pygobject_props_get_iter),
- (PyGProps_length), (pyg_props_descr_descr_get):
- * tests/Makefile.am:
- Add GObject support, patch mostly based on Iñaki and Gustavos work.
- Unittests added, fixes #81879
-
-2005-07-07 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (initgobject):
- * gobject/pygobject-private.h:
- * gobject/pygobject.h:
- * gobject/pygtype.c: (pyg_type_lookup),
- (pyg_register_gtype_custom), (pyg_value_from_pyobject),
- (pyg_value_as_pyobject):
- Rename pyg_register_boxed_custom to pyg_register_gtype_custom.
- Add note about private fields in exported API structure.
- Based on patch by Edward Hervey, fixes #309625
-
-2005-07-05 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (pyg_type_name), (pyg_type_from_name),
- (pyg_type_parent), (pyg_type_is_a), (pyg_type_children),
- (pyg_type_interfaces), (get_type_name_for_class), (initgobject):
- * gobject/pygtype.c: (_wrap_g_type_is_a), (pyg_type_wrapper_init):
- * tests/test_enum.py:
- * tests/test_gtype.py:
- * tests/test_unknown.py:
- Add GType.is_a and deprecate gobject.type_*
- Update tests
- and make GType.is_a/gobject.type_is_a return a bool instead of int
-
-2005-07-05 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (_wrap_pyg_type_register),
- (get_type_name_for_class), (pyg_type_register):
- * gobject/pygobject-private.h:
- * gobject/pygobject.c: (pygobjectmeta_register),
- (pygobjectmeta_init):
- * tests/test_gtype.py:
- Add support for specifying name for a GObject subclass,
- using __gtype_name__. Add a unittest. Fixes #169498
-
-2005-07-04 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (initgobject): Add GType to gobject
- namespace
- * gobject/pygtype.c: (_wrap_g_type_wrapper__get_pytype),
- (_wrap_g_type_wrapper__get_name),
- (_wrap_g_type_wrapper__get_parent),
- (_wrap_g_type_wrapper__get_fundamental),
- (_wrap_g_type_wrapper__get_children),
- (_wrap_g_type_wrapper__get_interfaces),
- (_wrap_g_type_wrapper__get_depth), (_wrap_g_type_is_interface),
- (_wrap_g_type_is_classed), (_wrap_g_type_is_instantiatable),
- (_wrap_g_type_is_derivable), (_wrap_g_type_is_deep_derivable),
- (_wrap_g_type_is_abstract), (_wrap_g_type_is_value_abstract),
- (_wrap_g_type_is_value_type), (_wrap_g_type_has_value_table),
- (_wrap_g_type_from_name):
- Wrap a number of GType utility functions
-
-2005-07-04 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (pyg_object_new):
- * tests/test_conversion.py:
- Use pyg_param_gvalue_from_pyobject in gobject.new, fixes
- unichar parameters specified from the constructor.
- Added unittests.
-
-2005-07-02 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gtk/gtkmodule.c (init_gtk): Check for cairo module import
- failure.
-
- * pangocairomodule.c (initpangocairo): Check for cairo module
- import failure.
-
-Fri Jul 1 18:51:15 PDT 2005 Manish Singh <yosh@gimp.org>
-
- * gobject/pygmaincontext.c: unref the underlying GMainContext upon
- object destruction. Some minor cleanups as well.
-
-2005-07-01 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/pygtype.c: Extend to add some new fields, add a getter
- for GType.type, which points to the python registered type
- of a PyGTypeWrapper.
-
- * gobject/gobjectmodule.c (initgobject): And register PyGTypeWrapper,
- a side effect is that dir(gtype) also works now.
-
-2005-06-27 John Finlay <finlay@moeraki.com>
-
- * gtk/gtk.override (_wrap_gtk_file_chooser_dialog_new)
- (_wrap_gtk_dialog_new): Allow defaults to be specified explicitly to
- the constructor. Fixes #309108 (Steve Chaplin)
-
-2005-06-21 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/pygparamspec.c: (pygenum_from_pspec),
- (pygflags_from_pspec): Try to register unknown enums and flags on the fly.
- Fixes #308536, patch by Edward Hervey
- * gobject/pygflags.c: (pyg_flags_add): Make module optional.
-
-2005-06-20 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/gobjectmodule.c (add_signals): Return a new dictionary
- to replace __gsignals__, whith signal names canonicalized
- (s/-/_/), for the signals that are being overridden, so that the
- class_init functions can safely check for them.
-
- * codegen/codegen.py (Wrapper.write_virtuals): Before overriding
- virtual method, check if the corresponding signal is already being
- overridden.
-
- * gobject/gobjectmodule.c (pyg_type_register): Instead of deleting
- __gsignals__, replace it with a dict containing only overridden
- signals, as returned by add_signals(). This is so that class init
- functions can inspect the signals that are being overridden.
- __gsignals__ then get's deleted only after running
- pyg_run_class_init.
-
- Fixes Bug 308097: Overriden realize gets called twice.
-
- * codegen/reversewrapper.py: Register GtkAllocation* as an alias
- for GdkRectangle*. Fixes #Bug 308099: No GtkWidget proxy handler
- for do_size_allocate.
-
- * codegen/argtypes.py (ULongArg): Use the new (python 2.3) 'k'
- template char to convert unsigned long, so that parsing of ULong
- parameters accepts both int and long python values. Add new
- UInt32Arg argtype for guint32, subclassing ULongArg and adding
- range checking on platforms that require it. As a side effect,
- guint32 return values are now always translated to python longs
- ( before they would be longs on 32-bit systems, or ints on 64-bit
- systems ).
-
-2005-06-20 Mark McLoughlin <mark@skynet.ie>
-
- Fixes bug #308384
-
- * gtk/gdk.override: make gtk.gdk.Window.set_user_data()
- accept None
-
-2005-06-20 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/pygobject.c (pygobject_new_with_interfaces): Fix
- typo in documentation string. Fixes #171910 (Tuure Laurinolli
- and Gian Mario Tagliaretti)
-
-2005-06-17 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * examples/pango/pangocairo-simple.py (main): Demonstrate how to
- output PDF file from the same drawing subroutine.
-
-2005-06-14 Johan Dahlin <jdahlin@async.com.br>
-
- * examples/ide/edit.py: Improve demo, patch by
- Fernando San Martin Woerner, fixes #171148
-
-2005-06-09 Cedric Gustin <cedric.gustin@swing.be>
-
- * setup.py : Define HAVE_BIND_TEXTDOMAIN_CODESET on win32.
-
-2005-06-09 Manish Singh <yosh@gimp.org>
-
- * gobject/pygobject.h
- * gtk/pygtk.h: Use G_STMT_START/END for init_ defines.
-
-2005-06-07 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * pango.override (pypango_item_get_type): Define boxed type for
- PangoItem.
- (_wrap_pango_layout_line__get_runs): Override/implement getter for
- pango.LayoutLine.runs.
-
- * pango-types.defs (LayoutLine): Add PangoLayoutLine fields.
- (Item): Declare PangoItem as boxed type.
-
-2005-06-06 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * examples/gtk/widget.py: Render the sample widget with cairo, if
- possible.
-
- * examples/pango/pangocairo-simple.py: cairosimple.c example
- ported to python.
-
- * examples/Makefile.am (EXTRA_DIST): Add pango/pangocairo-simple.py.
-
- * codegen/argtypes.py (CairoArg.write_return): Add cairo_t* argtype.
-
- * gtk/Makefile.am (EXTRA_DIST): Add gdkcairo.override.
-
- * gtk/gdk.defs: Optionally define method cairo_create of
- gtk.gdk.Drawable.
-
- * gtk/gdk.override (_wrap_gdk_cairo_create): Wrap gdk_cairo_create
- as method cairo_create of gtk.gdk.Drawable.
-
- * gtk/gdkcairo.override: If pycairo is available, define type
- gtk.gdk.CairoContext as a subclass of pangocairo.CairoContext with
- some additional methods.
-
- * configure.in: Check for libraries to build pangocairo module.
- Check for dependencies to optionally build gtk module with cairo
- support.
-
- * Makefile.am, pangocairomodule.c, pangocairo.defs,
- * pangocairo.override: Python bindings for the new libpangocairo.
-
- * codegen/codegen.py (Wrapper.write_getsets): Add support for
- structured fields. For example, a field 'bar' inside a structure
- 'foo' is declared in the defs as "foo.bar" and mapped as "foo_bar"
- python attribute.
-
- * codegen/codegen.py, codegen/override.py: Add a 'body' override
- section type, which includes code after headers, imports, and type
- declarations. Useful if you write code that depends on imported
- or declared types.
-
-2005-05-30 Johan Dahlin <johan@gnome.org>
-
- * gtk/gdk.defs (pixbuf_get_from_drawable): Add. We can't remove
- the old method.
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_get_from_drawable2):
- Rename it to ...2 and copy it to the override file since the code
- generator can't handle two functions with the same name
-
-2005-05-31 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * pango.override (pypango_layout_line_get_type): Fix copy function.
-
-2005-05-29 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * pango.override (_wrap_pango_layout_line_x_to_index)
- (_wrap_pango_layout_line_index_to_x)
- (_wrap_pango_layout_line_get_extents)
- (_wrap_pango_layout_line_get_pixel_extents): Impl.
-
- * gtk/gdk.override: Ignore gdk_draw_layout_line and
- gdk_draw_layout_line_with_colors, at least for now.
-
- * pango-types.defs (LayoutLine): Declare LayoutLine as boxed type.
-
- * pango.defs: pango_layout_line_ref and unref should not be
- exposed as python API.
-
- * pango.override (PANGO_TYPE_LAYOUT_LINE): Register boxed type for
- PangoLayoutLine, unless it's already defined.
-
- * pango.defs: Add defs for
- pango_font_metrics_get_underline_thickness,
- pango_font_metrics_get_underline_position,
- pango_font_metrics_get_strikethrough_thickness, and
- pango_font_metrics_get_strikethrough_position.
-
- * gobject/pygobject.c (pygobjectmeta_init): Don't register types
- that are already registered (have a __gtype__ attribute).
-
-2005-05-28 Manish Singh <yosh@gimp.org>
-
- * gobject/pygiochannel.c (pyg_iowatch_marshal): Pass the GIOCondition
- to PyObject_CallFunction.
-
-2005-05-28 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (initgobject):
- * gobject/pygobject-private.h:
- * gobject/pygtype.c: (pyg_register_boxed_custom):
- Sort quark names. Rename pyg_boxed_marshal_key to pygboxed_marshal_key.
- Don't set the keys twice
-
-2005-05-28 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/pygpointer.c (pyg_register_pointer): change quark name
- from pointer_type_id to pygpointer_class_key, for consistency;
- assume it to be already registered.
-
- * gobject/pygenum.c (pyg_enum_add): pygenum_class_id is already
- registered.
-
- * gobject/pygtype.c (pyg_register_boxed_custom):
- pyg_boxed_marshal_key is already registered.
-
- * gobject/pygobject.c (pygobject_register_class):
- pygobject_class_key is already registered.
- (pygobject_register_wrapper): pygobject_wrapper_key is already
- registered.
- (pygobject_new_with_interfaces): idem.
- (pygobject_new): pygobject_wrapper_key is already registered.
-
- * gobject/pygboxed.c (pyg_register_boxed): Don't register
- boxed_type_id, use pygboxed_type_key instead, which is assumed to
- be already registered.
-
- * gobject/gobjectmodule.c (initgobject): Register all the gquarks.
- (global): Remove the *_id static const strings, they are redundant now.
-
- * gobject/pygobject-private.h: Declare all the global gquarks.
-
-2005-05-25 Manish Singh <yosh@gimp.org>
-
- * gobject/pygiochannel.c: Pass gsize to GIOChannel functions that
- expect them.
-
-2005-05-25 Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
-
- * examples/gtk/widget.py (PyGtkWidget.do_realize): move_resize()
- window here as well.
- (PyGtkWidget.do_expose_event): Fix rectangle coordinates.
- (frame): Put custom widget in a frame (Christian Kirbach).
-
-2005-05-22 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * tests/test_signal.py: Update tests to deal with automatic
- registration.
-
- * examples/gobject/signal.py: Update example to not call
- gobject.type_register anymore.
-
- * gobject/pygobject.c: Add PyGObject_MetaType impl.
- (pygobject_register_class): Set the metaclass of new types to
- &PyGObject_MetaType.
-
- * gobject/gobjectmodule.c (pyg_type_register): split in two
- functions; one (pyg_type_register) that does all the work and
- return 0 on success or -1 on error; the other one
- ( _wrap_pyg_type_register ) does the python argument parsing and
- calls the first one.
- (initgobject): Register the new PyGObject_MetaType type, which is
- a metaclass that automatically registers user defined GObject
- subclasses.
-
- Fixes #128765: GObject metaclass.
-
-2005-05-22 Gustavo J. A. M. Carneiro <gjc@gnome.org>
-
- * gobject/gobjectmodule.c: Wrap g_markup_escape_text. Fixes #164665.
-
- * gtk/gtk.defs: Add gtk.EntryCompletion.get_text_column.
- Patch by Gian Mario Tagliaretti.
-
- * gtk/gdk.defs (save_to_callback): Add.
-
- * gtk/gdk.override (_wrap_gdk_pixbuf_save_to_callback): Wrap
- gdk_pixbuf_save_to_callback. Fixes #172445.
-
- * gobject/pygiochannel.c: Add; implements GIOChannel wrappers.
- Fixes #139176: GIOChannel wrapper.
-
- * gobject/gobjectmodule.c (initgobject): Register IOChannel type
- and some constants.
-
- * gtk/gdk.defs: Add functions notify_startup_complete,
- get_display_arg_name, get_program_class, set_program_class, and
- get_display. Fixes #167412.
-
-2005-05-22 Tim Evans <t.evans@aranz.com>
-
- * gtk/gtktreeview.override
- (_wrap_gtk_tree_view_map_expanded_rows): Don't unref borrowed
- reference data.user_data. Reviewed by Gustavo Carneiro; Fixes
- #165373 (crash due to extra Py_XDECREF in
- gtk.TreeView.map_expanded_rows)
-
-2005-05-17 Manish Singh <yosh@gimp.org>
-
- * gobject/pygparamspec.c (pyg_param_spec_getattr): make it build
- again (missing })
-
-2005-05-17 Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/pygparamspec.c: (pygenum_from_pspec),
- (pygflags_from_pspec): Improve GParamSpec wrapping, fixes
- bug #170614
-
-2005-05-17 Benjamin Otte <in7y118@public.uni-hamburg.de>
-
- reviewed by: Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c: (pyg_register_class_init),
- (pyg_run_class_init): Allow multiple calls to
- pyg_register_class_init, fixes bug #304353
-
-2005-05-17 Benjamin Otte <in7y118@public.uni-hamburg.de>
-
- reviewed by: Johan Dahlin <jdahlin@async.com.br>
-
- * gobject/gobjectmodule.c:
- * gobject/pygobject-private.h:
- * gobject/pygobject.h:
- * gobject/pygtype.c: (pyg_closure_marshal),
- (pyg_closure_set_exception_handler): Adds exception handling
- support to closures, fixes bug #304357
-
-2005-05-17 Johan Dahlin <jdahlin@async.com.br>
-
- * configure.in: Bump version to 2.7.0
-
- * pango-types.defs (EllipsizeMode): Remove commas
-
- * pango.defs (get_font_description, get_ellipsize, set_ellipsize):
- Add
-
-2005-05-17 Johan Dahlin <jdahlin@async.com.br>
-
- * ChangeLog.pre-2-6: Rename old ChangeLog
-
diff --git a/MANIFEST.in b/MANIFEST.in
deleted file mode 100644
index 5048948f..00000000
--- a/MANIFEST.in
+++ /dev/null
@@ -1,11 +0,0 @@
-exclude atk.c pango.c gtk/gtk.c gtk/gdk.c gtk/libglade.c
-include ChangeLog AUTHORS COPYING MAPPING NEWS README THREADS TODO
-include MANIFEST.in
-include pygobject.h pygobject-private.h
-include *.defs *.override
-include pygtk.py pygtk-2.0.pc.in
-include dsextras.py
-recursive-include gtk *.override *.defs *.h
-recursive-include codegen README.defs *.py pygtk-codegen-2.0.in
-recursive-include examples README *.py *.xpm
-global-exclude */CVS/* .cvsignore
diff --git a/MAPPING b/MAPPING
deleted file mode 100644
index fb758e46..00000000
--- a/MAPPING
+++ /dev/null
@@ -1,170 +0,0 @@
-The mapping of GTK+ onto Python
-===============================
-
-This file documents the mapping of the C GTK+ functions and types in
-the pygtk package. If you want just enough information on how to use
-C documentation to help you program with pygtk or help you read or
-translate GTK+ programs written in C, then see the "Mapping of GTK+
-functions to gtk.py" section.
-
-
-The _gtk module
-===============
-
-This module is almost a direct mapping of the GTK+ functions. It has
-no object oriented constructs and is the part written in C. Large
-parts of it are generated from .defs files (which are also used in the
-guile and perl bindings), while some is written in hand crafted C.
-Note that this module is mainly a convenience that makes it easier to
-code the higher level gtk.py.
-
-There are a number of types defined by this module. The main one is a
-wrapper for GtkObject and all its descendants. This type is just a
-wrapper round the pointer, and calls gtk_object_ref on creation, and
-gtk_object_unref on destruction (hence the C structure will not be
-freed while python has a reference to it).
-
-For all the functions in _gtk that take GtkObject descendents as
-arguments, the type conversion is done automatically (so you don't
-have to call GTK_WIDGET or GTK_CONTAINER type macros). So at this
-level, reference counting and type casting has already been taken care
-of.
-
-Also a number of other types are defined in this module. For these
-objects, there are relatively few functions and attributes specific to
-the individual types, so I have spent some time writing nice
-interfaces to them. Outlines of the available attributes and methods
-of these types are available in the file description.py, which is
-distributed with pygtk. These types include:
- GtkCTreeNode
- GtkStyle
- GtkSelectionData
- GdkAtom
- GdkColor
- GdkColormap
- GdkCursor
- GdkDragContext
- GdkEvent
- GdkFont
- GdkGC
- GdkWindow (aka GdkDrawable aka GdkPixmap aka GdkBitmap)
-
-Also, for the functions defined in _gtk, enumerations and flags are
-handled specially. Where an enumeration value is to be passed to a
-function, you can give it an integer representing its value, or a
-string representing the name. For the list of names that can be used,
-see the file gtk.defs that comes with the GTK+ distribution. The
-(define-enum) and (define-flags) sections list the possible values.
-For flags, you can pass any value that would be accepted as an enum
-value in adition to a tuple of strings, which would be converted to
-their corresponding numeric values and ORed together.
-
-GTK.py and GDK.py
-=================
-
-These python modules define the numerical values for the host of enums
-and flags in gtk and gdk respectively. The GTK_ prefix has been
-removed from the gtk enums, and the GDK_ prefix from the GDK ones
-(where this would leave the identifier starting with a digit, an
-underscore has been prepended). This way if you do an "import GTK",
-you reference the constants with a gtk prefix (eg GTK.STATE_NORMAL),
-or if you do a "from GTK import *" you can access the constants via
-shorter names (eg STATE_NORMAL).
-
-With _gtk, GTK.py and GDK.py, you should be able to write programs
-that quite closely resemble the what they would look like in C (minus
-type casts and occasional referencing/dereferencing).
-
-gtk.py
-======
-
-This module is meant to be the high level interface that will be used
-by most programmers. It defines a number of classes that mirror the
-class heirachy of the GtkObject descendents found in GTK+. Each of
-these classes has an _o attribute which points to an instance of the
-GtkObject wrapper type from _gtk.
-
-Because of reference counting problems (we don't want the GTK object
-to die while we have a reference to the python one, and we don't want
-the python one to die while we have a reference to the GTK object --
-circular reference alert :), there will usually be more than one of
-these python wrappers existing for a single GtkObject (ie. a 1 to many
-relationship). The bigest example of this is signal handlers where a
-different object will always be passed in. This means that any
-attributes you set on the object (ie. obj.foo = "bar") will not be
-visible inside the callback. You can get round this by using the
-object data mechanisms:
- obj.set_data("string_tag", data)
- data = obj.get_data("string_tag")
-
-This data will be accessible to every instance pointing to a single
-GtkObject.
-
-Since there are two times you may want to create instances of these
-classes, there are two ways to call their constructors:
- - as normal to create a new C level object.
- - as 'GtkSomething(_obj=obj)', which does not create a new C level
- object, but creates a new python instance that represents the C
- level object wrapped by obj.
-
-The second way of creating instances is done by giving default values
-for all the constructor arguments, and adding "_obj=None" to the end
-of the argument list. Then the first line of the constructor is set
-to:
- if _obj: self._o = _obj; return
-
-Mapping of GTK+ functions to gtk.py
-===================================
-
-For each GtkObject descendent, there is a python class of the same
-name. It will list the C class's superclass as its superclass. For
-each desendant, say GtkSomething, there will be a function defined in
-GTK+ called gtk_something_new() or similar. This is mapped to the
-constructor for the class.
-
-There are usually a number of other functions starting with
-gtk_something_ in GTK+. These functions will generally take an
-instance of GtkSomething as the first argument. These map to methods
-of the python class. So the following:
- gtk_something_method(GtkSomething *something, args, ...)
-maps to this:
- something.method(args, ...)
-
-Note that this means that methods of the parent class are accessed as
-easily as those of the actual class.
-
-There are a few special cases of course. For instance, all the
-gtk_drag_*() functions have been mapped to GtkWidget.drag_*(), and the
-gtk_selection_*() functions have been mapped to
-GtkWidget.selection_*().
-
-The object argument mechanisms are also implemented in pygtk. You can
-query and change these properties on an already instantiated object
-using the mapping behaviour similar to the way you can in Tkinter (eg
-label_widget['label'] = 'Hello' will change a label's text). You can
-also create new objects and setting their object arguments at creation
-time with the new() method. The first argument should be the class
-object for the instance you want. The rest of the arguments should be
-keyword arguments specifying the object arguments you want to set (eg
-label = new(GtkLabel, label='Hello')).
-
-There are also a number of other functions not associated with any
-particular class that are accessible through the global scope of the
-gtk.py module. It is probably easiest to read the end of gtk.py to
-get a feel for these functions.
-
-gtk.py also imports the GTK constants with "from GTK import *", and
-the GDK constants with "import GDK". The reasons for using "from GTK
-import *" are partly for convenience and partly because thats how I
-did it when I first wrote pygtk :)
-
-Conclusions
-===========
-
-That about sums up the language mapping in pygtk. The best way of
-learning how to program in pygtk is to read sample code. Take a look
-at the examples/ directory, and go through the examples there.
-
-If you think something is missing from this document, please mail me
-at <james@daa.com.au>.
-
diff --git a/Makefile.am b/Makefile.am
deleted file mode 100644
index 55083dbe..00000000
--- a/Makefile.am
+++ /dev/null
@@ -1,128 +0,0 @@
-AUTOMAKE_OPTIONS = 1.7
-
-if BUILD_GTK
- GTK_SUBDIR = gtk
-endif
-
-SUBDIRS = codegen . $(GTK_SUBDIR) examples tests docs
-
-PLATFORM_VERSION = 2.0
-
-CLEANFILES =
-EXTRA_DIST = \
- ChangeLog.pre-2-0 \
- ChangeLog.pre-2-6 \
- config.h.win32 \
- MANIFEST.in \
- MAPPING \
- pygtk.spec \
- pygtk.spec.in \
- pygtk-$(PLATFORM_VERSION).pc.in \
- pygtk_postinstall.py \
- PKG-INFO \
- PKG-INFO.in \
- setup.py \
- THREADS
-
-INCLUDES = \
- $(PYTHON_INCLUDES) \
- $(PYGOBJECT_CFLAGS) \
- $(GLIB_CFLAGS) \
- -I$(srcdir)/gtk
-
-# pkg-config files
-pkgconfigdir = $(libdir)/pkgconfig
-pkgconfig_DATA =
-pkgconfig_DATA += pygtk-$(PLATFORM_VERSION).pc
-
-# defs files
-defsdir = $(pkgdatadir)/$(PLATFORM_VERSION)/defs
-defs_DATA =
-
-# python
-pyexec_LTLIBRARIES =
-noinst_PYTHON = ltihooks.py
-
-# pygtk scripts
-pkgpythondir = $(pyexecdir)/gtk-2.0
-
-# pygtk extension modules
-pkgpyexecdir = $(pyexecdir)/gtk-2.0
-pkgpyexec_LTLIBRARIES =
-
-# linker flags
-common_ldflags = -module -avoid-version
-if PLATFORM_WIN32
-common_ldflags += -no-undefined
-endif
-
-# atk module
-ATK_DEFS = atk.defs atk-types.defs
-ATK_OVERRIDES = atk.override atkrectangle.override
-CLEANFILES += atk.c
-EXTRA_DIST += $(ATK_DEFS) $(ATK_OVERRIDES)
-atk.c: $(ATK_DEFS) $(ATK_OVERRIDES)
-atk_la_CFLAGS = $(ATK_CFLAGS)
-atk_la_LIBADD = $(ATK_LIBS)
-atk_la_LDFLAGS = $(common_ldflags) -export-symbols-regex initatk
-atk_la_SOURCES = atkmodule.c
-nodist_atk_la_SOURCES = atk.c
-if BUILD_ATK
-pkgpyexec_LTLIBRARIES += atk.la
-defs_DATA += $(ATK_DEFS)
-endif
-
-# pango module
-PANGO_DEFS = pango.defs pango-types.defs
-CLEANFILES += pango.c
-EXTRA_DIST += $(PANGO_DEFS) pango.override
-pango.c: $(PANGO_DEFS) pango.override
-pango_la_CFLAGS = $(PANGO_CFLAGS)
-pango_la_LIBADD = $(PANGO_LIBS)
-pango_la_LDFLAGS = $(common_ldflags) -export-symbols-regex initpango
-pango_la_SOURCES = pangomodule.c
-nodist_pango_la_SOURCES = pango.c
-if BUILD_PANGO
-pkgpyexec_LTLIBRARIES += pango.la
-defs_DATA += $(PANGO_DEFS)
-endif
-
-# pangocairo module
-PANGOCAIRO_DEFS = pangocairo.defs pangocairo.override
-CLEANFILES += pangocairo.c
-EXTRA_DIST += $(PANGOCAIRO_DEFS) pangocairo.override
-pangocairo.c: $(PANGOCAIRO_DEFS) pangocairo.override
-pangocairo_la_CFLAGS = $(PYCAIRO_CFLAGS) $(PANGOCAIRO_CFLAGS)
-pangocairo_la_LDFLAGS = $(common_ldflags) -export-symbols-regex initpangocairo
-pangocairo_la_LIBADD = $(PANGOCAIRO_LIBS)
-pangocairo_la_SOURCES = pangocairomodule.c
-nodist_pangocairo_la_SOURCES = pangocairo.c
-if BUILD_PANGOCAIRO
-pkgpyexec_LTLIBRARIES += pangocairo.la
-defs_DATA += $(PANGOCAIRO_DEFS)
-endif
-
-# code generator
-.defs.c:
- (cd $(srcdir)\
- && $(PYTHON) codegen/codegen.py \
- --py_ssize_t-clean \
- --register pango-types.defs \
- --register atk-types.defs \
- --register gtk/gtk-base-types.defs \
- --override $*.override \
- --prefix py$(*F) $*.defs) > $(*D)/gen-$(*F).c \
- && cp $(*D)/gen-$(*F).c $(*D)/$(*F).c \
- && rm -f $(*D)/gen-$(*F).c
-
-snap:
- $(MAKE) dist distdir=$(PACKAGE)-SNAP-`date +"%Y%m%d"`
-
-doc-dist:
- mkdir pygtk
- cp -r docs/html/*.html pygtk
- cp -r docs/html/*.sgml pygtk
- cp -r docs/html/*.devhelp pygtk
- cp -r $(PYGOBJECT_PYGDOCS)/style.css pygtk
- tar cfz $(PACKAGE)-docs.tar.gz pygtk
- rm -fr pygtk
diff --git a/NEWS b/NEWS
deleted file mode 100644
index 5bb92015..00000000
--- a/NEWS
+++ /dev/null
@@ -1,1086 +0,0 @@
-pygtk-2.10.4 4-februrary-2007
- - Documentation build fixes (John Finlay, Gustavo)
- - Return NULL on error in TextBuffer.register_serialize_format
- (Paolo Borelli)
- - Do not overwrite sys.argv (JP Calderone)
- - Add status icon example (Nikos Kouremenos)
- - Make it possible to remove rows in the gtk.TreeModel.foreach
- callback (Gustavo)
- - Code generator fix for %define (#381389, Manish Singh)
- - Duplicate GdkEvent.string member when setting it (#382428,
- Gustavo, John Ehresman)
- - Make it possible to use automake 1.10 (Kjartan Maraas)
- - distutils build fixes (#385934, Sebastien Bacher, Michael Bienia)
- - Allow None to be passed into gdk.Display (Johan)
- - Undeprecate gtk.container_class_list_child_properties (Johan)
- - Fix memory leak in gtk.Container.child_get (Gian Mario Tagliaretti)
-
-pygtk-2.10.3 3-october-2006
- - Fix a crasher bug introduced in 2.10.2 (Gustavo)
- - Make PyGTK work with Python 2.5 and 64-bit (#337368, Gustavo)
- (when used in conjunction with the soon-to-be-released PyGObject 2.12.2)
-
-pygtk-2.10.2 3-october-2006
- - distutils / win32 compilation fixes (Cedric Gustin)
- - gtk.TreeSelection.selected_foreach bug fix (#347273, Gustavo)
- - Fix compilation older C compilers (John Ehresman)
-
-pygtk-2.10.0 4-september-2006
- - Issue a warning when a DISPLAY is not set (#316877, Johan, Jeremey Katz)
- - Copy style.css from pygobject docs when installing docs.
- (#351385 Gian Mario Tagliaretti)
- - Include the built docs in the tarball (Johan)
-
-pygtk-2.9.6 8-august-2006
- - GtkTreePath can be converted from integers again (#350252, Gustavo,
- Sebastien Bacher)
- - Fix parallel build (#350225, Ed Catmur)
- - Reduce exception abuse in code generator (Gustavo)
- - Documentation improvements (Johan, John)
-
-pygtk-2.9.5 6-august-2006
- - Make it possible to build with GTK+ 2.10 (#350008, Joseph Sacco)
- - Make sure dir(gtk.keysyms) work again (#349892, Johan, John)
- - reloading the gtk module works again (#349026, Johan, Alexander Larsson)
-
-pygtk-2.9.4 4-august-2006
- - Include John Finlay's PyGTK reference manual (Johan, John)
- - Setters and getters for GtkWidget.activate_signal (#331445, Gustavo)
- - GtkToolItemType setter/getter (#331355, Gustavo)
- - Code generator fixes (Gustavo, Johan, John, Yevgen Muntyan, Gustavo)
- - Add more gtk+ 2.10 API (#337011, John, Sebastian Pölsterl)
- - Don't copy treeiters in callbacks (#347273, John, Stefano Maggiolo)
- - Provide full information for GtkTreeSelection.set_select_function
- (#340475 John, Wouter Bolsterlee)
- - Export less symbols and reduce the size of the libraries (#347825,
- Rafael Espíndola)
- - Allow negative values for GtkTreeModel.set/getitem (#311852, Baiju M)
- - Much improved interface/virtual method support (John)
- - Remove evil 100ms timeout timer (#348937, Gustavo)
-
-pygtk-2.9.3 12-july-2006
- - Update to latest gtk+ 2.10 API changes (#345447, #345623, Newren, Peters)
- - Many more new gtk+ 2.10 APIs wrapped (Finlay)
- - Wrap gtk_widget_class_find_style_property (Finlay)
- - gtk.gdk.CairoContext.rectangle bug fix (Gustavo)
- - Update defs for atk 1.8 (Finlay)
- - Misc. module cleanups (Dahlin)
- - New pango APIs wrapped (Finlay)
- - Fix refcount error in gtk.Clipboard (#343960, Gustavo, Finlay)
- - Enable GDK X11-specific APIs available also with gtk+ 2.8 (Gustavo)
- - Lazy loading of the gtk.keysyms module (Johan Dahlin)
-
-pygtk-2.9.2 15-june-2006
- - Fix a codegen bug that prevent build of other extensions (344845, Gustavo)
- - Builds with pycairo 1.1.6 (344957, Gustavo)
- - gtk.TextBuffer rich text copy and serialization (Finlay)
- - Correct Print Editor example (Gustavo)
-
-pygtk-2.9.1 13-june-2006
- - Allow gtk.TreeSortable.set_default_sort_func callback to be None
- (Johan, Patrick O'Brien)
- - Add API to unset the g_log handlers (#323786, Johan)
- - Allow the gtk module to be imported without DISPLAY (#316877, Johan)
- - Code cleanup and fixes considering Coverity reports (Johan)
- - Add codegen support for const-Object return type (#169204, Gustavo)
- - Add codgen support for unblocking threads around method calls (Gustavo)
- - Wrap gdk_event_handler_set (Johan)
- - Codegen reverse wrapper bug fix (#340162, Yevgen Muntyan)
- - Wrap GdkRegion (John Ehresman)
- - Add codegen support for ignore-type statement in override (Johan)
- - Add conditional support for gtk+ 2.10 API, especially printing
- (Johan, Finlay, Gustavo)
- - Complete the support for gtk.Container virtual methods (#341641, Gustavo)
- - Fix misc. reference leaks (Finlay, Gustavo)
- - Allow None parameter in pangocairo.CairoContext.set_font_options (Finlay)
- - Complete the support for gtk.CellRenderer virtual methods (#339431, Gustavo)
- - IconView.set_cursor method params 'cell' and 'start_editing'
- made optional (#343039, Ross Burton, Finlay)
- - Wrap a few more gdk_cairo_* methods (Finlay)
- - Add a 'selection' field to gdk.OWNER_CHANGE events (Finlay)
- - Allow None in gtk.Entry.set_inner_border() (Finlay)
- - gtk.Clipboard rich text methods (Finlay)
- - Add gtk.MessageDialog.set_image() (Finlay)
- - Wrap gtk_link_button_set_uri_hook() (Finlay)
- - Allow None in gtk.Widget.input_shape_combine_mask() (Finlay)
- - Allow gtk.LinkButton() constructor to optionally receive a label (Finlay)
- - Allow None in gtk.Label.set_mnemonic_widget() (Johan)
- - Wrap a bunch of X11 specific gdk methods (Gustavo)
- - Add gtk.SizeGroup.get_widgets() (Finlay)
- - Wrap gtk_style_lookup_color() (Finlay)
- - Wrap a bunch of gtk treeview grid lines methods (Finlay)
- - Better Drag and drop API support (Finlay)
- - Add -I option to codegen (defs search path) (Gustavo)
-
-pygtk-2.9.0 04-april-2006
- - Remove gobject, pygobject is now a hard dependency
- - Set encoding in pango instead of gtk (328031)
- - Wrap gdk.Screen.get_rgba_colormap/get_rgbma_visual (328996,
- Marco Cabizza)
- - Remove private gtk wrappers (321476)
- - Add a bunch of missing wrappers (316881, John Finlay)
- - Add inout support in reverse wrappers (335964, Gustavo)
- - Update h2defs to allow whitespace before parenthesis (317124)
- - Make it possible to reimplement interfaces (334986, Gustavo)
- - Allow log_handler to be called when python is not initialized
- (334188, Gustavo)
- - Support for const object args (wollny@cbs.mpg.de, Gustavo)
- - Export pygtk tree model api (318021, Gustavo)
- - Allow overrides to be in base classes (327715, Gustavo)
- - Wrap a pango cairo font options acecssors (328108,
- Rauli Ruohonen)
- - Add GDK_PARENT_RELATIVE relative handling (320248, Johan,
- Nikos Kouremenos)
- - Improve pixbuf demo (327931, Ben Caradoc-Davies)
- - Set default markup accel marker to \x00
- (329658, Johan, Johan Svedberg)
- - Set 1 as default argument to SpinButton.spin() (325452,
- Sebastian Rittau)
- - Wrap gdk.Drawable.gdk_draw_indexed_image (333431,
- Johan, Hamish Moffatt)
- - Mark rowreference.free() as deprecated (309811, Gustavo)
- - Rename name of first keyword argument to pango.LayoutLine.index_to_x
- (316581, Gustavo, John Finlay)
- - Run reindent on all python code (325320, Johan)
- - Improve generictreemodel example (311459, Steven Kennedy)
- - Wrap gdk.Pixbuf.rotate_simple (314164, Karel Vervaeke)
- - Use in argument in gtk.TreeView.cell_get_size (326357, John Ehresman)
-
-pygtk-2.8.5: 30-march-2006
- - String list bug fix (Christopher Aillon)
- - Improved examples (Johan)
- - Proper refcounting in gdk.Window constructor (John Ehresman)
- - Fix a bunch of reference leaks (Gustavo)
- - __init__.py fixes for pydoc (Johan)
- - gtk.Dialog.new_with_buttons leak (#332771, Gustavo)
-
-pygtk-2.8.4: 11-january-2006
- - Re-include gobject wrappers if pygobject is not found (Gustavo, Johan)
- - gtk.IconView should implement GtkCellLayout (Johan)
- - Always install pygtk-2.0.pc
-
-pygtk-2.8.3: 09-january-2006
- - Split out gobject wrappers into a separate module and
- depend on pygobject 2.9.0 (Johan)
- - Bug fixes (Bob Gibbs, Johan, Gustavo)
- - Size group example (Johan)
- - Plug mem leaks (Gustavo)
- - Build cairo on win32 (Cedric)
-
-pygtk-2.8.2: 09-october-2005
- - GIOChannel thread fix (Johan, Ole Andre Vadla Ravnås)
-
-pygtk-2.8.1: 03-october-2005
- - Bug fixes (Gustavo, Johan)
- - Improve exceptions when registering properties (Gustavo)
- - Extend warnings (John Ehresman)
- - Raise exception when working on uninitialized objects (Johan)
- - Plug libglade leak (Gustavo)
- - Undeprecate a few gobject functions (Johan)
- - UINT64 buf fixes (Gustavo, Johan)
- - GCC 4.0 warnings (Johan)
-
-pygtk-2.8.0: 03-september-2005
- - GObject metaclass bugfix (John Ehresman)
- - Double free fix in type_register (Gustavo)
- - Make it buildable srcdir != buildir (Johan)
- - Improve GdkRectangle conversion (Tim Evans, Gustavo)
- - Use automake 1.8 (Johan)
-
-pygtk-2.7.4: 24-august-2005
- - Container.do_forall implementable in subclasses (Johan)
- - Bug fixes (John Finlay, Christian Persch, Christopher Allion,
- Johan, Gustavo)
- - Build fixes (Stepan Kasal, John Ehresman, Johan)
-
-pygtk-2.7.3: 10-august-2005
- - Build fixes (Johan)
- - Code generator fixes (Gustavo)
- - Bug fixes (Johan, Andy, Gustavo)
-
-pygtk-2.7.2: 02-august-2005
- - Subclass/type registration bug fixes (Gustavo)
- - Allow gobject to be initialized twice (Yevgen Muntyan)
- - Deprecating warning bug fixes (Mark McLoughlin)
- - Bug fixes (Sebastien Bacher, Gustavo, Johan, Manish)
-
-pygtk-2.7.1: 21-july-2005
- - Update API to Gtk+ 2.7.3 (Johan)
- - Threading, Enum fixes (Johan
- - Registration fixes (Gustavo)
- - Make use of atomic ref counting in glib (Johan)
-
-pygtk-2.7.0: 10-july-2005
- - GIOChannel wrapper (Gustavo, John Ehresman, Manish)
- - GSource wrapper (Manish)
- - Allow creation of python classes through gobject.new (Gustavo,
- John Ehresman, Benjamin Otte)
- - Improved GObject property support (Gustavo, Iñaki, Johan)
- - Improved ParamSpec wrapping (Johan)
- - Add gdkcairo and pangocairo wrapping, depends on pycairo (Gustavo)
- - 2.8 API updates (Johan)
- - Add GObject metaclass, making type_register unnecessary (Gustavo)
- - C++ compilation fixes (Manish)
- - Handle longs/ints better (Gustavo)
- - Support new GType fundamentals (Edward Hervey, Johan)
- - Improved GType wrapping (Johan)
- - Support for specifying GType name (Johan)
- - GtkContainer iterator support (Johan)
- - Support for subclasses that implements scrolling (Gustavo, Johan)
- - Bug fixes/Misc fixes (Steve Chaplin, Tim Evans, John Finlay,
- Cedric Gustin, Edward Hervey, Christian Kirbach, Tuure Laurinolli,
- Benjamin Otte, Manish Singh, Gian Mario Tagliaretti,
- Fernando San Martin Woerner)
-
-pygtk-2.6.2: 9-may-2005
- - Allow None to be sent in to set_group radio widgets (Johan, Lorenzo)
- - guint/gsize as longs (Gustavo)
- - Check for exceptions in child_watch (Mark McLoughlin)
- - Bug fixes (Johan, Manish Singh, John Finaly)
-
-pygtk-2.6.1: 15-march-2005
- - GtkListStore.insert optimization (Johan)
- - GtkTreeStore/GtkListStore.reorder leak fix (Johan, Richard Hult)
- - GParamSpec bug fix (Johan)
- - Code generator improvements (Anders Carlsson, Johan, Doug Quale)
- - GCC4 build fixes
-
-pygtk-2.6.0: 07-march-2005
- - win32 fixes (Cedric Gustin)
- - remove unnecessary casting (Manish Singh)
- - updated examples (Johan)
-
-pygtk-2.5.4: 23-february-2005
- - Much improved GMainloop support (Mark McLoughlin)
- - Install pygtk-demo (Gustavo)
- - Deprecate gtk.TRUE/gtk.FALSE (Johan)
- - win32 build fixes (Cedric Gustin)
-
-pygtk-2.5.3: 23-january-2005
- - Revert some threading changes (Gustavo)
- - Build improvements (Johan)
- - Improve pixmap functions (John F)
- - GObject type registration fixes (Gustavo)
- - Code generator fixes (Johan, Gustavo)
- - Plug mem leaks (Mark McLoughlin)
- - Flag/Enum bug fixes (Gustavo)
-
-pygtk-2.5.2: 10-january-2005
- - Improved deprecation messages (Johan)
- - gtk.idle_add, gtk.timout_add, and others are now
- deprecated (Johan)
- - Overriding GTK+ virtual methods (Gustavo)
- - Interfaces now implementation (Gustavo)
- - 2.6 merge (Johan, Gian Mario Tagliaretti)
- - Bug fixes (Adam Hooper, John Finlay, Gustavo, Johan, Tim Evans)
- - Build system improvens (Johan)
-
-pygtk-2.5.1: 23-december-2004
- - Remove API removed in Gtk+ 2.6.0 (Gustavo, Johan)
- - Implement pango.LayoutIter (John)
- - Build fixes (Johan, Marco Pensenti Gritti)
- - Update examples (Alan Horkan)
- - distutils/win32 fixes (Cedric Gustin)
-
-pygtk-2.5.0: 29-november-2004
- - Port to Gtk+ 2.5.x (Johan, John)
- - Code generator improvements (Gustavo)
-
-pygtk-2.4.1: 04-november-2004
- - Bug fixes (Johan, Gustavo, John Finlay)
- - Allow the headers to be parsable by a C++ compiler
- - Updated examples (Johan, John)
-pygtk-2.4.0: 03-october-2004
- - Updated examples (John Finlay)
- - Tiny threading bug fix (John Ehresman)
-
-pygtk-2.3.97: 28-september-2004
- - Threading fixes (Gustavo, Johan, John E)
- - Other bug fixes (Gustavo, James, Johan, John, Ehresman,
- John Finaly, Owen Taylor and Xaiver Ordoquy)
- - x86_64 build fixes (Jonathan Blandford)
- - Updated examples (John Finlay)
-
-pygtk-2.3.96: 06-august-2004
- - Threading fixes (Johan, Gustavo)
- - Bug fixes (John, Johan, Gustavo)
- - GEnum/GFlags wrapping improvements
- - GdkAtom string wrapping (John)
- - Better boolean support (since we now can require 2.3)
-
-pygtk-2.3.95: 02-august-2004
- - Flags/Enum fixes (John, Johan)
- - Bug Fixes (John, John E, Johan, Gustavo)
- - Improved threading support (Johan)
-
-pygtk-2.3.94: 21-july-2004
- - bug fixed (Gustavo, Johan, John, Lorenzo)
- - small enum additions for gazpacho (Johan)
- - rename GMainLoop, GMainContext back to MainLoop and MainContext
-
-pygtk-2.3.93: 19-july-2004
- - GtkTreeView updates (John Finlay)
- - New examples (Johan)
- - GEnum/GFlags wrapping (Johan)
- - New (using g_object_new) constructors (Gustavo)
- - GParamSpec API, for GtkWidget and GtkContainer (Johan)
- - Unichar/Unicode support (Lorenzo, John Ehresman)
- - Widget subclassing (Johan, Gustavo, Lorenzo)
- - GdkEvents changable (Johan)
- - Warnings (Gustavo, Johan)
- - Many bugfixes (John Finlay, John Ehresman, Johan, Lorenzo, Gustavo)
- - Win32/FreeBSD/distutils build fixes (John, Johan)
-
-pygtk-2.3.92: 22-may-2004
- - Deprecate old function (John Finlay)
- - Add missing 2.4 api for pango, gdk and gtk (John Finlay):
- PangoAttrList, PangoFontset, PangoFontFamily,
- GdkWindow, GdkPixbuf, GdkPixbufLoader, GtkClipboard,
- GtkTreeView, GtkTreeModel, GtkToolbar
- - Reference counting fixes (John)
- - gobject type registration improvements (Gustavo)
-
-pygtk-2.3.91: 16-april-2004
- - Continue to wrap 2.4 api: GtkActionGroup,
- GtkColorButton, GtkCellLayout, GtkComboBox, GtkFileChooser,
- GtkFontButton, GtkIconInfo, Gtk*ToolButton (John Finlay, Johan)
- - ref GdkWindows on win32 (John Ehresman, Gustavo)
- - Clean up defs (John)
- - Deprecate 0.6.x compatibility functions (Johan)
- - Convert GValueArray to list, not tuple (Gustavo)
- - Add new demos (Joey Tsai)
- - Create unknown types on the fly, with interfaces (Johan)
- - Update spec (Jason Tackaberry, Thomas Vander Stichele)
- - Support tp_new (Johan)
-
-pygtk-2.3.90: 30-march-2004
- - Merge in changes for Gtk+ 2.4 (Johan, Xavier)
- - GtkUIManager, GtkFileChooser, GtkTreeModelFilter,
- GtkActionGroup, GtkAction, GtkToolbar etc
- - Export GParamSpec in GObject and support style properties
- - Distutils win32 fixes (Cedric Gustin)
- - Fix mainloop related warnings (bug 136731, bug 136705)
- - Updated examples (Johan)
- - gdk.atom_intern (Gustavo)
- - Code generator fixes (Xavier)
-
-pygtk-2.2.0: 11-march-2004
- - Added support for GTK+ 2.2 APIs, GdkDisplay, GdkScreen,
- GdkClipboard and GtkWindow (James)
- - Better and more flexible support for TreeModel and TreeView API
- (Don Allingham, Benjamin Cama, John Ehresman, Johan,
- jkluebs@luebsphoto.com)
- - Better support for gtk.gdk.Pixbuf integration with
- Numerical arrays (Tim Evans)
- - Better support for Pygtk generation tools (codegen, m4 macros,
- h2def, Makefile.am ...) (James, Jon Willeke, Xavier, Johan)
- - Removed gtkgl bindings (James)
- - Added gtk.gdk.Eventkey.hardware_code (Johan)
- - Added gtk.binding_entry_remove and gtk.accel_group_connect (Gustavo)
- - Don't allow reading non readable properties (James)
- - And lots of bug fixes: gdk.event_get_axis (Seth Nickell),
- distutils (Alif Wahid), mem leaks, gtk.Menu.popup (Gustavo)
-
-pygtk-2.0.0: 1-September-2003
- - Roll version number over to 2.0.
- - Small fix to gtk.TextView.set_border_window_size() method.
- - Miscelaneous bug fixes.
-
-pygtk-1.99.18: 24-August-2003
- - Fix up a duplicate symbol bug in the atk module, that was
- causing build problems on MacOS X (hopefully the last such
- problem).
- - add gtk.glade.set_custom_handler() API, that provides more
- info to the custom widget callback. Deprecate
- set_custom_widget_callbacks().
- - some other bug fixes.
-
-pygtk-1.99.17: 31-July-2003
- - Threading support is compiled in by default now. It is
- necessary to call gtk.threads_init() in order to make use of
- threading though. There have been a number of fixes to the
- threading support too.
- - Fix up some problems with multiple definitions of global
- variables in gobject module, that was causing problems on
- Mac OS X.
- - Wrappers for many new APIs (John Finlay, Naofumi Yasufuku,
- Johan Dahlin and others).
- - Improvements to the code generator to give better error
- messages.
- - Some fixes to property APIs to work correctly on 64 bit
- systems, and to handle ATOM type properties.
- - Fix copyright headers on source files.
-
-pygtk-1.99.16: 23-March-2003
- - various new functions wrapped.
- - More threding fixes (Jon Trowbridge)
- - Reworking of the single instance per GObject code to work
- better with the Python cycle GC.
- - more updates to the simplified Python tree model API.
- - fix error handling in constructors for GtkTreeStore and
- GtkListStore.
- - add some inline comments for the APIs for extending pygtk to
- handle other widget sets.
-
-pygtk-1.99.15: 08-February-2003
- - distutils support
- - Code generator improvements (Jeremy Katz)
- - Threading fixes (Lots of people)
- - API additions to GtkTextBuffer, GtkTextView and GtkFileSelection
- - GMainLoop/GMainContext support, you can now run input_add,
- timeout_add without importing gtk.
- - libglade now support passing in an instance to signal_autoconnect
- - pygtk.py import speedup.
- - Many many bugs fixed.
-
-pygtk-1.99.14: 27-December-2002
- - update to newer auto-tools (autoconf-2.57, automake-1.7.2,
- libtool-1.4.3).
- - many bug fixes and additions of missing APIs.
- - fix doc generation scripts to match the new style of gtk-doc
- documentation.
- - make code generator return either Py_True or Py_False for
- boolean return functions. This change is only noticable
- with Python 2.3 alphas.
- - removal of wrappers for deprecated functions where the
- deprecated method shadowed the replacement.
- - wrappers for idle_add, timeout_add, io_add_watch and
- source_remove to gobject module. Compatibility names are
- provided in the gtk module.
- - Many tree and text view wrapper updates from Johan Dahlin and
- John Finlay.
- - leak fixes.
- - Updated examples, including demo for editable cells.
- - Improved threading support.
- - Api additions for GdkEvents, TreeSelection, GtkTooltips, libglade,
- GtkContainer.
-
-pygtk-1.99.13: 24-August-2002
- - Support parallel install with pygtk >= 0.6.10
- - fix initial reference handling for derived GObjects. This
- also uncovered a few other reference leaks.
- - Other reference leak fixes from Arjan.
- - Support building out of the box on windows with mingw32 from
- Cedric Gustin.
-
-pygtk-1.99.12: 23-July-2002
- - more win32 compat updates.
- - simple tree model interfaces added.
- - added generic cell renderer type.
-
-pygtk-1.99.11: 10-July-2002
- - int64/uint64 arg handlers in code generator.
- - some reference leak fixes.
- - get signal handlers to participate in cyclic garbage
- collection (thanks to Arjan Molenaar).
- - correctly reset LC_NUMERIC to "C" when initialising the gtk
- module.
-
-pygtk-1.99.10: 13-May-2002
- - support new arg types in code generator.
- - handle (caller-owns-return) in code generator.
- - add gtk.compat module that provides similar naming to gtk
- 1.2 modules.
-
-pygtk-1.99.9: 23-April-2002
- - Some win32 compatibility fixes merged in from Hans.
- - update defs file to match final gtk 2.0 APIs.
- - added gtk.gl wrapper.
- - refactored code generator, fixing a number of bugs in the
- process.
-
-pygtk-1.99.8: 18-March-2002
- - Implement lots of stuff in Pango module.
- - make class names include module name so that help() output
- looks nicer.
- - lots of other functions added.
-
-pygtk-1.99.7: 31-January-2002
- - add (broken) threading support. Will need fixing one day.
- - make safe for use with PyMalloc.
- - split gobjectmodule.c into a number of files.
-
-pygtk-1.99.6: 24-December-2001
- - add scripts for generating documentation for pygtk.
- - add __gsignals__ and __gproperties__ sepcial class
- attributes for defining new signals and properties for an
- object.
- - better support for GError.
- - start of ATK wrapper (msw).
-
-pygtk-1.99.5: 26-November-2001
- - lots of updates.
-
-pygtk-1.99.4: 29-October-2001
- - fix up GObject last ref handling for derived types.
- - other fixes.
-
-pygtk-1.99.3: 9-October-2001
- - Rename the PyGtkTreeModel to PyGtkGenericTreeModel to avoid
- name conflicts.
- - many method wrappers added.
- - more reference fixes.
- - adjust code generator so that it outputs #line directives.
- - move defintions of types (as opposed to functions/methods)
- to separate files to improve compilation speed.
-
-pygtk-1.99.2: 29-September-2001
- - switch from ExtensionClass to use Python 2.2's type/class
- unification.
- - require Python 2.2a4
-
-pygtk-1.99.1: 20-September-2001
- - always use the GType wrapper type to represent GTypes,
- rather than using ints.
- - automatically populate modules with constants via
- introspection.
- - Switch from gtk.GtkFoo naming to gtk.Foo.
-
-pygtk-1.99.0: 10-September-2001
- - First cut tarball for 2.0 branch. Lots and lots of changes
- (since branching in April 2000).
- - Uses ExtensionClass, and implement GObject wrappers in C
- code, rather than the two stage wrapper like the 1.2 branch.
-
-
----- GTK-1.2 branch ----
-
-pygtk-0.6.11: 23-August-2002
- - Fix up libtool patch for older binutils'.
- - a few bug fixes in some GtkWidget methods.
-
-pygtk-0.6.10: 22-August-2002
- - Fix up segfaults when using with a Python compiled with
- pymalloc.
- - various new wrapper functions added.
- - Raise exception if gtk_init() fails.
- - bug fixes.
- - Support parallel install with PyGTK 2.0.
-
-pygtk-0.6.9: 3-Janyary-2002
- - always check the return value of functions for NULL values.
- This fixes a number of problems which caused crashes on
- exit.
- - add pygt_version and gtk_version variables.
- - update to autoconf-2.52/automake-1.5
- - many bug fixes (see ChangeLog).
-
-pygtk-0.6.8: 23-April-2001
- - bug fixes to GtkNotebook, GtkCList.
- - add some missing methods to GtkWidget
- - a gdk-pixbuf wrapper module.
- - install the code generator, so that other wrappers can use
- it as well.
-
-pygtk-0.6.7: 16-February-2001
- - added --disable-thread configure argument to turn off thread
- support even when compiling with a threaded python.
- - resets LC_NUMERIC back to "C" after calling gtk_set_locale,
- as this is the standard setting for python, no matter what
- the locale.
- - various other bug fixes.
-
-pygtk-0.6.6: 7-April-2000
- - switched over to using the CVS version of automake rather than
- my `pyautomake' patches, as CVS automake now has the python
- support integrated. Libtool is now used to build the extensions,
- so if there are problems on your platform, it is a libtool
- problem :)
- - typo fixes.
- - new pointer_(un)grab and keyboard_(un)grab methods for GdkWindow.
-
-pygtk-0.6.5: 13-March-2000
- - more reference leaks fixed.
- - crashes when changing window properties with 16 or 32 bit data
- formats fixed.
- - some libglade wrapper fixes.
- - various other fixes.
-
-pygtk-0.6.4: 16-February-2000
- - gnome-python now requires python >= 1.5.2, as it uses the 'N'
- format tag for PyArg_ParseTuple.
- - Reference leak fixes.
- - A few new features.
-
-pygtk-0.6.3: 30-September-1999
- - if the new gnome-python is installed, the libglade module will load
- the gnome support. Make sure you remember to import gnome.ui if the
- glade file contains any gnome widgets.
- - New methods for GdkWindow objects -- lower, _raise (for stacking
- order manipulation) and input_get_pointer (for XInput stuff).
- - A few other bugs have been fixed as well. See ChangeLog for details.
-
-pygtk-0.6.2: 9-August-1999
- - Threading should work correctly with multiple threads accessing
- GTK (assuming they use threads_enter/leave). Thanks go to Matt
- Wilson and Paul Fisher for this code.
- - A pygtk.h header file is now installed that should make it easier
- to write extensions to pygtk.
- - There is now optional support for the gtkglarea widget and the
- libglade library now.
- - There is support for gdkrgb functions for rendering rgb and greyscale
- image data to a drawable.
- - Optional support for numpy arrays. You can create a GdkImlibImage
- from a numpy array, and manipulate an image's data as an array.
- Also there is a gdk_draw_array wrapper that uses gdkrgb to render
- an array to a drawable. The code for the imlib stuff is based on
- stuff submitted by Travis Oliphant.
- - The GdkWindow type now has some methods for manipulating properties,
- and has an xid attribute for getting the X window ID of the window.
- - idle_add and timeout_add can now pass extra parameters to the
- callback, like you can do for signals. Also added a wrapper
- for signal handlers similar to gtk_signal_connect_object.
-
-pygtk-0.6.1: 22-May-1999
- - Fixed a few bugs to do with the threading patches I applied in the
- last release. Threading should now work correctly.
-
-pygtk-0.6.0: 25-April-1999
- - updated for gtk+-1.2.1.
- - You can now write multithreaded programs in python (if python was
- compiled with thread support enabled, of course). This feature
- is thanks to Duncan Grisby <dgrisby@uk.research.att.com>.
- To use the multithreading, write your program as normal, but
- before calling any GTK routines from outside the GTK thread (ie.
- not from a signal handler or timeout/idle func), call threads_enter()
- before hand, and threads_leave() after.
- - Various bug fixes.
-
-pygtk-0.5.11: 24-February-1999
- - Updated for gtk+-1.1.16
- - Changes to the style code, so that you can now write to the
- attributes. There is also a copy() method, which can be used
- so you don't change the style on other objects.
- - Some changes so some functions which are supposed to accept NULL
- arguments will accept None in place of a boxed/string/object
- argument.
- - Added a file MAPPING that describes the mapping of GTK onto python.
- - Various bug fixes.
- - Pyglade XML parser made more robust.
-
-pygtk-0.5.10: 9-February-1999
- - Updated for gtk+-1.1.14/15.
- - Fixed up some selection problems.
- - Added DnD example translated by Chi-Deok Hwang.
- - Some ctree fixes.
- - Some function renamings.
- - more functionality in the pixmap creation routines (you can create
- a pixmap if you have a GdkColormap but no GdkWindow).
- - added GdkWindow.depth attribute.
-
-pygtk-0.5.9:
- - Updated for gtk+-1.1.9
-
-pygtk-0.5.8: 10-December-1998
- - I made a mistake during building the last package. I ran
- cvs co pygtk; aclocal; automake --add-missing; autoconf; configure
- followed by make dist. Unfortunately, since there was no configure
- file when I ran automake, it didn't get added to the dist list.
- - Updated the spec files to match new version.
-
-pygtk-0.5.7: 9-December-1998
- - Updated for gtk+-1.1.6. Probably not much will change between now
- and 1.2.
- - Added GtkCTree, GtkLayout, GtkPlug and GtkSocket widgets.
- - There has been a renaming of a number of commonly used functions.
- if you use gtk.py, the old names still work, but give a warning.
- To get a list of the name changes, see the file
- $(prefix)/include/gtk/gtkcompat.h
- - signal connection now uses the gtk_signal_connect_full function,
- rather than relying on the default marshaller.
- - The append, prepend and insert methods of the toolbar now return
- the widget that was added, like the C equivalents do.
-
-pygtk-0.5.6: 27-November-1998
- - Updated for gtk+-1.1.5.
- - Renamed Gtkinter.py to gtk.py. This follows the naming scheme of
- other modules more closely, and is easier for people who prefer to
- use "import ...". It is also not a big change for people who
- use "from ... import *". I have included a simple Gtkinter.py
- module for backward compatibility.
- - Added a private function PyGtk_RegisterBoxed that can be used to add
- extra boxed types to the list of those registered in the callback
- marshals and the like.
-
-pygtk-0.5.5: 17-November-1998
- - Fixed a small bug in GdkImlib that caused a syntax error (I should
- have picked this up for the last release).
- - Removed some function wrappers that are not used anywhere, in order
- to get pygtk to compile cleanly on newer CVS GTK's.
- - I forgot to include the wrappings for the new GtkCalendar widget in
- the previous release. It is in this one.
-
-pygtk-0.5.4: 15-November-1998
- - updated for gtk+-1.1.3 (so you will need glib-1.1.4 as well). This
- release adds support for the new DnD functions, support for
- selection (through the gtk_selection_* functions, which I have
- mapped to GtkWidget.selection_*) and GdkAtoms, and support for
- GdkCursors.
- - To create a new cursor, use the cursor_new or cursor_new_from_pixmap
- function, and then call the GdkWindow.set_cursor method to attach
- it to a window.
- - Added create_pixmap_from_xpm_d function that allows you to embed
- XPM data into your program for easier distribution.
- - Updated the GdkImlib module to the features found in imlib-1.8.
- - Changed the build system, so SWIG is no longer needed. Also now
- using a modified version of automake to generate the makefiles.
- - Updated the pyglade code to handle menus and the like.
-
-pygtk-0.5.3: 27-September-1998
- - Updated for GTK+-1.1.2 (note that this version of gtk requires
- glib-1.1.3). This version adds the support for the tearoff menus
- and keyboard navigation of menus (if you use item factory).
- - This is the version of pygtk you will need for the pygnome wrapper
- for gnome v0.30 (when I finish writing them).
- - added events_pending function. Now you can use code like:
- while events_pending():
- mainiteration()
- to be sure that a scrollbar has been updated.
- - I have updated the examples/neil/*.py examples to use the
- GtkItemFactory class. This shows how to make keyboard navigable
- menus.
- - Fixed a typo in GtkWindow.set_focus
- - Fixed signal handler wrapper, so that handlers that return GtkObject
- classes get the return type converted back to the lower level
- GtkObjects. Also fixed _gtkbasemodule.c, so that return values from
- signals get returned to GTK properly. These fixes should allow
- people to use the GnomeMDI wrappers in pygnome if you change
- there signal definitions to use GTK_TYPE_OBJECT rather than
- GTK_TYPE_POINTER (I will ask the author to make this change).
-
-pygtk-0.5.2: 31-August-1998
- - fixed the ancestory for the GtkScrolledWindow class, fixed the
- GtkPreview constructor. Fixed some more spots in _gtkmodule.i
- where I'd used int types instead of the correct enumeration.
- - added the pyglade package. This will allow you to put a bit of
- code behind interfaces built with GLADE, which can be found at
- http://www.comp.lancs.ac.uk/~damon/builder/index.html
- In my current code, I have implemented most widgets on the
- palette, although the .glade file reader is a bit fragile. Note
- that this package is not a code generator (yet). It reads the
- interface description and builds the interface at runtime. This
- way you can keep the interface separate from the implementation.
- For an example of use, check the examples/glade directory.
- - Added support for the GtkItemFactory. Still no support for the
- GtkCTree -- even if I did put in support for it, the signal
- definitions define the GtkCTreeNode's as pointers, making it
- almost useless.
-
-pygtk-0.5.1: 19-August-1998
- - fix a small bug in configure script that prevented building.
-
-pygtk-0.5.0: 18-August-1998
- - Updated for GTK+-1.1.1
- - Replaced GtkAcceleratorTable with GtkAccelGroup.
- - Made use of the GtkFlagInfo and GtkEnumInfo structures. You can now
- specify enum values by a string as well as by a number. Flag values
- can be given as strings, or as a tuple of strings or numbers that
- are ORed together.
- - Added GtkAccelLabel, GtkFontSelection, GtkFontSelectionDialog,
- GtkPacker and GtkProgress widgets. Also updated the methods on all
- the other objects. I haven't yet done GtkCTree or GtkItemFactory.
- - Fixed the gtk_widget_size_request wrapper - it now returns the size
- requisition as a (w,h) tuple.
- - I have split gtkmodule into _gtkbasemodule and _gtkmodule. The code
- in _gtkbase is no longer generated. I have gone through and removed
- uneeded code put in by swig. This reduced the size of that piece
- of source by 25%. Hopefuly this will speed up some of the core
- functions a bit. If you use Gtkinter, this change is invisible.
- If you use gtkmodule directly, change:
- from gtk import *
- to
- from _gtkbase import *
- from _gtk import *
- pygtk_init()
- The pygtk_init function is part of the _gtk module, and is called
- to tell it about all the types in _gtkbase. (it should be called
- by the module's init routine, but I can't find out how to make that
- happen.
- - Updated the Gtkinter.new command. Now widget arguments don't get
- the widget name prepended, so I have changed the function from
- accepting the arguments as a dictionary to accepting them as
- keyword arguments. (eg you can do new(GtkWindow, title="title",
- allow_shrink=FALSE)). On a side note, the GTK_IS_*() functions
- have been removed from gtkmodule and added in gtk_*_get_type()
- functions. You can get the functionality of the removed functions
- with something like GTK_CHECK_TYPE(obj, gtk_*_get_type()).
-
-pygtk-0.4.5: 5-August-1998
- - This may be the last gtk v1.0 release of pygtk. If you have anymore
- nagging bugs, tell me now, or they won't be fixed in a version that
- can compile for gtk v1.0 (I will be moving to gtk v1.1)
- - Fixed some small bugs which I got bug reports about, but forgot to
- patch (in draw_polygon, GtkDrawingArea.draw_polygon and load_fontset)
- Also added the font argument to draw_string,draw_text. This was
- what was causing those problems.
- - Now gtk_set_locale is called when Gtkinter is loaded. This will
- make pygtk more useful for languages with non-latin character sets
- (eg Japanese).
- - Fixed up new_gc, so that if you don't pass it any arguments, it
- doesn't cause your program to segfault.
- - Made GtkObject.connect and GtkObject.connect_after var arg functions.
- Any extra arguments passed will be added to the argument list for
- the signal handler.
- - Added some attributes to the GdkFont object. You can now access
- the ascent and descent attributes, and call the width and measure
- methods, which both take a string as an argument.
-
-pygtk-0.4.4: 17-June-1998
- - Updated for gtk+-1.0.4, although it will work with gtk+-1.0.2 (No
- new features were added between these releases).
- - Fixed the date on the last changelog entry :(
- - Added the file description.py. It contains a breif description
- of some of the objects used in Gtkinter, such as GtkStyle's,
- GdkColors, GdkGC's and so on. It is structured as a python module,
- but is not intended to be imported. It can be used as a small
- reference.
- - Added variable GtkCList.selection, and method
- GtkCList.get_selection_info. These should help using clists, and
- help trap double clicks in a clist, since you can now do something
- like this:
- row, col = clist.get_selection_info(event.x, event.y)
- in a signal handler (maybe button_press).
- - Changed the GdkWindow destroy function to call gdk_pixmap_unref, if
- the window was a pixmap. This gets rid of the annoying warning
- when you close scribble.py.
- - pointer types and unknown boxed types are now passed as Python
- C objects in signal handlers. This is so wrappers for add on
- widgets that use pointer arguments can write code to convert
- the pointers to a more usable format.
- - Changed the behaviour of the PyObject -> GtkArg routines so that
- that they use python's conversion routines. Now you can pass a
- class instance which has a __int__ method in place of an integer
- in those routines (it implicitly uses int(o) on the instance).
- - Added method GtkObject.emit, which acts like gtk_signal_emit. Now
- widget.show() and widget.emit('show') are equivalent (although the
- first is faster). Now you should be able to use rulers properly.
- The specification is GtkObject.emit(signal_name, arg1, ...). It
- returns whatever the signal handler was supposed to. The rulers
- example in the testgtk.py program has been fixed, and gives an
- example of the GtkObject.emit method.
- - Added test of statusbar in testgtk.py. (The code was submited by
- Andrew Kuchling <akuchlin@cnri.reston.va.us>)
- - Fixed hude memory leak in GdkEvent initialisation -- when adding
- items to a dictionary with PyDict_SetItemString, the third argument
- is INCREF'd. I was forgetting to DECREF it after finishing with
- it.
- - Added method GdkWindow.new_gc. It takes keyword arguments with
- names matching the fields of the structure GdkGCValues, defined
- in gdk/gdktypes.h. It creates a gc for that window with the
- given attributes. Also, the GdkGC type now has the same attributes
- as the GdkGCValues structure, and they can be read and set.
- - Added a wrapper for the GdkColormap type. It can be accessed as a
- sequence (eg len(cmap), a = cmap[42], print cmap[:10]). The
- sequence items are colours. Also, the GtkStyle and GdkWindow types
- now also have the attribute colormap, which can be used for accessing
- the colormap. Also, the GdkColor type now has the attributes red,
- green, blue and pixel.
- The colormap also has a single method -- GdkColormap.alloc. It can
- either be called with a string argument (a colour name), or three
- integers (RGB components). It does the same thing as the function
- color_alloc (in fact, color_alloc is now implemented using it).
-
-pygtk-0.4.3: 7-May-1998
- - Updated for gtk+-1.0.1. This version of pygtk will not work with
- earlier versions. (You should upgrade anyway, since this version
- plugs some security holes and memory leaks).
- - Updated the GdkImlib module to take advntage of new features found
- in Imlib 1.3. You can now save images into just about any format.
- - Added the types GdkWindow and GdkGC. Also changed some of the
- functions like gtk_widget_shape_combine_mask to take their correct
- arguments. This will not break any code written with Gtkinter,
- as I have put in backward compatibility. However, if you used any
- of these functions in code that directly accessed the gtk module,
- you may have to recode some of your work.
- I have updated some of the testgtk.py examples. You will notice
- that the toolbar example loads quicker, since the test.xpm is only
- read off disk once.
- - Added the gdk_draw_* functions, and wrote wrappers for them as
- methods of the GtkDrawingArea class. See examples/simple/scribble.py
- for an example of using pixmaps and the drawing area.
-
-pygtk-0.4.2: 22-April-1998
- - Updated for gtk+-1.0.0. Since there have been no API changes
- between 0.99.10 and 1.0.0, it should work with that version as well.
- - Updated the configure script. It now uses the gtk-config script to
- work out the cflags and libraries for GTK. If gtk-config is not on
- the path, you can pass configure an argument something like
- --with-gtk-config=/subdir/gtk-config.
- - You can now specify the path name for the python executable (if it
- isn't on the path) with the --with-python=/subdir/python argument.
- - There is now a 'make install' option. It should work with both
- python 1.4 and 1.5.x. It defaults to installing scripts the
- $(prefix)/lib/site-python, with $(prefix)/lib/python$(version) as
- a backup, and shared modules in $(prefix)/lib/python$(version)
- /site-packages with $(prefix)/lib/python$(version)/lib-dynload and
- $(prefix)/lib/python$(version)/sharedmodules as backup locations.
- It also checks that the directory is in python's search path before
- making the choice.
- If you have installed previous versions of pygtk, it is probably a
- good idea to remove those files before running 'make install', as
- the locations chosen by this routine may be different from where
- you installed previous versions.
- - Changed the gtk_init function slightly, so it doesn't immediately
- call the gtk_*get_type functions, instead deferring this till the
- first call to gtk_object_new. This shouldn't affect anyone's
- programs, other than making loading slightly quicker.
- - Also added support for return types for signals (this only breaks
- compatibility if your handlers didn't return None or 0 or whatever).
- You should now be able to do things like returning TRUE from a
- delete_event signal handler to prevent a window being destroyed.
- - Added some functions for GtkCurve's and GtkPreview's that were
- previously missing.
- - Fixed some of the typemap stuff. GtkAspectFrame, GtkToolQuery and
- GtkCList.get_row_data now work properly. Also fixed a few similar
- problems in GdkImlib.
-
-pygtk-0.4.1: 6-April-1998
- - This archive is slightly smaller than the previous version, because
- I accidently included some unneeded files. (The package isn't
- missing anything that is required).
- - Updated for gtk+-0.99.9. Note that the previous version of pygtk
- works fine with 0.99.9, so this release is mainly new features.
- - There is now a mailing list for pygtk. To subscribe, send mail to
- pygtk-request@daa.com.au, with the word subscribe in the body.
- There is also a web site at http://www.daa.com.au/~james/pygtk/,
- although it isn't very interesting yet.
- - updated the examples/ide/gtkcons.py to take advantage of word
- wrapping in the text widget.
- - Added a function to export the Python types used in Gtkinter, so
- other python bindings (such as the imlib one) can use them.
- (It should be possible to do gnome bindings -- I will look at that
- in a little while).
- - Added support for gdk_imlib. Note that this does not change
- what libraries are required to build Gtkinter. If you don't
- have gdk_imlib, the configure script will notice, and decide not
- to build support for it. If you have gdk_imlib, and don't want to
- build it, you can pass configure the argument --without-imlib.
- - Added the directory examples/imlib, and a simple multi format
- image viewer called examples/imlib/view.py. This example requires
- the imlib bindings to have been built.
-
-pygtk-0.4.0: 23-Mar-1998
- - Updated for gtk+-0.99.8, so won't work with older versions (although
- your old pygtk programs will still work).
- - Added support quit handlers and input handlers.
- - Fixed a long standing bug in idle/timeout/quit function reactivation.
- Before, in order for an idle or timeout function to be reactivated,
- it needed to call idle_add or timeout_add again. Now they just have
- to return TRUE (like in C). This simplifies these functions
- substantially. The old behaviour still works.
- If you are using gtk+-0.99.7, you will find that timeout handlers
- don't work. This is caused by a bug in GTK, which was fixed in
- gtk+-0.99.8.
- - Found that GtkPixamp.__init__, GtkCList.set_pixtmap and GtkCList.
- set_pixtext all kept references to the pixmaps when they shouldn't.
- This is now fixed.
- - Added the module GtkExtra, which contains some convenience routines
- for writing pygtk programs. It includes an implementation of the
- menu factory (allows creation of arbitrary sized menus with about
- four function calls), and single function call interfaces for
- handling message boxes, file selection dialogs and input boxes.
- - Added the module GDK.py, that contains relevant constants from GDK.
- It is automatically imported by Gtkinter, so it is possible to do
- things like widget.set_events(GDK.ALL_EVENTS_MASK)
- - Added a crude integrated development environment (pyide.py) that
- pulls together the debugger, profiler, console and editor examples
- in the examples/ide directory.
- - Added a function colour_alloc (or color_alloc) that can be used to
- allocate new colours for use in the text widget and others.
- - Added the drag and drop functions (finally). Check the example in
- testgtk.py for the details.
- - Added GtkWidget.shape_combine_mask, which takes a pixmap as its first
- argument, and uses its mask as the shape mask.
- - Added the GtkCList.{set,get}_row_data functions.
-
-pygtk-0.3.0: 10-Mar-1998
- - Updated for gtk+-0.99.4. This means that it will not compile
- properly with previous versions. These incompatibilities are
- justified since according to the authors of gtk, gtk+-0.99.4 is
- very close to what 1.0.0 will look like.
- - Joined the reference counting revolution :) This doesn't affect
- anyone's programs, since reference counting (like type casting) is
- handled automatically by pygtk.
- - Check out the examples/ide directory. It contains a Gtkinter front
- end to the python debugger and profiler and also a graphical
- python console (which now works with different fonts and everything.
- - Added more of the functions I left out from previous versions. I
- still haven't fiddled round with dnd yet.
- - Fixed the gtk_object_get function (I had an '=' instead of a '==').
- You can now use Gtkinter objects as dictionaries. An example is
- >>> win = GtkWindow(WINDOW_TOPLEVEL)
- >>> # next line is equivalent to win['GtkWindow::title'] = 'a'
- >>> win.set_title("a")
- >>> win['GtkWindow::title']
- 'a'
- - Added the object data facility. You can use GtkObject.set_data,
- get_data and remove_data to manipulate it.
- - Added gtk_window_set_icon and gtk_window_set_icon_name. They are
- wrappers for the gdk counterparts. The functions are also exposed
- in Gtkinter as GtkWindow.set_icon[_name]. The set_icon function
- takes a GtkPixmap as its argumnet, extracts the GdkPixmap and mask
- from it and calls gtk_object_sink on the GtkPixmap, in case it never
- gets packed in another widget.
- - Similar wrappers are given for GtkCList.set_pixmap and
- GtkCList.set_pixtext. Once again, you pass a GtkPixmap instead of
- a GdkPixmap/GdkBitmap pair.
-
-pygtk-0.2.0: 12-Feb-1998
- - Fixed tooltips properly this time. Now you need to keep a reference
- to the GtkTooltips object for as long as you want to display those
- tips.
- - Added the example examples/testgtk/testgtk.py. This is a
- translation of the example with the same name that comes with the
- gtk distribution. The plus side of this is that I found and fixed
- many bits of pygtk that were either broken or missing. (eg.
- getting the selection of a list, connecting signals for a toolbar)
- - Added an example of using trees (examples/ide/browse.py). This one
- shows how you might set up a file manager where you only create
- as much of the tree as you are using.
- - Altered the signal handling behaviour so that the arguments to
- a signal handler are converted to their Gtkinter equivalents.
- - Pygtk should be complete enough for writing applications the size of
- ones you might use guile-gtk for, and as far as I know is the most
- complete out of the other python-gtk bindings I know of.
-
-pygtk-0.1.1: 4-Feb-1998
- - I accidentally broke tooltips in the previous version in such a way
- that you would get a seg fault when creating a GtkTooltips object.
- This has been fixed.
- - Added a new example called gtkcons.py. This is a simple interactive
- Python session in a GTK window. Currently it has some bugs, the
- most prominent being that the first character of output from a
- command remains hidden until the next command is executed. It
- also demonstrates GtkHandleBox's.
-
-pygtk-0.1.0: 2-Feb-1998
- - Changed the copyright to LGPL. (There is no point in making it
- more free, since this is the lisence on GTK itself).
- - Integrated some changes sent in by Neil Schemenauer
- <nascheme@acs.ucalgary.ca>. (Mainly spelling mistakes in
- Gtkinter.py, and a number of extra examples). The new examples
- are TAppli*.py and notebook.py.
- - Updated package for gtk+-0.99.3. (updates include addition of
- GtkCList, GtkCombo, GtkHandleBox, GtkStatusbar and GtkToolbar).
- - Updated the GTK.py, the constants module.
- - Updated the GtkStyle and GdkEvent types. You can now get the
- different colours of a style, and you can access the relevant
- information associated with a given type of GdkEvent. This means
- that you can now use signals that look at button clicks or key
- strokes.
- - Added support for GtkAcceleratorTable and GtkTooltips in
- Gtkinter.py. The types GdkColor, GdkEvent, GdkFont and GtkStyle
- don't have wrappers, but are clean enough to be used without any.
- - Added the GtkText.insert method. There is also a
- GtkText.insert_defaults that takes a single string argument.
-
-pygtk-0.0.2: 21-Jan-1998
- - Added file Gtkinter.py. This gives an object oriented
- interface to gtk accessable from Python. This is still not
- quite complete.
- - Added some example programs in the examples directory
- - Decided to release the code -- I wonder if anyone will use it?
-
-pygtk-0.0.1: (never released)
- - first release
- - contains basic functionality of gtk through use of SWIG
diff --git a/PKG-INFO.in b/PKG-INFO.in
deleted file mode 100644
index bda78b98..00000000
--- a/PKG-INFO.in
+++ /dev/null
@@ -1,25 +0,0 @@
-Metadata-Version: 1.0
-Name: PyGTK
-Version: @VERSION@
-Summary: Python bindings for GTK
-Home-page: http://www.pygtk.org/
-Author: James Henstridge
-Author-email: james@daa.com.au
-Maintainer: Johan Dahlin
-Maintainer-email: johan@gnome.org
-License: GNU LGPL
-Download-url: ftp://ftp.gnome.org/pub/GNOME/sources/pygtk/@PYGTK_MAJOR_VERSION@.@PYGTK_MINOR_VERSION@/pygtk-@VERSION@.tar.gz
-Description: PyGTK allows you to write full featured GTK programs in
- Python. It is targetted at GTK 2.x, and can be used in
- conjunction with gnome-python to write Gnome applications.
-Platform: POSIX, Windows
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: X11 Applications :: GTK
-Classifier: Environment :: Win32 (MS Windows)
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
-Classifier: Operating System :: POSIX
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Programming Language :: C
-Classifier: Programming Language :: Python
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
diff --git a/README b/README
deleted file mode 100644
index 5ab4890a..00000000
--- a/README
+++ /dev/null
@@ -1,129 +0,0 @@
-PyGTK
-=====
-Original author: James Henstridge <james@daa.com.au>
-Current maintainer: Johan Dahlin <johan@gnome.org>
-
-This archive contains modules that allow you to use gtk in Python
-programs. At present, it is a fairly complete set of bindings.
-Despite the low version number, this piece of software is quite
-useful, and is usable to write moderately complex programs. (see the
-examples directory for some examples of the simpler programs you could
-write).
-
-If you have any enhancements or bug reports, please file them in
-bugzilla at:
- http://bugzilla.gnome.org/enter_bug.cgi?product=pygtk
-
-If you have a patch, file the bug first and then use the "create new
-attachment" link on the bug's info page. My preferred format for
-patches is unified diff format (ie. diff -u). Please don't send me
-diffs which don't have any context, as these make it very difficult to
-see what the patch does.
-
-What's new in PyGTK 2.10
-========================
-
-See the wiki page for an overview of the features in PyGTK 2.10:
-
-http://live.gnome.org/PyGTK/WhatsNew210
-
-New Versions
-============
-
-New versions of this package can be found at:
- http://ftp.gnome.org/pub/GNOME/sources/pygtk/
-
-
-Mailing list
-============
-
-There is a mailing list for pygtk. You can subscribe to it through
-the web interface:
- http://www.daa.com.au/mailman/listinfo/pygtk
-
-
-Requirements
-============
- * C compiler (GCC and MSVC supported)
- * Python 2.3.5 or higher
- * PyGObject 2.12.1 or higher
- * Glib 2.8.0 or higher
- * GTK+ 2.8.0 or higher (optional) or
- GTK+ 2.10.0 or higher for 2.10 API
- * libglade 2.5.0 or higher (optional)
- * pycairo 0.5.0 or higher (optional)
- * Numeric (optional)
-
-This release is supporting the following GTK+ releases:
-
- 2.8.x
- 2.10.x
-
-To include support for the 2.10 API you'll need GTK+ 2.10.0 etc.
-
-Copyright Information
-=====================
-
-This software is covered by the GNU Lesser General Public Licence
-(version 2.1, or if you choose, a later version). Basically just don't
-say you wrote bits you didn't.
-
-Compilation
-===========
-
-PyGTK uses the standard autotools for the build infrastructure. To
-build, it should be as simple as running:
-
- $ ./configure --prefix=<prefix where python is installed>
- $ make
- $ make install
-
-If your Python interpreter isn't in the path, or is not called
-"python", you can set the PYTHON environment variable to the full path
-of the interpreter:
-
- $ PYTHON=/prefix/bin/python
- $ export PYTHON
-
-If configure can't find GTK+, you may need to set the PKG_CONFIG_PATH
-environment variable to help it find the libraries.
-
-The "make install" target will generate normal and optimised bytecode
-for all the .py files.
-
-Note. If you're installing to another prefix than the one where python
-is installed you'll need to set the PYTHONPATH variable to the
-$prefix/lib/pythonX.Y/site-packages directory created by
-the PyGTK installation.
-
-Upgrading from 0.6.x
-====================
-
-The API has changed a fair bit compared to the 0.6.x releases of pygtk
-in response to feedback from the mailing list. The main changes are:
- - no low level procedural interface. The extension now implements
- the object oriented API directly, rather than layering it on top
- of a procedural API.
- - class names have been shortened. Eg. instead of gtk.GtkWindow, we
- now have gtk.Window.
- - GDK classes and functions have been moved to the "gtk.gdk" module.
- - the GTK and GDK modules have been removed, with their constants
- being moved into the "gtk" and "gtk.gdk" modules.
-
-
-Tests
-=====
-
-After having compiled and installed pygtk, you may want to test them.
-There are a number of example programs available in the examples/
-subdirectory.
-
-
-Getting Help
-============
-
-If you have questions about programming with PyGTK, you might want to
-send a message to the mailing list (information on subscribing is
-above). Alternatively, your question may be answered in the FAQ:
-
- http://www.async.com.br/faq/pygtk/?req=index
diff --git a/THREADS b/THREADS
deleted file mode 100644
index f45b2b16..00000000
--- a/THREADS
+++ /dev/null
@@ -1,119 +0,0 @@
--*- mode: text; mode: auto-fill -*-
-
-Requirements to get threading to work with pygtk2
-=================================================
-
-Python side
------------
-* Python has a global interpreter lock, so no two threads can execute
- code at the same time.
-
-* In order to execute python code, you need to hold the interpreter
- lock, and have the correct PyThreadState object set
- (PyThreadState_Swap is used for this). As a convenience, the
- following functions can be used:
- void PyEval_AcquireThread(PyThreadState *tstate);
- void PyEval_ReleaseThread(PyThreadState *tstate);
-
-* When C functions are called from python, the global interpreter lock
- is held. If the function blocks, then no python code can execute in
- other threads during this time. Python provides two macros to allow
- threads to run while the function executes:
- Py_BEGIN_ALLOW_THREADS
- Py_END_ALLOW_THREADS
- between these two macro calls, the global interpreter lock is
- released, and the current thread state is set to NULL. This means
- that in order to execute python code, AcquireThread must be called.
-
-GLib side
----------
-* The glib main loop function blocks, so we need to allow threads so
- that other threads don't hang while in the event loop.
-
-* Destroy notifies and signal handlers may be called in response to
- some function call (such as GObject.set_data or GtkButton.clicked),
- or while the main loop is running. In the first case, the global
- interpreter lock will be held, and a thread state will be acquired.
- In the second case, the global interpreter lock will not be held by
- us and there will be a NULL thread state. Example:
----- Cut Here ----
- import gtk
- ...
- b = gtk.GtkButton("Click me")
- def f(button):
- ... some python code ...
- b.connect("clicked", f)
- b.clicked() # the signal handler f is called with the interpreter
- # lock held
- ...
- gtk.main() # if the button is clicked while in the main loop, the
- # interpreter lock may be held by someone else
----- Cut Here ----
-
-* We need to have a valid thread state before executing one of these
- callbacks, or bad things happen.
-
-* Ideally, the solution chosen should work at the GObject level,
- rather than GTK/GDK level.
-
-* In gtk 1.2 based PyGTK, we used a bit of code from Paul Fisher to
- handle this problem. It relied on the global GDK lock to serialise
- requests to unblock threading. As the GObject functions do not rely
- on a global lock being held, we can't use this. Here is the
- existing code:
----- Cut Here ----
-/* The threading code has been enhanced to be a little better with multiple
- * threads accessing GTK+. Here are some notes on the changes by
- * Paul Fisher:
- *
- * If threading is enabled, we create a recursive version of Python's
- * global interpreter mutex using TSD. This scheme makes it possible,
- * although rather hackish, for any thread to make a call into PyGTK,
- * as long as the GDK lock is held (that is, Python code is wrapped
- * around a threads_{enter,leave} pair).
- *
- * A viable alternative would be to wrap each and every GTK call, at
- * the Python/C level, with Py_{BEGIN,END}_ALLOW_THREADS. However,
- * given the nature of Python threading, this option is not
- * particularly appealing.
- */
-
-static GStaticPrivate pythreadstate_key = G_STATIC_PRIVATE_INIT;
-static GStaticPrivate counter_key = G_STATIC_PRIVATE_INIT;
-
-/* The global Python lock will be grabbed by Python when entering a
- * Python/C function; thus, the initial lock count will always be one.
- */
-# define INITIAL_LOCK_COUNT 1
-# define PyGTK_BLOCK_THREADS \
- { \
- gint counter = GPOINTER_TO_INT(g_static_private_get(&counter_key)); \
- if (counter == -INITIAL_LOCK_COUNT) { \
- PyThreadState *_save; \
- _save = g_static_private_get(&pythreadstate_key); \
- Py_BLOCK_THREADS; \
- } \
- counter++; \
- g_static_private_set(&counter_key, GINT_TO_POINTER(counter), NULL); \
- }
-
-# define PyGTK_UNBLOCK_THREADS \
- { \
- gint counter = GPOINTER_TO_INT(g_static_private_get(&counter_key)); \
- counter--; \
- if (counter == -INITIAL_LOCK_COUNT) { \
- PyThreadState *_save; \
- Py_UNBLOCK_THREADS; \
- g_static_private_set(&pythreadstate_key, _save, NULL); \
- } \
- g_static_private_set(&counter_key, GINT_TO_POINTER(counter), NULL); \
- }
----- Cut Here ----
-
-* One possible solution is to wrap every single pygtk call in
- Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS calls. This would
- probably be quite slow.
-
-* Can Paul Fisher's code be modified to work without needing the GDK
- lock for serialisation?
-
diff --git a/TODO b/TODO
deleted file mode 100644
index bc578301..00000000
--- a/TODO
+++ /dev/null
@@ -1,12 +0,0 @@
-This list is out of date. Query bugzilla.gnome.org for an up to date
-list.
-
-Things to do for the gtk 2.0 based release
-
-- fix up threading to work with GObject/GSignal/GClosure. See the
- THREADS file for more info on what is required.
-
-- Implement a new PyGtkTreeModel GObject type that can be the base for
- new tree models defined in Python. Need to look at how the
- GtkTreeIter->tree_node lifetime is handled, as it doesn't look like
- anything is called to let us know that that data should be unrefed.
diff --git a/atk-types.defs b/atk-types.defs
deleted file mode 100644
index becb6ed2..00000000
--- a/atk-types.defs
+++ /dev/null
@@ -1,403 +0,0 @@
-;; -*- scheme -*-
-; object definitions ...
-(define-object Hyperlink
- (in-module "Atk")
- (parent "GObject")
- (c-name "AtkHyperlink")
- (gtype-id "ATK_TYPE_HYPERLINK")
-)
-
-(define-object GObjectAccessible
- (in-module "Atk")
- (parent "AtkObject")
- (c-name "AtkGObjectAccessible")
- (gtype-id "ATK_TYPE_GOBJECT_ACCESSIBLE")
-)
-
-(define-object Object
- (in-module "Atk")
- (parent "GObject")
- (c-name "AtkObject")
- (gtype-id "ATK_TYPE_OBJECT")
-)
-
-(define-object NoOpObject
- (in-module "Atk")
- (parent "AtkObject")
- (c-name "AtkNoOpObject")
- (gtype-id "ATK_TYPE_NO_OP_OBJECT")
-)
-
-(define-object ObjectFactory
- (in-module "Atk")
- (parent "GObject")
- (c-name "AtkObjectFactory")
- (gtype-id "ATK_TYPE_OBJECT_FACTORY")
-)
-
-(define-object NoOpObjectFactory
- (in-module "Atk")
- (parent "AtkObjectFactory")
- (c-name "AtkNoOpObjectFactory")
- (gtype-id "ATK_TYPE_NO_OP_OBJECT_FACTORY")
-)
-
-(define-object Registry
- (in-module "Atk")
- (parent "GObject")
- (c-name "AtkRegistry")
- (gtype-id "ATK_TYPE_REGISTRY")
-)
-
-(define-object Relation
- (in-module "Atk")
- (parent "GObject")
- (c-name "AtkRelation")
- (gtype-id "ATK_TYPE_RELATION")
-)
-
-(define-object RelationSet
- (in-module "Atk")
- (parent "GObject")
- (c-name "AtkRelationSet")
- (gtype-id "ATK_TYPE_RELATION_SET")
-)
-
-(define-object StateSet
- (in-module "Atk")
- (parent "GObject")
- (c-name "AtkStateSet")
- (gtype-id "ATK_TYPE_STATE_SET")
-)
-
-(define-object Util
- (in-module "Atk")
- (parent "GObject")
- (c-name "AtkUtil")
- (gtype-id "ATK_TYPE_UTIL")
-)
-
-(define-interface Action
- (in-module "Atk")
- (c-name "AtkAction")
- (gtype-id "ATK_TYPE_ACTION")
-)
-
-(define-interface Component
- (in-module "Atk")
- (c-name "AtkComponent")
- (gtype-id "ATK_TYPE_COMPONENT")
-)
-
-(define-interface Document
- (in-module "Atk")
- (c-name "AtkDocument")
- (gtype-id "ATK_TYPE_DOCUMENT")
-)
-
-(define-interface EditableText
- (in-module "Atk")
- (c-name "AtkEditableText")
- (gtype-id "ATK_TYPE_EDITABLE_TEXT")
-)
-
-(define-interface Hypertext
- (in-module "Atk")
- (c-name "AtkHypertext")
- (gtype-id "ATK_TYPE_HYPERTEXT")
-)
-
-(define-interface Image
- (in-module "Atk")
- (c-name "AtkImage")
- (gtype-id "ATK_TYPE_IMAGE")
-)
-
-(define-interface ImplementorIface
- (in-module "Atk")
- (c-name "AtkImplementorIface")
- (gtype-id "ATK_TYPE_IMPLEMENTOR")
-)
-
-(define-interface Selection
- (in-module "Atk")
- (c-name "AtkSelection")
- (gtype-id "ATK_TYPE_SELECTION")
-)
-
-(define-interface StreamableContent
- (in-module "Atk")
- (c-name "AtkStreamableContent")
- (gtype-id "ATK_TYPE_STREAMABLE_CONTENT")
-)
-
-(define-interface Table
- (in-module "Atk")
- (c-name "AtkTable")
- (gtype-id "ATK_TYPE_TABLE")
-)
-
-(define-interface Text
- (in-module "Atk")
- (c-name "AtkText")
- (gtype-id "ATK_TYPE_TEXT")
-)
-
-(define-interface Value
- (in-module "Atk")
- (c-name "AtkValue")
- (gtype-id "ATK_TYPE_VALUE")
-)
-
-(define-boxed Rectangle
- (in-module "Atk")
- (c-name "AtkRectangle")
- (gtype-id "ATK_TYPE_RECTANGLE")
- (fields
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-;; Enumerations and flags ...
-
-(define-enum Role
- (in-module "Atk")
- (c-name "AtkRole")
- (gtype-id "ATK_TYPE_ROLE")
- (values
- '("invalid" "ATK_ROLE_INVALID")
- '("accel-label" "ATK_ROLE_ACCEL_LABEL")
- '("alert" "ATK_ROLE_ALERT")
- '("animation" "ATK_ROLE_ANIMATION")
- '("arrow" "ATK_ROLE_ARROW")
- '("calendar" "ATK_ROLE_CALENDAR")
- '("canvas" "ATK_ROLE_CANVAS")
- '("check-box" "ATK_ROLE_CHECK_BOX")
- '("check-menu-item" "ATK_ROLE_CHECK_MENU_ITEM")
- '("color-chooser" "ATK_ROLE_COLOR_CHOOSER")
- '("column-header" "ATK_ROLE_COLUMN_HEADER")
- '("combo-box" "ATK_ROLE_COMBO_BOX")
- '("date-editor" "ATK_ROLE_DATE_EDITOR")
- '("desktop-icon" "ATK_ROLE_DESKTOP_ICON")
- '("desktop-frame" "ATK_ROLE_DESKTOP_FRAME")
- '("dial" "ATK_ROLE_DIAL")
- '("dialog" "ATK_ROLE_DIALOG")
- '("directory-pane" "ATK_ROLE_DIRECTORY_PANE")
- '("drawing-area" "ATK_ROLE_DRAWING_AREA")
- '("file-chooser" "ATK_ROLE_FILE_CHOOSER")
- '("filler" "ATK_ROLE_FILLER")
- '("font-chooser" "ATK_ROLE_FONT_CHOOSER")
- '("frame" "ATK_ROLE_FRAME")
- '("glass-pane" "ATK_ROLE_GLASS_PANE")
- '("html-container" "ATK_ROLE_HTML_CONTAINER")
- '("icon" "ATK_ROLE_ICON")
- '("image" "ATK_ROLE_IMAGE")
- '("internal-frame" "ATK_ROLE_INTERNAL_FRAME")
- '("label" "ATK_ROLE_LABEL")
- '("layered-pane" "ATK_ROLE_LAYERED_PANE")
- '("list" "ATK_ROLE_LIST")
- '("list-item" "ATK_ROLE_LIST_ITEM")
- '("menu" "ATK_ROLE_MENU")
- '("menu-bar" "ATK_ROLE_MENU_BAR")
- '("menu-item" "ATK_ROLE_MENU_ITEM")
- '("option-pane" "ATK_ROLE_OPTION_PANE")
- '("page-tab" "ATK_ROLE_PAGE_TAB")
- '("page-tab-list" "ATK_ROLE_PAGE_TAB_LIST")
- '("panel" "ATK_ROLE_PANEL")
- '("password-text" "ATK_ROLE_PASSWORD_TEXT")
- '("popup-menu" "ATK_ROLE_POPUP_MENU")
- '("progress-bar" "ATK_ROLE_PROGRESS_BAR")
- '("push-button" "ATK_ROLE_PUSH_BUTTON")
- '("radio-button" "ATK_ROLE_RADIO_BUTTON")
- '("radio-menu-item" "ATK_ROLE_RADIO_MENU_ITEM")
- '("root-pane" "ATK_ROLE_ROOT_PANE")
- '("row-header" "ATK_ROLE_ROW_HEADER")
- '("scroll-bar" "ATK_ROLE_SCROLL_BAR")
- '("scroll-pane" "ATK_ROLE_SCROLL_PANE")
- '("separator" "ATK_ROLE_SEPARATOR")
- '("slider" "ATK_ROLE_SLIDER")
- '("split-pane" "ATK_ROLE_SPLIT_PANE")
- '("spin-button" "ATK_ROLE_SPIN_BUTTON")
- '("statusbar" "ATK_ROLE_STATUSBAR")
- '("table" "ATK_ROLE_TABLE")
- '("table-cell" "ATK_ROLE_TABLE_CELL")
- '("table-column-header" "ATK_ROLE_TABLE_COLUMN_HEADER")
- '("table-row-header" "ATK_ROLE_TABLE_ROW_HEADER")
- '("tear-off-menu-item" "ATK_ROLE_TEAR_OFF_MENU_ITEM")
- '("terminal" "ATK_ROLE_TERMINAL")
- '("text" "ATK_ROLE_TEXT")
- '("toggle-button" "ATK_ROLE_TOGGLE_BUTTON")
- '("tool-bar" "ATK_ROLE_TOOL_BAR")
- '("tool-tip" "ATK_ROLE_TOOL_TIP")
- '("tree" "ATK_ROLE_TREE")
- '("tree-table" "ATK_ROLE_TREE_TABLE")
- '("unknown" "ATK_ROLE_UNKNOWN")
- '("viewport" "ATK_ROLE_VIEWPORT")
- '("window" "ATK_ROLE_WINDOW")
- '("last-defined" "ATK_ROLE_LAST_DEFINED")
- )
-)
-
-(define-enum Layer
- (in-module "Atk")
- (c-name "AtkLayer")
- (gtype-id "ATK_TYPE_LAYER")
- (values
- '("invalid" "ATK_LAYER_INVALID")
- '("background" "ATK_LAYER_BACKGROUND")
- '("canvas" "ATK_LAYER_CANVAS")
- '("widget" "ATK_LAYER_WIDGET")
- '("mdi" "ATK_LAYER_MDI")
- '("popup" "ATK_LAYER_POPUP")
- '("overlay" "ATK_LAYER_OVERLAY")
- )
-)
-
-(define-enum RelationType
- (in-module "Atk")
- (c-name "AtkRelationType")
- (gtype-id "ATK_TYPE_RELATION_TYPE")
- (values
- '("null" "ATK_RELATION_NULL")
- '("controlled-by" "ATK_RELATION_CONTROLLED_BY")
- '("controller-for" "ATK_RELATION_CONTROLLER_FOR")
- '("label-for" "ATK_RELATION_LABEL_FOR")
- '("labelled-by" "ATK_RELATION_LABELLED_BY")
- '("member-of" "ATK_RELATION_MEMBER_OF")
- '("node-child-of" "ATK_RELATION_NODE_CHILD_OF")
- '("last-defined" "ATK_RELATION_LAST_DEFINED")
- )
-)
-
-(define-enum StateType
- (in-module "Atk")
- (c-name "AtkStateType")
- (gtype-id "ATK_TYPE_STATE_TYPE")
- (values
- '("invalid" "ATK_STATE_INVALID")
- '("active" "ATK_STATE_ACTIVE")
- '("armed" "ATK_STATE_ARMED")
- '("busy" "ATK_STATE_BUSY")
- '("checked" "ATK_STATE_CHECKED")
- '("defunct" "ATK_STATE_DEFUNCT")
- '("editable" "ATK_STATE_EDITABLE")
- '("enabled" "ATK_STATE_ENABLED")
- '("expandable" "ATK_STATE_EXPANDABLE")
- '("expanded" "ATK_STATE_EXPANDED")
- '("focusable" "ATK_STATE_FOCUSABLE")
- '("focused" "ATK_STATE_FOCUSED")
- '("horizontal" "ATK_STATE_HORIZONTAL")
- '("iconified" "ATK_STATE_ICONIFIED")
- '("modal" "ATK_STATE_MODAL")
- '("multi-line" "ATK_STATE_MULTI_LINE")
- '("multiselectable" "ATK_STATE_MULTISELECTABLE")
- '("opaque" "ATK_STATE_OPAQUE")
- '("pressed" "ATK_STATE_PRESSED")
- '("resizable" "ATK_STATE_RESIZABLE")
- '("selectable" "ATK_STATE_SELECTABLE")
- '("selected" "ATK_STATE_SELECTED")
- '("sensitive" "ATK_STATE_SENSITIVE")
- '("showing" "ATK_STATE_SHOWING")
- '("single-line" "ATK_STATE_SINGLE_LINE")
- '("stale" "ATK_STATE_STALE")
- '("transient" "ATK_STATE_TRANSIENT")
- '("vertical" "ATK_STATE_VERTICAL")
- '("visible" "ATK_STATE_VISIBLE")
- '("last-defined" "ATK_STATE_LAST_DEFINED")
- )
-)
-
-(define-enum TextAttribute
- (in-module "Atk")
- (c-name "AtkTextAttribute")
- (gtype-id "ATK_TYPE_TEXT_ATTRIBUTE")
- (values
- '("left-margin" "ATK_TEXT_ATTR_LEFT_MARGIN")
- '("right-margin" "ATK_TEXT_ATTR_RIGHT_MARGIN")
- '("indent" "ATK_TEXT_ATTR_INDENT")
- '("invisible" "ATK_TEXT_ATTR_INVISIBLE")
- '("editable" "ATK_TEXT_ATTR_EDITABLE")
- '("pixels-above-lines" "ATK_TEXT_ATTR_PIXELS_ABOVE_LINES")
- '("pixels-below-lines" "ATK_TEXT_ATTR_PIXELS_BELOW_LINES")
- '("pixels-inside-wrap" "ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP")
- '("bg-full-height" "ATK_TEXT_ATTR_BG_FULL_HEIGHT")
- '("rise" "ATK_TEXT_ATTR_RISE")
- '("underline" "ATK_TEXT_ATTR_UNDERLINE")
- '("strikethrough" "ATK_TEXT_ATTR_STRIKETHROUGH")
- '("size" "ATK_TEXT_ATTR_SIZE")
- '("scale" "ATK_TEXT_ATTR_SCALE")
- '("weight" "ATK_TEXT_ATTR_WEIGHT")
- '("language" "ATK_TEXT_ATTR_LANGUAGE")
- '("family-name" "ATK_TEXT_ATTR_FAMILY_NAME")
- '("bg-color" "ATK_TEXT_ATTR_BG_COLOR")
- '("fg-color" "ATK_TEXT_ATTR_FG_COLOR")
- '("bg-stipple" "ATK_TEXT_ATTR_BG_STIPPLE")
- '("fg-stipple" "ATK_TEXT_ATTR_FG_STIPPLE")
- '("wrap-mode" "ATK_TEXT_ATTR_WRAP_MODE")
- '("direction" "ATK_TEXT_ATTR_DIRECTION")
- '("justification" "ATK_TEXT_ATTR_JUSTIFICATION")
- '("stretch" "ATK_TEXT_ATTR_STRETCH")
- '("variant" "ATK_TEXT_ATTR_VARIANT")
- '("style" "ATK_TEXT_ATTR_STYLE")
- )
-)
-
-(define-enum TextBoundary
- (in-module "Atk")
- (c-name "AtkTextBoundary")
- (gtype-id "ATK_TYPE_TEXT_BOUNDARY")
- (values
- '("char" "ATK_TEXT_BOUNDARY_CHAR")
- '("word-start" "ATK_TEXT_BOUNDARY_WORD_START")
- '("word-end" "ATK_TEXT_BOUNDARY_WORD_END")
- '("sentence-start" "ATK_TEXT_BOUNDARY_SENTENCE_START")
- '("sentence-end" "ATK_TEXT_BOUNDARY_SENTENCE_END")
- '("line-start" "ATK_TEXT_BOUNDARY_LINE_START")
- '("line-end" "ATK_TEXT_BOUNDARY_LINE_END")
- )
-)
-
-(define-enum KeyEventType
- (in-module "Atk")
- (c-name "AtkKeyEventType")
- (gtype-id "ATK_TYPE_KEY_EVENT_TYPE")
- (values
- '("press" "ATK_KEY_EVENT_PRESS")
- '("release" "ATK_KEY_EVENT_RELEASE")
- '("last-defined" "ATK_KEY_EVENT_LAST_DEFINED")
- )
-)
-
-(define-enum CoordType
- (in-module "Atk")
- (c-name "AtkCoordType")
- (gtype-id "ATK_TYPE_COORD_TYPE")
- (values
- '("screen" "ATK_XY_SCREEN")
- '("window" "ATK_XY_WINDOW")
- )
-)
-(define-flags HyperlinkStateFlags
- (in-module "Atk")
- (c-name "AtkHyperlinkStateFlags")
- (gtype-id "ATK_TYPE_HYPERLINK_STATE_FLAGS")
- (values
- '("e" "ATK_HYPERLINK_IS_INLINE")
- )
-)
-
-(define-enum TextClipType
- (in-module "Atk")
- (c-name "AtkTextClipType")
- (gtype-id "ATK_TYPE_TEXT_CLIP_TYPE")
- (values
- '("none" "ATK_TEXT_CLIP_NONE")
- '("min" "ATK_TEXT_CLIP_MIN")
- '("max" "ATK_TEXT_CLIP_MAX")
- '("both" "ATK_TEXT_CLIP_BOTH")
- )
-)
-
diff --git a/atk.defs b/atk.defs
deleted file mode 100644
index 191b0f6d..00000000
--- a/atk.defs
+++ /dev/null
@@ -1,3018 +0,0 @@
-;; -*- scheme -*-
-
-(include "atk-types.defs")
-
-;; From atk-enum-types.h
-
-(define-function hyperlink_state_flags_get_type
- (c-name "atk_hyperlink_state_flags_get_type")
- (return-type "GType")
-)
-
-(define-function role_get_type
- (c-name "atk_role_get_type")
- (return-type "GType")
-)
-
-(define-function layer_get_type
- (c-name "atk_layer_get_type")
- (return-type "GType")
-)
-
-(define-function relation_type_get_type
- (c-name "atk_relation_type_get_type")
- (return-type "GType")
-)
-
-(define-function state_type_get_type
- (c-name "atk_state_type_get_type")
- (return-type "GType")
-)
-
-(define-function text_attribute_get_type
- (c-name "atk_text_attribute_get_type")
- (return-type "GType")
-)
-
-(define-function text_boundary_get_type
- (c-name "atk_text_boundary_get_type")
- (return-type "GType")
-)
-
-(define-function text_clip_type_get_type
- (c-name "atk_text_clip_type_get_type")
- (return-type "GType")
-)
-
-(define-function key_event_type_get_type
- (c-name "atk_key_event_type_get_type")
- (return-type "GType")
-)
-
-(define-function coord_type_get_type
- (c-name "atk_coord_type_get_type")
- (return-type "GType")
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkaction.h
-
-(define-function atk_action_get_type
- (c-name "atk_action_get_type")
- (return-type "GType")
- (parameters
- )
-)
-
-(define-method do_action
- (of-object "AtkAction")
- (c-name "atk_action_do_action")
- (return-type "gboolean")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method get_n_actions
- (of-object "AtkAction")
- (c-name "atk_action_get_n_actions")
- (return-type "gint")
-)
-
-(define-method get_description
- (of-object "AtkAction")
- (c-name "atk_action_get_description")
- (return-type "const-gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method get_name
- (of-object "AtkAction")
- (c-name "atk_action_get_name")
- (return-type "const-gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method get_keybinding
- (of-object "AtkAction")
- (c-name "atk_action_get_keybinding")
- (return-type "const-gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method set_description
- (of-object "AtkAction")
- (c-name "atk_action_set_description")
- (return-type "gboolean")
- (parameters
- '("gint" "i")
- '("const-gchar*" "desc")
- )
-)
-
-(define-method get_localized_name
- (of-object "AtkAction")
- (c-name "atk_action_get_localized_name")
- (return-type "const-gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual do_action
- (of-object "AtkAction")
- (return-type "gboolean")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual get_n_actions
- (of-object "AtkAction")
- (return-type "gint")
-)
-
-(define-virtual get_description
- (of-object "AtkAction")
- (return-type "const-gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual get_name
- (of-object "AtkAction")
- (return-type "const-gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual get_keybinding
- (of-object "AtkAction")
- (return-type "const-gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual set_description
- (of-object "AtkAction")
- (return-type "gboolean")
- (parameters
- '("gint" "i")
- '("const-gchar*" "desc")
- )
-)
-
-(define-virtual get_localized_name
- (of-object "AtkAction")
- (return-type "const-gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkcomponent.h
-
-(define-function atk_component_get_type
- (c-name "atk_component_get_type")
- (return-type "GType")
- (parameters
- )
-)
-
-(define-method add_focus_handler
- (of-object "AtkComponent")
- (c-name "atk_component_add_focus_handler")
- (return-type "guint")
- (parameters
- '("AtkFocusHandler" "handler")
- )
-)
-
-(define-method contains
- (of-object "AtkComponent")
- (c-name "atk_component_contains")
- (return-type "gboolean")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-method ref_accessible_at_point
- (of-object "AtkComponent")
- (c-name "atk_component_ref_accessible_at_point")
- (return-type "AtkObject*")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-method get_extents
- (of-object "AtkComponent")
- (c-name "atk_component_get_extents")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- '("gint*" "width")
- '("gint*" "height")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-method get_position
- (of-object "AtkComponent")
- (c-name "atk_component_get_position")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-method get_size
- (of-object "AtkComponent")
- (c-name "atk_component_get_size")
- (return-type "none")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-method grab_focus
- (of-object "AtkComponent")
- (c-name "atk_component_grab_focus")
- (return-type "gboolean")
-)
-
-(define-method remove_focus_handler
- (of-object "AtkComponent")
- (c-name "atk_component_remove_focus_handler")
- (return-type "none")
- (parameters
- '("guint" "handler_id")
- )
-)
-
-(define-method set_extents
- (of-object "AtkComponent")
- (c-name "atk_component_set_extents")
- (return-type "gboolean")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-method set_position
- (of-object "AtkComponent")
- (c-name "atk_component_set_position")
- (return-type "gboolean")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-method set_size
- (of-object "AtkComponent")
- (c-name "atk_component_set_size")
- (return-type "gboolean")
- (parameters
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-function rectangle_get_type
- (c-name "atk_rectangle_get_type")
- (return-type "GType")
-)
-
-(define-method get_layer
- (of-object "AtkComponent")
- (c-name "atk_component_get_layer")
- (return-type "AtkLayer")
-)
-
-(define-method get_mdi_zorder
- (of-object "AtkComponent")
- (c-name "atk_component_get_mdi_zorder")
- (return-type "gint")
-)
-
-(define-virtual add_focus_handler
- (of-object "AtkComponent")
- (return-type "guint")
- (parameters
- '("AtkFocusHandler" "handler")
- )
-)
-
-(define-virtual contains
- (of-object "AtkComponent")
- (return-type "gboolean")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-virtual ref_accessible_at_point
- (of-object "AtkComponent")
- (return-type "AtkObject*")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-virtual get_extents
- (of-object "AtkComponent")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- '("gint*" "width")
- '("gint*" "height")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-virtual get_position
- (of-object "AtkComponent")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-virtual get_size
- (of-object "AtkComponent")
- (return-type "none")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-virtual grab_focus
- (of-object "AtkComponent")
- (return-type "gboolean")
-)
-
-(define-virtual remove_focus_handler
- (of-object "AtkComponent")
- (return-type "none")
- (parameters
- '("guint" "handler_id")
- )
-)
-
-(define-virtual set_extents
- (of-object "AtkComponent")
- (return-type "gboolean")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-virtual set_position
- (of-object "AtkComponent")
- (return-type "gboolean")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-virtual set_size
- (of-object "AtkComponent")
- (return-type "gboolean")
- (parameters
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-virtual get_layer
- (of-object "AtkComponent")
- (return-type "AtkLayer")
-)
-
-(define-virtual get_mdi_zorder
- (of-object "AtkComponent")
- (return-type "gint")
-)
-
-(define-virtual bounds_changed
- (of-object "AtkComponent")
- (return-type "none")
- (parameters
- '("AtkRectangle*" "bounds")
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkdocument.h
-
-(define-function atk_document_get_type
- (c-name "atk_document_get_type")
- (return-type "GType")
-)
-
-(define-method get_document_type
- (of-object "AtkDocument")
- (c-name "atk_document_get_document_type")
- (return-type "const-gchar*")
-)
-
-(define-method get_document
- (of-object "AtkDocument")
- (c-name "atk_document_get_document")
- (return-type "gpointer")
-)
-
-(define-virtual get_document_type
- (of-object "AtkDocument")
- (return-type "const-gchar*")
-)
-
-(define-virtual get_document
- (of-object "AtkDocument")
- (return-type "gpointer")
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkeditabletext.h
-
-(define-function atk_editable_text_get_type
- (c-name "atk_editable_text_get_type")
- (return-type "GType")
-)
-
-(define-method set_run_attributes
- (of-object "AtkEditableText")
- (c-name "atk_editable_text_set_run_attributes")
- (return-type "gboolean")
- (parameters
- '("AtkAttributeSet*" "attrib_set")
- '("gint" "start_offset")
- '("gint" "end_offset")
- )
-)
-
-(define-method set_text_contents
- (of-object "AtkEditableText")
- (c-name "atk_editable_text_set_text_contents")
- (return-type "none")
- (parameters
- '("const-gchar*" "string")
- )
-)
-
-(define-method insert_text
- (of-object "AtkEditableText")
- (c-name "atk_editable_text_insert_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "string")
- '("gint" "length")
- '("gint*" "position")
- )
-)
-
-(define-method copy_text
- (of-object "AtkEditableText")
- (c-name "atk_editable_text_copy_text")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-
-(define-method cut_text
- (of-object "AtkEditableText")
- (c-name "atk_editable_text_cut_text")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-
-(define-method delete_text
- (of-object "AtkEditableText")
- (c-name "atk_editable_text_delete_text")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-
-(define-method paste_text
- (of-object "AtkEditableText")
- (c-name "atk_editable_text_paste_text")
- (return-type "none")
- (parameters
- '("gint" "position")
- )
-)
-
-(define-virtual set_run_attributes
- (of-object "AtkEditableText")
- (return-type "gboolean")
- (parameters
- '("AtkAttributeSet*" "attrib_set")
- '("gint" "start_offset")
- '("gint" "end_offset")
- )
-)
-
-(define-virtual set_text_contents
- (of-object "AtkEditableText")
- (return-type "none")
- (parameters
- '("const-gchar*" "string")
- )
-)
-
-(define-virtual insert_text
- (of-object "AtkEditableText")
- (return-type "none")
- (parameters
- '("const-gchar*" "string")
- '("gint" "length")
- '("gint*" "position")
- )
-)
-
-(define-virtual copy_text
- (of-object "AtkEditableText")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-
-(define-virtual cut_text
- (of-object "AtkEditableText")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-
-(define-virtual delete_text
- (of-object "AtkEditableText")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-
-(define-virtual paste_text
- (of-object "AtkEditableText")
- (return-type "none")
- (parameters
- '("gint" "position")
- )
-)
-
-
-
-;; From atkgobjectaccessible.h
-
-(define-function gobject_accessible_get_type
- (c-name "atk_gobject_accessible_get_type")
- (return-type "GType")
-)
-
-(define-function gobject_accessible_for_object
- (c-name "atk_gobject_accessible_for_object")
- (return-type "AtkObject*")
- (parameters
- '("GObject*" "obj")
- )
-)
-
-(define-method get_object
- (of-object "AtkGObjectAccessible")
- (c-name "atk_gobject_accessible_get_object")
- (return-type "GObject*")
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atk.h
-
-
-
-;; From /usr/include/atk-1.0/atk/atkhyperlink.h
-
-(define-function atk_hyperlink_get_type
- (c-name "atk_hyperlink_get_type")
- (return-type "GType")
-)
-
-(define-method get_uri
- (of-object "AtkHyperlink")
- (c-name "atk_hyperlink_get_uri")
- (return-type "gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method get_object
- (of-object "AtkHyperlink")
- (c-name "atk_hyperlink_get_object")
- (return-type "AtkObject*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method get_end_index
- (of-object "AtkHyperlink")
- (c-name "atk_hyperlink_get_end_index")
- (return-type "gint")
-)
-
-(define-method get_start_index
- (of-object "AtkHyperlink")
- (c-name "atk_hyperlink_get_start_index")
- (return-type "gint")
-)
-
-(define-method is_valid
- (of-object "AtkHyperlink")
- (c-name "atk_hyperlink_is_valid")
- (return-type "gboolean")
-)
-
-(define-method get_n_anchors
- (of-object "AtkHyperlink")
- (c-name "atk_hyperlink_get_n_anchors")
- (return-type "gint")
-)
-
-(define-method is_inline
- (of-object "AtkHyperlink")
- (c-name "atk_hyperlink_is_inline")
- (return-type "gboolean")
-)
-
-(define-method is_selected_link
- (of-object "AtkHyperlink")
- (c-name "atk_hyperlink_is_selected_link")
- (return-type "gboolean")
-)
-
-(define-virtual get_uri
- (of-object "AtkHyperlink")
- (return-type "gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual get_object
- (of-object "AtkHyperlink")
- (return-type "AtkObject*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual get_end_index
- (of-object "AtkHyperlink")
- (return-type "gint")
-)
-
-(define-virtual get_start_index
- (of-object "AtkHyperlink")
- (return-type "gint")
-)
-
-(define-virtual is_valid
- (of-object "AtkHyperlink")
- (return-type "gboolean")
-)
-
-(define-virtual get_n_anchors
- (of-object "AtkHyperlink")
- (return-type "gint")
-)
-
-(define-virtual link_state
- (of-object "AtkHyperlink")
- (return-type "guint")
-)
-
-(define-virtual is_selected_link
- (of-object "AtkHyperlink")
- (return-type "gboolean")
-)
-
-(define-virtual link_activated
- (of-object "AtkHyperlink")
- (return-type "none")
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkhypertext.h
-
-(define-function atk_hypertext_get_type
- (c-name "atk_hypertext_get_type")
- (return-type "GType")
-)
-
-(define-method get_link
- (of-object "AtkHypertext")
- (c-name "atk_hypertext_get_link")
- (return-type "AtkHyperlink*")
- (parameters
- '("gint" "link_index")
- )
-)
-
-(define-method get_n_links
- (of-object "AtkHypertext")
- (c-name "atk_hypertext_get_n_links")
- (return-type "gint")
-)
-
-(define-method get_link_index
- (of-object "AtkHypertext")
- (c-name "atk_hypertext_get_link_index")
- (return-type "gint")
- (parameters
- '("gint" "char_index")
- )
-)
-
-(define-virtual get_link
- (of-object "AtkHypertext")
- (return-type "AtkHyperlink*")
- (parameters
- '("gint" "link_index")
- )
-)
-
-(define-virtual get_n_links
- (of-object "AtkHypertext")
- (return-type "gint")
-)
-
-(define-virtual get_link_index
- (of-object "AtkHypertext")
- (return-type "gint")
- (parameters
- '("gint" "char_index")
- )
-)
-
-(define-virtual link_selected
- (of-object "AtkHypertext")
- (return-type "none")
- (parameters
- '("gint" "link_index")
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkimage.h
-
-(define-function atk_image_get_type
- (c-name "atk_image_get_type")
- (return-type "GType")
-)
-
-(define-method get_image_description
- (of-object "AtkImage")
- (c-name "atk_image_get_image_description")
- (return-type "const-gchar*")
-)
-
-(define-method get_image_size
- (of-object "AtkImage")
- (c-name "atk_image_get_image_size")
- (return-type "none")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-method set_image_description
- (of-object "AtkImage")
- (c-name "atk_image_set_image_description")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "description")
- )
-)
-
-(define-method get_image_position
- (of-object "AtkImage")
- (c-name "atk_image_get_image_position")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-virtual get_image_position
- (of-object "AtkImage")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- '("AtkCoordType" "coord_type")
- )
-)
-
-(define-virtual get_image_description
- (of-object "AtkImage")
- (return-type "const-gchar*")
-)
-
-(define-virtual get_image_size
- (of-object "AtkImage")
- (return-type "none")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-virtual set_image_description
- (of-object "AtkImage")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "description")
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atknoopobjectfactory.h
-
-(define-function atk_no_op_object_factory_get_type
- (c-name "atk_no_op_object_factory_get_type")
- (return-type "GType")
- (parameters
- )
-)
-
-(define-function atk_no_op_object_factory_new
- (c-name "atk_no_op_object_factory_new")
- (return-type "AtkObjectFactory*")
- (is-constructor-of AtkNoOpObjectFactory)
- (parameters
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atknoopobject.h
-
-(define-function atk_no_op_object_get_type
- (c-name "atk_no_op_object_get_type")
- (return-type "GType")
-)
-
-(define-function atk_no_op_object_new
- (c-name "atk_no_op_object_new")
- (return-type "AtkNoOpObject*")
- (is-constructor-of AtkNoOpObject)
- (parameters
- '("GObject*" "obj")
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkobjectfactory.h
-
-(define-function atk_object_factory_get_type
- (c-name "atk_object_factory_get_type")
- (return-type "GType")
- (parameters
- )
-)
-
-(define-method create_accessible
- (of-object "AtkObjectFactory")
- (c-name "atk_object_factory_create_accessible")
- (return-type "AtkObject*")
- (parameters
- '("GObject*" "obj")
- )
-)
-
-(define-method invalidate
- (of-object "AtkObjectFactory")
- (c-name "atk_object_factory_invalidate")
- (return-type "none")
-)
-
-(define-method get_accessible_type
- (of-object "AtkObjectFactory")
- (c-name "atk_object_factory_get_accessible_type")
- (return-type "GType")
-)
-
-(define-virtual create_accessible
- (of-object "AtkObjectFactory")
- (return-type "AtkObject*")
-)
-
-(define-virtual invalidate
- (of-object "AtkObjectFactory")
- (return-type "none")
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkobject.h
-
-(define-function atk_object_get_type
- (c-name "atk_object_get_type")
- (return-type "GType")
-)
-
-(define-function atk_implementor_get_type
- (c-name "atk_implementor_get_type")
- (return-type "GType")
-)
-
-(define-method ref_accessible
- (of-object "AtkImplementorIface")
- (c-name "atk_implementor_ref_accessible")
- (return-type "AtkObject*")
-)
-
-(define-virtual ref_accessible
- (of-object "AtkImplementor")
- (return-type "AtkObject*")
-)
-
-(define-method get_name
- (of-object "AtkObject")
- (c-name "atk_object_get_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_description
- (of-object "AtkObject")
- (c-name "atk_object_get_description")
- (return-type "const-gchar*")
-)
-
-(define-method get_parent
- (of-object "AtkObject")
- (c-name "atk_object_get_parent")
- (return-type "AtkObject*")
-)
-
-(define-method get_n_accessible_children
- (of-object "AtkObject")
- (c-name "atk_object_get_n_accessible_children")
- (return-type "gint")
-)
-
-(define-method ref_accessible_child
- (of-object "AtkObject")
- (c-name "atk_object_ref_accessible_child")
- (return-type "AtkObject*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method ref_relation_set
- (of-object "AtkObject")
- (c-name "atk_object_ref_relation_set")
- (return-type "AtkRelationSet*")
-)
-
-(define-method get_role
- (of-object "AtkObject")
- (c-name "atk_object_get_role")
- (return-type "AtkRole")
-)
-
-(define-method get_layer
- (of-object "AtkObject")
- (c-name "atk_object_get_layer")
- (return-type "AtkLayer")
-)
-
-(define-method get_mdi_zorder
- (of-object "AtkObject")
- (c-name "atk_object_get_mdi_zorder")
- (return-type "gint")
-)
-
-(define-method ref_state_set
- (of-object "AtkObject")
- (c-name "atk_object_ref_state_set")
- (return-type "AtkStateSet*")
-)
-
-(define-method get_index_in_parent
- (of-object "AtkObject")
- (c-name "atk_object_get_index_in_parent")
- (return-type "gint")
-)
-
-(define-method set_name
- (of-object "AtkObject")
- (c-name "atk_object_set_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method set_description
- (of-object "AtkObject")
- (c-name "atk_object_set_description")
- (return-type "none")
- (parameters
- '("const-gchar*" "description")
- )
-)
-
-(define-method set_parent
- (of-object "AtkObject")
- (c-name "atk_object_set_parent")
- (return-type "none")
- (parameters
- '("AtkObject*" "parent")
- )
-)
-
-(define-method set_role
- (of-object "AtkObject")
- (c-name "atk_object_set_role")
- (return-type "none")
- (parameters
- '("AtkRole" "role")
- )
-)
-
-(define-method connect_property_change_handler
- (of-object "AtkObject")
- (c-name "atk_object_connect_property_change_handler")
- (return-type "guint")
- (parameters
- '("AtkPropertyChangeHandler*" "handler")
- )
-)
-
-(define-method remove_property_change_handler
- (of-object "AtkObject")
- (c-name "atk_object_remove_property_change_handler")
- (return-type "none")
- (parameters
- '("guint" "handler_id")
- )
-)
-
-(define-method notify_state_change
- (of-object "AtkObject")
- (c-name "atk_object_notify_state_change")
- (return-type "none")
- (parameters
- '("AtkState" "state")
- '("gboolean" "value")
- )
-)
-
-(define-virtual get_name
- (of-object "AtkObject")
- (return-type "const-gchar*")
-)
-
-(define-virtual get_description
- (of-object "AtkObject")
- (return-type "const-gchar*")
-)
-
-(define-virtual get_parent
- (of-object "AtkObject")
- (return-type "AtkObject*")
-)
-
-(define-virtual get_n_children
- (of-object "AtkObject")
- (return-type "gint")
-)
-
-(define-virtual ref_child
- (of-object "AtkObject")
- (return-type "AtkObject*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual get_index_in_parent
- (of-object "AtkObject")
- (return-type "gint")
-)
-
-(define-virtual ref_relation_set
- (of-object "AtkObject")
- (return-type "AtkRelationSet*")
-)
-
-(define-virtual get_role
- (of-object "AtkObject")
- (return-type "AtkRole")
-)
-
-(define-virtual get_layer
- (of-object "AtkObject")
- (return-type "AtkLayer")
-)
-
-(define-virtual get_mdi_zorder
- (of-object "AtkObject")
- (return-type "gint")
-)
-
-(define-virtual ref_state_set
- (of-object "AtkObject")
- (return-type "AtkStateSet*")
-)
-
-(define-virtual set_name
- (of-object "AtkObject")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-virtual set_description
- (of-object "AtkObject")
- (return-type "none")
- (parameters
- '("const-gchar*" "description")
- )
-)
-
-(define-virtual set_parent
- (of-object "AtkObject")
- (return-type "none")
- (parameters
- '("AtkObject*" "parent")
- )
-)
-
-(define-virtual set_role
- (of-object "AtkObject")
- (return-type "none")
- (parameters
- '("AtkRole" "role")
- )
-)
-
-(define-virtual connect_property_change_handler
- (of-object "AtkObject")
- (return-type "guint")
- (parameters
- '("AtkPropertyChangeHandler*" "handler")
- )
-)
-
-(define-virtual remove_property_change_handler
- (of-object "AtkObject")
- (return-type "none")
- (parameters
- '("guint" "handler_id")
- )
-)
-
-(define-virtual initialize
- (of-object "AtkObject")
- (return-type "none")
- (parameters
- '("gpointer" "data")
- )
-)
-
-(define-virtual children_changed
- (of-object "AtkObject")
- (return-type "none")
- (parameters
- '("guint" "change_index")
- '("gpointer" "changed_child")
- )
-)
-
-(define-virtual focus_event
- (of-object "AtkObject")
- (return-type "none")
- (parameters
- '("gboolean" "focus_in")
- )
-)
-
-(define-virtual property_change
- (of-object "AtkObject")
- (return-type "none")
- (parameters
- '("AtkPropertyValues*" "values")
- )
-)
-
-(define-virtual state_change
- (of-object "AtkObject")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- '("gboolean" "state_set")
- )
-)
-
-(define-virtual visible_data_changed
- (of-object "AtkObject")
- (return-type "none")
-)
-
-(define-virtual active_descendant_changed
- (of-object "AtkObject")
- (return-type "none")
- (parameters
- '("gpointer*" "child")
- )
-)
-
-(define-function role_register
- (c-name "atk_role_register")
- (return-type "AtkRole")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method initialize
- (of-object "AtkObject")
- (c-name "atk_object_initialize")
- (return-type "none")
- (parameters
- '("gpointer" "data")
- )
-)
-
-(define-method add_relationship
- (of-object "AtkObject")
- (c-name "atk_object_add_relationship")
- (return-type "gboolean")
- (parameters
- '("AtkRelationType" "relationship")
- '("AtkObject*" "target")
- )
-)
-
-(define-method remove_relationship
- (of-object "AtkObject")
- (c-name "atk_object_remove_relationship")
- (return-type "gboolean")
- (parameters
- '("AtkRelationType" "relationship")
- '("AtkObject*" "target")
- )
-)
-
-(define-function role_get_localized_name
- (c-name "atk_role_get_localized_name")
- (return-type "const-gchar*")
- (parameters
- '("AtkRole" "role")
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkregistry.h
-
-(define-function atk_registry_get_type
- (c-name "atk_registry_get_type")
- (return-type "GType")
-)
-
-(define-method set_factory_type
- (of-object "AtkRegistry")
- (c-name "atk_registry_set_factory_type")
- (return-type "none")
- (parameters
- '("GType" "type")
- '("GType" "factory_type")
- )
-)
-
-(define-method get_factory_type
- (of-object "AtkRegistry")
- (c-name "atk_registry_get_factory_type")
- (return-type "GType")
- (parameters
- '("GType" "type")
- )
-)
-
-(define-method get_factory
- (of-object "AtkRegistry")
- (c-name "atk_registry_get_factory")
- (return-type "AtkObjectFactory*")
- (parameters
- '("GType" "type")
- )
-)
-
-(define-function get_default_registry
- (c-name "atk_get_default_registry")
- (return-type "AtkRegistry*")
- (parameters
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkrelation.h
-
-(define-function atk_relation_get_type
- (c-name "atk_relation_get_type")
- (return-type "GType")
-)
-
-(define-function relation_type_register
- (c-name "atk_relation_type_register")
- (return-type "AtkRelationType")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-function relation_type_get_name
- (c-name "atk_relation_type_get_name")
- (return-type "const-gchar*")
- (parameters
- '("AtkRelationType" "relationship")
- )
-)
-
-(define-function relation_type_for_name
- (c-name "atk_relation_type_for_name")
- (return-type "AtkRelationType")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-function relation_new
- (c-name "atk_relation_new")
- (return-type "AtkRelation*")
- (is-constructor-of AtkRelation)
- (parameters
- '("AtkObject**" "targets")
- '("gint" "n_targets")
- '("AtkRelationType" "relationship")
- )
-)
-
-(define-method get_relation_type
- (of-object "AtkRelation")
- (c-name "atk_relation_get_relation_type")
- (return-type "AtkRelationType")
-)
-
-(define-method get_target
- (of-object "AtkRelation")
- (c-name "atk_relation_get_target")
- (return-type "GPtrArray*")
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkrelationset.h
-
-(define-function atk_relation_set_get_type
- (c-name "atk_relation_set_get_type")
- (return-type "GType")
-)
-
-(define-function relation_set_new
- (c-name "atk_relation_set_new")
- (is-constructor-of AtkRelationSet)
- (return-type "AtkRelationSet*")
-)
-
-(define-method contains
- (of-object "AtkRelationSet")
- (c-name "atk_relation_set_contains")
- (return-type "gboolean")
- (parameters
- '("AtkRelationType" "relationship")
- )
-)
-
-(define-method remove
- (of-object "AtkRelationSet")
- (c-name "atk_relation_set_remove")
- (return-type "none")
- (parameters
- '("AtkRelation*" "relation")
- )
-)
-
-(define-method add
- (of-object "AtkRelationSet")
- (c-name "atk_relation_set_add")
- (return-type "none")
- (parameters
- '("AtkRelation*" "relation")
- )
-)
-
-(define-method get_n_relations
- (of-object "AtkRelationSet")
- (c-name "atk_relation_set_get_n_relations")
- (return-type "gint")
-)
-
-(define-method get_relation
- (of-object "AtkRelationSet")
- (c-name "atk_relation_set_get_relation")
- (return-type "AtkRelation*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method get_relation_by_type
- (of-object "AtkRelationSet")
- (c-name "atk_relation_set_get_relation_by_type")
- (return-type "AtkRelation*")
- (parameters
- '("AtkRelationType" "relationship")
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkselection.h
-
-(define-function atk_selection_get_type
- (c-name "atk_selection_get_type")
- (return-type "GType")
- (parameters
- )
-)
-
-(define-method add_selection
- (of-object "AtkSelection")
- (c-name "atk_selection_add_selection")
- (return-type "gboolean")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method clear_selection
- (of-object "AtkSelection")
- (c-name "atk_selection_clear_selection")
- (return-type "gboolean")
-)
-
-(define-method ref_selection
- (of-object "AtkSelection")
- (c-name "atk_selection_ref_selection")
- (return-type "AtkObject*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method get_selection_count
- (of-object "AtkSelection")
- (c-name "atk_selection_get_selection_count")
- (return-type "gint")
-)
-
-(define-method is_child_selected
- (of-object "AtkSelection")
- (c-name "atk_selection_is_child_selected")
- (return-type "gboolean")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method remove_selection
- (of-object "AtkSelection")
- (c-name "atk_selection_remove_selection")
- (return-type "gboolean")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method select_all_selection
- (of-object "AtkSelection")
- (c-name "atk_selection_select_all_selection")
- (return-type "gboolean")
-)
-
-(define-virtual add_selection
- (of-object "AtkSelection")
- (return-type "gboolean")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual clear_selection
- (of-object "AtkSelection")
- (return-type "gboolean")
-)
-
-(define-virtual ref_selection
- (of-object "AtkSelection")
- (return-type "AtkObject*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual get_selection_count
- (of-object "AtkSelection")
- (return-type "gint")
-)
-
-(define-virtual is_child_selected
- (of-object "AtkSelection")
- (return-type "gboolean")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual remove_selection
- (of-object "AtkSelection")
- (return-type "gboolean")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual select_all_selection
- (of-object "AtkSelection")
- (return-type "gboolean")
-)
-
-(define-virtual selection_changed
- (of-object "AtkSelection")
- (return-type "none")
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkstate.h
-
-(define-function state_type_register
- (c-name "atk_state_type_register")
- (return-type "AtkStateType")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-function state_type_get_name
- (c-name "atk_state_type_get_name")
- (return-type "const-gchar*")
- (parameters
- '("AtkStateType" "type")
- )
-)
-
-(define-function state_type_for_name
- (c-name "atk_state_type_for_name")
- (return-type "AtkStateType")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkstateset.h
-
-(define-function atk_state_set_get_type
- (c-name "atk_state_set_get_type")
- (return-type "GType")
-)
-
-(define-function atk_state_set_new
- (c-name "atk_state_set_new")
- (is-constructor-of "AtkStateSet")
- (return-type "AtkStateSet*")
-)
-
-(define-method is_empty
- (of-object "AtkStateSet")
- (c-name "atk_state_set_is_empty")
- (return-type "gboolean")
-)
-
-(define-method add_state
- (of-object "AtkStateSet")
- (c-name "atk_state_set_add_state")
- (return-type "gboolean")
- (parameters
- '("AtkStateType" "type")
- )
-)
-
-(define-method add_states
- (of-object "AtkStateSet")
- (c-name "atk_state_set_add_states")
- (return-type "none")
- (parameters
- '("AtkStateType*" "types")
- '("gint" "n_types")
- )
-)
-
-(define-method clear_states
- (of-object "AtkStateSet")
- (c-name "atk_state_set_clear_states")
- (return-type "none")
-)
-
-(define-method contains_state
- (of-object "AtkStateSet")
- (c-name "atk_state_set_contains_state")
- (return-type "gboolean")
- (parameters
- '("AtkStateType" "type")
- )
-)
-
-(define-method contains_states
- (of-object "AtkStateSet")
- (c-name "atk_state_set_contains_states")
- (return-type "gboolean")
- (parameters
- '("AtkStateType*" "types")
- '("gint" "n_types")
- )
-)
-
-(define-method remove_state
- (of-object "AtkStateSet")
- (c-name "atk_state_set_remove_state")
- (return-type "gboolean")
- (parameters
- '("AtkStateType" "type")
- )
-)
-
-(define-method and_sets
- (of-object "AtkStateSet")
- (c-name "atk_state_set_and_sets")
- (return-type "AtkStateSet*")
- (parameters
- '("AtkStateSet*" "compare_set")
- )
-)
-
-(define-method or_sets
- (of-object "AtkStateSet")
- (c-name "atk_state_set_or_sets")
- (return-type "AtkStateSet*")
- (parameters
- '("AtkStateSet*" "compare_set")
- )
-)
-
-(define-method xor_sets
- (of-object "AtkStateSet")
- (c-name "atk_state_set_xor_sets")
- (return-type "AtkStateSet*")
- (parameters
- '("AtkStateSet*" "compare_set")
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkstreamablecontent.h
-
-(define-function atk_streamable_content_get_type
- (c-name "atk_streamable_content_get_type")
- (return-type "GType")
-)
-
-(define-method get_n_mime_types
- (of-object "AtkStreamableContent")
- (c-name "atk_streamable_content_get_n_mime_types")
- (return-type "gint")
-)
-
-(define-method get_mime_type
- (of-object "AtkStreamableContent")
- (c-name "atk_streamable_content_get_mime_type")
- (return-type "const-gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-method get_stream
- (of-object "AtkStreamableContent")
- (c-name "atk_streamable_content_get_stream")
- (return-type "GIOChannel*")
- (parameters
- '("const-gchar*" "mime_type")
- )
-)
-
-(define-virtual get_n_mime_types
- (of-object "AtkStreamableContent")
- (return-type "gint")
-)
-
-(define-virtual get_mime_type
- (of-object "AtkStreamableContent")
- (return-type "const-gchar*")
- (parameters
- '("gint" "i")
- )
-)
-
-(define-virtual get_stream
- (of-object "AtkStreamableContent")
- (return-type "GIOChannel*")
- (parameters
- '("const-gchar*" "mime_type")
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atktable.h
-
-(define-function atk_table_get_type
- (c-name "atk_table_get_type")
- (return-type "GType")
- (parameters
- )
-)
-
-(define-method ref_at
- (of-object "AtkTable")
- (c-name "atk_table_ref_at")
- (return-type "AtkObject*")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-method get_index_at
- (of-object "AtkTable")
- (c-name "atk_table_get_index_at")
- (return-type "gint")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-method get_column_at_index
- (of-object "AtkTable")
- (c-name "atk_table_get_column_at_index")
- (return-type "gint")
- (parameters
- '("gint" "index")
- )
-)
-
-(define-method get_row_at_index
- (of-object "AtkTable")
- (c-name "atk_table_get_row_at_index")
- (return-type "gint")
- (parameters
- '("gint" "index")
- )
-)
-
-(define-method get_n_columns
- (of-object "AtkTable")
- (c-name "atk_table_get_n_columns")
- (return-type "gint")
-)
-
-(define-method get_n_rows
- (of-object "AtkTable")
- (c-name "atk_table_get_n_rows")
- (return-type "gint")
-)
-
-(define-method get_column_extent_at
- (of-object "AtkTable")
- (c-name "atk_table_get_column_extent_at")
- (return-type "gint")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-method get_row_extent_at
- (of-object "AtkTable")
- (c-name "atk_table_get_row_extent_at")
- (return-type "gint")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-method get_caption
- (of-object "AtkTable")
- (c-name "atk_table_get_caption")
- (return-type "AtkObject*")
-)
-
-(define-method get_column_description
- (of-object "AtkTable")
- (c-name "atk_table_get_column_description")
- (return-type "const-gchar*")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method get_column_header
- (of-object "AtkTable")
- (c-name "atk_table_get_column_header")
- (return-type "AtkObject*")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method get_row_description
- (of-object "AtkTable")
- (c-name "atk_table_get_row_description")
- (return-type "const-gchar*")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-method get_row_header
- (of-object "AtkTable")
- (c-name "atk_table_get_row_header")
- (return-type "AtkObject*")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-method get_summary
- (of-object "AtkTable")
- (c-name "atk_table_get_summary")
- (return-type "AtkObject*")
-)
-
-(define-method set_caption
- (of-object "AtkTable")
- (c-name "atk_table_set_caption")
- (return-type "none")
- (parameters
- '("AtkObject*" "caption")
- )
-)
-
-(define-method set_column_description
- (of-object "AtkTable")
- (c-name "atk_table_set_column_description")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("const-gchar*" "description")
- )
-)
-
-(define-method set_column_header
- (of-object "AtkTable")
- (c-name "atk_table_set_column_header")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("AtkObject*" "header")
- )
-)
-
-(define-method set_row_description
- (of-object "AtkTable")
- (c-name "atk_table_set_row_description")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("const-gchar*" "description")
- )
-)
-
-(define-method set_row_header
- (of-object "AtkTable")
- (c-name "atk_table_set_row_header")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("AtkObject*" "header")
- )
-)
-
-(define-method set_summary
- (of-object "AtkTable")
- (c-name "atk_table_set_summary")
- (return-type "none")
- (parameters
- '("AtkObject*" "accessible")
- )
-)
-
-(define-method get_selected_columns
- (of-object "AtkTable")
- (c-name "atk_table_get_selected_columns")
- (return-type "gint")
- (parameters
- '("gint**" "selected")
- )
-)
-
-(define-method get_selected_rows
- (of-object "AtkTable")
- (c-name "atk_table_get_selected_rows")
- (return-type "gint")
- (parameters
- '("gint**" "selected")
- )
-)
-
-(define-method is_column_selected
- (of-object "AtkTable")
- (c-name "atk_table_is_column_selected")
- (return-type "gboolean")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method is_row_selected
- (of-object "AtkTable")
- (c-name "atk_table_is_row_selected")
- (return-type "gboolean")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-method is_selected
- (of-object "AtkTable")
- (c-name "atk_table_is_selected")
- (return-type "gboolean")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-method add_row_selection
- (of-object "AtkTable")
- (c-name "atk_table_add_row_selection")
- (return-type "gboolean")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-method remove_row_selection
- (of-object "AtkTable")
- (c-name "atk_table_remove_row_selection")
- (return-type "gboolean")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-method add_column_selection
- (of-object "AtkTable")
- (c-name "atk_table_add_column_selection")
- (return-type "gboolean")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method remove_column_selection
- (of-object "AtkTable")
- (c-name "atk_table_remove_column_selection")
- (return-type "gboolean")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-virtual ref_at
- (of-object "AtkTable")
- (return-type "AtkObject*")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-virtual get_index_at
- (of-object "AtkTable")
- (return-type "gint")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-virtual get_column_at_index
- (of-object "AtkTable")
- (return-type "gint")
- (parameters
- '("gint" "index")
- )
-)
-
-(define-virtual get_row_at_index
- (of-object "AtkTable")
- (return-type "gint")
- (parameters
- '("gint" "index")
- )
-)
-
-(define-virtual get_n_columns
- (of-object "AtkTable")
- (return-type "gint")
-)
-
-(define-virtual get_n_rows
- (of-object "AtkTable")
- (return-type "gint")
-)
-
-(define-virtual get_column_extent_at
- (of-object "AtkTable")
- (return-type "gint")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-virtual get_row_extent_at
- (of-object "AtkTable")
- (return-type "gint")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-virtual get_caption
- (of-object "AtkTable")
- (return-type "AtkObject*")
-)
-
-(define-virtual get_column_description
- (of-object "AtkTable")
- (return-type "const-gchar*")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-virtual get_column_header
- (of-object "AtkTable")
- (return-type "AtkObject*")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-virtual get_row_description
- (of-object "AtkTable")
- (return-type "const-gchar*")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-virtual get_row_header
- (of-object "AtkTable")
- (return-type "AtkObject*")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-virtual get_summary
- (of-object "AtkTable")
- (return-type "AtkObject*")
-)
-
-(define-virtual set_caption
- (of-object "AtkTable")
- (return-type "none")
- (parameters
- '("AtkObject*" "caption")
- )
-)
-
-(define-virtual set_column_description
- (of-object "AtkTable")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("const-gchar*" "description")
- )
-)
-
-(define-virtual set_column_header
- (of-object "AtkTable")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("AtkObject*" "header")
- )
-)
-
-(define-virtual set_row_description
- (of-object "AtkTable")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("const-gchar*" "description")
- )
-)
-
-(define-virtual set_row_header
- (of-object "AtkTable")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("AtkObject*" "header")
- )
-)
-
-(define-virtual set_summary
- (of-object "AtkTable")
- (return-type "none")
- (parameters
- '("AtkObject*" "accessible")
- )
-)
-
-(define-virtual get_selected_columns
- (of-object "AtkTable")
- (return-type "gint")
- (parameters
- '("gint**" "selected")
- )
-)
-
-(define-virtual get_selected_rows
- (of-object "AtkTable")
- (return-type "gint")
- (parameters
- '("gint**" "selected")
- )
-)
-
-(define-virtual is_column_selected
- (of-object "AtkTable")
- (return-type "gboolean")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-virtual is_row_selected
- (of-object "AtkTable")
- (return-type "gboolean")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-virtual is_selected
- (of-object "AtkTable")
- (return-type "gboolean")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-virtual add_row_selection
- (of-object "AtkTable")
- (return-type "gboolean")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-virtual remove_row_selection
- (of-object "AtkTable")
- (return-type "gboolean")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-virtual add_column_selection
- (of-object "AtkTable")
- (return-type "gboolean")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-virtual remove_column_selection
- (of-object "AtkTable")
- (return-type "gboolean")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-virtual row_inserted
- (of-object "AtkTable")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "num_inserted")
- )
-)
-
-(define-virtual column_inserted
- (of-object "AtkTable")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("gint" "num_inserted")
- )
-)
-
-(define-virtual row_deleted
- (of-object "AtkTable")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "num_deleted")
- )
-)
-
-(define-virtual column_deleted
- (of-object "AtkTable")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("gint" "num_deleted")
- )
-)
-
-(define-virtual row_reordered
- (of-object "AtkTable")
- (return-type "none")
-)
-
-(define-virtual column_reordered
- (of-object "AtkTable")
- (return-type "none")
-)
-
-(define-virtual model_changed
- (of-object "AtkTable")
- (return-type "none")
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atktext.h
-
-(define-function atk_text_get_type
- (c-name "atk_text_get_type")
- (return-type "GType")
-)
-
-(define-method get_text
- (of-object "AtkText")
- (c-name "atk_text_get_text")
- (return-type "gchar*")
- (parameters
- '("gint" "start_offset")
- '("gint" "end_offset")
- )
-)
-
-(define-method get_character_at_offset
- (of-object "AtkText")
- (c-name "atk_text_get_character_at_offset")
- (return-type "gunichar")
- (parameters
- '("gint" "offset")
- )
-)
-
-(define-method get_text_after_offset
- (of-object "AtkText")
- (c-name "atk_text_get_text_after_offset")
- (return-type "gchar*")
- (parameters
- '("gint" "offset")
- '("AtkTextBoundary" "boundary_type")
- '("gint*" "start_offset")
- '("gint*" "end_offset")
- )
-)
-
-(define-method get_text_at_offset
- (of-object "AtkText")
- (c-name "atk_text_get_text_at_offset")
- (return-type "gchar*")
- (parameters
- '("gint" "offset")
- '("AtkTextBoundary" "boundary_type")
- '("gint*" "start_offset")
- '("gint*" "end_offset")
- )
-)
-
-(define-method get_text_before_offset
- (of-object "AtkText")
- (c-name "atk_text_get_text_before_offset")
- (return-type "gchar*")
- (parameters
- '("gint" "offset")
- '("AtkTextBoundary" "boundary_type")
- '("gint*" "start_offset")
- '("gint*" "end_offset")
- )
-)
-
-(define-method get_caret_offset
- (of-object "AtkText")
- (c-name "atk_text_get_caret_offset")
- (return-type "gint")
-)
-
-(define-method get_character_extents
- (of-object "AtkText")
- (c-name "atk_text_get_character_extents")
- (return-type "none")
- (parameters
- '("gint" "offset")
- '("gint*" "x")
- '("gint*" "y")
- '("gint*" "width")
- '("gint*" "height")
- '("AtkCoordType" "coords")
- )
-)
-
-(define-method get_run_attributes
- (of-object "AtkText")
- (c-name "atk_text_get_run_attributes")
- (return-type "AtkAttributeSet*")
- (parameters
- '("gint" "offset")
- '("gint*" "start_offset")
- '("gint*" "end_offset")
- )
-)
-
-(define-method get_default_attributes
- (of-object "AtkText")
- (c-name "atk_text_get_default_attributes")
- (return-type "AtkAttributeSet*")
-)
-
-(define-method get_character_count
- (of-object "AtkText")
- (c-name "atk_text_get_character_count")
- (return-type "gint")
-)
-
-(define-method get_offset_at_point
- (of-object "AtkText")
- (c-name "atk_text_get_offset_at_point")
- (return-type "gint")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("AtkCoordType" "coords")
- )
-)
-
-(define-method get_n_selections
- (of-object "AtkText")
- (c-name "atk_text_get_n_selections")
- (return-type "gint")
-)
-
-(define-method get_selection
- (of-object "AtkText")
- (c-name "atk_text_get_selection")
- (return-type "gchar*")
- (parameters
- '("gint" "selection_num")
- '("gint*" "start_offset")
- '("gint*" "end_offset")
- )
-)
-
-(define-method add_selection
- (of-object "AtkText")
- (c-name "atk_text_add_selection")
- (return-type "gboolean")
- (parameters
- '("gint" "start_offset")
- '("gint" "end_offset")
- )
-)
-
-(define-method remove_selection
- (of-object "AtkText")
- (c-name "atk_text_remove_selection")
- (return-type "gboolean")
- (parameters
- '("gint" "selection_num")
- )
-)
-
-(define-method set_selection
- (of-object "AtkText")
- (c-name "atk_text_set_selection")
- (return-type "gboolean")
- (parameters
- '("gint" "selection_num")
- '("gint" "start_offset")
- '("gint" "end_offset")
- )
-)
-
-(define-method set_caret_offset
- (of-object "AtkText")
- (c-name "atk_text_set_caret_offset")
- (return-type "gboolean")
- (parameters
- '("gint" "offset")
- )
-)
-
-(define-method get_range_extents
- (of-object "AtkText")
- (c-name "atk_text_get_range_extents")
- (return-type "none")
- (parameters
- '("gint" "start_offset")
- '("gint" "end_offset")
- '("AtkCoordType" "coord_type")
- '("AtkTextRectangle*" "rect")
- )
-)
-
-(define-method get_bounded_ranges
- (of-object "AtkText")
- (c-name "atk_text_get_bounded_ranges")
- (return-type "AtkTextRange**")
- (parameters
- '("AtkTextRectangle*" "rect")
- '("AtkCoordType" "coord_type")
- '("AtkTextClipType" "x_clip_type")
- '("AtkTextClipType" "y_clip_type")
- )
-)
-
-(define-function text_free_ranges
- (c-name "atk_text_free_ranges")
- (return-type "none")
- (parameters
- '("AtkTextRange**" "ranges")
- )
-)
-
-(define-method free
- (of-object "AtkAttributeSet")
- (c-name "atk_attribute_set_free")
- (return-type "none")
-)
-
-(define-function text_attribute_get_name
- (c-name "atk_text_attribute_get_name")
- (return-type "const-gchar*")
- (parameters
- '("AtkTextAttribute" "attr")
- )
-)
-
-(define-function text_attribute_get_value
- (c-name "atk_text_attribute_get_value")
- (return-type "const-gchar*")
- (parameters
- '("AtkTextAttribute" "attr")
- '("gint" "index")
- )
-)
-
-(define-function text_attribute_register
- (c-name "atk_text_attribute_register")
- (return-type "AtkTextAttribute")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-function text_attribute_for_name
- (c-name "atk_text_attribute_for_name")
- (return-type "AtkTextAttribute")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-virtual get_text
- (of-object "AtkText")
- (return-type "gchar*")
- (parameters
- '("gint" "start_offset")
- '("gint" "end_offset")
- )
-)
-
-(define-virtual get_text_after_offset
- (of-object "AtkText")
- (return-type "gchar*")
- (parameters
- '("gint" "offset")
- '("AtkTextBoundary" "boundary_type")
- '("gint*" "start_offset")
- '("gint*" "end_offset")
- )
-)
-
-(define-virtual get_text_at_offset
- (of-object "AtkText")
- (return-type "gchar*")
- (parameters
- '("gint" "offset")
- '("AtkTextBoundary" "boundary_type")
- '("gint*" "start_offset")
- '("gint*" "end_offset")
- )
-)
-
-(define-virtual get_character_at_offset
- (of-object "AtkText")
- (return-type "gunichar")
- (parameters
- '("gint" "offset")
- )
-)
-
-(define-virtual get_text_before_offset
- (of-object "AtkText")
- (return-type "gchar*")
- (parameters
- '("gint" "offset")
- '("AtkTextBoundary" "boundary_type")
- '("gint*" "start_offset")
- '("gint*" "end_offset")
- )
-)
-
-(define-virtual get_caret_offset
- (of-object "AtkText")
- (return-type "gint")
-)
-
-(define-virtual get_run_attributes
- (of-object "AtkText")
- (return-type "AtkAttributeSet*")
- (parameters
- '("gint" "offset")
- '("gint*" "start_offset")
- '("gint*" "end_offset")
- )
-)
-
-(define-virtual get_default_attributes
- (of-object "AtkText")
- (return-type "AtkAttributeSet*")
-)
-
-(define-virtual get_character_extents
- (of-object "AtkText")
- (return-type "none")
- (parameters
- '("gint" "offset")
- '("gint*" "x")
- '("gint*" "y")
- '("gint*" "width")
- '("gint*" "height")
- '("AtkCoordType" "coords")
- )
-)
-
-(define-virtual get_character_count
- (of-object "AtkText")
- (return-type "gint")
-)
-
-(define-virtual get_offset_at_point
- (of-object "AtkText")
- (return-type "gint")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("AtkCoordType" "coords")
- )
-)
-
-(define-virtual get_n_selections
- (of-object "AtkText")
- (return-type "gint")
-)
-
-(define-virtual get_selection
- (of-object "AtkText")
- (return-type "gchar*")
- (parameters
- '("gint" "selection_num")
- '("gint*" "start_offset")
- '("gint*" "end_offset")
- )
-)
-
-(define-virtual add_selection
- (of-object "AtkText")
- (return-type "gboolean")
- (parameters
- '("gint" "start_offset")
- '("gint" "end_offset")
- )
-)
-
-(define-virtual remove_selection
- (of-object "AtkText")
- (return-type "gboolean")
- (parameters
- '("gint" "selection_num")
- )
-)
-
-(define-virtual set_selection
- (of-object "AtkText")
- (return-type "gboolean")
- (parameters
- '("gint" "selection_num")
- '("gint" "start_offset")
- '("gint" "end_offset")
- )
-)
-
-(define-virtual set_caret_offset
- (of-object "AtkText")
- (return-type "gboolean")
- (parameters
- '("gint" "offset")
- )
-)
-
-(define-virtual text_changed
- (of-object "AtkText")
- (return-type "none")
- (parameters
- '("gint" "position")
- '("gint" "length")
- )
-)
-
-(define-virtual text_caret_moved
- (of-object "AtkText")
- (return-type "none")
- (parameters
- '("gint" "location")
- )
-)
-
-(define-virtual text_selection_changed
- (of-object "AtkText")
- (return-type "none")
-)
-
-(define-virtual text_attributes_changed
- (of-object "AtkText")
- (return-type "none")
-)
-
-(define-virtual get_range_extents
- (of-object "AtkText")
- (return-type "none")
- (parameters
- '("gint" "start_offset")
- '("gint" "end_offset")
- '("AtkCoordType" "coord_type")
- '("AtkTextRectangle*" "rect")
- )
-)
-
-(define-virtual get_bounded_ranges
- (of-object "AtkText")
- (return-type "AtkTextRange**")
- (parameters
- '("AtkTextRectangle*" "rect")
- '("AtkCoordType" "coord_type")
- '("AtkTextClipType" "x_clip_type")
- '("AtkTextClipType" "y_clip_type")
- )
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkutil.h
-
-(define-function atk_util_get_type
- (c-name "atk_util_get_type")
- (return-type "GType")
-)
-
-(define-function add_focus_tracker
- (c-name "atk_add_focus_tracker")
- (return-type "guint")
- (parameters
- '("AtkEventListener" "focus_tracker")
- )
-)
-
-(define-function remove_focus_tracker
- (c-name "atk_remove_focus_tracker")
- (return-type "none")
- (parameters
- '("guint" "tracker_id")
- )
-)
-
-(define-function focus_tracker_init
- (c-name "atk_focus_tracker_init")
- (return-type "none")
- (parameters
- '("AtkEventListenerInit" "add_function")
- )
-)
-
-(define-function focus_tracker_notify
- (c-name "atk_focus_tracker_notify")
- (return-type "none")
- (parameters
- '("AtkObject*" "object")
- )
-)
-
-(define-function add_global_event_listener
- (c-name "atk_add_global_event_listener")
- (return-type "guint")
- (parameters
- '("GSignalEmissionHook" "listener")
- '("const-gchar*" "event_type")
- )
-)
-
-(define-function remove_global_event_listener
- (c-name "atk_remove_global_event_listener")
- (return-type "none")
- (parameters
- '("guint" "listener_id")
- )
-)
-
-(define-function add_key_event_listener
- (c-name "atk_add_key_event_listener")
- (return-type "guint")
- (parameters
- '("AtkKeySnoopFunc" "listener")
- '("gpointer" "data")
- )
-)
-
-(define-function remove_key_event_listener
- (c-name "atk_remove_key_event_listener")
- (return-type "none")
- (parameters
- '("guint" "listener_id")
- )
-)
-
-(define-function get_root
- (c-name "atk_get_root")
- (return-type "AtkObject*")
-)
-
-(define-function get_toolkit_name
- (c-name "atk_get_toolkit_name")
- (return-type "const-gchar*")
-)
-
-(define-function get_toolkit_version
- (c-name "atk_get_toolkit_version")
- (return-type "const-gchar*")
-)
-
-(define-function get_focus_object
- (c-name "atk_get_focus_object")
- (return-type "AtkObject*")
-)
-
-(define-virtual add_global_event_listener
- (of-object "AtkUtil")
- (return-type "guint")
- (parameters
- '("const-gchar*" "event_type")
- )
-)
-
-(define-virtual remove_global_event_listener
- (of-object "AtkUtil")
- (return-type "none")
-)
-
-(define-virtual add_key_event_listener
- (of-object "AtkUtil")
- (return-type "guint")
- (parameters
- '("gpointer" "data")
- )
-)
-
-(define-virtual remove_key_event_listener
- (of-object "AtkUtil")
- (return-type "none")
-)
-
-
-
-;; From /usr/include/atk-1.0/atk/atkvalue.h
-
-(define-function atk_value_get_type
- (c-name "atk_value_get_type")
- (return-type "GType")
-)
-
-(define-method get_current_value
- (of-object "AtkValue")
- (c-name "atk_value_get_current_value")
- (return-type "none")
- (parameters
- '("GValue*" "value")
- )
-)
-
-(define-method get_maximum_value
- (of-object "AtkValue")
- (c-name "atk_value_get_maximum_value")
- (return-type "none")
- (parameters
- '("GValue*" "value")
- )
-)
-
-(define-method get_minimum_value
- (of-object "AtkValue")
- (c-name "atk_value_get_minimum_value")
- (return-type "none")
- (parameters
- '("GValue*" "value")
- )
-)
-
-(define-method set_current_value
- (of-object "AtkValue")
- (c-name "atk_value_set_current_value")
- (return-type "gboolean")
- (parameters
- '("const-GValue*" "value")
- )
-)
-
-(define-virtual get_current_value
- (of-object "AtkValue")
- (return-type "none")
- (parameters
- '("GValue*" "value")
- )
-)
-
-(define-virtual get_maximum_value
- (of-object "AtkValue")
- (return-type "none")
- (parameters
- '("GValue*" "value")
- )
-)
-
-(define-virtual get_minimum_value
- (of-object "AtkValue")
- (return-type "none")
- (parameters
- '("GValue*" "value")
- )
-)
-
-(define-virtual set_current_value
- (of-object "AtkValue")
- (return-type "gboolean")
- (parameters
- '("const-GValue*" "value")
- )
-)
-
-(define-function role_get_name
- (c-name "atk_role_get_name")
- (return-type "const-gchar*")
- (parameters
- '("AtkRole" "role")
- )
-)
-
-(define-function role_for_name
- (c-name "atk_role_for_name")
- (return-type "AtkRole")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-function rectangle_new
- (c-name "atk_rectangle_new")
- (is-constructor-of "AtkRectangle")
- (return-type "AtkRectangle")
-)
-
diff --git a/atk.override b/atk.override
deleted file mode 100644
index 7cb7beb9..00000000
--- a/atk.override
+++ /dev/null
@@ -1,690 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * atk.override: overrides for the ATK library
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-headers
-#define NO_IMPORT_PYGOBJECT
-#include "pygobject.h"
-#include <atk/atk.h>
-#include <atk/atk-enum-types.h>
-#include <atk/atknoopobjectfactory.h>
-#include <atk/atknoopobject.h>
-
-%%
-include
- atkrectangle.override
-%%
-modulename atk
-%%
-import gobject.GObject as PyGObject_Type
-%%
-ignore
- atk_text_free_ranges
- AtkObjectFactory__do_create_accessible
- AtkObjectFactory__proxy_do_create_accessible
- AtkUtil__do_add_global_event_listener
- AtkUtil__proxy_do_add_global_event_listener
- AtkUtil__do_remove_global_event_listener
- AtkUtil__proxy_do_remove_global_event_listener
- AtkUtil__do_add_key_event_listener
- AtkUtil__proxy_do_add_key_event_listener
- AtkUtil__do_remove_key_event_listener
- AtkUtil__proxy_do_remove_key_event_listener
-%%
-ignore-glob
- *_get_type
-%%
-override atk_relation_new kwargs
-static int
-_wrap_atk_relation_new (PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "targets", "relationship", NULL };
- AtkObject **targets;
- int relationship, count, i;
- PyObject *py_targets;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oi:relation_new", kwlist,
- &py_targets, &relationship))
- return -1;
-
- if (!PySequence_Check(py_targets)) {
- PyErr_SetString(PyExc_TypeError,
- "targets argument must be a non-empty sequence");
- return -1;
- }
-
- if ((count = PySequence_Length(py_targets)) == 0) {
- PyErr_SetString(PyExc_ValueError,
- "targets argument must be a non-empty sequence");
- return -1;
- }
- targets = g_new(AtkObject *, count);
- for (i = 0; i < count; i++) {
- PyObject *item = PySequence_GetItem(py_targets, i);
- Py_DECREF(item); /* PySequence_GetItem INCREF's */
- if (!pygobject_check(item, &PyAtkObject_Type)) {
- PyErr_SetString(PyExc_TypeError, "targets argument must be a sequence of AtkObjects.");
- g_free(targets);
- return -1;
- }
-
- targets[i] = (AtkObject *) pygobject_get(item);
- }
-
- self->obj = (GObject *) atk_relation_new(targets, count, relationship);
-
- g_free(targets);
-
- pygobject_register_wrapper((PyObject *) self);
- return 0;
-}
-%%
-override atk_component_get_extents kwargs
-static PyObject *
-_wrap_atk_component_get_extents(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "coord_type", NULL };
- gint x, y, width, height;
- AtkCoordType coord_type;
- PyObject *py_coord_type;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:atk.Component.get_extents", kwlist,
- &py_coord_type))
- return NULL;
-
- if (pyg_enum_get_value(ATK_TYPE_COORD_TYPE, py_coord_type,
- (gint *)&coord_type))
- return NULL;
- atk_component_get_extents(ATK_COMPONENT(self->obj), &x, &y, &width,
- &height, coord_type);
- return Py_BuildValue("(iiii)", x, y, width, height);
-}
-%%
-override atk_component_get_position kwargs
-static PyObject *
-_wrap_atk_component_get_position(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "coord_type", NULL };
- gint x, y;
- AtkCoordType coord_type;
- PyObject *py_coord_type;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:atk.Component.get_position", kwlist,
- &py_coord_type))
- return NULL;
-
- if (pyg_enum_get_value(ATK_TYPE_COORD_TYPE, py_coord_type,
- (gint *)&coord_type))
- return NULL;
- atk_component_get_position(ATK_COMPONENT(self->obj), &x, &y, coord_type);
- return Py_BuildValue("(ii)", x, y);
-}
-%%
-override atk_component_get_size noargs
-static PyObject *
-_wrap_atk_component_get_size(PyGObject *self)
-{
- gint width, height;
-
- atk_component_get_size(ATK_COMPONENT(self->obj), &width, &height);
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override atk_editable_text_set_run_attributes kwargs
-static PyObject *
-_wrap_atk_editable_text_set_run_attributes(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "attrib_set", "start_offset", "end_offset",
- NULL };
- gint start, end, n_attrs, i;
- gboolean ret;
- AtkAttributeSet *attrib_set = NULL;
- PyObject *py_attrib_set;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oii:atk.EditableText.set_run_attributes",
- kwlist, &py_attrib_set, &start, &end))
- return NULL;
-
-
- if (!(py_attrib_set = PySequence_Fast(py_attrib_set,
- "attrib_set must be a sequence")))
- return NULL;
-
- n_attrs = PySequence_Fast_GET_SIZE(py_attrib_set);
- for (i = 0; i < n_attrs; i++) {
- PyObject *item = PySequence_Fast_GET_ITEM(py_attrib_set, i);
- AtkAttribute *attr = g_new0(AtkAttribute, 1);
- if (!PyArg_ParseTuple(item, "ss", &attr->name, &attr->value)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "attrib_set items should be (string,string)");
- g_free(attr);
- g_slist_foreach(attrib_set, (GFunc)g_free, NULL);
- g_slist_free(attrib_set);
- Py_DECREF(py_attrib_set);
- return NULL;
- }
- attrib_set = g_slist_append(attrib_set, attr);
- }
- ret = atk_editable_text_set_run_attributes(ATK_EDITABLE_TEXT(self->obj),
- attrib_set, start, end);
-
- g_slist_foreach(attrib_set, (GFunc)g_free, NULL);
- g_slist_free(attrib_set);
- Py_DECREF(py_attrib_set);
- return PyBool_FromLong(ret);
-}
-%%
-override atk_editable_text_insert_text kwargs
-static PyObject *
-_wrap_atk_editable_text_insert_text(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "string", "length", "position",
- NULL };
- gint length, position;
- const gchar *string;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "sii:atk.EditableText.insert_text",
- kwlist, &string, &length, &position))
- return NULL;
-
- atk_editable_text_insert_text(ATK_EDITABLE_TEXT(self->obj),
- string, length, &position);
- return PyInt_FromLong(position);
-}
-%%
-override atk_image_get_image_size noargs
-static PyObject *
-_wrap_atk_image_get_image_size(PyGObject *self)
-{
- gint width, height;
-
- atk_image_get_image_size(ATK_IMAGE(self->obj), &width, &height);
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override atk_image_get_image_position kwargs
-static PyObject *
-_wrap_atk_image_get_image_position(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "coord_type", NULL };
- gint x, y;
- AtkCoordType coord_type;
- PyObject *py_coord_type;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:atk.Image.get_image_position", kwlist,
- &py_coord_type))
- return NULL;
-
- if (pyg_enum_get_value(ATK_TYPE_COORD_TYPE, py_coord_type,
- (gint *)&coord_type))
- return NULL;
- atk_image_get_image_position(ATK_IMAGE(self->obj), &x, &y, coord_type);
- return Py_BuildValue("(ii)", x, y);
-}
-%%
-override atk_relation_get_target noargs
-static PyObject *
-_wrap_atk_relation_get_target (PyGObject *self)
-{
- GPtrArray * trgtarray;
- AtkObject **targets;
- int i;
- PyObject *py_targets;
-
- trgtarray = atk_relation_get_target(ATK_RELATION(self->obj));
- py_targets = PyList_New(trgtarray->len);
- targets = (AtkObject**)trgtarray->pdata;
- for (i = 0; i < trgtarray->len; i++) {
- PyObject *item = pygobject_new((GObject*)targets[i]);
- PyList_SetItem(py_targets, i, item);
- }
- return py_targets;
-}
-%%
-override atk_state_set_add_states kwargs
-static PyObject *
-_wrap_atk_state_set_add_states(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "types", NULL };
- AtkStateType *types;
- gint count, i;
- PyObject *py_types;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:atk.StateSet.add_states",
- kwlist, &py_types))
- return NULL;
-
- if (!(py_types = PySequence_Fast(py_types, "types must be a sequence")))
- return NULL;
-
- count = PySequence_Fast_GET_SIZE(py_types);
- types = g_new0(AtkStateType, count);
- for (i = 0; i < count; i++) {
- if (pyg_enum_get_value(ATK_TYPE_STATE_TYPE,
- PySequence_Fast_GET_ITEM(py_types, i),
- (gpointer)&types[i])) {
- Py_DECREF(py_types);
- return NULL;
- }
- }
- atk_state_set_add_states(ATK_STATE_SET(self->obj), types, count);
-
- Py_DECREF(py_types);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override atk_state_set_contains_states kwargs
-static PyObject *
-_wrap_atk_state_set_contains_states(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "types", NULL };
- AtkStateType *types;
- gint count, i;
- gboolean ret;
- PyObject *py_types, *py_ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:atk.StateSet.contains_states",
- kwlist, &py_types))
- return NULL;
-
- if (!(py_types = PySequence_Fast(py_types, "types must be a sequence")))
- return NULL;
-
- count = PySequence_Fast_GET_SIZE(py_types);
- types = g_new0(AtkStateType, count);
- for (i = 0; i < count; i++) {
- if (pyg_enum_get_value(ATK_TYPE_STATE_TYPE,
- PySequence_Fast_GET_ITEM(py_types, i),
- (gpointer)&types[i])) {
- Py_DECREF(py_types);
- return NULL;
- }
- }
- ret = atk_state_set_contains_states(ATK_STATE_SET(self->obj), types,
- count);
- if (ret)
- py_ret = Py_True;
- else
- py_ret = Py_False;
-
- Py_DECREF(py_types);
- Py_INCREF(py_ret);
- return py_ret;
-}
-%%
-override atk_table_get_selected_columns noargs
-static PyObject *
-_wrap_atk_table_get_selected_columns(PyGObject *self)
-{
- gint *selected, ret, i;
- PyObject *py_selected;
-
- ret = atk_table_get_selected_columns(ATK_TABLE(self->obj), &selected);
- py_selected = PyTuple_New(ret);
- for (i = 0; i < ret; i++) {
- PyTuple_SetItem(py_selected, i, PyInt_FromLong(selected[i]));
- }
-
- g_free(selected);
- return py_selected;
-}
-%%
-override atk_table_get_selected_rows noargs
-static PyObject *
-_wrap_atk_table_get_selected_rows(PyGObject *self)
-{
- gint *selected, ret, i;
- PyObject *py_selected;
-
- ret = atk_table_get_selected_rows(ATK_TABLE(self->obj), &selected);
- py_selected = PyTuple_New(ret);
- for (i = 0; i < ret; i++) {
- PyTuple_SetItem(py_selected, i, PyInt_FromLong(selected[i]));
- }
-
- g_free(selected);
- return py_selected;
-}
-%%
-override atk_text_get_text_after_offset kwargs
-static PyObject *
-_wrap_atk_text_get_text_after_offset(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "offset", "boundary_type", NULL };
- gchar *text;
- gint start, end, offset;
- AtkTextBoundary boundary;
- PyObject *py_boundary;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iO:atk.Text.get_text_after_offset",
- kwlist, &offset, &py_boundary))
- return NULL;
-
- if (pyg_enum_get_value(ATK_TYPE_TEXT_BOUNDARY, py_boundary,
- (gpointer)&boundary))
- return NULL;
-
- text = atk_text_get_text_after_offset(ATK_TEXT(self->obj),
- offset, boundary, &start, &end);
- return Py_BuildValue("(s#ii)", text, (Py_ssize_t) (end - start), start, end);
-}
-%%
-override atk_text_get_text_at_offset kwargs
-static PyObject *
-_wrap_atk_text_get_text_at_offset(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "offset", "boundary_type", NULL };
- gchar *text;
- gint start, end, offset;
- AtkTextBoundary boundary;
- PyObject *py_boundary;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iO:atk.Text.get_text_at_offset",
- kwlist, &offset, &py_boundary))
- return NULL;
-
- if (pyg_enum_get_value(ATK_TYPE_TEXT_BOUNDARY, py_boundary,
- (gpointer)&boundary))
- return NULL;
-
- text = atk_text_get_text_at_offset(ATK_TEXT(self->obj),
- offset, boundary, &start, &end);
- return Py_BuildValue("(s#ii)", text, (Py_ssize_t) (end - start), start, end);
-}
-%%
-override atk_text_get_text_before_offset kwargs
-static PyObject *
-_wrap_atk_text_get_text_before_offset(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "offset", "boundary_type", NULL };
- gchar *text;
- gint start, end, offset;
- AtkTextBoundary boundary;
- PyObject *py_boundary;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iO:atk.Text.get_text_before_offset",
- kwlist, &offset, &py_boundary))
- return NULL;
-
- if (pyg_enum_get_value(ATK_TYPE_TEXT_BOUNDARY, py_boundary,
- (gpointer)&boundary))
- return NULL;
-
- text = atk_text_get_text_before_offset(ATK_TEXT(self->obj),
- offset, boundary, &start, &end);
- return Py_BuildValue("(s#ii)", text, (Py_ssize_t) (end - start), start, end);
-}
-%%
-override atk_text_get_character_extents kwargs
-static PyObject *
-_wrap_atk_text_get_character_extents(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "offset", "coords", NULL };
- gint offset, x, y, width, height;
- AtkCoordType coords;
- PyObject *py_coords;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iO:atk.Text.get_character_extents",
- kwlist, &offset, &py_coords))
- return NULL;
-
- if (pyg_enum_get_value(ATK_TYPE_COORD_TYPE, py_coords,
- (gpointer)&coords))
- return NULL;
-
- atk_text_get_character_extents(ATK_TEXT(self->obj), offset,
- &x, &y, &width, &height, coords);
- return Py_BuildValue("(iiii)", x, y, width, height);
-}
-%%
-override atk_text_get_run_attributes kwargs
-static PyObject *
-_wrap_atk_text_get_run_attributes(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "offset", NULL };
- gint offset, start, end;
- AtkAttributeSet *attribs;
- PyObject *py_attribs;
- gint count, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iO:atk.Text.get_run_attributes",
- kwlist, &offset))
- return NULL;
-
- attribs = atk_text_get_run_attributes(ATK_TEXT(self->obj), offset,
- &start, &end);
- count = g_slist_length(attribs);
- py_attribs = PyTuple_New(count);
- for (i = 0; i < count; i++) {
- AtkAttribute *attr = g_slist_nth_data(attribs, i);
- PyTuple_SetItem(py_attribs, i, Py_BuildValue("(ss)", attr->name,
- attr->value));
- }
- atk_attribute_set_free(attribs);
- return Py_BuildValue("(Nii)", py_attribs, start, end);
-}
-%%
-override atk_text_get_default_attributes noargs
-static PyObject *
-_wrap_atk_text_get_default_attributes(PyGObject *self)
-{
- AtkAttributeSet *attribs;
- PyObject *py_attribs;
- gint count, i;
-
- attribs = atk_text_get_default_attributes(ATK_TEXT(self->obj));
- count = g_slist_length(attribs);
- py_attribs = PyTuple_New(count);
- for (i = 0; i < count; i++) {
- AtkAttribute *attr = g_slist_nth_data(attribs, i);
- PyTuple_SetItem(py_attribs, i, Py_BuildValue("(ss)", attr->name,
- attr->value));
- }
- atk_attribute_set_free(attribs);
- return py_attribs;
-}
-%%
-override atk_text_get_bounded_ranges kwargs
-static PyObject *
-_wrap_atk_text_get_bounded_ranges(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "rect", "coord_type", "x_clip_type",
- "y_clip_type", NULL };
- AtkRectangle rect;
- AtkCoordType coord;
- AtkTextClipType x_clip, y_clip;
- AtkTextRange **ranges, *range;
- PyObject *py_rect, *py_coord, *py_x_clip, *py_y_clip, *py_ranges;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOOO:atk.Text.get_bounded_ranges",
- kwlist, &py_rect, &py_coord, &py_x_clip,
- &py_y_clip))
- return NULL;
-
- if (pyatk_rectangle_from_pyobject(py_rect, &rect))
- return NULL;
- if (pyg_enum_get_value(ATK_TYPE_COORD_TYPE, py_coord, (gpointer)&coord))
- return NULL;
- if (pyg_enum_get_value(ATK_TYPE_TEXT_CLIP_TYPE, py_x_clip,
- (gpointer)&x_clip))
- return NULL;
- if (pyg_enum_get_value(ATK_TYPE_TEXT_CLIP_TYPE, py_y_clip,
- (gpointer)&y_clip))
- return NULL;
-
- ranges = atk_text_get_bounded_ranges(ATK_TEXT(self->obj),
- (AtkTextRectangle*)&rect, coord,
- x_clip, y_clip);
- py_ranges = PyList_New(0);
- while ((range = *ranges++)) {
- PyObject *py_range;
- py_rect = pyg_boxed_new(ATK_TYPE_RECTANGLE,
- (AtkRectangle*)&range->bounds, TRUE, TRUE);
- py_range = Py_BuildValue("(Niis)", py_rect, range->start_offset,
- range->end_offset, range->content);
- PyList_Append(py_ranges, py_range);
- Py_DECREF(py_range);
- }
- atk_text_free_ranges(ranges);
-
- return py_ranges;
-}
-%%
-override atk_text_get_selection kwargs
-static PyObject *
-_wrap_atk_text_get_selection(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "selection_num", NULL };
- gchar *text;
- gint start, end, selection_num;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iO:atk.Text.get_selection",
- kwlist, &selection_num))
- return NULL;
-
- text = atk_text_get_selection(ATK_TEXT(self->obj),
- selection_num, &start, &end);
- return Py_BuildValue("(s#ii)", text, (Py_ssize_t) (end - start), start, end);
-}
-%%
-override atk_text_get_range_extents kwargs
-static PyObject *
-_wrap_atk_text_get_range_extents(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "start_offset", "end_offset", "coord_type",
- NULL };
- gint start, end;
- AtkCoordType coord;
- AtkTextRectangle rect;
- PyObject *py_coord;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iiO:atk.Text.get_range_extents",
- kwlist, &start, &end, &py_coord))
- return NULL;
-
- if (pyg_enum_get_value(ATK_TYPE_COORD_TYPE, py_coord,
- (gpointer)&coord))
- return NULL;
-
- atk_text_get_range_extents(ATK_TEXT(self->obj), start, end, coord, &rect);
- return pyg_boxed_new(ATK_TYPE_RECTANGLE, (AtkRectangle*)&rect, TRUE, TRUE);
-}
-%%
-override atk_value_get_current_value noargs
-static PyObject *
-_wrap_atk_value_get_current_value(PyGObject *self)
-{
- GValue value = { 0, };
- PyObject *ret;
-
- atk_value_get_current_value(ATK_VALUE(self->obj), &value);
- ret = pyg_value_as_pyobject(&value, TRUE);
- g_value_unset(&value);
- return ret;
-}
-%%
-override atk_value_get_maximum_value noargs
-static PyObject *
-_wrap_atk_value_get_maximum_value(PyGObject *self)
-{
- GValue value = { 0, };
- PyObject *ret;
-
- atk_value_get_maximum_value(ATK_VALUE(self->obj), &value);
- ret = pyg_value_as_pyobject(&value, TRUE);
- g_value_unset(&value);
- return ret;
-}
-%%
-override atk_value_get_minimum_value noargs
-static PyObject *
-_wrap_atk_value_get_minimum_value(PyGObject *self)
-{
- GValue value = { 0, };
- PyObject *ret;
-
- atk_value_get_minimum_value(ATK_VALUE(self->obj), &value);
- ret = pyg_value_as_pyobject(&value, TRUE);
- g_value_unset(&value);
- return ret;
-}
-%%
-override atk_value_set_current_value kwargs
-static PyObject *
-_wrap_atk_value_set_current_value(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "value", NULL };
- GValue value = { 0, };
- PyObject *ret, *py_value;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:atk.Value.set_current_value",
- kwlist, &py_value))
- return NULL;
-
- if (pyg_value_from_pyobject(&value, py_value)) {
- PyErr_SetString(PyExc_TypeError, "unable to convert value");
- return NULL;
- }
-
- if (atk_value_set_current_value(ATK_VALUE(self->obj), &value))
- ret = Py_True;
- else
- ret = Py_False;
-
- g_value_unset(&value);
- Py_INCREF(ret);
- return ret;
-}
diff --git a/atkmodule.c b/atkmodule.c
deleted file mode 100644
index 91c447a9..00000000
--- a/atkmodule.c
+++ /dev/null
@@ -1,48 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * atkmodule.c: module wrapping the ATK library.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
-/* include this first, before NO_IMPORT_PYGOBJECT is defined */
-#include <pygobject.h>
-
-void pyatk_register_classes (PyObject *d);
-void pyatk_add_constants(PyObject *module, const gchar *strip_prefix);
-void _pyatk_register_boxed_types(void);
-
-extern PyMethodDef pyatk_functions[];
-
-DL_EXPORT(void)
-initatk(void)
-{
- PyObject *m, *d;
-
- init_pygobject ();
-
- m = Py_InitModule ("atk", pyatk_functions);
- d = PyModule_GetDict (m);
- _pyatk_register_boxed_types();
- pyatk_register_classes (d);
- pyatk_add_constants(m, "ATK_");
-}
diff --git a/atkrectangle.override b/atkrectangle.override
deleted file mode 100644
index 4b2c01ae..00000000
--- a/atkrectangle.override
+++ /dev/null
@@ -1,265 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 2006 John Finlay
- *
- * atkrectangle.override: atk.Rectangle overrides
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-headers
-
-static gboolean
-pyatk_rectangle_from_pyobject(PyObject *object, AtkRectangle *rectangle)
-{
- g_return_val_if_fail(rectangle != NULL, FALSE);
-
- if (pyg_boxed_check(object, ATK_TYPE_RECTANGLE)) {
- *rectangle = *pyg_boxed_get(object, AtkRectangle);
- return TRUE;
- }
- if (PyArg_ParseTuple(object, "iiii", &rectangle->x, &rectangle->y,
- &rectangle->width, &rectangle->height)) {
- return TRUE;
- }
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError, "could not convert to AtkRectangle");
- return FALSE;
-}
-
-static PyObject *
-PyAtkRectangle_from_value(const GValue *value)
-{
- AtkRectangle *rect = (AtkRectangle *)g_value_get_boxed(value);
-
- return pyg_boxed_new(ATK_TYPE_RECTANGLE, rect, TRUE, TRUE);
-}
-static int
-PyAtkRectangle_to_value(GValue *value, PyObject *object)
-{
- AtkRectangle rect;
-
- if (!pyatk_rectangle_from_pyobject(object, &rect))
- return -1;
-
- g_value_set_boxed(value, &rect);
- return 0;
-}
-
-void
-_pyatk_register_boxed_types(void)
-{
- pyg_register_boxed_custom(ATK_TYPE_RECTANGLE,
- PyAtkRectangle_from_value,
- PyAtkRectangle_to_value);
-}
-%%
-override atk_rectangle_new kwargs
-static int
-_wrap_atk_rectangle_new(PyGBoxed *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "x", "y", "width", "height", NULL };
- AtkRectangle rect = {0, 0, 0, 0};
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|iiii:AtkRectangle.__init__",
- kwlist, &(rect.x), &(rect.y),
- &(rect.width), &(rect.height)))
- return -1;
-
- self->boxed = g_boxed_copy(ATK_TYPE_RECTANGLE, &rect);
- self->free_on_dealloc = TRUE;
- self->gtype = ATK_TYPE_RECTANGLE;
-
- return 0;
-}
-%%
-override-slot AtkRectangle.tp_as_sequence
-static Py_ssize_t
-_wrap_atk_rectangle_length(PyGBoxed *self)
-{
- return 4;
-}
-static PyObject *
-_wrap_atk_rectangle_getitem(PyGBoxed *self, Py_ssize_t pos)
-{
- AtkRectangle *rect;
-
- if (pos < 0) pos += 4;
- if (pos < 0 || pos >= 4) {
- PyErr_SetString(PyExc_IndexError, "index out of range");
- return NULL;
- }
- rect = pyg_boxed_get(self, AtkRectangle);
- switch (pos) {
- case 0: return PyInt_FromLong(rect->x);
- case 1: return PyInt_FromLong(rect->y);
- case 2: return PyInt_FromLong(rect->width);
- case 3: return PyInt_FromLong(rect->height);
- default:
- g_assert_not_reached();
- return NULL;
- }
-}
-static int
-_wrap_atk_rectangle_setitem(PyGBoxed *self, Py_ssize_t pos, PyObject *value)
-{
- AtkRectangle *rect;
- gint val;
-
- if (pos < 0) pos += 4;
- if (pos < 0 || pos >= 4) {
- PyErr_SetString(PyExc_IndexError, "index out of range");
- return -1;
- }
- rect = pyg_boxed_get(self, AtkRectangle);
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- switch(pos) {
- case 0: rect->x = val; break;
- case 1: rect->y = val; break;
- case 2: rect->width = val; break;
- case 3: rect->height = val; break;
- default:
- g_assert_not_reached();
- return -1;
- }
- return 0;
-}
-static PySequenceMethods _wrap_atk_rectangle_tp_as_sequence = {
- (lenfunc)_wrap_atk_rectangle_length, /* sq_length */
- 0, /* sq_concat */
- 0, /* sq_repeat */
- (ssizeargfunc)_wrap_atk_rectangle_getitem, /* sq_item */
- 0, /* sq_slice */
- (ssizeobjargproc)_wrap_atk_rectangle_setitem, /* sq_ass_item */
- 0, /* sq_contains */
- 0, /* sq_inplace_concat */
- 0 /* sq_inplace_repeat */
-};
-%%
-override-attr AtkRectangle.x
-static int
-_wrap_atk_rectangle__set_x(PyGBoxed *self, PyObject *value, void *closure)
-{
- gint val;
-
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- pyg_boxed_get(self, AtkRectangle)->x = val;
- return 0;
-}
-%%
-override-attr AtkRectangle.y
-static int
-_wrap_atk_rectangle__set_y(PyGBoxed *self, PyObject *value, void *closure)
-{
- gint val;
-
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- pyg_boxed_get(self, AtkRectangle)->y = val;
- return 0;
-}
-%%
-override-attr AtkRectangle.width
-static int
-_wrap_atk_rectangle__set_width(PyGBoxed *self, PyObject *value, void *closure)
-{
- gint val;
-
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- pyg_boxed_get(self, AtkRectangle)->width = val;
- return 0;
-}
-%%
-override-attr AtkRectangle.height
-static int
-_wrap_atk_rectangle__set_height(PyGBoxed *self, PyObject *value, void *closure)
-{
- gint val;
-
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- pyg_boxed_get(self, AtkRectangle)->height = val;
- return 0;
-}
-%%
-override atk_rectangle_intersect kwargs
-static PyObject *
-_wrap_atk_rectangle_intersect(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "src", NULL };
- PyObject *py_src;
- AtkRectangle src, dest = {0, 0, 0, 0};
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:AtkRectangle.intersect",
- kwlist, &py_src)) {
- return NULL;
- }
-
- if (!pyg_boxed_check(py_src, ATK_TYPE_RECTANGLE)) {
- if (!pyatk_rectangle_from_pyobject(py_src, &src)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "src must be a AtkRectangle or 4-tuple");
- return NULL;
- }
- } else {
- src = *pyg_boxed_get(py_src, AtkRectangle);
- }
-
- atk_rectangle_intersect(pyg_boxed_get(self, AtkRectangle), &src, &dest);
-
- return pyg_boxed_new(ATK_TYPE_RECTANGLE, &dest, TRUE, TRUE);
-}
-%%
-override atk_rectangle_union kwargs
-static PyObject *
-_wrap_atk_rectangle_union(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "src", NULL };
- PyObject *py_src;
- AtkRectangle src, dest;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:AtkRectangle.union",
- kwlist, &py_src)) {
- return NULL;
- }
-
- if (!pyg_boxed_check(py_src, ATK_TYPE_RECTANGLE)) {
- if (!pyatk_rectangle_from_pyobject(py_src, &src)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "src must be a AtkRectangle or 4-tuple");
- return NULL;
- }
- } else {
- src = *pyg_boxed_get(py_src, AtkRectangle);
- }
-
- atk_rectangle_union(pyg_boxed_get(self, AtkRectangle), &src, &dest);
-
- return pyg_boxed_new(ATK_TYPE_RECTANGLE, &dest, TRUE, TRUE);
-}
diff --git a/autogen.sh b/autogen.sh
deleted file mode 100755
index 51ae4903..00000000
--- a/autogen.sh
+++ /dev/null
@@ -1,477 +0,0 @@
-#!/bin/sh
-# Run this to generate all the initial makefiles, etc.
-
-srcdir=`dirname $0`
-test -z "$srcdir" && srcdir=.
-
-REQUIRED_AUTOMAKE_VERSION=1.8
-
-PKG_NAME="PyGTK"
-ACLOCAL_FLAGS="-I `pwd`/m4 $ACLOCAL_FLAGS"
-
-#name of package
-PKG_NAME=${PKG_NAME:-Package}
-srcdir=${srcdir:-.}
-
-# default version requirements ...
-REQUIRED_AUTOCONF_VERSION=${REQUIRED_AUTOCONF_VERSION:-2.53}
-REQUIRED_AUTOMAKE_VERSION=${REQUIRED_AUTOMAKE_VERSION:-1.4}
-REQUIRED_LIBTOOL_VERSION=${REQUIRED_LIBTOOL_VERSION:-1.4.3}
-REQUIRED_GETTEXT_VERSION=${REQUIRED_GETTEXT_VERSION:-0.10.40}
-REQUIRED_GLIB_GETTEXT_VERSION=${REQUIRED_GLIB_GETTEXT_VERSION:-2.2.0}
-REQUIRED_INTLTOOL_VERSION=${REQUIRED_INTLTOOL_VERSION:-0.25}
-REQUIRED_PKG_CONFIG_VERSION=${REQUIRED_PKG_CONFIG_VERSION:-0.14.0}
-REQUIRED_GTK_DOC_VERSION=${REQUIRED_GTK_DOC_VERSION:-1.0}
-REQUIRED_DOC_COMMON_VERSION=${REQUIRED_DOC_COMMON_VERSION:-2.3.0}
-REQUIRED_GNOME_DOC_UTILS_VERSION=${REQUIRED_GNOME_DOC_UTILS_VERSION:-0.3.2}
-
-# a list of required m4 macros. Package can set an initial value
-REQUIRED_M4MACROS=${REQUIRED_M4MACROS:-}
-FORBIDDEN_M4MACROS=${FORBIDDEN_M4MACROS:-}
-
-# Not all echo versions allow -n, so we check what is possible. This test is
-# based on the one in autoconf.
-case `echo "testing\c"; echo 1,2,3`,`echo -n testing; echo 1,2,3` in
- *c*,-n*) ECHO_N= ;;
- *c*,* ) ECHO_N=-n ;;
- *) ECHO_N= ;;
-esac
-
-# some terminal codes ...
-boldface="`tput bold 2>/dev/null`"
-normal="`tput sgr0 2>/dev/null`"
-printbold() {
- echo $ECHO_N "$boldface"
- echo "$@"
- echo $ECHO_N "$normal"
-}
-printerr() {
- echo "$@" >&2
-}
-
-# Usage:
-# compare_versions MIN_VERSION ACTUAL_VERSION
-# returns true if ACTUAL_VERSION >= MIN_VERSION
-compare_versions() {
- ch_min_version=$1
- ch_actual_version=$2
- ch_status=0
- IFS="${IFS= }"; ch_save_IFS="$IFS"; IFS="."
- set $ch_actual_version
- for ch_min in $ch_min_version; do
- ch_cur=`echo $1 | sed 's/[^0-9].*$//'`; shift # remove letter suffixes
- if [ -z "$ch_min" ]; then break; fi
- if [ -z "$ch_cur" ]; then ch_status=1; break; fi
- if [ $ch_cur -gt $ch_min ]; then break; fi
- if [ $ch_cur -lt $ch_min ]; then ch_status=1; break; fi
- done
- IFS="$ch_save_IFS"
- return $ch_status
-}
-
-# Usage:
-# version_check PACKAGE VARIABLE CHECKPROGS MIN_VERSION SOURCE
-# checks to see if the package is available
-version_check() {
- vc_package=$1
- vc_variable=$2
- vc_checkprogs=$3
- vc_min_version=$4
- vc_source=$5
- vc_status=1
-
- vc_checkprog=`eval echo "\\$$vc_variable"`
- if [ -n "$vc_checkprog" ]; then
- printbold "using $vc_checkprog for $vc_package"
- return 0
- fi
-
- if test "x$vc_package" = "xautomake" -a "x$vc_min_version" = "x1.4"; then
- vc_comparator="="
- else
- vc_comparator=">="
- fi
- printbold "checking for $vc_package $vc_comparator $vc_min_version..."
- for vc_checkprog in $vc_checkprogs; do
- echo $ECHO_N " testing $vc_checkprog... "
- if $vc_checkprog --version < /dev/null > /dev/null 2>&1; then
- vc_actual_version=`$vc_checkprog --version | head -n 1 | \
- sed 's/^.*[ ]\([0-9.]*[a-z]*\).*$/\1/'`
- if compare_versions $vc_min_version $vc_actual_version; then
- echo "found $vc_actual_version"
- # set variables
- eval "$vc_variable=$vc_checkprog; \
- ${vc_variable}_VERSION=$vc_actual_version"
- vc_status=0
- break
- else
- echo "too old (found version $vc_actual_version)"
- fi
- else
- echo "not found."
- fi
- done
- if [ "$vc_status" != 0 ]; then
- printerr "***Error***: You must have $vc_package $vc_comparator $vc_min_version installed"
- printerr " to build $PKG_NAME. Download the appropriate package for"
- printerr " from your distribution or get the source tarball at"
- printerr " $vc_source"
- printerr
- fi
- return $vc_status
-}
-
-# Usage:
-# require_m4macro filename.m4
-# adds filename.m4 to the list of required macros
-require_m4macro() {
- case "$REQUIRED_M4MACROS" in
- $1\ * | *\ $1\ * | *\ $1) ;;
- *) REQUIRED_M4MACROS="$REQUIRED_M4MACROS $1" ;;
- esac
-}
-
-forbid_m4macro() {
- case "$FORBIDDEN_M4MACROS" in
- $1\ * | *\ $1\ * | *\ $1) ;;
- *) FORBIDDEN_M4MACROS="$FORBIDDEN_M4MACROS $1" ;;
- esac
-}
-
-# Usage:
-# add_to_cm_macrodirs dirname
-# Adds the dir to $cm_macrodirs, if it's not there yet.
-add_to_cm_macrodirs() {
- case $cm_macrodirs in
- "$1 "* | *" $1 "* | *" $1") ;;
- *) cm_macrodirs="$cm_macrodirs $1";;
- esac
-}
-
-# Usage:
-# check_m4macros
-# Checks that all the requested macro files are in the aclocal macro path
-# Uses REQUIRED_M4MACROS and ACLOCAL variables.
-check_m4macros() {
- # construct list of macro directories
- cm_macrodirs=`$ACLOCAL --print-ac-dir`
- # aclocal also searches a version specific dir, eg. /usr/share/aclocal-1.9
- # but it contains only Automake's own macros, so we can ignore it.
-
- # Read the dirlist file, supported by Automake >= 1.7.
- if compare_versions 1.7 $AUTOMAKE_VERSION && [ -s $cm_macrodirs/dirlist ]; then
- cm_dirlist=`sed 's/[ ]*#.*//;/^$/d' $cm_macrodirs/dirlist`
- if [ -n "$cm_dirlist" ] ; then
- for cm_dir in $cm_dirlist; do
- if [ -d $cm_dir ]; then
- add_to_cm_macrodirs $cm_dir
- fi
- done
- fi
- fi
-
- # Parse $ACLOCAL_FLAGS
- set - $ACLOCAL_FLAGS
- while [ $# -gt 0 ]; do
- if [ "$1" = "-I" ]; then
- add_to_cm_macrodirs "$2"
- shift
- fi
- shift
- done
-
- cm_status=0
- if [ -n "$REQUIRED_M4MACROS" ]; then
- printbold "Checking for required M4 macros..."
- # check that each macro file is in one of the macro dirs
- for cm_macro in $REQUIRED_M4MACROS; do
- cm_macrofound=false
- for cm_dir in $cm_macrodirs; do
- if [ -f "$cm_dir/$cm_macro" ]; then
- cm_macrofound=true
- break
- fi
- # The macro dir in Cygwin environments may contain a file
- # called dirlist containing other directories to look in.
- if [ -f "$cm_dir/dirlist" ]; then
- for cm_otherdir in `cat $cm_dir/dirlist`; do
- if [ -f "$cm_otherdir/$cm_macro" ]; then
- cm_macrofound=true
- break
- fi
- done
- fi
- done
- if $cm_macrofound; then
- :
- else
- printerr " $cm_macro not found"
- cm_status=1
- fi
- done
- fi
- if [ -n "$FORBIDDEN_M4MACROS" ]; then
- printbold "Checking for forbidden M4 macros..."
- # check that each macro file is in one of the macro dirs
- for cm_macro in $FORBIDDEN_M4MACROS; do
- cm_macrofound=false
- for cm_dir in $cm_macrodirs; do
- if [ -f "$cm_dir/$cm_macro" ]; then
- cm_macrofound=true
- break
- fi
- done
- if $cm_macrofound; then
- printerr " $cm_macro found (should be cleared from macros dir)"
- cm_status=1
- fi
- done
- fi
- if [ "$cm_status" != 0 ]; then
- printerr "***Error***: some autoconf macros required to build $PKG_NAME"
- printerr " were not found in your aclocal path, or some forbidden"
- printerr " macros were found. Perhaps you need to adjust your"
- printerr " ACLOCAL_FLAGS?"
- printerr
- fi
- return $cm_status
-}
-
-# try to catch the case where the macros2/ directory hasn't been cleared out.
-forbid_m4macro gnome-cxx-check.m4
-
-want_libtool=false
-want_gettext=false
-want_glib_gettext=false
-want_intltool=false
-want_pkg_config=false
-want_gtk_doc=false
-want_gnome_doc_utils=false
-
-configure_files="`find $srcdir -name '{arch}' -prune -o -name configure.ac -print -o -name configure.in -print`"
-for configure_ac in $configure_files; do
- if grep "^A[CM]_PROG_LIBTOOL" $configure_ac >/dev/null ||
- grep "^LT_INIT" $configure_ac >/dev/null; then
- want_libtool=true
- fi
- if grep "^AM_GNU_GETTEXT" $configure_ac >/dev/null; then
- want_gettext=true
- fi
- if grep "^AM_GLIB_GNU_GETTEXT" $configure_ac >/dev/null; then
- want_glib_gettext=true
- fi
- if grep "^AC_PROG_INTLTOOL" $configure_ac >/dev/null ||
- grep "^IT_PROG_INTLTOOL" $configure_ac >/dev/null; then
- want_intltool=true
- fi
- if grep "^PKG_CHECK_MODULES" $configure_ac >/dev/null; then
- want_pkg_config=true
- fi
- if grep "^GTK_DOC_CHECK" $configure_ac >/dev/null; then
- want_gtk_doc=true
- fi
- if grep "^GNOME_DOC_INIT" $configure_ac >/dev/null; then
- want_gnome_doc_utils=true
- fi
-
- # check to make sure gnome-common macros can be found ...
- if grep "^GNOME_COMMON_INIT" $configure_ac >/dev/null ||
- grep "^GNOME_DEBUG_CHECK" $configure_ac >/dev/null ||
- grep "^GNOME_MAINTAINER_MODE_DEFINES" $configure_ac >/dev/null; then
- require_m4macro gnome-common.m4
- fi
- if grep "^GNOME_COMPILE_WARNINGS" $configure_ac >/dev/null ||
- grep "^GNOME_CXX_WARNINGS" $configure_ac >/dev/null; then
- require_m4macro gnome-compiler-flags.m4
- fi
-done
-
-DIE=0
-
-#tell Mandrake autoconf wrapper we want autoconf 2.5x, not 2.13
-WANT_AUTOCONF_2_5=1
-export WANT_AUTOCONF_2_5
-version_check autoconf AUTOCONF 'autoconf2.50 autoconf autoconf-2.53' $REQUIRED_AUTOCONF_VERSION \
- "http://ftp.gnu.org/pub/gnu/autoconf/autoconf-$REQUIRED_AUTOCONF_VERSION.tar.gz" || DIE=1
-AUTOHEADER=`echo $AUTOCONF | sed s/autoconf/autoheader/`
-
-case $REQUIRED_AUTOMAKE_VERSION in
- 1.4*) automake_progs="automake-1.4" ;;
- 1.5*) automake_progs="automake-1.5 automake-1.6 automake-1.7 automake-1.8 automake-1.9 automake-1.10" ;;
- 1.6*) automake_progs="automake-1.6 automake-1.7 automake-1.8 automake-1.9 automake-1.10" ;;
- 1.7*) automake_progs="automake-1.7 automake-1.8 automake-1.9 automake-1.10" ;;
- 1.8*) automake_progs="automake-1.8 automake-1.9 automake-1.10" ;;
- 1.9*) automake_progs="automake-1.9 automake-1-10" ;;
- 1.10*) automake_progs="automake-1.10" ;;
-esac
-version_check automake AUTOMAKE "$automake_progs" $REQUIRED_AUTOMAKE_VERSION \
- "http://ftp.gnu.org/pub/gnu/automake/automake-$REQUIRED_AUTOMAKE_VERSION.tar.gz" || DIE=1
-ACLOCAL=`echo $AUTOMAKE | sed s/automake/aclocal/`
-
-if $want_libtool; then
- version_check libtool LIBTOOLIZE libtoolize $REQUIRED_LIBTOOL_VERSION \
- "http://ftp.gnu.org/pub/gnu/libtool/libtool-$REQUIRED_LIBTOOL_VERSION.tar.gz" || DIE=1
- require_m4macro libtool.m4
-fi
-
-if $want_gettext; then
- version_check gettext GETTEXTIZE gettextize $REQUIRED_GETTEXT_VERSION \
- "http://ftp.gnu.org/pub/gnu/gettext/gettext-$REQUIRED_GETTEXT_VERSION.tar.gz" || DIE=1
- require_m4macro gettext.m4
-fi
-
-if $want_glib_gettext; then
- version_check glib-gettext GLIB_GETTEXTIZE glib-gettextize $REQUIRED_GLIB_GETTEXT_VERSION \
- "ftp://ftp.gtk.org/pub/gtk/v2.2/glib-$REQUIRED_GLIB_GETTEXT_VERSION.tar.gz" || DIE=1
- require_m4macro glib-gettext.m4
-fi
-
-if $want_intltool; then
- version_check intltool INTLTOOLIZE intltoolize $REQUIRED_INTLTOOL_VERSION \
- "http://ftp.gnome.org/pub/GNOME/sources/intltool/" || DIE=1
- require_m4macro intltool.m4
-fi
-
-if $want_pkg_config; then
- version_check pkg-config PKG_CONFIG pkg-config $REQUIRED_PKG_CONFIG_VERSION \
- "'http://www.freedesktop.org/software/pkgconfig/releases/pkgconfig-$REQUIRED_PKG_CONFIG_VERSION.tar.gz" || DIE=1
- require_m4macro pkg.m4
-fi
-
-if $want_gtk_doc; then
- version_check gtk-doc GTKDOCIZE gtkdocize $REQUIRED_GTK_DOC_VERSION \
- "http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/" || DIE=1
- require_m4macro gtk-doc.m4
-fi
-
-if $want_gnome_doc_utils; then
- version_check gnome-doc-utils GNOME_DOC_PREPARE gnome-doc-prepare $REQUIRED_GNOME_DOC_UTILS_VERSION \
- "http://ftp.gnome.org/pub/GNOME/sources/gnome-doc-utils/" || DIE=1
-fi
-
-if [ "x$USE_COMMON_DOC_BUILD" = "xyes" ]; then
- version_check gnome-common DOC_COMMON gnome-doc-common \
- $REQUIRED_DOC_COMMON_VERSION " " || DIE=1
-fi
-
-check_m4macros || DIE=1
-
-if [ "$DIE" -eq 1 ]; then
- exit 1
-fi
-
-if [ "$#" = 0 ]; then
- printerr "**Warning**: I am going to run \`configure' with no arguments."
- printerr "If you wish to pass any to it, please specify them on the"
- printerr \`$0\'" command line."
- printerr
-fi
-
-topdir=`pwd`
-for configure_ac in $configure_files; do
- dirname=`dirname $configure_ac`
- basename=`basename $configure_ac`
- if [ -f $dirname/NO-AUTO-GEN ]; then
- echo skipping $dirname -- flagged as no auto-gen
- elif [ ! -w $dirname ]; then
- echo skipping $dirname -- directory is read only
- else
- printbold "Processing $configure_ac"
- cd $dirname
-
- # Note that the order these tools are called should match what
- # autoconf's "autoupdate" package does. See bug 138584 for
- # details.
-
- # programs that might install new macros get run before aclocal
- if grep "^A[CM]_PROG_LIBTOOL" $basename >/dev/null ||
- grep "^LT_INIT" $basename >/dev/null; then
- printbold "Running $LIBTOOLIZE..."
- $LIBTOOLIZE --force --copy || exit 1
- fi
-
- if grep "^AM_GLIB_GNU_GETTEXT" $basename >/dev/null; then
- printbold "Running $GLIB_GETTEXTIZE... Ignore non-fatal messages."
- echo "no" | $GLIB_GETTEXTIZE --force --copy || exit 1
- elif grep "^AM_GNU_GETTEXT" $basename >/dev/null; then
- if grep "^AM_GNU_GETTEXT_VERSION" $basename > /dev/null; then
- printbold "Running autopoint..."
- autopoint --force || exit 1
- else
- printbold "Running $GETTEXTIZE... Ignore non-fatal messages."
- echo "no" | $GETTEXTIZE --force --copy || exit 1
- fi
- fi
-
- if grep "^AC_PROG_INTLTOOL" $basename >/dev/null ||
- grep "^IT_PROG_INTLTOOL" $basename >/dev/null; then
- printbold "Running $INTLTOOLIZE..."
- $INTLTOOLIZE --force --copy --automake || exit 1
- fi
- if grep "^GTK_DOC_CHECK" $basename >/dev/null; then
- printbold "Running $GTKDOCIZE..."
- $GTKDOCIZE --copy || exit 1
- fi
-
- if [ "x$USE_COMMON_DOC_BUILD" = "xyes" ]; then
- printbold "Running gnome-doc-common..."
- gnome-doc-common --copy || exit 1
- fi
- if grep "^GNOME_DOC_INIT" $basename >/dev/null; then
- printbold "Running $GNOME_DOC_PREPARE..."
- $GNOME_DOC_PREPARE --force --copy || exit 1
- fi
-
- # Now run aclocal to pull in any additional macros needed
-
- # if the AC_CONFIG_MACRO_DIR() macro is used, pass that
- # directory to aclocal.
- m4dir=`cat "$basename" | grep '^AC_CONFIG_MACRO_DIR' | sed -n -e 's/AC_CONFIG_MACRO_DIR(\([^()]*\))/\1/p' | sed -e 's/^\[\(.*\)\]$/\1/' | sed -e 1q`
- if [ -n "$m4dir" ]; then
- m4dir="-I $m4dir"
- fi
- printbold "Running $ACLOCAL..."
- $ACLOCAL $m4dir $ACLOCAL_FLAGS || exit 1
-
- if grep "GNOME_AUTOGEN_OBSOLETE" aclocal.m4 >/dev/null; then
- printerr "*** obsolete gnome macros were used in $configure_ac"
- fi
-
- # Now that all the macros are sorted, run autoconf and autoheader ...
- printbold "Running $AUTOCONF..."
- $AUTOCONF || exit 1
- if grep "^A[CM]_CONFIG_HEADER" $basename >/dev/null; then
- printbold "Running $AUTOHEADER..."
- $AUTOHEADER || exit 1
- # this prevents automake from thinking config.h.in is out of
- # date, since autoheader doesn't touch the file if it doesn't
- # change.
- test -f config.h.in && touch config.h.in
- fi
-
- # Finally, run automake to create the makefiles ...
- printbold "Running $AUTOMAKE..."
- cp -pf COPYING COPYING.autogen_bak
- cp -pf INSTALL INSTALL.autogen_bak
- if [ $REQUIRED_AUTOMAKE_VERSION != 1.4 ]; then
- $AUTOMAKE --gnu --add-missing --force --copy || exit 1
- else
- $AUTOMAKE --gnu --add-missing --copy || exit 1
- fi
- cmp COPYING COPYING.autogen_bak || cp -pf COPYING.autogen_bak COPYING
- cmp INSTALL INSTALL.autogen_bak || cp -pf INSTALL.autogen_bak INSTALL
- rm -f COPYING.autogen_bak INSTALL.autogen_bak
-
- cd "$topdir"
- fi
-done
-
-conf_flags="--enable-maintainer-mode"
-
-if test x$NOCONFIGURE = x; then
- printbold Running $srcdir/configure $conf_flags "$@" ...
- $srcdir/configure $conf_flags "$@" \
- && echo Now type \`make\' to compile $PKG_NAME || exit 1
-else
- echo Skipping configure process.
-fi
diff --git a/codegen/Makefile.am b/codegen/Makefile.am
deleted file mode 100644
index 350b1369..00000000
--- a/codegen/Makefile.am
+++ /dev/null
@@ -1,23 +0,0 @@
-PLATFORM_VERSION = 2.0
-
-bin_SCRIPTS = pygtk-codegen-$(PLATFORM_VERSION)
-
-codegendir = $(pkgdatadir)/$(PLATFORM_VERSION)/codegen
-
-codegen_PYTHON = \
- __init__.py \
- argtypes.py \
- reversewrapper.py \
- codegen.py \
- definitions.py \
- defsparser.py \
- docextract.py \
- docgen.py \
- h2def.py \
- createdefs.py \
- mergedefs.py \
- mkskel.py \
- override.py \
- scmexpr.py
-
-EXTRA_DIST = README.defs pygtk-codegen-$(PLATFORM_VERSION).in
diff --git a/codegen/README.defs b/codegen/README.defs
deleted file mode 100644
index 5f7957ef..00000000
--- a/codegen/README.defs
+++ /dev/null
@@ -1,351 +0,0 @@
- ChangeLog for this draft:
- - caller-owns-return attribute on functions/methods
- - include gtk-type-id in the type alias system
- - c-name for types converted to in-c-name out-c-name inout-c-name
- - merge unref-func and destroy-func for boxed types into release-func
-
- - split structs out of boxed types
- - c-declaration field
- - special "native" type alias; bail and use C declaration when
- necessary
- - defined objects and boxeds automatically create a module
- - make constructors functions and not methods, in appropriate
- object/boxed module
-
- Draft =========================
-
- The overall syntax is:
-
- (type-of-thing-being-defined name-used-to-refer-to-this-thing
- (attribute-name attribute-value-depending-on-the-attribute)
- (attribute-name attribute-value-depending-on-the-attribute)
- (attribute-name attribute-value-depending-on-the-attribute))
-
- Some definitions can have a c-declaration field that gives the C code
- we parsed to arrive at the definition. The c-declaration is a quoted
- string because it can contain parentheses and such.
-
- Defined types and their attributes:
-
- ===
- (module module-name
- (submodule-of module-name)) ;; submodule is optional
-
- Ex: (module Gtk)
- Ex: (module Rgb
- (submodule-of Gdk))
-
- modules are later referred to with a list of module names, like
- (Gdk Rgb) or (Gtk)
-
- Object and boxed type definitions automatically create a submodule.
- For example, GtkCList creates the module (module CList (submodule-of
- (Gtk))) which is referred to as module (Gtk CList).
-
- ===
-
- (type
- (alias some-unique-identifier)
- (in-module module-name) ;; optional, gchar* is not in a module
- (gtk-type-id gtk-type-system-id) ;; optional, absent if this is not
- ;; in the type system
- (in-c-name name-of-symbol-in-C)
- (out-c-name name-of-symbol-in-C)
- (inout-c-name name-of-symbol-in-C))
-
- Ex: (type
- (alias string)
- (gtk-type-id GTK_TYPE_STRING)
- (in-c-name const-gchar*)
- (out-c-name gchar**) ;; actually I'm not sure how strings work
- out/inout
- (inout-c-name gchar*))
-
- ;; This one would be implied by the (object) def for GtkWidget I
- ;; think - (type) is only required for types that are not implied
- ;; by other definitions, such as int/boolean/etc.
-
- (type
- (alias GtkWidget)
- (in-module (Gtk))
- (gtk-type-id GTK_TYPE_WIDGET)
- (in-c-name GtkWidget*)
- (inout-c-name GtkWidget*)
- (out-c-name GtkWidget**))
-
- "Type" bindings are automatically assumed for objects, boxed types,
- etc. as defined below.
-
- The alias field is used to refer to the type later on.
-
- If the C type has spaces they are converted to hyphens after
- compressing all syntactically significant whitespace to a single
- space:
- (type
- (alias const-gchar*
- (c-name const-gchar*)))
-
- So hyphens have to go back to spaces for binding generators that
- output C code.
-
- Whenever a type alias can be used, it is also possible to use the
- keyword "native", which implies that the type in question is too
- C-specific to represent. Then a c-declaration will typically be
- available for use.
-
- C types containing [] or () are function pointers or arrays. For
- arrays that don't specify a size, we just treat them as pointers. For
- function pointers, we need special (type) syntax/attributes of some
- kind, but since there basically aren't any of these right now in the
- libs we care about we can just ignore them. For arrays that specify a
- size ditto, you would handle them by adding an (array-size) attribute
- or something or using the "native" keyword and skipping the (type)
- stuff.
-
- ===
- (object object-name
- (in-module module-name-list)
- (parent object-name optional-module-name-if-different)
- (abstract boolean-is-abstract-class) ;; omit for default of #f
- (c-name name-of-the-object-in-C)
- (field (type-and-name type-alias-of-struct-field
- name-of-struct-field)
- (access read-or-write-or-readwrite)))
-
-
- Ex: (object Widget
- (in-module (Gtk))
- (parent Object) ;; could say (parent Object (Gtk))
- (abstract #t)
- (c-name GtkWidget)
- (field (type-and-name GdkWindow* window) (access read)))
-
- An "object" declaration automatically implies the type definition:
-
- (type
- (alias concat-module-elements-and-object-name)
- (in-c-name pointer-to-c-name)
- (out-c-name pointer-to-pointer-to-c-name)
- (inout-c-name pointer-to-c-name))
-
- Ex:
- (type (alias GtkWidget)
- (in-c-name GtkWidget*)
- (out-c-name GtkWidget**)
- (inout-c-name GtkWidget*))
-
- It also implies a module that is the name broken into parts:
- (module CTree
- (submodule-of Gtk))
-
- ===
-
- (function function-name
- (in-module module-name-list) ;; "static methods" go in their
- ;; object's module
- (is-constructor-of object-type-alias) ;; optional, marks a
- constructor
- (c-name function-name)
- (return-type return-value-type) ;; defaults to void
- (caller-owns-return boolean-value) ;; defaults to #f
- (parameter in-or-out-or-inout
- (type-and-name parameter-type-alias parameter-name)
- (c-declaration "c-type-and-name")) ;; c-declaration only
- required
- ;; if the type alias is
- "native"
- (varargs #t) ;; has varargs at the end
- )
-
- Ex:
- (function init
- (in-module (Gdk Rgb)
- (c-name gdk_rgb_init)))
-
- Ex:
- (function new
- (in-module (Gdk Rgb Cmap))
- (is-constructor-of GdkRgbCmap)
- (c-name gdk_rgb_cmap_new)
- (return-type GdkRgbCmap)
- (caller-owns-return #t) ;; perhaps this could be implied by
- is-constructor-of
- (parameter in (type-and-name array-of-guint32 colors))
- (parameter in (type-and-name gint n_colors)))
-
- Ex:
- (function config_set_set_handler
- (in-module (Gnome))
- (c-name gnome_config_set_set_handler)
- (parameter in (type-and-name native func)
- (c-declaration "void (*func)(void*)"))
- (parameter in (type-and-name gpointer data)))
-
- ===
- (method method-name
- (of-object object-name module-name)
- ;; retval/arg attributes as for (function), but with first parameter
-
- ;; omitted for non-constructors
- )
-
- Ex:
- (method set_text
- (of-object Label (Gtk))
- (parameter (type-and-name const-gchar* str)))
-
- ===
- (object-argument arg-name
- (of-object object-we-are-an-argument-of optional-objects-module)
- (type argument-type) ;; not sure what to put for type
- ;; flags all default to #f
- (readable bool-value)
- (writeable bool-value)
- (run-action bool-value)
- (construct-only bool-value))
-
- Ex:
- (object-argument label
- (of-object Label (Gtk))
- (type gchar*) ;; ????
- (readable #t)
- (writeable #t))
-
- ===
- (signal signal-name
- (of-object object-we-are-a-signal-of optional-objects-module)
- ;; return value and parameters as for a function, omitting the
- object
- ;; and user data parameters
-
- ;; what other properties matter for a signal?
- )
-
- Ex:
- (signal select_row
- (of-object CList (Gtk))
- ;; return type defaults to void
- (parameter in (type-and-name gint row))
- (parameter in (type-and-name gint column))
- (parameter in (type-and-name GdkEvent* event)))
-
- ===
- (enum enum-name
- (in-module modname)
- (c-name name-in-c)
- (value (name value-name-noprefixes-hyphen-lowercase) (c-name
- value-c-name)))
-
- Ex:
-
- (enum DirectionType
- (in-module Gtk)
- (c-name GtkDirectionType)
- (value (name tab-forward) (c-name GTK_DIR_TAB_FORWARD))
- (value (name tab-backward) (c-name GTK_DIR_TAB_BACKWARD))
- (value (name up) (c-name GTK_DIR_UP))
- (value (name down) (c-name GTK_DIR_DOWN))
- (value (name left) (c-name GTK_DIR_LEFT))
- (value (name right) (c-name GTK_DIR_RIGHT)))
-
- (enum Pos
- (in-module (Gtk CTree))
- (c-name GtkCTreePos)
- (value (name before) (c-name GTK_CTREE_POS_BEFORE))
- (value (name as-child) (c-name GTK_CTREE_POS_AS_CHILD))
- (value (name after) (c-name GTK_CTREE_POS_AFTER)))
-
- ===
- (flags) is just like enum, but some bindings may wrap enums and flags
- differently.
-
- ===
-
- (boxed boxed-name
- (in-module modname)
- (c-name c-name)
- (ref-func func-to-increase-refcount)
- (copy-func func-to-copy)
- (release-func func-to-destroy-or-decrement-refcount)
- (field (type-and-name type-alias-of-struct-field
- name-of-struct-field) (access access-rule)))
-
- It is never OK to use memcpy() to copy a boxed type, or use
- malloc()/free() to alloc/free one.
-
- Ex:
-
- (boxed Pixmap
- (in-module (Gdk))
- (c-name GdkPixmap)
- (ref-func pixmap_ref)
- (unref-func pixmap_unref))
-
- An "object" declaration automatically implies the type definition:
-
- (type
- (alias concat-module-elements-and-boxed-name)
- (in-c-name pointer-to-c-name)
- (out-c-name pointer-to-pointer-to-c-name)
- (inout-c-name pointer-to-c-name))
-
- Ex:
- (type (alias GdkPixmap)
- (in-c-name GdkPixmap*)
- (out-c-name GdkPixmap**)
- (inout-c-name GdkPixmap*))
-
- ===
-
- (struct struct-name
- (in-module modname)
- (c-name c-name)
- (field (type-and-name type-alias-of-struct-field
- name-of-struct-field) (access access-rule)))
-
- Ex:
- (struct Rectangle
- (in-module (Gdk))
- (c-name GdkRectangle)
- (field (type-and-name gint16 x) (access readwrite))
- (field (type-and-name gint16 y) (access readwrite))
- (field (type-and-name guint16 width) (access readwrite))
- (field (type-and-name guint16 height) (access readwrite)))
-
- Implies GdkRectangle type alias:
-
- (type (alias GdkRectangle)
- (in-c-name GdkRectangle*)
- (out-c-name GdkRectangle*) ;; note - not the same as boxed
- types
- (inout-c-name GdkRectangle*))
-
- ===
-
- (user-function name
- (in-module module)
- (c-name c-typedef-name)
- ;; return-type and parameters as for (function)
- )
-
- Ex:
-
- (user-function PrintFunc
- (in-module (Gtk))
- (parameter in (type-and-name gpointer func_data))
- (parameter in (type-and-name gchar* str)))
-
- ===
-
- (typedef new-name
- (in-module module)
- (c-name c-full-name)
- (orig-type alias-of-orig-type))
-
- Ex:
-
- (typedef Type
- (in-module (Gtk))
- (c-name GtkType)
- (orig-type guint))
-
diff --git a/codegen/__init__.py b/codegen/__init__.py
deleted file mode 100644
index cfa896ee..00000000
--- a/codegen/__init__.py
+++ /dev/null
@@ -1,15 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-
-__all__ = [
- 'argtypes',
- 'codegen',
- 'definitions',
- 'defsparser',
- 'docextract',
- 'docgen',
- 'h2def',
- 'mergedefs',
- 'mkskel',
- 'override',
- 'scmexpr'
-]
diff --git a/codegen/argtypes.py b/codegen/argtypes.py
deleted file mode 100644
index 3f145baa..00000000
--- a/codegen/argtypes.py
+++ /dev/null
@@ -1,1027 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-import string
-import keyword
-import struct
-
-py_ssize_t_clean = False
-
-class ArgTypeError(Exception):
- pass
-
-class ArgTypeNotFoundError(ArgTypeError):
- pass
-
-class ArgTypeConfigurationError(ArgTypeError):
- pass
-
-
-class VarList:
- """Nicely format a C variable list"""
- def __init__(self):
- self.vars = {}
- def add(self, ctype, name):
- if self.vars.has_key(ctype):
- self.vars[ctype] = self.vars[ctype] + (name,)
- else:
- self.vars[ctype] = (name,)
- def __str__(self):
- ret = []
- for type in self.vars.keys():
- ret.append(' ')
- ret.append(type)
- ret.append(' ')
- ret.append(string.join(self.vars[type], ', '))
- ret.append(';\n')
- if ret:
- ret.append('\n')
- return string.join(ret, '')
- return ''
-
-class WrapperInfo:
- """A class that holds information about variable defs, code
- snippets, etcd for use in writing out the function/method
- wrapper."""
- def __init__(self):
- self.varlist = VarList()
- self.parsestr = ''
- self.parselist = ['', 'kwlist']
- self.codebefore = []
- self.codeafter = []
- self.arglist = []
- self.kwlist = []
- def get_parselist(self):
- return string.join(self.parselist, ', ')
- def get_codebefore(self):
- return string.join(self.codebefore, '')
- def get_codeafter(self):
- return string.join(self.codeafter, '')
- def get_arglist(self):
- return string.join(self.arglist, ', ')
- def get_varlist(self):
- return str(self.varlist)
- def get_kwlist(self):
- ret = ' static char *kwlist[] = { %s };\n' % \
- string.join(self.kwlist + [ 'NULL' ], ', ')
- if not self.get_varlist():
- ret = ret + '\n'
- return ret
-
- def add_parselist(self, codes, parseargs, keywords):
- self.parsestr = self.parsestr + codes
- for arg in parseargs:
- self.parselist.append(arg)
- for kw in keywords:
- if keyword.iskeyword(kw):
- kw = kw + '_'
- self.kwlist.append('"%s"' % kw)
-
-class ArgType:
- def write_param(self, ptype, pname, pdflt, pnull, info):
- """Add code to the WrapperInfo instance to handle
- parameter."""
- raise RuntimeError, "write_param not implemented for %s" % \
- self.__class__.__name__
- def write_return(self, ptype, ownsreturn, info):
- """Adds a variable named ret of the return type to
- info.varlist, and add any required code to info.codeafter to
- convert the return value to a python object."""
- raise RuntimeError, "write_return not implemented for %s" % \
- self.__class__.__name__
-
-class NoneArg(ArgType):
- def write_return(self, ptype, ownsreturn, info):
- info.codeafter.append(' Py_INCREF(Py_None);\n' +
- ' return Py_None;')
-
-class StringArg(ArgType):
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- if pdflt != 'NULL': pdflt = '"' + pdflt + '"'
- info.varlist.add('char', '*' + pname + ' = ' + pdflt)
- else:
- info.varlist.add('char', '*' + pname)
- info.arglist.append(pname)
- if pnull:
- info.add_parselist('z', ['&' + pname], [pname])
- else:
- info.add_parselist('s', ['&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- if ownsreturn:
- # have to free result ...
- info.varlist.add('gchar', '*ret')
- info.codeafter.append(' if (ret) {\n' +
- ' PyObject *py_ret = PyString_FromString(ret);\n' +
- ' g_free(ret);\n' +
- ' return py_ret;\n' +
- ' }\n' +
- ' Py_INCREF(Py_None);\n' +
- ' return Py_None;')
- else:
- info.varlist.add('const gchar', '*ret')
- info.codeafter.append(' if (ret)\n' +
- ' return PyString_FromString(ret);\n'+
- ' Py_INCREF(Py_None);\n' +
- ' return Py_None;')
-
-class UCharArg(ArgType):
- # allows strings with embedded NULLs.
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add('guchar', '*' + pname + ' = "' + pdflt + '"')
- else:
- info.varlist.add('guchar', '*' + pname)
- if py_ssize_t_clean:
- info.varlist.add('Py_ssize_t', pname + '_len')
- else:
- info.varlist.add('int', pname + '_len')
- info.arglist.append(pname)
- if pnull:
- info.add_parselist('z#', ['&' + pname, '&' + pname + '_len'],
- [pname])
- else:
- info.add_parselist('s#', ['&' + pname, '&' + pname + '_len'],
- [pname])
-
-class CharArg(ArgType):
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add('char', pname + " = '" + pdflt + "'")
- else:
- info.varlist.add('char', pname)
- info.arglist.append(pname)
- info.add_parselist('c', ['&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('gchar', 'ret')
- info.codeafter.append(' return PyString_FromStringAndSize(&ret, 1);')
-class GUniCharArg(ArgType):
- ret_tmpl = ('#if !defined(Py_UNICODE_SIZE) || Py_UNICODE_SIZE == 2\n'
- ' if (ret > 0xffff) {\n'
- ' PyErr_SetString(PyExc_RuntimeError, "returned character can not be represented in 16-bit unicode");\n'
- ' return NULL;\n'
- ' }\n'
- '#endif\n'
- ' py_ret = (Py_UNICODE)ret;\n'
- ' return PyUnicode_FromUnicode(&py_ret, 1);\n')
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add('gunichar', pname + " = '" + pdflt + "'")
- else:
- info.varlist.add('gunichar', pname)
- info.arglist.append(pname)
- info.add_parselist('O&', ['pyg_pyobj_to_unichar_conv', '&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('gunichar', 'ret')
- info.varlist.add('Py_UNICODE', 'py_ret')
- info.codeafter.append(self.ret_tmpl)
-
-
-class IntArg(ArgType):
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add('int', pname + ' = ' + pdflt)
- else:
- info.varlist.add('int', pname)
- info.arglist.append(pname)
- info.add_parselist('i', ['&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('int', 'ret')
- info.codeafter.append(' return PyInt_FromLong(ret);')
-
-class UIntArg(ArgType):
- dflt = (' if (py_%(name)s) {\n'
- ' if (PyLong_Check(py_%(name)s))\n'
- ' %(name)s = PyLong_AsUnsignedLong(py_%(name)s);\n'
- ' else if (PyInt_Check(py_%(name)s))\n'
- ' %(name)s = PyInt_AsLong(py_%(name)s);\n'
- ' else\n'
- ' PyErr_SetString(PyExc_TypeError, "Parameter \'%(name)s\' must be an int or a long");\n'
- ' if (PyErr_Occurred())\n'
- ' return NULL;\n'
- ' }\n')
- before = (' if (PyLong_Check(py_%(name)s))\n'
- ' %(name)s = PyLong_AsUnsignedLong(py_%(name)s);\n'
- ' else if (PyInt_Check(py_%(name)s))\n'
- ' %(name)s = PyInt_AsLong(py_%(name)s);\n'
- ' else\n'
- ' PyErr_SetString(PyExc_TypeError, "Parameter \'%(name)s\' must be an int or a long");\n'
- ' if (PyErr_Occurred())\n'
- ' return NULL;\n')
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if not pdflt:
- pdflt = '0';
-
- info.varlist.add(ptype, pname + ' = ' + pdflt)
- info.codebefore.append(self.dflt % {'name':pname})
- info.varlist.add('PyObject', "*py_" + pname + ' = NULL')
- info.arglist.append(pname)
- info.add_parselist('O', ['&py_' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add(ptype, 'ret')
- info.codeafter.append(' return PyLong_FromUnsignedLong(ret);')
-
-class SizeArg(ArgType):
-
- if struct.calcsize('P') <= struct.calcsize('l'):
- llp64 = True
- else:
- llp64 = False
-
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add(ptype, pname + ' = ' + pdflt)
- else:
- info.varlist.add(ptype, pname)
- info.arglist.append(pname)
- if self.llp64:
- info.add_parselist('k', ['&' + pname], [pname])
- else:
- info.add_parselist('K', ['&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add(ptype, 'ret')
- if self.llp64:
- info.codeafter.append(' return PyLong_FromUnsignedLongLong(ret);\n')
- else:
- info.codeafter.append(' return PyLong_FromUnsignedLong(ret);\n')
-
-class SSizeArg(ArgType):
-
- if struct.calcsize('P') <= struct.calcsize('l'):
- llp64 = True
- else:
- llp64 = False
-
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add(ptype, pname + ' = ' + pdflt)
- else:
- info.varlist.add(ptype, pname)
- info.arglist.append(pname)
- if self.llp64:
- info.add_parselist('l', ['&' + pname], [pname])
- else:
- info.add_parselist('L', ['&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add(ptype, 'ret')
- if self.llp64:
- info.codeafter.append(' return PyLong_FromLongLong(ret);\n')
- else:
- info.codeafter.append(' return PyLong_FromLong(ret);\n')
-
-class LongArg(ArgType):
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add(ptype, pname + ' = ' + pdflt)
- else:
- info.varlist.add(ptype, pname)
- info.arglist.append(pname)
- info.add_parselist('l', ['&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add(ptype, 'ret')
- info.codeafter.append(' return PyInt_FromLong(ret);\n')
-
-class BoolArg(IntArg):
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('int', 'ret')
- info.codeafter.append(' return PyBool_FromLong(ret);\n')
-
-class TimeTArg(ArgType):
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add('time_t', pname + ' = ' + pdflt)
- else:
- info.varlist.add('time_t', pname)
- info.arglist.append(pname)
- info.add_parselist('i', ['&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('time_t', 'ret')
- info.codeafter.append(' return PyInt_FromLong(ret);')
-
-class ULongArg(ArgType):
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add('unsigned long', pname + ' = ' + pdflt)
- else:
- info.varlist.add('unsigned long', pname)
- info.arglist.append(pname)
- info.add_parselist('k', ['&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add(ptype, 'ret')
- info.codeafter.append(' return PyLong_FromUnsignedLong(ret);\n')
-
-class UInt32Arg(ULongArg):
- def write_param(self, ptype, pname, pdflt, pnull, info):
- ULongArg.write_param(self, ptype, pname, pdflt, pnull, info)
- ## if sizeof(unsigned long) > sizeof(unsigned int), we need to
- ## check the value is within guint32 range
- if struct.calcsize('L') > struct.calcsize('I'):
- info.codebefore.append((
- ' if (%(pname)s > G_MAXUINT32) {\n'
- ' PyErr_SetString(PyExc_ValueError,\n'
- ' "Value out of range in conversion of"\n'
- ' " %(pname)s parameter to unsigned 32 bit integer");\n'
- ' return NULL;\n'
- ' }\n') % vars())
-
-class Int64Arg(ArgType):
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add('gint64', pname + ' = ' + pdflt)
- else:
- info.varlist.add('gint64', pname)
- info.arglist.append(pname)
- info.add_parselist('L', ['&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('gint64', 'ret')
- info.codeafter.append(' return PyLong_FromLongLong(ret);')
-
-class UInt64Arg(ArgType):
- dflt = ' if (py_%(name)s)\n' \
- ' %(name)s = PyLong_AsUnsignedLongLong(py_%(name)s);\n'
- before = ' %(name)s = PyLong_AsUnsignedLongLong(py_%(name)s);\n'
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add('guint64', pname + ' = ' + pdflt)
- info.codebefore.append(self.dflt % {'name':pname})
- else:
- info.varlist.add('guint64', pname)
- info.codebefore.append(self.before % {'name':pname})
- info.varlist.add('PyObject', "*py_" + pname + ' = NULL')
- info.arglist.append(pname)
- info.add_parselist('O!', ['&PyLong_Type', '&py_' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('guint64', 'ret')
- info.codeafter.append(' return PyLong_FromUnsignedLongLong(ret);')
-
-
-class DoubleArg(ArgType):
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add('double', pname + ' = ' + pdflt)
- else:
- info.varlist.add('double', pname)
- info.arglist.append(pname)
- info.add_parselist('d', ['&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('double', 'ret')
- info.codeafter.append(' return PyFloat_FromDouble(ret);')
-
-class FileArg(ArgType):
- nulldflt = (' if (py_%(name)s == Py_None)\n'
- ' %(name)s = NULL;\n'
- ' else if (py_%(name)s && PyFile_Check(py_%(name)s)\n'
- ' %s = PyFile_AsFile(py_%(name)s);\n'
- ' else if (py_%(name)s) {\n'
- ' PyErr_SetString(PyExc_TypeError, "%(name)s should be a file object or None");\n'
- ' return NULL;\n'
- ' }')
- null = (' if (py_%(name)s && PyFile_Check(py_%(name)s)\n'
- ' %(name)s = PyFile_AsFile(py_%(name)s);\n'
- ' else if (py_%(name)s != Py_None) {\n'
- ' PyErr_SetString(PyExc_TypeError, "%(name)s should be a file object or None");\n'
- ' return NULL;\n'
- ' }\n')
- dflt = (' if (py_%(name)s)\n'
- ' %(name)s = PyFile_AsFile(py_%(name)s);\n')
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pnull:
- if pdflt:
- info.varlist.add('FILE', '*' + pname + ' = ' + pdflt)
- info.varlist.add('PyObject', '*py_' + pname + ' = NULL')
- info.codebefore.append(self.nulldflt % {'name':pname})
- else:
- info.varlist.add('FILE', '*' + pname + ' = NULL')
- info.varlist.add('PyObject', '*py_' + pname)
- info.codebefore.append(self.null & {'name':pname})
- info.arglist.appned(pname)
- info.add_parselist('O', ['&py_' + pname], [pname])
- else:
- if pdflt:
- info.varlist.add('FILE', '*' + pname + ' = ' + pdflt)
- info.varlist.add('PyObject', '*py_' + pname + ' = NULL')
- info.codebefore.append(self.dflt % {'name':pname})
- info.arglist.append(pname)
- else:
- info.varlist.add('PyObject', '*' + pname)
- info.arglist.append('PyFile_AsFile(' + pname + ')')
- info.add_parselist('O!', ['&PyFile_Type', '&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('FILE', '*ret')
- info.codeafter.append(' if (ret)\n' +
- ' return PyFile_FromFile(ret, "", "", fclose);\n' +
- ' Py_INCREF(Py_None);\n' +
- ' return Py_None;')
-
-class EnumArg(ArgType):
- enum = (' if (pyg_enum_get_value(%(typecode)s, py_%(name)s, (gpointer)&%(name)s))\n'
- ' return NULL;\n')
- def __init__(self, enumname, typecode):
- self.enumname = enumname
- self.typecode = typecode
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add(self.enumname, pname + ' = ' + pdflt)
- else:
- info.varlist.add(self.enumname, pname)
- info.varlist.add('PyObject', '*py_' + pname + ' = NULL')
- info.codebefore.append(self.enum % { 'typecode': self.typecode,
- 'name': pname})
- info.arglist.append(pname)
- info.add_parselist('O', ['&py_' + pname], [pname]);
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('gint', 'ret')
- info.codeafter.append(' return pyg_enum_from_gtype(%s, ret);' % self.typecode)
-
-class FlagsArg(ArgType):
- flag = (' if (%(default)spyg_flags_get_value(%(typecode)s, py_%(name)s, (gpointer)&%(name)s))\n'
- ' return NULL;\n')
- def __init__(self, flagname, typecode):
- self.flagname = flagname
- self.typecode = typecode
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add(self.flagname, pname + ' = ' + pdflt)
- default = "py_%s && " % (pname,)
- else:
- info.varlist.add(self.flagname, pname)
- default = ""
- info.varlist.add('PyObject', '*py_' + pname + ' = NULL')
- info.codebefore.append(self.flag % {'default':default,
- 'typecode':self.typecode,
- 'name':pname})
- info.arglist.append(pname)
- info.add_parselist('O', ['&py_' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('guint', 'ret')
- info.codeafter.append(' return pyg_flags_from_gtype(%s, ret);' % self.typecode)
-
-class ObjectArg(ArgType):
- # should change these checks to more typesafe versions that check
- # a little further down in the class heirachy.
- nulldflt = (' if ((PyObject *)py_%(name)s == Py_None)\n'
- ' %(name)s = NULL;\n'
- ' else if (py_%(name)s && pygobject_check(py_%(name)s, &Py%(type)s_Type))\n'
- ' %(name)s = %(cast)s(py_%(name)s->obj);\n'
- ' else if (py_%(name)s) {\n'
- ' PyErr_SetString(PyExc_TypeError, "%(name)s should be a %(type)s or None");\n'
- ' return NULL;\n'
- ' }\n')
- null = (' if (py_%(name)s && pygobject_check(py_%(name)s, &Py%(type)s_Type))\n'
- ' %(name)s = %(cast)s(py_%(name)s->obj);\n'
- ' else if ((PyObject *)py_%(name)s != Py_None) {\n'
- ' PyErr_SetString(PyExc_TypeError, "%(name)s should be a %(type)s or None");\n'
- ' return NULL;\n'
- ' }\n')
- dflt = ' if (py_%(name)s)\n' \
- ' %(name)s = %(cast)s(py_%(name)s->obj);\n'
- def __init__(self, objname, parent, typecode):
- self.objname = objname
- self.cast = string.replace(typecode, '_TYPE_', '_', 1)
- self.parent = parent
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pnull:
- if pdflt:
- info.varlist.add(self.objname, '*' + pname + ' = ' + pdflt)
- info.varlist.add('PyGObject', '*py_' + pname + ' = NULL')
- info.codebefore.append(self.nulldflt % {'name':pname,
- 'cast':self.cast,
- 'type':self.objname})
- else:
- info.varlist.add(self.objname, '*' + pname + ' = NULL')
- info.varlist.add('PyGObject', '*py_' + pname)
- info.codebefore.append(self.null % {'name':pname,
- 'cast':self.cast,
- 'type':self.objname})
- if ptype.endswith('*'):
- typename = ptype[:-1]
- try:
- const, typename = typename.split('const-')
- except ValueError:
- const = ''
- if typename != ptype:
- info.arglist.append('(%s *) %s' % (ptype[:-1], pname))
- else:
- info.arglist.append(pname)
-
- info.add_parselist('O', ['&py_' + pname], [pname])
- else:
- if pdflt:
- info.varlist.add(self.objname, '*' + pname + ' = ' + pdflt)
- info.varlist.add('PyGObject', '*py_' + pname + ' = NULL')
- info.codebefore.append(self.dflt % {'name':pname,
- 'cast':self.cast})
- info.arglist.append(pname)
- info.add_parselist('O!', ['&Py%s_Type' % self.objname,
- '&py_' + pname], [pname])
- else:
- info.varlist.add('PyGObject', '*' + pname)
- info.arglist.append('%s(%s->obj)' % (self.cast, pname))
- info.add_parselist('O!', ['&Py%s_Type' % self.objname,
- '&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- if ptype.endswith('*'):
- typename = ptype[:-1]
- try:
- const, typename = typename.split('const-')
- except ValueError:
- const = ''
- info.varlist.add(typename, '*ret')
- if ownsreturn:
- info.varlist.add('PyObject', '*py_ret')
- info.codeafter.append(' py_ret = pygobject_new((GObject *)ret);\n'
- ' if (ret != NULL)\n'
- ' g_object_unref(ret);\n'
- ' return py_ret;')
- else:
- info.codeafter.append(' /* pygobject_new handles NULL checking */\n' +
- ' return pygobject_new((GObject *)ret);')
-
-class BoxedArg(ArgType):
- # haven't done support for default args. Is it needed?
- check = (' if (pyg_boxed_check(py_%(name)s, %(typecode)s))\n'
- ' %(name)s = pyg_boxed_get(py_%(name)s, %(typename)s);\n'
- ' else {\n'
- ' PyErr_SetString(PyExc_TypeError, "%(name)s should be a %(typename)s");\n'
- ' return NULL;\n'
- ' }\n')
- null = (' if (pyg_boxed_check(py_%(name)s, %(typecode)s))\n'
- ' %(name)s = pyg_boxed_get(py_%(name)s, %(typename)s);\n'
- ' else if (py_%(name)s != Py_None) {\n'
- ' PyErr_SetString(PyExc_TypeError, "%(name)s should be a %(typename)s or None");\n'
- ' return NULL;\n'
- ' }\n')
- def __init__(self, ptype, typecode):
- self.typename = ptype
- self.typecode = typecode
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pnull:
- info.varlist.add(self.typename, '*' + pname + ' = NULL')
- info.varlist.add('PyObject', '*py_' + pname + ' = Py_None')
- info.codebefore.append(self.null % {'name': pname,
- 'typename': self.typename,
- 'typecode': self.typecode})
- else:
- info.varlist.add(self.typename, '*' + pname + ' = NULL')
- info.varlist.add('PyObject', '*py_' + pname)
- info.codebefore.append(self.check % {'name': pname,
- 'typename': self.typename,
- 'typecode': self.typecode})
- if ptype[-1] == '*':
- typename = ptype[:-1]
- if typename[:6] == 'const-': typename = typename[6:]
- if typename != self.typename:
- info.arglist.append('(%s *)%s' % (ptype[:-1], pname))
- else:
- info.arglist.append(pname)
- else:
- info.arglist.append(pname)
- info.add_parselist('O', ['&py_' + pname], [pname])
- ret_tmpl = ' /* pyg_boxed_new handles NULL checking */\n' \
- ' return pyg_boxed_new(%(typecode)s, %(ret)s, %(copy)s, TRUE);'
- def write_return(self, ptype, ownsreturn, info):
- if ptype[-1] == '*':
- info.varlist.add(self.typename, '*ret')
- ret = 'ret'
- else:
- info.varlist.add(self.typename, 'ret')
- ret = '&ret'
- ownsreturn = 0 # of course it can't own a ref to a local var ...
- info.codeafter.append(self.ret_tmpl %
- { 'typecode': self.typecode,
- 'ret': ret,
- 'copy': ownsreturn and 'FALSE' or 'TRUE'})
-
-class CustomBoxedArg(ArgType):
- # haven't done support for default args. Is it needed?
- null = (' if (%(check)s(py_%(name)s))\n'
- ' %(name)s = %(get)s(py_%(name)s);\n'
- ' else if (py_%(name)s != Py_None) {\n'
- ' PyErr_SetString(PyExc_TypeError, "%(name)s should be a %(type)s or None");\n'
- ' return NULL;\n'
- ' }\n')
- def __init__(self, ptype, pytype, getter, new):
- self.pytype = pytype
- self.getter = getter
- self.checker = 'Py' + ptype + '_Check'
- self.new = new
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pnull:
- info.varlist.add(ptype[:-1], '*' + pname + ' = NULL')
- info.varlist.add('PyObject', '*py_' + pname + ' = Py_None')
- info.codebefore.append(self.null % {'name': pname,
- 'get': self.getter,
- 'check': self.checker,
- 'type': ptype[:-1]})
- info.arglist.append(pname)
- info.add_parselist('O', ['&py_' + pname], [pname])
- else:
- info.varlist.add('PyObject', '*' + pname)
- info.arglist.append(self.getter + '(' + pname + ')')
- info.add_parselist('O!', ['&' + self.pytype, '&' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add(ptype[:-1], '*ret')
- info.codeafter.append(' if (ret)\n' +
- ' return ' + self.new + '(ret);\n' +
- ' Py_INCREF(Py_None);\n' +
- ' return Py_None;')
-
-class PointerArg(ArgType):
- # haven't done support for default args. Is it needed?
- check = (' if (pyg_pointer_check(py_%(name)s, %(typecode)s))\n'
- ' %(name)s = pyg_pointer_get(py_%(name)s, %(typename)s);\n'
- ' else {\n'
- ' PyErr_SetString(PyExc_TypeError, "%(name)s should be a %(typename)s");\n'
- ' return NULL;\n'
- ' }\n')
- null = (' if (pyg_pointer_check(py_%(name)s, %(typecode)s))\n'
- ' %(name)s = pyg_pointer_get(py_%(name)s, %(typename)s);\n'
- ' else if (py_%(name)s != Py_None) {\n'
- ' PyErr_SetString(PyExc_TypeError, "%(name)s should be a %(typename)s or None");\n'
- ' return NULL;\n'
- ' }\n')
- def __init__(self, ptype, typecode):
- self.typename = ptype
- self.typecode = typecode
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pnull:
- info.varlist.add(self.typename, '*' + pname + ' = NULL')
- info.varlist.add('PyObject', '*py_' + pname + ' = Py_None')
- info.codebefore.append(self.null % {'name': pname,
- 'typename': self.typename,
- 'typecode': self.typecode})
- else:
- info.varlist.add(self.typename, '*' + pname + ' = NULL')
- info.varlist.add('PyObject', '*py_' + pname)
- info.codebefore.append(self.check % {'name': pname,
- 'typename': self.typename,
- 'typecode': self.typecode})
- info.arglist.append(pname)
- info.add_parselist('O', ['&py_' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- if ptype[-1] == '*':
- info.varlist.add(self.typename, '*ret')
- info.codeafter.append(' /* pyg_pointer_new handles NULL checking */\n' +
- ' return pyg_pointer_new(' + self.typecode + ', ret);')
- else:
- info.varlist.add(self.typename, 'ret')
- info.codeafter.append(' /* pyg_pointer_new handles NULL checking */\n' +
- ' return pyg_pointer_new(' + self.typecode + ', &ret);')
-
-class AtomArg(IntArg):
- dflt = ' if (py_%(name)s) {\n' \
- ' %(name)s = pygdk_atom_from_pyobject(py_%(name)s);\n' \
- ' if (PyErr_Occurred())\n' \
- ' return NULL;\n' \
- ' }\n'
- atom = (' %(name)s = pygdk_atom_from_pyobject(py_%(name)s);\n'
- ' if (PyErr_Occurred())\n'
- ' return NULL;\n')
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pdflt:
- info.varlist.add('GdkAtom', pname + ' = ' + pdflt)
- info.varlist.add('PyObject', '*py_' + pname + ' = NULL')
- info.codebefore.append(self.dflt % {'name': pname})
- else:
- info.varlist.add('GdkAtom', pname)
- info.varlist.add('PyObject', '*py_' + pname + ' = NULL')
- info.codebefore.append(self.atom % {'name': pname})
- info.arglist.append(pname)
- info.add_parselist('O', ['&py_' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('GdkAtom', 'ret')
- info.varlist.add('PyObject *', 'py_ret')
- info.varlist.add('gchar *', 'name')
- info.codeafter.append(' name = gdk_atom_name(ret);\n'
- ' py_ret = PyString_FromString(name);\n'
- ' g_free(name);\n'
- ' return py_ret;')
-
-class GTypeArg(ArgType):
- gtype = (' if ((%(name)s = pyg_type_from_object(py_%(name)s)) == 0)\n'
- ' return NULL;\n')
- def write_param(self, ptype, pname, pdflt, pnull, info):
- info.varlist.add('GType', pname)
- info.varlist.add('PyObject', '*py_' + pname + ' = NULL')
- info.codebefore.append(self.gtype % {'name': pname})
- info.arglist.append(pname)
- info.add_parselist('O', ['&py_' + pname], [pname])
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('GType', 'ret')
- info.codeafter.append(' return pyg_type_wrapper_new(ret);')
-
-# simple GError handler.
-class GErrorArg(ArgType):
- handleerror = (' if (pyg_error_check(&%(name)s))\n'
- ' return NULL;\n')
- def write_param(self, ptype, pname, pdflt, pnull, info):
- info.varlist.add('GError', '*' + pname + ' = NULL')
- info.arglist.append('&' + pname)
- info.codeafter.append(self.handleerror % { 'name': pname })
-
-class GtkTreePathArg(ArgType):
- # haven't done support for default args. Is it needed?
- normal = (' %(name)s = pygtk_tree_path_from_pyobject(py_%(name)s);\n'
- ' if (!%(name)s) {\n'
- ' PyErr_SetString(PyExc_TypeError, "could not convert %(name)s to a GtkTreePath");\n'
- ' return NULL;\n'
- ' }\n')
- null = (' if (py_%(name)s != Py_None) {\n'
- ' %(name)s = pygtk_tree_path_from_pyobject(py_%(name)s);\n'
- ' if (!%(name)s) {\n'
- ' PyErr_SetString(PyExc_TypeError, "could not convert %(name)s to a GtkTreePath");\n'
- ' return NULL;\n'
- ' }\n'
- ' }\n')
- freepath = (' if (%(name)s)\n'
- ' gtk_tree_path_free(%(name)s);\n')
- def __init__(self):
- pass
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pnull:
- info.varlist.add('GtkTreePath', '*' + pname + ' = NULL')
- info.varlist.add('PyObject', '*py_' + pname + ' = Py_None')
- info.codebefore.append(self.null % {'name': pname})
- info.arglist.append(pname)
- info.add_parselist('O', ['&py_' + pname], [pname])
- else:
- info.varlist.add('GtkTreePath', '*' + pname)
- info.varlist.add('PyObject', '*py_' + pname)
- info.codebefore.append(self.normal % {'name': pname})
- info.arglist.append(pname)
- info.add_parselist('O', ['&py_' + pname], [pname])
- info.codeafter.append(self.freepath % {'name': pname})
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('GtkTreePath', '*ret')
- if ownsreturn:
- info.codeafter.append(' if (ret) {\n'
- ' PyObject *py_ret = pygtk_tree_path_to_pyobject(ret);\n'
- ' gtk_tree_path_free(ret);\n'
- ' return py_ret;\n'
- ' }\n'
- ' Py_INCREF(Py_None);\n'
- ' return Py_None;')
- else:
- info.codeafter.append(' if (ret) {\n'
- ' PyObject *py_ret = pygtk_tree_path_to_pyobject(ret);\n'
- ' return py_ret;\n'
- ' }\n'
- ' Py_INCREF(Py_None);\n'
- ' return Py_None;')
-
-class GdkRectanglePtrArg(ArgType):
- normal = (' if (!pygdk_rectangle_from_pyobject(py_%(name)s, &%(name)s))\n'
- ' return NULL;\n')
- null = (' if (py_%(name)s == Py_None)\n'
- ' %(name)s = NULL;\n'
- ' else if (pygdk_rectangle_from_pyobject(py_%(name)s, &%(name)s_rect))\n'
- ' %(name)s = &%(name)s_rect;\n'
- ' else\n'
- ' return NULL;\n')
- def write_param(self, ptype, pname, pdflt, pnull, info):
- if pnull:
- info.varlist.add('GdkRectangle', pname + '_rect = { 0, 0, 0, 0 }')
- info.varlist.add('GdkRectangle', '*' + pname)
- info.varlist.add('PyObject', '*py_' + pname + ' = Py_None')
- info.add_parselist('O', ['&py_' + pname], [pname])
- info.arglist.append(pname)
- info.codebefore.append(self.null % {'name': pname})
- else:
- info.varlist.add('GdkRectangle', pname + ' = { 0, 0, 0, 0 }')
- info.varlist.add('PyObject', '*py_' + pname)
- info.add_parselist('O', ['&py_' + pname], [pname])
- info.arglist.append('&' + pname)
- info.codebefore.append(self.normal % {'name': pname})
-
-class GdkRectangleArg(ArgType):
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add('GdkRectangle', 'ret')
- info.codeafter.append(' return pyg_boxed_new(GDK_TYPE_RECTANGLE, &ret, TRUE, TRUE);')
-
-class PyObjectArg(ArgType):
- def write_param(self, ptype, pname, pdflt, pnull, info):
- info.varlist.add('PyObject', '*' + pname)
- info.add_parselist('O', ['&' + pname], [pname])
- info.arglist.append(pname)
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add("PyObject", "*ret")
- if ownsreturn:
- info.codeafter.append(' if (ret) {\n'
- ' return ret;\n'
- ' }\n'
- ' Py_INCREF(Py_None);\n'
- ' return Py_None;')
- else:
- info.codeafter.append(' if (!ret) ret = Py_None;\n'
- ' Py_INCREF(ret);\n'
- ' return ret;')
-
-class CairoArg(ArgType):
- def write_param(self, ptype, pname, pdflt, pnull, info):
- info.varlist.add('PycairoContext', '*' + pname)
- info.add_parselist('O!', ['&PycairoContext_Type', '&' + pname], [pname])
- info.arglist.append('%s->ctx' % pname)
- def write_return(self, ptype, ownsreturn, info):
- info.varlist.add("cairo_t", "*ret")
- if ownsreturn:
- info.codeafter.append(' return PycairoContext_FromContext(ret, NULL, NULL);')
- else:
- info.codeafter.append(' cairo_reference(ret);\n'
- ' return PycairoContext_FromContext(ret, NULL, NULL);')
-
-
-class ArgMatcher:
- def __init__(self):
- self.argtypes = {}
- self.reverse_argtypes = {}
- self.reverse_rettypes = {}
-
- def register(self, ptype, handler, overwrite=False):
- if not overwrite and ptype in self.argtypes:
- return
- self.argtypes[ptype] = handler
- def register_reverse(self, ptype, handler):
- self.reverse_argtypes[ptype] = handler
- def register_reverse_ret(self, ptype, handler):
- self.reverse_rettypes[ptype] = handler
-
- def register_enum(self, ptype, typecode):
- if typecode is None:
- self.register(ptype, IntArg())
- else:
- self.register(ptype, EnumArg(ptype, typecode))
- def register_flag(self, ptype, typecode):
- if typecode is None:
- self.register(ptype, IntArg())
- else:
- self.register(ptype, FlagsArg(ptype, typecode))
- def register_object(self, ptype, parent, typecode):
- oa = ObjectArg(ptype, parent, typecode)
- self.register(ptype, oa) # in case I forget the * in the .defs
- self.register(ptype+'*', oa)
- self.register('const-'+ptype+'*', oa)
- if ptype == 'GdkPixmap':
- # hack to handle GdkBitmap synonym.
- self.register('GdkBitmap', oa)
- self.register('GdkBitmap*', oa)
- def register_boxed(self, ptype, typecode):
- if self.argtypes.has_key(ptype): return
- arg = BoxedArg(ptype, typecode)
- self.register(ptype, arg)
- self.register(ptype+'*', arg)
- self.register('const-'+ptype+'*', arg)
- def register_custom_boxed(self, ptype, pytype, getter, new):
- arg = CustomBoxedArg(ptype, pytype, getter, new)
- self.register(ptype+'*', arg)
- self.register('const-'+ptype+'*', arg)
- def register_pointer(self, ptype, typecode):
- arg = PointerArg(ptype, typecode)
- self.register(ptype, arg)
- self.register(ptype+'*', arg)
- self.register('const-'+ptype+'*', arg)
-
- def get(self, ptype):
- try:
- return self.argtypes[ptype]
- except KeyError:
- if ptype[:8] == 'GdkEvent' and ptype[-1] == '*':
- return self.argtypes['GdkEvent*']
- raise ArgTypeNotFoundError("No ArgType for %s" % (ptype,))
- def _get_reverse_common(self, ptype, registry):
- props = dict(c_type=ptype)
- try:
- return registry[ptype], props
- except KeyError:
- try:
- handler = self.argtypes[ptype]
- except KeyError:
- if ptype.startswith('GdkEvent') and ptype.endswith('*'):
- handler = self.argtypes['GdkEvent*']
- else:
- raise ArgTypeNotFoundError("No ArgType for %s" % (ptype,))
- if isinstance(handler, ObjectArg):
- return registry['GObject*'], props
- elif isinstance(handler, EnumArg):
- props['typecode'] = handler.typecode
- props['enumname'] = handler.enumname
- return registry['GEnum'], props
- elif isinstance(handler, FlagsArg):
- props['typecode'] = handler.typecode
- props['flagname'] = handler.flagname
- return registry['GFlags'], props
- elif isinstance(handler, BoxedArg):
- props['typecode'] = handler.typecode
- props['typename'] = handler.typename
- return registry['GBoxed'], props
- else:
- raise ArgTypeNotFoundError("No ArgType for %s" % (ptype,))
- def get_reverse(self, ptype):
- return self._get_reverse_common(ptype, self.reverse_argtypes)
- def get_reverse_ret(self, ptype):
- return self._get_reverse_common(ptype, self.reverse_rettypes)
-
- def object_is_a(self, otype, parent):
- if otype == None: return 0
- if otype == parent: return 1
- if not self.argtypes.has_key(otype): return 0
- return self.object_is_a(self.get(otype).parent, parent)
-
-matcher = ArgMatcher()
-
-arg = NoneArg()
-matcher.register(None, arg)
-matcher.register('none', arg)
-
-arg = StringArg()
-matcher.register('char*', arg)
-matcher.register('gchar*', arg)
-matcher.register('const-char*', arg)
-matcher.register('char-const*', arg)
-matcher.register('const-gchar*', arg)
-matcher.register('gchar-const*', arg)
-matcher.register('string', arg)
-matcher.register('static_string', arg)
-
-arg = UCharArg()
-matcher.register('unsigned-char*', arg)
-matcher.register('const-guchar*', arg)
-matcher.register('const-guint8*', arg)
-matcher.register('guchar*', arg)
-
-arg = CharArg()
-matcher.register('char', arg)
-matcher.register('gchar', arg)
-matcher.register('guchar', arg)
-
-arg = GUniCharArg()
-matcher.register('gunichar', arg)
-
-arg = IntArg()
-matcher.register('int', arg)
-matcher.register('gint', arg)
-matcher.register('short', arg)
-matcher.register('gshort', arg)
-matcher.register('gushort', arg)
-matcher.register('gsize', SizeArg())
-matcher.register('gssize', SSizeArg())
-matcher.register('guint8', arg)
-matcher.register('gint8', arg)
-matcher.register('guint16', arg)
-matcher.register('gint16', arg)
-matcher.register('gint32', arg)
-matcher.register('GTime', arg)
-
-arg = LongArg()
-matcher.register('long', arg)
-matcher.register('glong', arg)
-
-arg = UIntArg()
-matcher.register('guint', arg)
-
-arg = BoolArg()
-matcher.register('gboolean', arg)
-
-arg = TimeTArg()
-matcher.register('time_t', arg)
-
-matcher.register('guint32', UInt32Arg())
-
-arg = ULongArg()
-matcher.register('gulong', arg)
-
-arg = Int64Arg()
-matcher.register('gint64', arg)
-matcher.register('long-long', arg)
-
-arg = UInt64Arg()
-matcher.register('guint64', arg)
-matcher.register('unsigned-long-long', arg)
-
-arg = DoubleArg()
-matcher.register('double', arg)
-matcher.register('gdouble', arg)
-matcher.register('float', arg)
-matcher.register('gfloat', arg)
-
-arg = FileArg()
-matcher.register('FILE*', arg)
-
-# enums, flags, objects
-
-matcher.register('GdkAtom', AtomArg())
-
-matcher.register('GType', GTypeArg())
-matcher.register('GtkType', GTypeArg())
-
-matcher.register('GError**', GErrorArg())
-matcher.register('GtkTreePath*', GtkTreePathArg())
-matcher.register('GdkRectangle*', GdkRectanglePtrArg())
-matcher.register('GtkAllocation*', GdkRectanglePtrArg())
-matcher.register('GdkRectangle', GdkRectangleArg())
-matcher.register('PyObject*', PyObjectArg())
-
-matcher.register('GdkNativeWindow', ULongArg())
-
-matcher.register_object('GObject', None, 'G_TYPE_OBJECT')
-
-del arg
-
-matcher.register('cairo_t*', CairoArg())
diff --git a/codegen/code-coverage.py b/codegen/code-coverage.py
deleted file mode 100755
index fd150347..00000000
--- a/codegen/code-coverage.py
+++ /dev/null
@@ -1,42 +0,0 @@
-from __future__ import generators
-import sys, os
-
-def read_symbols(file, type=None, dynamic=0):
- if dynamic:
- cmd = 'nm -D %s' % file
- else:
- cmd = 'nm %s' % file
- for line in os.popen(cmd, 'r'):
- if line[0] != ' ': # has an address as first bit of line
- while line[0] != ' ':
- line = line[1:]
- while line[0] == ' ':
- line = line[1:]
- # we should be up to "type symbolname" now
- sym_type = line[0]
- symbol = line[1:].strip()
-
- if not type or type == sym_type:
- yield symbol
-
-def main():
- if len(sys.argv) != 3:
- sys.stderr.write('usage: coverage-check library.so wrapper.so\n')
- sys.exit(1)
- library = sys.argv[1]
- wrapper = sys.argv[2]
-
- # first create a dict with all referenced symbols in the wrapper
- # should really be a set, but a dict will do ...
- wrapper_symbols = {}
- for symbol in read_symbols(wrapper, type='U', dynamic=1):
- wrapper_symbols[symbol] = 1
-
- # now go through the library looking for matches on the defined symbols:
- for symbol in read_symbols(library, type='T', dynamic=1):
- if symbol[0] == '_': continue
- if symbol not in wrapper_symbols:
- print symbol
-
-if __name__ == '__main__':
- main()
diff --git a/codegen/codegen.py b/codegen/codegen.py
deleted file mode 100644
index c0ca17bd..00000000
--- a/codegen/codegen.py
+++ /dev/null
@@ -1,1707 +0,0 @@
-import getopt
-import keyword
-import os
-import string
-import sys
-
-import argtypes
-import definitions
-import defsparser
-import override
-import reversewrapper
-import warnings
-
-class Coverage(object):
- def __init__(self, name):
- self.name = name
- self.wrapped = 0
- self.not_wrapped = 0
-
- def declare_wrapped(self):
- self.wrapped += 1
-
- def declare_not_wrapped(self):
- self.not_wrapped += 1
-
- def printstats(self):
- total = self.wrapped + self.not_wrapped
- fd = sys.stderr
- if total:
- fd.write("***INFO*** The coverage of %s is %.2f%% (%i/%i)\n" %
- (self.name,
- float(self.wrapped*100)/total,
- self.wrapped,
- total))
- else:
- fd.write("***INFO*** There are no declared %s.\n" % self.name)
-
-functions_coverage = Coverage("global functions")
-methods_coverage = Coverage("methods")
-vproxies_coverage = Coverage("virtual proxies")
-vaccessors_coverage = Coverage("virtual accessors")
-iproxies_coverage = Coverage("interface proxies")
-
-def exc_info():
- warnings.warn("deprecated", DeprecationWarning, stacklevel=2)
- #traceback.print_exc()
- etype, value, tb = sys.exc_info()
- ret = ""
- try:
- sval = str(value)
- if etype == argtypes.ArgTypeError:
- ret = "No ArgType for %s" % (sval,)
- else:
- ret = sval
- finally:
- del etype, value, tb
- return ret
-
-def fixname(name):
- if keyword.iskeyword(name):
- return name + '_'
- return name
-
-class FileOutput:
- '''Simple wrapper for file object, that makes writing #line
- statements easier.''' # "
- def __init__(self, fp, filename=None):
- self.fp = fp
- self.lineno = 1
- if filename:
- self.filename = filename
- else:
- self.filename = self.fp.name
- # handle writing to the file, and keep track of the line number ...
- def write(self, str):
- self.fp.write(str)
- self.lineno = self.lineno + string.count(str, '\n')
- def writelines(self, sequence):
- for line in sequence:
- self.write(line)
- def close(self):
- self.fp.close()
- def flush(self):
- self.fp.flush()
-
- def setline(self, linenum, filename):
- '''writes out a #line statement, for use by the C
- preprocessor.''' # "
- self.write('#line %d "%s"\n' % (linenum, filename))
- def resetline(self):
- '''resets line numbering to the original file'''
- self.setline(self.lineno + 1, self.filename)
-
-class Wrapper:
- type_tmpl = (
- 'PyTypeObject G_GNUC_INTERNAL Py%(typename)s_Type = {\n'
- ' PyObject_HEAD_INIT(NULL)\n'
- ' 0, /* ob_size */\n'
- ' "%(classname)s", /* tp_name */\n'
- ' sizeof(%(tp_basicsize)s), /* tp_basicsize */\n'
- ' 0, /* tp_itemsize */\n'
- ' /* methods */\n'
- ' (destructor)%(tp_dealloc)s, /* tp_dealloc */\n'
- ' (printfunc)0, /* tp_print */\n'
- ' (getattrfunc)%(tp_getattr)s, /* tp_getattr */\n'
- ' (setattrfunc)%(tp_setattr)s, /* tp_setattr */\n'
- ' (cmpfunc)%(tp_compare)s, /* tp_compare */\n'
- ' (reprfunc)%(tp_repr)s, /* tp_repr */\n'
- ' (PyNumberMethods*)%(tp_as_number)s, /* tp_as_number */\n'
- ' (PySequenceMethods*)%(tp_as_sequence)s, /* tp_as_sequence */\n'
- ' (PyMappingMethods*)%(tp_as_mapping)s, /* tp_as_mapping */\n'
- ' (hashfunc)%(tp_hash)s, /* tp_hash */\n'
- ' (ternaryfunc)%(tp_call)s, /* tp_call */\n'
- ' (reprfunc)%(tp_str)s, /* tp_str */\n'
- ' (getattrofunc)%(tp_getattro)s, /* tp_getattro */\n'
- ' (setattrofunc)%(tp_setattro)s, /* tp_setattro */\n'
- ' (PyBufferProcs*)%(tp_as_buffer)s, /* tp_as_buffer */\n'
- ' %(tp_flags)s, /* tp_flags */\n'
- ' %(tp_doc)s, /* Documentation string */\n'
- ' (traverseproc)%(tp_traverse)s, /* tp_traverse */\n'
- ' (inquiry)%(tp_clear)s, /* tp_clear */\n'
- ' (richcmpfunc)%(tp_richcompare)s, /* tp_richcompare */\n'
- ' %(tp_weaklistoffset)s, /* tp_weaklistoffset */\n'
- ' (getiterfunc)%(tp_iter)s, /* tp_iter */\n'
- ' (iternextfunc)%(tp_iternext)s, /* tp_iternext */\n'
- ' (struct PyMethodDef*)%(tp_methods)s, /* tp_methods */\n'
- ' (struct PyMemberDef*)0, /* tp_members */\n'
- ' (struct PyGetSetDef*)%(tp_getset)s, /* tp_getset */\n'
- ' NULL, /* tp_base */\n'
- ' NULL, /* tp_dict */\n'
- ' (descrgetfunc)%(tp_descr_get)s, /* tp_descr_get */\n'
- ' (descrsetfunc)%(tp_descr_set)s, /* tp_descr_set */\n'
- ' %(tp_dictoffset)s, /* tp_dictoffset */\n'
- ' (initproc)%(tp_init)s, /* tp_init */\n'
- ' (allocfunc)%(tp_alloc)s, /* tp_alloc */\n'
- ' (newfunc)%(tp_new)s, /* tp_new */\n'
- ' (freefunc)%(tp_free)s, /* tp_free */\n'
- ' (inquiry)%(tp_is_gc)s /* tp_is_gc */\n'
- '};\n\n'
- )
-
- slots_list = [
- 'tp_getattr', 'tp_setattr', 'tp_getattro', 'tp_setattro',
- 'tp_compare', 'tp_repr',
- 'tp_as_number', 'tp_as_sequence', 'tp_as_mapping', 'tp_hash',
- 'tp_call', 'tp_str', 'tp_as_buffer', 'tp_richcompare', 'tp_iter',
- 'tp_iternext', 'tp_descr_get', 'tp_descr_set', 'tp_init',
- 'tp_alloc', 'tp_new', 'tp_free', 'tp_is_gc',
- 'tp_traverse', 'tp_clear', 'tp_dealloc', 'tp_flags', 'tp_doc'
- ]
-
- getter_tmpl = (
- 'static PyObject *\n'
- '%(funcname)s(PyObject *self, void *closure)\n'
- '{\n'
- '%(varlist)s'
- ' ret = %(field)s;\n'
- '%(codeafter)s\n'
- '}\n\n'
- )
-
- parse_tmpl = (
- ' if (!PyArg_ParseTupleAndKeywords(args, kwargs,'
- '"%(typecodes)s:%(name)s"%(parselist)s))\n'
- ' return %(errorreturn)s;\n'
- )
-
- deprecated_tmpl = (
- ' if (PyErr_Warn(PyExc_DeprecationWarning, '
- '"%(deprecationmsg)s") < 0)\n'
- ' return %(errorreturn)s;\n'
- )
-
- methdef_tmpl = (
- ' { "%(name)s", (PyCFunction)%(cname)s, %(flags)s,\n'
- ' %(docstring)s },\n'
- )
-
- noconstructor = (
- 'static int\n'
- 'pygobject_no_constructor(PyObject *self, PyObject *args, '
- 'PyObject *kwargs)\n'
- '{\n'
- ' gchar buf[512];\n'
- '\n'
- ' g_snprintf(buf, sizeof(buf), "%s is an abstract widget", '
- 'self->ob_type->tp_name);\n'
- ' PyErr_SetString(PyExc_NotImplementedError, buf);\n'
- ' return -1;\n'
- '}\n\n'
- )
-
- function_tmpl = (
- 'static PyObject *\n'
- '_wrap_%(cname)s(PyObject *self%(extraparams)s)\n'
- '{\n'
- '%(varlist)s'
- '%(parseargs)s'
- '%(codebefore)s'
- ' %(begin_allow_threads)s\n'
- ' %(setreturn)s%(cname)s(%(arglist)s);\n'
- ' %(end_allow_threads)s\n'
- '%(codeafter)s\n'
- '}\n\n'
- )
-
- virtual_accessor_tmpl = (
- 'static PyObject *\n'
- '_wrap_%(cname)s(PyObject *cls%(extraparams)s)\n'
- '{\n'
- ' gpointer klass;\n'
- '%(varlist)s'
- '%(parseargs)s'
- '%(codebefore)s'
- ' klass = g_type_class_ref(pyg_type_from_object(cls));\n'
- ' if (%(class_cast_macro)s(klass)->%(virtual)s)\n'
- ' %(setreturn)s%(class_cast_macro)s(klass)->'
- '%(virtual)s(%(arglist)s);\n'
- ' else {\n'
- ' PyErr_SetString(PyExc_NotImplementedError, '
- '"virtual method %(name)s not implemented");\n'
- ' g_type_class_unref(klass);\n'
- ' return NULL;\n'
- ' }\n'
- ' g_type_class_unref(klass);\n'
- '%(codeafter)s\n'
- '}\n\n'
- )
-
- # template for method calls
- constructor_tmpl = None
- method_tmpl = None
-
- def __init__(self, parser, objinfo, overrides, fp=FileOutput(sys.stdout)):
- self.parser = parser
- self.objinfo = objinfo
- self.overrides = overrides
- self.fp = fp
-
- def get_lower_name(self):
- return string.lower(string.replace(self.objinfo.typecode,
- '_TYPE_', '_', 1))
-
- def get_field_accessor(self, fieldname):
- raise NotImplementedError
-
- def get_initial_class_substdict(self): return {}
-
- def get_initial_constructor_substdict(self, constructor):
- return { 'name': '%s.__init__' % self.objinfo.c_name,
- 'errorreturn': '-1' }
- def get_initial_method_substdict(self, method):
- substdict = { 'name': '%s.%s' % (self.objinfo.c_name, method.name) }
- if method.unblock_threads:
- substdict['begin_allow_threads'] = 'pyg_begin_allow_threads;'
- substdict['end_allow_threads'] = 'pyg_end_allow_threads;'
- else:
- substdict['begin_allow_threads'] = ''
- substdict['end_allow_threads'] = ''
- return substdict
-
- def write_class(self):
- if self.overrides.is_type_ignored(self.objinfo.c_name):
- return
- self.fp.write('\n/* ----------- %s ----------- */\n\n' %
- self.objinfo.c_name)
- substdict = self.get_initial_class_substdict()
- if not substdict.has_key('tp_flags'):
- substdict['tp_flags'] = 'Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE'
- substdict['typename'] = self.objinfo.c_name
- if self.overrides.modulename:
- substdict['classname'] = '%s.%s' % (self.overrides.modulename,
- self.objinfo.name)
- else:
- substdict['classname'] = self.objinfo.name
- substdict['tp_doc'] = self.objinfo.docstring
-
- # Maybe this could be done in a nicer way, but I'll leave it as it is
- # for now: -- Johan
- if not self.overrides.slot_is_overriden('%s.tp_init' %
- self.objinfo.c_name):
- substdict['tp_init'] = self.write_constructor()
- substdict['tp_methods'] = self.write_methods()
- substdict['tp_getset'] = self.write_getsets()
-
- # handle slots ...
- for slot in self.slots_list:
-
- slotname = '%s.%s' % (self.objinfo.c_name, slot)
- slotfunc = '_wrap_%s_%s' % (self.get_lower_name(), slot)
- if slot[:6] == 'tp_as_':
- slotfunc = '&' + slotfunc
- if self.overrides.slot_is_overriden(slotname):
- data = self.overrides.slot_override(slotname)
- self.write_function(slotname, data)
- substdict[slot] = slotfunc
- else:
- if not substdict.has_key(slot):
- substdict[slot] = '0'
-
- self.fp.write(self.type_tmpl % substdict)
-
- self.write_virtuals()
-
- def write_function_wrapper(self, function_obj, template,
- handle_return=0, is_method=0, kwargs_needed=0,
- substdict=None):
- '''This function is the guts of all functions that generate
- wrappers for functions, methods and constructors.'''
- if not substdict: substdict = {}
-
- info = argtypes.WrapperInfo()
-
- substdict.setdefault('errorreturn', 'NULL')
-
- # for methods, we want the leading comma
- if is_method:
- info.arglist.append('')
-
- if function_obj.varargs:
- raise argtypes.ArgTypeNotFoundError("varargs functions not supported")
-
- for param in function_obj.params:
- if param.pdflt and '|' not in info.parsestr:
- info.add_parselist('|', [], [])
- handler = argtypes.matcher.get(param.ptype)
- handler.write_param(param.ptype, param.pname, param.pdflt,
- param.pnull, info)
-
- substdict['setreturn'] = ''
- if handle_return:
- if function_obj.ret not in ('none', None):
- substdict['setreturn'] = 'ret = '
- handler = argtypes.matcher.get(function_obj.ret)
- handler.write_return(function_obj.ret,
- function_obj.caller_owns_return, info)
-
- if function_obj.deprecated != None:
- deprecated = self.deprecated_tmpl % {
- 'deprecationmsg': function_obj.deprecated,
- 'errorreturn': substdict['errorreturn'] }
- else:
- deprecated = ''
-
- # if name isn't set, set it to function_obj.name
- substdict.setdefault('name', function_obj.name)
-
- if function_obj.unblock_threads:
- substdict['begin_allow_threads'] = 'pyg_begin_allow_threads;'
- substdict['end_allow_threads'] = 'pyg_end_allow_threads;'
- else:
- substdict['begin_allow_threads'] = ''
- substdict['end_allow_threads'] = ''
-
- if self.objinfo:
- substdict['typename'] = self.objinfo.c_name
- substdict.setdefault('cname', function_obj.c_name)
- substdict['varlist'] = info.get_varlist()
- substdict['typecodes'] = info.parsestr
- substdict['parselist'] = info.get_parselist()
- substdict['arglist'] = info.get_arglist()
- substdict['codebefore'] = deprecated + (
- string.replace(info.get_codebefore(),
- 'return NULL', 'return ' + substdict['errorreturn'])
- )
- substdict['codeafter'] = (
- string.replace(info.get_codeafter(),
- 'return NULL',
- 'return ' + substdict['errorreturn']))
-
- if info.parsestr or kwargs_needed:
- substdict['parseargs'] = self.parse_tmpl % substdict
- substdict['extraparams'] = ', PyObject *args, PyObject *kwargs'
- flags = 'METH_VARARGS|METH_KEYWORDS'
-
- # prepend the keyword list to the variable list
- substdict['varlist'] = info.get_kwlist() + substdict['varlist']
- else:
- substdict['parseargs'] = ''
- substdict['extraparams'] = ''
- flags = 'METH_NOARGS'
-
- return template % substdict, flags
-
- def write_constructor(self):
- initfunc = '0'
- constructor = self.parser.find_constructor(self.objinfo,self.overrides)
- if not constructor:
- return self.write_default_constructor()
-
- funcname = constructor.c_name
- try:
- if self.overrides.is_overriden(funcname):
- data = self.overrides.override(funcname)
- self.write_function(funcname, data)
- self.objinfo.has_new_constructor_api = (
- self.objinfo.typecode in
- self.overrides.newstyle_constructors)
- else:
- # ok, a hack to determine if we should use
- # new-style constructores :P
- property_based = getattr(self,
- 'write_property_based_constructor',
- None)
- if property_based:
- if (len(constructor.params) == 0 or
- isinstance(constructor.params[0],
- definitions.Property)):
- # write_property_based_constructor is only
- # implemented in GObjectWrapper
- return self.write_property_based_constructor(
- constructor)
- else:
- sys.stderr.write(
- "Warning: generating old-style constructor for:" +
- constructor.c_name + '\n')
-
- # write constructor from template ...
- code = self.write_function_wrapper(constructor,
- self.constructor_tmpl,
- handle_return=0, is_method=0, kwargs_needed=1,
- substdict=self.get_initial_constructor_substdict(
- constructor))[0]
- self.fp.write(code)
- initfunc = '_wrap_' + funcname
- except argtypes.ArgTypeError, ex:
- sys.stderr.write('Could not write constructor for %s: %s\n'
- % (self.objinfo.c_name, str(ex)))
-
- initfunc = self.write_noconstructor()
- return initfunc
-
- def write_noconstructor(self):
- # this is a hack ...
- if not hasattr(self.overrides, 'no_constructor_written'):
- self.fp.write(self.noconstructor)
- self.overrides.no_constructor_written = 1
- initfunc = 'pygobject_no_constructor'
- return initfunc
-
- def write_default_constructor(self):
- return self.write_noconstructor()
-
- def get_methflags(self, funcname):
- if self.overrides.wants_kwargs(funcname):
- flags = 'METH_VARARGS|METH_KEYWORDS'
- elif self.overrides.wants_noargs(funcname):
- flags = 'METH_NOARGS'
- elif self.overrides.wants_onearg(funcname):
- flags = 'METH_O'
- else:
- flags = 'METH_VARARGS'
- if self.overrides.is_staticmethod(funcname):
- flags += '|METH_STATIC'
- elif self.overrides.is_classmethod(funcname):
- flags += '|METH_CLASS'
- return flags
-
- def write_function(self, funcname, data):
- lineno, filename = self.overrides.getstartline(funcname)
- self.fp.setline(lineno, filename)
- self.fp.write(data)
- self.fp.resetline()
- self.fp.write('\n\n')
-
- def _get_class_virtual_substdict(self, meth, cname, parent):
- substdict = self.get_initial_method_substdict(meth)
- substdict['virtual'] = substdict['name'].split('.')[1]
- substdict['cname'] = cname
- substdict['class_cast_macro'] = parent.typecode.replace(
- '_TYPE_', '_', 1) + "_CLASS"
- substdict['typecode'] = self.objinfo.typecode
- substdict['cast'] = string.replace(parent.typecode, '_TYPE_', '_', 1)
- return substdict
-
- def write_methods(self):
- methods = []
- klass = self.objinfo.c_name
- # First, get methods from the defs files
- for meth in self.parser.find_methods(self.objinfo):
- method_name = meth.c_name
- if self.overrides.is_ignored(method_name):
- continue
- try:
- if self.overrides.is_overriden(method_name):
- if not self.overrides.is_already_included(method_name):
- data = self.overrides.override(method_name)
- self.write_function(method_name, data)
-
- methflags = self.get_methflags(method_name)
- else:
- # write constructor from template ...
- code, methflags = self.write_function_wrapper(meth,
- self.method_tmpl, handle_return=1, is_method=1,
- substdict=self.get_initial_method_substdict(meth))
- self.fp.write(code)
- methods.append(self.methdef_tmpl %
- { 'name': fixname(meth.name),
- 'cname': '_wrap_' + method_name,
- 'flags': methflags,
- 'docstring': meth.docstring })
- methods_coverage.declare_wrapped()
- except argtypes.ArgTypeError, ex:
- methods_coverage.declare_not_wrapped()
- sys.stderr.write('Could not write method %s.%s: %s\n'
- % (klass, meth.name, str(ex)))
-
- # Now try to see if there are any defined in the override
- for method_name in self.overrides.get_defines_for(klass):
- c_name = override.class2cname(klass, method_name)
- if self.overrides.is_already_included(method_name):
- continue
-
- try:
- data = self.overrides.define(klass, method_name)
- self.write_function(method_name, data)
- methflags = self.get_methflags(method_name)
-
- methods.append(self.methdef_tmpl %
- { 'name': method_name,
- 'cname': '_wrap_' + c_name,
- 'flags': methflags,
- 'docstring': 'NULL' })
- methods_coverage.declare_wrapped()
- except argtypes.ArgTypeError, ex:
- methods_coverage.declare_not_wrapped()
- sys.stderr.write('Could not write method %s.%s: %s\n'
- % (klass, method_name, str(ex)))
-
- # Add GObject virtual method accessors, for chaining to parent
- # virtuals from subclasses
- methods += self.write_virtual_accessors()
-
- if methods:
- methoddefs = '_Py%s_methods' % self.objinfo.c_name
- # write the PyMethodDef structure
- methods.append(' { NULL, NULL, 0, NULL }\n')
- self.fp.write('static const PyMethodDef %s[] = {\n' % methoddefs)
- self.fp.write(string.join(methods, ''))
- self.fp.write('};\n\n')
- else:
- methoddefs = 'NULL'
- return methoddefs
-
- def write_virtual_accessors(self):
- klass = self.objinfo.c_name
- methods = []
- for meth in self.parser.find_virtuals(self.objinfo):
- method_name = self.objinfo.c_name + "__do_" + meth.name
- if self.overrides.is_ignored(method_name):
- continue
- try:
- if self.overrides.is_overriden(method_name):
- if not self.overrides.is_already_included(method_name):
- data = self.overrides.override(method_name)
- self.write_function(method_name, data)
- methflags = self.get_methflags(method_name)
- else:
- # temporarily add a 'self' parameter as first argument
- meth.params.insert(0, definitions.Parameter(
- ptype=(self.objinfo.c_name + '*'),
- pname='self', pdflt=None, pnull=None))
- try:
- # write method from template ...
- code, methflags = self.write_function_wrapper(
- meth, self.virtual_accessor_tmpl,
- handle_return=True, is_method=False,
- substdict=self._get_class_virtual_substdict(
- meth, method_name, self.objinfo))
- self.fp.write(code)
- finally:
- del meth.params[0]
- methods.append(self.methdef_tmpl %
- { 'name': "do_" + fixname(meth.name),
- 'cname': '_wrap_' + method_name,
- 'flags': methflags + '|METH_CLASS',
- 'docstring': 'NULL'})
- vaccessors_coverage.declare_wrapped()
- except argtypes.ArgTypeError, ex:
- vaccessors_coverage.declare_not_wrapped()
- sys.stderr.write(
- 'Could not write virtual accessor method %s.%s: %s\n'
- % (klass, meth.name, str(ex)))
- return methods
-
- def write_virtuals(self):
- '''
- Write _wrap_FooBar__proxy_do_zbr() reverse wrapers for
- GObject virtuals
- '''
- klass = self.objinfo.c_name
- virtuals = []
- for meth in self.parser.find_virtuals(self.objinfo):
- method_name = self.objinfo.c_name + "__proxy_do_" + meth.name
- if self.overrides.is_ignored(method_name):
- continue
- try:
- if self.overrides.is_overriden(method_name):
- if not self.overrides.is_already_included(method_name):
- data = self.overrides.override(method_name)
- self.write_function(method_name, data)
- else:
- # write virtual proxy ...
- ret, props = argtypes.matcher.get_reverse_ret(meth.ret)
- wrapper = reversewrapper.ReverseWrapper(
- '_wrap_' + method_name, is_static=True)
- wrapper.set_return_type(ret(wrapper, **props))
- wrapper.add_parameter(reversewrapper.PyGObjectMethodParam(
- wrapper, "self", method_name="do_" + meth.name,
- c_type=(klass + ' *')))
- for param in meth.params:
- handler, props = argtypes.matcher.get_reverse(
- param.ptype)
- props["direction"] = param.pdir
- wrapper.add_parameter(handler(wrapper,
- param.pname, **props))
- buf = reversewrapper.MemoryCodeSink()
- wrapper.generate(buf)
- self.fp.write(buf.flush())
- virtuals.append((fixname(meth.name), '_wrap_' + method_name))
- vproxies_coverage.declare_wrapped()
- except argtypes.ArgTypeError, ex:
- vproxies_coverage.declare_not_wrapped()
- virtuals.append((fixname(meth.name), None))
- sys.stderr.write('Could not write virtual proxy %s.%s: %s\n'
- % (klass, meth.name, str(ex)))
- if virtuals:
- # Write a 'pygtk class init' function for this object,
- # except when the object type is explicitly ignored (like
- # GtkPlug and GtkSocket on win32).
- if self.overrides.is_ignored(self.objinfo.typecode):
- return
- class_cast_macro = self.objinfo.typecode.replace(
- '_TYPE_', '_', 1) + "_CLASS"
- cast_macro = self.objinfo.typecode.replace('_TYPE_', '_', 1)
- funcname = "__%s_class_init" % klass
- self.objinfo.class_init_func = funcname
- have_implemented_virtuals = not not [True
- for name, cname in virtuals
- if cname is not None]
- self.fp.write(
- ('\nstatic int\n'
- '%(funcname)s(gpointer gclass, PyTypeObject *pyclass)\n'
- '{\n') % vars())
-
- if have_implemented_virtuals:
- self.fp.write(' PyObject *o;\n')
- self.fp.write(
- ' %(klass)sClass *klass = '
- '%(class_cast_macro)s(gclass);\n'
- ' PyObject *gsignals = '
- 'PyDict_GetItemString(pyclass->tp_dict, "__gsignals__");\n'
- % vars())
-
- for name, cname in virtuals:
- do_name = 'do_' + name
- if cname is None:
- self.fp.write('\n /* overriding %(do_name)s '
- 'is currently not supported */\n' % vars())
- else:
- self.fp.write('''
- o = PyObject_GetAttrString((PyObject *) pyclass, "%(do_name)s");
- if (o == NULL)
- PyErr_Clear();
- else {
- if (!PyObject_TypeCheck(o, &PyCFunction_Type)
- && !(gsignals && PyDict_GetItemString(gsignals, "%(name)s")))
- klass->%(name)s = %(cname)s;
- Py_DECREF(o);
- }
-''' % vars())
- self.fp.write(' return 0;\n}\n')
-
- def write_getsets(self):
- lower_name = self.get_lower_name()
- getsets_name = lower_name + '_getsets'
- getterprefix = '_wrap_' + lower_name + '__get_'
- setterprefix = '_wrap_' + lower_name + '__set_'
-
- # no overrides for the whole function. If no fields,
- # don't write a func
- if not self.objinfo.fields:
- return '0'
- getsets = []
- for ftype, cfname in self.objinfo.fields:
- fname = cfname.replace('.', '_')
- gettername = '0'
- settername = '0'
- attrname = self.objinfo.c_name + '.' + fname
- if self.overrides.attr_is_overriden(attrname):
- code = self.overrides.attr_override(attrname)
- self.write_function(attrname, code)
- if string.find(code, getterprefix + fname) >= 0:
- gettername = getterprefix + fname
- if string.find(code, setterprefix + fname) >= 0:
- settername = setterprefix + fname
- if gettername == '0':
- try:
- funcname = getterprefix + fname
- info = argtypes.WrapperInfo()
- handler = argtypes.matcher.get(ftype)
- # for attributes, we don't own the "return value"
- handler.write_return(ftype, 0, info)
- self.fp.write(self.getter_tmpl %
- { 'funcname': funcname,
- 'varlist': info.varlist,
- 'field': self.get_field_accessor(cfname),
- 'codeafter': info.get_codeafter() })
- gettername = funcname
- except argtypes.ArgTypeError, ex:
- sys.stderr.write(
- "Could not write getter for %s.%s: %s\n"
- % (self.objinfo.c_name, fname, str(ex)))
- if gettername != '0' or settername != '0':
- getsets.append(' { "%s", (getter)%s, (setter)%s },\n' %
- (fixname(fname), gettername, settername))
-
- if not getsets:
- return '0'
- self.fp.write('static const PyGetSetDef %s[] = {\n' % getsets_name)
- for getset in getsets:
- self.fp.write(getset)
- self.fp.write(' { NULL, (getter)0, (setter)0 },\n')
- self.fp.write('};\n\n')
-
- return getsets_name
-
- def _write_get_symbol_names(self, writer, functions):
- self.fp.write("""static PyObject *
-_wrap__get_symbol_names(PyObject *self)
-{
- PyObject *pylist = PyList_New(0);
-
-""")
- for obj, bases in writer.get_classes():
- self.fp.write(' PyList_Append(pylist, '
- 'PyString_FromString("%s"));\n' % (obj.name))
-
- for name, cname, flags, docstring in functions:
- self.fp.write(' PyList_Append(pylist, '
- 'PyString_FromString("%s"));\n' % (name))
-
- for enum in writer.get_enums():
- self.fp.write(' PyList_Append(pylist, '
- 'PyString_FromString("%s"));\n' % (enum.name))
- for nick, value in enum.values:
- name = value[len(self.overrides.modulename)+1:]
- self.fp.write(' PyList_Append(pylist, '
- 'PyString_FromString("%s"));\n' % (name))
-
- self.fp.write(" return pylist;\n}\n\n");
-
- def _write_get_symbol(self, writer, functions):
- self.fp.write("""static PyObject *
-_wrap__get_symbol(PyObject *self, PyObject *args)
-{
- PyObject *d;
- char *name;
- static PyObject *modulename = NULL;
- static PyObject *module = NULL;
- static char *strip_prefix = "%s";
-
- if (!PyArg_ParseTuple(args, "Os", &d, &name))
- return NULL;
-
- if (!modulename)
- modulename = PyString_FromString("%s");
-
- if (!module)
- module = PyDict_GetItemString(d, "__module__");
-
-""" % (self.overrides.modulename.upper() + '_',
- self.overrides.modulename))
-
- first = True
- # Classes / GObjects
- for obj, bases in writer.get_classes():
- if first:
- self.fp.write(' if (!strcmp(name, "%s")) {\n' % obj.name)
- first = False
- else:
- self.fp.write(' } else if (!strcmp(name, "%s")) {\n' % obj.name)
- self.fp.write(
- ' return (PyObject*)pygobject_lookup_class(%s);\n' %
- obj.typecode)
- self.fp.write(' }\n')
-
- # Functions
- for name, cname, flags, docstring in functions:
- self.fp.write(' else if (!strcmp(name, "%s")) {\n' % name)
- self.fp.write(' static PyMethodDef ml = { '
- '"%s", (PyCFunction)%s, %s, "%s"};\n' % (
- name, cname, flags, docstring))
- self.fp.write(' return PyCFunction_NewEx(&ml, NULL, modulename);\n')
- self.fp.write(' }\n')
-
- # Enums
- def write_enum(enum, returnobj=False):
- if returnobj:
- ret = 'return '
- else:
- ret = ''
- if enum.deftype == 'enum':
- self.fp.write(
- ' %spyg_enum_add(module, "%s", strip_prefix, %s);\n'
- % (ret, enum.name, enum.typecode))
- else:
- self.fp.write(
- ' %spyg_flags_add(module, "%s", strip_prefix, %s);\n'
- % (ret, enum.name, enum.typecode))
-
- strip_len = len(self.overrides.modulename)+1 # GTK_
- for enum in writer.get_enums():
- # XXX: Implement without typecodes
- self.fp.write(' else if (!strcmp(name, "%s")) {\n' % enum.name)
- write_enum(enum, returnobj=True)
- self.fp.write(' }\n')
-
- for nick, value in enum.values:
- value = value[strip_len:]
- self.fp.write(' else if (!strcmp(name, "%s")) {\n' % value)
- write_enum(enum)
- self.fp.write(' return PyObject_GetAttrString(module, "%s");\n' %
- value)
- self.fp.write(' }\n')
-
- self.fp.write(' return Py_None;\n}\n\n');
-
- def _write_function_bodies(self):
- functions = []
- # First, get methods from the defs files
- for func in self.parser.find_functions():
- funcname = func.c_name
- if self.overrides.is_ignored(funcname):
- continue
- try:
- if self.overrides.is_overriden(funcname):
- data = self.overrides.override(funcname)
- self.write_function(funcname, data)
-
- methflags = self.get_methflags(funcname)
- else:
- # write constructor from template ...
- code, methflags = self.write_function_wrapper(func,
- self.function_tmpl, handle_return=1, is_method=0)
- self.fp.write(code)
- functions.append((func.name, '_wrap_' + funcname,
- methflags, func.docstring))
- functions_coverage.declare_wrapped()
- except argtypes.ArgTypeError, ex:
- functions_coverage.declare_not_wrapped()
- sys.stderr.write('Could not write function %s: %s\n'
- % (func.name, str(ex)))
-
- # Now try to see if there are any defined in the override
- for funcname in self.overrides.get_functions():
- try:
- data = self.overrides.function(funcname)
- self.write_function(funcname, data)
- methflags = self.get_methflags(funcname)
- functions.append((funcname, '_wrap_' + funcname,
- methflags, 'NULL'))
- functions_coverage.declare_wrapped()
- except argtypes.ArgTypeError, ex:
- functions_coverage.declare_not_wrapped()
- sys.stderr.write('Could not write function %s: %s\n'
- % (funcname, str(ex)))
- return functions
-
- def write_functions(self, writer, prefix):
- self.fp.write('\n/* ----------- functions ----------- */\n\n')
- functions = []
- func_infos = self._write_function_bodies()
-
- # If we have a dynamic namespace, write symbol and attribute getter
- if self.overrides.dynamicnamespace:
- self._write_get_symbol_names(writer, func_infos)
- self._write_get_symbol(writer, func_infos)
- for obj, bases in writer.get_classes():
- self.fp.write("""static PyTypeObject *
-%s_register_type(const gchar *name, PyObject *unused)
-{
- PyObject *m = PyImport_ImportModule("gtk");
- PyObject *d = PyModule_GetDict(m);
-""" % obj.c_name)
- writer.write_class(obj, bases, indent=1)
- self.fp.write(
- ' return (%s)PyDict_GetItemString(d, "%s");\n' % (
- 'PyTypeObject*', obj.name))
- self.fp.write("}\n")
-
- functions.append(' { "_get_symbol_names", '
- '(PyCFunction)_wrap__get_symbol_names, '
- 'METH_NOARGS, NULL },\n')
- functions.append(' { "_get_symbol", '
- '(PyCFunction)_wrap__get_symbol, '
- 'METH_VARARGS, NULL },\n')
- else:
- for name, cname, flags, docstring in func_infos:
- functions.append(self.methdef_tmpl % dict(name=name,
- cname=cname,
- flags=flags,
- docstring=docstring))
-
- # write the PyMethodDef structure
- functions.append(' { NULL, NULL, 0, NULL }\n')
-
- self.fp.write('const PyMethodDef ' + prefix + '_functions[] = {\n')
- self.fp.write(string.join(functions, ''))
- self.fp.write('};\n\n')
-
-class GObjectWrapper(Wrapper):
- constructor_tmpl = (
- 'static int\n'
- '_wrap_%(cname)s(PyGObject *self%(extraparams)s)\n'
- '{\n'
- '%(varlist)s'
- '%(parseargs)s'
- '%(codebefore)s'
- ' self->obj = (GObject *)%(cname)s(%(arglist)s);\n'
- '%(codeafter)s\n'
- ' if (!self->obj) {\n'
- ' PyErr_SetString(PyExc_RuntimeError, '
- '"could not create %(typename)s object");\n'
- ' return -1;\n'
- ' }\n'
- '%(aftercreate)s'
- ' pygobject_register_wrapper((PyObject *)self);\n'
- ' return 0;\n'
- '}\n\n'
- )
-
- method_tmpl = (
- 'static PyObject *\n'
- '_wrap_%(cname)s(PyGObject *self%(extraparams)s)\n'
- '{\n'
- '%(varlist)s'
- '%(parseargs)s'
- '%(codebefore)s'
- ' %(begin_allow_threads)s\n'
- ' %(setreturn)s%(cname)s(%(cast)s(self->obj)%(arglist)s);\n'
- ' %(end_allow_threads)s\n'
- '%(codeafter)s\n'
- '}\n\n'
- )
- def __init__(self, parser, objinfo, overrides, fp=FileOutput(sys.stdout)):
- Wrapper.__init__(self, parser, objinfo, overrides, fp)
- if self.objinfo:
- self.castmacro = string.replace(self.objinfo.typecode,
- '_TYPE_', '_', 1)
-
- def get_initial_class_substdict(self):
- return { 'tp_basicsize' : 'PyGObject',
- 'tp_weaklistoffset' : 'offsetof(PyGObject, weakreflist)',
- 'tp_dictoffset' : 'offsetof(PyGObject, inst_dict)' }
-
- def get_field_accessor(self, fieldname):
- castmacro = string.replace(self.objinfo.typecode, '_TYPE_', '_', 1)
- return '%s(pygobject_get(self))->%s' % (castmacro, fieldname)
-
- def get_initial_constructor_substdict(self, constructor):
- substdict = Wrapper.get_initial_constructor_substdict(self,
- constructor)
- if not constructor.caller_owns_return:
- substdict['aftercreate'] = " g_object_ref(self->obj);\n"
- else:
- substdict['aftercreate'] = ''
- return substdict
-
- def get_initial_method_substdict(self, method):
- substdict = Wrapper.get_initial_method_substdict(self, method)
- substdict['cast'] = string.replace(self.objinfo.typecode,
- '_TYPE_', '_', 1)
- return substdict
-
- def write_default_constructor(self):
- try:
- parent = self.parser.find_object(self.objinfo.parent)
- except ValueError:
- parent = None
- if parent is not None:
- ## just like the constructor is inheritted, we should
- # inherit the new API compatibility flag
- self.objinfo.has_new_constructor_api = (
- parent.has_new_constructor_api)
- elif self.objinfo.parent == 'GObject':
- self.objinfo.has_new_constructor_api = True
- return '0'
-
- def write_property_based_constructor(self, constructor):
- self.objinfo.has_new_constructor_api = True
- out = self.fp
- print >> out, "static int"
- print >> out, '_wrap_%s(PyGObject *self, PyObject *args,' \
- ' PyObject *kwargs)\n{' % constructor.c_name
- if constructor.params:
- s = " GType obj_type = pyg_type_from_object((PyObject *) self);"
- print >> out, s
-
- def py_str_list_to_c(arg):
- if arg:
- return "{" + ", ".join(
- map(lambda s: '"' + s + '"', arg)) + ", NULL }"
- else:
- return "{ NULL }"
-
- classname = '%s.%s' % (self.overrides.modulename,
- self.objinfo.name)
-
- if constructor.params:
- mandatory_arguments = [param for param in constructor.params
- if not param.optional]
- optional_arguments = [param for param in constructor.params
- if param.optional]
- arg_names = py_str_list_to_c(
- [param.argname
- for param in mandatory_arguments + optional_arguments])
-
- prop_names = py_str_list_to_c(
- [param.pname
- for param in mandatory_arguments + optional_arguments])
-
- print >> out, " GParameter params[%i];" % \
- len(constructor.params)
- print >> out, " PyObject *parsed_args[%i] = {NULL, };" % \
- len(constructor.params)
- print >> out, " char *arg_names[] = %s;" % arg_names
- print >> out, " char *prop_names[] = %s;" % prop_names
- print >> out, " guint nparams, i;"
- print >> out
- if constructor.deprecated is not None:
- out.write(
- ' if (PyErr_Warn(PyExc_DeprecationWarning, '
- '"%s") < 0)\n' %
- constructor.deprecated)
- print >> out, ' return -1;'
- print >> out
- out.write(" if (!PyArg_ParseTupleAndKeywords(args, kwargs, ")
- template = '"'
- if mandatory_arguments:
- template += "O"*len(mandatory_arguments)
- if optional_arguments:
- template += "|" + "O"*len(optional_arguments)
- template += ':%s.__init__"' % classname
- print >> out, template, ", arg_names",
- for i in range(len(constructor.params)):
- print >> out, ", &parsed_args[%i]" % i,
-
- out.write(
- "))\n"
- " return -1;\n"
- "\n"
- " memset(params, 0, sizeof(GParameter)*%i);\n"
- " if (!pyg_parse_constructor_args(obj_type, arg_names,\n"
- " prop_names, params, \n"
- " &nparams, parsed_args))\n"
- " return -1;\n"
- " pygobject_constructv(self, nparams, params);\n"
- " for (i = 0; i < nparams; ++i)\n"
- " g_value_unset(&params[i].value);\n"
- % len(constructor.params))
- else:
- out.write(
- " static char* kwlist[] = { NULL };\n"
- "\n")
-
- if constructor.deprecated is not None:
- out.write(
- ' if (PyErr_Warn(PyExc_DeprecationWarning, "%s") < 0)\n'
- ' return -1;\n'
- '\n' % constructor.deprecated)
-
- out.write(
- ' if (!PyArg_ParseTupleAndKeywords(args, kwargs,\n'
- ' ":%s.__init__",\n'
- ' kwlist))\n'
- ' return -1;\n'
- '\n'
- ' pygobject_constructv(self, 0, NULL);\n' % classname)
- out.write(
- ' if (!self->obj) {\n'
- ' PyErr_SetString(\n'
- ' PyExc_RuntimeError, \n'
- ' "could not create %s object");\n'
- ' return -1;\n'
- ' }\n' % classname)
-
- if not constructor.caller_owns_return:
- print >> out, " g_object_ref(self->obj);\n"
-
- out.write(
- ' return 0;\n'
- '}\n\n')
-
- return "_wrap_%s" % constructor.c_name
-
-
-class GInterfaceWrapper(GObjectWrapper):
- virtual_accessor_tmpl = (
- 'static PyObject *\n'
- '_wrap_%(cname)s(PyObject *cls%(extraparams)s)\n'
- '{\n'
- ' %(vtable)s *iface;\n'
- '%(varlist)s'
- '%(parseargs)s'
- '%(codebefore)s'
- ' iface = g_type_interface_peek('
- 'g_type_class_peek(pyg_type_from_object(cls)), %(typecode)s);\n'
- ' if (iface->%(virtual)s)\n'
- ' %(setreturn)siface->%(virtual)s(%(arglist)s);\n'
- ' else {\n'
- ' PyErr_SetString(PyExc_NotImplementedError, '
- '"interface method %(name)s not implemented");\n'
- ' return NULL;\n'
- ' }\n'
- '%(codeafter)s\n'
- '}\n\n'
- )
-
- def get_initial_class_substdict(self):
- return { 'tp_basicsize' : 'PyObject',
- 'tp_weaklistoffset' : '0',
- 'tp_dictoffset' : '0'}
-
- def write_constructor(self):
- # interfaces have no constructors ...
- return '0'
- def write_getsets(self):
- # interfaces have no fields ...
- return '0'
-
- def _get_class_virtual_substdict(self, meth, cname, parent):
- substdict = self.get_initial_method_substdict(meth)
- substdict['virtual'] = substdict['name'].split('.')[1]
- substdict['cname'] = cname
- substdict['typecode'] = self.objinfo.typecode
- substdict['vtable'] = self.objinfo.vtable
- return substdict
-
- def write_virtuals(self):
- ## Now write reverse method wrappers, which let python code
- ## implement interface methods.
- # First, get methods from the defs files
- klass = self.objinfo.c_name
- proxies = []
- for meth in self.parser.find_virtuals(self.objinfo):
- method_name = self.objinfo.c_name + "__proxy_do_" + meth.name
- if self.overrides.is_ignored(method_name):
- continue
- try:
- if self.overrides.is_overriden(method_name):
- if not self.overrides.is_already_included(method_name):
- data = self.overrides.override(method_name)
- self.write_function(method_name, data)
- else:
- # write proxy ...
- ret, props = argtypes.matcher.get_reverse_ret(meth.ret)
- wrapper = reversewrapper.ReverseWrapper(
- '_wrap_' + method_name, is_static=True)
- wrapper.set_return_type(ret(wrapper, **props))
- wrapper.add_parameter(reversewrapper.PyGObjectMethodParam(
- wrapper, "self", method_name="do_" + meth.name,
- c_type=(klass + ' *')))
- for param in meth.params:
- handler, props = argtypes.matcher.get_reverse(
- param.ptype)
- props["direction"] = param.pdir
- wrapper.add_parameter(
- handler(wrapper, param.pname, **props))
- buf = reversewrapper.MemoryCodeSink()
- wrapper.generate(buf)
- self.fp.write(buf.flush())
- proxies.append((fixname(meth.name), '_wrap_' + method_name))
- iproxies_coverage.declare_wrapped()
- except argtypes.ArgTypeError, ex:
- iproxies_coverage.declare_not_wrapped()
- proxies.append((fixname(meth.name), None))
- sys.stderr.write('Could not write interface proxy %s.%s: %s\n'
- % (klass, meth.name, str(ex)))
-
- if not proxies or not [cname for name, cname in proxies if cname]:
- return
-
- ## Write an interface init function for this object
- funcname = "__%s__interface_init" % klass
- vtable = self.objinfo.vtable
- self.fp.write(
- '\nstatic void\n'
- '%(funcname)s(%(vtable)s *iface, PyTypeObject *pytype)\n'
- '{\n'
- ' %(vtable)s *parent_iface = '
- 'g_type_interface_peek_parent(iface);\n'
- ' PyObject *py_method;\n'
- '\n'
- % vars())
-
- for name, cname in proxies:
- do_name = 'do_' + name
- if cname is None:
- continue
-
- self.fp.write((
- ' py_method = pytype? PyObject_GetAttrString('
- '(PyObject *) pytype, "%(do_name)s") : NULL;\n'
- ' if (py_method && !PyObject_TypeCheck(py_method, '
- '&PyCFunction_Type)) {\n'
- ' iface->%(name)s = %(cname)s;\n'
- ' } else {\n'
- ' PyErr_Clear();\n'
- ' if (parent_iface) {\n'
- ' iface->%(name)s = parent_iface->%(name)s;\n'
- ' }\n'
- ' Py_XDECREF(py_method);\n'
- ' }\n'
- ) % vars())
- self.fp.write('}\n\n')
- interface_info = "__%s__iinfo" % klass
- self.fp.write('''
-static const GInterfaceInfo %s = {
- (GInterfaceInitFunc) %s,
- NULL,
- NULL
-};
-''' % (interface_info, funcname))
- self.objinfo.interface_info = interface_info
-
-class GBoxedWrapper(Wrapper):
- constructor_tmpl = (
- 'static int\n'
- '_wrap_%(cname)s(PyGBoxed *self%(extraparams)s)\n'
- '{\n'
- '%(varlist)s'
- '%(parseargs)s'
- '%(codebefore)s'
- ' self->gtype = %(typecode)s;\n'
- ' self->free_on_dealloc = FALSE;\n'
- ' self->boxed = %(cname)s(%(arglist)s);\n'
- '%(codeafter)s\n'
- ' if (!self->boxed) {\n'
- ' PyErr_SetString(PyExc_RuntimeError, '
- '"could not create %(typename)s object");\n'
- ' return -1;\n'
- ' }\n'
- ' self->free_on_dealloc = TRUE;\n'
- ' return 0;\n'
- '}\n\n'
- )
-
- method_tmpl = (
- 'static PyObject *\n'
- '_wrap_%(cname)s(PyObject *self%(extraparams)s)\n'
- '{\n'
- '%(varlist)s'
- '%(parseargs)s'
- '%(codebefore)s'
- ' %(begin_allow_threads)s\n'
- ' %(setreturn)s%(cname)s(pyg_boxed_get(self, '
- '%(typename)s)%(arglist)s);\n'
- ' %(end_allow_threads)s\n'
- '%(codeafter)s\n'
- '}\n\n'
- )
-
- def get_initial_class_substdict(self):
- return { 'tp_basicsize' : 'PyGBoxed',
- 'tp_weaklistoffset' : '0',
- 'tp_dictoffset' : '0' }
-
- def get_field_accessor(self, fieldname):
- return 'pyg_boxed_get(self, %s)->%s' % (self.objinfo.c_name, fieldname)
-
- def get_initial_constructor_substdict(self, constructor):
- substdict = Wrapper.get_initial_constructor_substdict(
- self, constructor)
- substdict['typecode'] = self.objinfo.typecode
- return substdict
-
-class GPointerWrapper(GBoxedWrapper):
- constructor_tmpl = (
- 'static int\n'
- '_wrap_%(cname)s(PyGPointer *self%(extraparams)s)\n'
- '{\n'
- '%(varlist)s'
- '%(parseargs)s'
- '%(codebefore)s'
- ' self->gtype = %(typecode)s;\n'
- ' self->pointer = %(cname)s(%(arglist)s);\n'
- '%(codeafter)s\n'
- ' if (!self->pointer) {\n'
- ' PyErr_SetString(PyExc_RuntimeError, '
- '"could not create %(typename)s object");\n'
- ' return -1;\n'
- ' }\n'
- ' return 0;\n'
- '}\n\n'
- )
-
- method_tmpl = (
- 'static PyObject *\n'
- '_wrap_%(cname)s(PyObject *self%(extraparams)s)\n'
- '{\n'
- '%(varlist)s'
- '%(parseargs)s'
- '%(codebefore)s'
- ' %(setreturn)s%(cname)s(pyg_pointer_get(self, '
- '%(typename)s)%(arglist)s);\n'
- '%(codeafter)s\n'
- '}\n\n'
- )
-
- def get_initial_class_substdict(self):
- return { 'tp_basicsize' : 'PyGPointer',
- 'tp_weaklistoffset' : '0',
- 'tp_dictoffset' : '0' }
-
- def get_field_accessor(self, fieldname):
- return 'pyg_pointer_get(self, %s)->%s' % (self.objinfo.c_name,
- fieldname)
-
- def get_initial_constructor_substdict(self, constructor):
- substdict = Wrapper.get_initial_constructor_substdict(
- self, constructor)
- substdict['typecode'] = self.objinfo.typecode
- return substdict
-
-class SourceWriter:
- def __init__(self, parser, overrides, prefix, fp=FileOutput(sys.stdout)):
- self.parser = parser
- self.overrides = overrides
- self.prefix = prefix
- self.fp = fp
-
- def write(self, py_ssize_t_clean=False):
- argtypes.py_ssize_t_clean = py_ssize_t_clean
-
- self.write_headers(py_ssize_t_clean)
- self.write_imports()
- self.write_type_declarations()
- self.write_body()
- self.write_classes()
-
- wrapper = Wrapper(self.parser, None, self.overrides, self.fp)
- wrapper.write_functions(self, self.prefix)
-
- if not self.overrides.dynamicnamespace:
- self.write_enums()
- self.write_extension_init()
- self.write_registers()
-
- argtypes.py_ssize_t_clean = False
-
- def write_headers(self, py_ssize_t_clean):
- self.fp.write('/* -- THIS FILE IS GENERATED - DO NOT EDIT */')
- self.fp.write('/* -*- Mode: C; c-basic-offset: 4 -*- */\n\n')
- if py_ssize_t_clean:
- self.fp.write('#define PY_SSIZE_T_CLEAN\n')
- self.fp.write('#include <Python.h>\n\n\n')
- if py_ssize_t_clean:
- self.fp.write('''
-
-#if PY_VERSION_HEX < 0x02050000
-typedef int Py_ssize_t;
-#define PY_SSIZE_T_MAX INT_MAX
-#define PY_SSIZE_T_MIN INT_MIN
-typedef inquiry lenfunc;
-typedef intargfunc ssizeargfunc;
-typedef intobjargproc ssizeobjargproc;
-#endif
-
-''')
- self.fp.write(self.overrides.get_headers())
- self.fp.resetline()
- self.fp.write('\n\n')
-
- def write_imports(self):
- self.fp.write('/* ---------- types from other modules ---------- */\n')
- for module, pyname, cname in self.overrides.get_imports():
- self.fp.write('static PyTypeObject *_%s;\n' % cname)
- self.fp.write('#define %s (*_%s)\n' % (cname, cname))
- self.fp.write('\n\n')
-
- def write_type_declarations(self):
- #todo use 'static' if used only in one file
- self.fp.write('/* ---------- forward type declarations ---------- */\n')
- for obj in self.parser.boxes:
- if not self.overrides.is_type_ignored(obj.c_name):
- self.fp.write('PyTypeObject G_GNUC_INTERNAL Py' + obj.c_name + '_Type;\n')
- for obj in self.parser.objects:
- if not self.overrides.is_type_ignored(obj.c_name):
- self.fp.write('PyTypeObject G_GNUC_INTERNAL Py' + obj.c_name + '_Type;\n')
- for interface in self.parser.interfaces:
- if not self.overrides.is_type_ignored(interface.c_name):
- self.fp.write('PyTypeObject G_GNUC_INTERNAL Py' + interface.c_name + '_Type;\n')
- self.fp.write('\n')
-
- def write_body(self):
- self.fp.write(self.overrides.get_body())
- self.fp.resetline()
- self.fp.write('\n\n')
-
- def _sort_parent_children(self, objects):
- objects = list(objects)
- modified = True
- while modified:
- modified = False
- parent_index = None
- child_index = None
- for i, obj in enumerate(objects):
- if obj.parent == 'GObject':
- continue
- if obj.parent not in [info.c_name for info in objects[:i]]:
- for j, info in enumerate(objects[i+1:]):
- if info.c_name == obj.parent:
- parent_index = i + 1 + j
- child_index = i
- break
- else:
- continue
- break
- if child_index is not None and parent_index is not None:
- if child_index != parent_index:
- objects.insert(child_index, objects.pop(parent_index))
- modified = True
- return objects
-
- def write_classes(self):
- ## Sort the objects, so that we generate code for the parent types
- ## before their children.
- objects = self._sort_parent_children(self.parser.objects)
-
- for klass, items in ((GBoxedWrapper, self.parser.boxes),
- (GPointerWrapper, self.parser.pointers),
- (GObjectWrapper, objects),
- (GInterfaceWrapper, self.parser.interfaces)):
- for item in items:
- instance = klass(self.parser, item, self.overrides, self.fp)
- instance.write_class()
- self.fp.write('\n')
-
- def get_enums(self):
- enums = []
- for enum in self.parser.enums:
- if self.overrides.is_type_ignored(enum.c_name):
- continue
- enums.append(enum)
- return enums
-
- def write_enums(self):
- if not self.parser.enums:
- return
-
- self.fp.write('\n/* ----------- enums and flags ----------- */\n\n')
- self.fp.write(
- 'void\n' + self.prefix +
- '_add_constants(PyObject *module, const gchar *strip_prefix)\n{\n')
-
- for enum in self.get_enums():
- if enum.typecode is None:
- for nick, value in enum.values:
- self.fp.write(
- ' PyModule_AddIntConstant(module, '
- '(char *) pyg_constant_strip_prefix("%s", strip_prefix), %s);\n'
- % (value, value))
- else:
- if enum.deftype == 'enum':
- self.fp.write(' pyg_enum_add(module, "%s", strip_prefix, %s);\n'
- % (enum.name, enum.typecode))
- else:
- self.fp.write(' pyg_flags_add(module, "%s", strip_prefix, %s);\n'
- % (enum.name, enum.typecode))
-
- self.fp.write('\n')
- self.fp.write(' if (PyErr_Occurred())\n')
- self.fp.write(' PyErr_Print();\n')
- self.fp.write('}\n\n')
-
- def write_object_imports(self, retval=''):
- imports = self.overrides.get_imports()[:]
- if not imports:
- return
-
- bymod = {}
- for module, pyname, cname in imports:
- bymod.setdefault(module, []).append((pyname, cname))
- self.fp.write(' PyObject *module;\n\n')
- for module in bymod:
- self.fp.write(
- ' if ((module = PyImport_ImportModule("%s")) != NULL) {\n'
- % module)
- #self.fp.write(
- # ' PyObject *moddict = PyModule_GetDict(module);\n\n')
- for pyname, cname in bymod[module]:
- #self.fp.write(
- # ' _%s = (PyTypeObject *)PyDict_GetItemString('
- # 'moddict, "%s");\n' % (cname, pyname))
- self.fp.write(
- ' _%s = (PyTypeObject *)PyObject_GetAttrString('
- 'module, "%s");\n' % (cname, pyname))
- self.fp.write(' if (_%s == NULL) {\n' % cname)
- self.fp.write(' PyErr_SetString(PyExc_ImportError,\n')
- self.fp.write(' "cannot import name %s from %s");\n'
- % (pyname, module))
- self.fp.write(' return %s;\n' % retval)
- self.fp.write(' }\n')
- self.fp.write(' } else {\n')
- self.fp.write(' PyErr_SetString(PyExc_ImportError,\n')
- self.fp.write(' "could not import %s");\n' % module)
- self.fp.write(' return %s;\n' % retval)
- self.fp.write(' }\n')
- self.fp.write('\n')
-
- def write_extension_init(self):
- self.fp.write('/* initialise stuff extension classes */\n')
- self.fp.write('void\n' + self.prefix + '_register_classes(PyObject *d)\n{\n')
- self.write_object_imports()
- self.fp.write(self.overrides.get_init() + '\n')
- self.fp.resetline()
-
- def get_classes(self):
- objects = self.parser.objects[:]
- pos = 0
- while pos < len(objects):
- parent = objects[pos].parent
- for i in range(pos+1, len(objects)):
- if objects[i].c_name == parent:
- objects.insert(i+1, objects[pos])
- del objects[pos]
- break
- else:
- pos = pos + 1
-
- retval = []
- for obj in objects:
- if self.overrides.is_type_ignored(obj.c_name):
- continue
- bases = []
- if obj.parent != None:
- bases.append(obj.parent)
- bases = bases + obj.implements
- retval.append((obj, bases))
-
- return retval
-
- def write_registers(self):
- for boxed in self.parser.boxes:
- if not self.overrides.is_type_ignored(boxed.c_name):
- self.fp.write(' pyg_register_boxed(d, "' + boxed.name +
- '", ' + boxed.typecode +
- ', &Py' + boxed.c_name +
- '_Type);\n')
- for pointer in self.parser.pointers:
- if not self.overrides.is_type_ignored(pointer.c_name):
- self.fp.write(' pyg_register_pointer(d, "' + pointer.name +
- '", ' + pointer.typecode +
- ', &Py' + pointer.c_name + '_Type);\n')
- for interface in self.parser.interfaces:
- if not self.overrides.is_type_ignored(interface.c_name):
- self.fp.write(' pyg_register_interface(d, "'
- + interface.name + '", '+ interface.typecode
- + ', &Py' + interface.c_name + '_Type);\n')
- if interface.interface_info is not None:
- self.fp.write(' pyg_register_interface_info(%s, &%s);\n' %
- (interface.typecode, interface.interface_info))
-
- if not self.overrides.dynamicnamespace:
- for obj, bases in self.get_classes():
- self.write_class(obj, bases)
- else:
- for obj, bases in self.get_classes():
- self.fp.write(
- ' pyg_type_register_custom_callback("%s", '
- '(PyGTypeRegistrationFunction)%s_register_type, d);\n' %
- (obj.c_name, obj.c_name))
-
- self.fp.write('}\n')
-
- def _can_direct_ref(self, base):
- if not self.overrides.dynamicnamespace:
- return True
- if base == 'GObject':
- return True
- obj = get_object_by_name(base)
- if obj.module.lower() != self.overrides.modulename:
- return True
- return False
-
- def write_class(self, obj, bases, indent=1):
- indent_str = ' ' * (indent * 4)
- if bases:
- bases_str = 'Py_BuildValue("(%s)"' % (len(bases) * 'O')
-
- for base in bases:
- if self._can_direct_ref(base):
- bases_str += ', &Py%s_Type' % base
- else:
- baseobj = get_object_by_name(base)
- bases_str += ', PyObject_GetAttrString(m, "%s")' % baseobj.name
- bases_str += ')'
- else:
- bases_str = 'NULL'
-
- self.fp.write(
- '%(indent)spygobject_register_class(d, "%(c_name)s", %(typecode)s, &Py%(c_name)s_Type, %(bases)s);\n'
- % dict(indent=indent_str, c_name=obj.c_name, typecode=obj.typecode, bases=bases_str))
-
- if obj.has_new_constructor_api:
- self.fp.write(
- indent_str + 'pyg_set_object_has_new_constructor(%s);\n' %
- obj.typecode)
- else:
- print >> sys.stderr, (
- "Warning: Constructor for %s needs to be updated to new API\n"
- " See http://live.gnome.org/PyGTK_2fWhatsNew28"
- "#update-constructors") % obj.c_name
-
- if obj.class_init_func is not None:
- self.fp.write(
- indent_str + 'pyg_register_class_init(%s, %s);\n' %
- (obj.typecode, obj.class_init_func))
-
-_objects = {}
-
-def get_object_by_name(c_name):
- global _objects
- return _objects[c_name]
-
-def register_types(parser):
- global _objects
- for boxed in parser.boxes:
- argtypes.matcher.register_boxed(boxed.c_name, boxed.typecode)
- _objects[boxed.c_name] = boxed
- for pointer in parser.pointers:
- argtypes.matcher.register_pointer(pointer.c_name, pointer.typecode)
- for obj in parser.objects:
- argtypes.matcher.register_object(obj.c_name, obj.parent, obj.typecode)
- _objects[obj.c_name] = obj
- for iface in parser.interfaces:
- argtypes.matcher.register_object(iface.c_name, None, iface.typecode)
- _objects[iface.c_name] = iface
- for enum in parser.enums:
- if enum.deftype == 'flags':
- argtypes.matcher.register_flag(enum.c_name, enum.typecode)
- else:
- argtypes.matcher.register_enum(enum.c_name, enum.typecode)
-
-usage = 'usage: codegen.py [-o overridesfile] [-p prefix] defsfile'
-def main(argv):
- o = override.Overrides()
- prefix = 'pygtk'
- outfilename = None
- errorfilename = None
- opts, args = getopt.getopt(argv[1:], "o:p:r:t:D:I:",
- ["override=", "prefix=", "register=", "outfilename=",
- "load-types=", "errorfilename=", "py_ssize_t-clean"])
- defines = {} # -Dkey[=val] options
- py_ssize_t_clean = False
- for opt, arg in opts:
- if opt in ('-o', '--override'):
- o = override.Overrides(arg)
- elif opt in ('-p', '--prefix'):
- prefix = arg
- elif opt in ('-r', '--register'):
- # Warning: user has to make sure all -D options appear before -r
- p = defsparser.DefsParser(arg, defines)
- p.startParsing()
- register_types(p)
- del p
- elif opt == '--outfilename':
- outfilename = arg
- elif opt == '--errorfilename':
- errorfilename = arg
- elif opt in ('-t', '--load-types'):
- globals = {}
- execfile(arg, globals)
- elif opt == '-D':
- nameval = arg.split('=')
- try:
- defines[nameval[0]] = nameval[1]
- except IndexError:
- defines[nameval[0]] = None
- elif opt == '-I':
- defsparser.include_path.insert(0, arg)
- elif opt == '--py_ssize_t-clean':
- py_ssize_t_clean = True
- if len(args) < 1:
- print >> sys.stderr, usage
- return 1
- if errorfilename:
- sys.stderr = open(errorfilename, "w")
- p = defsparser.DefsParser(args[0], defines)
- if not outfilename:
- outfilename = os.path.splitext(args[0])[0] + '.c'
-
- p.startParsing()
-
- register_types(p)
- sw = SourceWriter(p, o, prefix, FileOutput(sys.stdout, outfilename))
- sw.write(py_ssize_t_clean)
-
- functions_coverage.printstats()
- methods_coverage.printstats()
- vproxies_coverage.printstats()
- vaccessors_coverage.printstats()
- iproxies_coverage.printstats()
-
-if __name__ == '__main__':
- sys.exit(main(sys.argv))
diff --git a/codegen/createdefs.py b/codegen/createdefs.py
deleted file mode 100644
index 84d50b19..00000000
--- a/codegen/createdefs.py
+++ /dev/null
@@ -1,17 +0,0 @@
-#!/usr/bin/env python
-import sys
-
-def main(args):
- output = args[1]
- input = args[2:]
- outfd = open(output, 'w')
- outfd.write(';; -*- scheme -*-\n')
- outfd.write(';; THIS FILE IS GENERATED - DO NOT EDIT\n')
- for filename in input:
- outfd.write('(include "%s")\n' % filename)
- outfd.close()
-
- return 0
-
-if __name__ == '__main__':
- sys.exit(main(sys.argv))
diff --git a/codegen/definitions.py b/codegen/definitions.py
deleted file mode 100644
index 617bcbee..00000000
--- a/codegen/definitions.py
+++ /dev/null
@@ -1,547 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-import copy
-import sys
-
-def get_valid_scheme_definitions(defs):
- return [x for x in defs if isinstance(x, tuple) and len(x) >= 2]
-
-def unescape(s):
- s = s.replace('\r\n', '\\r\\n').replace('\t', '\\t')
- return s.replace('\r', '\\r').replace('\n', '\\n')
-
-def make_docstring(lines):
- return "(char *) " + '\n'.join(['"%s"' % unescape(s) for s in lines])
-
-# New Parameter class, wich emulates a tuple for compatibility reasons
-class Parameter(object):
- def __init__(self, ptype, pname, pdflt, pnull, pdir=None):
- self.ptype = ptype
- self.pname = pname
- self.pdflt = pdflt
- self.pnull = pnull
- self.pdir = pdir
-
- def __len__(self): return 4
- def __getitem__(self, i):
- return (self.ptype, self.pname, self.pdflt, self.pnull)[i]
-
- def merge(self, old):
- if old.pdflt is not None:
- self.pdflt = old.pdflt
- if old.pnull is not None:
- self.pnull = old.pnull
-
-# Parameter for property based constructors
-class Property(object):
- def __init__(self, pname, optional, argname):
- self.pname = pname
- self.optional = optional
- self.argname = argname
-
- def merge(self, old):
- if old.optional is not None:
- self.optional = old.optional
- if old.argname is not None:
- self.argname = old.argname
-
-
-class Definition:
- docstring = "NULL"
- def __init__(self, *args):
- """Create a new defs object of this type. The arguments are the
- components of the definition"""
- raise RuntimeError, "this is an abstract class"
- def merge(self, old):
- """Merge in customisations from older version of definition"""
- raise RuntimeError, "this is an abstract class"
- def write_defs(self, fp=sys.stdout):
- """write out this definition in defs file format"""
- raise RuntimeError, "this is an abstract class"
-
- def guess_return_value_ownership(self):
- "return 1 if caller owns return value"
- if getattr(self, 'is_constructor_of', False):
- self.caller_owns_return = True
- elif self.ret in ('char*', 'gchar*', 'string'):
- self.caller_owns_return = True
- else:
- self.caller_owns_return = False
-
-
-class ObjectDef(Definition):
- def __init__(self, name, *args):
- self.name = name
- self.module = None
- self.parent = None
- self.c_name = None
- self.typecode = None
- self.fields = []
- self.implements = []
- self.class_init_func = None
- self.has_new_constructor_api = False
- for arg in get_valid_scheme_definitions(args):
- if arg[0] == 'in-module':
- self.module = arg[1]
- elif arg[0] == 'docstring':
- self.docstring = make_docstring(arg[1:])
- elif arg[0] == 'parent':
- self.parent = arg[1]
- elif arg[0] == 'c-name':
- self.c_name = arg[1]
- elif arg[0] == 'gtype-id':
- self.typecode = arg[1]
- elif arg[0] == 'fields':
- for parg in arg[1:]:
- self.fields.append((parg[0], parg[1]))
- elif arg[0] == 'implements':
- self.implements.append(arg[1])
- def merge(self, old):
- # currently the .h parser doesn't try to work out what fields of
- # an object structure should be public, so we just copy the list
- # from the old version ...
- self.fields = old.fields
- self.implements = old.implements
- def write_defs(self, fp=sys.stdout):
- fp.write('(define-object ' + self.name + '\n')
- if self.module:
- fp.write(' (in-module "' + self.module + '")\n')
- if self.parent != (None, None):
- fp.write(' (parent "' + self.parent + '")\n')
- for interface in self.implements:
- fp.write(' (implements "' + interface + '")\n')
- if self.c_name:
- fp.write(' (c-name "' + self.c_name + '")\n')
- if self.typecode:
- fp.write(' (gtype-id "' + self.typecode + '")\n')
- if self.fields:
- fp.write(' (fields\n')
- for (ftype, fname) in self.fields:
- fp.write(' \'("' + ftype + '" "' + fname + '")\n')
- fp.write(' )\n')
- fp.write(')\n\n')
-
-class InterfaceDef(Definition):
- def __init__(self, name, *args):
- self.name = name
- self.module = None
- self.c_name = None
- self.typecode = None
- self.vtable = None
- self.fields = []
- self.interface_info = None
- for arg in get_valid_scheme_definitions(args):
- if arg[0] == 'in-module':
- self.module = arg[1]
- elif arg[0] == 'docstring':
- self.docstring = make_docstring(arg[1:])
- elif arg[0] == 'c-name':
- self.c_name = arg[1]
- elif arg[0] == 'gtype-id':
- self.typecode = arg[1]
- elif arg[0] == 'vtable':
- self.vtable = arg[1]
- if self.vtable is None:
- self.vtable = self.c_name + "Iface"
- def write_defs(self, fp=sys.stdout):
- fp.write('(define-interface ' + self.name + '\n')
- if self.module:
- fp.write(' (in-module "' + self.module + '")\n')
- if self.c_name:
- fp.write(' (c-name "' + self.c_name + '")\n')
- if self.typecode:
- fp.write(' (gtype-id "' + self.typecode + '")\n')
- fp.write(')\n\n')
-
-class EnumDef(Definition):
- def __init__(self, name, *args):
- self.deftype = 'enum'
- self.name = name
- self.in_module = None
- self.c_name = None
- self.typecode = None
- self.values = []
- for arg in get_valid_scheme_definitions(args):
- if arg[0] == 'in-module':
- self.in_module = arg[1]
- elif arg[0] == 'c-name':
- self.c_name = arg[1]
- elif arg[0] == 'gtype-id':
- self.typecode = arg[1]
- elif arg[0] == 'values':
- for varg in arg[1:]:
- self.values.append((varg[0], varg[1]))
- def merge(self, old):
- pass
- def write_defs(self, fp=sys.stdout):
- fp.write('(define-' + self.deftype + ' ' + self.name + '\n')
- if self.in_module:
- fp.write(' (in-module "' + self.in_module + '")\n')
- fp.write(' (c-name "' + self.c_name + '")\n')
- fp.write(' (gtype-id "' + self.typecode + '")\n')
- if self.values:
- fp.write(' (values\n')
- for name, val in self.values:
- fp.write(' \'("' + name + '" "' + val + '")\n')
- fp.write(' )\n')
- fp.write(')\n\n')
-
-class FlagsDef(EnumDef):
- def __init__(self, *args):
- apply(EnumDef.__init__, (self,) + args)
- self.deftype = 'flags'
-
-class BoxedDef(Definition):
- def __init__(self, name, *args):
- self.name = name
- self.module = None
- self.c_name = None
- self.typecode = None
- self.copy = None
- self.release = None
- self.fields = []
- for arg in get_valid_scheme_definitions(args):
- if arg[0] == 'in-module':
- self.module = arg[1]
- elif arg[0] == 'c-name':
- self.c_name = arg[1]
- elif arg[0] == 'gtype-id':
- self.typecode = arg[1]
- elif arg[0] == 'copy-func':
- self.copy = arg[1]
- elif arg[0] == 'release-func':
- self.release = arg[1]
- elif arg[0] == 'fields':
- for parg in arg[1:]:
- self.fields.append((parg[0], parg[1]))
- def merge(self, old):
- # currently the .h parser doesn't try to work out what fields of
- # an object structure should be public, so we just copy the list
- # from the old version ...
- self.fields = old.fields
- def write_defs(self, fp=sys.stdout):
- fp.write('(define-boxed ' + self.name + '\n')
- if self.module:
- fp.write(' (in-module "' + self.module + '")\n')
- if self.c_name:
- fp.write(' (c-name "' + self.c_name + '")\n')
- if self.typecode:
- fp.write(' (gtype-id "' + self.typecode + '")\n')
- if self.copy:
- fp.write(' (copy-func "' + self.copy + '")\n')
- if self.release:
- fp.write(' (release-func "' + self.release + '")\n')
- if self.fields:
- fp.write(' (fields\n')
- for (ftype, fname) in self.fields:
- fp.write(' \'("' + ftype + '" "' + fname + '")\n')
- fp.write(' )\n')
- fp.write(')\n\n')
-
-class PointerDef(Definition):
- def __init__(self, name, *args):
- self.name = name
- self.module = None
- self.c_name = None
- self.typecode = None
- self.fields = []
- for arg in get_valid_scheme_definitions(args):
- if arg[0] == 'in-module':
- self.module = arg[1]
- elif arg[0] == 'c-name':
- self.c_name = arg[1]
- elif arg[0] == 'gtype-id':
- self.typecode = arg[1]
- elif arg[0] == 'fields':
- for parg in arg[1:]:
- self.fields.append((parg[0], parg[1]))
- def merge(self, old):
- # currently the .h parser doesn't try to work out what fields of
- # an object structure should be public, so we just copy the list
- # from the old version ...
- self.fields = old.fields
- def write_defs(self, fp=sys.stdout):
- fp.write('(define-pointer ' + self.name + '\n')
- if self.module:
- fp.write(' (in-module "' + self.module + '")\n')
- if self.c_name:
- fp.write(' (c-name "' + self.c_name + '")\n')
- if self.typecode:
- fp.write(' (gtype-id "' + self.typecode + '")\n')
- if self.fields:
- fp.write(' (fields\n')
- for (ftype, fname) in self.fields:
- fp.write(' \'("' + ftype + '" "' + fname + '")\n')
- fp.write(' )\n')
- fp.write(')\n\n')
-
-class MethodDefBase(Definition):
- def __init__(self, name, *args):
- dump = 0
- self.name = name
- self.ret = None
- self.caller_owns_return = None
- self.unblock_threads = None
- self.c_name = None
- self.typecode = None
- self.of_object = None
- self.params = [] # of form (type, name, default, nullok)
- self.varargs = 0
- self.deprecated = None
- for arg in get_valid_scheme_definitions(args):
- if arg[0] == 'of-object':
- self.of_object = arg[1]
- elif arg[0] == 'docstring':
- self.docstring = make_docstring(arg[1:])
- elif arg[0] == 'c-name':
- self.c_name = arg[1]
- elif arg[0] == 'gtype-id':
- self.typecode = arg[1]
- elif arg[0] == 'return-type':
- self.ret = arg[1]
- elif arg[0] == 'caller-owns-return':
- self.caller_owns_return = arg[1] in ('t', '#t')
- elif arg[0] == 'unblock-threads':
- self.unblock_threads = arg[1] in ('t', '#t')
- elif arg[0] == 'parameters':
- for parg in arg[1:]:
- ptype = parg[0]
- pname = parg[1]
- pdflt = None
- pnull = 0
- pdir = None
- for farg in parg[2:]:
- assert isinstance(farg, tuple)
- if farg[0] == 'default':
- pdflt = farg[1]
- elif farg[0] == 'null-ok':
- pnull = 1
- elif farg[0] == 'direction':
- pdir = farg[1]
- self.params.append(Parameter(ptype, pname, pdflt, pnull, pdir))
- elif arg[0] == 'varargs':
- self.varargs = arg[1] in ('t', '#t')
- elif arg[0] == 'deprecated':
- self.deprecated = arg[1]
- else:
- sys.stderr.write("Warning: %s argument unsupported.\n"
- % (arg[0]))
- dump = 1
- if dump:
- self.write_defs(sys.stderr)
-
- if self.caller_owns_return is None and self.ret is not None:
- self.guess_return_value_ownership()
-
- def merge(self, old, parmerge):
- self.caller_owns_return = old.caller_owns_return
- self.varargs = old.varargs
- # here we merge extra parameter flags accross to the new object.
- if not parmerge:
- self.params = copy.deepcopy(old.params)
- return
- for i in range(len(self.params)):
- ptype, pname, pdflt, pnull = self.params[i]
- for p2 in old.params:
- if p2[1] == pname:
- self.params[i] = (ptype, pname, p2[2], p2[3])
- break
- def _write_defs(self, fp=sys.stdout):
- if self.of_object != (None, None):
- fp.write(' (of-object "' + self.of_object + '")\n')
- if self.c_name:
- fp.write(' (c-name "' + self.c_name + '")\n')
- if self.typecode:
- fp.write(' (gtype-id "' + self.typecode + '")\n')
- if self.caller_owns_return:
- fp.write(' (caller-owns-return #t)\n')
- if self.unblock_threads:
- fp.write(' (unblock_threads #t)\n')
- if self.ret:
- fp.write(' (return-type "' + self.ret + '")\n')
- if self.deprecated:
- fp.write(' (deprecated "' + self.deprecated + '")\n')
- if self.params:
- fp.write(' (parameters\n')
- for ptype, pname, pdflt, pnull in self.params:
- fp.write(' \'("' + ptype + '" "' + pname +'"')
- if pdflt: fp.write(' (default "' + pdflt + '")')
- if pnull: fp.write(' (null-ok)')
- fp.write(')\n')
- fp.write(' )\n')
- if self.varargs:
- fp.write(' (varargs #t)\n')
- fp.write(')\n\n')
-
-
-class MethodDef(MethodDefBase):
- def __init__(self, name, *args):
- MethodDefBase.__init__(self, name, *args)
- for item in ('c_name', 'of_object'):
- if self.__dict__[item] == None:
- self.write_defs(sys.stderr)
- raise RuntimeError, "definition missing required %s" % (item,)
-
- def write_defs(self, fp=sys.stdout):
- fp.write('(define-method ' + self.name + '\n')
- self._write_defs(fp)
-
-class VirtualDef(MethodDefBase):
- def write_defs(self, fp=sys.stdout):
- fp.write('(define-virtual ' + self.name + '\n')
- self._write_defs(fp)
-
-class FunctionDef(Definition):
- def __init__(self, name, *args):
- dump = 0
- self.name = name
- self.in_module = None
- self.is_constructor_of = None
- self.ret = None
- self.caller_owns_return = None
- self.unblock_threads = None
- self.c_name = None
- self.typecode = None
- self.params = [] # of form (type, name, default, nullok)
- self.varargs = 0
- self.deprecated = None
- for arg in get_valid_scheme_definitions(args):
- if arg[0] == 'in-module':
- self.in_module = arg[1]
- elif arg[0] == 'docstring':
- self.docstring = make_docstring(arg[1:])
- elif arg[0] == 'is-constructor-of':
- self.is_constructor_of = arg[1]
- elif arg[0] == 'c-name':
- self.c_name = arg[1]
- elif arg[0] == 'gtype-id':
- self.typecode = arg[1]
- elif arg[0] == 'return-type':
- self.ret = arg[1]
- elif arg[0] == 'caller-owns-return':
- self.caller_owns_return = arg[1] in ('t', '#t')
- elif arg[0] == 'unblock-threads':
- self.unblock_threads = arg[1] in ('t', '#t')
- elif arg[0] == 'parameters':
- for parg in arg[1:]:
- ptype = parg[0]
- pname = parg[1]
- pdflt = None
- pnull = 0
- for farg in parg[2:]:
- if farg[0] == 'default':
- pdflt = farg[1]
- elif farg[0] == 'null-ok':
- pnull = 1
- self.params.append(Parameter(ptype, pname, pdflt, pnull))
- elif arg[0] == 'properties':
- if self.is_constructor_of is None:
- print >> sys.stderr, "Warning: (properties ...) "\
- "is only valid for constructors"
- for prop in arg[1:]:
- pname = prop[0]
- optional = False
- argname = pname
- for farg in prop[1:]:
- if farg[0] == 'optional':
- optional = True
- elif farg[0] == 'argname':
- argname = farg[1]
- self.params.append(Property(pname, optional, argname))
- elif arg[0] == 'varargs':
- self.varargs = arg[1] in ('t', '#t')
- elif arg[0] == 'deprecated':
- self.deprecated = arg[1]
- else:
- sys.stderr.write("Warning: %s argument unsupported\n"
- % (arg[0],))
- dump = 1
- if dump:
- self.write_defs(sys.stderr)
-
- if self.caller_owns_return is None and self.ret is not None:
- self.guess_return_value_ownership()
- for item in ('c_name',):
- if self.__dict__[item] == None:
- self.write_defs(sys.stderr)
- raise RuntimeError, "definition missing required %s" % (item,)
-
- _method_write_defs = MethodDef.__dict__['write_defs']
-
- def merge(self, old, parmerge):
- self.caller_owns_return = old.caller_owns_return
- self.varargs = old.varargs
- if not parmerge:
- self.params = copy.deepcopy(old.params)
- return
- # here we merge extra parameter flags accross to the new object.
- def merge_param(param):
- for old_param in old.params:
- if old_param.pname == param.pname:
- if isinstance(old_param, Property):
- # h2def never scans Property's, therefore if
- # we have one it was manually written, so we
- # keep it.
- return copy.deepcopy(old_param)
- else:
- param.merge(old_param)
- return param
- raise RuntimeError, "could not find %s in old_parameters %r" % (
- param.pname, [p.pname for p in old.params])
- try:
- self.params = map(merge_param, self.params)
- except RuntimeError:
- # parameter names changed and we can't find a match; it's
- # safer to keep the old parameter list untouched.
- self.params = copy.deepcopy(old.params)
-
- if not self.is_constructor_of:
- try:
- self.is_constructor_of = old.is_constructor_of
- except AttributeError:
- pass
- if isinstance(old, MethodDef):
- self.name = old.name
- # transmogrify from function into method ...
- self.write_defs = self._method_write_defs
- self.of_object = old.of_object
- del self.params[0]
- def write_defs(self, fp=sys.stdout):
- fp.write('(define-function ' + self.name + '\n')
- if self.in_module:
- fp.write(' (in-module "' + self.in_module + '")\n')
- if self.is_constructor_of:
- fp.write(' (is-constructor-of "' + self.is_constructor_of +'")\n')
- if self.c_name:
- fp.write(' (c-name "' + self.c_name + '")\n')
- if self.typecode:
- fp.write(' (gtype-id "' + self.typecode + '")\n')
- if self.caller_owns_return:
- fp.write(' (caller-owns-return #t)\n')
- if self.unblock_threads:
- fp.write(' (unblock-threads #t)\n')
- if self.ret:
- fp.write(' (return-type "' + self.ret + '")\n')
- if self.deprecated:
- fp.write(' (deprecated "' + self.deprecated + '")\n')
- if self.params:
- if isinstance(self.params[0], Parameter):
- fp.write(' (parameters\n')
- for ptype, pname, pdflt, pnull in self.params:
- fp.write(' \'("' + ptype + '" "' + pname +'"')
- if pdflt: fp.write(' (default "' + pdflt + '")')
- if pnull: fp.write(' (null-ok)')
- fp.write(')\n')
- fp.write(' )\n')
- elif isinstance(self.params[0], Property):
- fp.write(' (properties\n')
- for prop in self.params:
- fp.write(' \'("' + prop.pname +'"')
- if prop.optional: fp.write(' (optional)')
- fp.write(')\n')
- fp.write(' )\n')
- else:
- assert False, "strange parameter list %r" % self.params[0]
- if self.varargs:
- fp.write(' (varargs #t)\n')
-
- fp.write(')\n\n')
diff --git a/codegen/defsconvert.py b/codegen/defsconvert.py
deleted file mode 100644
index 2e71f7b8..00000000
--- a/codegen/defsconvert.py
+++ /dev/null
@@ -1,130 +0,0 @@
-import sys
-import string, re
-
-# ------------------ Create typecodes from typenames ---------
-
-_upperstr_pat1 = re.compile(r'([^A-Z])([A-Z])')
-_upperstr_pat2 = re.compile(r'([A-Z][A-Z])([A-Z][0-9a-z])')
-_upperstr_pat3 = re.compile(r'^([A-Z])([A-Z])')
-
-def to_upper_str(name):
- """Converts a typename to the equivalent upercase and underscores
- name. This is used to form the type conversion macros and enum/flag
- name variables"""
- name = _upperstr_pat1.sub(r'\1_\2', name)
- name = _upperstr_pat2.sub(r'\1_\2', name)
- name = _upperstr_pat3.sub(r'\1_\2', name, count=1)
- return string.upper(name)
-
-def typecode(typename):
- """create a typecode (eg. GTK_TYPE_WIDGET) from a typename"""
- return string.replace(to_upper_str(typename), '_', '_TYPE_', 1)
-
-
-STATE_START = 0
-STATE_OBJECT = 1
-STATE_INTERFACE = 2
-STATE_BOXED = 3
-STATE_ENUM = 4
-STATE_FLAGS = 5
-STATE_METHOD = 6
-STATE_FUNCTION = 7
-
-def convert(infp=sys.stdin, outfp=sys.stdout):
- state = STATE_START
- seen_params = 0
-
- line = infp.readline()
- while line:
- if line[:8] == '(object ':
- state = STATE_OBJECT
- seen_params = 0
- outfp.write('(define-object ' + line[8:])
- elif line[:11] == '(interface ':
- state = STATE_INTERFACE
- seen_params = 0
- outfp.write('(define-interface ' + line[11:])
- elif line[:7] == '(boxed ':
- state = STATE_BOXED
- seen_params = 0
- outfp.write('(define-boxed ' + line[7:])
- elif line[:6] == '(enum ':
- state = STATE_ENUM
- seen_params = 0
- outfp.write('(define-enum ' + line[6:])
- elif line[:7] == '(flags ':
- state = STATE_FLAGS
- seen_params = 0
- outfp.write('(define-flags ' + line[7:])
- elif line[:8] == '(method ':
- state = STATE_METHOD
- seen_params = 0
- outfp.write('(define-method ' + line[8:])
- elif line[:10] == '(function ':
- state = STATE_FUNCTION
- seen_params = 0
- outfp.write('(define-function ' + line[10:])
- elif line[:13] == ' (in-module ':
- outfp.write(re.sub(r'^(\s+\(in-module\s+)(\w+)(.*)$',
- r'\1"\2"\3', line))
- elif line[:10] == ' (parent ':
- outfp.write(re.sub(r'^(\s+\(parent\s+)(\w+)(\s+\((\w+)\))?(.*)$',
- r'\1"\4\2"\5', line))
- elif line[:14] == ' (implements ':
- outfp.write(re.sub(r'^(\s+\(implements\s+)([^\s]+)(\s*\))$',
- r'\1"\2"\3', line))
- elif line[:13] == ' (of-object ':
- outfp.write(re.sub(r'^(\s+\(of-object\s+)(\w+)(\s+\((\w+)\))?(.*)$',
- r'\1"\4\2"\5', line))
- elif line[:10] == ' (c-name ':
- outfp.write(re.sub(r'^(\s+\(c-name\s+)([^\s]+)(\s*\))$',
- r'\1"\2"\3', line))
- if state in (STATE_OBJECT, STATE_INTERFACE, STATE_BOXED,
- STATE_ENUM, STATE_FLAGS):
- c_name = re.match(r'^\s+\(c-name\s+([^\s]+)\s*\)$',
- line).group(1)
- outfp.write(' (gtype-id "%s")\n' % typecode(c_name))
- elif line[:15] == ' (return-type ':
- outfp.write(re.sub(r'^(\s+\(return-type\s+)([^\s]+)(\s*\))$',
- r'\1"\2"\3', line))
- elif line[:13] == ' (copy-func ':
- outfp.write(re.sub(r'^(\s+\(copy-func\s+)(\w+)(.*)$',
- r'\1"\2"\3', line))
- elif line[:16] == ' (release-func ':
- outfp.write(re.sub(r'^(\s+\(release-func\s+)(\w+)(.*)$',
- r'\1"\2"\3', line))
- elif line[:9] == ' (field ':
- if not seen_params:
- outfp.write(' (fields\n')
- seen_params = 1
- outfp.write(re.sub(r'^\s+\(field\s+\(type-and-name\s+([^\s]+)\s+([^\s]+)\s*\)\s*\)$',
- ' \'("\\1" "\\2")', line))
- elif line[:9] == ' (value ':
- if not seen_params:
- outfp.write(' (values\n')
- seen_params = 1
- outfp.write(re.sub(r'^\s+\(value\s+\(name\s+([^\s]+)\)\s+\(c-name\s+([^\s]+)\s*\)\s*\)$',
- ' \'("\\1" "\\2")', line))
- elif line[:13] == ' (parameter ':
- if not seen_params:
- outfp.write(' (parameters\n')
- seen_params = 1
- outfp.write(re.sub(r'^\s+\(parameter\s+\(type-and-name\s+([^\s]+)\s+([^\s]+)\s*\)(\s*.*)\)$',
- ' \'("\\1" "\\2"\\3)', line))
- elif line[:11] == ' (varargs ':
- if seen_params:
- outfp.write(' )\n')
- seen_params = 0
- outfp.write(' (varargs #t)\n')
- elif line[0] == ')':
- if seen_params:
- outfp.write(' )\n')
- seen_params = 0
- state = STATE_START
- outfp.write(line)
- else:
- outfp.write(line)
- line = infp.readline()
-
-if __name__ == '__main__':
- convert()
diff --git a/codegen/defsgen.py b/codegen/defsgen.py
deleted file mode 100644
index 69c6d684..00000000
--- a/codegen/defsgen.py
+++ /dev/null
@@ -1,656 +0,0 @@
-#!/usr/bin/env python
-# -*- Mode: Python; py-indent-offset: 4 -*-
-#
-# Copyright (C) 2006 John Finlay.
-#
-# Scan the given public .h files of a GTK module (or module using
-# GTK object conventions) and generates a set of scheme defs.
-#
-# defsgen uses the ctypes module to extract information from the installed
-# module library (or libraries) to generate the object, interface, function,
-# method, virtual, enum and flags defs. defsgen uses the gobject library
-# g_type_* functions. defsgen will try to open the "libgobject-2.0.so" library
-# if one is not specified on the command line.
-#
-# Basically the operation of defsgen is:
-#
-# - open and initialize the gobject and module libraries
-# - read each .h file into a buffer which is scrubbed of extraneous data
-# - find all *_get_type() functions prototypes
-# - look in the module libraries for the get_type symbols
-# - if found run the get_type() function to retrieve the GType
-# - find the parent type name and save the object info
-# - find each function prototypes in the file and check if it has a symbol in
-# the module libraries - save the info if found
-# - extract the virtual prototypes from the Class or Iface structs and save
-# - write out the various defs.
-#
-# The command line options are:
-#
-# -l --modulelib Adds the given module library name to the list to be used
-# for finding symbols. Mor ethan one modulefile may be
-# specified. (required)
-# -L --libgobject Specifies the name of the gobject library (optional but
-# must be specified if "libgobject-2.0.so" is not availble)
-# -s --separate Create separate files for objects and function/method defs
-# using the given name as the base name (optional). If this
-# is not specified the combined object and function defs
-# will be output to sys.stdout.
-# -f --defsfile Extract defs from the given file to filter the output defs
-# that is don't output defs that are defined in the
-# defsfile. More than one deffile may be specified.
-# -D --defines Include portions of the defsfile defs that are conditional
-# on the given define, for example GDK_TARGET_X11. Only
-# useful with the --defsfile option
-# -m --modulename The prefix to be stripped from the front of function names
-# for the given module
-# --onlyenums Only produce defs for enums and flags
-# --onlyobjdefs Only produce defs for objects
-# --onlyvirtuals Only produce defs for virtuals
-# --genpropgetsets Experimental option to generate prop-getset annotations.
-# Not supported by codegen.py and friends.
-#
-# Examples:
-#
-# python defsgen.py -m pango -l libpango-1.0.so \
-# /usr/local/include/pango-1.0/pango/*.h >/tmp/pango.defs
-#
-# - Outputs all defs for the pango module.using the library module
-# libpango-1.0.so.
-#
-# python defsgen.py -m gdk -DGDK_TARGET_X11 -l libgdk-x11-2.0.so \
-# -l libgdk_pixbuf-2.0.so -s /tmp/gdk-2.10 \
-# -f /usr/tmp/pygtk/gtk/gdk-base.defs \
-# /usr/local/include/gtk-2.0/gdk/*.h \
-# /usr/local/include/gtk-2.0/gdk-pixbuf/*.h
-#
-# - Outputs the gdk module defs that are not contained in the defs file
-# /usr/tmp/pygtk/gtk/gdk-base.defs. Two output files are created:
-# /tmp/gdk-2.10-types.defs and /tmp/gdk-2.10.defs.
-#
-# Based on the original h2def.py program by
-# Toby D. Reeves <toby@max.rl.plh.af.mil> and
-# modified by James Henstridge <james@daa.com.au> to output stuff in
-# Havoc's new defs format. Info on this format can be seen at:
-# http://www.gnome.org/mailing-lists/archives/gtk-devel-list/2000-January/0085.shtml
-# Updated to be PEP-8 compatible and refactored to use OOP
-# Extensively modified by John Finlay to use ctypes module to extract GType
-# info from the given library and to create virtual defines.
-#
-
-import getopt
-import os
-import re
-import sys
-import ctypes
-import defsparser
-
-#------------------ utility defs -----------------
-
-_upperstr_pat1 = re.compile(r'([^A-Z])([A-Z])')
-_upperstr_pat2 = re.compile(r'([A-Z][A-Z])([A-Z][0-9a-z])')
-_upperstr_pat3 = re.compile(r'^([A-Z])([A-Z])')
-
-def to_upper_str(name):
- """Converts a typename to the equivalent uppercase and underscores
- name. This is used to form the type conversion macros and enum/flag
- name variables"""
- name = _upperstr_pat1.sub(r'\1_\2', name)
- name = _upperstr_pat2.sub(r'\1_\2', name)
- name = _upperstr_pat3.sub(r'\1_\2', name, count=1)
- return name.upper()
-
-def typecode(typename):
- """create a typecode (eg. GTK_TYPE_WIDGET) from a typename"""
- return to_upper_str(typename).replace('_', '_TYPE_', 1)
-
-_class_iface_pat = re.compile(r'\w+(Class|Iface)')
-
-def class_iface_sub(mobj):
- '''Returns matched string if it matches a Class or Iface struct
- otherwise returns the empty string'''
- if not _class_iface_pat.match(mobj.group(1)):
- return ''
- return mobj.group(0)
-
-clean_patterns = [
- # strip comments
- (re.compile(r'/\*.*?\*/', re.DOTALL), ''),
- # compact continued lines
- (re.compile(r"\\\n", re.MULTILINE), ''),
- # remove preprocess directives
- (re.compile(r"""^[#].*?$""", re.MULTILINE), ''),
- # strip DECLS macros
- (re.compile(r"""G_BEGIN_DECLS|BEGIN_LIBGTOP_DECLS|G_END_DECLS""",
- re.MULTILINE), ''),
- # remove extern "C"
- (re.compile(r'^\s*(extern)\s+"C"\s+{', re.MULTILINE), ''),
- # remove singleline typedefs of stucts
- (re.compile(r'^typedef\s+struct\s*[^{;\n]*;\s*$', re.MULTILINE), ''),
- # remove enum definitions
- (re.compile(r'^typedef enum\s+{[^}]*}[^;]*;\s*$', re.MULTILINE), ''),
- # remove all struct definitons but those for object classes and interfaces
- (re.compile(r'^struct\s+(\w+)\s+{[^}]+}\s*;\s*$', re.MULTILINE),
- class_iface_sub),
- # compress multiple whitespace
- (re.compile(r'\s+', re.MULTILINE), ' '),
- # clean up line ends
- (re.compile(r';\s*', re.MULTILINE), '\n'),
- (re.compile(r'^\s*', re.MULTILINE), ''),
- # associate *, &, and [] with type instead of variable
- (re.compile(r' \s* ([*|&]+) \s* ([(\w]+)', re.VERBOSE), r'\1 \2'),
- (re.compile(r'\s+ (\w+) \[ \s* \]', re.VERBOSE), r'[] \1'),
- # make return types that are const work.
- (re.compile(r'G_CONST_RETURN |const '), 'const-'),
- # remove typedefs of callback types
- (re.compile(r'^typedef\s+\w+\s*\*?\s*\(\s*\*\s*\w+\)\s*\([^(]*\)\n',
- re.MULTILINE), '')
- ]
-
-def clean_buffer(buf):
- """Cleans out extraneous data leaving function prototypes, Class and Iface
- structs."""
- for pat, subst in clean_patterns:
- buf = pat.sub(subst, buf)
- return buf
-
-# ------------------ utility classes -------------------------
-
-class ObjDef(object):
- def __init__(self, name, type_id, parent_name, parent_type, base_name):
- self.name = name
- self.type = type_id
- self.parent_name = parent_name
- self.parent_type = parent_type
- self.base_name = base_name
- self.props = []
- return
- def __cmp__(self, other):
- try:
- res = cmp(self.name, other.name)
- except AttributeError:
- res = cmp(id(self), id(other))
- return res
- def set_properties(self, gobj):
- if self.base_name == 'GObject':
- self.props = self._get_gobject_properties(gobj)
- elif self.base_name == 'GInterface':
- self.props = self._get_ginterface_properties(gobj)
-
- def _get_gobject_properties(self, gobj):
- klass = gobj.g_type_class_ref(self.type)
- num = ctypes.c_uint()
- plist = gobj.g_object_class_list_properties(klass, ctypes.byref(num))
- props = [plist[i][0].name for i in range(num.value)
- if self.name == gobj.g_type_name(plist[i][0].owner_type)]
- return props
- def _get_ginterface_properties(self, gobj):
- iface = gobj.g_type_default_interface_ref(self.type)
- num = ctypes.c_uint()
- plist = gobj.g_object_interface_list_properties(iface,
- ctypes.byref(num))
- props = [plist[i][0].name for i in range(num.value)]
- return props
-
-# ------------------ Find object definitions -----------------
-
-split_prefix_pat = re.compile('([A-Z]+[a-z]*)([A-Za-z0-9]+)')
-
-get_type_pat = re.compile(r'''^\s*(GType|GtkType)\s+
-([a-z]\w+_get_type)\s*\(void\).*$''', re.VERBOSE | re.MULTILINE)
-
-defkeys = 'GBoxed GInterface GObject gpointer GEnum GFlags'
-
-def find_defs(buf, gobj, modlib, defs):
- """Find possible gobject, gboxed, interface, gpointer, enum and flags
- definitions in header files.and find parent type."""
- # find all *_get_type() functions that may represent a GObject
- for m in get_type_pat.findall(buf):
- func_name = m[1]
- for lib in modlib:
- if hasattr(lib, func_name):
- objtype = apply(getattr(lib, func_name))
- obj_name = gobj.g_type_name(objtype)
- parent = gobj.g_type_parent(objtype)
- parent_name = gobj.g_type_name(parent)
- base_name = gobj.g_type_name(gobj.g_type_fundamental(parent))
- #if gobj.g_type_is_a(parent, gobj.GObject):
- # base_name = 'GObject'
- if base_name in defkeys:
- obj = ObjDef(obj_name, objtype, parent_name, parent,
- base_name)
- obj.set_properties(gobj)
- defs[obj.base_name].append(obj)
- break
- return
-
-# ------------------ Find function definitions -----------------
-
-arg_split_pat = re.compile("\s*,\s*")
-
-proto_pat=re.compile(r"""^
-\s*((?:-|\w|\&|\*)+) # return type
-\s+ # skip whitespace
-([a-z]\w+)\s*[(] # match the function name until the opening (
-\s*(.*?)\s*[)].* # group the function arguments
-$""", re.IGNORECASE|re.VERBOSE|re.MULTILINE)
-
-def find_func_defs(buf, modlib, deffile, defs, verbose):
- '''Find function prototypes in buf that have symbols in modlib
- and save in defs.'''
- funcs = defs['funcs'][deffile] = []
- for m in proto_pat.findall(buf):
- ret, func, args = m
- if not True in [hasattr(lib, func) for lib in modlib]:
- if verbose:
- sys.stderr.write('no symbol for function: ' + func
- + ' from file' + deffile + '\n')
- else:
- args = arg_split_pat.split(args)
- args = [a.replace(' ','-', a.count(' ')-1) for a in args]
- funcs.append((func, ret, args))
- return
-
-virtual_pat = re.compile(r'''^
-\s*((?:-|\w|\&|\*)+) # return type
-\s* # skip whitespace
-\(\s*\*\s* # opening (
-([a-z]\w+)\) # match the function name until the closing )
-\s*\(\s*([^)]*)\).* # group the function arguments
-$''', re.VERBOSE|re.MULTILINE)
-
-class_iface_struct_pat = re.compile(
- r'^struct\s+_(\w+)(?:Class|Iface)\s+{([^}]+)}\s*$', re.MULTILINE)
-
-def find_virt_defs(buf, deffile, defs):
- '''Find virtual function prototypes in buf and save in defs.'''
- virts = defs['virts'][deffile] = []
- # get the Class or Iface structs
- for m in class_iface_struct_pat.findall(buf):
- objname, virtuals = m
- for v in virtual_pat.findall(virtuals):
- ret, func, args = v
- if 'reserved' in func or args == 'void':
- continue
- args = arg_split_pat.split(args)
- args = [a.replace(' ','-', a.count(' ')-1) for a in args]
- virts.append((func, ret, args, objname))
- return
-
-# ------------------ write definitions -----------------
-
-type_pat = re.compile(r'(?:const-)?([A-Za-z0-9]+)\*?\s+')
-pointer_pat = re.compile('(.*)\*$')
-func_new_pat = re.compile('(\w+)_new$')
-getset_pat = re.compile(r'^(?:get|set)_(.*)$')
-
-class DefsWriter:
- def __init__(self, defs, fp=None, prefix=None, verbose=False,
- defsfiles=None, defines={}, genpropgetsets=False):
- self.defs = defs
- self.objnames = reduce(list.__add__,
- [[o.name for o in defs[base]]
- for base in defkeys.split()[:3]])
- self.othernames = reduce(list.__add__,
- [[o.name for o in defs[base]]
- for base in defkeys.split()[3:]])
- self.objifacedefs = dict(reduce(list.__add__,
- [[(o.name, o) for o in defs[base]]
- for base in defkeys.split()[1:3]]))
- self.fp = (fp, sys.stdout)[not fp]
- self.prefix = prefix
- self.verbose = verbose
- self.genpropgetsets = genpropgetsets
- self._c_names={}
- for defsfile in defsfiles:
- filter = defsparser.DefsParser(defsfile, defines)
- filter.startParsing()
- self._c_names.update(filter.c_name)
- for vdef in filter.virtuals:
- self._c_names[vdef.of_object + '.' + vdef.name] = None
- return
-
- def write_func_defs(self, deffiles, onlyvirts=False):
- filter = self._c_names
- for deffile in deffiles:
- self.fp.write('\n;; From %s\n\n' % os.path.basename(deffile))
- if not onlyvirts:
- for func, ret, args in self.defs['funcs'][deffile]:
- if not func in filter:
- self._write_func(func, ret, args)
- for virt, ret, args, objname in self.defs['virts'][deffile]:
- if not objname + '.' + virt in filter:
- self._write_virt(objname, virt, ret, args)
- self.fp.write('\n')
- return
-
- def write_enum_defs(self, fp=None):
- fp = (fp, self.fp)[not fp]
- klassptrs = {'GEnum':ctypes.POINTER(EnumClass),
- 'GFlags':ctypes.POINTER(FlagsClass)}
- filter = self._c_names
- objs = self.defs['GEnum'] + self.defs ['GFlags']
- #objs.sort()
- fp.write(';; Enumerations and Flags ...\n\n')
- for obj in objs:
- cname = name = obj.name
- if cname in filter:
- continue
- parent_name = obj.parent_name
- klassptr = klassptrs[parent_name]
- typename = parent_name.lower()[1:]
- module = None
- m = split_prefix_pat.match(cname)
- if m:
- module = m.group(1)
- name = m.group(2)
- fp.write('(define-' + typename + ' ' + name + '\n')
- if module:
- fp.write(' (in-module "' + module + '")\n')
- fp.write(' (c-name "' + cname + '")\n')
- fp.write(' (gtype-id "' + typecode(cname) + '")\n')
- fp.write(' (values\n')
- classref = self.gobj.g_type_class_ref(obj.type)
- itemclass = ctypes.cast(classref, klassptr).contents
- for i in range(itemclass.n_values):
- val = itemclass.values[i]
- fp.write(' \'("%s" "%s")\n' % (val.value_nick,
- val.value_name))
- fp.write(' )\n')
- fp.write(')\n\n')
- return
-
- def _write_obj_helper(self, obj, fp):
- base_name = obj.base_name.lower()[1:]
- cmodule = None
- cname = name = obj.name
- type_id = obj.type
- parent_name = obj.parent_name
- m = split_prefix_pat.match(cname)
- if m:
- cmodule = m.group(1)
- name = m.group(2)
- fp.write('(define-' + base_name + ' ' + name + '\n')
- if cmodule:
- fp.write(' (in-module "' + cmodule + '")\n')
- if base_name == 'object':
- fp.write(' (parent "' + parent_name + '")\n')
- fp.write(' (c-name "' + cname + '")\n')
- fp.write(' (gtype-id "' + typecode(cname) + '")\n')
- n = ctypes.c_uint()
- ifaces = self.gobj.g_type_interfaces(type_id, ctypes.byref(n))
- for i in range(n.value):
- iface_name = self.gobj.g_type_name(ifaces[i])
- if iface_name in self.interfaces:
- fp.write(' (implements "%s")\n' % iface_name)
- if base_name == 'interface':
- prereq = self.gobj.g_type_interface_prerequisites(type_id,
- ctypes.byref(n))
- for i in range(n.value):
- fp.write(' (prerequisite "%s")\n'
- % self.gobj.g_type_name(prereq[i]))
- # should do something about accessible fields
- fp.write(')\n\n')
- return
-
- def write_obj_defs(self, fp=None):
- fp = (fp, self.fp)[not fp]
- fp.write(';; -*- scheme -*-\n')
- filter = self._c_names
- for base in defkeys.split()[:4]:
- base_name = base.lower()[1:]
- fp.write('; %s definitions ...\n\n' % base_name)
- for obj in self.defs[base]:
- if not obj.name in filter:
- self._write_obj_helper(obj, fp)
- return
-
- def _write_func(self, name, ret, args):
- if len(args) >= 1:
- # methods must have at least one argument
- munged_name = name.replace('_', '')
- m = type_pat.match(args[0])
- if m:
- obj = m.group(1)
- if munged_name.startswith(obj.lower()):
- if obj not in self.othernames:
- self._write_method(obj, name, ret, args)
- return
- fname = name
- if self.prefix:
- fname = re.sub('^'+self.prefix+'_', '', fname)
-
- # it is either a constructor or normal function
- self.fp.write('(define-function ' + fname + '\n')
- self.fp.write(' (c-name "' + name + '")\n')
-
- # Asume that a constructor function name
- # ends with '_new' and it returns an object pointer.
- m = func_new_pat.match(name)
- r = pointer_pat.match(ret)
- if m and r:
- cname = ''
- # get the type name by using the _get_type function
- func = m.group(1) + '_get_type'
- lib = [l for l in self.modlib if hasattr(l, func)]
- if lib:
- cname = self.gobj.g_type_name(apply(getattr(lib[0], func)))
- if cname and self.gobj.g_type_from_name(r.group(1)):
- self.fp.write(' (is-constructor-of "' + cname + '")\n')
- self._write_return(ret)
- self._write_arguments(args)
- return
-
- def _write_method(self, obj, name, ret, args):
- regex = ''.join([c+'_?' for c in obj.lower()])
- mname, count = re.subn(regex, '', name, 1)
- if not count and self.prefix:
- mname = re.sub('^'+self.prefix+'_', '', mname)
- self.fp.write('(define-method ' + mname + '\n')
- self.fp.write(' (of-object "' + obj + '")\n')
- self.fp.write(' (c-name "' + name + '")\n')
- m = getset_pat.match(mname)
- if self.genpropgetsets and m and len(args[1:]) <= 1:
- prop = m.group(1)
- if self.objifacedefs.has_key(obj):
- oidef = self.objifacedefs[obj]
- if prop.replace('_', '-') in oidef.props:
- self.fp.write(' (prop-getset "' + prop + '")\n')
- self._write_return(ret)
- self._write_arguments(args[1:])
- return
-
- def _write_virt(self, obj, name, ret, args):
- self.fp.write('(define-virtual ' + name + '\n')
- self.fp.write(' (of-object "' + obj + '")\n')
- self._write_return(ret)
- self._write_arguments(args[1:])
- return
-
- def _write_return(self, ret):
- if ret == 'void':
- ret = 'none'
- self.fp.write(' (return-type "' + ret + '")\n')
- return
-
- def _write_arguments(self, args):
- if args and not 'void' in args:
- varargs = ''
- self.fp.write(' (parameters\n')
- for arg in args:
- if arg == '...':
- varargs = ' (varargs #t)\n'
- else:
- tupleArg = tuple(arg.split())
- if len(tupleArg) == 2:
- self.fp.write(' \'("%s" "%s")\n' % tupleArg)
- self.fp.write(' )\n' + varargs)
- self.fp.write(')\n\n')
-
-# ---------- ctypes support classes for gobject library functions ----------
-
-GType = ctypes.c_uint
-
-class GTypeClass(ctypes.Structure):
- _fields_ = [('g_type', GType)]
-
-class GTypeInstance(ctypes.Structure):
- _fields_ = [('g_class', ctypes.POINTER(GTypeClass))]
-
-class EnumValue(ctypes.Structure):
- _fields_ = [('value', ctypes.c_int),
- ('value_name', ctypes.c_char_p),
- ('value_nick', ctypes.c_char_p)]
-
-class FlagsValue(ctypes.Structure):
- _fields_ = [('value', ctypes.c_uint),
- ('value_name', ctypes.c_char_p),
- ('value_nick', ctypes.c_char_p)]
-
-class EnumClass(ctypes.Structure):
- _fields_ = [('g_type_class', GTypeClass),
- ('minimum', ctypes.c_int),
- ('maximum', ctypes.c_int),
- ('n_values', ctypes.c_uint),
- ('values', ctypes.POINTER(EnumValue))]
-
-class FlagsClass(ctypes.Structure):
- _fields_ = [('g_type_class', GTypeClass),
- ('mask', ctypes.c_uint),
- ('n_values', ctypes.c_uint),
- ('values', ctypes.POINTER(FlagsValue))]
-
-class GTypeInterface(ctypes.Structure):
- _fields_ = [('g_type', GType),
- ('g_instance_type', GType)]
-
-class GParamSpec(ctypes.Structure):
- _fields_ = [('g_type_instance', GTypeInstance),
- ('name', ctypes.c_char_p),
- ('flags', ctypes.c_uint),
- ('value_type', GType),
- ('owner_type', GType)]
-
-# ------------------ Main function -----------------
-
-def main(args):
- verbose = False
- all = True
- onlyenums = False
- onlyobjdefs = False
- onlyvirtuals = False
- separate = False
- modulename = None
- defsfiles = []
- libgobject = None
- modulelibs = []
- defines = {}
- genpropgetsets = False
- opts, args = getopt.getopt(args[1:], 'vs:m:f:D:L:l:',
- ['onlyenums', 'onlyobjdefs', 'onlyvirtuals',
- 'modulename=', 'separate=',
- 'defsfile=', 'defines=', 'genpropgetsets',
- 'libgobject-', 'modulelib='])
- for o, v in opts:
- if o == '-v':
- verbose = True
- if o == '--onlyenums':
- onlyenums = True
- all = False
- if o == '--onlyvirtuals':
- onlyvirtuals = True
- all = False
- if o == '--onlyobjdefs':
- onlyobjdefs = True
- all = False
- if o == '--genpropgetsets':
- genpropgetsets = True
- if o in ('-s', '--separate'):
- separate = v
- if o in ('-m', '--modulename'):
- modulename = v
- if o in ('-L', '--libgobject'):
- libgobject = v
- if o in ('-l', '--modulelib'):
- modulelibs.append(v)
- if o in ('-f', '--defsfile'):
- defsfiles.append(v)
- if o in ('-D', '--defines'):
- nameval = v.split('=')
- try:
- defines[nameval[0]] = nameval[1]
- except IndexError:
- defines[nameval[0]] = None
-
- if not args[0:1]:
- print 'Must specify at least one input file name'
- return -1
- if not modulelibs:
- print 'Must specify one or more modulelib names'
- return -1
-
- # load the gobject and module libraries and init the gtype system
- if not libgobject:
- if verbose:
- sys.stderr.write('Using "libgobject-2.0.so" as the libobject' \
- 'library name by default\n')
- gobj = ctypes.cdll.LoadLibrary('libgobject-2.0.so')
- else:
- gobj = ctypes.cdll.LoadLibrary(libgobject)
-
- modlib = [ctypes.cdll.LoadLibrary(lib) for lib in modulelibs]
-
- gobj.g_type_init()
- gobj.g_type_name.restype = ctypes.c_char_p
- gobj.g_type_from_name.argtypes = [ctypes.c_char_p]
- gobj.g_type_interfaces.restype = ctypes.POINTER(ctypes.c_int)
- gobj.g_type_interface_prerequisites.restype = ctypes.POINTER(ctypes.c_int)
- gobj.g_object_class_list_properties.restype = ctypes.POINTER(ctypes.POINTER(GParamSpec))
- gobj.g_object_interface_list_properties.restype = ctypes.POINTER(ctypes.POINTER(GParamSpec))
- gobj.GObject = gobj.g_type_from_name('GObject')
-
- defs = {}
- for key in defkeys.split():
- defs[key] = []
- defs['funcs'] = {}
- defs['virts'] = {}
-
- # read in all the object and function definitions
- args.sort()
- for filename in args:
- buf = open(filename).read()
- buf = clean_buffer(buf)
- find_defs(buf, gobj, modlib, defs)
- find_func_defs(buf, modlib, filename, defs, verbose)
- find_virt_defs(buf, filename, defs)
-
- for key in defkeys.split():
- defs[key].sort()
-
- methods = types = None
- if separate:
- methods = file(separate + '.defs', 'w')
- types = file(separate + '-types.defs', 'w')
-
- dw = DefsWriter(defs, methods, prefix=modulename, verbose=verbose,
- defsfiles=defsfiles, defines=defines,
- genpropgetsets=genpropgetsets)
- dw.interfaces = [i.name for i in defs['GInterface']]
- dw.gobj = gobj
- dw.modlib = modlib
-
- if onlyobjdefs or all:
- dw.write_obj_defs(types)
- if separate:
- print "Wrote object defs to %s-types.defs" % separate
- if onlyenums or all:
- dw.write_enum_defs(types)
- if separate:
- print "Wrote enum and flags defs to %s-types.defs" % separate
- if onlyvirtuals or all:
- dw.write_func_defs(args, onlyvirtuals)
- if separate:
- print "Wrote function and virtual defs to %s.defs" % separate
-
-if __name__ == '__main__':
- sys.exit(main(sys.argv))
diff --git a/codegen/defsparser.py b/codegen/defsparser.py
deleted file mode 100644
index 37ba0a2f..00000000
--- a/codegen/defsparser.py
+++ /dev/null
@@ -1,153 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-import os, sys
-import scmexpr
-from definitions import BoxedDef, EnumDef, FlagsDef, FunctionDef, \
- InterfaceDef, MethodDef, ObjectDef, PointerDef, VirtualDef
-
-include_path = ['.']
-
-class IncludeParser(scmexpr.Parser):
- """A simple parser that follows include statements automatically"""
- def include(self, input_filename):
- global include_path
- if os.path.isabs(input_filename):
- filename = input_filename
- # set self.filename to the include name, to handle recursive includes
- oldfile = self.filename
- self.filename = filename
- self.startParsing()
- self.filename = oldfile
- else:
- inc_path = [os.path.dirname(self.filename)] + include_path
- for filename in [os.path.join(path_entry, input_filename)
- for path_entry in inc_path]:
- if not os.path.exists(filename):
- continue
- # set self.filename to the include name, to handle recursive includes
- oldfile = self.filename
- self.filename = filename
- self.startParsing()
- self.filename = oldfile
- break
- else:
- raise IOError("%s not found in include path %s" % (input_filename, inc_path))
-
-class DefsParser(IncludeParser):
- def __init__(self, arg, defines={}):
- IncludeParser.__init__(self, arg)
- self.objects = []
- self.interfaces = []
- self.enums = [] # enums and flags
- self.boxes = [] # boxed types
- self.pointers = [] # pointer types
- self.functions = [] # functions and methods
- self.virtuals = [] # virtual methods
- self.c_name = {} # hash of c names of functions
- self.methods = {} # hash of methods of particular objects
- self.defines = defines # -Dfoo=bar options, as dictionary
-
- def define_object(self, *args):
- odef = apply(ObjectDef, args)
- self.objects.append(odef)
- self.c_name[odef.c_name] = odef
- def define_interface(self, *args):
- idef = apply(InterfaceDef, args)
- self.interfaces.append(idef)
- self.c_name[idef.c_name] = idef
- def define_enum(self, *args):
- edef = apply(EnumDef, args)
- self.enums.append(edef)
- self.c_name[edef.c_name] = edef
- def define_flags(self, *args):
- fdef = apply(FlagsDef, args)
- self.enums.append(fdef)
- self.c_name[fdef.c_name] = fdef
- def define_boxed(self, *args):
- bdef = apply(BoxedDef, args)
- self.boxes.append(bdef)
- self.c_name[bdef.c_name] = bdef
- def define_pointer(self, *args):
- pdef = apply(PointerDef, args)
- self.pointers.append(pdef)
- self.c_name[pdef.c_name] = pdef
- def define_function(self, *args):
- fdef = apply(FunctionDef, args)
- self.functions.append(fdef)
- self.c_name[fdef.c_name] = fdef
- def define_method(self, *args):
- mdef = apply(MethodDef, args)
- self.functions.append(mdef)
- self.c_name[mdef.c_name] = mdef
- def define_virtual(self, *args):
- vdef = apply(VirtualDef, args)
- self.virtuals.append(vdef)
- def merge(self, old, parmerge):
- for obj in self.objects:
- if old.c_name.has_key(obj.c_name):
- obj.merge(old.c_name[obj.c_name])
- for f in self.functions:
- if old.c_name.has_key(f.c_name):
- f.merge(old.c_name[f.c_name], parmerge)
-
- def printMissing(self, old):
- for obj in self.objects:
- if not old.c_name.has_key(obj.c_name):
- obj.write_defs()
- for f in self.functions:
- if not old.c_name.has_key(f.c_name):
- f.write_defs()
-
- def write_defs(self, fp=sys.stdout):
- for obj in self.objects:
- obj.write_defs(fp)
- for enum in self.enums:
- enum.write_defs(fp)
- for boxed in self.boxes:
- boxed.write_defs(fp)
- for pointer in self.pointers:
- pointer.write_defs(fp)
- for func in self.functions:
- func.write_defs(fp)
-
- def find_object(self, c_name):
- for obj in self.objects:
- if obj.c_name == c_name:
- return obj
- else:
- raise ValueError('object %r not found' % c_name)
-
- def find_constructor(self, obj, overrides):
- for func in self.functions:
- if isinstance(func, FunctionDef) and \
- func.is_constructor_of == obj.c_name and \
- not overrides.is_ignored(func.c_name):
- return func
-
- def find_methods(self, obj):
- objname = obj.c_name
- return filter(lambda func, on=objname: isinstance(func, MethodDef) and
- func.of_object == on, self.functions)
-
- def find_virtuals(self, obj):
- objname = obj.c_name
- retval = filter(lambda func, on=objname: isinstance(func, VirtualDef) and
- func.of_object == on, self.virtuals)
- return retval
-
- def find_functions(self):
- return filter(lambda func: isinstance(func, FunctionDef) and
- not func.is_constructor_of, self.functions)
-
- def ifdef(self, *args):
- if args[0] in self.defines:
- for arg in args[1:]:
- #print >> sys.stderr, "-----> Handling conditional definition (%s): %s" % (args[0], arg)
- self.handle(arg)
- else:
- pass
- #print >> sys.stderr, "-----> Conditional %s is not true" % (args[0],)
-
- def ifndef(self, *args):
- if args[0] not in self.defines:
- for arg in args[1:]:
- self.handle(arg)
diff --git a/codegen/docextract.py b/codegen/docextract.py
deleted file mode 100644
index e6c65053..00000000
--- a/codegen/docextract.py
+++ /dev/null
@@ -1,185 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-'''Simple module for extracting GNOME style doc comments from C
-sources, so I can use them for other purposes.'''
-
-import sys, os, string, re
-
-__all__ = ['extract']
-
-class FunctionDoc:
- def __init__(self):
- self.name = None
- self.params = []
- self.description = ''
- self.ret = ''
- def set_name(self, name):
- self.name = name
- def add_param(self, name, description):
- if name == '...':
- name = 'Varargs'
- self.params.append((name, description))
- def append_to_last_param(self, extra):
- self.params[-1] = (self.params[-1][0], self.params[-1][1] + extra)
- def append_to_named_param(self, name, extra):
- for i in range(len(self.params)):
- if self.params[i][0] == name:
- self.params[i] = (name, self.params[i][1] + extra)
- return
- # fall through to adding extra parameter ...
- self.add_param(name, extra)
- def append_description(self, extra):
- self.description = self.description + extra
- def append_return(self, extra):
- self.ret = self.ret + extra
-
- def get_param_description(self, name):
- for param, description in self.params:
- if param == name:
- return description
- else:
- return ''
-
-comment_start_pat = re.compile(r'^\s*/\*\*\s')
-comment_end_pat = re.compile(r'^\s*\*+/')
-comment_line_lead = re.compile(r'^\s*\*\s*')
-funcname_pat = re.compile(r'^(\w+)\s*:?')
-return_pat = re.compile(r'^(returns:|return\s+value:|returns\s*)(.*\n?)$',
- re.IGNORECASE)
-param_pat = re.compile(r'^@(\S+)\s*:(.*\n?)$')
-
-def parse_file(fp, doc_dict):
- line = fp.readline()
- in_comment_block = 0
- while line:
- if not in_comment_block:
- if comment_start_pat.match(line):
- in_comment_block = 1
- cur_doc = FunctionDoc()
- in_description = 0
- in_return = 0
- line = fp.readline()
- continue
-
- # we are inside a comment block ...
- if comment_end_pat.match(line):
- if not cur_doc.name:
- sys.stderr.write("no function name found in doc comment\n")
- else:
- doc_dict[cur_doc.name] = cur_doc
- in_comment_block = 0
- line = fp.readline()
- continue
-
- # inside a comment block, and not the end of the block ...
- line = comment_line_lead.sub('', line)
- if not line: line = '\n'
-
- if not cur_doc.name:
- match = funcname_pat.match(line)
- if match:
- cur_doc.set_name(match.group(1))
- elif in_return:
- match = return_pat.match(line)
- if match:
- # assume the last return statement was really part of the
- # description
- return_start = match.group(1)
- cur_doc.ret = match.group(2)
- cur_doc.description = cur_doc.description + return_start + \
- cur_doc.ret
- else:
- cur_doc.append_return(line)
- elif in_description:
- if line[:12] == 'Description:':
- line = line[12:]
- match = return_pat.match(line)
- if match:
- in_return = 1
- return_start = match.group(1)
- cur_doc.append_return(match.group(2))
- else:
- cur_doc.append_description(line)
- elif line == '\n':
- # end of parameters
- in_description = 1
- else:
- match = param_pat.match(line)
- if match:
- param = match.group(1)
- desc = match.group(2)
- if param == 'returns':
- cur_doc.ret = desc
- else:
- cur_doc.add_param(param, desc)
- else:
- # must be continuation
- try:
- if param == 'returns':
- cur_doc.append_return(line)
- else:
- cur_doc.append_to_last_param(line)
- except:
- sys.stderr.write('something weird while reading param\n')
- line = fp.readline()
-
-def parse_dir(dir, doc_dict):
- for file in os.listdir(dir):
- if file in ('.', '..'): continue
- path = os.path.join(dir, file)
- if os.path.isdir(path):
- parse_dir(path, doc_dict)
- if len(file) > 2 and file[-2:] == '.c':
- parse_file(open(path, 'r'), doc_dict)
-
-def extract(dirs, doc_dict=None):
- if not doc_dict: doc_dict = {}
- for dir in dirs:
- parse_dir(dir, doc_dict)
- return doc_dict
-
-tmpl_section_pat = re.compile(r'^<!-- ##### (\w+) (\w+) ##### -->$')
-def parse_tmpl(fp, doc_dict):
- cur_doc = None
-
- line = fp.readline()
- while line:
- match = tmpl_section_pat.match(line)
- if match:
- cur_doc = None # new input shouldn't affect the old doc dict
- sect_type = match.group(1)
- sect_name = match.group(2)
-
- if sect_type == 'FUNCTION':
- cur_doc = doc_dict.get(sect_name)
- if not cur_doc:
- cur_doc = FunctionDoc()
- cur_doc.set_name(sect_name)
- doc_dict[sect_name] = cur_doc
- elif line == '<!-- # Unused Parameters # -->\n':
- cur_doc = None # don't worry about unused params.
- elif cur_doc:
- if line[:10] == '@Returns: ':
- if string.strip(line[10:]):
- cur_doc.append_return(line[10:])
- elif line[0] == '@':
- pos = string.find(line, ':')
- if pos >= 0:
- cur_doc.append_to_named_param(line[1:pos], line[pos+1:])
- else:
- cur_doc.append_description(line)
- else:
- cur_doc.append_description(line)
-
- line = fp.readline()
-
-def extract_tmpl(dirs, doc_dict=None):
- if not doc_dict: doc_dict = {}
- for dir in dirs:
- for file in os.listdir(dir):
- if file in ('.', '..'): continue
- path = os.path.join(dir, file)
- if os.path.isdir(path):
- continue
- if len(file) > 2 and file[-2:] == '.sgml':
- parse_tmpl(open(path, 'r'), doc_dict)
- return doc_dict
diff --git a/codegen/docextract_to_xml.py b/codegen/docextract_to_xml.py
deleted file mode 100755
index 76ac85d7..00000000
--- a/codegen/docextract_to_xml.py
+++ /dev/null
@@ -1,77 +0,0 @@
-#!/usr/bin/env python
-# -*- Mode: Python; py-indent-offset: 4 -*-
-#
-# This litte script outputs the C doc comments to an XML format.
-# So far it's only used by gtkmm (The C++ bindings). Murray Cumming.
-# Usage example:
-# # ./docextract_to_xml.py -s /gnome/head/cvs/gtk+/gtk/ -s /gnome/head/cvs/gtk+/docs/reference/gtk/tmpl/ > gtk_docs.xml
-
-import getopt
-import string
-import sys
-
-import docextract
-
-def escape_text(unescaped_text):
- escaped_text = unescaped_text
- escaped_text = string.replace(escaped_text, '<', '&lt;')
- escaped_text = string.replace(escaped_text, '>', '&gt;')
- escaped_text = string.replace(escaped_text, '&', '&amp;')
- escaped_text = string.replace(escaped_text, '\'', '&apos;')
- escaped_text = string.replace(escaped_text, '\"', '&quot;')
-
- #Apparently this is an undefined symbol:
- escaped_text = string.replace(escaped_text, '&mdash;', ' mdash ')
-
- return escaped_text
-
-if __name__ == '__main__':
- try:
- opts, args = getopt.getopt(sys.argv[1:], "d:s:o:",
- ["source-dir="])
- except getopt.error, e:
- sys.stderr.write('docgen.py: %s\n' % e)
- sys.stderr.write(
- 'usage: docgen.py [-s /src/dir]\n')
- sys.exit(1)
- source_dirs = []
- for opt, arg in opts:
- if opt in ('-s', '--source-dir'):
- source_dirs.append(arg)
- if len(args) != 0:
- sys.stderr.write(
- 'usage: docgen.py [-s /src/dir]\n')
- sys.exit(1)
-
- docs = docextract.extract(source_dirs);
- docextract.extract_tmpl(source_dirs, docs); #Try the tmpl sgml files too.
-
- # print d.docs
-
- if docs:
-
- print "<root>"
-
- for name, value in docs.items():
- print "<function name=\"" + escape_text(name) + "\">"
-
- print "<description>"
- #The value is a docextract.FunctionDoc
- print escape_text(value.description)
- print "</description>"
-
- # Loop through the parameters:
- print "<parameters>"
- for name, description in value.params:
- print "<parameter name=\"" + escape_text(name) + "\">"
- print "<parameter_description>" + escape_text(description) + "</parameter_description>"
- print "</parameter>"
-
- print "</parameters>"
-
- # Show the return-type:
- print "<return>" + escape_text(value.ret) + "</return>"
-
- print "</function>\n"
-
- print "</root>"
diff --git a/codegen/docgen.py b/codegen/docgen.py
deleted file mode 100644
index 57eb7fcb..00000000
--- a/codegen/docgen.py
+++ /dev/null
@@ -1,751 +0,0 @@
-#!/usr/bin/env python
-# -*- Mode: Python; py-indent-offset: 4 -*-
-import sys, os, string, re, getopt
-
-import defsparser
-import definitions
-import override
-import docextract
-
-class Node:
- def __init__(self, name, interfaces=[]):
- self.name = name
- self.interfaces = interfaces
- self.subclasses = []
- def add_child(self, node):
- self.subclasses.append(node)
-
-def build_object_tree(parser):
- # reorder objects so that parent classes come first ...
- objects = parser.objects[:]
- pos = 0
- while pos < len(objects):
- parent = objects[pos].parent
- for i in range(pos+1, len(objects)):
- if objects[i].c_name == parent:
- objects.insert(i+1, objects[pos])
- del objects[pos]
- break
- else:
- pos = pos + 1
-
- root = Node(None)
- nodes = { None: root }
- for obj_def in objects:
- parent_node = nodes[obj_def.parent]
- node = Node(obj_def.c_name, obj_def.implements)
- parent_node.add_child(node)
- nodes[node.name] = node
-
- if parser.interfaces:
- interfaces = Node('gobject.GInterface')
- root.add_child(interfaces)
- nodes[interfaces.name] = interfaces
- for obj_def in parser.interfaces:
- node = Node(obj_def.c_name)
- interfaces.add_child(node)
- nodes[node.name] = node
-
- if parser.boxes:
- boxed = Node('gobject.GBoxed')
- root.add_child(boxed)
- nodes[boxed.name] = boxed
- for obj_def in parser.boxes:
- node = Node(obj_def.c_name)
- boxed.add_child(node)
- nodes[node.name] = node
-
- if parser.pointers:
- pointers = Node('gobject.GPointer')
- root.add_child(pointers)
- nodes[pointers.name] = pointers
- for obj_def in parser.pointers:
- node = Node(obj_def.c_name)
- pointers.add_child(node)
- nodes[node.name] = node
-
- return root
-
-class DocWriter:
- def __init__(self):
- # parse the defs file
- self.parser = defsparser.DefsParser(())
- self.overrides = override.Overrides()
- self.classmap = {}
- self.docs = {}
-
- def add_sourcedirs(self, source_dirs):
- self.docs = docextract.extract(source_dirs, self.docs)
- def add_tmpldirs(self, tmpl_dirs):
- self.docs = docextract.extract_tmpl(tmpl_dirs, self.docs)
-
- def add_docs(self, defs_file, overrides_file, module_name):
- '''parse information about a given defs file'''
- self.parser.filename = defs_file
- self.parser.startParsing(defs_file)
- if overrides_file:
- self.overrides.handle_file(overrides_file)
-
- for obj in self.parser.objects:
- if not self.classmap.has_key(obj.c_name):
- self.classmap[obj.c_name] = '%s.%s' % (module_name, obj.name)
- for obj in self.parser.interfaces:
- if not self.classmap.has_key(obj.c_name):
- self.classmap[obj.c_name] = '%s.%s' % (module_name, obj.name)
- for obj in self.parser.boxes:
- if not self.classmap.has_key(obj.c_name):
- self.classmap[obj.c_name] = '%s.%s' % (module_name, obj.name)
- for obj in self.parser.pointers:
- if not self.classmap.has_key(obj.c_name):
- self.classmap[obj.c_name] = '%s.%s' % (module_name, obj.name)
-
- def pyname(self, name):
- return self.classmap.get(name, name)
-
- def __compare(self, obja, objb):
- return cmp(self.pyname(obja.c_name), self.pyname(objb.c_name))
- def output_docs(self, output_prefix):
- files = []
-
- # class hierarchy
- hierarchy = build_object_tree(self.parser)
- filename = self.create_filename('hierarchy', output_prefix)
- fp = open(filename, 'w')
- self.write_full_hierarchy(hierarchy, fp)
- fp.close()
-
- obj_defs = self.parser.objects + self.parser.interfaces + \
- self.parser.boxes + self.parser.pointers
- obj_defs.sort(self.__compare)
- for obj_def in obj_defs:
- filename = self.create_filename(obj_def.c_name, output_prefix)
- fp = open(filename, 'w')
- if isinstance(obj_def, definitions.ObjectDef):
- self.output_object_docs(obj_def, fp)
- elif isinstance(obj_def, definitions.InterfaceDef):
- self.output_interface_docs(obj_def, fp)
- elif isinstance(obj_def, definitions.BoxedDef):
- self.output_boxed_docs(obj_def, fp)
- elif isinstance(obj_def, definitions.PointerDef):
- self.output_boxed_docs(obj_def, fp)
- fp.close()
- files.append((os.path.basename(filename), obj_def))
-
- if files:
- filename = self.create_toc_filename(output_prefix)
- fp = open(filename, 'w')
- self.output_toc(files, fp)
- fp.close()
-
- def output_object_docs(self, obj_def, fp=sys.stdout):
- self.write_class_header(obj_def.c_name, fp)
-
- self.write_heading('Synopsis', fp)
- self.write_synopsis(obj_def, fp)
- self.close_section(fp)
-
- # construct the inheritence hierarchy ...
- ancestry = [ (obj_def.c_name, obj_def.implements) ]
- try:
- parent = obj_def.parent
- while parent != None:
- if parent == 'GObject':
- ancestry.append(('GObject', []))
- parent = None
- else:
- parent_def = self.parser.find_object(parent)
- ancestry.append((parent_def.c_name, parent_def.implements))
- parent = parent_def.parent
- except ValueError:
- pass
- ancestry.reverse()
- self.write_heading('Ancestry', fp)
- self.write_hierarchy(obj_def.c_name, ancestry, fp)
- self.close_section(fp)
-
- constructor = self.parser.find_constructor(obj_def, self.overrides)
- if constructor:
- self.write_heading('Constructor', fp)
- self.write_constructor(constructor,
- self.docs.get(constructor.c_name, None),
- fp)
- self.close_section(fp)
-
- methods = self.parser.find_methods(obj_def)
- methods = filter(lambda meth, self=self:
- not self.overrides.is_ignored(meth.c_name), methods)
- if methods:
- self.write_heading('Methods', fp)
- for method in methods:
- self.write_method(method, self.docs.get(method.c_name, None), fp)
- self.close_section(fp)
-
- self.write_class_footer(obj_def.c_name, fp)
-
- def output_interface_docs(self, int_def, fp=sys.stdout):
- self.write_class_header(int_def.c_name, fp)
-
- self.write_heading('Synopsis', fp)
- self.write_synopsis(int_def, fp)
- self.close_section(fp)
-
- methods = self.parser.find_methods(int_def)
- methods = filter(lambda meth, self=self:
- not self.overrides.is_ignored(meth.c_name), methods)
- if methods:
- self.write_heading('Methods', fp)
- for method in methods:
- self.write_method(method, self.docs.get(method.c_name, None), fp)
- self.close_section(fp)
-
- self.write_class_footer(int_def.c_name, fp)
-
- def output_boxed_docs(self, box_def, fp=sys.stdout):
- self.write_class_header(box_def.c_name, fp)
-
- self.write_heading('Synopsis', fp)
- self.write_synopsis(box_def, fp)
- self.close_section(fp)
-
- constructor = self.parser.find_constructor(box_def, self.overrides)
- if constructor:
- self.write_heading('Constructor', fp)
- self.write_constructor(constructor,
- self.docs.get(constructor.c_name, None),
- fp)
- self.close_section(fp)
-
- methods = self.parser.find_methods(box_def)
- methods = filter(lambda meth, self=self:
- not self.overrides.is_ignored(meth.c_name), methods)
- if methods:
- self.write_heading('Methods', fp)
- for method in methods:
- self.write_method(method, self.docs.get(method.c_name, None), fp)
- self.close_section(fp)
-
- self.write_class_footer(box_def.c_name, fp)
-
- def output_toc(self, files, fp=sys.stdout):
- fp.write('TOC\n\n')
- for filename, obj_def in files:
- fp.write(obj_def.c_name + ' - ' + filename + '\n')
-
- # override the following to create a more complex output format
- def create_filename(self, obj_name, output_prefix):
- '''Create output filename for this particular object'''
- return output_prefix + '-' + string.lower(obj_name) + '.txt'
- def create_toc_filename(self, output_prefix):
- return self.create_filename(self, 'docs', output_prefix)
-
- def write_full_hierarchy(self, hierarchy, fp):
- def handle_node(node, fp, indent=''):
- for child in node.subclasses:
- fp.write(indent + node.name)
- if node.interfaces:
- fp.write(' (implements ')
- fp.write(string.join(node.interfaces, ', '))
- fp.write(')\n')
- else:
- fp.write('\n')
- handle_node(child, fp, indent + ' ')
- handle_node(hierarchy, fp)
-
- # these need to handle default args ...
- def create_constructor_prototype(self, func_def):
- return func_def.is_constructor_of + '(' + \
- string.join(map(lambda x: x[1], func_def.params), ', ') + \
- ')'
- def create_function_prototype(self, func_def):
- return func_def.name + '(' + \
- string.join(map(lambda x: x[1], func_def.params), ', ') + \
- ')'
- def create_method_prototype(self, meth_def):
- return meth_def.of_object + '.' + \
- meth_def.name + '(' + \
- string.join(map(lambda x: x[1], meth_def.params), ', ') + \
- ')'
-
- def write_class_header(self, obj_name, fp):
- fp.write('Class %s\n' % obj_name)
- fp.write('======%s\n\n' % ('=' * len(obj_name)))
- def write_class_footer(self, obj_name, fp):
- pass
- def write_heading(self, text, fp):
- fp.write('\n' + text + '\n' + ('-' * len(text)) + '\n')
- def close_section(self, fp):
- pass
- def write_synopsis(self, obj_def, fp):
- fp.write('class %s' % obj_def.c_name)
- if isinstance(obj_def, definitions.ObjectDef):
- bases = []
- if obj_def.parent: bases.append(obj_def.parent)
- bases = bases = obj_def.implements
- if bases:
- fp.write('(%s)' % string.join(bases, ', '))
- fp.write(':\n')
-
- constructor = self.parser.find_constructor(obj_def, self.overrides)
- if constructor:
- prototype = self.create_constructor_prototype(constructor)
- fp.write(' def %s\n' % prototype)
- methods = self.parser.find_methods(obj_def)
- methods = filter(lambda meth, self=self:
- not self.overrides.is_ignored(meth.c_name), methods)
- for meth in methods:
- prototype = self.create_method_prototype(meth)
- fp.write(' def %s\n' % prototype)
-
- def write_hierarchy(self, obj_name, ancestry, fp):
- indent = ''
- for name, interfaces in ancestry:
- fp.write(indent + '+-- ' + name)
- if interfaces:
- fp.write(' (implements ')
- fp.write(string.join(interfaces, ', '))
- fp.write(')\n')
- else:
- fp.write('\n')
- indent = indent + ' '
- fp.write('\n')
- def write_constructor(self, func_def, func_doc, fp):
- prototype = self.create_constructor_prototype(func_def)
- fp.write(prototype + '\n\n')
- for type, name, dflt, null in func_def.params:
- if func_doc:
- descr = func_doc.get_param_description(name)
- else:
- descr = 'a ' + type
- fp.write(' ' + name + ': ' + descr + '\n')
- if func_def.ret and func_def.ret != 'none':
- if func_doc and func_doc.ret:
- descr = func_doc.ret
- else:
- descr = 'a ' + func_def.ret
- fp.write(' Returns: ' + descr + '\n')
- if func_doc and func_doc.description:
- fp.write(func_doc.description)
- fp.write('\n\n\n')
- def write_method(self, meth_def, func_doc, fp):
- prototype = self.create_method_prototype(meth_def)
- fp.write(prototype + '\n\n')
- for type, name, dflt, null in meth_def.params:
- if func_doc:
- descr = func_doc.get_param_description(name)
- else:
- descr = 'a ' + type
- fp.write(' ' + name + ': ' + descr + '\n')
- if meth_def.ret and meth_def.ret != 'none':
- if func_doc and func_doc.ret:
- descr = func_doc.ret
- else:
- descr = 'a ' + meth_def.ret
- fp.write(' Returns: ' + descr + '\n')
- if func_doc and func_doc.description:
- fp.write('\n')
- fp.write(func_doc.description)
- fp.write('\n\n')
-
-class DocbookDocWriter(DocWriter):
- def __init__(self, use_xml=0):
- DocWriter.__init__(self)
- self.use_xml = use_xml
-
- def create_filename(self, obj_name, output_prefix):
- '''Create output filename for this particular object'''
- stem = output_prefix + '-' + string.lower(obj_name)
- if self.use_xml:
- return stem + '.xml'
- else:
- return stem + '.sgml'
- def create_toc_filename(self, output_prefix):
- if self.use_xml:
- return self.create_filename('classes', output_prefix)
- else:
- return self.create_filename('docs', output_prefix)
-
- # make string -> reference translation func
- __transtable = [ '-' ] * 256
- for digit in '0123456789':
- __transtable[ord(digit)] = digit
- for letter in 'abcdefghijklmnopqrstuvwxyz':
- __transtable[ord(letter)] = letter
- __transtable[ord(string.upper(letter))] = letter
- __transtable = string.join(__transtable, '')
-
- def make_class_ref(self, obj_name):
- return 'class-' + string.translate(obj_name, self.__transtable)
- def make_method_ref(self, meth_def):
- return 'method-' + string.translate(meth_def.of_object,
- self.__transtable) + \
- '--' + string.translate(meth_def.name, self.__transtable)
-
- __function_pat = re.compile(r'(\w+)\s*\(\)')
- def __format_function(self, match):
- info = self.parser.c_name.get(match.group(1), None)
- if info:
- if isinstance(info, defsparser.FunctionDef):
- if info.is_constructor_of is not None:
- # should have a link here
- return '<function>%s()</function>' % \
- self.pyname(info.is_constructor_of)
- else:
- return '<function>' + info.name + '()</function>'
- if isinstance(info, defsparser.MethodDef):
- return '<link linkend="' + self.make_method_ref(info) + \
- '"><function>' + self.pyname(info.of_object) + '.' + \
- info.name + '()</function></link>'
- # fall through through
- return '<function>' + match.group(1) + '()</function>'
- __parameter_pat = re.compile(r'\@(\w+)')
- def __format_param(self, match):
- return '<parameter>' + match.group(1) + '</parameter>'
- __constant_pat = re.compile(r'\%(-?\w+)')
- def __format_const(self, match):
- return '<literal>' + match.group(1) + '</literal>'
- __symbol_pat = re.compile(r'#([\w-]+)')
- def __format_symbol(self, match):
- info = self.parser.c_name.get(match.group(1), None)
- if info:
- if isinstance(info, defsparser.FunctionDef):
- if info.is_constructor_of is not None:
- # should have a link here
- return '<methodname>' + self.pyname(info.is_constructor_of) + \
- '</methodname>'
- else:
- return '<function>' + info.name + '</function>'
- if isinstance(info, defsparser.MethodDef):
- return '<link linkend="' + self.make_method_ref(info) + \
- '"><methodname>' + self.pyname(info.of_object) + '.' + \
- info.name + '</methodname></link>'
- if isinstance(info, defsparser.ObjectDef) or \
- isinstance(info, defsparser.InterfaceDef) or \
- isinstance(info, defsparser.BoxedDef) or \
- isinstance(info, defsparser.PointerDef):
- return '<link linkend="' + self.make_class_ref(info.c_name) + \
- '"><classname>' + self.pyname(info.c_name) + \
- '</classname></link>'
- # fall through through
- return '<literal>' + match.group(1) + '</literal>'
-
- def reformat_text(self, text, singleline=0):
- # replace special strings ...
- text = self.__function_pat.sub(self.__format_function, text)
- text = self.__parameter_pat.sub(self.__format_param, text)
- text = self.__constant_pat.sub(self.__format_const, text)
- text = self.__symbol_pat.sub(self.__format_symbol, text)
-
- # don't bother with <para> expansion for single line text.
- if singleline: return text
-
- lines = string.split(string.strip(text), '\n')
- for index in range(len(lines)):
- if string.strip(lines[index]) == '':
- lines[index] = '</para>\n<para>'
- continue
- lines.insert(0, '<para>')
- lines.append('</para>')
- return string.join(lines, '\n')
-
- # write out hierarchy
- def write_full_hierarchy(self, hierarchy, fp):
- def handle_node(node, fp, indent=''):
- if node.name:
- fp.write('%s<link linkend="%s">%s</link>' %
- (indent, self.make_class_ref(node.name),
- self.pyname(node.name)))
- if node.interfaces:
- fp.write(' (implements ')
- for i in range(len(node.interfaces)):
- fp.write('<link linkend="%s">%s</link>' %
- (self.make_class_ref(node.interfaces[i]),
- self.pyname(node.interfaces[i])))
- if i != len(node.interfaces) - 1:
- fp.write(', ')
- fp.write(')\n')
- else:
- fp.write('\n')
-
- indent = indent + ' '
- node.subclasses.sort(lambda a,b:
- cmp(self.pyname(a.name), self.pyname(b.name)))
- for child in node.subclasses:
- handle_node(child, fp, indent)
- if self.use_xml:
- fp.write('<?xml version="1.0" standalone="no"?>\n')
- fp.write('<!DOCTYPE synopsis PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"\n')
- fp.write(' "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">\n')
- fp.write('<synopsis>')
- handle_node(hierarchy, fp)
- fp.write('</synopsis>\n')
-
- # these need to handle default args ...
- def create_constructor_prototype(self, func_def):
- sgml = [ '<constructorsynopsis language="python">\n']
- sgml.append(' <methodname>__init__</methodname>\n')
- for type, name, dflt, null in func_def.params:
- sgml.append(' <methodparam><parameter>')
- sgml.append(name)
- sgml.append('</parameter>')
- if dflt:
- sgml.append('<initializer>')
- sgml.append(dflt)
- sgml.append('</initializer>')
- sgml.append('</methodparam>\n')
- if not func_def.params:
- sgml.append(' <methodparam></methodparam>')
- sgml.append(' </constructorsynopsis>')
- return string.join(sgml, '')
- def create_function_prototype(self, func_def):
- sgml = [ '<funcsynopsis language="python">\n <funcprototype>\n']
- sgml.append(' <funcdef><function>')
- sgml.append(func_def.name)
- sgml.append('</function></funcdef>\n')
- for type, name, dflt, null in func_def.params:
- sgml.append(' <paramdef><parameter>')
- sgml.append(name)
- sgml.append('</parameter>')
- if dflt:
- sgml.append('<initializer>')
- sgml.append(dflt)
- sgml.append('</initializer>')
- sgml.append('</paramdef>\n')
- if not func_def.params:
- sgml.append(' <paramdef></paramdef')
- sgml.append(' </funcprototype>\n </funcsynopsis>')
- return string.join(sgml, '')
- def create_method_prototype(self, meth_def, addlink=0):
- sgml = [ '<methodsynopsis language="python">\n']
- sgml.append(' <methodname>')
- if addlink:
- sgml.append('<link linkend="%s">' % self.make_method_ref(meth_def))
- sgml.append(self.pyname(meth_def.name))
- if addlink:
- sgml.append('</link>')
- sgml.append('</methodname>\n')
- for type, name, dflt, null in meth_def.params:
- sgml.append(' <methodparam><parameter>')
- sgml.append(name)
- sgml.append('</parameter>')
- if dflt:
- sgml.append('<initializer>')
- sgml.append(dflt)
- sgml.append('</initializer>')
- sgml.append('</methodparam>\n')
- if not meth_def.params:
- sgml.append(' <methodparam></methodparam>')
- sgml.append(' </methodsynopsis>')
- return string.join(sgml, '')
-
- def write_class_header(self, obj_name, fp):
- if self.use_xml:
- fp.write('<?xml version="1.0" standalone="no"?>\n')
- fp.write('<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"\n')
- fp.write(' "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">\n')
- fp.write('<refentry id="' + self.make_class_ref(obj_name) + '">\n')
- fp.write(' <refmeta>\n')
- fp.write(' <refentrytitle>%s</refentrytitle>\n'
- % self.pyname(obj_name))
- fp.write(' <manvolnum>3</manvolnum>\n')
- fp.write(' <refmiscinfo>PyGTK Docs</refmiscinfo>\n')
- fp.write(' </refmeta>\n\n')
- fp.write(' <refnamediv>\n')
- fp.write(' <refname>%s</refname><refpurpose></refpurpose>\n'
- % self.pyname(obj_name))
- fp.write(' </refnamediv>\n\n')
- def write_class_footer(self, obj_name, fp):
- fp.write('</refentry>\n')
- def write_heading(self, text, fp):
- fp.write(' <refsect1>\n')
- fp.write(' <title>' + text + '</title>\n\n')
- def close_section(self, fp):
- fp.write(' </refsect1>\n')
-
- def write_synopsis(self, obj_def, fp):
- fp.write('<classsynopsis language="python">\n')
- fp.write(' <ooclass><classname>%s</classname></ooclass>\n'
- % self.pyname(obj_def.c_name))
- if isinstance(obj_def, definitions.ObjectDef):
- if obj_def.parent:
- fp.write(' <ooclass><classname><link linkend="%s">%s'
- '</link></classname></ooclass>\n'
- % (self.make_class_ref(obj_def.parent),
- self.pyname(obj_def.parent)))
- for base in obj_def.implements:
- fp.write(' <ooclass><classname><link linkend="%s">%s'
- '</link></classname></ooclass>\n'
- % (self.make_class_ref(base), self.pyname(base)))
- elif isinstance(obj_def, definitions.InterfaceDef):
- fp.write(' <ooclass><classname>gobject.GInterface'
- '</classname></ooclass>\n')
- elif isinstance(obj_def, definitions.BoxedDef):
- fp.write(' <ooclass><classname>gobject.GBoxed'
- '</classname></ooclass>\n')
- elif isinstance(obj_def, definitions.PointerDef):
- fp.write(' <ooclass><classname>gobject.GPointer'
- '</classname></ooclass>\n')
-
- constructor = self.parser.find_constructor(obj_def, self.overrides)
- if constructor:
- fp.write('%s\n' % self.create_constructor_prototype(constructor))
- methods = self.parser.find_methods(obj_def)
- methods = filter(lambda meth, self=self:
- not self.overrides.is_ignored(meth.c_name), methods)
- for meth in methods:
- fp.write('%s\n' % self.create_method_prototype(meth, addlink=1))
- fp.write('</classsynopsis>\n\n')
-
- def write_hierarchy(self, obj_name, ancestry, fp):
- fp.write('<synopsis>')
- indent = ''
- for name, interfaces in ancestry:
- fp.write(indent + '+-- <link linkend="' +
- self.make_class_ref(name) + '">'+ self.pyname(name) + '</link>')
- if interfaces:
- fp.write(' (implements ')
- for i in range(len(interfaces)):
- fp.write('<link linkend="%s">%s</link>' %
- (self.make_class_ref(interfaces[i]),
- self.pyname(interfaces[i])))
- if i != len(interfaces) - 1:
- fp.write(', ')
- fp.write(')\n')
- else:
- fp.write('\n')
- indent = indent + ' '
- fp.write('</synopsis>\n\n')
-
- def write_params(self, params, ret, func_doc, fp):
- if not params and (not ret or ret == 'none'):
- return
- fp.write(' <variablelist>\n')
- for type, name, dflt, null in params:
- if func_doc:
- descr = string.strip(func_doc.get_param_description(name))
- else:
- descr = 'a ' + type
- fp.write(' <varlistentry>\n')
- fp.write(' <term><parameter>%s</parameter>&nbsp;:</term>\n' % name)
- fp.write(' <listitem><simpara>%s</simpara></listitem>\n' %
- self.reformat_text(descr, singleline=1))
- fp.write(' </varlistentry>\n')
- if ret and ret != 'none':
- if func_doc and func_doc.ret:
- descr = string.strip(func_doc.ret)
- else:
- descr = 'a ' + ret
- fp.write(' <varlistentry>\n')
- fp.write(' <term><emphasis>Returns</emphasis>&nbsp;:</term>\n')
- fp.write(' <listitem><simpara>%s</simpara></listitem>\n' %
- self.reformat_text(descr, singleline=1))
- fp.write(' </varlistentry>\n')
- fp.write(' </variablelist>\n')
-
- def write_constructor(self, func_def, func_doc, fp):
- prototype = self.create_constructor_prototype(func_def)
- fp.write('<programlisting>%s</programlisting>\n' % prototype)
- self.write_params(func_def.params, func_def.ret, func_doc, fp)
-
- if func_doc and func_doc.description:
- fp.write(self.reformat_text(func_doc.description))
- fp.write('\n\n\n')
-
- def write_method(self, meth_def, func_doc, fp):
- fp.write(' <refsect2 id="' + self.make_method_ref(meth_def) + '">\n')
- fp.write(' <title>' + self.pyname(meth_def.of_object) + '.' +
- meth_def.name + '</title>\n\n')
- prototype = self.create_method_prototype(meth_def)
- fp.write('<programlisting>%s</programlisting>\n' % prototype)
- self.write_params(meth_def.params, meth_def.ret, func_doc, fp)
- if func_doc and func_doc.description:
- fp.write(self.reformat_text(func_doc.description))
- fp.write(' </refsect2>\n\n\n')
-
- def output_toc(self, files, fp=sys.stdout):
- if self.use_xml:
- fp.write('<?xml version="1.0" standalone="no"?>\n')
- fp.write('<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"\n')
- fp.write(' "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">\n')
- #for filename, obj_def in files:
- # fp.write(' <!ENTITY ' + string.translate(obj_def.c_name,
- # self.__transtable) +
- # ' SYSTEM "' + filename + '" >\n')
- #fp.write(']>\n\n')
-
- #fp.write('<reference id="class-reference">\n')
- #fp.write(' <title>Class Documentation</title>\n')
- #for filename, obj_def in files:
- # fp.write('&' + string.translate(obj_def.c_name,
- # self.__transtable) + ';\n')
- #fp.write('</reference>\n')
-
- fp.write('<reference id="class-reference" xmlns:xi="http://www.w3.org/2001/XInclude">\n')
- fp.write(' <title>Class Reference</title>\n')
- for filename, obj_def in files:
- fp.write(' <xi:include href="%s"/>\n' % filename)
- fp.write('</reference>\n')
- else:
- fp.write('<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1.2//EN" [\n')
- for filename, obj_def in files:
- fp.write(' <!ENTITY ' + string.translate(obj_def.c_name,
- self.__transtable) +
- ' SYSTEM "' + filename + '" >\n')
- fp.write(']>\n\n')
-
- fp.write('<book id="index">\n\n')
- fp.write(' <bookinfo>\n')
- fp.write(' <title>PyGTK Docs</title>\n')
- fp.write(' <authorgroup>\n')
- fp.write(' <author>\n')
- fp.write(' <firstname>James</firstname>\n')
- fp.write(' <surname>Henstridge</surname>\n')
- fp.write(' </author>\n')
- fp.write(' </authorgroup>\n')
- fp.write(' </bookinfo>\n\n')
-
- fp.write(' <chapter id="class-hierarchy">\n')
- fp.write(' <title>Class Hierarchy</title>\n')
- fp.write(' <para>Not done yet</para>\n')
- fp.write(' </chapter>\n\n')
-
- fp.write(' <reference id="class-reference">\n')
- fp.write(' <title>Class Documentation</title>\n')
- for filename, obj_def in files:
- fp.write('&' + string.translate(obj_def.c_name,
- self.__transtable) + ';\n')
-
- fp.write(' </reference>\n')
- fp.write('</book>\n')
-
-if __name__ == '__main__':
- try:
- opts, args = getopt.getopt(sys.argv[1:], "d:s:o:",
- ["defs-file=", "override=", "source-dir=",
- "output-prefix="])
- except getopt.error, e:
- sys.stderr.write('docgen.py: %s\n' % e)
- sys.stderr.write(
- 'usage: docgen.py -d file.defs [-s /src/dir] [-o output-prefix]\n')
- sys.exit(1)
- defs_file = None
- overrides_file = None
- source_dirs = []
- output_prefix = 'docs'
- for opt, arg in opts:
- if opt in ('-d', '--defs-file'):
- defs_file = arg
- if opt in ('--override',):
- overrides_file = arg
- elif opt in ('-s', '--source-dir'):
- source_dirs.append(arg)
- elif opt in ('-o', '--output-prefix'):
- output_prefix = arg
- if len(args) != 0 or not defs_file:
- sys.stderr.write(
- 'usage: docgen.py -d file.defs [-s /src/dir] [-o output-prefix]\n')
- sys.exit(1)
-
- d = DocbookDocWriter()
- d.add_sourcedirs(source_dirs)
- d.add_docs(defs_file, overrides_file, 'gtk')
- d.output_docs(output_prefix)
diff --git a/codegen/h2def.py b/codegen/h2def.py
deleted file mode 100755
index d4b21356..00000000
--- a/codegen/h2def.py
+++ /dev/null
@@ -1,536 +0,0 @@
-#!/usr/bin/env python
-# -*- Mode: Python; py-indent-offset: 4 -*-
-# Search through a header file looking for function prototypes.
-# For each prototype, generate a scheme style definition.
-# GPL'ed
-# Toby D. Reeves <toby@max.rl.plh.af.mil>
-#
-# Modified by James Henstridge <james@daa.com.au> to output stuff in
-# Havoc's new defs format. Info on this format can be seen at:
-# http://www.gnome.org/mailing-lists/archives/gtk-devel-list/2000-January/0085.shtml
-# Updated to be PEP-8 compatible and refactored to use OOP
-
-import getopt
-import os
-import re
-import string
-import sys
-
-import defsparser
-
-# ------------------ Create typecodes from typenames ---------
-
-_upperstr_pat1 = re.compile(r'([^A-Z])([A-Z])')
-_upperstr_pat2 = re.compile(r'([A-Z][A-Z])([A-Z][0-9a-z])')
-_upperstr_pat3 = re.compile(r'^([A-Z])([A-Z])')
-
-def to_upper_str(name):
- """Converts a typename to the equivalent upercase and underscores
- name. This is used to form the type conversion macros and enum/flag
- name variables"""
- name = _upperstr_pat1.sub(r'\1_\2', name)
- name = _upperstr_pat2.sub(r'\1_\2', name)
- name = _upperstr_pat3.sub(r'\1_\2', name, count=1)
- return string.upper(name)
-
-def typecode(typename):
- """create a typecode (eg. GTK_TYPE_WIDGET) from a typename"""
- return string.replace(to_upper_str(typename), '_', '_TYPE_', 1)
-
-
-# ------------------ Find object definitions -----------------
-
-def strip_comments(buf):
- parts = []
- lastpos = 0
- while 1:
- pos = string.find(buf, '/*', lastpos)
- if pos >= 0:
- parts.append(buf[lastpos:pos])
- pos = string.find(buf, '*/', pos)
- if pos >= 0:
- lastpos = pos + 2
- else:
- break
- else:
- parts.append(buf[lastpos:])
- break
- return string.join(parts, '')
-
-obj_name_pat = "[A-Z][a-z]*[A-Z][A-Za-z0-9]*"
-
-split_prefix_pat = re.compile('([A-Z]+[a-z]*)([A-Za-z0-9]+)')
-
-def find_obj_defs(buf, objdefs=[]):
- """
- Try to find object definitions in header files.
- """
-
- # filter out comments from buffer.
- buf = strip_comments(buf)
-
- maybeobjdefs = [] # contains all possible objects from file
-
- # first find all structures that look like they may represent a GtkObject
- pat = re.compile("struct _(" + obj_name_pat + ")\s*{\s*" +
- "(" + obj_name_pat + ")\s+", re.MULTILINE)
- pos = 0
- while pos < len(buf):
- m = pat.search(buf, pos)
- if not m: break
- maybeobjdefs.append((m.group(1), m.group(2)))
- pos = m.end()
-
- # handle typedef struct { ... } style struct defs.
- pat = re.compile("typedef struct\s+[_\w]*\s*{\s*" +
- "(" + obj_name_pat + ")\s+[^}]*}\s*" +
- "(" + obj_name_pat + ")\s*;", re.MULTILINE)
- pos = 0
- while pos < len(buf):
- m = pat.search(buf, pos)
- if not m: break
- maybeobjdefs.append((m.group(2), m.group(2)))
- pos = m.end()
-
- # now find all structures that look like they might represent a class:
- pat = re.compile("struct _(" + obj_name_pat + ")Class\s*{\s*" +
- "(" + obj_name_pat + ")Class\s+", re.MULTILINE)
- pos = 0
- while pos < len(buf):
- m = pat.search(buf, pos)
- if not m: break
- t = (m.group(1), m.group(2))
- # if we find an object structure together with a corresponding
- # class structure, then we have probably found a GtkObject subclass.
- if t in maybeobjdefs:
- objdefs.append(t)
- pos = m.end()
-
- pat = re.compile("typedef struct\s+[_\w]*\s*{\s*" +
- "(" + obj_name_pat + ")Class\s+[^}]*}\s*" +
- "(" + obj_name_pat + ")Class\s*;", re.MULTILINE)
- pos = 0
- while pos < len(buf):
- m = pat.search(buf, pos)
- if not m: break
- t = (m.group(2), m.group(1))
- # if we find an object structure together with a corresponding
- # class structure, then we have probably found a GtkObject subclass.
- if t in maybeobjdefs:
- objdefs.append(t)
- pos = m.end()
-
- # now find all structures that look like they might represent
- # a class inherited from GTypeInterface:
- pat = re.compile("struct _(" + obj_name_pat + ")Class\s*{\s*" +
- "GTypeInterface\s+", re.MULTILINE)
- pos = 0
- while pos < len(buf):
- m = pat.search(buf, pos)
- if not m: break
- t = (m.group(1), '')
- t2 = (m.group(1)+'Class', 'GTypeInterface')
- # if we find an object structure together with a corresponding
- # class structure, then we have probably found a GtkObject subclass.
- if t2 in maybeobjdefs:
- objdefs.append(t)
- pos = m.end()
-
- # now find all structures that look like they might represent
- # an Iface inherited from GTypeInterface:
- pat = re.compile("struct _(" + obj_name_pat + ")Iface\s*{\s*" +
- "GTypeInterface\s+", re.MULTILINE)
- pos = 0
- while pos < len(buf):
- m = pat.search(buf, pos)
- if not m: break
- t = (m.group(1), '')
- t2 = (m.group(1)+'Iface', 'GTypeInterface')
- # if we find an object structure together with a corresponding
- # class structure, then we have probably found a GtkObject subclass.
- if t2 in maybeobjdefs:
- objdefs.append(t)
- pos = m.end()
-
-def sort_obj_defs(objdefs):
- objdefs.sort() # not strictly needed, but looks nice
- pos = 0
- while pos < len(objdefs):
- klass,parent = objdefs[pos]
- for i in range(pos+1, len(objdefs)):
- # parent below subclass ... reorder
- if objdefs[i][0] == parent:
- objdefs.insert(i+1, objdefs[pos])
- del objdefs[pos]
- break
- else:
- pos = pos + 1
- return objdefs
-
-# ------------------ Find enum definitions -----------------
-
-def find_enum_defs(buf, enums=[]):
- # strip comments
- # bulk comments
- buf = strip_comments(buf)
-
- buf = re.sub('\n', ' ', buf)
-
- enum_pat = re.compile(r'enum\s*{([^}]*)}\s*([A-Z][A-Za-z]*)(\s|;)')
- splitter = re.compile(r'\s*,\s', re.MULTILINE)
- pos = 0
- while pos < len(buf):
- m = enum_pat.search(buf, pos)
- if not m: break
-
- name = m.group(2)
- vals = m.group(1)
- isflags = string.find(vals, '<<') >= 0
- entries = []
- for val in splitter.split(vals):
- if not string.strip(val): continue
- entries.append(string.split(val)[0])
- if name != 'GdkCursorType':
- enums.append((name, isflags, entries))
-
- pos = m.end()
-
-# ------------------ Find function definitions -----------------
-
-def clean_func(buf):
- """
- Ideally would make buf have a single prototype on each line.
- Actually just cuts out a good deal of junk, but leaves lines
- where a regex can figure prototypes out.
- """
- # bulk comments
- buf = strip_comments(buf)
-
- # compact continued lines
- pat = re.compile(r"""\\\n""", re.MULTILINE)
- buf = pat.sub('', buf)
-
- # Preprocess directives
- pat = re.compile(r"""^[#].*?$""", re.MULTILINE)
- buf = pat.sub('', buf)
-
- #typedefs, stucts, and enums
- pat = re.compile(r"""^(typedef|struct|enum)(\s|.|\n)*?;\s*""",
- re.MULTILINE)
- buf = pat.sub('', buf)
-
- #strip DECLS macros
- pat = re.compile(r"""G_BEGIN_DECLS|BEGIN_LIBGTOP_DECLS""", re.MULTILINE)
- buf = pat.sub('', buf)
-
- #extern "C"
- pat = re.compile(r"""^\s*(extern)\s+\"C\"\s+{""", re.MULTILINE)
- buf = pat.sub('', buf)
-
- #multiple whitespace
- pat = re.compile(r"""\s+""", re.MULTILINE)
- buf = pat.sub(' ', buf)
-
- #clean up line ends
- pat = re.compile(r""";\s*""", re.MULTILINE)
- buf = pat.sub('\n', buf)
- buf = buf.lstrip()
-
- #associate *, &, and [] with type instead of variable
- #pat = re.compile(r'\s+([*|&]+)\s*(\w+)')
- pat = re.compile(r' \s* ([*|&]+) \s* (\w+)', re.VERBOSE)
- buf = pat.sub(r'\1 \2', buf)
- pat = re.compile(r'\s+ (\w+) \[ \s* \]', re.VERBOSE)
- buf = pat.sub(r'[] \1', buf)
-
- # make return types that are const work.
- buf = string.replace(buf, 'G_CONST_RETURN ', 'const-')
- buf = string.replace(buf, 'const ', 'const-')
-
- return buf
-
-proto_pat=re.compile(r"""
-(?P<ret>(-|\w|\&|\*)+\s*) # return type
-\s+ # skip whitespace
-(?P<func>\w+)\s*[(] # match the function name until the opening (
-\s*(?P<args>.*?)\s*[)] # group the function arguments
-""", re.IGNORECASE|re.VERBOSE)
-#"""
-arg_split_pat = re.compile("\s*,\s*")
-
-get_type_pat = re.compile(r'(const-)?([A-Za-z0-9]+)\*?\s+')
-pointer_pat = re.compile('.*\*$')
-func_new_pat = re.compile('(\w+)_new$')
-
-class DefsWriter:
- def __init__(self, fp=None, prefix=None, verbose=False,
- defsfilter=None):
- if not fp:
- fp = sys.stdout
-
- self.fp = fp
- self.prefix = prefix
- self.verbose = verbose
-
- self._enums = {}
- self._objects = {}
- self._functions = {}
- if defsfilter:
- filter = defsparser.DefsParser(defsfilter)
- filter.startParsing()
- for func in filter.functions + filter.methods.values():
- self._functions[func.c_name] = func
- for obj in filter.objects + filter.boxes + filter.interfaces:
- self._objects[obj.c_name] = func
- for obj in filter.enums:
- self._enums[obj.c_name] = func
-
- def write_def(self, deffile):
- buf = open(deffile).read()
-
- self.fp.write('\n;; From %s\n\n' % os.path.basename(deffile))
- self._define_func(buf)
- self.fp.write('\n')
-
- def write_enum_defs(self, enums, fp=None):
- if not fp:
- fp = self.fp
-
- fp.write(';; Enumerations and flags ...\n\n')
- trans = string.maketrans(string.uppercase + '_',
- string.lowercase + '-')
- filter = self._enums
- for cname, isflags, entries in enums:
- if filter:
- if cname in filter:
- continue
- name = cname
- module = None
- m = split_prefix_pat.match(cname)
- if m:
- module = m.group(1)
- name = m.group(2)
- if isflags:
- fp.write('(define-flags ' + name + '\n')
- else:
- fp.write('(define-enum ' + name + '\n')
- if module:
- fp.write(' (in-module "' + module + '")\n')
- fp.write(' (c-name "' + cname + '")\n')
- fp.write(' (gtype-id "' + typecode(cname) + '")\n')
- prefix = entries[0]
- for ent in entries:
- # shorten prefix til we get a match ...
- # and handle GDK_FONT_FONT, GDK_FONT_FONTSET case
- while ent[:len(prefix)] != prefix or len(prefix) >= len(ent):
- prefix = prefix[:-1]
- prefix_len = len(prefix)
- fp.write(' (values\n')
- for ent in entries:
- fp.write(' \'("%s" "%s")\n' %
- (string.translate(ent[prefix_len:], trans), ent))
- fp.write(' )\n')
- fp.write(')\n\n')
-
- def write_obj_defs(self, objdefs, fp=None):
- if not fp:
- fp = self.fp
-
- fp.write(';; -*- scheme -*-\n')
- fp.write('; object definitions ...\n')
-
- filter = self._objects
- for klass, parent in objdefs:
- if filter:
- if klass in filter:
- continue
- m = split_prefix_pat.match(klass)
- cmodule = None
- cname = klass
- if m:
- cmodule = m.group(1)
- cname = m.group(2)
- fp.write('(define-object ' + cname + '\n')
- if cmodule:
- fp.write(' (in-module "' + cmodule + '")\n')
- if parent:
- fp.write(' (parent "' + parent + '")\n')
- fp.write(' (c-name "' + klass + '")\n')
- fp.write(' (gtype-id "' + typecode(klass) + '")\n')
- # should do something about accessible fields
- fp.write(')\n\n')
-
- def _define_func(self, buf):
- buf = clean_func(buf)
- buf = string.split(buf,'\n')
- filter = self._functions
- for p in buf:
- if not p:
- continue
- m = proto_pat.match(p)
- if m == None:
- if self.verbose:
- sys.stderr.write('No match:|%s|\n' % p)
- continue
- func = m.group('func')
- if func[0] == '_':
- continue
- if filter:
- if func in filter:
- continue
- ret = m.group('ret')
- args = m.group('args')
- args = arg_split_pat.split(args)
- for i in range(len(args)):
- spaces = string.count(args[i], ' ')
- if spaces > 1:
- args[i] = string.replace(args[i], ' ', '-', spaces - 1)
-
- self._write_func(func, ret, args)
-
- def _write_func(self, name, ret, args):
- if len(args) >= 1:
- # methods must have at least one argument
- munged_name = name.replace('_', '')
- m = get_type_pat.match(args[0])
- if m:
- obj = m.group(2)
- if munged_name[:len(obj)] == obj.lower():
- self._write_method(obj, name, ret, args)
- return
-
- if self.prefix:
- l = len(self.prefix)
- if name[:l] == self.prefix and name[l] == '_':
- fname = name[l+1:]
- else:
- fname = name
- else:
- fname = name
-
- # it is either a constructor or normal function
- self.fp.write('(define-function ' + fname + '\n')
- self.fp.write(' (c-name "' + name + '")\n')
-
- # Hmmm... Let's asume that a constructor function name
- # ends with '_new' and it returns a pointer.
- m = func_new_pat.match(name)
- if pointer_pat.match(ret) and m:
- cname = ''
- for s in m.group(1).split ('_'):
- cname += s.title()
- if cname != '':
- self.fp.write(' (is-constructor-of "' + cname + '")\n')
-
- self._write_return(ret)
- self._write_arguments(args)
-
- def _write_method(self, obj, name, ret, args):
- regex = string.join(map(lambda x: x+'_?', string.lower(obj)),'')
- mname = re.sub(regex, '', name, 1)
- if self.prefix:
- l = len(self.prefix) + 1
- if mname[:l] == self.prefix and mname[l+1] == '_':
- mname = mname[l+1:]
- self.fp.write('(define-method ' + mname + '\n')
- self.fp.write(' (of-object "' + obj + '")\n')
- self.fp.write(' (c-name "' + name + '")\n')
- self._write_return(ret)
- self._write_arguments(args[1:])
-
- def _write_return(self, ret):
- if ret != 'void':
- self.fp.write(' (return-type "' + ret + '")\n')
- else:
- self.fp.write(' (return-type "none")\n')
-
- def _write_arguments(self, args):
- is_varargs = 0
- has_args = len(args) > 0
- for arg in args:
- if arg == '...':
- is_varargs = 1
- elif arg in ('void', 'void '):
- has_args = 0
- if has_args:
- self.fp.write(' (parameters\n')
- for arg in args:
- if arg != '...':
- tupleArg = tuple(string.split(arg))
- if len(tupleArg) == 2:
- self.fp.write(' \'("%s" "%s")\n' % tupleArg)
- self.fp.write(' )\n')
- if is_varargs:
- self.fp.write(' (varargs #t)\n')
- self.fp.write(')\n\n')
-
-# ------------------ Main function -----------------
-
-def main(args):
- verbose = False
- onlyenums = False
- onlyobjdefs = False
- separate = False
- modulename = None
- defsfilter = None
- opts, args = getopt.getopt(args[1:], 'vs:m:f:',
- ['onlyenums', 'onlyobjdefs',
- 'modulename=', 'separate=',
- 'defsfilter='])
- for o, v in opts:
- if o == '-v':
- verbose = True
- if o == '--onlyenums':
- onlyenums = True
- if o == '--onlyobjdefs':
- onlyobjdefs = True
- if o in ('-s', '--separate'):
- separate = v
- if o in ('-m', '--modulename'):
- modulename = v
- if o in ('-f', '--defsfilter'):
- defsfilter = v
-
- if not args[0:1]:
- print 'Must specify at least one input file name'
- return -1
-
- # read all the object definitions in
- objdefs = []
- enums = []
- for filename in args:
- buf = open(filename).read()
- find_obj_defs(buf, objdefs)
- find_enum_defs(buf, enums)
- objdefs = sort_obj_defs(objdefs)
-
- if separate:
- methods = file(separate + '.defs', 'w')
- types = file(separate + '-types.defs', 'w')
-
- dw = DefsWriter(methods, prefix=modulename, verbose=verbose,
- defsfilter=defsfilter)
- dw.write_obj_defs(objdefs, types)
- dw.write_enum_defs(enums, types)
- print "Wrote %s-types.defs" % separate
-
- for filename in args:
- dw.write_def(filename)
- print "Wrote %s.defs" % separate
- else:
- dw = DefsWriter(prefix=modulename, verbose=verbose,
- defsfilter=defsfilter)
-
- if onlyenums:
- dw.write_enum_defs(enums)
- elif onlyobjdefs:
- dw.write_obj_defs(objdefs)
- else:
- dw.write_obj_defs(objdefs)
- dw.write_enum_defs(enums)
-
- for filename in args:
- dw.write_def(filename)
-
-if __name__ == '__main__':
- sys.exit(main(sys.argv))
diff --git a/codegen/mergedefs.py b/codegen/mergedefs.py
deleted file mode 100755
index 773e499b..00000000
--- a/codegen/mergedefs.py
+++ /dev/null
@@ -1,26 +0,0 @@
-#!/usr/bin/env python
-# -*- Mode: Python; py-indent-offset: 4 -*-
-
-import optparse
-
-import defsparser
-
-parser = optparse.OptionParser(
- usage="usage: %prog [options] generated-defs old-defs")
-parser.add_option("-p", "--merge-parameters",
- help="Merge changes in function/methods parameter lists",
- action="store_true", dest="parmerge", default=False)
-(options, args) = parser.parse_args()
-
-if len(args) != 2:
- parser.error("wrong number of arguments")
-
-newp = defsparser.DefsParser(args[0])
-oldp = defsparser.DefsParser(args[1])
-
-newp.startParsing()
-oldp.startParsing()
-
-newp.merge(oldp, options.parmerge)
-
-newp.write_defs()
diff --git a/codegen/missingdefs.py b/codegen/missingdefs.py
deleted file mode 100755
index f0017e73..00000000
--- a/codegen/missingdefs.py
+++ /dev/null
@@ -1,17 +0,0 @@
-#!/usr/bin/env python
-# -*- Mode: Python; py-indent-offset: 4 -*-
-
-import sys
-import defsparser
-
-if len(sys.argv) < 3:
- sys.stderr.write("Usage: missingdefs.py generated-defs old-defs\n")
- sys.exit(1)
-
-newp = defsparser.DefsParser(sys.argv[1])
-oldp = defsparser.DefsParser(sys.argv[2])
-
-newp.startParsing()
-oldp.startParsing()
-
-newp.printMissing(oldp)
diff --git a/codegen/mkskel.py b/codegen/mkskel.py
deleted file mode 100755
index 61f520bf..00000000
--- a/codegen/mkskel.py
+++ /dev/null
@@ -1,89 +0,0 @@
-#!/usr/bin/env python
-# -*- Mode: Python; py-indent-offset: 4 -*-
-
-import sys, os, getopt
-
-module_init_template = \
-'/* -*- Mode: C; c-basic-offset: 4 -*- */\n' + \
-'#ifdef HAVE_CONFIG_H\n' + \
-'# include "config.h"\n' + \
-'#endif\n' + \
-'#include <Python.h>\n' + \
-'#include <pygtk.h>\n' + \
-'\n' + \
-'/* include any extra headers needed here */\n' + \
-'\n' + \
-'void %(prefix)s_register_classes(PyObject *d);\n' + \
-'extern PyMethodDef %(prefix)s_functions[];\n' + \
-'\n' + \
-'DL_EXPORT(void)\n' + \
-'init%(module)s(void)\n' + \
-'{\n' + \
-' PyObject *m, *d;\n' + \
-'\n' + \
-' /* perform any initialisation required by the library here */\n' + \
-'\n' + \
-' m = Py_InitModule("%(module)s", %(prefix)s_functions);\n' + \
-' d = PyModule_GetDict(m);\n' + \
-'\n' + \
-' init_pygtk();\n' + \
-'\n' + \
-' %(prefix)s_register_classes(d);\n' + \
-'\n' + \
-' /* add anything else to the module dictionary (such as constants) */\n' +\
-'\n' + \
-' if (PyErr_Occurred())\n' + \
-' Py_FatalError("could not initialise module %(module)s");\n' + \
-'}\n'
-
-override_template = \
-'/* -*- Mode: C; c-basic-offset: 4 -*- */\n' + \
-'%%%%\n' + \
-'headers\n' + \
-'/* include any required headers here */\n' + \
-'%%%%\n' + \
-'init\n' + \
-' /* include any code here that needs to be executed before the\n' + \
-' * extension classes get initialised */\n' + \
-'%%%%\n' + \
-'\n' + \
-'/* you should add appropriate ignore, ignore-glob and\n' + \
-' * override sections here */\n'
-
-def open_with_backup(file):
- if os.path.exists(file):
- try:
- os.rename(file, file+'~')
- except OSError:
- # fail silently if we can't make a backup
- pass
- return open(file, 'w')
-
-def write_skels(fileprefix, prefix, module):
- fp = open_with_backup(fileprefix+'module.c')
- fp.write(module_init_template % { 'prefix': prefix, 'module': module })
- fp.close()
- fp = open_with_backup(fileprefix+'.override')
- fp.write(override_template % { 'prefix': prefix, 'module': module })
- fp.close()
-
-if __name__ == '__main__':
- opts, args = getopt.getopt(sys.argv[1:], 'f:p:m:h',
- ['file-prefix=', 'prefix=', 'module=', 'help'])
- fileprefix = None
- prefix = None
- module = None
- for opt, arg in opts:
- if opt in ('-f', '--file-prefix'):
- fileprefix = arg
- elif opt in ('-p', '--prefix'):
- prefix = arg
- elif opt in ('-m', '--module'):
- module = arg
- elif opt in ('-h', '--help'):
- print 'usage: mkskel.py -f fileprefix -p prefix -m module'
- sys.exit(0)
- if not fileprefix or not prefix or not module:
- print 'usage: mkskel.py -f fileprefix -p prefix -m module'
- sys.exit(1)
- write_skels(fileprefix, prefix, module)
diff --git a/codegen/override.py b/codegen/override.py
deleted file mode 100644
index c4d5ffa2..00000000
--- a/codegen/override.py
+++ /dev/null
@@ -1,281 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-
-# this file contains code for loading up an override file. The override file
-# provides implementations of functions where the code generator could not
-# do its job correctly.
-
-import fnmatch
-import os
-import re
-import string
-import sys
-
-def class2cname(klass, method):
- c_name = ''
- for c in klass:
- if c.isupper():
- c_name += '_' + c.lower()
- else:
- c_name += c
- return c_name[1:] + '_' + method
-
-import_pat = re.compile(r'\s*import\s+(\S+)\.([^\s.]+)\s+as\s+(\S+)')
-
-class Overrides:
- def __init__(self, filename=None):
- self.modulename = None
- self.ignores = {}
- self.glob_ignores = []
- self.type_ignores = {}
- self.overrides = {}
- self.overridden = {}
- self.kwargs = {}
- self.noargs = {}
- self.onearg = {}
- self.staticmethod = {}
- self.classmethod = {}
- self.startlines = {}
- self.override_attrs = {}
- self.override_slots = {}
- self.headers = ''
- self.body = ''
- self.init = ''
- self.imports = []
- self.defines = {}
- self.functions = {}
- self.newstyle_constructors = {}
- self.dynamicnamespace = False
- if filename:
- self.handle_file(filename)
-
- def handle_file(self, filename):
- oldpath = os.getcwd()
-
- fp = open(filename, 'r')
- dirname = os.path.dirname(os.path.abspath(filename))
-
- if dirname != oldpath:
- os.chdir(dirname)
-
- # read all the components of the file ...
- bufs = []
- startline = 1
- lines = []
- line = fp.readline()
- linenum = 1
- while line:
- if line == '%%\n' or line == '%%':
- if lines:
- bufs.append((string.join(lines, ''), startline))
- startline = linenum + 1
- lines = []
- else:
- lines.append(line)
- line = fp.readline()
- linenum = linenum + 1
- if lines:
- bufs.append((string.join(lines, ''), startline))
- if not bufs: return
-
- for buf, startline in bufs:
- self.__parse_override(buf, startline, filename)
-
- os.chdir(oldpath)
-
- def __parse_override(self, buffer, startline, filename):
- pos = string.find(buffer, '\n')
- if pos >= 0:
- line = buffer[:pos]
- rest = buffer[pos+1:]
- else:
- line = buffer ; rest = ''
- words = string.split(line)
- command = words[0]
- if (command == 'ignore' or
- command == 'ignore-' + sys.platform):
- "ignore/ignore-platform [functions..]"
- for func in words[1:]:
- self.ignores[func] = 1
- for func in string.split(rest):
- self.ignores[func] = 1
- elif (command == 'ignore-glob' or
- command == 'ignore-glob-' + sys.platform):
- "ignore-glob/ignore-glob-platform [globs..]"
- for func in words[1:]:
- self.glob_ignores.append(func)
- for func in string.split(rest):
- self.glob_ignores.append(func)
- elif (command == 'ignore-type' or
- command == 'ignore-type-' + sys.platform):
- "ignore-type/ignore-type-platform [typenames..]"
- for typename in words[1:]:
- self.type_ignores[typename] = 1
- for typename in string.split(rest):
- self.type_ignores[typename] = 1
- elif command == 'override':
- "override function/method [kwargs|noargs|onearg] [staticmethod|classmethod]"
- func = words[1]
- if 'kwargs' in words[1:]:
- self.kwargs[func] = 1
- elif 'noargs' in words[1:]:
- self.noargs[func] = 1
- elif 'onearg' in words[1:]:
- self.onearg[func] = True
-
- if 'staticmethod' in words[1:]:
- self.staticmethod[func] = True
- elif 'classmethod' in words[1:]:
- self.classmethod[func] = True
- if func in self.overrides:
- raise RuntimeError("Function %s is being overridden more than once" % (func,))
- self.overrides[func] = rest
- self.startlines[func] = (startline + 1, filename)
- elif command == 'override-attr':
- "override-slot Class.attr"
- attr = words[1]
- self.override_attrs[attr] = rest
- self.startlines[attr] = (startline + 1, filename)
- elif command == 'override-slot':
- "override-slot Class.slot"
- slot = words[1]
- self.override_slots[slot] = rest
- self.startlines[slot] = (startline + 1, filename)
- elif command == 'headers':
- "headers"
- self.headers = '%s\n#line %d "%s"\n%s' % \
- (self.headers, startline + 1, filename, rest)
- elif command == 'body':
- "body"
- self.body = '%s\n#line %d "%s"\n%s' % \
- (self.body, startline + 1, filename, rest)
- elif command == 'init':
- "init"
- self.init = '%s\n#line %d "%s"\n%s' % \
- (self.init, startline + 1, filename, rest)
- elif command == 'modulename':
- "modulename name"
- self.modulename = words[1]
- elif command == 'include':
- "include filename"
- for filename in words[1:]:
- self.handle_file(filename)
- for filename in string.split(rest):
- self.handle_file(filename)
- elif command == 'import':
- "import module1 [\n module2, \n module3 ...]"
- for line in string.split(buffer, '\n'):
- match = import_pat.match(line)
- if match:
- self.imports.append(match.groups())
- elif command == 'define':
- "define funcname [kwargs|noargs|onearg] [classmethod|staticmethod]"
- "define Class.method [kwargs|noargs|onearg] [classmethod|staticmethod]"
- func = words[1]
- klass = None
- if func.find('.') != -1:
- klass, func = func.split('.', 1)
-
- if not self.defines.has_key(klass):
- self.defines[klass] = {}
- self.defines[klass][func] = rest
- else:
- self.functions[func] = rest
-
- if 'kwargs' in words[1:]:
- self.kwargs[func] = 1
- elif 'noargs' in words[1:]:
- self.noargs[func] = 1
- elif 'onearg' in words[1:]:
- self.onearg[func] = 1
-
- if 'staticmethod' in words[1:]:
- self.staticmethod[func] = True
- elif 'classmethod' in words[1:]:
- self.classmethod[func] = True
-
- self.startlines[func] = (startline + 1, filename)
-
- elif command == 'new-constructor':
- "new-constructor GType"
- gtype, = words[1:]
- self.newstyle_constructors[gtype] = True
- elif command == 'options':
- for option in words[1:]:
- if option == 'dynamicnamespace':
- self.dynamicnamespace = True
-
- def is_ignored(self, name):
- if self.ignores.has_key(name):
- return 1
- for glob in self.glob_ignores:
- if fnmatch.fnmatchcase(name, glob):
- return 1
- return 0
-
- def is_type_ignored(self, name):
- return name in self.type_ignores
-
- def is_overriden(self, name):
- return self.overrides.has_key(name)
-
- def is_already_included(self, name):
- return self.overridden.has_key(name)
-
- def override(self, name):
- self.overridden[name] = 1
- return self.overrides[name]
-
- def define(self, klass, name):
- self.overridden[class2cname(klass, name)] = 1
- return self.defines[klass][name]
-
- def function(self, name):
- return self.functions[name]
-
- def getstartline(self, name):
- return self.startlines[name]
-
- def wants_kwargs(self, name):
- return self.kwargs.has_key(name)
-
- def wants_noargs(self, name):
- return self.noargs.has_key(name)
-
- def wants_onearg(self, name):
- return self.onearg.has_key(name)
-
- def is_staticmethod(self, name):
- return self.staticmethod.has_key(name)
-
- def is_classmethod(self, name):
- return self.classmethod.has_key(name)
-
- def attr_is_overriden(self, attr):
- return self.override_attrs.has_key(attr)
-
- def attr_override(self, attr):
- return self.override_attrs[attr]
-
- def slot_is_overriden(self, slot):
- return self.override_slots.has_key(slot)
-
- def slot_override(self, slot):
- return self.override_slots[slot]
-
- def get_headers(self):
- return self.headers
-
- def get_body(self):
- return self.body
-
- def get_init(self):
- return self.init
-
- def get_imports(self):
- return self.imports
-
- def get_defines_for(self, klass):
- return self.defines.get(klass, {})
-
- def get_functions(self):
- return self.functions
diff --git a/codegen/pygtk-codegen-2.0.in b/codegen/pygtk-codegen-2.0.in
deleted file mode 100644
index 95b547ac..00000000
--- a/codegen/pygtk-codegen-2.0.in
+++ /dev/null
@@ -1,11 +0,0 @@
-#!/bin/sh
-
-prefix=@prefix@
-datarootdir=@datarootdir@
-datadir=@datadir@
-codegendir=${datadir}/pygtk/2.0/codegen
-
-PYTHONPATH=$codegendir
-export PYTHONPATH
-
-exec @PYTHON@ $codegendir/codegen.py "$@"
diff --git a/codegen/reversewrapper.py b/codegen/reversewrapper.py
deleted file mode 100644
index 2a7b6414..00000000
--- a/codegen/reversewrapper.py
+++ /dev/null
@@ -1,851 +0,0 @@
-### -*- python -*-
-### Code to generate "Reverse Wrappers", i.e. C->Python wrappers
-### (C) 2004 Gustavo Carneiro <gjc@gnome.org>
-import argtypes
-import os
-
-DEBUG_MODE = ('PYGTK_CODEGEN_DEBUG' in os.environ)
-
-def join_ctype_name(ctype, name):
- '''Joins a C type and a variable name into a single string'''
- if ctype[-1] != '*':
- return " ".join((ctype, name))
- else:
- return "".join((ctype, name))
-
-
-class CodeSink(object):
- def __init__(self):
- self.indent_level = 0 # current indent level
- self.indent_stack = [] # previous indent levels
-
- def _format_code(self, code):
- assert isinstance(code, str)
- l = []
- for line in code.split('\n'):
- l.append(' '*self.indent_level + line)
- if l[-1]:
- l.append('')
- return '\n'.join(l)
-
- def writeln(self, line=''):
- raise NotImplementedError
-
- def indent(self, level=4):
- '''Add a certain ammount of indentation to all lines written
- from now on and until unindent() is called'''
- self.indent_stack.append(self.indent_level)
- self.indent_level += level
-
- def unindent(self):
- '''Revert indentation level to the value before last indent() call'''
- self.indent_level = self.indent_stack.pop()
-
-
-class FileCodeSink(CodeSink):
- def __init__(self, fp):
- CodeSink.__init__(self)
- assert isinstance(fp, file)
- self.fp = fp
-
- def writeln(self, line=''):
- self.fp.write(self._format_code(line))
-
-class MemoryCodeSink(CodeSink):
- def __init__(self):
- CodeSink.__init__(self)
- self.lines = []
-
- def writeln(self, line=''):
- self.lines.append(self._format_code(line))
-
- def flush_to(self, sink):
- assert isinstance(sink, CodeSink)
- for line in self.lines:
- sink.writeln(line.rstrip())
- self.lines = []
-
- def flush(self):
- l = []
- for line in self.lines:
- l.append(self._format_code(line))
- self.lines = []
- return "".join(l)
-
-class ReverseWrapper(object):
- '''Object that generates a C->Python wrapper'''
- def __init__(self, cname, is_static=True):
- assert isinstance(cname, str)
-
- self.cname = cname
- ## function object we will call, or object whose method we will call
- self.called_pyobj = None
- ## name of method of self.called_pyobj we will call
- self.method_name = None
- self.is_static = is_static
-
- self.parameters = []
- self.declarations = MemoryCodeSink()
- self.post_return_code = MemoryCodeSink()
- self.body = MemoryCodeSink()
- self.cleanup_actions = []
- self.pyargv_items = []
- self.pyargv_optional_items = []
- self.pyret_parse_items = [] # list of (format_spec, parameter)
-
- def set_call_target(self, called_pyobj, method_name=None):
- assert called_pyobj is not None
- assert self.called_pyobj is None
- self.called_pyobj = called_pyobj
- self.method_name = method_name
-
- def set_return_type(self, return_type):
- assert isinstance(return_type, ReturnType)
- self.return_type = return_type
-
- def add_parameter(self, param):
- assert isinstance(param, Parameter)
- self.parameters.append(param)
-
- def add_declaration(self, decl_code):
- self.declarations.writeln(decl_code)
-
- def add_pyargv_item(self, variable, optional=False):
- if optional:
- self.pyargv_optional_items.append(variable)
- else:
- self.pyargv_items.append(variable)
-
- def add_pyret_parse_item(self, format_specifier, parameter, prepend=False):
- if prepend:
- self.pyret_parse_items.insert(0, (format_specifier, parameter))
- else:
- self.pyret_parse_items.append((format_specifier, parameter))
-
- def write_code(self, code,
- cleanup=None,
- failure_expression=None,
- failure_cleanup=None,
- failure_exception=None,
- code_sink=None):
- '''Add a chunk of code with cleanup and error handling
-
- This method is to be used by TypeHandlers when generating code
-
- Keywork arguments:
- code -- code to add
- cleanup -- code to cleanup any dynamic resources created by @code
- (except in case of failure) (default None)
- failure_expression -- C boolean expression to indicate
- if anything failed (default None)
- failure_cleanup -- code to cleanup any dynamic resources
- created by @code in case of failure (default None)
- failure_exception -- code to raise an exception in case of
- failure (which will be immediately
- printed and cleared), (default None)
- code_sink -- "code sink" to use; by default,
- ReverseWrapper.body is used, which writes the
- main body of the wrapper, before calling the
- python method. Alternatively,
- ReverseWrapper.after_pyret_parse can be used, to
- write code after the PyArg_ParseTuple that
- parses the python method return value.
- '''
- if code_sink is None:
- code_sink = self.body
- if code is not None:
- code_sink.writeln(code)
- if failure_expression is not None:
- code_sink.writeln("if (%s) {" % (failure_expression,))
- code_sink.indent()
- if failure_exception is None:
- code_sink.writeln("if (PyErr_Occurred())")
- code_sink.indent()
- code_sink.writeln("PyErr_Print();")
- code_sink.unindent()
- else:
- code_sink.writeln(failure_exception)
- code_sink.writeln("PyErr_Print();")
- if failure_cleanup is not None:
- code_sink.writeln(failure_cleanup)
- for cleanup_action in self.cleanup_actions:
- code_sink.writeln(cleanup_action)
- self.return_type.write_error_return()
- code_sink.unindent()
- code_sink.writeln("}")
- if cleanup is not None:
- self.cleanup_actions.insert(0, cleanup)
-
- def generate(self, sink):
- '''Generate the code into a CodeSink object'''
- assert isinstance(sink, CodeSink)
-
- if DEBUG_MODE:
- self.declarations.writeln("/* begin declarations */")
- self.body.writeln("/* begin main body */")
- self.post_return_code.writeln("/* begin post-return code */")
-
- self.add_declaration("PyGILState_STATE __py_state;")
- self.write_code(code="__py_state = pyg_gil_state_ensure();",
- cleanup="pyg_gil_state_release(__py_state);")
-
- for param in self.parameters:
- param.convert_c2py()
-
- assert self.called_pyobj is not None,\
- "Parameters failed to provide a target function or method."
-
- if self.is_static:
- sink.writeln('static %s' % self.return_type.get_c_type())
- else:
- sink.writeln(self.return_type.get_c_type())
- c_proto_params = map(Parameter.format_for_c_proto, self.parameters)
- sink.writeln("%s(%s)\n{" % (self.cname, ", ".join(c_proto_params)))
-
- self.return_type.write_decl()
- self.add_declaration("PyObject *py_retval;")
-
- ## Handle number of arguments
- if self.pyargv_items:
- self.add_declaration("PyObject *py_args;")
- py_args = "py_args"
- if self.pyargv_optional_items:
- self.add_declaration("int argc = %i;" % len(self.pyargv_items))
- argc = "argc"
- for arg in self.pyargv_optional_items:
- self.body.writeln("if (%s)" % arg)
- self.body.indent()
- self.body.writeln("++argc;")
- self.body.unindent()
- else:
- argc = str(len(self.pyargv_items))
- else:
- if self.pyargv_optional_items:
- self.add_declaration("PyObject *py_args;")
- py_args = "py_args"
- self.add_declaration("int argc = 0;")
- argc = "argc"
- for arg in self.pyargv_optional_items:
- self.body.writeln("if (%s)" % arg)
- self.body.indent()
- self.body.writeln("++argc;")
- self.body.unindent()
- else:
- py_args = "NULL"
- argc = None
-
- self.body.writeln()
-
- if py_args != "NULL":
- self.write_code("py_args = PyTuple_New(%s);" % argc,
- cleanup="Py_DECREF(py_args);")
- pos = 0
- for arg in self.pyargv_items:
- try: # try to remove the Py_DECREF cleanup action, if we can
- self.cleanup_actions.remove("Py_DECREF(%s);" % arg)
- except ValueError: # otherwise we have to Py_INCREF..
- self.body.writeln("Py_INCREF(%s);" % arg)
- self.body.writeln("PyTuple_SET_ITEM(%s, %i, %s);" % (py_args, pos, arg))
- pos += 1
- for arg in self.pyargv_optional_items:
- self.body.writeln("if (%s) {" % arg)
- self.body.indent()
- try: # try to remove the Py_DECREF cleanup action, if we can
- self.cleanup_actions.remove("Py_XDECREF(%s);" % arg)
- except ValueError: # otherwise we have to Py_INCREF..
- self.body.writeln("Py_INCREF(%s);" % arg)
- self.body.writeln("PyTuple_SET_ITEM(%s, %i, %s);" % (py_args, pos, arg))
- self.body.unindent()
- self.body.writeln("}")
- pos += 1
-
- self.body.writeln()
-
- ## Call the python method
- if self.method_name is None:
- self.write_code("py_retval = PyObject_Call(%s, %s);"
- % (self.called_pyobj, py_args),
- cleanup="Py_DECREF(py_retval);",
- failure_expression="!py_retval")
- else:
- self.add_declaration("PyObject *py_method;")
- self.write_code("py_method = PyObject_GetAttrString(%s, \"%s\");"
- % (self.called_pyobj, self.method_name),
- cleanup="Py_DECREF(py_method);",
- failure_expression="!py_method")
- self.write_code("py_retval = PyObject_CallObject(py_method, %s);"
- % (py_args,),
- cleanup="Py_DECREF(py_retval);",
- failure_expression="!py_retval")
-
- ## -- Handle the return value --
-
- ## we need to check if the return_type object is prepared to cooperate with multiple return values
- len_before = len(self.pyret_parse_items)
- self.return_type.write_conversion()
- len_after = len(self.pyret_parse_items)
- assert (self.return_type.get_c_type() == 'void'
- or not (len_before == len_after and len_after > 0)),\
- ("Bug in reverse wrappers: return type handler %s"
- " is not prepared to cooperate multiple return values") % (type(self.return_type),)
-
- sink.indent()
-
- if len(self.pyret_parse_items) == 1:
- ## if retval is one item only, pack it in a tuple so we
- ## can use PyArg_ParseTuple as usual..
- self.write_code('py_retval = Py_BuildValue("(N)", py_retval);')
- if len(self.pyret_parse_items) > 0:
- ## Parse return values using PyArg_ParseTuple
- self.write_code(code=None, failure_expression=(
- '!PyArg_ParseTuple(py_retval, "%s", %s)' % (
- "".join([format for format, param in self.pyret_parse_items]),
- ", ".join([param for format, param in self.pyret_parse_items]))))
-
- if DEBUG_MODE:
- self.declarations.writeln("/* end declarations */")
- self.declarations.flush_to(sink)
- sink.writeln()
- if DEBUG_MODE:
- self.body.writeln("/* end main body */")
- self.body.flush_to(sink)
- sink.writeln()
- if DEBUG_MODE:
- self.post_return_code.writeln("/* end post-return code */")
- self.post_return_code.flush_to(sink)
- sink.writeln()
-
- for cleanup_action in self.cleanup_actions:
- sink.writeln(cleanup_action)
- if self.return_type.get_c_type() != 'void':
- sink.writeln()
- sink.writeln("return retval;")
- sink.unindent()
- sink.writeln("}")
-
-class TypeHandler(object):
- def __init__(self, wrapper, **props):
- assert isinstance(wrapper, ReverseWrapper)
- self.wrapper = wrapper
- self.props = props
-
-class ReturnType(TypeHandler):
-
- def get_c_type(self):
- raise NotImplementedError
-
- def write_decl(self):
- raise NotImplementedError
-
- def write_error_return(self):
- '''Write "return <value>" code in case of error'''
- raise NotImplementedError
-
- def write_conversion(self):
- '''Writes code to convert Python return value in 'py_retval'
- into C 'retval'. Returns a string with C boolean expression
- that determines if anything went wrong. '''
- raise NotImplementedError
-
-class Parameter(TypeHandler):
-
- def __init__(self, wrapper, name, **props):
- TypeHandler.__init__(self, wrapper, **props)
- self.name = name
-
- def get_c_type(self):
- raise NotImplementedError
-
- def convert_c2py(self):
- '''Write some code before calling the Python method.'''
- pass
-
- def format_for_c_proto(self):
- return join_ctype_name(self.get_c_type(), self.name)
-
-
-###---
-class StringParam(Parameter):
-
- def get_c_type(self):
- return self.props.get('c_type', 'char *').replace('const-', 'const ')
-
- def convert_c2py(self):
- if self.props.get('optional', False):
- self.wrapper.add_declaration("PyObject *py_%s = NULL;" % self.name)
- self.wrapper.write_code(code=("if (%s)\n"
- " py_%s = PyString_FromString(%s);\n"
- % (self.name, self.name, self.name)),
- cleanup=("Py_XDECREF(py_%s);" % self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name, optional=True)
- else:
- self.wrapper.add_declaration("PyObject *py_%s;" % self.name)
- self.wrapper.write_code(code=("py_%s = PyString_FromString(%s);" %
- (self.name, self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name),
- failure_expression=("!py_%s" % self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name)
-
-for ctype in ('char*', 'gchar*', 'const-char*', 'char-const*', 'const-gchar*',
- 'gchar-const*', 'string', 'static_string'):
- argtypes.matcher.register_reverse(ctype, StringParam)
-del ctype
-
-class StringReturn(ReturnType):
-
- def get_c_type(self):
- return self.props.get('c_type', 'char *').replace('const-', 'const ')
- #return "char *"
-
- def write_decl(self):
- self.wrapper.add_declaration("%s retval;" % self.get_c_type())
- #self.wrapper.add_declaration("char *retval;")
-
- def write_error_return(self):
- self.wrapper.write_code("return NULL;")
-
- def write_conversion(self):
- self.wrapper.add_pyret_parse_item("s", "&retval", prepend=True)
- self.wrapper.write_code("retval = g_strdup(retval);", code_sink=self.wrapper.post_return_code)
-
-for ctype in ('char*', 'gchar*', 'const-gchar*'):
- argtypes.matcher.register_reverse_ret(ctype, StringReturn)
-del ctype
-
-
-class VoidReturn(ReturnType):
-
- def get_c_type(self):
- return "void"
-
- def write_decl(self):
- pass
-
- def write_error_return(self):
- self.wrapper.write_code("return;")
-
- def write_conversion(self):
- self.wrapper.write_code(
- code=None,
- failure_expression="py_retval != Py_None",
- failure_exception='PyErr_SetString(PyExc_TypeError, "retval should be None");')
-
-argtypes.matcher.register_reverse_ret('void', VoidReturn)
-argtypes.matcher.register_reverse_ret('none', VoidReturn)
-
-class GObjectParam(Parameter):
-
- def get_c_type(self):
- return self.props.get('c_type', 'GObject *')
-
- def convert_c2py(self):
- self.wrapper.add_declaration("PyObject *py_%s = NULL;" % self.name)
- self.wrapper.write_code(code=("if (%s)\n"
- " py_%s = pygobject_new((GObject *) %s);\n"
- "else {\n"
- " Py_INCREF(Py_None);\n"
- " py_%s = Py_None;\n"
- "}"
- % (self.name, self.name, self.name, self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name)
-
-argtypes.matcher.register_reverse('GObject*', GObjectParam)
-
-class GObjectReturn(ReturnType):
-
- def get_c_type(self):
- return self.props.get('c_type', 'GObject *')
-
- def write_decl(self):
- self.wrapper.add_declaration("%s retval;" % self.get_c_type())
-
- def write_error_return(self):
- self.wrapper.write_code("return NULL;")
-
- def write_conversion(self):
- self.wrapper.write_code(
- code=None,
- failure_expression="!PyObject_TypeCheck(py_retval, &PyGObject_Type)",
- failure_exception='PyErr_SetString(PyExc_TypeError, "retval should be a GObject");')
- self.wrapper.write_code("retval = (%s) pygobject_get(py_retval);"
- % self.get_c_type())
- self.wrapper.write_code("g_object_ref((GObject *) retval);")
-
-argtypes.matcher.register_reverse_ret('GObject*', GObjectReturn)
-
-
-
-class IntParam(Parameter):
-
- def get_c_type(self):
- return self.props.get('c_type', 'int')
-
- def convert_c2py(self):
- self.wrapper.add_declaration("PyObject *py_%s;" % self.name)
- self.wrapper.write_code(code=("py_%s = PyInt_FromLong(%s);" %
- (self.name, self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name)
-
-class IntReturn(ReturnType):
- def get_c_type(self):
- return self.props.get('c_type', 'int')
- def write_decl(self):
- self.wrapper.add_declaration("%s retval;" % self.get_c_type())
- def write_error_return(self):
- self.wrapper.write_code("return -G_MAXINT;")
- def write_conversion(self):
- self.wrapper.add_pyret_parse_item("i", "&retval", prepend=True)
-
-for argtype in ('int', 'gint', 'guint', 'short', 'gshort', 'gushort', 'long',
- 'glong', 'gsize', 'gssize', 'guint8', 'gint8', 'guint16',
- 'gint16', 'gint32', 'GTime'):
- argtypes.matcher.register_reverse(argtype, IntParam)
- argtypes.matcher.register_reverse_ret(argtype, IntReturn)
-del argtype
-
-class IntPtrParam(Parameter):
- def __init__(self, wrapper, name, **props):
- if "direction" not in props:
- raise argtypes.ArgTypeConfigurationError(
- "cannot use int* parameter without direction")
- if props["direction"] not in ("out", "inout"):
- raise argtypes.ArgTypeConfigurationError(
- "cannot use int* parameter with direction '%s'"
- % (props["direction"],))
- Parameter.__init__(self, wrapper, name, **props)
- def get_c_type(self):
- return self.props.get('c_type', 'int*')
- def convert_c2py(self):
- if self.props["direction"] == "inout":
- self.wrapper.add_declaration("PyObject *py_%s;" % self.name)
- self.wrapper.write_code(code=("py_%s = PyInt_FromLong(*%s);" %
- (self.name, self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name)
- self.wrapper.add_pyret_parse_item("i", self.name)
-for argtype in ('int*', 'gint*'):
- argtypes.matcher.register_reverse(argtype, IntPtrParam)
-del argtype
-
-
-class GEnumReturn(IntReturn):
- def write_conversion(self):
- self.wrapper.write_code(
- code=None,
- failure_expression=(
- "pyg_enum_get_value(%s, py_retval, (gint *)&retval)"
- % (self.props['typecode'],)))
-
-argtypes.matcher.register_reverse_ret("GEnum", GEnumReturn)
-
-class GEnumParam(IntParam):
- def convert_c2py(self):
- self.wrapper.add_declaration("PyObject *py_%s;" % self.name)
- self.wrapper.write_code(code=("py_%s = pyg_enum_from_gtype(%s, %s);" %
- (self.name, self.props['typecode'], self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name),
- failure_expression=("!py_%s" % self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name)
-
-argtypes.matcher.register_reverse("GEnum", GEnumParam)
-
-class GFlagsReturn(IntReturn):
- def write_conversion(self):
- self.wrapper.write_code(
- code=None,
- failure_expression=(
- "pyg_flags_get_value(%s, py_retval, (gint *)&retval)" %
- self.props['typecode']))
-
-argtypes.matcher.register_reverse_ret("GFlags", GFlagsReturn)
-
-class GFlagsParam(IntParam):
- def convert_c2py(self):
- self.wrapper.add_declaration("PyObject *py_%s;" % self.name)
- self.wrapper.write_code(code=(
- "py_%s = pyg_flags_from_gtype(%s, %s);" %
- (self.name, self.props['typecode'], self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name),
- failure_expression=("!py_%s" % self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name)
-
-argtypes.matcher.register_reverse("GFlags", GFlagsParam)
-
-
-class GtkTreePathParam(IntParam):
- def convert_c2py(self):
- self.wrapper.add_declaration("PyObject *py_%s;" % self.name)
- self.wrapper.write_code(code=(
- "py_%s = pygtk_tree_path_to_pyobject(%s);" %
- (self.name, self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name),
- failure_expression=("!py_%s" % self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name)
-
-argtypes.matcher.register_reverse("GtkTreePath*", GtkTreePathParam)
-
-
-class GtkTreePathReturn(ReturnType):
- def get_c_type(self):
- return self.props.get('c_type', 'GtkTreePath *')
- def write_decl(self):
- self.wrapper.add_declaration("GtkTreePath * retval;")
- def write_error_return(self):
- self.wrapper.write_code("return NULL;")
- def write_conversion(self):
- self.wrapper.write_code(
- "retval = pygtk_tree_path_from_pyobject(py_retval);\n",
- failure_expression=('!retval'),
- failure_exception=(
- 'PyErr_SetString(PyExc_TypeError, "retval should be a GtkTreePath");'))
-
-argtypes.matcher.register_reverse_ret("GtkTreePath*", GtkTreePathReturn)
-
-
-class BooleanReturn(ReturnType):
- def get_c_type(self):
- return "gboolean"
- def write_decl(self):
- self.wrapper.add_declaration("gboolean retval;")
- self.wrapper.add_declaration("PyObject *py_main_retval;")
- def write_error_return(self):
- self.wrapper.write_code("return FALSE;")
- def write_conversion(self):
- self.wrapper.add_pyret_parse_item("O", "&py_main_retval", prepend=True)
- self.wrapper.write_code(
- "retval = PyObject_IsTrue(py_main_retval)? TRUE : FALSE;",
- code_sink=self.wrapper.post_return_code)
-argtypes.matcher.register_reverse_ret("gboolean", BooleanReturn)
-
-class BooleanParam(Parameter):
- def get_c_type(self):
- return "gboolean"
- def convert_c2py(self):
- self.wrapper.add_declaration("PyObject *py_%s;" % self.name)
- self.wrapper.write_code("py_%s = %s? Py_True : Py_False;"
- % (self.name, self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name)
-
-argtypes.matcher.register_reverse("gboolean", BooleanParam)
-
-
-class DoubleParam(Parameter):
- def get_c_type(self):
- return self.props.get('c_type', 'gdouble')
- def convert_c2py(self):
- self.wrapper.add_declaration("PyObject *py_%s;" % self.name)
- self.wrapper.write_code(code=("py_%s = PyFloat_FromDouble(%s);" %
- (self.name, self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name)
-
-class DoublePtrParam(Parameter):
- def __init__(self, wrapper, name, **props):
- if "direction" not in props:
- raise argtypes.ArgTypeConfigurationError(
- "cannot use double* parameter without direction")
- if props["direction"] not in ("out", ): # inout not yet implemented
- raise argtypes.ArgTypeConfigurationError(
- "cannot use double* parameter with direction '%s'"
- % (props["direction"],))
- Parameter.__init__(self, wrapper, name, **props)
- def get_c_type(self):
- return self.props.get('c_type', 'double*')
- def convert_c2py(self):
- self.wrapper.add_pyret_parse_item("d", self.name)
-for argtype in ('double*', 'gdouble*'):
- argtypes.matcher.register_reverse(argtype, DoublePtrParam)
-del argtype
-
-class DoubleReturn(ReturnType):
- def get_c_type(self):
- return self.props.get('c_type', 'gdouble')
- def write_decl(self):
- self.wrapper.add_declaration("%s retval;" % self.get_c_type())
- def write_error_return(self):
- self.wrapper.write_code("return -G_MAXFLOAT;")
- def write_conversion(self):
- self.wrapper.write_code(
- code=None,
- failure_expression="!PyFloat_AsDouble(py_retval)",
- failure_exception=
- 'PyErr_SetString(PyExc_TypeError, "retval should be a float");')
- self.wrapper.write_code("retval = PyFloat_AsDouble(py_retval);")
-
-for argtype in ('float', 'double', 'gfloat', 'gdouble'):
- argtypes.matcher.register_reverse(argtype, DoubleParam)
- argtypes.matcher.register_reverse_ret(argtype, DoubleReturn)
-
-
-class GBoxedParam(Parameter):
- def get_c_type(self):
- return self.props.get('c_type').replace('const-', 'const ')
- def convert_c2py(self):
- self.wrapper.add_declaration("PyObject *py_%s;" % self.name)
- ctype = self.get_c_type()
- if ctype.startswith('const '):
- ctype_no_const = ctype[len('const '):]
- self.wrapper.write_code(
- code=('py_%s = pyg_boxed_new(%s, (%s) %s, TRUE, TRUE);' %
- (self.name, self.props['typecode'],
- ctype_no_const, self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name))
- else:
- self.wrapper.write_code(
- code=('py_%s = pyg_boxed_new(%s, %s, FALSE, FALSE);' %
- (self.name, self.props['typecode'], self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name)
-
-argtypes.matcher.register_reverse("GBoxed", GBoxedParam)
-
-
-class GBoxedReturn(ReturnType):
- def get_c_type(self):
- return self.props.get('c_type')
- def write_decl(self):
- self.wrapper.add_declaration("%s retval;" % self.get_c_type())
- def write_error_return(self):
- self.wrapper.write_code("return retval;")
- def write_conversion(self):
- self.wrapper.write_code(code = None,
- failure_expression=("!pyg_boxed_check(py_retval, %s)" %
- (self.props['typecode'],)),
- failure_exception=(
- 'PyErr_SetString(PyExc_TypeError, "retval should be a %s");'
- % (self.props['typename'],)))
- self.wrapper.write_code('retval = pyg_boxed_get(py_retval, %s);' %
- self.props['typename'])
-
-argtypes.matcher.register_reverse_ret("GBoxed", GBoxedReturn)
-
-
-class GdkRegionPtrReturn(GBoxedReturn):
- def write_error_return(self):
- self.wrapper.write_code("return gdk_region_new();")
- def write_conversion(self):
- self.props['typecode'] = 'PYGDK_TYPE_REGION'
- self.props['typename'] = 'GdkRegion'
- super(GdkRegionPtrReturn, self).write_conversion()
-
-argtypes.matcher.register_reverse_ret("GdkRegion*", GdkRegionPtrReturn)
-
-
-class PangoFontDescriptionReturn(GBoxedReturn):
- def write_error_return(self):
- self.wrapper.write_code("return pango_font_description_new();")
- def write_conversion(self):
- self.props['typecode'] = 'PANGO_TYPE_FONT_DESCRIPTION'
- self.props['typename'] = 'PangoFontDescription'
- super(PangoFontDescriptionReturn, self).write_conversion()
-
-argtypes.matcher.register_reverse_ret("PangoFontDescription*",
- PangoFontDescriptionReturn)
-
-
-class PangoFontMetricsReturn(GBoxedReturn):
- def write_error_return(self):
- self.wrapper.write_code("return pango_font_metrics_new();")
- def write_conversion(self):
- self.props['typecode'] = 'PANGO_TYPE_FONT_METRICS'
- self.props['typename'] = 'PangoFontMetrics'
- super(PangoFontMetricsReturn, self).write_conversion()
-
-argtypes.matcher.register_reverse_ret("PangoFontMetrics*",
- PangoFontMetricsReturn)
-
-
-class PangoLanguageReturn(GBoxedReturn):
- def write_error_return(self):
- self.wrapper.write_code("return pango_language_from_string(\"\");")
- def write_conversion(self):
- self.props['typecode'] = 'PANGO_TYPE_LANGUAGE'
- self.props['typename'] = 'PangoLanguage'
- super(PangoLanguageReturn, self).write_conversion()
-
-argtypes.matcher.register_reverse_ret("PangoLanguage*", PangoLanguageReturn)
-
-
-class GdkRectanglePtrParam(Parameter):
- def get_c_type(self):
- return self.props.get('c_type').replace('const-', 'const ')
- def convert_c2py(self):
- self.wrapper.add_declaration("PyObject *py_%s;" % self.name)
- self.wrapper.write_code(
- code=('py_%s = pyg_boxed_new(GDK_TYPE_RECTANGLE, %s, TRUE, TRUE);' %
- (self.name, self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name))
- self.wrapper.add_pyargv_item("py_%s" % self.name)
-
-argtypes.matcher.register_reverse("GdkRectangle*", GdkRectanglePtrParam)
-argtypes.matcher.register_reverse('GtkAllocation*', GdkRectanglePtrParam)
-
-
-class PyGObjectMethodParam(Parameter):
- def __init__(self, wrapper, name, method_name, **props):
- Parameter.__init__(self, wrapper, name, **props)
- self.method_name = method_name
-
- def get_c_type(self):
- return self.props.get('c_type', 'GObject *')
-
- def convert_c2py(self):
- self.wrapper.add_declaration("PyObject *py_%s;" % self.name)
- self.wrapper.write_code(code=("py_%s = pygobject_new((GObject *) %s);" %
- (self.name, self.name)),
- cleanup=("Py_DECREF(py_%s);" % self.name),
- failure_expression=("!py_%s" % self.name))
- self.wrapper.set_call_target("py_%s" % self.name, self.method_name)
-
-
-class CallbackInUserDataParam(Parameter):
- def __init__(self, wrapper, name, free_it, **props):
- Parameter.__init__(self, wrapper, name, **props)
- self.free_it = free_it
-
- def get_c_type(self):
- return "gpointer"
-
- def convert_c2py(self):
- self.wrapper.add_declaration("PyObject **_user_data;")
- cleanup = self.free_it and ("g_free(%s);" % self.name) or None
- self.wrapper.write_code(code=("_real_user_data = (PyObject **) %s;"
- % self.name),
- cleanup=cleanup)
-
- self.wrapper.add_declaration("PyObject *py_func;")
- cleanup = self.free_it and "Py_DECREF(py_func);" or None
- self.wrapper.write_code(code="py_func = _user_data[0];",
- cleanup=cleanup)
- self.wrapper.set_call_target("py_func")
-
- self.wrapper.add_declaration("PyObject *py_user_data;")
- cleanup = self.free_it and "Py_XDECREF(py_user_data);" or None
- self.wrapper.write_code(code="py_user_data = _user_data[1];",
- cleanup=cleanup)
- self.wrapper.add_pyargv_item("py_user_data", optional=True)
-
-def _test():
- import sys
-
- if 1:
- wrapper = ReverseWrapper("this_is_the_c_function_name", is_static=True)
- wrapper.set_return_type(StringReturn(wrapper))
- wrapper.add_parameter(PyGObjectMethodParam(wrapper, "self", method_name="do_xxx"))
- wrapper.add_parameter(StringParam(wrapper, "param2", optional=True))
- wrapper.add_parameter(GObjectParam(wrapper, "param3"))
- #wrapper.add_parameter(InoutIntParam(wrapper, "param4"))
- wrapper.generate(FileCodeSink(sys.stderr))
-
- if 0:
- wrapper = ReverseWrapper("this_a_callback_wrapper")
- wrapper.set_return_type(VoidReturn(wrapper))
- wrapper.add_parameter(StringParam(wrapper, "param1", optional=False))
- wrapper.add_parameter(GObjectParam(wrapper, "param2"))
- wrapper.add_parameter(CallbackInUserDataParam(wrapper, "data", free_it=True))
- wrapper.generate(FileCodeSink(sys.stderr))
-
-if __name__ == '__main__':
- _test()
diff --git a/codegen/scanvirtuals.py b/codegen/scanvirtuals.py
deleted file mode 100755
index c108737b..00000000
--- a/codegen/scanvirtuals.py
+++ /dev/null
@@ -1,54 +0,0 @@
-#!/usr/bin/env python
-import re
-import sys
-
-
-def main():
- rx = re.compile(r'^\s*([\w\s\*]+)\(\s*\*\s*(\w+)\s*\)\s*\(([^()]*)\);',
- re.DOTALL|re.MULTILINE)
- for f in sys.argv[1:]:
- #print ";; From", f
- buf = file(f).read()
- for m in rx.findall(buf):
- return_type = m[0].strip()
- if 'typedef' in return_type:
- continue
- if return_type == 'void':
- return_type = 'none'
- return_type = return_type.replace(' ', '')
- virtual_name = m[1]
- if 'reserved' in virtual_name:
- continue
- params = []
- if not m[2]:
- print >> sys.stderr, repr(m)
- continue
- for param in map(str.strip, m[2].split(',')):
- if '*' in param:
- tokens = param.split('*')
- ptype = tokens[0].strip() + '*'*(len(tokens) - 1)
- pname = tokens[-1].strip()
- else:
- if param == 'void':
- continue
- ptype, pname = map(str.strip, param.split())
- ptype = ptype.replace('const ', 'const-')
- while '[]' in pname:
- pname = pname.replace('[]', '')
- ptype += '[]'
- params.append((ptype, pname))
- if not params:
- continue
- objname = params[0][0].replace('*', '')
- print '(define-virtual', virtual_name
- print ' (of-object "%s")' % objname
- print ' (return-type "%s")' % return_type
- if len(params) > 1:
- print ' (parameters'
- for param in params[1:]:
- print ' \'("%s" "%s")' % param
- print ' )'
- print ')'
-
-if __name__ == '__main__':
- main()
diff --git a/codegen/scmexpr.py b/codegen/scmexpr.py
deleted file mode 100644
index 02f2e4bf..00000000
--- a/codegen/scmexpr.py
+++ /dev/null
@@ -1,143 +0,0 @@
-#!/usr/bin/env python
-# -*- Mode: Python; py-indent-offset: 4 -*-
-from __future__ import generators
-
-import string
-from cStringIO import StringIO
-
-class error(Exception):
- def __init__(self, filename, lineno, msg):
- Exception.__init__(self, msg)
- self.filename = filename
- self.lineno = lineno
- self.msg = msg
- def __str__(self):
- return '%s:%d: error: %s' % (self.filename, self.lineno, self.msg)
-
-trans = [' '] * 256
-for i in range(256):
- if chr(i) in string.letters + string.digits + '_':
- trans[i] = chr(i)
- else:
- trans[i] = '_'
-trans = string.join(trans, '')
-
-def parse(filename):
- if isinstance(filename, str):
- fp = open(filename, 'r')
- else: # if not string, assume it is some kind of iterator
- fp = filename
- filename = getattr(fp, 'name', '<unknown>')
- whitespace = ' \t\n\r\x0b\x0c'
- nonsymbol = whitespace + '();\'"'
- stack = []
- openlines = []
- lineno = 0
- for line in fp:
- pos = 0
- lineno += 1
- while pos < len(line):
- if line[pos] in whitespace: # ignore whitespace
- pass
- elif line[pos] == ';': # comment
- break
- elif line[pos:pos+2] == "'(":
- pass # the open parenthesis will be handled next iteration
- elif line[pos] == '(':
- stack.append(())
- openlines.append(lineno)
- elif line[pos] == ')':
- if len(stack) == 0:
- raise error(filename, lineno, 'close parenthesis found when none open')
- closed = stack[-1]
- del stack[-1]
- del openlines[-1]
- if stack:
- stack[-1] += (closed,)
- else:
- yield closed
- elif line[pos] == '"': # quoted string
- if not stack:
- raise error(filename, lineno,
- 'string found outside of s-expression')
- endpos = pos + 1
- chars = []
- while endpos < len(line):
- if endpos+1 < len(line) and line[endpos] == '\\':
- endpos += 1
- if line[endpos] == 'n':
- chars.append('\n')
- elif line[endpos] == 'r':
- chars.append('\r')
- elif line[endpos] == 't':
- chars.append('\t')
- else:
- chars.append('\\')
- chars.append(line[endpos])
- elif line[endpos] == '"':
- break
- else:
- chars.append(line[endpos])
- endpos += 1
- if endpos >= len(line):
- raise error(filename, lineno, "unclosed quoted string")
- pos = endpos
- stack[-1] += (''.join(chars),)
- else: # symbol/number
- if not stack:
- raise error(filename, lineno,
- 'identifier found outside of s-expression')
- endpos = pos
- while endpos < len(line) and line[endpos] not in nonsymbol:
- endpos += 1
- symbol = line[pos:endpos]
- pos = max(pos, endpos-1)
- try: symbol = int(symbol)
- except ValueError:
- try: symbol = float(symbol)
- except ValueError: pass
- stack[-1] += (symbol,)
- pos += 1
- if len(stack) != 0:
- msg = '%d unclosed parentheses found at end of ' \
- 'file (opened on line(s) %s)' % (len(stack),
- ', '.join(map(str, openlines)))
- raise error(filename, lineno, msg)
-
-class Parser:
- def __init__(self, filename):
- """Argument is either a string, a parse tree, or file object"""
- self.filename = filename
- def startParsing(self, filename=None):
- statements = parse(filename or self.filename)
- for statement in statements:
- self.handle(statement)
- def handle(self, tup):
- cmd = string.translate(tup[0], trans)
- if hasattr(self, cmd):
- getattr(self, cmd)(*tup[1:])
- else:
- self.unknown(tup)
- def unknown(self, tup):
- pass
-
-_testString = """; a scheme file
-(define-func gdk_font_load ; a comment at end of line
- GdkFont
- ((string name)))
-
-(define-boxed GdkEvent
- gdk_event_copy
- gdk_event_free
- "sizeof(GdkEvent)")
-"""
-
-if __name__ == '__main__':
- import sys
- if sys.argv[1:]:
- fp = open(sys.argv[1])
- else:
- fp = StringIO(_testString)
- statements = parse(fp)
- for s in statements:
- print `s`
diff --git a/config.h.win32 b/config.h.win32
deleted file mode 100644
index 65dc1dab..00000000
--- a/config.h.win32
+++ /dev/null
@@ -1,6 +0,0 @@
-
-#define PYGTK_MAJOR_VERSION (2)
-#define PYGTK_MINOR_VERSION (4)
-#define PYGTK_MICRO_VERSION (1)
-
-#define VERSION "2.4.1"
diff --git a/configure.in b/configure.in
deleted file mode 100644
index 1da887ad..00000000
--- a/configure.in
+++ /dev/null
@@ -1,322 +0,0 @@
--*- mode: m4 -*-
-AC_PREREQ(2.52)
-
-dnl the pygtk version number
-m4_define(pygtk_major_version, 2)
-m4_define(pygtk_minor_version, 10)
-m4_define(pygtk_micro_version, 4)
-m4_define(pygtk_version, pygtk_major_version.pygtk_minor_version.pygtk_micro_version)
-
-dnl versions of packages we require ...
-m4_define(glib_required_version, 2.8.0)
-m4_define(pango_required_version, 1.10.0)
-m4_define(atk_required_version, 1.8.0)
-m4_define(gtk_required_version, 2.8.0)
-m4_define(libglade_required_version, 2.5.0)
-m4_define(gtkunixprint_required_version, 2.9.0)
-m4_define(pycairo_required_version, 1.0.2) dnl or 1.1.7
-m4_define(pygobject_required_version, 2.12.1)
-
-AC_INIT(pygtk, pygtk_version,
- [http://bugzilla.gnome.org/enter_bug.cgi?product=pygtk])
-AC_SUBST(ACLOCAL_AMFLAGS, "-I m4 -I .")
-
-AC_DEFINE(PYGTK_MAJOR_VERSION, pygtk_major_version, [PyGtk major version])
-AC_SUBST(PYGTK_MAJOR_VERSION, pygtk_major_version)
-AC_DEFINE(PYGTK_MINOR_VERSION, pygtk_minor_version, [PyGtk minor version])
-AC_SUBST(PYGTK_MINOR_VERSION, pygtk_minor_version)
-AC_DEFINE(PYGTK_MICRO_VERSION, pygtk_micro_version, [PyGtk micro version])
-AC_SUBST(PYGTK_MICRO_VERSION, pygtk_micro_version)
-
-AC_CONFIG_SRCDIR([gtk/gtkmodule.c])
-AM_CONFIG_HEADER(config.h)
-
-AM_INIT_AUTOMAKE
-AC_CHECK_FUNCS(bind_textdomain_codeset)
-
-dnl put the ACLOCAL flags in the makefile
-ACLOCAL="$ACLOCAL $ACLOCAL_FLAGS"
-
-AC_CANONICAL_BUILD
-AC_CANONICAL_HOST
-AC_MSG_CHECKING([for some Win32 platform])
-case "$host" in
- *-*-mingw*|*-*-cygwin*)
- platform_win32=yes
- ;;
- *)
- platform_win32=no
- ;;
-esac
-AC_MSG_RESULT([$platform_win32])
-AM_CONDITIONAL(PLATFORM_WIN32, test "$platform_win32" = "yes")
-
-AC_MSG_CHECKING([for native Win32])
-case "$host" in
- *-*-mingw*)
- os_win32=yes
- ;;
- *)
- os_win32=no
- ;;
-esac
-AC_MSG_RESULT([$os_win32])
-AM_CONDITIONAL(OS_WIN32, test "$os_win32" = "yes")
-
-AC_DISABLE_STATIC
-
-dnl XXXX hack to kill off all the libtool tags ...
-dnl it isn't like we are using C++ or Fortran.
-dnl (copied from libglade/configure.in)
-m4_define([_LT_AC_TAGCONFIG],[])
-
-AC_LIBTOOL_WIN32_DLL
-AC_PROG_LIBTOOL
-
-AM_PATH_PYTHON(2.3.5)
-
-AM_CHECK_PYTHON_HEADERS(,[AC_MSG_ERROR(could not find Python headers)])
-
-AC_ARG_ENABLE(thread,
- AC_HELP_STRING([--disable-thread], [Disable pygtk threading support]),,
- enable_thread=yes)
-
-AM_CHECK_PYMOD(thread,,,enable_thread=no)
-
-dnl Building documentation
-AC_ARG_ENABLE(docs,
- AC_HELP_STRING([--enable-docs], [Enable documentation building]),enable_docs=yes,
- enable_docs=no)
-if test "${enable_docs}" != no; then
- dnl Check for xsltproc
- AC_PATH_PROG([XSLTPROC], [xsltproc])
- if test -z "$XSLTPROC"; then
- enable_docs=no
- fi
-fi
-
-AM_CONDITIONAL(ENABLE_DOCS, test x$enable_docs != xno)
-
-
-AC_MSG_CHECKING(whether to enable threading in pygtk)
-if test "x$enable_thread" != xno; then
- extra_mods=gthread
- THREADING_CFLAGS=
- AC_MSG_RESULT(yes)
-else
- extra_mods=
- THREADING_CFLAGS="-DDISABLE_THREADING"
- AC_MSG_RESULT(no)
-fi
-AC_SUBST(THREADING_CFLAGS)
-CPPFLAGS="${CPPFLAGS} $THREADING_CFLAGS"
-
-dnl get rid of the -export-dynamic stuff from the configure flags ...
-export_dynamic=`(./libtool --config; echo eval echo \\$export_dynamic_flag_spec) | sh`
-
-dnl glib
-AM_PATH_GLIB_2_0(glib_required_version,,[AC_MSG_ERROR(gobject is required to build pygtk?)],gobject $extra_mods)
-if test -n "$export_dynamic"; then
- GLIB_LIBS=`echo $GLIB_LIBS | sed -e "s/$export_dynamic//"`
-fi
-
-PKG_CHECK_MODULES(PYGOBJECT, [pygobject-2.0 >= pygobject_required_version])
-
-PYGOBJECT_INCLUDEDIR=`$PKG_CONFIG --variable=pygtkincludedir pygobject-2.0`
-AC_SUBST(PYGOBJECT_INCLUDEDIR)
-
-PYGOBJECT_DATADIR=`$PKG_CONFIG --variable=datadir pygobject-2.0`
-AC_SUBST(PYGOBJECT_DATADIR)
-
-PYGOBJECT_FIXXREF="$PYTHON `$PKG_CONFIG --variable=fixxref pygobject-2.0`"
-AC_SUBST(PYGOBJECT_FIXXREF)
-
-PYGOBJECT_PYGDOCS="`$PKG_CONFIG --variable=pygdocs pygobject-2.0`"
-AC_SUBST(PYGOBJECT_PYGDOCS)
-
-dnl atk
-PKG_CHECK_MODULES(ATK, atk >= atk_required_version,
- have_atk=true, have_atk=false)
-AC_SUBST(ATK_CFLAGS)
-AC_SUBST(ATK_LIBS)
-AM_CONDITIONAL(BUILD_ATK, $have_atk)
-if test -n "$export_dynamic"; then
- ATK_LIBS=`echo $ATK_LIBS | sed -e "s/$export_dynamic//"`
-fi
-
-dnl pango
-PKG_CHECK_MODULES(PANGO, pango >= pango_required_version,
- have_pango=true, have_pango=false)
-AC_SUBST(PANGO_CFLAGS)
-AC_SUBST(PANGO_LIBS)
-AM_CONDITIONAL(BUILD_PANGO, $have_pango)
-if test -n "$export_dynamic"; then
- PANGO_LIBS=`echo $PANGO_LIBS | sed -e "s/$export_dynamic//"`
-fi
-
-dnl pycairo
-PYGTK_CODEGEN_DEFINES=""
-AC_SUBST([PYGTK_CODEGEN_DEFINES])
-
-gtk_version=""
-PKG_CHECK_MODULES(PYCAIRO, [pycairo >= pycairo_required_version],
- have_pycairo=true, have_pycairo=false)
-AC_SUBST(PYCAIRO_CFLAGS)
-AC_SUBST(PYCAIRO_LIBS)
-if test $have_pycairo; then
- PYGTK_CODEGEN_DEFINES="-DHAVE_PYCAIRO $PYGTK_CODEGEN_DEFINES";
- AC_DEFINE([HAVE_PYCAIRO], [1], [Define to 1 if pycairo is available])
-
- AC_DEFINE_UNQUOTED(PYCAIRO_MAJOR_VERSION, [`pkg-config --modversion pycairo | cut -d '.' -f 1`], dnl
- [pycairo major version])
- AC_DEFINE_UNQUOTED(PYCAIRO_MINOR_VERSION, [`pkg-config --modversion pycairo | cut -d '.' -f 2`], dnl
- [pycairo minor version])
- AC_DEFINE_UNQUOTED(PYCAIRO_MICRO_VERSION, [`pkg-config --modversion pycairo | cut -d '.' -f 3`], dnl
- [pycairo micro version])
-
- dnl pangocairo
- PKG_CHECK_MODULES(PANGOCAIRO,
- [pangocairo >= pango_required_version,
- pycairo >= pycairo_required_version],
- have_pangocairo=true, have_pangocairo=false)
- if test ! $have_pangocairo
- then
- AC_MSG_RESULT(no)
- fi
- AC_SUBST(PANGOCAIRO_CFLAGS)
- AC_SUBST(PANGOCAIRO_LIBS)
- AM_CONDITIONAL(BUILD_PANGOCAIRO, $have_pangocairo)
-
- if test -n "$export_dynamic"; then
- PANGOCAIRO_LIBS=`echo $PANGOCAIRO_LIBS | sed -e "s/$export_dynamic//"`
- fi
-
- dnl gtk+
- PKG_CHECK_MODULES(GTK, gtk+-2.0 >= gtk_required_version,
- HAVE_GTK="yes", HAVE_GTK="no")
- if test "x$HAVE_GTK" = "xyes"; then
- have_gtk=true
- else
- have_gtk=false
- AC_MSG_RESULT(no)
- fi
- AM_CONDITIONAL(BUILD_GTK, $have_gtk)
- AC_SUBST(GTK_CFLAGS)
- AC_SUBST(GTK_LIBS)
- if test -n "$export_dynamic"; then
- GTK_LIBS=`echo $GTK_LIBS | sed -e "s/$export_dynamic//"`
- fi
-
- PKG_CHECK_MODULES(GTK210, gtk+-2.0 >= 2.10.0,
- HAVE_GTK_210="yes", HAVE_GTK_210="no")
- if test "x$HAVE_GTK_210" = "xyes"; then
- gtk_version="2.10"
- have_gtk_210=true
- else
- AC_MSG_RESULT(no)
- gtk_version="2.8"
- have_gtk_210=false
- fi
-
- AM_CONDITIONAL(HAVE_GTK_2_10, $have_gtk_210)
- AC_SUBST(HAVE_GTK_2_10)
- AC_DEFINE([HAVE_GTK_2_10], [$have_gtk_210], [If Gtk 2.10 was found])
-
- dnl libglade
- PKG_CHECK_MODULES(LIBGLADE, [libglade-2.0 >= libglade_required_version],
- have_libglade=true, have_libglade=false)
- AC_SUBST(LIBGLADE_CFLAGS)
- AC_SUBST(LIBGLADE_LIBS)
- AM_CONDITIONAL(BUILD_LIBGLADE, $have_libglade)
- if test -n "$export_dynamic"; then
- LIBGLADE_LIBS=`echo $LIBGLADE_LIBS | sed -e "s/$export_dynamic//"`
- fi
-
- dnl gtkunixprint
- PKG_CHECK_MODULES(GTKUNIXPRINT, [gtk+-unix-print-2.0 >= gtkunixprint_required_version],
- have_gtkunixprint=true, have_gtkunixprint=false)
- AC_SUBST(GTKUNIXPRINT_CFLAGS)
- AC_SUBST(GTKUNIXPRINT_LIBS)
- AM_CONDITIONAL(BUILD_GTKUNIXPRINT, $have_gtkunixprint)
- if test -n "$export_dynamic"; then
- GTKUNIXPRINT_LIBS=`echo $GTKUNIXPRINT_LIBS | sed -e "s/$export_dynamic//"`
- fi
-
-else
- AC_MSG_RESULT(no)
- AC_MSG_RESULT(not checking for gtk due to missing pycairo)
-fi
-
-dnl Check for GDK target
-AC_MSG_CHECKING([for GDK target])
-gdk_target=`$PKG_CONFIG --variable target gdk-2.0`
-if test -z $gdk_target; then
- AC_MSG_RESULT((unknown))
- AC_MSG_WARN([unable to determine the GDK target system; some functions may not be available])
-else
- AC_MSG_RESULT($gdk_target)
-fi
-
-case $gdk_target in
- x11) PYGTK_CODEGEN_DEFINES="$PYGTK_CODEGEN_DEFINES -DGDK_TARGET_X11"
- ;;
-esac
-
-
-dnl checks to see if Numeric Python is installed.
-AC_ARG_ENABLE(numpy,
- AC_HELP_STRING([--disable-numpy], [Disable numeric python features]),,
- enable_numpy=yes)
-
-if test "x$enable_numpy" != xno; then
- save_CPPFLAGS="$CPPFLAGS"
- CPPFLAGS="$CPPFLAGS $PYTHON_INCLUDES"
- AC_CHECK_HEADER([Numeric/arrayobject.h],
- [AC_DEFINE(HAVE_NUMPY,,[whether to include numeric python support])],,
- [#include <Python.h>])
- CPPFLAGS="$save_CPPFLAGS"
-fi
-
-dnl add required cflags ...
-JH_ADD_CFLAG([-Wall])
-JH_ADD_CFLAG([-std=c9x])
-JH_ADD_CFLAG([-fno-strict-aliasing])
-
-AC_CONFIG_FILES(
- Makefile
- pygtk-2.0.pc
- codegen/Makefile
- gtk/Makefile
- docs/Makefile
- docs/reference/entities.docbook
- examples/Makefile
- tests/Makefile
- codegen/pygtk-codegen-2.0
- pygtk.spec
- PKG-INFO)
-AC_OUTPUT
-
-echo
-echo "The following modules will be built:"
-echo
-$have_atk && echo atk
-$have_pango && echo pango
-$have_pangocairo && echo pangocairo
-$have_gtk && echo gtk with $gtk_version API
-$have_libglade && echo gtk.glade
-$have_gtkunixprint && echo gtk.unixprint
-echo
-
-if test ! $have_atk || ! $have_pango || \
- ! $have_gtk || ! $have_libglade || \
- ! $have_pangocairo || ! $have_gtkunixprint; then
- echo "The following modules will NOT be built:"
- echo
- $have_atk || echo atk
- $have_pango || echo pango
- $have_pangocairo || echo pangocairo
- $have_gtk || echo gtk
- $have_libglade || echo gtk.glade
- $have_gtkunixprint || echo gtk.unixprint
-fi
-
diff --git a/docs/Makefile.am b/docs/Makefile.am
deleted file mode 100644
index e0a761a8..00000000
--- a/docs/Makefile.am
+++ /dev/null
@@ -1,632 +0,0 @@
-BUILDDIR = $(top_builddir)/docs
-
-REF_VERSION = $(PYGTK_MAJOR_VERSION).$(PYGTK_MINOR_VERSION)
-FULL_VERSION = $(REF_VERSION).$(PYGTK_MICRO_VERSION)
-
-HTML_STYLE = $(PYGOBJECT_DATADIR)/pygobject/xsl/ref-html-style.xsl
-PDF_STYLE = $(PYGOBJECT_DATADIR)/pygobject/xsl/pdf-style.xsl
-
-XMLFILES = \
- reference/pygtk2-ref.xml \
- reference/pygtk-atkaction.xml \
- reference/pygtk-atk-classes.xml \
- reference/pygtk-atkcomponent.xml \
- reference/pygtk-atk-constants.xml \
- reference/pygtk-atkdocument.xml \
- reference/pygtk-atkeditabletext.xml \
- reference/pygtk-atkgobjectaccessible.xml \
- reference/pygtk-atkhyperlink.xml \
- reference/pygtk-atkhypertext.xml \
- reference/pygtk-atkimage.xml \
- reference/pygtk-atkimplementor.xml \
- reference/pygtk-atknoopobjectfactory.xml \
- reference/pygtk-atknoopobject.xml \
- reference/pygtk-atkobjectfactory.xml \
- reference/pygtk-atkobject.xml \
- reference/pygtk-atkrectangle.xml \
- reference/pygtk-atkregistry.xml \
- reference/pygtk-atkrelationset.xml \
- reference/pygtk-atkrelation.xml \
- reference/pygtk-atkselection.xml \
- reference/pygtk-atkstateset.xml \
- reference/pygtk-atkstreamablecontent.xml \
- reference/pygtk-atktable.xml \
- reference/pygtk-atktext.xml \
- reference/pygtk-atkvalue.xml \
- reference/pygtk-gdkatom.xml \
- reference/pygtk-gdkcairocontext.xml \
- reference/pygtk-gdk-classes.xml \
- reference/pygtk-gdkcolormap.xml \
- reference/pygtk-gdkcolor.xml \
- reference/pygtk-gdk-constants.xml \
- reference/pygtk-gdkcursor.xml \
- reference/pygtk-gdkdevice.xml \
- reference/pygtk-gdkdisplaymanager.xml \
- reference/pygtk-gdkdisplay.xml \
- reference/pygtk-gdkdragcontext.xml \
- reference/pygtk-gdkdrawable.xml \
- reference/pygtk-gdkevent.xml \
- reference/pygtk-gdkfont.xml \
- reference/pygtk-gdk-functions.xml \
- reference/pygtk-gdkgc.xml \
- reference/pygtk-gdkimage.xml \
- reference/pygtk-gdkkeymap.xml \
- reference/pygtk-gdkpangorenderer.xml \
- reference/pygtk-gdkpixbufanimationiter.xml \
- reference/pygtk-gdkpixbufanimation.xml \
- reference/pygtk-gdkpixbufloader.xml \
- reference/pygtk-gdkpixbuf.xml \
- reference/pygtk-gdkpixmap.xml \
- reference/pygtk-gdkrectangle.xml \
- reference/pygtk-gdkregion.xml \
- reference/pygtk-gdkscreen.xml \
- reference/pygtk-gdkwindow.xml \
- reference/pygtk-gdkvisual.xml \
- reference/pygtk-glade-classes.xml \
- reference/pygtk-gladexml.xml \
- reference/pygtk-gtkaboutdialog.xml \
- reference/pygtk-gtkaccelgroup.xml \
- reference/pygtk-gtkaccellabel.xml \
- reference/pygtk-gtkaccelmap.xml \
- reference/pygtk-gtkaccessible.xml \
- reference/pygtk-gtkactiongroup.xml \
- reference/pygtk-gtkaction.xml \
- reference/pygtk-gtkadjustment.xml \
- reference/pygtk-gtkalignment.xml \
- reference/pygtk-gtkarrow.xml \
- reference/pygtk-gtkaspectframe.xml \
- reference/pygtk-gtkassistant.xml \
- reference/pygtk-gtkbin.xml \
- reference/pygtk-gtkborder.xml \
- reference/pygtk-gtkbox.xml \
- reference/pygtk-gtkbuttonbox.xml \
- reference/pygtk-gtkbutton.xml \
- reference/pygtk-gtkcalendar.xml \
- reference/pygtk-gtkcelleditable.xml \
- reference/pygtk-gtkcelllayout.xml \
- reference/pygtk-gtkcellrendereraccel.xml \
- reference/pygtk-gtkcellrenderercombo.xml \
- reference/pygtk-gtkcellrendererpixbuf.xml \
- reference/pygtk-gtkcellrendererprogress.xml \
- reference/pygtk-gtkcellrendererspin.xml \
- reference/pygtk-gtkcellrenderertext.xml \
- reference/pygtk-gtkcellrenderertoggle.xml \
- reference/pygtk-gtkcellrenderer.xml \
- reference/pygtk-gtkcellview.xml \
- reference/pygtk-gtkcheckbutton.xml \
- reference/pygtk-gtkcheckmenuitem.xml \
- reference/pygtk-gtk-classes.xml \
- reference/pygtk-gtkclipboard.xml \
- reference/pygtk-gtkcolorbutton.xml \
- reference/pygtk-gtkcolorselectiondialog.xml \
- reference/pygtk-gtkcolorselection.xml \
- reference/pygtk-gtkcomboboxentry.xml \
- reference/pygtk-gtkcombobox.xml \
- reference/pygtk-gtkcombo.xml \
- reference/pygtk-gtk-constants.xml \
- reference/pygtk-gtkcontainer.xml \
- reference/pygtk-gtkcurve.xml \
- reference/pygtk-gtkdialog.xml \
- reference/pygtk-gtkdrawingarea.xml \
- reference/pygtk-gtkeditable.xml \
- reference/pygtk-gtkentrycompletion.xml \
- reference/pygtk-gtkentry.xml \
- reference/pygtk-gtkeventbox.xml \
- reference/pygtk-gtkexpander.xml \
- reference/pygtk-gtkfilechooserbutton.xml \
- reference/pygtk-gtkfilechooserdialog.xml \
- reference/pygtk-gtkfilechooserwidget.xml \
- reference/pygtk-gtkfilechooser.xml \
- reference/pygtk-gtkfilefilter.xml \
- reference/pygtk-gtkfileselection.xml \
- reference/pygtk-gtkfixed.xml \
- reference/pygtk-gtkfontbutton.xml \
- reference/pygtk-gtkfontselectiondialog.xml \
- reference/pygtk-gtkfontselection.xml \
- reference/pygtk-gtkframe.xml \
- reference/pygtk-gtk-functions.xml \
- reference/pygtk-gtkgammacurve.xml \
- reference/pygtk-gtkhandlebox.xml \
- reference/pygtk-gtkhbox.xml \
- reference/pygtk-gtkhbuttonbox.xml \
- reference/pygtk-gtkhpaned.xml \
- reference/pygtk-gtkhruler.xml \
- reference/pygtk-gtkhscale.xml \
- reference/pygtk-gtkhscrollbar.xml \
- reference/pygtk-gtkhseparator.xml \
- reference/pygtk-gtkiconfactory.xml \
- reference/pygtk-gtkiconinfo.xml \
- reference/pygtk-gtkiconset.xml \
- reference/pygtk-gtkiconsource.xml \
- reference/pygtk-gtkicontheme.xml \
- reference/pygtk-gtkiconview.xml \
- reference/pygtk-gtkimagemenuitem.xml \
- reference/pygtk-gtkimage.xml \
- reference/pygtk-gtkimcontextsimple.xml \
- reference/pygtk-gtkimcontext.xml \
- reference/pygtk-gtkimmulticontext.xml \
- reference/pygtk-gtkinputdialog.xml \
- reference/pygtk-gtkinvisible.xml \
- reference/pygtk-gtkitemfactory.xml \
- reference/pygtk-gtkitem.xml \
- reference/pygtk-gtklabel.xml \
- reference/pygtk-gtklayout.xml \
- reference/pygtk-gtklinkbutton.xml \
- reference/pygtk-gtkliststore.xml \
- reference/pygtk-gtkmenubar.xml \
- reference/pygtk-gtkmenuitem.xml \
- reference/pygtk-gtkmenushell.xml \
- reference/pygtk-gtkmenutoolbutton.xml \
- reference/pygtk-gtkmenu.xml \
- reference/pygtk-gtkmessagedialog.xml \
- reference/pygtk-gtkmisc.xml \
- reference/pygtk-gtknotebook.xml \
- reference/pygtk-gtkobject.xml \
- reference/pygtk-gtkoptionmenu.xml \
- reference/pygtk-gtkpagesetupunixdialog.xml \
- reference/pygtk-gtkpagesetup.xml \
- reference/pygtk-gtkpaned.xml \
- reference/pygtk-gtkpapersize.xml \
- reference/pygtk-gtkplug.xml \
- reference/pygtk-gtkprintcontext.xml \
- reference/pygtk-gtkprinter.xml \
- reference/pygtk-gtkprintjob.xml \
- reference/pygtk-gtkprintoperationpreview.xml \
- reference/pygtk-gtkprintoperation.xml \
- reference/pygtk-gtkprintsettings.xml \
- reference/pygtk-gtkprintunixdialog.xml \
- reference/pygtk-gtkprogressbar.xml \
- reference/pygtk-gtkradioaction.xml \
- reference/pygtk-gtkradiobutton.xml \
- reference/pygtk-gtkradiomenuitem.xml \
- reference/pygtk-gtkradiotoolbutton.xml \
- reference/pygtk-gtkrange.xml \
- reference/pygtk-gtkrcstyle.xml \
- reference/pygtk-gtkrecentchooserdialog.xml \
- reference/pygtk-gtkrecentchoosermenu.xml \
- reference/pygtk-gtkrecentchooserwidget.xml \
- reference/pygtk-gtkrecentchooser.xml \
- reference/pygtk-gtkrecentfilter.xml \
- reference/pygtk-gtkrecentinfo.xml \
- reference/pygtk-gtkrecentmanager.xml \
- reference/pygtk-gtkrequisition.xml \
- reference/pygtk-gtkruler.xml \
- reference/pygtk-gtkscale.xml \
- reference/pygtk-gtkscrollbar.xml \
- reference/pygtk-gtkscrolledwindow.xml \
- reference/pygtk-gtkselectiondata.xml \
- reference/pygtk-gtkseparatormenuitem.xml \
- reference/pygtk-gtkseparatortoolitem.xml \
- reference/pygtk-gtkseparator.xml \
- reference/pygtk-gtksettings.xml \
- reference/pygtk-gtksizegroup.xml \
- reference/pygtk-gtksocket.xml \
- reference/pygtk-gtkspinbutton.xml \
- reference/pygtk-gtkstatusbar.xml \
- reference/pygtk-gtkstatusicon.xml \
- reference/pygtk-gtk-stock-items.xml \
- reference/pygtk-gtkstyle.xml \
- reference/pygtk-gtktable.xml \
- reference/pygtk-gtktearoffmenuitem.xml \
- reference/pygtk-gtktextattributes.xml \
- reference/pygtk-gtktextbuffer.xml \
- reference/pygtk-gtktextchildanchor.xml \
- reference/pygtk-gtktextiter.xml \
- reference/pygtk-gtktextmark.xml \
- reference/pygtk-gtktexttagtable.xml \
- reference/pygtk-gtktexttag.xml \
- reference/pygtk-gtktextview.xml \
- reference/pygtk-gtktoggleaction.xml \
- reference/pygtk-gtktogglebutton.xml \
- reference/pygtk-gtktoggletoolbutton.xml \
- reference/pygtk-gtktoolbar.xml \
- reference/pygtk-gtktoolbutton.xml \
- reference/pygtk-gtktoolitem.xml \
- reference/pygtk-gtktooltips.xml \
- reference/pygtk-gtktreedragdest.xml \
- reference/pygtk-gtktreedragsource.xml \
- reference/pygtk-gtktreeiter.xml \
- reference/pygtk-gtktreemodelfilter.xml \
- reference/pygtk-gtktreemodelsort.xml \
- reference/pygtk-gtktreemodel.xml \
- reference/pygtk-gtktreerowreference.xml \
- reference/pygtk-gtktreeselection.xml \
- reference/pygtk-gtktreesortable.xml \
- reference/pygtk-gtktreestore.xml \
- reference/pygtk-gtktreeviewcolumn.xml \
- reference/pygtk-gtktreeview.xml \
- reference/pygtk-gtkuimanager.xml \
- reference/pygtk-gtkvbox.xml \
- reference/pygtk-gtkvbuttonbox.xml \
- reference/pygtk-gtkwidget.xml \
- reference/pygtk-gtkviewport.xml \
- reference/pygtk-gtkwindowgroup.xml \
- reference/pygtk-gtkwindow.xml \
- reference/pygtk-gtkvpaned.xml \
- reference/pygtk-gtkvruler.xml \
- reference/pygtk-gtkvscale.xml \
- reference/pygtk-gtkvscrollbar.xml \
- reference/pygtk-gtkvseparator.xml \
- reference/pygtk-hierarchy.xml \
- reference/pygtk-introduction.xml \
- reference/pygtk-pangoattribute.xml \
- reference/pygtk-pangoattriter.xml \
- reference/pygtk-pangoattrlist.xml \
- reference/pygtk-pangocairocairocontext.xml \
- reference/pygtk-pangocairocairofontmap.xml \
- reference/pygtk-pangocairo-classes.xml \
- reference/pygtk-pangocairo-constants.xml \
- reference/pygtk-pangocairo-functions.xml \
- reference/pygtk-pango-classes.xml \
- reference/pygtk-pangocolor.xml \
- reference/pygtk-pango-constants.xml \
- reference/pygtk-pangocontext.xml \
- reference/pygtk-pangofontdescription.xml \
- reference/pygtk-pangofontface.xml \
- reference/pygtk-pangofontfamily.xml \
- reference/pygtk-pangofontmap.xml \
- reference/pygtk-pangofontmetrics.xml \
- reference/pygtk-pangofontsetsimple.xml \
- reference/pygtk-pangofontset.xml \
- reference/pygtk-pangofont.xml \
- reference/pygtk-pango-functions.xml \
- reference/pygtk-pangoglyphstring.xml \
- reference/pygtk-pangolanguage.xml \
- reference/pygtk-pangolayoutiter.xml \
- reference/pygtk-pangolayoutline.xml \
- reference/pygtk-pangolayout.xml \
- reference/pygtk-pango-markup.xml \
- reference/pygtk-pangorenderer.xml \
- reference/pygtk-pangotabarray.xml \
- reference/pygtk-pygtkgenericcellrenderer.xml \
- reference/pygtk-pygtkgenerictreemodel.xml \
- reference/pygtk-pygtktreemodelrowiter.xml \
- reference/pygtk-pygtktreemodelrow.xml \
- reference/pygtk-unixprint-classes.xml \
- reference/pygtk-unixprint-constants.xml \
- reference/pygtk-unixprint-functions.xml
-
-HTML_FILES = \
- html/atk-class-reference.html \
- html/atk-constants.html \
- html/class-atkaction.html \
- html/class-atkcomponent.html \
- html/class-atkdocument.html \
- html/class-atkeditabletext.html \
- html/class-atkgobjectaccessible.html \
- html/class-atkhyperlink.html \
- html/class-atkhypertext.html \
- html/class-atkimage.html \
- html/class-atkimplementor.html \
- html/class-atknoopobjectfactory.html \
- html/class-atknoopobject.html \
- html/class-atkobjectfactory.html \
- html/class-atkobject.html \
- html/class-atkrectangle.html \
- html/class-atkregistry.html \
- html/class-atkrelation.html \
- html/class-atkrelationset.html \
- html/class-atkselection.html \
- html/class-atkstateset.html \
- html/class-atkstreamablecontent.html \
- html/class-atktable.html \
- html/class-atktext.html \
- html/class-atkvalue.html \
- html/class-gdkatom.html \
- html/class-gdkcairocontext.html \
- html/class-gdkcolor.html \
- html/class-gdkcolormap.html \
- html/class-gdkcursor.html \
- html/class-gdkdevice.html \
- html/class-gdkdisplay.html \
- html/class-gdkdisplaymanager.html \
- html/class-gdkdragcontext.html \
- html/class-gdkdrawable.html \
- html/class-gdkevent.html \
- html/class-gdkgc.html \
- html/class-gdkimage.html \
- html/class-gdkkeymap.html \
- html/class-gdkpangorenderer.html \
- html/class-gdkpixbufanimation.html \
- html/class-gdkpixbufanimationiter.html \
- html/class-gdkpixbuf.html \
- html/class-gdkpixbufloader.html \
- html/class-gdkpixmap.html \
- html/class-gdkrectangle.html \
- html/class-gdkregion.html \
- html/class-gdkscreen.html \
- html/class-gdkwindow.html \
- html/class-gdkvisual.html \
- html/class-gladexml.html \
- html/class-gtkaboutdialog.html \
- html/class-gtkaccelgroup.html \
- html/class-gtkaccellabel.html \
- html/class-gtkaccelmap.html \
- html/class-gtkaccessible.html \
- html/class-gtkactiongroup.html \
- html/class-gtkaction.html \
- html/class-gtkadjustment.html \
- html/class-gtkalignment.html \
- html/class-gtkarrow.html \
- html/class-gtkaspectframe.html \
- html/class-gtkassistant.html \
- html/class-gtkbin.html \
- html/class-gtkborder.html \
- html/class-gtkbox.html \
- html/class-gtkbuttonbox.html \
- html/class-gtkbutton.html \
- html/class-gtkcalendar.html \
- html/class-gtkcelleditable.html \
- html/class-gtkcelllayout.html \
- html/class-gtkcellrendereraccel.html \
- html/class-gtkcellrenderercombo.html \
- html/class-gtkcellrenderer.html \
- html/class-gtkcellrendererpixbuf.html \
- html/class-gtkcellrendererprogress.html \
- html/class-gtkcellrendererspin.html \
- html/class-gtkcellrenderertext.html \
- html/class-gtkcellrenderertoggle.html \
- html/class-gtkcellview.html \
- html/class-gtkcheckbutton.html \
- html/class-gtkcheckmenuitem.html \
- html/class-gtkclipboard.html \
- html/class-gtkcolorbutton.html \
- html/class-gtkcolorselectiondialog.html \
- html/class-gtkcolorselection.html \
- html/class-gtkcomboboxentry.html \
- html/class-gtkcombobox.html \
- html/class-gtkcombo.html \
- html/class-gtkcontainer.html \
- html/class-gtkcurve.html \
- html/class-gtkdialog.html \
- html/class-gtkdrawingarea.html \
- html/class-gtkeditable.html \
- html/class-gtkentrycompletion.html \
- html/class-gtkentry.html \
- html/class-gtkeventbox.html \
- html/class-gtkexpander.html \
- html/class-gtkfilechooserbutton.html \
- html/class-gtkfilechooserdialog.html \
- html/class-gtkfilechooser.html \
- html/class-gtkfilechooserwidget.html \
- html/class-gtkfilefilter.html \
- html/class-gtkfileselection.html \
- html/class-gtkfixed.html \
- html/class-gtkfontbutton.html \
- html/class-gtkfontselectiondialog.html \
- html/class-gtkfontselection.html \
- html/class-gtkframe.html \
- html/class-gtkgammacurve.html \
- html/class-gtkhandlebox.html \
- html/class-gtkhbox.html \
- html/class-gtkhbuttonbox.html \
- html/class-gtkhpaned.html \
- html/class-gtkhruler.html \
- html/class-gtkhscale.html \
- html/class-gtkhscrollbar.html \
- html/class-gtkhseparator.html \
- html/class-gtkiconfactory.html \
- html/class-gtkiconinfo.html \
- html/class-gtkiconset.html \
- html/class-gtkiconsource.html \
- html/class-gtkicontheme.html \
- html/class-gtkiconview.html \
- html/class-gtkimage.html \
- html/class-gtkimagemenuitem.html \
- html/class-gtkimcontext.html \
- html/class-gtkimcontextsimple.html \
- html/class-gtkimmulticontext.html \
- html/class-gtkinputdialog.html \
- html/class-gtkinvisible.html \
- html/class-gtkitemfactory.html \
- html/class-gtkitem.html \
- html/class-gtklabel.html \
- html/class-gtklayout.html \
- html/class-gtklinkbutton.html \
- html/class-gtkliststore.html \
- html/class-gtkmenubar.html \
- html/class-gtkmenu.html \
- html/class-gtkmenuitem.html \
- html/class-gtkmenushell.html \
- html/class-gtkmenutoolbutton.html \
- html/class-gtkmessagedialog.html \
- html/class-gtkmisc.html \
- html/class-gtknotebook.html \
- html/class-gtkobject.html \
- html/class-gtkoptionmenu.html \
- html/class-gtkpagesetup.html \
- html/class-gtkpagesetupunixdialog.html \
- html/class-gtkpaned.html \
- html/class-gtkpapersize.html \
- html/class-gtkplug.html \
- html/class-gtkprintcontext.html \
- html/class-gtkprinter.html \
- html/class-gtkprintjob.html \
- html/class-gtkprintoperation.html \
- html/class-gtkprintoperationpreview.html \
- html/class-gtkprintsettings.html \
- html/class-gtkprintunixdialog.html \
- html/class-gtkprogressbar.html \
- html/class-gtkradioaction.html \
- html/class-gtkradiobutton.html \
- html/class-gtkradiomenuitem.html \
- html/class-gtkradiotoolbutton.html \
- html/class-gtkrange.html \
- html/class-gtkrcstyle.html \
- html/class-gtkrecentchooserdialog.html \
- html/class-gtkrecentchooser.html \
- html/class-gtkrecentchoosermenu.html \
- html/class-gtkrecentchooserwidget.html \
- html/class-gtkrecentfilter.html \
- html/class-gtkrecentinfo.html \
- html/class-gtkrecentmanager.html \
- html/class-gtkrequisition.html \
- html/class-gtkruler.html \
- html/class-gtkscale.html \
- html/class-gtkscrollbar.html \
- html/class-gtkscrolledwindow.html \
- html/class-gtkselectiondata.html \
- html/class-gtkseparator.html \
- html/class-gtkseparatormenuitem.html \
- html/class-gtkseparatortoolitem.html \
- html/class-gtksettings.html \
- html/class-gtksizegroup.html \
- html/class-gtksocket.html \
- html/class-gtkspinbutton.html \
- html/class-gtkstatusbar.html \
- html/class-gtkstatusicon.html \
- html/class-gtkstyle.html \
- html/class-gtktable.html \
- html/class-gtktearoffmenuitem.html \
- html/class-gtktextattributes.html \
- html/class-gtktextbuffer.html \
- html/class-gtktextchildanchor.html \
- html/class-gtktextiter.html \
- html/class-gtktextmark.html \
- html/class-gtktexttag.html \
- html/class-gtktexttagtable.html \
- html/class-gtktextview.html \
- html/class-gtktoggleaction.html \
- html/class-gtktogglebutton.html \
- html/class-gtktoggletoolbutton.html \
- html/class-gtktoolbar.html \
- html/class-gtktoolbutton.html \
- html/class-gtktoolitem.html \
- html/class-gtktooltips.html \
- html/class-gtktreedragdest.html \
- html/class-gtktreedragsource.html \
- html/class-gtktreeiter.html \
- html/class-gtktreemodelfilter.html \
- html/class-gtktreemodel.html \
- html/class-gtktreemodelsort.html \
- html/class-gtktreerowreference.html \
- html/class-gtktreeselection.html \
- html/class-gtktreesortable.html \
- html/class-gtktreestore.html \
- html/class-gtktreeviewcolumn.html \
- html/class-gtktreeview.html \
- html/class-gtkuimanager.html \
- html/class-gtkvbox.html \
- html/class-gtkvbuttonbox.html \
- html/class-gtkwidget.html \
- html/class-gtkviewport.html \
- html/class-gtkwindowgroup.html \
- html/class-gtkwindow.html \
- html/class-gtkvpaned.html \
- html/class-gtkvruler.html \
- html/class-gtkvscale.html \
- html/class-gtkvscrollbar.html \
- html/class-gtkvseparator.html \
- html/class-hierarchy.html \
- html/class-pangoattribute.html \
- html/class-pangoattriterator.html \
- html/class-pangoattrlist.html \
- html/class-pangocairocairocontext.html \
- html/class-pangocairocairofontmap.html \
- html/class-pangocolor.html \
- html/class-pangocontext.html \
- html/class-pangofontdescription.html \
- html/class-pangofontface.html \
- html/class-pangofontfamily.html \
- html/class-pangofont.html \
- html/class-pangofontmap.html \
- html/class-pangofontmetrics.html \
- html/class-pangofontset.html \
- html/class-pangofontsetsimple.html \
- html/class-pangoglyphstring.html \
- html/class-pangolanguage.html \
- html/class-pangolayout.html \
- html/class-pangolayoutiter.html \
- html/class-pangolayoutline.html \
- html/class-pangorenderer.html \
- html/class-pangotabarray.html \
- html/class-pygtkgenericcellrenderer.html \
- html/class-pygtkgenerictreemodel.html \
- html/class-pygtktreemodelrow.html \
- html/class-pygtktreemodelrowiter.html \
- html/gdk-class-reference.html \
- html/gdk-constants.html \
- html/gdk-functions.html \
- html/glade-class-reference.html \
- html/gtk-class-reference.html \
- html/gtk-constants.html \
- html/gtk-functions.html \
- html/gtk-stock-items.html \
- html/index.html \
- html/index.sgml \
- html/pangocairo-class-reference.html \
- html/pangocairo-constants.html \
- html/pangocairo-functions.html \
- html/pango-class-reference.html \
- html/pango-constants.html \
- html/pango-functions.html \
- html/pango-markup-language.html \
- html/pygtk.devhelp \
- html/pygtk-introduction.html \
- html/pygtk-reference-format.html \
- html/unixprint-class-reference.html \
- html/unixprint-constants.html \
- html/unixprint-functions.html
-
-
-
-CSS_FILES = $(PYGOBJECT_PYGDOCS)/style.css
-
-TARGET_DIR = $(datadir)/gtk-doc/html/pygtk
-CSSdir = $(TARGET_DIR)
-CSS_DATA = $(CSS_FILES)
-
-
-EXTRA_DIST = \
- $(HTML_FILES) \
- $(XMLFILES) \
- $(XSLFILES) \
- $(FIX_XREF)
-
-install-data-local:
- installfiles=`echo $(srcdir)/html/*`; \
- if test "$$installfiles" = '$(srcdir)/html/*'; \
- then echo '-- Nothing to install' ; \
- else \
- $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
- for i in $$installfiles; do \
- echo '-- Installing '$$i ; \
- $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
- done; \
- echo '-- Installing $(srcdir)/html/index.sgml' ; \
- $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR) || :; \
- fi
-
-install-data-hook:
- @$(PYGOBJECT_FIXXREF) $(DESTDIR)$(TARGET_DIR)
-
-uninstall-local:
- rm -f $(DESTDIR)$(TARGET_DIR)/*
-
-if ENABLE_DOCS
-
-BUILT_SOURCES = reference/builddate.xml $(HTML_FILES)
-DISTCLEANFILES = reference/builddate.xml $(HTML_FILES)
-
-reference/builddate.xml:
- @$(PYTHON) -c 'import datetime; print datetime.date.today()' > $@
-
-
-# Do not add a builddate.xml dependency here, because the generated html
-# documentation will be included in the tarball so xsltproc is not needed to
-# install the documentation. Adding a builddate.xml dependency will force
-# the documentation to be rebuilt when it doesn't need to be.
-$(HTML_FILES): $(XMLFILES) $(XSLFILES)
- @xsltproc --nonet --xinclude -o $(BUILDDIR)/html/ \
- --path $(BUILDDIR)/reference:$(srcdir)/reference \
- --stringparam gtkdoc.bookname "pygtk" \
- --stringparam gtkdoc.version ${REF_VERSION} \
- $(HTML_STYLE) $(srcdir)/reference/pygtk2-ref.xml
-
-# pdf: $(REFERENCE_DEPS) reference/builddate.xml
-# xsltproc --nonet --xinclude -o pygtk-ref.fo \
-# $(PDF_STYLE) reference/pygtk2-ref.xml
-# pdfxmltex pygtk-ref.fo >output </dev/null
-
-
-endif
diff --git a/docs/random/missing-symbols b/docs/random/missing-symbols
deleted file mode 100644
index 2623433f..00000000
--- a/docs/random/missing-symbols
+++ /dev/null
@@ -1,33 +0,0 @@
-Symbols, added in gtk+ between our merging with 2.5.x and 2.6.0
-They need to be added to the defs file, probably manually.
-
-gtk_label_get_max_width_chars
-gtk_label_set_max_width_chars
-gtk_label_get_angle
-gtk_label_set_angle
-gtk_label_get_single_line_mode
-gtk_label_set_single_line_mode
-gtk_button_get_image
-gtk_button_set_image
-gtk_progress_bar_get_ellipsize
-gtk_progress_bar_set_ellipsize
-gtk_icon_view_get_column_spacing
-gtk_icon_view_get_columns
-gtk_icon_view_get_item_width
-gtk_icon_view_get_margin
-gtk_icon_view_get_row_spacing
-gtk_icon_view_get_spacing
-gtk_icon_view_set_column_spacing
-gtk_icon_view_set_columns
-gtk_icon_view_set_item_width
-gtk_icon_view_set_margin
-gtk_icon_view_set_row_spacing
-gtk_icon_view_set_spacing
-gtk_cell_renderer_stop_editing
-gtk_list_store_insert_with_values
-gtk_list_store_insert_with_valuesv
-gtk_text_layout_get_iter_at_position (NOT MERGED INTERNAL API)
-gtk_text_view_get_iter_at_position
-gtk_dialog_set_alterantive_button_order_from_array
-gtk_action_get_accel_path
-gtk_file_filter_add_pixbuf_formats
diff --git a/docs/random/release-checklist b/docs/random/release-checklist
deleted file mode 100644
index 258f9a19..00000000
--- a/docs/random/release-checklist
+++ /dev/null
@@ -1,30 +0,0 @@
-Check list for releasing PyGTK
-==============================
-
-check bugzilla
-if first major
- update version in configure.in
-update NEWS
-update README
-add marker to ChangeLog
-ensure make distcheck passes:
- * ./configure --enable-docs
- * cd docs; make
- * cd ..
- * make distcheck
-commit ChangeLog, NEWS, README
-make dist
-tag cvs
-scp tarball to window.gnome.org
-ssh to window.gnome.org and run install-module
-write announcement
-verify version numbers
-send announcement
-update topic in #pygtk
-update pypi using PKG-INFO
-if stable
- update gnomefiles
-update website
-post release version bump
-if first major
- branch
diff --git a/docs/random/update-bindings b/docs/random/update-bindings
deleted file mode 100644
index 31567990..00000000
--- a/docs/random/update-bindings
+++ /dev/null
@@ -1,5 +0,0 @@
-To update the bindings to the latest version, do this:
-
-Gtk
-python codegen/h2def.py -m gtk -f gtk/gtk-base.defs -s gtk/gtk-2.10 headers...
-python codegen/h2def.py -m gdk -f gtk/gdk-base.defs -s gtk/gdk-2.10 headers...
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
deleted file mode 100644
index 9ec9a19b..00000000
--- a/docs/reference/ChangeLog
+++ /dev/null
@@ -1,2646 +0,0 @@
-2006-10-11 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml: Remove Author info.
-
- * pygtk-introduction.xml: Remove Copyright and License section.
-
-2006-08-22 Johan Dahlin <jdahlin@async.com.br>
-
- * pygtk-gtkcontainer.xml (linkend): forall, spotted by
- Tim Terlegård
-
-2006-08-11 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkaction.xml (set_menu_item_type, set_tool_item_type): Add.
-
- * pygtk-gtkwidget.xml (get_activate_signal): Add.
-
-2006-08-06 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkwidget.xml
- * pygtk-gtkcontainer.xml: Replace gobject-*-constants xrefs with
- link tags.
-
-2006-08-03 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtklinkbutton.xml: Remove extra Returns:
- * pygtk-gtkstatusicon.xml: Add missing "
- Fixes #349862 (Nikos Kouremenos)
-
-2006-07-19 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml: Add version and builddate entities.
-
- * pygtk-introduction.xml: Update.
-
-2006-07-18 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeselection.xml (set_select_function): Update description
- for 2.10 changes to enable full callback args.
-
- * pygtk-gtkmenu.xml (popup): Note func signature prior to 2.10.
-
-2006-07-14 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkaccelmap.xml: Add.
-
- * pygtk-gtkaccelgroup.xml: Move accel map functions to
- pygtk-gtkaccelmap.xml
-
- * pygtk-gtk-classes.xml: Add pygtk-gtkaccelmap.xml
-
-2006-07-12 John Finlay <finlay@moeraki.com>
-
- * pygtk-unixprint-classes.xml: Add pygtk-unixprint-functions.xml.
-
- * pygtk-unixprint-functions.xml: Add gtk.unixprint.enumerate_printers.
-
- * pygtk-gtkprinter.xml (accepts_ps, accepts_pdf): Add.
-
-2006-07-07 John Finlay <finlay@moeraki.com>
-
- * pygtk-pangofontfamily.xml (is_monospace): Fix Returns description.
- #340108 (Wouter Bolsterlee)
-
- * pygtk-gtk-constants.xml (Selection Mode Constants): Add link
- to TreeSelection. #329898 (Nikos Kouremenos)
-
- * pygtk-gtkfilechooser.xml (FileNamesAndEncodings): Add. #327888
- (Nikos Kouremenos)
-
- * pygtk-gtkexpander.xml ("activate"): Add note and link about using
- "notify:expanded" instead of activate. #323403 (Murray Cummings)
-
- * pygtk-gtkspinbutton.xml (spin): increment defaults to 1.0
-
- * pygtk-pango-functions.xml
- * pygtk-pangoattrlist.xml (pango.parse_markup): accel_marker defaults
- to u'\x00 - fix description.
-
- * pygtk-pangocairo-functions.xml: Fix function names and reorg.
-
- * pygtk-gtkcellrenderertoggle.xml ("toggled"): path is a string.
- Fixes #334473 (Alexander Konovalenko)
-
- ======== 2.9.0 ============
-2006-07-06 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml: Version 2.9.0.
-
- * pygtk-introduction.xml: Update for PyGTK 2.10
-
- * pygtk-pangofont.xml (get_font_map): Add.
-
- * pygtk-pangofontdescription.xml (get_size_is_absolute)
- (set_absolute_size): Add.
-
- * pygtk-pangoattribute.xml: Add descriptions of new text attributes.
-
- * pygtk-atk-constants.xml: Add Text constants.
-
- * pygtk-atkrectangle.xml: Add.
-
- * pygtk-atk-classes.xml: Add pygtk-atkrectangle.
-
- * pygtk-atkregistry.xml:
- * pygtk-atkrelation.xml:
- * pygtk-atkrelationset.xml:
- * pygtk-atkselection.xml:
- * pygtk-atkstateset.xml:
- * pygtk-atkstreamablecontent.xml:
- * pygtk-atktable.xml:
- * pygtk-atktext.xml:
- * pygtk-atkvalue.xml: Update to PyGTK API.
-
- * pygtk-atkutil.xml: Remove.
-
-2006-06-27 John Finlay <finlay@moeraki.com>
-
- * Add atk docs and new gtk 2.10 class docs.
-
- * Add links to ancestor properties and signals. Add new GTK 2.10
- classes, methods, functions and constants. Remove unused file
- pygtk-classes.xml
-
-2006-06-22 John Finlay <finlay@moeraki.com>
-
- * pygtk-gladexml.xml (set_custom_widget_callbacks): Fix external link.
- (signal_autoconnect): Fix typo.
-
-2006-06-10 John Finlay <finlay@moeraki.com>
-
- * pygtk-gobject-constants.xml (Type Constants): Add TYPE_PYOBJECT.
-
-2006-06-06 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkprintjob.xml: Add.
-
- * pygtk-gtkprintunixdialog.xml: Add.
-
- * pygtk-unixprint-constants.xml: Add.
-
- * pygtk-gtkprinter.xml: Add.
-
- * pygtk-gtkpagesetupunixdialog.xml: Add.
-
- * pygtk-unixprint-classes.xml: Add.
-
- * pygtk2-ref.xml: Add pygtk-unixprint-classes.xml
-
-2006-06-05 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkpapersize.xml: Add link to Paper Name constants.
-
- * pygtk-gtk-constants.xml: Add Paper Name constants.
-
-2006-06-04 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtk-functions.xml: Add PageSize Functions
-
- * pygtk-gtk-classes.xml: Add pygtk-gtkpapersize.xml.
-
- * pygtk-gtkpapersize.xml: Add.
-
- * pygtk-gtk-constants.xml: Add Page Orientation and Unit constants.
-
- * pygtk-gtk-classes.xml: Add pygtk-gtkpagesetup.xml.
-
- * pygtk-gtkpagesetup.xml: Add.
-
- * pygtk-gtknotebook.xml (set_tab_detachable, get_tab_detachable)
- (set_tab_reorderable, get_tab_reorderable, get_group_id)
- (set_group_id, "page-reordered", "page-added", "page-removed")
- ("tab-overlap", "tab-curvature", "arrow-spacing"): Add.
-
- * pygtk-gtkmessagedialog.xml (set_image, "image", "secondary-text")
- ("secondary-use-markup", "text", "use-markup"): Add.
-
- * pygtk-gtk-functions.xml (LinkButton Functions): Add.
-
- * pygtk-gtk-classes.xml: Add pygtk-gtklinkbutton.xml.
-
- * pygtk-gtklinkbutton.xml: Add.
-
- * pygtk-gtkfilechooserbutton.xml (get_focus_on_click)
- (set_focus_on_click, "focus-on-click"): Add.
-
- * pygtk-gtkwidget.xml (input_shape_combine_mask, is_composited)
- (drag_dest_get_track_motion, drag_dest_set_track_motion)
- (get_action): Add.
-
- * pygtk-gtk-classes.xml: Add pygtk-gtkcellrendererspin.xml
-
- * pygtk-gtkcellrendererspin.xml: Add.
-
- * pygtk-gtkcombobox.xml (set_title, get_title): Add.
-
- * pygtk-gtkclipboard.xml (wait_is_rich_text_available)
- (wait_for_rich_text, request_rich_text): Add.
-
-2006-06-03 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkentry.xml ("inner-border", "truncate-multiline")
- (set_inner_border, get_inner_border): Add.
-
- * pygtk-gtkcombobox.xml ("popup-shown", "tearoff-title"): Add.
-
- * pygtk-gtkcellrenderertext.xml ("alignment"): Add.
-
- * pygtk-gtkbutton.xml ("inner-border", "displace-focus")
- ("image-position"): Add new property descriptions.
-
- * pygtk-gtkcellrendereraccel.xml: Add.
-
- * pygtk-gtk-classes.xml: Add pygtk-gtkcellrendereraccel.xml
-
- * pygtk-gtk-constants.xml (GTK CellRendererAccel Mode Constants): Add.
-
- * pygtk-gtkassistant.xml: Add.
-
- * pygtk-gtk-classes.xml: Add pygtk-gtkassistant.xml
-
-2006-06-01 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtk-constants.xml (Assistant Page Type Constants): Add.
-
- * pygtk-gdkevent.xml (Attributes): Add common attributes into all
- Event type descriptions, Fixes #339825 (Johan Dahlin).
- Add new 2.8 attributes. Many small improvements.
-
- * pygtk-gdk-constants.xml: Add Owner Change constants.
-
-2006-05-31 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkdrawable.xml (draw_layout_line): Add.
-
- * pygtk-gtkwidget.xml (region_intersect): Add.
-
- * pygtk-gdkcairocontext.xml (set_source_pixmap, region)
- (rectangle): Add.
-
- * pygtk-gdk-functions.xml (gtk.gdk.region_rectangle): Add link.
-
- * pygtk-gdkgc.xml (set_clip_region):
-
- * pygtk-gdkwindow.xml (get_update_area, invalidate_region)
- (shape_combine_region, input_shape_combine_mask)
- (input_shape_combine_region): Add.
-
- * pygtk-gdk-classes.xml: Add pygtk-gdk-region.xml.
-
- * pygtk-gdkregion.xml: Add.
-
- * pygtk-gdk-constants.xml (overlap-type-constants): Revise description.
-
-2006-05-29 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdk-functions.xml (gtk.gdk.event_handler_set): Add link.
- (gtk.gdk.set_show_events, gtk.gdk.event_get_graphics_expose) Fix
- function signatures.
-
-2006-05-26 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeselection.xml (set_select_function): Fix callback
- signature.
-
- * pygtk-gdk-constants.xml (parent-relative-constant): Add.
-
- * pygtk-gtkstyle.xml (Attributes): Array attribute items are
- read-write.
-
- * pygtk-gtkiconview.xml (set_cursor): Bring description in line with
- behavior. Fixes #343039 (Ross Burton)
-
-2006-05-25 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcombobox.xml (get_active): Extend description for TreeStore
- model type active items. Fixes #342555 (Tuomas Vesterinen)
-
-2006-05-02 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkevent.xml (gtk.gdk.event_handler_set): Add description.
-
- * pygtk-gtk-functions.xml (gtk.init_check)
- (add_log_handlers, remove_log_handlers): Add function descriptions.
-
- * pygtk-gtktreesortable.xml (set_default_sort_func): Add info that
- sort_func param can be None.
-
- * pygtk-gtktreeviewcolumn.xml (cell_get_size): Add cell_area param.
-
- * pygtk-gdk-constants.xml (Pixbuf Rotation Constants): Add description.
-
- * pygtk-gdkpixbuf.xml (rotate_simple): Add method description
-
-2006-05-01 John Finlay <finlay@moeraki.com>
-
- * pygtk-pangolayoutline.xml (index_to_x): Fix param name.
-
- * pygtk-gtkcontainer.xml (list_child_properties)
- (install_child_property): Add method descriptions.
- (gtk.container_class_install_child_property)
- (gtk.container_class_list_child_properties): Add deprecation warning.
-
- * pygtk-gdkdrawable.xml (draw_indexed_image): Add method description.
-
- * pygtk-pangocairo-functions.xml (context_set_font_options)
- (context_get_font_options): Add function descriptions.
-
- * pygtk-gdkscreen.xml (get_rgba_colormap, gdk_screen_get_rgba_visual):
- Add these new method descriptions.
-
- * pygtk-gdkdragcontext.xml (set_icon_name): Add.
-
- * pygtk-gdkwindow.xml (set_urgency_hint): Add.
-
- * pygtk-gtktreeview.xml (get_visible_range): Add.
-
- * pygtk-gtkwidget.xml (drag_source_add_image_targets)
- (drag_source_add_uri_targets, drag_source_set_icon_name): Add.
-
- * pygtk-gtkdialog.xml (gtk.alternative_dialog_button_order): Add.
-
- * pygtk-gtk-functions.xml (gtk.alternative_dialog_button_order):
- Add.
-
- * pygtk-gtkclipboard.xml (request_image, wait_for_image, set_image)
- (wait_is_image_available): Add.
-
-2005-11-29 Johan Dahlin <jdahlin@async.com.br>
-
- * pygtk-gtkimage.xml: Remove in arguments from GtkImage getters TOC,
- they're a tuple return value in PyGTK.
-
-2005-10-22 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkdialog.xml (gtk.Dialog): Fix typo.
- Fixes #319498 (Nikos Kouremenos)
-
-2005-10-17 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcolorbutton.xml (gtk.ColorButton): Add initializer.
-
-2005-10-14 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdk-functions.xml (gtk.gdk.pointer_grab): Fix typo.
- Fixes #318857 (Nikos Kouremenos)
-
-2005-10-07 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkevent.xml (Constructor, copy, event_get, event_peek):
- Remove references to free() method. Fixes #318228 (Nikos Kouremenos)
-
- * pygtk2-ref.xml: Change date and bump version number.
-
-2005-09-20 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkmenu.xml (attach_to_menu): Add signatures of detach and
- menu position callbacks. Fixes #316780 (Nikos Kouremenos)
-
- ======== 2.8.1 ============
-2005-09-17 John Finlay <finlay@moeraki.com>
-
- * pygtk-gobject-functions.xml (spawn_async, child_watch_add)
- (main_depth, get_current_time) : Add descriptions.
-
- * pygtk-gobject-constants.xml (Spawn Flag Constants): Add.
-
- * pygtk-gtkobject.xml (gtk.binding_entry_remove): Add.
- * pygtk-gtk-functions.xml (gtk.binding_entry_add_signal):
- Move function description to gtk.Object class description. Fix
- varname errors (#316022 Nikos Kouremenos).
-
- * pygtk2-ref.xml: Change date and bump version number.
-
- * pygtk-hierarchy.xml: Update.
-
- * pygtk-pangocairocairocontext.xml : Add class description.
-
- * pygtk-pangocairocairofontmap.xml : Add class description.
-
- * pygtk-pangocairo-constants.xml : Add.
-
- * pygtk-pangocairo-functions.xml : Add.
-
- * pygtk-pangolayoutline.xml : Add class description.
-
- * pygtk-pangolayoutiter.xml (get_line): Add.
-
-2005-09-16 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkdrawable.xml (cairo_create): Add.
-
- * pygtk-pangorenderer.xml: Add pango.Renderer class description.
-
- * pygtk-gdkpangorenderer.xml: Add gtk.gdk.PangoRenderer class
- description.
-
- * pygtk-pango-constants.xml (pango.RENDER_PART): Add.
-
- * pygtk-gdkdragcontext.xml (set_icon_name): Remove.
-
- * pygtk-gdkwindow.xml (set_urgency_hint): Remove.
-
- * pygtk-gtktreeview.xml (get_visible_range): Remove.
-
- * pygtk-gtkwidget.xml (drag_source_add_image_targets)
- (drag_source_add_uri_targets, drag_source_set_icon_name): Remove.
-
- * pygtk-gtkdialog.xml (gtk.alternative_dialog_button_order): Remove.
-
- * pygtk-gtk-functions.xml (gtk.alternative_dialog_button_order):
- Remove.
-
- * pygtk-gtkclipboard.xml (request_image, wait_for_image, set_image)
- (wait_is_image_available): Remove.
-
- * pygtk-gtkaboutdialog.xml (gtk.about_dialog_set_email_hook)
- (gtk.about_dialog_set_url_hook): Add description of callback function.
-
- ======== 2.8.0 ============
-2005-09-07 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkwidget.xml (get_for_attach_widget): Add.
-
-2005-09-06 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml: Change date and version number.
-
- * pygtk-pangolayoutiter.xml (free):
- * pygtk-gdkevent.xml (free):
- * pygtk-gtktreerowreference.xml (free):
- * pygtk-gtktreeiter.xml (free):
- * pygtk-gtkrequisition.xml (free):
- * pygtk-gtkiconsource.xml (free):
- * pygtk-gtkborder.xml (free):
- * pygtk-gtkiconinfo.xml (free): Add deprecation warning.
-
- * pygtk-gdkwindow.xml (set_urgency_hint): Add.
-
- * pygtk-gtkwindow.xml (set_urgency_hint, get_urgency_hint): Add.
- (present_with_time): Add.
-
- * pygtk-gtktreeview.xml (get_visible_range): Add.
-
- * pygtk-gtktreeviewcolumn.xml (queue_resize): Add.
-
- * pygtk-gtktreerowreference.xml (get_icon_name): Add.
-
- * pygtk-gtktoolbutton.xml (set_icon_name, get_icon_name): Add.
-
- * pygtk-gtkiconsource.xml (set_icon_name, get_icon_name): Add.
-
- * pygtk-gtktextiter.xml (forward_visible_cursor_position)
- (backward_visible_cursor_position, forward_visible_cursor_positions)
- (backward_visible_cursor_positions, forward_visible_line)
- (backward_visible_line, forward_visible_lines, backward_visible_lines):
- Add.
-
- * pygtk-gtk-stock-items.xml: Add STOCK_FULLSCREEN,
- STOCK_LEAVE_FULLSCREEN and STOCK_INFO.
- Fix XMl so RTL icons display correctly.
-
- * pygtk-gtksizegroup.xml (set_ignore_hidden, get_ignore_hidden): Add.
-
- * pygtk-gtkscrolledwindow.xml (get_hscrollbar, get_vscrollbar): Add.
-
- * pygtk-gtkmenushell.xml (set_take_focus, get_take_focus): Add.
-
- * pygtk-gtkmenubar.xml (set_pack_direction, get_pack_direction)
- (set_child_pack_direction, get_child_pack_direction): Add.
-
- * pygtk-gtkimage.xml (clear): Add.
-
- * pygtk-gtkiconview.xml (create_drag_icon, enable_model_drag_dest)
- (enable_model_drag_source, get_cursor, get_dest_item_at_pos)
- (get_drag_dest_item, get_item_at_pos, get_reorderable)
- (get_visible_range, scroll_to_path, set_cursor, set_drag_dest_item)
- (set_reorderable, unset_model_drag_dest, unset_model_drag_source): Add.
-
- * pygtk-gtk-constants.xml (IconView Drop Position Constants)
- (Pack Direction Constants): Add.
-
-2005-09-05 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkfilechooser.xml (get_do_overwrite, set_do_overwrite)
- ("do-confirm-overwrite", confirm-overwrite): Add.
-
- * pygtk-gtkentrycompletion.xml (set_popup_set_width)
- (get_popup_set_width, set_popup_single_match, get_popup_single_match):
- Add.
-
- * pygtk-gtkaboutdialog.xml (get_wrap_license, set_wrap_license): Add.
-
- * pygtk-gtktextview.xml (get_iter_at_position):
-
- * pygtk-gtk-stock-items.xml: Add STOCK_DISCONNECT.
-
- * pygtk-gtkprogressbar.xml (set_ellipsize, get_ellipsize): Add.
-
- * pygtk-gtkfilefilter.xml (add_pixbuf_formats): Add.
-
- * pygtk-gtkwidget.xml (drag_source_add_image_targets)
- (drag_source_add_uri_targets): Add.
-
- * pygtk-gtkclipboard.xml (request_image, wait_for_image, set_image)
- (wait_is_image_available):
- Add.
-
- * pygtk-gtkdialog.xml (gtk.alternative_dialog_button_order)
- (get_response_for_widget): Add description.
-
- * pygtk-gtkbutton.xml (get_image, set_image): Add descriptions.
-
- * pygtk-gtkaction.xml (get_accel_path): Add description.
-
-2005-09-03 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkscrolledwindow.xml (set_vadjustment): Fix param name
- typo. Fixes #315202 (Nikos Kouremenos)
-
-2005-09-02 John Finlay <finlay@moeraki.com>
-
- * pygtk-gladexml.xml (set_custom_handler, bindtextdomain)
- (textdomain, set_custom_widget): Add descriptions of these functions.
- patch by Gian Mario Tagliaretti. Fixes #164078.
-
-2005-08-16 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkdialog.xml (add_buttons): Fix description of how button
- data is passed to the method.
-
-2005-08-12 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkwidget.xml ("drag-data-get"): Fix typo. Fixes #313351
- (Nikos Kouremenos)
-
-2005-08-09 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkscale.xml (set_digits): Note that if "draw-value" is FALSE
- set_digits() has no effect. (Steve Langer)
-
-2005-07-27 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkrcstyle.xml (Styles description): Add info about style
- property.
-
- * pygtk-gtkwidget.xml
- * pygtk-gtk-functions (widget_class_list_style_properties): Fix
- incorrectly named function.
-
-2005-07-22 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktextbuffer.xml: Explicitly identify params that are
- TextIters. Fixes #308835. (Nikos Kouremenos)
-
- * pygtk-gtknotebook.xml (switch-page): Add missing param descriptions.
- Fixes #311283 (Nikos Kouremenos)
-
- * pygtk-gtktreemodelsort.xml
- * pygtk-gtktreemodelfilter
- * pygtk-gtkliststore.xml
- * pygtk-gtktreestore.xml
- * pygtk-gtktreemodel.xml (Description): Add reference to tutorial and
- TreeModel description of Python protocol support.
-
-2005-07-21 John Finlay <finlay@moeraki.com>
-
- * pygtk-pangocolor.xml (pango.Color): remove parse() method and replace
- with pango.Colo()r constructor.
-
-2005-07-19 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkwindow.xml (various): Reference GDK constants directly
- via links. Fixes #310871 (Nikos Kouremenos)
- Fix freedesktop links.
-
-2005-07-18 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkmenu.xml (detach): Fix typo. #310745 (Nikos Kouremenos)
-
-2005-07-10 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkwidget.xml (set_activate_signal)
- (set_scroll_adjustments_signal): Add these new PyGTK 2.8 methods.
- Fixes #155679.
-
-2005-07-07 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkwidget.xml (render_icon): detail param defaults to None.
- Fixes #309724 (Nikos Kouremenos)
-
- * pygtk-gtktreestore.xml: Fix typos. Fixes #309719 (Nikos Kouremenos)
-
-2005-07-06 John Finlay <finlay@moeraki.com>
-
- * pygtk-gobject.xml (Signals): Add description of the "notify" signal.
-
-2005-06-20 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkradioaction.xml (set_group, get_group):
- * pygtk-gtkradiobutton.xml (set_group, get_group):
- * pygtk-gtkradiomenuitem.xml (set_group, get_group):
- * pygtk-gtkradiotoolbutton.xml (set_group, get_group):
- set group can specify None to remove item from group. #170514
-
-2005-05-29 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkdialog.xml (add_buttons): correct description of buttons
- param. (Sridhar Ratna)
-
-2005-05-26 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkwindow.xml (set_keep_abaove, set_keep_below, move):
- Latest attempt to track freedesktop wm standard link. (Olav Vitters)
-
-2005-05-22 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkpixbuf.xml (save_to_callback): Add.
-
- * pygtk-gobject-functions.xml (markup_escape_text): Add.
-
- * pygtk-gtkentrycompletion.xml (get_text_column): Add description.
-
- * pygtk-gdk-functions.xml (notify_startup_complete)
- (get_program_class, set_program_class, get_display)
- (get_display_arg_name): Add descriptions of these new functions.
-
-2005-05-20 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtksettings.xml (set_string_property, set_long_property)
- (set_double_property): Add more info about origin param.
-
-2005-05-03 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcellrenderer.xml (Properties): Add description of
- "sensitive" property. Fixes #302841 (Gustavo Rahal).
-
-2005-04-27 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkiconview.xml (set_columns, get_columns, set_item_width)
- (get_item_width, set_spacing, get_spacing, set_row_spacing)
- (get_row_spacing, set_column_spacing, get_column_spacing)
- (set_margin, get_margin): Add descriptions of these methods and
- their associated properties. Fixes #302196 (brett)
-
- * pygtk-gtktreeview.xml (insert_column_with_attributes): Fix typo
- and correct return value description. #302309. (Nick Kouremenos)
-
- * pygtk-gtktreeviewcolumn.xml (set_sizing): Add link to TreeViewColumn
- sizing constants.
-
-2005-04-13 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml: Bump version number and date.
-
- ======== 2.6.0 ============
-2005-04-10 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml: Change date and comment out revhistory.
-
- * pygtk-gdk-functions.xml (gtk.gdk.threads_init): Remove confusing
- and possibly erroneous description. Fixes #172615 (John Ehresman)
-
-2005-04-08 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkkeymap.xml (translate_keyboard_state): Remove extra arg from
- example call. (Nikos Kouremenos)
-
-2005-04-04 John Finlay <finlay@moeraki.com>
-
- * pygtk-hierarchy.xml: Add new 2.6 classes. (Nikos Kouremenos)
-
- * pygtk-gtkwindow.xml (set_keep_above): Fix link to "Extended Window
- Manager Hints" spec. (Nikos Kouremenos)
-
-2005-04-03 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkdialog.xml (Description, Constructor): Add links to
- constants used for response IDs and flags. Fixes #172550 (Johan Dahlin)
-
-2005-03-31 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcalendar.xml (Description, get_date): Add note about
- month value starting at zero. Patch by Gian Mario Tagliaretti.
-
- * pygtk2-ref.xml: Bump version number and change date.
-
- ======== 2.5.2 ============
-2005-03-05 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Bump version number and change date.
-
- * pygtk-introduction (Major Changes) Update description with new
- GTK+ 2.6 classes and add gtk.glade module.
-
-2005-02-28 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkcursor.xml (gtk.gdk.Cursor): Rephrase constructor
- descriptions to clarify how to make an invisible cursor. Fixes #168755
- (get_display) Fix mangled description.
-
-2005-02-15 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcellrenderertext.xml (Properties): Add GTK+ 2.6
- properties ellipsize, ellipsize-set, width-chars. Alphabetize entries.
- Fixes #167504 (Rafael Villar Burke)
-
-2005-02-03 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcellrenderer.xml (stop_editing, "editing-started"):
- Add descriptions of these PyGTK 2.6 additions.
-
-2005-01-18 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref-xml: Add pygtk-glade-classes.xml. Change date.
-
- * pygtk-glade-classes.xml
- * pygtk-gladexml.xml: Add these files created by Johan Dahlin.
-
- * pygtk-gladexml-classes.xml: Remove.
-
-2005-01-15 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkentrycompletion.xml (get_text_column): Remove unimplemented
- method.
- (insert-prefix): Add description of PyGTK2.6 method.
-
-2005-01-13 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtklabel.xml (get_angle, set_angle, set_max_width_chars)
- (get_max_width_chars): Add descriptions of these PyGTK 2.6 methods.
- ("angle", "max-width-chars"): Add descriptions.
-
- * pygtk-gtk-functions.xml (gtk.get_current_event)
- (gtk.get_current_event_state): Add descriptions of these PyGTK2.6
- functions.
-
- * pygtk-gdkpixmap.xml
- * pygtk-gdk-functions.xml (gtk.pixmap_colormap_create_from_xpm)
- (gtk.pixmap_colormap_create_from_xpm_d)
- (gtk.pixmap_colormap_from_xpm_d):
- First arg can be a GdkDrawable.
-
- * pygtk-gtkcontainer.xml (gtk.container_class_install_child_property):
- Add description of this PyGTK2.4 function. Update Description.
-
- * pygtk-gtk-functions.xml (gtk.container_class_install_child_property):
- Add link to.
-
- * pygtk-gtkwidget.xml ("child-notify", "client-event")
- ("proximity-in-event", "proximity-out-event") Add descriptions.
- Patch by Gian Mario Tagliaretti.
-
-2004-12-27 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdk-constants.xml (event type constants): Fix Typo (Gian Mario
- Tagliaretti)
-
-2004-12-26 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkevent.xml (Attributes): CLIENT_EVENT message_type is
- writeable.
-
-2004-12-24 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml: Bump version number and pubdate.
-
- * pygtk-gtkuimanager.xml ("post-activate", "pre-activate"): Add
- action param description.
-
- ======== 2.5.1 ============
-2004-12-23 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Update pubdate and revhistory.
-
- * pygtk-gdkpixbuf.xml (render_to_drawable, render_to_drawable_alpha):
- Add deprecation warning.
-
- * pygtk-gtkcellview.xml (set_value, set_values, set_cell_data_func):
- Remove descriptions of removed methods.
-
-2004-12-21 John Finlay <finlay@moeraki.com>
-
- * Various Use xref tags instead of link tags where possible.
-
- * pygtk2-ref.xml Add revhistory, releaseinfo and edition tags.
- Remove version number from title tag and add to releaseinfo tag.
-
- * pygtk-gtktoolbar.xml (set_style) Add a note about ToolItem label
- display when style is TOOLBAR_BOTH_HORIZ. (Gian Mario Tagliaretti)
-
-2004-12-10 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtksettings.xml (Description): Change description to indicate
- that there is one Settings object per GdkScreen (Rafael Villar Burke)
-
-2004-12-09 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtk-stock-items.xml (gtk.stock_add): Add reference to
- Modifier Constants docs.
-
-2004-12-07 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkwindow.xml (move): Fix example code.
- Fixes #160678. (Gian Mario Tagliaretti)
-
- * pygtk-gtkwindow.xml (set_type_hint): Add reference to window type
- hint constants. Fixes #160669 (Gian Mario Tagliaretti)
- (set_gravity, begin_resize_drag): Add reference to constants.
-
-2004-12-06 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtk-stock-items.xml Remove duplicate STOCK_WARNING.
- Fixes #160584 (Erik Grinaker).
- Add GTK+ 2.6 stock icons.
-
-2004-12-04 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkdialog.xml (set_alternative_button_order): Add.
-
- * pygtk-pangolayoutiter.xml Add.
-
- * pygtk-pangolayout.xml (get_iter) Add description of this PyGTK 2.6
- method.
-
- * pygtk-gtkcellview.xml (set_cell_data) Remove.
-
- * pygtk-gtkfilechooserbutton.xml (set_active, get_active, "active"):
- Remove.
-
-2004-11-20 John Finlay <finlay@moeraki.com>
-
- * pygtk_gtkdialog.xml (gtk.Dialog) Fix param list bug.
-
-2004-11-18 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkliststore.xml (remove): Document return value differences.
- (Doug Quale)
-
-2004-11-16 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Set pubdate. Bump version number to 2.5.1
-
- * pygtk-gtkselectiondata.xml (gtk.target_list_add_image_targets)
- (gtk.target_list_add_text_targets)
- (gtk.target_list_add_uri_targets): Add descriptions.
-
- * pygtk-gtkaboutdialog.xml (gtk.about_dialog_set_email_hook)
- (gtk.about_dialog_set_url_hook): Add descriptions.
-
- * pygtk-gtk-functions.xml: Add new AboutDialog, CellView, Image
- and Window functions. Fix SelectionData and Settings functions.
-
- ======== 2.5.0 ============
-2004-11-15 John Finlay <finlay@moeraki.com>
-
- * pygtk-introduction.xml Update.
-
- * pygtk2-ref.xml Set pubdate. Bump version number to 2.5.0
-
- * pygtk-gdkwindow.xml (set_focus_on_map)
- (enable_synchronized_configure, configure_finished): Add descriptions
-
- * pygtk-gdkdragcontext.xml (drag_drop_succeeded): Add description.
-
- * pygtk-gdkdisplay.xml (store_clipboard)
- (request_selection_notification, supports_clipboard_persistence
- (supports_selection_notification): Add descriptions.
-
- * pygtk-gtktreeselection.xml (get_selected_rows): Remove model
- arg - not needed. Fixes #158397 (Ken Harris)
-
- * pygtk-gtkwindow.xml (gtk.window_set_default_icon_name)
- (get_icon_name, set_icon_name, get_focus_on_map, set_focus_on_map):
- Add descriptions.
-
- * pygtk-gtktreeview.xml (set_row_separator_func)
- (set_hover_expand, get_hover_expand, set_hover_selection)
- (get_hover_selection, set_fixed_height_mode, get_fixed_height_mode)
- ("hover-selection", "hover-expand", "fixed-height-mode"):
- Add descriptions.
-
- * pygtk-gtktoolitem.xml (rebuild_menu): Add description
- ("create-menu-proxy"): Update description.
-
- * pygtk-gtktextbuffer.xml (backspace, "tag-table"): Add descriptions.
-
-2004-11-14 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkselectiondata.xml (data_targets_include_image)
- (get_uris, set_uris, get_pixbuf, set_pixbuf): Add descriptions.
-
- * pygtk-gtkmessagedialog.xml (format_secondary_text)
- (format_secondary_markup): Add descriptions.
-
- * pygtk-gtkmenutoolbutton.xml Add.
-
- * pygtk-gtkwidget.xml (menu_get_for_attach_widget): Add description.
-
- * pygtk-gtkmenu.xml ("tearoff-state") Add description.
-
- * pygtk-gtklabel.xml (Description): Update.
- (set_ellipsize, get_ellipsize, set_width_chars, get_width_chars)
- (get_single_line_mode, set_single_line_mode): Add descriptions.
- ("ellipsize, "width-chars", "single-line-mode"): Add descriptions.
-
- * pygtk-pango-constant.xml Add Ellipsize Mode Constants.
-
- * pygtk-gtkimage.xml (gtk.image_new_from_icon_name)
- (get_icon_name, set_from_icon_name, set_pixel_size, get_pixel_size):
- Add descriptions of these PyGTK 2.6 methods and function.
- (Description): Update.
-
-2004-11-13 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkiconview.xml Add.
- * pygtk-gtk-classes.xml Add pygtk-pygtk-gtkiconview.xml
-
- * pygtk-gtkicontheme.xml (get_icon_sizes): Add description.
-
- * pygtk-gtkfilechooser.xml (set_show_hidden, get_show_hidden):
- Add description os these PyGTK 2.6 methods.
- (Description) Update.
-
- * pygtk-gtkfilechooserbutton.xml Add.
-
- * pygtk-gtk-classes.xml Add pygtk-gtkfilechooserbutton.xml
-
-2004-11-12 John Finlay <finlay@moeraki.com>
-
- * pygtk-gobject-functions.xml (signal_list_ids, signal_lookup)
- (signal_name, signal_query): Add descriptions of these PyGTK 2.6
- methods.
-
- * pygtk-gtkwidget.xml (set_accelerator): Change wording to clarify
- argument value usage. (stan@saticed.me.uk)
-
-2004-11-10 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkentrycompletion.xml (get_text_column)
- (set_inline_completion, get_inline_completion)
- (set_popup_completion, get_popup_completion): Add descriptions of
- these PyGTK 2.6 methods.
-
- * pygtk-gtkwidget.xml (drag_dest_add_image_targets)
- (drag_dest_add_text_targets, drag_dest_add_uri_targets)
- (drag_source_add_text_targets, drag_source_get_target_list)
- (drag_source_set_target_list): Add descriptions of these PyGTK 2.6
- methods.
-
- * pygtk-gtkcombobox.xml (get_wrap_width, get_row_span_column)
- (get_column_span_column, get_active_text, get_popup_accessible)
- (get_row_separator_func, set_row_separator_func, get_add_tearoffs)
- (set_add_tearoffs, get_focus_on_click, set_focus_on_click):
- Add descriptions of these PyGTK 2.6 methods.
-
- * pygtk-gtkclipboard.xml (wait_is_target_available)
- (set_can_store, store): Add documentation on these PyGTK 2.6 methods
-
- * pygtk-gtkcellrenderercombo.xml Add.
- * pygtk-gtkcellrendererprogress.xml Add.
- * pygtk-gtkcellview.xml Add.
- * pygtk-gtk-classes.xml Add above files.
-
-2004-11-09 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkaboutdialog.xml Add.
-
- * pygtk-gtk-classes.xml Add pygtk-gtkaboutdialog.xml
-
-2004-11-08 Johan Dahlin <johan@gnome.org>
-
- * pygtk-gtkwindow.xml: s/gtk.IN/gtk.WIN/
-
-2004-11-08 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkwindow.xml (Description, gtk.Window, set_position):
- Add link to appropriate Constants description.
-
-2004-11-01 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtksettings.xml Add gtk-alternative-button-order and
- gtk-modules properties. Fix typo.
-
-2004-10-28 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcombobox.xml (set_model) model can be and default to None
- in PyGTK 2.4.1.
-
- * pygtk-gtkentrycompletion.xml (set_model) model can be and default
- to None in PyGTK 2.4.1.
-
-2004-10-21 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkalignment.xml (gtk.Alignment) Undo changes since new
- default values are wrong.
-
-2004-10-19 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkalignment.xml (gtk.Alignment) Note change of default values
- in 2.4. (Gustavo Niemeyer)
-
-2004-10-12 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkwidget.xml ("destroy-event") Add description per
- Christian Reis.
-
- * pygtk-gtkstatusbar.xml (push) Note that the message id can be used
- with the remove() method. (Rafael Villar Burke)
-
- * pygtk-gtkwidget.xml (modify_bg) Note that bg can only be
- modified on widgets with a gdkWindow. (Rafael Villar Burke)
-
- * pygtk-gtkadjustment.xml (Description) Fix broken links reported by
- Antoon Pardon.
-
-2004-10-05 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Bump version number and set pubdate
-
- * pygtk-gdkgc.xml (set_clip_rectangle) Note that the clip origin
- is also set to (0, 0) per Rafael Villar Burke.
-
- ================ 2.4.11 ==============
-2004-10-03 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Set pubdate.
-
- * pygtk-gtkuimanager.xml (insert_action_group) Add details on pos
- param.
- (add_ui) Additional info on path param. Add info on type values.
- (new_merge_id) Add info on merge ids.
-
-
-2004-09-28 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkalignment.xml (Description) Fix example description.
-
-2004-09-18 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkactiongroup.xml (add_actions) (add_toggle_actions)
- (add_radio_actions) Clarify entry tuple field usage.
-
-2004-09-15 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeview.xml (set_search_equal_func) Note that the
- comparison function should return FALSE to indicate a match. (Thomas
- Mills Hinkle)
-
-2004-09-06 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkaction.xml (Properties) name property is construct only.
-
-2004-08-11 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.html Bump version number.
-
- ================ 2.4.10 ==============
-2004-08-11 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Set pubdate.
-
- * pygtk-gdkdisplay.xml pygtk-gdkdisplaymanager.xml
- * pygtk-gdkkeymap.xml pygtk-gdkpixbufloader.xml
- * pygtk-gdkscreen.xml pygtk-gtkaccelgroup.xml
- * pygtk-gtkaction.xml pygtk-gtkactiongroup.xml
- * pygtk-gtkadjustment.xml pygtk-gtkbutton.xml
- * pygtk-gtkcalendar.xml pygtk-gtkcelleditable.xml
- * pygtk-gtkcellrenderer.xml pygtk-gtkcellrenderertext.xml
- * pygtk-gtkcellrenderertoggle.xml pygtk-gtkcheckmenuitem.xml
- * pygtk-gtkcolorbutton.xml pygtk-gtkcolorselection.xml
- * pygtk-gtkcombobox.xml pygtk-gtkcontainer.xml
- * pygtk-gtkcurve.xml pygtk-gtkdialog.xml pygtk-gtkeditable.xml
- * pygtk-gtkentry.xml pygtk-gtkentrycompletion.xml
- * pygtk-gtkexpander.xml pygtk-gtkfilechooser.xml
- * pygtk-gtkfontbutton.xml pygtk-gtkhandlebox.xml
- * pygtk-gtkicontheme.xml pygtk-gtkimcontext.xml
- * pygtk-gtkinputdialog.xml pygtk-gtkitem.xml pygtk-gtklabel.xml
- * pygtk-gtklayout.xml pygtk-gtkmenu.xml pygtk-gtkmenuitem.xml
- * pygtk-gtkmenushell.xml pygtk-gtknotebook.xml
- * pygtk-gtkobject.xml pygtk-gtkoptionmenu.xml pygtk-gtkpaned.xml
- * pygtk-gtkplug.xml pygtk-gtkradioaction.xml
- * pygtk-gtkradiobutton.xml pygtk-gtkradiomenuitem.xml
- * pygtk-gtkrange.xml pygtk-gtkscale.xml
- * pygtk-gtkscrolledwindow.xml pygtk-gtksocket.xml
- * pygtk-gtkspinbutton.xml pygtk-gtkstatusbar.xml
- * pygtk-gtktextbuffer.xml pygtk-gtktexttag.xml
- * pygtk-gtktexttagtable.xml pygtk-gtktextview.xml
- * pygtk-gtktoggleaction.xml pygtk-gtktogglebutton.xml
- * pygtk-gtktoggletoolbutton.xml pygtk-gtktoolbar.xml
- * pygtk-gtktoolbutton.xml pygtk-gtktoolitem.xml
- * pygtk-gtktreemodel.xml pygtk-gtktreeselection.xml
- * pygtk-gtktreesortable.xml pygtk-gtktreeview.xml
- * pygtk-gtktreeviewcolumn.xml pygtk-gtkuimanager.xml
- * pygtk-gtkviewport.xml pygtk-gtkwidget.xml pygtk-gtkwindow.xml
- Fix signal titles.
-
-2004-08-10 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Undo erroneous check-in
-
-2004-08-06 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Bump version number and pubdate
-
- * pygtk-gtkclipboard.xml (Synopsis) Fix typo. (Able Daniel)
-
- ================ 2.4.9 ==============
-2004-08-03 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Update pubdate.
-
-2004-08-02 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkexpander.xml (gtk.expander_new_with_mnemonic)
- (gtk.Expander) Note that label is optional and defaults to None.
- (set_label) (set_label_widget) Note that label and label_widget
- can be None.
-
- * pygtk-gtkcomboboxentry.xml (gtk.ComboBoxEntry) Default value
- for column is -1.
- (Description) (set_text_column)
- Note that the text column can only be set once.
-
-2004-07-31 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkmenu.xml (Properties) Swap Child and Style property titles.
-
-2004-07-29 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeview.xml (get_drag_dest_row) None is a valid return
- value.
-
- * pygtk-gtkliststore.xml (insert_before) (insert_after)
- sibling param can be None in PyGTK 2.4.
-
-2004-07-28 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkicontheme.xml (Description) Fix broken ulink tag.
-
- * pygtk-gtkexpander.xml (Description) Fix bug in example code using
- "expanded" property signal. Add note about using "activate" signal.
-
-2004-07-27 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkatom.xml (Description) Add note on support for
- Atom and string comparsion support in PyGTK 2.4.
-
- * pygtk-gdkwindow.xml (property_get) (property_change) Add links for
- gtk.gdk.Atom references. Fixes #148569. Thanks to Abel Daniel.
-
-2004-07-24 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdk-constants.xml (Filter Return Constants) Add reference to
- gtk.gdk.Window.Add_filter() method.
-
- * pygtk-gdkwindow.xml (add_filter) Add initializer for data.
- Describe return value for callback.
-
-2004-07-23 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreemodel.xml ("row-inserted") ("row-changed") Add
- detail on when these are emitted.
-
-2004-07-22 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktextbuffer.xml (add_selection_clipboard)
- (remove_selection_clipboard)
- (cut_clipboard) (copy_clipboard) (paste_clipboard)
- These methods are available in PyGTK 2.2.
-
- * pygtk-gtktextview.xml (Description) Clipboard access is available
- in PyGTK 2.2.
-
- * pygtk-gtkwidget.xml (get_clipboard) Available in PyGTK 2.2.
-
-2004-07-21 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkclipboard.xml (gtk.Clipboard) Add description of defaults
- for optional params.
- (gtk.clipboard_get) Add description of this PyGTK 2.4 function.
-
- * pygtk-gtk-functions.xml
- (gtk.clipboard_get) Add link for this PyGTK 2.4 function.
-
- * pygtk-gtkclipboard.xml (set_with_data) Add description of get_func
- and clear_func signatures.
-
-2004-07-20 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeviewcolumn.xml (set_sort_column_id) Expand description
- of this convenience method.
- (set_sort_indicator) Add note re effect of set_sort_column_id() on
- use of this method.
-
-2004-07-19 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreesortable.xml (set_sort_func) Add description of
- comaprison function return value. Thanks to Andrew Boie.
-
- * pygtk-gtktreeview.xml (get_path_at_pos) Return value if no path
- is None.
-
-2004-07-18 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkactiongroup.xml (add_actions)
- (add_toggle_actions) (add_radio_actions) Document new user_data
- param.
-
-2004-07-15 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkbutton.xml Add description of optional use_underline
- param added in PyGTK 2.4
- * pygtk-gtktogglebutton.xml Add description of optional use_underline
- param added in PyGTK 2.4. Add missing constructor param description.
- * pygtk-gtkcheckbutton.xml Add description of optional use_underline
- param added in PyGTK 2.4.
- * pygtk-gtkradiobutton.xml Add description of optional use_underline
- param added in PyGTK 2.4.
- * pygtk-gtkcheckmenuitem.xml Add description of optional use_underline
- param added in PyGTK 2.4.
- * pygtk-gtkmenuitem.xml Add description of optional use_underline
- param added in PyGTK 2.4.
- * pygtk-gtkradiomenuitem.xml Add description of optional use_underline
- param added in PyGTK 2.4.
-
-2004-07-12 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkwindow.xml (set_geometry_hints) Add missing param names.
- Thanks to Theo Reed in #147458.
-
-2004-07-09 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkbin.xml ("child") Add description of this attribute.
-
- * pygtk-gtkcheckmenuitem ("active") Add description of this attribute.
- ("indicator-size") Add description of this style property.
-
- * pygtk-gtkgammadialog.xml (Attributes) Add description of attributes.
-
-2004-07-08 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkcolor.xml (gtk.gdk.parse_color) Add info on exceptions.
-
- * pygtk-gdkcolormap.xml (alloc_color) Modify description on
- exceptions.
-
-2004-07-04 John Finlay <finlay@moeraki.com>
-
- * pygtk-pygtkgenerictreemodel.xml Fix broken links.
-
- * pygtk-gtktreemodel.xml (rows_reordered) ("rows-reordered")
- Update these to indicate top level row reordering.
-
- * pygtk-gdkcolormap.xml (query_color) Add description of this
- PyGTK 2.4 method.
-
-2004-07-03 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkpixbuf.xml (subpixbuf) Add description of this new
- PyGTK 2.4 method.
-
- * pygtk-pygtkgenerictreemodel.xml (Description) Add info on new
- methods invalidate_iters() and iter_is_valid().
- (invalidate_iters) (iter_is_valid) Add description of these
- PyGTK 2.4 methods.
-
- * pygtk-gtktreeview.xml (get_search_equal_func) Remove. This wasn't
- implemented.
-
- * pygtk-gtktreeview.xml (get_search_equal_func)
- (set_search_equal_func) Add description of these PyGTK 2.4 methods.
- Fix some typos.
-
- * pygtk-gobject-functions.xml (io_add_watch)
-
- * pygtk2-ref.html Bump version number.
-
- ================ 2.4.8 ==============
-2004-07-01 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Change pubdate.
-
- * pygtk-gdkwindow.xml (set_user_data) Add info about TypeError
- exception.
-
- * pygtk-gtknotebook.xml (append_page) (append_page_menu)
- (prepend_page) (prepend_page_menu) (insert_page) (insert_page_menu)
- (set_tab_label) (set_menu_label)
- Describe default values for tab_label, menu_label and position params.
-
- * pygtk-gtkcombobox.xml (Description) Fix typo.
- * pygtk-introduction.xml Fix broken link
- * pygtk-gtkentrycompletion.xml Fix typo.
- Fixes #145239 thanks to Olav Vitters
-
-2004-06-30 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreesortable.xml (Description)
- (get_sort_column_id) (set_sort_func_id) Add more detail on the
- meaning and use of sort column IDs.
-
- * pygtk-gtktreesortable.xml (set_default_sort_func) Revise
- description of sort_func param. Change
- gtk.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID to -1.
- (set_sort_column_id) Change gtk.TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID
- to -1.
-
-2004-06-28 John Finlay <finlay@moeraki.com>
-
- * pygtk-pygtkgenerictreemodel.xml (Properties) Add description
- of the "leak-references" property.
-
-2004-06-20 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkwidget.xml (allocation) (window) These attributes are
- writeable in PyGTK 2.4
- * pygtk-gtkwidget.xml
- * pygtk-gtk-functions.xml (widget_class_install_style_property)
- Add description of this PyGTK 2.4 function.
-
- * pygtk-gtkcontainer.xml
- * pygtk-gtk-functions.xml (container_class_list_child_properties)
- Add description of this PyGTK 2.4 function.
-
- * pygtk-gtkitemfactory.xml (Description) Add link to gtk.UIManager
- in the deprecation message. Thanks to Matthew Bull.
-
- * pygtk-gdkwindow.xml (set_user_data) (get_user_data) Add
- description of these PyGTK 2.4 methods.
-
- * pygtk-gtknotebook.xml (insert_page) (set_tab_label) tab_label
- parameter can be None in PyGTK 2.4 and above.
-
- * pygtk-gtkwidget.xml ("drag-drop") Fix broken link.
-
- * pygtk-gtkaccelgroup.xml
- * pygtk-gtk-functions.xml (accel_groups_from_object) Add
- description of this PyGTK 2.4 function.
-
-2004-06-14 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkwidget.xml ("drag-motion") ("drag-leave") ("drag-end")
- ("drag-drop") ("drag-data-received") ("drag-data-get")
- ("drag-data-delete") ("drag-begin") Update the documentation on
- these signals.
-
-2004-06-13 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkicontheme.xml (Description) Fix typo and add exception
- handling to example. Thanks to Steve Chaplin.
-
- * pygtk-gtktextview.xml (Description) Add info about popup menu and
- selection clipboards.
-
-2004-06-12 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkimage.xml ("pixbuf") Attribute contains a pixbuf not
- a pixmap. Thanks to Christian Reis.
-
-2004-06-06 Johan Dahlin <johan@gnome.org>
-
- * pygtk-gdkevent.xml : Proper documentation of all attributes, in
- sync with latest CVS. Remove the common attribute and only show
- them in the beginning of the event list.
-
-2004-06-02 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkpaned.xml (pack1) (pack2) Change references to expand
- param to resize. Thanks to Toon Verstraelen. Fixes #143589
-
-2004-05-31 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkwindow.xml (add_filter) Add description of this PyGTK 2.2
- method.
-
-2004-05-30 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreemodel.xml ("rows-reordered") Note that new_order is
- a gpointer value.
-
- * pygtk-gtktreeview.xml ("columns-changed") Fix confusing wording.
- ("test-collapse-row") ("test-expand-row") Update return value
- wording.
-
- * pygtk-gtktreedragdest.xml (row_drop_possible) Add missing word.
-
-2004-05-29 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeview.xml (set_column_drag_function) Add description
- of this PyGTK2.4 method.
-
- * pygtk-pygtkgenerictreemodel.xml (Description) Add self as
- a param to all the methods to be implemented and use rowref
- instead of iter to avoid confusion. Correct method name from
- on_get_iter_next() to on_iter_next()
-
- * pygtk-gtktreemodel.xml (iter_next) Fix description.
-
-2004-05-28 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkpixbuf.xml (save)
- (gdk.pixbuf_new_from_file)
- (gdk.pixbuf_new_from_file_at_size)
- (gdk.pixbuf_new_from_inline) Note that GError exception is
- raised on error.
-
- * pygtk-gdkpixbufanimation.xml (gtk.gdk.PixbufAnimation) Note that
- GError exception is raised on error.
-
- * pygtk-gdkpixbufloader.xml (gtk.gdk.PixbufLoader)
- (gtk.gdk.pixbuf_loader_new_with_mime_type)
- (write) (close) Note that GError exception is raised on error.
-
- * pygtk-gtkiconinfo.xml (load_icon) Note that GError exception
- is raised on error.
-
- * pygtk-gtkicontheme.xml (load_icon) Note that GError exception
- is raised on error.
-
- * pygtk-gtkuimanager.xml (add_ui_from_string)
- (add_ui_from_file) Note that GError exception is raised on error.
-
- * pygtk-gtkwindow.xml (set_icon_from_file) Add.
- (gtk.window_set_default_icon_from_file) Note that GError exception
- is raised on error.
-
- * pygtk-gtkfilechooser.xml (add_shortcut_folder)
- (remove_shortcut_folder)
- (add_shortcut_folder_uri)
- (remove_shortcut_folder_uri) Note that GError exception is raised
- on error.
-
- * pygtk-pangoattrlist.xml (pango.parse_markup) Note that GError
- exception is raised on error.
-
-2004-05-27 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcelllayout.xml (set_cell_data_func) Add description
- of this PyGTK 2.4 method.
-
- * pygtk-gtktreeviewcolumn.xml Add note that GtkTreeViewColumn
- implements the GtkCellLayout interface in PyGTK 2.4.
-
-2004-05-25 John Finlay <finlay@moeraki.com>
-
- * pygtk-introduction.xml Add reference link to www.pygtk.org
- Thanks to Rafael Villar Burke.
-
- * pygtk-gtkentrycompletion.xml (Description) Fix example code.
-
-2004-05-24 John Finlay <finlay@moeraki.com>
-
- * pygtk-pygtktreemodelrowiter.xml (next) Fix broken links and name.
-
-2004-05-22 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreemodelfilter.xml (set_modify_func) Add description.
- Add to Description re modify function.
-
- * pygtk2-ref.xml Bump release number to 2.4.8.
-
-2004-05-21 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreemodel.xml (iter_n_children) Change NULL to None.
-
-2004-05-20 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeviewcolumn.xml (pack_start)
- (pack_end) expand param can default to TRUE.
-
- =========== 2.4.7 ==============
-2004-05-19 John Finlay <finlay@moeraki.com>
-
- * pygtk-pygtktreemodelrow.xml Add.
-
- * pygtk-pygtktreemodelrowiter.xml Add.
-
- * pygtk-gtk-classes.xml Add pygtk-pygtktreemodelrow.xml and
- pygtk-pygtktreemodelrowiter.xml
-
- * pygtk2-ref.xml Bump release number to 2.4.7
-
- * pygtk-gtktreemodel.xml Add description of mapping and iterator
- protocol support.
-
- =========== 2.4.6 ==============
-2004-05-17 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtk-constants.xml (gtk-selection-mode-constants) Fix typo.
-
- * pygtk-gtktreemodel.xml (get) Remove dangling tag.
-
- * pygtk2-ref.xml Bump release number to 2.4.6
-
-2004-05-16 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeselection.xml (set_selection_function) Fix bogus
- description of signature of func.
-
-2004-05-15 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeselection.xml Fix method links in Description.
- (set_mode) Add detail on selection mode and reference to selection
- constants.
- (selected_foreach) Add note.
-
-2004-05-13 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeselection.xml
- (get_selected) Add info that treeiter is None if no row selected.
- (get_selected_rows) Correct return value is a tuple with
- a tree modle and a list of selected paths.
-
-2004-05-12 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeview.xml (get_dest_row_at_pos) Change parameters
- to x and y from drag_x and drag_y.
-
-2004-05-10 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtknotebook.xml (append_page) (append_page_menu)
- (prepend_page) (prepend_page_menu) (insert_page)
- (insert_page_menu) Add description of return value for PyGTK 2.4
- and above - these return a page index.
-
-2004-05-07 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreestore.xml (remove) Fix return value explanation.
-
- * pygtk-gtkliststore.xml (iter_is_valid) (reorder)
- (move_before) (move_after) Change first release designation
- to PyGTK 2.2.
-
- * pygtk-gtktreemodel.xml (get) Add description of this PyGTK 2.4
- method.
- (get) Add column param to description.
-
-2004-05-06 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreestore (insert) (insert_after) (insert_before)
- (append) (prepend) Add initializers to the Synopsis.
-
-2004-05-05 John Finlay <finlay@moeraki.com>
-
- * pygtk-gobject-constants (gobject-type-constants) Fix link.
-
- * pygtk2-ref.xml Bump release number to 2.4.5
-
- ============= 2.4.4 =============
-2004-05-05 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkmenuitem.xml (activate) Accidentally commented out
- description.
-
- * pygtk-introduction.xml Unscramble programlisting.
-
- * pygtk-gobject.xml Fix Attribute formatting.
-
- * pygtk-gtkaction.xml (get_visible) Fix link.
-
- * pygtk-gtkbox.xml (pack_start_defaults)
- (pack_end_defaults) Add deprecation warnings. Remove references in
- Description.
-
- * pygtk-gtkcombo.xml Fix Properties formatting.
-
- * pygtk-gtkcontainer.xml Fix Attribute formatting.
-
- * pygtk-gtkdialog.xml Fix Attribute formatting.
-
- * pygtk-gtkfileselection.xml Fix Attribute formatting.
-
- * pygtk-gtkfontselectiondialog.xml Fix Attribute formatting.
-
- * pygtk-gtkmessagedialog.xml Fix Attribute formatting.
-
- * pygtk-gtknotebook.xml Fix Attribute formatting.
-
- * pygtk-gtkrequisition.xml Fix Attribute formatting.
-
- * pygtk-gtkselectiondata.xml Fix Attribute formatting.
-
- * pygtk-gtkstyle.xml Fix Attribute formatting.
-
- * pygtk-gtktextattributes.xml Fix Attribute formatting.
-
- * pygtk-gtktextbuffer.xml Fix Attribute formatting.
-
- * pygtk-gtktogglebutton.xml Fix Attribute formatting.
-
- * pygtk-gtktooltips.xml Fix Attribute formatting.
-
- * pygtk-gtkwidget.xml Fix Attribute formatting.
-
- * pygtk-gtkwindow.xml Fix Attribute formatting.
-
- * pygtk-gdkcolor.xml Fix Attribute formatting.
-
- * pygtk-gdkdevice.xml Fix Attribute formatting.
-
- * pygtk-gdkdragcontext.xml Fix Attribute formatting.
-
- * pygtk-gdkdrawable.xml Fix Attribute formatting.
-
- * pygtk-gdkevent.xml Fix Attribute formatting.
-
- * pygtk-gdkgc.xml Fix Attribute formatting.
-
- * pygtk-gdkpixbuf.xml Fix Attribute formatting.
-
- * pygtk-gdkrectangle.xml Fix Attribute formatting.
-
- * pygtk-gdkvisual.xml Fix Attribute formatting.
-
- * pygtk-pangoattribute.xml Fix Attribute formatting.
-
- * pygtk-pangocolor.xml Fix Attribute formatting.
-
- * pygtk-pangoglyphstring.xml Fix Attribute formatting.
-
- * pygtk2-ref.xml Bump release number to 2.4.4
-
-2004-05-04 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkmenuitem.xml (toggle_size_request) Add description.
-
- * pygtk-gtktextiter.xml (backward_find_char)
- (forward_find_char) Add descriptions of these methods.
- Fix spelling errors.
-
- * pygtk-gtktextview.xml Spell checked.
-
- * pygtk-gtktextbuffer.xml Spell checked.
-
- * pygtk-introduction.xml Add section listing major changes since 1.9.
-
- * pygtk-gobject-maincontext.xml Spell checked.
-
- * pygtk-gobject-functions.xml Spell checked.
-
- * pygtk-gobject-constants.xml Spell checked.
-
- * pygtk-gtkaccellabel.xml Spell checked.
-
- * pygtk-gtkaction.xml Spell checked.
-
-2004-04-30 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Bump release number to 2.4.3
-
- * pygtk-gtkaction.xml
- * pygtk-gtkactiongroup.xml
- * pygtk-gtkborder.xml
- * pygtk-gtkclipboard.xml
- * pygtk-gtkcolorbutton.xml
- * pygtk-gtkcombobox.xml
- * pygtk-gtkcomboboxentry.xml
- * pygtk-gtkentrycompletion.xml
- * pygtk-gtkexpander.xml
- * pygtk-gtkfilechooser.xml
- * pygtk-gtkfilechooserdialog.xml
- * pygtk-gtkfilechooserwidget.xml
- * pygtk-gtkfilefilter.xml
- * pygtk-gtkfontbutton.xml
- * pygtk-gtkiconinfo.xml
- * pygtk-gtkicontheme.xml
- * pygtk-gtkradioaction.xml
- * pygtk-gtktoolbutton.xml
- * pygtk-gtkseparatortoolitem.xml
- * pygtk-gtktoggleaction.xml
- * pygtk-gtktoggletoolitem.xml
- * pygtk-gtktoolbutton.xml
- * pygtk-gtktoolitem.xml
- * pygtk-gtktreemodelfilter.xml
- * pygtk-gtktreerowreference.xml
- * pygtk-gtkuimanager.xml
- Add a note indicating which release of PyGTK the above were new in.
-
- ============ Release 2.4.2 ===============
-2004-04-29 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkclipboard.xml Fix notes to correct release availabilities
- for object, constructor and methods.
-
- * pygtk-introduction.xml Update the introduction re: PyGTK 2.4
- and Pango. Also add description of Child Properties.
-
- * pygtk-gtktreestore.xml (remove) Add return value description.
-
- * pygtk-gtkliststore.xml (remove) Add return value description.
-
- * pygtk2-ref.xml Bump release level to 2.4.2
-
-2004-04-27 John Finlay <finlay@moeraki.com>
-
- * pygtk-gobject-function.xml (io_add_watch) Add description of
- callback signature.
-
- * pygtk2-ref.xml Bump release level to 2.4.1
-
-===== Release 2.4 =====
-
-2004-04-27 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkclipboard.xml Fix link to gtk.gdk.atom-intern().
-
- * pygtk-gtkexpander.xml Fix link to pango.parse_markup().
-
- * pygtk-gtkicontheme.xml Fix link to gtk.gdk.pixbuf_new_from_inline()
- function.
-
- * pygtk-gtkscale.xml Fix link to pango.PIXELS().
-
- * pygtk-gtkwidget.xml Fix link to gtk.gdk.Screen.
-
- * pygtk-gtkwindow.xml Fix link to Gravity Constants.
- Remove bogus link to gdk_notify_startup_complete() function.
-
- * pygtk-gtk-constants.xml Fix links to gtk.gdk.DragConstext.finish()
- method.
-
- * pygtk-pangocolor.xml Fix link to gobject.GBoxed.
-
- * pygtk-hierarchy.xml Tweak formatting.
-
- * pygtk-hierarchy.xml Use PyGTK 2.4 hierarchy.
-
- * pygtk-hierarchy.xml Remove undocumented ATK entries, etc.
-
- * pygtk-pango-constants.xml Remove reference to unimplemented
- functions.
-
- * pygtk-gdkwindow.xml Remove reference to unimplmented function.
-
- * pygtk-gdkdrawable.xml Remove reference to unimplmented function.
-
- * pygtk-gtkaccelgroup.xml Remove reference to unimplemnted function.
-
- * pygtk-gobject-ginterface.xml Add.
-
- * pygtk-gobject-classes.xml Add pygtk-gobject-ginterface.xml
-
- * pygtk2-ref.xml Update date and set version to 2.4
-
- * pygtk-gtkclipboard.xml Remove reference to unimplemnted function.
- Add initlaizers for user_data in request_* methods.
-
- * pygtk-gtk-classes Add pygtk-gtk-constants.xml
-
-2004-04-26 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdk-constants.xml Add.
-
- * pygtk-gdk-classes.xml Add pygtk-gdk-constants.xml to list.
-
- * pygtk-pango-constants.xml Reorganize with a Synopsis and add
- a description for each set of constants.
-
- * pygtk-gobject-constants.xml Add.
-
- * pygtk-gobject-gboxed.xml Add.
-
- * pygtk-gobject-gboxed.xml Remove gobject from Ancestry.
-
- * pygtk-gobject-gboxed.xml Fix typo.
-
- * pygtk-gobject-maincontext.xml Add.
-
- * pygtk-gobject-mainloop.xml Add.
-
- * pygtk-gobject-classes.xml Add pygtk-gobject-gboxed.xml,
- pygtk-gobject-maincontext.xml and pygtk-gobject-mainloop.xml to
- the list of files to be processed.
-
- * pygtk-gobject-maincontext.xml Add description of constructor.
-
- * pygtk-gobject.xml Move Ancestry section ahead of Description.
-
- * pygtk-gobject.xml Add some attribute descriptions.
-
- * pygtk-gobject-gpointer.xml Add.
-
- * pygtk-gtk-constants.xml Add.
-
-2004-04-25 John Finlay <finlay@moeraki.com>
-
- * pygtk-pango-functions.xml Add.
-
- * pygtk-pangolanguage.xml Add pango functions to cover the real
- API pre-PyGTK 2.4.
-
- * pygtk-pango-functions.xml Remove extraneous sections.
-
- * pygtk-gdkscreen.xml ("size-changed") Add description.
-
- * pygtk-gtk-stock-items.xml (gtk.stock_lookup)
- (gtk.stock_list_ids) Add reference links.
-
- * pygtk-pango-markup.xml ("fallback") Add description of this
- attribute type.
-
- * pygtk-pangoattribute.xml Reorder attributes.
-
- * pygtk-pangofontmap.xml (get_shape_engine_type) Add description.
-
- * pygtk-gdk-classes.xml Add new xml files for processing.
-
- * pygtk-gdk-functions.xml Add links to all module functions.
-
- * pygtk-pango-classes.xml Add class references for FontsetSimple
- and pango functions for processing.
-
- * pygtk-pango-constants.xml Add.
-
- * pygtk-pango-classes.xml Add Pango Constants ref.
-
- * pygtk-gdkgc.xml Fix typo.
-
- * pygtk-gdkwindow.xml (get_state) Add to WINDOW_STATE flag list.
-
-2004-04-24 John Finlay <finlay@moeraki.com>
-
- * pygtk-pangoattribute.xml Fix typo. Reorder attributes.
-
- * pygtk-pangoattrlist.xml (filter) Add description of this
- PyGTK 2.4 method.
-
- * pygtk-pangocontext.xml Fix link in Description.
-
- * pygtk-pangofontface.xml (list_sizes) Add desciption of this
- PyGTK 2,4 method.
-
- * pygtk-pangofontfamily.xml (is_monospace) Add description of this
- PyGTK 2.4 method.
-
- * pygtk-pangofontset.xml Fix typo in Description.
- (foreach) Add description of this PyGTK 2.4 method.
-
- * pygtk-pangofontsetsimple.xml Add.
-
-2004-04-23 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkwindow.xml (set_accept_focus) (get_group)
- Add descriptions of these methods.
- (gtk.gdk.window_lookup_for_display)
- (gtk.gdk.window_foreign_new_for_display)
- Add description for these functions.
-
- * pygtk-gdkatom.xml Fix constructor link.
-
- * pygtk-gdkdisplaymanager.xml Fix gdkdisplay link.
-
- * pygtk-gdkkeymap.xml Fix signal links.
- Fix keyval_get_keys link - change to lookup_key method.
- ("keys-changed") Add description of this GTK+ 2.2 signal.
- (gtk.gdk.keyval_to_lower) Fix name.
-
- * pygtk-gdk-functions.xml
- (gtk.gdk.screen_width) (gtk.gdk.screen_height)
- (gtk.gdk.screen_width_mm) (gtk.gdk.screen_height_mm)
- Remove these descriptions - now with GdkWindow.
- Add links to all functions.
-
- * pygtk-gdkwindow.xml Fix links to gtk.Window.set_wmclass method.
- fix reference to gtk.gdk.window_constrain_size function
-
- * pygtk-gdkvisual.xml (visual_get_best_with_type)
- Add missing parameter.
-
- * pygtk-gdkpixbuf.xml (gtk.gdk.pixbuf_new_from_file_at_size)
- Fix parameter name.
-
- * pygtk-gdk-functions.xml Fix reference to gtk.gdk.atom_intern.
- Update the description. Reorder function listing.
-
- * pygtk-gtkvseparator.xml Fix link to constructor.
-
- * pygtk-gtkwindow.xml (gtk.window_set_auto_startup_notification)
- Add description for this PyGTK 2.2 function.
-
- * pygtk-gtkobject.xml (gtk.bindings_activate_event) Add.
- (gtk.bindings_activate) Fix name.
-
- * pygtk-gtk-stock-items.xml (gtk.stock_add)
- (gtk.stock_lookup) (gtk.stock_list_ids) Add description of
- these functions.
-
- * pygtk-gtk-functions.xml Add links to all functions and update
- description.
-
- * pygtk-gtkwindow.xml Fix typo.
-
- * pygtk-gtk-functions.xml Add gtkWidget function links.
-
- * pygtk-pangoattribute.xml (AttrFallback) Add description of this
- PyGTK 2.4 function.
-
- * pygtk-pangoattriter.xml (get_attrs) Add description of this
- PyGTK 2.4 method.
-
-2004-04-22 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkpixbuf.xml
- (gtk.gdk.pixbuf_new_from_data) (gtk.gdk.pixbuf_new_from_array)
- Add descriptions of these PyGTK 2.2 functions.
- (gtk.gdk.pixbuf_new_from_file_at_size)
- (gtk.gdk.pixbuf_get_formats) (gtk.gdk.pixbuf.get_file_info)
- Add descriptions of these PyGTK 2.4 functions.
- ("bits-per-sample"( ("colorspace") ("has-alpha") ("height")
- ("n-channels") ("pixels") ("rowstride") ("width")
- Add descriptions fo these GTK+ 2.4 properties.
-
- * pygtk-gdkpixbuf.xml (gtk.gdk.pixbuf_get_formats) Tweak description.
-
- * pygtk-gdkpixbufloader.xml (set_size) (get_format)
- Add descriptions for these PyGTK 2.4 methods.
- (gtk.gdk.pixbuf_loader_new_with_mime_type)
- Add description for this PyGTK 2.4 function
- ("size-prepared") Add desription of this GTK+ 2.2 signal.
-
- * pygtk-gdkpixmap.xml (gtk.gdk.pixmap_foreign_new_for_display)
- (gtk.gdk.pixmap_lookup_for_display) Add descriptions for these
- PyGTK 2.2 functions.
-
- * pygtk-gdkrectangle.xml (union) Fix typo.
-
- * pygtk-gdkscreen.xml Add.
- Add purpose description.
-
- * pygtk-gdkvisual.xml Reorder attribute list.
- (get_screen) Add desciption of this PyGTK 2.2 method.
- (query_depths) (query_visual_types)
- Add description of these PyGTK 2.4 functions.
-
- * pygtk-gdkwindow.xml (set_keep_above) (set_keep_below)
- (set_skip_taskbar) (set_skip_pager) (set_geometry_hints)
- (get_deskrelative_origin) (set_icon_list)
- (fullscreen) (unfullscreen)
- Add descriptions of these methods.
- (gtk.gdk.window_at_pointer)
- Add description for this function.
-
-2004-04-21 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkgc.xml (get_screen) Add description of this PyGTK 2.2
- method
-
- * pygtk-gdkkeymap.xml (keymap_get_for_display) Add desciption of
- this PyGTK 2.2 function.
- (keyval_convert_case) Add description of this PyGTK 2.4 function.
- (get_entries_for_keyval)
- (get_entries_for_keycode)
- (lookup_key)
- (translate_keyboard_state) Add descriptions of these PyGTK 2.4 methods.
-
- * pygtk-gdkevent.xml (gtk.gdk.KEY_PRESS) Add "hardware_keycode"
- attribute description for PyGTK 2.2. Add "group" attribute
- description for PyGTK 2.4.
-
-2004-04-20 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtk-classes.xml Add pygtk-gtk-stock-items.xml to list
-
- * pygtk-gtk-stock-items.xml Fix reference to stock_network_24.png
- and stock_new_24.png
-
- * pygtk-gdkatom.xml Tweak the description.
-
- * pygtk-gdkcolormap.xml (get_screen) Add description of
- PyGTK 2.4 method.
- (gtk.gdk.colormap_get_system) Add reference to
- gtk.gdk.Screen.get_system_colormap() method.
-
- * pygtk-gdkcursor.xml (get_display) Add description of this
- PyGTK 2.2 method.
- Add descriptions of 2 more constructor signatures for PyGTK 2.4.
-
- * pygtk-gdkdevice.xml Reorder attribute list.
-
- * pygtk-gdkatom.xml (atom_intern) Note that value of
- only_if_exists is ignored.
-
- * pygtk-gdkdisplay.xml Add.
-
- * pygtk-gdkdisplaymanager.xml Add.
-
- * pygtk-gdkdragcontext.xml (find_window_for_screen) Add description
- for this PyGTK 2.2 method.
-
- * pygtk-gdkdrawable.xml (get_screen) (get_display) (draw_pixbuf)
- Add descriptions of these PyGTK 2.2 methods. Update the Description.
-
- * pygtk-gdkdrawable.xml ("xid") ("handle")
- Add attribute descriptions.
-
- * pygtk-gdkevent.xml (get_state) Add note about availability.
- Added description of event masks.
- (gtk.gdk.Event) Added for PyGTK 2.2.
-
- * pygtk-gdkevent.xml (set_screen) (get_screen) Add descriptions of
- these PyGTK 2.2 methods.
-
-2004-04-19 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreeview.xml (expand_to_path) (map_expanded_rows)
- (set_cursor_on_cell)
- Add descriptions of these methods added in PyGTK 2.2
- ("fixed-height-mode") ("even-row-color") ("odd-row-color")
- Add descriptions of these properties.
- Add signal return value descriptions as needed.
-
- * pygtk-gtktreeviewcolumn.xml (set_expand) (get_expand)
- (cell_get_position)
- Add description of these PyGTK 2.4 methods.
- (focus_cell) Add description of this PyGTK 2.2 method.
- ("expand") Add description of this GTK+ 2.4 signal.
-
- * pygtk-gtkuimanager.xml Add.
-
- * pygtk-gtkvbuttonbox.xml Tweak description.
-
- * pygtk-gtkwidget.xml (set_no_show_all) (get_no_show_all)
- (queue_resize_no_redraw) (can_activate_accel)
- (get_clipboard) (get_screen) (has_screen) (get_display)
- (get_root_window)
- Add descriptions of these PyGTK 2.4 methods.
- (gtk.widget_list_style_properties)
- Add description of this PyGTK 2.4 function.
- (get_size_request) Add description.
- (get_accessible) Remove description.
- ("can-activate-accel") ("screen-changed") ("key-release-event")
- Add descriptions for these signals.
-
- * pygtk-gtkwindow.xml (set_screen) (get_screen) (is_active)
- (has_toplevel_focus) (activate_key) (propagate_key_event)
- (fullscreen) (unfullscreen) (set-keep-above) (set-keep-below)
- Add description for these PyGTK 2.2 and 2.4 methods.
- ("accept-focus") ("decorated") ("gravity") ("role")
- ("has-toplevel-focus") ("is-active") ("screen") ("skip-pager-hint")
- (skip-taskbar-hint") ("type-hint")
- Add decriptions for these GTK+ 2.2 adn 2.4 properties.
- (gtk.set_default_icon) (gtk.set_default_icon_from_file)
- Add descriptions of these functions.
-
- * pygtk-gtktoolitem.xml Fix reference to gtk.Button.set_relief()
- method.
-
- * pygtk-gtktoolbar.xml Fix reference to gtk.SeparatorToolItem class.
-
- * pygtk-gtkseparatortoolitem.xml Fix reference to
- gtk.SeparatorToolItem class.
-
- * pygtk-gtkscale.xml Fix reference to get_layout_offsets() method.
-
- * pygtk-gtknotebook.xml Fix formatting error.
-
- * pygtk-gtk-classes.xml Add missing pygtk-gtkiconinfo.xml include.
-
- * pygtk-gtkwindow.xml Fix references to gtk.Widget
- "window-state-event" signal.
-
- * pygtk-gdkatom.xml Fix reference to gtk.atom_intern() constructor.
-
- * pygtk-gtkwidget.xml Fix reference to
- gtk.widget_set_default_direction() function. Fix references and id
- for gtk.widget_list_style_properties function.
-
- * pygtk-gtkicontheme.xml Fix reference to gtk.pixbuf_new_from_inline
- function.
-
- * pygtk-gtk-stock-items.xml Add.
-
-2004-04-18 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreemodelfilter.xml Add.
-
- * pygtk-gtktreemodelsort.xml (iter_is_valid) Add description of
- PyGTK 2.2 method.
-
- * pygtk-gtktreerowreference.xml Add.
-
- * pygtk-gtktreeselection.xml (get_selected_rows)
- (count_selected_rows) (unselect_range) Add new methods for PyGTK 2.2
-
- * pygtk-gtktreestore.xml (iter_is_valid) (reorder) (swap)
- (move_after) (move_before) Add descriptions for these PyGTK 2.2
- methods.
-
-2004-04-17 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktoolbutton.xml Add.
-
- * pygtk-gtktoolitem.xml Add.
-
- * pygtk-gtktoolitem.xml (set_tooltip) tip_text and tip_private can
- default to None.
-
- * pygtk-gtkwindow.xml (tooltips_get_info_from_tip_window) Add
- description of PyGTK 2.4 method.
-
- * pygtk-gtktreeiter.xml Add class info for TreeIter creation methods.
-
- * pygtk_gtktreemodel.xml (filter_new) Add description of new
- PyGTK 2.4 method.
-
-2004-04-16 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtksocket.xml ("plug-removed") Add return value description
- for this signal handler.
-
- * pygtk-gtkspinbutton.xml ("input") ("output") Add return value
- descriptions. Reorder property descriptions.
-
- * pygtk-gtkspinbutton.xml ("input") ("output") Fix typos.
-
- * pygtk-gtkstatusbar.xml ("has-resize-grip") Add GTK+ 2.4 property
- description.
-
- * pygtk-gtk-functions.xml (gtk.draw_insertion_cursor) Add.
-
- * pygtk-gtktable.xml (attach_defaults) Remove - it's deprecated.
- Reorder property descriptions.
-
- * pygtk-gtktextbuffer.xml (create_tag) Remove keyword role.
- (select_range) (add_selection_clipboard) (remove_selection_clipboard)
- (cut_clipboard) (copy_clipboard) (paste_clipboard) Add for PyGTK 2.4
-
- * pygtk-gtktextiter.xml (forward_visible_word_end)
- (backward_visible_word_start) (forward_visible_word_ends)
- (backward_visible_word_starts) Add descriptions for PyGTK 2.4
-
- * pygtk-gtktexttag.xml Reorder property descriptions.
- ("event") Add return value description.
-
- * pygtk-gtktexttagtable.xml (foreach) Add description for PyGTK 2.4
-
- * pygtk-gtkaccelgroup.xml
- pygtk-gtkpaned.xml
- pygtk-gtkscrolledwindow.xml
- pygtk-gtkspinbutton.xml
- pygtk-gtktreeview.xml
- pygtk-gtkwidget.xml
- pygtk-gtkwindow.xml Make keycombos simultaneous.
-
- * pygtk-gtktextview.xml ("move-viewport") ("select-all") Add
- descriptions of these signals for GTK+ 2.4 and 2.2.
- ("accepts-tab") ("overwrite") Add descriptions of these GTK+ 2.4
- properties.
- (set_accepts_tab) (get_accepts_tab) (set_overwrite) (get_overwrite)
- Add descriptions of these PyGTK 2,4 methods.
-
- * pygtk-gtktoggleaction.xml Add.
-
- * pygtk-gtktoggletoolbutton.xml Add.
-
- * pygtk-gtktoolbar.xml Add new GTK+ 2.4 method descriptions.
- Add deprecation warnings for old toolbar methods.
-
-2004-04-15 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkmessagedialog.xml (set_markup) Add description of this
- PyGTK 2.4 method.
-
- * pygtk-gtknotebook.xml (get_n_pages) Add description.
- Add GTK+2.4 style properties
- Add return value description for "focus-tab" and "select-page"
- signals.
-
- * pygtk-gtkoptionmenu.xml Added deprecation warning for PyGTK 2.4
-
- * pygtk-gtkpaned.xml (get_child1) (get_child2) Add descriptions of
- these PyGTK 2.4 methods.
- ("max-position") ("min-position") Add descriptions of these GTK+ 2.4
- properties.
- ("resize") ("shrink") Add descriptions of these GTK+ 2.4 child
- properties.
- Add return value description for signals.
-
- * pygtk-gtkplug.xml (gtk.plug_new_for_display) Add description.
- (construct) Add warning - method not available since PyGTK 2.2
-
- * pygtk-gtkradioaction.xml Add.
-
- * pygtk-gtkradiobutton.xml Add description of "group-changed" signal
- for GTK+ 2.4
-
- * pygtk-gtkradiomenuitem.xml Add description of "group-changed" signal
- for GTK+ 2.4
-
- * pygtk-gtkradioaction.xml Fix description of "group" property.
-
- * pygtk-gtkradiotoolbutton.xml Add.
-
- * pygtk-gtkrange.xml Reorder property descriptions.
-
- * pygtk-gtkrcstyle.xml Add gtk.rc_reset_style() function for PyGTK 2.4
-
- * pygtk-gtkscale.xml (get_layout) (get_layout_offsets) Add
- descriptions for PyGTK 2.4
-
- * pygtk-gtkscrollbar.xml Reorder property descriptions.
-
- * pygtk-gtkscrolledwindow.xml Add "scrollbar-spacing" style property
- available in GTK+ 2.2
-
- * pygtk_gtkselectiondata.xml Add function description of
- gtk.selection_owner_set_for_display().
-
- * pygtk_gtkseparatortoolitem.xml Add. Add purpose description
-
- * pygtk-gtksettings.xml (gtk.settings_get_for_screen) Add description.
- Add various properties for GTK+ 2.2 and 2.4
-
-2004-04-14 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkiconsource.xml Add gtk.icon_size_lookup_for_settings()
- function.
-
- * pygtk-gdkpixmap.xml Fix description and parameter list of
- gtk.pixmap_create_from_data() function.
-
- * pygtk-gtkicontheme.xml Add.
-
- * pygtk-gtkiconinfo.xml Add.
-
- * pygtk-gtkinvisible.xml Add the set_screen() and get_screen() methods
- available in PyGTK 2.2
-
- * pygtk-gtkitemfactory.xml Add deprecation warning.
-
- * pygtk-gtklabel.xml Fix typo.
-
- * pygtk-gtkliststore.xml (set_column_types)
- (iter_is_valid) (reorder) (swap) (move_after) (move_before) Add
- descriptions for these methods.
-
- * pygtk-gtkmenu.xml (set_screen) (attach) (set_monitor) Add
- descriptions for these methods.
-
- * pygtk-gtkmenu.xml ("move-scroll") Add description for this GTK+ 2.2
- signal. Add descriptions for the style and child properties added in
- GTK+ 2.4
-
- * pygtk-gtkmenuitme.xml ("toggle-size-allocate") Fix typo.
-
- * pygtk-gtkmenushell.xml (select_first) (cancel) Add descriptions
- for these methods in PyGTK 2.2 and 2.4 respectively.
-
-2004-04-13 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkexpander.xml Add.
-
- * pygtk-gtkimcontext.xml Add return value description for
- "delete-surrounding" and "retrieve-surrounding" signals.
-
- * pygtk-gtkclipboard.xml Add the request_* and wait_for_targets
- method descriptions.
-
-2004-04-10 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkactiongroup.xml (add_toggle_actions) Add description of
- is_active item in toggle action tuple.
- (add_radio_actions) Add description of value and on_change parameters.
- Remove callback description from radio action tuple.
-
- * pygtk-gdkatom.xml Add.
-
- * pygtk-gdk-functions.xml (atom_intern) Remove.
- Fix dumb error.
-
- * pygtk-gtkclipboard.xml Add.
-
- * pygtk-gdk-classes.xml Add pygtk-gdkatom.xml.
- Hide unimplemented new classes
-
- * pygtk-gtk-classes Hide unimplemented new classes
-
- * pygtk-gtkaccelgroup.xml
- * pygtk-gtkbutton.xml
- * pygtk-gtkentrycompletion.xml
- * pygtk-gtkfilechooserdialog.xml
- * pygtk-gtkfontselectiondialog.xml
- * pygtk-gtkgenericcellrenderer.xml
- * pygtk-gdkatom.xml Fix some link errors.
-
-2004-04-09 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkaction.xml Add.
-
- * pygtk-gtkactiongroup.xml Add.
-
- * pygtk-gtkborder.xml Add.
-
-2004-04-08 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkfilefilter.xml Fix links to get_needed() method. Fix custom
- function signature and description.
-
- * pygtk-gtkfontbutton.xml Add.
-
- * pygtk-gtkfontbutton.xml Add purpose description. Fix
- GtkFontSelectionDialog links.
-
- * pygtk-gtkfontselectiondialog.xml Add note about lack of font filters,
- etc. in GTK+ 2.2 and above.
-
- * pygtk-gtkhandlebox.xml Add "snap-edge-set" property description.
- GTK+ 2.2 and above.
-
- * pygtk-gtkhbuttonbox.xml Tweak the description.
-
-2004-04-07 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkfilechooser.xml Add.
- * pygtk-gtkfilechooserdialog.xml Add.
- * pygtk-gtkfilechooserwidget.xml Add.
- * pygtk-gtkfilefilter.xml Add.
-
- * pygtk-gtkfilefilter.xml (add_custom) Doesn't take keyword args.
-
-2004-04-06 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkeventbox.xml Add new methods: set_visible_window(),
- get_visible_window(), set_above_child() and get_above_child(); and
- properties: "above-child" and "visible-window" for PyGTK 2.4 and
- GTK+ 2.4.
-
-2004-04-05 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcomboboxentry.xml Add.
-
- * pygtk-gtkcontainer.xml Fix bug in synopsis of get_focus_chain().
-
- * pygtk-gtkcontainer.xml Property "child" is read-only.
-
- * pygtk-gtkdrawingarea.xml Tweak the description.
-
- * pygtk-gtkcombobox.xml
- * pygtk-gtkcomboboxentry.xml Add gtk.CellLayout to class synopsis.
-
- * pygtk-gtkeditable.xml Tweak description to specify it's an interface.
-
- * pygtk-gtkentry.xml Add PyGTK 2,4 methods set_alignment(),
- get_alignment(), set_completion(), get_completion(). Also add GTK+2.4
- property "xalign"
-
- * pygtk-gtkentrycompletion.xml Add.
-
-2004-04-04 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcombobox.xml Add.
-
- * pygtk-gtkcelllayout.xml. Add.
-
-2004-04-03 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcheckbutton.xml Fix formatting of Ancestry description.
-
- * pygtk-gtkcheckmenuitem.xml Minor reformatting.
-
- * pygtk-gtkcolorbutton.xml Add description of GtkColorButton in
- GTK+ 2.4 and PyGTK 2.4.
-
- * pygtk-gtkcombo.xml Added deprecation warning for PyGTK 2.4.
-
-2004-04-02 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkbutton.xml Added descriptions of "focus-on-click", "xalign"
- and "yalign" propertiees for GTK+ 2.4. Added descriptions of the
- set_alignment(), get_alignment(), set_focus_on_click() and
- get_focus_on_click() methods available in PyGTK 2.4
-
- * pygtk-gtkbuttonbox.xml Add description of get_child_secondary()
- method available in PyGTK 2.4.
-
- * pygtk-gtkcalendar.xml Add descriptions of get_display_options() and
- set_display_options() methods available in PyGTK 2.4. Add deprecation
- warning for display_options() method.
-
- * pygtk-gtkcellrenderer.xml Add description of editing_canceled()
- method available in PyGTK 2.4. Add description of "editing-canceled"
- signal available in GTK+ 2.4.
-
-2004-04-01 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkaccelgroup.xml Added descriptions of connect_by_path()
- method, and accel_map_add_entry(), accel_map_lock_path and
- accel_map_unlock_path() functions.
-
- * pygtk-gtkalignment.xml Fix small bug in get_padding() description.
-
-2004-03-31 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkalignment.xml Add description of set_padding() and
- get_padding() methods available in PyGTK 2.4
-
-2004-03-30 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkcellrenderertoggle.xml Add description of "inconsistent"
- property added in GTK+ 2.2. Update other property descriptions.
-
- * pygtk-gtkcheckmenuitem.xml Add description of "draw-as-radio"
- property fro GTK+ 2.4 and add PyGTK2.4 methods set_draw_as_radio() and
- get_draw_as_radio().
-
-2004-03-29 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkaccelgroup.xml Add documentation on the connect() method.
- Add a description of the return value for the "accel-activate" signal.
-
- * pygtk-gtkadjustment.xml Add description of properties available in
- GTK+2.4. Reformat the Attributes description.
-
- * pygtk-gtkalignment.xml Add description of padding properties
- available in GTK+ 2.4.
-
- * pygtk-gtkaccessible.xml Added one line description.
-
- * pygtk-gtkcalendar.xml Added description of properties available in
- GTK+2.4.
-
- * pygtk-gtkcellrenderertext.xml Added description of properties
- available in GTK+2.4.
-
-2004-03-25 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkwindow.xml Remove description of atom_intern function.
-
- * pygtk-gdk-function.xml Add description of atom_intern function. Fixes
- #137935 (thanks to Erik Grinaker).
-
- * pygtk-gtkdrawingarea.xml Add explanation that drawing is done on the
- contained gtk.gdk.Window using the gdk.Drawable methods. Fixes #136297.
- (thanks to pachi@mmn-arquitectos.com)
-
-2004-03-22 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkmessagedialog.xml (MessageDialog) Remove
- gtk.DIALOG_NO_SEPARATOR from the list of valid flags. Fixes #136984.
- (thanks to j.jordens and Eric Grinaker).
-
-2004-04-13 Erik Grinaker <erikg@wired-networks.net>
-
- * pygtk-gdkwindow.xml (raise): Changed name of raise() to
- raise_(), and added a note to explain this is because
- raise is a reserved Python keyword.
-
-2004-01-28 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktogglebutton.xml (get_mode)
- (set_mode) Clarify the use of these methods as applied to checkbuttons
- and radiobuttons and the results. (thanks to Antonio A. A.)
-
- * pygtk2-ref.xml Change date. Version number to 1.9
-
-2003-11-18 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtktreemodel.xml (foreach) Add description of function
- signature.
-
-
-2003-10-07 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Change date. Version number to 1.8
-
- * pygtk-gtkcellrenderertext.xml Fix signature an ddescription of the
- "edited" signal to add path and new_text arguments. (thanks to Steve
- Chaplin)
-
- * pygtk-gtkcellrenderertoggle.xml Fix signature and description of
- "toggled" signal to add path argument. (thanks to Steve Chaplin)
-
-2003-08-25 John Finlay <finlay@moeraki.com>
-
- * pygtk-gtkadjustment.xml (set_all) Remove deprecation note and add
- keyword designations.
-
- * pygtk-gdkpixbufloader.xml (write) Set initializer on parameter count
- and change description to indicate how count is used.
-
- * pygtk-gtktextbuffer.xml (create_tag) tag_name defaults to None.
-
-2003-08-23 John Finlay <finlay@moeraki.com>
-
- * pygtk-gdkpixbuf.xml Note that pixel_array attribute array contents
- can be changed.
-
- * pygtk-gdk-functions.xml (threads_init) Remove comments about broken
- threads imiplementation which is now fixed in 1.99.17+.
-
- * pygtk-gtktreemodel.xml (rows_reordered) Add description of this
- method.
-
- * pygtk-gtktreeview.xml (enable_model_drag_source)
- (emable_model_drag_dest)
- (get_drag_dest_row)
- (get_dest_row_at_pos)
- (enable_model_drag_source)
- (enable_model_drag_dest) Add descriptions of these methods.
-
- * pygtk-gtkwidget.xml (drag_source_set) Fix typo.
-
- * pygtk-gtkdialog.xml (add_buttons) Add description of this method.
-
- * pygtk-gobject.xml (handler_is_connected) Add description of this
- method.
-
- * pygtk2-ref.xml Change date. Version number to 1.7
-
- * pygtk-gtkdialog.xml (add_buttons) Fix typo in synopsis.
-
- * pygtk-gobject.xml (handler_is_connected) Fix link in synopsis.
-
- * pygtk-gdkwindow.xml Fix link references to
- function-gdk--window-foreign-new and function-gdk--visual-get-system.
-
-2003-07-20 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Change date. Version number to 1.6
-
- * pygtk-gdkwindow.xml (gtk.gdk.Window) Add documentation on the
- constructor.
-
-2003-07-17 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Change date and version number to 1.5.
-
- * pygtk-gtkeditable.xml Remove extraneous "widget" parameter from
- "insert-text" signal description. Add description indicating position
- can't be retrieved in PyGTK.
-
-2003-07-16 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Change date and version number to 1.4.
-
- * pygtk-gtkitmefactory.xml (gtk.ItemFactory)
- (construct) Change container_type to refer to PyGTK types: gtk.Menu,
- gtk.MenuBar and gtk.OptionMenu.
-
-2003-07-15 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.html Change to version 1.3
-
- * pygtk-gtkliststore.xml (insert)
- (insert_after)
- (insert_before)
- (prepend)
- (append) Add an entry for the return value for these methods.
-
- * pygtk-gtktoolbar.xml (insert_stock) Remove extraneous stock_id entry.
-
-2003-07-12 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.html Change version number.
-
- * pygtk-pangoattriter.xml Change to pango.AttrIterator to match
- GTK+and PyGTK naming.
-
- * pygtk-pangoattrlist.xml (get_iterator) Change to reference
- pango.AttrIterator.
-
-2003-07-11 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Change date tag to pubdate tag so it will be
- displayed.
-
- * pygtk-pangolayout.xml Correct the references to the Pango Markup
- Language reference page.
-
- * pygtk-gtk-functions.xml Fix incorrect reference to gtk.Object class.
-
- * pygtk-gtktextview.xml Remove reference to pango.TabArray.free
-
- * Pango Add content to pango class files (they were empty):
- pygtk-pangoattribute.xml
- pygtk-pangoattriter.xml
- pygtk-pangoattrlist.xml
- pygtk-pangocolor.xml
- pygtk-pangocontext.xml
- pygtk-pangofontdescription.xml
- pygtk-pangofontface.xml
- pygtk-pangofontfamily.xml
- pygtk-pangofontmap.xml
- pygtk-pangofontmetrics.xml
- pygtk-pangofontset.xml
- pygtk-pangofont.xml
- pygtk-pangoglyphstring.xml
- pygtk-pangolanguage.xml
- pygtk-pangolayout.xml
- pygtk-pango-markup.xml
- pygtk-pangotabarray.xml
-
- * pygtk-pango-classes.xml Add include for:
- pygtk-pangoattribute.xml
- pygtk-pangoattriter.xml
- pygtk-pango-markup.xml
-
- * pygtk2-ref.html Update date and version number. Add pango class
- reference chapter.
-
-2003-07-10 John Finlay <finlay@moeraki.com>
-
- * Pango Add pango class files:
- pygtk-pangoattribute.xml
- pygtk-pangoattriter.xml
- pygtk-pangoattrlist.xml
- pygtk-pangocolor.xml
- pygtk-pangocontext.xml
- pygtk-pangofontdescription.xml
- pygtk-pangofontface.xml
- pygtk-pangofontfamily.xml
- pygtk-pangofontmap.xml
- pygtk-pangofontmetrics.xml
- pygtk-pangofontset.xml
- pygtk-pangofont.xml
- pygtk-pangoglyphstring.xml
- pygtk-pangolanguage.xml
- pygtk-pangolayout.xml
- pygtk-pango-markup.xml
- pygtk-pangotabarray.xml
-
- * ChangeLog Add this change log
-
- * pygtk2-ref.xml Include ChangeLog info in reference.
-
- * pygtk-gtkliststore.xml (insert)
- (insert_before)
- (insert_after)
- (prepend)
- (append) Fix description of row arg to be a sequence of values.
-
- * pygtk-gtktreestore.xml (insert)
- (insert_before)
- (insert_after)
- (prepend)
- (append) Fix description of row arg to be a sequence of values.
-
-2003-07-02 John Finlay <finlay@moeraki.com>
-
- * pygtk2-ref.xml Update date.
-
- * pygtk-gdk-functions.xml (gtk.gdk.threads_init) Update
- description of thread support.
-
- * ChangeLog Add change log.
diff --git a/docs/reference/entities.docbook.in b/docs/reference/entities.docbook.in
deleted file mode 100644
index be788f85..00000000
--- a/docs/reference/entities.docbook.in
+++ /dev/null
@@ -1 +0,0 @@
-<!ENTITY version "@PACKAGE_VERSION@">
diff --git a/docs/reference/pygtk-atk-classes.xml b/docs/reference/pygtk-atk-classes.xml
deleted file mode 100644
index eb5f9f6c..00000000
--- a/docs/reference/pygtk-atk-classes.xml
+++ /dev/null
@@ -1,34 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<chapter id="atk-class-reference" xmlns:xi="http://www.w3.org/2001/XInclude">
- <title>The atk Class Reference</title>
-
-<!-- ATK OBJECTS -->
-
- <xi:include href="pygtk-atkaction.xml"/>
- <xi:include href="pygtk-atkcomponent.xml"/>
- <xi:include href="pygtk-atkdocument.xml"/>
- <xi:include href="pygtk-atkeditabletext.xml"/>
- <xi:include href="pygtk-atkgobjectaccessible.xml"/>
- <xi:include href="pygtk-atkhyperlink.xml"/>
- <xi:include href="pygtk-atkhypertext.xml"/>
- <xi:include href="pygtk-atkimage.xml"/>
- <xi:include href="pygtk-atkimplementor.xml"/>
- <xi:include href="pygtk-atknoopobject.xml"/>
- <xi:include href="pygtk-atknoopobjectfactory.xml"/>
- <xi:include href="pygtk-atkobject.xml"/>
- <xi:include href="pygtk-atkobjectfactory.xml"/>
- <xi:include href="pygtk-atkrectangle.xml"/>
- <xi:include href="pygtk-atkregistry.xml"/>
- <xi:include href="pygtk-atkrelation.xml"/>
- <xi:include href="pygtk-atkrelationset.xml"/>
- <xi:include href="pygtk-atkselection.xml"/>
- <xi:include href="pygtk-atkstateset.xml"/>
- <xi:include href="pygtk-atkstreamablecontent.xml"/>
- <xi:include href="pygtk-atktable.xml"/>
- <xi:include href="pygtk-atktext.xml"/>
- <xi:include href="pygtk-atkvalue.xml"/>
- <xi:include href="pygtk-atk-constants.xml"/>
-
-</chapter>
diff --git a/docs/reference/pygtk-atk-constants.xml b/docs/reference/pygtk-atk-constants.xml
deleted file mode 100644
index 4ef98642..00000000
--- a/docs/reference/pygtk-atk-constants.xml
+++ /dev/null
@@ -1,1464 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="atk-constants">
- <refnamediv>
- <refname>atk Constants</refname>
- <refpurpose>the built-in constants of the atk module</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <programlisting>
-<xref linkend="atk-coord-type-constants" endterm="atk-coord-type-constants-title"></xref>
-<xref linkend="atk-layer-constants" endterm="atk-layer-constants-title"></xref>
-<xref linkend="atk-relation-type-constants" endterm="atk-relation-type-constants-title"></xref>
-<xref linkend="atk-role-constants" endterm="atk-role-constants-title"></xref>
-<xref linkend="atk-state-type-constants" endterm="atk-state-type-constants-title"></xref>
-<xref linkend="atk-text-attr-constants" endterm="atk-text-attr-constants-title"></xref>
-<xref linkend="atk-text-boundary-constants" endterm="atk-text-boundary-constants-title"></xref>
-<xref linkend="atk-text-clip-type-constants" endterm="atk-text-clip-type-constants-title"></xref>
-</programlisting>
-
- </refsect1>
-
- <refsect1 id="atk-constants-description">
- <title>Description</title>
-
- <refsect2 id="atk-coord-type-constants">
- <title id="atk-coord-type-constants-title">Atk Coord Type Constants</title>
-
- <para>The Atk Coord Type constants specify how xy coordinates are to
- be interpreted. Used by methods such as <link
- linkend="method-atkcomponent--get-position"><methodname>atk.Component.get_position</methodname>()</link>
- and <link
- linkend="method-atktext--get-character-extents"><methodname>atk.Text.get_character_extents</methodname>()</link></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>atk.XY_SCREEN</literal></term>
- <listitem>
- <simpara>specifies xy coordinates relative to the
- screen</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.XY_WINDOW</literal></term>
- <listitem>
- <simpara>specifies xy coordinates relative to the widget's
- top-level window</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="atk-layer-constants">
- <title id="atk-layer-constants-title">Atk Layer Constants</title>
-
- <para>The Atk Layer constants specify the layer of a component. These
- enumerated "layer values" are used when determining which UI rendering
- layer a component is drawn into, which can help in making
- determinations of when components occlude one another.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>atk.LAYER_INVALID</literal></term>
- <listitem>
- <simpara>The object does not have a layer</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.LAYER_BACKGROUND</literal></term>
- <listitem>
- <simpara>This layer is reserved for the desktop
- background</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.LAYER_CANVAS</literal></term>
- <listitem>
- <simpara>This layer is used for Canvas components</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.LAYER_WIDGET</literal></term>
- <listitem>
- <simpara>This layer is normally used for components</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.LAYER_MDI</literal></term>
- <listitem>
- <simpara>This layer is used for layered components</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.LAYER_POPUP</literal></term>
- <listitem>
- <simpara>This layer is used for popup components, such as
- menus</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.LAYER_OVERLAY</literal></term>
- <listitem>
- <simpara>This layer is reserved for future use.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.LAYER_WINDOW</literal></term>
- <listitem>
- <simpara>This layer is used for toplevel windows.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="atk-relation-type-constants">
- <title id="atk-relation-type-constants-title">Atk Relation Type Constants</title>
-
- <para>The Atk Relation Type constants specify the type of the
- relation.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>atk.RELATION_NULL</literal></term>
- <listitem>
- <simpara> Not used, represents "no relationship" or an error
- condition. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_CONTROLLED_BY</literal></term>
- <listitem>
- <simpara> Indicates an object controlled by one or more target
- objects. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_CONTROLLER_FOR</literal></term>
- <listitem>
- <simpara> Indicates an object is an controller for one or more
- target objects. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_LABEL_FOR</literal></term>
- <listitem>
- <simpara> Indicates an object is a label for one or more target
- objects. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_LABELLED_BY</literal></term>
- <listitem>
- <simpara> Indicates an object is labelled by one or more target
- objects. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_MEMBER_OF</literal></term>
- <listitem>
- <simpara> Indicates an object is a member of a group of one or
- more target objects. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_NODE_CHILD_OF</literal></term>
- <listitem>
- <simpara> Indicates an object is a cell in a treetable which is
- displayed because a cell in the same column is expanded and
- identifies that cell. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_FLOWS_TO</literal></term>
- <listitem>
- <simpara> Indicates that the object has content that flows
- logically to another <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- in a sequential way, (for instance text-flow). </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_FLOWS_FROM</literal></term>
- <listitem>
- <simpara> Indicates that the object has content that flows
- logically from another <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- in a sequential way, (for instance text-flow). </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_SUBWINDOW_OF</literal></term>
- <listitem>
- <simpara> Indicates a subwindow attached to a component but
- otherwise has no connection in the UI hierarchy to that
- component. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_EMBEDS</literal></term>
- <listitem>
- <simpara> Indicates that the object visually embeds another
- object's content, i.e. this object's content flows around
- another's content. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_EMBEDDED_BY</literal></term>
- <listitem>
- <simpara> Inverse of <literal>atk.RELATION_EMBEDS</literal>,
- indicates that this object's content is visualy embedded in
- another object. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_POPUP_FOR</literal></term>
- <listitem>
- <simpara>Indicates that an object is a popup for another
- object.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_PARENT_WINDOW_OF</literal></term>
- <listitem>
- <simpara> Indicates that an object is a parent window of another
- object. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.RELATION_LAST_DEFINED</literal></term>
- <listitem>
- <simpara> Not used, this value indicates the end of the
- enumeration. </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="atk-role-constants">
- <title id="atk-role-constants-title">Atk Role Constants</title>
-
- <para>The Atk Role constants describes the role of an object. These
- are the built-in enumerated roles that UI components can have in
- ATK. Other roles may be added at runtime, so an AtkRole >=
- <literal>atk.ROLE_LAST_DEFINED</literal> is not necessarily an
- error.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>atk.ROLE_INVALID</literal></term>
- <listitem>
- <simpara>Invalid role</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_ACCEL_LABEL</literal></term>
- <listitem>
- <simpara>A label which represents an accelerator</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_ALERT</literal></term>
- <listitem>
- <simpara>An object which is an alert to the user</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_ANIMATION</literal></term>
- <listitem>
- <simpara>An object which is an animated image</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_ARROW</literal></term>
- <listitem>
- <simpara>An arrow in one of the four cardinal directions</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_CALENDAR</literal></term>
- <listitem>
- <simpara> An object that displays a calendar and allows the user
- to select a date </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_CANVAS</literal></term>
- <listitem>
- <simpara> An object that can be drawn into and is used to trap
- events </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_CHECK_BOX</literal></term>
- <listitem>
- <simpara> A choice that can be checked or unchecked and provides
- a separate indicator for the current state </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_CHECK_MENU_ITEM</literal></term>
- <listitem>
- <simpara>A menu item with a check box</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_COLOR_CHOOSER</literal></term>
- <listitem>
- <simpara>A specialized dialog that lets the user choose a
- color</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_COLUMN_HEADER</literal></term>
- <listitem>
- <simpara>The header for a column of data</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_COMBO_BOX</literal></term>
- <listitem>
- <simpara>A list of choices the user can select from</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_DATE_EDITOR</literal></term>
- <listitem>
- <simpara>An object whose purpose is to allow a user to edit a
- date</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_DESKTOP_ICON</literal></term>
- <listitem>
- <simpara>An inconifed internal frame within a
- DESKTOP_PANE</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_DESKTOP_FRAME</literal></term>
- <listitem>
- <simpara> A pane that supports internal frames and iconified
- versions of those internal frames </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_DIAL</literal></term>
- <listitem>
- <simpara>An object whose purpose is to allow a user to set a
- value</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_DIALOG</literal></term>
- <listitem>
- <simpara>A top level window with title bar and a border</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_DIRECTORY_PANE</literal></term>
- <listitem>
- <simpara> A pane that allows the user to navigate through and
- select the contents of a directory </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_DRAWING_AREA</literal></term>
- <listitem>
- <simpara> An object used for drawing custom user interface
- elements </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_FILE_CHOOSER</literal></term>
- <listitem>
- <simpara>A specialized dialog that lets the user choose a
- file</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_FILLER</literal></term>
- <listitem>
- <simpara>A object that fills up space in a user
- interface</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_FONT_CHOOSER</literal></term>
- <listitem>
- <simpara>A specialized dialog that lets the user choose a
- font</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_FRAME</literal></term>
- <listitem>
- <simpara> A top level window with a title bar, border, menubar,
- etc. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_GLASS_PANE</literal></term>
- <listitem>
- <simpara> A pane that is guaranteed to be painted on top of all
- panes beneath it </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_HTML_CONTAINER</literal></term>
- <listitem>
- <simpara> A document container for HTML, whose children
- represent the document content </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_ICON</literal></term>
- <listitem>
- <simpara> A small fixed size picture, typically used to decorate
- components </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_IMAGE</literal></term>
- <listitem>
- <simpara> An object whose primary purpose is to display an image
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_INTERNAL_FRAME</literal></term>
- <listitem>
- <simpara>A frame-like object that is clipped by a desktop
- pane</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_LABEL</literal></term>
- <listitem>
- <simpara> An object used to present an icon or short string in
- an interface </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_LAYERED_PANE</literal></term>
- <listitem>
- <simpara> A specialized pane that allows its children to be
- drawn in layers, providing a form of stacking order </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_LIST</literal></term>
- <listitem>
- <simpara> An object that presents a list of objects to the user
- and allows the user to select one or more of them </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_LIST_ITEM</literal></term>
- <listitem>
- <simpara>An object that represents an element of a
- list</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_MENU</literal></term>
- <listitem>
- <simpara> An object usually found inside a menu bar that
- contains a list of actions the user can choose from </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_MENU_BAR</literal></term>
- <listitem>
- <simpara> An object usually drawn at the top of the primary
- dialog box of an application that contains a list of menus the
- user can choose from </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_MENU_ITEM</literal></term>
- <listitem>
- <simpara> An object usually contained in a menu that presents an
- action the user can choose </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_OPTION_PANE</literal></term>
- <listitem>
- <simpara> A specialized pane whose primary use is inside a
- DIALOG </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_PAGE_TAB</literal></term>
- <listitem>
- <simpara> An object that is a child of a page tab list
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_PAGE_TAB_LIST</literal></term>
- <listitem>
- <simpara> An object that presents a series of panels (or page
- tabs), one at a time, through some mechanism provided by the
- object </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_PANEL</literal></term>
- <listitem>
- <simpara>A generic container that is often used to group
- objects</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_PASSWORD_TEXT</literal></term>
- <listitem>
- <simpara> A text object uses for passwords, or other places
- where the text content is not shown visibly to the user
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_POPUP_MENU</literal></term>
- <listitem>
- <simpara> A temporary window that is usually used to offer the
- user a list of choices, and then hides when the user selects one
- of those choices </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_PROGRESS_BAR</literal></term>
- <listitem>
- <simpara> An object used to indicate how much of a task has been
- completed </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_PUSH_BUTTON</literal></term>
- <listitem>
- <simpara> An object the user can manipulate to tell the
- application to do something </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_RADIO_BUTTON</literal></term>
- <listitem>
- <simpara> A specialized check box that will cause other radio
- buttons in the same group to become unchecked when this one is
- checked </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_RADIO_MENU_ITEM</literal></term>
- <listitem>
- <simpara> A check menu item which belongs to a group. At each
- instant exactly one of the radio menu items from a group is
- selected</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_ROOT_PANE</literal></term>
- <listitem>
- <simpara> A specialized pane that has a glass pane and a layered
- pane as its children </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_ROW_HEADER</literal></term>
- <listitem>
- <simpara>The header for a row of data</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_SCROLL_BAR</literal></term>
- <listitem>
- <simpara> An object usually used to allow a user to
- incrementally view a large amount of data. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_SCROLL_PANE</literal></term>
- <listitem>
- <simpara> An object that allows a user to incrementally view a
- large amount of information </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_SEPARATOR</literal></term>
- <listitem>
- <simpara> An object usually contained in a menu to provide a
- visible and logical separation of the contents in a menu
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_SLIDER</literal></term>
- <listitem>
- <simpara> An object that allows the user to select from a
- bounded range </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_SPLIT_PANE</literal></term>
- <listitem>
- <simpara> A specialized panel that presents two other panels at
- the same time </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_SPIN_BUTTON</literal></term>
- <listitem>
- <simpara> An object used to get an integer or floating point
- number from the user </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_STATUSBAR</literal></term>
- <listitem>
- <simpara> An object which reports messages of minor importance
- to the user </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TABLE</literal></term>
- <listitem>
- <simpara> An object used to represent information in terms of
- rows and columns </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TABLE_CELL</literal></term>
- <listitem>
- <simpara>A cell in a table</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TABLE_COLUMN_HEADER</literal></term>
- <listitem>
- <simpara>The header for a column of a table</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TABLE_ROW_HEADER</literal></term>
- <listitem>
- <simpara>The header for a row of a table</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TEAR_OFF_MENU_ITEM</literal></term>
- <listitem>
- <simpara>A menu item used to tear off and reattach its
- menu</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TERMINAL</literal></term>
- <listitem>
- <simpara>An object that represents an accessible
- terminal</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TEXT</literal></term>
- <listitem>
- <simpara>An object that presents text to the user</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TOGGLE_BUTTON</literal></term>
- <listitem>
- <simpara> A specialized push button that can be checked or
- unchecked, but does not provide a separate indicator for the
- current state </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TOOL_BAR</literal></term>
- <listitem>
- <simpara> A bar or palette usually composed of push buttons or
- toggle buttons </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TOOL_TIP</literal></term>
- <listitem>
- <simpara>An object that provides information about another
- object</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TREE</literal></term>
- <listitem>
- <simpara> An object used to represent hierarchical information
- to the user </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_TREE_TABLE</literal></term>
- <listitem>
- <simpara> An object capable of expanding and collapsing rows as
- well as showing multiple columns of data </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_UNKNOWN</literal></term>
- <listitem>
- <simpara> The object contains some Accessible information, but
- its role is not known </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_VIEWPORT</literal></term>
- <listitem>
- <simpara>An object usually used in a scroll pane</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_WINDOW</literal></term>
- <listitem>
- <simpara>A top level window with no title or border.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_HEADER</literal></term>
- <listitem>
- <simpara>An object that serves as a document header.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_FOOTER</literal></term>
- <listitem>
- <simpara>An object that serves as a document footer.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_PARAGRAPH</literal></term>
- <listitem>
- <simpara>An object which is contains a paragraph of text
- content.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_RULER</literal></term>
- <listitem>
- <simpara> An object which describes margins and tab stops,
- etc. for text objects which it controls (should have
- CONTROLLER_FOR relation to such). </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_APPLICATION</literal></term>
- <listitem>
- <simpara> The object is an application object, which may contain
- atk.ROLE_FRAME objects or other types of accessibles. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_AUTOCOMPLETE</literal></term>
- <listitem>
- <simpara> The object is a dialog or list containing items for
- insertion into an entry widget, for instance a list of words for
- completion of a text entry. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_EDITBAR</literal></term>
- <listitem>
- <simpara>The object is an editable text object in a
- toolbar</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_EMBEDDED</literal></term>
- <listitem>
- <simpara> The object is an embedded container within a document
- or panel. This role is a grouping "hint" indicating that the
- contained objects share a context. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_ENTRY</literal></term>
- <listitem>
- <simpara> The object is a component whose textual content may be
- entered or modified by the user, provided atk.STATE_EDITABLE is
- present. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_CHART</literal></term>
- <listitem>
- <simpara> The object is a graphical depiction of quantitative
- data. It may contain multiple subelements whose attributes
- and/or description may be queried to obtain both the
- quantitative data and information about how the data is being
- presented. The LABELLED_BY relation is particularly important in
- interpreting objects of this type, as is the
- accessible-description property. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_CAPTION</literal></term>
- <listitem>
- <simpara> The object contains descriptive information, usually
- textual, about another user interface element such as a table,
- chart, or image. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_DOCUMENT_FRAME</literal></term>
- <listitem>
- <simpara> The object is a visual frame or container which
- contains a view of document content. Document frames may occur
- within another Document instance, in which case the second
- document may be said to be embedded in the containing
- instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this
- object, or a singleton descendant, should implement the Document
- interface. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_HEADING</literal></term>
- <listitem>
- <simpara> The object serves as a heading for content which
- follows it in a document. The 'heading level' of the heading, if
- availabe, may be obtained by querying the object's
- attributes. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_PAGE</literal></term>
- <listitem>
- <simpara> The object is a containing instance which encapsulates
- a page of information. atk.ROLE_PAGE is used in documents and
- content which support a paginated navigation model. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_SECTION</literal></term>
- <listitem>
- <simpara> The object is a containing instance of document
- content which constitutes a particular 'logical' section of the
- document. The type of content within a section, and the nature
- of the section division itself, may be obtained by querying the
- object's attributes. Sections may be nested. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_REDUNDANT_OBJECT</literal></term>
- <listitem>
- <simpara> The object is redundant with another object in the
- hierarchy, and is exposed for purely technical reasons. Objects
- of this role should normally be ignored by clients. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.ROLE_LAST_DEFINED</literal></term>
- <listitem>
- <simpara>not a valid role, used for finding end of the
- enumeration</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="atk-state-type-constants">
- <title id="atk-state-type-constants-title">Atk State Type Constants</title>
-
- <para>The Atk State Type constants specify a particular state of a
- component. The actual state of an component is described by its <link
- linkend="class-atkstateset"><classname>atk.StateSet</classname></link>,
- which is a set of states.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>atk.STATE_INVALID</literal></term>
- <listitem>
- <simpara>Indicates an invalid state</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_ACTIVE</literal></term>
- <listitem>
- <simpara>Indicates a window is currently the active
- window</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_ARMED</literal></term>
- <listitem>
- <simpara>Indicates that the object is armed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_BUSY</literal></term>
- <listitem>
- <simpara> Indicates the current object is busy. This state may
- be used by implementors of Document to indicate that content
- loading is in process. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_CHECKED</literal></term>
- <listitem>
- <simpara>Indicates this object is currently checked</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_DEFUNCT</literal></term>
- <listitem>
- <simpara> Indicates the user interface object corresponding to
- this object no longer exists </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_EDITABLE</literal></term>
- <listitem>
- <simpara> Indicates the user can change the contents of this
- object </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_ENABLED</literal></term>
- <listitem>
- <simpara> Indicates that this object is enabled. An inconsistent
- <link
- linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
- is an example of an object which is sensitive but not
- enabled. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_EXPANDABLE</literal></term>
- <listitem>
- <simpara> Indicates this object allows progressive disclosure of
- its children </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_EXPANDED</literal></term>
- <listitem>
- <simpara>Indicates this object its expanded</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_FOCUSABLE</literal></term>
- <listitem>
- <simpara> Indicates this object can accept keyboard focus, which
- means all events resulting from typing on the keyboard will
- normally be passed to it when it has focus </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_FOCUSED</literal></term>
- <listitem>
- <simpara>Indicates this object currently has the keyboard
- focus</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_HORIZONTAL</literal></term>
- <listitem>
- <simpara>Indicates the orientation of this object is
- horizontal</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_ICONIFIED</literal></term>
- <listitem>
- <simpara> Indicates this object is minimized and is represented
- only by an icon </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_MODAL</literal></term>
- <listitem>
- <simpara> Indicates something must be done with this object
- before the user can interact with an object in a different
- window </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_MULTI_LINE</literal></term>
- <listitem>
- <simpara> Indicates this (text) object can contain multiple lines of text </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_MULTISELECTABLE</literal></term>
- <listitem>
- <simpara> Indicates this object allows more than one of its
- children to be selected at the same time </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_OPAQUE</literal></term>
- <listitem>
- <simpara> Indicates this object paints every pixel within its
- rectangular region. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_PRESSED</literal></term>
- <listitem>
- <simpara>Indicates this object is currently pressed</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_RESIZABLE</literal></term>
- <listitem>
- <simpara>Indicates the size of this object is not fixed</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_SELECTABLE</literal></term>
- <listitem>
- <simpara> Indicates this object is the child of an object that
- allows its children to be selected and that this child is one of
- those children that can be selected </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_SELECTED</literal></term>
- <listitem>
- <simpara> Indicates this object is the child of an object that
- allows its children to be selected and that this child is one of
- those children that has been selected </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_SENSITIVE</literal></term>
- <listitem>
- <simpara>Indicates this object is sensitive</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_SHOWING</literal></term>
- <listitem>
- <simpara> Indicates this object, the object's parent, the
- object's parent's parent, and so on, are all visible </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_SINGLE_LINE</literal></term>
- <listitem>
- <simpara> Indicates this (text) object can contain only a single
- line of text </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_STALE</literal></term>
- <listitem>
- <simpara> Indicates that the index associated with this object
- has changed since the user accessed the object. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_TRANSIENT</literal></term>
- <listitem>
- <simpara>Indicates this object is transient</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_VERTICAL</literal></term>
- <listitem>
- <simpara>Indicates the orientation of this object is
- vertical</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_VISIBLE</literal></term>
- <listitem>
- <simpara>Indicates this object is visible</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_MANAGES_DESCENDANTS</literal></term>
- <listitem>
- <simpara> Indicates that "active-descendant-changed" event is
- sent when children become 'active' (i.e. are selected or
- navigated to onscreen). Used to prevent need to enumerate all
- children in very large containers, like tables. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_INDETERMINATE</literal></term>
- <listitem>
- <simpara> Indicates that a check box is in a state other than
- checked or not checked. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_TRUNCATED</literal></term>
- <listitem>
- <simpara> Indicates that an object is truncated, e.g. a text
- value in a speradsheet cell. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_REQUIRED</literal></term>
- <listitem>
- <simpara> Indicates that explicit user interaction with an
- object is required by the user interface, e.g. a required field
- in a "web-form" interface. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_INVALID_ENTRY</literal></term>
- <listitem>
- <simpara> Indicates that the object has encountered an error
- condition due to failure of input validation. For instance, a
- form control may acquire this state in response to invalid or
- malformed user input. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_SUPPORTS_AUTOCOMPLETION</literal></term>
- <listitem>
- <simpara> Indicates that the object may exhibit "typeahead"
- behavior in response to user keystrokes, e.g. one keystroke may
- result in the insertion of several characters into an entry, or
- result in the auto-selection of an item in a list. This state
- supplants <literal>atk.ROLE_AUTOCOMPLETE</literal>. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_SELECTABLE_TEXT</literal></term>
- <listitem>
- <simpara>Indicates that the object in question supports text
- selection. It should only be exposed on objects which implement
- the Text interface, in order to distinguish this state from
- <literal>atk.STATE_SELECTABLE</literal>, which infers that the
- object in question is a selectable child of an object which
- implements Selection. While similar, text selection and
- subelement selection are distinct operations. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.STATE_LAST_DEFINED</literal></term>
- <listitem>
- <simpara>Not a valid state, used for finding end of
- enumeration</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="atk-text-attr-constants">
- <title id="atk-text-attr-constants-title">Atk Text Attribute Constants</title>
-
- <para>The Atk Text Attribute constants specify the built-in text
- attributes supported. Other text attributes may be set by an
- application using the <link
- linkend="function-atk--text-attribute-register"><function>atk.text_attribute_register</function>()</link>
- function.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_INVALID</literal></term>
- <listitem>
- <simpara>nvalid attribute</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_LEFT_MARGIN</literal></term>
- <listitem>
- <simpara>The pixel width of the left margin</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_RIGHT_MARGIN</literal></term>
- <listitem>
- <simpara>The pixel width of the right margin</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_INDENT</literal></term>
- <listitem>
- <simpara>The number of pixels that the text is indented</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_INVISIBLE</literal></term>
- <listitem>
- <simpara>Either "true" or "false" indicating whether text is
- visible or not</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_PIXELS_ABOVE_LINES</literal></term>
- <listitem>
- <simpara>Pixels of blank space to leave above each
- newline-terminated line.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_PIXELS_BELOW_LINES</literal></term>
- <listitem>
- <simpara>Pixels of blank space to leave below each
- newline-terminated line.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_PIXELS_INSIDE_WRAP</literal></term>
- <listitem>
- <simpara>Pixels of blank space to leave between wrapped lines
- inside the same newline-terminated line (paragraph).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_BG_FULL_HEIGHT</literal></term>
- <listitem>
- <simpara>"true" or "false" whether to make the background color
- for each character the height of the highest font used on the
- current line, or the height of the font used for the current
- character.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_RISE</literal></term>
- <listitem>
- <simpara>Number of pixels that the characters are risen above
- the baseline</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_UNDERLINE</literal></term>
- <listitem>
- <simpara>"none", "single", "double" or "low"</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_STRIKETHROUGH</literal></term>
- <listitem>
- <simpara>"true" or "false" whether the text is
- strikethrough</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_SIZE</literal></term>
- <listitem>
- <simpara>The size of the characters.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_SCALE</literal></term>
- <listitem>
- <simpara>The scale of the characters. The value is a string
- representation of a double</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_WEIGHT</literal></term>
- <listitem>
- <simpara>The weight of the characters.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_LANGUAGE</literal></term>
- <listitem>
- <simpara>The language used</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_FAMILY_NAME</literal></term>
- <listitem>
- <simpara>The font family name</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_BG_COLOR</literal></term>
- <listitem>
- <simpara>The background color. The value is an RGB value of the
- format "u,u,u"</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_FG_COLOR</literal></term>
- <listitem>
- <simpara>The foreground color. The value is an RGB value of the
- format "u,u,u"</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_BG_STIPPLE</literal></term>
- <listitem>
- <simpara>"true" if a <link
- linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
- is set for stippling the background color.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_FG_STIPPLE</literal></term>
- <listitem>
- <simpara>"true" if a <link
- linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
- is set for stippling the foreground color.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_WRAP_MODE</literal></term>
- <listitem>
- <simpara>The wrap mode of the text, if any. Values are "none",
- "char" or "word"</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_DIRECTION</literal></term>
- <listitem>
- <simpara>The direction of the text, if set. Values are "none",
- "ltr" or "rtl"</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_JUSTIFICATION</literal></term>
- <listitem>
- <simpara> The justification of the text, if set. Values are
- "left", "right", "center" or "fill" </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_STRETCH</literal></term>
- <listitem>
- <simpara> The stretch of the text, if set. Values are
- "ultra_condensed", "extra_condensed", "condensed",
- "semi_condensed", "normal", "semi_expanded", "expanded",
- "extra_expanded" or "ultra_expanded" </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_VARIANT</literal></term>
- <listitem>
- <simpara> The capitalization variant of the text, if set. Values
- are "normal" or "small_caps" </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_STYLE</literal></term>
- <listitem>
- <simpara> The slant style of the text, if set. Values are
- "normal", "oblique" or "italic" </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_ATTR_LAST_DEFINED</literal></term>
- <listitem>
- <simpara> not a valid text attribute, used for finding end of
- enumeration </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="atk-text-boundary-constants">
- <title id="atk-text-boundary-constants-title">Atk Text Boundary Constants</title>
-
- <para>The Atk Text Boundary constants specify oundaries for regions of
- text.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>atk.TEXT_BOUNDARY_CHAR</literal></term>
- <listitem>
- <simpara> Boundary is the boundary between characters (including
- non-printing characters) </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_BOUNDARY_WORD_START</literal></term>
- <listitem>
- <simpara>Boundary is the start (i.e. first character) of a
- word.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_BOUNDARY_WORD_END</literal></term>
- <listitem>
- <simpara>Boundary is the end (i.e. last character) of a
- word.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_BOUNDARY_SENTENCE_START</literal></term>
- <listitem>
- <simpara>Boundary is the first character in a
- sentence.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_BOUNDARY_SENTENCE_END</literal></term>
- <listitem>
- <simpara> Boundary is the last (terminal) character in a
- sentence; in languages which use "sentence stop" punctuation
- such as English, the boundary is thus the '.', '?', or similar
- terminal punctuation character. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_BOUNDARY_LINE_START</literal></term>
- <listitem>
- <simpara> Boundary is the initial character of the content or a
- character immediately following a newline, linefeed, or return
- character. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_BOUNDARY_LINE_END</literal></term>
- <listitem>
- <simpara>Boundary is the linefeed, or return
- character.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="atk-text-clip-type-constants">
- <title id="atk-text-clip-type-constants-title">Atk Text Clip Type Constants</title>
-
- <para>The Atk Text Clip Type constants specify the type of clipping
- required.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>atk.TEXT_CLIP_NONE</literal></term>
- <listitem>
- <simpara>No clipping to be done</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_CLIP_MIN</literal></term>
- <listitem>
- <simpara>Text clipped by min coordinate is omitted</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_CLIP_MAX</literal></term>
- <listitem>
- <simpara>Text clipped by max coordinate is omitted</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>atk.TEXT_CLIP_BOTH</literal></term>
- <listitem>
- <simpara>Only text fully within mix/max bound is
- retained</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkaction.xml b/docs/reference/pygtk-atkaction.xml
deleted file mode 100644
index 3e89ce18..00000000
--- a/docs/reference/pygtk-atkaction.xml
+++ /dev/null
@@ -1,283 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkaction">
-
- <refnamediv>
- <refname>atk.Action</refname>
- <refpurpose>the ATK interface provided by UI components that the user
- can activate/interact with, </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Action</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkaction--do-action">do_action</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkaction--get-n-actions">get_n_actions</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkaction--get-description">get_description</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkaction--get-name">get_name</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkaction--get-keybinding">get_keybinding</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkaction--set-description">set_description</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- <methodparam><parameter role="keyword">desc</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkaction--get-localized-name">get_localized_name</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-atkaction"><classname>atk.Action</classname></link>
- should be implemented by instances of <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- classes with which the user can interact directly, i.e. buttons,
- checkboxes, scrollbars, e.g. components which are not "passive"
- providers of UI information.</para>
-
- <para>Exceptions: when the user interaction is already covered by
- another appropriate interface such as <link
- linkend="class-atkeditabletext"><classname>atk.EditableText</classname></link>
- (insert/delete test, etc.) or <link
- linkend="class-atkvalue"><classname>atk.Value</classname></link> (set
- value) then these actions should not be exposed by <link
- linkend="class-atkaction"><classname>atk.Action</classname></link> as
- well.</para>
-
- <para>Also note that the <link
- linkend="class-atkaction"><classname>atk.Action</classname></link> API
- is limited in that parameters may not be passed to the object being
- activated; thus the action must be self-contained and specifiable via
- only a single "verb". Concrete examples include "press", "release",
- "click" for buttons, "drag" (meaning initiate drag) and "drop" for drag
- sources and drop targets, etc.</para>
-
- <para>Though most UI interactions on components should be invocable via
- keyboard as well as mouse, there will generally be a close mapping
- between "mouse actions" that are possible on a component and the
- AtkActions. Where mouse and keyboard actions are redundant in effect,
- <link linkend="class-atkaction"><classname>atk.Action</classname></link>
- should expose only one action rather than exposing redundant actions if
- possible. By convention we have been using "mouse centric" terminology
- for <link
- linkend="class-atkaction"><classname>atk.Action</classname></link>
- names.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkaction--do-action">
- <title>atk.Action.do_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>do_action</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>the action index corresponding to the action to
- be performed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if success,
- <literal>False</literal> otherwise</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Perform the specified action on the object.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkaction--get-n-actions">
- <title>atk.Action.get_n_actions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_actions</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a the number of actions, or 0 if
- <parameter>action</parameter> does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the number of accessible actions available on the object.
- If there are more than one, the first one is considered the "default"
- action of the object.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkaction--get-description">
- <title>atk.Action.get_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_description</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>the action index corresponding to the action to be performed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a description string, or
- <literal>None</literal> if <parameter>action</parameter> does not
- implement this interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Returns a description of the specified action of the
- object.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkaction--get-name">
- <title>atk.Action.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>the action index corresponding to the action to
- be performed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a name string, or <literal>None</literal> if
- <parameter>action</parameter> does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Returns the name of the specified action of the object.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkaction--get-keybinding">
- <title>atk.Action.get_keybinding</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_keybinding</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>the action index corresponding to the action to
- be performed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string representing the keybinding, or
- <literal>None</literal> if there is no keybinding for this
- action.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Returns a keybinding associated with this action, if one
- exists.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkaction--set-description">
- <title>atk.Action.set_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_description</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- <methodparam><parameter role="keyword">desc</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>the action index corresponding to the action to
- be performed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">desc</parameter>&nbsp;:</term>
- <listitem><simpara>the description to be assigned to this
- action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the description was
- successfully set;</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets a description of the specified action of the object.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkaction--get-localized-name">
- <title>atk.Action.get_localized_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_localized_name</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>the action index corresponding to the action to
- be performed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a name string, or <literal>None</literal> if
- <parameter>action</parameter> does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Returns the localized name of the specified action of the
- object.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkcomponent.xml b/docs/reference/pygtk-atkcomponent.xml
deleted file mode 100644
index da1d3f2b..00000000
--- a/docs/reference/pygtk-atkcomponent.xml
+++ /dev/null
@@ -1,568 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkcomponent">
-
- <refnamediv>
- <refname>atk.Component</refname>
- <refpurpose>the ATK interface provided by UI components that occupy a
- physical area on the screen. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Component</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent- -add-focus-handler">add_focus_handler</link></methodname>
- <methodparam><parameter role="keyword">handler</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--contains">contains</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--ref-accessible-at-point">ref_accessible_at_point</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--get-extents">get_extents</link></methodname>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--get-position">get_position</link></methodname>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--get-size">get_size</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--grab-focus">grab_focus</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--remove-focus-handler">remove_focus_handler</link></methodname>
- <methodparam><parameter role="keyword">handler_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--set-extents">set_extents</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--set-position">set_position</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--set-size">set_size</link></methodname>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--get-layer">get_layer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkcomponent--get-mdi-zorder">get_mdi_zorder</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atkcomponent">
- <title>atk.Component Signal Prototypes</title>
-
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-atkcomponent--bounds-changed">bounds-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkcomponent</parameter></methodparam>
- <methodparam><parameter>rect</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-atkcomponent"><classname>atk.Component</classname></link>
- should be implemented by most if not all UI elements with an actual
- on-screen presence, i.e. components which can be said to have a
- screen-coordinate bounding box. Virtually all widgets will need to have
- <link
- linkend="class-atkcomponent"><classname>atk.Component</classname></link>
- implementations provided for their corresponding <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- class. In short, only UI elements which are *not* GUI elements will
- omit this ATK interface.</para>
-
- <para>A possible exception might be textual information with a
- transparent background, in which case text glyph bounding box
- information is provided by <link
- linkend="class-atktext"><classname>atk.Text</classname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-atkcomponent- -add-focus-handler">
- <title>atk.Component.add_focus_handler</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_focus_handler</methodname>
- <methodparam><parameter role="keyword">handler</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">handler</parameter>&nbsp;:</term>
- <listitem><simpara>The <literal>AtkFocusHandler</literal> to be attached to <parameter>component</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a handler id which can be used in atk_component_remove_focus_handler
-or zero if the handler was already added.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Add the specified handler to the set of functions to be called
- when this object receives focus events (in or out). If the handler is
- already added it is not added again</para>
-
- </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-atkcomponent--contains">
- <title>atk.Component.contains</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>contains</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>x coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
- <listitem><simpara>specifies whether the coordinates are relative
- to the screen or to the components top level window - one of the
- <xref linkend="atk-coord-type-constants"
- endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> or
- <literal>False</literal> indicating whether the specified point is
- within the extent of the component or not</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Checks whether the specified point is within the extent of the
- <parameter>component</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkcomponent--ref-accessible-at-point">
- <title>atk.Component.ref_accessible_at_point</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ref_accessible_at_point</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>x coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
- <listitem><simpara>specifies whether the coordinates are relative
- to the screen or to the components top level
- window - one of the
- <xref linkend="atk-coord-type-constants"
- endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- reference to the accessible child, if one
- exists</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets a reference to the accessible child, if one exists, at the
- coordinate point specified by <parameter>x</parameter> and
- <parameter>y</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkcomponent--get-extents">
- <title>atk.Component.get_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_extents</methodname>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
- <listitem><simpara>specifies whether the coordinates are relative
- to the screen or to the components top level window - one of the
- <xref linkend="atk-coord-type-constants"
- endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 4-tuple containing the x, y position
- coordinates and the width and height of the
- component.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the rectangle which gives the extent of the
- component.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkcomponent--get-position">
- <title>atk.Component.get_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_position</methodname>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
- <listitem><simpara>specifies whether the coordinates are relative
- to the screen or to the components top level window - one of the
- <xref linkend="atk-coord-type-constants"
- endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the x, y position
- coordinates of the component.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the position of the component in the form of a point
- specifying the component's top-left corner.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkcomponent--get-size">
- <title>atk.Component.get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the width and height of
- the component.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the size of the component in terms of width and
- height.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkcomponent--grab-focus">
- <title>atk.Component.grab_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>grab_focus</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if successful,
- <literal>False</literal> otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Grabs focus for this component.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkcomponent--remove-focus-handler">
- <title>atk.Component.remove_focus_handler</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_focus_handler</methodname>
- <methodparam><parameter role="keyword">handler_id</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">handler_id</parameter>&nbsp;:</term>
- <listitem><simpara>the handler id of the focus handler to be
- removed from component</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Remove the handler specified by
- <parameter>handler_id</parameter> from the list of functions to be
- executed when this object receives focus events (in or out).</para>
-
- </refsect2>
-
- <refsect2 id="method-atkcomponent--set-extents">
- <title>atk.Component.set_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_extents</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>x coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>width to set for the
- component</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>height to set for the
- component</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
- <listitem><simpara>specifies whether the coordinates are relative
- to the screen or to the components top level window - one of the
- <xref linkend="atk-coord-type-constants"
- endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the extents were
- set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the extents of the component.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkcomponent--set-position">
- <title>atk.Component.set_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_position</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>x coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
- <listitem><simpara>specifies whether the coordinates are relative
- to the screen or to the components top level window - one of the
- <xref linkend="atk-coord-type-constants"
- endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the position was
- set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the postition of the component.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkcomponent--set-size">
- <title>atk.Component.set_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_size</methodname>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>width to set for component</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>height to set for component</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the size was
- set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Set the size of the component in terms of width and
- height.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkcomponent--get-layer">
- <title>atk.Component.get_layer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_layer</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>one of the <xref linkend="atk-layer-constants"
- endterm="atk-layer-constants-title"></xref> which is the layer of
- the component</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the layer of the component.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkcomponent--get-mdi-zorder">
- <title>atk.Component.get_mdi_zorder</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_mdi_zorder</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer which is the zorder of the
- component, i.e. the depth at which the component is shown in
- relation to other components in the same
- container.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the zorder of the component. The value G_MININT will be
- returned if the layer of the component is not
- <literal>atk.LAYER_MDI</literal> or
- <literal>atk.LAYER_WINDOW</literal>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-atkcomponent--bounds-changed">
- <title>The "bounds-changed" atk.Component Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkcomponent</parameter></methodparam>
- <methodparam><parameter>rect</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atkcomponent</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>rect</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
- linkend="class-atkrectangle"><classname>atk.Rectangle</classname></link>
- giving the new position and size.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The 'bounds-changed" signal is emitted when the bposition or
- size of the a component changes.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkdocument.xml b/docs/reference/pygtk-atkdocument.xml
deleted file mode 100644
index 919270ad..00000000
--- a/docs/reference/pygtk-atkdocument.xml
+++ /dev/null
@@ -1,91 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkdocument">
-
- <refnamediv>
- <refname>atk.Document</refname>
- <refpurpose>the ATK interface which allows access to a DOM associated
- with on object. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Document</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkdocument--get-document-type">get_document_type</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkdocument- -get-document">get_document</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-END -->
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
- linkend="class-atkdocument"><classname>atk.Document</classname></link>
- interface should be supported by any object that has an associated
- document object model (DOM). This interface provides the standard
- mechanism allowing an assistive technology access to the DOM.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkdocument--get-document-type">
- <title>atk.Document.get_document_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_document_type</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string indicating the document type</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets a string indicating the document type.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-atkdocument- -get-document">
- <title>atk.Document.get_document</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_document</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <literal>gpointer</literal> that points to an instance of the DOM.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets a <literal>gpointer</literal> that points to an instance of the DOM. It is
- up to the caller to check atk_document_get_type to determine
- how to cast this pointer.</para>
-
- </refsect2>
-END -->
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkeditabletext.xml b/docs/reference/pygtk-atkeditabletext.xml
deleted file mode 100644
index 8c578a67..00000000
--- a/docs/reference/pygtk-atkeditabletext.xml
+++ /dev/null
@@ -1,281 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkeditabletext">
-
- <refnamediv>
- <refname>atk.EditableText</refname>
- <refpurpose>the ATK interface implemented by components containing
- user-editable text content. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.EditableText</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkeditabletext--set-run-attributes">set_run_attributes</link></methodname>
- <methodparam><parameter role="keyword">attrib_set</parameter></methodparam>
- <methodparam><parameter role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">end_offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkeditabletext--set-text-contents">set_text_contents</link></methodname>
- <methodparam><parameter role="keyword">string</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkeditabletext--insert-text">insert_text</link></methodname>
- <methodparam><parameter role="keyword">string</parameter></methodparam>
- <methodparam><parameter role="keyword">length</parameter></methodparam>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkeditabletext--copy-text">copy_text</link></methodname>
- <methodparam><parameter role="keyword">start_pos</parameter></methodparam>
- <methodparam><parameter role="keyword">end_pos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkeditabletext--cut-text">cut_text</link></methodname>
- <methodparam><parameter role="keyword">start_pos</parameter></methodparam>
- <methodparam><parameter role="keyword">end_pos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkeditabletext--delete-text">delete_text</link></methodname>
- <methodparam><parameter role="keyword">start_pos</parameter></methodparam>
- <methodparam><parameter role="keyword">end_pos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkeditabletext--paste-text">paste_text</link></methodname>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-atkeditabletext"><classname>atk.EditableText</classname></link>
- should be implemented by UI components which contain text which the user
- can edit, via the <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- corresponding to that component (see <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>).</para>
-
- <para><link
- linkend="class-atkeditabletext"><classname>atk.EditableText</classname></link>
- is a subclass of <link
- linkend="class-atktext"><classname>atk.Text</classname></link>, and as
- such, an object which implements <link
- linkend="class-atkeditabletext"><classname>atk.EditableText</classname></link>
- is by definition an <link
- linkend="class-atktext"><classname>atk.Text</classname></link>
- implementor as well.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkeditabletext--set-run-attributes">
- <title>atk.EditableText.set_run_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_run_attributes</methodname>
- <methodparam><parameter role="keyword">attrib_set</parameter></methodparam>
- <methodparam><parameter role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">end_offset</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">attrib_set</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of 2-tuples containing name-value
- string pairs.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start_offset</parameter>&nbsp;:</term>
- <listitem><simpara>start of range in which to set
- attributes</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_offset</parameter>&nbsp;:</term>
- <listitem><simpara>end of range in which to set
- attributes</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if attributes were
- successfully set for the specified range, otherwise
- <literal>False</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the attributes for a specified range. See the <xref
- linkend="atk-text-attr-constants"
- endterm="atk-text-attr-constants-title"></xref> (such as
- <literal>atk.TEXT_ATTR_LEFT_MARGIN</literal>) for examples of
- attributes that can be set. Note that other attributes that do not
- have corresponding <xref linkend="atk-text-attr-constants"
- endterm="atk-text-attr-constants-title"></xref> may also be set for
- certain text widgets.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkeditabletext--set-text-contents">
- <title>atk.EditableText.set_text_contents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text_contents</methodname>
- <methodparam><parameter role="keyword">string</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">string</parameter>&nbsp;:</term>
- <listitem><simpara>string to set for text contents of the
- text</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Set text contents of the text.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkeditabletext--insert-text">
- <title>atk.EditableText.insert_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_text</methodname>
- <methodparam><parameter role="keyword">string</parameter></methodparam>
- <methodparam><parameter role="keyword">length</parameter></methodparam>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">string</parameter>&nbsp;:</term>
- <listitem><simpara>the text to insert</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">length</parameter>&nbsp;:</term>
- <listitem><simpara>the length of text to insert, in bytes</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the position at which to insert the text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the position after the newly inserted
- text.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Insert text at a given position.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkeditabletext--copy-text">
- <title>atk.EditableText.copy_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy_text</methodname>
- <methodparam><parameter role="keyword">start_pos</parameter></methodparam>
- <methodparam><parameter role="keyword">end_pos</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start_pos</parameter>&nbsp;:</term>
- <listitem><simpara>start position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_pos</parameter>&nbsp;:</term>
- <listitem><simpara>end position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Copy text from <parameter>start_pos</parameter> up to, but not
- including <parameter>end_pos</parameter> to the clipboard.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkeditabletext--cut-text">
- <title>atk.EditableText.cut_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>cut_text</methodname>
- <methodparam><parameter role="keyword">start_pos</parameter></methodparam>
- <methodparam><parameter role="keyword">end_pos</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start_pos</parameter>&nbsp;:</term>
- <listitem><simpara>start position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_pos</parameter>&nbsp;:</term>
- <listitem><simpara>end position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Copy text from <parameter>start_pos</parameter> up to, but not
- including <parameter>end_pos</parameter> to the clipboard and then
- delete from the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkeditabletext--delete-text">
- <title>atk.EditableText.delete_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>delete_text</methodname>
- <methodparam><parameter role="keyword">start_pos</parameter></methodparam>
- <methodparam><parameter role="keyword">end_pos</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start_pos</parameter>&nbsp;:</term>
- <listitem><simpara>start position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_pos</parameter>&nbsp;:</term>
- <listitem><simpara>end position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Delete text <parameter>start_pos</parameter> up to, but not
- including <parameter>end_pos</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkeditabletext--paste-text">
- <title>atk.EditableText.paste_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paste_text</methodname>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>position to paste</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Paste text from clipboard to the specified
- <parameter>position</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkgobjectaccessible.xml b/docs/reference/pygtk-atkgobjectaccessible.xml
deleted file mode 100644
index 6cc7fb17..00000000
--- a/docs/reference/pygtk-atkgobjectaccessible.xml
+++ /dev/null
@@ -1,134 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkgobjectaccessible">
-
- <refnamediv>
- <refname>atk.GObjectAccessible</refname>
- <refpurpose>this object class is derived from AtkObject and can be
- used as a basis implementing accessible objects. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.GObjectAccessible</classname></ooclass>
- <ooclass><classname><link linkend="class-atkobject">atk.Object</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkgobjectaccessible--get-object">get_object</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-atk--gobject-accessible-for-object">atk.gobject_accessible_for_object</link></methodname>
- <methodparam><parameter role="keyword">obj</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-atkobject">atk.Object</link>
- +-- <link linkend="class-atkgobjectaccessible">atk.GObjectAccessible</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-atkgobjectaccessible">
- <title>atk.GObjectAccessible Properties</title>
-
- <para><link linkend="properties-atkobject">atk.Object Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atkgobjectaccessible">
- <title>atk.GObjectAccessible Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-atkobject">atk.Object Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>This object class is derived from <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>. It
- can be used as a basis for implementing accessible objects for <link
- linkend="class-gobject"><classname>gobject.GObject</classname></link>
- objects which are not derived from <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>. One
- example of its use is in providing an accessible object for
- GnomeCanvasItem in the GAIL library.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkgobjectaccessible--get-object">
- <title>atk.GObjectAccessible.get_object</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_object</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gobject"><classname>gobject.GObject</classname></link>
- which is the object for the accessible object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the <link
- linkend="class-gobject"><classname>gobject.GObject</classname></link>
- for the accessible object.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-atk--gobject-accessible-for-object">
- <title>atk.gobject_accessible_for_object</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.gobject_accessible_for_object</methodname>
- <methodparam><parameter
- role="keyword">obj</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">obj</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gobject"><classname>gobject.GObject</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- which is the accessible object for
- <parameter>obj</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the accessible object for the specified
- <parameter>obj</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkhyperlink.xml b/docs/reference/pygtk-atkhyperlink.xml
deleted file mode 100644
index f382d698..00000000
--- a/docs/reference/pygtk-atkhyperlink.xml
+++ /dev/null
@@ -1,382 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkhyperlink">
-
- <refnamediv>
- <refname>atk.Hyperlink</refname>
- <refpurpose>An ATK object which encapsulates a link or set of links in a hypertext document. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Hyperlink</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkhyperlink--get-uri">get_uri</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkhyperlink--get-object">get_object</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkhyperlink--get-end-index">get_end_index</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkhyperlink--get-start-index">get_start_index</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkhyperlink--is-valid">is_valid</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkhyperlink--get-n-anchors">get_n_anchors</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkhyperlink--is-inline">is_inline</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkhyperlink--is-selected-link">is_selected_link</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-atkhyperlink">atk.Hyperlink</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-atkhyperlink">
- <title>atk.Hyperlink Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"end-index"</entry>
- <entry>Read</entry>
- <entry>The end index of the <link
- linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
- object. Allowed values: >= 0. Default value: 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"number-of-anchors"</entry>
- <entry>Read</entry>
- <entry>The number of anchors associated with the <link
- linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
- object. Allowed values: >= 0. Default value: 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"selected-link"</entry>
- <entry>Read</entry>
- <entry>if <literal>True</literal> the <link
- linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
- object is selected. Default value:
- <literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"start-index"</entry>
- <entry>Read</entry>
- <entry>The start index of the AtkHyperlink object. Allowed values:
- >= 0. Default value: 0.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atkhyperlink">
- <title>atk.Hyperlink Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-atkhyperlink--link-activated">link-activated</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkhyperlink</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>An ATK object which encapsulates a link or set of links in a
- hypertext document. It implements the <link
- linkend="class-atkaction"><classname>atk.Action</classname></link>
- interface.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkhyperlink--get-uri">
- <title>atk.Hyperlink.get_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_uri</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>a (zero-index) integer specifying the desired
- anchor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string specifying the
- URI</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Get a the URI associated with the anchor specified by
- <parameter>i</parameter>.</para>
-
- <para>Multiple anchors are primarily used by client-side image
- maps.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkhyperlink--get-object">
- <title>atk.Hyperlink.get_object</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_object</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>a (zero-index) integer specifying the desired
- anchor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- associated with this hyperlinks i-th anchor</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Returns the item associated with this hyperlinks nth anchor.
- For instance, the returned <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- will implement <link
- linkend="class-atktext"><classname>atk.Text</classname></link> if
- the link is a text hyperlink, <link
- linkend="class-atkimage"><classname>atk.Image</classname></link> if
- the link is an image hyperlink etc. </para>
-
- <para>Multiple anchors are primarily used by client-side image
- maps.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkhyperlink--get-end-index">
- <title>atk.Hyperlink.get_end_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_end_index</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the index with the hypertext document at which
- this link ends</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the index with the hypertext document at which this link
- ends.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkhyperlink--get-start-index">
- <title>atk.Hyperlink.get_start_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_start_index</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the index with the hypertext document at which
- this link begins</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the index with the hypertext document at which this link
- begins.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkhyperlink--is-valid">
- <title>atk.Hyperlink.is_valid</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_valid</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> this link is still
- valid</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Since the document that a link is associated with may have
- changed this method returns <literal>True</literal> if the link is
- still valid (with respect to the document it references) and
- <literal>False</literal> otherwise.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkhyperlink--get-n-anchors">
- <title>atk.Hyperlink.get_n_anchors</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_anchors</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of anchors associated with this
- hyperlink</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the number of anchors associated with this
- hyperlink.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkhyperlink--is-inline">
- <title>atk.Hyperlink.is_inline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_inline</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> this link displays
- its content inline.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Indicates whether the link currently displays some or all of its
- content inline. Ordinary HTML links will usually return
- <literal>False</literal>, but an inline &lt;src&gt; HTML element will
- return <literal>True</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkhyperlink--is-selected-link">
- <title>atk.Hyperlink.is_selected_link</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_selected_link</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the <link
- linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
- is selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Determines whether this <link
- linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
- is selected</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-atkhyperlink--link-activated">
- <title>The "link-activated" atk.Hyperlink Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkhyperlink</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atkhyperlink</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The signal "link-activated" is emitted when a link is
- activated.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkhypertext.xml b/docs/reference/pygtk-atkhypertext.xml
deleted file mode 100644
index 0762f126..00000000
--- a/docs/reference/pygtk-atkhypertext.xml
+++ /dev/null
@@ -1,201 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkhypertext">
-
- <refnamediv>
- <refname>atk.Hypertext</refname>
- <refpurpose>the ATK interface which provides standard mechanism for
- manipulating hyperlinks. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Hypertext</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkhypertext--get-link">get_link</link></methodname>
- <methodparam><parameter role="keyword">link_index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkhypertext--get-n-links">get_n_links</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkhypertext--get-link-index">get_link_index</link></methodname>
- <methodparam><parameter role="keyword">char_index</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atkhypertext">
- <title>atk.Hypertext Signal Prototypes</title>
-
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-atkhypertext--link-selected">link-selected</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkhypertext</parameter></methodparam>
- <methodparam><parameter>index</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>An interface used for objects which implement linking between
- multiple resource or content locations, or multiple 'markers' within a
- single document. A <link
- linkend="class-atkhypertext"><classname>atk.Hypertext</classname></link>
- instance is associated with one or more <link
- linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
- objects, which are associated with particular offsets within the <link
- linkend="class-atkhypertext"><classname>atk.Hypertext</classname></link>'s
- included content. While this interface is derived from <link
- linkend="class-atktext"><classname>atk.Text</classname></link>, there is
- no requirement that <link
- linkend="class-atkhypertext"><classname>atk.Hypertext</classname></link>
- instances have textual content; they may implement <link
- linkend="class-atkimage"><classname>atk.Image</classname></link> as
- well, and <link
- linkend="class-atkhyperlink"><classname>atk.Hyperlink</classname></link>
- objects need not have non-zero text offsets.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkhypertext--get-link">
- <title>atk.Hypertext.get_link</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_link</methodname>
- <methodparam><parameter role="keyword">link_index</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">link_index</parameter>&nbsp;:</term>
- <listitem><simpara>an integer specifying the desired
- link</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the link in this hypertext document at
-index <parameter>link_index</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the link in this hypertext document at index
- <parameter>link_index</parameter></para>
-
- </refsect2>
-
- <refsect2 id="method-atkhypertext--get-n-links">
- <title>atk.Hypertext.get_n_links</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_links</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of links within this hypertext
- document</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the number of links within this hypertext document.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkhypertext--get-link-index">
- <title>atk.Hypertext.get_link_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_link_index</methodname>
- <methodparam><parameter role="keyword">char_index</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">char_index</parameter>&nbsp;:</term>
- <listitem><simpara>a character index</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an index into the array of hyperlinks in the
- hypertext</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the index into the array of hyperlinks that is associated
- with the character specified by <parameter>char_index</parameter>, or
- -1 if there is no hyperlink associated with this character.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-atkhypertext--link-selected">
- <title>The "link-selected" atk.Hypertext Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkhypertext</parameter></methodparam>
- <methodparam><parameter>index</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atkhypertext</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the
- signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the hyperlink which is
- selected</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "link-selected" signal is emitted by an <link
- linkend="class-atkhypertext"><classname>atk.HyperText</classname></link>
- object when one of the hyperlinks associated with the object is
- selected.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkimage.xml b/docs/reference/pygtk-atkimage.xml
deleted file mode 100644
index 55f1c3a4..00000000
--- a/docs/reference/pygtk-atkimage.xml
+++ /dev/null
@@ -1,162 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkimage">
-
- <refnamediv>
- <refname>atk.Image</refname>
- <refpurpose>the ATK Interface implemented by components that expose
- image or pixmap content on-screen. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Image</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkimage--get-image-description">get_image_description</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkimage--get-image-size">get_image_size</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkimage--set-image-description">set_image_description</link></methodname>
- <methodparam><parameter role="keyword">description</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkimage--get-image-position">get_image_position</link></methodname>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-atkimage"><classname>atk.Image</classname></link> should
- be implemented by <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- subtypes on behalf of components which display image/pixmap information
- onscreen, and which provide information (other than just widget borders,
- etc.) via that image content. For instance, icons, buttons with icons,
- toolbar elements, and image viewing panes typically should implement
- <link
- linkend="class-atkimage"><classname>atk.Image</classname></link>.</para>
-
- <para><link
- linkend="class-atkimage"><classname>atk.Image</classname></link>
- primarily provides two types of information: coordinate information
- (useful for screen review mode of screenreaders, and for use by onscreen
- magnifiers), and descriptive information. The descriptive information
- is provided for alternative, text-only presentation of the most
- significant information present in the image.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkimage--get-image-description">
- <title>atk.Image.get_image_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_image_description</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string representing the image
- description</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Get a textual description of this image.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkimage--get-image-size">
- <title>atk.Image.get_image_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_image_size</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the width and height of
- the image</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Get the width and height in pixels for the specified image. The
- width and height are returned as -1 if the values cannot be
- obtained.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkimage--set-image-description">
- <title>atk.Image.set_image_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_image_description</methodname>
- <methodparam><parameter role="keyword">description</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">description</parameter>&nbsp;:</term>
- <listitem><simpara>a string description to set for
- <parameter>image</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if operation could be
- completed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the textual description for this image.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkimage--get-image-position">
- <title>atk.Image.get_image_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_image_position</methodname>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
- <listitem><simpara>specifies whether the coordinates are relative
- to the screen or to the components top level window - one of the
- <xref linkend="atk-coord-type-constants"
- endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the x and y coordinates of
- the image</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the position of the image in the form of a point specifying
- the images top-left corner. The values of x and y are returned as -1
- if the values cannot be obtained.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkimplementor.xml b/docs/reference/pygtk-atkimplementor.xml
deleted file mode 100644
index a1a006ff..00000000
--- a/docs/reference/pygtk-atkimplementor.xml
+++ /dev/null
@@ -1,62 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkimplementor">
-
- <refnamediv>
- <refname>atk.Implementor</refname>
- <refpurpose></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Implementor</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkimplementor--ref-accessible">ref_accessible</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para></para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkimplementor--ref-accessible">
- <title>atk.Implementor.ref_accessible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ref_accessible</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a reference to an object's <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- implementation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets a reference to an object's <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- implementation, if the object implements <link
- linkend="class-atkobject"><classname>atk.Object</classname></link></para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atknoopobject.xml b/docs/reference/pygtk-atknoopobject.xml
deleted file mode 100644
index 50d11486..00000000
--- a/docs/reference/pygtk-atknoopobject.xml
+++ /dev/null
@@ -1,103 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atknoopobject">
-
- <refnamediv>
- <refname>atk.NoOpObject</refname>
- <refpurpose>an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- which purports to implement all ATK interfaces. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.NoOpObject</classname></ooclass>
- <ooclass><classname><link linkend="class-atkobject">atk.Object</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-atknoopobject">atk.NoOpObject</link></methodname>
- <methodparam><parameter role="keyword">obj</parameter></methodparam>
- </constructorsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-atkobject">atk.Object</link>
- +-- <link linkend="class-atknoopobject">atk.NoOpObject</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-atknoopobject">
- <title>atk.NoOpObject Properties</title>
-
- <para><link linkend="properties-atkobject">atk.Object Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atknoopobject">
- <title>atk.NoOpObject Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-atkobject">atk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-atkcomponent">atk.Component Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-atkhypertext">atk.Hypertext Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-atkselection">atk.Selection Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-atktable">atk.Table Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-atktext">atk.Text Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>An <link
- linkend="class-atknoopobject"><classname>atk.NoOpObject</classname></link>
- is an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link> which
- purports to implement all ATK interfaces. It is the type of <link
- linkend="class-atkobject"><classname>atk.Object</classname></link> that
- is created if an accessible object is requested for an object type for
- which no factory type is specified.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-atknoopobject">
- <title>atk.NoOpObject</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>atk.NoOpObject</methodname>
- <methodparam><parameter role="keyword">obj</parameter></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">obj</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gobject"><classname>gobject.GObject</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a default (non-functioning stub) <link
- linkend="class-atkobject"><classname>atk.Object</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Provides a default (non-functioning stub) <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>.
- Application maintainers should not use this method.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atknoopobjectfactory.xml b/docs/reference/pygtk-atknoopobjectfactory.xml
deleted file mode 100644
index 3ba878da..00000000
--- a/docs/reference/pygtk-atknoopobjectfactory.xml
+++ /dev/null
@@ -1,89 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atknoopobjectfactory">
-
- <refnamediv>
- <refname>atk.NoOpObjectFactory</refname>
- <refpurpose>the <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- which creates an <link
- linkend="class-atknoopobject"><classname>atk.NoOpObject</classname></link>.
- </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.NoOpObjectFactory</classname></ooclass>
- <ooclass><classname><link linkend="class-atkobjectfactory">atk.ObjectFactory</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-atknoopobjectfactory">atk.NoOpObjectFactory</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-atkobjectfactory">atk.ObjectFactory</link>
- +-- <link linkend="class-atknoopobjectfactory">atk.NoOpObjectFactory</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atknoopobjectfactory">
- <title>atk.NoOpObjectFactory Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- which creates an <link
- linkend="class-atknoopobject"><classname>atk.NoOpObject</classname></link>. An
- instance of this is created by an <link
- linkend="class-atkregistry"><classname>atk.Registry</classname></link>
- if no factory type has not been specified to create an accessible object
- of a particular type.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-atknoopobjectfactory">
- <title>atk.NoOpObjectFactory</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>atk.NoOpObjectFactory</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an instance of an <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates an instance of an <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- which generates primitive (non-functioning) <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- objects.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkobject.xml b/docs/reference/pygtk-atkobject.xml
deleted file mode 100644
index 3379ba3d..00000000
--- a/docs/reference/pygtk-atkobject.xml
+++ /dev/null
@@ -1,1110 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkobject">
-
- <refnamediv>
- <refname>atk.Object</refname>
- <refpurpose>the base object class for the Accessibility Toolkit
- API.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Object</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--get-name">get_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--get-description">get_description</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--get-parent">get_parent</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--get-n-accessible-children">get_n_accessible_children</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--ref-accessible-child">ref_accessible_child</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--ref-relation-set">ref_relation_set</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--get-role">get_role</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--get-layer">get_layer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--get-mdi-zorder">get_mdi_zorder</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--ref-state-set">ref_state_set</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--get-index-in-parent">get_index_in_parent</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--set-name">set_name</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--set-description">set_description</link></methodname>
- <methodparam><parameter role="keyword">description</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--set-parent">set_parent</link></methodname>
- <methodparam><parameter role="keyword">parent</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--set-role">set_role</link></methodname>
- <methodparam><parameter role="keyword">role</parameter></methodparam>
- </methodsynopsis>
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject- -connect-property-change-handler">connect_property_change_handler</link></methodname>
- <methodparam><parameter role="keyword">handler</parameter></methodparam>
- </methodsynopsis>
-END -->
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--remove-property-change-handler">remove_property_change_handler</link></methodname>
- <methodparam><parameter role="keyword">handler_id</parameter></methodparam>
- </methodsynopsis>
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject- -notify-state-change">notify_state_change</link></methodname>
- <methodparam><parameter role="keyword">state</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject- -initialize">initialize</link></methodname>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis>
-END -->
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--add-relationship">add_relationship</link></methodname>
- <methodparam><parameter role="keyword">relationship</parameter></methodparam>
- <methodparam><parameter role="keyword">target</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobject--remove-relationship">remove_relationship</link></methodname>
- <methodparam><parameter role="keyword">relationship</parameter></methodparam>
- <methodparam><parameter role="keyword">target</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-atkobject">atk.Object</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-atkobject">
- <title>atk.Object Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"accessible-component-layer"</entry>
- <entry>Read</entry>
- <entry>The accessible layer of this object. Allowed values: >= 0.
- Default value: 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-component-mdi-zorder"</entry>
- <entry>Read</entry>
- <entry>The accessible MDI value of this object. Default value:
- -2147483648</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-description"</entry>
- <entry>Read-Write</entry>
- <entry>Description of an object, formatted for assistive
- technology access. Default value: <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-hypertext-nlinks"</entry>
- <entry>Read</entry>
- <entry>The number of links which the current <link
- linkend="class-atkhypertext"><classname>atk.Hypertext</classname></link>
- has. Allowed values: >= 0. Default value: 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-name"</entry>
- <entry>Read-Write</entry>
- <entry>Object instance's name formatted for assistive technology
- access. Default value: <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-parent"</entry>
- <entry>Read-Write</entry>
- <entry>Is used to notify that the parent has changed.</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-role"</entry>
- <entry>Read-Write</entry>
- <entry>The accessible role of this object. Allowed values: >= 0.
- Default value: 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-table-caption"</entry>
- <entry>Read-Write</entry>
- <entry>Is used to notify that the table caption has changed; this
- property should not be used. "accessible-table-caption-object"
- should be used instead. Default value:
- <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-table-caption-object"</entry>
- <entry>Read-Write</entry>
- <entry>Is used to notify that the table caption has changed</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-table-column-description"</entry>
- <entry>Read-Write</entry>
- <entry>Is used to notify that the table column description has
- changed. Default value: <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-table-column-header"</entry>
- <entry>Read-Write</entry>
- <entry>Is used to notify that the table column header has
- changed</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-table-row-description"</entry>
- <entry>Read-Write</entry>
- <entry>Is used to notify that the table row description has
- changed. Default value: <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-table-row-header"</entry>
- <entry>Read-Write</entry>
- <entry>Is used to notify that the table row header has changed</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-table-summary"</entry>
- <entry>Read-Write</entry>
- <entry>Is used to notify that the table summary has changed</entry>
- </row>
-
- <row valign="top">
- <entry>"accessible-value"</entry>
- <entry>Read-Write</entry>
- <entry>Is used to notify that the value has changed. Allowed
- values: >= 0. Default value: 0.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atkobject">
- <title>atk.Object Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-atkobject--active-descendant-changed">active-descendant-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>object</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atkobject--children-changed">children-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>index</parameter></methodparam>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atkobject--focus-event">focus-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>has_focus</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atkobject--property-change">property-change</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atkobject--state-change">state-change</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>state</parameter></methodparam>
- <methodparam><parameter>is_set</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atkobject--visible-data-changed">visible-data-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>This class is the primary class for accessibility support via the
- Accessibility ToolKit (ATK). Objects that are instances of <link
- linkend="class-atkobject"><classname>atk.Object</classname></link> (or
- instances of <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>-derived
- types) are queried for properties which relate basic (and generic)
- properties of a UI component such as name and description. Instances of
- <link linkend="class-atkobject"><classname>atk.Object</classname></link>
- may also be queried as to whether they implement other ATK interfaces
- (e.g. <link
- linkend="class-atkaction"><classname>atk.Action</classname></link>,
- <link
- linkend="class-atkcomponent"><classname>atk.Component</classname></link>,
- etc.), as appropriate to the role which a given UI component plays in a
- user interface.</para>
-
- <para>All UI components in an applicationthat provide useful information
- or services to the user must provide corresponding <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- instances on request (in GTK+, for instance, usually on a call to the
- <link
- linkend="method-gtkwidget--get-accessible"><methodname>gtk.Widget.get_accessible()</methodname></link>
- method), either via ATK support built into the toolkit for the widget
- class or ancestor class, or in the case of custom widgets, if the
- inherited <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- implementation is insufficient, via instances of a new <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- subclass.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkobject--get-name">
- <title>atk.Object.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a character string representing the accessible
- name of the object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the accessible name of the accessible.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--get-description">
- <title>atk.Object.get_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_description</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a character string representing the accessible
- description of the accessible.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the accessible description of the accessible.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--get-parent">
- <title>atk.Object.get_parent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_parent</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- representing the accessible parent of the
- accessible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the accessible parent of the accessible.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--get-n-accessible-children">
- <title>atk.Object.get_n_accessible_children</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_accessible_children</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer representing the number of
- accessible children of the accessible.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the number of accessible children of the accessible.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--ref-accessible-child">
- <title>atk.Object.ref_accessible_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ref_accessible_child</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>an integer representing the position of the
- child, starting from 0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- representing the specified accessible child of the
- accessible.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets a reference to the specified accessible child of the
- object. The accessible children are 0-based so the first accessible
- child is at index 0, the second at index 1 and so on.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--ref-relation-set">
- <title>atk.Object.ref_relation_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ref_relation_set</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkrelationset"><classname>atk.RelationSet</classname></link>
- representing the relation set of the object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the <link
- linkend="class-atkrelationset"><classname>atk.RelationSet</classname></link>
- associated with the object.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--get-role">
- <title>atk.Object.get_role</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_role</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>one of the <xref linkend="atk-role-constants"
- endterm="atk-role-constants-title"></xref> which is the role of
- the accessible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the role of the accessible.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--get-layer">
- <title>atk.Object.get_layer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_layer</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>one of the <xref linkend="atk-layer-constants"
- endterm="atk-layer-constants-title"></xref> which is the layer of
- the accessible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is deprecated. Use the <link
- linkend="method-atkcomponent--get-layer"><methodname>atk.Component.get_layer</methodname>()</link>
- method instead.</para>
- </note>
-
- <para>Gets the layer of the accessible.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--get-mdi-zorder">
- <title>atk.Object.get_mdi_zorder</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_mdi_zorder</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer which is the zorder of the
- accessible, i.e. the depth at which the component is shown in
- relation to other components in the same
- container.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is deprecated. Use the <link
- linkend="method-atkcomponent--get-mdi-zorder"><methodname>atk.Component.get_mdi_zorder</methodname>()</link>
- method instead.</para>
- </note>
-
- <para>Gets the zorder of the accessible. The value
- <literal>G_MININT</literal> will be returned if the layer of the
- accessible is not <literal>atk.LAYER_MDI</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--ref-state-set">
- <title>atk.Object.ref_state_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ref_state_set</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a reference to an <link
- linkend="class-atkstateset"><classname>atk.StateSet</classname></link>
- which is the state set of the accessible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets a reference to the state set of the accessible.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--get-index-in-parent">
- <title>atk.Object.get_index_in_parent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_index_in_parent</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer which is the index of the accessible
- in its parent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the 0-based index of this accessible in its parent; returns
- -1 if the accessible does not have an accessible parent.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--set-name">
- <title>atk.Object.set_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_name</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a character string to be set as the accessible
- name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the accessible name of the accessible.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--set-description">
- <title>atk.Object.set_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_description</methodname>
- <methodparam><parameter role="keyword">description</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">description</parameter>&nbsp;:</term>
- <listitem><simpara>a character string to be set as the accessible
- description</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the accessible description of the accessible.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--set-parent">
- <title>atk.Object.set_parent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_parent</methodname>
- <methodparam><parameter role="keyword">parent</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- to be set as the accessible parent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the accessible parent of the accessible.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--set-role">
- <title>atk.Object.set_role</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_role</methodname>
- <methodparam><parameter role="keyword">role</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">role</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref linkend="atk-role-constants"
- endterm="atk-role-constants-title"></xref> to be set as the
- role</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the role of the accessible.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-atkobject- -connect-property-change-handler">
- <title>atk.Object.connect_property_change_handler</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>connect_property_change_handler</methodname>
- <methodparam><parameter role="keyword">handler</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">handler</parameter>&nbsp;:</term>
- <listitem><simpara>a function to be called when a property changes its value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <literal>guint</literal> which is the handler id used in
-<link linkend="method-atkobject- -remove-property-change-handler"><methodname>atk.Object.remove_property_change_handler()</methodname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Specifies a function to be called when a property changes value.</para>
-
- </refsect2>
-END -->
-
- <refsect2 id="method-atkobject--remove-property-change-handler">
- <title>atk.Object.remove_property_change_handler</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_property_change_handler</methodname>
- <methodparam><parameter role="keyword">handler_id</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">handler_id</parameter>&nbsp;:</term>
- <listitem><simpara>an integer that identifies the handler to be
- removed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Removes a property change handler.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-atkobject- -notify-state-change">
- <title>atk.Object.notify_state_change</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>notify_state_change</methodname>
- <methodparam><parameter role="keyword">state</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">state</parameter>&nbsp;:</term>
- <listitem><simpara>an <literal>AtkState</literal> whose state is
- changed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the state is being
- set on</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Emits a state-change signal for the specified state.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject- -initialize">
- <title>atk.Object.initialize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>initialize</methodname>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>a <literal>gpointer</literal> which identifies
- the object for which the <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- was created.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>This method is called when implementing subclasses of <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>.
- It does initialization required for the new object. It is intended
- that this function should called only in the
- ...<methodname>_new</methodname>() constructors used to create an
- instance of a subclass of <link
- linkend="class-atkobject"><classname>atk.Object</classname></link></para>
-
- </refsect2>
-END -->
-
- <refsect2 id="method-atkobject--add-relationship">
- <title>atk.Object.add_relationship</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_relationship</methodname>
- <methodparam><parameter role="keyword">relationship</parameter></methodparam>
- <methodparam><parameter role="keyword">target</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">relationship</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-relation-type-constants"
- endterm="atk-relation-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- which is to be the target of the relation.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the relationship is
- added.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Adds a relationship of the specified type with the specified
- target.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobject--remove-relationship">
- <title>atk.Object.remove_relationship</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_relationship</methodname>
- <methodparam><parameter role="keyword">relationship</parameter></methodparam>
- <methodparam><parameter role="keyword">target</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">relationship</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-relation-type-constants"
- endterm="atk-relation-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- which is the target of the relation to be
- removed.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the relationship is
- removed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Removes a relationship of the specified type with the specified
- target.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-atkobject--active-descendant-changed">
- <title>The "active-descendant-changed" atk.Object Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>obj</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atkobject</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>obj</parameter>&nbsp;:</term>
- <listitem><simpara>the newly focused object.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "active-descendant-changed" signal is emitted by an object
- which has the state <literal>atk.STATE_MANAGES_DESCENDANTS</literal>
- when the focus object in the object changes. For instance, a table
- will emit the signal when the cell in the table which has focus
- changes.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atkobject--children-changed">
- <title>The "children-changed" atk.Object Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>index</parameter></methodparam>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atkobject</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>index</parameter>&nbsp;:</term>
- <listitem><simpara>The index of the added or removed child</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>child</parameter>&nbsp;:</term>
- <listitem><simpara>The child which was added or removed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The signal "children-changed" is emitted when a child is added
- or removed form an object. It supports two details: "add" and
- "remove"</para>
-
- </refsect2>
-
- <refsect2 id="signal-atkobject--focus-event">
- <title>The "focus-event" atk.Object Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>has_focus</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atkobject</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>has_focus</parameter>&nbsp;:</term>
- <listitem><simpara>A boolean value which indicates whether the object gained or lost focus.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The signal "focus-event" is emitted when an object gains or
- loses focus.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atkobject--property-change">
- <title>The "property-change" atk.Object Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atkobject</parameter>&nbsp;:</term>
- <listitem><simpara>the object that received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter>&nbsp;:</term>
- <listitem><simpara>The new value of the property that
- changed.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The signal "property-change" is emitted when an object's
- property value changes. The detail identifies the name of the property
- whose value has changed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atkobject--state-change">
- <title>The "state-change" atk.Object Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>state</parameter></methodparam>
- <methodparam><parameter>is_set</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atkobject</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>state</parameter>&nbsp;:</term>
- <listitem><simpara>The name of the state which has
- changed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>is_set</parameter>&nbsp;:</term>
- <listitem><simpara>A boolean which indicates whether the state has
- been set or unset.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "state-change" signal is emitted when an object's state
- changes. The detail value identifies the state type which has
- changed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atkobject--visible-data-changed">
- <title>The "visible-data-changed" atk.Object Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkobject</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atkobject</parameter>&nbsp;:</term>
- <listitem><simpara>the object that received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "visible-data-changed" signal is emitted when the visual
- appearance of the object changed.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkobjectfactory.xml b/docs/reference/pygtk-atkobjectfactory.xml
deleted file mode 100644
index 79898445..00000000
--- a/docs/reference/pygtk-atkobjectfactory.xml
+++ /dev/null
@@ -1,136 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkobjectfactory">
-
- <refnamediv>
- <refname>atk.ObjectFactory</refname>
- <refpurpose>the base object class for a factory used to create
- accessible objects for objects of a specific GType. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.ObjectFactory</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobjectfactory--create-accessible">create_accessible</link></methodname>
- <methodparam><parameter role="keyword">obj</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobjectfactory--invalidate">invalidate</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkobjectfactory--get-accessible-type">get_accessible_type</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-atkobjectfactory">atk.ObjectFactory</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atkobjectfactory">
- <title>atk.ObjectFactory Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>This class is the base object class for a factory used to create
- an accessible object for a specific GType. The method <link
- linkend="method-atkregistry--set-factory-type"><methodname>atk.Registry.set_factory_type()</methodname></link>
- is normally called to store in the registry the factory type to be used
- to create an accessible of a particular GType.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkobjectfactory--create-accessible">
- <title>atk.ObjectFactory.create_accessible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_accessible</methodname>
- <methodparam><parameter role="keyword">obj</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">obj</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gobject"><classname>gobject.GObject</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- that implements an accessibility interface on behalf of
- <parameter>obj</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Provides an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- that implements an accessibility interface on behalf of
- <parameter>obj</parameter></para>
-
- </refsect2>
-
- <refsect2 id="method-atkobjectfactory--invalidate">
- <title>atk.ObjectFactory.invalidate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>invalidate</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>Inform the factory that it is no longer being used to create
- accessibles. When called, the factory may need to inform the <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- objects it has created that they need to be re-instantiated. Note:
- primarily used for runtime replacement of <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- objects in object registries.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkobjectfactory--get-accessible-type">
- <title>atk.ObjectFactory.get_accessible_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_accessible_type</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the type of the accessible which is created by
- the <parameter>factory</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the GType of the accessible which is created by the
- factory. The value <literal>gobject.TYPE_INVALID</literal> is
- returned if no type if found.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkrectangle.xml b/docs/reference/pygtk-atkrectangle.xml
deleted file mode 100644
index 6b3ed2fc..00000000
--- a/docs/reference/pygtk-atkrectangle.xml
+++ /dev/null
@@ -1,134 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkrectangle">
-
- <refnamediv>
- <refname>atk.Rectangle</refname>
- <refpurpose>an object holding data about a rectangle</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Rectangle</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-atkrectangle">atk.Rectangle</link></methodname>
- <methodparam><parameter
- role="keyword">x</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter>
- <initializer>0</initializer></methodparam>
- </constructorsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"x"</entry>
- <entry>Read-Write</entry>
- <entry>The X coordinate of the top left corner of the
- rectangle.</entry>
- </row>
-
- <row valign="top">
- <entry>"y"</entry>
- <entry>Read-Write</entry>
- <entry>The Y coordinate of the top left corner of the
- rectangle.</entry>
- </row>
-
- <row valign="top">
- <entry>"width"</entry>
- <entry>Read-Write</entry>
- <entry>The width of the rectangle.</entry>
- </row>
-
- <row valign="top">
- <entry>"height"</entry>
- <entry>Read-Write</entry>
- <entry>The height of the rectangle.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
- linkend="class-gdkrectangle"><classname>atk.Rectangle</classname></link>
- holds the position and size of a rectangle. The position is specified by
- the "x" and "y" attributes and the size, by the "width" and "height"
- attributes.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-atkrectangle">
- <title>atk.Rectangle</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>atk.Rectangle</methodname>
- <methodparam><parameter
- role="keyword">x</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter>
- <initializer>0</initializer></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-atkrectangle"><classname>atk.Rectangle</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
- linkend="class-atkrectangle"><classname>atk.Rectangle</classname></link>
- with the attributes specified by <parameter>x</parameter>,
- <parameter>y</parameter>, <parameter>width</parameter> and
- <parameter>height</parameter>. Any unspecified attributes default to
- 0.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkregistry.xml b/docs/reference/pygtk-atkregistry.xml
deleted file mode 100644
index 88f01019..00000000
--- a/docs/reference/pygtk-atkregistry.xml
+++ /dev/null
@@ -1,219 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkregistry">
-
- <refnamediv>
- <refname>atk.Registry</refname>
- <refpurpose>an object used to store the GType of the factories used to
- create an accessible object for an object of a particular GType.
- </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Registry</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkregistry--set-factory-type">set_factory_type</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- <methodparam><parameter role="keyword">factory_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkregistry--get-factory-type">get_factory_type</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkregistry--get-factory">get_factory</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-atk--get-default-registry">atk.get_default_registry</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-atkregistry">atk.Registry</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atkregistry">
- <title>atk.Registry Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
-<para>The <link
-linkend="class-atkregistry"><classname>atk.Registry</classname></link> is
-normally used to create appropriate ATK "peers" for user interface
-components. Application developers usually need only interact with the <link
-linkend="class-atkregistry"><classname>atk.Registry</classname></link> by
-associating appropriate ATK implementation classes with <link
-linkend="class-gobject"><classname>gobject.GObject</classname></link>
-classes via the <link
-linkend="method-atkregistry--set-factory-type"><methodname>set_factory_type</methodname>()</link>
-method, passing the appropriate GType for application custom widget
-classes.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkregistry--set-factory-type">
- <title>atk.Registry.set_factory_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_factory_type</methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- <methodparam><parameter role="keyword">factory_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>an <link linkend="class-atkobject"><classname>atk.Object</classname></link> type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">factory_type</parameter>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- type to associate with <parameter>type</parameter>. Must
- implement the <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- appropriate for <parameter>type</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Associate an <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- subclass with a <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- type. Note: The associated <parameter>factory_type</parameter> will
- thereafter be responsible for the creation of new <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- implementations for instances appropriate for
- <parameter>type</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkregistry--get-factory-type">
- <title>atk.Registry.get_factory_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_factory_type</methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- type with which to look up the associated <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- subclass</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- type associated with <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- <parameter>type</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Returns a <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- subclass associated with <parameter>type</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkregistry--get-factory">
- <title>atk.Registry.get_factory</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_factory</methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- with which to look up the associated <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- appropriate for creating <parameter>type</parameter> <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>s.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets an <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- appropriate for creating <parameter>type</parameter> <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>s.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-atk--get-default-registry">
- <title>atk.get_default_registry</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.get_default_registry</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a default implementation of the <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- type registry</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets a default implementation of the <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- type registry. Note: For most toolkit maintainers, this will be the
- correct registry for registering new <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- factories. Following a call to this function, maintainers may call the
- <link
- linkend="method-atkregistry--set-factory-type"><methodname>set_factory_type</methodname>()</link>
- method to associate an <link
- linkend="class-atkobjectfactory"><classname>atk.ObjectFactory</classname></link>
- subclass with the type of objects for whom accessibility information
- will be provided.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkrelation.xml b/docs/reference/pygtk-atkrelation.xml
deleted file mode 100644
index ec4db48b..00000000
--- a/docs/reference/pygtk-atkrelation.xml
+++ /dev/null
@@ -1,298 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkrelation">
-
- <refnamediv>
- <refname>atk.Relation</refname>
- <refpurpose>an object used to describe a relation between a object and
- one or more other objects. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Relation</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-atkrelation">atk.Relation</link></methodname>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- <methodparam><parameter role="keyword">relationship</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkrelation--get-relation-type">get_relation_type</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkrelation--get-target">get_target</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-atk--relation-type-register">atk.relation_type_register</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-atk--relation-type-get-name">atk.relation_type_get_name</link></methodname>
- <methodparam><parameter role="keyword">relationship</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-atk--relation-type-for-name">atk.relation_type_for_name</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-atkrelation">atk.Relation</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-atkrelation">
- <title>atk.Relation Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"relation-type"</entry>
- <entry>Read-Write</entry>
- <entry>The type of the relation - one of the <xref
- linkend="atk-relation-type-constants"
- endterm="atk-relation-type-constants-title"></xref>. Default
- value: atk.RELATION_NULL.</entry>
- </row>
-
- <row valign="top">
- <entry>"target"</entry>
- <entry>Read-Write</entry>
- <entry>An array of the targets for the relation. Default value:
- None.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atkrelation">
- <title>atk.Relation Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>An <link
- linkend="class-atkrelation"><classname>atk.Relation</classname></link>
- describes a relation between an object and one or more other
- objects. The actual relations that an object has with other objects are
- defined as an <link
- linkend="class-atkrelationset"><classname>atk.RelationSet</classname></link>,
- which contains a set of <link
- linkend="class-atkrelation"><classname>atk.Relation</classname></link>
- objects.
-
-
-</para>
-
-
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-atkrelation">
- <title>atk.Relation</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>atk.Relation</methodname>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- <methodparam><parameter role="keyword">relationship</parameter></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of <link
- linkend="class-atkobject"><classname>atk.Object</classname>
- objects</link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">relationship</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-relation-type-constants"
- endterm="atk-relation-type-constants-title"></xref> with which to
- create the new <link
- linkend="class-atkrelation"><classname>atk.Relation</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-atkrelation"><classname>atk.Relation</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Create a new relation for the specified
- <parameter>relationship</parameter> type and the specified sequence of
- <parameter>targets</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkrelation--get-relation-type">
- <title>atk.Relation.get_relation_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_relation_type</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the relation type - one of the <xref
- linkend="atk-relation-type-constants"
- endterm="atk-relation-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the relationship type.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkrelation--get-target">
- <title>atk.Relation.get_target</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_target</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the target list of <parameter>relation</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the target list of <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- objects.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-atk--relation-type-register">
- <title>atk.relation_type_register</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.relation_type_register</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a name string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new one of the <xref
- linkend="atk-relation-type-constants"
- endterm="atk-relation-type-constants-title"></xref> that is
- associated with <parameter>name</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Associate <parameter>name</parameter> with a new one of the <xref
- linkend="atk-relation-type-constants"
- endterm="atk-relation-type-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="function-atk--relation-type-get-name">
- <title>atk.relation_type_get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.relation_type_get_name</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-relation-type-constants"
- endterm="atk-relation-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the string associated with
- <parameter>relationship</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the description string describing the relation type
- specified by <parameter>type</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-atk--relation-type-for-name">
- <title>atk.relation_type_for_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.relation_type_for_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a string which is the (non-localized) name of
- an ATK relation type.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the matching type of the <xref
- linkend="atk-relation-type-constants"
- endterm="atk-relation-type-constants-title"></xref> corresponding
- to the specified <parameter>name</parameter>, or
- <literal>atk.RELATION_NULL</literal> if no matching relation type
- is found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Get the relation type corresponding to the specified
- <parameter>name</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkrelationset.xml b/docs/reference/pygtk-atkrelationset.xml
deleted file mode 100644
index 82a73c92..00000000
--- a/docs/reference/pygtk-atkrelationset.xml
+++ /dev/null
@@ -1,263 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkrelationset">
-
- <refnamediv>
- <refname>atk.RelationSet</refname>
- <refpurpose>a set of <link
- linkend="class-atkrelation"><classname>atk.Relation</classname></link>
- objects, normally the set of <link
- linkend="class-atkrelation"><classname>atk.Relation</classname></link>
- objects that an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- has.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.RelationSet</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-atkrelationset">atk.RelationSet</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkrelationset--contains">contains</link></methodname>
- <methodparam><parameter role="keyword">relationship</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkrelationset--remove">remove</link></methodname>
- <methodparam><parameter role="keyword">relation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkrelationset--add">add</link></methodname>
- <methodparam><parameter role="keyword">relation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkrelationset--get-n-relations">get_n_relations</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkrelationset--get-relation">get_relation</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkrelationset--get-relation-by-type">get_relation_by_type</link></methodname>
- <methodparam><parameter role="keyword">relationship</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-atkrelationset">atk.RelationSet</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atkrelationset">
- <title>atk.RelationSet Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
- linkend="class-atkrelationset"><classname>atk.RelationSet</classname></link>
- held by an object establishes its relationships with objects beyond the
- normal "parent/child" hierarchical relationships that all user interface
- objects have. <link
- linkend="class-atkrelationset"><classname>atk.RelationSet</classname></link>
- objects establish whether objects are labelled or controlled by other
- components, share group membership with other components (for instance
- within a radio-button group), or share content which "flows" between
- them, among other types of possible relationships.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-atkrelationset">
- <title>atk.RelationSet</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>atk.RelationSet</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-atkrelationset"><classname>atk.RelationSet</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new empty relation set.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkrelationset--contains">
- <title>atk.RelationSet.contains</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>contains</methodname>
- <methodparam><parameter role="keyword">relationship</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">relationship</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-relation-type-constants"
- endterm="atk-relation-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>relationship</parameter> is the relationship
- type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Determines whether the relation set contains a relation that
- matches the type specified by
- <parameter>relationship</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkrelationset--remove">
- <title>atk.RelationSet.remove</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove</methodname>
- <methodparam><parameter role="keyword">relation</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">relation</parameter>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkrelation"><classname>atk.Relation</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Removes a relation from the relation set.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkrelationset--add">
- <title>atk.RelationSet.add</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add</methodname>
- <methodparam><parameter role="keyword">relation</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">relation</parameter>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkrelation"><classname>atk.Relation</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Add a new <link
- linkend="class-atkrelation"><classname>atk.Relation</classname></link>
- to the current relation set if it is not already present.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkrelationset--get-n-relations">
- <title>atk.RelationSet.get_n_relations</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_relations</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer representing the number of relations
- in the set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Returns the number of relations in a relation set.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkrelationset--get-relation">
- <title>atk.RelationSet.get_relation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_relation</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a position in the set,
- starting from 0.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-atkrelation"><classname>atk.Relation</classname></link>,
- that is the relation at position <parameter>i</parameter> in the
- set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Determines the relation at the specified position in the relation set.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkrelationset--get-relation-by-type">
- <title>atk.RelationSet.get_relation_by_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_relation_by_type</methodname>
- <methodparam><parameter role="keyword">relationship</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">relationship</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-relation-type-constants"
- endterm="atk-relation-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkrelation"><classname>atk.Relation</classname></link>,
- which is a relation matching the specified
- type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Finds a relation that matches the specified type.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkselection.xml b/docs/reference/pygtk-atkselection.xml
deleted file mode 100644
index bcb79082..00000000
--- a/docs/reference/pygtk-atkselection.xml
+++ /dev/null
@@ -1,322 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkselection">
-
- <refnamediv>
- <refname>atk.Selection</refname>
- <refpurpose>the ATK interface implemented by container objects whose
- <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- children can be selected. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Selection</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkselection--add-selection">add_selection</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkselection--clear-selection">clear_selection</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkselection--ref-selection">ref_selection</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkselection--get-selection-count">get_selection_count</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkselection--is-child-selected">is_child_selected</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkselection--remove-selection">remove_selection</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkselection--select-all-selection">select_all_selection</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atkselection">
- <title>atk.Selection Signal Prototypes</title>
-
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-atkselection--selection-changed">selection-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkselection</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-atkselection"><classname>atk.Selection</classname></link>
- should be implemented by UI components with children which are exposed
- by the <link
- linkend="method-atkobject--ref-accessible-child"><methodname>ref_accessible_child</methodname>()</link>
- and <link
- linkend="method-atkobject--get-n-accessible-children"><methodname>get_n_accessible_children</methodname>()</link>
- methods, if the use of the parent UI component ordinarily involves
- selection of one or more of the objects corresponding to those <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- children - for example, selectable lists.</para>
-
- <para>Note that other types of "selection" (for instance text selection)
- are accomplished a other ATK interfaces - <link
- linkend="class-atkselection"><classname>atk.Selection</classname></link>
- is limited to the selection/deselection of children.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkselection--add-selection">
- <title>atk.Selection.add_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_selection</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>an index specifying the child
- index.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if success,
- <literal>False</literal> otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Adds the specified accessible child of the object to the
- object's selection.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkselection--clear-selection">
- <title>atk.Selection.clear_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear_selection</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if success,
- <literal>False</literal> otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Clears the selection in the object so that no children in the
- object are selected.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkselection--ref-selection">
- <title>atk.Selection.ref_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ref_selection</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>an index specifying the index in the selection
- set. (e.g. the ith selection as opposed to the ith
- child).</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- representing the selected accessible , or <literal>None</literal>
- if the selection does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets a reference to the accessible object representing the
- specified selected child of the object. Note: callers should not rely
- on <literal>None</literal> or on a zero value for indication of
- whether the <link
- linkend="class-atkselection"><classname>atk.Selection</classname></link>
- interface is implemented.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkselection--get-selection-count">
- <title>atk.Selection.get_selection_count</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selection_count</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer representing the number of items
- selected, or 0 if the selection does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the number of accessible children currently selected.
- Note: callers should not rely on <literal>None</literal> or on a zero
- value for indication of whether the <link
- linkend="class-atkselection"><classname>atk.Selection</classname></link>
- interface is implemented.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkselection--is-child-selected">
- <title>atk.Selection.is_child_selected</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_child_selected</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>an index specifying the child
- index.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the specified child
- is selected, or 0 if the selection does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Determines if the current child of this object is selected Note:
- callers should not rely on <literal>None</literal> or on a zero value
- for indication of whether the <link
- linkend="class-atkselection"><classname>atk.Selection</classname></link>
- interface is implemented.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkselection--remove-selection">
- <title>atk.Selection.remove_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_selection</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>an index specifying the index in the selection
- set. (e.g. the ith selection as opposed to the ith
- child).</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if success,
- <literal>False</literal> otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Removes the specified child of the object from the object's
- selection.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkselection--select-all-selection">
- <title>atk.Selection.select_all_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_all_selection</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if success,
- <literal>False</literal> otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Causes every child of the object to be selected if the object
- supports multiple selections.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-atkselection--selection-changed">
- <title>The "selection-changed" atk.Selection Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atkselection</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atkselection</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "selection-changed" signal is emitted by an object which
- implements <link
- linkend="class-atkselection"><classname>atk.Selection</classname></link>
- interface when the selection changes.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkstateset.xml b/docs/reference/pygtk-atkstateset.xml
deleted file mode 100644
index 74baea20..00000000
--- a/docs/reference/pygtk-atkstateset.xml
+++ /dev/null
@@ -1,473 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkstateset">
-
- <refnamediv>
- <refname>atk.StateSet</refname>
- <refpurpose>an <link
- linkend="class-atkstateset"><classname>atk.StateSet</classname></link>
- determines a component's state set.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.StateSet</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-atkstateset">atk.StateSet</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstateset--is-empty">is_empty</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstateset--add-state">add_state</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstateset--add-states">add_states</link></methodname>
- <methodparam><parameter role="keyword">types</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstateset--clear-states">clear_states</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstateset--contains-state">contains_state</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstateset--contains-states">contains_states</link></methodname>
- <methodparam><parameter role="keyword">types</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstateset--remove-state">remove_state</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstateset--and-sets">and_sets</link></methodname>
- <methodparam><parameter role="keyword">compare_set</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstateset--or-sets">or_sets</link></methodname>
- <methodparam><parameter role="keyword">compare_set</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstateset--xor-sets">xor_sets</link></methodname>
- <methodparam><parameter role="keyword">compare_set</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-atk--state-type-register">atk.state_type_register</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-atk--state-type-get-name">atk.state_type_get_name</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-atk--state-type-for-name">atk.state_type_for_name</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-atkstateset">atk.StateSet</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atkstateset">
- <title>atk.StateSet Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>An <link
- linkend="class-atkstateset"><classname>atk.StateSet</classname></link>
- determines a component's state set. It is composed of a set of ATK
- states specified using the <xref linkend="atk-state-type-constants"
- endterm="atk-state-type-constants-title"></xref>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-atkstateset">
- <title>atk.StateSet</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>atk.StateSet</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-atkstateset"><classname>atk.StateSet</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new empty state set.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkstateset--is-empty">
- <title>atk.StateSet.is_empty</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_empty</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the set has no
- states set, otherwise
- <literal>False</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Checks whether the state set is empty, i.e. has no states
- set.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkstateset--add-state">
- <title>atk.StateSet.add_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_state</methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-state-type-constants"
- endterm="atk-state-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the state for
- <parameter>type</parameter> is not already in the
- set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Add a new state for the specified type to the current state set
- if it is not already present.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkstateset--add-states">
- <title>atk.StateSet.add_states</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_states</methodname>
- <methodparam><parameter role="keyword">types</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">types</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of <xref
- linkend="atk-state-type-constants"
- endterm="atk-state-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Add the states for the specified types to the current state
- set.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkstateset--clear-states">
- <title>atk.StateSet.clear_states</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear_states</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>Removes all states from the state set.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkstateset--contains-state">
- <title>atk.StateSet.contains_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>contains_state</methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-state-type-constants"
- endterm="atk-state-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>type</parameter> is the state type is in the
- set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Checks whether the state for the specified type is in the
- specified set.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkstateset--contains-states">
- <title>atk.StateSet.contains_states</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>contains_states</methodname>
- <methodparam><parameter role="keyword">types</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">types</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of <xref
- linkend="atk-state-type-constants"
- endterm="atk-state-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if all the states in
- <parameter>types</parameter> are in the set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Checks whether the states for all the specified types are in the
- specified set.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkstateset--remove-state">
- <title>atk.StateSet.remove_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_state</methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-state-type-constants"
- endterm="atk-state-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>type</parameter> was in the set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Removes the state for the specified type from the state
- set.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkstateset--and-sets">
- <title>atk.StateSet.and_sets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>and_sets</methodname>
- <methodparam><parameter role="keyword">compare_set</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">compare_set</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
- linkend="class-atkstateset"><classname>atk.StateSet</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-atkstateset"><classname>atk.StateSet</classname></link>
- which is the intersection of the two sets.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Constructs the intersection of the two sets, returning
- <literal>None</literal> if the intersection is empty.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkstateset--or-sets">
- <title>atk.StateSet.or_sets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>or_sets</methodname>
- <methodparam><parameter role="keyword">compare_set</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">compare_set</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
- linkend="class-atkstateset"><classname>atk.StateSet</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-atkstateset"><classname>atk.StateSet</classname></link>
- which is the union of the two sets, returning
- <literal>None</literal> is empty.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Constructs the union of the two sets.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkstateset--xor-sets">
- <title>atk.StateSet.xor_sets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>xor_sets</methodname>
- <methodparam><parameter role="keyword">compare_set</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">compare_set</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
- linkend="class-atkstateset"><classname>atk.StateSet</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-atkstateset"><classname>atk.StateSet</classname></link>
- which contains the states which are in exactly one of the two
- sets.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Constructs the exclusive-or of the two sets, returning
- <literal>None</literal> is empty. The set returned by this operation
- contains the states in exactly one of the two sets.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-atk--state-type-register">
- <title>atk.state_type_register</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.state_type_register</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a character string describing the new
- state.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new state type value for the new
- state.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Registers a new object state and adds it to the <xref
- linkend="atk-state-type-constants"
- endterm="atk-state-type-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="function-atk--state-type-get-name">
- <title>atk.state_type_get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.state_type_get_name</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-state-type-constants"
- endterm="atk-state-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the string describing the state
- type</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the description string describing the state type specified
- by<parameter>type</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-atk--state-type-for-name">
- <title>atk.state_type_for_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.state_type_for_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a character string state
- name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-state-type-constants"
- endterm="atk-state-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the state type corresponding to the description string
- <parameter>name</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkstreamablecontent.xml b/docs/reference/pygtk-atkstreamablecontent.xml
deleted file mode 100644
index 6026df54..00000000
--- a/docs/reference/pygtk-atkstreamablecontent.xml
+++ /dev/null
@@ -1,141 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkstreamablecontent">
-
- <refnamediv>
- <refname>atk.StreamableContent</refname>
- <refpurpose>the ATK interface which provides access to streamable
- content. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.StreamableContent</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstreamablecontent--get-n-mime-types">get_n_mime_types</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstreamablecontent--get-mime-type">get_mime_type</link></methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis>
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkstreamablecontent- -get-stream">get_stream</link></methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- </methodsynopsis>
-END -->
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>An interface whereby an object allows its backing content to be
- streamed to clients. Typical implementors would be images or icons, HTML
- content, or multimedia display/rendering widgets.</para>
-
- <para>Negotiation of content type is allowed. Clients may examine the
- backing data and transform, convert, or parse the content in order to
- present it in an alternate form to end-users.</para>
-
- <para>The <link
- linkend="class-atkstreamablecontent"><classname>atk.StreamableContent</classname></link>
- interface is particularly useful for saving, printing, or
- post-processing entire documents, or for persisting alternate views of a
- document. If document content itself is being serialized, stored, or
- converted, then use of the <link
- linkend="class-atkstreamablecontent"><classname>atk.StreamableContent</classname></link>
- interface can help address performance issues. Unlike most ATK
- interfaces, this interface is not strongly tied to the current
- user-agent view of the a particular document, but may in some cases give
- access to the underlying model data.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkstreamablecontent--get-n-mime-types">
- <title>atk.StreamableContent.get_n_mime_types</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_mime_types</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer which is the number of mime types
- supported by the object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the number of mime types supported by this object.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkstreamablecontent--get-mime-type">
- <title>atk.StreamableContent.get_mime_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_mime_type</methodname>
- <methodparam><parameter role="keyword">i</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">i</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing the position of the mime
- type starting from 0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>: a string* representing the specified mime
- type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the character string of the specified mime type. The first
- mime type is at position 0, the second at position 1, and so
- on.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-atkstreamablecontent- -get-stream">
- <title>atk.StreamableContent.get_stream</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_stream</methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mime_type</parameter>&nbsp;:</term>
- <listitem><simpara>a string representing the mime
- type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <literal>GIOChannel</literal> which contains the content in the specified mime
-type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the content in the specified mime type.</para>
-
- </refsect2>
-END -->
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atktable.xml b/docs/reference/pygtk-atktable.xml
deleted file mode 100644
index 32acac9e..00000000
--- a/docs/reference/pygtk-atktable.xml
+++ /dev/null
@@ -1,1338 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atktable">
-
- <refnamediv>
- <refname>atk.Table</refname>
- <refpurpose>the ATK interface implemented for UI components which
- contain tabular or row/column information. </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Table</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--ref-at">ref_at</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-index-at">get_index_at</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-column-at-index">get_column_at_index</link></methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-row-at-index">get_row_at_index</link></methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-n-columns">get_n_columns</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-n-rows">get_n_rows</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-column-extent-at">get_column_extent_at</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-row-extent-at">get_row_extent_at</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-caption">get_caption</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-column-description">get_column_description</link></methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-column-header">get_column_header</link></methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-row-description">get_row_description</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-row-header">get_row_header</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-summary">get_summary</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--set-caption">set_caption</link></methodname>
- <methodparam><parameter role="keyword">caption</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--set-column-description">set_column_description</link></methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- <methodparam><parameter role="keyword">description</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--set-column-header">set_column_header</link></methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- <methodparam><parameter role="keyword">header</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--set-row-description">set_row_description</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">description</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--set-row-header">set_row_header</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">header</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--set-summary">set_summary</link></methodname>
- <methodparam><parameter role="keyword">accessible</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-selected-columns">get_selected_columns</link></methodname>
- <methodparam><parameter role="keyword">selected</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--get-selected-rows">get_selected_rows</link></methodname>
- <methodparam><parameter role="keyword">selected</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--is-column-selected">is_column_selected</link></methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--is-row-selected">is_row_selected</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--is-selected">is_selected</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--add-row-selection">add_row_selection</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--remove-row-selection">remove_row_selection</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--add-column-selection">add_column_selection</link></methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktable--remove-column-selection">remove_column_selection</link></methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atktable">
- <title>atk.Table Signal Prototypes</title>
-
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-atktable--column-deleted">column-deleted</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>column</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atktable--column-inserted">column-inserted</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>column</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atktable--column-reordered">column-reordered</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atktable--model-changed">model-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atktable--row-deleted">row-deleted</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>row</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atktable--row-inserted">row-inserted</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>row</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atktable--row-reordered">row-reordered</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-atktable"><classname>atk.Table</classname></link> should
- be implemented by components which present elements ordered via rows and
- columns. It may also be used to present tree-structured information if
- the nodes of the trees can be said to contain multiple "columns".
- Individual elements of an <link
- linkend="class-atktable"><classname>atk.Table</classname></link> are
- typically referred to as "cells", and these cells are exposed by <link
- linkend="class-atktable"><classname>atk.Table</classname></link> as
- child <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- objects of the <link
- linkend="class-atktable"><classname>atk.Table</classname></link>. Both
- row/column and child-index-based access to these children is
- provided.</para>
-
- <para>Children of <link
- linkend="class-atktable"><classname>atk.Table</classname></link> are
- frequently "lightweight" objects, that is, they may not have backing
- widgets in the host UI toolkit. They are therefore often
- transient.</para>
-
- <para>Since tables are often very complex, <link
- linkend="class-atktable"><classname>atk.Table</classname></link>
- includes provision for offering simplified summary information, as well
- as row and column headers and captions. Headers and captions are <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- objects which may implement other interfaces (<link
- linkend="class-atktext"><classname>atk.Text</classname></link>, <link
- linkend="class-atkimage"><classname>atk.Image</classname></link>, etc.)
- as appropriate. <link
- linkend="class-atktable"><classname>atk.Table</classname></link>
- summaries may themselves be (simplified) <link
- linkend="class-atktable"><classname>atk.Table</classname></link>
- objects, etc.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atktable--ref-at">
- <title>atk.Table.ref_at</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ref_at</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in
- <parameter>table</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in
- <parameter>table</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- representing the referred to accessible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Get a reference to the table cell at <parameter>row</parameter>,
- <parameter>column</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-index-at">
- <title>atk.Table.get_index_at</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_index_at</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in
- <parameter>table</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in
- <parameter>table</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an index representing the index at specified
- position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the index at the specified <parameter>row</parameter> and
- <parameter>column</parameter>. The value -1 is returned if the object
- at row,column is not a child of table or table does not implement this
- interface.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-column-at-index">
- <title>atk.Table.get_column_at_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_column_at_index</methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer representing the column at the
- specified index.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets an index representing the column at the specified
- <parameter>index</parameter>, or -1 if the table does not implement
- this interface</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-row-at-index">
- <title>atk.Table.get_row_at_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_row_at_index</methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer representing the row at the
- specified index.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets an index representing the row at the specified
- <parameter>index</parameter>, or -1 if the table does not implement
- this interface</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-n-columns">
- <title>atk.Table.get_n_columns</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_columns</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer representing the number of columns,
- or 0 if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the number of columns in the table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-n-rows">
- <title>atk.Table.get_n_rows</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_rows</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer representing the number of rows, or
- 0 if value does not implement this interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the number of rows in the table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-column-extent-at">
- <title>atk.Table.get_column_extent_at</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_column_extent_at</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in
- <parameter>table</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in
- <parameter>table</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer representing the column extent at
- specified position, or 0 if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the number of columns occupied by the accessible object at
- the specified <parameter>row</parameter> and
- <parameter>column</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-row-extent-at">
- <title>atk.Table.get_row_extent_at</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_row_extent_at</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in
- <parameter>table</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in
- <parameter>table</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer representing the row extent at
- specified position, or 0 if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the number of rows occupied by the accessible object at a
- specified <parameter>row</parameter> and
- <parameter>column</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-caption">
- <title>atk.Table.get_caption</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_caption</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- representing the table caption, or <literal>None</literal> if
- value does not implement this interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the caption for the table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-column-description">
- <title>atk.Table.get_column_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_column_description</methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in the
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string representing the column description,
- or <literal>None</literal> if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the description text of the specified
- <parameter>column</parameter> in the table</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-column-header">
- <title>atk.Table.get_column_header</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_column_header</methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in the
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- representing the specified column header, or
- <literal>None</literal> if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the column header of a specified column in an accessible
- table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-row-description">
- <title>atk.Table.get_row_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_row_description</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string representing the row description, or
- <literal>None</literal> if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the description text of the specified row in the
- table</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-row-header">
- <title>atk.Table.get_row_header</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_row_header</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in the
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- representing the specified row header, or <literal>None</literal>
- if value does not implement this interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the row header of a specified row in an accessible
- table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-summary">
- <title>atk.Table.get_summary</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_summary</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- representing a summary description of the table, or zero if value
- does not implement this interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the summary description of the table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--set-caption">
- <title>atk.Table.set_caption</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_caption</methodname>
- <methodparam><parameter role="keyword">caption</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">caption</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- representing the caption to set for table</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the caption for the table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--set-column-description">
- <title>atk.Table.set_column_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_column_description</methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- <methodparam><parameter role="keyword">description</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">description</parameter>&nbsp;:</term>
- <listitem><simpara>a string representing the description text to
- set for the specified <parameter>column</parameter> of the
- table</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the description text for the specified
- <parameter>column</parameter> of the table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--set-column-header">
- <title>atk.Table.set_column_header</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_column_header</methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- <methodparam><parameter role="keyword">header</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">header</parameter>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atktable"><classname>atk.Table</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the specified column header to
- <parameter>header</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--set-row-description">
- <title>atk.Table.set_row_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_row_description</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">description</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">description</parameter>&nbsp;:</term>
- <listitem><simpara>a string representing the description text to
- set for the specified <parameter>row</parameter> of
- table</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the description text for the specified
- <parameter>row</parameter> of table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--set-row-header">
- <title>atk.Table.set_row_header</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_row_header</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">header</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">header</parameter>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atktable"><classname>atk.Table</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the specified row header to
- <parameter>header</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--set-summary">
- <title>atk.Table.set_summary</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_summary</methodname>
- <methodparam><parameter role="keyword">accessible</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">accessible</parameter>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- representing the summary description to set for
- table</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the summary description of the table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-selected-columns">
- <title>atk.Table.get_selected_columns</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selected_columns</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the indices ofthe selected
- columns.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the selected columns of the table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--get-selected-rows">
- <title>atk.Table.get_selected_rows</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selected_rows</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the indices ofthe selected
- rows.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the selected rows of the table.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--is-column-selected">
- <title>atk.Table.is_column_selected</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_column_selected</methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the column is
- selected, or 0 if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets a boolean value indicating whether the specified
- <parameter>column</parameter> is selected</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--is-row-selected">
- <title>atk.Table.is_row_selected</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_row_selected</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the row is selected,
- or 0 if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets a boolean value indicating whether the specified
- <parameter>row</parameter> is selected</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--is-selected">
- <title>atk.Table.is_selected</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_selected</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the cell is
- selected, or 0 if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets a boolean value indicating whether the accessible object at
- the specified <parameter>row</parameter> and
- <parameter>column</parameter> is selected</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--add-row-selection">
- <title>atk.Table.add_row_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_row_selection</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>row</parameter> was successfully added to selection, or
- 0 if value does not implement this interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Adds the specified <parameter>row</parameter> to the
- selection.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--remove-row-selection">
- <title>atk.Table.remove_row_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_row_selection</methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a row in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>row</parameter> was successfully removed from the
- selection, or 0 if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Removes the specified <parameter>row</parameter> from the
- selection.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--add-column-selection">
- <title>atk.Table.add_column_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_column_selection</methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>column</parameter> was successfully added to the
- selection, or 0 if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Adds the specified <parameter>column</parameter> to the
- selection.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktable--remove-column-selection">
- <title>atk.Table.remove_column_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_column_selection</methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>an index representing a column in
- table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>column</parameter> was successfully removed from the
- selection, or 0 if value does not implement this
- interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Adds the specified <parameter>column</parameter> to the
- selection.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-atktable--column-deleted">
- <title>The "column-deleted" atk.Table Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>arg1</parameter></methodparam>
- <methodparam><parameter>arg2</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atktable</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>column</parameter>&nbsp;:</term>
- <listitem><simpara>The index of the first column deleted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>The number of columns deleted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "column-deleted" signal is emitted by an object which
- implements the <link
- linkend="class-atktable"><classname>atk.Table</classname></link>
- interface when a column is deleted.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atktable--column-inserted">
- <title>The "column-inserted" atk.Table Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>column</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atktable</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>column</parameter>&nbsp;:</term>
- <listitem><simpara>The index of the column inserted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>The number of colums inserted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "column-inserted" signal is emitted by an object which
- implements the <link
- linkend="class-atktable"><classname>atk.Table</classname></link>
- interface when a column is inserted.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atktable--column-reordered">
- <title>The "column-reordered" atk.Table Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atktable</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "column-reordered" signal is emitted by an object which
- implements the <link
- linkend="class-atktable"><classname>atk.Table</classname></link>
- interface when the columns are reordered.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atktable--model-changed">
- <title>The "model-changed" atk.Table Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atktable</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "model-changed" signal is emitted by an object which
- implements the <link
- linkend="class-atktable"><classname>atk.Table</classname></link>
- interface when the model displayed by the table changes.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atktable--row-deleted">
- <title>The "row-deleted" atk.Table Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>row</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atktable</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>row</parameter>&nbsp;:</term>
- <listitem><simpara>The index of the first row deleted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>The number of rows deleted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "row-deleted" signal is emitted by an object which
- implements the <link
- linkend="class-atktable"><classname>atk.Table</classname></link>
- interface when a column is inserted.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atktable--row-inserted">
- <title>The "row-inserted" atk.Table Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>row</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atktable</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>row</parameter>&nbsp;:</term>
- <listitem><simpara>The index of the first row
- deleted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>The number of rows
- deleted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "row-inserted" signal is emitted by an object which
- implements the <link
- linkend="class-atktable"><classname>atk.Table</classname></link>
- interface when a column is inserted.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atktable--row-reordered">
- <title>The "row-reordered" atk.Table Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktable</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atktable</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "row-reordered" signal is emitted by an object which
- implements the AtkTable interface when the columns are
- reordered.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atktext.xml b/docs/reference/pygtk-atktext.xml
deleted file mode 100644
index fe69057e..00000000
--- a/docs/reference/pygtk-atktext.xml
+++ /dev/null
@@ -1,1275 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atktext">
-
- <refnamediv>
- <refname>atk.Text</refname>
- <refpurpose>the ATK interface implemented by components with text
- content.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Text</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-text">get_text</link></methodname>
- <methodparam><parameter role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">end_offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-character-at-offset">get_character_at_offset</link></methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-text-after-offset">get_text_after_offset</link></methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- <methodparam><parameter role="keyword">boundary_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-text-at-offset">get_text_at_offset</link></methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- <methodparam><parameter role="keyword">boundary_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-text-before-offset">get_text_before_offset</link></methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- <methodparam><parameter role="keyword">boundary_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-caret-offset">get_caret_offset</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-character-extents">get_character_extents</link></methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- <methodparam><parameter role="keyword">coords</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-run-attributes">get_run_attributes</link></methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-default-attributes">get_default_attributes</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-character-count">get_character_count</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-offset-at-point">get_offset_at_point</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">coords</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-n-selections">get_n_selections</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-selection">get_selection</link></methodname>
- <methodparam><parameter role="keyword">selection_num</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--add-selection">add_selection</link></methodname>
- <methodparam><parameter role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">end_offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--remove-selection">remove_selection</link></methodname>
- <methodparam><parameter role="keyword">selection_num</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--set-selection">set_selection</link></methodname>
- <methodparam><parameter role="keyword">selection_num</parameter></methodparam>
- <methodparam><parameter role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">end_offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--set-caret-offset">set_caret_offset</link></methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-range-extents">get_range_extents</link></methodname>
- <methodparam><parameter role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">end_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atktext--get-bounded-ranges">get_bounded_ranges</link></methodname>
- <methodparam><parameter role="keyword">rect</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- <methodparam><parameter role="keyword">x_clip_type</parameter></methodparam>
- <methodparam><parameter role="keyword">y_clip_type</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-atk--text-attribute-get-name">atk.text_attribute_get_name</link></methodname>
- <methodparam><parameter role="keyword">attr</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-atk--text-attribute-get-value">atk.text_attribute_get_value</link></methodname>
- <methodparam><parameter role="keyword">attr</parameter></methodparam>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-atk--text-attribute-register">atk.text_attribute_register</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-atk--text-attribute-for-name">atk.text_attribute_for_name</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-atktext">
- <title>atk.Text Signal Prototypes</title>
-
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-atktext--text-attributes-changed">text-attributes-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktext</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atktext--text-caret-moved">text-caret-moved</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktext</parameter></methodparam>
- <methodparam><parameter>position</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atktext--text-changed">text-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktext</parameter></methodparam>
- <methodparam><parameter>position</parameter></methodparam>
- <methodparam><parameter>length</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-atktext--text-selection-changed">text-selection-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktext</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-atktext"><classname>atk.Text</classname></link> should be
- implemented by <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- objects on behalf of widgets that have text content which is either
- attributed or otherwise non-trivial. <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- objects whose text content is simple, unattributed, and very brief may
- expose that content via <link
- linkend="method-atkobject--get-name"><methodname>atk.Object.get_name</methodname></link>
- instead; however if the text is editable, multi-line, typically longer
- than three or four words, attributed, selectable, or if the object
- already uses the 'name' ATK property for other information, the <link
- linkend="class-atktext"><classname>atk.Text</classname></link> interface
- should be used to expose the text content. In the case of editable text
- content, <link
- linkend="class-atkeditabletext"><classname>atk.EditableText</classname></link>
- (a subtype of the <link
- linkend="class-atktext"><classname>atk.Text</classname></link>
- interface) should be implemented instead.</para>
-
- <para><link
- linkend="class-atktext"><classname>atk.Text</classname></link> provides
- not only traversal facilities and change notification for text content,
- but also caret tracking and glyph bounding box calculations. Note that
- the text strings are exposed as UTF-8, and are therefore potentially
- multi-byte, and caret-to-byte offset mapping makes no assumptions about
- the character length; also bounding box glyph-to-offset mapping may be
- complex for languages which use ligatures.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atktext--get-text">
- <title>atk.Text.get_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text</methodname>
- <methodparam><parameter role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">end_offset</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start_offset</parameter>&nbsp;:</term>
- <listitem><simpara>start position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_offset</parameter>&nbsp;:</term>
- <listitem><simpara>end position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the text from
- <parameter>start_offset</parameter> up to, but not including
- <parameter>end_offset</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the specified text.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-character-at-offset">
- <title>atk.Text.get_character_at_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_character_at_offset</methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">offset</parameter>&nbsp;:</term>
- <listitem><simpara>position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the character at
- <parameter>offset</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the specified text.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-text-after-offset">
- <title>atk.Text.get_text_after_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text_after_offset</methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- <methodparam><parameter role="keyword">boundary_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">offset</parameter>&nbsp;:</term>
- <listitem><simpara>position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">boundary_type</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-text-boundary-constants"
- endterm="atk-text-boundary-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple containing the text after
- <parameter>offset</parameter> bounded by the specified
- <parameter>boundary_type</parameter>, the start offset of the
- returned string and the offset of the first character after the
- returned substring.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the specified text.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_CHAR</literal> the character after the
- offset is returned.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_WORD_START</literal> the returned string is
- from the word start after the offset to the next word start.</para>
-
- <para>The returned string will contain the word after the offset if
- the offset is inside a word or if the offset is not inside a
- word.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_WORD_END</literal> the returned string is
- from the word end at or after the offset to the next work end.</para>
-
- <para>The returned string will contain the word after the offset if
- the offset is inside a word and will contain the word after the word
- after the offset if the offset is not inside a word.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_SENTENCE_START</literal> the returned
- string is from the sentence start after the offset to the next
- sentence start.</para>
-
- <para>The returned string will contain the sentence after the offset
- if the offset is inside a sentence or if the offset is not inside a
- sentence.</para>
-
- <para>If the <parameter>boundary_type</parameter> is atk.TEXT_BOUNDARY_SENTENCE_END the
- returned string is from the sentence end at or after the offset to the
- next sentence end.</para>
-
- <para>The returned string will contain the sentence after the offset
- if the offset is inside a sentence and will contain the sentence after
- the sentence after the offset if the offset is not inside a
- sentence.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_LINE_START</literal> the returned string is
- from the line start after the offset to the next line start.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_LINE_END</literal> the returned string is
- from the line end at or after the offset to the next line
- start.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-text-at-offset">
- <title>atk.Text.get_text_at_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text_at_offset</methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- <methodparam><parameter role="keyword">boundary_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">offset</parameter>&nbsp;:</term>
- <listitem><simpara>position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">boundary_type</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-text-boundary-constants"
- endterm="atk-text-boundary-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple containing the text at
- <parameter>offset</parameter> bounded by the specified
- <parameter>boundary_type</parameter>, the start offset of the
- returned string and the offset of the first character after the
- returned substring.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the specified text.</para>
-
- <para>If the <parameter>boundary_type</parameter> if
- <literal>atk.TEXT_BOUNDARY_CHAR</literal> the character at the offset
- is returned.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_WORD_START</literal> the returned string is
- from the word start at or before the offset to the word start after
- the offset.</para>
-
- <para>The returned string will contain the word at the offset if the
- offset is inside a word and will contain the word before the offset if
- the offset is not inside a word.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_WORD_END</literal> the returned string is
- from the word end before the offset to the word end at or after the
- offset.</para>
-
- <para>The returned string will contain the word at the offset if the
- offset is inside a word and will contain the word after to the offset
- if the offset is not inside a word.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_SENTENCE_START</literal> the returned
- string is from the sentence start at or before the offset to the
- sentence start after the offset.</para>
-
- <para>The returned string will contain the sentence at the offset if
- the offset is inside a sentence and will contain the sentence before
- the offset if the offset is not inside a sentence.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_SENTENCE_END</literal> the returned string
- is from the sentence end before the offset to the sentence end at or
- after the offset.</para>
-
- <para>The returned string will contain the sentence at the offset if
- the offset is inside a sentence and will contain the sentence after
- the offset if the offset is not inside a sentence.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_LINE_START</literal> the returned string is
- from the line start at or before the offset to the line start after
- the offset.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_LINE_END</literal> the returned string is
- from the line end before the offset to the line end at or after the
- offset.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-text-before-offset">
- <title>atk.Text.get_text_before_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text_before_offset</methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- <methodparam><parameter role="keyword">boundary_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">offset</parameter>&nbsp;:</term>
- <listitem><simpara>position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">boundary_type</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="atk-text-boundary-constants"
- endterm="atk-text-boundary-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple containing the text before
- <parameter>offset</parameter> bounded by the specified
- <parameter>boundary_type</parameter>, the start offset of the
- returned string and the offset of the first character after the
- returned substring.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the specified text.</para>
-
- <para>If the <parameter>boundary_type</parameter> if
- <literal>atk.TEXT_BOUNDARY_CHAR</literal> the character before the
- offset is returned.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_WORD_START</literal> the returned string is
- from the word start before the word start before the offset to the
- word start before the offset.</para>
-
- <para>The returned string will contain the word before the offset if
- the offset is inside a word and will contain the word before the word
- before the offset if the offset is not inside a word.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_WORD_END</literal> the returned string is
- from the word end before the word end at or before the offset to the
- word end at or before the offset.</para>
-
- <para>The returned string will contain the word before the offset if
- the offset is inside a word or if the offset is not inside a
- word.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_SENTENCE_START</literal> the returned
- string is from the sentence start before the sentence start before the
- offset to the sentence start before the offset.</para>
-
- <para>The returned string will contain the sentence before the offset
- if the offset is inside a sentence and will contain the sentence
- before the sentence before the offset if the offset is not inside a
- sentence.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_SENTENCE_END</literal> the returned string
- is from the sentence end before the sentence end at or before the
- offset to the sentence end at or before the offset.</para>
-
- <para>The returned string will contain the sentence before the offset
- if the offset is inside a sentence or if the offset is not inside a
- sentence.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_LINE_START</literal> the returned string is
- from the line start before the line start ar or before the offset to
- the line start ar or before the offset.</para>
-
- <para>If the <parameter>boundary_type</parameter> is
- <literal>atk.TEXT_BOUNDARY_LINE_END</literal> the returned string is
- from the line end before the line end before the offset to the line
- end before the offset.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-caret-offset">
- <title>atk.Text.get_caret_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_caret_offset</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the offset position of the caret
- (cursor).</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the offset position of the caret (cursor).</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-character-extents">
- <title>atk.Text.get_character_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_character_extents</methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- <methodparam><parameter role="keyword">coords</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">offset</parameter>&nbsp;:</term>
- <listitem><simpara>The offset of the text character for which
- bounding information is required.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">coords</parameter>&nbsp;:</term>
- <listitem><simpara>specify whether coordinates are relative to the
- screen or widget window - one of the <xref
- linkend="atk-coord-type-constants"
- endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 4-tuple containing the x, y position and
- width and height of the bounding box.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Get the bounding box containing the glyph representing the
- character at a particular text offset.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-run-attributes">
- <title>atk.Text.get_run_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_run_attributes</methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">offset</parameter>&nbsp;:</term>
- <listitem><simpara>the offset at which to get the attributes</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start_offset</parameter>&nbsp;:</term>
- <listitem><simpara>the address to put </simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_offset</parameter>&nbsp;:</term>
- <listitem><simpara>the address to put </simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple containing an attribute set tuple,
- the start offset of the range and the end offset of the range. The
- attribute set tuple contains a 2-tuple of (name, value) strings
- for each attribute explicitly set at
- <parameter>offset</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a 3=tuple containing an attribute set (which consists of
- the attributes explicitly set at the position
- <parameter>offset</parameter> in the text), the start and end of the
- range around <parameter>offset</parameter> where the attributes are
- invariant. Note that the end offset is the offset of the first
- character after the range. See the <xref
- linkend="atk-text-attr-constants"
- endterm="atk-text-attr-constants-title"></xref> for types of text
- attributes that can be returned. Note that other attributes may also
- be returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-default-attributes">
- <title>atk.Text.get_default_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_attributes</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the attribute set which
- contains the default values of attributes. The attribute set tuple
- contains a 2-tuple of (name, value) strings for each
- attribute.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a tuple containing an attribute set which consists of
- the default values of attributes for the text. The attribute set
- tuple contains a 2-tuple of (name, value) strings for each attribute
- See the <xref linkend="atk-text-attr-constants"
- endterm="atk-text-attr-constants-title"></xref> for types of text
- attributes that can be returned. Note that other attributes may also
- be returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-character-count">
- <title>atk.Text.get_character_count</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_character_count</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of characters.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the character count.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-offset-at-point">
- <title>atk.Text.get_offset_at_point</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_offset_at_point</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">coords</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>screen x-position of
- character</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>screen y-position of
- character</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">coords</parameter>&nbsp;:</term>
- <listitem><simpara>specify whether coordinates are relative to the
- screen or widget window - one of the <xref
- linkend="atk-coord-type-constants"
- endterm="atk-coord-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the offset to the character which is located at
- the specified <parameter>x</parameter> and
- <parameter>y</parameter> coordinates.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the offset of the character located at coordinates
- <parameter>x</parameter> and
- <parameter>y</parameter>. <parameter>x</parameter> and
- <parameter>y</parameter> are interpreted as being relative to the
- screen or this widget's window depending on
- <parameter>coords</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-n-selections">
- <title>atk.Text.get_n_selections</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_selections</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The number of selected regions, or -1 if a
- failure occurred.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the number of selected regions.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-selection">
- <title>atk.Text.get_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selection</methodname>
- <methodparam><parameter role="keyword">selection_num</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">selection_num</parameter>&nbsp;:</term>
- <listitem><simpara>The selection number. The selected regions are
- assigned numbers that correspond to how far the region is from the
- start of the text. The selected region closest to the beginning
- of the text region is assigned the number 0, etc. Note that
- adding, moving or deleting a selected region can change the
- numbering.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple containing the selected text, the
- start position of the selected region and the end position of
- (e.g. offset immediately past) the selected
- region.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the text from the specified selection.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--add-selection">
- <title>atk.Text.add_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_selection</methodname>
- <methodparam><parameter role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">end_offset</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start_offset</parameter>&nbsp;:</term>
- <listitem><simpara>the start position of the selected
- region</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_offset</parameter>&nbsp;:</term>
- <listitem><simpara>the offset of the first character after the
- selected region.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if success,
- <literal>False</literal> otherwise</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Adds a selection bounded by the specified offsets.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--remove-selection">
- <title>atk.Text.remove_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_selection</methodname>
- <methodparam><parameter role="keyword">selection_num</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">selection_num</parameter>&nbsp;:</term>
- <listitem><simpara>The selection number. The selected regions are
- assigned numbers that correspond to how far the region is from the
- start of the text. The selected region closest to the beginning
- of the text region is assigned the number 0, etc. Note that
- adding, moving or deleting a selected region can change the
- numbering.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if success,
- <literal>False</literal> otherwise</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Removes the specified selection.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--set-selection">
- <title>atk.Text.set_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_selection</methodname>
- <methodparam><parameter role="keyword">selection_num</parameter></methodparam>
- <methodparam><parameter role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">end_offset</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">selection_num</parameter>&nbsp;:</term>
- <listitem><simpara>The selection number. The selected regions are
- assigned numbers that correspond to how far the region is from the
- start of the text. The selected region closest to the beginning
- of the text region is assigned the number 0, etc. Note that
- adding, moving or deleting a selected region can change the
- numbering.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start_offset</parameter>&nbsp;:</term>
- <listitem><simpara>the new start position of the
- selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_offset</parameter>&nbsp;:</term>
- <listitem><simpara>the new end position of (e.g. offset
- immediately past) the selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if success,
- <literal>False</literal> otherwise</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Changes the start and end offset of the specified
- selection.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--set-caret-offset">
- <title>atk.Text.set_caret_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_caret_offset</methodname>
- <methodparam><parameter role="keyword">offset</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">offset</parameter>&nbsp;:</term>
- <listitem><simpara>position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if success,
- <literal>False</literal> otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the caret (cursor) position to the specified
- <parameter>offset</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-range-extents">
- <title>atk.Text.get_range_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_range_extents</methodname>
- <methodparam><parameter role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">end_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start_offset</parameter>&nbsp;:</term>
- <listitem><simpara>The offset of the first text character for
- which boundary information is required.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_offset</parameter>&nbsp;:</term>
- <listitem><simpara>The offset of the text character after the last
- character for which boundary information is
- required.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
- <listitem><simpara>Specify whether coordinates are relative to the
- screen or widget window - one of the <xref
- linkend="atk-coord-type-constants"
- endterm="atk-coord-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-atkrectangle"><classname>atk.Rectangle</classname></link>
- containing the extents of the range.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Get the bounding box for text within the specified range.</para>
-
- </refsect2>
-
- <refsect2 id="method-atktext--get-bounded-ranges">
- <title>atk.Text.get_bounded_ranges</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_bounded_ranges</methodname>
- <methodparam><parameter role="keyword">rect</parameter></methodparam>
- <methodparam><parameter role="keyword">coord_type</parameter></methodparam>
- <methodparam><parameter role="keyword">x_clip_type</parameter></methodparam>
- <methodparam><parameter role="keyword">y_clip_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rect</parameter>&nbsp;:</term>
- <listitem><simpara>An <link
- linkend="class-atkrectangle"><classname>atk.Rectangle</classname></link>
- giving the dimensions of the bounding box.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">coord_type</parameter>&nbsp;:</term>
- <listitem><simpara>Specify whether coordinates are relative to the
- screen or widget window - one of the <xref
- linkend="atk-coord-type-constants"
- endterm="atk-coord-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x_clip_type</parameter>&nbsp;:</term>
- <listitem><simpara>Specify the horizontal clip type - one of the
- <xref linkend="atk-text-clip-type-constants"
- endterm="atk-text-clip-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y_clip_type</parameter>&nbsp;:</term>
- <listitem><simpara>Specify the vertical clip type - one of the
- <xref linkend="atk-text-clip-type-constants"
- endterm="atk-text-clip-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of text ranges. The list contains a
- 4-tuple for each text range. The 4-tuple contains a <link
- linkend="class-atkrectangle"><classname>atk.Rectangle</classname></link>
- bounding the text range, the start and end offsets of the range
- and the text in the range.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Get the ranges of text in the specified bounding box.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-atk--text-attribute-get-name">
- <title>atk.text_attribute_get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.text_attribute_get_name</methodname>
- <methodparam><parameter
- role="keyword">attr</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">attr</parameter>&nbsp;:</term>
- <listitem><simpara>a text attribute (one of the <xref
- linkend="atk-text-attr-constants"
- endterm="atk-text-attr-constants-title"></xref>) whose name is
- required</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the name corresponding to
- <parameter>attr</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-atk--text-attribute-get-value">
- <title>atk.text_attribute_get_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.text_attribute_get_value</methodname>
- <methodparam><parameter
- role="keyword">attr</parameter></methodparam>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">attr</parameter>&nbsp;:</term>
- <listitem><simpara>a text attribute (one of the <xref
- linkend="atk-text-attr-constants"
- endterm="atk-text-attr-constants-title"></xref>) whose name is
- required</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>The index of the required
- value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the
- value. <literal>None</literal> is returned if there are no values
- maintained for the <parameter>attr</parameter>
- value.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the value for the <parameter>index</parameter> of the text
- attribute specified by <parameter>attr</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-atk--text-attribute-register">
- <title>atk.text_attribute_register</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.text_attribute_register</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a name string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new one of the <xref
- linkend="atk-text-attr-constants"
- endterm="atk-text-attr-constants-title"></xref> that is associated
- with name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Associate <parameter>name</parameter> with a new text
- attribute.</para>
-
- </refsect2>
-
- <refsect2 id="function-atk--text-attribute-for-name">
- <title>atk.text_attribute_for_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>atk.text_attribute_for_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a string which is the (non-localized) name of
- an ATK text attribute.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the text attribute (one of the <xref
- linkend="atk-text-attr-constants"
- endterm="atk-text-attr-constants-title"></xref>) corresponding to
- the specified name, or
- <literal>atk.TEXT_ATTRIBUTE_INVALID</literal> if no matching text
- attribute is found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Get the text attribute type corresponding to a text attribute
- name specified by <parameter>name</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-atktext--text-attributes-changed">
- <title>The "text-attributes-changed" atk.Text Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktext</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atktext</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the
- signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "text-attributes-changed" signal is emitted when the text
- attributes of the text of an object which implements <link
- linkend="class-atktext"><classname>atk.Text</classname></link>
- changes.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atktext--text-caret-moved">
- <title>The "text-caret-moved" atk.Text Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktext</parameter></methodparam>
- <methodparam><parameter>position</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atktext</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the
- signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>position</parameter>&nbsp;:</term>
- <listitem><simpara>The new position of the text
- caret.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "text-caret-moved" signal is emitted when the caret position
- of the text of an object which implements <link
- linkend="class-atktext"><classname>atk.Text</classname></link>
- changes.</para>
-
- </refsect2>
-
- <refsect2 id="signal-atktext--text-changed">
- <title>The "text-changed" atk.Text Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktext</parameter></methodparam>
- <methodparam><parameter>position</parameter></methodparam>
- <methodparam><parameter>length</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atktext</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>position</parameter>&nbsp;:</term>
- <listitem><simpara>The position of the insertion or deletion.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>length</parameter>&nbsp;:</term>
- <listitem><simpara>The length of text inserted or deleted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "text-changed" signal is emitted when the text of the object
- which implements the <link
- linkend="class-atktext"><classname>atk.Text</classname></link>
- interface changes, This signal will have a detail which is either
- "insert" or "delete" which identifies whether the text change was an
- insertion or a deletion</para>
-
- </refsect2>
-
- <refsect2 id="signal-atktext--text-selection-changed">
- <title>The "text-selection-changed" atk.Text Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>atktext</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>atktext</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "text-selection-changed" signal is emitted when the selected
- text of an object which implements <link
- linkend="class-atktext"><classname>atk.Text</classname></link>
- changes.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-atkvalue.xml b/docs/reference/pygtk-atkvalue.xml
deleted file mode 100644
index c14e89bf..00000000
--- a/docs/reference/pygtk-atkvalue.xml
+++ /dev/null
@@ -1,144 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-atkvalue">
-
- <refnamediv>
- <refname>atk.Value</refname>
- <refpurpose>the ATK interface implemented by valuators and components
- which display or select a value from a bounded range of values.
- </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>atk.Value</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkvalue--get-current-value">get_current_value</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkvalue--get-maximum-value">get_maximum_value</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkvalue--get-minimum-value">get_minimum_value</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-atkvalue--set-current-value">set_current_value</link></methodname>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-atkvalue"><classname>atk.Value</classname></link> should
- be implemented for components which either display a value from a
- bounded range, or which allow the user to specify a value from a bounded
- range, or both. For instance, most sliders and range controls, as well
- as dials, should have <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>
- representations which implement <link
- linkend="class-atkvalue"><classname>atk.Value</classname></link> on the
- component's behalf. <link
- linkend="class-atkvalue"><classname>atk.Value</classname></link> objects
- may be read-only, in which case attempts to alter the value return
- <literal>False</literal> to indicate failure.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-atkvalue--get-current-value">
- <title>atk.Value.get_current_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_current_value</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current accessible
- value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the value of this object.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkvalue--get-maximum-value">
- <title>atk.Value.get_maximum_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_maximum_value</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the maximum accessible
- value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the maximum value of this object.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkvalue--get-minimum-value">
- <title>atk.Value.get_minimum_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_minimum_value</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the minimum accessible
- value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Gets the minimum value of this object.</para>
-
- </refsect2>
-
- <refsect2 id="method-atkvalue--set-current-value">
- <title>atk.Value.set_current_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_current_value</methodname>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>the desired new accessible
- value.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if new value is
- successfully set, <literal>False</literal>
- otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Sets the value of this object.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdk-classes.xml b/docs/reference/pygtk-gdk-classes.xml
deleted file mode 100644
index 13cf4f03..00000000
--- a/docs/reference/pygtk-gdk-classes.xml
+++ /dev/null
@@ -1,37 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<chapter id="gdk-class-reference" xmlns:xi="http://www.w3.org/2001/XInclude">
- <title>The gtk.gdk Class Reference</title>
-
-<!-- GDK CLASSES -->
-
- <xi:include href="pygtk-gdkatom.xml"/>
- <xi:include href="pygtk-gdkcairocontext.xml"/>
- <xi:include href="pygtk-gdkcolor.xml"/>
- <xi:include href="pygtk-gdkcolormap.xml"/>
- <xi:include href="pygtk-gdkcursor.xml"/>
- <xi:include href="pygtk-gdkdevice.xml"/>
- <xi:include href="pygtk-gdkdisplay.xml"/>
- <xi:include href="pygtk-gdkdisplaymanager.xml"/>
- <xi:include href="pygtk-gdkdragcontext.xml"/>
- <xi:include href="pygtk-gdkdrawable.xml"/>
- <xi:include href="pygtk-gdkevent.xml"/>
- <xi:include href="pygtk-gdkgc.xml"/>
- <xi:include href="pygtk-gdkimage.xml"/>
- <xi:include href="pygtk-gdkkeymap.xml"/>
- <xi:include href="pygtk-gdkpangorenderer.xml"/>
- <xi:include href="pygtk-gdkpixbuf.xml"/>
- <xi:include href="pygtk-gdkpixbufanimation.xml"/>
- <xi:include href="pygtk-gdkpixbufanimationiter.xml"/>
- <xi:include href="pygtk-gdkpixbufloader.xml"/>
- <xi:include href="pygtk-gdkpixmap.xml"/>
- <xi:include href="pygtk-gdkrectangle.xml"/>
- <xi:include href="pygtk-gdkregion.xml"/>
- <xi:include href="pygtk-gdkscreen.xml"/>
- <xi:include href="pygtk-gdkvisual.xml"/>
- <xi:include href="pygtk-gdkwindow.xml"/>
- <xi:include href="pygtk-gdk-functions.xml"/>
- <xi:include href="pygtk-gdk-constants.xml"/>
-
-</chapter>
diff --git a/docs/reference/pygtk-gdk-constants.xml b/docs/reference/pygtk-gdk-constants.xml
deleted file mode 100644
index 486e8f04..00000000
--- a/docs/reference/pygtk-gdk-constants.xml
+++ /dev/null
@@ -1,2715 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="gdk-constants">
- <refnamediv>
- <refname>gtk.gdk Constants</refname>
- <refpurpose>the built-in constants of the gtk.gdk module</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <programlisting>
-<xref linkend="gdk-drag-action-constants" endterm="gdk-drag-action-constants-title"></xref>
-<xref linkend="gdk-device-axis-use" endterm="gdk-device-axis-use-title"></xref>
-<xref linkend="gdk-byte-order-constants" endterm="gdk-byte-order-constants-title"></xref>
-<xref linkend="gdk-cap-style-constants" endterm="gdk-cap-style-constants-title"></xref>
-<xref linkend="gdk-crossing-mode-constants" endterm="gdk-crossing-mode-constants-title"></xref>
-<xref linkend="gdk-cursor-type-constants" endterm="gdk-cursor-type-constants-title"></xref>
-<xref linkend="gdk-drag-protocol-constants" endterm="gdk-drag-protocol-constants-title"></xref>
-<xref linkend="gdk-event-mask-constants" endterm="gdk-event-mask-constants-title"></xref>
-<xref linkend="gdk-event-type-constants" endterm="gdk-event-type-constants-title"></xref>
-<xref linkend="gdk-extension-mode-constants" endterm="gdk-extension-mode-constants-title"></xref>
-<xref linkend="gdk-fill-constants" endterm="gdk-fill-constants-title"></xref>
-<xref linkend="gdk-fill-rule-constants" endterm="gdk-fill-rule-constants-title"></xref>
-<xref linkend="gdk-filter-return-constants" endterm="gdk-filter-return-constants-title"></xref>
-<xref linkend="gdk-function-constants" endterm="gdk-function-constants-title"></xref>
-<xref linkend="gdk-gc-values-mask-constants" endterm="gdk-gc-values-mask-constants-title"></xref>
-<xref linkend="gdk-gravity-constants" endterm="gdk-gravity-constants-title"></xref>
-<xref linkend="gdk-image-type-constants" endterm="gdk-image-type-constants-title"></xref>
-<xref linkend="gdk-input-condition-constants" endterm="gdk-input-condition-constants-title"></xref>
-<xref linkend="gdk-input-mode-constants" endterm="gdk-input-mode-constants-title"></xref>
-<xref linkend="gdk-input-source-constants" endterm="gdk-input-source-constants-title"></xref>
-<xref linkend="gdk-join-style-constants" endterm="gdk-join-style-constants-title"></xref>
-<xref linkend="gdk-line-style-constants" endterm="gdk-line-style-constants-title"></xref>
-<xref linkend="gdk-modifier-constants" endterm="gdk-modifier-constants-title"></xref>
-<xref linkend="gdk-notify-type-constants" endterm="gdk-notify-type-constants-title"></xref>
-<xref linkend="gdk-overlap-type-constants" endterm="gdk-overlap-type-constants-title"></xref>
-<xref linkend="gdk-owner-change-constants" endterm="gdk-owner-change-constants-title"></xref>
-<xref linkend="gdk-parent-relative-constant" endterm="gdk-parent-relative-constant-title"></xref>
-<xref linkend="gdk-pixbuf-rotation-constants" endterm="gdk-pixbuf-rotation-constants-title"></xref>
-<xref linkend="gdk-property-mode-constants" endterm="gdk-property-mode-constants-title"></xref>
-<xref linkend="gdk-property-state-constants" endterm="gdk-property-state-constants-title"></xref>
-<xref linkend="gdk-rgb-dither-constants" endterm="gdk-rgb-dither-constants-title"></xref>
-<xref linkend="gdk-scroll-direction-constants" endterm="gdk-scroll-direction-constants-title"></xref>
-<xref linkend="gdk-setting-action-constants" endterm="gdk-setting-action-constants-title"></xref>
-<xref linkend="gdk-subwindow-mode-constants" endterm="gdk-subwindow-mode-constants-title"></xref>
-<xref linkend="gdk-visibility-state-constants" endterm="gdk-visibility-state-constants-title"></xref>
-<xref linkend="gdk-visual-type-constants" endterm="gdk-visual-type-constants-title"></xref>
-<xref linkend="gdk-window-class-constants" endterm="gdk-window-class-constants-title"></xref>
-<xref linkend="gdk-window-edge-constants" endterm="gdk-window-edge-constants-title"></xref>
-<xref linkend="gdk-window-hints-constants" endterm="gdk-window-hints-constants-title"></xref>
-<xref linkend="gdk-window-state-constants" endterm="gdk-window-state-constants-title"></xref>
-<xref linkend="gdk-window-type-constants" endterm="gdk-window-type-constants-title"></xref>
-<xref linkend="gdk-window-type-hint-constants" endterm="gdk-window-type-hint-constants-title"></xref>
-<xref linkend="gdk-wm-decoration-constants" endterm="gdk-wm-decoration-constants-title"></xref>
-<xref linkend="gdk-wm-function-constants" endterm="gdk-wm-function-constants-title"></xref>
-</programlisting>
-
- </refsect1>
-
- <refsect1 id="gdk-constants-description">
- <title>Description</title>
-
- <refsect2 id="gdk-drag-action-constants">
- <title id="gdk-drag-action-constants-title">GDK Drag Action Constants</title>
-
- <para>The Drag Action constants are used by <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link>
-objects to indicate what the destination should do with the dropped
-data.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_DEFAULT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_COPY</literal></term>
- <listitem>
- <simpara>Copy the data.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_MOVE</literal></term>
- <listitem>
- <simpara>Move the data, i.e. first copy it, then delete it from
-the source using the DELETE target of the X selection protocol.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_LINK</literal></term>
- <listitem>
- <simpara>Add a link to the data. Note that this is only useful
-if source and destination agree on what it means.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_PRIVATE</literal></term>
- <listitem>
- <simpara>Special action which tells the source that the
-destination will do something that the source doesn't understand.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_ASK</literal></term>
- <listitem>
- <simpara>Ask the user what to do with the data.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-device-axis-use">
- <title id="gdk-device-axis-use-title">GDK Device Axis Use Constants</title>
-
- <para>The Device Axis constants describing the way in which a device
-axis (valuator) maps onto predefined valuator types.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_IGNORE</literal></term>
- <listitem>
- <simpara>the axis is ignored.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_X</literal></term>
- <listitem>
- <simpara>the axis is used as the x axis.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_Y</literal></term>
- <listitem>
- <simpara>the axis is used as the y axis.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_PRESSURE</literal></term>
- <listitem>
- <simpara>the axis is used for pressure information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_XTILT</literal></term>
- <listitem>
- <simpara>the axis is used for x tilt information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_YTILT</literal></term>
- <listitem>
- <simpara>the axis is used for y tilt information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_WHEEL</literal></term>
- <listitem>
- <simpara>the axis is used for wheel information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_LAST</literal></term>
- <listitem>
- <simpara>a constant equal to the numerically highest axis
-value.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-byte-order-constants">
- <title id="gdk-byte-order-constants-title">GDK Byte Order Constants</title>
-
- <para>The Byte Order constants specify a set of values describing the
-possible byte-orders for storing pixel values in memory.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.LSB_FIRST</literal></term>
- <listitem>
- <simpara>The values are stored with the least-significant byte
- first. For instance, the 32-bit value 0xffeecc would be stored
- in memory as 0xcc, 0xee, 0xff, 0x00.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MSB_FIRST</literal></term>
- <listitem>
- <simpara>The values are stored with the most-significant byte
- first. For instance, the 32-bit value 0xffeecc would be stored
- in memory as 0x00, 0xcc, 0xee, 0xff.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-cap-style-constants">
- <title id="gdk-cap-style-constants-title">GDK Cap Style Constants</title>
-
- <para>The Cap Style constants specify how the end of lines are
-drawn.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.CAP_NOT_LAST</literal></term>
- <listitem>
- <simpara>The same as <literal>gtk.gdk.CAP_BUTT</literal> for
-lines of non-zero width but for zero width lines, the final point on the
-line will not be drawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CAP_BUTT</literal></term>
- <listitem>
- <simpara>The ends of the lines are drawn squared off and
-extending to the coordinates of the end point.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CAP_ROUND</literal></term>
- <listitem>
- <simpara>The ends of the lines are drawn as semicircles with the
-diameter equal to the line width and centered at the end point.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CAP_PROJECTING</literal></term>
- <listitem>
- <simpara>The ends of the lines are drawn squared off and
-extending half the width of the line beyond the end point.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-crossing-mode-constants">
- <title id="gdk-crossing-mode-constants-title">GDK Crossing Mode Constants</title>
-
- <para>The Crossing Mode constants specify the crossing mode for the
-Crossing <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></para>
-
- <variablelist>
- <varlistentry>
- <term><literal></literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal></literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-cursor-type-constants">
- <title id="gdk-cursor-type-constants-title">GDK Cursor Type Constants</title>
-
- <para>The Cursor Type constants specify the set of standard cursors
-available.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.X_CURSOR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/X_cursor.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BASED_ARROW_DOWN</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/based_arrow_down.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BASED_ARROW_UP</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/based_arrow_up.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOAT</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/boat.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOGOSITY</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/bogosity.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOTTOM_LEFT_CORNER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/bottom_left_corner.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOTTOM_RIGHT_CORNER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/bottom_right_corner.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOTTOM_SIDE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/bottom_side.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOTTOM_TEE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/bottom_tee.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOX_SPIRAL</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/box_spiral.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CENTER_PTR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/center_ptr.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CIRCLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/circle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CLOCK</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/clock.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.COFFEE_MUG</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/coffee_mug.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CROSS</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/cross.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CROSS_REVERSE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/cross_reverse.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CROSSHAIR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/crosshair.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DIAMOND_CROSS</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/diamond_cross.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DOT</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/dot.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DOTBOX</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/dotbox.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DOUBLE_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/double_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAFT_LARGE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/draft_large.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAFT_SMALL</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/draft_small.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAPED_BOX</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/draped_box.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.EXCHANGE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/exchange.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.FLEUR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/fleur.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GOBBLER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/gobbler.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GUMBY</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/gumby.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HAND1</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/hand1.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HAND2</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/hand2.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HEART</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/heart.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ICON</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/icon.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.IRON_CROSS</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/iron_cross.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LEFT_PTR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/left_ptr.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LEFT_SIDE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/left_side.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LEFT_TEE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/left_tee.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LEFTBUTTON</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/leftbutton.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LL_ANGLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/ll_angle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LR_ANGLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/lr_angle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MAN</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/man.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MIDDLEBUTTON</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/middlebutton.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MOUSE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/mouse.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PENCIL</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/pencil.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PIRATE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/pirate.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PLUS</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/plus.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.QUESTION_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/question_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RIGHT_PTR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/right_ptr.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RIGHT_SIDE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/right_side.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RIGHT_TEE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/right_tee.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RIGHTBUTTON</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/rightbutton.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RTL_LOGO</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/rtl_logo.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SAILBOAT</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sailboat.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_DOWN_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_down_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_H_DOUBLE_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_h_double_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_LEFT_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_left_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_RIGHT_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_right_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_UP_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_up_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_V_DOUBLE_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_v_double_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SHUTTLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/shuttle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SIZING</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sizing.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SPIDER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/spider.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SPRAYCAN</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/spraycan.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.STAR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/star.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TARGET</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/target.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TCROSS</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/tcross.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TOP_LEFT_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/top_left_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TOP_LEFT_CORNER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/top_left_corner.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TOP_RIGHT_CORNER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/top_right_corner.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TOP_SIDE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/top_side.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TOP_TEE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/top_tee.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TREK</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/trek.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.UL_ANGLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/ul_angle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.UMBRELLA</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/umbrella.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.UR_ANGLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/ur_angle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WATCH</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/watch.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.XTERM</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/xterm.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-drag-protocol-constants">
- <title id="gdk-drag-protocol-constants-title">GDK Drag Protocol Constants</title>
-
- <para>The Drag Protocol constants specify the protocol for a <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link>
-according to which <literal>DND</literal> is done.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_MOTIF</literal></term>
- <listitem>
- <simpara>The Motif DND protocol. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_XDND</literal></term>
- <listitem>
- <simpara>The Xdnd protocol.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_ROOTWIN</literal></term>
- <listitem>
- <simpara>An extension to the Xdnd protocol for unclaimed root
-window drops. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_NONE</literal></term>
- <listitem>
- <simpara>no protocol.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_WIN32_DROPFILES</literal></term>
- <listitem>
- <simpara>The simple WM_DROPFILES protocol.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_OLE2</literal></term>
- <listitem>
- <simpara>The complex OLE2 DND protocol (not
-implemented).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_LOCAL</literal></term>
- <listitem>
- <simpara>Intra-application DND.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-event-mask-constants">
- <title id="gdk-event-mask-constants-title">GDK Event Mask Flag Constants</title>
-
- <para>The Event Mask flag constants are a set of bit-flags that
-specify the events a window is to receive. Most of these masks map onto one
-or more of the <link linkend="gdk-event-type-constants">Event Type
-Constants</link>.</para>
-
- <variablelist>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.EXPOSURE_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.POINTER_MOTION_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.POINTER_MOTION_HINT_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.BUTTON_MOTION_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.BUTTON1_MOTION_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.BUTTON2_MOTION_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.BUTTON3_MOTION_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.BUTTON_PRESS_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.BUTTON_RELEASE_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.KEY_PRESS_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.KEY_RELEASE_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.ENTER_NOTIFY_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.LEAVE_NOTIFY_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.FOCUS_CHANGE_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.STRUCTURE_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.PROPERTY_CHANGE_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.VISIBILITY_NOTIFY_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.PROXIMITY_IN_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.PROXIMITY_OUT_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.SUBSTRUCTURE_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.SCROLL_MASK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.ALL_EVENTS_MASK</literal></simpara>
- </listitem></varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-event-type-constants">
- <title id="gdk-event-type-constants-title">GDK Event Type Constants</title>
-
- <para>The Event Type constants specify the type of an event.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.NOTHING</literal></term>
- <listitem>
- <simpara>a special code to indicate a null event.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DELETE</literal></term>
- <listitem>
- <simpara>the window manager has requested that the toplevel window be hidden or destroyed, usually when the user clicks on a special icon in the title bar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DESTROY</literal></term>
- <listitem>
- <simpara>the window has been destroyed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.EXPOSE</literal></term>
- <listitem>
- <simpara>all or part of the window has become visible and needs to be redrawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MOTION_NOTIFY</literal></term>
- <listitem>
- <simpara>the pointer (usually a mouse) has moved.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BUTTON_PRESS</literal></term>
- <listitem>
- <simpara>a mouse button has been pressed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk._2BUTTON_PRESS</literal></term>
- <listitem>
- <simpara>a mouse button has been double-clicked (clicked twice within
-a short period of time). Note that each click also generates a <literal>gtk.gdk.BUTTON_PRESS</literal> event.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk._3BUTTON_PRESS</literal></term>
- <listitem>
- <simpara>a mouse button has been clicked 3 times in a short period of time. Note that each click also generates a <literal>gtk.gdk.BUTTON_PRESS</literal> event.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BUTTON_RELEASE</literal></term>
- <listitem>
- <simpara>a mouse button has been released.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.KEY_PRESS</literal></term>
- <listitem>
- <simpara>a key has been pressed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.KEY_RELEASE</literal></term>
- <listitem>
- <simpara>a key has been released.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ENTER_NOTIFY</literal></term>
- <listitem>
- <simpara>the pointer has entered the window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LEAVE_NOTIFY</literal></term>
- <listitem>
- <simpara>the pointer has left the window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.FOCUS_CHANGE</literal></term>
- <listitem>
- <simpara>the keyboard focus has entered or left the window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CONFIGURE</literal></term>
- <listitem>
- <simpara>the size, position or stacking order of the window has changed. Note that <literal>PyGTK</literal> discards these events for <literal>gtk.gdk.WINDOW_CHILD</literal> windows.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MAP</literal></term>
- <listitem>
- <simpara>the window has been mapped.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.UNMAP</literal></term>
- <listitem>
- <simpara>the window has been unmapped.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PROPERTY_NOTIFY</literal></term>
- <listitem>
- <simpara>a property on the window has been changed or deleted.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SELECTION_CLEAR</literal></term>
- <listitem>
- <simpara>the application has lost ownership of a selection.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SELECTION_REQUEST</literal></term>
- <listitem>
- <simpara>another application has requested a selection.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SELECTION_NOTIFY</literal></term>
- <listitem>
- <simpara>a selection has been received.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PROXIMITY_IN</literal></term>
- <listitem>
- <simpara>an input device has moved into contact with a sensing surface (e.g. a touchscreen or graphics tablet).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PROXIMITY_OUT</literal></term>
- <listitem>
- <simpara>an input device has moved out of contact with a sensing surface.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_ENTER</literal></term>
- <listitem>
- <simpara>the mouse has entered the window while a drag is in progress.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_LEAVE</literal></term>
- <listitem>
- <simpara>the mouse has left the window while a drag is in progress</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_MOTION</literal></term>
- <listitem>
- <simpara>the mouse has moved in the window while a drag is in progress.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_STATUS</literal></term>
- <listitem>
- <simpara>the status of the drag operation initiated by the window has changed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DROP_START</literal></term>
- <listitem>
- <simpara>a drop operation onto the window has started.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DROP_FINISHED</literal></term>
- <listitem>
- <simpara>the drop operation initiated by the window has completed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CLIENT_EVENT</literal></term>
- <listitem>
- <simpara>a message has been received from another application.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISIBILITY_NOTIFY</literal></term>
- <listitem>
- <simpara>the window visibility status has changed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.NO_EXPOSE</literal></term>
- <listitem>
- <simpara>indicates that the source region was completely available when parts of a drawable were copied. This is not very useful.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SCROLL</literal></term>
- <listitem>
- <simpara>a scroll had occurred for a window</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_STATE</literal></term>
- <listitem>
- <simpara>the window state has changed</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SETTING</literal></term>
- <listitem>
- <simpara>a setting has changed</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-extension-mode-constants">
- <title id="gdk-extension-mode-constants-title">GDK Extension Mode Constants</title>
-
- <para>The Extension Mode constants specify which extension events are
-desired for a particular widget.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.EXTENSION_EVENTS_NONE</literal></term>
- <listitem>
- <simpara>No extension events are desired.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.EXTENSION_EVENTS_ALL</literal></term>
- <listitem>
- <simpara>All extension events are desired.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.EXTENSION_EVENTS_CURSOR</literal></term>
- <listitem>
- <simpara>Extension events are desired only if a cursor will be
- displayed for the device.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-fill-constants">
- <title id="gdk-fill-constants-title">GDK Fill Constants</title>
-
- <para>The Fill constants specify how primitives are drawn.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.SOLID</literal></term>
- <listitem>
- <simpara>draw with the foreground color. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TILED</literal></term>
- <listitem>
- <simpara>draw with a tiled pixmap.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.STIPPLED</literal></term>
- <listitem>
- <simpara>draw using the stipple bitmap. Pixels corresponding to
-bits in the stipple bitmap that are set will be drawn in the foreground
-color; pixels corresponding to bits that are not set will be left
-untouched.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.OPAQUE_STIPPLED</literal></term>
- <listitem>
- <simpara>draw using the stipple bitmap. Pixels corresponding to
-bits in the stipple bitmap that are set will be drawn in the foreground
-color; pixels corresponding to bits that are not set will be drawn with the
-background color.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-fill-rule-constants">
- <title id="gdk-fill-rule-constants-title">GDK Fill Rule Constants</title>
-
- <para>The Fill Rule constants specify the method for determining which
-pixels are included in a region, when creating a GdkRegion from a
-polygon. The fill rule is only relevant for polygons which overlap
-themselves. Not used in PyGTK.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.EVEN_ODD_RULE</literal></term>
- <listitem>
- <simpara>Areas which are overlapped an odd number of times are
-included in the region, while areas overlapped an even number of times are
-not.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDING_RULE</literal></term>
- <listitem>
- <simpara>Overlapping areas are always included.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-filter-return-constants">
- <title id="gdk-filter-return-constants-title">GDK Filter Return Constants</title>
-
- <para>The Filter Return constants specify the result of filtering a
-native event. See the <link
-linkend="method-gdkwindow--add-filter"><methodname>gtk.gdk.Window.add_filter</methodname>()</link>
-method for more information.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.FILTER_CONTINUE</literal></term>
- <listitem>
- <simpara>Event not handled, continue processing.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.FILTER_TRANSLATE</literal></term>
- <listitem>
- <simpara>Native event translated and stored into the <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> passed
-in.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.FILTER_REMOVE</literal></term>
- <listitem>
- <simpara>Event handled, terminate processing.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-function-constants">
- <title id="gdk-function-constants-title">GDK Function Constants</title>
-
- <para>The Function constants specify how the bit values for the source
-pixels are combined with the bit values for destination pixels to produce
-the final result. The sixteen values here correspond to the 16 different
-possible 2x2 truth tables. Only a couple of these values are usually useful;
-for colored images, only <literal>gtk.gdk.COPY</literal>,
-<literal>gtk.gdk.XOR</literal> and <literal>gtk.gdk.INVERT</literal> are
-generally useful. For bitmaps, <literal>gtk.gdk.AND</literal> and
-<literal>gtk.gdk.OR</literal> are also useful.</para>
-
- <variablelist>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.COPY</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.INVERT</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.XOR</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.CLEAR</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.AND</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.AND_REVERSE.</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.AND_INVERT</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.NOOP</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.OR</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.EQUIV</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.OR_REVERSE</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.COPY_INVERT</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.OR_INVERT</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.NAND</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.NOR</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.gdk.SET</literal></simpara>
- </listitem></varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-gc-values-mask-constants">
- <title id="gdk-gc-values-mask-constants-title">GDK GC Values Mask Flag Constants</title>
-
- <para>The GC Values Mask flag constants are a set of bit flags used to
-specify which fields GdkGCValues structure are set. These are only used
-internally by PyGTK.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.GC_FOREGROUND</literal></term>
- <listitem>
- <simpara>the foreground is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_BACKGROUND</literal></term>
- <listitem>
- <simpara>the background is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_FONT</literal></term>
- <listitem>
- <simpara>the font is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_FUNCTION</literal></term>
- <listitem>
- <simpara>the function is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_FILL</literal></term>
- <listitem>
- <simpara>the fill is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_TILE</literal></term>
- <listitem>
- <simpara>the tile is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_STIPPLE</literal></term>
- <listitem>
- <simpara>the stipple is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_CLIP_MASK</literal></term>
- <listitem>
- <simpara>the clip_mask is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_SUBWINDOW</literal></term>
- <listitem>
- <simpara>the subwindow_mode is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_TS_X_ORIGIN</literal></term>
- <listitem>
- <simpara>the ts_x_origin is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_TS_Y_ORIGIN</literal></term>
- <listitem>
- <simpara>the ts_y_origin is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_CLIP_X_ORIGIN</literal></term>
- <listitem>
- <simpara>the clip_x_origin is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_CLIP_Y_ORIGIN</literal></term>
- <listitem>
- <simpara>the clip_y_origin is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_EXPOSURES</literal></term>
- <listitem>
- <simpara>the graphics_exposures is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_LINE_WIDTH</literal></term>
- <listitem>
- <simpara>the line_width is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_LINE_STYLE</literal></term>
- <listitem>
- <simpara>the line_style is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_CAP_STYLE</literal></term>
- <listitem>
- <simpara>the cap_style is set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GC_JOIN_STYLE</literal></term>
- <listitem>
- <simpara>the join_style is set.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-gravity-constants">
- <title id="gdk-gravity-constants-title">GDK Gravity Constants</title>
-
- <para>The Gravity constants specify the reference point of a window
-and the meaning of coordinates passed to the <link
-linkend="method-gtkwindow--move"><methodname>gtk.Window.move</methodname>()</link>
-method.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.GRAVITY_NORTH_WEST</literal></term>
- <listitem>
- <simpara>The reference point is at the top left
- corner.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAVITY_NORTH</literal></term>
- <listitem>
- <simpara>The reference point is in the middle of the top
- edge.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAVITY_NORTH_EAST</literal></term>
- <listitem>
- <simpara>The reference point is at the top right
- corner.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAVITY_WEST</literal></term>
- <listitem>
- <simpara>The reference point is at the middle of the left
- edge.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAVITY_CENTER</literal></term>
- <listitem>
- <simpara>The reference point is at the center of the
- window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAVITY_EAST</literal></term>
- <listitem>
- <simpara>The reference point is at the middle of the right
- edge. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAVITY_SOUTH_WEST</literal></term>
- <listitem>
- <simpara>The reference point is at the lower left
- corner.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAVITY_SOUTH</literal></term>
- <listitem>
- <simpara>The reference point is at the middle of the lower
- edge.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAVITY_SOUTH_EAST</literal></term>
- <listitem>
- <simpara>The reference point is at the lower right
- corner.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAVITY_STATIC</literal></term>
- <listitem>
- <simpara>The reference point is at the top left corner of the
- window itself, ignoring window manager decorations.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-image-type-constants">
- <title id="gdk-image-type-constants-title">GDK Image Type Constants</title>
-
- <para>The Image Type constants specify the type of a <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.IMAGE_NORMAL</literal></term>
- <listitem>
- <simpara>The original X image type, which is quite slow since the
-image has to be transferred from the client to the server to display
-it.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.IMAGE_SHARED</literal></term>
- <listitem>
- <simpara>A faster image type, which uses shared memory to transfer
-the image data between client and server. However this will only be
-available if client and server are on the same machine and the shared memory
-extension is supported by the server.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.IMAGE_FASTEST</literal></term>
- <listitem>
- <simpara>Specifies that gtk.gdk.IMAGE_SHARED should be tried
-first, and if that fails then gtk.gdk.IMAGE_NORMAL will be used.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-input-condition-constants">
- <title id="gdk-input-condition-constants-title">GDK Input Condition Flag Constants</title>
-
- <para>The Input Condition constants are a set of bit-flags that
-specify conditions for which an input callback will be triggered. The three
-members of this enumeration correspond to the
-<parameter>readfds</parameter>, <parameter>writefds</parameter>, and
-<parameter>exceptfds</parameter> arguments to the
-<function>select</function> system call.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.INPUT_READ</literal></term>
- <listitem>
- <simpara>The file descriptor has become available for
- reading. (Or, as is standard in Unix, a socket or pipe was
- closed at the other end; this is the case if a subsequent read
- on the file descriptor returns a count of zero.)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INPUT_WRITE</literal></term>
- <listitem>
- <simpara>The file descriptor has become available for
- writing.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INPUT_EXCEPTION</literal></term>
- <listitem>
- <simpara>An exception was raised on the file
- descriptor.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-input-mode-constants">
- <title id="gdk-input-mode-constants-title">GDK Input Mode Constants</title>
-
- <para>The Input Mode constants specify the mode of an input
-device.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.MODE_DISABLED</literal></term>
- <listitem>
- <simpara>the device is disabled and will not report any
-events.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MODE_SCREEN</literal></term>
- <listitem>
- <simpara>the device is enabled. The device's coordinate space
-maps to the entire screen.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MODE_WINDOW</literal></term>
- <listitem>
- <simpara>the device is enabled. The device's coordinate space is
-mapped to a single window. The manner in which this window is chosen is
-undefined, but it will typically be the same way in which the focus window
-for key events is determined.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-input-source-constants">
- <title id="gdk-input-source-constants-title">GDK Input Source Constants</title>
-
- <para>The Input Source constants specify the type of an input device
-in general terms.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.SOURCE_MOUSE</literal></term>
- <listitem>
- <simpara>the device is a mouse. (This will be reported for the
-core pointer, even if it is something else, such as a trackball.)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SOURCE_PEN</literal></term>
- <listitem>
- <simpara>the device is a stylus of a graphics tablet or similar
-device.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SOURCE_ERASER</literal></term>
- <listitem>
- <simpara>the device is an eraser. Typically, this would be the
-other end of a stylus on a graphics tablet.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SOURCE_CURSOR</literal></term>
- <listitem>
- <simpara>the device is a graphics tablet "puck" or similar
-device.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-join-style-constants">
- <title id="gdk-join-style-constants-title">GDK Join Style Constants</title>
-
- <para>The Join Style constants specify how the joins between segments
-of a polygon are drawn.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.JOIN_MITER</literal></term>
- <listitem>
- <simpara>The sides of each line are extended to meet at an
-angle.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.JOIN_ROUND</literal></term>
- <listitem>
- <simpara>The sides of the two lines are joined by a circular
-arc.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.JOIN_BEVEL</literal></term>
- <listitem>
- <simpara>The sides of the two lines are joined by a straight
-line which makes an equal angle with each line.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-line-style-constants">
- <title id="gdk-line-style-constants-title">GDK Line Style Constants</title>
-
- <para>The Line Style constants specify how lines are drawn.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.LINE_SOLID</literal></term>
- <listitem>
- <simpara>Lines are drawn solid.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LINE_ON_OFF_DASH</literal></term>
- <listitem>
- <simpara>Lines are drawn dashed where even segments are drawn
-but odd segments are not drawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LINE_DOUBLE_DASH</literal></term>
- <listitem>
- <simpara>Lines are drawn dashed where even segments are drawn
-normally but odd segments are drawn in the background color if the fill
-style is <literal>gtk.gdk.SOLID</literal>, or in the background color masked
-by the stipple if the fill style is
-<literal>gtk.gdk.STIPPLED</literal>.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-modifier-constants">
- <title id="gdk-modifier-constants-title">GDK Modifier Constants</title>
-
- <para>The Modifier constants are a set of bit-flags to indicate the
-state of modifier keys and mouse buttons in various event types. Typical
-modifier keys are <keycap>Shift</keycap>, <keycap>Control</keycap>,
-<keycap>Meta</keycap>, <keycap>Super</keycap>, <keycap>Hyper</keycap>,
-<keycap>Alt</keycap>, <keycap>Compose</keycap>, <keycap>Apple</keycap>,
-<keycap>CapsLock</keycap> or <keycap>ShiftLock</keycap>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.SHIFT_MASK</literal></term>
- <listitem>
- <simpara>The Shift key.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LOCK_MASK</literal></term>
- <listitem>
- <simpara>A Lock key (depending on the modifier mapping of the X
-server this may either be CapsLock or ShiftLock).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CONTROL_MASK</literal></term>
- <listitem>
- <simpara>The Control key. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MOD1_MASK</literal></term>
- <listitem>
- <simpara>The fourth modifier key (it depends on the modifier
-mapping of the X server which key is interpreted as this modifier, but
-normally it is the Alt key).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MOD2_MASK</literal></term>
- <listitem>
- <simpara>The fifth modifier key (it depends on the modifier
-mapping of the X server which key is interpreted as this
-modifier).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MOD3_MASK</literal></term>
- <listitem>
- <simpara>The sixth modifier key (it depends on the modifier
-mapping of the X server which key is interpreted as this
-modifier).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MOD4_MASK</literal></term>
- <listitem>
- <simpara>The seventh modifier key (it depends on the modifier
-mapping of the X server which key is interpreted as this
-modifier).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MOD5_MASK</literal></term>
- <listitem>
- <simpara>The eighth modifier key (it depends on the modifier
-mapping of the X server which key is interpreted as this
-modifier).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BUTTON1_MASK</literal></term>
- <listitem>
- <simpara>The first mouse button.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BUTTON2_MASK</literal></term>
- <listitem>
- <simpara>The second mouse button.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BUTTON3_MASK</literal></term>
- <listitem>
- <simpara>The third mouse button.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BUTTON4_MASK</literal></term>
- <listitem>
- <simpara>The fourth mouse button.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BUTTON5_MASK</literal></term>
- <listitem>
- <simpara>The fifth mouse button.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RELEASE_MASK</literal></term>
- <listitem>
- <simpara>Differentiates between (keyval, modifiers) pairs from
-key press and release events.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MODIFIER_MASK</literal></term>
- <listitem>
- <simpara>all of the above</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-notify-type-constants">
- <title id="gdk-notify-type-constants-title">GDK Notify Type Constants</title>
-
- <para>The Notify Type constants specify the kind of crossing for the
-Crossing <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.NOTIFY_ANCESTOR</literal></term>
- <listitem>
- <simpara>the window is entered from an ancestor or left toward
- an ancestor.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.NOTIFY_VIRTUAL</literal></term>
- <listitem>
- <simpara>the pointer moves between an ancestor and an inferior
- of the window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.NOTIFY_INFERIOR</literal></term>
- <listitem>
- <simpara>the window is entered from an inferior or left toward
- an inferior.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.NOTIFY_NONLINEAR</literal></term>
- <listitem>
- <simpara> the window is entered from or left toward a window
- which is neither an ancestor nor an inferior.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.NOTIFY_NONLINEAR_VIRTUAL</literal></term>
- <listitem>
- <simpara>the pointer moves between two windows which are not
- ancestors of each other and the window is part of the ancestor
- chain between one of these windows and their least common
- ancestor.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.NOTIFY_UNKNOWN</literal></term>
- <listitem>
- <simpara>???</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-overlap-type-constants">
- <title id="gdk-overlap-type-constants-title">GDK Overlap Type Constants</title>
-
- <para>The Overlap Type constants specify the possible values returned
- by the <link
- linkend="method-gdkregion--rect-in"><methodname>gtk.gdk.Region.rect_in</methodname>()</link>
- method.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.OVERLAP_RECTANGLE_IN</literal></term>
- <listitem>
- <simpara>The rectangle is inside the GdkRegion.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.OVERLAP_RECTANGLE_OUT</literal></term>
- <listitem>
- <simpara>The rectangle is outside the GdkRegion.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.OVERLAP_RECTANGLE_PART</literal></term>
- <listitem>
- <simpara>The rectangle is partly inside the GdkRegion.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-owner-change-constants">
- <title id="gdk-owner-change-constants-title">GDK Owner Change Constants</title>
-
- <para>The Owner Change constants specify the possible values
- indicating why selection ownership changed. These are used by the
- <literal>gdk.OWNER_CHANGE</literal> type <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
- "owner" attribute.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.OVERLAP_RECTANGLE_IN</literal></term>
- <listitem>
- <simpara>The rectangle is inside the GdkRegion.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.OVERLAP_RECTANGLE_OUT</literal></term>
- <listitem>
- <simpara>The rectangle is outside the GdkRegion.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.OVERLAP_RECTANGLE_PART</literal></term>
- <listitem>
- <simpara>The rectangle is partly inside the GdkRegion.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-parent-relative-constant">
- <title id="gdk-parent-relative-constant-title">GDK Parent Relative Constant</title>
-
- <note>
- <para>This constant is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The Parent Relative constant is a special value (equivalent to
- 1L) for <link
- linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
- variables, indicating that the background pixmap for a window should
- be inherited from the parent window.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.PARENT_RELATIVE</literal></term>
- <listitem>
- <simpara>the background pixmap for a window should be inherited
- from the parent window.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-pixbuf-rotation-constants">
- <title id="gdk-pixbuf-rotation-constants-title">GDK Pixbuf Rotation Constants</title>
-
- <para>The Pixbuf Rotation constants specify the angles that a pixbuf
- can be rotated using the <link
- linkend="method-gdkpixbuf--rotate-simple"><methodname>gtk.gdk.Pixbuf.rotate_simple</methodname>()</link>
- method.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.PIXBUF_ROTATE_NONE</literal></term>
- <listitem>
- <simpara>No rotation. Rotate by 0 degrees.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PIXBUF_ROTATE_COUNTERCLOCKWISE</literal></term>
- <listitem>
- <simpara>Rotate by 90 degrees.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PIXBUF_ROTATE_UPSIDEDOWN</literal></term>
- <listitem>
- <simpara>Rotate by 180 degrees.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PIXBUF_ROTATE_CLOCKWISE</literal></term>
- <listitem>
- <simpara>Rotate by 270 degrees.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-property-mode-constants">
- <title id="gdk-property-mode-constants-title">GDK Property Mode Constants</title>
-
- <para>The Property Mode constants specify how existing data is
-combined with new data when using the the <link
-linkend="method-gdkwindow--property-change"><methodname>gtk.gdk.Window.property_change</methodname>()</link>
-method.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.PROP_MODE_REPLACE</literal></term>
- <listitem>
- <simpara>The new data replaces the existing data.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PROP_MODE_PREPEND</literal></term>
- <listitem>
- <simpara>The new data is prepended to the existing data.
-</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PROP_MODE_APPEND</literal></term>
- <listitem>
- <simpara>The new data is appended to the existing
-data.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-property-state-constants">
- <title id="gdk-property-state-constants-title">GDK Property State Constants</title>
-
- <para>The Property State constants specify the type of a property
-change for a Property <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.PROPERTY_NEW_VALUE</literal></term>
- <listitem>
- <simpara>the property value was changed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PROPERTY_DELETE</literal></term>
- <listitem>
- <simpara>the property was deleted.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-rgb-dither-constants">
- <title id="gdk-rgb-dither-constants-title">GDK RGB Dither Constants</title>
-
- <para>The RGB Dither constants specify the type of dithering to apply
-to the image on display.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.RGB_DITHER_NONE</literal></term>
- <listitem>
- <simpara>Never use dithering.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RGB_DITHER_NORMAL</literal></term>
- <listitem>
- <simpara>Use dithering in 8 bits per pixel (and below)
- only.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RGB_DITHER_MAX</literal></term>
- <listitem>
- <simpara>Use dithering in 16 bits per pixel and below.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-scroll-direction-constants">
- <title id="gdk-scroll-direction-constants-title">GDK Scroll Direction Constants</title>
-
- <para>The Scroll Direction constants specify the direction for the
-Scroll.<link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.SCROLL_UP</literal></term>
- <listitem>
- <simpara>the window is scrolled up.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SCROLL_DOWN</literal></term>
- <listitem>
- <simpara>the window is scrolled down. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SCROLL_LEFT</literal></term>
- <listitem>
- <simpara>the window is scrolled to the left.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SCROLL_RIGHT</literal></term>
- <listitem>
- <simpara>the window is scrolled to the right.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-setting-action-constants">
- <title id="gdk-setting-action-constants-title">GDK Setting Action Constants</title>
-
- <para>The Setting Action constants specify the kind of modification
-applied to a setting in a Setting <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.SETTING_ACTION_NEW</literal></term>
- <listitem>
- <simpara>A setting was added.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SETTING_ACTION_CHANGED</literal></term>
- <listitem>
- <simpara>A setting was changed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SETTING_ACTION_DELETED</literal></term>
- <listitem>
- <simpara>A setting was deleted.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-subwindow-mode-constants">
- <title id="gdk-subwindow-mode-constants-title">GDK Subwindow Mode Constants</title>
-
- <para>The Subwindow Mode constants specify how drawing onto a window
-will affect child windows of that window.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.CLIP_BY_CHILDREN</literal></term>
- <listitem>
- <simpara>only draw onto the window itself not the
-subwindows.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INCLUDE_INFERIORS</literal></term>
- <listitem>
- <simpara>draw onto the window and child windows.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-visibility-state-constants">
- <title id="gdk-visibility-state-constants-title">GDK Visibility State Constants</title>
-
- <para>The Visibility State constants specify the visibility status of a
-window for the Visibility <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.VISIBILITY_UNOBSCURED</literal></term>
- <listitem>
- <simpara>the window is completely visible.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISIBILITY_PARTIAL</literal></term>
- <listitem>
- <simpara>the window is partially visible.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISIBILITY_FULLY_OBSCURED</literal></term>
- <listitem>
- <simpara>the window is not visible at all.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-visual-type-constants">
- <title id="gdk-visual-type-constants-title">GDK Visual Type Constants</title>
-
- <para>The Visual Type constants specify a set of values that describe
-the manner in which the pixel values for a visual are converted into RGB
-values for display.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_STATIC_GRAY</literal></term>
- <listitem>
- <simpara>Each pixel value indexes a grayscale value
-directly.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_GRAYSCALE</literal></term>
- <listitem>
- <simpara>Each pixel is an index into a color map that maps pixel
-values into grayscale values. The color map can be changed by an
-application.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_STATIC_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value is an index into a predefined,
-unmodifiable color map that maps pixel values into RGB values.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_PSEUDO_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel is an index into a color map that maps pixel
-values into rgb values. The color map can be changed by an
-application.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_TRUE_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value directly contains red, green, and blue
-components. The red_mask, green_mask, and blue_mask fields of the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
-structure describe how the components are assembled into a pixel
-value.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_DIRECT_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value contains red, green, and blue components
-as for <literal>gtk.gdk.TRUE_COLOR</literal>, but the components are mapped
-via a color table into the final output table instead of being converted
-directly. </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-window-class-constants">
- <title id="gdk-window-class-constants-title">GDK Window Class Constants</title>
-
- <para>The Window Class constants specify the class of
-window. <literal>gtk.gdk.INPUT_OUTPUT</literal> windows are the standard
-kind of window you might expect. <literal>gtk.gdk.INPUT_ONLY</literal>
-windows are invisible; they are used to trap events, but you can't draw on
-them.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.INPUT_OUTPUT</literal></term>
- <listitem>
- <simpara>A window for graphics and events.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INPUT_ONLY</literal></term>
- <listitem>
- <simpara>A window for events only.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-window-edge-constants">
- <title id="gdk-window-edge-constants-title">GDK Window Edge Constants</title>
-
- <para>The Window Edge constants specify window edge or corner.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_EDGE_NORTH_WEST</literal></term>
- <listitem>
- <simpara>The top left corner.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_EDGE_NORTH</literal></term>
- <listitem>
- <simpara>The top edge.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_EDGE_NORTH_EAST</literal></term>
- <listitem>
- <simpara>The top right corner.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_EDGE_WEST</literal></term>
- <listitem>
- <simpara>The left edge.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_EDGE_EAST</literal></term>
- <listitem>
- <simpara>The right edge.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_EDGE_SOUTH_WEST</literal></term>
- <listitem>
- <simpara>The lower left corner.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_EDGE_SOUTH</literal></term>
- <listitem>
- <simpara>The lower edge.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_EDGE_SOUTH_EAST</literal></term>
- <listitem>
- <simpara>The lower right corner.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-window-hints-constants">
- <title id="gdk-window-hints-constants-title">GDK Window Hints Constants</title>
-
- <para>The Window Hints constants specify the fields of a GdkGeometry
-struct should be paid attention to. Also, the presence/absence of
-<literal>gtk.gdk.HINT_POS</literal>,
-<literal>gtk.gdk.HINT_USER_POS</literal>, and
-<literal>gtk.gdk.HINT_USER_SIZE</literal> is significant, though they don't
-directly refer to GdkGeometry
-fields. <literal>gtk.gdk.HINT_USER_POS</literal> will be set automatically
-by <link linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
-if you call the <link
-linkend="method-gtkwindow--move"><methodname>gtk.Window.move</methodname>()</link>
-method. <literal>gtk.gdk.HINT_USER_POS</literal> and
-<literal>gtk.gdk.HINT_USER_SIZE</literal> should be set if the user
-specified a size/position using a --geometry command-line argument; the
-<link
-linkend="method-gtkwindow--parse-geometry"><methodname>gtk.Window.parse_geometry</methodname>()</link>
-method automatically sets these flags. These constants aren't useful in
-PyGTK.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.HINT_POS</literal></term>
- <listitem>
- <simpara>Indicates that the program has positioned the
- window</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HINT_MIN_SIZE</literal></term>
- <listitem>
- <simpara>Min size fields are set</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HINT_MAX_SIZE</literal></term>
- <listitem>
- <simpara>Max size fields are set</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HINT_BASE_SIZE</literal></term>
- <listitem>
- <simpara>Base size fields are set </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HINT_ASPECT</literal></term>
- <listitem>
- <simpara>Aspect ratio fields are set</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HINT_RESIZE_INC</literal></term>
- <listitem>
- <simpara>Resize increment fields are set</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HINT_WIN_GRAVITY</literal></term>
- <listitem>
- <simpara>Window gravity field is set</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HINT_USER_POS</literal></term>
- <listitem>
- <simpara>Indicates that the window's position was explicitly set
- by the user</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HINT_USER_SIZE</literal></term>
- <listitem>
- <simpara>Indicates that the window's size was explicitly set by
- the user</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-window-state-constants">
- <title id="gdk-window-state-constants-title">GDK Window State Flag Constants</title>
-
- <para>The Window State flag constants are a set of bit-flags that
-specify the state of a toplevel window.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_STATE_WITHDRAWN</literal></term>
- <listitem>
- <simpara>The window is not shown.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_STATE_ICONIFIED</literal></term>
- <listitem>
- <simpara>The window is minimized.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_STATE_MAXIMIZED</literal></term>
- <listitem>
- <simpara>The window is maximized. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_STATE_STICKY</literal></term>
- <listitem>
- <simpara>The window is sticky.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_STATE_FULLSCREEN</literal></term>
- <listitem>
- <simpara>The window is maximized without decorations. Available
-in PyGTK 2.2 and above.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_STATE_ABOVE</literal></term>
- <listitem>
- <simpara>The window is kept above other windows. Available in
-PyGTK 2.4 and above.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_STATE_BELOW</literal></term>
- <listitem>
- <simpara>The window is kept below other windows. Available in
-PyGTK 2.4 and above.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-window-type-constants">
- <title id="gdk-window-type-constants-title">GDK Window Type Constants</title>
-
- <para>The Window Type constants specify the type of window.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_ROOT</literal></term>
- <listitem>
- <simpara>The root window; this window has no parent, covers the
-entire screen, and is created by the window system.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_TOPLEVEL</literal></term>
- <listitem>
- <simpara>A toplevel window (used to implement <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_CHILD</literal></term>
- <listitem>
- <simpara>A child window (used to implement widgets e.g. <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link>).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_DIALOG</literal></term>
- <listitem>
- <simpara>A useless/deprecated compatibility type.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_TEMP</literal></term>
- <listitem>
- <simpara>An override redirect temporary window (used to implement
-<link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_FOREIGN</literal></term>
- <listitem>
- <simpara>A foreign window (see the <link
-linkend="function-gdk--window-foreign-new"><function>gtk.gdk.window_foreign_new</function>()</link>
-function).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
-
- </refsect2>
-
- <refsect2 id="gdk-window-type-hint-constants">
- <title id="gdk-window-type-hint-constants-title">GDK Window Type Hint Constants</title>
-
- <para>The Window Type Hint constants specify hints for the window
-manager that indicate what type of function the window has. The window
-manager can use this when determining decoration and behavior of the
-window. The hint must be set before mapping the window.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_TYPE_HINT_NORMAL</literal></term>
- <listitem>
- <simpara>A normal toplevel window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_TYPE_HINT_DIALOG</literal></term>
- <listitem>
- <simpara>A dialog window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_TYPE_HINT_MENU</literal></term>
- <listitem>
- <simpara>A window used to implement a menu.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_TYPE_HINT_TOOLBAR</literal></term>
- <listitem>
- <simpara>A window used to implement a toolbar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_TYPE_HINT_SPLASHSCREEN</literal></term>
- <listitem>
- <simpara>A window used to implement a splash screen</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_TYPE_HINT_UTILITY</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_TYPE_HINT_DOCK</literal></term>
- <listitem>
- <simpara>A window used to implement a docking bar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_TYPE_HINT_DESKTOP</literal></term>
- <listitem>
- <simpara>A window used to implement a desktop.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-wm-decoration-constants">
- <title id="gdk-wm-decoration-constants-title">GDK WM Decoration Constants</title>
-
- <para>The WM Decoration constants are bit-flags that specify the hints
-that the window manager can use when determining how to decorate the
-window. The hints must be set before mapping the window.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.DECOR_ALL</literal></term>
- <listitem>
- <simpara>All decorations should be applied.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DECOR_BORDER</literal></term>
- <listitem>
- <simpara>A frame should be drawn around the window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DECOR_RESIZEH</literal></term>
- <listitem>
- <simpara>The frame should have resize handles.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DECOR_TITLE</literal></term>
- <listitem>
- <simpara>A titlebar should be placed above the window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DECOR_MENU</literal></term>
- <listitem>
- <simpara>A button for opening a menu should be included.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DECOR_MINIMIZE</literal></term>
- <listitem>
- <simpara>A minimize button should be included.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DECOR_MAXIMIZE</literal></term>
- <listitem>
- <simpara>A maximize button should be included.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gdk-wm-function-constants">
- <title id="gdk-wm-function-constants-title">GDK WM Function Constants</title>
-
- <para>The WM Function constants specify hints originally defined by
-the Motif toolkit. The window manager can use them when determining the
-functions to offer for the window. The hint must be set before mapping the
-window.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.FUNC_ALL</literal></term>
- <listitem>
- <simpara>All functions should be offered.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.FUNC_RESIZE</literal></term>
- <listitem>
- <simpara>The window should be resizable.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.FUNC_MOVE</literal></term>
- <listitem>
- <simpara>The window should be movable.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.FUNC_MINIMIZE</literal></term>
- <listitem>
- <simpara>The window should be minimizable.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.FUNC_MAXIMIZE</literal></term>
- <listitem>
- <simpara>The window should be maximizable.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.FUNC_CLOSE</literal></term>
- <listitem>
- <simpara>The window should be closeable.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdk-functions.xml b/docs/reference/pygtk-gdk-functions.xml
deleted file mode 100644
index 004c0e60..00000000
--- a/docs/reference/pygtk-gdk-functions.xml
+++ /dev/null
@@ -1,1537 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="gdk-functions">
- <refnamediv>
- <refname>gtk.gdk Functions</refname>
- <refpurpose>the gtk.gdk module functions</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <refsect2>
- <title><link linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkatom-intern">gtk.gdk.atom_intern</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">only_if_exists</parameter><initializer>False</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--color-parse">gtk.gdk.color_parse</link></methodname>
- <methodparam><parameter
- role="keyword">spec</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--colormap-get-system">gtk.gdk.colormap_get_system</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkdevice"><classname>gtk.gdk.Device</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--devices-list">gtk.gdk.devices_list</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--device-get-core-pointer">gtk.gdk.device_get_core_pointer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--display-get-default">gtk.gdk.display_get_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkdisplaymanager"><classname>gtk.gdk.DisplayManager</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--display-manager-get">gtk.gdk.display_manager_get</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--events-pending">gtk.gdk.events_pending</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--event-peek">gtk.gdk.event_peek</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--event-get">gtk.gdk.event_get</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--event-get-graphics-expose">gtk.gdk.event_get_graphics_expose</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--set-show-events">gtk.gdk.set_show_events</link></methodname>
- <methodparam><parameter
- role="keyword">show_events</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--get-show-events">gtk.gdk.get_show_events</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--event-handler-set">gtk.gdk.event_handler_set</link></methodname>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkkeymap"><classname>gtk.gdk.Keymap</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keymap-get-default">gtk.gdk.keymap_get_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keymap-get-for-display">gtk.gdk.keymap_get_for_display</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-name">gtk.gdk.keyval_name</link></methodname>
- <methodparam><parameter role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-from-name">gtk.gdk.keyval_from_name</link></methodname>
- <methodparam><parameter role="keyword">keyval_name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-convert-case">gtk.gdk.keyval_convert_case</link></methodname>
- <methodparam><parameter role="keyword">symbol</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-to-upper">gtk.gdk.keyval_to_upper</link></methodname>
- <methodparam><parameter role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-to-lower">gtk.gdk.keyval_to_lower</link></methodname>
- <methodparam><parameter role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-is-upper">gtk.gdk.keyval_is_upper</link></methodname>
- <methodparam><parameter role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-is-lower">gtk.gdk.keyval_is_lower</link></methodname>
- <methodparam><parameter role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-to-unicode">gtk.gdk.keyval_to_unicode</link></methodname>
- <methodparam><parameter role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--unicode-to-keyval">gtk.gdk.unicode_to_keyval</link></methodname>
- <methodparam><parameter role="keyword">wc</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkpangorenderer"><classname>gtk.gdk.PangoRenderer</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--gdk-pango-renderer-get-default">gtk.gdk.gdk_pango_renderer_get_default</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-file">gtk.gdk.pixbuf_new_from_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-file-at-size">gtk.gdk.pixbuf_new_from_file_at_size</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-data">gtk.gdk.pixbuf_new_from_data</link></methodname>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- <methodparam><parameter role="keyword">colorspace</parameter></methodparam>
- <methodparam><parameter role="keyword">has_alpha</parameter></methodparam>
- <methodparam><parameter role="keyword">bits_per_sample</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">rowstride</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-array">gtk.gdk.pixbuf_new_from_array</link></methodname>
- <methodparam><parameter role="keyword">array</parameter></methodparam>
- <methodparam><parameter role="keyword">colorspace</parameter></methodparam>
- <methodparam><parameter role="keyword">bits_per_sample</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-xpm-data">gtk.gdk.pixbuf_new_from_xpm_data</link></methodname>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-inline">gtk.gdk.pixbuf_new_from_inline</link></methodname>
- <methodparam><parameter role="keyword">data_length</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- <methodparam><parameter role="keyword">copy_pixels</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-get-formats">gtk.gdk.pixbuf_get_formats</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-get-file-info">gtk.gdk.pixbuf_get_file_info</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname> Functions</link></title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-loader-new-with-mime-type">gtk.gdk.pixbuf_loader_new_with_mime_type</link></methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--bitmap-create-from-data">gtk.gdk.bitmap_create_from_data</link></methodname>
- <methodparam><parameter role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-create-from-data">gtk.gdk.pixmap_create_from_data</link></methodname>
- <methodparam><parameter role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">depth</parameter></methodparam>
- <methodparam><parameter role="keyword">fg</parameter></methodparam>
- <methodparam><parameter role="keyword">bg</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-create-from-xpm">gtk.gdk.pixmap_create_from_xpm</link></methodname>
- <methodparam><parameter role="keyword">window</parameter></methodparam>
- <methodparam><parameter role="keyword">transparent_color</parameter></methodparam>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-colormap-create-from-xpm">gtk.gdk.pixmap_colormap_create_from_xpm</link></methodname>
- <methodparam><parameter role="keyword">window</parameter></methodparam>
- <methodparam><parameter role="keyword">colormap</parameter></methodparam>
- <methodparam><parameter role="keyword">transparent_color</parameter></methodparam>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-create-from-xpm-d">gtk.gdk.pixmap_create_from_xpm_d</link></methodname>
- <methodparam><parameter role="keyword">window</parameter></methodparam>
- <methodparam><parameter role="keyword">transparent_color</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-colormap-create-from-xpm-d">gtk.gdk.pixmap_colormap_create_from_xpm_d</link></methodname>
- <methodparam><parameter role="keyword">window</parameter></methodparam>
- <methodparam><parameter role="keyword">colormap</parameter></methodparam>
- <methodparam><parameter role="keyword">transparent_color</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-foreign-new">gtk.gdk.pixmap_foreign_new</link></methodname>
- <methodparam><parameter role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-lookup">gtk.gdk.pixmap_lookup</link></methodname>
- <methodparam><parameter role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-foreign-new-for-display">gtk.gdk.pixmap_foreign_new_for_display</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- <methodparam><parameter role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-lookup-for-display">gtk.gdk.pixmap_lookup_for_display</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- <methodparam><parameter role="keyword">anid</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
- linkend="function-gdk--region-rectangle">gtk.gdk.region_rectangle</link></methodname>
- <methodparam><parameter
- role="keyword">rectangle</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
-<refsect2>
- <title><link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--screen-width">gtk.gdk.screen_width</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--screen-height">gtk.gdk.screen_height</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--screen-width-mm">gtk.gdk.screen_width_mm</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--screen-height-mm">gtk.gdk.screen_height_mm</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--screen-get-default">gtk.gdk.screen_get_default</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--list-visuals">gtk.gdk.list_visuals</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--visual-get-best">gtk.gdk.visual_get_best</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--visual-get-best-depth">gtk.gdk.visual_get_best_depth</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--visual-get-best-type">gtk.gdk.visual_get_best_type</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--visual-get-best-with-depth">gtk.gdk.visual_get_best_with_depth</link></methodname>
- <methodparam><parameter role="keyword">depth</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--visual-get-best-with-type">gtk.gdk.visual_get_best_with_type</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--visual-get-system">gtk.gdk.visual_get_system</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--query-depths">gtk.gdk.query_depths</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--query-visual-types">gtk.gdk.query_visual_types</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-foreign-new">gtk.gdk.window_foreign_new</link></methodname>
- <methodparam><parameter role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-foreign-new-for-display">gtk.gdk.window_foreign_new_for_display</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- <methodparam><parameter role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--get-default-root-window">gtk.gdk.get_default_root_window</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-get-toplevels">gtk.gdk.window_get_toplevels</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-lookup">gtk.gdk.window_lookup</link></methodname>
- <methodparam><parameter role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-lookup-for-display">gtk.gdkwindow_lookup_for_display.</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- <methodparam><parameter role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-process-all-updates">gtk.gdk.window_process_all_updates</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--gdk-window-set-debug-updates">gtk.gdk.gdk_window_set_debug_updates</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-at-pointer">gtk.gdk.window_at_pointer</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title>Miscellaneous Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
- linkend="function-gdk--pointer-grab">gtk.gdk.pointer_grab</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">owner_events</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">event_mask</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">confine_to</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">cursor</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pointer-ungrab">gtk.gdk.pointer_ungrab</link></methodname>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyboard-grab">gtk.gdk.keyboard_grab</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">owner_events</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyboard-ungrab">gtk.gdk.keyboard_ungrab</link></methodname>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pointer-is-grabbed">gtk.gdk.pointer_is_grabbed</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--flush">gtk.gdk.flush</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--beep">gtk.gdk.beep</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--set-double-click-time">gtk.gdk.set_double_click_time</link></methodname>
- <methodparam><parameter
- role="keyword">msec</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--threads-enter">gtk.gdk.threads_enter</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--threads-leave">gtk.gdk.threads_leave</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--threads-init">gtk.gdk.threads_init</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--rgb-ditherable">gtk.gdk.rgb_ditherable</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--rgb-get-colormap">gtk.gdk.rgb_get_colormap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--rgb-set-verbose">gtk.gdk.rgb_set_verbose</link></methodname>
- <methodparam><parameter
- role="keyword">verbose</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--rgb-set-install">gtk.gdk.rgb_set_install</link></methodname>
- <methodparam><parameter
- role="keyword">install</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--rgb-set-min-colors">gtk.gdk.rgb_set_min_colors</link></methodname>
- <methodparam><parameter
- role="keyword">min_colors</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--rgb-get-visual">gtk.gdk.rgb_get_visual</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--selection-owner-get">gtk.gdk.selection_owner_get</link></methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--selection-send-notify">gtk.gdk.selection_send_notify</link></methodname>
- <methodparam><parameter
- role="keyword">requestor</parameter></methodparam>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- <methodparam><parameter
- role="keyword">property</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--set-sm-client-id">gtk.gdk.set_sm_client_id</link></methodname>
- <methodparam><parameter
- role="keyword">sm_client_id</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--notify-startup-complete">gtk.gdk.notify_startup_complete</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--get-program-class">gtk.gdk.get_program_class</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--set-program-class">gtk.gdk.set_program_class</link></methodname>
- <methodparam><parameter
- role="keyword">program_class</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--get-display">gtk.gdk.get_display</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--get-display-arg-name">gtk.gdk.get_display_arg_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--gdk-pango-context-get-for-screen">gtk.gdk.gdk_pango_context_get_for_screen</link></methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--gdk-pango-context-get">gtk.gdk.gdk_pango_context_get</link></methodname>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>These functions are part of the <literal>PyGTK</literal> gtk.gdk
-module. All the functions are listed above with links to the function
-description. Most functions are associated with a specific object class and
-their descriptions are part of the class reference. Those functions that are
-not directly associated with a specific class have their descriptions
-below.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--pointer-grab">
- <title>gtk.gdk.pointer_grab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pointer_grab</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">owner_events</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">event_mask</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">confine_to</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">cursor</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> that
-will own the grab (the grab window).</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">owner_events</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>False</literal> then all pointer
-events are reported with respect to <parameter>window</parameter> and are
-only reported if selected by <parameter>event_mask</parameter>. If
-<literal>True</literal> then pointer events for this application are
-reported as normal, but pointer events outside this application are reported
-with respect to <parameter>window</parameter> and only if selected by
-<parameter>event_mask</parameter>. In either mode, unreported events are
-discarded.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">event_mask</parameter>&nbsp;:</term>
- <listitem><simpara>specifies the event mask, that is used in
-accordance with <parameter>owner_events</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">confine_to</parameter>&nbsp;:</term>
- <listitem><simpara>If not <literal>None</literal>, the pointer
-will be confined to this <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-during the grab. If the pointer is outside
-<parameter>confine_to</parameter>, it will automatically be moved to the
-closest edge of <parameter>confine_to</parameter> and enter and leave events
-will be generated as necessary.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">cursor</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link> to
-display while the grab is active. If this is None then the normal cursors
-are used for <parameter>window</parameter> and its descendants, and the
-cursor for <parameter>window</parameter> is used for all other
-windows.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp of the event that led to this
-pointer grab. This usually comes from a <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>, though
-0L can be used to use the current time if the time isn't
-known.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a grab status value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pointer_grab</function>() function grabs
-the pointer (usually a mouse) so that all events are passed to this
-application until the pointer is ungrabbed with the <link
-linkend="function-gdk--pointer-ungrab"><function>gtk.gdk.pointer_ungrab</function>()</link>,
-or the grab window becomes unviewable. This overrides any previous pointer
-grab by this client. This function returns a grab status value:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.GRAB_SUCCESS</literal></term>
- <listitem>
- <simpara>The resource was successfully grabbed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAB_ALREADY_GRABBED</literal></term>
- <listitem>
- <simpara>The resource is actively grabbed by another
-client.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAB_INVALID_TIME</literal></term>
- <listitem>
- <simpara>The resource was grabbed more recently than the
-specified time.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAB_NOT_VIEWABLE</literal></term>
- <listitem>
- <simpara>The grab window or the
-<parameter>confine_to</parameter> window are not viewable.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAB_FROZEN</literal></term>
- <listitem>
- <simpara>The resource is frozen by an active grab of another
-client.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>Pointer grabs are used for operations that need complete
-control over mouse events, even if the mouse leaves the application. For
-example it is used for drag and drop, for dragging the handle in the <link
-linkend="class-gtkhpaned"><classname>gtk.HPaned</classname></link> and <link
-linkend="class-gtkvpaned"><classname>gtk.VPaned</classname></link> widgets.
-Note that if the event mask of an X window has selected both button press
-and button release events, then a button press event will cause an automatic
-pointer grab until the button is released. X does this automatically since
-most applications expect to receive button press and release events in
-pairs. It is equivalent to a pointer grab on the window with
-<parameter>owner_events</parameter> set to <literal>True</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pointer-ungrab">
- <title>gtk.gdk.pointer_ungrab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pointer_ungrab</methodname>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>a timestamp from a <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> or 0L
-to use the current time</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pointer_ungrab</function>() function
-ungrabs the pointer if it is grabbed by this application.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--keyboard-grab">
- <title>gtk.gdk.keyboard_grab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keyboard_grab</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">owner_events</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> that
-will own the grab (the grab window).</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">owner_events</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>False</literal> then all keyboard
-events are reported with respect to <parameter>window</parameter>. If
-<literal>True</literal> then keyboard events for this application are
-reported as normal, but keyboard events outside this application are
-reported with respect to <parameter>window</parameter>. Both key press and
-key release events are always reported, independent of the event mask set by
-the application.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>a timestamp from a <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> or 0L
-to use the current time</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a grab status value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.keyboard_grab</function>() function grabs
-the keyboard so that all events are passed to this application until the
-keyboard is ungrabbed with the <link
-linkend="function-gdk--keyboard-ungrab"><function>gtk.gdk.keyboard_ungrab</function>()</link>)
-function. This overrides any previous keyboard grab by this client.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--keyboard-ungrab">
- <title>gtk.gdk.keyboard_ungrab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keyboard_ungrab</methodname>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>a timestamp from a <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> or 0L
-to use the current time</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.keyboard_ungrab</function>() function
-ungrabs the keyboard if it is grabbed by this application.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pointer-is-grabbed">
- <title>gtk.gdk.pointer_is_grabbed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pointer_is_grabbed</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the pointer is
-currently grabbed by this application.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pointer_is_grabbed</function>() function
-returns <literal>True</literal> if the pointer is currently grabbed by this
-application. Note that this does not take the implicit pointer grab on
-button presses into account.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--flush">
- <title>gtk.gdk.flush</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.flush</methodname>
- <methodparam><parameter
- role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.gdk.flush</function>() function flushes the X
-output buffer and waits until all requests have been processed by the
-server. This is rarely needed by applications.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--beep">
- <title>gtk.gdk.beep</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.beep</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.gdk.beep</function>() function emits a short
-beep.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--set-double-click-time">
- <title>gtk.gdk.set_double_click_time</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.set_double_click_time</methodname>
- <methodparam><parameter
- role="keyword">msec</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">msec</parameter>&nbsp;:</term>
- <listitem><simpara>the double click time in
-milliseconds</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.set_double_click_time</function>()
-function set the double click time for the default display. Applications
-should NOT set this, it is a global user-configured setting.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--threads-enter">
- <title>gtk.gdk.threads_enter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.threads_enter</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.gdk.threads_enter</function>() function marks
-the beginning of a critical section that only one thread can operate within
-at a time. The critical section is guarded by a <literal>GDK</literal>
-mutual exclusion lock. Python threads are enabled while waiting for the
-<literal>GDK</literal> lock. See the <link
-linkend="function-gdk--threads-init"><function>gtk.gtk.threads_init</function>()</link>
-function for more information about threading.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--threads-leave">
- <title>gtk.gdk.threads_leave</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.threads_leave</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.gdk.threads_leave</function>() function marks
-the end of a critical section started by the <link
-linkend="function-gdk--threads-enter"><function>gtk.gdk.threads_enter</function>()</link>
-function. See the <link
-linkend="function-gdk--threads-init"><function>gtk.gtk.threads_init</function>()</link>
-function for more information about threading.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--threads-init">
- <title>gtk.gdk.threads_init</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.threads_init</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.gdk.threads_init</function>() function
-initializes <literal>PyGTK</literal> to use the Python macros that allow
-multiple threads to serialize access to the Python interpreter (using the
-Python Global Interpreter Lock (GIL)). In addition, the
-<function>gtk.gdk.threads_init</function>() function initializes the
-<literal>GDK</literal> global lock (mutex) that serializes thread access to
-the <literal>GTK</literal> and <literal>GDK</literal> libraries. Thus there
-are two different global locking mechanisms at work that are initialized by
-the <function>gtk.gdk.threads_init</function>() function: Python and
-<literal>GDK</literal>.</para>
-
- <para>The <function>gtk.gdk.threads_init</function>() function must be
-called before the <link
-linkend="function-gtk--main"><function>gtk.main</function>()</link>
-function. At this point in the application the Python GIL is held by the
-main application thread. (Usually the main thread calls the
-<function>gtk.gdk.threads_init</function>() function though any thread could
-call it instead.) When the <link
-linkend="function-gtk--main"><function>gtk.main</function>()</link> function
-is called the GIL is released and other threads may use the Python
-interpreter. When <literal>PyGTK</literal> signal handlers are invoked in
-the main thread the GIL is reacquired so that the Python interpreter can run
-the handler code.</para>
-<!--
- <para>The assumptions behind <literal>PyGTK</literal> thread support
-were originally:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>A GIL count is initialized for each thread to indicate
-that it holds the GIL - the assumption being that the thread will be a
-Python thread and will hold the GIL when it starts because it is running in
-the Python interpreter. <literal>PyGTK</literal> adds the GIL count for each
-thread to provide a recursive lock mechanism. That is, a Python thread may
-attempt to gain exclusive access to the Python interpreter multiple times
-without fear of deadlock.</simpara>
- </listitem>
- <listitem>
- <simpara>The Python thread that calls the
-<function>gtk.main</function>() function releases the GIL allowing other
-Python threads to run.</simpara>
- </listitem>
- <listitem>
- <simpara><literal>PyGTK</literal> does not release the GIL when
-calling a <literal>GTK</literal> or <literal>GDK</literal> function. Also it
-does not acquire the <literal>GDK</literal> global lock (GGL). This means
-that, in effect, Python threads can use the GIL alone to serialize access to
-the <literal>GTK</literal> and <literal>GDK</literal> libraries. Of course,
-if there are non-Python threads calling <literal>GTK</literal> or
-<literal>GDK</literal> functions the GGL must be used.</simpara>
- </listitem>
- <listitem>
- <simpara>Signal, timeout and idle handlers written in Python that
-are invoked from the <literal>GTK</literal> mainloop acquire the GIL
-automatically.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The <link
-linkend="function-gdk- -threads-enter"><function>gtk.gdk.threads_enter</function>()</link>
-and <link
-linkend="function-gdk- -threads-leave"><function>gtk.gdk.threads_leave</function>()</link>
-functions use the <literal>GDK</literal> global lock (GGL) to manage access
-to the <literal>GTK</literal> and <literal>GDK</literal> libraries. The
-intention is to allow only one thread to execute within the
-<literal>GTK</literal> and <literal>GDK</literal> code at a time.
-Theoretically any time a thread calls a <literal>PyGTK</literal> method or
-function it should bracket the call with the <link
-linkend="function-gdk- -threads-enter"><function>gtk.gdk.threads_enter</function>()</link>
-and <link
-linkend="function-gdk- -threads-leave"><function>gtk.gdk.threads_leave</function>()</link>
-functions. If your application only uses Python threads then this is not
-necessary since only the main thread can safely call
-<literal>PyGTK</literal> methods or functions. However if your application
-has foreign threads that call <literal>GTK</literal> or
-<literal>GDK</literal> functions you should use the <link
-linkend="function-gdk- -threads-enter"><function>gtk.gdk.threads_enter</function>()</link>
-and <link
-linkend="function-gdk- -threads-leave"><function>gtk.gdk.threads_leave</function>()</link>
-functions to serialize access.</para>
-
- <note>
- <para>Signal handlers are automatically invoked within a
-<function>gdk_threads_enter</function>() and
-<function>gdk_threads_leave</function>() function pair by
-<literal>GTK</literal> so the <link
-linkend="function-gdk- -threads-enter"><function>gtk.gdk.threads_enter</function>()</link>
-and <link
-linkend="function-gdk- -threads-leave"><function>gtk.gdk.threads_leave</function>()</link>
-functions should not be called within a Python signal handler or the
-application will deadlock. However, idle, timeout and input handlers are
-executed outside the GGL so these should use the <link
-linkend="function-gdk- -threads-enter"><function>gtk.gdk.threads_enter</function>()</link>
-and <link
-linkend="function-gdk- -threads-leave"><function>gtk.gdk.threads_leave</function>()</link>
-functions if <literal>PyGTK</literal> methods or functions are
-called.</para>
- </note>
-
- <para>In general the safest strategy is to only call
-<literal>PyGTK</literal> methods and functions from the main Python thread
-and use idle or timeout handlers (which run in the main thread) to invoke
-<literal>PyGTK</literal> calls from other threads.</para>
--->
- </refsect2>
-
- <refsect2 id="function-gdk--rgb-ditherable">
- <title>gtk.gdk.rgb_ditherable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.rgb_ditherable</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> is
-ditherable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.rgb_ditherable</function>() function
-returns <literal>True</literal> if the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> is
-ditherable. This function may be useful for presenting a user interface
-choice to the user about which dither mode is desired; if the display is not
-ditherable, it may make sense to gray out or hide the corresponding UI
-widget.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--rgb-get-colormap">
- <title>gtk.gdk.rgb_get_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.rgb_get_colormap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the preferred <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-for rendering image data.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.rgb_get_colormap</function>() function
-returns the preferred <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--rgb-set-verbose">
- <title>gtk.gdk.rgb_set_verbose</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.rgb_set_verbose</methodname>
- <methodparam><parameter
- role="keyword">verbose</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">verbose</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> messages should be
-verbose</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.rgb_set_verbose</function>() function sets
-the "verbose" flag to the value specified by <parameter>verbose</parameter>.
-If <parameter>verbose</parameter> is <literal>True</literal> messages will
-be verbose. This is generally only useful for debugging.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--rgb-set-install">
- <title>gtk.gdk.rgb_set_install</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.rgb_set_install</methodname>
- <methodparam><parameter
- role="keyword">install</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">install</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> set install
-mode</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.rgb_set_install</function>() function sets
-the "install" mode to the value of <parameter>install</parameter>. If
-<parameter>install</parameter> is <literal>True</literal>, a new "private"
-colormap is always installed rather than trying to find a best fit with the
-colors already allocated. Ordinarily, a colormap only be installed if a
-sufficient cube cannot be allocated. A private colormap has more colors,
-leading to better quality display, but also leads to the dreaded "colormap
-flashing" effect.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--rgb-set-min-colors">
- <title>gtk.gdk.rgb_set_min_colors</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.rgb_set_min_colors</methodname>
- <methodparam><parameter
- role="keyword">min_colors</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">min_colors</parameter>&nbsp;:</term>
- <listitem><simpara>the minimum number of
-colors.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.rgb_set_min_colors</function>() function
-sets the minimum number of colors for the color cube to the value specified
-by <parameter>min_colors</parameter>. Generally, the largest color cube is
-allocated. If a color cube at least as large as
-<parameter>min_colors</parameter> can't be allocated, a private colormap is
-installed. </para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--rgb-get-visual">
- <title>gtk.gdk.rgb_get_visual</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.rgb_get_visual</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> being
-used</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.rgb_get_visual</function>() function
-returns the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> being
-used to render image data on the default screen.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--selection-owner-get">
- <title>gtk.gdk.selection_owner_get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.selection_owner_get</methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>an atom indentifying a
-selection.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> that
-owns the selection or None.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.selection_owner_get</function>() function
-returns the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> that
-owns the selection specified by <parameter>selection</parameter> if there is
-a selection owner for this window, and if it is a window known to the
-current application. Note that the return value may be owned by a different
-process if a foreign window was previously created for that window, but a
-new foreign window will never be created by this call.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--selection-send-notify">
- <title>gtk.gdk.selection_send_notify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.selection_send_notify</methodname>
- <methodparam><parameter
- role="keyword">requestor</parameter></methodparam>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- <methodparam><parameter
- role="keyword">property</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">requestor</parameter>&nbsp;:</term>
- <listitem><simpara>the integer ID of the window to deliver the
-response to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>an atom representing the selection that was
-requested.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>an atom representing the target that was
-selected. </simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">property</parameter>&nbsp;:</term>
- <listitem><simpara>an atom representing the property in which the
-selection owner stored the data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>a timestamp</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.selection_send_notify</function>()
-function sends a response to a SelectionRequest event.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--set-sm-client-id">
- <title>gtk.gdk.set_sm_client_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.set_sm_client_id</methodname>
- <methodparam><parameter
- role="keyword">sm_client_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">sm_client_id</parameter>&nbsp;:</term>
- <listitem><simpara>the client id string assigned by the session
-manager when the connection was opened</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.set_sm_client_id</function>() function
-sets the <literal>SM_CLIENT_ID</literal> property on the application's
-leader window so that the window manager can save the application's state
-using the X11R6 ICCCM session management protocol. See the X Session
-Management Library documentation for more information on session management
-and the Inter-Client Communication Conventions Manual (ICCCM) for
-information on the <literal>WM_CLIENT_LEADER</literal> property. (Both
-documents are part of the X Window System distribution.)</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--notify-startup-complete">
- <title>gtk.gdk.notify_startup_complete</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.notify_startup_complete</methodname>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This function is available in PyGTK 2.8 and above</para>
- </note>
-
- <para>The <function>gtk.gdk.notify_startup_complete</function>()
-function indicates to the GUI environment that the application has finished
-loading. If the applications opens windows, this function is normally called
-after opening the application's initial set of windows.</para>
-
- <para>GTK+ will call this function automatically after opening the
-first <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> unless
-the <link
-linkend="function-gtk--window-set-auto-startup-notification"><function>gtk.window_set_auto_startup_notification</function>()</link>
-function is called to disable that feature.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--get-program-class">
- <title>gtk.gdk.get_program_class</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.get_program_class</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the program class</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.8 and above</para>
- </note>
-
- <para>The <function>gtk.gdk.get_program_class</function>() function
-returns the program class. Unless the program class has explicitly been set
-with the <link
-linkend="function-gdk--set-program-class"><function>gtk.gdk.set_program_class</function>()</link>
-function or with the <option>--class</option> commandline option, the
-default value is the program name with the first character converted to
-uppercase.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--set-program-class">
- <title>gtk.gdk.set_program_class</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.set_program_class</methodname>
- <methodparam><parameter
- role="keyword">program_class</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">program_class</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the program
-class</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.8 and above</para>
- </note>
-
- <para>The <function>gtk.gdk.set_program_class</function>() function
-sets the program class to the string contained in
-<parameter>program_class</parameter>. The <literal>X11</literal> backend
-uses the program class to set the class name part of the
-<literal>WM_CLASS</literal> property on toplevel windows.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--get-display">
- <title>gtk.gdk.get_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.get_display</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the display</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.8 and above</para>
- </note>
-
- <para>The <function>gtk.gdk.get_display</function>() function returns
-the name of the display, which is usually derived from the
-<envar>DISPLAY</envar> environment variable or the
-<option>--display</option> command line option.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--get-display-arg-name">
- <title>gtk.gdk.get_display_arg_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.get_display_arg_name</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the display name, if specified explicitly, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.8 and above</para>
- </note>
-
- <para>The <function>gtk.gdk.get_display_arg_name</function>() function
-returns the display name specified in the command line arguments, if any or
-<literal>None</literal> if the display name was not explicitly set.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--gdk-pango-context-get-for-screen">
- <title>gtk.gdk.gdk_pango_context_get_for_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.gdk_pango_context_get_for_screen</methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.8 and above</para>
- </note>
-
- <para>The
-<function>gtk.gdk.gdk_pango_context_get_for_screen</function>() function
-creates a new <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-object for the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-specified by <parameter>screen</parameter>. Normally you should use the
-<link
-linkend="method-gtkwidget--get-pango-context"><methodname>get_pango_context</methodname>()</link>
-method instead of this function, to get the appropriate Pango context for
-the widget you intend to render text onto.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--gdk-pango-context-get">
- <title>gtk.gdk.gdk_pango_context_get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.gdk_pango_context_get</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-for the default display.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.8 and above</para>
- </note>
-
- <para>The <function>gtk.gdk.gdk_pango_context_get</function>()
-function creates a new <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link> for
-the default display. Normally you should use the <link
-linkend="method-gtkwidget--get-pango-context"><methodname>get_pango_context</methodname>()</link>
-method instead of this function, to get the appropriate Pango context for
-the widget you intend to render text onto.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkatom.xml b/docs/reference/pygtk-gdkatom.xml
deleted file mode 100644
index cc085330..00000000
--- a/docs/reference/pygtk-gdkatom.xml
+++ /dev/null
@@ -1,182 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkatom">
- <refnamediv>
- <refname>gtk.gdk.Atom</refname>
- <refpurpose>an object representing an interned string</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Atom</classname></ooclass>
-<constructorsynopsis language="python">
- <methodname><link linkend="constructor-gdkatom-intern">gtk.gdk.atom_intern</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">only_if_exists</parameter><initializer><literal>False</literal></initializer></methodparam>
- </constructorsynopsis>
-</classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> is a
-<literal>PyGTK</literal> class that wraps the <literal>GTK</literal>+
-<type>GdkAtom</type> - an unsigned integer representing an interned
-string. An interned string is a string that has an internal
-<literal>GTK</literal>+ mapping between an atom and a string. <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> has no
-methods. A copy of the interned string can be retrieved by using the Python
-<function>str()</function> function. <link
-linkend="constructor-gdkatom-intern">gtk.gdk.atom_intern</link>() will
-return a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>
-referencing an existing interned string but will intern a string if it isn't
-already interned.</para>
-
- <para><link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> objects
-are used to provide the targets for <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-objects that are used by <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link> and
-<link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>,
-objects and for drag and drop (see <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link>,
-<link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-and <link
-linkend="class-gtktreedragsource"><classname>gtk.TreeDragSource</classname></link>
-and <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-for more information). The advantage of the interned string is that it is
-easy to pass between processes and even systems since only an integer value
-is passed.</para>
-
- <para><literal>PyGTK</literal> 2.4 has a number of pre-defined atoms
-that map to builtin <literal>GTK+</literal> interned string atoms. The
-interned strings and the <literal>PyGTK</literal> 2.4 <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> objects
-are:</para>
-
- <variablelist>
- <varlistentry>
- <term>"PRIMARY"</term>
- <listitem>
- <simpara><literal>gtk.gdk.SELECTION_PRIMARY</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"SECONDARY"</term>
- <listitem>
- <simpara><literal>gtk.gdk.SELECTION_SECONDARY</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"CLIPBOARD"</term>
- <listitem>
- <simpara><literal>gtk.gdk.SELECTION_CLIPBOARD</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"ATOM"</term>
- <listitem>
- <simpara><literal>gtk.gdk.SELECTION_TYPE_ATOM</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"BITMAP"</term>
- <listitem>
- <simpara><literal>gtk.gdk.TARGET_BITMAP</literal> or
-<literal>gtk.gdk.SELECTION_TYPE_BITMAP</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"COLORMAP"</term>
- <listitem>
- <simpara><literal>gtk.gdk.TARGET_COLORMAP</literal> or
-<literal>gtk.gdk.SELECTION_TYPE_COLORMAP</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"DRAWABLE"</term>
- <listitem>
- <simpara><literal>gtk.gdk.TARGET_DRAWABLE</literal> or
-<literal>gtk.gdk.SELECTION_TYPE_DRAWABLE</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"PIXMAP"</term>
- <listitem>
- <simpara><literal>gtk.gdk.TARGET_PIXMAP</literal> or
-<literal>gtk.gdk.SELECTION_TYPE_PIXMAP</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"STRING"</term>
- <listitem>
- <simpara><literal>gtk.gdk.TARGET_STRING</literal> or
-<literal>gtk.gdk.SELECTION_TYPE_STRING</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"WINDOW"</term>
- <listitem>
- <simpara><literal>gtk.gdk.SELECTION_TYPE_WINDOW</literal></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>Also in <literal>PyGTK</literal> 2.4, comparison between a string
-and a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> is
-supported.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkatom-intern">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.atom_intern</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">only_if_exists</parameter><initializer><literal>False</literal></initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the string to be interned or
- retrieved</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">only_if_exists</parameter>&nbsp;:</term>
- <listitem><simpara>this value is ignored</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>
- or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>
-referencing the interned string specified by <parameter>name</parameter>. An
-interned string is a string that has a <literal>GTK</literal>+ mapping to an
-unsigned integer value. This constructor will intern the string and create a
-<link linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> if
-it does not already exist. <parameter>only_if_exists</parameter> is
-ignored and essentially is always <literal>False</literal>.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkcairocontext.xml b/docs/reference/pygtk-gdkcairocontext.xml
deleted file mode 100644
index 4bff8fc2..00000000
--- a/docs/reference/pygtk-gdkcairocontext.xml
+++ /dev/null
@@ -1,260 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkcairocontext">
- <refnamediv>
- <refname>gtk.gdk.CairoContext</refname>
- <refpurpose>object providing support for drawing using Cairo (new in
-PyGTK 2.8)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.CairoContext</classname></ooclass>
- <ooclass><classname><link
-linkend="class-pangocairocairocontext">pangocairo.CairoContext</link></classname></ooclass>
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkcairocontext--set-source-color">set_source_color</link></methodname>
- <methodparam><parameter role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkcairocontext--set-source-pixbuf">set_source_pixbuf</link></methodname>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- <methodparam><parameter role="keyword">pixbuf_x</parameter></methodparam>
- <methodparam><parameter role="keyword">pixbuf_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkcairocontext--rectangle">rectangle</link></methodname>
- <methodparam><parameter role="keyword">rectangle</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkcairocontext--region">region</link></methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkcairocontext--set-source-pixmap">set_source_pixmap</link></methodname>
- <methodparam><parameter role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter role="keyword">pixmap_x</parameter></methodparam>
- <methodparam><parameter role="keyword">pixmap_y</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- cairo.Context
- +-- <link linkend="class-pangocairocairocontext">pangocairo.CairoContext</link>
- +-- <link linkend="class-gdkcairocontext">gtk.gdk.CairoContext</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>Cairo is a graphics library that supports vector graphics and
-image compositing that can be used with PyGTK. Since 2.8, GTK+ and Pango do
-most of their drawing using Cairo. The Cairo drawing model and primitives
-are similar to PostScript which uses an imaging model of painting on a two
-dimensional surface. There is a Python module that wraps the Cairo API that
-is used by PyGTK via subclassing of the cairo.Context class by the <link
-linkend="class-pangocairocairocontext"><classname>pangocairo.CairoContext</classname></link>
-class. The cairo.Context class provides most of the drawing primitives used
-for drawing on Cairo surfaces.</para>
-
- <para>PyGTK (and GTK+ and GDK) does not wrap the Cairo API, instead
-<link
-linkend="class-gdkcairocontext"><classname>gtk.gdk.CairoContext</classname></link>
-objects can be used to draw on <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-objects. A <link
-linkend="class-gdkcairocontext"><classname>gtk.gdk.CairoContext</classname></link>
-is created using the <link
-linkend="method-gdkdrawable--cairo-create"><methodname>gtk.gdk.Drawable.cairo_create</methodname>()</link>
-method. See the <link
-linkend="class-pangocairocairocontext"><classname>pangocairo.CairoContext</classname></link>
-and Python cairo module documentation for additional methods.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkcairocontext--set-source-color">
- <title>gtk.gdk.CairoContext.set_source_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_source_color</methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_source_color</methodname>() method sets the
-source color of the cairo context to the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-specified by <parameter>color</parameter>. See the
-cairo.Context.set_source_rgb() method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkcairocontext--set-source-pixbuf">
- <title>gtk.gdk.CairoContext.set_source_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_source_pixbuf</methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixbuf_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixbuf_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixbuf_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the location to place the
-upper left corner of <parameter>pixbuf</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixbuf_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the location to place the
-upper left corner of <parameter>pixbuf</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_source_pixbuf</methodname>() method sets the
-<link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-specified by <parameter>pixbuf</parameter> as the source pattern for the
-cairo context. The pattern has an extend mode of
-<literal>cairo.EXTEND_NONE</literal> and is aligned so that the origin of
-<parameter>pixbuf</parameter> is at the location specified by
-<parameter>pixbuf_x</parameter>, <parameter>pixbuf_y</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkcairocontext--rectangle">
- <title>gtk.gdk.CairoContext.rectangle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>rectangle</methodname>
- <methodparam><parameter
- role="keyword">rectangle</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rectangle</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
- or a 4-tuple representing a rectangle</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>rectangle</methodname>() method adds the
- rectangle specified by <parameter>rectangle</parameter> to the current
- path.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkcairocontext--region">
- <title>gtk.gdk.CairoContext.region</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>region</methodname>
- <methodparam><parameter
- role="keyword">region</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">region</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>region</methodname>() method adds the
- <link linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link> specified by <parameter>region</parameter> to the current
- path.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkcairocontext--set-source-pixmap">
- <title>gtk.gdk.CairoContext.set_source_pixmap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_source_pixmap</methodname>
- <methodparam><parameter
- role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixmap_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixmap_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixmap</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixmap_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the location to place the
-upper left corner of <parameter>pixmap</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixmap_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the location to place the
-upper left corner of <parameter>pixmap</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_source_pixmap</methodname>() method sets the
-<link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-specified by <parameter>pixmap</parameter> as the source pattern for the
-cairo context. The pattern has an extend mode of
-<literal>cairo.EXTEND_NONE</literal> and is aligned so that the origin of
-<parameter>pixmap</parameter> is at the location specified by
-<parameter>pixmap_x</parameter>, <parameter>pixmap_y</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkcolor.xml b/docs/reference/pygtk-gdkcolor.xml
deleted file mode 100644
index 36e987ec..00000000
--- a/docs/reference/pygtk-gdkcolor.xml
+++ /dev/null
@@ -1,210 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkcolor">
- <refnamediv>
- <refname>gtk.gdk.Color</refname>
- <refpurpose>an object holding color information</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Color</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkcolor">gtk.gdk.Color</link></methodname>
- <methodparam><parameter
- role="keyword">red</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">green</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">blue</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">pixel</parameter>
- <initializer>0</initializer></methodparam>
- </constructorsynopsis></classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gdk--color-parse">gtk.gdk.color_parse</link></methodname>
- <methodparam><parameter role="keyword">spec</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"pixel"</entry>
- <entry>Read-Write</entry>
- <entry>The pixel value of the color</entry>
- </row>
-
- <row valign="top">
- <entry>"red"</entry>
- <entry>Read-Write</entry>
- <entry>The value of the red component of the color</entry>
- </row>
-
- <row valign="top">
- <entry>"green"</entry>
- <entry>Read-Write</entry>
- <entry>The value of the green component of the color</entry>
- </row>
-
- <row valign="top">
- <entry>"blue"</entry>
- <entry>Read-Write</entry>
- <entry>The value of the blue component of the color</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-contains the values of a color that may or may not be allocated. The red,
-green and blue attributes are specified by an unsigned integer in the range
-0-65535. The pixel value is an index into the colormap that has allocated
-the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>.
-Typically a color is allocated by using the <link
-linkend="method-gdkcolormap--alloc-color"><methodname>gdk.Colormap.alloc_color</methodname>()</link>
-method. Unallocated colors can be used to specify the color attributes of
-<link linkend="class-gtkstyle"><classname>gtk.Style</classname></link>
-objects since these colors will be allocated when an attempt is made to use
-the <link linkend="class-gtkstyle"><classname>gtk.Style</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkcolor">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Color</methodname>
- <methodparam><parameter
- role="keyword">red</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">green</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">blue</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">pixel</parameter>
- <initializer>0</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">red</parameter>&nbsp;:</term>
- <listitem><simpara>The red color component in the range
-0-65535</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">green</parameter>&nbsp;:</term>
- <listitem><simpara>The green color component in the range
-0-65535</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">blue</parameter>&nbsp;:</term>
- <listitem><simpara>The blue color component in the range
-0-65535</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixel</parameter>&nbsp;:</term>
- <listitem><simpara>The index of the color when allocated in its
-colormap</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> object
-with the color component values specified by <parameter>red</parameter>,
-<parameter>green</parameter> and <parameter>blue</parameter> (all default to
-0) and using the pixel value specified by <parameter>pixel</parameter>. The
-value of <parameter>pixel</parameter> will be overwritten when the color is
-allocated.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--color-parse">
- <title>gtk.gdk.color_parse</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.color_parse</methodname>
- <methodparam><parameter role="keyword">spec</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">spec</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing a color
-specification</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.color_parse</function>() method returns
-the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-specified by <parameter>spec</parameter>. The format of
-<parameter>spec</parameter> is a string containing the specification of the
-color either as a name (e.g. "navajowhite") as specified in the X11
-<filename>rgb.txt</filename> file or as a hexadecimal string (e.g.
-"#FF0078"). The hexadecimal string must start with '#' and must contain 3
-sets of hexadecimal digits of the same length (i.e. 1, 2 ,3 or 4 digits).
-For example the following specify the same color value: "#F0A", "#FF00AA",
-"#FFF000AAA" and "#FFFF0000AAAA". The <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> is
-<emphasis>not</emphasis> allocated.</para>
-
- <para>This function raise the ValueError (TypeError prior to PyGTK
-2.4) exception if unable to parse the color specification</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkcolormap.xml b/docs/reference/pygtk-gdkcolormap.xml
deleted file mode 100644
index bfb12819..00000000
--- a/docs/reference/pygtk-gdkcolormap.xml
+++ /dev/null
@@ -1,488 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkcolormap">
- <refnamediv>
- <refname>gtk.gdk.Colormap</refname>
- <refpurpose>a table of color display component values</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Colormap</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkcolormap">gtk.gdk.Colormap</link></methodname>
- <methodparam><parameter
- role="keyword">visual</parameter></methodparam>
- <methodparam><parameter
- role="keyword">allocate</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkcolormap--alloc-color">alloc_color</link></methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- <methodparam><parameter
- role="keyword">writeable</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">best_match</parameter>
- <initializer>True</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkcolormap--alloc-color2">alloc_color</link></methodname>
- <methodparam><parameter
- role="keyword">spec</parameter></methodparam>
- <methodparam><parameter
- role="keyword">writeable</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">best_match</parameter>
- <initializer>True</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkcolormap--alloc-color3">alloc_color</link></methodname>
- <methodparam><parameter
- role="keyword">red</parameter></methodparam>
- <methodparam><parameter
- role="keyword">green</parameter></methodparam>
- <methodparam><parameter
- role="keyword">blue</parameter></methodparam>
- <methodparam><parameter
- role="keyword">writeable</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">best_match</parameter>
- <initializer>True</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkcolormap--get-visual">get_visual</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkcolormap--get-screen">get_screen</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkcolormap--query-color">query_color</link></methodname>
- <methodparam><parameter role="keyword">pixel</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gdk--colormap-get-system">gtk.gdk.colormap_get_system</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkcolormap">gtk.gdk.Colormap</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-contains a table mapping index values to the RGB color component values used
-to display the colors. The index value corresponds to the pixel value of a
-<link linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-object and the RGB component values correspond to the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> red,
-green and blue values. The <link
-linkend="method-gtkwidget--get-colormap"><methodname>gtk.Widget.get_colormap</methodname>()</link>
-method is used to retrieve the colormap used by a widget. The default system
-colormap is retrieved by using the <link
-linkend="function-gdk--colormap-get-system"><methodname>gtk.gdk.colormap_get_system</methodname>()</link>
-function. The <link
-linkend="method-gdkcolormap--alloc-color"><methodname>alloc_color</methodname>()</link>
-method has three signatures to allow the color specification using an
-unallocated <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>, a
-string or a RGB trio.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkcolormap">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Colormap</methodname>
- <methodparam><parameter
- role="keyword">visual</parameter></methodparam>
- <methodparam><parameter
- role="keyword">allocate</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">visual</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> to
-use</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">allocate</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the newly created
-colormap will be a private colormap, and all colors in it will be allocated
-for the applications use.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-for the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
-specified by <parameter>visual</parameter>. If
-<parameter>allocate</parameter> is <literal>True</literal> the colormap will
-be a private colormap for the sole use of the application.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkcolormap--alloc-color">
- <title>gtk.gdk.Colormap.alloc_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>alloc_color</methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- <methodparam><parameter role="keyword">writeable</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter role="keyword">best_match</parameter>
- <initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>an unallocated <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">writeable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the colormap entry
-is writeable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">best_match</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> a best match to the
-requested color can be used if needed.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>alloc_color</methodname>() method allocates the
-color specified by <parameter>color</parameter> in the colormap. The value
-of color should be an unallocated <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>. If
-<parameter>writeable</parameter> is <literal>True</literal> the color is
-allocated writeable which means it can be changed after allocation but
-cannot be shared with another application. If
-<parameter>best_match</parameter> is <literal>True</literal> the closest
-match to the color will be returned if the request could not be satisfied
-exactly.</para>
-
- <para>This method raises:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the ValueError (TypeError prior to PyGTK 2.4) exception if
-unable to parse the color specification</simpara>
- </listitem>
- <listitem>
- <simpara>the RuntimeError exception if the color could not be
-allocated</simpara>
- </listitem>
- </itemizedlist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkcolormap--alloc-color2">
- <title>gtk.gdk.Colormap.alloc_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>alloc_color</methodname>
- <methodparam><parameter
- role="keyword">spec</parameter></methodparam>
- <methodparam><parameter role="keyword">writeable</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter role="keyword">best_match</parameter>
- <initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">spec</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing a color
-specification</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">writeable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the colormap entry
-is writeable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">best_match</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> a best match to the
-requested color can be used if needed.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>alloc_color</methodname>() method allocates the
-color specified by <parameter>spec</parameter> in the colormap. The format
-of <parameter>spec</parameter> is a string containing the specification of
-the color either as a name (e.g. "navajowhite") as specified in the X11
-<filename>rgb.txt</filename> file or as a hexadecimal string (e.g.
-"#FF0078"). The hexadecimal string must start with '#' and must contain 3
-sets of hexadecimal digits of the same length (i.e. 1, 2 ,3 or 4 digits).
-For example the following specify the same color value: "#F0A", "#FF00AA",
-"#FFF000AAA" and "#FFFF0000AAAA". If <parameter>writeable</parameter> is
-<literal>True</literal> the color is allocated writeable which means it can
-be changed after allocation but cannot be shared with another application.
-If <parameter>best_match</parameter> is <literal>True</literal> the closest
-match to the color will be returned if the request could not be satisfied
-exactly.</para>
-
- <para>This method raises:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the ValueError (TypeError prior to PyGTK 2.4) exception if
-unable to parse the color specification</simpara>
- </listitem>
- <listitem>
- <simpara>the RuntimeError exception if the color could not be
-allocated</simpara>
- </listitem>
- </itemizedlist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkcolormap--alloc-color3">
- <title>gtk.gdk.Colormap.alloc_color</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>alloc_color</methodname>
- <methodparam><parameter role="keyword">red</parameter></methodparam>
- <methodparam><parameter role="keyword">green</parameter></methodparam>
- <methodparam><parameter role="keyword">blue</parameter></methodparam>
- <methodparam><parameter role="keyword">writeable</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter role="keyword">best_match</parameter>
- <initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">red</parameter>&nbsp;:</term>
- <listitem><simpara>the red component of the color in the range 0-65535</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">green</parameter>&nbsp;:</term>
- <listitem><simpara>the green component of the color in the range 0-65535</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">blue</parameter>&nbsp;:</term>
- <listitem><simpara>the blue component of the color in the range 0-65535</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">writeable</parameter>&nbsp;:</term>
- <listitem><simpara>a gboolean</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">best_match</parameter>&nbsp;:</term>
- <listitem><simpara>a gboolean</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>alloc_color</methodname>() method allocates the
-color specified by the component values <parameter>red</parameter>,
-<parameter>green</parameter> and <parameter>blue</parameter>. If
-<parameter>writeable</parameter> is <literal>True</literal> the color is
-allocated writeable which means it can be changed after allocation but
-cannot be shared with another application. If
-<parameter>best_match</parameter> is <literal>True</literal> the closest
-match to the color will be returned if the request could not be satisfied
-exactly.</para>
-
- <para>This method raises:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the ValueError (TypeError prior to PyGTK 2.4) exception if
-unable to parse the color specification</simpara>
- </listitem>
- <listitem>
- <simpara>the RuntimeError exception if the color could not be
-allocated</simpara>
- </listitem>
- </itemizedlist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkcolormap--get-visual">
- <title>gtk.gdk.Colormap.get_visual</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visual</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visual</methodname>() method returns the
-visual the colormap was created for. See the <link
-linkend="constructor-gdkcolormap">gtk.gdk.Colormap</link>
-constructor.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkcolormap--get-screen">
- <title>gtk.gdk.Colormap.get_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_screen</methodname>
- <methodparam></methodparam>
-</methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_screen</methodname>() method returns the
-<link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-the colormap was created for.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkcolormap--query-color">
- <title>gtk.gdk.Colormap.query_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>query_color</methodname>
- <methodparam></methodparam>
-</methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixel</parameter>&nbsp;:</term>
- <listitem><simpara>a pixel value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
- corresponding to <parameter>pixel</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>query_color</methodname>() method returns the
-<link linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-corresponding to the hardware pixel value specified by
-<parameter>pixel</parameter>. <parameter>pixel</parameter> must be a valid
-pixel in the colormap. It's a programmer error to call this method with a
-pixel which is not in the colormap. Hardware pixels are normally obtained
-from the <link
-linkend="method-gdkcolormap--alloc-color"><methodname>alloc_color</methodname>()</link>
-method, or from a <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
-object. (A <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
-contains image data in hardware format while a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-contains image data in a canonical 24-bit RGB format.)</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--colormap-get-system">
- <title>gtk.gdk.colormap_get_system</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.colormap_get_system</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the system' default
-colormap</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>gtk.gdk.colormap_get_system</methodname>()
-method returns the default colormap used by the system on the default
-screen. See the <link
-linkend="method-gdkscreen--get-system-colormap"><methodname>gtk.gdk.Screen.get_system_colormap</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkcursor.xml b/docs/reference/pygtk-gdkcursor.xml
deleted file mode 100644
index 89186b43..00000000
--- a/docs/reference/pygtk-gdkcursor.xml
+++ /dev/null
@@ -1,795 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkcursor">
- <refnamediv>
- <refname>gtk.gdk.Cursor</refname>
- <refpurpose>standard and pixmap cursors</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Cursor</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkcursor1">gtk.gdk.Cursor</link></methodname>
- <methodparam><parameter role="keyword">cursor_type</parameter></methodparam>
- </constructorsynopsis>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkcursor2">gtk.gdk.Cursor</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- <methodparam><parameter role="keyword">cursor_type</parameter></methodparam>
- </constructorsynopsis>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkcursor3">gtk.gdk.Cursor</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </constructorsynopsis>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkcursor4">gtk.gdk.Cursor</link></methodname>
- <methodparam><parameter role="keyword">source</parameter></methodparam>
- <methodparam><parameter role="keyword">mask</parameter></methodparam>
- <methodparam><parameter role="keyword">fg</parameter></methodparam>
- <methodparam><parameter role="keyword">bg</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkcursor--get-display">get_display</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link>
-represents a bitmap image used for the mouse pointer. Each <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> can
-have its own cursor. By default a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> uses
-its parent's cursor. A standard set of cursors is provided in
-<literal>PyGTK</literal>:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.X_CURSOR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/X_cursor.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BASED_ARROW_DOWN</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/based_arrow_down.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BASED_ARROW_UP</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/based_arrow_up.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOAT</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/boat.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOGOSITY</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/bogosity.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOTTOM_LEFT_CORNER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/bottom_left_corner.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOTTOM_RIGHT_CORNER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/bottom_right_corner.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOTTOM_SIDE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/bottom_side.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOTTOM_TEE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/bottom_tee.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BOX_SPIRAL</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/box_spiral.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CENTER_PTR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/center_ptr.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CIRCLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/circle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CLOCK</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/clock.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.COFFEE_MUG</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/coffee_mug.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CROSS</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/cross.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CROSS_REVERSE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/cross_reverse.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CROSSHAIR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/crosshair.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DIAMOND_CROSS</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/diamond_cross.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DOT</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/dot.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DOTBOX</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/dotbox.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DOUBLE_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/double_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAFT_LARGE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/draft_large.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAFT_SMALL</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/draft_small.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAPED_BOX</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/draped_box.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.EXCHANGE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/exchange.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.FLEUR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/fleur.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GOBBLER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/gobbler.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GUMBY</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/gumby.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HAND1</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/hand1.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HAND2</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/hand2.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.HEART</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/heart.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ICON</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/icon.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.IRON_CROSS</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/iron_cross.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LEFT_PTR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/left_ptr.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LEFT_SIDE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/left_side.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LEFT_TEE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/left_tee.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LEFTBUTTON</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/leftbutton.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LL_ANGLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/ll_angle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LR_ANGLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/lr_angle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MAN</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/man.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MIDDLEBUTTON</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/middlebutton.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MOUSE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/mouse.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PENCIL</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/pencil.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PIRATE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/pirate.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PLUS</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/plus.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.QUESTION_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/question_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RIGHT_PTR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/right_ptr.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RIGHT_SIDE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/right_side.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RIGHT_TEE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/right_tee.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RIGHTBUTTON</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/rightbutton.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RTL_LOGO</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/rtl_logo.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SAILBOAT</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sailboat.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_DOWN_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_down_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_H_DOUBLE_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_h_double_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_LEFT_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_left_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_RIGHT_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_right_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_UP_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_up_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SB_V_DOUBLE_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sb_v_double_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SHUTTLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/shuttle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SIZING</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/sizing.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SPIDER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/spider.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SPRAYCAN</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/spraycan.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.STAR</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/star.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TARGET</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/target.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TCROSS</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/tcross.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TOP_LEFT_ARROW</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/top_left_arrow.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TOP_LEFT_CORNER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/top_left_corner.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TOP_RIGHT_CORNER</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/top_right_corner.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TOP_SIDE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/top_side.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TOP_TEE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/top_tee.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TREK</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/trek.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.UL_ANGLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/ul_angle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.UMBRELLA</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/umbrella.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.UR_ANGLE</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/ur_angle.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WATCH</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/watch.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.XTERM</literal></term>
- <listitem>
- <simpara><imagedata fileref="cursors/xterm.png" format="png"/></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gdkcursor1">
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Cursor</methodname>
- <methodparam><parameter role="keyword">cursor_type</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cursor_type</parameter>&nbsp;:</term>
- <listitem><simpara>the standard cursor to
-create</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates the new <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link> from
-a builtin cursor specified by <parameter>cursor_type</parameter>. To make
-the cursor invisible, see the description of the <link
-linkend="constructor-gdkcursor4">gtk.gdk.Cursor</link>() constructor that
-creates a cursor from a pixmap below.</para>
-
- </refsect2>
-
- <refsect2 id="constructor-gdkcursor2">
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Cursor</methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- <methodparam><parameter role="keyword">cursor_type</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
- to create the cursor for</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">cursor_type</parameter>&nbsp;:</term>
- <listitem><simpara>the standard cursor to
-create</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates the new <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link> for
-the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-specified by <parameter>display</parameter> from a builtin cursor specified
-by <parameter>cursor_type</parameter>. To make the cursor invisible, see the
-description of the <link
-linkend="constructor-gdkcursor4">gtk.gdk.Cursor</link>() constructor that
-creates a cursor from a pixmap below.</para>
-
- </refsect2>
-
- <refsect2 id="constructor-gdkcursor3">
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Cursor</methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
- to create the cursor for</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-holding the cursor image</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the "hot spot" x offset</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the "hot spot" y offset</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link> for
-the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-specified by display using the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-specified by <parameter>source</parameter> as the icon image. The "hotspot"
-of the cursor will be located as the position specified by
-<parameter>x</parameter> and <parameter>y</parameter>. To make the cursor
-invisible, see the description of the <link
-linkend="constructor-gdkcursor4">gtk.gdk.Cursor</link>() constructor that
-creates a cursor from a pixmap below</para>
-
- </refsect2>
-
- <refsect2 id="constructor-gdkcursor4">
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Cursor</methodname>
- <methodparam><parameter role="keyword">source</parameter></methodparam>
- <methodparam><parameter role="keyword">mask</parameter></methodparam>
- <methodparam><parameter role="keyword">fg</parameter></methodparam>
- <methodparam><parameter role="keyword">bg</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">source</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-holding the cursor image</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">mask</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> to
-use as a mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fg</parameter>&nbsp;:</term>
- <listitem><simpara>the unallocated foreground <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">bg</parameter>&nbsp;:</term>
- <listitem><simpara>the unallocated background <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the "hot spot" x offset</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the "hot spot" y offset</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link>
-using:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-specified by <parameter>source</parameter> as the icon image</simpara>
- </listitem>
- <listitem>
- <simpara>the <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-specified by <parameter>mask</parameter> to mask
-<parameter>source</parameter> (must be the same size as source)</simpara>
- </listitem>
- <listitem>
- <simpara>the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-specified by <parameter>fg</parameter> as the foreground color of the
-cursor</simpara>
- </listitem>
- <listitem>
- <simpara>the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-specified by <parameter>bg</parameter> as the background color of the
-cursor</simpara>
- </listitem>
- <listitem>
- <simpara>the horizontal offset of the cursor "hot spot" specified
-by <parameter>x</parameter></simpara>
- </listitem>
- <listitem>
- <simpara>the vertical offset of the cursor "hot spot" specified
-by <parameter>y</parameter></simpara>
- </listitem>
- </itemizedlist>
-
- <para>To make the cursor invisible, create a cursor from an empty
-<link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-as follows:</para>
-
- <programlisting>
- pixmap = gtk.gdk.Pixmap(None, 1, 1, 1)
- color = gtk.gdk.Color()
- cursor = gtk.gdk.Cursor(pixmap, pixmap, color, color, 0, 0)
-</programlisting>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkcursor--get-display">
- <title>gtk.gdk.Cursor.get_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_display</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the associated <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_display</methodname>() method returns the
-<link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link> on
-which the cursor is defined.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkdevice.xml b/docs/reference/pygtk-gdkdevice.xml
deleted file mode 100644
index 36150fb0..00000000
--- a/docs/reference/pygtk-gdkdevice.xml
+++ /dev/null
@@ -1,663 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkdevice">
- <refnamediv>
- <refname>gtk.gdk.Device</refname>
- <refpurpose>an object for supporting input devices</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Device</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdevice--set-source">set_source</link></methodname>
- <methodparam><parameter
- role="keyword">source</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdevice--set-mode">set_mode</link></methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdevice--set-key">set_key</link></methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">modifiers</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdevice--set-axis-use">set_axis_use</link></methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- <methodparam><parameter role="keyword">use</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdevice--get-state">get_state</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdevice--get-history">get_history</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">stop</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdevice--get-axis">get_axis</link></methodname>
- <methodparam><parameter
- role="keyword">axes</parameter></methodparam>
- <methodparam><parameter role="keyword">use</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--devices-list">gtk.gdk.devices_list</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--device-get-core-pointer">gtk.gdk.device_get_core_pointer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkdevice">gtk.gdk.Device</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"axes"</entry>
- <entry>Read</entry>
- <entry>a tuple containing axes information. Each axes is
-described by a tuple containing: use information (one of:
-<literal>gtk.gdk.AXIS_IGNORE</literal>, <literal>gtk.gdk.AXIS_X</literal>,
-<literal>gtk.gdk.AXIS_Y</literal>, <literal>gtk.gdk.AXIS_PRESSURE</literal>,
-<literal>gtk.gdk.AXIS_XTILT</literal>,
-<literal>gtk.gdk.AXIS_YTILT</literal>,
-<literal>gtk.gdk.AXIS_WHEEL</literal>,
-<literal>gtk.gdk.AXIS_LAST</literal>), the minimum and maximum axes
-values.</entry>
- </row>
-
- <row valign="top">
- <entry>"has_cursor"</entry>
- <entry>Read</entry>
- <entry>if <literal>True</literal> the pointer follows device
-motion.</entry>
- </row>
-
- <row valign="top">
- <entry>"keys"</entry>
- <entry>Read</entry>
- <entry>a tuple describing the mapped macro buttons. Each macro
-button is described by a tuple containing: a key value output when the macro
-button is pressed and a set of modifiers output with the key value.</entry>
- </row>
-
- <row valign="top">
- <entry>"mode"</entry>
- <entry>Read</entry>
- <entry>the mode of this device - one of:
-<literal>gtk.gdk.MODE_DISABLED</literal>,
-<literal>gtk.gdk.MODE_SCREEN</literal>,
-<literal>gtk.gdk.MODE_WINDOW</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"name"</entry>
- <entry>Read</entry>
- <entry>the name of this device.</entry>
- </row>
-
- <row valign="top">
- <entry>"num_axes"</entry>
- <entry>Read</entry>
- <entry>the length of the <literal>axes</literal>
-tuple.</entry>
- </row>
-
- <row valign="top">
- <entry>"num_keys"</entry>
- <entry>Read</entry>
- <entry>the length of the <literal>keys</literal> tuple</entry>
- </row>
-
- <row valign="top">
- <entry>"source"</entry>
- <entry>Read</entry>
- <entry>the type of this device - one of:
-<literal>gtk.gdk.SOURCE_MOUSE</literal>,
-<literal>gtk.gdk.SOURCE_PEN</literal>,
-<literal>gtk.gdk.SOURCE_ERASER</literal>,
-<literal>gtk.gdk.SOURCE_CURSOR</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>In addition to the normal keyboard and mouse input devices,
-<literal>PyGTK</literal> also contains support for extended input devices.
-In particular, this support is targeted at graphics tablets. Graphics
-tablets typically return sub-pixel positioning information and possibly
-information about the pressure and tilt of the stylus. Under X, the support
-for extended devices is done through the XInput extension. Because handling
-extended input devices may involve considerable overhead, they need to be
-turned on for each <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-individually using <link
-linkend="method-gdkwindow--input-set-extension-events"><methodname>gtk.gdk.Window.input_set_extension_events</methodname>()</link>.
-(Or, more typically, for <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> objects,
-using the <link
-linkend="method-gtkwidget--set-extension-events"><methodname>gtk.Widget.set_extension_events</methodname>()</link>
-method). As an additional complication, depending on the support from the
-windowing system, its possible that a normal mouse cursor will not be
-displayed for a particular extension device. If an application does not want
-to deal with displaying a cursor itself, it can ask only to get extension
-events from devices that will display a cursor, by passing the
-<literal>gtk.gdk.EXTENSION_EVENTS_CURSOR</literal> value to the <link
-linkend="method-gdkwindow--input-set-extension-events"><methodname>gtk.gdk.Window.input_set_extension_events</methodname>()</link>
-method. Otherwise, the application must retrieve the device information
-using the <link
-linkend="function-gdk--devices-list"><methodname>gtk.gdk.devices_list</methodname>()</link>
-function, check the has_cursor field, and, if it is
-<literal>False</literal>, draw a cursor itself when it receives motion
-events. </para>
-
- <para>Each pointing device is assigned a unique integer ID; events from
-a particular device can be identified by the <parameter>deviceid</parameter>
-attribute in the event structure. The events generated by pointer devices
-have also been extended to contain <parameter>pressure</parameter>,
-<parameter>xtilt</parameter> and <parameter>ytilt</parameter> attributes
-which contain the extended information reported as additional valuators from
-the device. The <parameter>pressure</parameter> attribute ranges from 0.0 to
-1.0, while the tilt attributes range from -1.0 to 1.0. (With -1.0
-representing the maximum tilt to the left or up, and 1.0 representing the
-maximum tilt to the right or down.) One additional attribute in each event
-is the <parameter>source</parameter> attribute, which contains an
-enumeration value describing the type of device; this currently can be one
-of <literal>gtk.gdk.SOURCE_MOUSE</literal>,
-<literal>gtk.gdk.SOURCE_PEN</literal>,
-<literal>gtk.gdk.SOURCE_ERASER</literal>, or
-<literal>gtk.gdk.SOURCE_CURSOR</literal>. This attribute is present to allow
-simple applications to (for instance) delete when they detect eraser devices
-without having to keep track of complicated per-device settings.</para>
-
- <para>Various aspects of each device may be configured. The easiest way
-of creating a GUI to allow the user to configure such a device is to use the
-<link
-linkend="class-gtkinputdialog"><classname>gtk.InputDialog</classname></link>
-widget in <literal>PyGTK</literal>. However, even when using this widget,
-application writers will need to directly query and set the configuration
-parameters in order to save the state between invocations of the
-application. The configuration of devices is queried using the <link
-linkend="function-gdk--devices-list"><methodname>gtk.gdk.devices_list</methodname>()</link>
-function. Each device must be activated using the <link
-linkend="method-gdkdevice--set-mode"><methodname>set_mode</methodname>()</link>
-method, which also controls whether the device's range is mapped to the
-entire screen or to a single window. The mapping of the valuators of the
-device onto the predefined valuator types is set using the <link
-linkend="method-gdkdevice--set-axis-use"><methodname>set_axis_use</methodname>()</link>
-method. And the source type for each device can be set with the <link
-linkend="method-gdkdevice--set-source"><methodname>set_source</methodname>()</link>
-method.</para>
-
- <para>Devices may also have associated keys or macro buttons. Such keys
-can be globally set to map into normal X keyboard events. The mapping is set
-using the <link
-linkend="method-gdkdevice--set-key"><methodname>set_key</methodname>()</link>
-method. The interfaces in this section will most likely be considerably
-modified in the future to accommodate devices that may have different sets of
-additional valuators than the pressure xtilt and ytilt.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkdevice--set-source">
- <title>gtk.gdk.Device.set_source</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_source</methodname>
- <methodparam><parameter
- role="keyword">source</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">source</parameter>&nbsp;:</term>
- <listitem><simpara>the source type of the
-device</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_source</methodname>() method sets the source
-type for the input device to the value specified by
-<parameter>source</parameter>. The value of <parameter>source</parameter>
-must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.SOURCE_MOUSE</literal></term>
- <listitem>
- <simpara>the device is a mouse. (This will be reported for the
-core pointer, even if it is something else, such as a trackball.)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SOURCE_PEN</literal></term>
- <listitem>
- <simpara>the device is a stylus of a graphics tablet or similar
-device.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SOURCE_ERASER</literal></term>
- <listitem>
- <simpara>the device is an eraser. Typically, this would be the
-other end of a stylus on a graphics tablet.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SOURCE_CURSOR</literal></term>
- <listitem>
- <simpara>the device is a graphics tablet "puck" or similar
-device.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdevice--set-mode">
- <title>gtk.gdk.Device.set_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_mode</methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mode</parameter>&nbsp;:</term>
- <listitem><simpara>the input mode</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the mode was
-successfully changed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_mode</methodname>() method sets the input
-device mode to the value specified by <parameter>mode</parameter>. The value
-of <parameter>mode</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.MODE_DISABLED</literal></term>
- <listitem>
- <simpara>the device is disabled and will not report any
-events.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MODE_SCREEN</literal></term>
- <listitem>
- <simpara>the device is enabled. The device's coordinate space
-maps to the entire screen.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MODE_WINDOW</literal></term>
- <listitem>
- <simpara>the device is enabled. The device's coordinate space is
-mapped to a single window. The manner in which this window is chosen is
-undefined, but it will typically be the same way in which the focus window
-for key events is determined.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdevice--set-key">
- <title>gtk.gdk.Device.set_key</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_key</methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">modifiers</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the macro button to
-set.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>the key value to generate.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">modifiers</parameter>&nbsp;:</term>
- <listitem><simpara>the modifiers to set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_key</methodname>() method sets the key event
-to generate when a macro button of a device is pressed. The macro button is
-specified by <parameter>index</parameter>. The key value and modifiers
-generated are specified by <parameter>keyval</parameter> and
-<parameter>modifiers</parameter> respectively.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdevice--set-axis-use">
- <title>gtk.gdk.Device.set_axis_use</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_axis_use</methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the axis.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">use</parameter>&nbsp;:</term>
- <listitem><simpara>how the axis is used.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_axis_use</methodname>() method sets the axis
-(specified by <parameter>index</parameter>) of the input device to be used
-in the fashion specified by <parameter>use</parameter>. The value of
-<parameter>use</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_IGNORE</literal></term>
- <listitem>
- <simpara>the axis is ignored.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_X</literal></term>
- <listitem>
- <simpara>the axis is used as the x axis.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_Y</literal></term>
- <listitem>
- <simpara>the axis is used as the y axis.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_PRESSURE</literal></term>
- <listitem>
- <simpara>the axis is used for pressure information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_XTILT</literal></term>
- <listitem>
- <simpara>the axis is used for x tilt information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_YTILT</literal></term>
- <listitem>
- <simpara>the axis is used for y tilt information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_WHEEL</literal></term>
- <listitem>
- <simpara>the axis is used for wheel information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_LAST</literal></term>
- <listitem>
- <simpara>a constant equal to the numerically highest axis
-value.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdevice--get-state">
- <title>gtk.gdk.Device.get_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_state</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing: a tuple containing the axes
-data; and, the modifiers in effect.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_state</methodname>() method returns a tuple
-containing:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>a tuple containing the axes data</simpara>
- </listitem>
- <listitem>
- <simpara>the bitmask containing the set of key modifiers in
-effect</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The state information is relative to the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-specified by <parameter>window</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdevice--get-history">
- <title>gtk.gdk.Device.get_history</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_history</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">stop</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>the earliest event time
-limit</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">stop</parameter>&nbsp;:</term>
- <listitem><simpara>the latest event time
-limit</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing event tuples each with axes
-data and a timestamp</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_history</methodname>() method returns a
-tuple containing the motion history for the device with respect to the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-specified by window between the time limits specified by
-<parameter>start</parameter> and <parameter>stop</parameter>. The motion
-history is a tuple containing event motion tuples that each contain a
-timestamp for the event and a tuple with the axes data for the event.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdevice--get-axis">
- <title>gtk.gdk.Device.get_axis</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_axis</methodname>
- <methodparam><parameter
- role="keyword">axes</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">axes</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of axes values</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">use</parameter>&nbsp;:</term>
- <listitem><simpara>the axis use to match</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the axis value from <parameter>axes</parameter>
-that matches the use type or <literal>None</literal> if there is no
-match.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_axis</methodname>() method returns the value
-in <parameter>axes</parameter> whose axis matches the specified
-<parameter>use</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--devices-list">
- <title>gtk.gdk.devices_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.devices_list</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list containing the <link
-linkend="class-gdkdevice"><classname>gtk.gdk.Device</classname></link>
-objects for the default display</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.devices_list</function>() function returns
-a list containing the <link
-linkend="class-gdkdevice"><classname>gtk.gdk.Device</classname></link>
-objects fro the default display.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--device-get-core-pointer">
- <title>gtk.gdk.device_get_core_pointer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.device_get_core_pointer</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the </simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.device_get_core_pointer</function>()
-function returns the device that is used as the core pointer.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkdisplay.xml b/docs/reference/pygtk-gdkdisplay.xml
deleted file mode 100644
index 9633cd4d..00000000
--- a/docs/reference/pygtk-gdkdisplay.xml
+++ /dev/null
@@ -1,1186 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gdkdisplay">
- <refnamediv>
- <refname>gtk.gdk.Display</refname>
-
- <refpurpose>controls the keyboard/mouse pointer grabs and a set of <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-objects</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Display</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gdkdisplay">gtk.gdk.Display</link></methodname>
- <methodparam><parameter role="keyword">display_name</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--get-name">get_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--get-n-screens">get_n_screens</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--get-screen">get_screen</link></methodname>
- <methodparam><parameter role="keyword">screen_num</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--get-default-screen">get_default_screen</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--pointer-ungrab">pointer_ungrab</link></methodname>
- <methodparam><parameter role="keyword">time_</parameter><initializer>0L</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--keyboard-ungrab">keyboard_ungrab</link></methodname>
- <methodparam><parameter role="keyword">time_</parameter><initializer>0L</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--pointer-is-grabbed">pointer_is_grabbed</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--beep">beep</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--sync">sync</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--close">close</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--list-devices">list_devices</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--get-event">get_event</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--peek-event">peek_event</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--put-event">put_event</link></methodname>
- <methodparam><parameter role="keyword">event</parameter></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay- -add-client-message-filter">add_client_message_filter</link></methodname>
- <methodparam><parameter role="keyword">message_type</parameter></methodparam>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--set-double-click-time">set_double_click_time</link></methodname>
- <methodparam><parameter role="keyword">msec</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--get-core-pointer">get_core_pointer</link></methodname>
- <methodparam></methodparam>
-</methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--get-pointer">get_pointer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--get-window-at-pointer">get_window_at_pointer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay- -set-pointer-hooks">set_pointer_hooks</link></methodname>
- <methodparam><parameter role="keyword">new_hooks</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--flush">flush</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--set-double-click-distance">set_double_click_distance</link></methodname>
- <methodparam><parameter role="keyword">distance</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--supports-cursor-alpha">supports_cursor_alpha</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--supports-cursor-color">supports_cursor_color</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--get-default-cursor-size">get_default_cursor_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--get-maximal-cursor-size">get_maximal_cursor_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--get-default-group">get_default_group</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--supports-selection-notification">supports_selection_notification</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--supports-clipboard-persistence">supports_clipboard_persistence</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--request-selection-notification">request_selection_notification</link></methodname>
- <methodparam><parameter role="keyword">selection</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplay--store-clipboard">store_clipboard</link></methodname>
- <methodparam><parameter role="keyword">clipboard_window</parameter></methodparam>
- <methodparam><parameter role="keyword">time_</parameter></methodparam>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gdk--display-get-default">gtk.gdk.display_get_default</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkdisplay">gtk.gdk.Display</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gdkdisplay--closed">closed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>is_error</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
-
- <note>
- <para>This object is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para><link linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link> objects provide two capabilities:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>To grab/ungrab keyboard focus and mouse pointer</simpara>
- </listitem>
- <listitem>
- <simpara>To manage and provide information about the <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>)
- objects available for this <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link></simpara>
- </listitem>
- </itemizedlist>
-
- <para><link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-objects are the <literal>GDK</literal> representation of the X Display which
-can be described as a workstation consisting of a keyboard, a pointing
-device (such as a mouse) and one or more screens. It is used to open and
-keep track of various <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-objects currently instantiated by the application. It is also used to grab
-and release the keyboard and the mouse pointer.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkdisplay">
- <title>Constructor</title>
-
-<programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Display</methodname>
- <methodparam><parameter role="keyword">display_name</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the display to
- open</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term> <listitem><simpara>a
- <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>,
- or <literal>None</literal> if the display could not be
- opened.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>Opens the display with the name specified by
-<parameter>display_name</parameter> and returns a <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-object wrapping the display..</para>
-
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkdisplay--get-name">
- <title>gtk.gdk.Display.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term> <listitem><simpara>a
- string representing the display name.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_name</methodname>() method returns the name
-of the display.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--get-n-screens">
- <title>gtk.gdk.Display.get_n_screens</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_screens</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of display
- screens.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_n_screens</methodname>() method returns the
-number of screens managed by the display.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--get-screen">
- <title>gtk.gdk.Display.get_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_screen</methodname>
- <methodparam><parameter role="keyword">screen_num</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">screen_num</parameter>&nbsp;:</term>
- <listitem><simpara>the screen number</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
- object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_screen</methodname>() method returns a <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-object for one of the screens of the display.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--get-default-screen">
- <title>gtk.gdk.Display.get_default_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_screen</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
- object for <parameter>display</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_default_screen</methodname>() method returns
-the default <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> for
-the display</para> </refsect2>
-
-
- <refsect2 id="method-gdkdisplay--pointer-ungrab">
- <title>gtk.gdk.Display.pointer_ungrab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pointer_ungrab</methodname>
- <methodparam><parameter role="keyword">time_</parameter><initializer>0L</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">time_</parameter>&nbsp;:</term>
- <listitem><simpara>a timestamp or 0L for the current
- time.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>pointer_ungrab</methodname>() method releases
-any pointer grab held by the display.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--keyboard-ungrab">
- <title>gtk.gdk.Display.keyboard_ungrab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>keyboard_ungrab</methodname>
- <methodparam><parameter role="keyword">time_</parameter><initializer>0L</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">time_</parameter>&nbsp;:</term>
- <listitem><simpara>a timestamp or 0L for the current
- time.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>keyboard_ungrab</methodname>() method
-releases any keyboard grab held by the display.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--pointer-is-grabbed">
- <title>gtk.gdk.Display.pointer_is_grabbed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pointer_is_grabbed</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if an active X pointer
- grab is in effect</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>pointer_is_grabbed</methodname>() method returns
-<literal>True</literal> if the pointer is grabbed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--beep">
- <title>gtk.gdk.Display.beep</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>beep</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>beep</methodname>() method
-emits a short beep on the display.</para> </refsect2>
-
-
- <refsect2 id="method-gdkdisplay--sync">
- <title>gtk.gdk.Display.sync</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>sync</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>sync</methodname>() method flushes any requests
-queued for the windowing system and waits until all requests have been
-handled. This is often used for making sure that the display is synchronized
-with the current state of the program. This is most useful for X11. On
-windowing systems where requests are handled synchronously, this method will
-do nothing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--close">
- <title>gtk.gdk.Display.close</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>close</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>close</methodname>() method closes the
-connection to the windowing system for the given display, and cleans up
-associated resources.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--list-devices">
- <title>gtk.gdk.Display.list_devices</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_devices</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of <link
- linkend="class-gdkdevice"><classname>gtk.gdk.Device</classname></link>
- objects.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>list_devices</methodname>() method returns the
-list of available input devices attached to the display.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--get-event">
- <title>gtk.gdk.Display.get_event</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_event</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the next <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
- to be processed, or <literal>None</literal> if no events are
- pending..</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_event</methodname>() method returns the next
-<link linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
-to be processed for the display, fetching events from the windowing system
-if necessary. The returned <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> should
-be freed with the <link
-linkend="method-gdkevent--free"><methodname>gtk.gdk.Event.free()</methodname></link>
-method </para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--peek-event">
- <title>gtk.gdk.Display.peek_event</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>peek_event</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the first <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
- on the event queue, or <literal>None</literal> if no events are in
- the queue.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>peek_event</methodname>() method returns a copy
-of the first <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> in the
-the display's event queue, without removing the event from the queue. (Note
-that this method will not get more events from the windowing system. It only
-checks the events that have already been moved to the <literal>GDK</literal>
-event queue.) The returned <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> should
-be freed with <link
-linkend="method-gdkevent--free"><methodname>gtk.gdk.Event.free()</methodname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--put-event">
- <title>gtk.gdk.Display.put_event</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>put_event</methodname>
- <methodparam><parameter role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>put_event</methodname>() method appends a copy
-of the given event onto the front of the event queue for the display.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gdkdisplay- -add-client-message-filter">
- <title>gtk.gdk.Display.add_client_message_filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_client_message_filter</methodname>
- <methodparam><parameter role="keyword">message_type</parameter></methodparam>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">message_type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of ClientMessage events to receive.
-This will be checked against the <parameter>message_type</parameter> field
-of the XClientMessage event struct.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>the function to call to process the event.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to <parameter>func</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>
-Adds a filter to be called when X ClientMessage events are received.
-</para>
- <para>
-Since: 2.2
-</para> </refsect2>
-END NTO IMPLEMENTED -->
-
- <refsect2 id="method-gdkdisplay--set-double-click-time">
- <title>gtk.gdk.Display.set_double_click_time</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_double_click_time</methodname>
- <methodparam><parameter role="keyword">msec</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">msec</parameter>&nbsp;:</term>
- <listitem><simpara>the double click time in milliseconds
- (thousandths of a second)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_double_click_time</methodname>() method sets
-the double click time (two clicks within this time interval count as a
-double click and result in a <literal>gtk.gdk._2BUTTON_PRESS</literal>
-event). Applications should <emphasis>not</emphasis> set this, it is a
-global user-configured setting.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--get-core-pointer">
- <title>gtk.gdk.Display.get_core_pointer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_core_pointer</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the core pointer device</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_core_pointer</methodname>() method returns
-the core pointer device for the given display</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--get-pointer">
- <title>gtk.gdk.Display.get_pointer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pointer</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 4-tuple containing the screen that the cursor
- is on, the root window X and Y coordinates of the pointer and the
- current modifier mask</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_pointer</methodname>() method returns a
-4-tuple containing the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> that
-the pointer is on, the current location coordinates of the pointer and the
-current modifier mask for the display. The returned modifier mask is a
-combination of the <xref linkend="gdk-modifier-constants"
-endterm="gdk-modifier-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--get-window-at-pointer">
- <title>gtk.gdk.Display.get_window_at_pointer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_window_at_pointer</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple containing the <link
- linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
- under the mouse pointer and the x and y coordinates of the window
- origin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_window_at_pointer</methodname>() method
-returns a 3-tuple containing the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-underneath the mouse pointer and the location of that window's
-origin. Returns <literal>None</literal> if the window under the mouse
-pointer is not known to <literal>GDK</literal> (for example, belongs to
-another application).</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gdkdisplay- -set-pointer-hooks">
- <title>gtk.gdk.Display.set_pointer_hooks</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_pointer_hooks</methodname>
- <methodparam><parameter role="keyword">new_hooks</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">new_hooks</parameter>&nbsp;:</term>
- <listitem><simpara>a table of pointers to functions for getting
-quantities related to the current pointer position,
-or <literal>NULL</literal> to restore the default table.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the previous pointer hook table
-
-Since: 2.2</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>
-This function allows for hooking into the operation
-of getting the current location of the pointer on a particular
-display. This is only useful for such low-level tools as an
-event recorder. Applications should never have any
-reason to use this facility.
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gdkdisplay--flush">
- <title>gtk.gdk.Display.flush</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>flush</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>flush</methodname>() method flushes any requests
-queued for the windowing system; this happens automatically when the main
-loop blocks waiting for new events, but if your application is drawing
-without returning control to the main loop, you may need to call this method
-explicitly. A common case where this method needs to be called is when an
-application is executing drawing commands from a thread other than the
-thread where the main loop is running.</para>
-
- <para>This is most useful for X11. On windowing systems where requests
-are handled synchronously, this method will do nothing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--set-double-click-distance">
- <title>gtk.gdk.Display.set_double_click_distance</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_double_click_distance</methodname>
- <methodparam><parameter role="keyword">distance</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">distance</parameter>&nbsp;:</term>
- <listitem><simpara>the distance in pixels</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_double_click_distance</methodname>() method
-sets the double click distance (two clicks within this distance count as a
-double click and result in a <literal>gtk.gdk.2BUTTON_PRESS</literal>
-event). See the <link
-linkend="method-gdkdisplay--set-double-click-time"><methodname>set_double_click_time()</methodname></link>
-method for more information. Applications should <emphasis>not</emphasis>
-set this, it is a global user-configured setting.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--supports-cursor-alpha">
- <title>gtk.gdk.Display.supports_cursor_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>supports_cursor_alpha</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if cursors can have
- alpha channels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>supports_cursor_alpha</methodname>() method
-returns <literal>True</literal> if cursors can use an 8bit alpha channel on
-the display. Otherwise, cursors are restricted to bilevel alpha (i.e. a
-mask).</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--supports-cursor-color">
- <title>gtk.gdk.Display.supports_cursor_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>supports_cursor_color</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if cursors can have
- multiple colors.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>supports_cursor_color</methodname>() method
-returns <literal>True</literal> if multicolored cursors are supported on the
-display. Otherwise, cursors have only a foreground and a background
-color.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--get-default-cursor-size">
- <title>gtk.gdk.Display.get_default_cursor_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_cursor_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default cursor size.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_default_cursor_size</methodname>() method
-returns the default size to use for cursors on the display.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--get-maximal-cursor-size">
- <title>gtk.gdk.Display.get_maximal_cursor_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_maximal_cursor_size</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the maximal cursor width
- and height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_maximal_cursor_size</methodname>() method
-returns a 2-tuple containing the maximum width and height to use for cursors
-on the display.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--get-default-group">
- <title>gtk.gdk.Display.get_default_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_group</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The default group leader window for the
- display</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_default_group</methodname>() method returns
-the default group leader window for all toplevel windows on the
-display. This window is implicitly created by <literal>GDK</literal>. See
-the <link
-linkend="method-gdkwindow--set-group"><methodname>gtk.gdk.Window.set_group()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--supports-selection-notification">
- <title>gtk.gdk.Display.supports_selection_notification</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_group</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<literal>gtk.gdk.EventOwnerChange</literal> events will be
-sent.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>supports_selection_notification</methodname>()
-method returns <literal>True</literal> if
-<literal>gtk.gdk.EventOwnerChange</literal> events will be sent when the
-owner of a selection changes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--supports-clipboard-persistence">
- <title>gtk.gdk.Display.supports_clipboard_persistence</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>supports_clipboard_persistence</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the display
-supports clipboard persistence.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>supports_clipboard_persistence</methodname>()
-method Returns whether the specified display supports clipboard persistence;
-i.e. if it's possible to store the clipboard data after an application has
-quit. On X11 this checks if a clipboard daemon is running.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--request-selection-notification">
- <title>gtk.gdk.Display.request_selection_notification</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>request_selection_notification</methodname>
- <methodparam><parameter role="keyword">selection</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>The string (or <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>) naming
-the selection for which ownership change notification is
-requested</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>request_selection_notification</methodname>()
-method requests that <literal>gtk.gdk.EventOwnerChange</literal> events will
-be sent for changes in ownership of the atom specified by
-<parameter>selection</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplay--store-clipboard">
- <title>gtk.gdk.Display.store_clipboard</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>store_clipboard</methodname>
- <methodparam><parameter role="keyword">clipboard_window</parameter></methodparam>
- <methodparam><parameter role="keyword">time</parameter></methodparam>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">clipboard_window</parameter>&nbsp;:</term>
- <listitem><simpara> a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-belonging to the clipboard owner</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>a timestamp</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a list of targets that should be saved, or
-<literal>None</literal> if all available targets should be
-saved.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>store_clipboard</methodname>() method issues a
-request to the the clipboard manager to store the clipboard data. On X11,
-this is a special program that works according to the freedesktop clipboard
-specification, available at <ulink
-url="http://www.freedesktop.org/Standards/clipboard-manager-spec">http://www.freedesktop.org/Standards/clipboard-manager-spec</ulink>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--display-get-default">
- <title>gtk.gdk.display_get_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.display_get_default</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>,
- or <literal>None</literal> if there is no default
- display.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.display_get_default</function>() function
-returns the default <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>. This
-is a convenience function for:</para>
-
- <programlisting>
- display_manager = gtk.gdk.display_manager_get()
- display = display.manager.get_default_display()
-</programlisting>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gdkdisplay--closed">
- <title>The "closed" gtk.gdk.Display Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>display</parameter></methodparam>
- <methodparam><parameter>is_error</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>display</parameter>&nbsp;:</term>
- <listitem><simpara>the display that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>is_error</parameter>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the display was
- closed due to an error</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "closed" signal is emitted when the connection to the
-windowing system for <parameter>display</parameter> is closed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkdisplaymanager.xml b/docs/reference/pygtk-gdkdisplaymanager.xml
deleted file mode 100644
index 7b268605..00000000
--- a/docs/reference/pygtk-gdkdisplaymanager.xml
+++ /dev/null
@@ -1,279 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gdkdisplaymanager">
- <refnamediv>
- <refname>gtk.gdk.DisplayManager</refname>
-
- <refpurpose>maintains a list of all open <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-objects</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.DisplayManager</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplaymanager--get-default-display">get_default_display</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplaymanager--set-default-display">set_default_display</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdisplaymanager--list-displays">list_displays</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gdk--display-manager-get">gtk.gdk.display_manager_get</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkdisplaymanager">gtk.gdk.DisplayManager</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"default-display"</entry>
- <entry>Read-Write</entry>
-
- <entry>The default <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>. Available
-in GTK+ 2.2 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gdkdisplaymanager--display-opened">display-opened</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>displaymanager</parameter></methodparam>
- <methodparam><parameter>display</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <link
- linkend="class-gdkdisplaymanager"><classname>gtk.gdk.DisplayManager</classname></link>
- is a singleton object that offers notification when displays appear or
- disappear or the default display changes. The global <link
- linkend="class-gdkdisplaymanager"><classname>gtk.gdk.DisplayManager</classname></link>
- object is returned from the <link
- linkend="function-gdk--display-manager-get"><function>gtk.gdk.display_manager_get</function>()</link>
- function.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkdisplaymanager--get-default-display">
- <title>gtk.gdk.DisplayManager.get_default_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_display</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>,
- or <literal>None</literal> if there is no default
- display.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_default_display</methodname>() method
-returns the default <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplaymanager--set-default-display">
- <title>gtk.gdk.DisplayManager.set_default_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_default_display</methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_default_display</methodname>() method sets
-the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-specified by <parameter>display</parameter> as the default display.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdisplaymanager--list-displays">
- <title>gtk.gdk.DisplayManager.list_displays</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_displays</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list containing <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
- objects.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>list_displays</methodname>() method returns a
-list containing all currently open displays.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--display-manager-get">
- <title>gtk.gdk.display_manager_get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.display_manager_get</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term> <listitem><simpara>
- the singleton <link
- linkend="class-gdkdisplaymanager"><classname>gtk.gdk.DisplayManager</classname></link>
- object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>gtk.gdk.display_manager_get</methodname>()
-method returns the global <link
-linkend="class-gdkdisplaymanager"><classname>gtk.gdk.DisplayManager</classname></link>
-singleton.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gdkdisplaymanager--display-opened">
- <title>The "display-opened" gtk.gdk.DisplayManager Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>displaymanager</parameter></methodparam>
- <methodparam><parameter>display</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>displaymanager</parameter>&nbsp;:</term>
- <listitem><simpara>the displaymanager that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>display</parameter>&nbsp;:</term>
- <listitem><simpara>the display that was opened</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
-
- <note>
- <para>This signal is available in GTK+ 2.2 and above.</para>
- </note>
-
- <para>The "display-opened" signal is emitted when display is
-opened.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkdragcontext.xml b/docs/reference/pygtk-gdkdragcontext.xml
deleted file mode 100644
index d222b606..00000000
--- a/docs/reference/pygtk-gdkdragcontext.xml
+++ /dev/null
@@ -1,1146 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkdragcontext">
- <refnamediv>
- <refname>gtk.gdk.DragContext</refname>
- <refpurpose>an object containing the drag and drop context
-data</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.DragContext</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkdragcontext">gtk.gdk.DragContext</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--drag-status">drag_status</link></methodname>
- <methodparam><parameter
- role="keyword">action</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--drop-reply">drop_reply</link></methodname>
- <methodparam><parameter role="keyword">ok</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--drop-finish">drop_finish</link></methodname>
- <methodparam><parameter
- role="keyword">success</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--drag-get-selection">drag_get_selection</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--drag-find-window">drag_find_window</link></methodname>
- <methodparam><parameter
- role="keyword">drag_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x_root</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_root</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdragcontext--drag-find-window-for-screen">drag_find_window_for_screen</link></methodname>
- <methodparam><parameter
- role="keyword">drag_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x_root</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_root</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--drag-motion">drag_motion</link></methodname>
- <methodparam><parameter
- role="keyword">dest_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">protocol</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x_root</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_root</parameter></methodparam>
- <methodparam><parameter
- role="keyword">suggested_action</parameter></methodparam>
- <methodparam><parameter
- role="keyword">possible_actions</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--drag-drop">drag_drop</link></methodname>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--drag-abort">drag_abort</link></methodname>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--finish">finish</link></methodname>
- <methodparam><parameter
- role="keyword">success</parameter></methodparam>
- <methodparam><parameter
- role="keyword">del_</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--get-source-widget">get_source_widget</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--set-icon-widget">set_icon_widget</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--set-icon-pixmap">set_icon_pixmap</link></methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--set-icon-pixbuf">set_icon_pixbuf</link></methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--set-icon-stock">set_icon_stock</link></methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--set-icon-name">set_icon_name</link></methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--set-icon-default">set_icon_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdragcontext--drag-drop-succeeded">drag_drop_succeeded</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkdragcontext">gtk.gdk.DragContext</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"action"</entry>
- <entry>Read</entry>
- <entry>the action chosen by the destination. One of:
-<literal>gtk.gdk.ACTION_COPY</literal>,
-<literal>gtk.gdk.ACTION_MOVE</literal>,
-<literal>gtk.gdk.ACTION_LINK</literal>,
-<literal>gtk.gdk.ACTION_PRIVATE</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"actions"</entry>
- <entry>Read</entry>
- <entry>a bitmask of actions proposed by the source when
-<literal>suggested_action</literal> is
-<literal>gtk.gdk.ACTION_ASK</literal>. A combination of:
-<literal>gtk.gdk.ACTION_COPY</literal>,
-<literal>gtk.gdk.ACTION_MOVE</literal>,
-<literal>gtk.gdk.ACTION_LINK</literal>,
-<literal>gtk.gdk.ACTION_PRIVATE</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"dest_window"</entry>
- <entry>Read</entry>
- <entry>the destination <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-this drag.</entry>
- </row>
-
- <row valign="top">
- <entry>"is_source"</entry>
- <entry>Read</entry>
- <entry>if True the context is used on the source side.</entry>
- </row>
-
- <row valign="top">
- <entry>"protocol"</entry>
- <entry>Read</entry>
- <entry>the DND protocol which governs this drag - one of:
-<literal>gtk.gdk.DRAG_PROTO_MOTIF</literal>,
-<literal>gtk.gdk.DRAG_PROTO_XDND</literal>,
-<literal>gtk.gdk.DRAG_PROTO_ROOTWIN</literal>,
-<literal>gtk.gdk.DRAG_PROTO_NONE</literal>,
-<literal>gtk.gdk.DRAG_PROTO_WIN32_DROPFILES</literal>,
-<literal>gtk.gdk.DRAG_PROTO_OLE2</literal>,
-<literal>gtk.gdk.DRAG_PROTO_LOCAL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"source_window"</entry>
- <entry>Read</entry>
- <entry>the source <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-this drag.</entry>
- </row>
-
- <row valign="top">
- <entry>"start_time"</entry>
- <entry>Read</entry>
- <entry>a timestamp recording the start time of this
-drag.</entry>
- </row>
-
- <row valign="top">
- <entry>"suggested_action"</entry>
- <entry>Read</entry>
- <entry>the action suggested by the source. One of:
-<literal>gtk.gdk.ACTION_DEFAULT</literal>,
-<literal>gtk.gdk.ACTION_COPY</literal>,
-<literal>gtk.gdk.ACTION_MOVE</literal>,
-<literal>gtk.gdk.ACTION_LINK</literal>,
-<literal>gtk.gdk.ACTION_PRIVATE</literal>,
-<literal>gtk.gdk.ACTION_ASK</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"targets"</entry>
- <entry>Read</entry>
- <entry>a list of targets offered by the source.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link>
-holds information about a drag in progress. It is used for both source and
-destination. A <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link>
-can be created using the <link
-linkend="constructor-gdkdragcontext">gtk.gdk.DragContext</link>()
-constructor but since there is no way to set its attributes the new object
-is not much use. Useful <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link>
-objects are created as a result of the <link
-linkend="method-gdkwindow--drag-begin"><methodname>gtk.gdk.Window.drag_begin</methodname>()</link>
-or the <link
-linkend="method-gtkwidget--drag-begin"><methodname>gtk.Widget.drag_begin</methodname>()</link>
-methods.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkdragcontext">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.DragContext</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkdragcontext--drag-status">
- <title>gtk.gdk.DragContext.drag_status</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_status</methodname>
- <methodparam><parameter
- role="keyword">action</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">action</parameter>&nbsp;:</term>
- <listitem><simpara>a drag action that will be taken when a drop
-happens</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp for this
-action</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_status</methodname>() method sets the
-specified <parameter>action</parameter> to be taken when a drop happens. The
-value of <parameter>action</parameter> is one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_DEFAULT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_COPY</literal></term>
- <listitem>
- <simpara>Copy the data.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_MOVE</literal></term>
- <listitem>
- <simpara>Move the data, i.e. first copy it, then delete it from
-the source using the DELETE target of the X selection protocol.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_LINK</literal></term>
- <listitem>
- <simpara>Add a link to the data. Note that this is only useful
-if source and destination agree on what it means.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_PRIVATE</literal></term>
- <listitem>
- <simpara>Special action which tells the source that the
-destination will do something that the source doesn't understand.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ACTION_ASK</literal></term>
- <listitem>
- <simpara>Ask the user what to do with the data.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The time the action occurred is specified by
-<parameter>time</parameter>. This method is called by the drag destination
-in response to <link
-linkend="method-gdkdragcontext--drag-motion"><methodname>drag_motion</methodname>()</link>
-called by the drag source.
-</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--drop-reply">
- <title>gtk.gdk.DragContext.drop_reply</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drop_reply</methodname>
- <methodparam><parameter
- role="keyword">ok</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">ok</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the drop is accepted
-by the destination</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drop_reply</methodname>() method determines if
-the drop is accepted or rejected according to the value specified by
-<parameter>ok</parameter>. If <parameter>ok</parameter> is
-<literal>True</literal> the drop is accepted. <parameter>time</parameter>
-specifies the time that the drop reply occurred. This method is called by
-the drag destination when a drop is initiated by the drag source.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--drop-finish">
- <title>gtk.gdk.DragContext.drop_finish</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drop_finish</methodname>
- <methodparam><parameter
- role="keyword">success</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">success</parameter>&nbsp;:</term>
- <listitem><simpara>if True the data was
-received</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>the time of the finish</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drop_finish</methodname>() method ends a drag
-operation and indicates if the drop was successful by setting the value of
-<parameter>success</parameter>. <parameter>time</parameter> indicates the
-time of the drop finish. This method is called by the drag
-destination.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--drag-get-selection">
- <title>gtk.gdk.DragContext.drag_get_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_get_selection</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the selection atom</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_get_selection</methodname>() method returns
-the selection atom for the current source window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--drag-find-window">
- <title>gtk.gdk.DragContext.drag_find_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_find_window</methodname>
- <methodparam><parameter
- role="keyword">drag_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x_root</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_root</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">drag_window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x_root</parameter>&nbsp;:</term>
- <listitem><simpara>the x position of the pointer in root
-coordinates.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y_root</parameter>&nbsp;:</term>
- <listitem><simpara>the y position of the pointer in root
-coordinates.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the drag destination <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> and
-the drag protocol</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_find_window</methodname>() method returns a
-2-tuple containing the drag destination <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> and
-the drag protocol being used. The drag protocol is one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_MOTIF</literal></term>
- <listitem>
- <simpara>The Motif DND protocol. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_XDND</literal></term>
- <listitem>
- <simpara>The Xdnd protocol.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_ROOTWIN</literal></term>
- <listitem>
- <simpara>An extension to the Xdnd protocol for unclaimed root
-window drops. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_NONE</literal></term>
- <listitem>
- <simpara>no protocol.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_WIN32_DROPFILES</literal></term>
- <listitem>
- <simpara>The simple WM_DROPFILES protocol.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_OLE2</literal></term>
- <listitem>
- <simpara>The complex OLE2 DND protocol (not
-implemented).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_LOCAL</literal></term>
- <listitem>
- <simpara>Intra-application DND.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para><parameter>drag_window</parameter> is a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> and
-<parameter>x_root</parameter> and <parameter>y_root</parameter> specify the
-location of the mouse pointer in the root window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--drag-find-window-for-screen">
- <title>gtk.gdk.DragContext.drag_find_window_for_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_find_window_for_screen</methodname>
- <methodparam><parameter
- role="keyword">drag_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x_root</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_root</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">drag_window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
-<listitem><simpara>a <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x_root</parameter>&nbsp;:</term>
- <listitem><simpara>the x position of the pointer in root
-coordinates.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y_root</parameter>&nbsp;:</term>
- <listitem><simpara>the y position of the pointer in root
-coordinates.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the drag destination <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> and
-the drag protocol</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>drag_find_window_for_screen</methodname>()
-method returns a 2-tuple containing the drag destination <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> and
-the drag protocol being used. The drag protocol is one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_MOTIF</literal></term>
- <listitem>
- <simpara>The Motif DND protocol. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_XDND</literal></term>
- <listitem>
- <simpara>The Xdnd protocol.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_ROOTWIN</literal></term>
- <listitem>
- <simpara>An extension to the Xdnd protocol for unclaimed root
-window drops. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_NONE</literal></term>
- <listitem>
- <simpara>no protocol.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_WIN32_DROPFILES</literal></term>
- <listitem>
- <simpara>The simple WM_DROPFILES protocol.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_OLE2</literal></term>
- <listitem>
- <simpara>The complex OLE2 DND protocol (not
-implemented).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_PROTO_LOCAL</literal></term>
- <listitem>
- <simpara>Intra-application DND.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para><parameter>drag_window</parameter> is a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> and
-<parameter>x_root</parameter> and <parameter>y_root</parameter> specify the
-location of the mouse pointer in the root window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--drag-motion">
- <title>gtk.gdk.DragContext.drag_motion</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_motion</methodname>
- <methodparam><parameter
- role="keyword">dest_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">protocol</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x_root</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_root</parameter></methodparam>
- <methodparam><parameter
- role="keyword">suggested_action</parameter></methodparam>
- <methodparam><parameter
- role="keyword">possible_actions</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">dest_window</parameter>&nbsp;:</term>
- <listitem><simpara>the destination <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-drag is moving over</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">protocol</parameter>&nbsp;:</term>
- <listitem><simpara>the drag protocol in use</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x_root</parameter>&nbsp;:</term>
- <listitem><simpara>the x root coordinate of the mouse
-pointer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y_root</parameter>&nbsp;:</term>
- <listitem><simpara>the y root coordinate of the mouse
-pointer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">suggested_action</parameter>&nbsp;:</term>
- <listitem><simpara>the suggest drag action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">possible_actions</parameter>&nbsp;:</term>
- <listitem><simpara>the possible drag actions</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp of the drag
-motion</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if there is a drag destination window and
-the drag has paused or a drop has occurred.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_motion</methodname>() method updates the
-drag context when the pointer moves or the set of actions changes. This
-method is called by the drag source. <parameter>dest_window</parameter>
-specifies the drag destination <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>;
-<parameter>protocol</parameter> specifies the drag protocol being used (see
-the <link
-linkend="method-gdkdragcontext--drag-find-window"><methodname>drag_find_window</methodname>()</link>
-method for details); <parameter>x_root</parameter> and
-<parameter>y_root</parameter> specify the root window coordinates of the
-mouse pointer; <parameter>suggested_action</parameter> specifies the
-suggested drag action (see the <link
-linkend="method-gdkdragcontext--drag-status"><methodname>drag_status</methodname>()</link>
-method for more detail); possible_actions specifies the possible drag
-actions for the drag (see the <link
-linkend="method-gdkdragcontext--drag-status"><methodname>drag_status</methodname>()</link>
-method for more detail); and, <parameter>time</parameter> specifies the
-timestamp of the drag motion.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--drag-drop">
- <title>gtk.gdk.DragContext.drag_drop</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_drop</methodname>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp of the drag
-drop.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_drop</methodname>() method initiates a drop
-on the current drag destination at the time specified by
-<parameter>time</parameter>. This method is called by the drag
-source.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--drag-abort">
- <title>gtk.gdk.DragContext.drag_abort</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_abort</methodname>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>the time of the drag abort
-operation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_abort</methodname>() method aborts the
-current drag operation at the specified <parameter>time</parameter>. No drop
-operation is initiated. This method is called by the drag source.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--finish">
- <title>gtk.gdk.DragContext.finish</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>finish</methodname>
- <methodparam><parameter
- role="keyword">success</parameter></methodparam>
- <methodparam><parameter
- role="keyword">del_</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
-</methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">success</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the drop was
-completed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">del_</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the drag source
-should delete the source data</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>the time of the drag finish
-operation.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>finish</methodname>() method informs the drag
-source that the drop is finished, and that the data of the drag will no
-longer be required. If <parameter>success</parameter> is
-<literal>True</literal> the drag drop completed successfully; if
-<parameter>del_</parameter> is <literal>True</literal> the source data
-should be deleted; <parameter>time</parameter> is the timestamp of the
-finish operation. This method is called by the drag destination.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--get-source-widget">
- <title>gtk.gdk.DragContext.get_source_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_source_widget</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the source <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> if the
-drag is within the same application or <literal>None</literal>
-otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_source_widget</methodname>() method returns
-the source <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> if the
-drag is within the application; otherwise <literal>None</literal> is
-returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--set-icon-widget">
- <title>gtk.gdk.DragContext.set_icon_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_widget</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a toplevel window to use as an
-icon.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">hot_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X offset within
-<parameter>widget</parameter> of the hotspot.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">hot_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y offset within
-<parameter>widget</parameter> of the hotspot.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_icon_widget</methodname>() method changes
-the icon for a drag source to the specified <parameter>widget</parameter>
-with its hot spot at the offset specified by <parameter>hot_x</parameter>
-and <parameter>hot_y</parameter>. <literal>PyGTK</literal> will not destroy
-the icon, so if you don't want it to persist, you should connect to the
-"drag_end" signal and destroy it yourself.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--set-icon-pixmap">
- <title>gtk.gdk.DragContext.set_icon_pixmap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_pixmap</methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
- <listitem><simpara>the colormap of the icon</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixmap</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> image
-data for the icon</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">mask</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-transparency mask for the icon</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">hot_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X offset within
-<parameter>pixmap</parameter> of the hotspot.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">hot_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y offset within
-<parameter>pixmap</parameter> of the hotspot.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_icon_pixmap</methodname>() method sets
-<parameter>pixmap</parameter> as the icon for the drag.
-<parameter>mask</parameter> is a bitmap mask for
-<parameter>pixmap</parameter> and <parameter>hot_x</parameter> and
-<parameter>hot_y</parameter> specify the offset of the hot spot in
-<parameter>pixmap</parameter>. In general, <link
-linkend="method-gdkdragcontext--set-icon-pixbuf"><function>gtk.gdk.DragContext.set_icon_pixbuf()</function></link>
-will be more convenient to use.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--set-icon-pixbuf">
- <title>gtk.gdk.DragContext.set_icon_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_pixbuf</methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> to
-use as the drag icon.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">hot_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X offset within
-<parameter>pixbuf</parameter> of the hotspot.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">hot_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y offset within
-<parameter>pixbuf</parameter> of the hotspot.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_icon_pixbuf</methodname>() method sets
-<parameter>pixbuf</parameter> as the icon for the drag.
-<parameter>hot_x</parameter> and <parameter>hot_y</parameter> specify the
-offset of the hot spot within <parameter>pixbuf</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--set-icon-stock">
- <title>gtk.gdk.DragContext.set_icon_stock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_stock</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>the ID of the stock icon to use for the
-drag.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">hot_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X offset within the icon of the
-hotspot.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">hot_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y offset within the icon of the
-hotspot.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_icon_stock</methodname>() method sets the
-the icon for a given drag from a stock ID specified by
-<parameter>stock_id</parameter>. <parameter>hot_x</parameter> and
-<parameter>hot_y</parameter> specify the offset of the hot spot within the
-stock icon.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--set-icon-name">
- <title>gtk.gdk.DragContext.set_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_name</methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">hot_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the icon to use for the
-drag.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">hot_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X offset within the icon of the
-hotspot.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">hot_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y offset within the icon of the
-hotspot.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_icon_name</methodname>() method sets the the
-icon for a given drag from the named themed icon specified by
-<parameter>icon_name</parameter>. <parameter>hot_x</parameter> and
-<parameter>hot_y</parameter> specify the offset of the hot spot within the
-stock icon. See the docs for <link
-linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link> for
-more information. Note that the size of the icon depends on the icon theme
-(the icon is loaded at the symbolic size
-<literal>gtk.ICON_SIZE_DND</literal>), thus <parameter>hot_x</parameter> and
-<parameter>hot_y</parameter> have to be used with care.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--set-icon-default">
- <title>gtk.gdk.DragContext.set_icon_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_default</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>set_icon_default</methodname>() method sets the
-icon for the drag to the default icon.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdragcontext--drag-drop-succeeded">
- <title>gtk.gdk.DragContext.drag_drop_succeeded</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_drop_succeeded</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the drop was
-successful.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_drop_succeeded</methodname>() method
-returns <literal>True</literal> if the dropped data has been successfully
-transferred. This method is intended to be used while handling a
-<literal>gtk.gdk.DROP_FINISHED</literal> event, its return value is
-meaningless at other times.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkdrawable.xml b/docs/reference/pygtk-gdkdrawable.xml
deleted file mode 100644
index 4b57871b..00000000
--- a/docs/reference/pygtk-gdkdrawable.xml
+++ /dev/null
@@ -1,2171 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkdrawable">
- <refnamediv>
- <refname>gtk.gdk.Drawable</refname>
- <refpurpose>a base class for drawing methods</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Drawable</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--get-size">get_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--set-colormap">set_colormap</link></methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--get-colormap">get_colormap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--get-visual">get_visual</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--get-depth">get_depth</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdrawable--get-screen">get_screen</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdrawable--get-display">get_display</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-point">draw_point</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-line">draw_line</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x1</parameter></methodparam>
- <methodparam><parameter role="keyword">y1</parameter></methodparam>
- <methodparam><parameter role="keyword">x2</parameter></methodparam>
- <methodparam><parameter role="keyword">y2</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-rectangle">draw_rectangle</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">filled</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-arc">draw_arc</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">filled</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">angle1</parameter></methodparam>
- <methodparam><parameter
- role="keyword">angle2</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-polygon">draw_polygon</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">filled</parameter></methodparam>
- <methodparam><parameter
- role="keyword">points</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-drawable">draw_drawable</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">src</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xsrc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ysrc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xdest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ydest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-image">draw_image</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">image</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xsrc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ysrc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xdest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ydest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-points">draw_points</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">points</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-segments">draw_segments</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">segs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-lines">draw_lines</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">points</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdrawable--draw-pixbuf">draw_pixbuf</link></methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter
- role="keyword">dither</parameter><initializer>gtk.gdk.RGB_DITHER_NORMAL</initializer></methodparam>
- <methodparam><parameter
- role="keyword">x_dither</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">y_dither</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-glyphs">draw_glyphs</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">glyphs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdrawable--draw-layout-line">draw_layout_line</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">line</parameter></methodparam>
- <methodparam><parameter
- role="keyword">layout</parameter></methodparam>
- <methodparam><parameter role="keyword">foreground</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">background</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-layout">draw_layout</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">layout</parameter></methodparam>
- <methodparam><parameter role="keyword">foreground</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">background</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--get-image">get_image</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--get-clip-region">get_clip_region</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--get-visible-region">get_visible_region</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--new-gc">new_gc</link></methodname>
- <methodparam><parameter
- role="keyword">foreground</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- <methodparam><parameter
- role="keyword">function</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tile</parameter></methodparam>
- <methodparam><parameter
- role="keyword">stipple</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">subwindow_mode</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">graphics_exposures</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cap_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">join_style</parameter>></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-rgb-image">draw_rgb_image</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dith</parameter></methodparam>
- <methodparam><parameter
- role="keyword">rgb_buf</parameter></methodparam>
- <methodparam><parameter role="keyword">rowstride</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">xdith</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">ydith</parameter>
- <initializer>0</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-rgb-32-image">draw_rgb_32_image</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dith</parameter></methodparam>
- <methodparam><parameter
- role="keyword">rgb_buf</parameter></methodparam>
- <methodparam><parameter role="keyword">rowstride</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">xdith</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">ydith</parameter>
- <initializer>0</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--draw-gray-image">draw_gray_image</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dith</parameter></methodparam>
- <methodparam><parameter role="keyword">buf</parameter></methodparam>
- <methodparam><parameter role="keyword">rowstride</parameter>
- <initializer>-1</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkdrawable--draw-indexed-image">draw_indexed_image</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">dith</parameter></methodparam>
- <methodparam><parameter role="keyword">buf</parameter></methodparam>
- <methodparam><parameter role="keyword">rowstride</parameter></methodparam>
- <methodparam><parameter role="keyword">cmap</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkdrawable--cairo-create">cairo_create</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkdrawable">gtk.gdk.Drawable</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"handle"</entry>
- <entry>Read</entry>
- <entry>The handle of the MS Windows window associated with
-the drawable. Not supported on X11.</entry>
- </row>
-
- <row valign="top">
- <entry>"xid"</entry>
- <entry>Read</entry>
- <entry>The id of the X window available with the
-drawable. Not supported on MS Windows</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-is a base class providing drawing primitives for its subclasses: <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> and
-<link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</para>
-
- <para>These methods provide support for drawing points, lines, arcs and
-text onto what are called 'drawables'. Drawables, as the name suggests, are
-things which support drawing onto them, and are either <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> or
-<link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-objects.</para>
-
- <para>Many of the drawing operations take a <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> argument,
-which represents a graphics context. This <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> contains a
-number of drawing attributes such as foreground color, background color and
-line width, and is used to reduce the number of arguments needed for each
-drawing operation. See the <link linkend="class-gdkgc"><classname>Graphics
-Contexts</classname></link> section for more information.</para>
-
- <para>Some of the drawing operations take Pango objects like <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link> or
-<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-as arguments. Use the <link
-linkend="method-gtkwidget--create-pango-context"><methodname>gtk.Widget.create_pango_context</methodname>()</link>
-or <link
-linkend="method-gtkwidget--create-pango-layout"><methodname>gtk.Widget.create_pango_layout</methodname>()</link>
-methods to obtain these objects.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkdrawable--get-size">
- <title>gtk.gdk.Drawable.get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the drawable's width and
-height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_size</methodname>() method returns a tuple
-containing the width and height of the drawable.</para>
-
- <para>On the X11 platform, if the drawable is a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>, the
-returned size is the size reported in the most-recently-processed configure
-event, rather than the current size on the X server.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--set-colormap">
- <title>gtk.gdk.Drawable.set_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_colormap</methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_colormap</methodname>() method sets the
-<link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-associated with the drawable to the value specified by
-<parameter>colormap</parameter>. Normally this will happen automatically
-when the drawable is created; you only need to use this function if the
-drawable-creating function did not have a way to determine the colormap, and
-you then use drawable operations that require a colormap. The colormap for
-all drawables and graphics contexts you intend to use together should match.
-i.e. when using a <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> to draw to a
-drawable, or copying one drawable to another, the colormaps should
-match.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--get-colormap">
- <title>gtk.gdk.Drawable.get_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_colormap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the colormap, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_colormap</methodname>() method returns the
-<link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-for the drawable or <literal>None</literal> if no colormap is set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--get-visual">
- <title>gtk.gdk.Drawable.get_visual</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visual</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visual</methodname>() method returns the
-<link linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
-describing the pixel format of the drawable.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--get-depth">
- <title>gtk.gdk.Drawable.get_depth</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_depth</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of bits per
-pixel</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_depth</methodname>() method returns the bit
-depth of the drawable, that is, the number of bits that make up a pixel in
-the drawable's visual. Examples are 8 bits per pixel, 24 bits per pixel,
-etc.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--get-screen">
- <title>gtk.gdk.Drawable.get_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_screen</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
- associated with the drawable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_screen</methodname>() method returns the
-<link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-associated with the drawable.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gdkdrawable--get-display">
- <title>gtk.gdk.Drawable.get_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_display</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
- associated with the drawable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_display</methodname>() method returns the
-<link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-associated with the drawable.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-point">
- <title>gtk.gdk.Drawable.draw_point</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_point</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the point in drawable
-coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the point in drawable
-coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_point</methodname>() method draws a point
-at the location specified by <parameter>x</parameter> and
-<parameter>y</parameter> in the drawable using the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> graphics
-context specified by <parameter>gc</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-line">
- <title>gtk.gdk.Drawable.draw_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_line</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x1</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y1</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x2</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y2</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x1</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the first
-point</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y1</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the first
-point</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x2</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the second
-point</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y2</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the second
-point</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_line</methodname>() method draws a line
-between the two points specified by (<parameter>x1</parameter>,
-<parameter>y1</parameter>) and (<parameter>x2</parameter>,
-<parameter>y2</parameter>) using the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> graphics
-context specified by <parameter>gc</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-rectangle">
- <title>gtk.gdk.Drawable.draw_rectangle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_rectangle</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">filled</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">filled</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the rectangle will
-be filled with the foreground color</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the top left
-corner</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the top left
-corner</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the
-rectangle</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_rectangle</methodname>() method draws a
-rectangle of the specified <parameter>width</parameter> and
-<parameter>height</parameter> with its top left corner at the location
-specified by (<parameter>x</parameter>, <parameter>y</parameter>) using the
-<link linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>
-graphics context specified by <parameter>gc</parameter>. If
-<parameter>filled</parameter> is <literal>True</literal> the rectangle will
-be filled with the foreground color.</para>
-
- <note>
- <para>A rectangle drawn filled is 1 pixel smaller in both dimensions
-than a rectangle outlined. Calling:</para>
-
- <programlisting>
- window.draw_rectangle(gc, True, 0, 0, 20, 20)
-</programlisting>
-
- <para>results in a filled rectangle 20 pixels wide and 20 pixels
-high. Calling:</para>
-
- <programlisting>
- window.draw_rectangle(gc, False, 0, 0, 20, 20)
- </programlisting>
-
- <para>results in an outlined rectangle with corners at (0, 0), (0,
-20), (20, 20), and (20, 0), which makes it 21 pixels wide and 21 pixels
-high.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-arc">
- <title>gtk.gdk.Drawable.draw_arc</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_arc</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">filled</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">angle1</parameter></methodparam>
- <methodparam><parameter
- role="keyword">angle2</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">filled</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the arc will be
-filled with the foreground color creating a "pie slice"</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the left edge of the
-bounding rectangle.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the top edge of the
-bounding rectangle. </simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the bounding
-rectangle.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the bounding
-rectangle.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">angle1</parameter>&nbsp;:</term>
- <listitem><simpara>the start angle of the arc, relative to the 3
-o'clock position, counter-clockwise, in 1/64ths of a
-degree.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">angle2</parameter>&nbsp;:</term>
- <listitem><simpara>the end angle of the arc, relative to angle1,
-counter-clockwise, in 1/64ths of a degree.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_arc</methodname>() method draws an arc or a
-filled 'pie slice' if <parameter>filled</parameter> is
-<literal>True</literal>. The arc is defined by the bounding rectangle of the
-entire ellipse (specified by <parameter>x</parameter>,
-<parameter>y</parameter>, <parameter>width</parameter> and
-<parameter>height</parameter>), and the start and end angles of the part of
-the ellipse to be drawn (specified by <parameter>angle1</parameter> and
-<parameter>angle2</parameter>). The <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> graphics
-context specified by <parameter>gc</parameter> is used to determine the
-drawing attributes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-polygon">
- <title>gtk.gdk.Drawable.draw_polygon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_polygon</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">filled</parameter></methodparam>
- <methodparam><parameter
- role="keyword">points</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">filled</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the polygon will be
-filled with the foreground color</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">points</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of 2-tuples</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_polygon</methodname>() method draws an
-outlined or filled polygon using the points specified by
-<parameter>points</parameter>. <parameter>points</parameter> is a sequence
-of 2-tuples that each contain an x and y coordinate of a point. The points
-are connected in the order that they are specified and the last point is
-automatically connected to the first point. The <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> graphics
-context specified by <parameter>gc</parameter> is used to determine the
-drawing attributes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-drawable">
- <title>gtk.gdk.Drawable.draw_drawable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_drawable</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xsrc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ysrc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xdest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ydest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> sharing the
-drawable's visual and colormap</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xsrc</parameter>&nbsp;:</term>
- <listitem><simpara>the X position in <parameter>src</parameter> of
-rectangle to draw</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ysrc</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position in <parameter>src</parameter> of
-rectangle to draw</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xdest</parameter>&nbsp;:</term>
- <listitem><simpara>the X position in the drawable where the
-rectangle should be drawn</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ydest</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position in the drawable where the
-rectangle should be drawn</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of rectangle to draw, or -1 for
-entire <parameter>src</parameter> width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of rectangle to draw, or -1 for
-entire <parameter>src</parameter> height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The draw_drawable() method copies the specified
-<parameter>width</parameter> x <parameter>height</parameter> area of the
-drawable specified by <parameter>src</parameter> at the specified
-coordinates (<parameter>xsrc</parameter>, <parameter>ysrc</parameter>) to
-the specified coordinates (<parameter>xdest</parameter>,
-<parameter>ydest</parameter>) in the drawable. <parameter>width</parameter>
-and <parameter>height</parameter> may be given as -1, to copy the entire
-<parameter>src</parameter> drawable. Most fields in the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> specified by
-<parameter>gc</parameter> are not used for this operation, but the clip mask
-or clip region will be honored.</para>
-
- <para>The source and destination drawables must have the same visual
-and colormap, or errors will result. (On X11, failure to match visual and
-colormap results in a <literal>BadMatch</literal> error from the X server.)
-A common cause of this problem is an attempt to draw a bitmap to a color
-drawable. The way to draw a bitmap is to set the bitmap as a clip mask on
-your <link linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>,
-then use the <link
-linkend="method-gdkdrawable--draw-rectangle"><methodname>draw_rectangle</methodname>()</link>
-method to draw a rectangle clipped to the bitmap.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-image">
- <title>gtk.gdk.Drawable.draw_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_image</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">image</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xsrc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ysrc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xdest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ydest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">image</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xsrc</parameter>&nbsp;:</term>
- <listitem><simpara>the left edge of the source rectangle within
-<parameter>image</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ysrc</parameter>&nbsp;:</term>
- <listitem><simpara>the top edge of the source rectangle within
-<parameter>image</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xdest</parameter>&nbsp;:</term>
- <listitem><simpara>the left edge of the destination within
-drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ydest</parameter>&nbsp;:</term>
- <listitem><simpara>the top edge of the destination within
-drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the area to be copied, or -1 to
-make the area extend to the right edge of
-<parameter>image</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the area to be copied, or -1 to
-make the area extend to the bottom edge of
-<parameter>image</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_image</methodname>() method draws the
-portion of the <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
-specified by the rectangle (<parameter>xsrc</parameter>,
-<parameter>ysrc</parameter>, <parameter>width</parameter> and
-<parameter>height</parameter>) onto the drawable at the location specified
-by <parameter>xdest</parameter> and <parameter>ydest</parameter>. The depth
-of the <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> must
-match the depth of the <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>.
-The <link linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>
-graphics context specified by <parameter>gc</parameter> is used to determine
-the drawing attributes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-points">
- <title>gtk.gdk.Drawable.draw_points</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_points</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">points</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">points</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of 2-tuples</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_points</methodname>() method draws the set
-of points specified by <parameter>points</parameter> on the drawable using
-the <link linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>
-graphics context specified by <parameter>gc</parameter>.
-<parameter>points</parameter> is a sequence of 2-tuples each containing a
-pair of x and y coordinates of a point location in the drawable.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-segments">
- <title>gtk.gdk.Drawable.draw_segments</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_segments</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">segs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">segs</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of 4-tuples</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_segments</methodname>() method draws a set
-of line segments specified by <parameter>segs</parameter> on the drawable
-using the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> graphics
-context specified by <parameter>gc</parameter> to specify the drawing
-attributes. <parameter>segs</parameter> is a sequence of 4-tuples each
-containing the coordinates of the start and end points of the line segment
-in the format (x1, y1, x2, y2).</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-lines">
- <title>gtk.gdk.Drawable.draw_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_lines</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">points</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">points</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of 2-tuples</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_lines</methodname>() method draws a series
-of lines connecting the points specified by <parameter>points</parameter>.
-<parameter>points</parameter> is a sequence of 2-tuples each containing the
-x and y coordinates of a point location. The <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> graphics
-context specified by <parameter>gc</parameter> is used to determine the
-drawing attributes.The style of joins between lines is determined by the cap
-style attribute in the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>. This can be
-set with the <link
-linkend="method-gdkgc--set-line-attributes"><methodname>gtk.gdk.GC.set_line_attributes</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-pixbuf">
- <title>gtk.gdk.Drawable.draw_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_pixbuf</methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- <methodparam><parameter role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">height</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">dither</parameter><initializer>gtk.gdk.RGB_DITHER_NORMAL</initializer></methodparam>
- <methodparam><parameter role="keyword">x_dither</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">y_dither</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>,
- used for clipping, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_x</parameter>&nbsp;:</term>
- <listitem><simpara>Source X coordinate within
- pixbuf.</simpara></listitem> </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_y</parameter>&nbsp;:</term>
- <listitem><simpara>Source Y coordinate within
- pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_x</parameter>&nbsp;:</term>
- <listitem><simpara>Destination X coordinate within
- drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_y</parameter>&nbsp;:</term>
- <listitem><simpara>Destination Y coordinate within
- drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>Width of region to render, in pixels, or -1 to
- use pixbuf width. Must be specified in PyGTK
- 2.2.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>Height of region to render, in pixels, or -1 to
- use pixbuf height. Must be specified in PyGTK
- 2.2</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dither</parameter>&nbsp;:</term>
- <listitem><simpara>Dithering mode for
- <literal>GdkRGB</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x_dither</parameter>&nbsp;:</term>
- <listitem><simpara>X offset for dither.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y_dither</parameter>&nbsp;:</term>
- <listitem><simpara>Y offset for dither.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>draw_pixbuf</methodname>() method renders a
-rectangular portion of a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-specified by <parameter>pixbuf</parameter> to the drawable using the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> specified by
-<parameter>gc</parameter>. The portion of <parameter>pixbuf</parameter> that
-is rendered is specified by the origin point (<parameter>src_x</parameter>
-<parameter>src_y</parameter>) and the <parameter>width</parameter> and
-<parameter>height</parameter> arguments. <parameter>pixbuf</parameter> is
-rendered to the location in the drawable specified by
-(<parameter>dest_x</parameter>
-<parameter>dest_y</parameter>). <parameter>dither</parameter> specifies the
-dithering mode as one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.RGB_DITHER_NONE</literal></term>
- <listitem>
- <simpara>Never use dithering.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RGB_DITHER_NORMAL</literal></term>
- <listitem>
- <simpara>Use dithering in 8 bits per pixel (and below)
- only.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.RGB_DITHER_MAX</literal></term>
- <listitem>
- <simpara>Use dithering in 16 bits per pixel and below.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The destination drawable must have a colormap. All windows have a
-colormap, however, pixmaps only have colormap by default if they were
-created with a non-<literal>None</literal> window argument. Otherwise a
-colormap must be set on them with the <link
-linkend="method-gdkdrawable--set-colormap"><methodname>gtk.gdk.Drawable.set_colormap()</methodname></link>
-method.</para>
-
- <para>On older X servers, rendering pixbufs with an alpha channel
-involves round trips to the X server, and may be somewhat slow. The clip
-mask of <parameter>gc</parameter> is ignored, but clip rectangles and clip
-regions work fine.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-glyphs">
- <title>gtk.gdk.Drawable.draw_glyphs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_glyphs</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">glyphs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">font</parameter>&nbsp;:</term>
- <listitem><simpara>the font to be used</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of baseline
-origin</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of baseline
-origin</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">glyphs</parameter>&nbsp;:</term>
- <listitem><simpara>the glyphs to render</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_glyphs</methodname>() method draws the
-sequence of glyphs (characters in a font) specified by
-<parameter>glyphs</parameter> at the location specified by
-<parameter>x</parameter> and <parameter>y</parameter> using the font
-specified by <parameter>font</parameter>. Instead of using this method 99%
-of text rendering should be done using the <link
-linkend="method-gdkdrawable--draw-layout"><methodname>draw_layout</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-layout-line">
- <title>gtk.gdk.Drawable.draw_layout_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_layout_line</methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">line</parameter></methodparam>
- <methodparam><parameter role="keyword">foreground</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">background</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>base graphics to use</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x position of start of string (in pixels)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y position of baseline (in pixels)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">line</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">foreground</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
- to override the foreground color or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">background</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
- to override the background color or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <parameter>draw_layout_line</parameter>() method renders the
- <link
- linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>
- specified by <parameter>line</parameter> onto the drawable at the
- position specified by (<parameter>x</parameter>,
- <parameter>y</parameter>). The <link
- linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>
- specified by <parameter>gc</parameter> is used as the graphics context
- but the layout's normal colors may be overriden with the <link
- linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>s
- specified by <parameter>foreground</parameter> and/or
- <parameter>background</parameter>. <parameter>foreground</parameter>
- and <parameter>background</parameter> are optional and default to
- <literal>None</literal>.</para>
-
- <para>If the layout's <link
- linkend="class-pangocontext"><classname>pango.Context</classname></link>
- has a transformation matrix set, then <parameter>x</parameter> and
- <parameter>y</parameter> specify the position of the left edge of the
- baseline (left is in before-tranform user coordinates) in
- after-transform device coordinates.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-layout">
- <title>gtk.gdk.Drawable.draw_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_layout</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">layout</parameter></methodparam>
- <methodparam><parameter role="keyword">foreground</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">background</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>base graphics context to
-use</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position of the left of the layout (in
-pixels)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position of the top of the layout (in
-pixels)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">layout</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">foreground</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to
-override the foreground color or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">background</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to
-override the background color or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_layout</methodname>() method renders the
-<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-specified by <parameter>layout</parameter> onto the drawable at the location
-specified by <parameter>x</parameter> and <parameter>y</parameter>. If
-<parameter>foreground</parameter> or <parameter>background</parameter> has a
-value other than <literal>None</literal> it is used to override the
-corresponding attribute specified by <parameter>gc</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--get-image">
- <title>gtk.gdk.Drawable.get_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_image</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate on the
-drawable</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate on the
-drawable</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of region to get</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height or region to
-get</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
-containing the contents of the drawable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_image</methodname>() method returns a <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
-object containing a copy of the region in the drawable specified by
-<parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. A <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> stores
-client-side image data (pixels). In contrast, a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> and
-<link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-are server-side objects. The <methodname>get_image</methodname>() method
-retrieves the pixels from a server-side drawable as a client-side <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>. The
-format of a <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> depends
-on the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> of
-the current display, which makes manipulating <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
-extremely difficult; therefore, in most cases you should use the <link
-linkend="method-gdkpixbuf--get-from-drawable"><methodname>gtk.gdk.Pixbuf.get_from_drawable</methodname>()</link>
-method instead of this lower-level function. A <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-contains image data in a canonicalized RGB format, rather than a
-display-dependent format. Of course, there's a convenience vs. speed
-tradeoff here, so you'll want to think about what makes sense for your
-application.</para>
-
- <para>You would usually copy image data to the client side if you
-intend to examine the values of individual pixels, for example to darken an
-image or add a red tint. It would be prohibitively slow to make a round-trip
-request to the windowing system for each pixel, so instead you get all of
-them at once, modify them, then copy them all back at once. If the X server
-or other windowing system backend is on the local machine, this function may
-use shared memory to avoid copying the image data. If the source drawable is
-a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> and
-partially off screen or obscured, then the obscured portions of the returned
-image will contain undefined data.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--get-clip-region">
- <title>gtk.gdk.Drawable.get_clip_region</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_clip_region</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_clip_region</methodname>() method computes
- and returns the <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- of the drawable that potentially can be written to by drawing
- primitives. This region will not take into account the clip region for
- the <link
- linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>, and
- may also not take into account other factors such as if the window is
- obscured by other windows, but no area outside of this region will be
- affected by drawing primitives.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gdkdrawable--get-visible-region">
- <title>gtk.gdk.Drawable.get_visible_region</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_region</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>. This must be freed with <function>gdk_region_destroy()</function>
- when you are done.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_visible_region</methodname>() method
- computes and returns the <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- of the drawable that is potentially visible. This does not
- necessarily take into account if the window is obscured by other
- windows, but no area outside of this region is visible.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--new-gc">
- <title>gtk.gdk.Drawable.new_gc</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>new_gc</methodname>
- <methodparam><parameter
- role="keyword">foreground</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- <methodparam><parameter
- role="keyword">function</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tile</parameter></methodparam>
- <methodparam><parameter
- role="keyword">stipple</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">subwindow_mode</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">graphics_exposures</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cap_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">join_style</parameter>></methodparam>
-</methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">foreground</parameter>&nbsp;:</term>
- <listitem><simpara>the foreground <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">background</parameter>&nbsp;:</term>
- <listitem><simpara>the background <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">font</parameter>&nbsp;:</term>
- <listitem><simpara>a font (deprecated and
-ignored)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">function</parameter>&nbsp;:</term>
- <listitem><simpara>the bitwise operator used to combine the
-existing pixel value and a new pixel value - usually one of:
-<literal>gtk.gdk.COPY</literal>, <literal>gtk.gdk.XOR</literal> or
-<literal>gtk.gdk.INVERT</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
- <listitem><simpara>the fill style - one of:
-<literal>gtk.gdk.SOLID</literal>, <literal>gtk.gdk.TILED</literal>,
-<literal>gtk.gdk.STIPPLED</literal>,
-<literal>gtk.gdk.OPAQUE_STIPPLED</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tile</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> used
-for tiling the background</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">stipple</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> used
-for stippling the background</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">clip_mask</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> of
-depth 1 used to mask pixels to be drawn</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">subwindow_mode</parameter>&nbsp;:</term>
- <listitem><simpara>the mode of drawing on subwindows in a
-<link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> - one of: <literal>gtk.gdk.CLIP_BY_CHILDREN</literal> or
-<literal>gtk.gdk.INCLUDE_INFERIORS</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">ts_x_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the origin of
-<parameter>tile</parameter> or
-<parameter>stipple</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">ts_y_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the origin of
-<parameter>tile</parameter> or
-<parameter>stipple</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">clip_x_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the origin of
-<parameter>clip_mask</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">clip_y_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the origin of
-<parameter>clip_mask</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">graphics_exposures</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> graphics exposures
-are enabled for calls to the <link
-linkend="method-gdkdrawable--draw-drawable"><methodname>draw_drawable</methodname>()</link>
-method.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">line_width</parameter>&nbsp;:</term>
- <listitem><simpara>the line width in pixels</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">line_style</parameter>&nbsp;:</term>
- <listitem><simpara>the line style - one of:
-<literal>gtk.gdk.LINE_SOLID</literal>,
-<literal>gtk.gdk.LINE_ON_OFF_DASH</literal>,
-<literal>gtk.gdk.LINE_DOUBLE_DASH</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">cap_style</parameter>&nbsp;:</term>
- <listitem><simpara>the style of line ends - one of:
-<literal>gtk.gdk.CAP_NOT_LAST</literal>,
-<literal>gtk.gdk.CAP_BUTT</literal>, <literal>gtk.gdk.CAP_ROUND</literal>,
-<literal>gtk.gdk.CAP_PROJECTING</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">join_style</parameter>&nbsp;:</term>
- <listitem><simpara>the style of line joins - one of:
-<literal>gtk.gdk.JOIN_MITER</literal>,
-<literal>gtk.gdk.JOIN_ROUND</literal>,
-<literal>gtk.gdk.JOIN_BEVEL</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>new_gc</methodname>() method creates a new <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> object with
-the attributes as specified by the arguments. Since there are a large number
-of parameters it's probably best to specify the attributes using keywords.
-Any attributes not specified will use a default value.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-rgb-image">
- <title>gtk.gdk.Drawable.draw_rgb_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_rgb_image_dithalign</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dith</parameter></methodparam>
- <methodparam><parameter
- role="keyword">rgb_buf</parameter></methodparam>
- <methodparam><parameter role="keyword">rowstride</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">xdith</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">ydith</parameter>
- <initializer>0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the top-left corner in the
-drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the top-left corner in the
-drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the image to be
-drawn.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the image to be
-drawn.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dith</parameter>&nbsp;:</term>
- <listitem><simpara>a dither value - one of:
-<literal>gtk.gdk.RGB_DITHER_NONE</literal>,
-<literal>gtk.gdk.RGB_DITHER_NORMAL</literal>,
-<literal>gtk.gdk.RGB_DITHER_MAX</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">rgb_buf</parameter>&nbsp;:</term>
- <listitem><simpara>the pixel data, represented as packed 24-bit
-data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">rowstride</parameter>&nbsp;:</term>
- <listitem><simpara>the number of bytes from the start of one row
-in <parameter>rgb_buf</parameter> to the start of the next or -1 to
-calculate the number of bytes.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xdith</parameter>&nbsp;:</term>
- <listitem><simpara>an X offset for dither
-alignment.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ydith</parameter>&nbsp;:</term>
- <listitem><simpara>a Y offset for dither
-alignment.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_rgb_image</methodname>() method draws an
-RGB image in the drawable, with an adjustment for dither alignment. This
-method is useful when drawing dithered images into a window that may be
-scrolled. Pixel (x, y) will be drawn dithered as if its actual location is
-(x + xdith, y + ydith). Thus, if you draw an image into a window using zero
-dither alignment, then scroll up one pixel, subsequent draws to the window
-should have ydith = 1. Setting the dither alignment correctly allows
-updating of small parts of the screen while avoiding visible "seams" between
-the different dither textures.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-rgb-32-image">
- <title>gtk.gdk.Drawable.draw_rgb_32_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_rgb_32_image</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dith</parameter></methodparam>
- <methodparam><parameter
- role="keyword">rgb_buf</parameter></methodparam>
- <methodparam><parameter role="keyword">rowstride</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">xdith</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">ydith</parameter>
- <initializer>0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the top-left corner in the
-drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the top-left corner in the
-drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the image to be
-drawn.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the image to be
-drawn.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dith</parameter>&nbsp;:</term>
- <listitem><simpara>a dither value - one of:
-<literal>gtk.gdk.RGB_DITHER_NONE</literal>,
-<literal>gtk.gdk.RGB_DITHER_NORMAL</literal>,
-<literal>gtk.gdk.RGB_DITHER_MAX</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">buf</parameter>&nbsp;:</term>
- <listitem><simpara>the pixel data, represented as padded 32-bit
-data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">rowstride</parameter>&nbsp;:</term>
- <listitem><simpara>the number of bytes from the start of one row
-in <parameter>buf</parameter> to the start of the next or -1 to calculate
-the number of bytes.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xdith</parameter>&nbsp;:</term>
- <listitem><simpara>an X offset for dither
-alignment.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ydith</parameter>&nbsp;:</term>
- <listitem><simpara>a Y offset for dither
-alignment.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_rgb_32_image</methodname>() method draws a
-padded RGB image in the drawable. The image is stored as one pixel per
-32-bit word. It is laid out as a red byte, a green byte, a blue byte, and a
-padding byte. Otherwise this method works the same as the <link
-linkend="method-gdkdrawable--draw-rgb-image"><methodname>draw_rgb_image</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-gray-image">
- <title>gtk.gdk.Drawable.draw_gray_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_gray_image</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dith</parameter></methodparam>
- <methodparam><parameter
- role="keyword">buf</parameter></methodparam>
- <methodparam><parameter role="keyword">rowstride</parameter>
- <initializer>-1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the top-left corner in the
-drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the top-left corner in the
-drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the image to be
-drawn.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the image to be
-drawn.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dith</parameter>&nbsp;:</term>
- <listitem><simpara>a dither value - one of:
-<literal>gtk.gdk.RGB_DITHER_NONE</literal>,
-<literal>gtk.gdk.RGB_DITHER_NORMAL</literal>,
-<literal>gtk.gdk.RGB_DITHER_MAX</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">buf</parameter>&nbsp;:</term>
- <listitem><simpara>the pixel data, represented as 8-bit gray
-values.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">rowstride</parameter>&nbsp;:</term>
- <listitem><simpara>the number of bytes from the start of one row
-in <parameter>buf</parameter> to the start of the next or -1 to calculate
-the number of bytes.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>draw_gray_image</methodname>() method draws a
-grayscale image on the drawable at the location specified by
-<parameter>x</parameter> and <parameter>y</parameter> with the image data in
-<parameter>buf</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--draw-indexed-image">
- <title>gtk.gdk.Drawable.draw_indexed_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_indexed_image</methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">dith</parameter></methodparam>
- <methodparam><parameter role="keyword">buf</parameter></methodparam>
- <methodparam><parameter role="keyword">rowstride</parameter></methodparam>
- <methodparam><parameter role="keyword">colors</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a graphics context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>The x coordinate of the top-left corner in the
- drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y coordinate of the top-left corner in the
- drawable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the rectangle to be
- drawn.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the rectangle to be
- drawn.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dith</parameter>&nbsp;:</term>
- <listitem><simpara>a GdkRgbDither value, selecting the desired
- dither mode.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">buf</parameter>&nbsp;:</term>
- <listitem><simpara>the pixel data, represented as 8-bit color
- indices.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">rowstride</parameter>&nbsp;:</term>
- <listitem><simpara>the number of bytes from the start of one row in
- <parameter>buf</parameter> to the start of the
- next.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">colors</parameter>&nbsp;:</term>
- <listitem><simpara>a list of colors represented as 0xRRGGBB integer
- values.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>draw_indexed_image</methodname>() method draws an
- indexed image in the drawable, using the list of colors specified
- by <parameter>colors</parameter> to assign actual colors to the image's
- color indices.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkdrawable--cairo-create">
- <title>gtk.gdk.Drawable.cairo_create</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>cairo_create</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkcairocontext"><classname>gtk.gdk.CairoContext</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>cairo_create</methodname>() method returns a
- <link
- linkend="class-gdkcairocontext"><classname>gtk.gdk.CairoContext</classname></link>
- object to be used for drawing on the drawable using Cairo drawing
- operations.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkevent.xml b/docs/reference/pygtk-gdkevent.xml
deleted file mode 100644
index ff36df22..00000000
--- a/docs/reference/pygtk-gdkevent.xml
+++ /dev/null
@@ -1,2454 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkevent">
- <refnamediv>
- <refname>gtk.gdk.Event</refname>
- <refpurpose>an object representing an event from the windowing
-system</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Event</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gdkevent">gtk.gdk.Event</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkevent--put">put</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkevent--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkevent--free">free</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkevent--get-time">get_time</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkevent--get-state">get_state</link></methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkevent--get-coords">get_coords</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkevent--get-root-coords">get_root_coords</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkevent--get-axis">get_axis</link></methodname>
- <methodparam><parameter>axis_use</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkevent--set-screen">set_screen</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkevent--get-screen">get_screen</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--events-pending">gtk.gdk.events_pending</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--event-peek">gtk.gdk.event_peek</link></methodname>
- <methodparam><parameter></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--event-get">gtk.gdk.event_get</link></methodname>
- <methodparam><parameter></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--event-get-graphics-expose">gtk.gdk.event_get_graphics_expose</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--set-show-events">gtk.gdk.set_show_events</link></methodname>
- <methodparam><parameter
- role="keyword">show_events</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--get-show-events">gtk.gdk.get_show_events</link></methodname>
- <methodparam><parameter></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--event-handler-set">gtk.gdk.event_handler_set</link></methodname>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <para>The attributes available for a <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> are
-dependent on the type of the event. The event types are described in the
-<link linkend="description-gdkevent">Description</link> section.</para>
-
- <refsect2>
- <title><literal>gtk.gdk.NOTHING</literal></title>
- <title><literal>gtk.gdk.DELETE</literal></title>
- <title><literal>gtk.gdk.DESTROY</literal></title>
- <title><literal>gtk.gdk.MAP</literal></title>
- <title><literal>gtk.gdk.UNMAP</literal></title>
- <title><literal>gtk.gdk.NO_EXPOSE</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Contain only the fields that are common to all event
- types.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.EXPOSE</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"area"</entry>
- <entry>Read/Write</entry>
- <entry>The bounding box of the area to be redrawn</entry>
- </row>
-
- <row valign="top">
- <entry>"count"</entry>
- <entry>Read/Write</entry>
- <entry>The number of contiguous gtk.gdk.EXPOSE events
-following this one. The only use for this is "exposure compression", i.e.
-handling all contiguous gtk.gdk.EXPOSE events in one go, though
-<literal>PyGTK</literal> performs some exposure compression so this is not
-normally needed.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated when all or part of a window becomes visible and needs
- to be redrawn.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.MOTION_NOTIFY</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"time"</entry>
- <entry>Read/Write</entry>
- <entry>The time of the event in milliseconds.</entry>
- </row>
-
- <row valign="top">
- <entry>"x"</entry>
- <entry>Read/Write</entry>
- <entry>The x coordinate of the pointer relative to the
-window.</entry>
- </row>
-
- <row valign="top">
- <entry>"y"</entry>
- <entry>Read/Write</entry>
- <entry>The y coordinate of the pointer relative to the
-window.</entry>
- </row>
-
- <row valign="top">
- <entry>"axes"</entry>
- <entry>Read</entry>
- <entry><parameter>x</parameter>, <parameter>y</parameter>
-translated to the axes of <parameter>device</parameter>, or
-<literal>None</literal> if <parameter>device</parameter> is the
-mouse.</entry>
- </row>
-
- <row valign="top">
- <entry>"state"</entry>
- <entry>Read/Write</entry>
- <entry>A bit-mask representing the state of the modifier
-keys (e.g. <keycap>Control</keycap>, <keycap>Shift</keycap> and
-<keycap>Alt</keycap>) and the pointer buttons.</entry>
- </row>
-
- <row valign="top">
- <entry>"is_hint"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the
-<literal>gdk.POINTER_MOTION_HINT_MASK</literal> is set.</entry>
- </row>
-
- <row valign="top">
- <entry>"device"</entry>
- <entry>Read</entry>
- <entry>The device where the event originated.</entry>
- </row>
-
- <row valign="top">
- <entry>"x_root"</entry>
- <entry>Read/Write</entry>
- <entry>The x coordinate of the pointer relative to the root
-of the screen.</entry>
- </row>
-
- <row valign="top">
- <entry>"y_root"</entry>
- <entry>Read/Write</entry>
- <entry>The y coordinate of the pointer relative to the root
-of the screen.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated when the pointer moves.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.BUTTON_PRESS</literal></title>
- <title><literal>gtk.gdk._2BUTTON_PRESS</literal></title>
- <title><literal>gtk.gdk._3BUTTON_PRESS</literal></title>
- <title><literal>gtk.gdk.BUTTON_RELEASE</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"time"</entry>
- <entry>Read/Write</entry>
- <entry>The time of the event in milliseconds.</entry>
- </row>
-
- <row valign="top">
- <entry>"x"</entry>
- <entry>Read/Write</entry>
- <entry>The x coordinate of the pointer relative to the
-window.</entry>
- </row>
-
- <row valign="top">
- <entry>"y"</entry>
- <entry>Read/Write</entry>
- <entry>The y coordinate of the pointer relative to the
-window.</entry>
- </row>
-
- <row valign="top">
- <entry>"axes"</entry>
- <entry>Read</entry>
- <entry><parameter>x</parameter>, <parameter>y</parameter>
-translated to the axes of <parameter>device</parameter>, or
-<literal>None</literal> if <parameter>device</parameter> is the
-mouse.</entry>
- </row>
-
- <row valign="top">
- <entry>"state"</entry>
- <entry>Read/Write</entry>
- <entry>A bit-mask representing the state of the modifier
-keys (e.g. <keycap>Control</keycap>, <keycap>Shift</keycap> and
-<keycap>Alt</keycap>) and the pointer buttons.</entry>
- </row>
-
- <row valign="top">
- <entry>"button"</entry>
- <entry>Read/Write</entry>
- <entry>The button which was pressed or released, numbered
-from 1 to 5. Normally button 1 is the left mouse button, 2 is the middle
-button, and 3 is the right button. On 2-button mice, the middle button can
-often be simulated by pressing both mouse buttons together.</entry>
- </row>
-
- <row valign="top">
- <entry>"device"</entry>
- <entry>Read</entry>
- <entry>The device where the event originated.</entry>
- </row>
-
- <row valign="top">
- <entry>"x_root"</entry>
- <entry>Read/Write</entry>
- <entry>The x coordinate of the pointer relative to the root
-of the screen.</entry>
- </row>
-
- <row valign="top">
- <entry>"y_root"</entry>
- <entry>Read/Write</entry>
- <entry>The y coordinate of the pointer relative to the root
-of the screen.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Used for button press and button release events.</para>
-
- <para>Double and triple-clicks result in a sequence of events being
- received. For double-clicks the order of events will be:</para>
-
- <orderedlist>
- <listitem><literal>gtk.gdk.BUTTON_PRESS</literal></listitem>
- <listitem><literal>gtk.gdk.BUTTON_RELEASE</literal></listitem>
- <listitem><literal>gtk.gdk.BUTTON_PRESS</literal></listitem>
- <listitem><literal>gtk.gdk.2BUTTON_PRESS</literal></listitem>
- <listitem><literal>gtk.gdk.BUTTON_RELEASE</literal></listitem>
- </orderedlist>
-
- <para>Note that the first click is received just like a normal button
- press, while the second click results in a
- <literal>gtk.gdk.2BUTTON_PRESS</literal> being received just after the
- <literal>gtk.gdk.BUTTON_PRESS</literal>.</para>
-
- <para>Triple-clicks are very similar to double-clicks, except that
- <literal>gtk.gdk.3BUTTON_PRESS</literal> is inserted after the third
- click. The order of the events is:</para>
-
- <orderedlist>
- <listitem><literal>gtk.gdk.BUTTON_PRESS</literal></listitem>
- <listitem><literal>gtk.gdk.BUTTON_RELEASE</literal></listitem>
- <listitem><literal>gtk.gdk.BUTTON_PRESS</literal></listitem>
- <listitem><literal>gtk.gdk.2BUTTON_PRESS</literal></listitem>
- <listitem><literal>gtk.gdk.BUTTON_RELEASE</literal></listitem>
- <listitem><literal>gtk.gdk.BUTTON_PRESS</literal></listitem>
- <listitem><literal>gtk.gdk.3BUTTON_PRESS</literal></listitem>
- <listitem><literal>gtk.gdk.BUTTON_RELEASE</literal></listitem>
- </orderedlist>
-
- <para>For a double click to occur, the second button press must occur
- within 1/4 of a second of the first. For a triple click to occur, the
- third button press must also occur within 1/2 second of the first
- button press.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.KEY_PRESS</literal></title>
- <title><literal>gtk.gdk.KEY_RELEASE</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"time"</entry>
- <entry>Read/Write</entry>
- <entry>The time of the event in milliseconds.</entry>
- </row>
-
- <row valign="top">
- <entry>"state"</entry>
- <entry>Read/Write</entry>
- <entry>A bit-mask representing the state of the modifier
-keys (e.g. <keycap>Control</keycap>, <keycap>Shift</keycap> and
-<keycap>Alt</keycap>) and the pointer buttons.</entry>
- </row>
-
- <row valign="top">
- <entry>"keyval"</entry>
- <entry>Read/Write</entry>
- <entry>The key that was pressed or released.</entry>
- </row>
-
- <row valign="top">
- <entry>"string"</entry>
- <entry>Read/Write</entry>
- <entry>A multi-byte string containing the composed
-characters resulting from the key press. When text is being input, in a
-<link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> for
-example, it is these characters which should be added to the input buffer.
-When using Input Methods to support internationalized text input, the
-composed characters appear here after the pre-editing has been
-completed.</entry>
- </row>
-
- <row valign="top">
- <entry>"hardware_keycode"</entry>
- <entry>Read/Write</entry>
- <entry>The raw code of the key that was pressed or
-released. Available in PyGTK 2.2 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"group"</entry>
- <entry>Read/Write</entry>
- <entry>the keyboard group. Available in PyGTK 2.4 and
-above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated for a key press or key release event.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.ENTER_NOTIFY</literal></title>
- <title><literal>gtk.gdk.LEAVE_NOTIFY</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"subwindow"</entry>
- <entry>Read/Write</entry>
- <entry>The window that was entered or left.</entry>
- </row>
-
- <row valign="top">
- <entry>"time"</entry>
- <entry>Read/Write</entry>
- <entry>The time of the event in milliseconds.</entry>
- </row>
-
- <row valign="top">
- <entry>"x"</entry>
- <entry>Read/Write</entry>
- <entry>The x coordinate of the pointer relative to the
-window.</entry>
- </row>
-
- <row valign="top">
- <entry>"y"</entry>
- <entry>Read/Write</entry>
- <entry>The y coordinate of the pointer relative to the
-window.</entry>
- </row>
-
- <row valign="top">
- <entry>"x_root"</entry>
- <entry>Read/Write</entry>
- <entry>The x coordinate of the pointer relative to the root
-of the screen.</entry>
- </row>
-
- <row valign="top">
- <entry>"y_root"</entry>
- <entry>Read/Write</entry>
- <entry>The y coordinate of the pointer relative to the root
-of the screen.</entry>
- </row>
-
- <row valign="top">
- <entry>"mode"</entry>
- <entry>Read/Write</entry>
- <entry>The crossing mode
-(<literal>gtk.gdk.CROSSING_NORMAL</literal>,
-<literal>gtk.gdk.CROSSING_GRAB</literal> or
-<literal>gtk.gdk.CROSSING_UNGRAB</literal>).</entry>
- </row>
-
- <row valign="top">
- <entry>"detail"</entry>
- <entry>Read/Write</entry>
- <entry>The kind of crossing that happened
-(<literal>gtk.gdk.NOTIFY_INFERIOR</literal>,
-<literal>gtk.gdk.NOTIFY_ANCESTOR</literal>,
-<literal>gtk.gdk.NOTIFY_VIRTUAL</literal>,
-<literal>gtk.gdk.NOTIFY_NONLINEAR</literal> or
-<literal>gtk.gdk.NOTIFY_NONLINEAR_VIRTUAL</literal>).</entry>
- </row>
-
- <row valign="top">
- <entry>"focus"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if
-<parameter>window</parameter> is the focus window or an inferior.</entry>
- </row>
-
- <row valign="top">
- <entry>"state"</entry>
- <entry>Read/Write</entry>
- <entry>A bit-mask representing the state of the modifier
-keys (e.g. <keycap>Control</keycap>, <keycap>Shift</keycap> and
-<keycap>Alt</keycap>) and the pointer buttons.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated when the pointer enters or leaves a window.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.FOCUS_CHANGE</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"in_"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the window has gained the
-keyboard focus, <literal>False</literal> if it has lost the focus.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Describes a change of keyboard focus.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.CONFIGURE</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"x"</entry>
- <entry>Read/Write</entry>
- <entry>The new x coordinate of the window relative to its
-parent.</entry>
- </row>
-
- <row valign="top">
- <entry>"y"</entry>
- <entry>Read/Write</entry>
- <entry>The new y coordinate of the window relative to its
-parent.</entry>
- </row>
-
- <row valign="top">
- <entry>"width"</entry>
- <entry>Read/Write</entry>
- <entry>The new width of the window.</entry>
- </row>
-
- <row valign="top">
- <entry>"height"</entry>
- <entry>Read/Write</entry>
- <entry>The new height of the window.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated when a window size or position has changed.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.PROPERTY_NOTIFY</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"atom"</entry>
- <entry>Read</entry>
- <entry>The property that was changed.</entry>
- </row>
-
- <row valign="top">
- <entry>"time"</entry>
- <entry>Read/Write</entry>
- <entry>The time of the event in milliseconds.</entry>
- </row>
-
- <row valign="top">
- <entry>"state"</entry>
- <entry>Read/Write</entry>
- <entry>The property was changed
-(<literal>gtk.gdk.PROPERTY_NEW_VALUE</literal>) or deleted
-(<literal>gtk.gdk.PROPERTY_DELETE</literal>).</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Describes a property change on a window.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.SELECTION_CLEAR</literal></title>
- <title><literal>gtk.gdk.SELECTION_REQUEST</literal></title>
- <title><literal>gtk.gdk.SELECTION_NOTIFY</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"selection"</entry>
- <entry>Read</entry>
- <entry>The selection.</entry>
- </row>
-
- <row valign="top">
- <entry>"target"</entry>
- <entry>Read</entry>
- <entry>The target to which the selection should be
-converted.</entry>
- </row>
-
- <row valign="top">
- <entry>"property"</entry>
- <entry>Read</entry>
- <entry>The property in which to place the result of the
-conversion.</entry>
- </row>
-
- <row valign="top">
- <entry>"requestor"</entry>
- <entry>Read/Write</entry>
- <entry>the native window ID on which to place
-property.</entry>
- </row>
-
- <row valign="top">
- <entry>"time"</entry>
- <entry>Read/Write</entry>
- <entry>The time of the event in milliseconds.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated when a selection is requested or ownership of a
- selection is taken over by another client application.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.PROXIMITY_IN</literal></title>
- <title><literal>gtk.gdk.PROXIMITY_OUT</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"time"</entry>
- <entry>Read/Write</entry>
- <entry>The time of the event in milliseconds.</entry>
- </row>
-
- <row valign="top">
- <entry>"device"</entry>
- <entry>Read</entry>
- <entry>The device where the event originated.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Proximity events are generated when using GDK's wrapper for the
- XInput extension. The XInput extension is an add-on for standard X
- that allows you to use nonstandard devices such as graphics tablets. A
- proximity event indicates that the stylus has moved in or out of
- contact with the tablet, or perhaps that the user's finger has moved
- in or out of contact with a touch screen.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.DRAG_ENTER</literal></title>
- <title><literal>gtk.gdk.DRAG_LEAVE</literal></title>
- <title><literal>gtk.gdk.DRAG_MOTION</literal></title>
- <title><literal>gtk.gdk.DRAG_STATUS</literal></title>
- <title><literal>gtk.gdk.DRAG_START</literal></title>
- <title><literal>gtk.gdk.DRAG_FINISHED</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"context"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link>
-for the current DND operation.</entry>
- </row>
-
- <row valign="top">
- <entry>"time"</entry>
- <entry>Read/Write</entry>
- <entry>The time of the event in milliseconds.</entry>
- </row>
-
- <row valign="top">
- <entry>"x_root"</entry>
- <entry>Read/Write</entry>
- <entry>The x coordinate of the pointer relative to the root
-of the screen only set for <literal>gtk.gdk.DRAG_MOTION</literal> and
-<literal>gtk.gdk.DROP_START</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"y_root"</entry>
- <entry>Read/Write</entry>
- <entry>The y coordinate of the pointer relative to the root
-of the screen only set for <literal>gtk.gdk.DRAG_MOTION</literal> and
-<literal>gtk.gdk.DROP_START</literal>.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated during Drag and Drop operations.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.CLIENT_EVENT</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"message_type"</entry>
- <entry>Read/Write</entry>
- <entry>The type of the message, which can be defined by the
-application.</entry>
- </row>
-
- <row valign="top">
- <entry>"data_format"</entry>
- <entry>Read/Write</entry>
- <entry>The format of the data, given as the number of bits
-in each data element, i.e. 8, 16, or 32.</entry>
- </row>
-
- <row valign="top">
- <entry>"data"</entry>
- <entry>Read/Write</entry>
- <entry>The data as a string of 8-bit characters.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>An event sent by another client application.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.VISIBILITY_NOTIFY</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"state"</entry>
- <entry>Read/Write</entry>
- <entry>The new visibility state
-(<literal>gtk.gdk.VISIBILITY_FULLY_OBSCURED</literal>,
-<literal>gtk.gdk.VISIBILITY_PARTIAL</literal> or
-<literal>gtk.gdk.VISIBILITY_UNOBSCURED</literal>).</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated when the window visibility status has changed.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.SCROLL</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"time"</entry>
- <entry>Read/Write</entry>
- <entry>The time of the event in milliseconds.</entry>
- </row>
-
- <row valign="top">
- <entry>"x"</entry>
- <entry>Read/Write</entry>
- <entry>The x coordinate of the pointer relative to the
-window.</entry>
- </row>
-
- <row valign="top">
- <entry>"y"</entry>
- <entry>Read/Write</entry>
- <entry>The y coordinate of the pointer relative to the
-window.</entry>
- </row>
-
- <row valign="top">
- <entry>"state"</entry>
- <entry>Read/Write</entry>
- <entry>A bit-mask representing the state of the modifier
-keys (e.g. <keycap>Control</keycap>, <keycap>Shift</keycap> and
-<keycap>Alt</keycap>) and the pointer buttons.</entry>
- </row>
-
- <row valign="top">
- <entry>"direction"</entry>
- <entry>Read/Write</entry>
- <entry>The direction to scroll to (one of
-<literal>gtk.gdk.SCROLL_UP</literal>,
-<literal>gtk.gdk.SCROLL_DOWN</literal>,
-<literal>gtk.gdk.SCROLL_LEFT</literal> or
-<literal>gtk.gdk.SCROLL_RIGHT</literal>).</entry>
- </row>
-
- <row valign="top">
- <entry>"device"</entry>
- <entry>Read</entry>
- <entry>The device where the event originated.</entry>
- </row>
-
- <row valign="top">
- <entry>"x_root"</entry>
- <entry>Read/Write</entry>
- <entry>The x coordinate of the pointer relative to the root
-of the screen.</entry>
- </row>
-
- <row valign="top">
- <entry>"y_root"</entry>
- <entry>Read/Write</entry>
- <entry>The y coordinate of the pointer relative to the root
-of the screen.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated from button presses for the buttons 4 to 7. Wheel mice
- are usually configured to generate button press events for buttons 4
- and 5 when the wheel is turned.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.WINDOW_STATE</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"changed_mask"</entry>
- <entry>Read/Write</entry>
- <entry>The mask specifying what flags have changed - a
-combination of: <literal>gtk.gdk.WINDOW_STATE_WITHDRAWN</literal>,
-<literal>gtk.gdk.WINDOW_STATE_ICONIFIED</literal>,
-<literal>gtk.gdk.WINDOW_STATE_MAXIMIZED</literal> and
-<literal>gtk.gdk.WINDOW_STATE_STICKY</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"new_window_state"</entry>
- <entry>Read/Write</entry>
- <entry>The new window state - a combination of:
-<literal>gtk.gdk.WINDOW_STATE_WITHDRAWN</literal>,
-<literal>gtk.gdk.WINDOW_STATE_ICONIFIED</literal>,
-<literal>gtk.gdk.WINDOW_STATE_MAXIMIZED</literal> and
-<literal>gtk.gdk.WINDOW_STATE_STICKY</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated when the state of a toplevel window changes.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.SETTING</literal></title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"action"</entry>
- <entry>Read/Write</entry>
- <entry>What happened to the setting
-(<literal>gtk.gdk.SETTING_ACTION_NEW</literal>,
-<literal>gtk.gdk.SETTING_ACTION_CHANGED</literal> or
-<literal>gtk.gdk.SETTING_ACTION_DELETED</literal>).</entry>
- </row>
-
- <row valign="top">
- <entry>"name"</entry>
- <entry>Read/Write</entry>
- <entry>The name of the setting.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated when a setting is modified.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.OWNER_CHANGE</literal></title>
-
- <note>
- <para>This Event type is available in PyGTK 2.8 and above.</para>
- </note>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"owner"</entry>
- <entry>Read/Write</entry>
- <entry>the new owner of the selection - the native window
- ID as an integer</entry>
- </row>
-
- <row valign="top">
- <entry>"reason"</entry>
- <entry>Read/Write</entry>
- <entry>the reason for the ownership change indicated by one
- of the <xref linkend="gdk-owner-change-constants"
- endterm="gdk-owner-change-constants-title"></xref>.</entry>
- </row>
-
- <row valign="top">
- <entry>"selection"</entry>
- <entry>Read</entry>
- <entry>the atom identifying the selection</entry>
- </row>
-
- <row valign="top">
- <entry>"time"</entry>
- <entry>Read/Write</entry>
- <entry>the timestamp of the event</entry>
- </row>
-
- <row valign="top">
- <entry>"selection_time"</entry>
- <entry>Read/Write</entry>
- <entry>the time at which the selection ownership was taken
- over</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated when the owner of a selection changes. On X11, this
- information is only available if the X server supports the XFIXES
- extension.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.GRAB_BROKEN</literal></title>
-
- <note>
- <para>This Event type is available in PyGTK 2.8 and above.</para>
- </note>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The event type - see the list below in the <link
-linkend="description-gdkevent">Description</link> section</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read/Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> the
-event occurred on.</entry>
- </row>
-
- <row valign="top">
- <entry>"send_event"</entry>
- <entry>Read/Write</entry>
- <entry><literal>True</literal> if the event was sent
-explicitly.</entry>
- </row>
-
- <row valign="top">
- <entry>"keyboard"</entry>
- <entry>Read/Write</entry>
- <entry>if <literal>True</literal> a keyboard grab was
- broken; if <literal>False</literal> a pointer grab was
- broken</entry>
- </row>
-
- <row valign="top">
- <entry>"implicit"</entry>
- <entry>Read/Write</entry>
- <entry>if True the broken grab was implicit</entry>
- </row>
-
- <row valign="top">
- <entry>"grab_window"</entry>
- <entry>Read</entry>
- <entry>If this event is caused by another grab in the same
- application, <parameter>grab_window</parameter> contains the
- new grab window. Otherwise
- <parameter>grab_window</parameter> is
- <literal>None</literal>.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>Generated when a pointer or keyboard grab is broken. On X11,
- this happens when the grab window becomes unviewable (i.e. it or one
- of its ancestors is unmapped), or if the same application grabs the
- pointer or keyboard again. Note that implicit grabs (which are
- initiated by button presses) can also cause
- <literal>gtk.gdk.GRAB_BROKEN</literal> events.</para>
-
- </refsect2>
-
- <para></para>
-
- </refsect1>
-
- <refsect1 id="description-gdkevent">
- <title>Description</title>
-
- <para>A <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
- represents an event from the windowing system. The <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
- methods are usually not used by applications since the
- <literal>PyGTK</literal> main loop generates signals and invokes the
- appropriate signal handler. The event types are:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.NOTHING</literal></term>
- <listitem>
- <simpara>a special code to indicate a null event.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DELETE</literal></term>
- <listitem>
- <simpara>the window manager has requested that the toplevel window be hidden or destroyed, usually when the user clicks on a special icon in the title bar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DESTROY</literal></term>
- <listitem>
- <simpara>the window has been destroyed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.EXPOSE</literal></term>
- <listitem>
- <simpara>all or part of the window has become visible and needs to be redrawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MOTION_NOTIFY</literal></term>
- <listitem>
- <simpara>the pointer (usually a mouse) has moved.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BUTTON_PRESS</literal></term>
- <listitem>
- <simpara>a mouse button has been pressed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk._2BUTTON_PRESS</literal></term>
- <listitem>
- <simpara>a mouse button has been double-clicked (clicked twice within a short period of time). Note that each click also generates a <literal>gtk.gdk.BUTTON_PRESS</literal> event.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk._3BUTTON_PRESS</literal></term>
- <listitem>
- <simpara>a mouse button has been clicked 3 times in a short period of time. Note that each click also generates a <literal>gtk.gdk.BUTTON_PRESS</literal> event.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.BUTTON_RELEASE</literal></term>
- <listitem>
- <simpara>a mouse button has been released.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.KEY_PRESS</literal></term>
- <listitem>
- <simpara>a key has been pressed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.KEY_RELEASE</literal></term>
- <listitem>
- <simpara>a key has been released.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.ENTER_NOTIFY</literal></term>
- <listitem>
- <simpara>the pointer has entered the window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LEAVE_NOTIFY</literal></term>
- <listitem>
- <simpara>the pointer has left the window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.FOCUS_CHANGE</literal></term>
- <listitem>
- <simpara>the keyboard focus has entered or left the window.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CONFIGURE</literal></term>
- <listitem>
- <simpara>the size, position or stacking order of the window has changed. Note that <literal>PyGTK</literal> discards these events for <literal>gtk.gdk.WINDOW_CHILD</literal> windows.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MAP</literal></term>
- <listitem>
- <simpara>the window has been mapped.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.UNMA</literal></term>
- <listitem>
- <simpara>the window has been unmapped.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PROPERTY_NOTIFY</literal></term>
- <listitem>
- <simpara>a property on the window has been changed or deleted.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SELECTION_CLEAR</literal></term>
- <listitem>
- <simpara>the application has lost ownership of a selection.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SELECTION_REQUEST</literal></term>
- <listitem>
- <simpara>another application has requested a selection.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SELECTION_NOTIFY</literal></term>
- <listitem>
- <simpara>a selection has been received.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PROXIMITY_IN</literal></term>
- <listitem>
- <simpara>an input device has moved into contact with a sensing surface (e.g. a touchscreen or graphics tablet).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.PROXIMITY_OUT</literal></term>
- <listitem>
- <simpara>an input device has moved out of contact with a sensing surface.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_ENTER</literal></term>
- <listitem>
- <simpara>the mouse has entered the window while a drag is in progress.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_LEAVE</literal></term>
- <listitem>
- <simpara>the mouse has left the window while a drag is in progress</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_MOTION</literal></term>
- <listitem>
- <simpara>the mouse has moved in the window while a drag is in progress.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DRAG_STATUS</literal></term>
- <listitem>
- <simpara>the status of the drag operation initiated by the window has changed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DROP_START</literal></term>
- <listitem>
- <simpara>a drop operation onto the window has started.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.DROP_FINISHED</literal></term>
- <listitem>
- <simpara>the drop operation initiated by the window has completed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CLIENT_EVENT</literal></term>
- <listitem>
- <simpara>a message has been received from another application.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISIBILITY_NOTIFY</literal></term>
- <listitem>
- <simpara>the window visibility status has changed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.NO_EXPOSE</literal></term>
- <listitem>
- <simpara>indicates that the source region was completely available when parts of a drawable were copied. This is not very useful.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SCROLL</literal></term>
- <listitem>
- <simpara>a scroll had occurred for a window</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.WINDOW_STATE</literal></term>
- <listitem>
- <simpara>the window state has changed</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.SETTING</literal></term>
- <listitem>
- <simpara>a setting has changed</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.OWNER_CHANGE</literal></term>
- <listitem>
- <simpara>the owner of a selection has changed. Added in GTK+
- 2.6</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.GRAB_BROKEN</literal></term>
- <listitem>
- <simpara>a pointer or keyboard grab was broken. Added in GTK+
- 2.8.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>A set of bit-flags is used to indicate which events a window is to
- receive. Most of these masks map onto one or more of the event types
- above. Use the <link
- linkend="method-gtkwidget--set-events"><methodname>gtk.Widget.set_events</methodname>()</link>
- method to indicate which events a widget should receive.</para>
-
- <para>The <literal>gtk.gdk.POINTER_MOTION_HINT_MASK</literal> is a
-special mask which is used to reduce the number of
-<literal>gtk.gdk.MOTION_NOTIFY</literal> events received. Normally a
-<literal>gtk.gdk.MOTION_NOTIFY</literal> event is received each time the
-mouse moves. However, if the application spends a lot of time processing the
-event (updating the display, for example), it can easily lag behind the
-position of the mouse. When using the
-<literal>gtk.gdk.POINTER_MOTION_HINT_MASK</literal> the server will only
-send a single <literal>gtk.gdk.MOTION_NOTIFY</literal> event (which is
-marked as a hint) until the application asks for more, by calling the <link
-linkend="method-gdkwindow--get-pointer"><methodname>gtk.gdk.Window.get_pointer</methodname>()</link>
-method. The masks are:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>gtk.gdk.EXPOSURE_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.POINTER_MOTION_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.POINTER_MOTION_HINT_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.BUTTON_MOTION_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.BUTTON1_MOTION_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.BUTTON2_MOTION_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.BUTTON3_MOTION_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.BUTTON_PRESS_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.BUTTON_RELEASE_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.KEY_PRESS_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.KEY_RELEASE_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.ENTER_NOTIFY_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.LEAVE_NOTIFY_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.FOCUS_CHANGE_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.STRUCTURE_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.PROPERTY_CHANGE_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.VISIBILITY_NOTIFY_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.PROXIMITY_IN_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.PROXIMITY_OUT_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.SUBSTRUCTURE_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.SCROLL_MASK</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.ALL_EVENTS_MASK</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para><literal>gtk.gdk.ALL_EVENTS_MASK</literal> is a combination of all
-the event masks.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkevent">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Event</methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term> <listitem><simpara>a
- event type - see the <link
- linkend="description-gdkevent">Description</link>
- above</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a newly-allocated <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> of the
-given type. All fields are set to 0.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkevent--put">
- <title>gtk.gdk.Event.put</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>put</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>put</methodname>() method appends a copy of the
-given event onto the tail of the event queue.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkevent--copy">
- <title>gtk.gdk.Event.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the event</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method copies the event,
- copying or incrementing the reference count of the resources
- associated with it (e.g. windows and strings).</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkevent--free">
- <title>gtk.gdk.Event.free</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>free</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <warning>
- <para>This method is deprecated and should not be used since it may
-crash your application.</para>
- </warning>
-
- <para>The <methodname>free</methodname>() method frees the event,
-freeing or decrementing any resources associated with it. Note that this
-method should only be called on <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> objects
-returned from methods or functions such as <link
-linkend="function-gdk--event-peek"><methodname>gtk.gdk.event_peek</methodname>()</link>,
-<link
-linkend="function-gdk--event-get"><methodname>gtk.gdk.event_get</methodname>()</link>,
-<link
-linkend="function-gdk--event-get-graphics-expose"><methodname>gtk.gdk.event_get_graphics_expose</methodname>()</link>
-and <link
-linkend="method-gdkevent--copy"><methodname>copy</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkevent--get-time">
- <title>gtk.gdk.Event.get_time</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_time</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the time stamp field from the
-event</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_time</methodname>() method returns the time
-stamp from the event, if there is one; otherwise returns 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkevent--get-state">
- <title>gtk.gdk.Event.get_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_state</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the modifier state</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_state</methodname>() method returns the
- value of the modifier "state" field. If the event has no "state" field
- the empty state value (0) is returned. The "state" field contains a
- modifier type: a combination of the <xref
- linkend="gdk-modifier-constants"
- endterm="gdk-modifier-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2>
- <title><literal>gtk.gdk.NOTHING</literal></title>
- <title><literal>gtk.gdk.DELETE</literal></title>
- <title><literal>gtk.gdk.DESTROY</literal></title>
- <title><literal>gtk.gdk.MAP</literal></title>
- <title><literal>gtk.gdk.UNMAP</literal></title>
- <title><literal>gtk.gdk.NO_EXPOSE</literal></title>
-
- <blockquote>
- <para>These events do not have any additional attributes.</para>
- </blockquote>
- </refsect2>
-
- <refsect2 id="method-gdkevent--get-coords">
- <title>gtk.gdk.Event.get_coords</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_coords</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the event window x and y
-coordinates or an empty tuple if the event did not deliver event window
-coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_coords</methodname>() method returns a tuple
-containing the x and y coordinates of an event relative to the event <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> or an
-empty tuple if the event did not deliver event window coordinates.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkevent--get-root-coords">
- <title>gtk.gdk.Event.get_root_coords</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_root_coords</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the root window x and y
-coordinates or an empty tuple if the event did not deliver root window
-coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_root_coords</methodname>() method returns a
-tuple containing the x and y coordinates from an event relative to the root
-window or an empty tuple if the event did not deliver root window
-coordinates.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkevent--get-axis">
- <title>gtk.gdk.Event.get_axis</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_axis</methodname>
- <methodparam><parameter>axis_use</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>axis_use</parameter>&nbsp;:</term>
- <listitem><simpara>the axis use to look for</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the value found or <literal>None</literal> if
-the axis was not found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_axis</methodname>() method returns the axis
-value for the axis use specified by <parameter>axis_use</parameter> from an
-event structure. The value of <parameter>axis_use</parameter> must be one
-of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_IGNORE</literal></term>
- <listitem>
- <simpara>the axis is ignored.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_X</literal></term>
- <listitem>
- <simpara>the axis is used as the x axis.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_Y</literal></term>
- <listitem>
- <simpara>the axis is used as the y axis.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_PRESSURE</literal></term>
- <listitem>
- <simpara>the axis is used for pressure information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_XTILT</literal></term>
- <listitem>
- <simpara>the axis is used for x tilt information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_YTILT</literal></term>
- <listitem>
- <simpara>the axis is used for y tilt information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_WHEEL</literal></term>
- <listitem>
- <simpara>the axis is used for wheel information.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.AXIS_LAST</literal></term>
- <listitem>
- <simpara>a constant equal to the numerically highest axis
-value.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>If an axis with the specified axis use is not found, this method
-returns <literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkevent--set-screen">
- <title>gtk.gdk.Event.set_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_screen</methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_screen</methodname>() method sets the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> to
-the value of <parameter>screen</parameter>. The event must have been
-allocated by <literal>PyGTK</literal>, for instance, by the <link
-linkend="method-gdkevent--copy"><methodname>gtk.gdk.Event.copy()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkevent--get-screen">
- <title>gtk.gdk.Event.get_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_screen</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the screen for the event</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_screen</methodname>() method returns the
-<link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-for the event. The screen is typically the screen for the event window, but
-for events such as mouse events, it is the screen where the the pointer was
-when the event occurs - that is, the screen that has the root window for the
-event.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--events-pending">
- <title>gtk.gdk.events_pending</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.events_pending</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if any events are
-pending</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.events_pending</function>() function
-returns <literal>True</literal> if any events are ready to be
-processed.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--event-peek">
- <title>gtk.gdk.event_peek</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.event_peek</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the first <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> on the
-event queue or <literal>None</literal> if there is no event in the
-queue.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.event_peek</function>() function returns a
-copy of the first <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> on the
-event queue or <literal>None</literal> if there is no event on the event
-queue.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--event-get">
- <title>gtk.gdk.event_get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.event_get</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the next <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> to be
-processed, or <literal>None</literal> if no events are
-pending.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.event_get</function>() function returns
-the next <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> to be
-processed or <literal>None</literal> if no events are available.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--event-get-graphics-expose">
- <title>gtk.gdk.event_get_graphics_expose</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.event_get_graphics_expose</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an expose <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> if a
-<literal>GraphicsExpose</literal> was received, or <literal>None</literal>
-if a <literal>NoExpose</literal> event was received.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.event_get_graphics_expose</function>()
-function waits for and returns returns an expose <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> if a
-<literal>GraphicsExpose</literal> was received, or <literal>None</literal>
-if a <literal>NoExpose</literal> event was received.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--set-show-events">
- <title>gtk.gdk.set_show_events</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.set_show_events</methodname>
- <methodparam><parameter
- role="keyword">show_events</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">show_events</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> output event debug
-information</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.set_show_events</function>() function sets
-the debug events flag if <parameter>show_events</parameter> is
-<literal>True</literal>. Otherwise the debug events flag is unset.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--get-show-events">
- <title>gtk.gdk.get_show_events</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.get_show_events</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the debug events
-flag is set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.get_show_events</function>() function
-returns the setting of the internal debug events flag.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--event-handler-set">
- <title>gtk.gdk.event_handler_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.event_handler_set</methodname>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>func</parameter>&nbsp;:</term>
- <listitem><simpara> the function to call to handle events from GDK
- or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter>&nbsp;:</term>
- <listitem><simpara> user data to pass to the function.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.event_handler_set</function>() function
- specifies <parameter>func</parameter> as the function to call to
- handle all events from GDK. <parameter>data</parameter> is the
- optional user data to pass to <parameter>func</parameter>.</para>
-
- <para>The signature of <parameter>func</parameter> is:</para>
-
- <programlisting>
- def func(event, user_data):
- </programlisting>
-
- <para>where <parameter>event</parameter> is the <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
- and <parameter>user_data</parameter> is
- <parameter>data</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkfont.xml b/docs/reference/pygtk-gdkfont.xml
deleted file mode 100644
index 63d79c18..00000000
--- a/docs/reference/pygtk-gdkfont.xml
+++ /dev/null
@@ -1,521 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gdkfont">
- <refmeta>
- <refentrytitle>gtk.gdk.Font</refentrytitle>
- <manvolnum>3</manvolnum>
- <refmiscinfo>PyGTK Docs</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>gtk.gdk.Font</refname><refpurpose></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Font</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
-<constructorsynopsis language="python">
- <methodname>__init__</methodname>
- <methodparam><parameter>font_name</parameter></methodparam>
- </constructorsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--id">id</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--string-width">string_width</link></methodname>
- <methodparam><parameter>string</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--width">width</link></methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--text-width-wc">text_width_wc</link></methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--char-width">char_width</link></methodname>
- <methodparam><parameter>character</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--char-width-wc">char_width_wc</link></methodname>
- <methodparam><parameter>character</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--string-measure">string_measure</link></methodname>
- <methodparam><parameter>string</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--measure">measure</link></methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--char-measure">char_measure</link></methodname>
- <methodparam><parameter>character</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--string-height">string_height</link></methodname>
- <methodparam><parameter>string</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--height">height</link></methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--char-height">char_height</link></methodname>
- <methodparam><parameter>character</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--extents">extents</link></methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter></methodparam>
- <methodparam><parameter>lbearing</parameter></methodparam>
- <methodparam><parameter>rbearing</parameter></methodparam>
- <methodparam><parameter>width</parameter></methodparam>
- <methodparam><parameter>ascent</parameter></methodparam>
- <methodparam><parameter>descent</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--text-extents-wc">text_extents_wc</link></methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter></methodparam>
- <methodparam><parameter>lbearing</parameter></methodparam>
- <methodparam><parameter>rbearing</parameter></methodparam>
- <methodparam><parameter>width</parameter></methodparam>
- <methodparam><parameter>ascent</parameter></methodparam>
- <methodparam><parameter>descent</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkfont--string-extents">string_extents</link></methodname>
- <methodparam><parameter>string</parameter></methodparam>
- <methodparam><parameter>lbearing</parameter></methodparam>
- <methodparam><parameter>rbearing</parameter></methodparam>
- <methodparam><parameter>width</parameter></methodparam>
- <methodparam><parameter>ascent</parameter></methodparam>
- <methodparam><parameter>descent</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
- <refsect1>
- <title>Constructor</title>
-
-<programlisting><constructorsynopsis language="python">
- <methodname>__init__</methodname>
- <methodparam><parameter>font_name</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>font_name</parameter>&nbsp;:</term>
- <listitem><simpara>a const-gchar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a GdkFont*</simpara></listitem>
- </varlistentry>
- </variablelist>
-
-
-
- </refsect1>
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkfont--id">
- <title>gtk.gdk.Font.id</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>id</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--string-width">
- <title>gtk.gdk.Font.string_width</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>string_width</methodname>
- <methodparam><parameter>string</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>string</parameter>&nbsp;:</term>
- <listitem><simpara>a const-gchar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--width">
- <title>gtk.gdk.Font.width</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>width</methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>a const-gchar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>text_length</parameter>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--text-width-wc">
- <title>gtk.gdk.Font.text_width_wc</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>text_width_wc</methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>a const-GdkWChar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>text_length</parameter>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--char-width">
- <title>gtk.gdk.Font.char_width</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>char_width</methodname>
- <methodparam><parameter>character</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>character</parameter>&nbsp;:</term>
- <listitem><simpara>a gchar</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--char-width-wc">
- <title>gtk.gdk.Font.char_width_wc</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>char_width_wc</methodname>
- <methodparam><parameter>character</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>character</parameter>&nbsp;:</term>
- <listitem><simpara>a GdkWChar</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--string-measure">
- <title>gtk.gdk.Font.string_measure</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>string_measure</methodname>
- <methodparam><parameter>string</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>string</parameter>&nbsp;:</term>
- <listitem><simpara>a const-gchar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--measure">
- <title>gtk.gdk.Font.measure</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>measure</methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>a const-gchar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>text_length</parameter>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--char-measure">
- <title>gtk.gdk.Font.char_measure</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>char_measure</methodname>
- <methodparam><parameter>character</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>character</parameter>&nbsp;:</term>
- <listitem><simpara>a gchar</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--string-height">
- <title>gtk.gdk.Font.string_height</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>string_height</methodname>
- <methodparam><parameter>string</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>string</parameter>&nbsp;:</term>
- <listitem><simpara>a const-gchar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--height">
- <title>gtk.gdk.Font.height</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>height</methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>a const-gchar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>text_length</parameter>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--char-height">
- <title>gtk.gdk.Font.char_height</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>char_height</methodname>
- <methodparam><parameter>character</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>character</parameter>&nbsp;:</term>
- <listitem><simpara>a gchar</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--extents">
- <title>gtk.gdk.Font.extents</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>extents</methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter></methodparam>
- <methodparam><parameter>lbearing</parameter></methodparam>
- <methodparam><parameter>rbearing</parameter></methodparam>
- <methodparam><parameter>width</parameter></methodparam>
- <methodparam><parameter>ascent</parameter></methodparam>
- <methodparam><parameter>descent</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>a const-gchar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>text_length</parameter>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>lbearing</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>rbearing</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>width</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>ascent</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>descent</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--text-extents-wc">
- <title>gtk.gdk.Font.text_extents_wc</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>text_extents_wc</methodname>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>text_length</parameter></methodparam>
- <methodparam><parameter>lbearing</parameter></methodparam>
- <methodparam><parameter>rbearing</parameter></methodparam>
- <methodparam><parameter>width</parameter></methodparam>
- <methodparam><parameter>ascent</parameter></methodparam>
- <methodparam><parameter>descent</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>a const-GdkWChar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>text_length</parameter>&nbsp;:</term>
- <listitem><simpara>a gint</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>lbearing</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>rbearing</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>width</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>ascent</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>descent</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gdkfont--string-extents">
- <title>gtk.gdk.Font.string_extents</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>string_extents</methodname>
- <methodparam><parameter>string</parameter></methodparam>
- <methodparam><parameter>lbearing</parameter></methodparam>
- <methodparam><parameter>rbearing</parameter></methodparam>
- <methodparam><parameter>width</parameter></methodparam>
- <methodparam><parameter>ascent</parameter></methodparam>
- <methodparam><parameter>descent</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>string</parameter>&nbsp;:</term>
- <listitem><simpara>a const-gchar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>lbearing</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>rbearing</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>width</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>ascent</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>descent</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- </refsect1>
-</refentry>
diff --git a/docs/reference/pygtk-gdkgc.xml b/docs/reference/pygtk-gdkgc.xml
deleted file mode 100644
index 17a71798..00000000
--- a/docs/reference/pygtk-gdkgc.xml
+++ /dev/null
@@ -1,1622 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkgc">
- <refnamediv>
- <refname>gtk.gdk.GC</refname>
- <refpurpose>objects to encapsulate drawing properties.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.GC</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkgc">gtk.gdk.GC</link></methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">foreground</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- <methodparam><parameter
- role="keyword">function</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tile</parameter></methodparam>
- <methodparam><parameter
- role="keyword">stipple</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">subwindow_mode</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">graphics_exposures</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cap_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">join_style</parameter>></methodparam>
- </constructorsynopsis>
-
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkgc- -get-values">get_values</link></methodname>
- <methodparam><parameter role="keyword">values</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-values">set_values</link></methodname>
- <methodparam><parameter
- role="keyword">foreground</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- <methodparam><parameter
- role="keyword">function</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tile</parameter></methodparam>
- <methodparam><parameter
- role="keyword">stipple</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">subwindow_mode</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">graphics_exposures</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cap_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">join_style</parameter>></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-foreground">set_foreground</link></methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-background">set_background</link></methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-function">set_function</link></methodname>
- <methodparam><parameter
- role="keyword">function</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-fill">set_fill</link></methodname>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-tile">set_tile</link></methodname>
- <methodparam><parameter
- role="keyword">tile</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-stipple">set_stipple</link></methodname>
- <methodparam><parameter
- role="keyword">stipple</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-ts-origin">set_ts_origin</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-clip-origin">set_clip_origin</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-clip-mask">set_clip_mask</link></methodname>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-clip-rectangle">set_clip_rectangle</link></methodname>
- <methodparam><parameter
- role="keyword">rectangle</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkgc--set-clip-region">set_clip_region</link></methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-subwindow">set_subwindow</link></methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-exposures">set_exposures</link></methodname>
- <methodparam><parameter
- role="keyword">exposures</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-line-attributes">set_line_attributes</link></methodname>
- <methodparam><parameter
- role="keyword">line_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cap_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">join_style</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-dashes">set_dashes</link></methodname>
- <methodparam><parameter>dash_offset</parameter></methodparam>
- <methodparam><parameter>dash_list</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--offset">offset</link></methodname>
- <methodparam><parameter
- role="keyword">x_offset</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--copy">copy</link></methodname>
- <methodparam><parameter
- role="keyword">src_gc</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-colormap">set_colormap</link></methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--get-colormap">get_colormap</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-rgb-fg-color">set_rgb_fg_color</link></methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkgc--set-rgb-bg-color">set_rgb_bg_color</link></methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkgc--get-screen">get_screen</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkgc">gtk.gdk.GC</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"background"</entry>
- <entry>Read-Write</entry>
- <entry>The background <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>.</entry>
- </row>
-
- <row valign="top">
- <entry>"cap_style"</entry>
- <entry>Read-Write</entry>
- <entry>The style of drawing the ends of lines - one of:
-<literal>gtk.gdk.CAP_NOT_LAST</literal>,
-<literal>gtk.gdk.CAP_BUTT</literal>, <literal>gtk.gdk.CAP_ROUND</literal> or
-<literal>gtk.gdk.CAP_PROJECTING</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"clip_mask"</entry>
- <entry>Read-Write</entry>
- <entry>A <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-bitmap used to clip the drawing operation.</entry>
- </row>
-
- <row valign="top">
- <entry>"clip_x_origin"</entry>
- <entry>Read-Write</entry>
- <entry>The x origin of the clip mask.</entry>
- </row>
-
- <row valign="top">
- <entry>"clip_y_origin"</entry>
- <entry>Read-Write</entry>
- <entry>The y origin of the clip mask.</entry>
- </row>
-
- <row valign="top">
- <entry>"fill"</entry>
- <entry>Read-Write</entry>
- <entry>The fill style - one of:
-<literal>gtk.gdk.SOLID</literal>, <literal>gtk.gdk.TILED</literal>,
-<literal>gtk.gdk.STIPPLED</literal> or
-<literal>gtk.gdk.OPAQUE_STIPPLED</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"font"</entry>
- <entry>Read-Write</entry>
- <entry>The default font (deprecated and unused)</entry>
- </row>
-
- <row valign="top">
- <entry>"foreground"</entry>
- <entry>Read-Write</entry>
- <entry>The foreground <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>.</entry>
- </row>
-
- <row valign="top">
- <entry>"function"</entry>
- <entry>Read-Write</entry>
- <entry>A bitwise operation type to combine source and
-destination pixels - one of: <literal>gtk.gdk.COPY</literal>,
-<literal>gtk.gdk.INVERT</literal>, <literal>gtk.gdk.XOR</literal>,
-<literal>gtk.gdk.CLEAR</literal>, <literal>gtk.gdk.AND</literal>,
-<literal>gtk.gdk.AND_REVERSE</literal>,
-<literal>gtk.gdk.AND_INVERT</literal>, <literal>gtk.gdk.NOOP</literal>,
-<literal>gtk.gdk.OR</literal>, <literal>gtk.gdk.EQUIV</literal>,
-<literal>gtk.gdk.OR_REVERSE</literal>,
-<literal>gtk.gdk.COPY_INVERT</literal>,
-<literal>gtk.gdk.OR_INVERT</literal>, <literal>gtk.gdk.NAND</literal>,
-<literal>gtk.gdk.NOR</literal> or <literal>gtk.gdk.SET</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"graphics_exposures"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> graphics exposures are
-enabled.</entry>
- </row>
-
- <row valign="top">
- <entry>"join_style"</entry>
- <entry>Read-Write</entry>
- <entry>The style used to join lines - one of:
-<literal>gtk.gdk.JOIN_MITER</literal>, <literal>gtk.gdk.JOIN_ROUND</literal>
-or <literal>gtk.gdk.JOIN_BEVEL</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"line_style"</entry>
- <entry>Read-Write</entry>
- <entry>The style of drawing lines - one of:
-<literal>gtk.gdk.LINE_SOLID</literal>,
-<literal>gtk.gdk.LINE_ON_OFF_DASH</literal> or
-<literal>gtk.gdk.LINE_DOUBLE_DASH</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"line_width"</entry>
- <entry>Read-Write</entry>
- <entry>The width of a line in pixels.</entry>
- </row>
-
- <row valign="top">
- <entry>"stipple"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-bitmap used to stipple the background.</entry>
- </row>
-
- <row valign="top">
- <entry>"sub_window"</entry>
- <entry>Read-Write</entry>
- <entry>The mode of drawing in a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> with
-subwindows - one of: <literal>gtk.gdk.CLIP_BY_CHILDREN</literal> or
-<literal>gtk.gdk.INCLUDE_INFERIORS</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"tile"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> used
-to tile the background.</entry>
- </row>
-
- <row valign="top">
- <entry>"ts_x_origin"</entry>
- <entry>Read-Write</entry>
- <entry>The x origin of the tile or stipple.</entry>
- </row>
-
- <row valign="top">
- <entry>"ts_y_origin"</entry>
- <entry>Read-Write</entry>
- <entry>The y origin of the tile or stipple.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>All drawing operations in <literal>PyGTK</literal> take a graphics
-context (<link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) argument
-(See the <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-description). A graphics context encapsulates information about the way
-things are drawn, such as the foreground color or line width. By using
-graphics contexts, the number of arguments to each drawing call is greatly
-reduced, and communication overhead is minimized, since identical arguments
-do not need to be passed repeatedly. Most values of a graphics context can
-be set at creation time by using <link
-linkend="method-gdkdrawable--new-gc"><methodname>gtk.gdk.Drawable.new_gc</methodname>()</link>,
-or can be set one-by-one using functions such as <link
-linkend="method-gdkgc--set-foreground"><methodname>set_foreground</methodname>()</link>
-or by setting a <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> attribute. A
-few of the values in the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>, such as the
-dash pattern, can only be set by the latter method.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkgc">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.GC</methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">foreground</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- <methodparam><parameter
- role="keyword">function</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tile</parameter></methodparam>
- <methodparam><parameter
- role="keyword">stipple</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">subwindow_mode</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">graphics_exposures</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cap_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">join_style</parameter>></methodparam>
-</constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">drawable</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-(<link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> or
-<link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">foreground</parameter>&nbsp;:</term>
- <listitem><simpara>the foreground <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">background</parameter>&nbsp;:</term>
- <listitem><simpara>the background <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">font</parameter>&nbsp;:</term>
- <listitem><simpara>a font (deprecated and
-ignored)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">function</parameter>&nbsp;:</term>
- <listitem><simpara>the bitwise operator used to combine the existing
-pixel value and a new pixel value - usually one of:
-<literal>gtk.gdk.COPY</literal>, <literal>gtk.gdk.XOR</literal> or
-<literal>gtk.gdk.INVERT</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
- <listitem><simpara>the fill style - one of:
-<literal>gtk.gdk.SOLID</literal>, <literal>gtk.gdk.TILED</literal>,
-<literal>gtk.gdk.STIPPLED</literal>,
-<literal>gtk.gdk.OPAQUE_STIPPLED</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tile</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> used
-for tiling the background</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">stipple</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> used
-for stippling the background</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">clip_mask</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> of
-depth 1 used to mask pixels to be drawn</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">subwindow_mode</parameter>&nbsp;:</term>
- <listitem><simpara>the mode of drawing on subwindows in a <link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-- one of: <literal>gtk.gdk.CLIP_BY_CHILDREN</literal> or
-<literal>gtk.gdk.INCLUDE_INFERIORS</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">ts_x_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the origin of
-<parameter>tile</parameter> or
-<parameter>stipple</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">ts_y_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the origin of
-<parameter>tile</parameter> or
-<parameter>stipple</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">clip_x_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the origin of
-<parameter>clip_mask</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">clip_y_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the origin of
-<parameter>clip_mask</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">graphics_exposures</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> graphics exposures are
-enabled for calls to the <link
-linkend="method-gdkdrawable--draw-drawable"><methodname>gtk.gdk.Drawable.draw_drawable</methodname>()</link>
-method.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">line_width</parameter>&nbsp;:</term>
- <listitem><simpara>the line width in pixels</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">line_style</parameter>&nbsp;:</term>
- <listitem><simpara>the line style - one of:
-<literal>gtk.gdk.LINE_SOLID</literal>,
-<literal>gtk.gdk.LINE_ON_OFF_DASH</literal>,
-<literal>gtk.gdk.LINE_DOUBLE_DASH</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">cap_style</parameter>&nbsp;:</term>
- <listitem><simpara>the style of line ends - one of:
-<literal>gtk.gdk.CAP_NOT_LAST</literal>,
-<literal>gtk.gdk.CAP_BUTT</literal>, <literal>gtk.gdk.CAP_ROUND</literal>,
-<literal>gtk.gdk.CAP_PROJECTING</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">join_style</parameter>&nbsp;:</term>
- <listitem><simpara>the style of line joins - one of:
-<literal>gtk.gdk.JOIN_MITER</literal>,
-<literal>gtk.gdk.JOIN_ROUND</literal>,
-<literal>gtk.gdk.JOIN_BEVEL</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> object for
-the <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-specified by <parameter>drawable</parameter> with the optional attributes as
-specified by the arguments. The drawable parameter must be specified but the
-rest of the parameters are optional. Any attributes not specified will use a
-default value. This is an alternative to the <link
-linkend="method-gdkdrawable--new-gc"><methodname>gtk.gdk.Drawable.new_gc</methodname>()</link>
-method. Since there are a large number of optional attribute parameters it's
-probably best to specify the attribute values using keywords.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gdkgc- -get-values">
- <title>gtk.gdk.GC.get_values</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>get_values</methodname>
- <methodparam><parameter role="keyword">values</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">values</parameter>&nbsp;:</term>
- <listitem><simpara>a GdkGCValues*</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gdkgc--set-values">
- <title>gtk.gdk.GC.set_values</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_values</methodname>
- <methodparam><parameter
- role="keyword">values</parameter></methodparam>
- <methodparam><parameter
- role="keyword">foreground</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- <methodparam><parameter
- role="keyword">function</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tile</parameter></methodparam>
- <methodparam><parameter
- role="keyword">stipple</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">subwindow_mode</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ts_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_x_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">clip_y_origin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">graphics_exposures</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cap_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">join_style</parameter>></methodparam>
-</methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">foreground</parameter>&nbsp;:</term>
- <listitem><simpara>the foreground <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">background</parameter>&nbsp;:</term>
- <listitem><simpara>the background <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">font</parameter>&nbsp;:</term>
- <listitem><simpara>a font (deprecated and
-ignored)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">function</parameter>&nbsp;:</term>
- <listitem><simpara>the bitwise operator used to combine the
-existing pixel value and a new pixel value - usually one of:
-<literal>gtk.gdk.COPY</literal>, <literal>gtk.gdk.XOR</literal> or
-<literal>gtk.gdk.INVERT</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
- <listitem><simpara>the fill style - one of:
-<literal>gtk.gdk.SOLID</literal>, <literal>gtk.gdk.TILED</literal>,
-<literal>gtk.gdk.STIPPLED</literal>,
-<literal>gtk.gdk.OPAQUE_STIPPLED</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tile</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> used
-for tiling the background</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">stipple</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> used
-for stippling the background</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">clip_mask</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> of
-depth 1 used to mask pixels to be drawn</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">subwindow_mode</parameter>&nbsp;:</term>
- <listitem><simpara>the mode of drawing on subwindows in a
-<link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> - one of: <literal>gtk.gdk.CLIP_BY_CHILDREN</literal> or
-<literal>gtk.gdk.INCLUDE_INFERIORS</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">ts_x_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the origin of
-<parameter>tile</parameter> or
-<parameter>stipple</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">ts_y_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the origin of
-<parameter>tile</parameter> or
-<parameter>stipple</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">clip_x_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the origin of
-<parameter>clip_mask</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">clip_y_origin</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the origin of
-<parameter>clip_mask</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">graphics_exposures</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> graphics exposures
-are enabled for calls to the <link
-linkend="method-gdkdrawable--draw-drawable"><methodname>gtk.gdk.Drawable.draw_drawable</methodname>()</link>
-method.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">line_width</parameter>&nbsp;:</term>
- <listitem><simpara>the line width in pixels</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">line_style</parameter>&nbsp;:</term>
- <listitem><simpara>the line style - one of:
-<literal>gtk.gdk.LINE_SOLID</literal>,
-<literal>gtk.gdk.LINE_ON_OFF_DASH</literal>,
-<literal>gtk.gdk.LINE_DOUBLE_DASH</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">cap_style</parameter>&nbsp;:</term>
- <listitem><simpara>the style of line ends - one of:
-<literal>gtk.gdk.CAP_NOT_LAST</literal>,
-<literal>gtk.gdk.CAP_BUTT</literal>, <literal>gtk.gdk.CAP_ROUND</literal>,
-<literal>gtk.gdk.CAP_PROJECTING</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">join_style</parameter>&nbsp;:</term>
- <listitem><simpara>the style of line joins - one of:
-<literal>gtk.gdk.JOIN_MITER</literal>,
-<literal>gtk.gdk.JOIN_ROUND</literal>,
-<literal>gtk.gdk.JOIN_BEVEL</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_values</methodname>() method sets the
-attributes of a graphics context in bulk using the optional parameters.
-Since there are a large number of attribute parameters it's probably best to
-specify the attribute values using keywords. Any attributes not specified
-will be left as is.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-foreground">
- <title>gtk.gdk.GC.set_foreground</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_foreground</methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>the new foreground <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_foreground</methodname>() method sets the
-foreground <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to the
-value specified by <parameter>color</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-background">
- <title>gtk.gdk.GC.set_background</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_background</methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>the new background <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_background</methodname>() method sets the
-background <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to the
-value specified by <parameter>color</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-function">
- <title>gtk.gdk.GC.set_function</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_function</methodname>
- <methodparam><parameter
- role="keyword">function</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">function</parameter>&nbsp;:</term>
- <listitem><simpara>the bitwise operator used to combine the
-existing pixel value and a new pixel value - usually one of:
-<literal>gtk.gdk.COPY</literal>, <literal>gtk.gdk.XOR</literal> or
-<literal>gtk.gdk.INVERT</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_function</methodname>() method sets the
-function attribute to the value specified by
-<parameter>function</parameter>. The value of
-<parameter>function</parameter> must be one of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>gtk.gdk.COPY</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.INVERT</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.XOR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.CLEAR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.AND</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.AND_REVERSE.</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.AND_INVERT</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.NOOP</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.OR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.EQUIV</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.OR_REVERSE</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.COPY_INVERT</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.OR_INVERT</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.NAND</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.NOR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.gdk.SET</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para>Only a couple of these values are usually useful. For colored
-images, only <literal>gtk.gdk.COPY</literal>, <literal>gtk.gdk.XOR</literal>
-and <literal>gtk.gdk.INVERT</literal> are generally useful. For bitmaps,
-<literal>gtk.gdk.AND</literal> and <literal>gtk.gdk.OR</literal> are also
-useful. </para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-fill">
- <title>gtk.gdk.GC.set_fill</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_fill</methodname>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
- <listitem><simpara>the new fill mode</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_fill</methodname>() method sets the fill
-mode for the graphics context to the value specified by
-<parameter>fill</parameter>. The value of <parameter>fill</parameter> must
-be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.SOLID</literal></term>
- <listitem>
- <simpara>draw with the foreground color. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.TILED</literal></term>
- <listitem>
- <simpara>draw with a tiled pixmap.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.STIPPLED</literal></term>
- <listitem>
- <simpara>draw using the stipple bitmap. Pixels corresponding to
-bits in the stipple bitmap that are set will be drawn in the foreground
-color; pixels corresponding to bits that are not set will be left
-untouched.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.OPAQUE_STIPPLED</literal></term>
- <listitem>
- <simpara>draw using the stipple bitmap. Pixels corresponding to
-bits in the stipple bitmap that are set will be drawn in the foreground
-color; pixels corresponding to bits that are not set will be drawn with the
-background color.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-tile">
- <title>gtk.gdk.GC.set_tile</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tile</methodname>
- <methodparam><parameter
- role="keyword">tile</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tile</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_tile</methodname>() method sets the <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-specified by <parameter>tile</parameter> to be used for filling the
-background when the fill mode is <literal>gtk.gdk.TILED</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-stipple">
- <title>gtk.gdk.GC.set_stipple</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>set_stipple</methodname>
- <methodparam><parameter role="keyword">stipple</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stipple</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> bitmap</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_stipple</methodname>() method sets the <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-bitmap specified by <parameter>stipple</parameter> to be used for stippling
-the background. <parameter>stipple</parameter> will only be used if the fill
-mode is <literal>gtk.gdk.STIPPLED</literal> or
-<literal>gtk.gdk.OPAQUE_STIPPLED</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-ts-origin">
- <title>gtk.gdk.GC.set_ts_origin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_ts_origin</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x origin of the tile or
-stipple</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y origin of the tile or
-stipple</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_ts_origin</methodname>() method sets the
-origin of the tile or stipple to the value specified by
-<parameter>x</parameter> and <parameter>y</parameter>. The tile or stipple
-will be aligned such that the upper left corner of the tile or stipple will
-coincide with this point.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-clip-origin">
- <title>gtk.gdk.GC.set_clip_origin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_clip_origin</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x origin of the clip
-mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y origin of the clip
-mask</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_clip_origin</methodname>() method sets the
-origin of the clip mask to the value specified by <parameter>x</parameter>
-and <parameter>y</parameter>. The coordinates are interpreted relative to
-the upper-left corner of the destination drawable of the current
-operation.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-clip-mask">
- <title>gtk.gdk.GC.set_clip_mask</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_clip_mask</methodname>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mask</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_clip_mask</methodname>() method sets the
-clip mask (a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> bit
-map) to the value specified by <parameter>mask</parameter>. The clip mask is
-interpreted relative to the clip origin. See the <link
-linkend="method-gdkgc--set-clip-origin"><methodname>set_clip_origin</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-clip-rectangle">
- <title>gtk.gdk.GC.set_clip_rectangle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_clip_rectangle</methodname>
- <methodparam><parameter
- role="keyword">rectangle</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">rectangle</parameter>&nbsp;:</term> <listitem><simpara>a
-<link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-to use for clipping</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_clip_rectangle</methodname>() method sets
-the clip mask for the graphics context from the <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-specified by <parameter>rectangle</parameter> and sets the clip origin to
-(0, 0). The clip origin can be changed using the <link
-linkend="method-gdkgc--set-clip-origin"><methodname>set_clip_origin</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-clip-region">
- <title>gtk.gdk.GC.set_clip_region</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_clip_region</methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">region</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_clip_region</methodname>() method sets the
- clip mask for a graphics context from the <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- specified by <parameter>region</parameter>. The clip mask is
- interpreted relative to the clip origin. (See the <link
- linkend="method-gdkgc--set-clip-origin"><methodname>set_clip_origin</methodname>()</link>
- method).</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-subwindow">
- <title>gtk.gdk.GC.set_subwindow</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_subwindow</methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mode</parameter>&nbsp;:</term>
- <listitem><simpara>the new subwindow mode</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_subwindow</methodname>() method sets the
-mode of drawing on subwindows when drawing on a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> to
-the value specified by <parameter>mode</parameter>. The value of mode must
-be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.CLIP_BY_CHILDREN</literal></term>
- <listitem>
- <simpara>only draw onto the window itself not the
-subwindows.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INCLUDE_INFERIORS</literal></term>
- <listitem>
- <simpara>draw onto the window and child windows.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-exposures">
- <title>gtk.gdk.GC.set_exposures</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_exposures</methodname>
- <methodparam><parameter
- role="keyword">exposures</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">exposures</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> exposure events will
-be generated for non-visible areas</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_exposures</methodname>() method sets an
-attribute that determines if copying non-visible portions of a drawable
-using this graphics context will generate exposure events for the
-corresponding regions of the destination drawable. If
-<parameter>exposures</parameter> is <literal>True</literal> exposure events
-will be generated for non-visible areas. See the <link
-linkend="method-gdkdrawable--draw-drawable"><methodname>gtk.gdk.Drawable.draw_drawable</methodname>()</link>
-method. </para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-line-attributes">
- <title>gtk.gdk.GC.set_line_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_line_attributes</methodname>
- <methodparam><parameter
- role="keyword">line_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">line_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cap_style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">join_style</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">line_width</parameter>&nbsp;:</term>
- <listitem><simpara>the new line width in
-pixels</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">line_style</parameter>&nbsp;:</term>
- <listitem><simpara>the new line style</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">cap_style</parameter>&nbsp;:</term>
- <listitem><simpara>the new line end style</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">join_style</parameter>&nbsp;:</term>
- <listitem><simpara>the new line join style</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_line_attributes</methodname>() method sets
-the attributes to be used when drawing a line using the graphics context to
-the values specified by <parameter>line_width</parameter>,
-<parameter>line_style</parameter>, <parameter>cap_style</parameter> and
-<parameter>join_style</parameter>. The value of
-<parameter>line_style</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.LINE_SOLID</literal></term>
- <listitem>
- <simpara>Lines are drawn solid.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LINE_ON_OFF_DASH</literal></term>
- <listitem>
- <simpara>Lines are drawn dashed where even segments are drawn
-but odd segments are not drawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.LINE_DOUBLE_DASH</literal></term>
- <listitem>
- <simpara>Lines are drawn dashed where even segments are drawn
-normally but odd segments are drawn in the background color if the fill
-style is <literal>gtk.gdk.SOLID</literal>, or in the background color masked
-by the stipple if the fill style is
-<literal>gtk.gdk.STIPPLED</literal>.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The value of cap_style must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.CAP_NOT_LAST</literal></term>
- <listitem>
- <simpara>The same as <literal>gtk.gdk.CAP_BUTT</literal> for
-lines of non-zero width but for zero width lines, the final point on the
-line will not be drawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CAP_BUTT</literal></term>
- <listitem>
- <simpara>The ends of the lines are drawn squared off and
-extending to the coordinates of the end point.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CAP_ROUND</literal></term>
- <listitem>
- <simpara>The ends of the lines are drawn as semicircles with the
-diameter equal to the line width and centered at the end point.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CAP_PROJECTING</literal></term>
- <listitem>
- <simpara>The ends of the lines are drawn squared off and
-extending half the width of the line beyond the end point.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The value of join_style must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.JOIN_MITER</literal></term>
- <listitem>
- <simpara>The sides of each line are extended to meet at an
-angle.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.JOIN_ROUND</literal></term>
- <listitem>
- <simpara>The sides of the two lines are joined by a circular
-arc.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.JOIN_BEVEL</literal></term>
- <listitem>
- <simpara>The sides of the two lines are joined by a straight
-line which makes an equal angle with each line.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-dashes">
- <title>gtk.gdk.GC.set_dashes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_dashes</methodname>
- <methodparam><parameter
- role="keyword">dash_offset</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dash_list</parameter></methodparam>
- <methodparam><parameter role="keyword">n</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>dash_offset</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the length in
-<parameter>dash_list</parameter> to use as the firstst
-dash</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>dash_list</parameter>&nbsp;:</term>
- <listitem><simpara>the tuple or list of dash lengths in
-pixels</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_dashes</methodname>() method sets the
-pattern for drawing dashed lines using the tuple or list of dash lengths
-specified by <parameter>dash_list</parameter> with the index of the starting
-dash length specified by <parameter>dash_offset</parameter>. The dashes are
-drawn starting with the number of pixels at the offset position; then the
-next number of pixels is skipped; and then the next number is drawn; and so
-on rotating through all the <parameter>dash_list</parameter> numbers and
-starting over when the end is reached. For example, if
-<parameter>dash_list</parameter> is (2, 4, 8, 16) and the offset is 1, the
-dashes will be drawn as: draw 4 pixels, skip 8 pixels, draw 16 pixels, skip
-2 pixels, draw 4 pixels and so on.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--offset">
- <title>gtk.gdk.GC.offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>offset</methodname>
- <methodparam><parameter
- role="keyword">x_offset</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_offset</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x_offset</parameter>&nbsp;:</term>
- <listitem><simpara>the amount by which to offset the graphics context in the X
-direction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y_offset</parameter>&nbsp;:</term>
- <listitem><simpara>the amount by which to offset the graphics context in the Y
-direction</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>offset</methodname>() method sets offset
-attributes such as the clip and tile-stipple origins of the graphics context so that
-drawing at x - <parameter>x_offset</parameter>, y -
-<parameter>y_offset</parameter> with the offset graphics context has the same effect as
-drawing at x, y with the original graphics context.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--copy">
- <title>gtk.gdk.GC.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam><parameter
- role="keyword">src_gc</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">src_gc</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> to
-copy</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method copies the attributes
-of the <link linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>
-specified by <parameter>src_gc</parameter> into this graphics context.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-colormap">
- <title>gtk.gdk.GC.set_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_colormap</methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_colormap</methodname>() method sets the
-colormap for the graphics context to the specified
-<parameter>colormap</parameter>. The depth of the colormap's visual must
-match the depth of the drawable for which the graphics context was
-created.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--get-colormap">
- <title>gtk.gdk.GC.get_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_colormap</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the colormap used by the graphics
-context</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_colormap</methodname>() method returns the
-colormap for the graphics context, if it exists. A graphics context will
-have a colormap if the drawable for which it was created has a colormap, or
-if a colormap was set explicitly with the <link
-linkend="method-gdkgc--set-colormap"><methodname>set_colormap</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-rgb-fg-color">
- <title>gtk.gdk.GC.set_rgb_fg_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_rgb_fg_color</methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>an unallocated <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_rgb_fg_color</methodname>() method sets the
-foreground color of a graphics context using the specified unallocated
-<parameter>color</parameter>. The pixel value for
-<parameter>color</parameter> will be determined using GdkRGB. If the
-colormap for the graphics context has not previously been initialized for
-GdkRGB, then for pseudo-color colormaps (colormaps with a small modifiable
-number of colors), a colorcube will be allocated in the colormap. Calling
-this method for a graphics context without a colormap is an error.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--set-rgb-bg-color">
- <title>gtk.gdk.GC.set_rgb_bg_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_rgb_bg_color</methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>an unallocated <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_rgb_bg_color</methodname>() method sets the
-background color of a graphics context using the specified unallocated
-<parameter>color</parameter>. The pixel value for
-<parameter>color</parameter> will be determined using GdkRGB. If the
-colormap for the graphics context has not previously been initialized for
-GdkRGB, then for pseudo-color colormaps (colormaps with a small modifiable
-number of colors), a colorcube will be allocated in the colormap. Calling
-this method for a graphics context without a colormap is an error.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkgc--get-screen">
- <title>gtk.gdk.GC.get_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_screen</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
- for the gc</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2. and above.</para>
- </note>
-
- <para>The <methodname>get_screen</methodname>() method returns the
-<link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-on which the gc was created.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkimage.xml b/docs/reference/pygtk-gdkimage.xml
deleted file mode 100644
index 81b111cb..00000000
--- a/docs/reference/pygtk-gdkimage.xml
+++ /dev/null
@@ -1,281 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkimage">
- <refnamediv>
- <refname>gtk.gdk.Image</refname>
- <refpurpose>an area for bit-mapped graphics stored on the X Windows
-client.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Image</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkimage">gtk.gdk.Image</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">visual</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkimage--put-pixel">put_pixel</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixel</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkimage--get-pixel">get_pixel</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkimage--set-colormap">set_colormap</link></methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkimage--get-colormap">get_colormap</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkimage">gtk.gdk.Image</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> type
-represents an area for drawing graphics. It has now been superseded to a
-large extent by the much more flexible RGB methods (see <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>).</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkimage">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Image</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">visual</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
-type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">visual</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width in pixels of the
-image</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height in pixels of the
-image</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> object
-of the specified <parameter>type</parameter>, <parameter>width</parameter>
-and <parameter>height</parameter> and using the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
-specified by <parameter>visual</parameter>. The value of
-<parameter>type</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.IMAGE_NORMAL</literal></term>
- <listitem>
- <simpara>The original X image type, which is quite slow since the
-image has to be transferred from the client to the server to display
-it.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.IMAGE_SHARED</literal></term>
- <listitem>
- <simpara>A faster image type, which uses shared memory to transfer
-the image data between client and server. However this will only be
-available if client and server are on the same machine and the shared memory
-extension is supported by the server.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.IMAGE_FASTEST</literal></term>
- <listitem>
- <simpara>Specifies that gtk.gdk.IMAGE_SHARED should be tried
-first, and if that fails then gtk.gdk.IMAGE_NORMAL will be used.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>Usually using <literal>gtk.gdk.IMAGE_FASTEST</literal> is the best
-choice.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkimage--put-pixel">
- <title>gtk.gdk.Image.put_pixel</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>put_pixel</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixel</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x coordinate of the pixel to
-set.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y coordinate of the pixel to
-set.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixel</parameter>&nbsp;:</term>
- <listitem><simpara>the pixel value to set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>put_pixel</methodname>() method sets the value
-of the pixel in the image at the location specified by
-<parameter>x</parameter> and <parameter>y</parameter> to the value specified
-by <parameter>pixel</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkimage--get-pixel">
- <title>gtk.gdk.Image.get_pixel</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixel</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x coordinate of the pixel to
-get.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y coordinate of the pixel to
-get.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the pixel value at the image
-location</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixel</methodname>() method returns the
-value of the pixel at the image location specified by
-<parameter>x</parameter> and <parameter>y</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkimage--set-colormap">
- <title>gtk.gdk.Image.set_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_colormap</methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_colormap</methodname>() method sets the
-colormap for the image to the specified <parameter>colormap</parameter>.
-Normally there's no need to use this method since images are created with
-the correct colormap if you get the image from a drawable. If you create the
-image from scratch, use the colormap of the drawable you intend to render
-the image to.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkimage--get-colormap">
- <title>gtk.gdk.Image.get_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_colormap</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the colormap for the image</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_colormap</methodname>() method returns the
-colormap for a given image, if it exists. An image will have a colormap if
-the drawable from which it was created has a colormap, or if a colormap was
-set explicitly with the <link
-linkend="method-gdkimage--set-colormap"><methodname>set_colormap</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkkeymap.xml b/docs/reference/pygtk-gdkkeymap.xml
deleted file mode 100644
index adce874d..00000000
--- a/docs/reference/pygtk-gdkkeymap.xml
+++ /dev/null
@@ -1,858 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkkeymap">
- <refnamediv>
- <refname>gtk.gdk.Keymap</refname>
- <refpurpose>an object containing mappings of keys to key
-values.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Keymap</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkkeymap--lookup-key">lookup_key</link></methodname>
- <methodparam><parameter role="keyword">keycode</parameter></methodparam>
- <methodparam><parameter role="keyword">group</parameter></methodparam>
- <methodparam><parameter role="keyword">level</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkkeymap--translate-keyboard-state">translate_keyboard_state</link></methodname>
- <methodparam><parameter role="keyword">keycode</parameter></methodparam>
- <methodparam><parameter role="keyword">state</parameter></methodparam>
- <methodparam><parameter role="keyword">group</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkkeymap--get-entries-for-keyval">get_entries_for_keyval</link></methodname>
- <methodparam><parameter role="keyword">keyval</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkkeymap--get-entries-for-keycode">get_entries_for_keycode</link></methodname>
- <methodparam><parameter role="keyword">hardware_keycode</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkkeymap--get-direction">get_direction</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keymap-get-default">gtk.gdk.keymap_get_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keymap-get-for-display">gtk.gdk.keymap_get_for_display</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-name">gtk.gdk.keyval_name</link></methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-from-name">gtk.gdk.keyval_from_name</link></methodname>
- <methodparam><parameter
- role="keyword">keyval_name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-convert-case">gtk.gdk.keyval_convert_case</link></methodname>
- <methodparam><parameter
- role="keyword">symbol</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-to-upper">gtk.gdk.keyval_to_upper</link></methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-to-lower">gtk.gdk.keyval_to_lower</link></methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-is-upper">gtk.gdk.keyval_is_upper</link></methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-is-lower">gtk.gdk.keyval_is_lower</link></methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--keyval-to-unicode">gtk.gdk.keyval_to_unicode</link></methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--unicode-to-keyval">gtk.gdk.unicode_to_keyval</link></methodname>
- <methodparam><parameter role="keyword">wc</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkkeymap">gtk.gdk.Keymap</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gdkkeymap--direction-changed">direction-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>gdkkeymap</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gdkkeymap--keys-changed">keys-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>gdkkeymap</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkkeymap"><classname>gtk.gdk.Keymap</classname></link>
-defines the translation from keyboard state (including a hardware key, a
-modifier mask, and active keyboard group) to a keyval. This translation has
-two phases. The first phase is to determine the effective keyboard group and
-level for the keyboard state; the second phase is to look up the
-keycode/group/level triplet in the keymap and see what keyval it corresponds
-to. One <link
-linkend="class-gdkkeymap"><classname>gtk.gdk.Keymap</classname></link>
-object exists for each user display. <literal>PyGTK</literal> supports only
-one display, so <link
-linkend="function-gdk--keymap-get-default"><function>gtk.gdk.keymap_get_default()</function>()</link>
-returns the singleton <link
-linkend="class-gdkkeymap"><classname>gtk.gdk.Keymap</classname></link>.</para>
-
- <para>A keymap is a mapping from a Keymap key to key values. You can
-think of a Keymap key as a representation of a symbol printed on a physical
-keyboard key. That is, it contains three pieces of information. First, it
-contains the hardware keycode; this is an identifying number for a physical
-key. Second, it contains the level of the key. The level indicates which
-symbol on the key will be used, in a vertical direction. So on a standard US
-keyboard, the key with the number "1" on it also has the exclamation point
-("!") character on it. The level indicates whether to use the "1" or the "!"
-symbol. The letter keys are considered to have a lowercase letter at level
-0, and an uppercase letter at level 1, though only the uppercase letter is
-printed. Third, the Keymap key contains a group; groups are not used on
-standard US keyboards, but are used in many other countries. On a keyboard
-with groups, there can be 3 or 4 symbols printed on a single key. The group
-indicates movement in a horizontal direction. Usually groups are used for
-two different languages. In group 0, a key might have two English
-characters, and in group 1 it might have two Hebrew characters. The Hebrew
-characters will be printed on the key next to the English characters.
-</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkkeymap--lookup-key">
- <title>gtk.gdk.Keymap.lookup_key</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>lookup_key</methodname>
- <methodparam><parameter
- role="keyword">keycode</parameter></methodparam>
- <methodparam><parameter
- role="keyword">group</parameter></methodparam>
- <methodparam><parameter
- role="keyword">level</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keycode</parameter>&nbsp;:</term>
- <listitem><simpara>the hardware keycode.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">group</parameter>&nbsp;:</term>
- <listitem><simpara>the key group</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">level</parameter>&nbsp;:</term>
- <listitem><simpara>the key level</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a keyval, or 0 if none was mapped to the
- (<parameter>keycode</parameter>, <parameter>group</parameter>,
- <parameter>level</parameter>) triplet.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>lookup_key</methodname>() method returns the
-keyval mapped to the specified (<parameter>keycode</parameter>,
-<parameter>group</parameter>, <parameter>level</parameter>) triplet. This
-method returns 0 if no keyval is found. For normal user input, you want to
-use the <link
-linkend="method-gdkkeymap--translate-keyboard-state"><methodname>translate_keyboard_state()</methodname></link>
-method instead of this method, since the effective group or level may not be
-the same as the current keyboard state.</para>
-
- <para>The parameters to this method are:</para>
-
- <variablelist>
- <varlistentry>
- <term><parameter>keycode</parameter>&nbsp;:</term>
- <listitem>
- <simpara>the hardware keycode. This is an identifying number for
-a physical key.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>group</parameter>&nbsp;:</term>
- <listitem>
- <simpara>indicates movement in a horizontal direction. Usually
-groups are used for two different languages. In group 0, a key might have
-two English characters, and in group 1 it might have two Hebrew
-characters. The Hebrew characters will be printed on the key next to the
-English characters.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>level</parameter>&nbsp;:</term>
- <listitem>
- <simpara>indicates which symbol on the key will be used, in a
-vertical direction. So on a standard US keyboard, the key with the number
-"1" on it also has the exclamation point ("!") character on it. The level
-indicates whether to use the "1" or the "!" symbol. The letter keys are
-considered to have a lowercase letter at level 0, and an uppercase letter at
-level 1, though only the uppercase letter is printed.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkkeymap--translate-keyboard-state">
- <title>gtk.gdk.Keymap.translate_keyboard_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>translate_keyboard_state</methodname>
- <methodparam><parameter role="keyword">keycode</parameter></methodparam>
- <methodparam><parameter role="keyword">state</parameter></methodparam>
- <methodparam><parameter role="keyword">group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keycode</parameter>&nbsp;:</term>
- <listitem><simpara>a keycode</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">state</parameter>&nbsp;:</term>
- <listitem><simpara>a modifier state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">group</parameter>&nbsp;:</term>
- <listitem><simpara>an active keyboard group</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>a 4-tuple containing the keyval, the effective group,
-the level and the modifiers that were used to determine the group or
-level</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>translate_keyboard_state</methodname>() method
- translates the contents of a keyboard <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
- (specified by <parameter>keycode</parameter>,
- <parameter>state</parameter> and <parameter>group</parameter>) into a
- keyval, effective group, level and consumed modifiers that affected
- the translation (and are unavailable for application use) which are
- returned in a 4-tuple. See the <link
- linkend="method-gdkkeymap--lookup-key"><methodname>lookup_key</methodname>()</link>
- method for an explanation of groups and levels. The effective group is
- the group that was actually used for the translation; some keys such
- as <keycap>Enter</keycap> are not affected by the active keyboard
- group. The level is derived from <parameter>state</parameter>. For
- convenience, the keyboard <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
- already contains the translated keyval, so this method isn't as useful
- as you might think.</para>
-
- <para>The value of <parameter>state</parameter> or the consumed
- modifiers is a combination of the <xref
- linkend="gdk-modifier-constants"
- endterm="gdk-modifier-constants-title"></xref>.</para>
-
- <refsect3>
- <title>Consumed Modifiers</title>
-
- <para>The consumed modifiers are modifiers that should be masked out
-from <parameter>state</parameter> when comparing this key press to a hot
-key. For instance, on a US keyboard, the <keysym>plus</keysym> symbol is
-shifted, so when comparing a key press to a
-<keycombo>
- <keycap>Control</keycap><keysym>plus</keysym></keycombo>
- accelerator <keycap>Shift</keycap> should be masked out. For
- example:</para>
-
- <programlisting>
- # We want to ignore irrelevant modifiers like ScrollLock
- ALL_ACCELS_MASK = (gtk.gdk.CONTROL_MASK | gtk.gdk.SHIFT_MASK
- | gtk.gdk.MOD1_MASK)
- keyval, egroup, level, consumed = keymap.translate_keyboard_state(
- event.hardware_keycode, event.state, event.group)
- if (keyval == gtk.keysyms.plus and
- (event.state &amp; ~consumed &amp; ALL_ACCELS_MASK) == gtk.gdk.CONTROL_MASK):
- # Control was pressed
-</programlisting>
-
- <para>Note that most keys that are affected by the
-<keycap>Shift</keycap> key will have <literal>gtk.gdk.SHIFT_MASK</literal>
-part of the consumed modifiers (e.g. <keycombo>
-<keycap>Control</keycap><keycap>Shift</keycap><keycap>Tab</keycap>
-</keycombo>).</para>
-
- <para>All single modifier combinations that could affect the key for
-any combination of modifiers will be returned in consumed_modifiers.
-Multi-modifier combinations are returned only when actually found in
-<parameter>state</parameter>. When you store accelerators, you should always
-store them with consumed modifiers removed. Store &lt;Control&gt;plus, not
-&lt;Control&gt;&lt;Shift&gt;plus,</para>
-
- </refsect3>
-
- </refsect2>
-
- <refsect2 id="method-gdkkeymap--get-entries-for-keyval">
- <title>gtk.gdk.Keymap.get_entries_for_keyval</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_entries_for_keyval</methodname>
- <methodparam><parameter role="keyword">keyval</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>a keyval, such as <literal>GDK_a</literal>,
-<literal>GDK_Up</literal>, <literal>GDK_Return</literal>,
-etc.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing 3-tuple containing a keycode,
-a group and a level that will generate
-<parameter>keyval</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_entries_for_keyval</methodname>() method
-returns a tuple of (keycode, group, level) 3-tuples that will generate
-<parameter>keyval</parameter>. Groups and levels are two kinds of keyboard
-mode; in general, the level determines whether the top or bottom symbol on a
-key is used, and the group determines whether the left or right symbol is
-used. On US keyboards, the shift key changes the keyboard level, and there
-are no groups. A group switch key might convert a keyboard between Hebrew to
-English modes, for example, the <literal>gtk.gdk.KEY_PRESS</literal> and
-<literal>gtk.gdk.KEY_RELEASE</literal> <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> objects
-contain a <literal>group</literal> attribute that indicates the active
-keyboard group. The level is computed from the modifier mask.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkkeymap--get-entries-for-keycode">
- <title>gtk.gdk.Keymap.get_entries_for_keycode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_entries_for_keycode</methodname>
- <methodparam><parameter role="keyword">hardware_keycode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">hardware_keycode</parameter>&nbsp;:</term>
- <listitem><simpara>a keycode</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing 4-tuples: (keyval, keycode,
-group, level)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_entries_for_keycode</methodname>() method
-returns a tuple containing 4-tuples with: the keyvals bound to
-<parameter>hardware_keycode</parameter>, the keycode, the group and the
-level. When a keycode is pressed by the user, the keyval from this list of
-entries is selected by considering the effective keyboard group and
-level. See the <link
-linkend="method-gdkkeymap--translate-keyboard-state"><methodname>translate_keyboard_state()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkkeymap--get-direction">
- <title>gtk.gdk.Keymap.get_direction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_direction</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a Pango direction: <literal>pango.DIRECTION_LTR</literal> or <literal>pango.DIRECTION_RTL</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_direction</methodname>() method returns the direction of the keymap.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--keymap-get-default">
- <title>gtk.gdk.keymap_get_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keymap_get_default</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default gdk keymap for the
-display.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.keymap_get_default</function>() function
-returns the default <link
-linkend="class-gdkkeymap"><classname>gtk.gdk.Keymap</classname></link> for
-the display.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--keymap-get-for-display">
- <title>gtk.gdk.keymap_get_for_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keymap_get_for_display</methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the keymap for
- <parameter>display</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.keymap_get_for_display</function>()
-function returns the <link
-linkend="class-gdkkeymap"><classname>gtk.gdk.Keymap</classname></link> for
-the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-specified by <parameter>display</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--keyval-name">
- <title>gtk.gdk.keyval_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keyval_name</methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>a key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the name of the key, or
-None if keyval is not a valid key.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.keyval_name</function>() function converts
-the key value specified by <parameter>keyval</parameter> into a symbolic
-name.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--keyval-from-name">
- <title>gtk.gdk.keyval_from_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keyval_from_name</methodname>
- <methodparam><parameter
- role="keyword">keyval_name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">keyval_name</parameter>&nbsp;:</term>
- <listitem><simpara>a key name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the corresponding key value or 0 if the key
-name is not a valid key.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.keyval_from_name</function>() function
-converts the key name specified by <parameter>keyval_name</parameter> to a
-key value.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--keyval-convert-case">
- <title>gtk.gdk.keyval_convert_case</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keyval_convert_case</methodname>
- <methodparam><parameter
- role="keyword">symbol</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">symbol</parameter>&nbsp;:</term>
- <listitem><simpara>a keyval</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the lowercase and
- uppercase versions of
- <parameter>symbol</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.keyval_convert_case</function>() function
-returns the lowercase and uppercase versions of the keyval specified by
-<parameter>symbol</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--keyval-to-upper">
- <title>gtk.gdk.keyval_to_upper</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keyval_to_upper</methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>a key value.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the upper case form of keyval, or keyval itself
-if it is already in upper case or it is not subject to case
-conversion.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.keyval_to_upper</function>() function
-converts the key value specified by <parameter>keyval</parameter> to upper
-case, if applicable.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--keyval-to-lower">
- <title>gtk.gdk.keyval_to_lower</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keyval_to_lower</methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>the key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the lower case form of keyval, or keyval itself
-if it is already in lower case or it is not subject to case
-conversion.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.keyval_to_lower</function>() function
-converts the key value specified by <parameter>keyval</parameter> to lower
-case, if applicable. </para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--keyval-is-upper">
- <title>gtk.gdk.keyval_is_upper</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keyval_is_upper</methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>the key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>keyval</parameter> is in upper case or if keyval is not subject
-to case conversion.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.keyval_is_upper</function>() function
-returns <literal>True</literal> if the key value specified by
-<parameter>keyval</parameter> is in upper case or not subject to case
-conversion.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--keyval-is-lower">
- <title>gtk.gdk.keyval_is_lower</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keyval_is_lower</methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>the key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>keyval</parameter> is in lower case, or if
-<parameter>keyval</parameter> is not subject to case
-conversion.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.keyval_is_lower</function>() function
-returns <literal>True</literal> if the key value specified by
-<parameter>keyval</parameter> is in lower case or is not subject to case
-conversion.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--keyval-to-unicode">
- <title>gtk.gdk.keyval_to_unicode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.keyval_to_unicode</methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>the key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the corresponding unicode character, or 0 if
-there is no corresponding character.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.keyval_to_unicode</function>() function
-converts the key value specified by <parameter>keyval</parameter> to the
-corresponding ISO10646 (Unicode) character.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--unicode-to-keyval">
- <title>gtk.gdk.unicode_to_keyval</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.unicode_to_keyval</methodname>
- <methodparam><parameter
- role="keyword">wc</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">wc</parameter>&nbsp;:</term>
- <listitem><simpara> a ISO10646 encoded (unicode)
-character</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the corresponding key value, if one exists. or,
-if there is no corresponding symbol, <parameter>wc</parameter> |
-0x01000000</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.unicode_to_keyval</function>() function
-converts the ISO10646 (unicode) character specified by
-<parameter>wc</parameter> to a key value.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gdkkeymap--direction-changed">
- <title>The "direction-changed" gtk.gdk.Keymap Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>gdkkeymap</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>gdkkeymap</parameter>&nbsp;:</term>
- <listitem><simpara>the gdkkeymap that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "direction-changed" signal is emitted when the pango text
-direction of <parameter>gdkkeymap</parameter> is changed</para>
-
- </refsect2>
-
- <refsect2 id="signal-gdkkeymap--keys-changed">
- <title>The "keys-changed" gtk.gdk.Keymap Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>gdkkeymap</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>gdkkeymap</parameter>&nbsp;:</term>
- <listitem><simpara>the gdkkeymap that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.2 and above.</para>
- </note>
-
- <para>The "keys-changed" signal is emitted when the mapping
-represented by <parameter>keymap</parameter> changes.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkpangorenderer.xml b/docs/reference/pygtk-gdkpangorenderer.xml
deleted file mode 100644
index df729352..00000000
--- a/docs/reference/pygtk-gdkpangorenderer.xml
+++ /dev/null
@@ -1,404 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkpangorenderer">
- <refnamediv>
- <refname>gtk.gdk.PangoRenderer</refname>
- <refpurpose>an object providing use of Pango in GDK (new in PyGTK
-2.8)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.gdk.PangoRenderer</classname></ooclass>
- <ooclass><classname><link linkend="class-pangorenderer">pango.Renderer</link></classname></ooclass>
-<constructorsynopsis language="python">
- <methodname>pango.Renderer</methodname>
- <methodparam><parameter role="keyword">screen</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkpangorenderer--set-drawable">set_drawable</link></methodname>
- <methodparam><parameter role="keyword">drawable</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkpangorenderer--set-gc">set_gc</link></methodname>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkpangorenderer--set-stipple">set_stipple</link></methodname>
- <methodparam><parameter role="keyword">part</parameter></methodparam>
- <methodparam><parameter role="keyword">stipple</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkpangorenderer--set-override-color">set_override_color</link></methodname>
- <methodparam><parameter role="keyword">part</parameter></methodparam>
- <methodparam><parameter role="keyword">color</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gdk--gdk-pango-renderer-get-default">gtk.gdk.gdk_pango_renderer_get_default</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pangorenderer">pango.Renderer</link>
- +-- <link linkend="class-gdkpangorenderer">gtkgdk.PangoRenderer</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"screen"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-for the renderer. Available in GTK+ 2.8 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>Pango is the text layout system used by PyGTK (via GDK and
-GTK+). The functions and types in this section are used to render Pango
-objects to <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-objects, and also extend the set of Pango attributes to include stippling
-and embossing.</para>
-
- <para>Creating a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-object is the first step in rendering text, and requires getting a handle to
-a <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>.
-For PyGTK programs, you'll usually want to use the <link
-linkend="method-gtkwidget--get-pango-context"><methodname>gtk.Widget.get_pango_context</methodname>()</link>
-method, or the <link
-linkend="method-gtkwidget--create-pango-layout"><methodname>create_pango_layout</methodname>()</link>)
-method, rather than using the lowlevel <link
-linkend="function-gdk--gdk-pango-context-get-for-screen"><function>gtk.gdk.gdk_pango_context_get_for_screen</function>()</link>
-function. Once you have a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>, you
-can set the text and attributes of it with Pango methods like <link
-linkend="method-pangolayout--set-text"><methodname>pango.Layout.set_text</methodname>()</link>
-and get its size using the <link
-linkend="method-pangolayout--get-size"><methodname>get_size</methodname>()</link>
-method. (Note that Pango uses a fixed point system internally, so convert
-between Pango units and pixels using <literal>pango.SCALE</literal> or the
-<link
-linkend="function-pango--PIXELS"><function>pango.PIXELS</function>()</link>
-function.)</para>
-
- <para>Rendering a Pango layout is done most simply with the <link
-linkend="method-gdkdrawable--draw-layout"><methodname>draw_layout</methodname>()</link>
-method; you can also draw pieces of the layout with the <link
-linkend="method-gdkdrawable--draw-layout"><methodname>draw_layout</methodname>()</link>
-method or the <link
-linkend="method-gdkdrawable--draw-glyphs"><methodname>draw_glyphs</methodname>()</link>
-method.</para>
-
- <para><link
-linkend="class-gdkpangorenderer"><classname>gtk.gdk.PangoRenderer</classname></link>
-is a subclass of <link
-linkend="class-pangorenderer"><classname>pango.Renderer</classname></link>
-that is used internally to implement these functions. Using it directly or
-subclassing it can be useful in some cases. The default renderer for a
-particular screen is obtained with the <link
-linkend="function-gdk--gdk-pango-renderer-get-default"><function>gtk.gdk.gdk_pango_renderer_get_default</function>()</link>
-function. Pango methods like <link
-linkend="method-pangorenderer--draw-layout"><methodname>pango.Renderer.draw_layout</methodname>()</link>
-and <link
-linkend="method-pangorenderer--draw-layout-line"><methodname>pango.Renderer.draw_layout_line</methodname>()</link>
-are then used to draw objects with the renderer.</para>
-
- <para>In most simple cases, applications can just use the <link
-linkend="method-gdkdrawable--draw-layout"><methodname>draw_layout</methodname>()</link>
-method, and don't need to directly use <link
-linkend="class-gdkpangorenderer"><classname>gtk.gdk.PangoRenderer</classname></link>
-at all. Using the <link
-linkend="class-gdkpangorenderer"><classname>gtk.gdk.PangoRenderer</classname></link>
-directly is most useful when working with a transformation such as a
-rotation, because the Pango drawing functions take user space coordinates
-(coordinates before the transformation) instead of device
-coordinates.</para>
-
- <para>In certain cases it can be useful to subclass <link
-linkend="class-gdkpangorenderer"><classname>gtk.gdk.PangoRenderer</classname></link>. Examples
-of reasons to do this are to add handling of custom attributes by overriding
-'prepare_run' or to do custom drawing of embedded objects by overriding
-'draw_shape'.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.PangoRenderer</methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkpangorenderer"><classname>gtk.gdk.PangoRenderer</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gdkpangorenderer"><classname>gtk.gdk.PangoRenderer</classname></link>
-object for the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-specified by screen. Normally you can use the results of the <link
-linkend="function-gdk--gdk-pango-renderer-get-default"><function>gtk.gdk.gdk_pango_renderer_get_default</function>()</link>
-function rather than creating a new renderer.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkpangorenderer--set-drawable">
- <title>gtk.gdk.PangoRenderer.set_drawable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_drawable</methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">drawable</parameter>&nbsp;:</term>
- <listitem><simpara>the new target <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link> or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_drawable</methodname>() method sets the
-<link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-specified by <parameter>drawable</parameter> as the drawable for
-rendering.</para>
-
-<para>In PyGTK 2.10, <parameter>drawable</parameter> may be
-<literal>None</literal> to unset the drawable.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpangorenderer--set-gc">
- <title>gtk.gdk.PangoRenderer.set_gc</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_gc</methodname>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_gc</methodname>() method sets the graphics
-context the renderer draws with to the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> specified by
-<parameter>gc</parameter>.</para>
-
-<para>In PyGTK 2.10, <parameter>gc</parameter> may be
-<literal>None</literal> to unset the gc to use for drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpangorenderer--set-stipple">
- <title>gtk.gdk.PangoRenderer.set_stipple</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_stipple</methodname>
- <methodparam><parameter
- role="keyword">part</parameter></methodparam>
- <methodparam><parameter
- role="keyword">stipple</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">part</parameter>&nbsp;:</term>
- <listitem><simpara> the part to render with the
-stipple</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">stipple</parameter>&nbsp;:</term>
- <listitem><simpara> the new stipple bitmap</simpara> or
- <literal>None</literal>.</listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_stipple</methodname>() method sets the
-stipple for one render part (foreground, background, underline,
-strikethrough) to the bitmap specified by
-<parameter>stipple</parameter>. The value of part must be one of the <xref
-linkend="pango-render-part-constants"
-endterm="pango-render-part-constants-title"></xref>. Note that this is
-overwritten when iterating through the individual styled runs of a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> or
-<link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>. This
-method is thus only useful when you call low level methods like <link
-linkend="method-pangorenderer--draw-glyphs"><methodname>draw_glyphs</methodname>()</link>
-directly, or in the 'prepare_run' virtual function of a subclass of <link
-linkend="class-gdkpangorenderer"><classname>gtk.gdk.PangoRenderer</classname></link>.</para>
-
-<para>In PyGTK 2.10 <parameter>stipple</parameter> may be set to
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpangorenderer--set-override-color">
- <title>gtk.gdk.PangoRenderer.set_override_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_override_color</methodname>
- <methodparam><parameter
- role="keyword">part</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">part</parameter>&nbsp;:</term>
- <listitem><simpara> the part to render with
-<parameter>color</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_override_color</methodname>() method sets
-the color for a particular render part (foreground, background, underline,
-strikethrough.) to the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-specified by <parameter>color</parameter>, overriding any attributes on the
-layouts renderered with this renderer.</para>
-
-<para>In PyGTK 2.10 <parameter>color</parameter> may be set to
-<literal>None</literal>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--gdk-pango-renderer-get-default">
- <title>gtk.gdk.gdk_pango_renderer_get_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.gdk_pango_renderer_get_default</methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default <link
-linkend="class-gdkpangorenderer"><classname>gtk.gdk.PangoRenderer</classname></link>
-object for <parameter>screen</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The
-<function>gtk.gdk.gdk_pango_renderer_get_default</function>() function
-returns the default <link
-linkend="class-gdkpangorenderer"><classname>gtk.gdk.PangoRenderer</classname></link>
-for the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-specified by <parameter>screen</parameter>. This default renderer is shared
-by all users of the display, so properties such as the color or
-transformation matrix set for the renderer may be overwritten by methods
-such as <link
-linkend="method-gdkdrawable--draw-layout"><methodname>gtk.gdk.Drawable.draw_layout</methodname>()</link>.</para>
-
- <para>Before using the renderer, you need to call the <link
-linkend="method-gdkpangorenderer--set-drawable"><methodname>set_drawable</methodname>()</link>
-and <link
-linkend="method-gdkpangorenderer--set-gc"><methodname>set_gc</methodname>()</link>
-methods to set the drawable and graphics context to use for drawing.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkpixbuf.xml b/docs/reference/pygtk-gdkpixbuf.xml
deleted file mode 100644
index e64183ed..00000000
--- a/docs/reference/pygtk-gdkpixbuf.xml
+++ /dev/null
@@ -1,2915 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkpixbuf">
- <refnamediv>
- <refname>gtk.gdk.Pixbuf</refname>
- <refpurpose>an object containing a client side image.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Pixbuf</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkpixbuf">gtk.gdk.Pixbuf</link></methodname>
- <methodparam><parameter
- role="keyword">colorspace</parameter></methodparam>
- <methodparam><parameter
- role="keyword">has_alpha</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bits_per_sample</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--render-to-drawable">render_to_drawable</link></methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dither</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x_dither</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_dither</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--render-to-drawable-alpha">render_to_drawable_alpha</link></methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">alpha_mode</parameter></methodparam>
- <methodparam><parameter
- role="keyword">alpha_threshold</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dither</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x_dither</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_dither</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--render-pixmap-and-mask">render_pixmap_and_mask</link></methodname>
- <methodparam><parameter
- role="keyword">alpha_threshold</parameter><initializer>127</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--get-from-drawable">get_from_drawable</link></methodname>
- <methodparam><parameter role="keyword">src</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--get-from-image">get_from_image</link></methodname>
- <methodparam><parameter role="keyword">src</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--get-colorspace">get_colorspace</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--get-n-channels">get_n_channels</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--get-has-alpha">get_has_alpha</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--get-bits-per-sample">get_bits_per_sample</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--get-pixels">get_pixels</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--get-width">get_width</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--get-height">get_height</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--get-rowstride">get_rowstride</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--get-option">get_option</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--fill">fill</link></methodname>
- <methodparam><parameter
- role="keyword">pixel</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--save">save</link></methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">options</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkpixbuf- -savev">savev</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- <methodparam><parameter role="keyword">option_keys</parameter></methodparam>
- <methodparam><parameter role="keyword">option_values</parameter></methodparam>
- <methodparam><parameter role="keyword">error</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--save-to-callback">save_to_callback</link></methodname>
- <methodparam><parameter
- role="keyword">save_func</parameter></methodparam>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">options</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--add-alpha">add_alpha</link></methodname>
- <methodparam><parameter
- role="keyword">substitute_color</parameter></methodparam>
- <methodparam><parameter role="keyword">r</parameter></methodparam>
- <methodparam><parameter role="keyword">g</parameter></methodparam>
- <methodparam><parameter role="keyword">b</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--copy-area">copy_area</link></methodname>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_pixbuf</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--saturate-and-pixelate">saturate_and_pixelate</link></methodname>
- <methodparam><parameter
- role="keyword">dest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">saturation</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixelate</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--scale">scale</link></methodname>
- <methodparam><parameter
- role="keyword">dest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interp_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--composite">composite</link></methodname>
- <methodparam><parameter
- role="keyword">dest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interp_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">overall_alpha</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--composite-color">composite_color</link></methodname>
- <methodparam><parameter
- role="keyword">dest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interp_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">overall_alpha</parameter></methodparam>
- <methodparam><parameter
- role="keyword">check_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">check_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">check_size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color1</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color2</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--scale-simple">scale_simple</link></methodname>
- <methodparam><parameter
- role="keyword">dest_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interp_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--composite-color-simple">composite_color_simple</link></methodname>
- <methodparam><parameter
- role="keyword">dest_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interp_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">overall_alpha</parameter></methodparam>
- <methodparam><parameter
- role="keyword">check_size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color1</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color2</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkpixbuf--get-pixels-array">get_pixels_array</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--subpixbuf">subpixbuf</link></methodname>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbuf--rotate-simple">rotate_simple</link></methodname>
- <methodparam><parameter
- role="keyword">angle</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-file">gtk.gdk.pixbuf_new_from_file</link></methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-file-at-size">gtk.gdk.pixbuf_new_from_file_at_size</link></methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-data">gtk.gdk.pixbuf_new_from_data</link></methodname>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">colorspace</parameter></methodparam>
- <methodparam><parameter
- role="keyword">has_alpha</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bits_per_sample</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">rowstride</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-array">gtk.gdk.pixbuf_new_from_array</link></methodname>
- <methodparam><parameter
- role="keyword">array</parameter></methodparam>
- <methodparam><parameter
- role="keyword">colorspace</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bits_per_sample</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-xpm-data">gtk.gdk.pixbuf_new_from_xpm_data</link></methodname>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-new-from-inline">gtk.gdk.pixbuf_new_from_inline</link></methodname>
- <methodparam><parameter
- role="keyword">data_length</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">copy_pixels</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-get-formats">gtk.gdk.pixbuf_get_formats</link></methodname>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixbuf-get-file-info">gtk.gdk.pixbuf_get_file_info</link></methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkpixbuf">gtk.gdk.Pixbuf</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"pixel_array"</entry>
- <entry>Read</entry>
- <entry>A numeric array containing the pixel values of the
-<link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>. The
-contents of the numeric array can be changed even though the array is
-read-only. However you cannot change the pixel data of pixbufs that are
-backed by a const string such as stock icon pixbufs.
-<literal>PyGTK</literal> must be compiled with Numeric Python support for
-this to work.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"bits-per-sample"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The number of bits per sample. Available in GTK+ 2.4
-and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"colorspace"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The colorspace in which the samples are interpreted.Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"has-alpha"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>If <literal>True</literal>,the pixbuf has an alpha
-channel. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"height"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The number of rows of the pixbuf. Available in GTK+ 2.4
-and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"n-channels"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The number of samples per pixel. Available in GTK+ 2.4
-and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>A pointer to the pixel data of the pixbuf. Available
-in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"rowstride"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The number of bytes between the start of a row and
-the start of the next row. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"width"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The number of columns of the pixbuf. Available in GTK+ 2.4
-and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-object contains the data that describes an image using client side
-resources. By contrast a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> uses
-server side resources to hold image data. Manipulating the image data in a
-<link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-may involve round trip transfers between a client and a server in X11 while
-manipulating image data in a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-involves only client side operations. Therefore using <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-objects may be more efficient than using <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-objects if a lot of image manipulation is necessary.</para>
-
- <para>In addition to the methods associated with a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-object there are a number of functions that can be used to create <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-objects from file and inline data.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkpixbuf">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Pixbuf</methodname>
- <methodparam><parameter
- role="keyword">colorspace</parameter></methodparam>
- <methodparam><parameter
- role="keyword">has_alpha</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bits_per_sample</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">colorspace</parameter>&nbsp;:</term>
- <listitem><simpara>the color space for the image - currently only
-<literal>gtk.gdk.COLORSPACE_RGB</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">has_alpha</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the image will have
-transparency information.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">bits_per_sample</parameter>&nbsp;:</term>
- <listitem><simpara>the number of bits per color sample - currently
-must be 8.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of image in
-pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of image in
-pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a newly-created <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-structure and allocates a buffer for it. The buffer has an optimal
-rowstride. Note that the buffer is not cleared; you will have to fill it
-completely yourself. The size of the image is specified by
-<parameter>width</parameter> and <parameter>height</parameter>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkpixbuf--render-to-drawable">
- <title>gtk.gdk.Pixbuf.render_to_drawable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>render_to_drawable</methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dither</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x_dither</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_dither</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">drawable</parameter>&nbsp;:</term>
- <listitem><simpara>the destination <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> used for
-rendering.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate within the
-pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate within the
-pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate within
-<parameter>drawable</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate within
-<parameter>drawable</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of region to render, in pixels, or -1
-to use pixbuf width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of region to render, in pixels, or
--1 to use pixbuf height</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dither</parameter>&nbsp;:</term>
- <listitem><simpara>the dithering mode.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x_dither</parameter>&nbsp;:</term>
- <listitem><simpara>the X offset for
-dithering.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y_dither</parameter>&nbsp;:</term>
- <listitem><simpara>the Y offset for
-dithering.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.2 and above. Use the
-<link
-linkend="method-gdkdrawable--draw-pixbuf"><methodname>gtk.gdk.Drawable.draw_pixbuf</methodname>()</link>
-method instead.</para>
- </warning>
-
- <para>The <methodname>render_to_drawable</methodname>() method renders
-a rectangular portion of the pixbuf to a <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-specified by <parameter>drawable</parameter> while using the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> specified by
-<parameter>gc</parameter>. This is done using GdkRGB, so the specified
-drawable must have the GdkRGB visual and colormap. Note that this method
-will ignore the opacity information for images with an alpha channel; the
-<link linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> must
-already have the clipping mask set if you want transparent regions to show
-through.</para>
-
- <para>The dither offset is important when re-rendering partial regions
-of an image to a rendered version of the full image, or when the offsets to
-a base position change, as in scrolling. The dither matrix has to be shifted
-for consistent visual results. If you do not have any of these cases, the
-dither offsets can be both zero.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--render-to-drawable-alpha">
- <title>gtk.gdk.Pixbuf.render_to_drawable_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>render_to_drawable_alpha</methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">alpha_mode</parameter></methodparam>
- <methodparam><parameter
- role="keyword">alpha_threshold</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dither</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x_dither</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y_dither</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">drawable</parameter>&nbsp;:</term>
- <listitem><simpara>the destination <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">gc</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> used for
-rendering.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate within the
-pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate within the
-pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate within
-<parameter>drawable</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate within
-<parameter>drawable</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of region to render, in pixels, or -1
-to use pixbuf width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of region to render, in pixels, or
--1 to use pixbuf height</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">alpha_mode</parameter>&nbsp;:</term>
- <listitem><simpara>Ignored. Present for backward
-compatibility.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">alpha_threshold</parameter>&nbsp;:</term>
- <listitem><simpara>Ignored. Present for backward
-compatibility</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dither</parameter>&nbsp;:</term>
- <listitem><simpara>the dithering mode.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x_dither</parameter>&nbsp;:</term>
- <listitem><simpara>the X offset for
-dithering.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y_dither</parameter>&nbsp;:</term>
- <listitem><simpara>the Y offset for
-dithering.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.2 and above. Use the
-<link
-linkend="method-gdkdrawable--draw-pixbuf"><methodname>gtk.gdk.Drawable.draw_pixbuf</methodname>()</link>
-method instead.</para>
- </warning>
-
- <para>The <methodname>render_to_drawable_alpha</methodname>() method
-renders a rectangular portion of the pixbuf to a <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-specified by <parameter>drawable</parameter>.
-<parameter>drawable</parameter> must have a colormap. All windows have a
-colormap; however, pixmaps only have colormap by default if they were
-created with a window argument.specifying a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.
-Otherwise a colormap must be set on them with the <link
-linkend="method-gdkdrawable--set-colormap"><methodname>gtk.gdk.Drawable.set_colormap</methodname>()</link>
-method. On older X servers, rendering pixbufs with an alpha channel involves
-round trips to the X server, and may be somewhat slow.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--render-pixmap-and-mask">
- <title>gtk.gdk.Pixbuf.render_pixmap_and_mask</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>render_pixmap_and_mask</methodname>
- <methodparam><parameter
- role="keyword">alpha_threshold</parameter><initializer>127</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">alpha_threshold</parameter>&nbsp;:</term>
- <listitem><simpara>the threshold value for opacity
-values.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the created pixmap and
-mask.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>render_to_pixmap_and_mask</methodname>() method
-returns a tuple containing a pixmap and a mask bitmap that the pixbuf and
-its corresponding thresholded alpha mask are rendered to. This is merely a
-convenience method; applications that need to render pixbufs with dither
-offsets or to specific drawables should use the <link
-linkend="method-gdkpixbuf--render-to-drawable-alpha"><methodname>render_to_drawable_alpha</methodname>()</link>
-or <link
-linkend="method-gdkpixbuf--render-to-drawable"><methodname>render_to_drawable</methodname>()</link>
-methods. If the pixbuf does not have an alpha channel, then the mask
-returned will be None.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-from-drawable">
- <title>gtk.gdk.Pixbuf.get_from_drawable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_from_drawable</methodname>
- <methodparam><parameter
- role="keyword">src</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">src</parameter>&nbsp;:</term>
- <listitem><simpara>the source <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">cmap</parameter>&nbsp;:</term>
- <listitem><simpara>a colormap if <parameter>src</parameter>
-doesn't have one set.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate within
-<parameter>drawable</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate within
-<parameter>drawable</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate in the
-pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate in the
-pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width in pixels of the region to
-get.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height in pixels of the region to
-get.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the pixbuf or <literal>None</literal> on
-error</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_from_drawable</methodname>() method
-transfers image data from the <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-specified by <parameter>src</parameter> and converts it to an RGB(A)
-representation inside a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>. In
-other words, copies image data from a server-side drawable to a client-side
-RGB(A) buffer. This allows you to efficiently read individual pixels on the
-client side. If <parameter>src</parameter> has no colormap (the <link
-linkend="method-gdkdrawable--get-colormap"><methodname>gtk.gdk.Drawable.get_colormap</methodname>()</link>
-method returns <literal>None</literal>), then a suitable colormap must be
-specified as <parameter>cmap</parameter>. Typically a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> or a
-pixmap created by passing a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> to
-<function>gtk.gdk.Pixmap()</function> will already have a colormap
-associated with it. If <parameter>src</parameter> has a colormap, the
-<parameter>cmap</parameter> argument will be ignored. If
-<parameter>src</parameter> is a bitmap (1 bit per pixel pixmap), then a
-colormap is not required; pixels with a value of 1 are assumed to be white,
-and pixels with a value of 0 are assumed to be black. For taking
-screenshots, the <link
-linkend="function-gdk--colormap-get-system"><methodname>gtk.gdk.colormap_get_system</methodname>()</link>
-function returns the correct colormap to use.</para>
-
- <para>If <parameter>src</parameter> is a pixmap, then the requested
-source rectangle must be completely contained within the pixmap, otherwise
-the function will return <literal>None</literal>. For pixmaps only (not for
-windows) passing -1 for <parameter>width</parameter> or
-<parameter>height</parameter> is allowed to mean the full width or height of
-the pixmap. If <parameter>src</parameter> is a window, and the window
-is off the screen, then there is no image data in the obscured/offscreen
-regions to be placed in the pixbuf. The contents of portions of the pixbuf
-corresponding to the offscreen region are undefined.</para>
-
- <para>If the window you're obtaining data from is partially obscured
-by other windows, then the contents of the pixbuf areas corresponding to the
-obscured regions are undefined. If the target drawable is not mapped
-(typically because it's iconified/minimized or not on the current
-workspace), <literal>None</literal> will be returned. If memory can't be
-allocated for the return value, <literal>None</literal> will be returned
-instead. (In short, there are several ways this method can fail, and if it
-fails it returns <literal>None</literal>; so check the return value.)</para>
-
- <para>This method calls the <link
-linkend="method-gdkdrawable--get-image"><methodname>gtk.gdk.Drawable.get_image</methodname>()</link>
-method internally and converts the resulting image to a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>, so
-the documentation for the <link
-linkend="method-gdkdrawable--get-image"><methodname>gtk.gdk.Drawable.get_image</methodname>()</link>
-method may also be helpful.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-from-image">
- <title>gtk.gdk.Pixbuf.get_from_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_from_image</methodname>
- <methodparam><parameter
- role="keyword">src</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">src</parameter>&nbsp;:</term>
- <listitem><simpara>the source <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">cmap</parameter>&nbsp;:</term>
- <listitem><simpara>a colormap if <parameter>src</parameter>
-doesn't have one set or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate within
-<parameter>src</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate within
-<parameter>src</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate in the
-pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate in the
-pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width in pixels of the region to
-get.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height in pixels of the region to
-get.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the pixbuf or <literal>None</literal> on
-error</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_from_image</methodname>() method is the same
-as the <link
-linkend="method-gdkpixbuf--get-from-drawable"><methodname>get_from_drawable</methodname>()</link>
-method but gets the pixbuf from the <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
-specified by <parameter>src</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-colorspace">
- <title>gtk.gdk.Pixbuf.get_colorspace</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_colorspace</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the color space.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_colorspace</methodname>() method returns the
-color space of the pixbuf.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-n-channels">
- <title>gtk.gdk.Pixbuf.get_n_channels</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_channels</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of channels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_n_channels</methodname>() method returns the
-number of channels of a pixbuf.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-has-alpha">
- <title>gtk.gdk.Pixbuf.get_has_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_has_alpha</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the pixbuf has an
-alpha channel.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_has_alpha</methodname>() method returns
-<literal>True</literal> if the pixbuf has an alpha channel (opacity
-information).</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-bits-per-sample">
- <title>gtk.gdk.Pixbuf.get_bits_per_sample</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_bits_per_sample</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of bits per color
-sample.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_bits_per_sample</methodname>() method returns
-the number of bits per color sample in a pixbuf.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-pixels">
- <title>gtk.gdk.Pixbuf.get_pixels</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixels</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the pixel data of the
-pixbuf</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixels</methodname>() method returns a sting
-containing the pixel data of the pixbuf.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-width">
- <title>gtk.gdk.Pixbuf.get_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the width in pixels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_width</methodname>() method returns the
-width of the pixbuf.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-height">
- <title>gtk.gdk.Pixbuf.get_height</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_height</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the height in pixels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_height</methodname>() method returns the
-height of the pixbuf.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-rowstride">
- <title>gtk.gdk.Pixbuf.get_rowstride</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_rowstride</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of bytes between
-rows.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_rowstride</methodname>() method returns the
-rowstride of a pixbuf, which is the number of bytes between rows.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-option">
- <title>gtk.gdk.Pixbuf.get_option</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_option</methodname>
- <methodparam><parameter
- role="keyword">key</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the value associated with
-<parameter>key</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_option</methodname>() method looks up
-<parameter>key</parameter> in the list of options that may have been
-attached to the pixbuf when it was loaded.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--copy">
- <title>gtk.gdk.Pixbuf.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A newly-created pixbuf or
-<literal>None</literal> if not enough memory could be
-allocated.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns a new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> with
-a copy of the data in the pixbuf.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--fill">
- <title>gtk.gdk.Pixbuf.fill</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>fill</methodname>
- <methodparam><parameter
- role="keyword">pixel</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixel</parameter>&nbsp;:</term>
- <listitem><simpara>the RGBA pixel to clear to (0xffffffff is
-opaque white, 0x00000000 transparent black)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>fill</methodname>() method clears the pixbuf to
-the RGBA value specified by <parameter>pixel</parameter>, converting the
-RGBA value into the pixbuf's pixel format. The alpha will be ignored if the
-pixbuf doesn't have an alpha channel.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--save">
- <title>gtk.gdk.Pixbuf.save</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>save</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter role="keyword">options</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the name of file to save.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the file
-format.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">options</parameter>&nbsp;:</term>
- <listitem><simpara>a Python dict containing key-value string pairs
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>save</methodname>() method saves the pixbuf to a
-file in the format specified by <parameter>type</parameter>, which may be
-"jpeg" or "png". If <parameter>options</parameter> is not
-<literal>None</literal> it should be a Python dict containing key-value
-string pairs that modify the save parameters. For example:</para>
-
-<informalexample><programlisting>
- pixbuf.save(filename, "jpeg", {"quality":"100"})
-</programlisting></informalexample>
-
- <para>Currently only a few parameters exist. JPEG images can be saved
-with a "quality" parameter; its value should be in the range [0,100]. Text
-chunks can be attached to PNG images by specifying parameters of the form
-"tEXt::key", where key is an ASCII string of length 1-79. Note however that
-PNG text chunks are stored in ISO-8859-1 encoding, so you can only set texts
-that can be represented in this encoding. The values are UTF-8 encoded
-strings. ICO images can be saved in depth 16, 24, or 32, by using the
-"depth" parameter. When the ICO saver is given "x_hot" and "y_hot"
-parameters, it produces a CUR instead of an ICO.</para>
-
- <para>This method raises the GError exception if an error occurs
-during the save operation.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gdkpixbuf- -savev">
- <title>gtk.gdk.Pixbuf.savev</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>savev</methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- <methodparam><parameter role="keyword">option_keys</parameter></methodparam>
- <methodparam><parameter role="keyword">option_values</parameter></methodparam>
- <methodparam><parameter role="keyword">error</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>name of file to save.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>name of file format.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">option_keys</parameter>&nbsp;:</term>
- <listitem><simpara>name of options to set, <literal>NULL</literal>-terminated</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">option_values</parameter>&nbsp;:</term>
- <listitem><simpara>values for named options</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">error</parameter>&nbsp;:</term>
- <listitem><simpara>return location for error, or <literal>NULL</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>whether an error was set</simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-Saves pixbuf to a file in <parameter>type</parameter>, which is currently "jpeg" or "png".
-If <parameter>error</parameter> is set, <literal>False</literal> will be returned. See <link linkend="method-gdkpixbuf- -save"><function>gtk.gdk.Pixbuf.save()</function></link> for more
-details.
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gdkpixbuf--save-to-callback">
- <title>gtk.gdk.Pixbuf.save_to_callback</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>save_to_callback</methodname>
- <methodparam><parameter
- role="keyword">save_func</parameter></methodparam>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">options</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">save_func</parameter>&nbsp;:</term>
- <listitem><simpara> a function that is called to save each block
-of data that the save routine generates.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the file
-format.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">options</parameter>&nbsp;:</term>
- <listitem><simpara>a Python dict containing key-value string pairs
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user-specified data passed to
-<literal>save_func</literal> or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method was available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>save_to_callback</methodname>() method saves the
-pixbuf in the format specified by <parameter>type</parameter> by feeding the
-pixbuf data to the callback function specified by
-<parameter>save_func</parameter>. <parameter>type</parameter> may be "jpeg",
-"png" or "ico" or other installed formats. If <parameter>options</parameter>
-is not <literal>None</literal> it should be a Python dict containing
-key-value string pairs that modify the save parameters. For example:</para>
-
-<informalexample><programlisting>
- pixbuf.save_to_callback(func, "jpeg", {"quality":"100"})
-</programlisting></informalexample>
-
- <para>See the <link
-linkend="method-gdkpixbuf--save"><methodname>save</methodname>()</link>
-method for more information on formats. If <parameter>user_data</parameter>
-is not None it is passed to <parameter>save_func</parameter> with each
-invocation.</para>
-
- <para>This method raises a GError exception or exceptions raised by
-<parameter>save_func</parameter> if an error occurs during the save
-operation.</para>
-
- <para>The signature of <parameter>save_func</parameter> is:</para>
-
- <programlisting>
-def pixbuf_save_func(buf, data=None):
-</programlisting>
-
- <para>where <parameter>buf</parameter> is a Python string containing
-the pixbuf data and <parameter>data</parameter> is
-<parameter>user_data</parameter>. <parameter>pixbuf_save_func</parameter>
-returns <literal>True</literal> if successful or <literal>False</literal> on
-failure.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--add-alpha">
- <title>gtk.gdk.Pixbuf.add_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_alpha</methodname>
- <methodparam><parameter
- role="keyword">substitute_color</parameter></methodparam>
- <methodparam><parameter role="keyword">r</parameter></methodparam>
- <methodparam><parameter role="keyword">g</parameter></methodparam>
- <methodparam><parameter role="keyword">b</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">substitute_color</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>False</literal>, the
-(<parameter>r</parameter>, <parameter>g</parameter>,
-<parameter>b</parameter>) arguments will be ignored.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">r</parameter>&nbsp;:</term>
- <listitem><simpara>the red value to
-substitute.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">g</parameter>&nbsp;:</term>
- <listitem><simpara>the green value to
-substitute.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">b</parameter>&nbsp;:</term>
- <listitem><simpara>the blue value to
-substitute.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_alpha</methodname>() method returns a new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-created from the pixbuf with an alpha channel added. If the pixbuf already
-had an alpha channel, the channel values are copied; otherwise, the alpha
-channel is initialized to 255 (full opacity).</para>
-
- <para>If <parameter>substitute_color</parameter> is
-<literal>True</literal>, then the color specified by
-(<parameter>r</parameter>, <parameter>g</parameter>,
-<parameter>b</parameter>) will be assigned zero opacity. That is, if you
-pass (255, 255, 255) for the substitute color, all white pixels will become
-fully transparent.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--copy-area">
- <title>gtk.gdk.Pixbuf.copy_area</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy_area</methodname>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_pixbuf</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">src_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate within the
-pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate within the
-pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the area to
-copy.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the area to
-copy.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">dest_pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>the destination pixbuf.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate within
-<parameter>dest_pixbuf</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate within
-<parameter>dest_pixbuf</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy_area</methodname>() method copies a
-rectangular area from the pixbuf to the destination <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-specified by <parameter>dest_pixbuf</parameter>. Conversion of pixbuf
-formats is done automatically.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--saturate-and-pixelate">
- <title>gtk.gdk.Pixbuf.saturate_and_pixelate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>saturate_and_pixelate</methodname>
- <methodparam><parameter
- role="keyword">dest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">saturation</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixelate</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dest</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> to
-write the modified version of the pixbuf</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">saturation</parameter>&nbsp;:</term>
- <listitem><simpara>the saturation factor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixelate</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> pixelate
-<parameter>dest</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>saturate_and_pixelate</methodname>() method
-modifies the saturation and optionally pixelates the pixbuf, placing the
-result in <parameter>dest</parameter>. the pixbuf and
-<parameter>dest</parameter> may be the same <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> with
-no ill effects. If <parameter>saturation</parameter> is 1.0 then saturation
-is not changed. If it's less than 1.0, saturation is reduced (the image is
-darkened); if greater than 1.0, saturation is increased (the image is
-brightened). If <parameter>pixelate</parameter> is <literal>True</literal>,
-then pixels are faded in a checkerboard pattern to create a pixelated image.
-The pixbuf and <parameter>dest</parameter> must have the same image format,
-size, and rowstride.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--scale">
- <title>gtk.gdk.Pixbuf.scale</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>scale</methodname>
- <methodparam><parameter
- role="keyword">dest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interp_type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dest</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> the
-scaling is rendered to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate for the
-rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate for the
-rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">dest_width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">dest_height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the
-rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_x</parameter>&nbsp;:</term>
- <listitem><simpara>the offset in the X direction (currently
-rounded to an integer)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_y</parameter>&nbsp;:</term>
- <listitem><simpara>the offset in the Y direction (currently
-rounded to an integer)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">scale_x</parameter>&nbsp;:</term>
- <listitem><simpara>the scale factor in the X
-direction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">scale_y</parameter>&nbsp;:</term>
- <listitem><simpara>the scale factor in the Y
-direction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">interp_type</parameter>&nbsp;:</term>
- <listitem><simpara>the interpolation type for the
-transformation.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>scale</methodname>() method creates a
-transformation of the pixbuf's image by scaling by
-<parameter>scale_x</parameter> and <parameter>scale_y</parameter> and
-translating by <parameter>offset_x</parameter> and
-<parameter>offset_y</parameter> it, then rendering the rectangle
-(<parameter>dest_x</parameter>, <parameter>dest_y</parameter>,
-<parameter>dest_width</parameter>, <parameter>dest_height</parameter>) of
-the resulting image onto the destination image specified by
-<parameter>dest</parameter> replacing the previous contents. The value of
-<parameter>interp_type</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_NEAREST</literal></term>
- <listitem>
- <simpara>Nearest neighbor sampling; this is the fastest and
-lowest quality mode. Quality is normally unacceptable when scaling down, but
-may be OK when scaling up.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_TILES</literal></term>
- <listitem>
- <simpara>This is an accurate simulation of the PostScript image
-operator without any interpolation enabled. Each pixel is rendered as a tiny
-parallelogram of solid color, the edges of which are implemented with
-antialiasing. It resembles nearest neighbor for enlargement, and bilinear
-for reduction.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_BILINEAR</literal></term>
- <listitem>
- <simpara>Best quality/speed balance; use this mode by default.
-Bilinear interpolation. For enlargement, it is equivalent to point-sampling
-the ideal bilinear-interpolated image. For reduction, it is equivalent to
-laying down small tiles and integrating over the coverage area.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_HYPER</literal></term>
- <listitem>
- <simpara>This is the slowest and highest quality reconstruction
-function. It is derived from the hyperbolic filters in Wolberg's "Digital
-Image Warping", and is formally defined as the hyperbolic-filter sampling
-the ideal hyperbolic-filter interpolated image (the filter is designed to be
-idempotent for 1:1 pixel mapping).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>Try the <link
-linkend="method-gdkpixbuf--scale-simple"><methodname>scale_simple</methodname>()</link>
-method as an alternative with a simpler interface.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--composite">
- <title>gtk.gdk.Pixbuf.composite</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>composite</methodname>
- <methodparam><parameter
- role="keyword">dest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interp_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">overall_alpha</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dest</parameter>&nbsp;:</term>
- <listitem><simpara>the output <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate for the
-rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_y</parameter>&nbsp;:</term>
- <listitem><simpara>the top coordinate for the
-rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">dest_width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">dest_height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the
-rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_x</parameter>&nbsp;:</term>
- <listitem><simpara>the offset in the X direction (currently
-rounded to an integer)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_y</parameter>&nbsp;:</term>
- <listitem><simpara>the offset in the Y direction (currently
-rounded to an integer)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">scale_x</parameter>&nbsp;:</term>
- <listitem><simpara>the scale factor in the X
-direction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">scale_y</parameter>&nbsp;:</term>
- <listitem><simpara>the scale factor in the Y
-direction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">interp_type</parameter>&nbsp;:</term>
- <listitem><simpara>the interpolation type for the
-transformation.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">overall_alpha</parameter>&nbsp;:</term>
- <listitem><simpara>overall alpha for source image
-(0..255)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>composite</methodname>() method creates a
-transformation of the pixbuf's image by scaling by
-<parameter>scale_x</parameter> and <parameter>scale_y</parameter> and
-translating by <parameter>offset_x</parameter> and
-<parameter>offset_y</parameter>, then compositing the rectangle
-(<parameter>dest_x</parameter>, <parameter>dest_y</parameter>,
-<parameter>dest_width</parameter>, <parameter>dest_height</parameter>) of
-the resulting image onto the destination image. The value of
-<parameter>interp_type</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_NEAREST</literal></term>
- <listitem>
- <simpara>Nearest neighbor sampling; this is the fastest and
-lowest quality mode. Quality is normally unacceptable when scaling down, but
-may be OK when scaling up.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_TILES</literal></term>
- <listitem>
- <simpara>This is an accurate simulation of the PostScript image
-operator without any interpolation enabled. Each pixel is rendered as a tiny
-parallelogram of solid color, the edges of which are implemented with
-antialiasing. It resembles nearest neighbor for enlargement, and bilinear
-for reduction.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_BILINEAR</literal></term>
- <listitem>
- <simpara>Best quality/speed balance; use this mode by default.
-Bilinear interpolation. For enlargement, it is equivalent to point-sampling
-the ideal bilinear-interpolated image. For reduction, it is equivalent to
-laying down small tiles and integrating over the coverage area.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_HYPER</literal></term>
- <listitem>
- <simpara>This is the slowest and highest quality reconstruction
-function. It is derived from the hyperbolic filters in Wolberg's "Digital
-Image Warping", and is formally defined as the hyperbolic-filter sampling
-the ideal hyperbolic-filter interpolated image (the filter is designed to be
-idempotent for 1:1 pixel mapping).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--composite-color">
- <title>gtk.gdk.Pixbuf.composite_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>composite_color</methodname>
- <methodparam><parameter
- role="keyword">dest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">scale_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interp_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">overall_alpha</parameter></methodparam>
- <methodparam><parameter
- role="keyword">check_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">check_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">check_size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color1</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color2</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dest</parameter>&nbsp;:</term>
- <listitem><simpara>the output <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate for the
-rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dest_y</parameter>&nbsp;:</term>
- <listitem><simpara>the top coordinate for the
-rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">dest_width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">dest_height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the
-rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_x</parameter>&nbsp;:</term>
- <listitem><simpara>the offset in the X direction (currently
-rounded to an integer)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_y</parameter>&nbsp;:</term>
- <listitem><simpara>the offset in the Y direction (currently
-rounded to an integer)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">scale_x</parameter>&nbsp;:</term>
- <listitem><simpara>the scale factor in the X
-direction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">scale_y</parameter>&nbsp;:</term>
- <listitem><simpara>the scale factor in the Y
-direction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">interp_type</parameter>&nbsp;:</term>
- <listitem><simpara>the interpolation type for the
-transformation.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">overall_alpha</parameter>&nbsp;:</term>
- <listitem><simpara>overall alpha for source image
-(0..255)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">check_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X offset for the checkboard (origin of
-checkboard is at -<parameter>check_x</parameter>,
--<parameter>check_y</parameter>)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">check_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y offset for the
-checkboard</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">check_size</parameter>&nbsp;:</term>
- <listitem><simpara>the size of checks in the checkboard (must be a
-power of two)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">color1</parameter>&nbsp;:</term>
- <listitem><simpara>the color of check at upper
-left</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">color2</parameter>&nbsp;:</term>
- <listitem><simpara>the color of the other
-check</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>composite_color</methodname>() method creates a
-transformation of the source image <parameter>src</parameter> by scaling by
-<parameter>scale_x</parameter> and <parameter>scale_y</parameter> and
-translating by <parameter>offset_x</parameter> and
-<parameter>offset_y</parameter>, then compositing the rectangle
-(<parameter>dest_x</parameter> ,<parameter>dest_y</parameter>,
-<parameter>dest_width</parameter>, <parameter>dest_height</parameter>) of
-the resulting image with a checkboard of the colors
-<parameter>color1</parameter> and <parameter>color2</parameter> and renders
-it onto the destination image. The value of
-<parameter>interp_type</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_NEAREST</literal></term>
- <listitem>
- <simpara>Nearest neighbor sampling; this is the fastest and
-lowest quality mode. Quality is normally unacceptable when scaling down, but
-may be OK when scaling up.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_TILES</literal></term>
- <listitem>
- <simpara>This is an accurate simulation of the PostScript image
-operator without any interpolation enabled. Each pixel is rendered as a tiny
-parallelogram of solid color, the edges of which are implemented with
-antialiasing. It resembles nearest neighbor for enlargement, and bilinear
-for reduction.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_BILINEAR</literal></term>
- <listitem>
- <simpara>Best quality/speed balance; use this mode by default.
-Bilinear interpolation. For enlargement, it is equivalent to point-sampling
-the ideal bilinear-interpolated image. For reduction, it is equivalent to
-laying down small tiles and integrating over the coverage area.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_HYPER</literal></term>
- <listitem>
- <simpara>This is the slowest and highest quality reconstruction
-function. It is derived from the hyperbolic filters in Wolberg's "Digital
-Image Warping", and is formally defined as the hyperbolic-filter sampling
-the ideal hyperbolic-filter interpolated image (the filter is designed to be
-idempotent for 1:1 pixel mapping).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>See the <link
-linkend="method-gdkpixbuf--composite-color-simple"><methodname>composite_color_simple</methodname>()</link>
-method for a simpler variant of this method suitable for most tasks.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--scale-simple">
- <title>gtk.gdk.Pixbuf.scale_simple</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>scale_simple</methodname>
- <methodparam><parameter
- role="keyword">dest_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interp_type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">dest_width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of destination
-image</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">dest_height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of destination
-image</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">interp_type</parameter>&nbsp;:</term>
- <listitem><simpara>the interpolation type for the
-transformation.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>, or
-<literal>None</literal> if not enough memory could be allocated for
-it.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>scale_simple</methodname>() method returns a new
-<link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-containing a copy of the pixbuf scaled to <parameter>dest_width</parameter>
-x <parameter>dest_height</parameter>. The pixbuf is unaffected by the
-scaling operation. The value of <parameter>interp_type</parameter> must be
-one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_NEAREST</literal></term>
- <listitem>
- <simpara>Nearest neighbor sampling; this is the fastest and
-lowest quality mode. Quality is normally unacceptable when scaling down, but
-may be OK when scaling up.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_TILES</literal></term>
- <listitem>
- <simpara>This is an accurate simulation of the PostScript image
-operator without any interpolation enabled. Each pixel is rendered as a tiny
-parallelogram of solid color, the edges of which are implemented with
-antialiasing. It resembles nearest neighbor for enlargement, and bilinear
-for reduction.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_BILINEAR</literal></term>
- <listitem>
- <simpara>Best quality/speed balance; use this mode by default.
-Bilinear interpolation. For enlargement, it is equivalent to point-sampling
-the ideal bilinear-interpolated image. For reduction, it is equivalent to
-laying down small tiles and integrating over the coverage area.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_HYPER</literal></term>
- <listitem>
- <simpara>This is the slowest and highest quality reconstruction
-function. It is derived from the hyperbolic filters in Wolberg's "Digital
-Image Warping", and is formally defined as the hyperbolic-filter sampling
-the ideal hyperbolic-filter interpolated image (the filter is designed to be
-idempotent for 1:1 pixel mapping).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para><parameter>interp_type</parameter> should be
-<literal>gtk.gdk.INTERP_NEAREST</literal> if you want maximum speed (but
-when scaling down <literal>gtk.gdk.INTERP_NEAREST</literal> is usually
-unusably ugly). The default <parameter>interp_type</parameter> should be
-<literal>GDK_INTERP_BILINEAR</literal> which offers reasonable quality and
-speed.</para>
-
- <para>You can scale a sub-portion of <parameter>src</parameter> by
-creating a sub-pixbuf pointing into <parameter>src</parameter>; see the
-<link
-linkend="method-gdkpixbuf--subpixbuf"><methodname>subpixbuf</methodname>()</link>
-method for more information.</para>
-
- <para>For more complicated scaling/compositing see the <link
-linkend="method-gdkpixbuf--scale"><methodname>scale</methodname>()</link>
-and <link
-linkend="method-gdkpixbuf--composite"><methodname>composite</methodname>()</link>
-methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--composite-color-simple">
- <title>gtk.gdk.Pixbuf.composite_color_simple</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>composite_color_simple</methodname>
- <methodparam><parameter
- role="keyword">dest_width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dest_height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interp_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">overall_alpha</parameter></methodparam>
- <methodparam><parameter
- role="keyword">check_size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color1</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color2</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">dest_width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of destination
-image</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">dest_height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of destination
-image</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">interp_type</parameter>&nbsp;:</term>
- <listitem><simpara>the interpolation type for the
-transformation.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">overall_alpha</parameter>&nbsp;:</term>
- <listitem><simpara>overall alpha for source image
-(0..255)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">check_size</parameter>&nbsp;:</term>
- <listitem><simpara>the size of checks in the checkboard (must be a
-power of two)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">color1</parameter>&nbsp;:</term>
- <listitem><simpara>the color of check at upper
-left</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">color2</parameter>&nbsp;:</term>
- <listitem><simpara>the color of the other
-check</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>, or
-<literal>NULL</literal> if not enough memory could be allocated for
-it.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>composite_color_simple</methodname>() method
-returns a new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> by
-scaling the pixbuf to <parameter>dest_width</parameter> x
-<parameter>dest_height</parameter> and compositing the result with a
-checkboard of colors <parameter>color1</parameter> and
-<parameter>color2</parameter>. The value of <parameter>interp_type</parameter> must be
-one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_NEAREST</literal></term>
- <listitem>
- <simpara>Nearest neighbor sampling; this is the fastest and
-lowest quality mode. Quality is normally unacceptable when scaling down, but
-may be OK when scaling up.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_TILES</literal></term>
- <listitem>
- <simpara>This is an accurate simulation of the PostScript image
-operator without any interpolation enabled. Each pixel is rendered as a tiny
-parallelogram of solid color, the edges of which are implemented with
-antialiasing. It resembles nearest neighbor for enlargement, and bilinear
-for reduction.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_BILINEAR</literal></term>
- <listitem>
- <simpara>Best quality/speed balance; use this mode by default.
-Bilinear interpolation. For enlargement, it is equivalent to point-sampling
-the ideal bilinear-interpolated image. For reduction, it is equivalent to
-laying down small tiles and integrating over the coverage area.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.INTERP_HYPER</literal></term>
- <listitem>
- <simpara>This is the slowest and highest quality reconstruction
-function. It is derived from the hyperbolic filters in Wolberg's "Digital
-Image Warping", and is formally defined as the hyperbolic-filter sampling
-the ideal hyperbolic-filter interpolated image (the filter is designed to be
-idempotent for 1:1 pixel mapping).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>See the <link
-linkend="method-gdkpixbuf--composite-color"><methodname>composite_color</methodname>()</link>
-method for a more powerful but complicated interface.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--get-pixels-array">
- <title>gtk.gdk.Pixbuf.get_pixels_array</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixels_array</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a Numeric Python array containing the pixel
- data of the pixbuf</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_pixels_array</methodname>() method returns a
-Numeric Python array containing the pixel data of the pixbuf.</para>
-
- <note>
- <para>PyGTK must be compiled with Numeric Python support for this
-method to be available.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--subpixbuf">
- <title>gtk.gdk.Pixbuf.subpixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>subpixbuf</methodname>
- <methodparam><parameter role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter role="keyword">src_y</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">src_x</parameter>&nbsp;:</term>
- <listitem><simpara>X coord in the pixbuf</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_y</parameter>&nbsp;:</term>
- <listitem><simpara>Y coord in the pixbuf</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>width of region in the pixbuf</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>height of region in the pixbuf</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>subpixbuf</methodname>() method creates a new
-<link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-that represents a sub-region of the pixbuf. The new pixbuf shares its pixels
-with the original pixbuf, so writing to one affects both.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbuf--rotate-simple">
- <title>gtk.gdk.Pixbuf.rotate_simple</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>rotate_simple</methodname>
- <methodparam><parameter role="keyword">angle</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">angle</parameter>&nbsp;:</term>
- <listitem><simpara>the rotation angle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>rotate_simple</methodname>() method creates a
- new <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
- by roatating the given pixbuf by a multiple of 90 degrees as specified
- by <parameter>angle</parameter> which is one of the <xref
- linkend="gdk-pixbuf-rotation-constants"
- endterm="gdk-pixbuf-rotation-constants-title"></xref></para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--pixbuf-new-from-file">
- <title>gtk.gdk.pixbuf_new_from_file</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixbuf_new_from_file</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the file containing the image to
-load</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pixbuf_new_from_file</function>() function
-returns a new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-containing an image loaded from the file specified by
-<parameter>filename</parameter>. The image file format is detected
-automatically. The application will block until the image is done loading.
-This method can be used by applications in which blocking is acceptable
-while an image is being loaded (small images in general). Applications that
-need progressive loading should use <link
-linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname></link>
-instead.</para>
-
- <para>This function raises the GError exception if an error occurs
-during the loading of the pixbuf.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixbuf-new-from-file-at-size">
- <title>gtk.gdk.pixbuf_new_from_file_at_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixbuf_new_from_file_at_size</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the file containing the image to
-load</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara> The width the image should
- have</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara> The height the image should
- have</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.pixbuf_new_from_file_at_size</function>()
-function returns a new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-containing an image loaded from the file specified by
-<parameter>filename</parameter> with it scaled to the size specified by
-<parameter>width</parameter> and <parameter>height</parameter>. The image
-file format is detected automatically. The application will block until the
-image is done loading. This function can be used by applications in which
-blocking is acceptable while an image is being loaded (small images in
-general). Applications that need progressive loading should use a <link
-linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname></link>
-instead.</para>
-
- <para>This function raises the GError exception if an error occurs
-during the loading of the pixbuf.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixbuf-new-from-data">
- <title>gtk.gdk.pixbuf_new_from_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixbuf_new_from_data</methodname>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">colorspace</parameter></methodparam>
- <methodparam><parameter
- role="keyword">has_alpha</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bits_per_sample</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">rowstride</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing image data in 8-bit/sample
- packed format.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">colorspace</parameter>&nbsp;:</term>
- <listitem><simpara>the colorspace for the image
- data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">has_alpha</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal>, the data has an
- opacity channel.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">bits_per_sample</parameter>&nbsp;:</term>
- <listitem><simpara>the number of bits per
- sample.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the image in pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the image in pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">rowstride</parameter>&nbsp;:</term>
- <listitem><simpara>the distance in bytes between row
- starts.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.pixbuf_new_from_data</function>() function
-returns a new pixbuf created from the string specified by
-<parameter>data</parameter>. <parameter>data</parameter> must be RGB image
-data with 8 bits per sample. <parameter>colorspace</parameter> must be
-<literal>gtk.gdk.COLORSPACE_RGB</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixbuf-new-from-array">
- <title>gtk.gdk.pixbuf_new_from_array</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixbuf_new_from_array</methodname>
- <methodparam><parameter
- role="keyword">array</parameter></methodparam>
- <methodparam><parameter
- role="keyword">colorspace</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bits_per_sample</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">array</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing image data in 8-bit/sample
- packed format.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">colorspace</parameter>&nbsp;:</term>
- <listitem><simpara>the colorspace for the image
- data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">bits_per_sample</parameter>&nbsp;:</term>
- <listitem><simpara>the number of bits per
- sample.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.pixbuf_new_from_array</function>()
-function returns a new pixbuf created from the Numeric Python array
-specified by <parameter>array</parameter>. <parameter>array</parameter> must
-be a 3 or 4 dimensional array (4 if the image has an alpha channel) with
-<parameter>bits_per_sample</parameter> bits per sample.
-<parameter>colorspace</parameter> must be
-<literal>gtk.gdk.COLORSPACE_RGB</literal>.</para>
-
- <note>
- <para>PyGTK must be compiled with the Numeric Python module to
-support this function.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixbuf-new-from-xpm-data">
- <title>gtk.gdk.pixbuf_new_from_xpm_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixbuf_new_from_xpm_data</methodname>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>a list of strings containing the XPM image
-data</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pixbuf_new_from_xpm_data</function>()
-function returns a new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> by
-parsing <literal>XPM</literal> data in memory specified by
-<parameter>data</parameter>. <parameter>data</parameter> is a list of
-strings containing the <literal>XPM</literal> data.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixbuf-new-from-inline">
- <title>gtk.gdk.pixbuf_new_from_inline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixbuf_new_from_inline</methodname>
- <methodparam><parameter
- role="keyword">data_length</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">copy_pixels</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">data_length</parameter>&nbsp;:</term>
- <listitem><simpara>the length in bytes of the
-<parameter>data</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the inline pixbuf
-data</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">copy_pixels</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the pixel data
-should be copied</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pixbuf_new_from_inline</function>()
-function returns a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> from
-a flat representation that is suitable for storing as inline data in a
-program. This is useful if you want to ship a program with images, but don't
-want to depend on any external files.</para>
-
- <para>GTK+ ships with a program called
-<command>gdk-pixbuf-csource</command> which allows for conversion of an
-image into such a inline representation.In almost all cases, you should pass
-the <option>--raw</option> flag to <command>gdk-pixbuf-csource</command>. A
-sample invocation would be:</para>
-
- <programlisting>
- gdk-pixbuf-csource --raw --name=myimage_inline myimage.png
-</programlisting>
-
- <para>For the typical case where the inline pixbuf is read-only static
-data, you don't need to copy the pixel data unless you intend to write to
-it, so you can pass <literal>False</literal> for
-<parameter>copy_pixels</parameter>.</para>
-
- <para>This function raises the GError exception if an error occurs
-during the loading of the pixbuf.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixbuf-get-formats">
- <title>gtk.gdk.pixbuf_get_formats</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixbuf_get_formats</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of image formats as Python
- dicts</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pixbuf_get_formats</function>() function
-returns a list of the supported image formats as a Python dict. The keys
-of the image format dict are:</para>
-
- <variablelist>
- <varlistentry>
- <term><parameter>name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the image format.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>description</parameter>&nbsp;:</term>
- <listitem><simpara>a description of the image
- format.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mime_types</parameter>&nbsp;:</term>
- <listitem><simpara>a list of the mime types this image
- matches.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>extensions</parameter>&nbsp;:</term>
- <listitem><simpara>a list of typical filename extensions for the
- image format.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>is_writable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the image can be
- written to a file</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixbuf-get-file-info">
- <title>gtk.gdk.pixbuf_get_file_info</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixbuf_get_file_info</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the file to check</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an image format as a Python dict</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pixbuf_get_file_info</function>() function
-reads enough of the file specified by <parameter>filename</parameter> to
-determine its image format and then returns the image format information in
-a Python dict. See the <link
-linkend="function-gdk--pixbuf-get-formats"><function>gtk.gdk.pixbuf_get_formats</function>()</link>
-function for more details on the image format dict.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkpixbufanimation.xml b/docs/reference/pygtk-gdkpixbufanimation.xml
deleted file mode 100644
index fe9c2f4a..00000000
--- a/docs/reference/pygtk-gdkpixbufanimation.xml
+++ /dev/null
@@ -1,264 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkpixbufanimation">
- <refnamediv>
- <refname>gtk.gdk.PixbufAnimation</refname>
- <refpurpose>an object holding an animation</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.PixbufAnimation</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkpixbufanimation">gtk.gdk.PixbufAnimation</link></methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufanimation--get-width">get_width</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufanimation--get-height">get_height</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufanimation--is-static-image">is_static_image</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufanimation--get-static-image">get_static_image</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufanimation--get-iter">get_iter</link></methodname>
- <methodparam><parameter role="keyword">start_time</parameter>
- <initializer>0.0</initializer></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkpixbufanimation">gtk.gdk.PixbufAnimation</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>
-is an object that holds an animation. An animation is conceptually a series
-of frames to be displayed over time. Each frame is the same size. The
-animation may not be represented as a series of frames internally; for
-example, it may be stored as a sprite and instructions for moving the sprite
-around a background. To display an animation you don't need to understand
-its representation, you just ask a <link
-linkend="class-gdkpixbufanimationiter"><classname>gtk.gdk.PixbufAnimationIter</classname></link>
-for the next frame that should be displayed at a given point in time.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkpixbufanimation">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.PixbufAnimation</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the file to
-load.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>
- object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>
-by loading it from a file. The file format is detected automatically. If the
-file's format does not support multi-frame images, then an animation with a
-single frame will be created.</para>
-
- <para>This constructor raises the GError exception if any of several
-error conditions occurred: the file could not be opened, there was no loader
-for the file's format, there was not enough memory to allocate the image
-buffer, or the image file contained invalid data.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkpixbufanimation--get-width">
- <title>gtk.gdk.PixbufAnimation.get_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the width of the bounding box of the
-animation.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_width</methodname>() method returns the
-width of the bounding box of a pixbuf animation.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufanimation--get-height">
- <title>gtk.gdk.PixbufAnimation.get_height</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_height</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the height of the bounding box of the
-animation.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_height</methodname>() method returns the
-height of the bounding box of a pixbuf animation.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufanimation--is-static-image">
- <title>gtk.gdk.PixbufAnimation.is_static_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_static_image</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the "animation" was
-really just an image</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_static_image</methodname>() method returns
-True if you load a file containing a plain, unanimated image. Use the <link
-linkend="method-gdkpixbufanimation--get-static-image"><methodname>get_static_image</methodname>()</link>
-method to retrieve the image.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufanimation--get-static-image">
- <title>gtk.gdk.PixbufAnimation.get_static_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_static_image</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the unanimated image representing the
-animation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_static_image</methodname>() method returns a
-<link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-that represents a static image of the animation. If the animation is really
-just a plain image (has only one frame), this method returns that image. If
-the animation is an animation, this method returns a reasonable thing to
-display as a static unanimated image, which might be the first frame, or
-something more sophisticated. If an animation hasn't loaded any frames yet,
-this method will return <literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufanimation--get-iter">
- <title>gtk.gdk.PixbufAnimation.get_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter</methodname>
- <methodparam><parameter role="keyword">start_time</parameter>
- <initializer>0.0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">start_time</parameter>&nbsp;:</term>
- <listitem><simpara>the time when the animation starts
-playing</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbufanimationiter"><classname>gtk.gdk.PixbufAnimationIter</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter</methodname>() method returns a <link
-linkend="class-gdkpixbufanimationiter"><classname>gtk.gdk.PixbufAnimationIter</classname></link>
-that is used to access the frames of the animation. The iterator provides
-the frames that should be displayed at specific times.
-<parameter>start_time</parameter> is the start time specified as a float as
-output from the Python time.time() function.
-<parameter>start_time</parameter> marks the beginning of the animation
-playback. After creating an iterator, you should immediately display the
-pixbuf returned by the <link
-linkend="method-gdkpixbufanimationiter--get-pixbuf"><methodname>gtk.gdk.PixbufAnimationIter.get_pixbuf</methodname>()</link>
-method. Then, you should install a timeout (with the <link
-linkend="function-gobject--timeout-add"><methodname>gobject.timeout_add</methodname>()</link>()
-function) or by some other mechanism ensure that you'll update the image
-after the number of milliseconds specified by the <link
-linkend="method-gdkpixbufanimationiter--get-delay-time"><methodname>gtk.gdk.PixbufAnimationIter.get_delay_time</methodname>()</link>
-method. Each time the image is updated, you should reinstall the timeout
-with the new, possibly-changed delay time. As a shortcut, if
-<parameter>start_time</parameter> is 0.0 (the default), the current time
-will be used.</para>
-
- <para>To update the image (i.e. possibly change the result of the
-<link
-linkend="method-gdkpixbufanimationiter--get-pixbuf"><methodname>gtk.gdk.PixbufAnimationIter.get_pixbuf</methodname>()</link>
-method to a new frame of the animation), call the <link
-linkend="method-gdkpixbufanimationiter--advance"><methodname>gtk.gdk.PixbufAnimationIter.advance</methodname>()</link>
-method.</para>
-
- <para>If you're using a <link
-linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname></link>,
-in addition to updating the image after the delay time, you should also
-update it whenever you receive the "area_updated" signal and the <link
-linkend="method-gdkpixbufanimationiter--on-currently-loading-frame"><methodname>gtk.gdk.PixbufAnimationIter.on_currently_loading_frame</methodname>()</link>
-method returns <literal>True</literal>. In this case, the frame currently
-being fed into the loader has received new data, so needs to be refreshed.
-The delay time for a frame may also be modified after an "area_updated"
-signal, for example if the delay time for a frame is encoded in the data
-after the frame itself. So your timeout should be reinstalled after any
-area_updated signal. A delay time of -1 is possible, indicating
-"infinite."</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkpixbufanimationiter.xml b/docs/reference/pygtk-gdkpixbufanimationiter.xml
deleted file mode 100644
index d4d12c22..00000000
--- a/docs/reference/pygtk-gdkpixbufanimationiter.xml
+++ /dev/null
@@ -1,225 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkpixbufanimationiter">
- <refnamediv>
- <refname>gtk.gdk.PixbufAnimationIter</refname>
- <refpurpose>an object providing access to the frames of a <link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.PixbufAnimationIter</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufanimationiter--get-delay-time">get_delay_time</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufanimationiter--get-pixbuf">get_pixbuf</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufanimationiter--on-currently-loading-frame">on_currently_loading_frame</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufanimationiter--advance">advance</link></methodname>
- <methodparam><parameter
- role="keyword">current_time</parameter>
- <initializer>0.0</initializer></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkpixbufanimationiter">gtk.gdk.PixbufAnimationIter</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkpixbufanimationiter"><classname>gtk.gdk.PixbufAnimationIter</classname></link>
-is used to access the frames of a <link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>
-at specified times. A <link
-linkend="class-gdkpixbufanimationiter"><classname>gtk.gdk.PixbufAnimationIter</classname></link>
-object is created using the <link
-linkend="method-gdkpixbufanimation--get-iter"><methodname>gtk.gdk.PixbufAnimation.get_iter</methodname>()</link>
-method. After creating an iterator, you should immediately display the
-pixbuf returned by the <link
-linkend="method-gdkpixbufanimationiter--get-pixbuf"><methodname>get_pixbuf</methodname>()</link>
-method. Then, you should install a timeout (with the <link
-linkend="function-gobject--timeout-add"><methodname>gobject.timeout_add</methodname>()</link>()
-function) or by some other mechanism ensure that you'll update the image
-after the number of milliseconds specified by the <link
-linkend="method-gdkpixbufanimationiter--get-delay-time"><methodname>get_delay_time</methodname>()</link>
-method. Each time the image is updated, you should reinstall the timeout
-with the new, possibly-changed delay time.</para>
-
- <para>To update the image (i.e. possibly change the result of the <link
-linkend="method-gdkpixbufanimationiter--get-pixbuf"><methodname>get_pixbuf</methodname>()</link>
-method to a new frame of the animation), call the <link
-linkend="method-gdkpixbufanimationiter--advance"><methodname>advance</methodname>()</link>
-method.</para>
-
- <para>If you're using a <link
-linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname></link>,
-in addition to updating the image after the delay time, you should also
-update it whenever you receive the "area_updated" signal and the <link
-linkend="method-gdkpixbufanimationiter--on-currently-loading-frame"><methodname>on_currently_loading_frame</methodname>()</link>
-method returns <literal>True</literal>. In this case, the frame currently
-being fed into the loader has received new data, so needs to be refreshed.
-The delay time for a frame may also be modified after an "area_updated"
-signal, for example if the delay time for a frame is encoded in the data
-after the frame itself. So your timeout should be reinstalled after any
-area_updated signal. A delay time of -1 is possible, indicating
-"infinite."</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkpixbufanimationiter--get-delay-time">
- <title>gtk.gdk.PixbufAnimationIter.get_delay_time</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_delay_time</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the delay time in milliseconds (thousandths of
-a second)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_delay_time</methodname>() method returns the
-number of milliseconds the current pixbuf should be displayed, or -1 if the
-current pixbuf should be displayed forever. The <link
-linkend="function-gobject--timeout-add"><methodname>gobject.timeout_add</methodname>()</link>()
-function conveniently takes a timeout in milliseconds, so you can use a
-timeout to schedule the next update.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufanimationiter--get-pixbuf">
- <title>gtk.gdk.PixbufAnimationIter.get_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixbuf</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> to be
-displayed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixbuf</methodname>() method returns the
-current <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> that
-should be displayed. The pixbuf will be the same size as the animation
-itself (see the <link
-linkend="method-gdkpixbufanimation--get-width"><methodname>gtk.gdk.PixbufAnimation.get_width</methodname>()</link>
-and <link
-linkend="method-gdkpixbufanimation--get-height"><methodname>gtk.gdk.PixbufAnimation.get_height</methodname>()</link>
-methods). The <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-should be displayed for the number of milliseconds specified by the <link
-linkend="method-gdkpixbufanimationiter--get-delay-time"><methodname>get_delay_time</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufanimationiter--on-currently-loading-frame">
- <title>gtk.gdk.PixbufAnimationIter.on_currently_loading_frame</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>on_currently_loading_frame</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the frame we're on
-is partially loaded, or the last frame</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>on_currently_loading_frame</methodname>() method
-returns <literal>True</literal> if the frame currently pointed to by the
-iterator is partially loaded or the last frame. This method is used to
-determine how to respond to the "area_updated" signal on <link
-linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname></link>
-when loading an animation. The "area_updated" signal is emitted for an area
-of the frame currently streaming in to the loader. So if you're on the
-currently loading frame, you need to redraw the screen for the updated
-area.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufanimationiter--advance">
- <title>gtk.gdk.PixbufAnimationIter.advance</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>advance</methodname>
- <methodparam><parameter role="keyword">current_time</parameter>
- <initializer>0.0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">current_time</parameter>&nbsp;:</term>
- <listitem><simpara>the current time as a float or 0.0 to
-automatically determine the current time</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the image may need
-updating</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>advance</methodname>() method attempts to
-advance an animation to a new frame. The frame is chosen based on the start
-time passed to the <link
-linkend="method-gdkpixbufanimation--get-iter"><methodname>gtk.gdk.PixbufAnimation.get_iter</methodname>()</link>
-method. <parameter>current_time</parameter> is normally the current time (as
-specified by the Python time.time() function) and must be greater than or
-equal to the time passed to the <link
-linkend="method-gdkpixbufanimation--get-iter"><methodname>gtk.gdk.PixbufAnimation.get_iter</methodname>()</link>
-method, and must increase or remain unchanged each time the <link
-linkend="method-gdkpixbufanimationiter--get-pixbuf"><methodname>get_pixbuf</methodname>()</link>
-method is called. That is, you can't go backward in time; animations only
-play forward. As a shortcut, pass 0.0 (the default) for the current time and
-the current time will automatically be determined an used. So you only need
-to explicitly pass <parameter>current_time</parameter> if you're doing
-something odd like playing the animation at double speed.</para>
-
- <para>If this method returns <literal>False</literal>, there's no need
-to update the animation display, assuming the display had been rendered
-prior to advancing; if <literal>True</literal>, you need to call the <link
-linkend="method-gdkpixbufanimationiter--get-pixbuf"><methodname>get_pixbuf</methodname>()</link>
-method and update the display with the new pixbuf.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkpixbufloader.xml b/docs/reference/pygtk-gdkpixbufloader.xml
deleted file mode 100644
index f45fa3e9..00000000
--- a/docs/reference/pygtk-gdkpixbufloader.xml
+++ /dev/null
@@ -1,666 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkpixbufloader">
- <refnamediv>
- <refname>gtk.gdk.PixbufLoader</refname>
- <refpurpose>an object providing application-driven progressive image
-loading</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.PixbufLoader</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkpixbufloader">gtk.gdk.PixbufLoader</link></methodname>
- <methodparam><parameter
- role="keyword">image_type</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufloader--write">write</link></methodname>
- <methodparam><parameter role="keyword">buf</parameter></methodparam>
- <methodparam><parameter
- role="keyword">count</parameter>
- <initializer>-1</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufloader--get-pixbuf">get_pixbuf</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufloader--get-animation">get_animation</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkpixbufloader--close">close</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkpixbufloader--set-size">set_size</link></methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkpixbufloader--get-format">get_format</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gdk--pixbuf-loader-new-with-mime-type">gtk.gdk.pixbuf_loader_new_with_mime_type</link></methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkpixbufloader">gtk.gdk.PixbufLoader</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gdkpixbufloader--area-prepared">area-prepared</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>pixbufloader</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gdkpixbufloader--area-updated">area-updated</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>pixbufloader</parameter></methodparam>
- <methodparam><parameter>x</parameter></methodparam>
- <methodparam><parameter>y</parameter></methodparam>
- <methodparam><parameter>width</parameter></methodparam>
- <methodparam><parameter>height</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gdkpixbufloader--closed">closed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>pixbufloader</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gdkpixbufloader--size-prepared">size-prepared</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>pixbufloader</parameter></methodparam>
- <methodparam><parameter>width</parameter></methodparam>
- <methodparam><parameter>height</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname></link>
-provides a way for applications to drive the process of loading an image, by
-letting them send the image data directly to the loader instead of having
-the loader read the data from a file. Applications can use this instead of
-the <link
-linkend="function-gdk--pixbuf-new-from-file"><function>gtk.gdk.pixbuf_new_from_file</function></link> function
-or the <link
-linkend="constructor-gdkpixbufanimation"><function>gtk.gdk.PixbufAnimation</function></link>
-constructor when they need to parse image data in small chunks. For example,
-it should be used when reading an image from a (potentially) slow network
-connection, or when loading an extremely large file.</para>
-
- <para>To use <link
-linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname></link>
-to load an image, just create a new one, and call the <link
-linkend="method-gdkpixbufloader--write"><methodname>write</methodname>()</link>
-method to send the data to it. When done, the <link
-linkend="method-gdkpixbufloader--close"><methodname>close</methodname>()</link>
-method should be called to end the stream and finalize everything. The
-loader will emit two important signals throughout the process. The first,
-"area-prepared", will be called as soon as the image has enough information
-to determine the size of the image to be used. The application can call the
-<link
-linkend="method-gdkpixbufloader--get-pixbuf"><methodname>get_pixbuf</methodname>()</link>
-method to retrieve the pixbuf. No actual image data will be in the pixbuf,
-so it can be safely filled with any temporary graphics (or an initial color)
-as needed.</para>
-
- <para>The "area-updated" signal is emitted every time a region is
-updated. This way you can update a partially completed image. Note that you
-do not know anything about the completeness of an image from the area
-updated. For example, in an interlaced image, you need to make several
-passes before the image is done loading.</para>
-
- <refsect2>
- <title>Loading an Animation</title>
-
- <para>Loading an animation is almost as easy as loading an image. Once
-the first "area-prepared" signal has been emitted, you can call the <link
-linkend="method-gdkpixbufloader--get-animation"><methodname>get_animation</methodname>()</link>
-method to get the <link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>
-object and the <link
-linkend="method-gdkpixbufanimation--get-iter"><methodname>gtk.gdk.PixbufAnimation.get_iter</methodname>()</link>
-method to get an <link
-linkend="class-gdkpixbufanimationiter"><classname>gtk.gdk.PixbufAnimationIter</classname></link>
-for displaying it.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkpixbufloader">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.PixbufLoader</methodname>
- <methodparam><parameter role="keyword">image_type</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">image_type</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the image format or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new <link
-linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname></link>
-object. If <parameter>image_type</parameter> is not specified or is
-<literal>None</literal> the image type will be automatically deduced from
-the image data. If <parameter>image_type</parameter> is specified the <link
-linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname></link>
-attempts to parse the image data as if it were an image of the specified
-type. Identifying the image type is useful if you want an error if the image
-isn't the expected type, for loading image formats that can't be reliably
-identified by looking at the data, or if the user manually forces a specific
-type.</para>
-
- <para>This constructor raises the GError exception if an error occurs
-trying to load the module for <parameter>image_type</parameter>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkpixbufloader--write">
- <title>gtk.gdk.PixbufLoader.write</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>write</methodname>
- <methodparam><parameter
- role="keyword">buf</parameter></methodparam>
- <methodparam><parameter
- role="keyword">count</parameter>
- <initializer>-1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">buf</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing some portion of the image
-data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the length of <parameter>buf</parameter> in
-bytes.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the write was
-successful.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>write</methodname>() method causes the pixbuf
-loader to parse the bytes of an image contained in the string specified by
-<parameter>buf</parameter>. If <parameter>count</parameter> is specified and
-is in the range (0, len(buf)) only <parameter>count</parameter> bytes of
-<parameter>buf</parameter> are used. This method returns
-<literal>True</literal> if the image data was loaded successfully. If an
-error occurred this method raises the GError exception and will not accept
-further writes. The loader may or may not be closed depending on the
-error.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufloader--get-pixbuf">
- <title>gtk.gdk.PixbufLoader.get_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixbuf</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> that
-the loader is creating, or <literal>None</literal> if not enough data has
-been read to determine how to create the image buffer.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixbuf</methodname>() method returns the
-<link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-that a pixbuf loader is currently creating. In general it only makes sense
-to call this method after the "area-prepared" signal has been emitted by
-the loader which means that enough data has been read to know the size of
-the image that will be allocated. If the loader has not received enough data
-via the <link
-linkend="method-gdkpixbufloader--write"><methodname>write</methodname>()</link>
-method, this method returns <literal>None</literal>. The same pixbuf will be
-returned in all future calls to this method. Also, if the loader is an
-animation, it will return the "static image" of the animation (see the <link
-linkend="method-gdkpixbufanimation--get-static-image"><methodname>gtk.gdk.PixbufAnimation.get_static_image</methodname>()</link>
-method).</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufloader--get-animation">
- <title>gtk.gdk.PixbufLoader.get_animation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_animation</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>
-that the loader is loading, or <literal>None</literal> if not enough data
-has been read to determine the information.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_animation</methodname>() method returns the
-<link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>
-that the pixbuf loader is currently creating. In general it only makes sense
-to call this method after the "area-prepared" signal has been emitted by the
-loader. If the loader doesn't have enough bytes yet (hasn't emitted the
-"area-prepared" signal) this method will return
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufloader--close">
- <title>gtk.gdk.PixbufLoader.close</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>close</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if all image data
-written so far was successfully passed out via the "area_update"
-signal</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>close</methodname>() method informs the pixbuf
-loader that no further writes using the <link
-linkend="method-gdkpixbufloader--write"><methodname>write</methodname>()</link>
-will occur, so that it can free its internal loading structures. Also, the
-pixbuf loader tries to parse any data that hasn't yet been parsed and if the
-remaining data is partial or corrupt, the GError exception will be
-raised.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufloader--set-size">
- <title>gtk.gdk.PixbufLoader.set_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_size</methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>The desired width for the image being
- loaded.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>The desired height for the image being
- loaded.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_size</methodname>() method causes the image
-to be scaled to the size specified by <parameter>width</parameter> and
-<parameter>height</parameter> while it is being loaded. The desired image
-size can be determined relative to the original size of the image by calling
-the <link
-linkend="method-gdkpixbufloader--set-size"><methodname>set_size()</methodname></link>
-from a signal handler for the "<link
-linkend="signal-gdkpixbufloader--size-prepared">size-prepared</link>"
-signal.</para>
-
- <para>Attempts to set the desired image size are ignored after the
-emission of the "<link
-linkend="signal-gdkpixbufloader--size-prepared">size-prepared</link>".</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkpixbufloader--get-format">
- <title>gtk.gdk.PixbufLoader.get_format</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_format</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a Python dict containing the image format
- information or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_format</methodname>() method returns the
-available information about the format of the currently loading image
-file. This method returns None if their is no information available
-e.g. before the image has started loading.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--pixbuf-loader-new-with-mime-type">
- <title>gtk.gdk.pixbuf_loader_new_with_mime_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixbuf_loader_new_with_mime_type</methodname>
- <methodparam><parameter
- role="keyword">mime_type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mime_type</parameter>&nbsp;:</term>
- <listitem><simpara> the mime type to be loaded</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gdkpixbufloader"><classname>gtk.gdk.PixbufLoader</classname></link>
- object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The
-<function>gtk.gdk.pixbuf_loader_new_with_mime_type</function>() function
-creates a new pixbuf loader object that always attempts to parse image data
-as if it were an image of the mime type specified by
-<parameter>mime_type</parameter>, instead of identifying the type
-automatically. Useful if you want an error if the image isn't the expected
-mime type, for loading image formats that can't be reliably identified by
-looking at the data, or if the user manually forces a specific mime
-type.</para>
-
- <para>This function raises the GError exception if an error occurs
-during the loading of the mime type image module.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gdkpixbufloader--area-prepared">
- <title>The "area-prepared" gtk.gdk.PixbufLoader Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>pixbufloader</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>pixbufloader</parameter>&nbsp;:</term>
- <listitem><simpara>the pixbufloader that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "area-prepared" signal is emitted when sufficient image data
-has been received and parsed to determine the size of the image.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gdkpixbufloader--area-updated">
- <title>The "area-updated" gtk.gdk.PixbufLoader Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>pixbufloader</parameter></methodparam>
- <methodparam><parameter>x</parameter></methodparam>
- <methodparam><parameter>y</parameter></methodparam>
- <methodparam><parameter>width</parameter></methodparam>
- <methodparam><parameter>height</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>pixbufloader</parameter>&nbsp;:</term>
- <listitem><simpara>the pixbufloader that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the
-region</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the
-region</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the region</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the region</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "area-updated" signal is emitted when sufficient image data
-has been received and parsed to allow the region specified by
-<parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter> to be
-displayed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gdkpixbufloader--closed">
- <title>The "closed" gtk.gdk.PixbufLoader Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>pixbufloader</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>pixbufloader</parameter>&nbsp;:</term>
- <listitem><simpara>the pixbufloader that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "closed" signal is emitted when the
-<parameter>pixbufloader</parameter> is closed by calling the <link
-linkend="method-gdkpixbufloader--close"><methodname>close</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gdkpixbufloader--size-prepared">
- <title>The "size-prepared" gtk.gdk.PixbufLoader Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>pixbufloader</parameter></methodparam>
- <methodparam><parameter>width</parameter></methodparam>
- <methodparam><parameter>height</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>pixbufloader</parameter>&nbsp;:</term>
- <listitem><simpara>the pixbufloader that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>width</parameter>&nbsp;:</term>
- <listitem><simpara>the original width of the
- image</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>height</parameter>&nbsp;:</term>
- <listitem><simpara>he original height of the
- image</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.2 and above.</para>
- </note>
-
- <para>The "size-prepared" signal is emitted when the pixbuf loader has
-been fed the initial amount of data that is required to figure out the size
-of the image that it will create. Applications can call the <link
-linkend="method-gdkpixbufloader--set-size"><methodname>set_size</methodname>()</link>
-method in response to this signal to set the desired size of the
-image.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkpixmap.xml b/docs/reference/pygtk-gdkpixmap.xml
deleted file mode 100644
index 05029da8..00000000
--- a/docs/reference/pygtk-gdkpixmap.xml
+++ /dev/null
@@ -1,766 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkpixmap">
- <refnamediv>
- <refname>gtk.gdk.Pixmap</refname>
- <refpurpose>An offscreen <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Pixmap</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gdkdrawable">gtk.gdk.Drawable</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gdkpixmap">gtk.gdk.Pixmap</link></methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">depth</parameter>
- <initializer>-1</initializer></methodparam>
- </constructorsynopsis>
-
-</classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--bitmap-create-from-data">gtk.gdk.bitmap_create_from_data</link></methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-create-from-data">gtk.gdk.pixmap_create_from_data</link></methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">depth</parameter></methodparam>
- <methodparam><parameter role="keyword">fg</parameter></methodparam>
- <methodparam><parameter role="keyword">bg</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-create-from-xpm">gtk.gdk.pixmap_create_from_xpm</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">transparent_color</parameter></methodparam>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-colormap-create-from-xpm">gtk.gdk.pixmap_colormap_create_from_xpm</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">transparent_color</parameter></methodparam>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-create-from-xpm-d">gtk.gdk.pixmap_create_from_xpm_d</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">transparent_color</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-colormap-create-from-xpm-d">gtk.gdk.pixmap_colormap_create_from_xpm_d</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">transparent_color</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-foreign-new">gtk.gdk.pixmap_foreign_new</link></methodname>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-lookup">gtk.gdk.pixmap_lookup</link></methodname>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-foreign-new-for-display">gtk.gdk.pixmap_foreign_new_for_display</link></methodname>
- <methodparam><parameter
- role="keyword">display</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--pixmap-lookup-for-display">gtk.gdk.pixmap_lookup_for_display</link></methodname>
- <methodparam><parameter
- role="keyword">display</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkdrawable">gtk.gdk.Drawable</link>
- +-- <link linkend="class-gdkpixmap">gtk.gdk.Pixmap</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> is an
-offscreen <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>.
-It can be drawn upon with the standard <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-drawing primitives, then copied to another <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-(such as a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>) with
-the <link
-linkend="method-gdkdrawable--draw-drawable"><methodname>draw_drawable</methodname>()</link>
-method. The depth of a pixmap is the number of bits per pixels. A bitmaps
-are simply a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> with
-a depth of 1. (That is, they are monochrome pixmaps - each pixel can be
-either on or off).</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkpixmap">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Pixmap</methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">depth</parameter><initializer>-1</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">drawable</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link> used
-to determine default values for the new pixmap or <literal>None</literal> if
-<parameter>depth</parameter> is specified.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the new pixmap in
-pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the new pixmap in
-pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">depth</parameter>&nbsp;:</term>
- <listitem><simpara>the depth (number of bits per pixel) of the new
-pixmap or -1 to use the depth of
-<parameter>drawable</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> with
-the size specified by <parameter>width</parameter> and
-<parameter>height</parameter> and the number of bits per pixel specified by
-<parameter>depth</parameter>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--bitmap-create-from-data">
- <title>gtk.gdk.bitmap_create_from_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.bitmap_create_from_data</methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">drawable</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link> used
-to determine default values for the new pixmap or <literal>None</literal>
-to use the root window.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the XBM
-data</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the new bitmap in
-pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the new bitmap in
-pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new bitmap (<link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>)
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.bitmap_create_from_data</function>()
-function returns a new bitmap of the size specified by
-<parameter>width</parameter> and <parameter>height</parameter> from the
-<literal>XBM</literal> format string specified by
-<parameter>data</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixmap-create-from-data">
- <title>gtk.gdk.pixmap_create_from_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixmap_create_from_data</methodname>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">depth</parameter></methodparam>
- <methodparam><parameter role="keyword">fg</parameter></methodparam>
- <methodparam><parameter role="keyword">bg</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">drawable</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link> used
-to determine default values for the new pixmap or <literal>None</literal> if
-<parameter>depth</parameter> is specified.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>the string containing the pixmap
-data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the new pixmap in
-pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the new pixmap in
-pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">depth</parameter>&nbsp;:</term>
- <listitem><simpara>the depth (number of bits per pixel) of the new
-pixmap or -1 to use the depth of
-<parameter>drawable</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fg</parameter>&nbsp;:</term>
- <listitem><simpara>the foreground color.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">bg</parameter>&nbsp;:</term>
- <listitem><simpara>he background color. </simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pixmap_create_from_data</function>()
-function creates a two-color <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> of
-the size specified by <parameter>width</parameter> and
-<parameter>height</parameter> from the <literal>XBM</literal> format string
-specified by <parameter>data</parameter>. The foreground and background
-colors of the pixmap are specified by <parameter>fg</parameter> and
-<parameter>bg</parameter> respectively. If <parameter>depth</parameter> is
--1 <parameter>drawable</parameter> is used to determine the bits per pixels
-otherwise the value of <parameter>depth</parameter> is used.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixmap-create-from-xpm">
- <title>gtk.gdk.pixmap_create_from_xpm</title>
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixmap_create_from_xpm</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">transparent_color</parameter></methodparam>
-
-
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>,
- used to determine default values for the new <link
- linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">transparent_color</parameter>&nbsp;:</term>
- <listitem><simpara>the color to be used for the pixels that are
-transparent in the input file or <literal>None</literal> to use a default
-color.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a file containing
-<literal>XPM</literal> data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-object and a bitmap that is the transparency mask.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pixmap_create_from_xpm</function>()
-function returns a tuple containing a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> and a
-bitmap transparency mask created from the <literal>XPM</literal> data in the
-file specified by <parameter>filename</parameter>.
-<parameter>transparent_color</parameter> (if not <literal>None</literal>)
-specifies the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to by
-used for the transparent pixels.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixmap-colormap-create-from-xpm">
- <title>gtk.gdk.pixmap_colormap_create_from_xpm</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixmap_colormap_create_from_xpm</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">transparent_color</parameter></methodparam>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>,
-used to determine default values for the new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> or
-<literal>None</literal> if a <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-is specified.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-that the new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> will
-be use or <literal>None</literal> to use the colormap of
-<parameter>window</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">transparent_color</parameter>&nbsp;:</term>
- <listitem><simpara>the color to be used for the pixels that are
-transparent in the input file or <literal>None</literal> to use a default
-color.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a file containing
-<literal>XPM</literal> data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-object and a bitmap that is the transparency mask.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The
-<function>gtk.gdk.pixmap_colormap_create_from_xpm</function>() function
-returns a tuple containing a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> and a
-bitmap transparency mask created from the <literal>XPM</literal> data in the
-file specified by <parameter>filename</parameter>.
-<parameter>transparent_color</parameter> (if not <literal>None</literal>)
-specifies the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to by
-used for the transparent pixels. If <parameter>colormap</parameter> is not
-<literal>None</literal> it must specify a <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-that the new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> will
-use. If <parameter>colormap</parameter> is <literal>None</literal> the new
-<link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-will use the colormap of <parameter>window</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixmap-create-from-xpm-d">
- <title>gtk.gdk.pixmap_create_from_xpm_d</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixmap_create_from_xpm_d</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">transparent_color</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>,
-used to determine default values for the new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">transparent_color</parameter>&nbsp;:</term>
- <listitem><simpara>the color to be used for the pixels that are
-transparent in the input file or <literal>None</literal> to use a default
-color.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>a list of strings containing the
-<literal>XPM</literal> data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-object and a bitmap that is the transparency mask.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pixmap_create_from_xpm_d</function>()
-function returns a tuple containing a new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> and a
-bitmap transparency mask created from the <literal>XPM</literal> data
-contained in <parameter>data</parameter>.
-<parameter>transparent_color</parameter> (if not <literal>None</literal>)
-specifies the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to by
-used for the transparent pixels.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixmap-colormap-create-from-xpm-d">
- <title>gtk.gdk.pixmap_colormap_create_from_xpm_d</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixmap_colormap_create_from_xpm_d</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">transparent_color</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>,
-used to determine default values for the new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-that the new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> will
-be use or <literal>None</literal> to use the colormap of
-<parameter>window</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">transparent_color</parameter>&nbsp;:</term>
- <listitem><simpara>the color to be used for the pixels that are
-transparent in the input file or <literal>None</literal> to use a default
-color.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>a list of strings containing the
-<literal>XPM</literal> data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-object and a bitmap that is the transparency mask.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The
-<function>gtk.gdk.pixmap_colormap_create_from_xpm_d</function>() function
-returns a tuple containing a new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> and a
-bitmap transparency mask created from the <literal>XPM</literal> data
-contained in <parameter>data</parameter>.
-<parameter>transparent_color</parameter> (if not <literal>None</literal>)
-specifies the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to by
-used for the transparent pixels. If <parameter>colormap</parameter> is not
-<literal>None</literal> it must specify a <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-that the new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> will
-use. If <parameter>colormap</parameter> is <literal>None</literal> the new
-<link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-will use the colormap of <parameter>window</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixmap-foreign-new">
- <title>gtk.gdk.pixmap_foreign_new</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixmap_foreign_new</methodname>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
- <listitem><simpara> a native window system pixmap
-handle.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-wrapper for the native pixmap or <literal>None</literal> if the pixmap has
-been destroyed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pixmap_foreign_new</function>() function
-returns a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> that
-wraps the native window specified by <parameter>anid</parameter> for the
-default display. If the pixmap has been destroyed this function returns
-<literal>None</literal>. In the X backend, <parameter>anid</parameter> must
-specify an Xlib XID that is a native pixmap handle.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixmap-lookup">
- <title>gtk.gdk.pixmap_lookup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixmap_lookup</methodname>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
- <listitem><simpara> a native window system pixmap
-handle.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-wrapper for the native pixmap or <literal>None</literal> if the pixmap has
-been destroyed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.pixmap_lookup</function>() function
-returns looks up and returns the <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> that
-wraps the native pixmap handle specified by <parameter>anid</parameter>.
-This method returns <literal>None</literal> if no <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> wraps
-<parameter>anid</parameter>. In the X backend, <parameter>anid</parameter>
-must specify an Xlib XID that is a native pixmap handle.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixmap-foreign-new-for-display">
- <title>gtk.gdk.pixmap_foreign_new_for_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixmap_foreign_new_for_display</methodname>
- <methodparam><parameter
- role="keyword">display</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
- object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
- <listitem><simpara> a native window system pixmap
-handle.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-wrapper for the native pixmap or <literal>None</literal> if the pixmap has
-been destroyed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK2.2 and above.</para>
- </note>
-
- <para>The
-<function>gtk.gdk.pixmap_foreign_new_for_display</function>() function
-returns a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> that
-wraps the native window specified by <parameter>anid</parameter> for the
-<link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-specified by <parameter>display</parameter>. If the pixmap has been
-destroyed this function returns <literal>None</literal>. In the X backend,
-<parameter>anid</parameter> must specify an Xlib XID that is a native pixmap
-handle.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--pixmap-lookup-for-display">
- <title>gtk.gdk.pixmap_lookup_for_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.pixmap_lookup_for_display</methodname>
- <methodparam><parameter
- role="keyword">display</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
- object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
- <listitem><simpara> a native window system pixmap
-handle.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the new <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-wrapper for the native pixmap or <literal>None</literal> if the pixmap has
-been destroyed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK2.2 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.pixmap_lookup_for_display</function>()
-function returns looks up and returns the <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> that
-wraps the native pixmap handle specified by <parameter>anid</parameter> for
-the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-specified by <parameter>display</parameter>. This method returns
-<literal>None</literal> if no <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> wraps
-<parameter>anid</parameter>. In the X backend, <parameter>anid</parameter>
-must specify an Xlib XID that is a native pixmap handle.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkrectangle.xml b/docs/reference/pygtk-gdkrectangle.xml
deleted file mode 100644
index 19de9bb3..00000000
--- a/docs/reference/pygtk-gdkrectangle.xml
+++ /dev/null
@@ -1,240 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkrectangle">
- <refnamediv>
- <refname>gtk.gdk.Rectangle</refname>
- <refpurpose>an object holding data about a rectangle</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Rectangle</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkrectangle">gtk.gdk.Rectangle</link></methodname>
- <methodparam><parameter
- role="keyword">x</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter>
- <initializer>0</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkrectangle--intersect">intersect</link></methodname>
- <methodparam><parameter
- role="keyword">src</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkrectangle--union">union</link></methodname>
- <methodparam><parameter
- role="keyword">src</parameter></methodparam>
- </methodsynopsis>
-
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"x"</entry>
- <entry>Read-Write</entry>
- <entry>The X coordinate of the top left corner of the
-rectangle.</entry>
- </row>
-
- <row valign="top">
- <entry>"y"</entry>
- <entry>Read-Write</entry>
- <entry>The Y coordinate of the top left corner of the
-rectangle.</entry>
- </row>
-
- <row valign="top">
- <entry>"width"</entry>
- <entry>Read-Write</entry>
- <entry>The width of the rectangle.</entry>
- </row>
-
- <row valign="top">
- <entry>"height"</entry>
- <entry>Read-Write</entry>
- <entry>The height of the rectangle.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-holds the position and size of a rectangle. The position is specified by the
-"x" and "y" attributes and the size, by the "width" and "height"
-attributes.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkrectangle">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Rectangle</methodname>
- <methodparam><parameter
- role="keyword">x</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter>
- <initializer>0</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the top left corner of the
-rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the top left corner of the
-rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-with the attributes specified by <parameter>x</parameter>,
-<parameter>y</parameter>, <parameter>width</parameter> and
-<parameter>height</parameter>. Any unspecified attributes default to
-0.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkrectangle--intersect">
- <title>gtk.gdk.Rectangle.intersect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>intersect</methodname>
- <methodparam><parameter
- role="keyword">src</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">src</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-of a 4-tuple specifying the attributes of a rectangle as (x, y, width,
-height)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-that is the intersection of <parameter>src</parameter> and the
-rectangle</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>intersect</methodname>() method returns a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-that is the intersection of this rectangle and the <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-specified by <parameter>src</parameter>. The value of
-<parameter>src</parameter> is either a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-or a 4-tuple containing the position and size of a rectangle. If the
-rectangles do not intersect the returned <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-will have all attributes set to 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkrectangle--union">
- <title>gtk.gdk.Rectangle.union</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>union</methodname>
- <methodparam><parameter
- role="keyword">src</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">src</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-of a 4-tuple specifying the attributes of a rectangle as (x, y, width,
-height)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-that includes both <parameter>src</parameter> and the
-rectangle</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>union</methodname>() method returns a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-that is the smallest rectangle containing both this rectangle and the <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-specified by <parameter>src</parameter>. The value of
-<parameter>src</parameter> is either a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-or a 4-tuple containing the position and size of a rectangle.</para>
-
- </refsect2>
-
- </refsect1>
-
- </refentry>
diff --git a/docs/reference/pygtk-gdkregion.xml b/docs/reference/pygtk-gdkregion.xml
deleted file mode 100644
index d2631743..00000000
--- a/docs/reference/pygtk-gdkregion.xml
+++ /dev/null
@@ -1,579 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkregion">
- <refnamediv>
- <refname>gtk.gdk.Region</refname>
- <refpurpose>an object representing a set of pixels on the screen (new in
- PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Region</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkregion">gtk.gdk.Region</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--get-clipbox">get_clipbox</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--empty">empty</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--equal">equal</link></methodname>
- <methodparam><parameter
- role="keyword">other</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--point-in">point_in</link></methodname>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--rect-in">rect_in</link></methodname>
- <methodparam><parameter
- role="keyword">rect</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--copy">copy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--offset">offset</link></methodname>
- <methodparam><parameter
- role="keyword">dx</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--shrink">shrink</link></methodname>
- <methodparam><parameter
- role="keyword">dx</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--union-with-rect">union_with_rect</link></methodname>
- <methodparam><parameter
- role="keyword">rect</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--intersect">intersect</link></methodname>
- <methodparam><parameter
- role="keyword">source2</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--union">union</link></methodname>
- <methodparam><parameter
- role="keyword">source2</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--subtract">subtract</link></methodname>
- <methodparam><parameter
- role="keyword">source2</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkregion--xor">xor</link></methodname>
- <methodparam><parameter
- role="keyword">source2</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--region-rectangle">gtk.gdk.region_rectangle</link></methodname>
- <methodparam><parameter
- role="keyword">rectangle</parameter></methodparam>
-</methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- is an objrect holding a set of arbitrary pixels, and is usually used for
- clipping graphical operations (see the <link
- linkend="method-gdkgc--set-clip-region"><methodname>gtk.gdk.GC.set_clip_region</methodname>()</link>
- method).</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkregion">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Region</methodname>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkregion--get-clipbox">
- <title>gtk.gdk.Region.get_clipbox</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_clipbox</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>returns the smallest rectangle which includes all
- of the region.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_clipbox</methodname>() method returns the
- smallest rectangle which includes the entire region.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--empty">
- <title>gtk.gdk.Region.empty</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>empty</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the region is empty.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>empty</methodname>() method returns True if the
- region is empty.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--equal">
- <title>gtk.gdk.Region.equal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>equal</methodname>
- <methodparam><parameter
- role="keyword">other</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">other</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the region is equal to
- <parameter>other</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>equal</methodname>() method returns True if the
- region specified by <parameter>other</parameter> is equal to this
- region.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--point-in">
- <title>gtk.gdk.Region.point_in</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>point_in</methodname>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x coordinate of a point.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y coordinate of a point.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the point (x,y) is in the
- region.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname></methodname>() method returns True if the point
- specified by the coordinates <parameter>x</parameter> and
- <parameter>y</parameter> is in a region.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--rect-in">
- <title>gtk.gdk.Region.rect_in</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>rect_in</methodname>
- <methodparam><parameter
- role="keyword">rect</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rect</parameter>&nbsp;:</term>
- <listitem><simpara>a rectangle (<link
- linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
- or 4-tuple representing a rectangle) </simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a value indicating whether
- <parameter>rectangle</parameter> is inside or outside the
- region.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>rect_in</methodname>() method returns one of the
- <xref linkend="gdk-overlap-type-constants"
- endterm="gdk-overlap-type-constants-title"></xref> depending whether
- the rectangle specified by <parameter>rect</parameter> is inside,
- outside, or partly inside this region.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--copy">
- <title>gtk.gdk.Region.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- identical to the region</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>copy</methodname>() method returns a new <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- identical to this region.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--offset">
- <title>gtk.gdk.Region.offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>offset</methodname>
- <methodparam><parameter
- role="keyword">dx</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dx</parameter>&nbsp;:</term>
- <listitem><simpara>the distance to move this region
- horizontally.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dy</parameter>&nbsp;:</term>
- <listitem><simpara>the distance to move this region
- vertically.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>offset</methodname>() method moves this region
- the distance specified by <parameter>dx</parameter> and
- <parameter>dy</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--shrink">
- <title>gtk.gdk.Region.shrink</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>shrink</methodname>
- <methodparam><parameter
- role="keyword">dx</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dx</parameter>&nbsp;:</term>
- <listitem><simpara>the number of pixels to shrink this region
- horizontally.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dy</parameter>&nbsp;:</term>
- <listitem><simpara>the number of pixels to shrink this region
- vertically. </simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>shrink</methodname>() method resizes this region
- by the amount specified by <parameter>dx</parameter> and
- <parameter>dy</parameter>. Positive values shrink the region. Negative
- values expand it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--union-with-rect">
- <title>gtk.gdk.Region.union_with_rect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>union_with_rect</methodname>
- <methodparam><parameter
- role="keyword">rect</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rect</parameter>&nbsp;:</term>
- <listitem><simpara>a rectangle</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>union_with_rect</methodname>() method sets the
- area of this region to the union of the areas of this region and the
- rectangle specified by <parameter>rect</parameter>. The resulting area
- is the set of pixels contained in either the region or
- <parameter>rect</parameter>. The value of <parameter>rect</parameter>
- is either a <link
- linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
- or a 4-tuple containing the position and size of a rectangle.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--intersect">
- <title>gtk.gdk.Region.intersect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>intersect</methodname>
- <methodparam><parameter
- role="keyword">source2</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">source2</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>intersect</methodname>() method sets the area of
- this region to the intersection of the areas of this region and the
- region specified by <parameter>source2</parameter>. The resulting area
- is the set of pixels contained in both this region and
- <parameter>source2</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--union">
- <title>gtk.gdk.Region.union</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>union</methodname>
- <methodparam><parameter
- role="keyword">source2</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">source2</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>union</methodname>() method sets the area of
- this region to the union of the areas of this region and the region
- specified by <parameter>source2</parameter>. The resulting area is the
- set of pixels contained in either this region or
- <parameter>source2</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--subtract">
- <title>gtk.gdk.Region.subtract</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>subtract</methodname>
- <methodparam><parameter
- role="keyword">source2</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">source2</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>subtract</methodname>() method sets the area of
- this region to the subtraction of the areas of this region and the
- region specified by <parameter>source2</parameter>. The resulting area
- is the set of pixels contained in this region but not in
- <parameter>source2</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkregion--xor">
- <title>gtk.gdk.Region.xor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>xor</methodname>
- <methodparam><parameter
- role="keyword">source2</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">source2</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>xor</methodname>() method sets the area of this
- region to the exclusive-OR of the areas of this region and the region
- specified by <parameter>source2</parameter>. The resulting area is the
- set of pixels contained in either this region or
- <parameter>source2</parameter> but not both.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--region-rectangle">
- <title>gtk.gdk.region_rectangle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.region_rectangle</methodname>
- <methodparam><parameter
- role="keyword">rectangle</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rectangle</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
- or a 4-tuple representing a rectangle.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.region_rectangle</function>() function
- creates a new <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- containing the area specified by
- <parameter>rectangle</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkscreen.xml b/docs/reference/pygtk-gdkscreen.xml
deleted file mode 100644
index 1b334944..00000000
--- a/docs/reference/pygtk-gdkscreen.xml
+++ /dev/null
@@ -1,1028 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gdkscreen">
- <refnamediv>
- <refname>gtk.gdk.Screen</refname>
- <refpurpose>an object representing a physical screen</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Screen</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-default-colormap">get_default_colormap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--set-default-colormap">set_default_colormap</link></methodname>
- <methodparam><parameter role="keyword">colormap</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-system-colormap">get_system_colormap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-system-visual">get_system_visual</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-rgb-colormap">get_rgb_colormap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-rgb-visual">get_rgb_visual</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-root-window">get_root_window</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-display">get_display</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-number">get_number</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-width">get_width</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-height">get_height</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-width-mm">get_width_mm</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-height-mm">get_height_mm</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--list-visuals">list_visuals</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-toplevel-windows">get_toplevel_windows</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--make-display-name">make_display_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-n-monitors">get_n_monitors</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-monitor-geometry">get_monitor_geometry</link></methodname>
- <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-monitor-at-point">get_monitor_at_point</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-monitor-at-window">get_monitor_at_window</link></methodname>
- <methodparam><parameter role="keyword">window</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--broadcast-client-message">broadcast_client_message</link></methodname>
- <methodparam><parameter role="keyword">event</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-setting">get_setting</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-rgba-colormap">get_rgba_colormap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkscreen--get-rgba-visual">get_rgba_visual</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gdk--screen-width">gtk.gdk.screen_width</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--screen-height">gtk.gdk.screen_height</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--screen-width-mm">gtk.gdk.screen_width_mm</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--screen-height-mm">gtk.gdk.screen_height_mm</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--screen-get-default">gtk.gdk.screen_get_default</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkscreen">gtk.gdk.Screen</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gdkscreen--size-changed">size-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>screen</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para><link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-objects are the <literal>PyGTK</literal> representation of a physical
-screen. It is used throughout <literal>PyGTK</literal> to specify which
-screen the top level windows are to be displayed on. It is also used to
-query the screen specification and default settings such as the default
-colormap (the <link
-linkend="method-gdkscreen--get-default-colormap"><methodname>get_default_colormap</methodname>()</link>
-method), the screen width (the <link
-linkend="method-gdkscreen--get-width"><methodname>get_width</methodname>()</link>
-method), etc.</para>
-
- <note>
- <para>a screen may consist of multiple monitors that are merged to
-form a large screen area.</para>
- </note>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkscreen--get-default-colormap">
- <title>gtk.gdk.Screen.get_default_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_colormap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default <link
- linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_default_colormap</methodname>() method
-returns the default <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-for the screen.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--set-default-colormap">
- <title>gtk.gdk.Screen.set_default_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_default_colormap</methodname>
- <methodparam><parameter role="keyword">colormap</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_default_colormap</methodname>() method sets
-the <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-specified by <parameter>colormap</parameter> as the default colormap for the
-screen.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-system-colormap">
- <title>gtk.gdk.Screen.get_system_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_system_colormap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default colormap for the screen.
-
-Since: 2.2</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_system_colormap</methodname>() method
-returns the system's default colormap for the screen</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-system-visual">
- <title>gtk.gdk.Screen.get_system_visual</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_system_visual</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the system <link
- linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_system_visual</methodname>() method returns
-the system's default <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> for
-the screen. This is the visual for the root window of the display.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-rgb-colormap">
- <title>gtk.gdk.Screen.get_rgb_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_rgb_colormap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_rgb_colormap</methodname>() method returns
-the preferred colormap for rendering image data on the screen. Not a very
-useful function; historically, <literal>GDK</literal> could only render RGB
-image data to one colormap and visual, but in the current version it can
-render to any colormap and visual. So there's no need to call this
-function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-rgb-visual">
- <title>gtk.gdk.Screen.get_rgb_visual</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_rgb_visual</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_rgb_visual</methodname>() method returns a
-"preferred visual" chosen for rendering <literal>RGB</literal> image data on
-the screen.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-root-window">
- <title>gtk.gdk.Screen.get_root_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_root_window</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the root <link
- linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_root_window</methodname>() method returns
-the root <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-the screen.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-display">
- <title>gtk.gdk.Screen.get_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_display</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the display that the screen belongs
- to</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_display</methodname>() method returns the
-<link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-that the screen belongs to.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-number">
- <title>gtk.gdk.Screen.get_number</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_number</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the index</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_number</methodname>() method returns the
-index of the screen among the screens in its display. (See the <link
-linkend="method-gdkscreen--get-display"><methodname>get_display()</methodname></link>
-method)</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-width">
- <title>gtk.gdk.Screen.get_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_width</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the width of the screen in
- pixels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_width</methodname>() method returns the
-width of the screen in pixels</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-height">
- <title>gtk.gdk.Screen.get_height</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_height</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the height of the screen in
- pixels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_height</methodname>() method returns the
-height of the screen in pixels</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-width-mm">
- <title>gtk.gdk.Screen.get_width_mm</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_width_mm</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the width of the screen in
- millimeters.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_width_mm</methodname>() method returns the
-width of the screen in millimeters. Note that on some X servers this value
-will not be correct.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-height-mm">
- <title>gtk.gdk.Screen.get_height_mm</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_height_mm</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the height of the screen in pixels.
-
-Since: 2.2</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_height_mm</methodname>() method returns the
-height of the screen in millimeters. Note that on some X servers this value
-will not be correct.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--list-visuals">
- <title>gtk.gdk.Screen.list_visuals</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_visuals</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of <link
- linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>list_visuals</methodname>() method returns a list
-of the available visuals for the screen. A <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
-describes a hardware image data format. For example, a visual might support
-24-bit color, or 8-bit color, and might expect pixels to be in a certain
-format.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-toplevel-windows">
- <title>gtk.gdk.Screen.get_toplevel_windows</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_toplevel_windows</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the toplevel <link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> objects</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_toplevel_windows</methodname>() method
-returns a list of all toplevel <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-objects known to <literal>PyGTK</literal> on the screen. A toplevel window
-is a child of the root window (see the <link
-linkend="function-gdk--get-default-root-window"><function>gtk.gdk.get_default_root_window</function>()</link>
-function).</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--make-display-name">
- <title>gtk.gdk.Screen.make_display_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>make_display_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a generated nae</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>make_display_name</methodname>() method
-determines the name to pass to <function>gtk.gdk.Display()</function> to get
-a <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-with this screen as the default screen.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-n-monitors">
- <title>gtk.gdk.Screen.get_n_monitors</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_monitors</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of monitors that the screen consists
- of.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_n_monitors</methodname>() method returns the
-number of monitors that the screen consists of.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-monitor-geometry">
- <title>gtk.gdk.Screen.get_monitor_geometry</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_monitor_geometry</methodname>
- <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">monitor_num</parameter>&nbsp;:</term>
- <listitem><simpara>the monitor number.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
- containing the monitor geometry</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_monitor_geometry</methodname>() method
-returns a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-representing the size and position of the individual monitor within the the
-entire screen area.</para>
-
- <para>Note that the size of the entire screen area can be retrieved
-via the <link
-linkend="method-gdkscreen--get-width"><methodname>get_width()</methodname></link>
-and <link
-linkend="method-gdkscreen--get-height"><methodname>get_height()</methodname></link>. methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-monitor-at-point">
- <title>gtk.gdk.Screen.get_monitor_at_point</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_monitor_at_point</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>an x coordinate in the virtual
- screen.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>a y coordinate in the virtual
- screen.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of the monitor that the point
- (<parameter>x</parameter>,<parameter>y</parameter>) lies in, or a
- monitor close to
- (<parameter>x</parameter>,<parameter>y</parameter>) if the point
- is not in any monitor.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_monitor_at_point</methodname>() method
-returns the number of the monitor in which the point
-(<parameter>x</parameter>,<parameter>y</parameter>) is located or the
-closest monitor if not in a monitor.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-monitor-at-window">
- <title>gtk.gdk.Screen.get_monitor_at_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_monitor_at_window</methodname>
- <methodparam><parameter role="keyword">window</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of the monitor that most of <parameter>window</parameter> is located.
-
-
-Since: 2.2</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_monitor_at_window</methodname>() method
-returns the number of the monitor that most of the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-specified by <parameter>window</parameter> is in. If
-<parameter>window</parameter> does not intersect any monitors, the closest
-monitor to the main bounding rectangle of <parameter>window</parameter> is
-returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--broadcast-client-message">
- <title>gtk.gdk.Screen.broadcast_client_message</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>broadcast_client_message</methodname>
- <methodparam><parameter role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>broadcast_client_message</methodname>() method
-sends a message to all top level windows. On X11, sends an X ClientMessage
-event to all toplevel windows on the screen.</para>
-
- <para>Toplevel windows are determined by checking for the
-<literal>WM_STATE</literal> property, as described in the Inter-Client
-Communication Conventions Manual (ICCCM). If no windows are found with the
-<literal>WM_STATE</literal> property set, the message is sent to all
-children of the root window.</para>
-
- <para>On Windows, broadcasts a message registered with the name
-<literal>GDK_WIN32_CLIENT_MESSAGE</literal> to all top-level windows. The
-amount of data is limited to one long, i.e. four bytes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-setting">
- <title>gtk.gdk.Screen.get_setting</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_setting</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the setting</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the value of
- <parameter>setting</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_setting</methodname>() method returns the
-value of the desktop-wide setting (specified by
-<parameter>setting</parameter>) such as double-click time for the
-screen.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-rgba-colormap">
- <title>gtk.gdk.Screen.get_rgba_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_rgba_colormap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
- for use with windows with an alpha channel or <literal>None</literal>
- if the capability is not available.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_rgba_colormap</methodname>() method returns
- a colormap to use for creating windows or pixmaps with an alpha
- channel. The windowing system on which PyGTK is running may not
- support this capability, in which case <literal>None</literal> will be
- returned. Even if a non-<literal>None</literal> value is returned,
- it's possible that the window's alpha channel won't be honored when
- displaying the window on the screen: in particular, for X an
- appropriate windowing manager and compositing manager must be running
- to provide appropriate display.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkscreen--get-rgba-visual">
- <title>gtk.gdk.Screen.get_rgba_visual</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_rgba_visual</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
- to use for windows with an alpha channel or <literal>None</literal>
- if the capability is not available.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_rgba_visual</methodname>() method returns a
- visual to use for creating windows or pixmaps with an alpha
- channel. See the <link
- linkend="method-gdkscreen--get-rgba-colormap"><methodname>get_rgba_colormap</methodname>()</link>
- method for caveats.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--screen-width">
- <title>gtk.gdk.screen_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.screen_width</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term> <listitem><simpara>
- the width of the default screen in pixels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.screen_width</function>() function
-returns the width of the default screen in pixels.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--screen-height">
- <title>gtk.gdk.screen_height</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.screen_height</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term> <listitem><simpara>
- the height of the default screen in pixels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.screen_height</function>() function
-returns the height of the default screen in pixels.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--screen-width-mm">
- <title>gtk.gdk.screen_width_mm</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.screen_width_mm</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term> <listitem><simpara>
- the width of the default screen in millimeters, though it is not
- always correct.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.screen_width_mm</function>() function
-returns the width of the default screen in millimeters. Note that on many X
-servers this value will not be correct.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--screen-height-mm">
- <title>gtk.gdk.screen_height_mm</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.screen_height_mm</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term> <listitem><simpara>
- the height of the default screen in millimeters, though it is not
- always correct.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.screen_height_mm</function>() function
-returns the height of the default screen in millimeters. Note that on many X
-servers this value will not be correct.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--screen-get-default">
- <title>gtk.gdk.screen_get_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.screen_get_default</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>,
- or <literal>None</literal> if there is no default
- display.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.screen_get_default</function>() function
-returns the default <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> for
-the default <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>. (See
-the <link
-linkend="function-gdk--display-get-default"><function>gtk.gdk.display_get_default</function>()</link>
-function).</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gdkscreen--size-changed">
- <title>The "size-changed" gtk.gdk.Screen Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>screen</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>screen</parameter>&nbsp;:</term>
- <listitem><simpara>the screen that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "size-changed" signal is emitted when the pixel width or
-height of a screen changes.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkvisual.xml b/docs/reference/pygtk-gdkvisual.xml
deleted file mode 100644
index b659c1a6..00000000
--- a/docs/reference/pygtk-gdkvisual.xml
+++ /dev/null
@@ -1,716 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkvisual">
- <refnamediv>
- <refname>gtk.gdk.Visual</refname>
- <refpurpose>an object containing hardware display
-information</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Visual</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkvisual">gtk.gdk.Visual</link></methodname>
- <methodparam><parameter
- role="keyword">depth</parameter></methodparam>
- <methodparam><parameter
- role="keyword">visual_type</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkvisual--get-screen">get_screen</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gdk--list-visuals">gtk.gdk.list_visuals</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--visual-get-best">gtk.gdk.visual_get_best</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--visual-get-best-depth">gtk.gdk.visual_get_best_depth</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--visual-get-best-type">gtk.gdk.visual_get_best_type</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--visual-get-best-with-depth">gtk.gdk.visual_get_best_with_depth</link></methodname>
- <methodparam><parameter role="keyword">depth</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--visual-get-best-with-type">gtk.gdk.visual_get_best_with_type</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--visual-get-system">gtk.gdk.visual_get_system</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--query-depths">gtk.gdk.query_depths</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gdk--query-visual-types">gtk.gdk.query_visual_types</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkvisual">gtk.gdk.Visual</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"bits_per_rgb"</entry>
- <entry>Read</entry>
- <entry>The number of significant bits per red, green, or blue
-when specifying colors for this visual. (For instance, for the <link
-linkend="method-gdkcolormap--alloc-color"><methodname>gtk.gdk.Colormap.alloc_color</methodname>()</link>
-method)</entry>
- </row>
-
- <row valign="top">
- <entry>"blue_mask"</entry>
- <entry>Read</entry>
- <entry>A mask giving the bits in a pixel value that correspond
-to the blue field.</entry>
- </row>
-
- <row valign="top">
- <entry>"blue_prec"</entry>
- <entry>Read</entry>
- <entry>See above.</entry>
- </row>
-
- <row valign="top">
- <entry>"blue_shift"</entry>
- <entry>Read</entry>
- <entry>The <parameter>blue_shift</parameter> and
-<parameter>blue_prec</parameter> give an alternate presentation of the
-information in <parameter>blue_mask</parameter>. </entry>
- </row>
-
- <row valign="top">
- <entry>"byte_order"</entry>
- <entry>Read</entry>
- <entry>The byte-order for this visual - either:
-<literal>gtk.gdk.LSB_FIRST</literal> or
-<literal>gtk.gdk.MSB_FIRST</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"colormap_size"</entry>
- <entry>Read</entry>
- <entry>The number of entries in the colormap, for visuals of
-type <literal>gtk.gdk.VISUAL_PSEUDO_COLOR</literal> or
-<literal>gtk.gdk.VISUAL_GRAY_SCALE</literal>. For other visual types, it is
-the number of possible levels per color component. If the visual has
-different numbers of levels for different components, the value of this
-field is undefined.</entry>
- </row>
-
- <row valign="top">
- <entry>"depth"</entry>
- <entry>Read</entry>
- <entry>The number of bits per pixel.</entry>
- </row>
-
- <row valign="top">
- <entry>"green_mask"</entry>
- <entry>Read</entry>
- <entry>A mask giving the bits in a pixel value that correspond
-to the green field.</entry>
- </row>
-
- <row valign="top">
- <entry>"green_prec"</entry>
- <entry>Read</entry>
- <entry>See above.</entry>
- </row>
-
- <row valign="top">
- <entry>"green_shift"</entry>
- <entry>Read</entry>
- <entry>The <parameter>green_shift</parameter> and
-<parameter>green_prec</parameter> give an alternate presentation of the
-information in <parameter>green_mask</parameter>.</entry>
- </row>
-
- <row valign="top">
- <entry>"red_mask"</entry>
- <entry>Read</entry>
- <entry>A mask giving the bits in a pixel value that correspond
-to the red field. Significant only for
-<literal>gtk.gdk.VISUAL_PSEUDOCOLOR</literal> and
-<literal>gtk.gdk.VISUAL_DIRECTCOLOR</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"red_prec"</entry>
- <entry>Read</entry>
- <entry>See above.</entry>
- </row>
-
- <row valign="top">
- <entry>"red_shift"</entry>
- <entry>Read</entry>
- <entry>The <parameter>red_shift</parameter> and
-<parameter>red_prec</parameter> give an alternate presentation of the
-information in <parameter>red_mask</parameter>.
-<parameter>red_mask</parameter> is a contiguous sequence of
-<parameter>red_prec</parameter> bits starting at bit number
-<parameter>red_shift</parameter>.</entry>
- </row>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The type of this visual - one of:
-<literal>gtk.gdk.VISUAL_STATIC_GRAY</literal>,
-<literal>gtk.gdk.VISUAL_GRAYSCALE</literal>,
-<literal>gtk.gdk.VISUAL_STATIC_COLOR</literal>,
-<literal>gtk.gdk.VISUAL_PSEUDO_COLOR</literal>,
-<literal>gtk.gdk.VISUAL_TRUE_COLOR</literal>,
-<literal>gtk.gdk.VISUAL_DIRECT_COLOR</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
-describes a particular video hardware display format. It includes
-information about the number of bits used for each color, the way the bits
-are translated into an RGB value for display, and the way the bits are
-stored in memory. For example, a piece of display hardware might support
-24-bit color, 16-bit color, or 8-bit color; meaning 24/16/8-bit pixel sizes.
-For a given pixel size, pixels can be in different formats; for example the
-"red" element of an RGB pixel may be in the top 8 bits of the pixel, or may
-be in the lower 4 bits.</para>
-
- <para>Usually you can avoid thinking about visuals in
-<literal>PyGTK</literal>. Visuals are useful to interpret the contents of a
-<link linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>,
-but you should avoid <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link>
-precisely because its contents depend on the display hardware; use <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-instead, for all but the most low-level purposes. Also, anytime you provide
-a <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>,
-the visual is implied as part of the colormap (see the <link
-linkend="method-gdkcolormap--get-visual"><methodname>gtk.gdk.Colormap.get_visual</methodname>()</link>
-method), so you won't have to provide a visual in addition.</para>
-
- <para>There are several standard visuals. The visual returned by the
-<link
-linkend="function-gdk--visual-get-system"><methodname>gtk.gdk.visual_get_system</methodname>()</link>
-function is the system's default visual. The <link
-linkend="function-gdk--rgb-get-visual"><methodname>gtk.gdk.rgb_get_visual</methodname>()</link>
-function returns the visual most suited to displaying full-color image data.
-If you use the calls in GdkRGB, you should create your windows using this
-visual (and the colormap returned by the <link
-linkend="function-gdk--rgb-get-colormap"><methodname>gtk.gdk.rgb_get_colormap</methodname>()</link>
-function).</para>
-
- <para>A number of functions are provided for determining the "best"
-available visual. For the purposes of making this determination, higher bit
-depths are considered better, and for visuals of the same bit depth,
-<literal>gtk.gdk.VISUAL_PSEUDO_COLOR</literal> is preferred at 8bpp,
-otherwise, the visual types are ranked in the order of (highest to lowest)
-<literal>gtk.gdk.VISUAL_DIRECT_COLOR</literal>,
-<literal>gtk.gdk.VISUAL_TRUE_COLOR</literal>,
-<literal>gtk.gdk.VISUAL_PSEUDO_COLOR</literal>,
-<literal>gtk.gdk.VISUAL_STATIC_COLOR</literal>,
-<literal>gtk.gdk.VISUAL_GRAYSCALE</literal>, then
-<literal>gtk.gdk.VISUAL_STATIC_GRAY</literal>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkvisual">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Visual</methodname>
- <methodparam><parameter
- role="keyword">depth</parameter></methodparam>
- <methodparam><parameter
- role="keyword">visual_type</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">depth</parameter>&nbsp;:</term>
- <listitem><simpara>a bit depth</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">visual_type</parameter>&nbsp;:</term>
- <listitem><simpara>a visual type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the best <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> with
-both <parameter>depth</parameter> and <parameter>visual_type</parameter>, or
-<literal>None</literal> if none</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> that
-is the best choice for the specified <parameter>depth</parameter> and
-<parameter>visual_type</parameter>. Color visuals and visuals with mutable
-colormaps are preferred over grayscale or fixed-colormap visuals and visuals
-with higher color depths are considered better. The value of
-<parameter>visual_type</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_STATIC_GRAY</literal></term>
- <listitem>
- <simpara>Each pixel value indexes a grayscale value
-directly.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_GRAYSCALE</literal></term>
- <listitem>
- <simpara>Each pixel is an index into a color map that maps pixel
-values into grayscale values. The color map can be changed by an
-application.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_STATIC_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value is an index into a predefined,
-unmodifiable color map that maps pixel values into RGB values.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_PSEUDO_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel is an index into a color map that maps pixel
-values into rgb values. The color map can be changed by an
-application.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_TRUE_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value directly contains red, green, and blue
-components. The red_mask, green_mask, and blue_mask fields of the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
-structure describe how the components are assembled into a pixel
-value.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_DIRECT_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value contains red, green, and blue components
-as for <literal>gtk.gdk.TRUE_COLOR</literal>, but the components are mapped
-via a color table into the final output table instead of being converted
-directly. </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkvisual--get-screen">
- <title>gtk.gdk.Visual.get_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_screen</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the screen that this visual belongs
-to.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_screen</methodname>() method returns the
-<link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-that this visual belongs to.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--list-visuals">
- <title>gtk.gdk.list_visuals</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.list_visuals</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
-objects</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.list_visuals</function>() function returns
-a list containing the available <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
-objects for the default screen.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--visual-get-best">
- <title>gtk.gdk.visual_get_best</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.visual_get_best</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the best <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> for
-the default screen</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.visual_get_best</function>() function
-returns the visual with the most available colors for the default
-screen.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--visual-get-best-depth">
- <title>gtk.gdk.visual_get_best_depth</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.visual_get_best_depth</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> with
-the best depth.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.visual_get_best_depth</function>()
-function returns the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> with
-the best depth for the default screen where "best" means the largest</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--visual-get-best-type">
- <title>gtk.gdk.visual_get_best_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.visual_get_best_type</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> with
-the best type for the default screen</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.visual_get_best_type</function>() function
-returns the best available <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> type
-for the default screen.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--visual-get-best-with-depth">
- <title>gtk.gdk.visual_get_best_with_depth</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.visual_get_best_with_depth</methodname>
- <methodparam><parameter
- role="keyword">depth</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">depth</parameter>&nbsp;:</term>
- <listitem><simpara>the number of bits per
-pixel</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the best <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> for
-the specified <parameter>depth</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.visual_get_best_with_depth</function>()
-function returns the best <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> with
-the specified <parameter>depth</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--visual-get-best-with-type">
- <title>gtk.gdk.visual_get_best_with_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.visual_get_best_with_type</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a visual type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the best gdkVisual for the visual type
-specified by <parameter>type</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.visual_get_best_with_type</function>()
-function returns the best <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> for
-the visual type specified by <parameter>type</parameter>. The value of
-<parameter>visual_type</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_STATIC_GRAY</literal></term>
- <listitem>
- <simpara>Each pixel value indexes a grayscale value
-directly.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_GRAYSCALE</literal></term>
- <listitem>
- <simpara>Each pixel is an index into a color map that maps pixel
-values into grayscale values. The color map can be changed by an
-application.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_STATIC_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value is an index into a predefined,
-unmodifiable color map that maps pixel values into RGB values.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_PSEUDO_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel is an index into a color map that maps pixel
-values into rgb values. The color map can be changed by an
-application.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_TRUE_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value directly contains red, green, and blue
-components. The red_mask, green_mask, and blue_mask fields of the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
-structure describe how the components are assembled into a pixel
-value.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_DIRECT_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value contains red, green, and blue
-components as for <literal>gtk.gdk.TRUE_COLOR</literal>, but the components
-are mapped via a color table into the final output table instead of being
-converted directly. </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--visual-get-system">
- <title>gtk.gdk.visual_get_system</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.visual_get_system</methodname>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the system <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.gdk.visual_get_system</function>() function
-returns the default <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> for
-the system's default screen.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--query-depths">
- <title>gtk.gdk.query_depths</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.query_depths</methodname>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the unique supported
- visual depths</simpara></listitem>
- </varlistentry>
- </variablelist>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.query_depths</function>() function returns
-a tuple containing the unique supported visual depths for the default
-screen. It's equivalent to listing the visuals (see the <link
-linkend="function-gdk--list-visuals"><function>gtk.gdk.list_visuals</function>()</link>
-function) and then looking at the depth field in each visual, removing
-duplicates.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--query-visual-types">
- <title>gtk.gdk.query_visual_types</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.query_visual_types</methodname>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the system <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.gdk.query_visual_types</function>() function
-returns a tuple containing the unique visual types supported by the default
-screen.It's equivalent to listing the visuals (see the <link
-linkend="function-gdk--list-visuals"><function>gtk.gdk.list_visuals</function>()</link>
-function) and then looking at the type field in each visual, removing
-duplicates.</para>
-
- <para>The returned value will be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_STATIC_GRAY</literal></term>
- <listitem>
- <simpara>Each pixel value indexes a grayscale value
- directly.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_GRAYSCALE</literal></term>
- <listitem>
- <simpara>Each pixel is an index into a color map that maps pixel
- values into grayscale values. The color map can be changed by an
- application.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_STATIC_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value is an index into a predefined,
- unmodifiable color map that maps pixel values into RGB
- values.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_PSEUDO_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel is an index into a color map that maps pixel
- values into rgb values. The color map can be changed by an
- application.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_TRUE_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value directly contains red, green, and blue
- components. The red_mask, green_mask, and blue_mask fields of
- the <link
- linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
- structure describe how the components are assembled into a pixel
- value.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.VISUAL_DIRECT_COLOR</literal></term>
- <listitem>
- <simpara>Each pixel value contains red, green, and blue
- components as for <literal>gtk.gdk.VISUAL_TRUE_COLOR</literal>,
- but the components are mapped via a color table into the final
- output table instead of being converted directly.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gdkwindow.xml b/docs/reference/pygtk-gdkwindow.xml
deleted file mode 100644
index dd7a0b20..00000000
--- a/docs/reference/pygtk-gdkwindow.xml
+++ /dev/null
@@ -1,4414 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gdkwindow">
- <refnamediv>
- <refname>gtk.gdk.Window</refname>
- <refpurpose>on-screen display areas in the target window
-system</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.gdk.Window</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gdkdrawable">gtk.gdk.Drawable</link></classname></ooclass>
-
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gdkwindow">gtk.gdk.Window</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">window_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">event_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">wclass</parameter></methodparam>
- <methodparam><parameter role="keyword">title</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">x</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">y</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">visual</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">colormap</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">cursor</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">wmclass_name</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">wmclass_class</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">override_redirect</parameter>
- <initializer>-1</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--drag-begin">drag_begin</link></methodname>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--input-set-extension-events">input_set_extension_events</link></methodname>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--property-get">property_get</link></methodname>
- <methodparam><parameter
- role="keyword">property</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">pdelete</parameter>
- <initializer>False</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--property-change">property_change</link></methodname>
- <methodparam><parameter
- role="keyword">property</parameter></methodparam>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">format</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--property-delete">property_delete</link></methodname>
- <methodparam><parameter
- role="keyword">property</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--selection-convert">selection_convert</link></methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow- -selection-property-get">selection_property_get</link></methodname>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- <methodparam><parameter role="keyword">prop_type</parameter></methodparam>
- <methodparam><parameter role="keyword">prop_format</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--set-keep-above">set_keep_above</link></methodname>
- <methodparam><parameter role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--set-keep-below">set_keep_below</link></methodname>
- <methodparam><parameter role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--destroy">destroy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-window-type">get_window_type</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--show">show</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--hide">hide</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--withdraw">withdraw</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--move">move</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--resize">resize</link></methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--move-resize">move_resize</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--reparent">reparent</link></methodname>
- <methodparam><parameter
- role="keyword">new_parent</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--clear">clear</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--clear-area">clear_area</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--clear-area-e">clear_area_e</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--raise_">raise_</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--lower">lower</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--focus">focus</link></methodname>
- <methodparam><parameter role="keyword">timestamp</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--set-user-data">set_user_data</link></methodname>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--get-user-data">get_user_data</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-override-redirect">set_override_redirect</link></methodname>
- <methodparam><parameter
- role="keyword">override_redirect</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--add-filter">add_filter</link></methodname>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow- -remove-filter">remove_filter</link></methodname>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--scroll">scroll</link></methodname>
- <methodparam><parameter role="keyword">dx</parameter></methodparam>
- <methodparam><parameter role="keyword">dy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--shape-combine-mask">shape_combine_mask</link></methodname>
- <methodparam><parameter
- role="keyword">shape_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-child-shapes">set_child_shapes</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--merge-child-shapes">merge_child_shapes</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--is-visible">is_visible</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--is-viewable">is_viewable</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-state">get_state</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-static-gravities">set_static_gravities</link></methodname>
- <methodparam><parameter
- role="keyword">use_static</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-type-hint">set_type_hint</link></methodname>
- <methodparam><parameter
- role="keyword">hint</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-modal-hint">set_modal_hint</link></methodname>
- <methodparam><parameter
- role="keyword">modal</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--set-skip-taskbar-hint">set_skip_taskbar_hint</link></methodname>
- <methodparam><parameter
- role="keyword">skips_taskbar</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--set-skip-pager-hint">set_skip_pager_hint</link></methodname>
- <methodparam><parameter
- role="keyword">skips_pager</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--set-geometry-hints">set_geometry_hints</link></methodname>
- <methodparam><parameter role="keyword">min_width</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">min_height</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">max_width</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">max_height</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">base_width</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">base_height</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">width_inc</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">height_inc</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">min_aspect</parameter><initializer>-1.0</initializer></methodparam>
- <methodparam><parameter role="keyword">max_aspect</parameter><initializer>-1.0</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--begin-paint-rect">begin_paint_rect</link></methodname>
- <methodparam><parameter
- role="keyword">rectangle</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--begin-paint-region">begin_paint_region</link></methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--end-paint">end_paint</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-title">set_title</link></methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-role">set_role</link></methodname>
- <methodparam><parameter
- role="keyword">role</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-transient-for">set_transient_for</link></methodname>
- <methodparam><parameter
- role="keyword">leader</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-background">set_background</link></methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-back-pixmap">set_back_pixmap</link></methodname>
- <methodparam><parameter
- role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">parent_relative</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-cursor">set_cursor</link></methodname>
- <methodparam><parameter
- role="keyword">cursor</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-geometry">get_geometry</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-position">get_position</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-origin">get_origin</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-root-origin">get_root_origin</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-frame-extents">get_frame_extents</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-pointer">get_pointer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-parent">get_parent</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-toplevel">get_toplevel</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-children">get_children</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-events">get_events</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-events">set_events</link></methodname>
- <methodparam><parameter
- role="keyword">event_mask</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--set-icon-list">set_icon_list</link></methodname>
- <methodparam><parameter role="keyword">pixbufs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-icon">set_icon</link></methodname>
- <methodparam><parameter
- role="keyword">icon_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-icon-name">set_icon_name</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-group">set_group</link></methodname>
- <methodparam><parameter
- role="keyword">leader</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-group">get_group</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-decorations">set_decorations</link></methodname>
- <methodparam><parameter
- role="keyword">decorations</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--get-decorations">get_decorations</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--set-functions">set_functions</link></methodname>
- <methodparam><parameter
- role="keyword">functions</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--iconify">iconify</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--deiconify">deiconify</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--stick">stick</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--unstick">unstick</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--maximize">maximize</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--unmaximize">unmaximize</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--fullscreen">fullscreen</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--unfullscreen">unfullscreen</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--register-dnd">register_dnd</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--begin-resize-drag">begin_resize_drag</link></methodname>
- <methodparam><parameter
- role="keyword">edge</parameter></methodparam>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">timestamp</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--begin-move-drag">begin_move_drag</link></methodname>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">timestamp</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--invalidate-rect">invalidate_rect</link></methodname>
- <methodparam><parameter
- role="keyword">rect</parameter></methodparam>
- <methodparam><parameter
- role="keyword">invalidate_children</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--invalidate-region">invalidate_region</link></methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- <methodparam><parameter role="keyword">invalidate_children</parameter></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow- -invalidate-maybe-recurse">invalidate_maybe_recurse</link></methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- <methodparam><parameter role="keyword">(*child_func</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--get-update-area">get_update_area</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--freeze-updates">freeze_updates</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--thaw-updates">thaw_updates</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--process-updates">process_updates</link></methodname>
- <methodparam><parameter
- role="keyword">update_children</parameter></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow- -get-internal-paint-info">get_internal_paint_info</link></methodname>
- <methodparam><parameter role="keyword">real_drawable</parameter></methodparam>
- <methodparam><parameter role="keyword">x_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">y_offset</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--set-accept-focus">set_accept_focus</link></methodname>
- <methodparam><parameter role="keyword">accept_focus</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--enable-synchronized-configure">enable_synchronized_configure</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--configure-finished">configure_finished</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--set-focus-on-map">set_focus_on_map</link></methodname>
- <methodparam><parameter role="keyword">focus_on_map</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--set-urgency-hint">set_urgency_hint</link></methodname>
- <methodparam><parameter role="keyword">urgent</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gdkwindow--move-region">move_region</link></methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- <methodparam><parameter role="keyword">dx</parameter></methodparam>
- <methodparam><parameter role="keyword">dy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--shape-combine-region">shape_combine_region</link></methodname>
- <methodparam><parameter
- role="keyword">shape_region</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--input-shape-combine-mask">input_shape_combine_mask</link></methodname>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gdkwindow--input-shape-combine-region">input_shape_combine_region</link></methodname>
- <methodparam><parameter
- role="keyword">shape_region</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-foreign-new">gtk.gdk.window_foreign_new</link></methodname>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-foreign-new-for-display">gtk.gdk.window_foreign_new_for_display</link></methodname>
- <methodparam><parameter
- role="keyword">display</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--get-default-root-window">gtk.gdk.get_default_root_window</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-get-toplevels">gtk.gdk.window_get_toplevels</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-lookup">gtk.gdk.window_lookup</link></methodname>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-lookup-for-display">gtk.gdk.window_lookup_for_display</link></methodname>
- <methodparam><parameter
- role="keyword">display</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-process-all-updates">gtk.gdk.window_process_all_updates</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--gdk-window-set-debug-updates">gtk.gdk.gdk_window_set_debug_updates</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gdk--window-at-pointer">gtk.gdk.window_at_pointer</link></methodname>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gdkdrawable">gtk.gdk.Drawable</link>
- +-- <link linkend="class-gdkwindow">gtk.gdk.Window</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para> <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> is a
-rectangular region on the screen. It's a low-level object, used to implement
-high-level objects such as <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> and <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>. A <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> is a
-toplevel window, the object a user might think of as a "window" with a
-titlebar and so on. A <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> may
-contain several <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-objects since most widgets use a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</para>
-
- <para>A <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-object interacts with the native window system for input and events. Some
-<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-objects do not have an associated <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> and
-therefore cannot receive events. To receive events on behalf of these
-"windowless" widgets a <link
-linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link> must
-be used.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gdkwindow">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.gdk.Window</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">window_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">event_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">wclass</parameter></methodparam>
- <methodparam><parameter role="keyword">title</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">x</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">y</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">visual</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">colormap</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">cursor</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">wmclass_name</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">wmclass_class</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">override_redirect</parameter>
- <initializer>-1</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the window in
-pixels</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the window in
-pixels</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">window_type</parameter>&nbsp;:</term>
- <listitem><simpara>the window type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">event_mask</parameter>&nbsp;:</term>
- <listitem><simpara>the bitmask of events received by the
-window</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">wclass</parameter>&nbsp;:</term>
- <listitem><simpara>the class of window - either
-<literal>gtk.gdk.INPUT_OUTPUT</literal> or
-<literal>gtk.gdk.INPUT_ONLY</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>the window title if a toplevel
-window</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x coordinate of the window position relative
-to <parameter>parent</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y coordinate of the window position relative
-to <parameter>parent</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">visual</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> for
-the window</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-for the window</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">cursor</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link> for
-the window</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">wmclass_name</parameter>&nbsp;:</term>
- <listitem><simpara>don't use this - see the <link
-linkend="method-gtkwindow--set-wmclass"><methodname>gtk.Window.set_wmclass</methodname>()</link>
-method for more information.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">wmclass_class</parameter>&nbsp;:</term>
- <listitem><simpara>don't use this - see the <link
-linkend="method-gtkwindow--set-wmclass"><methodname>gtk.Window.set_wmclass</methodname>()</link>
-method for more information.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">override_redirect</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> bypass the window
-manager</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-the type and class specified by <parameter>window_type</parameter> and
-<parameter>wclass</parameter>. The window will be a child of the specified
-<parameter>parent</parameter> and will have the specified
-<parameter>width</parameter> and <parameter>height</parameter>.
-<parameter>event_mask</parameter> is a bitfield specifying the events that
-the window will receive - see the <link
-linkend="method-gdkwindow--set-events"><methodname>set_events</methodname>()</link>
-method for more information. The value of <parameter>window_type</parameter>
-must be one of the <xref linkend="gdk-window-type-constants"
-endterm="gdk-window-type-constants-title"></xref>.</para>
-
- <para>The value of <parameter>wclass</parameter> must be one of the
-<xref linkend="gdk-window-class-constants"
-endterm="gdk-window-class-constants-title"></xref>.</para>
-
- <para>If the optional parameters are not specified the corresponding
-attribute values will have default values:</para>
-
- <variablelist>
- <varlistentry>
- <term><parameter>x</parameter></term>
- <listitem>
- <simpara>0</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>y</parameter></term>
- <listitem>
- <simpara>0</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>visual</parameter></term>
- <listitem>
- <simpara>the default system visual - see the <link
-linkend="function-gdk--visual-get-system"><function>gtk.gdk.visual_get_system</function>()</link>
-function</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>colormap</parameter></term>
- <listitem>
- <simpara>either the system <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-if using the system <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> (see
-the <link
-linkend="function-gdk--colormap-get-system"><function>gtk.gdk.colormap_get_system</function>()</link>
-function) or a new <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-using <parameter>visual</parameter></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>cursor</parameter></term>
- <listitem>
- <simpara>use the parent window's cursor</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>override_redirect</parameter></term>
- <listitem>
- <simpara>False</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gdkwindow--drag-begin">
- <title>gtk.gdk.Window.drag_begin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_begin</methodname>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a list of offered targets</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_begin</methodname>() method starts a drag
-operation and returns the new <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link>
-created for it. The list of targets (integer values) supported by the drag
-source are specified by <parameter>targets</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--input-set-extension-events">
- <title>gtk.gdk.Window.input_set_extension_events</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>input_set_extension_events</methodname>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mask</parameter>&nbsp;:</term>
- <listitem><simpara>the event mask to be used</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">mode</parameter>&nbsp;:</term>
- <listitem><simpara>the set of extension events to
-receive</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>input_set_extension_events</methodname>() method
-enables or disables the extension events specified by
-<parameter>mode</parameter> for the window when using the event mask
-specified by <parameter>mask</parameter>. The value of
-<parameter>mode</parameter> must be one of the <xref
-linkend="gdk-extension-mode-constants"
-endterm="gdk-extension-mode-constants-title">.</xref></para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--property-get">
- <title>gtk.gdk.Window.property_get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>property_get</methodname>
- <methodparam><parameter
- role="keyword">property</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">pdelete</parameter>
- <initializer>False</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">property</parameter>&nbsp;:</term>
- <listitem><simpara>the property to get</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of property to get or not specified if
-any type of property data is acceptable.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pdelete</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, delete the property
-after retrieving the data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the actual property type,
-the data format and the data</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>property_get</methodname>() method returns a
-tuple containing the actual property type (as a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>), the
-format and the data of the specified <parameter>property</parameter> with
-the specified <parameter>type</parameter>. The value of
-<parameter>type</parameter> may not be be specified in which case it will be
-0 to match any type of property. the returned data will be a string if the
-data format is 8; a list of integers if the data format is 16; or, a list of
-<link linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>
-objects or integers if the data format is 32. If
-<parameter>property</parameter> cannot be found <literal>None</literal> is
-returned. <parameter>property</parameter> and <parameter>type</parameter>
-(if specified) must be a string or a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--property-change">
- <title>gtk.gdk.Window.property_change</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>property_change</methodname>
- <methodparam><parameter
- role="keyword">property</parameter></methodparam>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">format</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">property</parameter>&nbsp;:</term>
- <listitem><simpara>the property to change</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the new type of the property. If
-<parameter>mode</parameter> is <literal>gtk.gdk.PROP_MODE_PREPEND</literal>
-or <literal>gtk.gdk.PROP_MODE_APPEND</literal>, then this must match the
-existing type or an error will occur.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">format</parameter>&nbsp;:</term>
- <listitem><simpara>the new format for the property. If
-<parameter>mode</parameter> is <literal>gtk.gdk.PROP_MODE_PREPEND</literal>
-or <literal>gtk.gdk.PROP_MODE_APPEND</literal>, then this must match the
-existing format or an error will occur.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">mode</parameter>&nbsp;:</term>
- <listitem><simpara>a value describing how the new data is to be
-combined with the current data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>the data for the property</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>property_change</methodname>() method changes
-the contents of the specified <parameter>property</parameter> to the
-specified <parameter>data</parameter> with the specified
-<parameter>type</parameter> and <parameter>format</parameter>. The value of
-<parameter>mode</parameter> must be one of the <xref
-linkend="gdk-property-mode-constants"
-endterm="gdk-property-mode-constants-title"></xref> which describes how the
-new data is to be combined with the existing property data.The value of
-<parameter>format</parameter> must be 8, 16 or
-32. <parameter>property</parameter> and <parameter>type</parameter> must be
-a string or a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--property-delete">
- <title>gtk.gdk.Window.property_delete</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>property_delete</methodname>
- <methodparam><parameter
- role="keyword">property</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">property</parameter>&nbsp;:</term>
- <listitem><simpara>the property to delete</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>property_delete</methodname>() method deletes
-the specified <parameter>property</parameter> from the window.
-<parameter>property</parameter> must be a string or a gtk.gdk.Atom.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--selection-convert">
- <title>gtk.gdk.Window.selection_convert</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>selection_convert</methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>the selection to retrieve</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>the target form of
-<parameter>selection</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp to use when retrieving
-<parameter>selection</parameter>. The selection owner may refuse the request
-if it did not own the selection at the time indicated by the
-timestamp.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>selection_convert</methodname>() method converts
-the specified <parameter>selection</parameter> to the specified
-<parameter>form</parameter>.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gdkwindow- -selection-property-get">
- <title>gtk.gdk.Window.selection_property_get</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>selection_property_get</methodname>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- <methodparam><parameter role="keyword">prop_type</parameter></methodparam>
- <methodparam><parameter role="keyword">prop_format</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>a guchar**</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">prop_type</parameter>&nbsp;:</term>
- <listitem><simpara>a GdkAtom*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">prop_format</parameter>&nbsp;:</term>
- <listitem><simpara>a gint*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gboolean</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gdkwindow--set-keep-above">
- <title>gtk.gdk.Window.set_keep_above</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_keep_above</methodname>
- <methodparam><parameter role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>xif <literal>True</literal> keep the window
- above other windows</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_keep_above</methodname>() method sets the
-"keep-above" setting to the value of <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal> the window must be
-kept above other windows. If the window is already above, then this method
-does nothing.</para>
-
- <para>On X11, asks the window manager to keep the window above, if the
-window manager supports this operation. Not all window managers support
-this, and some deliberately ignore it or don't have a concept of "keep
-above", but most standard window managers do.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-keep-below">
- <title>gtk.gdk.Window.set_keep_below</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_keep_below</methodname>
- <methodparam><parameter role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, keep the window
- below other windows</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_keep_below</methodname>() method sets the
-"keep-below" setting to the value of <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal> the window must be
-kept below other windows. If the window was already below, then this
-method does nothing.</para>
-
- <para>On X11, asks the window manager to keep the window below, if the
-window manager supports this operation. Not all window managers support
-this, and some deliberately ignore it or don't have a concept of "keep
-below" but most standard window managers do.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--destroy">
- <title>gtk.gdk.Window.destroy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>destroy</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>destroy</methodname>() method destroys the
-window (destroys the server-side resource associated with the window). All
-children of the window are also destroyed. There's normally no need to use
-this method since windows are automatically destroyed when their reference
-count reaches 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-window-type">
- <title>gtk.gdk.Window.get_window_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_window_type</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the type of window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_window_type</methodname>() method returns
-the type of the window which is one of the <xref
-linkend="gdk-window-type-constants"
-endterm="gdk-window-type-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--show">
- <title>gtk.gdk.Window.show</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>show</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>show</methodname>() method maps the window so
-it's visible on-screen and also raises it to the top of the window stack
-(moves the window to the front of the Z-order). This method is opposite to
-the <link
-linkend="method-gdkwindow--hide"><methodname>hide</methodname>()</link>
-method. When implementing a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>, you
-should call this method on the widget's <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> as
-part of the "map" method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--hide">
- <title>gtk.gdk.Window.hide</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>hide</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>hide</methodname>() method withdraws toplevel
-windows, so they will no longer be known to the window manager and for all
-windows, unmaps them, so they won't be displayed. This is normally done
-automatically as part of the <link
-linkend="method-gtkwidget--hide"><methodname>gtk.Widget.hide</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--withdraw">
- <title>gtk.gdk.Window.withdraw</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>withdraw</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>withdraw</methodname>() method withdraws the
-window (unmaps it and asks the window manager to forget about it). This is
-normally done automatically by the <link
-linkend="method-gtkwidget--hide"><methodname>gtk.Widget.hide</methodname>()</link>
-method called on a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--move">
- <title>gtk.gdk.Window.move</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate relative to the window's
-parent</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate relative to the window's
-parent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>move</methodname>() method repositions the
-window to the location specified by <parameter>x</parameter> and
-<parameter>y</parameter> relative to its parent window. For toplevel
-windows, window managers may ignore or modify the move. You should probably
-use the <link
-linkend="method-gtkwindow--move"><methodname>gtk.Window.move</methodname>()</link>
-method on a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> widget
-anyway, instead of using this method. For child windows, the move will
-reliably succeed. If you're also planning to resize the window, use the
-<link
-linkend="method-gdkwindow--move-resize"><methodname>move_resize</methodname>()</link>
-method to both move and resize simultaneously, for a nicer visual
-effect.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--resize">
- <title>gtk.gdk.Window.resize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>resize</methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the new width of the
-window</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the new height of the
-window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>resize</methodname>() method resizes the window
-to the specified <parameter>width</parameter> and
-<parameter>height</parameter>. For toplevel windows, this method asks the
-window manager to resize the window. However, the window manager may not
-allow the resize. You should use the <link
-linkend="method-gtkwindow--resize"><methodname>gtk.Window.resize</methodname>()</link>
-method instead of this low-level method. Windows may not be resized smaller
-than 1x1. If you're also planning to move the window, use the <link
-linkend="method-gdkwindow--move-resize"><methodname>move_resize</methodname>()</link>
-method to both move and resize simultaneously, for a nicer visual
-effect.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--move-resize">
- <title>gtk.gdk.Window.move_resize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_resize</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the new X position relative to the window's
-parent</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the new Y position relative to the window's
-parent</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the new width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the new height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>move_resize</methodname>() method repositions
-the window to the location specified by <parameter>x</parameter> and
-<parameter>y</parameter> with the size specified by
-<parameter>width</parameter> and <parameter>height</parameter>. This method
-is equivalent to calling the <link
-linkend="method-gdkwindow--move"><methodname>move</methodname>()</link> and
-<link
-linkend="method-gdkwindow--resize"><methodname>resize</methodname>()</link>
-methods, except that both operations are performed at once, avoiding strange
-visual effects. (i.e. the user may be able to see the window first move,
-then resize, if you don't use the <methodname>move_resize</methodname>()
-method.)</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--reparent">
- <title>gtk.gdk.Window.reparent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reparent</methodname>
- <methodparam><parameter
- role="keyword">new_parent</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">new_parent</parameter>&nbsp;:</term>
- <listitem><simpara>the new parent <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> to
-move the window into</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X location inside the new
-parent</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y location inside the new
-parent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>reparent</methodname>() method reparents the
-window into the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-specified <parameter>new_parent</parameter>. The window being reparented
-will be unmapped as a side effect.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--clear">
- <title>gtk.gdk.Window.clear</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>clear</methodname>() method clears an entire the
-window to the background color or background pixmap.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--clear-area">
- <title>gtk.gdk.Window.clear_area</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear_area</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the rectangle to
-clear</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the rectangle to
-clear</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the rectangle to
-clear</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the rectangle to
-clear</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>clear_area</methodname>() method clears the area
-(specified by <parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>) of the
-window to the background color or background pixmap.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--clear-area-e">
- <title>gtk.gdk.Window.clear_area_e</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear_area_e</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the rectangle to
-clear</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the rectangle to
-clear</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the rectangle to
-clear</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the rectangle to
-clear</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>clear_area_e</methodname>() method is like the
-<link
-linkend="method-gdkwindow--clear-area"><methodname>clear_area</methodname>()</link>,
-but also generates an expose event for the cleared area.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--raise_">
- <title>gtk.gdk.Window.raise_</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>raise_</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>raise_</methodname>() method raises the window to
-the top of the Z-order (stacking order), so that other windows with the same
-parent window appear below the window. If the window is a toplevel, the
-window manager may choose to deny the request to move the window in the
-Z-order. Therefore, the <link
-linkend="method-gdkwindow--raise_"><methodname>raise_</methodname>()</link>
-method only requests the restack, it does not guarantee it.</para>
-
- <note><para>
- This method is called <methodname>raise</methodname>() in
- the C API, but was renamed <methodname>raise_</methodname>()
- since <literal>raise</literal> is a reserved Python keyword.
- </para></note>
- </refsect2>
-
- <refsect2 id="method-gdkwindow--lower">
- <title>gtk.gdk.Window.lower</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>lower</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The lower() method lowers the window to the bottom of the
-Z-order (stacking order), so that other windows with the same parent window
-appear above the window. If the window is a toplevel, the window manager may
-choose to deny the request to move the window in the Z-order. Therefore, the
-<link
-linkend="method-gdkwindow--lower"><methodname>lower</methodname>()</link>
-only requests the restack, it does not guarantee it. Note that the <link
-linkend="method-gdkwindow--show"><methodname>show</methodname>()</link>
-method raises the window again, so don't call this method before calling the
-<link
-linkend="method-gdkwindow--show"><methodname>show</methodname>()</link>
-method to avoid duplication.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--focus">
- <title>gtk.gdk.Window.focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>focus</methodname>
- <methodparam><parameter role="keyword">timestamp</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp of the event triggering the
-window focus</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>focus</methodname>() method sets keyboard focus
-to the window. If the window is not on-screen this will not work. In most
-cases, the <link
-linkend="method-gtkwindow--present"><methodname>gtk.Window.present</methodname>()</link>
-method should be used on a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>, rather
-than calling this method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-user-data">
- <title>gtk.gdk.Window.set_user_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_user_data</methodname>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_user_data</methodname>() method stores the
-underlying GTK+ widget of the PyGTK widget that is specified by
-<parameter>user_data</parameter> as the user data of the window. In general
-GTK+ stores the widget that owns a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> as
-user data on a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>. So,
-custom widget implementations in <literal>PyGTK</literal> should use this
-method to provide that capability. If <literal>GTK+</literal> receives an
-event for a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>, and
-the user data for the window is set, <literal>GTK+</literal> will assume the
-user data is a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>, and
-forward the event to that widget.</para>
-
- <para>In PyGTK 2.4 and above this method will raise the TypeError
-exception if <parameter>user_data</parameter> is not a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.</para>
-
- <note>
- <para>This method is deprecated for any use other than the above. To
-set other user data on a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> use
-the <link
-linkend="method-gobject--set-data"><methodname>gobject.GObject.set_data</methodname>()</link>
-method instead.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-user-data">
- <title>gtk.gdk.Window.get_user_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_user_data</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the user data set on the
- window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_user_data</methodname>() method returns the
-PyGTK widget that was set as the user data of the window using the <link
-linkend="method-gdkwindow--set-user-data"><methodname>set_user_data</methodname>()</link>
-method. This method raises the ValueError exception if the user data is not
-set or is not a PyGTK object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-override-redirect">
- <title>gtk.gdk.Window.set_override_redirect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_override_redirect</methodname>
- <methodparam><parameter
- role="keyword">override_redirect</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">override_redirect</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the window should be
-override redirect</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_override_redirect</methodname>() method sets
-the "override redirect" attribute on the window to the value specified by
-<parameter>override_redirect</parameter>. If
-<parameter>override_redirect</parameter> is <literal>True</literal> the
-window is not under the control of the window manager. This means it won't
-have a titlebar, won't be minimizable, etc. - it will be entirely under the
-control of the application. The window manager can't see the override
-redirect window at all. Override redirect should only be used for
-short-lived temporary windows, such as popup menus. <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> uses an
-override redirect window in its implementation, for example. This method
-does not work on MS Windows.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--add-filter">
- <title>gtk.gdk.Window.add_filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_filter</methodname>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">function</parameter>&nbsp;:</term>
- <listitem><simpara>a function</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>data to pass to
- <parameter>function</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>add_filter</methodname>() method adds an event
-filter function specified by <parameter>function</parameter> to the window,
-allowing you to intercept events before they reach GDK. This is a low-level
-operation and makes it easy to break GDK and/or GTK+, so you have to know
-what you're doing. Once added there is no way to remove a filter
-function. The function signature is:</para>
-
- <programlisting>
- def function(<parameter>event</parameter>, <parameter>user_data</parameter>)
-</programlisting>
-
- <para>where <parameter>event</parameter> is a <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> and
-<parameter>user_data</parameter> is <parameter>data</parameter>. If
-<parameter>data</parameter> is not specified then
-<parameter>user_data</parameter> is not passed to
-<parameter>function</parameter>.</para>
-
- <para><parameter>function</parameter> should return one of the
-following values which is on of the <xref
-linkend="gdk-filter-return-constants"
-endterm="gdk-filter-return-constants-title"></xref>.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gdkwindow- -remove-filter">
- <title>gtk.gdk.Window.remove_filter</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>remove_filter</methodname>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">function</parameter>&nbsp;:</term>
- <listitem><simpara>previously-added filter function</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>user data for previously-added filter function</simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-Remove a filter previously added with <link linkend="method-gdkwindow- -add-filter"><function>gtk.gdk.Window.add_filter()</function></link>.
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gdkwindow--scroll">
- <title>gtk.gdk.Window.scroll</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>scroll</methodname>
- <methodparam><parameter
- role="keyword">dx</parameter></methodparam>
- <methodparam><parameter
- role="keyword">dy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dx</parameter>&nbsp;:</term>
- <listitem><simpara>the amount to scroll in the X
-direction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dy</parameter>&nbsp;:</term>
- <listitem><simpara>the amount to scroll in the Y
-direction</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>scroll</methodname>() method scrolls the
-contents of the window, both pixels and children, by the horizontal and
-vertical amounts specified by <parameter>dx</parameter> and
-<parameter>dy</parameter> respectively. The window itself does not move.
-Portions of the window that the scroll operation brings in from off-screen
-areas are invalidated. The invalidated region may be bigger than what would
-strictly be necessary. (For X11, a minimum area will be invalidated if the
-window has no subwindows, or if the edges of the window's parent do not
-extend beyond the edges of the window. In other cases, a multi-step process
-is used to scroll the window which may produce temporary visual artifacts
-and unnecessary invalidations.)</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--shape-combine-mask">
- <title>gtk.gdk.Window.shape_combine_mask</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>shape_combine_mask</methodname>
- <methodparam><parameter
- role="keyword">shape_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">shape_mask</parameter>&nbsp;:</term>
- <listitem><simpara>the shape bitmap mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position of shape mask with respect to
-the window</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position of shape mask with respect to
-the window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>shape_combine_mask</methodname>() method applies
-the bitmap mask specified by <parameter>shape_mask</parameter> to the window
-at the location specified by <parameter>x</parameter> and
-<parameter>y</parameter>. Pixels in the window corresponding to set bits in
-the <parameter>shape_mask</parameter> will be visible; pixels in the window
-corresponding to unset bits in the <parameter>shape_mask</parameter> will be
-transparent. This method provides a non-rectangular window. If
-<parameter>shape_mask</parameter> is <literal>None</literal>, the shape mask
-will be unset, and the <parameter>x</parameter>/<parameter>y</parameter>
-parameters are not used.</para>
-
- <para>On the X11 platform, this uses an X server extension which is
-widely available on most common platforms, but not available on very old X
-servers, and occasionally the implementation will be buggy. On servers
-without the shape extension, this function will do nothing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-child-shapes">
- <title>gtk.gdk.Window.set_child_shapes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_child_shapes</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>set_child_shapes</methodname>() method sets the
-shape mask of the window to the union of shape masks for all children of the
-window, ignoring the shape mask of the window itself. Contrast this method
-with the <link
-linkend="method-gdkwindow--merge-child-shapes"><methodname>merge_child_shapes</methodname>()</link>
-method that includes the shape mask of the window in the masks to be
-merged.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--merge-child-shapes">
- <title>gtk.gdk.Window.merge_child_shapes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>merge_child_shapes</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>merge_child_shapes</methodname>() method merges
-the shape masks for any child windows into the shape mask for the window.
-i.e. the union of all masks for the window and its children will become the
-new mask for the window. See the <link
-linkend="method-gdkwindow--shape-combine-mask"><methodname>shape_combine_mask</methodname>()</link>
-method. This method is distinct from the <link
-linkend="method-gdkwindow--set-child-shapes"><methodname>set_child_shapes</methodname>()</link>
-method because it includes the window's shape mask in the set of shapes to
-be merged.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--is-visible">
- <title>gtk.gdk.Window.is_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_visible</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the window is
-mapped</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_visible</methodname>() method returns
-<literal>True</literal> if the window has been mapped (with the <link
-linkend="method-gdkwindow--show"><methodname>show</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--is-viewable">
- <title>gtk.gdk.Window.is_viewable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_viewable</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the window is
-viewable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_viewable</methodname>() method returns
-<literal>True</literal> if the window and all its ancestors are mapped.
-(This is not necessarily "viewable" in the X sense, since we only check as
-far as we have <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-parents, not to the root window.)</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-state">
- <title>gtk.gdk.Window.get_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_state</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the window state bitfield</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_state</methodname>() method returns the
-bitwise <literal>OR</literal> of the currently active <xref
-linkend="gdk-window-state-constants"
-endterm="gdk-window-state-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-static-gravities">
- <title>gtk.gdk.Window.set_static_gravities</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_static_gravities</methodname>
- <methodparam><parameter
- role="keyword">use_static</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">use_static</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> turn on static
-gravity</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the server supports
-static gravity</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_static_gravities</methodname>() method sets
-the bit gravity of the given window to the value specified by
-<parameter>use_static</parameter>. If <parameter>use_static</parameter> is
-<literal>True</literal> the window uses static gravity and all children get
-static subwindow gravity as well. This method returns
-<literal>True</literal> if the window system server supports static
-gravity.</para>
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-type-hint">
- <title>gtk.gdk.Window.set_type_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_type_hint</methodname>
- <methodparam><parameter
- role="keyword">hint</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">hint</parameter>&nbsp;:</term>
- <listitem><simpara>a hint of the function this window will
-have</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_type_hint</methodname>() method provides the
-specified <parameter>hint</parameter> to the window manager about the
-functionality of a window. The window manager can use this information when
-determining the decoration and behavior of the window. The hint must be set
-before the window is mapped. The value of hint must be one of the <xref
-linkend="gdk-window-type-hint-constants"
-endterm="gdk-window-type-hint-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-modal-hint">
- <title>gtk.gdk.Window.set_modal_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_modal_hint</methodname>
- <methodparam><parameter
- role="keyword">modal</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">modal</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the window is
-modal.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_modal_hint</methodname>() method sets the
-window's modal hint to the value specified by <parameter>modal</parameter>.
-If <parameter>modal</parameter> is <literal>True</literal> the window is
-modal. The window manager can use this information to handle modal windows
-in a special way which usually means that the window gets all the input for
-the application effectively blocking input to other windows in the
-application. . You should only use this on windows for which you have
-previously called the <link
-linkend="method-gdkwindow--set-transient-for"><methodname>set_transient_for</methodname>()</link>
-method</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-skip-taskbar-hint">
- <title>gtk.gdk.Window.set_skip_taskbar_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_skip_taskbar_hint</methodname>
- <methodparam><parameter role="keyword">modal</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">skip_taskbar</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> skip the
- taskbar.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_skip_taskbar_hint</methodname>() method sets
-the "skip_taskbar" setting to the value specified by
-<parameter>skips_taskbar</parameter>. If
-<parameter>skips_taskbar</parameter> is <literal>True</literal> the window
-should <emphasis role="bold">not</emphasis> appear in a task list or window
-list. If the window's semantic type as specified with the <link
-linkend="method-gdkwindow--set-type-hint"><methodname>set_type_hint()</methodname></link>
-method already fully describes the window, this method should <emphasis
-role="bold">not</emphasis> be called in addition; instead you should allow
-the window to be treated according to standard policy for its semantic
-type.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-skip-pager-hint">
- <title>gtk.gdk.Window.set_skip_pager_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_skip_pager_hint</methodname>
- <methodparam><parameter role="keyword">skips_pager</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">skips_pager</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> skip the pager</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_skip_pager_hint</methodname>() method sets
-the "skip_pager" setting to the value of skips_pager. If skips_pager is True
-the window should <emphasis role="bold">not</emphasis> appear in a pager (a
-workspace switcher, or other desktop utility program that displays a small
-thumbnail representation of the windows on the desktop). If the window's
-semantic type as specified with <link
-linkend="method-gdkwindow--set-type-hint"><methodname>set_type_hint()</methodname></link>
-already fully describes the window, this method should <emphasis
-role="bold">not</emphasis> be called in addition, instead you should allow
-the window to be treated according to standard policy for its semantic
-type.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-geometry-hints">
- <title>gtk.gdk.Window.set_geometry_hints</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_geometry_hints</methodname>
- <methodparam><parameter role="keyword">min_width</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">min_height</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">max_width</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">max_height</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">base_width</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">base_height</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">width_inc</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">height_inc</parameter><initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">min_aspect</parameter><initializer>-1.0</initializer></methodparam>
- <methodparam><parameter role="keyword">max_aspect</parameter><initializer>-1.0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">min_width</parameter>&nbsp;:</term>
- <listitem><simpara>minimum width of window or -1 to use
-requisition</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">min_height</parameter>&nbsp;:</term>
- <listitem><simpara>minimum height of window or -1 to use
-requisition</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">max_width</parameter>&nbsp;:</term>
- <listitem><simpara>maximum width of window or -1 to use
-requisition</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">max_height</parameter>&nbsp;:</term>
- <listitem><simpara>maximum height of window or -1 to use
-requisition</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">base_width</parameter>&nbsp;:</term>
- <listitem><simpara>allowed window widths are
-base_width + width_inc * N (where N is any integer) or
--1</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">base_height</parameter>&nbsp;:</term>
- <listitem><simpara>allowed window widths are
-base_height + height_inc * N (where N is any integer) or
--1</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width_inc</parameter>&nbsp;:</term>
- <listitem><simpara>width resize increment</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height_inc</parameter>&nbsp;:</term>
- <listitem><simpara>height resize increment</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">min_aspect</parameter>&nbsp;:</term>
- <listitem><simpara>minimum width/height ratio</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">max_aspect</parameter>&nbsp;:</term>
- <listitem><simpara>maximum width/height ratio</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_geometry_hints</methodname>() method sets
-the geometry hints for the window.</para>
-
- <para>This method provides hints to the windowing system about
-acceptable sizes for a toplevel window. The purpose of this is to constrain
-user resizing, but the windowing system will typically (but is not required
-to) also constrain the current size of the window to the provided values and
-constrain programmatic resizing via gdk_window_resize() or
-gdk_window_move_resize().</para>
-
- <para>Note that on X11, this effect has no effect on windows of type
-GDK_WINDOW_TEMP or windows where override_redirect has been turned on via
-the <link
-linkend="method-gdkwindow--set-override-redirect"><methodname>set_override_redirect</methodname>()</link>
-method since these windows are not resizable by the user.</para>
-
-<!-- <para>Since you can't count on the windowing system doing the
-constraints for programmatic resizes, you should generally call the <link
-linkend="function-gdk- -window-constrain-size"><function>gtk.gdk.window_constrain_size</function>()</link>
-function yourself to determine appropriate sizes.</para>-->
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--begin-paint-rect">
- <title>gtk.gdk.Window.begin_paint_rect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>begin_paint_rect</methodname>
- <methodparam><parameter
- role="keyword">rectangle</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">rectangle</parameter>&nbsp;:</term>
- <listitem><simpara>the rectangle you intend to draw
-to</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>begin_paint_rect</methodname>() method indicates
-that you are beginning the process of redrawing the area specified by
-<parameter>rectangle</parameter>. A backing store (off-screen buffer) large
-enough to contain <parameter>rectangle</parameter> will be created. The
-backing store will be initialized with the background color or background
-pixmap for window. Then, all drawing operations performed on the window will
-be diverted to the backing store. When you call the <link
-linkend="method-gdkwindow--end-paint"><methodname>end_paint</methodname>()</link>
-method, the backing store will be copied to the window, making it visible
-on-screen. Only the part of window contained in region will be modified; that
-is, drawing operations are clipped to <parameter>rectangle</parameter>. The
-net result of all this is to remove flicker, because the user sees the
-finished product appear all at once when you call the <link
-linkend="method-gdkwindow--end-paint"><methodname>end_paint</methodname>()</link>
-method. If you draw to window directly without calling the
-<methodname>begin_paint_rect</methodname>() method, the user may see flicker
-as individual drawing operations are performed in sequence. The clipping and
-background initializing features of the
-<methodname>begin_paint_rect</methodname>() are conveniences for the
-programmer, so you can avoid doing that work yourself.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--begin-paint-region">
- <title>gtk.gdk.Window.begin_paint_region</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>begin_paint_region</methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">region</parameter>&nbsp;:</term>
- <listitem><simpara>the region you intend to draw to</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>begin_paint_region</methodname>() method
- indicates that you are beginning the process of redrawing the <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- specified by <parameter>region</parameter>. A backing store
- (off-screen buffer) large enough to contain
- <parameter>region</parameter> will be created. The backing store will
- be initialized with the background color or background pixmap for the
- window. Then, all drawing operations performed on the window will be
- diverted to the backing store. When you call the <link
- linkend="method-gdkwindow--end-paint"><methodname>end_paint</methodname>()</link>
- method, the backing store will be copied to the window, making it
- visible on-screen. Only the part of the window contained in
- <parameter>region</parameter> will be modified; that is, drawing
- operations are clipped to <parameter>region</parameter>.</para>
-
- <para>The net result of all this is to remove flicker, because the
- user sees the finished product appear all at once when you call the
- <link
- linkend="method-gdkwindow--end-paint"><methodname>end_paint</methodname>()</link>
- method. If you draw to the window directly without calling the <link
- linkend="method-gdkwindow--begin-paint-region"><methodname>begin_paint_region</methodname>()</link>
- method, the user may see flicker as individual drawing operations are
- performed in sequence. The clipping and background initializing
- features of the <link
- linkend="method-gdkwindow--begin-paint-region"><methodname>begin_paint_region</methodname>()</link>
- method are conveniences for the programmer, so you can avoid doing
- that work yourself.</para>
-
- <para>The widget system automatically places calls to the <link
- linkend="method-gdkwindow--begin-paint-region"><methodname>begin_paint_region</methodname>()</link>
- and <link
- linkend="method-gdkwindow--end-paint"><methodname>end_paint</methodname>()</link>
- methods around emissions of the "expose_event" signal. That is, if
- you're writing an expose event handler, you can assume that the
- exposed area in a gtk.gdk.EXPOSE type <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
- has already been cleared to the window background, is already set as
- the clip region, and already has a backing store. Therefore in most
- cases, application code need not call the <link
- linkend="method-gdkwindow--begin-paint-region"><methodname>begin_paint_region</methodname>()</link>
- method. (You can disable the automatic calls around expose events on a
- widget-by-widget basis by calling <link
- linkend="method-gtkwidget--set-double-buffered"><methodname>gtk.Widget.set_double_buffered</methodname>()</link>.)</para>
-
- <para>If you call this method multiple times before calling the
- matching the <link
- linkend="method-gdkwindow--end-paint"><methodname>end_paint</methodname>()</link>
- method, the backing stores are pushed onto a stack. The <link
- linkend="method-gdkwindow--end-paint"><methodname>end_paint</methodname>()</link>
- method copies the topmost backing store on-screen, subtracts the
- topmost region from all other regions in the stack, and pops the
- stack. All drawing operations affect only the topmost backing store in
- the stack. One matching call to the <link
- linkend="method-gdkwindow--end-paint"><methodname>end_paint</methodname>()</link>
- method is required for each call to the <link
- linkend="method-gdkwindow--begin-paint-region"><methodname>begin_paint_region</methodname>()</link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--end-paint">
- <title>gtk.gdk.Window.end_paint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>end_paint</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>end_paint</methodname>() method indicates that
-the backing store created by the most recent call to the <link
-linkend="method-gdkwindow--begin-paint-rect"><methodname>begin_paint_rect</methodname>()</link>
-method should be copied on-screen and deleted, leaving the next-most-recent
-backing store or no backing store at all as the active paint region. It is
-an error to call this function without a matching call to the <link
-linkend="method-gdkwindow--begin-paint-rect"><methodname>begin_paint_rect</methodname>()</link>
-method first.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-title">
- <title>gtk.gdk.Window.set_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_title</methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>the new title of the
-window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_title</methodname>() method sets the title
-of a toplevel window, to the string specified by
-<parameter>title</parameter>. If you haven't explicitly set the icon name
-for the window (using the <link
-linkend="method-gdkwindow--set-icon-name"><methodname>set_icon_name</methodname>()</link>
-method), the icon name will be set to <parameter>title</parameter> as well.
-<parameter>title</parameter> must be in UTF-8 encoding (as with all
-user-readable strings in <literal>PyGTK</literal>).</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-role">
- <title>gtk.gdk.Window.set_role</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_role</methodname>
- <methodparam><parameter
- role="keyword">role</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">role</parameter>&nbsp;:</term>
- <listitem><simpara>a string indicating its
-role</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_role</methodname>() method sets the string
-specified by <parameter>role</parameter> as the window's role. When using
-<literal>PyGTK</literal>, you should generally use the <link
-linkend="method-gtkwindow--set-role"><methodname>gtk.Window.set_role</methodname>()</link>
-method instead of this low-level function. The window manager and session
-manager use a window's role to distinguish it from other kinds of window in
-the same application. When an application is restarted after being saved in
-a previous session, all windows with the same title and role are treated as
-interchangeable. So if you have two windows with the same title that should
-be distinguished for session management purposes, you should set the role on
-those windows. It doesn't matter what string you use for the role, as long
-as you have a different role for each non-interchangeable kind of
-window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-transient-for">
- <title>gtk.gdk.Window.set_transient_for</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_transient_for</methodname>
- <methodparam><parameter
- role="keyword">leader</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">leader</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_transient_for</methodname>() method
-indicates to the window manager that the window is a transient dialog
-associated with the application window <parameter>leader</parameter>. This
-allows the window manager to do things like center the window on
-<parameter>leader</parameter> and keep the window above
-<parameter>leader</parameter>. See the <link
-linkend="method-gtkwindow--set-transient-for"><methodname>gtk.Window.set_transient_for</methodname>()</link>
-method if you're using a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> or <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-background">
- <title>gtk.gdk.Window.set_background</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_background</methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>an allocated <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_background</methodname>() method sets the
-background <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> of the
-window to the value specified by <parameter>color</parameter>. (However,
-when using <literal>PyGTK</literal>, set the background of a widget with the
-<link
-linkend="method-gtkwidget--modify-bg"><methodname>gtk.Widget.modify_bg</methodname>()</link>
-method from an application - or the <link
-linkend="method-gtkstyle--set-background"><methodname>gtk.Style.set_background</methodname>()</link>
-method from a custom widget implementation.) The
-<parameter>color</parameter> must be allocated Also see the <link
-linkend="method-gdkwindow--set-back-pixmap"><methodname>set_back_pixmap</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-back-pixmap">
- <title>gtk.gdk.Window.set_back_pixmap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_back_pixmap</methodname>
- <methodparam><parameter
- role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">parent_relative</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixmap</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">parent_relative</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the tiling origin is
-at the origin of the window's parent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_back_pixmap</methodname>() method sets the
-background pixmap of the window to the value specified by
-<parameter>pixmap</parameter> A background pixmap will be tiled, positioning
-the first tile at the origin of the window, or if
-<parameter>parent_relative</parameter> is <literal>True</literal>, the
-tiling will be done based on the origin of the parent window (useful to
-align tiles in a parent with tiles in a child). If
-<parameter>pixmap</parameter> is <literal>None</literal> the window will
-have no background which means it will never have its background filled by
-the windowing system. Instead the window will contain whatever pixels were
-already in the corresponding area of the display. The windowing system will
-normally fill a window with its background when the window is obscured then
-exposed, and when you call the <link
-linkend="method-gdkwindow--clear"><methodname>clear</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-cursor">
- <title>gtk.gdk.Window.set_cursor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_cursor</methodname>
- <methodparam><parameter
- role="keyword">cursor</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cursor</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcursor"><classname>gtk.gdk.Cursor</classname></link> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_cursor</methodname>() method sets the mouse
-pointer for a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>. Use
-either the <link linkend="constructor-gdkcursor1">gtk.gdk.Cursor()</link> or
-<link linkend="constructor-gdkcursor2">gtk.gdk.Cursor</link>() constructors
-to create the cursor. To make the cursor invisible, use the <link
-linkend="constructor-gdkcursor2">gtk.gdk.Cursor</link>() constructor to
-create a cursor with no pixels in it. Passing <literal>None</literal> for
-the <parameter>cursor</parameter> argument to the
-<methodname>set_cursor</methodname>() method means that the window will use
-the cursor of its parent window. Most windows should use this
-default.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-geometry">
- <title>gtk.gdk.Window.get_geometry</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_geometry</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 5-tuple containing the X and Y coordinate of
-the location of the window relative to its parent and the width and height
-of the window and the bit depth of the window.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_geometry</methodname>() method returns a
-5-tuple containing the window's location and size (x, y, width, height) and
-the bit depth of the window. The X and Y coordinates returned are relative
-to the parent window of the window, which for toplevels usually means
-relative to the window decorations (titlebar, etc.) rather than relative to
-the root window (screen-size background window).
-</para>
- <para>
-On the X11 platform, the geometry is obtained from the X server, so reflects
-the latest position of the window; this may be out-of-sync with the position
-of the window delivered in the most-recently-processed
-<literal>GdkEventConfigure</literal>. the <link
-linkend="method-gdkwindow--get-position"><methodname>get_position</methodname>()</link>
-method in contrast gets the position from the most recent configure
-event.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-position">
- <title>gtk.gdk.Window.get_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_position</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the X and Y coordinates of
-the window location.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_position</methodname>() returns a 2-tuple
-containing the position of the window as reported in the
-most-recently-processed <literal>GdkEventConfigure</literal>. By comparison
-with the <link
-linkend="method-gdkwindow--get-geometry"><methodname>get_geometry</methodname>()</link>
-method that queries the X server for the current window position, regardless
-of what events have been received or processed. The position coordinates are
-relative to the window's parent window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-origin">
- <title>gtk.gdk.Window.get_origin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_origin</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the X and Y coordinates of
-the window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_origin</methodname>() method returns a
-2-tuple containing the x and y coordinates of the position of a window in
-root window coordinates. (Compare this method with the <link
-linkend="method-gdkwindow--get-position"><methodname>get_position</methodname>()</link>
-and <link
-linkend="method-gdkwindow--get-geometry"><methodname>get_geometry</methodname>()</link>
-methods that return the position of a window relative to its parent
-window.)</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-root-origin">
- <title>gtk.gdk.Window.get_root_origin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_root_origin</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the X and Y coordinates of
-the window frame position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_root_origin</methodname>() method returns a
-2-tuple containing the top-left corner of the window manager frame in root
-window coordinates.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-frame-extents">
- <title>gtk.gdk.Window.get_frame_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_frame_extents</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-specifying the bounding box of the window frame</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_frame_extents</methodname>() method returns
-a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-specifying the bounding box of the window, including window manager
-titlebar/borders if any. The frame position is given in root window
-coordinates. To get the position of the window itself (rather than the
-frame) in root window coordinates, use the <link
-linkend="method-gdkwindow--get-origin"><methodname>get_origin</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-pointer">
- <title>gtk.gdk.Window.get_pointer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pointer</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple containing the X and Y coordinates of
-the mouse pointer and the modifier mask</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pointer</methodname>() method returns a
-3-tuple containing the coordinates of the mouse pointer location relative to
-the window and the modifier state. The modifier state is a combination of
-the <xref linkend="gdk-modifier-constants"
-endterm="gdk-modifier-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-parent">
- <title>gtk.gdk.Window.get_parent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_parent</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the parent <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-the window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_parent</methodname>() method returns the
-parent of the window as set when the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> was
-created or when the <link
-linkend="method-gdkwindow--reparent"><methodname>reparent</methodname>()</link>
-method was called.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-toplevel">
- <title>gtk.gdk.Window.get_toplevel</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_toplevel</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the toplevel <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-containing the window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_toplevel</methodname>() method returns the
-toplevel <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-that's an ancestor of the window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-children">
- <title>gtk.gdk.Window.get_children</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_children</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the list of child windows inside the
-window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_children</methodname>() method returns the
-list of children <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-objects of the window. This method only returns children created via
-<literal>PyGTK</literal>, so for example it's useless when used with the
-root window; it only returns windows an application created itself.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-events">
- <title>gtk.gdk.Window.get_events</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_events</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the event mask for the
-window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_events</methodname>() method returns the
-event mask for the window. See the <link
-linkend="method-gdkwindow--set-events"><methodname>set_events</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-events">
- <title>gtk.gdk.Window.set_events</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_events</methodname>
- <methodparam><parameter
- role="keyword">event_mask</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">event_mask</parameter>&nbsp;:</term>
- <listitem><simpara>the event mask for the
-window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_events</methodname>() method sets the event
-mask to the value specified by event_mask for the window. The event mask
-determines which events will be reported for the window. For example, an
-event mask including <literal>gtk.gdk.BUTTON_PRESS_MASK</literal> means the
-window should report button press events. The event mask is the bitwise OR
-of the <xref linkend="gdk-event-mask-constants"
-endterm="gdk-event-mask-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-icon-list">
- <title>gtk.gdk.Window.set_icon_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_list</methodname>
- <methodparam><parameter role="keyword">pixbufs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbufs</parameter>&nbsp;:</term>
- <listitem><simpara>a list (or tuple) containing pixbufs, of
- different sizes.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_icon_list</methodname>() method sets the
-list of icons for the window. pixbufs is a list or tuple containing <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-objects to be used as the icon images. One of these will be used to
-represent the window when it has been iconified. The icon is usually shown
-in an icon box or some sort of task bar. Which icon size is shown depends on
-the window manager. The window manager can scale the icon but setting
-several size icons can give better image quality since the window manager
-may only need to scale the icon by a small amount or not at all.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-icon">
- <title>gtk.gdk.Window.set_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon</methodname>
- <methodparam><parameter
- role="keyword">icon_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">icon_window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> to
-use for the icon</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixmap</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> to
-use as the icon</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">mask</parameter>&nbsp;:</term>
- <listitem><simpara>a 1-bit pixmap (<literal>GdkBitmap</literal>)
-to use as mask for <parameter>pixmap</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_icon</methodname>() method sets the icon of
-the window as a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-(specified by <parameter>pixmap</parameter>) or <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-specified by <parameter>icon_window</parameter>). Investigate the <link
-linkend="function-gtk--window-set-default-icon-list"><methodname>gtk.window_set_default_icon_list()</methodname>()</link>
-function first, and then the <link
-linkend="method-gtkwindow--set-icon-list"><methodname>gtk.Window.set_icon_list</methodname>()</link>
-and <link
-linkend="method-gtkwindow--set-icon"><methodname>gtk.Window.set_icon</methodname>()</link>
-methods. If those don't meet your needs, look at the <link
-linkend="method-gdkwindow--set-icon-list"><methodname>set_icon_list</methodname>()</link>
-method. Only if all those are too high-level do you want to fall back to the
-<link
-linkend="method-gdkwindow--set-icon"><methodname>set_icon</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-icon-name">
- <title>gtk.gdk.Window.set_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the window while iconified
-(minimized)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_icon_name</methodname>() method sets the
-name of the window when it is iconified to the value of
-<parameter>name</parameter>. Windows may have a name used while minimized,
-distinct from the name they display in their titlebar. Most of the time this
-is a bad idea from a user interface standpoint. But you can set such a name
-with this method, if you like.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-group">
- <title>gtk.gdk.Window.set_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_group</methodname>
- <methodparam><parameter
- role="keyword">leader</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">leader</parameter>&nbsp;:</term>
- <listitem><simpara>the group leader <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_group</methodname>() method sets the group
-leader for the window to the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-specified by <parameter>leader</parameter>. By default, the group leader
-for all toplevel windows is set to a global window implicitly created by
-<literal>PyGTK</literal>. With this method you can override this default.
-The group leader window allows the window manager to distinguish all windows
-that belong to a single application. It may for example allow users to
-minimize or unminimize all windows belonging to an application at once. You
-should only set a non-default group window if your application pretends to
-be multiple applications. The group leader window may not be changed after a
-window has been mapped (with the <link
-linkend="method-gdkwindow--show"><methodname>show</methodname>()</link>
-method for example).</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-group">
- <title>gtk.gdk.Window.get_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_group</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the group leader <link
- linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
- for the window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_group</methodname>() method returns the
-group leader <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> for
-the window. See the <link
-linkend="method-gdkwindow--set-group"><methodname>set_group()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-decorations">
- <title>gtk.gdk.Window.set_decorations</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_decorations</methodname>
- <methodparam><parameter
- role="keyword">decorations</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">decorations</parameter>&nbsp;:</term>
- <listitem><simpara>the decoration hint mask</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_decorations</methodname>() method sets the
-specified decorations for the window. "Decorations" are the features the
-window manager adds to a toplevel <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>. This
-method sets the traditional Motif window manager hints that tell the window
-manager which decorations you would like your window to have. Usually you
-should use the <link
-linkend="method-gtkwindow--set-decorated"><methodname>gtk.Window.set_decorated</methodname>()</link>
-method on a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> instead
-of using this method directly. The value of
-<parameter>decorations</parameter> is the logical OR of the <xref
-linkend="gdk-wm-decoration-constants"
-endterm="gdk-wm-decoration-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--get-decorations">
- <title>gtk.gdk.Window.get_decorations</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_decorations</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the window decorations</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_decorations</methodname>() method returns
-the decorations set on the window with the <link
-linkend="method-gdkwindow--set-decorations"><methodname>set_decorations</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-functions">
- <title>gtk.gdk.Window.set_functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_functions</methodname>
- <methodparam><parameter
- role="keyword">functions</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">functions</parameter>&nbsp;:</term>
- <listitem><simpara>the bitmask of operations to allow on the
-window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_functions</methodname>() method sets the
-traditional Motif window manager hint for which operations the window
-manager should allow on a toplevel window. However, few window managers do
-anything reliable or interesting with this hint. Many ignore it
-entirely. The <parameter>functions</parameter> argument is the logical OR of
-the <xref linkend="gdk-wm-function-constants"
-endterm="gdk-wm-function-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--iconify">
- <title>gtk.gdk.Window.iconify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iconify</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>iconify</methodname>() method asks the window
-manager to iconify (minimize) the window. The window manager may choose to
-ignore the request, but normally will honor it. Using the <link
-linkend="method-gtkwindow--iconify"><methodname>gtk.Window.iconify</methodname>()</link>
-method is preferred, if you have a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
-widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--deiconify">
- <title>gtk.gdk.Window.deiconify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>deiconify</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>deiconify</methodname>() method asks the window
-manager to deiconify (unminimize) the window. On X11 the window manager may
-choose to ignore the request to deiconify. Using the <link
-linkend="method-gtkwindow--deiconify"><methodname>gtk.Window.deiconify</methodname>()</link>
-method is preferred. Or better yet, use the <link
-linkend="method-gtkwindow--present"><methodname>gtk.Window.present</methodname>()</link>,
-which raises the window, focuses it, unminimizes it, and puts it on the
-current desktop.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--stick">
- <title>gtk.gdk.Window.stick</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>stick</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>stick</methodname>() method "pins" a window such
-that it's on all workspaces and does not scroll with viewports, for window
-managers that have scrollable viewports. (When using a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>, the
-<link
-linkend="method-gtkwindow--stick"><methodname>gtk.Window.stick</methodname>()</link>
-method may be more useful.) On the X11 platform, this method depends on
-window manager support, so may have no effect with many window managers.
-However, <literal>PyGTK</literal> will do the best it can to convince the
-window manager to stick the window. For window managers that don't support
-this operation, there's nothing you can do to force it to happen.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--unstick">
- <title>gtk.gdk.Window.unstick</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unstick</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>unstick</methodname>() method reverses the
-effect of the <link
-linkend="method-gdkwindow--stick"><methodname>stick</methodname>()</link>
-method. See the <link
-linkend="method-gdkwindow--stick"><methodname>stick</methodname>()</link>
-and <link
-linkend="method-gtkwindow--unstick"><methodname>gtk.Window.unstick</methodname>()</link>
-methods for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--maximize">
- <title>gtk.gdk.Window.maximize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>maximize</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>maximize</methodname>() method asks the window
-manager to maximize the window, if the window manager supports this
-operation. Not all window managers support this, and some deliberately
-ignore it or don't have a concept of "maximized"; so you can't rely on the
-maximization actually happening. But it will happen with most standard
-window managers. If the window was already maximized, then this method does
-nothing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--unmaximize">
- <title>gtk.gdk.Window.unmaximize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unmaximize</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>unmaximize</methodname>() method asks the window
-manager to unmaximize the window, if the window manager supports this
-operation. Not all window managers support this, and some deliberately
-ignore it or don't have a concept of "maximized"; so you can't rely on the
-unmaximization actually happening. But it will happen with most standard
-window managers. If the window wasn't maximized, then this method does
-nothing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--fullscreen">
- <title>gtk.gdk.Window.fullscreen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>fullscreen</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>fullscreen</methodname>() method moves the window
-into fullscreen mode. This means the window covers the entire screen and is
-above any panels or task bars.</para>
-
- <para>If the window was already fullscreen, then this method does
-nothing.</para>
-
- <para>On X11, asks the window manager to put the window in a
-fullscreen state, if the window manager supports this operation. Not all
-window managers support this, and some deliberately ignore it or don't have
-a concept of "fullscreen" but most standard window managers do.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--unfullscreen">
- <title>gtk.gdk.Window.unfullscreen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unfullscreen</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>unfullscreen</methodname>() method moves the
-window out of fullscreen mode. If the window was not fullscreen, does
-nothing.</para>
-
- <para>On X11, asks the window manager to move the window out of the
-fullscreen state, if the window manager supports this operation. Not all
-window managers support this, and some deliberately ignore it or don't have
-a concept of "fullscreen" but most standard window managers do.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--register-dnd">
- <title>gtk.gdk.Window.register_dnd</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>register_dnd</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>register_dnd</methodname>() method registers the
-window as a potential drop destination.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--begin-resize-drag">
- <title>gtk.gdk.Window.begin_resize_drag</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>begin_resize_drag</methodname>
- <methodparam><parameter
- role="keyword">edge</parameter></methodparam>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">timestamp</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">edge</parameter>&nbsp;:</term>
- <listitem><simpara>the edge or corner from which the drag is
-started</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">button</parameter>&nbsp;:</term>
- <listitem><simpara>the mouse button being used to
-drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">root_x</parameter>&nbsp;:</term>
- <listitem><simpara>the root window X coordinate of the mouse click
-that began the drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">root_y</parameter>&nbsp;:</term>
- <listitem><simpara>the root window Y coordinate of the mouse click
-that began the drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp of the mouse click that began the
-drag (use the <link
-linkend="method-gdkevent--get-time"><methodname>gtk.gdk.Event.get_time</methodname>()</link>
-method)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>begin_resize_drag</methodname>() method begins a
-window resize operation (for a toplevel <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>) from
-the specified <parameter>edge</parameter> using the specified
-<parameter>button</parameter> starting at the location specified by
-<parameter>root_x</parameter> and <parameter>root_y</parameter>. The value
-of edge must be one of the <xref linkend="gdk-window-edge-constants"
-endterm="gdk-window-edge-constants-title"></xref>.</para>
-
- <para>You might use this
-method to implement a "window resize grip," for example; in fact the <link
-linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link>
-uses it. The method works best with window managers that support the
-Extended Window Manager Hints spec (see <ulink
-url="http://www.freedesktop.org">http://www.freedesktop.org</ulink>),
-but has a fallback implementation for other window managers.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--begin-move-drag">
- <title>gtk.gdk.Window.begin_move_drag</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>begin_move_drag</methodname>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">timestamp</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">button</parameter>&nbsp;:</term>
- <listitem><simpara>the button being used to
-drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">root_x</parameter>&nbsp;:</term>
- <listitem><simpara>the root window X coordinate of the mouse click
-that began the drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">root_y</parameter>&nbsp;:</term>
- <listitem><simpara>the root window Y coordinate of the mouse click
-that began the drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp of the mouse click that began the
-drag</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>begin_move_drag</methodname>() method begins a
-window move operation (for a toplevel window) using the specified
-<parameter>button</parameter> starting at the location specified by
-<parameter>root_x</parameter> and <parameter>root_y</parameter>. You might
-use this method to implement a "window move grip," for example. The method
-works best with window managers that support the Extended Window Manager
-Hints spec (see <ulink
-url="http://www.freedesktop.org">http://www.freedesktop.org</ulink>),
-but has a fallback implementation for other window managers.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--invalidate-rect">
- <title>gtk.gdk.Window.invalidate_rect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>invalidate_rect</methodname>
- <methodparam><parameter
- role="keyword">rect</parameter></methodparam>
- <methodparam><parameter
- role="keyword">invalidate_children</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rect</parameter>&nbsp;:</term>
- <listitem><simpara>the rectangle to
-invalidate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">invalidate_children</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> invalidate child
-<link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-objects</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>invalidate_rect</methodname>() method
-invalidates the rectangular region specified by rect. If
-<parameter>invalidate_children</parameter> is <literal>True</literal> the
-child <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-object of the window are also invalidated.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--invalidate-region">
- <title>gtk.gdk.Window.invalidate_region</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>invalidate_region</methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- <methodparam><parameter role="keyword">invalidate_children</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">region</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">invalidate_children</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> also invalidate child
- windows</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>invalidate_region</methodname>() method adds the
- <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- specified by <parameter>region</parameter> to the update area for the
- window. The update area is the region that needs to be redrawn, or the
- "dirty region." The call to the <link
- linkend="method-gdkwindow--process-updates"><methodname>process_updates</methodname>()</link>
- method sends one or more expose events to the window, which together
- cover the entire update area. An application would normally redraw the
- contents of the window in response to those expose events.</para>
-
- <para>PyGTK will call the <link
- linkend="function-gdk--window-process-all-updates"><function>gtk.gdk.window_process_all_updates</function>()</link>
- method on your behalf whenever your program returns to the main loop
- and becomes idle, so normally there's no need to do that manually, you
- just need to invalidate regions that you know should be
- redrawn.</para>
-
- <para>The <parameter>invalidate_children</parameter> parameter
- controls whether the region of each child window that intersects
- <parameter>region</parameter> will also be invalidated. If
- <literal>False</literal>, then the update area for child windows will
- remain unaffected.<!-- See gdk_window_invalidate_maybe_recurse if you
- need fine grained control over which children are
- invalidated.--></para>
-
- </refsect2>
-
-
-<!-- NOT IMPLEMENTED <refsect2 id="method-gdkwindow-
- -invalidate-maybe-recurse">
- <title>gtk.gdk.Window.invalidate_maybe_recurse</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>invalidate_maybe_recurse</methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- <methodparam><parameter role="keyword">(*child_func</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">region</parameter>&nbsp;:</term>
- <listitem><simpara>a <literal>GdkRegion</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">(*child_func</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-Adds <parameter>region</parameter> to the update area for the window. The update area is the
-region that needs to be redrawn, or "dirty region." The call
-<link linkend="method-gdkwindow- -process-updates"><function>gtk.gdk.Window.process_updates()</function></link> sends one or more expose events to the
-window, which together cover the entire update area. An
-application would normally redraw the contents of the window in
-response to those expose events.
-</para>
-<para>
-GDK will call <function>window_process_all_updates()</function> on your behalf
-whenever your program returns to the main loop and becomes idle, so
-normally there's no need to do that manually, you just need to
-invalidate regions that you know should be redrawn.
-</para>
-<para>
-The <parameter>child_func</parameter> parameter controls whether the region of
-each child window that intersects <parameter>region</parameter> will also be invalidated.
-Only children for which <parameter>child_func</parameter> returns True will have the area
-invalidated.
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
-
-<refsect2 id="method-gdkwindow--get-update-area">
- <title>gtk.gdk.Window.get_update_area</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_update_area</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- conatining the update area for the window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_update_area</methodname>() method returns a
- <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- containing the update area and transfers ownership of the update area from
- the window to the caller of the method. That is, after calling this
- method, the window will no longer have an invalid/dirty region; the update
- area is removed from the window and passed in the returned <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>. If
- a window has no update area, the <link
- linkend="method-gdkwindow--get-update-area"><methodname>get_update_area()</methodname></link>
- method returns <literal>None</literal>.</para>
-
-</refsect2>
-
- <refsect2 id="method-gdkwindow--freeze-updates">
- <title>gtk.gdk.Window.freeze_updates</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>freeze_updates</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>freeze_updates</methodname>() method temporarily
-freezes the window such that it won't receive expose events. The window will
-begin receiving expose events again when the <link
-linkend="method-gdkwindow--thaw-updates"><methodname>thaw_updates</methodname>()</link>
-method is called. If the <methodname>freeze_updates</methodname>() method
-has been called more than once, the <link
-linkend="method-gdkwindow--thaw-updates"><methodname>thaw_updates</methodname>()</link>
-method must be called an equal number of times to begin processing
-exposes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--thaw-updates">
- <title>gtk.gdk.Window.thaw_updates</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>thaw_updates</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>thaw_updates</methodname>() method thaws a
-window frozen with the <link
-linkend="method-gdkwindow--freeze-updates"><methodname>freeze_updates</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--process-updates">
- <title>gtk.gdk.Window.process_updates</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>process_updates</methodname>
- <methodparam><parameter
- role="keyword">update_children</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">update_children</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> process updates for
-child windows</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>process_updates</methodname>() method sends one
-or more expose events to the window. The areas in each expose event will
-cover the entire update area for the window (see the <link
-linkend="method-gdkwindow--invalidate-rect"><methodname>invalidate_rect</methodname>()</link>
-method for details). Normally <literal>PyGTK</literal> calls the <link
-linkend="function-gdk--window-process-all-updates"><methodname>gtk.gdk.window_process_all_updates</methodname>()</link>
-function on your behalf, so there's no need to call this method unless you
-want to force expose events to be delivered immediately and synchronously
-(vs. the usual case, where <literal>PyGTK</literal> delivers them in an idle
-handler). Occasionally this is useful to produce nicer scrolling behavior,
-for example.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gdkwindow- -get-internal-paint-info">
- <title>gtk.gdk.Window.get_internal_paint_info</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>get_internal_paint_info</methodname>
- <methodparam><parameter role="keyword">real_drawable</parameter></methodparam>
- <methodparam><parameter role="keyword">x_offset</parameter></methodparam>
- <methodparam><parameter role="keyword">y_offset</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">real_drawable</parameter>&nbsp;:</term>
- <listitem><simpara>location to store the drawable to which drawing should be
-done.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x_offset</parameter>&nbsp;:</term>
- <listitem><simpara>location to store the X offset between coordinates in the window,
-and the underlying window system primitive coordinates for
-*<parameter>real_drawable</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y_offset</parameter>&nbsp;:</term>
- <listitem><simpara>location to store the Y offset between coordinates in the window,
-and the underlying window system primitive coordinates for
-*<parameter>real_drawable</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-If you bypass the GDK layer and use windowing system primitives to
-draw directly onto a <link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>, then you need to deal with two
-details: there may be an offset between GDK coordinates and windowing
-system coordinates, and GDK may have redirected drawing to a off-screen
-pixmap as the result of a <link linkend="method-gdkwindow- -begin-paint-region"><function>gtk.gdk.Window.begin_paint_region()</function></link> calls.
-This function allows retrieving the information you need to compensate
-for these effects.
-</para>
-<para>
-This function exposes details of the GDK implementation, and is thus
-likely to change in future releases of GDK.
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gdkwindow--set-accept-focus">
- <title>gtk.gdk.Window.set_accept_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_accept_focus</methodname>
- <methodparam><parameter role="keyword">accept_focus</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">accept_focus</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the window should
- receive input focus</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_accept_focus</methodname>() method sets the
-"accept_focus setting to the value of
-<parameter>accept_focus</parameter>. If <parameter>accept_focus</parameter>
-is <literal>True</literal> the window will accept focus; if
-<literal>False</literal> hints to the desktop environment that the window
-doesn't want to receive input focus.</para>
-
- <para>On X, it is the responsibility of the window manager to
-interpret this hint. ICCCM-compliant window manager usually respect
-it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--enable-synchronized-configure">
- <title>gtk.gdk.Window.enable_synchronized_configure</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>enable_synchronized_configure</methodname>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>enable_synchronized_configure</methodname>()
-method indicates that the application will cooperate with the window system
-in synchronizing the window repaint with the window manager during resizing
-operations. After an application calls this method, it must call the <link
-linkend="method-gdkwindow--configure-finished"><methodname>configure_finished</methodname>()</link>
-method every time it has finished all processing associated with a set of
-Configure events. Toplevel GTK+ windows automatically use this
-protocol.</para>
-
- <para>On X, calling this function makes window participate in the
-_NET_WM_SYNC_REQUEST window manager protocol.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--configure-finished">
- <title>gtk.gdk.Window.configure_finished</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>configure_finished</methodname>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>configure_finished</methodname>() method signals
-to the window system that the application has finished handling all the
-Configure events it has received. Window Managers can use this to better
-synchronize the frame repaint with the application. GTK+ applications will
-automatically call this function when appropriate.</para>
-
- <para>This function can only be called if the <link
-linkend="method-gdkwindow--enable-synchronized-configure"><methodname>enable_synchronized_configure</methodname>()</link>
-method was called previously.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-focus-on-map">
- <title>gtk.gdk.Window.set_focus_on_map</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_focus_on_map</methodname>
- <methodparam><parameter role="keyword">focus_on_map</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">focus_on_map</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the window should
-receive input focus when mapped.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_focus_on_map</methodname>() method sets the
-a hint for the desktop environment to the value specified by
-<parameter>focus_on_map</parameter>. If <parameter>focus_on_map</parameter>
-is <literal>True</literal> the window sets a hint for the desktop
-environment indicating that it would like to receive input focus when
-mapped.</para>
-
- <para>On X, it is the responsibility of the window manager to
-interpret this hint. Window managers following the <ulink
-url="http://www.freedesktop.org">freedesktop.org</ulink> window manager
-extension specification should respect it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--set-urgency-hint">
- <title>gtk.gdk.Window.set_urgency_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_urgency_hint</methodname>
- <methodparam><parameter role="keyword">urgent</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">urgent</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the window requires
-urgent user attention.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_urgency_hint</methodname>() method sets the
-a hint for the desktop environment to the value specified by
-<parameter>urgent</parameter>. If <parameter>urgent</parameter> is
-<literal>True</literal> the window sets a hint for the desktop environment
-indicating that it needs urgent user attention.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--move-region">
- <title>gtk.gdk.Window.move_region</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_region</methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- <methodparam><parameter role="keyword">dx</parameter></methodparam>
- <methodparam><parameter role="keyword">dy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">region</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link> to move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">dx</parameter>&nbsp;:</term>
- <listitem><simpara>the distance to move horizontally</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">dy</parameter>&nbsp;:</term>
- <listitem><simpara>the distance to move vertically</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>move_region</methodname>() method moves the part
- of window indicated by the <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- specified by <parameter>region</parameter> by
- <parameter>dy</parameter> pixels in the Y direction and
- <parameter>dx</parameter> pixels in the X direction. The portions of
- <parameter>region</parameter> that are not covered by the new position
- of <parameter>region</parameter> are invalidated.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--shape-combine-region">
- <title>gtk.gdk.Window.shape_combine_region</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>shape_combine_region</methodname>
- <methodparam><parameter role="keyword">shape_region</parameter></methodparam>
- <methodparam><parameter role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter role="keyword">offset_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">shape_region</parameter>&nbsp;:</term>
- <listitem><simpara>the region of the window to leave
- opaque</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">offset_x</parameter>&nbsp;:</term>
- <listitem><simpara>X position of <parameter>shape_region</parameter>
- in window coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">offset_y</parameter>&nbsp;:</term>
- <listitem><simpara>Y position of <parameter>shape_region</parameter>
- in window coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>shape_combine_region</methodname>() method makes
- pixels in the window outside of the <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- specified by <parameter>shape_region</parameter> transparent, so
- that the window may be nonrectangular. See the <link
- linkend="method-gdkwindow--shape-combine-mask"><methodname>shape_combine_mask</methodname>()</link>
- method to use a bitmap as the mask.</para>
-
- <para>If <parameter>shape_region</parameter> is
- <literal>None</literal>, the shape will be unset, so the whole window
- will be opaque again. <parameter>offset_x</parameter> and
- <parameter>offset_y</parameter> are ignored if
- <parameter>shape_region</parameter> is <literal>None</literal>.</para>
-
- <para>This method works on both toplevel and child windows.</para>
-
- <para>On the X11 platform, this uses an X server extension which is
- widely available on most common platforms, but not available on very
- old X servers, and occasionally the implementation will be buggy. On
- servers without the shape extension, this method will do
- nothing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--input-shape-combine-mask">
- <title>gtk.gdk.Window.input_shape_combine_mask</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>input_shape_combine_mask</methodname>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">mask</parameter>&nbsp;:</term>
- <listitem><simpara>the shape bitmap mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position of shape mask with respect to
-the window</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position of shape mask with respect to
-the window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>input_shape_combine_mask</methodname>() method
- is similar to the <link
- linkend="method-gdkwindow--shape-combine-mask"><methodname>shape_combine_mask</methodname>()</link>
- method but the shape applies only to event handling. Mouse events
- which happen while the pointer position corresponds to an unset bit in
- the mask will be passed onto the window below this window.</para>
-
- <para>An input shape is typically used with RGBA windows. The alpha
- channel of the window defines which pixels are invisible and allows
- for nicely antialiased borders, and the input shape controls where the
- window is "clickable".</para>
-
- <para>On the X11 platform, this requires version 1.1 of the shape
- extension.</para>
-
- </refsect2>
-
- <refsect2 id="method-gdkwindow--input-shape-combine-region">
- <title>gtk.gdk.Window.input_shape_combine_region</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>input_shape_combine_region</methodname>
- <methodparam><parameter role="keyword">shape_region</parameter></methodparam>
- <methodparam><parameter role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter role="keyword">offset_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">shape_region</parameter>&nbsp;:</term>
- <listitem><simpara>the region of the window to leave
- opaque</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">offset_x</parameter>&nbsp;:</term>
- <listitem><simpara>X position of <parameter>shape_region</parameter>
- in window coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">offset_y</parameter>&nbsp;:</term>
- <listitem><simpara>Y position of <parameter>shape_region</parameter>
- in window coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>input_shape_combine_region</methodname>() method
- is similar to the <link
- linkend="method-gdkwindow--shape-combine-region"><methodname>shape_combine_region</methodname>()</link>
- method, but the shape applies only to event handling. Mouse events
- which happen while the pointer position corresponds to an unset bit in
- <parameter>shape_region</parameter> will be passed onto the window
- below this window.</para>
-
- <para>An input shape is typically used with RGBA windows. The alpha
- channel of the window defines which pixels are invisible and allows
- for nicely antialiased borders, and the input shape controls where the
- window is "clickable".</para>
-
- <para>On the X11 platform, this requires version 1.1 of the shape
- extension.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gdk--window-foreign-new">
- <title>gtk.gdk.window_foreign_new</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.window_foreign_new</methodname>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
- <listitem><simpara>a native window system ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-wrapper for the native window or <literal>None</literal> if the window has
-been destroyed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.window_foreign_new</function>() function
-wraps a native window specified by <parameter>anid</parameter> for the default display in a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>. This
-may fail if the window has been destroyed. For example in the X Window
-System backend, a native window handle is an Xlib
-<literal>XID</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--window-foreign-new-for-display">
- <title>gtk.gdk.window_foreign_new_for_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.window_foreign_new_for_display</methodname>
- <methodparam><parameter
- role="keyword">display</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
- <listitem><simpara>a native window system ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-wrapper for the native window or <literal>None</literal> if the window has
-been destroyed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The
-<function>gtk.gdk.window_foreign_new_for_display</function>() function wraps
-a native window specified by <parameter>anid</parameter> for the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-specified by <parameter>display</parameter> in a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>. This
-may fail if the window has been destroyed. For example in the X Window
-System backend, a native window handle is an Xlib
-<literal>XID</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--get-default-root-window">
- <title>gtk.gdk.get_default_root_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.get_default_root_window</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the default root <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.get_default_root_window</function>()
-function returns the root <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> (the
-parent window that all other windows are inside) for the default display and
-screen.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--window-get-toplevels">
- <title>gtk.gdk.window_get_toplevels</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.window_get_toplevels</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list containing the toplevel <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.window_get_toplevels</function>() function
-returns a list of all toplevel windows known to <literal>PyGTK</literal> on
-the default screen. A toplevel window is a child of the root window (see the
-<link
-linkend="function-gdk--get-default-root-window">gtk.gdk.get_default_root_window</link>()
-function).</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--window-lookup">
- <title>gtk.gdk.window_lookup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.window_lookup</methodname>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
- <listitem><simpara>a native window system ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-wrapper for the native window or <literal>None</literal> if there is
-none.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.window_lookup</function>() function looks
-up the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> that
-wraps the native window handle specified by <parameter>anid</parameter>. For
-example in the X Window System backend, a native window handle is an Xlib
-<literal>XID</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--window-lookup-for-display">
- <title>gtk.gdk.window_lookup_for_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.window_lookup_for_display</methodname>
- <methodparam><parameter
- role="keyword">display</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anid</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">anid</parameter>&nbsp;:</term>
- <listitem><simpara>a native window system ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-wrapper for the native window or <literal>None</literal> if there is
-none.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.window_lookup_for_display</function>()
-function looks up the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> that
-wraps the native window handle specified by <parameter>anid</parameter> for
-the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-specified by <parameter>display</parameter>. For example in the X Window
-System backend, a native window handle is an Xlib
-<literal>XID</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--window-process-all-updates">
- <title>gtk.gdk.window_process_all_updates</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.window_process_all_updates</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.gdk.process_all_updates</function>() function
-calls the <link
-linkend="method-gdkwindow--process-updates"><methodname>process_updates</methodname>()</link>
-method for each <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> in
-the application.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--gdk-window-set-debug-updates">
- <title>gtk.gdk.gdk_window_set_debug_updates</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.gdk_window_set_debug_updates</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> enable update
-debugging</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.gdk.gdk_set_debug_updates</function>() function
-sets the update debugging flag to the value of
-<parameter>setting</parameter>. If <parameter>setting</parameter> is
-<literal>True</literal>, update debugging is enabled. With update debugging
-enabled, calls to the <link
-linkend="method-gdkwindow--invalidate-rect"><methodname>invalidate_rect</methodname>()</link>
-method clear the invalidated rectangle of the screen to a noticeable color,
-and <literal>PyGTK</literal> pauses for a short time before sending exposes
-to windows during the <link
-linkend="method-gdkwindow--process-updates"><methodname>process_updates</methodname>()</link>
-method. The net effect is that you can see the invalid region for each
-window and watch redraws as they occur. This allows you to diagnose
-inefficiencies in your application.In essence, because the
-<literal>GDK</literal> rendering model prevents all flicker, if you are
-redrawing the same region 400 times you may never notice, aside from
-noticing a speed problem. Enabling update debugging causes
-<literal>PyGTK</literal> to flicker slowly and noticeably, so you can see
-exactly what's being redrawn when, in what order.</para>
-
- <para>The <option>--gtk-debug=updates</option> command line option
-passed to <literal>PyGTK</literal> programs enables this debug option at
-application startup time. That's usually more useful than calling
-<function>gtk.gdk.gdk_set_debug_updates</function>() yourself, though you might
-want to use this function to enable updates sometime after application
-startup time.</para>
-
- </refsect2>
-
- <refsect2 id="function-gdk--window-at-pointer">
- <title>gtk.gdk.window_at_pointer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.gdk.window_at_pointer</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3 tuple containing the <link
- linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
- and the pointer location in the window or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.gdk.window_at_pointer</function>() function
-returns a 3-tuple containing the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-underneath the mouse pointer, and the location of the pointer in the
-window. This function returns <literal>None</literal> if the window under
-the mouse pointer is not known to GDK (if the window belongs to another
-application and a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-hasn't been created for it with the <link
-linkend="function-gdk--window-foreign-new"><function>gtk.gdk.window_foreign_new</function>()</link>
-function)</para>
-
- <note>
- <para>For multi-head-aware widgets or applications use the <link
-linkend="method-gdkdisplay--get-window-at-pointer"><methodname>gtk.gdk.Display.get_window_at_pointer</methodname>()</link>
-method instead.</para>
- </note>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-glade-classes.xml b/docs/reference/pygtk-glade-classes.xml
deleted file mode 100644
index 678c11e7..00000000
--- a/docs/reference/pygtk-glade-classes.xml
+++ /dev/null
@@ -1,11 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<chapter id="glade-class-reference" xmlns:xi="http://www.w3.org/2001/XInclude">
- <title>The gtk.glade Class Reference</title>
-
-<!-- GLADE CLASSES -->
-
- <xi:include href="pygtk-gladexml.xml"/>
-
-</chapter>
diff --git a/docs/reference/pygtk-gladexml.xml b/docs/reference/pygtk-gladexml.xml
deleted file mode 100644
index e9ff5630..00000000
--- a/docs/reference/pygtk-gladexml.xml
+++ /dev/null
@@ -1,541 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gladexml">
- <refnamediv>
- <refname>gtk.glade.XML</refname>
- <refpurpose>Allows dynamic loading of user interfaces
- from XML descriptions.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.glade.XML</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gladexml">gtk.glade.XML</link></methodname>
- <methodparam><parameter role="keyword">fname</parameter></methodparam>
- <methodparam><parameter role="keyword">root</parameter><initializer><literal>""</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">domain</parameter><initializer><literal>""</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">typedict</parameter><initializer><literal>{}</literal></initializer></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gladexml--signal-connect">signal_connect</link></methodname>
- <methodparam><parameter>handler_name</parameter></methodparam>
- <methodparam><parameter>func</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gladexml--signal-autoconnect">signal_autoconnect</link></methodname>
- <methodparam><parameter role="keyword">dict</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gladexml--get-widget">get_widget</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gladexml--get-widget-prefix">get_widget_prefix</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gladexml--relative-file">relative_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-glade--xml-new-from-buffer">gtk.glade.xml_new_from_buffer</link></methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- <methodparam><parameter role="keyword">root</parameter><initializer><literal>""</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">domain</parameter><initializer><literal>""</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">typedict</parameter><initializer><literal>{}</literal></initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-glade--get-widget-name">gtk.glade.get_widget_name</link></methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-glade--get-widget-tree">gtk.glade.get_widget_tree</link></methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-glade--set-custom-handler">gtk.glade.set_custom_handler</link></methodname>
- <methodparam><parameter>handler</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-glade--bindtextdomain">gtk.glade.bindtextdomain</link></methodname>
- <methodparam><parameter role="keyword">domainname</parameter></methodparam>
- <methodparam><parameter role="keyword">dirname</parameter><initializer><literal>""</literal></initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-glade--textdomain">gtk.glade.textdomain</link></methodname>
- <methodparam><parameter role="keyword">domainname</parameter><initializer><literal>""</literal></initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-glade--set-custom-widget-callbacks">gtk.glade.set_custom_widget_callbacks</link></methodname>
- <methodparam><parameter role="keyword">dict</parameter></methodparam>
- </methodsynopsis></programlisting>
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
- <synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gladexml">gtk.glade.XML</link>
- </synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gladexml">
- <title>gtk.glade.XML Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>This object represents an `instantiation' of an XML interface
-description. When one of these objects is created, the XML file is read,
-and the interface is created. The <link
-linkend="class-gladexml"><classname>gtk.glade.XML</classname></link> object
-then provides an interface for accessing the widgets in the interface by the
-names assigned to them inside the XML description.</para>
-
- <para>The <link
-linkend="class-gladexml"><classname>gtk.glade.XML</classname></link> object
-can also be used to connect handlers to the named signals in the
-description. Libglade also provides an interface by which it can look up
-the signal handler names in the program's symbol table and automatically
-connect as many handlers up as it can that way.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gladexml">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.glade.XML</methodname>
- <methodparam><parameter role="keyword">fname</parameter></methodparam>
- <methodparam><parameter role="keyword">root</parameter><initializer><literal>""</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">domain</parameter><initializer><literal>""</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">typedict</parameter><initializer><literal>{}</literal></initializer></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">fname</parameter>&nbsp;:</term>
- <listitem><simpara>the XML file name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">root</parameter>&nbsp;:</term>
- <listitem><simpara>the widget node in <parameter>fname</parameter> to
-start building from (or <literal>""</literal>)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">domain</parameter>&nbsp;:</term>
- <listitem><simpara>the translation domain for the XML file (or
-<literal>""</literal> for default)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">typedict</parameter>&nbsp;:</term>
- <listitem><simpara>A dictionary used to lookup types (or
-<literal>{}</literal> for default)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>a new <link
-linkend="class-gladexml"><classname>gtk.glade.XML</classname></link>
-object</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gladexml"><classname>gtk.glade.XML</classname></link> object
-(and the corresponding widgets) from the XML file specified by
-<parameter>fname</parameter>. Optionally it will only build the interface
-from the widget node specified by <parameter>root</parameter> (if it is not
-<literal>""</literal>). This feature is useful if you only want to build
-say a toolbar or menu from the XML file, but not the window it is embedded
-in. Note also that the XML parse tree is cached to speed up creating another
-<link linkend="class-gladexml"><classname>gtk.glade.XML</classname></link>
-object for the same file.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gladexml--signal-connect">
- <title>gtk.glade.XML.signal_connect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>signal_connect</methodname>
- <methodparam><parameter>handler_name</parameter></methodparam>
- <methodparam><parameter>func</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>handler_name</parameter>&nbsp;:</term>
- <listitem><simpara>the signal handler name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>func</parameter>&nbsp;:</term>
- <listitem><simpara>the signal handler function</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>In the glade interface descriptions, signal handlers are
-specified for widgets by name. The <methodname>signal_connect</methodname>()
-method allows you to connect a callback specified by
-<parameter>func</parameter> to all signals in the <link
-linkend="class-gladexml"><classname>gtk.glade.XML</classname></link> file
-with the signal handler name specified by
-<parameter>handler_name</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gladexml--signal-autoconnect">
- <title>gtk.glade.XML.signal_autoconnect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>signal_autoconnect</methodname>
- <methodparam><parameter role="keyword">dict</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dict</parameter>&nbsp;:</term>
- <listitem><simpara>a mapping or an instance</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>signal_autoconnect</methodname>() method is a
-variation of the <link
-linkend="method-gladexml--signal-connect">gtk.glade.XML.signal_connect</link>
-method. It uses Python's introspective features to look at the keys (if
-<parameter>dict</parameter> is a mapping) or attributes (if
-<parameter>dict</parameter> is an instance) and tries to match them with the
-signal handler names given in the interface description. The callbacks
-referenced by each matched key or attribute are connected to their matching
-signals. The argument is called <literal>dict</literal> due to compatibility
-reasons since originally only the mapping interface was supported. The
-instance variant was introduced in PyGTK 2.0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gladexml--get-widget">
- <title>gtk.glade.XML.get_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_widget</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>the widget matching the name or
-<literal>None</literal></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_widget</methodname>() method returns a
-reference to the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> specified
-by <parameter>name</parameter> in the interface
-description. <literal>None</literal> is returned, if
-<parameter>name</parameter> doesn't specify a widget in the
-interface.</para>
-
- </refsect2>
-
- <refsect2 id="method-gladexml--get-widget-prefix">
- <title>gtk.glade.XML.get_widget_prefix</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_widget_prefix</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the prefix the widget names or
-<literal>""</literal> for all widgets</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>A list of widgets that match <parameter>name</parameter>
-as the start of their name or <literal>None</literal></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_widget_prefix</methodname>() method returns
-a list of interface <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> objects
-that have names prefixed by
-<parameter>name</parameter>. <literal>None</literal> is returned if no
-interface widget names match the prefix <parameter>name</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gladexml--relative-file">
- <title>gtk.glade.XML.relative_file</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>relative_file</methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>a relative file pathname</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>the absolute file pathname</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>relative_file</methodname>() method resolves the
-relative pathname specified by <parameter>filename</parameter>, using the
-directory of the XML file as a base. If <parameter>filename</parameter>
-contains an absolute pathname, then the original file name is
-returned.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-glade--xml-new-from-buffer">
- <title>gtk.glade.xml_new_from_buffer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.image_new_from_buffer</methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- <methodparam><parameter role="keyword">root</parameter><initializer><literal>""</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">domain</parameter><initializer><literal>""</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">typedict</parameter><initializer><literal>{}</literal></initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">buffer</parameter>&nbsp;:</term>
- <listitem><simpara>the string containing the XML buffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>size of the string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">root</parameter>&nbsp;:</term>
- <listitem><simpara>the widget node in fname to start building from
-(or <literal>""</literal>)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">domain</parameter>&nbsp;:</term>
- <listitem><simpara>the translation domain for the XML file (or
-<literal>""</literal> for default)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">typedict</parameter>&nbsp;:</term>
- <listitem><simpara>A dictionary used to lookup types (or
-<literal>{}</literal> for default)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>a new <link
-linkend="class-gladexml"><classname>gtk.glade.XML</classname></link>
- object.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.glade.xml_new_from_buffer</function>()
-function creates a new <link
-linkend="class-gladexml"><classname>gtk.glade.XML</classname></link> object
-(and the corresponding widgets) from the string specified by
-<parameter>buffer</parameter>. Optionally it will only build the interface
-from the widget node specified by <parameter>root</parameter> (if it is not
-<literal>""</literal>). This feature is useful if you only want to build
-say a toolbar or menu from the XML document, but not the window it is
-embedded in.</para>
-
- </refsect2>
-
- <refsect2 id="function-glade--get-widget-name">
- <title>gtk.glade.get_widget_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.glade.get_widget_name</methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>the name of the widget</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.glade.get_widget_name</function>() function
-returns the name of the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> specified
-by <parameter>widget</parameter> that was generated by a <link
-linkend="class-gladexml"><classname>gtk.glade.XML</classname></link>
-object.</para>
-
- </refsect2>
-
- <refsect2 id="function-glade--get-widget-tree">
- <title>gtk.glade.get_widget_tree</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.glade.get_widget_tree</methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>the <link
-linkend="class-gladexml"><classname>gtk.glade.XML</classname></link>
-object that built <parameter>widget</parameter></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>This <function>gtk.glade.get_widget_tree</function>() function
-is used to get the <link
-linkend="class-gladexml"><classname>gtk.glade.XML</classname></link> object
-that built the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> specified
-by <parameter>widget</parameter>.</para>
-
- </refsect2>
-
-<refsect2 id="function-glade--set-custom-handler">
- <title>gtk.glade.set_custom_handler</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.glade.set_custom_handler</methodname>
- <methodparam><parameter role="keyword">handler</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">handler</parameter>&nbsp;:</term>
- <listitem><simpara>the custom widget handler.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data passed to the custom handler.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>This <function>gtk.glade.set_custom_handler</function>() function
- allows you to override the default behaviour when a Custom widget is found in an interface.
- </para>
-</refsect2>
-
-<refsect2 id="function-glade--bindtextdomain">
- <title>gtk.glade.bindtextdomain</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.glade.bindtextdomain</methodname>
- <methodparam><parameter role="keyword">domainname</parameter></methodparam>
- <methodparam><parameter role="keyword">dirname</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">domainname</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the application.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dirname</parameter>&nbsp;:</term>
- <listitem><simpara>the directory where to find locales.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the value of <parameter>dirname</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>This <function>gtk.glade.bindtextdomain</function>() function allows you to use internationalisation with glade.
- </para>
-</refsect2>
-
-<refsect2 id="function-glade--textdomain">
- <title>gtk.glade.textdomain</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.glade.textdomain</methodname>
- <methodparam><parameter role="keyword">domainname</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">domainname</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the application.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the value of <parameter>domainname</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>This <function>gtk.glade.textdomain</function>() function allows you to use internationalisation with glade.
- </para>
-</refsect2>
-
-<refsect2 id="function-glade--set-custom-widget-callbacks">
- <title>gtk.glade.set_custom_widget_callbacks</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.glade.set_custom_widget_callbacks</methodname>
- <methodparam><parameter role="keyword">dict</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dict</parameter>&nbsp;:</term>
- <listitem><simpara>a dictionary of function names.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>This <function>gtk.glade.set_custom_widget_callbacks</function>() function
- takes a dictionary of function names->functions, for an example see
- <ulink url="http://www.async.com.br/faq/pygtk/index.py">PyGTK FAQ 22.7</ulink>
- for an example.
- </para>
-</refsect2>
-</refsect1>
-</refentry>
diff --git a/docs/reference/pygtk-gobject-classes.xml b/docs/reference/pygtk-gobject-classes.xml
deleted file mode 100644
index 25b37a09..00000000
--- a/docs/reference/pygtk-gobject-classes.xml
+++ /dev/null
@@ -1,20 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<chapter id="gobject-class-reference"
- xmlns:xi="http://www.w3.org/2001/XInclude">
-
-<title>The gobject Class Reference</title>
-
-<!-- GOBJECT CLASSES -->
-
-<xi:include href="pygtk-gobject.xml"/>
-<xi:include href="pygtk-gobject-gboxed.xml"/>
-<xi:include href="pygtk-gobject-gpointer.xml"/>
-<xi:include href="pygtk-gobject-ginterface.xml"/>
-<xi:include href="pygtk-gobject-maincontext.xml"/>
-<xi:include href="pygtk-gobject-mainloop.xml"/>
-<xi:include href="pygtk-gobject-functions.xml"/>
-<xi:include href="pygtk-gobject-constants.xml"/>
-
-</chapter>
diff --git a/docs/reference/pygtk-gobject-constants.xml b/docs/reference/pygtk-gobject-constants.xml
deleted file mode 100644
index 894c8aeb..00000000
--- a/docs/reference/pygtk-gobject-constants.xml
+++ /dev/null
@@ -1,495 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="gobject-constants">
- <refnamediv>
- <refname>gobject Constants</refname>
- <refpurpose>the built-in constants of the gobject module</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <programlisting>
-<xref linkend="gobject-io-condition-constants" endterm="gobject-io-condition-constants-title"></xref>
-<xref linkend="gobject-param-constants" endterm="gobject-param-constants-title"></xref>
-<xref linkend="gobject-priority-constants" endterm="gobject-priority-constants-title"></xref>
-<xref linkend="gobject-signal-constants" endterm="gobject-signal-constants-title"></xref>
-<xref linkend="gobject-spawn-flag-constants" endterm="gobject-spawn-flag-constants-title"></xref>
-<xref linkend="gobject-type-constants" endterm="gobject-type-constants-title"></xref>
-<xref linkend="gobject-version-constants" endterm="gobject-version-constants-title"></xref>
-</programlisting>
-
- </refsect1>
-
- <refsect1 id="gobject-constants-description">
- <title>Description</title>
-
- <refsect2 id="gobject-io-condition-constants">
- <title id="gobject-io-condition-constants-title">GObject IO Condition Constants</title>
-
- <para>The IO Condition constants are a set of bit-flags that specify a
-condition to watch for on an event source.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gobject.IO_IN</literal></term>
- <listitem>
- <simpara>There is data to read</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.IO_OUT</literal></term>
- <listitem>
- <simpara>Data can be written (without blocking).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.IO_PRI</literal></term>
- <listitem>
- <simpara>There is urgent data to read.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.IO_ERR</literal></term>
- <listitem>
- <simpara>Error condition.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.IO_HUP</literal></term>
- <listitem>
- <simpara>Hung up (the connection has been broken, usually for
- pipes and sockets).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.IO_NVAL</literal></term>
- <listitem>
- <simpara>Invalid request. The file descriptor is not
- open.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gobject-param-constants">
- <title id="gobject-param-constants-title">GObject Param Flag Constants</title>
-
- <para>The Param Flag constants are a set of bit-flags that specify
-certain aspects of parameters that can be configured.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gobject.PARAM_READABLE</literal></term>
- <listitem>
- <simpara>The parameter is readable</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.PARAM_WRITABLE</literal></term>
- <listitem>
- <simpara>The parameter is writable</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.PARAM_CONSTRUCT</literal></term>
- <listitem>
- <simpara>The parameter will be set upon object
- construction</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.PARAM_CONSTRUCT_ONLY</literal></term>
- <listitem>
- <simpara>The parameter will only be set upon object
- construction</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.PARAM_LAX_VALIDATION</literal></term>
- <listitem>
- <simpara>Upon parameter conversion strict validation is not
- required</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gobject-priority-constants">
- <title id="gobject-priority-constants-title">GObject Priority Constants</title>
-
- <para>The Priority constants specify </para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gobject.PRIORITY_HIGH</literal></term>
- <listitem>
- <simpara>Use this for high priority event sources.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.PRIORITY_DEFAULT</literal></term>
- <listitem>
- <simpara>Use this for default priority event sources. This
- priority is used when adding timeout functions with the <link
- linkend="function-gobject--timeout-add"><function>gobject.timeout_add</function>()</link>
- function. This priority is also used for events from the X
- server.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.PRIORITY_HIGH_IDLE</literal></term>
- <listitem>
- <simpara>Use this for high priority idle functions. For example,
- gobject.PRIORITY_HIGH_IDLE + 10 is used for resizing operations;
- and, gobject.PRIORITY_HIGH_IDLE + 20, for redrawing
- operations. (This is done to ensure that any pending resizes are
- processed before any pending redraws, so that widgets are not
- redrawn twice unnecessarily.)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.PRIORITY_DEFAULT_IDLE</literal></term>
- <listitem>
- <simpara>Use this for default priority idle functions. This
- priority is used when adding idle functions with the <link
- linkend="function-gobject--idle-add"><function>gobject.idle_add</function>()</link>
- function.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.PRIORITY_LOW</literal></term>
- <listitem>
- <simpara>Use this for very low priority background
- tasks.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gobject-signal-constants">
- <title id="gobject-signal-constants-title">GObject Signal Flag Constants</title>
-
- <para>The Signal Flag constants are a set of bit-flags that specify a
-signal's behavior. The overall signal description outlines how especially
-the <literal>RUN</literal> flags control the stages of a signal
-emission.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gobject.SIGNAL_RUN_FIRST</literal></term>
- <listitem>
- <simpara>Invoke the object method handler in the first emission
- stage.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_RUN_LAST</literal></term>
- <listitem>
- <simpara>Invoke the object method handler in the third emission
- stage.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_RUN_CLEANUP</literal></term>
- <listitem>
- <simpara>Invoke the object method handler in the last emission
- stage.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_NO_RECURSE</literal></term>
- <listitem>
- <simpara>Signals being emitted for an object while currently
- being in emission for this very object will not be emitted
- recursively, but instead cause the first emission to be
- restarted.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_DETAILED</literal></term>
- <listitem>
- <simpara>This signal supports "::detail" appendices to the
- signal name upon handler connections and emissions.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_ACTION</literal></term>
- <listitem>
- <simpara>Action signals are signals that may freely be emitted
- on alive objects from user code via the <link
- linkend="method-gobject--emit"><methodname>gobject.emit</methodname>()</link>
- method and friends, without the need of being embedded into
- extra code that performs pre or post emission adjustments on the
- object. They can also be thought of as object methods which can
- be called generically by third-party code.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_NO_HOOKS</literal></term>
- <listitem>
- <simpara>No emissions hooks are supported for this
- signal.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gobject-spawn-flag-constants">
- <title id="gobject-spawn-flag-constants-title">GObject Spawn Flag Constants</title>
-
- <para>The Spawn Flag constants are a set of bit-flags that can be
-passed to the <link
-linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
-function.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gobject.SPAWN_LEAVE_DESCRIPTORS_OPEN</literal></term>
- <listitem>
- <simpara>the parent's open file descriptors will be inherited by
-the child; otherwise all descriptors except stdin/stdout/stderr will be
-closed before calling <function>exec</function>() in the child.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SPAWN_DO_NOT_REAP_CHILD</literal></term>
- <listitem>
- <simpara>the child will not be automatically reaped; you must
-call <function>waitpid</function>() or handle <literal>SIGCHLD</literal>
-yourself, or the child will become a zombie.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SPAWN_SEARCH_PATH</literal></term>
- <listitem>
- <simpara><parameter>argv</parameter>[0] need not be an absolute
-path, it will be looked for in the user's <envar>PATH</envar>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SPAWN_STDOUT_TO_DEV_NULL</literal></term>
- <listitem>
- <simpara>the child's standard output will be discarded, instead
-of going to the same location as the parent's standard output.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SPAWN_STDERR_TO_DEV_NULL</literal></term>
- <listitem>
- <simpara>the child's standard error will be discarded.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SPAWN_CHILD_INHERITS_STDIN</literal></term>
- <listitem>
- <simpara>the child will inherit the parent's standard input (by
-default, the child's standard input is attached to /dev/null).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SPAWN_FILE_AND_ARGV_ZERO</literal></term>
- <listitem>
- <simpara>the first element of <parameter>argv</parameter> is the
-file to execute, while the remaining elements are the actual argument vector
-to pass to the file. Normally <link
-linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
-uses <parameter>argv</parameter>[0] as the file to execute, and passes all
-of <parameter>argv</parameter> to the child.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gobject-type-constants">
- <title id="gobject-type-constants-title">GObject Built-in Type Constants</title>
-
- <para>The Built-in Type constants specify the pre-defined types used
-by gobject.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gobject.TYPE_INVALID</literal></term>
- <listitem>
- <simpara>An invalid type, used as error return value in some
- functions.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_NONE</literal></term>
- <listitem>
- <simpara>A fundamental type indicating no type.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_INTERFACE</literal></term>
- <listitem>
- <simpara>The fundamental type from which all interfaces are
- derived.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_CHAR</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a
- character. This maps to a string in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_UCHAR</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to an unsigned
- character. This maps to a string in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_BOOLEAN</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a True or False
- value. This maps to an integer in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_INT</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to an
- integer. This maps to an integer in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_UINT</literal></term>
- <listitem>
- <simpara>he fundamental type corresponding to an unsigned
- integer. This maps to an integer in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_LONG</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a long
- integer. This maps to an integer in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_ULONG</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to an unsigned
- integer. This maps to an integer in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_INT64</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to an long long
- integer. This maps to a long integer in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_UINT64</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to an unsigned long
- long integer. This maps to a long integer in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_ENUM</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to an enumeration
- type. This maps to an integer in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_FLAGS</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a flag
- type. This maps to an integer in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_FLOAT</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a floating point
- number. This maps to a float in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_DOUBLE</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a double
- floating point number. This maps to a float in Python.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_STRING</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a string.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_POINTER</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a pointer to an
- anonymous type. This has no corresponding Python type.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_BOXED</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a boxed object
- type.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_PARAM</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a GParamSpec
- type.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_OBJECT</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a GObject
- type.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_PYOBJECT</literal></term>
- <listitem>
- <simpara>The fundamental type corresponding to a Python Object
- type.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gobject-version-constants">
- <title id="gobject-version-constants-title">GObject Version Constants</title>
-
- <para>The Version constants specify the version of
-<literal>GLIB</literal> used by PyGTK as a 3-tuple containing the major,
-minor and patch release numbers.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gobject.glib_version</literal></term>
- <listitem>
- <simpara>A 3-tuple containing (major, minor, patch) release
- numbers.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gobject-functions.xml b/docs/reference/pygtk-gobject-functions.xml
deleted file mode 100644
index 5e0145fc..00000000
--- a/docs/reference/pygtk-gobject-functions.xml
+++ /dev/null
@@ -1,1373 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="gobject-functions">
- <refnamediv>
- <refname>gobject Functions</refname>
- <refpurpose>miscellaneous functions</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <programlisting>
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--type-name">gobject.type_name</link></methodname>
- <methodparam><parameter>type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--type-from-name">gobject.type_from_name</link></methodname>
- <methodparam><parameter>type_name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--type-parent">gobject.type_parent</link></methodname>
- <methodparam><parameter>type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--type-is-a">gobject.type_is_a</link></methodname>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>parent_type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--type-children">gobject.type_children</link></methodname>
- <methodparam><parameter>type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--type-interfaces">gobject.type_interfaces</link></methodname>
- <methodparam><parameter>type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--type-register">gobject.type_register</link></methodname>
- <methodparam><parameter>class</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--signal-new">gobject.signal_new</link></methodname>
- <methodparam><parameter>signal_name</parameter></methodparam>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>flags</parameter></methodparam>
- <methodparam><parameter>return_type</parameter></methodparam>
- <methodparam><parameter>param_types</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--signal-list-names">gobject.signal_list_names</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--signal-list-ids">gobject.signal_list_ids</link></methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--signal-lookup">gobject.signal_lookup</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--signal-name">gobject.signal_name</link></methodname>
- <methodparam><parameter role="keyword">signal_id</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--signal-query1">gobject.signal_query</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--signal-query2">gobject.signal_query</link></methodname>
- <methodparam><parameter role="keyword">signal_id</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--list-properties">gobject.list_properties</link></methodname>
- <methodparam><parameter>type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--new">gobject.new</link></methodname>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--idle-add">gobject.idle_add</link></methodname>
- <methodparam><parameter>callback</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--timeout-add">gobject.timeout_add</link></methodname>
- <methodparam><parameter>interval</parameter></methodparam>
- <methodparam><parameter>callback</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--io-add-watch">gobject.io_add_watch</link></methodname>
- <methodparam><parameter>fd</parameter></methodparam>
- <methodparam><parameter>condition</parameter></methodparam>
- <methodparam><parameter>callback</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--source-remove">gobject.source_remove</link></methodname>
- <methodparam><parameter>tag</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--main-context-default">gobject.main_context_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--markup-escape-text">gobject.markup_escape_text</link></methodname>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gobject--child-watch-add">gobject.child_watch_add</link></methodname>
- <methodparam><parameter role="keyword">pid</parameter></methodparam>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">priority</parameter><initializer>gobject.PRIORITY_DEFAULT</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--spawn-async">gobject.spawn_async</link></methodname>
- <methodparam><parameter role="keyword">argv</parameter></methodparam>
- <methodparam><parameter role="keyword">envp</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">working_directory</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">flags</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">child_setup</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">standard_input</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">standard_output</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">standard_error</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--get-current-time">gobject.get_current_time</link></methodname>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gobject--main-depth">gobject.main_depth</link></methodname>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>These functions are part of the <literal>PyGTK</literal> gobject
-module but are not directly associated with a specific class.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gobject--type-name">
- <title>gobject.type_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.type_name</methodname>
- <methodparam><parameter>type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.type_name</function>() function returns
-the unique name that is assigned to the specified
-<parameter>type</parameter>. <parameter>type</parameter> can be a GObject
-type, type ID or instance. This function raises a TypeError exception
-if <parameter>type</parameter> isn't a <literal>PyGTK</literal> type.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--type-from-name">
- <title>gobject.type_from_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.type_from_name</methodname>
- <methodparam><parameter>type_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>type_name</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the name of a
-type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the type ID named
-<parameter>type_name</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.type_from_name</function>() function
-returns the type ID of the <literal>PyGTK</literal> type with the name
-specified by <parameter>type_name</parameter>. This function raises a
-RuntimeError exception if no type matches
-<parameter>type_name</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--type-parent">
- <title>gobject.type_parent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.type_parent</methodname>
- <methodparam><parameter>type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the parent type ID</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.type_parent</function>() function returns
-the direct parent type ID of the specified <parameter>type</parameter>.
-<parameter>type</parameter> can be a GObject type, type ID or instance. If
-<parameter>type</parameter> has no parent, i.e. is a fundamental type, the
-RuntimeError exception is raised. </para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--type-is-a">
- <title>gobject.type_is_a</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.type_is_a</methodname>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>parent_type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>parent_type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>parent_type</parameter> is an ancestor of
-<parameter>type</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.type_is_a</function>() function returns
-<literal>True</literal> if the specified <parameter>type</parameter> is a
-descendant of the type specified by <parameter>parent_type</parameter>. This
-function also returns <literal>True</literal> if
-<parameter>parent_type</parameter> is an interface and
-<parameter>type</parameter> conforms to it.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--type-children">
- <title>gobject.type_children</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.type_children</methodname>
- <methodparam><parameter>type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the child types of
-<parameter>type</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.type_children</function>() function
-returns a list containing the child types of the specified
-<parameter>type</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--type-interfaces">
- <title>gobject.type_interfaces</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.type_interfaces</methodname>
- <methodparam><parameter>type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the interface types supported by
-<parameter>type</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.type_interfaces</function>() function
-returns a list of the interface types supported by
-<parameter>type</parameter>. <parameter>type</parameter> can be a GObject
-type, type ID or instance. This function returns a RuntimeError exception if
-type is not a valid type or has no interfaces.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--type-register">
- <title>gobject.type_register</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.type_register</methodname>
- <methodparam><parameter>class</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>class</parameter>&nbsp;:</term>
- <listitem><simpara>a Python class that is a descendant of <link
-linkend="class-gobject"><classname>gobject.GObject</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.type_register</function>() function
-registers the specified Python <parameter>class</parameter> as a PyGTK type.
-class must be a descendant of <link
-linkend="class-gobject"><classname>gobject.GObject</classname></link>. The function generates a name for the new type.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--signal-new">
- <title>gobject.signal_new</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.signal_new</methodname>
- <methodparam><parameter>signal_name</parameter></methodparam>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>flags</parameter></methodparam>
- <methodparam><parameter>return_type</parameter></methodparam>
- <methodparam><parameter>param_types</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>signal_name</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the name of the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term>
- <listitem><simpara>the object type that the signal is associated
-with</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>flags</parameter>&nbsp;:</term>
- <listitem><simpara>the signal flags</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>return_type</parameter>&nbsp;:</term>
- <listitem><simpara>the return type of the signal
-handler</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>param_types</parameter>&nbsp;:</term>
- <listitem><simpara>the parameter types passed to the signal
-handler</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a unique integer signal ID</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.signal_new</function>() function registers
-a signal with the specified <parameter>signal_name</parameter> for the
-specified object <parameter>type</parameter>. The value of
-<parameter>flags</parameter> is a combination of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gobject.SIGNAL_RUN_FIRST</literal></term>
- <listitem>
- <simpara>Invoke the object method handler in the first emission
-stage. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_RUN_LAST</literal></term>
- <listitem>
- <simpara>Invoke the object method handler in the third emission
-stage.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_RUN_CLEANUP</literal></term>
- <listitem>
- <simpara>Invoke the object method handler in the last emission
-stage.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_NO_RECURSE</literal></term>
- <listitem>
- <simpara>Signals being emitted for an object while currently
-being in emission for this very object will not be emitted recursively, but
-instead cause the first emission to be restarted.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_DETAILED</literal></term>
- <listitem>
- <simpara>This signal supports "::detail" appendixes to the
-signal name upon handler connections and emissions.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_ACTION</literal></term>
- <listitem>
- <simpara>Action signals are signals that may freely be emitted
-on alive objects from user code via <link
-linkend="method-gobject--emit"><methodname>gobject.emit()</methodname>()</link>
-and friends, without the need of being embedded into extra code that
-performs pre or post emission adjustments on the object. They can also be
-thought of as generically callable object methods.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.SIGNAL_NO_HOOKS</literal></term>
- <listitem>
- <simpara> No emissions hooks are supported for this
-signal.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para><parameter>return_type</parameter> is the type of the return
-value from a signal handler and may be a gobject type, type ID or instance.
-The <parameter>param_types</parameter> parameter is a list of additional
-types that are passed to the signal handler. Each parameter type may be
-specified as a gobject type, type ID or instance. For example, to add a
-signal to the gtk.Window type called "my-signal" that calls a handler with a
-gtk.Button widget and an integer value and a return value that is a
-boolean, use:</para>
-
- <programlisting>
- gobject.signal_new("my_signal", gtk.Window, gobject.SIGNAL_RUN_LAST, gobject.TYPE_BOOLEAN, (gtk.Button, gobject.TYPE_INT))
-</programlisting>
-
- </refsect2>
-
- <refsect2 id="function-gobject--signal-list-names">
- <title>gobject.signal_list_names</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.signal_list_names</methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the signal names supported by
-<parameter>type</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.signal_list_names</function>() function
-returns a list of the names of the signals that are supported by the
-specified GObject <parameter>type</parameter></para>
-
- <note>
- <para>The type keyword is available in PyGTK 2.6 and above.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="function-gobject--signal-list-ids">
- <title>gobject.signal_list_ids</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.signal_list_ids</methodname>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the signal ids supported by
-<parameter>type</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gobject.signal_list_ids</function>() function
-returns a list of the integer ids of the signals that are supported by the
-GObject specified by <parameter>type</parameter></para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--signal-lookup">
- <title>gobject.signal_lookup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.signal_lookup</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a signal for
-<parameter>type</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the integer id of a signal supported by
-<parameter>type</parameter></simpara> or 0.</listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gobject.signal_lookup</function>() function
-returns the id of the signal with the name specified by
-<parameter>name</parameter> that is supported by the GObject specified
-specified by<parameter>type</parameter>. 0 is returned if the signal is not
-found.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--signal-name">
- <title>gobject.signal_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.signal_name</methodname>
- <methodparam><parameter role="keyword">signal_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">signal_id</parameter>&nbsp;:</term>
- <listitem><simpara>an integer signal id</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the signal or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gobject.signal_name</function>() function returns
-the name of the signal that has the signal id specified by
-<parameter>id</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--signal-query1">
- <title>gobject.signal_query</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.signal_query</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a signal for
-<parameter>type</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 6-tuple containing signal information or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gobject.signal_query</function>() function returns
-a 6-tuple containing information about the signal with the name specified by
-<parameter>name</parameter> that is supported by the GObject specified by
-<parameter>type</parameter>. If the signal is not found
-<literal>None</literal> is returned.</para>
-
- <para>The signal information 6-tuple contains:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the integer signal id</simpara>
- </listitem>
- <listitem>
- <simpara>the signal name</simpara>
- </listitem>
- <listitem>
- <simpara>the GType that the signal is registered for</simpara>
- </listitem>
- <listitem>
- <simpara>the signal flags (see the <xref
-linkend="gobject-signal-constants"
-endterm="gobject-signal-constants-title"></xref>)</simpara>
- </listitem>
- <listitem>
- <simpara>the GType of the return from the signal callback
-function</simpara>
- </listitem>
- <listitem>
- <simpara>a tuple containing the GTypes of the parameters that are
-passed to the signal callback function. Note that these may not correspond
-exactly to the <literal>PyGTK</literal> signal callback parameters.</simpara>
- </listitem>
- </itemizedlist>
-
- </refsect2>
-
- <refsect2 id="function-gobject--signal-query2">
- <title>gobject.signal_query</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.signal_query</methodname>
- <methodparam><parameter role="keyword">signal_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">signal_id</parameter>&nbsp;:</term>
- <listitem><simpara>the integer id of a signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 6-tuple containing signal information or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gobject.signal_query</function>() function returns
-a 6-tuple containing information about the signal with the id specified by
-<parameter>signal_id</parameter>. If the signal is not found
-<literal>None</literal> is returned.</para>
-
- <para>The signal information 6-tuple contains:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the integer signal id</simpara>
- </listitem>
- <listitem>
- <simpara>the signal name</simpara>
- </listitem>
- <listitem>
- <simpara>the GType that the signal is registered for</simpara>
- </listitem>
- <listitem>
- <simpara>the signal flags (see the <xref
-linkend="gobject-signal-constants"
-endterm="gobject-signal-constants-title"></xref>)</simpara>
- </listitem>
- <listitem>
- <simpara>the GType of the return from the signal callback
-function</simpara>
- </listitem>
- <listitem>
- <simpara>a tuple containing the GTypes of the parameters that are
-passed to the signal callback function. Note that these may not correspond
-exactly to the <literal>PyGTK</literal> signal callback parameters.</simpara>
- </listitem>
- </itemizedlist>
-
- </refsect2>
-
- <refsect2 id="function-gobject--list-properties">
- <title>gobject.list_properties</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.list_properties</methodname>
- <methodparam><parameter>type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the properties (as GParam objects)
-supported by <parameter>type</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.list_properties</function>() function
-returns a list of the properties (as GParam objects) supported by
-<parameter>type</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--new">
- <title>gobject.new</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.new</methodname>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject type, type ID or
-instance</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>zero or more property-value
-pairs</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new object if the specified
-<parameter>type</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.new</function>() function returns a new
-object of the specified <parameter>type</parameter>. type must specify a
-type that is a descendant of <link
-linkend="class-gobject"><classname>gobject.GObject</classname></link>. A
-TypeError exception is raised if <parameter>type</parameter> specifies an
-abstract class or a type that is not a descendant of <link
-linkend="class-gobject"><classname>gobject.GObject</classname></link>. A set
-of property-value pairs may be specified to set the value of the object's
-properties.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--idle-add">
- <title>gobject.idle_add</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.idle_add</methodname>
- <methodparam><parameter>callback</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>callback</parameter>&nbsp;:</term>
- <listitem><simpara>a function to call when
-<literal>PyGTK</literal> is idle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>optionals arguments to be passed to
-<parameter>callback</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer ID</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.idle_add</function>() function adds a
-function (specified by <parameter>callback</parameter>) to be called
-whenever there are no higher priority events pending to the default main
-loop. The function is given the default idle priority,
-<literal>gobject.PRIORITY_DEFAULT_IDLE</literal>. Additional arguments to
-pass to <parameter>callback</parameter> can be specified after
-<parameter>callback</parameter>. The idle priority can be specified as a
-keyword-value pair with the keyword "priority". If
-<parameter>callback</parameter> returns <literal>False</literal> it is
-automatically removed from the list of event sources and will not be called
-again.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--timeout-add">
- <title>gobject.timeout_add</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.timeout_add</methodname>
- <methodparam><parameter>interval</parameter></methodparam>
- <methodparam><parameter>callback</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>interval</parameter>&nbsp;:</term>
- <listitem><simpara>the time between calls to the function, in
-milliseconds </simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>callback</parameter>&nbsp;:</term>
- <listitem><simpara>the function to call</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>zero or more arguments that will be passed to
-<parameter>callback</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer ID of the event
-source</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.timeout_add</function>() function sets a
-function (specified by <parameter>callback</parameter>) to be called at
-regular intervals (specified by <parameter>interval</parameter>, with the
-default priority, <literal>gobject.PRIORITY_DEFAULT</literal>. Additional
-arguments to pass to <parameter>callback</parameter> can be specified after
-<parameter>callback</parameter>. The idle priority may be specified as a
-keyword-value pair with the keyword "priority".</para>
-
- <para>The function is called repeatedly until it returns
-<literal>False</literal>, at which point the timeout is automatically
-destroyed and the function will not be called again. The first call to the
-function will be at the end of the first interval. Note that timeout
-functions may be delayed, due to the processing of other event sources. Thus
-they should not be relied on for precise timing. After each call to the
-timeout function, the time of the next timeout is recalculated based on the
-current time and the given interval (it does not try to 'catch up' time lost
-in delays).</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--io-add-watch">
- <title>gobject.io_add_watch</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.io_add_watch</methodname>
- <methodparam><parameter>fd</parameter></methodparam>
- <methodparam><parameter>condition</parameter></methodparam>
- <methodparam><parameter>callback</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>fd</parameter>&nbsp;:</term>
- <listitem><simpara>a Python file object or an integer file
-descriptor ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>condition</parameter>&nbsp;:</term>
- <listitem><simpara>a condition mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>callback</parameter>&nbsp;:</term>
- <listitem><simpara>a function to call</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional arguments to pass to
-<parameter>callback</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer ID of the event source</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.io_add_watch</function>() function
-arranges for the file (specified by <parameter>fd</parameter>) to be
-monitored by the main loop for the specified
-<parameter>condition</parameter>. <parameter>fd</parameter> may be a Python
-file object or an integer file descriptor. The value of condition is a
-combination of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gobject.IO_IN</literal></term>
- <listitem>
- <simpara>There is data to read.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.IO_OUT</literal></term>
- <listitem>
- <simpara>Data can be written (without blocking). </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.IO_PRI</literal></term>
- <listitem>
- <simpara>There is urgent data to read.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.IO_ERR</literal></term>
- <listitem>
- <simpara>Error condition.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.IO_HUP</literal></term>
- <listitem>
- <simpara>Hung up (the connection has been broken, usually for
-pipes and sockets).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>Additional arguments to pass to <parameter>callback</parameter>
-can be specified after <parameter>callback</parameter>. The idle priority
-may be specified as a keyword-value pair with the keyword "priority". The
-signature of the callback function is:</para>
-
- <programlisting>
- def callback(source, cb_condition, ...)
-</programlisting>
-
- <para>where <parameter>source</parameter> is
-<parameter>fd</parameter>, the file descriptor;
-<parameter>cb_condition</parameter> is the condition that triggered the
-signal; and, <parameter>...</parameter> are the zero or more arguments that
-were passed to the <function>gobject.io_add_watch</function>()
-function.</para>
-
- <para>If the callback function returns <literal>False</literal> it
-will be automatically removed from the list of event sources and will not be
-called again. If it returns <literal>True</literal> it will be called again
-when the condition is matched.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--source-remove">
- <title>gobject.source_remove</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.source_remove</methodname>
- <methodparam><parameter>tag</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>tag</parameter>&nbsp;:</term>
- <listitem><simpara>an integer ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the event source was
-removed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.source_remove</function>() function
-removes the event source specified by tag (as returned by the <link
-linkend="function-gobject--idle-add"><function>gobject.idle_add</function>()</link>,
-<link
-linkend="function-gobject--timeout-add"><function>gobject.timeout_add</function></link>()
-and <link
-linkend="function-gobject--io-add-watch"><function>gobject.io_add_watch</function>()</link>
-functions)</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--main-context-default">
- <title>gobject.main_context_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.main_context_default</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default gobject.MainContext
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gobject.main_context_default</function>() function
-returns the default gobject.MainContext object.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--markup-escape-text">
- <title>gobject.markup_escape_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.markup_escape_text</methodname>
- <methodparam><parameter>text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>the UTF-8 string to be
-escaped</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the escaped text</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <function>gobject.markup_escape_text</function>() function
-escapes the string specified by <parameter>text</parameter> so that the
-markup parser will parse it verbatim. Less than, greater than, ampersand,
-etc. are replaced with the corresponding entities. This function would
-typically be used when writing out a file to be parsed with the markup
-parser.</para>
-
- <para>Note that this function doesn't protect whitespace and line
-endings from being processed according to the XML rules for normalization of
-line endings and attribute values.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--child-watch-add">
- <title>gobject.child_watch_add</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.child_watch_add</methodname>
- <methodparam><parameter role="keyword">pid</parameter></methodparam>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">priority</parameter><initializer>gobject.PRIORITY_DEFAULT</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist role="params">
- <varlistentry>
- <term><parameter role="keyword">pid</parameter>&nbsp;:</term>
- <listitem><simpara>process id of a child process to watch</simpara></listitem>
- </varlistentry>
- <varlistentry><term><parameter role="keyword">function</parameter>&nbsp;:</term>
- <listitem><simpara>the function to call</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>the optional data to pass to
-<parameter>function</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">priority</parameter>&nbsp;:</term>
- <listitem><simpara>the priority of the idle source - one of the
-<xref linkend="gobject-priority-constants"
-endterm="gobject-priority-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the id of event source.</simpara></listitem>
- </varlistentry>
- </variablelist>
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gobject.child_watch_add</function>() function sets
-the function specified by <parameter>function</parameter> to be called with
-the user data specified by <parameter>data</parameter> when the child
-indicated by <parameter>pid</parameter> exits. The signature for the
-callback is:</para>
-
- <programlisting>
-def callback(pid, condition, user_data)
-</programlisting>
-
- <para>where <parameter>pid</parameter> is is the child process id,
-<parameter>condition</parameter> is the status information about the child
-process and <parameter>user_data</parameter> is <parameter>data</parameter>
-PyGTK supports only a single callback per process id.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--spawn-async">
- <title>gobject.spawn_async</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.spawn_async</methodname>
- <methodparam><parameter role="keyword">argv</parameter></methodparam>
- <methodparam><parameter role="keyword">envp</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">working_directory</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">flags</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">child_setup</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">standard_input</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">standard_output</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">standard_error</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist role="params">
- <varlistentry>
- <term><parameter role="keyword">argv</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of strings containing the arguments
-of the child process</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">envp</parameter>&nbsp;:</term>
- <listitem><simpara>the child's environment or
-<literal>None</literal> to inherit the parent's
-environment.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">working_directory</parameter>&nbsp;:</term>
- <listitem><simpara>the child's current working directory, or
-<literal>None</literal> to inherit parent's</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>flags from the <xref
-linkend="gobject-spawn-flag-constants"
-endterm="gobject-spawn-flag-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">child_setup</parameter>&nbsp;:</term>
- <listitem><simpara>a function to run in the child just before
-calling <function>exec</function>()</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>the user data for the
-<parameter>child_setup</parameter> function</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">standard_input</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> return the file
-descriptor for the child's stdin</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">standard_output</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> return the file
-descriptor for the child's stdout</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">standard_error</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> return the file
-descriptor for the child's stderr</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 4-tuple containing the child's process id and
-the stdin, stdout and stderr file descriptor integers.</simpara></listitem>
- </varlistentry>
- </variablelist>
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gobject.spawn_async</function>() function executes
-a child program asynchronously (your program will not block waiting for the
-child to exit). The child program is specified by the only argument that
-must be provided, <parameter>argv</parameter>. <parameter>argv</parameter>
-should be a sequence of strings, to be passed as the argument vector for the
-child. The first string in <parameter>argv</parameter> is of course the name
-of the program to execute. By default, the name of the program must be a
-full path; the <envar>PATH</envar> shell variable will only be searched if
-you pass the <literal>gobject.SPAWN_SEARCH_PATH</literal> flag in
-<parameter>flags</parameter>. The function returns a 4-tuple containing the
-child's process id and the file descriptors for the child's stdin, stdout
-and stderr. The stdin, stdout and stderr file descriptors are returned only
-ofthe corresponding <parameter>standard_input</parameter>,
-<parameter>standard_output</parameter> or
-<parameter>standard_error</parameter> params are
-<literal>True</literal>.</para>
-
- <para>On Windows, the low-level child process creation API
-(<function>CreateProcess</function>()) doesn't use argument vectors, but a
-command line. The C runtime library's <function>spawn*</function>() family
-of functions (which <link
-linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
-eventually calls) paste the argument vector elements into a command line,
-and the C runtime startup code does a corresponding reconstruction of an
-argument vector from the command line, to be passed to
-<function>main</function>(). Complications arise when you have argument
-vector elements that contain spaces of double quotes. The
-<function>spawn*</function>() functions don't do any quoting or escaping,
-but on the other hand the startup code does do unquoting and unescaping in
-order to enable receiving arguments with embedded spaces or double
-quotes. To work around this asymmetry, the <link
-linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
-function will do quoting and escaping on argument vector elements that need
-it before calling the C runtime <function>spawn</function>()
-function.</para>
-
- <para><parameter>envp</parameter> is a sequence of strings, where each
- string has the form <literal>KEY=VALUE</literal>. This will become the
- child's environment. If <parameter>envp</parameter> is
- <parameter>None</parameter> or not specified, the child inherits its
- parent's environment.</para>
-
- <para><parameter>flags</parameter> should be the bitwise
-<literal>OR</literal> of the <xref linkend="gobject-spawn-flag-constants"
-endterm="gobject-spawn-flag-constants-title"></xref> you want to affect the
-function's behaviour. The <literal>gobject.SPAWN_DO_NOT_REAP_CHILD</literal>
-flag means that the child will not automatically be reaped; you must use a
-GChildWatch source to be notified about the death of the child
-process. Eventually you must call g_spawn_close_pid() on the child_pid, in
-order to free resources which may be associated with the child process. (On
-Unix, using a GChildWatch source is equivalent to calling
-<function>waitpid</function>() or handling the <literal>SIGCHLD</literal>
-signal manually. On Windows, calling g_spawn_close_pid() is equivalent to
-calling <function>CloseHandle</function>() on the process handle
-returned).</para>
-
- <para><literal>gobject.SPAWN_LEAVE_DESCRIPTORS_OPEN</literal> means
-that the parent's open file descriptors will be inherited by the child;
-otherwise all descriptors except stdin/stdout/stderr will be closed before
-calling <function>exec</function>() in the
-child. <literal>gobject.SPAWN_SEARCH_PATH</literal> means that
-<parameter>argv</parameter>[0] need not be an absolute path, it will be
-looked for in the user's
-<envar>PATH</envar>. <literal>gobject.SPAWN_STDOUT_TO_DEV_NULL</literal>
-means that the child's standard output will be discarded, instead of going
-to the same location as the parent's standard output. If you use this flag,
-<parameter>standard_output</parameter> must be
-<literal>None</literal>. <literal>gobject.SPAWN_STDERR_TO_DEV_NULL</literal>
-means that the child's standard error will be discarded, instead of going to
-the same location as the parent's standard error. If you use this flag,
-<parameter>standard_error</parameter> must be
-<literal>None</literal>. <literal>gobject.SPAWN_CHILD_INHERITS_STDIN</literal>
-means that the child will inherit the parent's standard input (by default,
-the child's standard input is attached to
-<filename>/dev/null</filename>). If you use this flag,
-<parameter>standard_input</parameter> must be
-<literal>None</literal>. <literal>gobject.SPAWN_FILE_AND_ARGV_ZERO</literal>
-means that the first element of <parameter>argv</parameter> is the file to
-execute, while the remaining elements are the actual argument vector to pass
-to the file. Normally the <link
-linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
-function uses <parameter>argv</parameter>[0] as the file to execute, and
-passes all of <parameter>argv</parameter> to the child.</para>
-
- <para><parameter>child_setup</parameter> and
-<parameter>user_data</parameter> are a function and user data. On POSIX
-platforms, the function is called in the child after GLib has performed all
-the setup it plans to perform (including creating pipes, closing file
-descriptors, etc.) but before calling <function>exec</function>(). That is,
-<parameter>child_setup</parameter> is called just before calling
-<function>exec</function>() in the child. Obviously actions taken in this
-function will only affect the child, not the parent. On Windows, there is no
-separate <function>fork</function>() and <function>exec</function>()
-functionality. Child processes are created and run right away with one API
-call,
-<function>CreateProcess</function>(). <parameter>child_setup</parameter> is
-called in the parent process just before creating the child process. You
-should carefully consider what you do in <parameter>child_setup</parameter>
-if you intend your software to be portable to Windows.</para>
-
- <para>The returned child process id can be used to send signals to the
-child, or to wait for the child if you specified the
-<literal>gobject.SPAWN_DO_NOT_REAP_CHILD</literal> flag. On Windows, child
-pid will be returned only if you specified the
-<literal>gobject.SPAWN_DO_NOT_REAP_CHILD</literal> flag.</para>
-
- <para>The caller of the <link
-linkend="function-gobject--spawn-async"><function>gobject.spawn_async</function>()</link>
-must close any returned file descriptors when they are no longer in
-use.</para>
-
- <para>If <parameter>standard_input</parameter> is
-<literal>None</literal>, the child's standard input is attached to
-<filename>/dev/null</filename> unless
-<literal>gobject.SPAWN_CHILD_INHERITS_STDIN</literal> is set.</para>
-
- <para>If <parameter>standard_error</parameter> is
-<literal>None</literal>, the child's standard error goes to the same
-location as the parent's standard error unless
-<literal>gobject.SPAWN_STDERR_TO_DEV_NULL</literal> is set.</para>
-
- <para>If <parameter>standard_output</parameter> is
-<literal>None</literal>, the child's standard output goes to the same
-location as the parent's standard output unless
-<literal>gobject.SPAWN_STDOUT_TO_DEV_NULL</literal> is set.</para>
-
- <para>If an error occurs, the gobject.GError exception will be
-raised.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--get-current-time">
- <title>gobject.get_current_time</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.get_current_time</methodname>
- </methodsynopsis></programlisting>
- <variablelist role="params">
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current time as the number of seconds and
-microseconds from the epoch.</simpara></listitem>
- </varlistentry>
- </variablelist>
- <note>
- <para>This function is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <function>gobject.get_current_time</function>() function
-reurns the current time of day as the number of seconds and microseconds
-from the epoch.</para>
-
- </refsect2>
-
- <refsect2 id="function-gobject--main-depth">
- <title>gobject.main_depth</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gobject.main_depth</methodname>
- </methodsynopsis></programlisting>
- <variablelist role="params">
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>he depth of the stack of calls to the main
-context.</simpara></listitem>
- </varlistentry>
- </variablelist>
- <note>
- <para>This function is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <function>main_depth</function>() function returns the depth
-of the stack of calls in the main context. That is, when called from the
-toplevel, it gives 0. When called from within a callback from the <link
-linkend="method-gobjectmaincontext--iteration"><methodname>gobject.MainContext.iteration</methodname>()</link>
-method (or the <link
-linkend="method-gobjectmainloop--run"><methodname>gobject.MainLoop.run</methodname>()</link>
-method, etc.) it returns 1. When called from within a callback to a
-recursive call to the <link
-linkend="method-gobjectmaincontext--iteration"><methodname>gobject.MainContext.iteration</methodname>()</link>
-method), it returns 2. And so forth.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gobject-gboxed.xml b/docs/reference/pygtk-gobject-gboxed.xml
deleted file mode 100644
index f7f24387..00000000
--- a/docs/reference/pygtk-gobject-gboxed.xml
+++ /dev/null
@@ -1,68 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gobjectgboxed">
- <refnamediv>
- <refname>gobject.GBoxed</refname>
- <refpurpose>an object containing an opaque chunk of data</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gobjectgboxed--copy">copy</link></methodname>
- </methodsynopsis>
-</classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobjectgboxed">gobject.GBoxed</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
-linkend="class-gobjectgboxed"><classname>gobject.GBoxed</classname></link>
-is an abstract base class that encapsulates an opaque chunk of data to
-provide an object-oriented interface and a type that is registered with the
-<literal>GLIB</literal> type system. A boxed type is registered with
-functions that provide for the copying and freeing of the underlying data
-structure - this allows PyGTK to encapsulate these as Python objects.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gobjectgboxed--copy">
- <title>gobject.GBoxed.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the <link
- linkend="class-gobjectgboxed"><classname>gobject.GBoxed</classname></link>
- object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method makes and returns a copy of the boxed object.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gobject-ginterface.xml b/docs/reference/pygtk-gobject-ginterface.xml
deleted file mode 100644
index 1b29ddf7..00000000
--- a/docs/reference/pygtk-gobject-ginterface.xml
+++ /dev/null
@@ -1,38 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gobjectginterface">
- <refnamediv>
- <refname>gobject.GInterface</refname>
-
- <refpurpose>an object representing a GInterface</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gobject.GInterface</classname></ooclass>
-</classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobjectginterface">gobject.GInterface</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
-linkend="class-gobjectginterface"><classname>gobject.GInterface</classname></link>
-is an abstract base class that encapsulates a GInterface.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gobject-gpointer.xml b/docs/reference/pygtk-gobject-gpointer.xml
deleted file mode 100644
index da169542..00000000
--- a/docs/reference/pygtk-gobject-gpointer.xml
+++ /dev/null
@@ -1,42 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gobjectgpointer">
- <refnamediv>
- <refname>gobject.GPointer</refname>
-
- <refpurpose>an object containing a completely opaque chunk of
- data</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gobject.GPointer</classname></ooclass>
-</classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobjectgpointer">gobject.GPointer</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
-linkend="class-gobjectgpointer"><classname>gobject.GPointer</classname></link>
-is an abstract base class that encapsulates an opaque chunk of data and
-registers it with the <literal>GLIB</literal> type system. A pointer type
-has no methods and generic ways of copying and freeing the data. It
-shouldn't be used in PyGTK.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gobject-maincontext.xml b/docs/reference/pygtk-gobject-maincontext.xml
deleted file mode 100644
index ef688780..00000000
--- a/docs/reference/pygtk-gobject-maincontext.xml
+++ /dev/null
@@ -1,152 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gobjectmaincontext">
- <refnamediv>
- <refname>gobject.MainContext</refname>
-
- <refpurpose>an object representing a set of event sources to be handled
-in a <link
-linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link>.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gobject.MainContext</classname></ooclass>
-<constructorsynopsis language="python">
- <methodname><link linkend="constructor-gobjectmaincontext">gobject.MainContext</link></methodname>
- </constructorsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gobjectmaincontext--iteration">iteration</link></methodname>
- <methodparam><parameter>may_block</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gobjectmaincontext--pending">pending</link></methodname>
- </methodsynopsis>
-</classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobjectmaincontext">gobject.MainContext</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>
-represents a set of event sources that can be run in a single thread. File
-descriptors (plain files, pipes or sockets) and timeouts are the standard
-event sources for <literal>GTK</literal> and <literal>PyGTK</literal> though
-others can be added. Each event source is assigned a priority. The default
-priority, <literal>gobject.PRIORITY_DEFAULT</literal>, is 0. Values less
-than 0 denote higher priorities. Values greater than 0 denote lower
-priorities. Events from high priority sources are always processed before
-events from lower priority sources. Single iterations of a <link
-linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>
-can be run with the <link
-linkend="method-gobjectmaincontext--iteration"><methodname>iteration</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gobjectmaincontext">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gobject.MainContext</methodname>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>
- object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gobjectmaincontext--iteration">
- <title>gobject.MainContext.iteration</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iteration</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>may_block</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the call may block
- waiting for an event.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if events were
- dispatched.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>iteration</methodname>() method runs a single
-iteration. This involves:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>checking to see if any associated event sources are ready
-to be processed;</simpara>
- </listitem>
- <listitem>
- <simpara>then if no events sources are ready and
-<parameter>may_block</parameter> is <literal>True</literal>, waiting for a
-source to become ready;</simpara>
- </listitem>
- <listitem>
- <simpara>and finally, dispatching the highest priority events
-sources that are ready</simpara>
- </listitem>
- </itemizedlist>
-
- <para>Note that even when <parameter>may_block</parameter> is
-<literal>True</literal>, it is still possible for
-<methodname>iteration</methodname>() to return <literal>False</literal>,
-since the the wait may be interrupted for other reasons than an event source
-becoming ready.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobjectmaincontext--pending">
- <title>gobject.MainContext.pending</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pending</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if events are
- pending.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>pending</methodname>() method checks if any
-associated sources have pending events.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gobject-mainloop.xml b/docs/reference/pygtk-gobject-mainloop.xml
deleted file mode 100644
index 41454038..00000000
--- a/docs/reference/pygtk-gobject-mainloop.xml
+++ /dev/null
@@ -1,202 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gobjectmainloop">
- <refnamediv>
- <refname>gobject.MainLoop</refname>
-
- <refpurpose>an object representing the main event loop of a PyGTK
- application.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gobject.MainLoop</classname></ooclass>
-<constructorsynopsis language="python">
- <methodname><link linkend="constructor-gobjectmainloop">gobject.MainLoop</link></methodname>
- <methodparam><parameter>context</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter>is_running</parameter><initializer>0</initializer></methodparam>
- </constructorsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gobjectmainloop--get-context">get_context</link></methodname>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gobjectmainloop--is-running">is_running</link></methodname>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gobjectmainloop--quit">quit</link></methodname>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gobjectmainloop--run">run</link></methodname>
- </methodsynopsis>
-</classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobjectmainloop">gobject.MainLoop</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
-linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link>
-represents a main event loop. A <link
-linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link>
-is created with the <link
-linkend="constructor-gobjectmainloop">gobject.MainLoop</link>()
-constructor. After adding the initial event sources, the <link
-linkend="method-gobjectmainloop--run"><methodname>run</methodname>()</link>
-method is called. This continuously checks for new events from each of the
-event sources and dispatches them. Finally, the processing of an event from
-one of the sources leads to a call to the <link
-linkend="method-gobjectmainloop--quit"><methodname>quit</methodname>()</link>
-method to exit the main loop, and the <link
-linkend="method-gobjectmainloop--run"><methodname>run</methodname>()</link>
-method returns.</para>
-
- <para>It is possible to create new instances of <link
-linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link>
-recursively. This is often used in <literal>PyGTK</literal> applications
-when showing modal dialog boxes. Note that event sources are associated with
-a particular <link
-linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>,
-and will be checked and dispatched for all main loops associated with that
-<link
-linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>.</para>
-
- <para><literal>PyGTK</literal> contains wrappers of some of these
-functions, e.g. the <link
-linkend="function-gtk--main"><function>gtk.main</function>()</link>, <link
-linkend="function-gtk--main-quit"><function>gtk.main_quit</function>()</link>
-and <link
-linkend="function-gtk--events-pending"><function>gtk.events_pending</function>()</link>
-functions.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gobjectmainloop">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gobject.MainLoop</methodname>
- <methodparam><parameter>context</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter>is_running</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>context</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>
- or <literal>None</literal> to use the default
- context.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>is_running</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> indicates that the
- loop is running. This is not very important since calling the <link
- linkend="method-gobjectmainloop--run"><methodname>run</methodname>()</link>
- method will set this to <literal>True</literal>
- anyway.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link>
- object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gobjectmainloop--get-context">
- <title>gobject.MainLoop.get_context</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_context</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>
- the mainloop is associated with</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_context</methodname>() method returns the
-<link
-linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>
-that the mainloop was created with.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobjectmainloop--is-running">
- <title>gobject.MainLoop.is_running</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_running</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the mainloop is
- currently being run.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_running</methodname>() method checks to see
-if the mainloop is currently being run via the <link
-linkend="method-gobjectmainloop--run"><methodname>run</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobjectmainloop--quit">
- <title>gobject.MainLoop.quit</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>quit</methodname>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>quit</methodname>() method stops the mainloop
-from running. Any subsequent calls to the <link
-linkend="method-gobjectmainloop--run"><methodname>run</methodname>()</link>
-method will return immediately.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobjectmainloop--run">
- <title>gobject.MainLoop.run</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>run</methodname>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>run</methodname>() method runs a mainloop until
-the <link
-linkend="method-gobjectmainloop--quit"><methodname>quit</methodname>()</link>
-method is called. If this is called for the thread of the loop's <link
-linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link>,
-it will process events from the loop, otherwise it will simply wait.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gobject.xml b/docs/reference/pygtk-gobject.xml
deleted file mode 100644
index 7364c06b..00000000
--- a/docs/reference/pygtk-gobject.xml
+++ /dev/null
@@ -1,867 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gobject">
- <refmeta>
- <refentrytitle>gobject.GObject</refentrytitle>
- <manvolnum>3</manvolnum>
- <refmiscinfo>PyGTK Docs</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>gobject.GObject</refname>
- <refpurpose>the base class</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gobject.GObject</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--get-property">get_property</link></methodname>
- <methodparam><parameter>property_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--set-property">set_property</link></methodname>
- <methodparam><parameter>property_name</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--freeze-notify">freeze_notify</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--notify">notify</link></methodname>
- <methodparam><parameter>property_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--thaw-notify">thaw_notify</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--get-data">get_data</link></methodname>
- <methodparam><parameter>key</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--set-data">set_data</link></methodname>
- <methodparam><parameter>key</parameter></methodparam>
- <methodparam><parameter>data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--connect">connect</link></methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- <methodparam><parameter>handler</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--connect-after">connect_after</link></methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- <methodparam><parameter>handler</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--connect-object">connect_object</link></methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- <methodparam><parameter>handler</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--connect-object-after">connect_object_after</link></methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- <methodparam><parameter>handler</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--disconnect">disconnect</link></methodname>
- <methodparam><parameter>handler_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--handler-disconnect">handler_disconnect</link></methodname>
- <methodparam><parameter>handler_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--handler-is-connected">handler_is_connected</link></methodname>
- <methodparam><parameter>handler_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--handler-block">handler_block</link></methodname>
- <methodparam><parameter>handler_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--handler-unblock">handler_unblock</link></methodname>
- <methodparam><parameter>handler_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--emit">emit</link></methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--stop-emission">stop_emission</link></methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--emit-stop-by-name">emit_stop_by_name</link></methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gobject--chain">chain</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"__doc__"</entry>
- <entry>Read</entry>
- <entry>The documentation for the object type. Uses
- "__gdoc__" if no specific documentation set.</entry>
- </row>
- <row valign="top">
- <entry>"__gdoc__"</entry>
- <entry>Read</entry>
- <entry>The generated documentation for the underlying GObject
- type.</entry>
- </row>
- <row valign="top">
- <entry>"__gtype__"</entry>
- <entry>Read</entry>
- <entry>The underlying GObject type.</entry>
- </row>
- <row valign="top">
- <entry>"__grefcount__"</entry>
- <entry>Read</entry>
- <entry>The reference count for the underlying GObject.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gobject">
- <title>gobject.GObject Signal Prototypes</title>
-
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gobject--notify">notify</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>gobject</parameter></methodparam>
- <methodparam><parameter>property_spec</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
- <para>The <link
- linkend="class-gobject"><classname>gobject.GObject</classname></link>
- class is the base class providing the common attributes and methods for
- the PyGTK classes. The <link
- linkend="class-gobject"><classname>gobject.GObject</classname></link>
- class is not a user interface widget class.</para>
-
- <para>The <link
- linkend="class-gobject"><classname>gobject.GObject</classname></link>
- class provides the signal management methods, the object property access
- methods and the object data management methods.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gobject--get-property">
- <title>gobject.GObject.get_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_property</methodname>
- <methodparam><parameter>property_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>property_name</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the property name for the
-GObject</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a Python object containing the value of the
-property</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_property</methodname>() method returns the
-value of the property specified by <parameter>property_name</parameter> or
-None if there is no value associated with the property.</para>
- <para>The <exceptionname>TypeError</exceptionname> exception is raised
-if the property name is not registered with the object class.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--set-property">
- <title>gobject.GObject.set_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_property</methodname>
- <methodparam><parameter>property_name</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>property_name</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the property
-name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter>&nbsp;:</term>
- <listitem><simpara>a Python object containing the property value
-to be set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_property</methodname>() method sets the
-property specified by <parameter>property_name</parameter> to the specified
-<parameter>value</parameter>.</para>
- <para>The <exceptionname>TypeError</exceptionname> exception is raised
-if the property name is not registered with the object class or if the value
-specified could not be converted to the property type.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--freeze-notify">
- <title>gobject.GObject.freeze_notify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>freeze_notify</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>freeze_notify</methodname>() method freezes the
-object's property-changed notification queue so that "notify" signals are
-blocked until the <methodname>thaw_notify</methodname>() method is
-called.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--notify">
- <title>gobject.GObject.notify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>notify</methodname>
- <methodparam><parameter>property_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>property_name</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing a property
-name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>notify</methodname>() method causes the "notify"
-signal for the property specified by <parameter>property_name</parameter> to
-be emitted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--thaw-notify">
- <title>gobject.GObject.thaw_notify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>thaw_notify</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>thaw_notify</methodname>() method thaws the
-object's property-changed notification queue so that "notify" signals are
-emitted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--get-data">
- <title>gobject.GObject.get_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_data</methodname>
- <methodparam><parameter>key</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter>&nbsp;:</term>
- <listitem><simpara>a string used as the key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a Python object containing the associated
-data</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_data</methodname>() method returns the
-Python object associated with the specified <parameter>key</parameter> or
-None if there is no data associated with the <parameter>key</parameter> or
-if there is no key associated with the object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--set-data">
- <title>gobject.GObject.set_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_data</methodname>
- <methodparam><parameter>key</parameter></methodparam>
- <methodparam><parameter>data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter>&nbsp;:</term>
- <listitem><simpara>a string used as a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter>&nbsp;:</term>
- <listitem><simpara>a Python object that is the value to be
-associated with the key</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_data</methodname>() method associates the
-specified Python object (<parameter>data</parameter>) with
-<parameter>key</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--connect">
- <title>gobject.GObject.connect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>connect</methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- <methodparam><parameter>handler</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>detailed_signal</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the signal
-name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>handler</parameter>&nbsp;:</term>
- <listitem><simpara>a Python function or method
-object.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional optional
-parameters</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>connect</methodname>() method adds a function or
-method (<parameter>handler</parameter>)to the end of the list of signal
-handlers for the named <parameter>detailed_signal</parameter> but before the
-default class signal handler. An optional set of parameters may be specified
-after the <parameter>handler</parameter> parameter. These will all be passed
-to the signal handler when invoked.</para>
- <para>For example if a function handler was connected to a signal
-using:</para>
- <programlisting>
- handler_id = object.connect("signal_name", handler, arg1, arg2, arg3)
-</programlisting>
- <para>The handler should be defined as:</para>
- <programlisting>
- def handler(object, arg1, arg2, arg3):
-</programlisting>
- <para>A method handler connected to a signal using:</para>
- <programlisting>
- handler_id = object.connect("signal_name", self.handler, arg1, arg2)
-</programlisting>
- <para>requires an additional argument when defined:</para>
- <programlisting>
- def handler(self, object, arg1, arg2)
-</programlisting>
- <para>A <exceptionname>TypeError</exceptionname> exception is raised
-if <parameter>detailed_signal</parameter> identifies a signal name that is
-not associated with the object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--connect-after">
- <title>gobject.GObject.connect_after</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>connect_after</methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- <methodparam><parameter>handler</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>detailed_signal</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the signal
-name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>handler</parameter>&nbsp;:</term>
- <listitem><simpara>a Python function or method
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional optional
-parameters</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer handler
-identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>connect_after</methodname>() method is similar
-to the <methodname>connect</methodname>() method except that the
-<parameter>handler</parameter> is added to the signal handler list after the
-default class signal handler. Otherwise the details of
-<parameter>handler</parameter> definition and invocation are the
-same.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--connect-object">
- <title>gobject.GObject.connect_object</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>connect_object</methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- <methodparam><parameter>handler</parameter></methodparam>
- <methodparam><parameter>gobject</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>detailed_signal</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the signal
-name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>handler</parameter>&nbsp;:</term>
- <listitem><simpara>a Python function or method
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>gobject</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer handler
-identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>connect_object</methodname>() method is the same
-as the <methodname>connect</methodname>() method except that the
-<parameter>handler</parameter> is invoked with the specified
-<parameter>gobject</parameter> in place of the object invoking the
-<methodname>connect_object</methodname>() method. For example, a call with a
-function handler:</para>
- <programlisting>
- handler_id = object("signal_name", handler, gobject)
-</programlisting>
- <para>will cause the <parameter>handler</parameter> to be invoked
-as:</para>
- <programlisting>
- handler(gobject)
-</programlisting>
- <para>Likewise a method handler will be invoked as:</para>
- <programlisting>
- self.handler(gobject)
-</programlisting>
- <para>This can be helpful in invoking PyGTK widget methods that
-require no arguments except the widget itself (e.g.
-<methodname>widget.destroy</methodname>()) by using the class method as the
-handler. For example, a Button "clicked" signal can be set up to invoke the
-Window <methodname>destroy</methodname>() method as:</para>
-
- <programlisting>
- handler_id = button.connect_object("clicked", Window.destroy, window)
-</programlisting>
-
- <para>When the button is clicked the handler is invoked as:</para>
-
- <programlisting>
- Window.destroy(window)
-</programlisting>
-
- <para>which is the same as:</para>
-
- <programlisting>
- window.destroy()
-</programlisting>
-
- <para>Additional arguments may be passed to the handler as with the
-<methodname>connect</methodname>() method handler invocations.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--connect-object-after">
- <title>gobject.GObject.connect_object_after</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>connect_object_after</methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- <methodparam><parameter>handler</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>detailed_signal</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the signal
-name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>handler</parameter>&nbsp;:</term>
- <listitem><simpara>a Python function or method
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>gobject</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer handler
-identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>connect_object_after</methodname>() method is
-similar to the <methodname>connect_object</methodname>() method except that
-the <parameter>handler</parameter> is added to the signal handler list after
-the default class signal handler. Otherwise the details of
-<parameter>handler</parameter> definition and invocation are the
-same.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--disconnect">
- <title>gobject.GObject.disconnect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>disconnect</methodname>
- <methodparam><parameter>handler_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>handler_id</parameter>&nbsp;:</term>
- <listitem><simpara>an integer handler
-identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>disconnect</methodname>() method removes the
-signal handler with the specified <parameter>handler_id</parameter> from the
-list of signal handlers for the object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--handler-disconnect">
- <title>gobject.GObject.handler_disconnect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>handler_disconnect</methodname>
- <methodparam><parameter>handler_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>handler_id</parameter>&nbsp;:</term>
- <listitem><simpara>an integer handler
-identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>handler_disconnect</methodname>() method removes
-the signal handler with the specified <parameter>handler_id</parameter> from
-the list of signal handlers for the object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--handler-is-connected">
- <title>gobject.GObject.handler_is_connected</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>handler_is_connected</methodname>
- <methodparam><parameter>handler_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>handler_id</parameter>&nbsp;:</term>
- <listitem><simpara>an integer handler
-identifier</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal handler
-is connected to the object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>handler_is_connected</methodname>() method
-returns <literal>True</literal> if the signal handler with the specified
-<parameter>handler_id</parameter> is connected to the object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--handler-block">
- <title>gobject.GObject.handler_block</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>handler_block</methodname>
- <methodparam><parameter>handler_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>handler_id</parameter>&nbsp;:</term>
- <listitem><simpara>an integer handler
-identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>handler_block</methodname>() method blocks the
-signal handler with the specified <parameter>handler_id</parameter> from
-being invoked until it is unblocked.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--handler-unblock">
- <title>gobject.GObject.handler_unblock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>handler_unblock</methodname>
- <methodparam><parameter>handler_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>handler_id</parameter>&nbsp;:</term>
- <listitem><simpara>an integer handler
-identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>handler_unblock</methodname>() method unblocks
-the signal handler with the specified <parameter>handler_id</parameter>
-thereby allowing it to be invoked when the associated signal is
-emitted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--emit">
- <title>gobject.GObject.emit</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>emit</methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>detailed_signal</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the signal
-name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional parameters</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a PyObject*</simpara></listitem>
- </varlistentry>
- </variablelist>
- <para>The <methodname>emit</methodname>() method causes the object to
-emit the signal specified by <parameter>detailed_signal</parameter>. The
-additional parameters must match the number and type of the required signal
-handler parameters. In most cases no additional parameters are needed. for
-example:</para>
- <programlisting>
- button.emit("clicked")
-</programlisting>
- <para>is all that is required to emit the "clicked" signal for a
-button. The most common case requiring additional parameters occurs when
-emitting an event signal; for example:</para>
- <programlisting>
- button.emit("button_press_event", event)
-</programlisting>
-
- </refsect2>
-
- <refsect2 id="method-gobject--stop-emission">
- <title>gobject.GObject.stop_emission</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>stop_emission</methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>detailed_signal</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the signal
-name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>stop_emission</methodname>() method stops the
-current emission of the signal specified by
-<parameter>detailed_signal</parameter>. Any signal handlers in the list
-still to be run will not be invoked.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--emit-stop-by-name">
- <title>gobject.GObject.emit_stop_by_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>emit_stop_by_name</methodname>
- <methodparam><parameter>detailed_signal</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>detailed_signal</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the signal
-name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>emit_stop_by_name</methodname>() method stops
-the current emission of the signal specified by
-<parameter>detailed_signal</parameter>. Any signal handlers in the list
-still to be run will not be invoked.</para>
-
- </refsect2>
-
- <refsect2 id="method-gobject--chain">
- <title>gobject.GObject.chain</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>chain</methodname>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional parameters</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a Python object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The chain() method does something.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gobject--notify">
- <title>The GObject "notify" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>gobject</parameter></methodparam>
- <methodparam><parameter>property_spec</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>gobject</parameter>&nbsp;:</term>
- <listitem><simpara>the gobject that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>property_spec</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gobjectgparamspec"><classname>gobject.GParamSpec</classname></link> of the property that was
-changed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "notify" signal is emitted on a gobject when one of its
-properties has been changed. Note that getting this signal doesn't guarantee
-that the value of the property has actually changed, it may also be emitted
-when the setter for the property is called to reinstate the previous
-value. For example to be notified of the change of the title of a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> you could
-connect to the "notify" signal similar to:</para>
-
- <programlisting>
- window.connect("notify::title", callback)
-</programlisting>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtk-classes.xml b/docs/reference/pygtk-gtk-classes.xml
deleted file mode 100644
index 354ebbaf..00000000
--- a/docs/reference/pygtk-gtk-classes.xml
+++ /dev/null
@@ -1,192 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<chapter id="gtk-class-reference" xmlns:xi="http://www.w3.org/2001/XInclude">
- <title>The gtk Class Reference</title>
-
-<!-- GTK CLASSES -->
-
- <xi:include href="pygtk-gtkaboutdialog.xml"/>
- <xi:include href="pygtk-gtkaccelgroup.xml"/>
- <xi:include href="pygtk-gtkaccellabel.xml"/>
- <xi:include href="pygtk-gtkaccelmap.xml"/>
- <xi:include href="pygtk-gtkaccessible.xml"/>
- <xi:include href="pygtk-gtkaction.xml"/>
- <xi:include href="pygtk-gtkactiongroup.xml"/>
- <xi:include href="pygtk-gtkadjustment.xml"/>
- <xi:include href="pygtk-gtkalignment.xml"/>
- <xi:include href="pygtk-gtkarrow.xml"/>
- <xi:include href="pygtk-gtkaspectframe.xml"/>
- <xi:include href="pygtk-gtkassistant.xml"/>
- <xi:include href="pygtk-gtkbin.xml"/>
- <xi:include href="pygtk-gtkborder.xml"/>
- <xi:include href="pygtk-gtkbox.xml"/>
- <xi:include href="pygtk-gtkbutton.xml"/>
- <xi:include href="pygtk-gtkbuttonbox.xml"/>
- <xi:include href="pygtk-gtkcalendar.xml"/>
- <xi:include href="pygtk-gtkcelleditable.xml"/>
- <xi:include href="pygtk-gtkcelllayout.xml"/>
- <xi:include href="pygtk-gtkcellrenderer.xml"/>
- <xi:include href="pygtk-gtkcellrendereraccel.xml"/>
- <xi:include href="pygtk-gtkcellrenderercombo.xml"/>
- <xi:include href="pygtk-gtkcellrendererpixbuf.xml"/>
- <xi:include href="pygtk-gtkcellrendererprogress.xml"/>
- <xi:include href="pygtk-gtkcellrendererspin.xml"/>
- <xi:include href="pygtk-gtkcellrenderertext.xml"/>
- <xi:include href="pygtk-gtkcellrenderertoggle.xml"/>
- <xi:include href="pygtk-gtkcellview.xml"/>
- <xi:include href="pygtk-gtkcheckbutton.xml"/>
- <xi:include href="pygtk-gtkcheckmenuitem.xml"/>
- <xi:include href="pygtk-gtkclipboard.xml"/>
- <xi:include href="pygtk-gtkcolorbutton.xml"/>
- <xi:include href="pygtk-gtkcolorselection.xml"/>
- <xi:include href="pygtk-gtkcolorselectiondialog.xml"/>
- <xi:include href="pygtk-gtkcombo.xml"/>
- <xi:include href="pygtk-gtkcombobox.xml"/>
- <xi:include href="pygtk-gtkcomboboxentry.xml"/>
- <xi:include href="pygtk-gtkcontainer.xml"/>
- <xi:include href="pygtk-gtkcurve.xml"/>
- <xi:include href="pygtk-gtkdialog.xml"/>
- <xi:include href="pygtk-gtkdrawingarea.xml"/>
- <xi:include href="pygtk-gtkeditable.xml"/>
- <xi:include href="pygtk-gtkentry.xml"/>
- <xi:include href="pygtk-gtkentrycompletion.xml"/>
- <xi:include href="pygtk-gtkeventbox.xml"/>
- <xi:include href="pygtk-gtkexpander.xml"/>
- <xi:include href="pygtk-gtkfilechooser.xml"/>
- <xi:include href="pygtk-gtkfilechooserbutton.xml"/>
- <xi:include href="pygtk-gtkfilechooserdialog.xml"/>
- <xi:include href="pygtk-gtkfilechooserwidget.xml"/>
- <xi:include href="pygtk-gtkfilefilter.xml"/>
- <xi:include href="pygtk-gtkfileselection.xml"/>
- <xi:include href="pygtk-gtkfixed.xml"/>
- <xi:include href="pygtk-gtkfontbutton.xml"/>
- <xi:include href="pygtk-gtkfontselection.xml"/>
- <xi:include href="pygtk-gtkfontselectiondialog.xml"/>
- <xi:include href="pygtk-gtkframe.xml"/>
- <xi:include href="pygtk-gtkgammacurve.xml"/>
- <xi:include href="pygtk-pygtkgenericcellrenderer.xml"/>
- <xi:include href="pygtk-pygtkgenerictreemodel.xml"/>
- <xi:include href="pygtk-gtkhandlebox.xml"/>
- <xi:include href="pygtk-gtkhbox.xml"/>
- <xi:include href="pygtk-gtkhbuttonbox.xml"/>
- <xi:include href="pygtk-gtkhpaned.xml"/>
- <xi:include href="pygtk-gtkhruler.xml"/>
- <xi:include href="pygtk-gtkhscale.xml"/>
- <xi:include href="pygtk-gtkhscrollbar.xml"/>
- <xi:include href="pygtk-gtkhseparator.xml"/>
- <xi:include href="pygtk-gtkiconfactory.xml"/>
- <xi:include href="pygtk-gtkiconinfo.xml"/>
- <xi:include href="pygtk-gtkiconset.xml"/>
- <xi:include href="pygtk-gtkiconsource.xml"/>
- <xi:include href="pygtk-gtkicontheme.xml"/>
- <xi:include href="pygtk-gtkiconview.xml"/>
- <xi:include href="pygtk-gtkimage.xml"/>
- <xi:include href="pygtk-gtkimagemenuitem.xml"/>
- <xi:include href="pygtk-gtkimcontext.xml"/>
- <xi:include href="pygtk-gtkimcontextsimple.xml"/>
- <xi:include href="pygtk-gtkimmulticontext.xml"/>
- <xi:include href="pygtk-gtkinputdialog.xml"/>
- <xi:include href="pygtk-gtkinvisible.xml"/>
- <xi:include href="pygtk-gtkitem.xml"/>
- <xi:include href="pygtk-gtkitemfactory.xml"/>
- <xi:include href="pygtk-gtklabel.xml"/>
- <xi:include href="pygtk-gtklayout.xml"/>
- <xi:include href="pygtk-gtklinkbutton.xml"/>
- <xi:include href="pygtk-gtkliststore.xml"/>
- <xi:include href="pygtk-gtkmenu.xml"/>
- <xi:include href="pygtk-gtkmenubar.xml"/>
- <xi:include href="pygtk-gtkmenuitem.xml"/>
- <xi:include href="pygtk-gtkmenushell.xml"/>
- <xi:include href="pygtk-gtkmenutoolbutton.xml"/>
- <xi:include href="pygtk-gtkmessagedialog.xml"/>
- <xi:include href="pygtk-gtkmisc.xml"/>
- <xi:include href="pygtk-gtknotebook.xml"/>
- <xi:include href="pygtk-gtkobject.xml"/>
- <xi:include href="pygtk-gtkoptionmenu.xml"/>
- <xi:include href="pygtk-gtkpagesetup.xml"/>
- <xi:include href="pygtk-gtkpaned.xml"/>
- <xi:include href="pygtk-gtkpapersize.xml"/>
- <xi:include href="pygtk-gtkplug.xml"/>
- <xi:include href="pygtk-gtkprintcontext.xml"/>
- <xi:include href="pygtk-gtkprintoperation.xml"/>
- <xi:include href="pygtk-gtkprintoperationpreview.xml"/>
- <xi:include href="pygtk-gtkprintsettings.xml"/>
- <xi:include href="pygtk-gtkprogressbar.xml"/>
- <xi:include href="pygtk-gtkradioaction.xml"/>
- <xi:include href="pygtk-gtkradiobutton.xml"/>
- <xi:include href="pygtk-gtkradiomenuitem.xml"/>
- <xi:include href="pygtk-gtkradiotoolbutton.xml"/>
- <xi:include href="pygtk-gtkrange.xml"/>
- <xi:include href="pygtk-gtkrcstyle.xml"/>
- <xi:include href="pygtk-gtkrecentchooserdialog.xml"/>
- <xi:include href="pygtk-gtkrecentchoosermenu.xml"/>
- <xi:include href="pygtk-gtkrecentchooserwidget.xml"/>
- <xi:include href="pygtk-gtkrecentchooser.xml"/>
- <xi:include href="pygtk-gtkrecentfilter.xml"/>
- <xi:include href="pygtk-gtkrecentinfo.xml"/>
- <xi:include href="pygtk-gtkrecentmanager.xml"/>
- <xi:include href="pygtk-gtkrequisition.xml"/>
- <xi:include href="pygtk-gtkruler.xml"/>
- <xi:include href="pygtk-gtkscale.xml"/>
- <xi:include href="pygtk-gtkscrollbar.xml"/>
- <xi:include href="pygtk-gtkscrolledwindow.xml"/>
- <xi:include href="pygtk-gtkselectiondata.xml"/>
- <xi:include href="pygtk-gtkseparator.xml"/>
- <xi:include href="pygtk-gtkseparatormenuitem.xml"/>
- <xi:include href="pygtk-gtkseparatortoolitem.xml"/>
- <xi:include href="pygtk-gtksettings.xml"/>
- <xi:include href="pygtk-gtksizegroup.xml"/>
- <xi:include href="pygtk-gtksocket.xml"/>
- <xi:include href="pygtk-gtkspinbutton.xml"/>
- <xi:include href="pygtk-gtkstatusbar.xml"/>
- <xi:include href="pygtk-gtkstatusicon.xml"/>
- <xi:include href="pygtk-gtkstyle.xml"/>
- <xi:include href="pygtk-gtktable.xml"/>
- <xi:include href="pygtk-gtktearoffmenuitem.xml"/>
- <xi:include href="pygtk-gtktextattributes.xml"/>
- <xi:include href="pygtk-gtktextbuffer.xml"/>
- <xi:include href="pygtk-gtktextchildanchor.xml"/>
- <xi:include href="pygtk-gtktextiter.xml"/>
- <xi:include href="pygtk-gtktextmark.xml"/>
- <xi:include href="pygtk-gtktexttag.xml"/>
- <xi:include href="pygtk-gtktexttagtable.xml"/>
- <xi:include href="pygtk-gtktextview.xml"/>
- <xi:include href="pygtk-gtktoggleaction.xml"/>
- <xi:include href="pygtk-gtktogglebutton.xml"/>
- <xi:include href="pygtk-gtktoggletoolbutton.xml"/>
- <xi:include href="pygtk-gtktoolbar.xml"/>
- <xi:include href="pygtk-gtktoolbutton.xml"/>
- <xi:include href="pygtk-gtktoolitem.xml"/>
- <xi:include href="pygtk-gtktooltips.xml"/>
- <xi:include href="pygtk-gtktreedragdest.xml"/>
- <xi:include href="pygtk-gtktreedragsource.xml"/>
- <xi:include href="pygtk-gtktreeiter.xml"/>
- <xi:include href="pygtk-gtktreemodel.xml"/>
- <xi:include href="pygtk-gtktreemodelfilter.xml"/>
- <xi:include href="pygtk-gtktreemodelsort.xml"/>
- <xi:include href="pygtk-pygtktreemodelrow.xml"/>
- <xi:include href="pygtk-pygtktreemodelrowiter.xml"/>
- <xi:include href="pygtk-gtktreerowreference.xml"/>
- <xi:include href="pygtk-gtktreeselection.xml"/>
- <xi:include href="pygtk-gtktreesortable.xml"/>
- <xi:include href="pygtk-gtktreestore.xml"/>
- <xi:include href="pygtk-gtktreeview.xml"/>
- <xi:include href="pygtk-gtktreeviewcolumn.xml"/>
- <xi:include href="pygtk-gtkuimanager.xml"/>
- <xi:include href="pygtk-gtkvbox.xml"/>
- <xi:include href="pygtk-gtkvbuttonbox.xml"/>
- <xi:include href="pygtk-gtkvpaned.xml"/>
- <xi:include href="pygtk-gtkvruler.xml"/>
- <xi:include href="pygtk-gtkvscale.xml"/>
- <xi:include href="pygtk-gtkvscrollbar.xml"/>
- <xi:include href="pygtk-gtkvseparator.xml"/>
- <xi:include href="pygtk-gtkviewport.xml"/>
- <xi:include href="pygtk-gtkwidget.xml"/>
- <xi:include href="pygtk-gtkwindow.xml"/>
- <xi:include href="pygtk-gtkwindowgroup.xml"/>
- <xi:include href="pygtk-gtk-functions.xml"/>
- <xi:include href="pygtk-gtk-stock-items.xml"/>
- <xi:include href="pygtk-gtk-constants.xml"/>
-
-</chapter>
diff --git a/docs/reference/pygtk-gtk-constants.xml b/docs/reference/pygtk-gtk-constants.xml
deleted file mode 100644
index 3db49cd2..00000000
--- a/docs/reference/pygtk-gtk-constants.xml
+++ /dev/null
@@ -1,4188 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="gtk-constants">
- <refnamediv>
- <refname>gtk Constants</refname>
- <refpurpose>the built-in constants of the gtk module</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <programlisting>
-<xref linkend="gtk-accel-flags-constants" endterm="gtk-accel-flags-constants-title"></xref>
-<xref linkend="gtk-anchor-type-constants" endterm="gtk-anchor-type-constants-title"></xref>
-<xref linkend="gtk-arrow-type-constants" endterm="gtk-arrow-type-constants-title"></xref>
-<xref linkend="gtk-assistant-page-type-constants" endterm="gtk-assistant-page-type-constants-title"></xref>
-<xref linkend="gtk-attach-options-constants" endterm="gtk-attach-options-constants-title"></xref>
-<xref linkend="gtk-buttonbox-style-constants" endterm="gtk-buttonbox-style-constants-title"></xref>
-<xref linkend="gtk-buttons-type-constants" endterm="gtk-buttons-type-constants-title"></xref>
-<xref linkend="gtk-calendar-display-options-constants" endterm="gtk-calendar-display-options-constants-title"></xref>
-<xref linkend="gtk-cellrenderer-mode-constants" endterm="gtk-cellrenderer-mode-constants-title"></xref>
-<xref linkend="gtk-cellrenderer-state-constants" endterm="gtk-cellrenderer-state-constants-title"></xref>
-<xref linkend="gtk-cellrendereraccel-mode-constants" endterm="gtk-cellrendereraccel-mode-constants-title"></xref>
-<xref linkend="gtk-corner-type-constants" endterm="gtk-corner-type-constants-title"></xref>
-<xref linkend="gtk-curve-type-constants" endterm="gtk-curve-type-constants-title"></xref>
-<xref linkend="gtk-debug-flag-constants" endterm="gtk-debug-flag-constants-title"></xref>
-<xref linkend="gtk-delete-type-constants" endterm="gtk-delete-type-constants-title"></xref>
-<xref linkend="gtk-dest-defaults-constants" endterm="gtk-dest-defaults-constants-title"></xref>
-<xref linkend="gtk-dialog-flag-constants" endterm="gtk-dialog-flag-constants-title"></xref>
-<xref linkend="gtk-direction-type-constants" endterm="gtk-direction-type-constants-title"></xref>
-<xref linkend="gtk-expander-style-constants" endterm="gtk-expander-style-constants-title"></xref>
-<xref linkend="gtk-filechooser-action-constants" endterm="gtk-filechooser-action-constants-title"></xref>
-<xref linkend="gtk-filechooser-confirmation-constants" endterm="gtk-filechooser-confirmation-constants-title"></xref>
-<xref linkend="gtk-filechooser-error-constants" endterm="gtk-filechooser-error-constants-title"></xref>
-<xref linkend="gtk-filefilter-flags-constants" endterm="gtk-filefilter-flags-constants-title"></xref>
-<xref linkend="gtk-icon-lookup-flags-constants" endterm="gtk-icon-lookup-flags-constants-title"></xref>
-<xref linkend="gtk-icon-size-constants" endterm="gtk-icon-size-constants-title"></xref>
-<xref linkend="gtk-icontheme-error-constants" endterm="gtk-icontheme-error-constants-title"></xref>
-<xref linkend="gtk-iconview-drop-position-constants" endterm="gtk-iconview-drop-position-constants-title"></xref>
-<xref linkend="gtk-im-preedit-style-constants" endterm="gtk-im-preedit-style-constants-title"></xref>
-<xref linkend="gtk-im-status-style-constants" endterm="gtk-im-status-style-constants-title"></xref>
-<xref linkend="gtk-image-type-constants" endterm="gtk-image-type-constants-title"></xref>
-<xref linkend="gtk-justification-constants" endterm="gtk-justification-constants-title"></xref>
-<xref linkend="gtk-menu-direction-type-constants" endterm="gtk-menu-direction-type-constants-title"></xref>
-<xref linkend="gtk-message-type-constants" endterm="gtk-message-type-constants-title"></xref>
-<xref linkend="gtk-metric-type-constants" endterm="gtk-metric-type-constants-title"></xref>
-<xref linkend="gtk-movement-step-constants" endterm="gtk-movement-step-constants-title"></xref>
-<xref linkend="gtk-notebook-tab-constants" endterm="gtk-notebook-tab-constants-title"></xref>
-<xref linkend="gtk-object-flags-constants" endterm="gtk-object-flags-constants-title"></xref>
-<xref linkend="gtk-orientation-constants" endterm="gtk-orientation-constants-title"></xref>
-<xref linkend="gtk-pack-direction-constants" endterm="gtk-pack-direction-constants-title"></xref>
-<xref linkend="gtk-pack-type-constants" endterm="gtk-pack-type-constants-title"></xref>
-<xref linkend="gtk-page-orientation-constants" endterm="gtk-page-orientation-constants-title"></xref>
-<xref linkend="gtk-page-set-constants" endterm="gtk-page-set-constants-title"></xref>
-<xref linkend="gtk-paper-name-constants" endterm="gtk-paper-name-constants-title"></xref>
-<xref linkend="gtk-path-priority-type-constants" endterm="gtk-path-priority-type-constants-title"></xref>
-<xref linkend="gtk-path-type-constants" endterm="gtk-path-type-constants-title"></xref>
-<xref linkend="gtk-policy-type-constants" endterm="gtk-policy-type-constants-title"></xref>
-<xref linkend="gtk-position-type-constants" endterm="gtk-position-type-constants-title"></xref>
-<xref linkend="gtk-print-duplex-constants" endterm="gtk-print-duplex-constants-title"></xref>
-<xref linkend="gtk-print-error-constants" endterm="gtk-print-error-constants-title"></xref>
-<xref linkend="gtk-print-pages-constants" endterm="gtk-print-pages-constants-title"></xref>
-<xref linkend="gtk-print-operation-action-constants" endterm="gtk-print-operation-action-constants-title"></xref>
-<xref linkend="gtk-print-operation-result-constants" endterm="gtk-print-operation-result-constants-title"></xref>
-<xref linkend="gtk-print-quality-constants" endterm="gtk-print-quality-constants-title"></xref>
-<xref linkend="gtk-print-status-constants" endterm="gtk-print-status-constants-title"></xref>
-<xref linkend="gtk-progressbar-orientation-constants" endterm="gtk-progressbar-orientation-constants-title"></xref>
-<xref linkend="gtk-progressbar-style-constants" endterm="gtk-progressbar-style-constants-title"></xref>
-<xref linkend="gtk-rc-flags-constants" endterm="gtk-rc-flags-constants-title"></xref>
-<xref linkend="gtk-rc-token-type-constants" endterm="gtk-rc-token-type-constants-title"></xref>
-<xref linkend="gtk-recent-chooser-error-constants" endterm="gtk-recent-chooser-error-constants-title"></xref>
-<xref linkend="gtk-recent-filter-flags-constants" endterm="gtk-recent-filter-flags-constants-title"></xref>
-<xref linkend="gtk-recent-sort-type-constants" endterm="gtk-recent-sort-type-constants-title"></xref>
-<xref linkend="gtk-relief-style-constants" endterm="gtk-relief-style-constants-title"></xref>
-<xref linkend="gtk-resize-mode-constants" endterm="gtk-resize-mode-constants-title"></xref>
-<xref linkend="gtk-response-type-constants" endterm="gtk-response-type-constants-title"></xref>
-<xref linkend="gtk-scroll-step-constants" endterm="gtk-scroll-step-constants-title"></xref>
-<xref linkend="gtk-scroll-type-constants" endterm="gtk-scroll-type-constants-title"></xref>
-<xref linkend="gtk-selection-mode-constants" endterm="gtk-selection-mode-constants-title"></xref>
-<xref linkend="gtk-shadow-type-constants" endterm="gtk-shadow-type-constants-title"></xref>
-<xref linkend="gtk-sizegroup-mode-constants" endterm="gtk-sizegroup-mode-constants-title"></xref>
-<xref linkend="gtk-sort-type" endterm="gtk-sort-type-title"></xref>
-<xref linkend="gtk-spinbutton-update-policy-constants" endterm="gtk-spinbutton-update-policy-constants-title"></xref>
-<xref linkend="gtk-spin-type-constants" endterm="gtk-spin-type-constants-title"></xref>
-<xref linkend="gtk-state-type-constants" endterm="gtk-state-type-constants-title"></xref>
-<xref linkend="gtk-target-flags-constants" endterm="gtk-target-flags-constants-title"></xref>
-<xref linkend="gtk-text-direction-constants" endterm="gtk-text-direction-constants-title"></xref>
-<xref linkend="gtk-text-search-flags-constants" endterm="gtk-text-search-flags-constants-title"></xref>
-<xref linkend="gtk-text-window-type-constants" endterm="gtk-text-window-type-constants-title"></xref>
-<xref linkend="gtk-textbuffer-target-info-constants" endterm="gtk-textbuffer-target-info-constants-title"></xref>
-<xref linkend="gtk-toolbar-space-style-constants" endterm="gtk-toolbar-space-style-constants-title"></xref>
-<xref linkend="gtk-toolbar-style-constants" endterm="gtk-toolbar-style-constants-title"></xref>
-<xref linkend="gtk-treemodel-flags-constants" endterm="gtk-treemodel-flags-constants-title"></xref>
-<xref linkend="gtk-treeview-drop-position-constants" endterm="gtk-treeview-drop-position-constants-title"></xref>
-<xref linkend="gtk-treeview-grid-lines-constants" endterm="gtk-treeview-grid-lines-constants-title"></xref>
-<xref linkend="gtk-treeviewcolumn-sizing-constants" endterm="gtk-treeviewcolumn-sizing-constants-title"></xref>
-<xref linkend="gtk-uimanager-item-type-constants" endterm="gtk-uimanager-item-type-constants-title"></xref>
-<xref linkend="gtk-unit-constants" endterm="gtk-unit-constants-title"></xref>
-<xref linkend="gtk-update-type-constants" endterm="gtk-update-type-constants-title"></xref>
-<xref linkend="gtk-version-constants" endterm="gtk-version-constants-title"></xref>
-<xref linkend="gtk-widget-flags-constants" endterm="gtk-widget-flags-constants-title"></xref>
-<xref linkend="gtk-widget-help-type-constants" endterm="gtk-widget-help-type-constants-title"></xref>
-<xref linkend="gtk-window-position-constants" endterm="gtk-window-position-constants-title"></xref>
-<xref linkend="gtk-window-type-constants" endterm="gtk-window-type-constants-title"></xref>
-<xref linkend="gtk-wrap-mode-constants" endterm="gtk-wrap-mode-constants-title"></xref>
-</programlisting>
-
- </refsect1>
-
- <refsect1 id="gtk-constants-description">
- <title>Description</title>
-
- <refsect2 id="gtk-accel-flags-constants">
- <title id="gtk-accel-flags-constants-title">GTK Accel Flags Constants</title>
-
- <para>The Accel Flags constants are a set of bit-flags that specify
-characteristics of the accelerator.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.ACCEL_VISIBLE</literal></term>
- <listitem>
- <simpara>if set, the accelerator is visible in a label</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ACCEL_LOCKED</literal></term>
- <listitem>
- <simpara>If set the accelerator cannot be changed by the
- user.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ACCEL_MASK</literal></term>
- <listitem>
- <simpara>A mask for the Accel Flags</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-anchor-type-constants">
- <title id="gtk-anchor-type-constants-title">GTK Anchor Type Constants</title>
-
- <para>The Anchor Type constants specify the anchor point of a
- widget.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.ANCHOR_CENTER</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_NORTH</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_NORTH_WEST</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_NORTH_EAST</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_SOUTH</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_SOUTH_WEST</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_SOUTH_EAST</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_WEST</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_EAST,</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_N</literal></term>
- <listitem>
- <simpara>Same as <literal>gtk.ANCHOR_NORTH</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_NW</literal></term>
- <listitem>
- <simpara>Same as <literal>gtk.ANCHOR_NORTH_WEST</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_NE</literal></term>
- <listitem>
- <simpara>Same as <literal>gtk.ANCHOR_NORTH_EAST</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_S</literal></term>
- <listitem>
- <simpara>Same as <literal>gtk.ANCHOR_SOUTH</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_SW</literal></term>
- <listitem>
- <simpara>Same as <literal>gtk.ANCHOR_SOUTH_WEST</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_SE</literal></term>
- <listitem>
- <simpara>Same as <literal>gtk.ANCHOR_SOUTH_EAST</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_W</literal></term>
- <listitem>
- <simpara>Same as <literal>gtk.ANCHOR_WEST</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ANCHOR_E</literal></term>
- <listitem>
- <simpara>Same as <literal>gtk.ANCHOR_EAST</literal></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-arrow-type-constants">
- <title id="gtk-arrow-type-constants-title">GTK Arrow Type Constants</title>
-
- <para>The Arrow Type constants specify the direction a <link
-linkend="class-gtkarrow"><classname>gtk.Arrow</classname></link> should
-point.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.ARROW_UP</literal></term>
- <listitem>
- <simpara>Represents an upward pointing arrow.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ARROW_DOWN</literal></term>
- <listitem>
- <simpara>Represents a downward pointing arrow.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ARROW_LEFT</literal></term>
- <listitem>
- <simpara>Represents a left pointing arrow.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ARROW_RIGHT</literal></term>
- <listitem>
- <simpara>Represents a right pointing arrow.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-assistant-page-type-constants">
- <title id="gtk-assistant-page-type-constants-title">GTK Assistant Page Type Constants</title>
-
- <para>The Assistant Page Type constants are used to determine the page
- role inside the <link
- linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>. It's
- used to handle buttons sensitivity and visibility.</para>
-
- <note>
- <para>An assistant needs to end its page flow with a page of type
- <literal>gtk.ASSISTANT_PAGE_CONFIRM</literal> or
- <literal>gtk.ASSISTANT_PAGE_SUMMARY</literal> to be correct.</para>
- </note>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.ASSISTANT_PAGE_CONTENT</literal></term>
- <listitem>
- <simpara>The page has regular contents.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ASSISTANT_PAGE_INTRO</literal></term>
- <listitem>
- <simpara>The page contains an introduction to the assistant
- task.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ASSISTANT_PAGE_CONFIRM</literal></term>
- <listitem>
- <simpara>The page lets the user confirm or deny the
- changes.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ASSISTANT_PAGE_SUMMARY</literal></term>
- <listitem>
- <simpara>The page informs the user of the changes done.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ASSISTANT_PAGE_PROGRESS</literal></term>
- <listitem>
- <simpara>Used for tasks that take a long time to complete,
- blocks the assistant until the page is marked as
- complete.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-attach-options-constants">
- <title id="gtk-attach-options-constants-title">GTK Attach Flag Options Constants</title>
-
- <para>The Attach Flag Options constants are a set of bit-flags that
-specify the expansion properties that a widget will have when it (or its
-parent) is resized.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.EXPAND</literal></term>
- <listitem>
- <simpara>The widget should expand to take up any extra space in
-its container that has been allocated.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SHRINK</literal></term>
- <listitem>
- <simpara>The widget should shrink as and when
-possible.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILL</literal></term>
- <listitem>
- <simpara>The widget should fill the space allocated to
-it.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-buttonbox-style-constants">
- <title id="gtk-buttonbox-style-constants-title">GTK ButtonBox Style Constants</title>
-
- <para>The ButtonBox Style constants specify the style that a <link
-linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link>
-uses to layout the buttons it contains. (See also: <link
-linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
-and <link
-linkend="class-gtkhbuttonbox"><classname>gtk.HButtonBox</classname></link>).</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.BUTTONBOX_DEFAULT_STYLE</literal></term>
- <listitem>
- <simpara>Default packing.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.BUTTONBOX_SPREAD</literal></term>
- <listitem>
- <simpara>Buttons are evenly spread across the ButtonBox.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.BUTTONBOX_EDGE</literal></term>
- <listitem>
- <simpara>Buttons are placed at the edges of the
- ButtonBox.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.BUTTONBOX_START</literal></term>
- <listitem>
- <simpara>Buttons are grouped toward the start of box, (on the
- left for a HBox, or the top for a VBox).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.BUTTONBOX_END</literal></term>
- <listitem>
- <simpara>Buttons are grouped toward the end of a box, (on the
- right for a HBox, or the bottom for a VBox).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-buttons-type-constants">
- <title id="gtk-buttons-type-constants-title">GTK Buttons Type Constants</title>
-
- <para>The Buttons Type constants specify the pre-defined sets of
-buttons for the dialog. If none of these choices are appropriate, simply use
-<literal>gtk.BUTTONS_NONE</literal> then call the <link
-linkend="method-gtkdialog--add-buttons"><methodname>add_buttons</methodname>()</link>
-method.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.BUTTONS_NONE</literal></term>
- <listitem>
- <simpara>no buttons at all</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.BUTTONS_OK</literal></term>
- <listitem>
- <simpara>an OK button</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.BUTTONS_CLOSE</literal></term>
- <listitem>
- <simpara>a Close button</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.BUTTONS_CANCEL</literal></term>
- <listitem>
- <simpara>a Cancel button</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.BUTTONS_YES_NO</literal></term>
- <listitem>
- <simpara>Yes and No buttons</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.BUTTONS_OK_CANCEL</literal></term>
- <listitem>
- <simpara>OK and Cancel buttons</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-calendar-display-options-constants">
- <title id="gtk-calendar-display-options-constants-title">GTK Calendar Display Options Constants</title>
-
- <para>The Calendar Display Options constants are a set of bit-flags
-that specify the display and behavior of a <link
-linkend="class-gtkcalendar"><classname>gtk.Calendar</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_HEADING</literal></term>
- <listitem>
- <simpara>Specifies that the month and year should be
- displayed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_DAY_NAMES</literal></term>
- <listitem>
- <simpara>Specifies that three letter day descriptions should be
- present.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_NO_MONTH_CHANGE</literal></term>
- <listitem>
- <simpara>Prevents the user from switching months with the
- calendar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_WEEK_NUMBERS</literal></term>
- <listitem>
- <simpara>Displays each week numbers of the current year, down
- the left side of the calendar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_WEEK_START_MONDAY</literal></term>
- <listitem>
- <simpara>Since GTK+ 2.4, this option is deprecated and ignored
- by GTK+. The information on which day the calendar week starts
- is derived from the locale.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-cellrenderer-mode-constants">
- <title id="gtk-cellrenderer-mode-constants-title">GTK CellRenderer Mode Constants</title>
-
- <para>The CellRenderer Mode constants specify how the user can
-interact with a particular cell.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.CELL_RENDERER_MODE_INERT</literal></term>
- <listitem>
- <simpara>The cell is just for display and cannot be interacted
-with. Note that this doesn't mean that e.g. the row being drawn can't be
-selected -- just that a particular element of it cannot be individually
-modified.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CELL_RENDERER_MODE_ACTIVATABLE</literal></term>
- <listitem>
- <simpara>The cell can be clicked.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CELL_RENDERER_MODE_EDITABLE</literal></term>
- <listitem>
- <simpara>The cell can be edited or otherwise modified.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-cellrenderer-state-constants">
- <title id="gtk-cellrenderer-state-constants-title">GTK CellRenderer State Constants</title>
-
- <para>The CellRenderer State constants specify how a cell is to be
-rendered.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.CELL_RENDERER_SELECTED</literal></term>
- <listitem>
- <simpara>The cell is currently selected, and probably has a
- selection colored background to render to.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CELL_RENDERER_PRELIT</literal></term>
- <listitem>
- <simpara>The mouse is hovering over the cell.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CELL_RENDERER_INSENSITIVE</literal></term>
- <listitem>
- <simpara>The cell is drawn in an insensitive manner</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CELL_RENDERER_SORTED</literal></term>
- <listitem>
- <simpara>The cell is in a sorted row</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CELL_RENDERER_FOCUSED</literal></term>
- <listitem>
- <simpara>The cell has the focus.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-cellrendereraccel-mode-constants">
- <title id="gtk-cellrendereraccel-mode-constants-title">GTK CellRendererAccel Mode Constants</title>
-
- <para>The CellRendererAccel Mode constants specify if the edited
- accelerators are GTK+ accelerators. If they are, consumed modifiers
- are suppressed, only accelerators accepted by GTK+ are allowed, and
- the accelerators are rendered in the same way as they are in
- menus.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.CELL_RENDERER_ACCEL_MODE_GTK</literal></term>
- <listitem>
- <simpara>Only accelerators accepted by GTK+ are allowed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CELL_RENDERER_ACCEL_MODE_OTHER</literal></term>
- <listitem>
- <simpara>Any accelerators are allowed.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-corner-type-constants">
- <title id="gtk-corner-type-constants-title">GTK Corner Type Constants</title>
-
- <para>The Corner Type constants specify the corner a child widget
-should be placed in when packed into a <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>. This
-is effectively the opposite of where the scroll bars are placed.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.CORNER_TOP_LEFT</literal></term>
- <listitem>
- <simpara>Place the scrollbars on the right and bottom of the
-widget (default behavior).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CORNER_BOTTOM_LEFT</literal></term>
- <listitem>
- <simpara>Place the scrollbars on the top and right of the
-widget.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CORNER_TOP_RIGHT</literal></term>
- <listitem>
- <simpara>Place the scrollbars on the left and bottom of the
-widget.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CORNER_BOTTOM_RIGHT</literal></term>
- <listitem>
- <simpara>Place the scrollbars on the top and left of the
-widget.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-curve-type-constants">
- <title id="gtk-curve-type-constants-title">GTK Curve Type Constants</title>
-
- <para>The Curve Type constants specify the type of curve to use for a
-<link
-linkend="class-gtkcurve"><classname>gtk.Curve</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.CURVE_TYPE_LINEAR</literal></term>
- <listitem>
- <simpara>Linear interpolation</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CURVE_TYPE_SPLINE</literal></term>
- <listitem>
- <simpara>Spline interpolation</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CURVE_TYPE_FREE</literal></term>
- <listitem>
- <simpara>Free form curve</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-debug-flag-constants">
- <title id="gtk-debug-flag-constants-title">GTK Debug Flag Constants</title>
-
- <para>The Debug Flag constants are a set of bit-flags that specify the
-debug options.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.DEBUG_MISC</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DEBUG_PLUGSOCKET</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DEBUG_TEXT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DEBUG_TREE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DEBUG_UPDATES</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DEBUG_KEYBINDINGS</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DEBUG_MULTIHEAD</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-delete-type-constants">
- <title id="gtk-delete-type-constants-title">GTK Delete Type Constants</title>
-
- <para>The Delete Type constants specify the deletion type.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.DELETE_CHARS</literal></term>
- <listitem>
- <simpara>Delete a character at the cursor</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DELETE_WORD_ENDS</literal></term>
- <listitem>
- <simpara>Delete from the cursor to the end of a word</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DELETE_WORDS</literal></term>
- <listitem>
- <simpara>Delete a number of words</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DELETE_DISPLAY_LINES</literal></term>
- <listitem>
- <simpara>Delete a single line at the cursor</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DELETE_DISPLAY_LINE_ENDS,</literal></term>
- <listitem>
- <simpara>Delete from the cursor to the end of the line.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DELETE_PARAGRAPH_ENDS</literal></term>
- <listitem>
- <simpara>Delete from the cursor to a paragraph end (usually to
- the period)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DELETE_PARAGRAPHS</literal></term>
- <listitem>
- <simpara>Delete several complete paragraphs at the cursor </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DELETE_WHITESPACE</literal></term>
- <listitem>
- <simpara>Delete the whitespace at the cursor.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-dest-defaults-constants">
- <title id="gtk-dest-defaults-constants-title">GTK Dest Defaults Constants</title>
-
- <para>The Dest Defaults constants are a set of bit-flags that specify
-the various types of action that will be taken on behalf of the user for a
-drag destination site.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.DEST_DEFAULT_MOTION</literal></term>
- <listitem>
- <simpara>If set for a widget, during a drag over this widget
-will check if the drag matches this widget's list of possible targets and
-actions. The <link
-linkend="method-gdkdragcontext--drag-status"><methodname>gtk.gdk.DragContext.drag_status</methodname>()</link>
-method will be called as appropriate.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DEST_DEFAULT_HIGHLIGHT</literal></term>
- <listitem>
- <simpara> If set for a widget, draw a highlight on this widget
-as long as a drag is over this widget and the widget drag format and action
-are acceptable.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DEST_DEFAULT_DROP</literal></term>
- <listitem>
- <simpara>If set for a widget, when a drop occurs, check if the
-drag matches this widget's list of possible targets and actions. If so, call
-the <link
-linkend="method-gtkwidget--drag-get-data"><methodname>gtk.Widget.drag_get_data</methodname>()</link>
-method on behalf of the widget. Whether or not the drop is successful, call
-the <link
-linkend="method-gdkdragcontext--finish"><methodname>gtk.gdk.DragContext.finish</methodname>()</link>
-method. If the action was a move, then if the drag was successful, then
-<literal>True</literal> will be passed for the delete parameter to the <link
-linkend="method-gdkdragcontext--finish"><methodname>gtk.gdk.DragContext.finish</methodname>()</link>
-method.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DEST_DEFAULT_ALL</literal></term>
- <listitem>
- <simpara>If set, specifies that all default actions should be
-taken.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-dialog-flag-constants">
- <title id="gtk-dialog-flag-constants-title">GTK Dialog Flag Constants</title>
-
- <para>The Dialog Flag constants are a set of bit-flags that specify
-characteristics of a dialog.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.DIALOG_MODAL</literal></term>
- <listitem>
- <simpara>If set, the dialog grabs all keyboard
- events</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DIALOG_DESTROY_WITH_PARENT</literal></term>
- <listitem>
- <simpara>If set, the dialog is destroyed when its parent
- is.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DIALOG_NO_SEPARATOR</literal></term>
- <listitem>
- <simpara>If set, there is no separator bar above the
- buttons.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-direction-type-constants">
- <title id="gtk-direction-type-constants-title">GTK Direction Type Constants</title>
-
- <para>The Direction Type constants specify a direction for moving a
-cursor or focus.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.DIR_TAB_FORWARD</literal></term>
- <listitem>
- <simpara>Tab forward.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DIR_TAB_BACKWARD</literal></term>
- <listitem>
- <simpara>Tab backward.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DIR_UP</literal></term>
- <listitem>
- <simpara>Up.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DIR_DOWN</literal></term>
- <listitem>
- <simpara>Down.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DIR_LEFT</literal></term>
- <listitem>
- <simpara>Left.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DIR_RIGHT</literal></term>
- <listitem>
- <simpara>Right.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-expander-style-constants">
- <title id="gtk-expander-style-constants-title">GTK Expander Style Constants</title>
-
- <para>The Expander Style constants specify the style of the expanders
-drawn by a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.EXPANDER_COLLAPSED</literal></term>
- <listitem>
- <simpara>The style used for a collapsed subtree.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.EXPANDER_SEMI_COLLAPSED</literal></term>
- <listitem>
- <simpara>Intermediate style used during animation.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.EXPANDER_SEMI_EXPANDED</literal></term>
- <listitem>
- <simpara>Intermediate style used during animation.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.EXPANDER_EXPANDED</literal></term>
- <listitem>
- <simpara>The style used for an expanded subtree.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-filechooser-action-constants">
- <title id="gtk-filechooser-action-constants-title">GTK FileChooser Action Constants</title>
-
- <para>The FileChooser Action constants specify the mode of a <link
-linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
-i.e. whether it is being used to open existing files or to save to a
-possibly new file.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></term>
- <listitem>
- <simpara>Indicates open mode. The file chooser will only let the
- user pick an existing file.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal></term>
- <listitem>
- <simpara>Indicates save mode. The file chooser will let the user
- pick an existing file, or type in a new filename.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER</literal></term>
- <listitem>
- <simpara>Indicates an Open mode for selecting folders. The file
- chooser will let the user pick an existing folder.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_ACTION_CREATE_FOLDER</literal></term>
- <listitem>
- <simpara>Indicates a mode for creating a new folder. The file
- chooser will let the user name an existing or new
- folder.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-filechooser-confirmation-constants">
- <title id="gtk-filechooser-confirmation-constants-title">GTK FileChooser Confirmation Constants</title>
-
- <note>
- <para>These constants are available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The FileChooser Confirmation constants are used to specify the
-return value of a <link
-linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
-"<link
-linkend="signal-gtkfilechooser--confirm-overwrite">confirm-overwrite</link>"
-signal handler. This value determines whether the file chooser will present
-the stock confirmation dialog, accept the user's choice of a filename, or
-let the user choose another filename.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_CONFIRMATION_CONFIRM</literal></term>
- <listitem>
- <simpara>The file chooser will present its stock dialog to
-confirm overwriting an existing file.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME</literal></term>
- <listitem>
- <simpara>The file chooser will terminate and accept the user's
-choice of a file name.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN</literal></term>
- <listitem>
- <simpara>The file chooser will continue running, allowing
-the user to select another file name.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-filechooser-error-constants">
- <title id="gtk-filechooser-error-constants-title">GTK FileChooser Error Constants</title>
-
- <para>The FileChooser Error constants specify the various errors that
-can occur while calling <link
-linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
-functions.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_ERROR_NONEXISTENT</literal></term>
- <listitem>
- <simpara>Indicates that a file does not exist.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_ERROR_BAD_FILENAME</literal></term>
- <listitem>
- <simpara>Indicates a malformed filename.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-filefilter-flags-constants">
- <title id="gtk-filefilter-flags-constants-title">GTK FileFilter Flags Constants</title>
-
- <para>The FileFilter Flags constants are a set of bit-flags that
-specify the file types to filter the files against.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_FILENAME</literal></term>
- <listitem>
- <simpara>The full pathname of the file e.g. /tmp/junk.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_URI</literal></term>
- <listitem>
- <simpara>The full URI of the file
- e.g. file:///tmp/junk.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_DISPLAY_NAME</literal></term>
- <listitem>
- <simpara>The simple name of the file e.g. junk.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_MIME_TYPE</literal></term>
- <listitem>
- <simpara>The MIME type of the file e.g. text/html.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-icon-lookup-flags-constants">
- <title id="gtk-icon-lookup-flags-constants-title">GTK Icon Lookup Flags Constants</title>
-
- <para>The Icon Lookup Flags constants are a set of bit-flags that
-specify options for the <link
-linkend="method-gtkicontheme--lookup-icon"><methodname>gtk.IconTheme.lookup_icon</methodname>()</link>
-method</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.ICON_LOOKUP_NO_SVG</literal></term>
- <listitem>
- <simpara> Never return SVG (Scalable Vector Graphics) icons,
-even if gdk-pixbuf supports them. Cannot be used together with
-<literal>gtk.ICON_LOOKUP_FORCE_SVG</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_LOOKUP_FORCE_SVG</literal></term>
- <listitem>
- <simpara>Return SVG icons, even if gdk-pixbuf doesn't support
-them. Cannot be used together with
-<literal>gtk.ICON_LOOKUP_NO_SVG</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_LOOKUP_USE_BUILTIN</literal></term>
- <listitem>
- <simpara>When passed to the <link
-linkend="method-gtkicontheme--lookup-icon"><methodname>gtk.IconTheme.lookup_icon</methodname>()</link>
-method includes builtin icons as well as files. For a builtin icon, the
-<link
-linkend="method-gtkiconinfo--get-filename"><methodname>gtk.IconInfo.get_filename</methodname>()</link>
-method returns <literal>None</literal> and you need to call the <link
-linkend="method-gtkiconinfo--get-builtin-pixbuf"><methodname>gtk.IconInfo.get_builtin_pixbuf</methodname>()</link>
-method.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-icon-size-constants">
- <title id="gtk-icon-size-constants-title">GTK Icon Size Constants</title>
-
- <para>The Icon Size constants specify the pre-defined sizes of icons
-for various application uses.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.ICON_SIZE_INVALID</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_SIZE_MENU</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_SIZE_BUTTON</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_SIZE_DND</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_SIZE_DIALOG</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-icontheme-error-constants">
- <title id="gtk-icontheme-error-constants-title">GTK IconTheme Error Constants</title>
-
- <para>The IconTheme Error constants specify error codes for <link
-linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>
-operations.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.ICON_THEME_NOT_FOUND</literal></term>
- <listitem>
- <simpara>The icon specified does not exist in the
- theme</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_THEME_FAILED</literal></term>
- <listitem>
- <simpara>An unspecified error occurred.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-iconview-drop-position-constants">
- <title id="gtk-iconview-drop-position-constants-title">GTK IconView Drop Position Constants</title>
-
- <para>The IconView Drop Position constants specify the location relative to the receiving item where the drop should take place.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.ICON_VIEW_NO_DROP</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_VIEW_DROP_INTO</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_VIEW_DROP_LEFT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_VIEW_DROP_RIGHT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_VIEW_DROP_ABOVE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_VIEW_DROP_BELOW</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-im-preedit-style-constants">
- <title id="gtk-im-preedit-style-constants-title">GTK IM Pre-edit Style Constants</title>
-
- <para>The IM Pre-edit Style constants specify the style of input method
-pre-edit display.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.IM_PREEDIT_NOTHING</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.IM_PREEDIT_CALLBACK</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.IM_PREEDIT_NONE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-im-status-style-constants">
- <title id="gtk-im-status-style-constants-title">GTK IM Status Style Constants</title>
-
- <para>The IM Status Style constants specify the style of input method
-display.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.IM_STATUS_NOTHING</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.IM_STATUS_CALLBACK</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.IM_STATUS_NONE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-image-type-constants">
- <title id="gtk-image-type-constants-title">GTK Image Type Constants</title>
-
- <para>The Image Type constants specify the type of image in a <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.IMAGE_EMPTY</literal></term>
- <listitem>
- <simpara>There is no image displayed by the widget</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.IMAGE_PIXMAP</literal></term>
- <listitem>
- <simpara>The widget contains a <link
- linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.IMAGE_IMAGE</literal></term>
- <listitem>
- <simpara>The widget contains a <link
- linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.IMAGE_PIXBUF</literal></term>
- <listitem>
- <simpara>The widget contains a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.IMAGE_STOCK</literal></term>
- <listitem>
- <simpara>The widget contains a stock icon name (see the <link
- linkend="gtk-stock-items">Stock Items</link> reference)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.IMAGE_ICON_SET</literal></term>
- <listitem>
- <simpara>The widget contains a <link
- linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.IMAGE_ANIMATION</literal></term>
- <listitem>
- <simpara>The widget contains a <link
- linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-justification-constants">
- <title id="gtk-justification-constants-title">GTK Justification Constants</title>
-
- <para>The Justification constants specify the justification of the
-text inside a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link>
-widget. (See also <link
-linkend="class-gtkalignment"><classname>gtk.Alignment</classname></link>).</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.JUSTIFY_LEFT</literal></term>
- <listitem>
- <simpara>The text is placed at the left edge of the
- label.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.JUSTIFY_RIGHT</literal></term>
- <listitem>
- <simpara>The text is placed at the right edge of the
- label.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.JUSTIFY_CENTER</literal></term>
- <listitem>
- <simpara>The text is placed in the center of the
- label.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.JUSTIFY_FILL</literal></term>
- <listitem>
- <simpara>The text is placed is distributed across the
- label.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-menu-direction-type-constants">
- <title id="gtk-menu-direction-type-constants-title">GTK Menu Direction Type Constants</title>
-
- <para>The Menu Direction Type constants specify directional movements
-within a menu.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.MENU_DIR_PARENT</literal></term>
- <listitem>
- <simpara>To the parent menu shell.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MENU_DIR_CHILD</literal></term>
- <listitem>
- <simpara>To the submenu, if any, associated with the item.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MENU_DIR_NEXT</literal></term>
- <listitem>
- <simpara>To the next menu item.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MENU_DIR_PREV</literal></term>
- <listitem>
- <simpara>To the previous menu item.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-message-type-constants">
- <title id="gtk-message-type-constants-title">GTK Message Type Constants</title>
-
- <para>The Message Type constants specify the type of message being
-displayed in the message dialog.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.MESSAGE_INFO</literal></term>
- <listitem>
- <simpara>Informational message</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MESSAGE_WARNING</literal></term>
- <listitem>
- <simpara>Nonfatal warning message</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MESSAGE_QUESTION</literal></term>
- <listitem>
- <simpara>Question requiring a choice</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MESSAGE_ERROR</literal></term>
- <listitem>
- <simpara>Fatal error message</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-metric-type-constants">
- <title id="gtk-metric-type-constants-title">GTK Metric Type Constants</title>
-
- <para>The Metric Type constants specify the metric used by a <link
-linkend="class-gtkruler"><classname>gtk.Ruler</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PIXELS</literal></term>
- <listitem>
- <simpara>Pixels.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.INCHES</literal></term>
- <listitem>
- <simpara>Inches.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CENTIMETERS</literal></term>
- <listitem>
- <simpara>Centimeters.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-movement-step-constants">
- <title id="gtk-movement-step-constants-title">GTK Movement Step Constants</title>
-
- <para>The Movement Step constants specify the steps used in movement
-through text.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_LOGICAL_POSITIONS</literal></term>
- <listitem>
- <simpara>move by graphemes</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_VISUAL_POSITIONS</literal></term>
- <listitem>
- <simpara>move by graphemes</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_WORDS</literal></term>
- <listitem>
- <simpara>move by words</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_DISPLAY_LINES</literal></term>
- <listitem>
- <simpara>move by lines(wrapped lines)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_DISPLAY_LINE_ENDS</literal></term>
- <listitem>
- <simpara>move to line ends(wrapped lines)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_PARAGRAPHS</literal></term>
- <listitem>
- <simpara>move by paragraphs(newline-ended lines)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_PARAGRAPH_ENDS</literal></term>
- <listitem>
- <simpara>move to ends of a paragraph</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_PAGES</literal></term>
- <listitem>
- <simpara>move by pages</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_BUFFER_ENDS</literal></term>
- <listitem>
- <simpara>move to ends of the buffer</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-notebook-tab-constants">
- <title id="gtk-notebook-tab-constants-title">GTK Notebook Tab Constants</title>
-
- <para>The Notebook Tab constants specify the tab position to receive
-focus.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.NOTEBOOK_TAB_FIRST</literal></term>
- <listitem>
- <simpara>The first <link
-linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link>
-tab</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.NOTEBOOK_TAB_LAST</literal></term>
- <listitem>
- <simpara>The last <link
-linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link>
-tab</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-object-flags-constants">
- <title id="gtk-object-flags-constants-title">GTK Object Flags Constants</title>
-
- <para>The Object Flags constants are a set of bit-flags that specify
-the state of the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.IN_DESTRUCTION</literal></term>
- <listitem>
- <simpara>The object is currently being destroyed. This is used
- internally to prevent reinvocations during
- destruction.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FLOATING</literal></term>
- <listitem>
- <simpara>The object is orphaned.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-orientation-constants">
- <title id="gtk-orientation-constants-title">GTK Orientation Constants</title>
-
- <para>The Orientation constants specify the orientation of widgets
-which can be switched between horizontal and vertical orientation on the
-fly, like <link
-linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.ORIENTATION_HORIZONTAL</literal></term>
- <listitem>
- <simpara>The widget is in horizontal orientation.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ORIENTATION_VERTICAL</literal></term>
- <listitem>
- <simpara>The widget is in vertical orientation. </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-pack-direction-constants">
- <title id="gtk-pack-direction-constants-title">GTK Pack Direction Constants</title>
-
- <para>The Pack Direction constants specify the arrangement of <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>s in a
-<link linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>
-or in a child <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> of a
-menubar.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.ACK_DIRECTION_LTR</literal></term>
- <listitem>
- <simpara>Pack left to right</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PACK_DIRECTION_RTL</literal></term>
- <listitem>
- <simpara>Pack right to left</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PACK_DIRECTION_TTB</literal></term>
- <listitem>
- <simpara>Pack top to bottom</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PACK_DIRECTION_BTT</literal></term>
- <listitem>
- <simpara>Pack bottom to top</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-pack-type-constants">
- <title id="gtk-pack-type-constants-title">GTK Pack Type Constants</title>
-
- <para>The Pack Type constants specify the packing location <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> children. (See:
-<link linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>, <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link>, and <link
-linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link>).</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PACK_START</literal></term>
- <listitem>
- <simpara>The child is packed into the start of the box</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PACK_END</literal></term>
- <listitem>
- <simpara>The child is packed into the end of the box</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-page-orientation-constants">
- <title id="gtk-page-orientation-constants-title">GTK Page Orientation Constants</title>
-
- <para>The Page Orientation constants specify the orientation of a
- page.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PAGE_ORIENTATION_PORTRAIT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PAGE_ORIENTATION_LANDSCAPE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PAGE_ORIENTATION_REVERSE_PORTRAIT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PAGE_ORIENTATION_REVERSE_LANDSCAPE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-page-set-constants">
- <title id="gtk-page-set-constants-title">GTK Page Set Constants</title>
-
- <para>The Page Set constants specify the set of
- pages to print.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PAGE_SET_ALL</literal></term>
- <listitem>
- <simpara>print all pages</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PAGE_SET_EVEN</literal></term>
- <listitem>
- <simpara>print even pages only</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PAGE_SET_ODD</literal></term>
- <listitem>
- <simpara>print odd pages only</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-paper-name-constants">
- <title id="gtk-paper-name-constants-title">GTK Papaer Name Constants</title>
-
- <para>The Paper Name constants specify the common standard sizes of
- paper as a string.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PAPER_NAME_A3</literal></term>
- <listitem>
- <simpara>Name for the A4 paper size.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PAPER_NAME_A4</literal></term>
- <listitem>
- <simpara>Name for the A4 paper size.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PAPER_NAME_A5</literal></term>
- <listitem>
- <simpara>Name for the A5 paper size.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PAPER_NAME_B5</literal></term>
- <listitem>
- <simpara>Name for the B5 paper size.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PAPER_NAME_LETTER</literal></term>
- <listitem>
- <simpara>Name for the Letter paper size.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PAPER_NAME_EXECUTIVE</literal></term>
- <listitem>
- <simpara>Name for the Executive paper size.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.Name for the Legal paper size.</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-path-priority-type-constants">
- <title id="gtk-path-priority-type-constants-title">GTK Path Priority Type Constants</title>
-
- <para>The Path Priority Type constants are a set of bit-flags that
-specify the priority of path lookup.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PATH_PRIO_LOWEST</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PATH_PRIO_GTK</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PATH_PRIO_APPLICATION</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PATH_PRIO_THEME</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PATH_PRIO_RC</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PATH_PRIO_HIGHEST</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-path-type-constants">
- <title id="gtk-path-type-constants-title">GTK Path Type Constants</title>
-
- <para>The Path Type constants specify </para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PATH_WIDGET</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PATH_WIDGET_CLASS</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PATH_CLASS</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-policy-type-constants">
- <title id="gtk-policy-type-constants-title">GTK Policy Type Constants</title>
-
- <para>The Policy Type constants specify when a scroll bar will be
-visible.</para>
-
- <variablelist>
- <varlistentry>
- <term>gtk.POLICY_ALWAYS</term>
- <listitem>
- <simpara>the scrollbar is always present</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>gtk.POLICY_AUTOMATIC</term>
- <listitem>
- <simpara>the scrollbar is present only if needed i.e. the
-contents are larger than the window</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>gtk.POLICY_NEVER</term>
- <listitem>
- <simpara>the scrollbar is never present</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-position-type-constants">
- <title id="gtk-position-type-constants-title">GTK Position Type Constants</title>
-
- <para>The Position Type constants specify </para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.POS_LEFT</literal></term>
- <listitem>
- <simpara>The feature is at the left edge.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.POS_RIGHT</literal></term>
- <listitem>
- <simpara>The feature is at the right edge.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.POS_TOP</literal></term>
- <listitem>
- <simpara>The feature is at the top edge.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.POS_BOTTOM</literal></term>
- <listitem>
- <simpara>The feature is at the bottom edge</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-print-duplex-constants">
- <title id="gtk-print-duplex-constants-title">GTK Print Duplex Constants</title>
-
- <para>The Print Status constants specify how the output pages should
- be duplexed:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PRINT_DUPLEX_SIMPLEX</literal></term>
- <listitem>
- <simpara>one page per sheet i.e. no duplexing</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_DUPLEX_HORIZONTAL</literal></term>
- <listitem>
- <simpara>two pages per sheet horizontally duplexed</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_DUPLEX_VERTICAL</literal></term>
- <listitem>
- <simpara>two pages per sheet vertically duplexed</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-print-error-constants">
- <title id="gtk-print-error-constants-title">GTK Print Error Constants</title>
-
- <para>The Print Error constants specify the type of printing
- error:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PRINT_ERROR_GENERAL</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_ERROR_INTERNAL_ERROR</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_ERROR_NOMEM</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-print-pages-constants">
- <title id="gtk-print-pages-constants-title">GTK Print Pages Constants</title>
-
- <para>The Print Pages constants specify the set that should be
- printed:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PRINT_PAGES_ALL</literal></term>
- <listitem>
- <simpara>print all pages</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_PAGES_CURRENT</literal></term>
- <listitem>
- <simpara>print the current page</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_PAGES_RANGES</literal></term>
- <listitem>
- <simpara>print the specified ranges of pages</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-print-operation-action-constants">
- <title id="gtk-print-operation-action-constants-title">GTK Print Operation Action Constants</title>
-
- <para>The Print Operation Action constants specify the print operation
- to be performed:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PRINT_OPERATION_ACTION_PRINT_DIALOG</literal></term>
- <listitem>
- <simpara>Show the print dialog.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_OPERATION_ACTION_PRINT</literal></term>
- <listitem>
- <simpara>Start to print without showing the print dialog, based
- on the current print settings.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_OPERATION_ACTION_PREVIEW</literal></term>
- <listitem>
- <simpara>Show the print preview.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_OPERATION_ACTION_EXPORT</literal></term>
- <listitem>
- <simpara>Export to a file. This requires the "export-filename"
- property to be set.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-print-operation-result-constants">
- <title id="gtk-print-operation-result-constants-title">GTK Print Operation Result Constants</title>
-
- <para>The Print Operation Result constants specify the result of the
- print operation as returned by the <link
- linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run</methodname>()</link>)
- method:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PRINT_OPERATION_RESULT_ERROR</literal></term>
- <listitem>
- <simpara>An error has occured.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_OPERATION_RESULT_APPLY</literal></term>
- <listitem>
- <simpara>The print settings should be stored.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_OPERATION_RESULT_CANCEL</literal></term>
- <listitem>
- <simpara>The print operation has been canceled, the print
- settings should not be stored.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_OPERATION_RESULT_IN_PROGRESS</literal></term>
- <listitem>
- <simpara>The print operation is complete yet. This value will
- only be returned when running asynchronously.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-print-quality-constants">
- <title id="gtk-print-quality-constants-title">GTK Print Quality Constants</title>
-
- <para>The Print Quality constants specify the quality that should be
- used when printing the output pages:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PRINT_QUALITY_LOW</literal></term>
- <listitem>
- <simpara>low quality</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_QUALITY_NORMAL</literal></term>
- <listitem>
- <simpara>normal quality</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_QUALITY_HIGH</literal></term>
- <listitem>
- <simpara>high quality</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_QUALITY_DRAFT</literal></term>
- <listitem>
- <simpara>draft quality</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-print-status-constants">
- <title id="gtk-print-status-constants-title">GTK Print Status Constants</title>
-
- <para>The Print Status constants specify </para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PRINT_STATUS_INITIAL</literal></term>
- <listitem>
- <simpara>The printing has not started yet; this status is set
- initially, and while the print dialog is shown.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_STATUS_PREPARING</literal></term>
- <listitem>
- <simpara>This status is set while the "begin-print" signal is
- emitted and during pagination.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_STATUS_GENERATING_DATA</literal></term>
- <listitem>
- <simpara>This status is set while the pages are being
- rendered.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_STATUS_SENDING_DATA</literal></term>
- <listitem>
- <simpara>The print job is being sent off to the
- printer.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_STATUS_PENDING</literal></term>
- <listitem>
- <simpara>The print job has been sent to the printer, but is not
- printed for some reason, e.g. the printer may be
- stopped.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_STATUS_PENDING_ISSUE</literal></term>
- <listitem>
- <simpara>Some problem has occurred during printing, e.g. a paper
- jam.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_STATUS_PRINTING</literal></term>
- <listitem>
- <simpara>The printer is processing the print job.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_STATUS_FINISHED</literal></term>
- <listitem>
- <simpara>The printing has been completed successfully.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PRINT_STATUS_FINISHED_ABORTED</literal></term>
- <listitem>
- <simpara>The printing has been aborted. </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-progressbar-orientation-constants">
- <title id="gtk-progressbar-orientation-constants-title">GTK ProgressBar Orientation Constants</title>
-
- <para>The ProgressBar Orientation constants specify the orientation
-and growth direction for a visible progress bar.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PROGRESS_LEFT_TO_RIGHT</literal></term>
- <listitem>
- <simpara>A horizontal progress bar growing from left to
-right.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.PROGRESS_RIGHT_TO_LEFT</literal></term>
- <listitem>
- <simpara>A horizontal progress bar growing from right to
-left.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.PROGRESS_BOTTOM_TO_TOP</literal></term>
- <listitem>
- <simpara>A vertical progress bar growing from bottom to
-top.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.PROGRESS_TOP_TO_BOTTOM</literal></term>
- <listitem>
- <simpara>A vertical progress bar growing from top to
-bottom.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-progressbar-style-constants">
- <title id="gtk-progressbar-style-constants-title">GTK ProgressBar Style Constants</title>
-
- <para>The ProgressBar Style constants specify the style of the <link
-linkend="class-gtkprogressbar"><classname>gtk.ProgressBar</classname></link>
-display.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.PROGRESS_CONTINUOUS</literal></term>
- <listitem>
- <simpara>The progress bar grows in a smooth, continuous
- manner.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PROGRESS_DISCRETE</literal></term>
- <listitem>
- <simpara>The progress bar grows in discrete, visible
- blocks.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-rc-flags-constants">
- <title id="gtk-rc-flags-constants-title">GTK RC Flags Constants</title>
-
- <para>The>RC Flags constants are a set of bit-flags that specify which
-fields of a <link
-linkend="class-gtkrcstyle"><classname>gtk.RcStyle</classname></link> have
-been set for each state.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.RC_FG</literal></term>
- <listitem>
- <simpara>If present, the foreground color has been set for this
- state.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_BG</literal></term>
- <listitem>
- <simpara>If present, the background color has been set for this
- state.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TEXT</literal></term>
- <listitem>
- <simpara>If present, the text color has been set for this
- state.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_BASE</literal></term>
- <listitem>
- <simpara>If present, the base color has been set for this
- state.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-rc-token-type-constants">
- <title id="gtk-rc-token-type-constants-title">GTK RC Token Type Constants</title>
-
- <para>The RC Token Type constants specify the tokens in the RC
-file. It is exposed so that theme engines can reuse these tokens when
-parsing the theme-engine specific portions of a RC file.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_INVALID</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_INCLUDE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_NORMAL</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_ACTIVE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_PRELIGHT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_SELECTED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_INSENSITIVE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_FG</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_BG</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_TEXT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_BASE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_XTHICKNESS</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_YTHICKNESS</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_FONT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_FONTSET</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_FONT_NAME</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_BG_PIXMAP</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_PIXMAP_PATH</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_STYLE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_BINDING</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_BIND</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_WIDGET</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_WIDGET_CLASS</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_CLASS</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_LOWEST</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_GTK</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_APPLICATION</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_THEME</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_RC</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_HIGHEST</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_ENGINE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_MODULE_PATH</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_IM_MODULE_PATH</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_IM_MODULE_FILE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_STOCK</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_LTR</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_RTL</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_TOKEN_LAST</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-recent-chooser-error-constants">
- <title id="gtk-recent-chooser-error-constants-title">GTK Recent Chooser Error Constants</title>
-
- <para>The Recent Recent Chooser Error constants specify the various
- errors that can occur while calling <link
- linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>
- methods:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.RECENT_CHOOSER_ERROR_NOT_FOUND</literal></term>
- <listitem>
- <simpara>Indicates that a file does not exist</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RECENT_CHOOSER_ERROR_INVALID_URI</literal></term>
- <listitem>
- <simpara>Indicates a malformed URI</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-recent-filter-flags-constants">
- <title id="gtk-recent-filter-flags-constants-title">GTK Recent Filter Flags</title>
-
- <para>The Recent Filter Flags specify what types of filtering are
- needed:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.RECENT_FILTER_URI</literal></term>
- <listitem>
- <simpara>the URI of the file being tested</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RECENT_FILTER_DISPLAY_NAME</literal></term>
- <listitem>
- <simpara>the string that will be used to display the file in the
- recent chooser</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RECENT_FILTER_MIME_TYPE</literal></term>
- <listitem>
- <simpara>the mime type of the file</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RECENT_FILTER_APPLICATION</literal></term>
- <listitem>
- <simpara>the list of applications that have registered the
- file</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RECENT_FILTER_GROUP</literal></term>
- <listitem>
- <simpara>the groups to which the file belongs</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RECENT_FILTER_AGE</literal></term>
- <listitem>
- <simpara>the number of days elapsed since the file has been
- registered</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-recent-sort-type-constants">
- <title id="gtk-recent-sort-type-constants-title">GTK Recent Sort Type Constants</title>
-
- <para>The Recent Sort Type constants specify the sorting method to be
- applyed to the recently used resource list.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.RECENT_SORT_NONE</literal></term>
- <listitem>
- <simpara>Do not sort the returned list of recently used
- resources.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RECENT_SORT_MRU</literal></term>
- <listitem>
- <simpara>Sort the returned list with the most recently used
- items first.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RECENT_SORT_LRU</literal></term>
- <listitem>
- <simpara>Sort the returned list with the least recently used
- items first.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RECENT_SORT_CUSTOM</literal></term>
- <listitem>
- <simpara>Sort the returned list using a custom sorting function
- passed using the <link
- linkend="method-gtkrecentchooser--set-sort-func"><methodname>gtk.RecentChooser.set_sort_func</methodname>()</link>
- method.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-relief-style-constants">
- <title id="gtk-relief-style-constants-title">GTK Relief Style Constants</title>
-
- <para>The Relief Style constants specify </para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.RELIEF_NORMAL</literal></term>
- <listitem>
- <simpara>Draw a normal relief.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RELIEF_HALF</literal></term>
- <listitem>
- <simpara>Draw a half relief.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RELIEF_NONE</literal></term>
- <listitem>
- <simpara>Draw no relief.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-resize-mode-constants">
- <title id="gtk-resize-mode-constants-title">GTK Resize Mode Constants</title>
-
- <para>The Resize Mode constants specify how resize requests are
-handled by a widget.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.RESIZE_PARENT</literal></term>
- <listitem>
- <simpara>Pass resize request to the parent</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RESIZE_QUEUE</literal></term>
- <listitem>
- <simpara>Queue resizes on this widget</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RESIZE_IMMEDIATE</literal></term>
- <listitem>
- <simpara>Perform the resizes now</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-response-type-constants">
- <title id="gtk-response-type-constants-title">GTK Response Type Constants</title>
-
- <para>The Response Type constants specify pre-defined response
- values.</para>
-
- <variablelist>
- <varlistentry><listitem>
- <simpara><literal>gtk.RESPONSE_NONE</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.RESPONSE_REJECT</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.RESPONSE_ACCEPT</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.RESPONSE_DELETE_EVENT</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.RESPONSE_OK</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.RESPONSE_CANCEL</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.RESPONSE_CLOSE</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.RESPONSE_YES</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.RESPONSE_NO</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.RESPONSE_APPLY</literal></simpara>
- </listitem></varlistentry>
- <varlistentry><listitem>
- <simpara><literal>gtk.RESPONSE_HELP</literal></simpara>
- </listitem></varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-scroll-step-constants">
- <title id="gtk-scroll-step-constants-title">GTK Scroll Step Constants</title>
-
- <para>The Scroll Step constants specify the size of the scroll
-movements.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.SCROLL_STEPS</literal></term>
- <listitem>
- <simpara>Scroll up or down in step increments</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_PAGES,</literal></term>
- <listitem>
- <simpara>Scroll up or down in page increments</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_ENDS</literal></term>
- <listitem>
- <simpara>Scroll to the beginning or end</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_HORIZONTAL_STEPS</literal></term>
- <listitem>
- <simpara>Scroll left or right in step increments</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_HORIZONTAL_PAGES</literal></term>
- <listitem>
- <simpara>Scroll left or right in step increments</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_HORIZONTAL_ENDS</literal></term>
- <listitem>
- <simpara>Scroll to the far left end or far right end.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-scroll-type-constants">
- <title id="gtk-scroll-type-constants-title">GTK Scroll Type Constants</title>
-
- <para>The Scroll Type constants specify the type of scroll
- \movement.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.SCROLL_NONE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_JUMP</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_STEP_BACKWARD</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_STEP_FORWARD</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_PAGE_BACKWARD</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_PAGE_FORWARD</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_STEP_UP</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_STEP_DOWN</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_PAGE_UP</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_PAGE_DOWN</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_STEP_LEFT,</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_STEP_RIGHT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_PAGE_LEFT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_PAGE_RIGHT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_START</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SCROLL_END</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-selection-mode-constants">
- <title id="gtk-selection-mode-constants-title">GTK Selection Mode Constants</title>
-
- <para>The Selection Mode constants specify the mode of <link
- linkend="class-gtktreeselection"><classname>gtk.TreeSelection</classname></link>
- in a <link
- linkend="class-gtktreeview"><classname>gtk.Treeview</classname></link></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.SELECTION_NONE</literal></term>
- <listitem>
- <simpara>No selection allowed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SELECTION_SINGLE</literal></term>
- <listitem>
- <simpara>A single selection allowed by clicking.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SELECTION_BROWSE</literal></term>
- <listitem>
- <simpara>A single selection allowed by browsing with the
-pointer.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SELECTION_MULTIPLE</literal></term>
- <listitem>
- <simpara>Multiple items can be selected at once.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SELECTION_EXTENDED</literal></term>
- <listitem>
- <simpara>Deprecated.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-shadow-type-constants">
- <title id="gtk-shadow-type-constants-title">GTK Shadow Type Constants</title>
-
- <para>The Shadow Type constants specify the appearance of an outline
-typically provided by a <link
-linkend="class-gtkframe"><classname>gtk.Frame</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.SHADOW_NONE</literal></term>
- <listitem>
- <simpara>No outline.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SHADOW_IN</literal></term>
- <listitem>
- <simpara>The outline is beveled inward.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SHADOW_OUT</literal></term>
- <listitem>
- <simpara>The outline is beveled outward like a button.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SHADOW_ETCHED_IN</literal></term>
- <listitem>
- <simpara>The outline itself is an inward bevel, but the frame
- bevels outward</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SHADOW_ETCHED_OUT</literal></term>
- <listitem>
- <simpara>The outline itself is an outward bevel, but the frame
- bevels inward</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-sizegroup-mode-constants">
- <title id="gtk-sizegroup-mode-constants-title">GTK SizeGroup Mode Constants</title>
-
- <para>The SizeGroup Mode constants specify the directions in which the
-size group affects the requested sizes of its component widgets.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.SIZE_GROUP_NONE</literal></term>
- <listitem>
- <simpara>The group has no affect</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SIZE_GROUP_HORIZONTAL</literal></term>
- <listitem>
- <simpara>The group affects horizontal requisition</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SIZE_GROUP_VERTICAL</literal></term>
- <listitem>
- <simpara>The group affects vertical requisition</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SIZE_GROUP_BOTH</literal></term>
- <listitem>
- <simpara>The group affects both horizontal and vertical
- requisition</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-sort-type">
- <title id="gtk-sort-type-title">GTK Sort Type Constants</title>
-
- <para>The Sort Type constants specify he direction of a sort.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.SORT_ASCENDING</literal></term>
- <listitem>
- <simpara>Sorting is in ascending order.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SORT_DESCENDING</literal></term>
- <listitem>
- <simpara>Sorting is in descending order.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-spinbutton-update-policy-constants">
- <title id="gtk-spinbutton-update-policy-constants-title">GTK SpinButton Update Policy Constants</title>
-
- <para>The SpinButton Update Policy constants specify the update policy
-for a <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.UPDATE_ALWAYS</literal></term>
- <listitem>
- <simpara>When refreshing a <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>,
-the value is always displayed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UPDATE_IF_VALID</literal></term>
- <listitem>
- <simpara>When refreshing a <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>,
-the value is only displayed if it is valid within the bounds of the spin
-button's <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-spin-type-constants">
- <title id="gtk-spin-type-constants-title">GTK Spin Type Constants</title>
-
- <para>The Spin Type constants specify the step movement of a <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.SPIN_STEP_FORWARD</literal></term>
- <listitem>
- <simpara>Spin a <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>
-forward by the step value of the spin button's <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_STEP_BACKWARD</literal></term>
- <listitem>
- <simpara>Spin a <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>
-backward by the step value of the spin button's <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_PAGE_FORWARD</literal></term>
- <listitem>
- <simpara>Spin a <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>
-forward by the page value of the spin button's <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_PAGE_BACKWARD</literal></term>
- <listitem>
- <simpara>Spin a <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>
-backward by the page value of the spin button's <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_HOME</literal></term>
- <listitem>
- <simpara>Set the spin button's value to the minimum possible
-value specified by its <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_END</literal></term>
- <listitem>
- <simpara>Set the spin button's value to the maximum possible
-value specified by its <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_USER_DEFINED</literal></term>
- <listitem>
- <simpara>The programmer must specify the exact amount to spin
-the <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-state-type-constants">
- <title id="gtk-state-type-constants-title">GTK State Type Constants</title>
-
- <para>The State Type constants specify the current state of a widget;
-the state determines how the widget is drawn. The State Type constants are
-also used to identify different colors in a <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> for
-drawing, so states can be used for subparts of a widget as well as entire
-widgets.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.STATE_NORMAL</literal></term>
- <listitem>
- <simpara>State during normal operation.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.STATE_ACTIVE</literal></term>
- <listitem>
- <simpara>State of a currently active widget, such as a depressed
- button.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.STATE_PRELIGHT</literal></term>
- <listitem>
- <simpara>State indicating that the mouse pointer is over the
- widget and the widget will respond to mouse clicks.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.STATE_SELECTED</literal></term>
- <listitem>
- <simpara>State of a selected item, such the selected row in a
- list.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.STATE_INSENSITIVE</literal></term>
- <listitem>
- <simpara>State indicating that the widget is unresponsive to
- user actions.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-target-flags-constants">
- <title id="gtk-target-flags-constants-title">GTK Target Flags Constants</title>
-
- <para>The Target Flags constants are a set of bit-flags that specify
-constraints on the target of a drag operation.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TARGET_SAME_APP</literal></term>
- <listitem>
- <simpara> If this is set, the target will only be selected for
-drags within a single application.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TARGET_SAME_WIDGET</literal></term>
- <listitem>
- <simpara>f this is set, the target will only be selected for
-drags within a single widget.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-text-direction-constants">
- <title id="gtk-text-direction-constants-title">GTK Text Direction Constants</title>
-
- <para>The Text Direction constants specify the direction of the
-text.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TEXT_DIR_NONE</literal></term>
- <listitem>
- <simpara>Text direction not specified.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_DIR_LTR,</literal></term>
- <listitem>
- <simpara>Left to right direction.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_DIR_RTL</literal></term>
- <listitem>
- <simpara>Right to left direction</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-text-search-flags-constants">
- <title id="gtk-text-search-flags-constants-title">GTK Text Search Flags Constants Constants</title>
-
- <para>The Text Search Flags constants are a set of bit-flags that specify what types of text are
-suitable for search matches in a <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TEXT_SEARCH_VISIBLE_ONLY</literal></term>
- <listitem>
- <simpara>Only visible text can match the search
- criteria.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_SEARCH_TEXT_ONLY</literal></term>
- <listitem>
- <simpara>Both visible and invisible text can match the search
- criteria.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-text-window-type-constants">
- <title id="gtk-text-window-type-constants-title">GTK Text Window Type Constants</title>
-
- <para>The Text Window Type constants specify the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-objects that make up a <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>. See
-the <link
-linkend="method-gtktextview--get-window"><methodname>gtk.TextView.get_window</methodname>()</link>
-method for more detail.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_WIDGET</literal></term>
- <listitem>
- <simpara>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-the <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>
-widget.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_TEXT</literal></term>
- <listitem>
- <simpara>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> that
-contains the text in the <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_LEFT</literal></term>
- <listitem>
- <simpara>The left child <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-the <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_RIGHT</literal></term>
- <listitem>
- <simpara>The right child <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-the <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_TOP</literal></term>
- <listitem>
- <simpara>The top child <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-the <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_BOTTOM</literal></term>
- <listitem>
- <simpara>The bottom child <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-the <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-textbuffer-target-info-constants">
- <title id="gtk-textbuffer-target-info-constants-title">GTK TextBuffer Target Info Constants</title>
-
- <para>The TextBuffer Target Info constants specify the info integer
- for use with the <link
- linkend="function-gtk--target-list-add-rich-text-targets"><function>gtk.target_list_add_rich_text_targets</function>()</link>
- and <link
- linkend="function-gtk--target-list-add-text-targets"><function>gtk.target_list_add_text_targets</function>()</link>
- functions.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_BUFFER_TARGET_INFO_RICH_TEXT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_BUFFER_TARGET_INFO_TEXT</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-toolbar-space-style-constants">
- <title id="gtk-toolbar-space-style-constants-title">GTK Toolbar Space Style Constants</title>
-
- <para>The Toolbar Space Style constants specify whether a spacer is
-displayed as a vertical line or space.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_SPACE_EMPTY,</literal></term>
- <listitem>
- <simpara>Show as an empty space</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_SPACE_LINE</literal></term>
- <listitem>
- <simpara>Show as a vertical line.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-toolbar-style-constants">
- <title id="gtk-toolbar-style-constants-title">GTK Toolbar Style Constants</title>
-
- <para>The Toolbar Style constants specify the appearance of a <link
-linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link>. Note
-that setting the toolbar style overrides the user's preferences for the
-default toolbar style.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_ICONS</literal></term>
- <listitem>
- <simpara>Buttons display only icons in the toolbar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_TEXT</literal></term>
- <listitem>
- <simpara>Buttons display only text labels in the
- toolbar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_BOTH</literal></term>
- <listitem>
- <simpara>Buttons display text and icons in the
- toolbar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_BOTH_HORIZ</literal></term>
- <listitem>
- <simpara>Buttons display icons and text alongside each other,
- rather than vertically stacked</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-treemodel-flags-constants">
- <title id="gtk-treemodel-flags-constants-title">GTK TreeModel Flags Constants</title>
-
- <para>The TreeModel Flags constants are a set of bit-flags that
-specify various properties of a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>. They
-are returned by the <link
-linkend="method-gtktreemodel--get-flags"><methodname>gtk.TreeModel.get_flags</methodname>()</link>
-method, and must be static for the lifetime of the object. A more complete
-description of <literal>gtk.TREE_MODEL_ITERS_PERSIST</literal> can be found
-in the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-reference description.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TREE_MODEL_ITERS_PERSIST</literal></term>
- <listitem>
- <simpara>Iterators survive all signals emitted by the
- tree.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TREE_MODEL_LIST_ONLY</literal></term>
- <listitem>
- <simpara>The model is a list only, and never has
- children</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-treeview-drop-position-constants">
- <title id="gtk-treeview-drop-position-constants-title">GTK TreeView Drop Position Constants</title>
-
- <para>The TreeView Drop Position constants specify where a dropped row
-goes.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TREE_VIEW_DROP_BEFORE</literal></term>
- <listitem>
- <simpara>The dropped item goes before the row it's dropped
-on.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TREE_VIEW_DROP_AFTER</literal></term>
- <listitem>
- <simpara>The dropped item goes after the row it's dropped
-on.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TREE_VIEW_DROP_INTO_OR_BEFORE</literal></term>
- <listitem>
- <simpara>The dropped item becomes a child of the row it's dropped
-on. Fallback to goes before.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TREE_VIEW_DROP_INTO_OR_AFTER</literal></term>
- <listitem>
- <simpara>The dropped item becomes a child of the row it's dropped
-on. Fallback to goes after.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-treeview-grid-lines-constants">
- <title id="gtk-treeview-grid-lines-constants-title">GTK TreeView Grid Lines Constants</title>
-
- <para>The TreeView Grid Lines constants specify how grid lines should be applied to a TreeView.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TREE_VIEW_GRID_LINES_NONE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TREE_VIEW_GRID_LINES_HORIZONTAL</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TREE_VIEW_GRID_LINES_VERTICAL</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TREE_VIEW_GRID_LINES_BOTH</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-treeviewcolumn-sizing-constants">
- <title id="gtk-treeviewcolumn-sizing-constants-title">GTK TreeViewColumn Sizing Constants</title>
-
- <para>The TreeViewColumn Sizing constants specify the sizing method the
-column uses to determine its width. Please note that
-<literal>gtk.TREE_VIEW_COLUMN_AUTOSIZE</literal> are inefficient for large
-views, and can make columns appear choppy.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TREE_VIEW_COLUMN_GROW_ONLY</literal></term>
- <listitem>
- <simpara>Columns only get bigger in reaction to changes in the
- model</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TREE_VIEW_COLUMN_AUTOSIZE</literal></term>
- <listitem>
- <simpara>Columns resize to be the optimal size every time the
- model changes.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TREE_VIEW_COLUMN_FIXED</literal></term>
- <listitem>
- <simpara>Columns are a fixed numbers of pixels wide.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-uimanager-item-type-constants">
- <title id="gtk-uimanager-item-type-constants-title">GTK UIManager Item Type Constants</title>
-
- <para>The UIManager Item Type constants specify what UI element to
-create.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_AUTO</literal></term>
- <listitem>
- <simpara>Pick the type of the UI element according to
- context.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_MENUBAR</literal></term>
- <listitem>
- <simpara>Create a menubar. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_MENU</literal></term>
- <listitem>
- <simpara>Create a menu.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_TOOLBAR</literal></term>
- <listitem>
- <simpara>Create a toolbar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_PLACEHOLDER</literal></term>
- <listitem>
- <simpara>Insert a placeholder.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_POPUP</literal></term>
- <listitem>
- <simpara>Create a popup menu.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_MENUITEM</literal></term>
- <listitem>
- <simpara>Create a menuitem.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_TOOLITEM</literal></term>
- <listitem>
- <simpara>Create a toolitem.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_SEPARATOR</literal></term>
- <listitem>
- <simpara>Create a separator.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_ACCELERATOR</literal></term>
- <listitem>
- <simpara>Install an accelerator.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-unit-constants">
- <title id="gtk-unit-constants-title">GTK Unit Constants</title>
-
- <para>The Unit constants specify the </para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.UNIT_PIXEL</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UNIT_POINTS</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UNIT_INCH</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UNIT_MM</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-update-type-constants">
- <title id="gtk-update-type-constants-title">GTK Update Type Constants</title>
-
- <para>The Update Type constants specify the update policy of a <link
-linkend="class-gtkrange"><classname>gtk.Range</classname></link> and <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.UPDATE_CONTINUOUS</literal></term>
- <listitem>
- <simpara>Update the display continuously as the pointer is
- moved.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UPDATE_DISCONTINUOUS</literal></term>
- <listitem>
- <simpara>Update the display at intervals while the pointer is
- being moved.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UPDATE_DELAYED</literal></term>
- <listitem>
- <simpara>Update the display after the pointer has finished
- moving.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-version-constants">
- <title id="gtk-version-constants-title">GTK Version Constants</title>
-
- <para>The Version constants specify the versions of
-<literal>GTK+</literal> and <literal>PyGTK</literal> as a 3-tuple containing
-the major, minor and patch release numbers.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gtk_version</literal></term>
- <listitem>
- <simpara>A 3-tuple containing the <literal>GTK+</literal>
- (major, minor, patch) release numbers.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.pygtk_version</literal></term>
- <listitem>
- <simpara>A 3-tuple containing the <literal>PyGTK</literal>
- (major, minor, patch) release numbers.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-widget-flags-constants">
- <title id="gtk-widget-flags-constants-title">GTK Widget Flags Constants</title>
-
- <para>The Widget Flags constants are a set of bit-flags that specify
-certain properties of the widget.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TOPLEVEL</literal></term>
- <listitem>
- <simpara>Widgets without a real parent, as there are <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> and <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> objects that
-have this flag set throughout their lifetime. Toplevel widgets always
-contain their own <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.NO_WINDOW</literal></term>
- <listitem>
- <simpara> Indicative for a widget that does not provide its own
-<link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>. Visible
-action (e.g. drawing) is performed on the parent's <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.REALIZED</literal></term>
- <listitem>
- <simpara>Set by the <link
-linkend="method-gtkwidget--realize"><methodname>gtk.Widget.realize</methodname>()</link>
-method , unset by the <link
-linkend="method-gtkwidget--unrealize"><methodname>gtk.Widget.unrealize</methodname>()</link>
-method. A realized widget has an associated <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MAPPED</literal></term>
- <listitem>
- <simpara> Set by the <link
-linkend="method-gtkwidget--map"><methodname>gtk.Widget.map</methodname>()</link>
-method, unset by the <link
-linkend="method-gtkwidget--unmap"><methodname>gtk.Widget.unmap</methodname>()</link>
-method. Only realized widgets can be mapped. It means that the <link
-linkend="method-gdkwindow--show"><methodname>gtk.Window.show</methodname>()</link>
-method has been called on the widgets window(s).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.VISIBLE</literal></term>
- <listitem>
- <simpara>Set by the <link
-linkend="method-gtkwidget--show"><methodname>gtk.Widget.show</methodname>()</link>
-method, unset by the <link
-linkend="method-gtkwidget--hide"><methodname>gtk.Widget.hide</methodname>()</link>
-method. Implies that a widget will be mapped as soon as its parent is
-mapped.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SENSITIVE</literal></term>
- <listitem>
- <simpara>Set and unset by the <link
-linkend="method-gtkwidget--set-sensitive"><methodname>gtk.Widget.set_sensitive</methodname>()</link>
-method. The sensitivity of a widget determines whether it will receive
-certain events (e.g. button or key presses). One premise for the widgets
-sensitivity is to have this flag set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PARENT_SENSITIVE</literal></term>
- <listitem>
- <simpara>Set and unset by the <link
-linkend="method-gtkwidget--set-sensitive"><methodname>gtk.Widget.set_sensitive</methodname>()</link>
-method operations on the parents of the widget. This is the second premise
-for the widgets sensitivity. Once it has <literal>gtk.SENSITIVE</literal>
-and <literal>gtk.PARENT_SENSITIVE</literal> set, its state is effectively
-sensitive.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CAN_FOCUS</literal></term>
- <listitem>
- <simpara>Determines if a widget is able to handle focus
- grabs.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.HAS_FOCUS</literal></term>
- <listitem>
- <simpara>Set by the <link
-linkend="method-gtkwidget--grab-focus"><methodname>gtk.Widget.grab_focus</methodname>()</link>
-method for widgets that also have <literal>gtk.CAN_FOCUS</literal> set. The
-flag will be unset once another widget grabs the focus.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CAN_DEFAULT</literal></term>
- <listitem>
- <simpara>The widget is allowed to receive the default action via
-the <link
-linkend="method-gtkwidget--grab-default"><methodname>gtk.Widget.grab_default</methodname>()</link>
-method.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.HAS_DEFAULT</literal></term>
- <listitem>
- <simpara>The widget currently is receiving the default
- action.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.HAS_GRAB</literal></term>
- <listitem>
- <simpara>Set by the <link
-linkend="method-gtkwidget--grab-add"><methodname>gtk.Widget.grab_add</methodname>()</link>
-method, unset by the <link
-linkend="method-gtkwidget--grab-remove"><methodname>gtk.Widget.grab_remove</methodname>()</link>
-method. It means that the widget is in the grab_widgets stack, and will be
-the preferred one for receiving events other than ones of cosmetic
-value.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_STYLE</literal></term>
- <listitem>
- <simpara> Indicates that the widgets style has been looked up
-through the rc mechanism. It does not imply that the widget actually had a
-style defined through the rc mechanism.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.COMPOSITE_CHILD</literal></term>
- <listitem>
- <simpara>Indicates that the widget is a composite child of its
-parent; see the <link
-linkend="function-gtk--widget-push-composite-child"><function>gtk.widget_push_composite_child</function>()</link>
-and <link
-linkend="function-gtk--widget-pop-composite-child"><function>gtk.widget_pop_composite_child</function>()</link>
-functions.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.NO_REPARENT</literal></term>
- <listitem>
- <simpara>Unused.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.APP_PAINTABLE</literal></term>
- <listitem>
- <simpara>Set and unset by the <link
-linkend="method-gtkwidget--set-app-paintable"><methodname>gtk.Widget.set_app_paintable</methodname>()</link>
-method. Must be set on widgets whose window the application directly draws
-on, in order to keep PyGTK and GTK+ from overwriting the drawn
-stuff.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RECEIVES_DEFAULT</literal></term>
- <listitem>
- <simpara>The widget when focused will receive the default action
-and have <literal>gtk.HAS_DEFAULT</literal> set even if there is a different
-widget set as default.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DOUBLE_BUFFERED</literal></term>
- <listitem>
- <simpara>Set and unset by the <link
-linkend="method-gtkwidget--set-double-buffered"><methodname>gtk.Widget.set_double_buffered</methodname>()</link>
-method. Indicates that exposes done on the widget should be
-double-buffered.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.NO_SHOW_ALL</literal></term>
- <listitem>
- <simpara>If <literal>True</literal>, the <link
-linkend="method-gtkwidget--show-all"><methodname>show_all</methodname>()</link>
-and <link
-linkend="method-gtkwidget--hide-all"><methodname>hide_all</methodname>()</link>
-methods do not affect the widget.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-widget-help-type-constants">
- <title id="gtk-widget-help-type-constants-title">GTK Widget Help Type Constants</title>
-
- <para>The Widget Help Type constants specify the help type of the
-widget.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.WIDGET_HELP_TOOLTIP</literal></term>
- <listitem>
- <simpara>Tooltip help.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.WIDGET_HELP_WHATS_THIS</literal></term>
- <listitem>
- <simpara>What's this help.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-window-position-constants">
- <title id="gtk-window-position-constants-title">GTK Window Position Constants</title>
-
- <para>The Window Position constants specify hints for initial window
-placement.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.WIN_POS_NONE</literal></term>
- <listitem>
- <simpara>No influence is made on placement.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.WIN_POS_CENTER</literal></term>
- <listitem>
- <simpara>Windows should be placed in the center of the screen.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.WIN_POS_MOUSE</literal></term>
- <listitem>
- <simpara>Windows should be placed at the current mouse position.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.WIN_POS_CENTER_ALWAYS</literal></term>
- <listitem>
- <simpara>Keep window centered as it changes size, etc.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.WIN_POS_CENTER_ON_PARENT</literal></term>
- <listitem>
- <simpara>Center the window on its transient parent (see the
- <link
- linkend="method-gtkwindow--set-transient-for"><methodname>gtk.Window.set_transient_for</methodname>()</link>)
- method.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-window-type-constants">
- <title id="gtk-window-type-constants-title">GTK Window Type Constants</title>
-
- <para>The Window Type constants specify the type of a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>. Most
-things you'd consider a "window" should have type
-<literal>gtk.WINDOW_TOPLEVEL</literal>; windows with this type are managed
-by the window manager and have a frame by default (call the <link
-linkend="method-gtkwindow--set-decorated"><methodname>set_decorated</methodname>()</link>
-method to toggle the frame). Windows with type
-<literal>gtk.WINDOW_POPUP</literal> are ignored by the window manager;
-window manager keybindings won't work on them, the window manager won't
-decorate the window with a frame, many GTK+ features that rely on the window
-manager will not work (e.g. resize grips and
-maximization/minimization). <literal>gtk.WINDOW_POPUP</literal> is used to
-implement widgets such as <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> or tooltips
-that you normally don't think of as windows per se. Nearly all windows
-should be <literal>gtk.WINDOW_TOPLEVEL</literal>. In particular, do not use
-<literal>gtk.WINDOW_POPUP</literal> just to turn off the window borders; use
-the <link
-linkend="method-gtkwindow--set-decorated"><methodname>gtk.Window.set_decorated</methodname>()</link>
-method for that.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.WINDOW_TOPLEVEL</literal></term>
- <listitem>
- <simpara>A regular window, such as a dialog.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.WINDOW_POPUP</literal></term>
- <listitem>
- <simpara>A special window such as a tooltip.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="gtk-wrap-mode-constants">
- <title id="gtk-wrap-mode-constants-title">GTK Wrap Mode Constants</title>
-
- <para>The Wrap Mode constants specify the type of line wrapping in a
-<link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.WRAP_NONE</literal></term>
- <listitem>
- <simpara>Do not wrap lines - just make the text area
-wider</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.WRAP_CHAR</literal></term>
- <listitem>
- <simpara>Wrap text, breaking lines anywhere the cursor can
-appear (usually between characters)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.WRAP_WORD</literal></term>
- <listitem>
- <simpara>Wrap text, breaking lines in between words</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.WRAP_WORD_CHAR</literal></term>
- <listitem>
- <simpara>Wrap text, breaking lines in between words, or if that
-is not enough, also between graphemes.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtk-functions.xml b/docs/reference/pygtk-gtk-functions.xml
deleted file mode 100644
index 728778fa..00000000
--- a/docs/reference/pygtk-gtk-functions.xml
+++ /dev/null
@@ -1,1386 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="gtk-functions">
- <refnamediv>
- <refname>gtk Functions</refname>
- <refpurpose>miscellaneous functions</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <refsect2>
- <title><link linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--about-dialog-set-email-hook">gtk.about_dialog_set_email_hook</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--about-dialog-set-url-hook">gtk.about_dialog_set_url_hook</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-valid">gtk.accelerator_valid</link></methodname>
- <methodparam><parameter role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter role="keyword">modifiers</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-parse">gtk.accelerator_parse</link></methodname>
- <methodparam><parameter role="keyword">accelerator</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-name">gtk.accelerator_name</link></methodname>
- <methodparam><parameter role="keyword">accelerator_key</parameter></methodparam>
- <methodparam><parameter role="keyword">accelerator_mods</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-set-default-mod-mask">gtk.accelerator_set_default_mod_mask</link></methodname>
- <methodparam><parameter role="keyword">default_mod_mask</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-get-default-mod-mask">gtk.accelerator_get_default_mod_mask</link></methodname>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-get-label">gtk.accelerator_get_label</link></methodname>
- <methodparam><parameter role="keyword">accelerator_key</parameter></methodparam>
- <methodparam><parameter role="keyword">accelerator_mods</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-groups-from-object">gtk.accel_groups_from_object</link></methodname>
- <methodparam><parameter>object</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkaccelmap"><classname>gtk.AccelMap</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-add-entry">gtk.accel_map_add_entry</link></methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- <methodparam><parameter role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter role="keyword">accel_mods</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-change-entry">gtk.accel_map_lookup_entry</link></methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-change-entry">gtk.accel_map_change_entry</link></methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- <methodparam><parameter role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter role="keyword">accel_mods</parameter></methodparam>
- <methodparam><parameter role="keyword">replace</parameter></methodparam> </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--accel-map-foreach">gtk.accel_map_foreach</link></methodname>
- <methodparam><parameter role="keyword">foreach_func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--accel-map-foreach-unfiltered">gtk.accel_map_foreach_unfiltered</link></methodname>
- <methodparam><parameter role="keyword">foreach_func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--accel-map-get">gtk.accel_map_get</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-load">gtk.accel_map_load</link></methodname>
- <methodparam><parameter role="keyword">file_name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-save">gtk.accel_map_save</link></methodname>
- <methodparam><parameter role="keyword">file_name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-load-fd">gtk.accel_map_load_fd</link></methodname>
- <methodparam><parameter role="keyword">fd</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-save-fd">gtk.accel_map_save_fd</link></methodname>
- <methodparam><parameter role="keyword">fd</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-lock-path">gtk.accel_map_lock_path</link></methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-unlock-path">gtk.accel_map_unlock_path</link></methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-add-filter">gtk.accel_map_add_filter</link></methodname>
- <methodparam><parameter role="keyword">filter_pattern</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkcellview"><classname>gtk.CellView</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--cell-view-new-with-text">gtk.cell_view_new_with_text</link></methodname>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--cell-view-new-with-markup">gtk.cell_view_new_with_markup</link></methodname>
- <methodparam><parameter role="keyword">markup</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--cell-view-new-with-pixbuf">gtk.cell_view_new_with_pixbuf</link></methodname>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--clipboard-get">gtk.clipboard_get</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--color-selection-palette-from-string">gtk.color_selection_palette_from_string</link></methodname>
- <methodparam><parameter role="keyword">str</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--color-selection-palette-to-string">gtk.color_selection_palette_to_string</link></methodname>
- <methodparam><parameter role="keyword">colors</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--combo-box-new-text">gtk.combo_box_new_text</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--combo-box-entry-new-text">gtk.combo_box_entry_new_text</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkcomboboxentry"><classname>gtk.Container</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--container-class-install-child-property">gtk.container_class_install_child_property</link></methodname>
- <methodparam><parameter role="keyword">klass</parameter></methodparam>
- <methodparam><parameter role="keyword">property_id</parameter></methodparam>
- <methodparam><parameter role="keyword">pspec</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--container-class-list-child-properties">gtk.container_class_list_child_properties</link></methodname>
- <methodparam><parameter role="keyword">klass</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk- -alternative-dialog-button-order">gtk.alternative_dialog_button_order</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkexpander"><classname>gtk.Expander</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--expander-new-with-mnemonic">gtk.expander_new_with_mnemonic</link></methodname>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkiconfactory"><classname>gtk.IconFactory</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-factory-lookup-default">gtk.icon_factory_lookup_default</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter>
- </methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-lookup">gtk.icon_size_lookup</link></methodname>
- <methodparam><parameter
- role="keyword">icon_size</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-lookup-for-settings">gtk.icon_size_lookup_for_settings</link></methodname>
- <methodparam><parameter
- role="keyword">settings</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon_size</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-register">gtk.icon_size_register</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-register-alias">gtk.icon_size_register_alias</link></methodname>
- <methodparam><parameter
- role="keyword">alias</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-from-name">gtk.icon_size_from_name</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-get-name">gtk.icon_size_get_name</link></methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--icon-theme-get-default">gtk.icon_theme_get_default</link></methodname>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--icon-theme-get-for-screen">gtk.icon_theme_get_for_screen</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--icon-theme-add-builtin-icon">gtk.icon_theme_add_builtin_icon</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkimage"><classname>gtk.Image</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--image-new-from-stock">gtk.image_new_from_stock</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--image-new-from-icon-set">gtk.image_new_from_icon_set</link></methodname>
- <methodparam><parameter role="keyword">icon_set</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--image-new-from-animation">gtk.image_new_from_animation</link></methodname>
- <methodparam><parameter role="keyword">animation</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--image-new-from-animation">gtk.image_new_from_icon_name</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--item-factory-from-widget">gtk.item_factory_from_widget</link></methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--item-factory-path-from-widget">gtk.item_factory_path_from_widget</link></methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--link-button-set-uri-hook">gtk.link_button_set_uri_hook</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkobject"><classname>gtk.Object</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--bindings-activate">gtk.bindings_activate</link></methodname>
- <methodparam><parameter
- role="keyword">object</parameter></methodparam>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">modifiers</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--bindings-activate">gtk.bindings_activate_event</link></methodname>
- <methodparam><parameter
- role="keyword">object</parameter></methodparam>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--binding-entry-add-signal">gtk.binding_entry_add_signal</link></methodname>
- <methodparam><parameter>object</parameter></methodparam>
- <methodparam><parameter>keyval</parameter></methodparam>
- <methodparam><parameter>modifiers</parameter></methodparam>
- <methodparam><parameter>signal_name</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--binding-entry-remove">gtk.binding_entry_remove</link></methodname>
- <methodparam><parameter
- role="keyword">class_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">modifiers</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--paper-size-new-from-ppd">gtk.paper_size_new_from_ppd</link></methodname>
- <methodparam><parameter role="keyword">ppd_name</parameter></methodparam>
- <methodparam><parameter role="keyword">ppd_display_name</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--paper-size-new-custom">gtk.paper_size_new_cutom</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">display_name</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--paper-size-get-default">gtk.paper_size_get_default</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkplug"><classname>gtk.Plug</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--plug-new-for-display">gtk.plug_new_for_display</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam> <methodparam><parameter role="keyword">socket_id</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkrcstyle"><classname>gtk.RcStyle</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-add-default-file">gtk.rc_add_default_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-set-default-files">gtk.rc_set_default_files</link></methodname>
- <methodparam><parameter role="keyword">filenames</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-default-files">gtk.rc_get_default_files</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-style-by-paths">gtk.rc_get_style_by_paths</link></methodname>
- <methodparam><parameter role="keyword">settings</parameter></methodparam>
- <methodparam><parameter role="keyword">widget_path</parameter></methodparam> <methodparam><parameter role="keyword">class_path</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-reparse-all-for-settings">gtk.rc_reparse_all_for_settings</link></methodname>
- <methodparam><parameter role="keyword">settings</parameter></methodparam>
- <methodparam><parameter role="keyword">force_load</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-reset-styles">gtk.rc_reset_styles</link></methodname>
- <methodparam><parameter role="keyword">settings</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-parse">gtk.rc_parse</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-parse-string">gtk.rc_parse_string</link></methodname>
- <methodparam><parameter role="keyword">rc_string</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-reparse-all">gtk.rc_reparse_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-find-module-in-path">gtk.rc_find_module_in_path</link></methodname>
- <methodparam><parameter role="keyword">module_file</parameter></methodparam> </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-theme-dir">gtk.rc_get_theme_dir</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-module-dir">gtk.rc_get_module_dir</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-im-module-path">gtk.rc_get_im_module_path</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-im-module-file">gtk.rc_get_im_module_file</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--recent-manager-get-default">gtk.recent_manager_get_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--recent-manager-get-for-screen">gtk.recent_manager_get_for_screen</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--selection-owner-set-for-display">gtk.selection_owner_set_for_display</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- <methodparam><parameter role="keyword">selection</parameter></methodparam>
- <methodparam><parameter role="keyword">time</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--target-list-add-image-targets">gtk.target_list_add_image_targets</link></methodname>
- <methodparam><parameter role="keyword">list</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">info</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">writable</parameter><initializer>False</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--target-list-add-text-targets">gtk.target_list_add_text_targets</link></methodname>
- <methodparam><parameter role="keyword">list</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">info</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--target-list-add-uri-targets">gtk.target_list_add_uri_targets</link></methodname>
- <methodparam><parameter role="keyword">list</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">info</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtksettings"><classname>gtk.Settings</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--settings-get-default">gtk.settings_get_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--settings-get-for-screen">gtk.settings_get_for_screen</link></methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--status-icon-new-from-pixbuf">gtk.status_icon_new_from_pixbuf</link></methodname>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--status-icon-new-from-file">gtk.status_icon_new_from_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--status-icon-new-from-stock">gtk.status_icon_new_from_stock</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--status-icon-new-from-icon-name">gtk.status_icon_new_from_icon_name</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--status-icon-position-menu">gtk.status_icon_position_menu</link></methodname>
- <methodparam><parameter>menu</parameter></methodparam>
- <methodparam><parameter>statusicon</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--tooltips-data-get">gtk.tooltips_data_get</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--tree-row-reference-inserted">gtk.tree_row_reference_inserted</link></methodname>
- <methodparam><parameter
- role="keyword">proxy</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--tree-row-reference-deleted">gtk.tree_row_reference_deleted</link></methodname>
- <methodparam><parameter
- role="keyword">proxy</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-push-colormap">gtk.widget_push_colormap</link></methodname>
- <methodparam><parameter role="keyword">cmap</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-push-composite-child">gtk.widget_push_composite_child</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-pop-composite-child">gtk.widget_pop_composite_child</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-pop-colormap">gtk.widget_pop_colormap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-get-default-style">gtk.widget_get_default_style</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-set-default-colormap">gtk.widget_set_default_colormap</link></methodname>
- <methodparam><parameter role="keyword">colormap</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-get-default-colormap">gtk.widget_get_default_colormap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-get-default-visual">gtk.widget_get_default_visual</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-set-default-direction">gtk.widget_set_default_direction</link></methodname>
- <methodparam><parameter role="keyword">dir</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-get-default-direction">gtk.widget_get_default_direction</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-class-list-style-properties">gtk.widget_class_list_style_properties</link></methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-class-install-style-property">gtk.widget_class_install_style_property</link></methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- <methodparam><parameter role="keyword">pspec</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-gtkwindow"><classname>gtk.Window</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--window-set-default-icon">gtk.window_set_default_icon</link></methodname>
- <methodparam><parameter role="keyword">icon</parameter></methodparam> </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--window-set-default-icon-from-file">gtk.window_set_default_icon_from_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam> </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--window-set-default-icon-list">gtk.window_set_default_icon_list</link></methodname>
- <methodparam><parameter>...</parameter></methodparam> </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--window-get-default-icon-list">gtk.window_get_default_icon_list</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--window-set-auto-startup-notification">gtk.window_set_auto_startup_notification</link></methodname>
- <methodparam><parameter role="keyword">setting</parameter></methodparam> </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--window-list-toplevels">gtk.window_list_toplevels</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--window-set-default-icon-name">gtk.window_set_default_icon_name</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="gtk-stock-items">Stock Item</link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--stock-add">gtk.stock_add</link></methodname>
- <methodparam><parameter role="keyword">items</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--stock-lookup">gtk.stock_lookup</link></methodname>
- <methodparam><parameter>stock_id</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--stock-list-ids">gtk.stock_list_ids</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title>Miscellaneous Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--check-version">gtk.check_version</link></methodname>
- <methodparam><parameter
- role="keyword">required_major</parameter></methodparam>
- <methodparam><parameter
- role="keyword">required_minor</parameter></methodparam>
- <methodparam><parameter
- role="keyword">required_micro</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--draw-insertion-cursor">gtk.draw_insertion_cursor</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">location</parameter></methodparam>
- <methodparam><parameter
- role="keyword">is_primary</parameter></methodparam>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- <methodparam><parameter
- role="keyword">draw_arrow</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--get-default-language">gtk.get_default_language</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--events-pending">gtk.events_pending</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--main-do-event">gtk.main_do_event</link></methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--main">gtk.main</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--main-level">gtk.main_level</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--main-quit">gtk.main_quit</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--main-iteration">gtk.main_iteration</link></methodname>
- <methodparam><parameter
- role="keyword">block</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--main-iteration-do">gtk.main_iteration_do</link></methodname>
- <methodparam><parameter
- role="keyword">block</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--grab-get-current">gtk.grab_get_current</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--quit-add">gtk.quit_add</link></methodname>
- <methodparam><parameter>level</parameter></methodparam>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--quit-remove">gtk.quit_remove</link></methodname>
- <methodparam><parameter
- role="keyword">quit_handler_id</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--get-current-event">gtk.get_current_event</link></methodname>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--get-current-event-state">gtk.get_current_event_state</link></methodname>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--get-current-event-time">gtk.get_current_event_time</link></methodname>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--init-check">gtk.init_check</link></methodname>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>All <literal>PyGTK</literal> functions for the gtk module are
-listed above categorized by class. Those functions associated with a class
-have their descriptions included with the class reference. Those functions
-that are not associated with a specific class are described below.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--check-version">
- <title>gtk.check_version</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.check_version</methodname>
- <methodparam><parameter
- role="keyword">required_major</parameter></methodparam>
- <methodparam><parameter
- role="keyword">required_minor</parameter></methodparam>
- <methodparam><parameter
- role="keyword">required_micro</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">required_major</parameter>&nbsp;:</term>
- <listitem><simpara>the required major version
-number</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">required_minor</parameter>&nbsp;:</term>
- <listitem><simpara>the required minor version
-number</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">required_micro</parameter>&nbsp;:</term>
- <listitem><simpara>the required micro version
-number</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>None</literal> if the underlying
-<literal>GTK+</literal> library is compatible or a string describing the
-mismatch</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.check_version</function>() function checks the
-underlying <literal>GTK+</literal> library version against the version
-specified by <parameter>required_major</parameter>,
-<parameter>required_minor</parameter> and
-<parameter>required_micro</parameter>. If the library is compatible this
-function returns <literal>None</literal>; otherwise it returns a string
-describing the mismatch.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--draw-insertion-cursor">
- <title>gtk.draw_insertion_cursor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.draw_insertion_cursor</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">drawable</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">location</parameter></methodparam>
- <methodparam><parameter
- role="keyword">is_primary</parameter></methodparam>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- <methodparam><parameter
- role="keyword">draw_arrow</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">drawable</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>the rectangle to which the output is clipped, or
-<literal>None</literal> if the output should not be clipped</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">location</parameter>&nbsp;:</term>
- <listitem><simpara>the location to draw the cursor
- (<parameter>location.width</parameter> is
- ignored)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">is_primary</parameter>&nbsp;:</term>
- <listitem><simpara> if <literal>True</literal> the cursor should
- be the primary cursor color.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">direction</parameter>&nbsp;:</term>
- <listitem><simpara>the direction of the cursor; either
- <literal>gtk.TEXT_DIR_LTR</literal> or
- <literal>gtk.TEXT_DIR_RTL</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">draw_arrow</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> draw a directional
- arrow on the cursor. Should be <literal>False</literal> unless the
- cursor is split.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.draw_insertion_cursor</function>() function
-draws a text caret on the <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-specified by <parameter>drawable</parameter> at the position specified by
-<parameter>location</parameter>. <parameter>area</parameter> specifies a
-clipping rectangle or is <literal>None</literal> if the output should not be
-clipped. If <parameter>is_primary</parameter> is <literal>True</literal> the
-cursor should be the primary cursor color. <parameter>direction</parameter>
-specifies whether the cursor is right-to-left or left-to-right. This is a
-convenience function for drawing the standard cursor shape.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--get-default-language">
- <title>gtk.get_default_language</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.get_default_language</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-object for the default language</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.get_default_language</function>() function
-returns a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-describing the default language.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--events-pending">
- <title>gtk.events_pending</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.events_pending</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if any events are
-pending</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.events_pending</function>() function returns
-<literal>True</literal> if any events are pending. This can be used to
-update the user interface and invoke timeouts etc. while doing some time
-intensive computation.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--main-do-event">
- <title>gtk.main_do_event</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.main_do_event</methodname>
- <methodparam><parameter
- role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> to
-process</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.main_do_event</function>() function processes
-a single <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>. This
-function is public only to allow filtering of events between
-<literal>GDK</literal> and <literal>GTK+</literal>. You will not usually
-need to call this function directly. While you should not call this function
-directly, you might want to know how exactly events are handled. So here is
-what this function does with the event:</para>
-
- <orderedlist>
- <listitem>
- <simpara>Compress enter/leave notify events. If the event passed
-builds an enter-leave pair together with the next event (peeked from
-<literal>GDK</literal>) both events are thrown away. This is to avoid a
-backlog of (de-)highlighting widgets crossed by the pointer.</simpara>
- </listitem>
- <listitem>
- <simpara>Find the widget which got the event. If the widget can't
-be determined the event is thrown away unless it belongs to a
-<literal>INCR</literal> transaction. In that case it is passed to
-<function>gtk_selection_incr_event</function>().</simpara>
- </listitem>
- <listitem>
- <simpara>Then the event is passed on a stack so you can query the
-currently handled event with <link
-linkend="function-gtk--get-current-event"><function>gtk.get_current_event</function>()</link>.</simpara>
- </listitem>
- <listitem>
- <simpara>The event is sent to a widget. If a grab is active all
-events for widgets that are not in the contained in the grab widget are sent
-to the latter with a few exceptions:</simpara>
- <itemizedlist>
- <listitem>
- <simpara>Deletion and destruction events are still sent to the
-event widget for obvious reasons. </simpara>
- </listitem>
- <listitem>
- <simpara>Events which directly relate to the visual
-representation of the event widget. </simpara>
- </listitem>
- <listitem>
- <simpara>Leave events are delivered to the event widget if
-there was an enter event delivered to it before without the paired leave
-event. </simpara>
- </listitem>
- <listitem>
- <simpara>Drag events are not redirected because it is unclear
-what the semantics of that would be. </simpara>
- </listitem>
- </itemizedlist>
- <simpara>Another point of interest might be that all key events
-are first passed through the key snooper functions if there are any. Read
-the description of <function>gtk_key_snooper_install</function>() if you
-need this feature.</simpara>
- </listitem>
- <listitem>
- <simpara>After finishing the delivery the event is popped from the
-event stack. </simpara>
- </listitem>
- </orderedlist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--main">
- <title>gtk.main</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.main</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.main</function>() function runs the main loop
-until the <link
-linkend="function-gtk--main-quit"><function>gtk.main_quit</function>()</link>
-function is called. You can nest calls to <function>gtk.main</function>().
-In that case the call to the <link
-linkend="function-gtk--main-quit"><function>gtk.main_quit</function>()</link>
-function will make the innermost invocation of the main loop return.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--main-level">
- <title>gtk.main_level</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.main_level</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the nesting level of the current invocation of
-the main loop</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.main_level</function>() function returns the
-current nesting level of the main loop. The nesting level is increased by
-calling the <link
-linkend="function-gtk--main"><function>gtk.main</function>()</link> function
-and reduced by calling the <link
-linkend="function-gtk--main-quit"><function>gtk.main_quit</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--main-quit">
- <title>gtk.main_quit</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.main_quit</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.main_quit</function>() function terminates the
-current main loop level started by the most recent call to the <link
-linkend="function-gtk--main"><function>gtk.main</function>()</link>
-function. The nesting level of the main loop is reduced by calling this
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--main-iteration">
- <title>gtk.main_iteration</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.main_iteration</methodname>
- <methodparam><parameter
- role="keyword">block</parameter>
- <initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">block</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> block if no events
-are pending</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the <link
-linkend="function-gtk--main-quit"><function>gtk.main_quit</function>()</link>
-function has been called for the innermost main loop.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.main_iteration</function>() function runs a
-single iteration of the mainloop. If no events are waiting to be processed
-<literal>PyGTK</literal> will block until the next event is noticed if
-<parameter>block</parameter> is <literal>True</literal>. This function is
-identical to the <link
-linkend="function-gtk--main-iteration-do"><function>gtk.main_iteration_do</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--main-iteration-do">
- <title>gtk.main_iteration_do</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.main_iteration_do</methodname>
- <methodparam><parameter
- role="keyword">block</parameter>
- <initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">block</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> block if no events
-are pending</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the <link
-linkend="function-gtk--main-quit"><function>gtk.main_quit</function>()</link>
-function has been called for the innermost main loop.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.main_iteration_do</function>() function runs a
-single iteration of the main loop. If <parameter>block</parameter> is
-<literal>True</literal> block until an event occurs. This function is
-identical to the <link
-linkend="function-gtk--main-iteration"><function>gtk.main_iteration</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--grab-get-current">
- <title>gtk.grab_get_current</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.grab_get_current</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> that has
-the grab currently or <literal>None</literal> if no grab is
-active</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.grab_get_current</function>() function returns
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-that has the grab or <literal>None</literal> if no grab is active.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--quit-add">
- <title>gtk.quit_add</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.quit_add</methodname>
- <methodparam><parameter>level</parameter></methodparam>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">level</parameter>&nbsp;:</term>
- <listitem><simpara>the level at which termination
-<parameter>func</parameter> shall be called. You can pass 0 here to have
-<parameter>func</parameter> run at the termination of the current main
-loop.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>the function to call - it should return 0 to be
-removed from the list of quit handlers</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">...</parameter>&nbsp;:</term>
- <listitem><simpara>optional parameter(s) to be passed to
-<parameter>func</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a handle for this quit handler (you need this
-for the <link
-linkend="function-gtk--quit-remove"><function>gtk.quit_remove</function>()</link>
-function).</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.quit_add</function>() function registers a
-function specified by <parameter>func</parameter> to be called when the
-specified main loop <parameter>level</parameter> is exited.
-<parameter>func</parameter> should return 0 to be removed from the list of
-quit handlers. This function returns a handler ID that is used when removing
-the handler with the <link
-linkend="function-gtk--quit-remove"><function>gtk.quit_remove</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--quit-remove">
- <title>gtk.quit_remove</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.quit_remove</methodname>
- <methodparam><parameter
- role="keyword">quit_handler_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">quit_handler_id</parameter>&nbsp;:</term>
- <listitem><simpara>the ID of a quit handler</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.quit_remove</function>() function removes the
-quit handler specified by <parameter>quit_handler_id</parameter> from the
-list of quit handlers.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--get-current-event">
- <title>gtk.get_current_event</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.get_current_event</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the current event or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.get_current_event</function>() function
-returns a copy of the event currently being processed by GTK+. For example,
-if you get a "clicked" signal from <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link>, the
-current event will be the GdkEventButton that triggered the "clicked"
-signal. If there is no current event, the function returns
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--get-current-event-state">
- <title>gtk.get_current_event_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.get_current_event_state</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the state of the current event if any or
-<literal>None</literal> if there is no current event or
-state</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.get_current_event_state</function>() function
-returns the state of the current event or <literal>None</literal> if there
-is no current event or state.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--get-current-event-time">
- <title>gtk.get_current_event_time</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.get_current_event_time</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the timestamp of the current event or
-0L</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.get_current_event_time</function>() function
-returns the timestamp from the current event or 0L if there is no current
-event.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--init-check">
- <title>gtk.init_check</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.init_check</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if GTK has been
- successfully initialized</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.init_check</function>() function tries to
- initialize GTK and returns <literal>True</literal> if
- successful.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--remove-log-handlers">
- <title>gtk.remove_log_handlers</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.remove_log_handlers</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <function>gtk.remove_log_handlers</function>() function
- removes the default PyGTK log handlers,</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--add-log-handlers">
- <title>gtk.add_log_handlers</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.add_log_handlers</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <function>gtk.add_log_handlers</function>() function
- installs the default PyGTK log handlers,</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtk-stock-items.xml b/docs/reference/pygtk-gtk-stock-items.xml
deleted file mode 100644
index e68128f8..00000000
--- a/docs/reference/pygtk-gtk-stock-items.xml
+++ /dev/null
@@ -1,1205 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="gtk-stock-items">
- <refnamediv>
- <refname>Stock Items</refname>
- <refpurpose>prebuilt common menu/toolbar items and corresponding
-icons</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--stock-add">gtk.stock_add</link></methodname>
- <methodparam><parameter role="keyword">items</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--stock-lookup">gtk.stock_lookup</link></methodname>
- <methodparam><parameter>stock_id</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--stock-list-ids">gtk.stock_list_ids</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>Stock items represent commonly-used menu or toolbar items such as
-"Open" or "Exit". Each stock item is identified by a stock ID; stock IDs are
-just strings, but macros such as <literal>gtk.STOCK_OPEN</literal> are
-provided to avoid typing mistakes in the strings. Applications can register
-their own stock items in addition to those built-in to
-<literal>PyGTK</literal>.</para>
-
- <para>The stock items are:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.STOCK_ABOUT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_about_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_ADD</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_add_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_APPLY</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_apply_20.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_BOLD</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_text_bold_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_CANCEL</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_cancel_20.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_CDROM</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_cdrom_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_CLEAR</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_clear_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_CLOSE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_close_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_COLOR_PICKER</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_color_picker_25.png"
- format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.2 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_CONVERT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_convert_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_CONNECT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_connect_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_COPY</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_copy_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_CUT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_cut_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_DELETE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_trash_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_DIALOG_AUTHENTICATION</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_dialog_authentication_48.png"
- format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.4 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_DIALOG_ERROR</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_dialog_error_48.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_DIALOG_INFO</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_dialog_info_48.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_DIALOG_QUESTION</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_dialog_question_48.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_DIALOG_WARNING</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_dialog_warning_48.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_DIRECTORY</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_directory_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_DISCONNECT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_disconnect_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_DND</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_dnd_32.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_DND_MULTIPLE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_dnd_multiple_32.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_EDIT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_edit_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_EXECUTE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_exec_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_FILE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_file_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_FIND</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_search_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_FIND_AND_REPLACE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_search_replace_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_FLOPPY</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_save_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_FULLSCREEN</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_fullscreen_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.8 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_GOTO_BOTTOM</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_bottom_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_GOTO_FIRST</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_first_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_GOTO_LAST</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_last_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_GOTO_TOP</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_top_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_GO_BACK</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_left_arrow_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_GO_DOWN</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_down_arrow_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_GO_FORWARD</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_right_arrow_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_GO_UP</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_up_arrow_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_HARDDISK</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_harddisk_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.4 and above</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_HELP</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_help_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_HOME</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_home_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_INDENT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_text_indent_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.4 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_INDEX</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_index_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_INFO</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_info_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.8 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_ITALIC</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_text_italic_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_JUMP_TO</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_jump_to_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> RTL version is <inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_jump_to_rtl_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_JUSTIFY_CENTER</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_align_center_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_JUSTIFY_FILL</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_align_justify_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_JUSTIFY_LEFT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_align_left_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_JUSTIFY_RIGHT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_align_right_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_LEAVE_FULLSCREEN</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_leave_fullscreen_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.8 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_MEDIA_FORWARD</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_media_forward_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_MEDIA_NEXT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_media_next_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_MEDIA_PAUSE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_media_pause_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_MEDIA_PLAY</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_media_play_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> RTL version is <inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_media_play_rtl_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_MEDIA_PREVIOUS</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_media_previous_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_MEDIA_RECORD</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_media_record_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_MEDIA_REWIND</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_media_rewind_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_MEDIA_STOP</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_media_stop_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.6 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_MISSING_IMAGE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_broken_image_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_NETWORK</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_network_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject>
-Available in GTK+ 2.4 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_NEW</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_new_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_NO</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_no_20.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_OK</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_ok_20.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_OPEN</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_open_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_PASTE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_paste_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_PREFERENCES</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_preferences_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_PRINT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_print_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_PRINT_PREVIEW</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_print_preview_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_PROPERTIES</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_properties_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_QUIT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_exit_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_REDO</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_redo_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> RTL version is <inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_redo_rtl_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_REFRESH</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_refresh_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_REMOVE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_remove_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_REVERT_TO_SAVED</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_revert_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> RTL version is <inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_revert_rtl_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_SAVE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_save_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_SAVE_AS</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_save_as_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_SELECT_COLOR</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_colorselector_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_SELECT_FONT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_font_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_SORT_ASCENDING</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_sort_ascending_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_SORT_DESCENDING</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_sort_descending_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_SPELL_CHECK</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_spellcheck_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_STOP</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_stop_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_STRIKETHROUGH</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_text_strikethrough_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_UNDELETE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_undelete_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> RTL version is <inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_undelete_rtl_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_UNDERLINE</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_text_underline_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_UNDO</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_undo_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> RTL version is <inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_undo_rtl_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_UNINDENT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_text_unindent_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject> Available in GTK+ 2.4 and above.</simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_YES</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_yes_20.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_ZOOM_100</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_zoom_1_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_ZOOM_FIT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_zoom_fit_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_ZOOM_IN</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_zoom_in_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>gtk.STOCK_ZOOM_OUT</literal></term>
- <listitem>
- <simpara><inlinemediaobject>
- <imageobject>
- <imagedata fileref="icons/stock_zoom_out_24.png" format="png"/>
- </imageobject>
- </inlinemediaobject></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--stock-add">
- <title>gtk.stock_add</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.stock_add</methodname>
- <methodparam><parameter
- role="keyword">items</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">items</parameter>&nbsp;:</term>
- <listitem><simpara>a list or tuple containing 5-tuples of stock
- items</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.stock_add</function>() function registers each
-of the stock items in the list or tuple specified by
-<parameter>items</parameter>. The stock items are specified by a 5-tuple
-containing:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>stock_id - a string identifier</simpara>
- </listitem>
- <listitem>
- <simpara>label - a string to use for a label</simpara>
- </listitem>
- <listitem>
- <simpara>modifier - a modifier mask (see the <xref
-linkend="gdk-modifier-constants"
-endterm="gdk-modifier-constants-title"></xref> section for more detail on
-modifiers)</simpara>
- </listitem>
- <listitem>
- <simpara>keyval - an integer key value (see <link
- linkend="class-gdkkeymap"><classname>gtk.gdk.Keymap</classname></link>)
- Together with the modifiers specifies an accelerator.</simpara>
- </listitem>
- <listitem>
- <simpara>translation_domain - a string identifier of a translation
- domain</simpara>
- </listitem>
- </itemizedlist>
-
- <para>If an item already exists with the same stock ID as one of the
-items, the old item gets replaced.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--stock-lookup">
- <title>gtk.stock_lookup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.stock_lookup</methodname>
- <methodparam><parameter>stock_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>a stock item name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 5-tuple containing the stock item info or
- <literal>None</literal> if <parameter>stock_id</parameter> is
- unknown</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.stock_lookup</function>() function looks up
-the stock item identified by <parameter>stock_id</parameter> and returns a
-5-tuple containing its information. If <parameter>stock_id</parameter> is
-not known this function returns <literal>None</literal>. See the <link
-linkend="function-gtk--stock-add"><function>gtk.stock_add</function>()</link>
-function for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--stock-list-ids">
- <title>gtk.stock_list_ids</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.stock_list_ids</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of known stock IDs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.stock_list_ids</function>() function returns a
-list containing all of the known stock IDs added to a <link
-linkend="class-gtkiconfactory"><classname>gtk.IconFactory</classname></link>
-or registered with the <link
-linkend="function-gtk--stock-add"><function>gtk.stock_add</function>()</link>
-function.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkaboutdialog.xml b/docs/reference/pygtk-gtkaboutdialog.xml
deleted file mode 100644
index 9ea36ad8..00000000
--- a/docs/reference/pygtk-gtkaboutdialog.xml
+++ /dev/null
@@ -1,1212 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkaboutdialog">
- <refnamediv>
- <refname>gtk.AboutDialog</refname>
- <refpurpose>popup window displaying information about an
-application (new in PyGTK 2.6)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.AboutDialog</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
-<constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkaboutdialog">gtk.AboutDialog</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-name">get_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-name">set_name</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-version">get_version</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-version">set_version</link></methodname>
- <methodparam><parameter role="keyword">version</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-copyright">get_copyright</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-copyright">set_copyright</link></methodname>
- <methodparam><parameter role="keyword">copyright</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-comments">get_comments</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-comments">set_comments</link></methodname>
- <methodparam><parameter role="keyword">comments</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-license">get_license</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-license">set_license</link></methodname>
- <methodparam><parameter role="keyword">license</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-wrap-license">get_wrap_license</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-wrap-license">set_wrap_license</link></methodname>
- <methodparam><parameter role="keyword">license</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-website">get_website</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-website">set_website</link></methodname>
- <methodparam><parameter role="keyword">website</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-website-label">get_website_label</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-website-label">set_website_label</link></methodname>
- <methodparam><parameter role="keyword">website_label</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-authors">get_authors</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-authors">set_authors</link></methodname>
- <methodparam><parameter role="keyword">authors</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-documenters">get_documenters</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-documenters">set_documenters</link></methodname>
- <methodparam><parameter role="keyword">documenters</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-artists">get_artists</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-artists">set_artists</link></methodname>
- <methodparam><parameter role="keyword">artists</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-translator-credits">get_translator_credits</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-translator-credits">set_translator_credits</link></methodname>
- <methodparam><parameter role="keyword">translator_credits</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-logo">get_logo</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-logo">set_logo</link></methodname>
- <methodparam><parameter role="keyword">logo</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--get-logo-icon-name">get_logo_icon_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="method-gtkaboutdialog--set-logo-icon-name">set_logo_icon_name</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--about-dialog-set-email-hook">gtk.about_dialog_set_email_hook</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--about-dialog-set-url-hook">gtk.about_dialog_set_url_hook</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
- +--<link linkend="class-gtkaboutdialog">gtk.AboutDialog</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkaboutdialog">
- <title>gtk.AboutDialog Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
- <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"artists"</entry>
- <entry>Read-Write</entry>
- <entry>The list of people who have contributed artwork to
-the program.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"authors"</entry>
- <entry>Read-Write</entry>
- <entry>The list of authors of the program.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"comments"</entry>
- <entry>Read-Write</entry>
- <entry>A string containing comments about the program.
-Default value: <literal>None</literal>.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"copyright"</entry>
- <entry>Read-Write</entry>
- <entry>A string containing copyright information for
-the program. Default value: <literal>None</literal>.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"documenters"</entry>
- <entry>Read-Write</entry>
- <entry>The list of people documenting the program.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"license"</entry>
- <entry>Read-Write</entry>
- <entry>A string containing the license of the program.
-Default value: <literal>None</literal>.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"logo"</entry>
- <entry>Read-Write</entry>
- <entry>A logo for the about box. If this is not set,
-it defaults to the default window icon list.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"logo-icon-name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of an icon to use as the logo for the
-about box. Default value: <literal>None</literal>.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the program. If this is not set, it
-defaults to g_get_application_name().
-Default value: <literal>None</literal>.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"translator-credits"</entry>
- <entry>Read-Write</entry>
- <entry>Credits to the translators. This string should be
-marked as translatable. Default value: <literal>None</literal>.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"version"</entry>
- <entry>Read-Write</entry>
- <entry>A string containing the version of the program.
-Default value: <literal>None</literal>.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"website"</entry>
- <entry>Read-Write</entry>
- <entry>The URL for the link to the website of the
-program. Default value: <literal>None</literal>.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"website-label"</entry>
- <entry>Read-Write</entry>
- <entry>The label for the link to the website of the program.
-If this is not set, it defaults to the URL.
-Default value: <literal>None</literal>.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
- <row valign="top">
- <entry>"wrap-license"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the license text should be
-wrapped. Default value: <literal>False</literal>.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkaboutdialog">
- <title>gtk.AboutDialog Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"link-color"</entry>
- <entry>Read</entry>
- <entry>The color of hyperlinks. This property is not available
- in GTK+ 2.10 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkaboutdialog">
- <title>gtk.AboutDialog Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <link
- linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link>
- offers a simple way to display information about a program like its
- logo, name, copyright, website and license. It is also possible to give
- credits to the authors, documenters, translators and artists who have
- worked on the program. An about dialog is typically opened when the user
- selects the <guimenu>Help</guimenu><guimenuitem>About</guimenuitem>
- menu. All parts of the dialog are optional.</para>
-
- <para>About dialog often contain links and email addresses. <link
- linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link>
- supports this by offering global hooks, which are called when the user
- clicks on a link or email address, see the <link
- linkend="function-gtk--about-dialog-set-email-hook"><function>gtk.about_dialog_set_email_hook</function>()</link>
- and <link
- linkend="function-gtk--about-dialog-set-url-hook"><function>gtk.about_dialog_set_url_hook</function>()</link>
- functions. Email addresses in the authors, documenters and artists
- properties are recognized by looking for <literal>&lt;user@<!--
- -->host&gt;</literal>, URLs are recognized by looking for
- <literal>http://url</literal>, with <literal>url</literal> extending to
- the next space, tab or line break.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkaboutdialog">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.AboutDialog</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkdialog"><classname>gtk.AboutDialog</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>Creates a new gtk.AboutDialog with default property values.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkaboutdialog--get-name">
- <title>gtk.AboutDialog.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The program name or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_name</methodname>() method returns the value
-of the "name" property which is the program name displayed in the about
-dialog. <methodname>get_name</methodname>() returns <literal>None</literal>
-if the name is not set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-name">
- <title>gtk.AboutDialog.set_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the program
-name or <literal>None</literal> to use the default name.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_name</methodname>() method sets the "name"
-property to the string contained in <parameter>name</parameter>. The "name"
-property is used as the program name in the about dialog. If
-<parameter>name</parameter> is <literal>None</literal>, it defaults to
-g_get_application_name().</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-version">
- <title>gtk.AboutDialog.get_version</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_version</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The version string or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_version</methodname>() method returns the
-string contained in the "version" property.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-version">
- <title>gtk.AboutDialog.set_version</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_version</methodname>
- <methodparam><parameter
- role="keyword">version</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">version</parameter>&nbsp;:</term>
- <listitem><simpara>the version string or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_version</methodname>() method sets the
-"version" property to the string in <parameter>version</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-copyright">
- <title>gtk.AboutDialog.get_copyright</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_copyright</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the copyright string or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_copyright</methodname>() method returns the
-string contained in the "copyright" property.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-copyright">
- <title>gtk.AboutDialog.set_copyright</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_copyright</methodname>
- <methodparam><parameter
- role="keyword">copyright</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">copyright</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the copyright
-notice or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_copyright</methodname>() method sets the
-"copyright" property to the string contained in
-<parameter>copyright</parameter>. If <parameter>copyright</parameter> is
-<literal>None</literal>, the copyright notice is hidden.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-comments">
- <title>gtk.AboutDialog.get_comments</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_comments</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the
-comments or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_comments</methodname>() method returns the
-string contained in the "comments" property.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-comments">
- <title>gtk.AboutDialog.set_comments</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_comments</methodname>
- <methodparam><parameter
- role="keyword">comments</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">comments</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the
-comments or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_comments</methodname>() method sets the
-"comments" property to the string contained in
-<parameter>comments</parameter>. If <parameter>comments</parameter> is
-<literal>None</literal> the comments label is hidden.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-license">
- <title>gtk.AboutDialog.get_license</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_license</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the license
-information or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_license</methodname>() method returns the
-string contained in the "license" property.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-license">
- <title>gtk.AboutDialog.set_license</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_license</methodname>
- <methodparam><parameter
- role="keyword">license</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">license</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_license</methodname>() method sets the
-"license" property to the string contained in
-<parameter>license</parameter>. If <parameter>license</parameter> is
-<literal>None</literal> the license button is hidden.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-wrap-license">
- <title>gtk.AboutDialog.get_wrap_license</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_wrap_license</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the license text
-should be wrapped</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_wrap_license</methodname>() method returns
-the value of the "wrap-license" property. If "wrap-license" is
-<literal>True</literal> the license text should be automatically
-wrapped.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-wrap-license">
- <title>gtk.AboutDialog.set_wrap_license</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_wrap_license</methodname>
- <methodparam><parameter
- role="keyword">wrap_license</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">wrap_license</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_wrap_license</methodname>() method sets the
-"wrap-license" property to the value of
-<parameter>wrap_license</parameter>. If <parameter>wrap_license</parameter>
-is <literal>True</literal> the license text should be automatically
-wrapped.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-website">
- <title>gtk.AboutDialog.get_website</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_website</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the website URL or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_website</methodname>() method returns the
-string contained in the "website" property. The website should be a
-URL.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-website">
- <title>gtk.AboutDialog.set_website</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_website</methodname>
- <methodparam><parameter
- role="keyword">website</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">website</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the URL of the program's
-website or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_website</methodname>() method sets the
-"website" property to the string contained in
-<parameter>website</parameter>. The string should be a valid URL.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-website-label">
- <title>gtk.AboutDialog.get_website_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_website_label</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the website link
-label</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_website_label</methodname>() method returns
-the contents of the "website_label" property. The website label is used if
-the url hook has been set using the <link
-linkend="function-gtk--about-dialog-set-url-hook"><function>gtk.about_dialog_set_url_hook</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-website-label">
- <title>gtk.AboutDialog.set_website_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_website_label</methodname>
- <methodparam><parameter
- role="keyword">website_label</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">website_label</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_website_label</methodname>() method sets the
-"website_label" property to the string contained in
-<parameter>website_label</parameter> if the url hook has been set using the
-<link
-linkend="function-gtk--about-dialog-set-url-hook"><function>gtk.about_dialog_set_url_hook</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-authors">
- <title>gtk.AboutDialog.get_authors</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_authors</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list containing the names of the program
-authors</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_authors</methodname>() method returns the
-contents of the "authors" property. The "authors" property contains a list
-of the names of the authors of the program.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-authors">
- <title>gtk.AboutDialog.set_authors</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_authors</methodname>
- <methodparam><parameter
- role="keyword">authors</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">authors</parameter>&nbsp;:</term>
- <listitem><simpara>a list containing the names of the program
-authors.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_authors</methodname>() method sets the
-"authors" property to the list contained in
-<parameter>authors</parameter>. The author names are displayed in the
-authors tab of the secondary credits
-dialog. <methodname>set_authors</methodname>() method will show the
-<guibutton>Credits</guibutton> button if it is not displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-documenters">
- <title>gtk.AboutDialog.get_documenters</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_documenters</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the program
-documenters</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_documenters</methodname>() method returns
-the contents of the "documenters" property which contains a list of the
-names of the program documenters.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-documenters">
- <title>gtk.AboutDialog.set_documenters</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_documenters</methodname>
- <methodparam><parameter
- role="keyword">documenters</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">documenters</parameter>&nbsp;:</term>
- <listitem><simpara>a list of the names of the program
-documenters</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_documenters</methodname>() method sets the
-"documenters" property to the contents of
-<parameter>documenters</parameter>. The documenter names are displayed in
-the documenters tab of the secondary credits
-dialog. <methodname>set_documenters</methodname>() method will show the
-<guibutton>Credits</guibutton> button if it is not displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-artists">
- <title>gtk.AboutDialog.get_artists</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_artists</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the names of the program
-artists</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_artists</methodname>() method returns the
-contents of the "artists" property which contains a list of the names of the
-program artists.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-artists">
- <title>gtk.AboutDialog.set_artists</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_artists</methodname>
- <methodparam><parameter
- role="keyword">artists</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">artists</parameter>&nbsp;:</term>
- <listitem><simpara>a list of the names of the program
-artists</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_artists</methodname>() method sets the
-"artists" property to the contents of <parameter>artists</parameter>. The
-artist names are displayed in the artists tab of the secondary credits
-dialog. <methodname>set_artists</methodname>() method will show the
-<guibutton>Credits</guibutton> button if it is not displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-translator-credits">
- <title>gtk.AboutDialog.get_translator_credits</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_translator_credits</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the translator
-credits</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_translator_credits</methodname>() method
-returns the contents of the "translator-credits" property which contains the
-credits for the current translation.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-translator-credits">
- <title>gtk.AboutDialog.set_translator_credits</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_translator_credits</methodname>
- <methodparam><parameter
- role="keyword">translator_credits</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">translator_credits</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the current translation
-credits</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_translator_credits</methodname>() method
-sets the "translator_credits" property to the value of
-<parameter>translator_credits</parameter>. The translator credits are
-displayed in the translators tab of the secondary credits dialog.</para>
-
- <para>The intended use for this string is to display the translator of
-the language which is currently used in the user interface. Using the
-<function>gettext</function>() function, a simple way to achieve that is to
-mark the string for translation.</para>
-
- <para>It is a good idea to use the customary msgid
-"translator-credits" for this purpose, since translators will already know
-the purpose of that msgid, and since <link
-linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link>
-will detect if "translator-credits" is untranslated and hide the tab.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-logo">
- <title>gtk.AboutDialog.get_logo</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_logo</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-used as the logo</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_logo</methodname>() method returns the
-contents of the "logo" property which contains a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> that
-is used as the logo.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-logo">
- <title>gtk.AboutDialog.set_logo</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_logo</methodname>
- <methodparam><parameter
- role="keyword">logo</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">logo</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> to be
-used as the logo</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_logo</methodname>() method sets the "logo"
-property to the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-contained in <parameter>logo</parameter>. If <parameter>logo</parameter> is
-<literal>None</literal>, the default window icon set with the <link
-linkend="function-gtk--window-set-default-icon"><function>gtk.window_set_default_icon_list</function>()</link>
-function will be used.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--get-logo-icon-name">
- <title>gtk.AboutDialog.get_logo_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_logo_icon_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the icon used as the
-logo</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_logo_name</methodname>() method returns the
-contents of the "logo-icon-name" property which contains the name of the
-icon used as the logo.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaboutdialog--set-logo-icon-name">
- <title>gtk.AboutDialog.set_logo_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_logo_icon_name</methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of an icon or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_logo_icon_name</methodname>() method sets
-the "logo-icon-name" property to the value of
-<parameter>icon_name</parameter>. If <parameter>icon_name</parameter> is
-<literal>None</literal>, the default window icon set with the <link
-linkend="function-gtk--window-set-default-icon-list"><function>gtk.window_set_default_icon_list</function>()</link>
-function will be used.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--about-dialog-set-email-hook">
- <title>gtk.about_dialog_set_email_hook</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.about_dialog_set_email_hook</methodname>
- <methodparam><parameter
- role="keyword">func</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara> a function to call when an email link is
-activated.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara> data to pass to
-<parameter>func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.about_dialog_set_email_hook</function>
-function installs a global function (specified by
-<parameter>func</parameter>) to be called whenever the user activates an
-email link in an about dialog.</para>
-
- <para>The signature of the callback function
-<parameter>func</parameter> is:</para>
-
- <programlisting>
-def func(dialog, link, user_data)
-</programlisting>
-
- <para>where <parameter>link</parameter> is the email address
-destination of the activated link, <parameter>dialog</parameter> is the
-<link
-linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link>
-containing <parameter>link</parameter> and <parameter>user_data</parameter>
-is the <parameter>data</parameter> argument passed to <link
-linkend="function-gtk--about-dialog-set-email-hook"><function>gtk.about_dialog_set_email_hook</function>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--about-dialog-set-url-hook">
- <title>gtk.about_dialog_set_url_hook</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.about_dialog_set_url_hook</methodname>
- <methodparam><parameter
- role="keyword">func</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara> a function to call when a URL link is
-activated.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara> data to pass to
-<parameter>func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.about_dialog_set_url_hook</function> function
-installs a global function (specified by <parameter>func</parameter>) to be
-called whenever the user activates a URL link in an about dialog.</para>
-
- <para>The signature of the callback function
-<parameter>func</parameter> is:</para>
-
- <programlisting>
-def func(dialog, link, user_data)
-</programlisting>
-
- <para>where <parameter>link</parameter> is the URL destination of the
-activated link, <parameter>dialog</parameter> is the <link
-linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link>
-containing <parameter>link</parameter> and <parameter>user_data</parameter>
-is the <parameter>data</parameter> argument passed to <link
-linkend="function-gtk--about-dialog-set-url-hook"><function>gtk.about_dialog_set_url_hook</function>()</link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- </refentry>
diff --git a/docs/reference/pygtk-gtkaccelgroup.xml b/docs/reference/pygtk-gtkaccelgroup.xml
deleted file mode 100644
index 0d3d13a5..00000000
--- a/docs/reference/pygtk-gtkaccelgroup.xml
+++ /dev/null
@@ -1,855 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkaccelgroup">
-
- <refnamediv>
- <refname>gtk.AccelGroup</refname>
- <refpurpose>a group of accelerators for a Window hierarchy</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.AccelGroup</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkaccelgroup">gtk.AccelGroup</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccelgroup--lock">lock</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccelgroup--unlock">unlock</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccelgroup--connect-group">connect</link></methodname>
- <methodparam><parameter
- role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_mods</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_flags</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccelgroup--connect-group">connect_group</link></methodname>
- <methodparam><parameter
- role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_mods</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_flags</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccelgroup--connect-by-path">connect_by_path</link></methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- </methodsynopsis>
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccelgroup- -disconnect">disconnect</link></methodname>
- <methodparam><parameter>closure</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccelgroup--disconnect-key">disconnect_key</link></methodname>
- <methodparam><parameter
- role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_mods</parameter></methodparam>
- </methodsynopsis>
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccelgroup- -find">find</link></methodname>
- <methodparam><parameter>(*find_func</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-valid">gtk.accelerator_valid</link></methodname>
- <methodparam><parameter role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter role="keyword">modifiers</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-parse">gtk.accelerator_parse</link></methodname>
- <methodparam><parameter role="keyword">accelerator</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-name">gtk.accelerator_name</link></methodname>
- <methodparam><parameter role="keyword">accelerator_key</parameter></methodparam>
- <methodparam><parameter role="keyword">accelerator_mods</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-set-default-mod-mask">gtk.accelerator_set_default_mod_mask</link></methodname>
- <methodparam><parameter role="keyword">default_mod_mask</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-get-default-mod-mask">gtk.accelerator_get_default_mod_mask</link></methodname>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accelerator-get-label">gtk.accelerator_get_label</link></methodname>
- <methodparam><parameter role="keyword">accelerator_key</parameter></methodparam>
- <methodparam><parameter role="keyword">accelerator_mods</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-groups-from-object">gtk.accel_groups_from_object</link></methodname>
- <methodparam><parameter>object</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
- <synopsis>
-+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkaccelgroup">gtk.AccelGroup</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkaccelgroup">
- <title>gtk.AccelGroup Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkaccelgroup--accel-activate">accel-activate</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>accelgroup</parameter></methodparam>
- <methodparam><parameter>acceleratable</parameter></methodparam>
- <methodparam><parameter>accel_key</parameter></methodparam>
- <methodparam><parameter>accel_mods</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkaccelgroup--accel-changed">accel-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>accelgroup</parameter></methodparam>
- <methodparam><parameter>accel_key</parameter></methodparam>
- <methodparam><parameter>accel_mods</parameter></methodparam>
- <methodparam><parameter>closure</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
- <para>A <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-object groups all the accelerators for the associated window hierarchy
-(either <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> (or a
-descendant) or <link
-linkend="class-gtkmenushell"><classname>gtk.MenuShell</classname></link> (or
-a descendant)). Once the <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-is associated with a window or menu (using <link
-linkend="method-gtkwindow--add-accel-group"><methodname>gtk.Window.add_accel_group</methodname>()</link>
-or <link
-linkend="method-gtkmenu--set-accel-group"><methodname>gtk.Menu.set_accel_group</methodname>()</link>),
-accelerators can be added to the widget or one of its children by using
-<link
-linkend="method-gtkwidget--add-accelerator"><methodname>gtk.Widget.add_accelerator</methodname>()</link>
-. Accelerators can also be added by using a <link
-linkend="class-gtkaccelgroup"><classname>gtk.ItemFactory</classname></link>.</para>
- <para>Note that accelerators are different from mnemonics. Accelerators
-are shortcuts for activating a menu item; they appear alongside the menu
-item they're a shortcut for. For example
-<keycombo
- action="simul"><keycap>Ctrl</keycap><keycap>Q</keycap>
- </keycombo> might appear alongside the
-<menuchoice><guimenu>Files</guimenu><guimenuitem>Quit</guimenuitem>
- </menuchoice> menu item. Mnemonics are shortcuts for GUI elements such
-as text entries or buttons; they appear as underlined characters. Of course,
-menu items can have both accelerators and mnemonics.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkaccelgroup">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.AccelGroup</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an AccelGroup object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkaccelgroup--lock">
- <title>gtk.AccelGroup.lock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>lock</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>lock</methodname>() method locks the accelerator
-group. preventing its accelerators from being changed during runtime. Refer
-to <link
-linkend="function-gtk--accel-map-change-entry"><function>gtk.accel_map_change_entry</function>()</link>
-about runtime accelerator changes.</para>
-
- <para>If called more than once, the accelerator group remains locked
-until <link
-linkend="method-gtkaccelgroup--unlock"><methodname>gtk.AccelGroup.unlock</methodname>()</link>
-has been called an equivalent number of times.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaccelgroup--unlock">
- <title>gtk.AccelGroup.unlock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unlock</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>unlock</methodname>() method undoes the last
-call to <link
-linkend="method-gtkaccelgroup--lock"><methodname>gtk.AccelGroup.lock</methodname>()</link>
-for this accelerator group.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaccelgroup--connect-group">
- <title>gtk.AccelGroup.connect_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>connect</methodname>
- <methodparam><parameter
- role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_mods</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_flags</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">accel_key</parameter>&nbsp;:</term>
- <listitem><simpara>key value of the
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">accel_mods</parameter>&nbsp;:</term>
- <listitem><simpara>modifier combination of the
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">accel_flags</parameter>&nbsp;:</term>
- <listitem><simpara>a flag mask to configure this
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a function or method to be executed upon
-accelerator activation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 as
- <parameter>connect</parameter>() and was changed in PyGTK 2.4 and
- above to <parameter>connect_group</parameter>() to avoid conflict
- with the <link
- linkend="method-gobject--connect"><methodname>gobject.GObject.connect</methodname>()</link>
- method.</para>
- </note>
-
- <para>The <methodname>connect_group</methodname>() method installs an
-accelerator in the accelerator group. When the accelerator group is being
-activated, the function (or method) specified by
-<parameter>callback</parameter> will be invoked if the accelerator key and
-modifier key match those specified by <parameter>accel_key</parameter> and
-<parameter>accel_mods</parameter>.</para>
-
- <para>The value of <parameter>modifier</parameter> is a combination of
-the <xref linkend="gdk-modifier-constants"
-endterm="gdk-modifier-constants-title"></xref>. <parameter>accel_flags</parameter>
-is a combination of <literal>gtk.ACCEL_VISIBLE</literal> and
-<literal>gtk.ACCEL_LOCKED</literal>.</para>
-
- <para>The <parameter>callback</parameter> function is defined as:</para>
-
- <programlisting>
- def callback(accel_group, acceleratable, keyval, modifier)
-</programlisting>
-
- <para>where <parameter>accel_group</parameter> is the accelerator
-group, <parameter>acceleratable</parameter> is the object that the
-<parameter>accel_group</parameter> is attached to (e.g. a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>),
-<parameter>keyval</parameter> is the accelerator key and
-<parameter>modifier</parameter> is the key
-modifier. <parameter>callback</parameter> returns <literal>True</literal> if
-the accelerator was handled by <parameter>callback</parameter>.</para>
-
- <note><para>Due to implementation details, a single function or method
-can only be connected to one accelerator group.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkaccelgroup--connect-by-path">
- <title>gtk.AccelGroup.connect_by_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>connect_by_path</methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">accel_path</parameter>&nbsp;:</term>
- <listitem><simpara>path used for determining key and
-modifiers.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>function or method to be executed upon accelerator
-activation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above</para>
- </note>
-
- <para>The <methodname>connect_by_path</methodname>() method installs
-an accelerator in the accelerator group, using an accelerator path to look
-up the appropriate key and modifiers (see the function <link
-linkend="function-gtk--accel-map-add-entry"><function>gtk.accel_map_add_entry</function>()</link>). When
-the accelerator group is being activated, the function (or method) specified
-by <parameter>callback</parameter> will be invoked if the
-<parameter>accel_key</parameter> and <parameter>accel_mods</parameter> that
-cause the activation match the key and modifiers for the accelerator path
-specified by <parameter>accel_path</parameter>.</para>
-
- <para>The <parameter>callback</parameter> function is defined as:</para>
-
- <programlisting>
- def callback(accel_group, acceleratable, keyval, modifier)
-</programlisting>
-
- <para>where <parameter>accel_group</parameter> is the accelerator
-group, <parameter>acceleratable</parameter> is the object that the
-<parameter>accel_group</parameter> is attached to (e.g. a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>),
-<parameter>keyval</parameter> is the accelerator key and
-<parameter>modifier</parameter> is the key
-modifier. <parameter>callback</parameter> returns <literal>True</literal> if
-the accelerator was handled by <parameter>callback</parameter>.</para>
-
- </refsect2>
-
-
-<!-- NOT IMPLEMENTED
-
- <refsect2 id="method-gtkaccelgroup- -disconnect">
- <title>gtk.AccelGroup.disconnect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>disconnect</methodname>
- <methodparam><parameter>closure</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>closure</parameter>&nbsp;:</term>
- <listitem><simpara>the closure to remove from this accelerator
-group</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a gboolean</simpara></listitem>
- </varlistentry>
- </variablelist>
- <para>
-Removes an accelerator previously installed through <link
-linkend="method-gtkaccelgroup- -connect"><function>gtk.AccelGroup.connect()</function></link>.
-</para> </refsect2>
-
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gtkaccelgroup--disconnect-key">
- <title>gtk.AccelGroup.disconnect_key</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>disconnect_key</methodname>
- <methodparam><parameter
- role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_mods</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_key</parameter>&nbsp;:</term>
- <listitem><simpara>key value of the
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_mods</parameter>&nbsp;:</term>
- <listitem><simpara>modifier combination of the
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if there was an
- accelerator which was removed, <literal>False</literal>
- otherwise</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>disconnect</methodname>() method removes a
-previously installed accelerator specified by
-<parameter>accel_key</parameter> and <parameter>accel_mods</parameter> from
-the accelerator group.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
-
- <refsect2 id="method-gtkaccelgroup- -find">
- <title>gtk.AccelGroup.find</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>find</methodname>
- <methodparam><parameter>(*find_func</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>(*find_func</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a GtkAccelKey*</simpara></listitem>
- </varlistentry>
- </variablelist>
- <para>
-Finds the first entry in an accelerator group for which
-<parameter>find_func</parameter> returns <literal>True</literal> and returns
-its <literal>GtkAccelKey</literal>.
-</para> </refsect2>
-
-END NOT IMPLEMENTED -->
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--accelerator-valid">
- <title>gtk.accelerator_valid</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accelerator_valid</methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">modifiers</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>a key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">modifiers</parameter>&nbsp;:</term>
- <listitem><simpara>a modifier mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the accelerator is
-valid</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accelerator_valid</function>() function
-returns <literal>True</literal> if the specified
-<parameter>keyval</parameter> and <parameter>modifiers</parameter>
-constitute a valid keyboard accelerator. For example, the
-<literal>ord('a')</literal> keyval plus
-<literal>gtk.gdk.CONTROL_MASK</literal> is valid - this is a <keycombo
-action="simul"><keycap>Control</keycap><keycap>a</keycap> </keycombo>
-accelerator. The value of <parameter>modifiers</parameter> is a combination
-of the <xref linkend="gdk-modifier-constants"
-endterm="gdk-modifier-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accelerator-parse">
- <title>gtk.accelerator_parse</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accelerator_parse</methodname>
- <methodparam><parameter
- role="keyword">accelerator</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accelerator</parameter>&nbsp;:</term>
- <listitem><simpara>a string representing an
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the keyval and modifier
-mask of the accelerator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accelerator_parse</function>() function parses
-the specified <parameter>accelerator</parameter> string and returns a
-2-tuple containing the keyval and modifier mask corresponding to
-<parameter>accelerator</parameter>. The format looks like "&lt;Control&gt;a" or
-"&lt;Shift&gt;&lt;Alt&gt;F1" or "&lt;Release&gt;z" (the last one is for key release). The
-parser is fairly liberal and allows lower or upper case, and also
-abbreviations such as "&lt;Ctl&gt;" and "&lt;Ctrl&gt;". If the parse fails, the tuple
-values will both be 0 (zero). See the <link
-linkend="function-gtk--accelerator-valid"><function>gtk.accelerator_valid</function>()</link>
-function for more details.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accelerator-name">
- <title>gtk.accelerator_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accelerator_name</methodname>
- <methodparam><parameter
- role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accelerator_key</parameter>&nbsp;:</term>
- <listitem><simpara>a key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accelerator_mods</parameter>&nbsp;:</term>
- <listitem><simpara>a modifier mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string representing the accelerator or
-<literal>None</literal> if not a valid accelerator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accelerator_name</function>() function
-converts the accelerator keyval and modifier mask (specified by
-<parameter>accelerator_key</parameter> and
-<parameter>accelerator_mods</parameter>) into a string parseable by the
-<link
-linkend="function-gtk--accelerator-parse"><function>gtk.accelerator_parse</function>()</link>
-function. For example, if you pass in <literal>ord('q')</literal> and
-<literal>gtk.gdk.CONTROL_MASK</literal>, this function returns
-"&lt;Control&gt;q".</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accelerator-set-default-mod-mask">
- <title>gtk.accelerator_set_default_mod_mask</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accelerator_set_default_mod_mask</methodname>
- <methodparam><parameter
- role="keyword">default_mod_mask</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">default_mod_mask</parameter>&nbsp;:</term>
- <listitem><simpara>the new default accelerator modifier
-mask</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accelerator_set_default_mod_mask</function>()
-function sets the modifiers (specified by
-<parameter>default_mod_mask</parameter>) that will be considered significant
-for keyboard accelerators. The default mod mask is
-<literal>gtk.gdk.CONTROL_MASK</literal> |
-<literal>gtk.gdk.SHIFT_MASK</literal> |
-<literal>gtk.gdk.MOD1_MASK</literal>, that is, <keycap>Control</keycap>,
-<keycap>Shift</keycap>, and <keycap>Alt</keycap>. Other modifiers will by
-default be ignored by <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>.
-You must include at least the three default modifiers in any value you pass
-to this function. The default mod mask should be changed on application
-startup, before using any accelerator groups. The value of
-<parameter>default_mod_mask</parameter> is a combination of the <xref
-linkend="gdk-modifier-constants"
-endterm="gdk-modifier-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accelerator-get-default-mod-mask">
- <title>gtk.accelerator_get_default_mod_mask</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accelerator_get_default_mod_mask</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default accelerator modifier
-mask</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accelerator_get_default_mod_mask</function>()
-function returns the default accelerator modifier mask as set by the <link
-linkend="function-gtk--accelerator-set-default-mod-mask"><function>gtk.accelerator_set_default_mod_mask</function>()</link>
-function. See the <link
-linkend="function-gtk--accelerator-set-default-mod-mask"><function>gtk.accelerator_set_default_mod_mask</function>()</link>
-function for more detail on modifier masks.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accelerator-get-label">
- <title>gtk.accelerator_get_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accelerator_get_label</methodname>
- <methodparam><parameter
- role="keyword">accelerator_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accelerator_mods</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">accelerator_key</parameter>&nbsp;:</term>
- <listitem><simpara>a key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">accelerator_mods</parameter>&nbsp;:</term>
- <listitem><simpara>a modifier mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string representing the
-accelerator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.accelerator_get_label</function>() function
-converts the accelerator keyval and modifier mask specified by
-<parameter>accelerator_key</parameter> and
-<parameter>accelerator_mods</parameter> respectively into a string which can
-be used to represent the accelerator to the user. The value of
-<parameter>accelerator_mods</parameter> is a combination of the <xref
-linkend="gdk-modifier-constants"
-endterm="gdk-modifier-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accel-groups-from-object">
- <title>gtk.accel_groups_from_object</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_groups_from_object</methodname>
- <methodparam><parameter>object</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>object</parameter>&nbsp;:</term>
- <listitem><simpara>a GObject usually a <link
- linkend="class-gtkwindow"><classname>gtk.Window</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.accel_groups_from_object</function>() function
-returns a list of all the <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-objects attached to the object specified by
-<parameter>object</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkaccelgroup--accel-activate">
- <title>The "accel-activate" gtk.AccelGroup Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>accelgroup</parameter></methodparam>
- <methodparam><parameter>acceleratable</parameter></methodparam>
- <methodparam><parameter>accel_key</parameter></methodparam>
- <methodparam><parameter>accel_mods</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>accelgroup</parameter>&nbsp;:</term>
- <listitem><simpara>the accelgroup that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>acceleratable</parameter>&nbsp;:</term>
- <listitem><simpara>the object that the accelerator is associated
-with</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>accel_key</parameter>&nbsp;:</term>
- <listitem><simpara>the accelerator key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>accel_mods</parameter>&nbsp;:</term>
- <listitem><simpara>the accelerator modifiers</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>gobject.GObject.connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the accelerator
-was handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "accel-activate" signal is emitted when an accelerator is
-activated.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkaccelgroup--accel-changed">
- <title>The "accel-changed" gtk.AccelGroup Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>accelgroup</parameter></methodparam>
- <methodparam><parameter>accel_key</parameter></methodparam>
- <methodparam><parameter>accel_mods</parameter></methodparam>
- <methodparam><parameter>closure</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>accelgroup</parameter>&nbsp;:</term>
- <listitem><simpara>the accelgroup that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>accel_key</parameter>&nbsp;:</term>
- <listitem><simpara>the key value of the
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>accel_mods</parameter>&nbsp;:</term>
- <listitem><simpara>the modifiers of the
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>closure</parameter>&nbsp;:</term>
- <listitem><simpara>the closure of the
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "accel-changed" signal is emitted when an accelerator is
-added or removed from an accelerator group.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkaccellabel.xml b/docs/reference/pygtk-gtkaccellabel.xml
deleted file mode 100644
index 52c47488..00000000
--- a/docs/reference/pygtk-gtkaccellabel.xml
+++ /dev/null
@@ -1,379 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkaccellabel">
-
- <refnamediv>
- <refname>gtk.AccelLabel</refname>
- <refpurpose>a label which displays accelerator info to the right of the text</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.AccelLabel</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtklabel">gtk.Label</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkaccellabel">gtk.AccelLabel</link></methodname>
- <methodparam><parameter
- role="keyword">string</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccellabel--accelerator-width">accelerator_width</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccellabel--get-accel-widget">get_accel_widget</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccellabel--get-accel-width">get_accel_width</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccellabel--set-accel-widget">set_accel_widget</link></methodname>
- <methodparam><parameter
- role="keyword">accel_widget</parameter></methodparam>
- </methodsynopsis>
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkaccellabel- -set-accel-closure">set_accel_closure</link></methodname>
- <methodparam><parameter>accel_closure</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccellabel--refetch">refetch</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkmisc">gtk.Misc</link>
- +-- <link linkend="class-gtklabel">gtk.Label</link>
- +-- <link linkend="class-gtkaccellabel">gtk.AccelLabel</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkaccellabel">
- <title>gtk.AccelLabel Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkmisc">gtk.Misc Properties</link></para>
- <para><link linkend="properties-gtklabel">gtk.Label Properties</link></para>
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"accel-closure"</entry>
- <entry>Read-Write</entry>
- <entry>The closure to be monitored for accelerator
-changes</entry>
- </row>
- <row valign="top">
- <entry>"accel-widget"</entry>
- <entry>Read-Write</entry>
- <entry>The widget associated with the accelerator
-label</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkaccellabel">
- <title>gtk.AccelLabel Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkaccellabel">
- <title>gtk.AccelLabel Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtklabel">gtk.Label Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkaccellabel"><classname>gtk.AccelLabel</classname></link>
-widget is a subclass of <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> that
-displays an accelerator string to the right of the label text, e.g.
-<keycombo
- action="simul"><keycap>Ctrl</keycap><keycap>S</keycap>
- </keycombo>. It is commonly used in menus to show the keyboard
-shortcuts for commands. The accelerator string to display is not set
-explicitly; instead, the <link
-linkend="class-gtkaccellabel"><classname>gtk.AccelLabel</classname></link>
-displays the accelerators which have been added to the associated widget. A
-widget is associated with the accelerator label by calling <link
-linkend="method-gtkaccellabel--set-accel-widget"><methodname>set_accel_widget</methodname>()</link>.</para>
-
- <para>For example, a <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-widget may have an accelerator added to emit the "activate" signal when the
-<keycombo
- action="simul"><keycap>Ctrl</keycap><keycap>S</keycap>
- </keycombo> key combination is pressed. A <link
-linkend="class-gtkaccellabel"><classname>gtk.AccelLabel</classname></link>
-is created and added to the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>, and
-<link
-linkend="method-gtkaccellabel--set-accel-widget"><methodname>set_accel_widget</methodname>()</link> is called with the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> as
-the first argument. The <link
-linkend="class-gtkaccellabel"><classname>gtk.AccelLabel</classname></link>
-will now display <keycombo
- action="simul"><keycap>Ctrl</keycap><keycap>S</keycap>
- </keycombo> after its label.</para>
-
- <para>Creating a <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> with
-the <link
-linkend="constructor-gtkmenuitem"><function>gtk.MenuItem</function>()</link>
-function (or one of the similar functions <link
-linkend="constructor-gtkcheckmenuitem"><function>gtk.CheckMenuItem</function>()</link>
-and <link
-linkend="constructor-gtkradiomenuitem"><function>gtk.RadioMenuItem</function>()</link>)
-and specifying a label, automatically adds a <link
-linkend="class-gtkaccellabel"><classname>gtk.AccelLabel</classname></link>
-to the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> and
-calls <link
-linkend="method-gtkaccellabel--set-accel-widget"><methodname>set_accel_widget</methodname>()</link>
-to set it up for you.</para>
-
- <para>A <link
-linkend="class-gtkaccellabel"><classname>gtk.AccelLabel</classname></link>
-will only display accelerators which have
-<literal>gtk.ACCEL_VISIBLE</literal> set. A <link
-linkend="class-gtkaccellabel"><classname>gtk.AccelLabel</classname></link>
-can display multiple accelerators and even signal names, though it is almost
-always used to display just one accelerator.</para>
-
- <para>The following code fragment creates a simple menu item with an
-accelerator and enables the display of the accelerator key string in the
-menu item label:</para>
-
-<example>
-<title>Creating a simple menu item with an accelerator key.</title>
-<programlisting>
- # Create an accelgroup and add it to the window
- accel_group = gtk.AccelGroup()
- window.add_accel_group(accel_group)
-
- # Create the menu item
- save_item = gtk.MenuItem("Save")
- save_item.show()
- menu.add(save_item)
-
- # Now add the accelerator to the menu item. Note that since we created
- # the menu item with a label the AccelLabel is automatically setup to
- # display the accelerators.
- save_item.add_accelerator("activate", accel_group, ord("S"),
- gtk.gdk.CONTROL_MASK, gtk.ACCEL_VISIBLE)
-</programlisting>
-</example>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkaccellabel">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.AccelLabel</methodname>
- <methodparam><parameter
- role="keyword">string</parameter></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">string</parameter>&nbsp;:</term>
- <listitem><simpara>the label string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <classname>gtk.AccelLabel</classname>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para><function>gtk.AccelLabel</function>() creates a new <link
-linkend="class-gtkaccellabel"><classname>gtk.AccelLabel</classname></link>
-object. The <parameter>string</parameter> parameter specifies the text to be
-displayed by the label. The accelerator text is automatically added by the
-associated widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkaccellabel--accelerator-width">
- <title>gtk.AccelLabel.accelerator_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>accelerator_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the width in pixels needed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>accelerator_width</methodname>() method returns
-the width in pixels needed to display the accelerator(s). It is used by
-menus to align all of the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-widgets, and isn't usually needed by applications.</para>
- <note><para><methodname>accelerator_width</methodname>() is deprecated
-- use the <link
-linkend="method-gtkaccellabel--get-accel-width"><methodname>get_accel_width</methodname>()</link>
-method instead.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkaccellabel--get-accel-widget">
- <title>gtk.AccelLabel.get_accel_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_accel_widget</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the widget associated with the accelerator
-label, or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_accel_widget</methodname>() method retrieves
-the widget associated with this accelerator label. See <link
-linkend="method-gtkaccellabel--set-accel-widget"><function>gtk.AccelLabel.set_accel_widget()</function></link>.
-</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaccellabel--get-accel-width">
- <title>gtk.AccelLabel.get_accel_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_accel_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the width in pixels needed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_accel_width</methodname>() method returns
-the width in pixels needed to display the accelerator(s). It is used by
-menus to align all of the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-widgets, and isn't usually needed by applications.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaccellabel--set-accel-widget">
- <title>gtk.AccelLabel.set_accel_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_accel_widget</methodname>
- <methodparam><parameter
- role="keyword">accel_widget</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to be
-associated.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_accel_widget</methodname>() method
-associates the accelerator label with the widget specified by
-<parameter>accel_widget</parameter>.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
-
- <refsect2 id="method-gtkaccellabel- -set-accel-closure">
- <title>gtk.AccelLabel.set_accel_closure</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>set_accel_closure</methodname>
- <methodparam><parameter role="keyword">accel_closure</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">accel_closure</parameter>&nbsp;:</term>
- <listitem><simpara>the closure to monitor for accelerator changes.</simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-Sets the closure to be monitored by this accelerator label. The closure
-must be connected to an accelerator group; see <link linkend="method-gtkaccelgroup- -connect"><function>gtk.AccelGroup.connect()</function></link>.
-</para> </refsect2>
-
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gtkaccellabel--refetch">
- <title>gtk.AccelLabel.refetch</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>refetch</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>False</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>refetch</methodname>() method recreates the
-accelerator label string holding the accelerator information when the
-accelerator is changed. The size of the string is also recalculated.</para>
-
- <para>This method is not usually needed by applications since the
-accelerator label string is automatically updated whenever accelerators are
-added or removed from the associated widget.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkaccelmap.xml b/docs/reference/pygtk-gtkaccelmap.xml
deleted file mode 100644
index 47d6185f..00000000
--- a/docs/reference/pygtk-gtkaccelmap.xml
+++ /dev/null
@@ -1,688 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkaccelmap">
-
- <refnamediv>
- <refname>gtk.AccelMap</refname>
- <refpurpose>Loadable keyboard accelerator specifications (new in PyGTK
- 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.AccelMap</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-add-entry">gtk.accel_map_add_entry</link></methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- <methodparam><parameter role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter role="keyword">accel_mods</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-lookup-entry">gtk.accel_map_lookup_entry</link></methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-change-entry">gtk.accel_map_change_entry</link></methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- <methodparam><parameter role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter role="keyword">accel_mods</parameter></methodparam>
- <methodparam><parameter role="keyword">replace</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--accel-map-foreach">gtk.accel_map_foreach</link></methodname>
- <methodparam><parameter role="keyword">foreach_func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--accel-map-foreach-unfiltered">gtk.accel_map_foreach_unfiltered</link></methodname>
- <methodparam><parameter role="keyword">foreach_func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--accel-map-get">gtk.accel_map_get</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-load">gtk.accel_map_load</link></methodname>
- <methodparam><parameter role="keyword">file_name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-save">gtk.accel_map_save</link></methodname>
- <methodparam><parameter role="keyword">file_name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-load-fd">gtk.accel_map_load_fd</link></methodname>
- <methodparam><parameter role="keyword">fd</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-save-fd">gtk.accel_map_save_fd</link></methodname>
- <methodparam><parameter role="keyword">fd</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-lock-path">gtk.accel_map_lock_path</link></methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-unlock-path">gtk.accel_map_unlock_path</link></methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-map-add-filter">gtk.accel_map_add_filter</link></methodname>
- <methodparam><parameter role="keyword">filter_pattern</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--accel-groups-from-object">gtk.accel_groups_from_object</link></methodname>
- <methodparam><parameter>object</parameter></methodparam>
- </methodsynopsis>
-</programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkaccelmap">gtk.AccelMap</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkaccelmap">
- <title>gtk.AccelMap Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkaccelmap--changed">changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>object</parameter></methodparam>
- <methodparam><parameter>accel_path</parameter></methodparam>
- <methodparam><parameter>accel_key</parameter></methodparam>
- <methodparam><parameter>accel_mods</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
-<para></para>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--accel-map-add-entry">
- <title>gtk.accel_map_add_entry</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_add_entry</methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_mods</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_path</parameter>&nbsp;:</term>
- <listitem><simpara>a valid accelerator path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_key</parameter>&nbsp;:</term>
- <listitem><simpara>the accelerator key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_mods</parameter>&nbsp;:</term>
- <listitem><simpara>the accelerator modifiers</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.accel_map_add_entry</function>() function
-registers a new accelerator specified by <parameter>accel_key</parameter>
-and <parameter>accel_mods</parameter> with the global accelerator map. The
-accelerator will be associated with the accelerator path specified by
-<parameter>accel_path</parameter>. This function should only be called once
-per <parameter>accel_path</parameter> with the canonical
-<parameter>accel_key</parameter> and <parameter>accel_mods</parameter> for
-this path. To change the accelerator during runtime programatically, use the
-<link
-linkend="function-gtk--accel-map-change-entry"><function>gtk.accel_map_change_entry</function>()</link>
-function. The accelerator path must consist of
-"&lt;WINDOWTYPE&gt;/Category1/Category2/.../Action", where
-&lt;WINDOWTYPE&gt; should be a unique application-specific identifier, that
-corresponds to the kind of window the accelerator is being used in,
-e.g. "Gimp-Image", "Abiword-Document" or "Gnumeric-Settings". The
-Category1/.../Action portion is most appropriately chosen by the action the
-accelerator triggers, i.e. for accelerators on menu items, choose the item's
-menu path, e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All". So a
-full valid accelerator path may look like:
-"&lt;Gimp-Toolbox&gt;/File/Dialogs/Tool Options...".</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-lookup-entry">
- <title>gtk.accel_map_lookup_entry</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_lookup_entry</methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_path</parameter>&nbsp;:</term>
- <listitem><simpara>a valid accelerator path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the keyval and modifier
-mask corresponding to <parameter>accel_path</parameter> or
-<literal>None</literal> if not valid</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accel_map_lookup_entry</function>() function
-returns a 2-tuple containing the keyval and modifier mask corresponding to
-the accelerator path specified by <parameter>accel_path</parameter> or
-<literal>None</literal> if <parameter>accel_path</parameter> is not a valid
-accelerator path.</para>
-
- <para>The accelerator path must consist of
-"&lt;WINDOWTYPE&gt;/Category1/Category2/.../Action", where &lt;WINDOWTYPE&gt; should be
-a unique application-specific identifier, that corresponds to the kind of
-window the accelerator is being used in, e.g. "Gimp-Image",
-"Abiword-Document" or "Gnumeric-Settings". The Category1/.../Action portion
-is most appropriately chosen by the action the accelerator triggers, i.e.
-for accelerators on menu items, choose the item's menu path, e.g. "File/Save
-As", "Image/View/Zoom" or "Edit/Select All". So a full valid accelerator
-path may look like: "&lt;Gimp-Toolbox&gt;/File/Dialogs/Tool Options...".</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-change-entry">
- <title>gtk.accel_map_change_entry</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_change_entry</methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_mods</parameter></methodparam>
- <methodparam><parameter
- role="keyword">replace</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_path</parameter>&nbsp;:</term>
- <listitem><simpara>a valid accelerator path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_key</parameter>&nbsp;:</term>
- <listitem><simpara> the new accelerator key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_mods</parameter>&nbsp;:</term>
- <listitem><simpara> the new accelerator
-modifiers</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">replace</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> other accelerators
-may be deleted if conflicting</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the accelerator
-could be changed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accel_map_change_entry</function>() function
-changes the keyval and modifier mask currently associated with the
-accelerator path specified by <parameter>accel_path</parameter> to the
-values specified by <parameter>accel_key</parameter> and
-<parameter>accel_mods</parameter> respectively. Due to conflicts with other
-accelerators, a change may not always be possible. If
-<parameter>replace</parameter> is <literal>True</literal> the other
-accelerators may be deleted to resolve such conflicts. A change will only
-occur if all conflicts could be resolved (which might not be the case if
-conflicting accelerators are locked). Successful changes are indicated by a
-<literal>True</literal> return value.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-foreach">
- <title>gtk.accel_map_foreach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_foreach</methodname>
- <methodparam><parameter role="keyword">foreach_func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">foreach_func</parameter>&nbsp;:</term>
- <listitem><simpara>function to be executed for each accel map
- entry which is not filtered out</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>data to be passed into
- <parameter>foreach_func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Loops over the entries in the accelerator map whose accel path
- doesn't match any of the filters added with the <link
- linkend="function-gtk--accel-map-add-filter"><function>gtk.accel_map_add_filter</function>()</link>
- function, and executes <parameter>foreach_func</parameter> on
- each. The signature of <parameter>foreach_func</parameter> is:</para>
-
- <programlisting>
- def foreach_func(accel_path, accel_key, accel_mode, changed, user_data):
- </programlisting>
-
- <para>where <parameter>accel_path</parameter>,
- <parameter>accel_key</parameter> and <parameter>accel_mode</parameter>
- describe the accel map accelerator entry and the
- <parameter>changed</parameter> parameter indicates whether this
- accelerator was changed during runtime ( and thus, would need saving
- during an accelerator map dump). <parameter>user_data</parameter> is
- <parameter>data</parameter> if <parameter>data</parameter> was
- specified. See the <link
- linkend="function-gtk--accel-map-add-entry"><function>gtk.accel_map_add_entry</function>()</link>
- function for more information.</para>
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-foreach-unfiltered">
- <title>gtk.accel_map_foreach_unfiltered</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_foreach_unfiltered</methodname>
- <methodparam><parameter role="keyword">foreach_func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">foreach_func</parameter>&nbsp;:</term>
- <listitem><simpara>function to be executed for each accel map
- entry</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>data to be passed into
- <parameter>foreach_func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Loops over all entries in the accelerator map, and executes
- <parameter>foreach_func</parameter> on each. The signature of
- <parameter>foreach_func</parameter> is:</para>
-
- <programlisting>
- def foreach_func(accel_path, accel_key, accel_mode, changed, user_data):
- </programlisting>
-
- <para>where <parameter>accel_path</parameter>,
- <parameter>accel_key</parameter> and <parameter>accel_mode</parameter>
- describe the accel map accelerator entry and the
- <parameter>changed</parameter> parameter indicates whether this
- accelerator was changed during runtime (thus, would need saving during
- an accelerator map dump). <parameter>user_data</parameter> is
- <parameter>data</parameter> if <parameter>data</parameter> was
- specified. See the <link
- linkend="function-gtk--accel-map-add-entry"><function>gtk.accel_map_add_entry</function>()</link>
- function for more information.</para>
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-get">
- <title>gtk.accel_map_get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_get</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the global <link
- linkend="class-gtkaccelmap"><classname>gtk.AccelMap</classname></link>
- object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets the singleton global <link
- linkend="class-gtkaccelmap"><classname>gtk.AccelMap</classname></link>
- object. This object is useful only for notification of changes to the
- accelerator map via the "changed" signal. it has no methods or
- properties.</para>
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-load">
- <title>gtk.accel_map_load</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_load</methodname>
- <methodparam><parameter
- role="keyword">file_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">file_name</parameter>&nbsp;:</term>
- <listitem><simpara>the file containing accelerator
-specifications</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accel_map_load</function>() function parses
-the file (specified by <parameter>file_name</parameter>) previously saved
-with the <link
-linkend="function-gtk--accel-map-save"><function>gtk.accel_map_save</function>()</link>
-function for accelerator specifications, and propagates them
-accordingly.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-save">
- <title>gtk.accel_map_save</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_save</methodname>
- <methodparam><parameter
- role="keyword">file_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">file_name</parameter>&nbsp;:</term>
- <listitem><simpara>the file to save the accelerator specifications
-in</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accel_map_save</function>() function saves
-current accelerator specifications (accelerator path, key and modifiers) to
-the file specified by <parameter>file_name</parameter>. The file is written
-in a format suitable to be read back in by the <link
-linkend="function-gtk--accel-map-load"><function>gtk.accel_map_load</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-load-fd">
- <title>gtk.accel_map_load_fd</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_load_fd</methodname>
- <methodparam><parameter
- role="keyword">fd</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">fd</parameter>&nbsp;:</term>
- <listitem><simpara>a Python file object or an integer file
-descriptor</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accel_map_load_fd</function>() function loads
-the accelerator map from the open Python file object specified by
-<parameter>fd</parameter>. <parameter>fd</parameter> may also be an integer
-file descriptor. See the <link
-linkend="function-gtk--accel-map-load"><function>gtk.accel_map_load</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-save-fd">
- <title>gtk.accel_map_save_fd</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_save_fd</methodname>
- <methodparam><parameter
- role="keyword">fd</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">fd</parameter>&nbsp;:</term>
- <listitem><simpara>a Python file object or an integer file
-descriptor</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accel_map_save_fd</function>() function saves
-the accelerator map into the open Python file object specified by fd.
-<parameter>fd</parameter> may also be an integer file descriptor. See the
-<link
-linkend="function-gtk--accel-map-save"><function>gtk.accel_map_save</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-lock-path">
- <title>gtk.accel_map_lock_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_lock_path</methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">accel_path</parameter>&nbsp;:</term>
- <listitem><simpara>a valid accelerator path</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.accel_map_lock_path</function>() function
- locks the accelerator path specified by
- <parameter>accel_path</parameter>. If the accelerator map doesn't yet
- contain an entry for <parameter>accel_path</parameter>, a new one is
- created.</para>
-
- <para>Locking an accelerator path prevents its accelerator from being
- changed during runtime. A locked accelerator path can be unlocked by
- the <link
- linkend="function-gtk--accel-map-unlock-path"><function>gtk.accel_map_unlock_path</function>()</link>
- function. Refer to the <link
- linkend="function-gtk--accel-map-change-entry"><function>gtk.accel_map_change_entry</function>()</link>
- function for information about runtime accelerator changes.</para>
-
- <para>If called more than once, <parameter>accel_path</parameter>
- remains locked until the <link
- linkend="function-gtk--accel-map-unlock-path"><function>gtk.accel_map_unlock_path</function>()</link>
- function has been called an equivalent number of times.</para>
-
- <para>Note that locking of individual accelerator paths is independent
- from locking the <link
- linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
- containing them. For runtime accelerator changes to be possible both
- the accelerator path and its <link
- linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
- have to be unlocked.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-unlock-path">
- <title>gtk.accel_map_unlock_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_unlock_path</methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">accel_path</parameter>&nbsp;:</term>
- <listitem><simpara>a valid accelerator path</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.accel_map_unlock_path</function>() function
- undoes the last call to the <link
- linkend="function-gtk--accel-map-lock-path"><function>gtk.accel_map_lock_path</function>()</link>
- function on the accelerator path specified by
- <parameter>accel_path</parameter>. Refer to the <link
- linkend="function-gtk--accel-map-lock-path"><function>gtk.accel_map_lock_path</function>()</link>
- function for information about accelerator path locking.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--accel-map-add-filter">
- <title>gtk.accel_map_add_filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.accel_map_add_filter</methodname>
- <methodparam><parameter
- role="keyword">filter_pattern</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">filter_pattern</parameter>&nbsp;:</term>
- <listitem><simpara>a glob-style pattern</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.accel_map_add_filter</function>() function
- adds the filter pattern specified by
- <parameter>filter_pattern</parameter> to the global list of accel path
- filters. The pattern specified by
- <parameter>filter_pattern</parameter> contain '*' and '?' wildcards
- with similar semantics as the Python <filename>glob.py</filename> and
- <filename>fnmatch.py</filename> modules: '*' matches an arbitrary,
- possibly empty, string, '?' matches an arbitrary character. Note that
- in contrast to <filename>glob.py</filename>, the '/' character can be
- matched by the wildcards, there are no '[...]' character ranges and
- '*' and '?' can not be escaped to include them literally in a
- pattern. Accelerator map entries whose accelerator path matches one of
- the filters are skipped by the <link
- linkend="function-gtk--accel-map-foreach"><function>gtk.accel_map_foreach</function>()</link>
- function. This function is intended for <literal>PyGTK</literal>
- modules that create their own menus, but don't want them to be saved
- into the applications accelerator map dump.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkaccelmap--changed">
- <title>The "changed" gtk.AccelMap Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>object</parameter></methodparam>
- <methodparam><parameter>accel_path</parameter></methodparam>
- <methodparam><parameter>accel_key</parameter></methodparam>
- <methodparam><parameter>accel_mods</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>object</parameter>&nbsp;:</term>
- <listitem><simpara>the global accel map object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>accel_path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the accelerator that
- changed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>accel_key</parameter>&nbsp;:</term>
- <listitem><simpara>the key value for the new
- accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>accel_mods</parameter>&nbsp;:</term>
- <listitem><simpara>the modifier mask for the new
- accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
- any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>Notifies of a change in the global accelerator map. The path is
- also used as the detail for the signal, so it is possible to connect
- to changed::<replaceable>accel_path</replaceable>.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkaccessible.xml b/docs/reference/pygtk-gtkaccessible.xml
deleted file mode 100644
index b69f70aa..00000000
--- a/docs/reference/pygtk-gtkaccessible.xml
+++ /dev/null
@@ -1,75 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkaccessible">
- <refnamediv>
- <refname>gtk.Accessible</refname>
- <refpurpose>accessibility support for widgets.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Accessible</classname></ooclass>
- <ooclass><classname><link
-linkend="class-atkobject">atk.Object</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaccessible--connect-widget-destroyed">connect_widget_destroyed</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-atkobject">atk.Object</link>
- +-- <link linkend="class-gtkaccessible">gtk.Accessible</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkaccessible">
- <title>gtk.Accessible Properties</title>
-
- <para><link linkend="properties-atkobject">atk.Object Properties</link></para>
-
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkaccessible">
- <title>gtk.Accessible Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-atkobject">atk.Object Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The gtk.Accessible class is an abstract base class.</para>
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkaccessible--connect-widget-destroyed">
- <title>gtk.Accessible.connect_widget_destroyed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>connect_widget_destroyed</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>This method specifies the callback function to be called when
-the widget corresponding to a <classname>gtk.Accessible</classname> is
-destroyed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkaction.xml b/docs/reference/pygtk-gtkaction.xml
deleted file mode 100644
index 51e38a8f..00000000
--- a/docs/reference/pygtk-gtkaction.xml
+++ /dev/null
@@ -1,1144 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkaction">
- <refnamediv>
- <refname>gtk.Action</refname>
- <refpurpose>an action which can be triggered by a menu or toolbar
-item (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Action</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkaction">gtk.Action</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- <methodparam><parameter role="keyword">tooltip</parameter></methodparam>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--get-name">get_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--is-sensitive">is_sensitive</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--get-sensitive">get_sensitive</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--is-visible">is_visible</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--get-visible">get_visible</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--activate">activate</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--create-icon">create_icon</link></methodname>
- <methodparam><parameter role="keyword">icon_size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--create-menu-item">create_menu_item</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--create-tool-item">create_tool_item</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--connect-proxy">connect_proxy</link></methodname>
- <methodparam><parameter role="keyword">proxy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--disconnect-proxy">disconnect_proxy</link></methodname>
- <methodparam><parameter role="keyword">proxy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--get-proxies">get_proxies</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--connect-accelerator">connect_accelerator</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--disconnect-accelerator">disconnect_accelerator</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--block-activate-from">block_activate_from</link></methodname>
- <methodparam><parameter role="keyword">proxy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--unblock-activate-from">unblock_activate_from</link></methodname>
- <methodparam><parameter role="keyword">proxy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--get-accel-path">get_accel_path</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--set-accel-path">set_accel_path</link></methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--set-accel-group">set_accel_group</link></methodname>
- <methodparam><parameter role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--set-sensitive">set_sensitive</link></methodname>
- <methodparam><parameter role="keyword">sensitive</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--set-visible">set_visible</link></methodname>
- <methodparam><parameter role="keyword">visible</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--set-menu-item-type">set_menu_item_type</link></methodname>
- <methodparam><parameter role="keyword">visible</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkaction--set-tool-item-type">set_tool_item_type</link></methodname>
- <methodparam><parameter role="keyword">visible</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkaction">gtk.Action</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkaction">
- <title>gtk.Action Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"action-group"</entry>
- <entry>Read-Write</entry>
-
- <entry>The <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-this <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> is
-associated with, or <literal>None</literal> (for internal use).</entry>
- </row>
-
- <row valign="top">
- <entry>"hide-if-empty"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, empty menu proxies for this
-action are hidden.</entry>
- </row>
-
- <row valign="top">
- <entry>"is-important"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-proxies for this action show text in
-<literal>gtk.TOOLBAR_BOTH_HORIZ</literal> mode.</entry>
- </row>
-
- <row valign="top">
- <entry>"label"</entry>
- <entry>Read-Write</entry>
- <entry>The label used for menu items and buttons that activate
-this action.</entry>
- </row>
-
- <row valign="top">
- <entry>"name"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>A unique name for the action.</entry>
- </row>
-
- <row valign="top">
- <entry>"sensitive"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the action is
-enabled.</entry>
- </row>
-
- <row valign="top">
- <entry>"short-label"</entry>
- <entry>Read-Write</entry>
- <entry>A shorter label that may be used on toolbar
-buttons.</entry>
- </row>
-
- <row valign="top">
- <entry>"stock-id"</entry>
- <entry>Read-Write</entry>
- <entry>The stock icon displayed in widgets representing this
-action.</entry>
- </row>
-
- <row valign="top">
- <entry>"tooltip"</entry>
- <entry>Read-Write</entry>
- <entry>A tooltip for this action.</entry>
- </row>
-
- <row valign="top">
- <entry>"visible"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the action is
-visible.</entry>
- </row>
-
- <row valign="top">
- <entry>"visible-horizontal"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the toolbar item is
-visible when the toolbar is in a horizontal orientation.</entry>
- </row>
-
- <row valign="top">
- <entry>"visible-vertical"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the toolbar item is
-visible when the toolbar is in a vertical orientation.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkaction">
- <title>gtk.Action Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkaction--activate">activate</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>
-represents operations that the user can perform, along with some information
-how it should be presented in the interface. Each <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> provides
-methods to create icons, menu items and toolbar items representing
-itself.</para>
-
- <para>As well as the callback that is called when the action gets
-activated, the following also gets associated with the action:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>a name (not translated, for path lookup)</simpara>
- </listitem>
- <listitem>
- <simpara>a label (translated, for display)</simpara>
- </listitem>
- <listitem>
- <simpara>an accelerator</simpara>
- </listitem>
- <listitem>
- <simpara>whether the label indicates a stock id</simpara>
- </listitem>
- <listitem>
- <simpara>a tooltip (optional, translated)</simpara>
- </listitem>
- <listitem>
- <simpara>a toolbar label (optional, shorter than label)</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The action will also have some state information:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>visible (shown/hidden)</simpara>
- </listitem>
- <listitem>
- <simpara>sensitive (enabled/disabled)</simpara>
- </listitem>
- </itemizedlist>
-
- <para>Apart from regular actions, there are toggle actions, which can be
-toggled between two states and radio actions, where only one in a group
-can be in the "active" state. Other actions can be implemented as <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>
-subclasses.</para>
-
- <para>Each <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> can have
-one or more proxy menu items, toolbar buttons or other proxy
-widgets. Proxies mirror the state of the action (text label, tooltip, icon,
-visible, sensitive, etc), and should change when the action's state
-changes. When the proxy is activated, it should activate its action. </para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkaction">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Action</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- <methodparam><parameter role="keyword">tooltip</parameter></methodparam>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a unique name for the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>the label displayed in menu items and on
-buttons</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tooltip</parameter>&nbsp;:</term>
- <listitem><simpara>a tooltip for the action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>the stock icon to display in widgets
-representing the action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>
-object. To add the action to a <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-and set the accelerator for the action, call the <link
-linkend="method-gtkactiongroup--add-action-with-accel"><methodname>gtk.ActionGroup.add_action_with_accel()</methodname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkaction--get-name">
- <title>gtk.Action.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the action.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_name</methodname>() method returns the value
-of the "name" property containing the name of the action.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--is-sensitive">
- <title>gtk.Action.is_sensitive</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_sensitive</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the action and its
-associated action group are both sensitive.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>is_sensitive</methodname>() method returns
-<literal>True</literal> if the action is effectively sensitive i.e. both the
-<link linkend="class-gtkaction"><classname>gtk.Action</classname></link> and
-its associated <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-are sensitive.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--get-sensitive">
- <title>gtk.Action.get_sensitive</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_sensitive</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the action itself
-is sensitive.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_sensitive</methodname>() method returns the
-value of the "sensitive" property. If "sensitive" is <literal>True</literal>
-the action itself is sensitive. Note that this doesn't necessarily mean
-effective sensitivity. See the <link
-linkend="method-gtkaction--is-sensitive"><methodname>is_sensitive()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--is-visible">
- <title>gtk.Action.is_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_visible</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the action and
-its associated action group are both visible.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>is_visible</methodname>() method returns
-<literal>True</literal> if the action is effectively visible i.e. both the
-<link linkend="class-gtkaction"><classname>gtk.Action</classname></link> and
-its associated <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-as visible.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--get-visible">
- <title>gtk.Action.get_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the action itself
-is visible.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_visible</methodname>() method returns the
-value of the "visible" property. If "visible" is <literal>True</literal> the
-<link linkend="class-gtkaction"><classname>gtk.Action</classname></link>
-itself is visible. Note that this doesn't necessarily mean effective
-visibility. See the <link
-linkend="method-gtkaction--is-visible"><methodname>is_visible()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--activate">
- <title>gtk.Action.activate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>activate</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>activate</methodname>() method emits the
-"activate" signal on the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>, if it
-isn't insensitive. This gets called by the proxy widgets when they get
-activated. It can also be used to manually activate an action.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--create-icon">
- <title>gtk.Action.create_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_icon</methodname>
- <methodparam><parameter role="keyword">icon_size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_size</parameter>&nbsp;:</term>
- <listitem><simpara>the size of the icon that should be
-created.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a widget that displays the icon for this
-action.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>create_icon</methodname>() method creates and
-returns a <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> with the
-size specified by <parameter>size</parameter> from the icon contained in the
-"stock-id" property if it exists. The value of <parameter>size</parameter>
-must be one of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_MENU</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_BUTTON</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_DND</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_DIALOG</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para>This method is intended for use by <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>
-implementations to create icons displayed in the proxy widgets.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--create-menu-item">
- <title>gtk.Action.create_menu_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_menu_item</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a menu item connected to the
-action.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>create_menu_item</methodname>() method creates
-and returns a menu item widget that proxies for the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--create-tool-item">
- <title>gtk.Action.create_tool_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_tool_item</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tool item connected to the
-action.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>create_tool_item</methodname>() method creates
-and returns a tool item widget that proxies for the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--connect-proxy">
- <title>gtk.Action.connect_proxy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>connect_proxy</methodname>
- <methodparam><parameter role="keyword">proxy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">proxy</parameter>&nbsp;:</term>
- <listitem><simpara>the proxy widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>connect_proxy</methodname>() method connects the
-widget specified by <parameter>proxy</parameter> to the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> object as
-a proxy. This method synchronizes various properties of the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> with the
-widget (such as label text, icon, tooltip, etc), and attaches a callback so
-that the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> is
-activated when <parameter>proxy</parameter> is.</para>
-
- <para>If <parameter>proxy</parameter> is already connected to another
-<link linkend="class-gtkaction"><classname>gtk.Action</classname></link>, it
-is disconnected first. The <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> should be
-added to a <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-before calling this method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--disconnect-proxy">
- <title>gtk.Action.disconnect_proxy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>disconnect_proxy</methodname>
- <methodparam><parameter role="keyword">proxy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">proxy</parameter>&nbsp;:</term>
- <listitem><simpara>the proxy widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>disconnect_proxy</methodname>() method
-disconnects the widget specified by <parameter>proxy</parameter> from the
-<link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>. This
-method does <emphasis>not</emphasis> destroy the widget. The <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> should be
-added to a <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-before calling this method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--get-proxies">
- <title>gtk.Action.get_proxies</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_proxies</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of proxy widgets.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_proxies</methodname>() method returns a list
-containing the proxy widgets associated with the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--connect-accelerator">
- <title>gtk.Action.connect_accelerator</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>connect_accelerator</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>connect_accelerator</methodname>() method
-installs the accelerator for the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> if it has
-an associated accel path and <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>. See
-the <link
-linkend="method-gtkaction--set-accel-path"><methodname>set_accel_path()</methodname></link>
-and the <link
-linkend="method-gtkaction--set-accel-group"><methodname>set_accel_group()</methodname></link>
-methods.</para>
-
- <para>Since multiple proxies may independently trigger the
-installation of the accelerator, the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> counts
-the number of times this method has been called and doesn't remove the
-accelerator until <link
-linkend="method-gtkaction--disconnect-accelerator"><methodname>disconnect_accelerator()</methodname></link>
-has been called as many times.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--disconnect-accelerator">
- <title>gtk.Action.disconnect_accelerator</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>disconnect_accelerator</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>disconnect_accelerator</methodname>() method
-undoes the effect of one call to the <link
-linkend="method-gtkaction--connect-accelerator"><methodname>connect_accelerator()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--block-activate-from">
- <title>gtk.Action.block_activate_from</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>block_activate_from</methodname>
- <methodparam><parameter role="keyword">proxy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">proxy</parameter>&nbsp;:</term>
- <listitem><simpara>a proxy widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>block_activate_from</methodname>() method
-disables calls to the <link
-linkend="method-gtkaction--activate"><methodname>activate()</methodname></link>
-method by signals on the widget specified by
-<parameter>proxy</parameter>. This is used to break notification loops for
-things like check or radio actions.</para>
-
- <para>This method is intended for use by <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>
-implementations.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--unblock-activate-from">
- <title>gtk.Action.unblock_activate_from</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unblock_activate_from</methodname>
- <methodparam><parameter role="keyword">proxy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">proxy</parameter>&nbsp;:</term>
- <listitem><simpara>a proxy widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>unblock_activate_from</methodname>() method
-re-enables calls to the <link
-linkend="method-gtkaction--activate"><methodname>activate()</methodname></link>
-method by signals on the widget specified by <parameter>proxy</parameter>.
-This undoes the blocking done by the <link
-linkend="method-gtkaction--block-activate-from"><methodname>block_activate_from()</methodname></link>
-method.</para>
-
- <para>This method is intended for use by <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>
-implementations.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--get-accel-path">
- <title>gtk.Action.get_accel_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_accel_path</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the accelerator path associated with the action
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_accel_path</methodname>() method returns the
-accel path for the action or <literal>None</literal> if no accel path is
-set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--set-accel-path">
- <title>gtk.Action.set_accel_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_accel_path</methodname>
- <methodparam><parameter role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">accel_path</parameter>&nbsp;:</term>
- <listitem><simpara>the accelerator path</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_accel_path</methodname>() method sets the
-accel path for the action to the value of
-<parameter>accel_path</parameter>. All proxy widgets associated with the
-action will have this accel path, so that their accelerators are
-consistent.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--set-accel-group">
- <title>gtk.Action.set_accel_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_accel_group</methodname>
- <methodparam><parameter role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">accel_group</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link> or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_accel_group</methodname>() method sets the
-<link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-specified by <parameter>accel_group</parameter> as the accelerator group for
-the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--set-sensitive">
- <title>gtk.Action.set_sensitive</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_sensitive</methodname>
- <methodparam><parameter role="keyword">sensitive</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">sensitive</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> make the action
-sensitive</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_sensitive</methodname>() method sets the
-"sensitive" property to the value of <parameter>sensitive</parameter>. Note
-that this doesn't necessarily set the effective sensitivity. See the <link
-linkend="method-gtkaction--is-sensitive"><methodname>is_sensitive</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--set-visible">
- <title>gtk.Action.set_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible</methodname>
- <methodparam><parameter role="keyword">visible</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">visible</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> make the action
-visible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_visible</methodname>() method sets the
-"visible" property to the value of <parameter>visible</parameter>. Note that
-this doesn't necessarily set the effective visibility. See the <link
-linkend="method-gtkaction--is-visible"><methodname>is_visible</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--set-menu-item-type">
- <title>gtk.Action.set_menu_item_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_menu_item_type</methodname>
- <methodparam><parameter role="keyword">visible</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of menuitem to be created for the
- action</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_menu_item_type</methodname>() method is a
- classmethod that sets the type of menuitem to be created for the
- action to that specified by <parameter>type</parameter>. This is
- useful when using the <link
- linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>
- and you would like to use something other than a <link
- linkend="class-gtkimagemenuitem"><classname>gtk.ImageMenuItem</classname></link>
- (<link
- linkend="class-gtkaction"><classname>gtk.Action</classname></link>) or
- a <link
- linkend="class-gtkcheckmenuitem"><classname>gtk.CheckMenuItem</classname></link>
- (<link
- linkend="class-gtktoogleaction"><classname>gtk.ToogleAction</classname></link>
- or <link
- linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link>).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkaction--set-tool-item-type">
- <title>gtk.Action.set_tool_item_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tool_item_type</methodname>
- <methodparam><parameter role="keyword">visible</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of toolitem to be created for the
- action</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_tool_item_type</methodname>() method is a
- classmethod that sets the type of toolitem to be created for the
- action to that specified by <parameter>type</parameter>. This is
- useful when using the <link
- linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>
- and you would like to use something other than a <link
- linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>
- (<link
- linkend="class-gtkaction"><classname>gtk.Action</classname></link>) or
- a <link
- linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>
- (<link
- linkend="class-gtktoogleaction"><classname>gtk.ToogleAction</classname></link>
- or <link
- linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link>).</para>
-
- <para>For example, to use a <link
- linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
- in a toolbar you would subclass <link
- linkend="class-gtkaction"><classname>gtk.Action</classname></link>:</para>
-
- <programlisting>
- class MenuToolAction(gtk.Action):
- __gtype_name__ = "MenuToolAction"
-
- gobject.type_register(MenuToolAction)
- </programlisting>
-
- <para>and then call <link
- linkend="method-gtkaction--set-tool-item-type"><methodname>set_tool_item_type</methodname>()</link>:</para>
-
- <programlisting>
- MenuToolAction.set_tool_item_type(gtk.MenuToolButton)
- </programlisting>
-
- <para>You have to create, name and add an instance of
- <parameter>MenuToolAction</parameter> to your <link
- linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>:</para>
-
- <programlisting>
- actiongroup.add_action(MenuToolAction("my_menutoolaction", "_MTB_label",
- "do something", None))
- </programlisting>
-
- <para>The ui description should reference the
- <parameter>MenuToolAction</parameter> like:</para>
-
- <programlisting>
- &lt;toolitem action="my_menutoolaction"/&gt;
- </programlisting>
-
- <para>After the <link
- linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>
- creates the toolbar including the <link
- linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
- proxy for the <parameter>MenuToolAction</parameter>, you would have to
- create and add a menu to the <link
- linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
- instance.</para>
-
- <para>This technique can be extended by subclassing <link
- linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
- and adding custom widgets to it.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkaction--activate">
- <title>The "activate" gtk.Action Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>action</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> that
-received the signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "activate" signal is emitted when
-<parameter>action</parameter> is activated.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkactiongroup.xml b/docs/reference/pygtk-gtkactiongroup.xml
deleted file mode 100644
index 6ef84f5e..00000000
--- a/docs/reference/pygtk-gtkactiongroup.xml
+++ /dev/null
@@ -1,1054 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkactiongroup">
- <refnamediv>
- <refname>gtk.ActionGroup</refname>
- <refpurpose>a group of actions (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ActionGroup</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkactiongroup">gtk.ActionGroup</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--get-name">get_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--get-sensitive">get_sensitive</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--set-sensitive">set_sensitive</link></methodname>
- <methodparam><parameter role="keyword">sensitive</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--get-visible">get_visible</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--set-visible">set_visible</link></methodname>
- <methodparam><parameter role="keyword">visible</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--get-action">get_action</link></methodname>
- <methodparam><parameter role="keyword">action_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--list-actions">list_actions</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--add-action">add_action</link></methodname>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--add-action-with-accel">add_action_with_accel</link></methodname>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- <methodparam><parameter role="keyword">accelerator</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--remove-action">remove_action</link></methodname>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--add-actions">add_actions</link></methodname>
- <methodparam><parameter role="keyword">entries</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--add-toggle-actions">add_toggle_actions</link></methodname>
- <methodparam><parameter role="keyword">entries</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--add-radio-actions">add_radio_actions</link></methodname>
- <methodparam><parameter role="keyword">entries</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">on_change</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--set-translation-domain">set_translation_domain</link></methodname>
- <methodparam><parameter role="keyword">domain</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkactiongroup--translate-string">translate_string</link></methodname>
- <methodparam><parameter role="keyword">string</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkactiongroup">gtk.ActionGroup</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkactiongroup">
- <title>gtk.ActionGroup Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"name"</entry>
- <entry>Read-Write</entry>
- <entry>A name for the action group.</entry>
- </row>
-
- <row valign="top">
- <entry>"sensitive"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the action group is
-enabled.</entry>
- </row>
-
- <row valign="top">
- <entry>"visible"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the action group is
-visible.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkactiongroup">
- <title>gtk.ActionGroup Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkactiongroup--connect-proxy">connect-proxy</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>actiongroup</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>proxy</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkactiongroup--disconnect-proxy">disconnect-proxy</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>actiongroup</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>proxy</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkactiongroup--post-activate">post-activate</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>actiongroup</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkactiongroup--pre-activate">pre-activate</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>actiongroup</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para><link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> objects
-are organized into <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-objects. An action group is basically a map from names to <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>
-objects.</para>
-
- <para>All actions that would make sense to use in a particular context
-should be in a single action group. Multiple action groups may be used for a
-particular user interface. In fact, it is expected that most nontrivial
-applications will make use of multiple groups. For example, in an
-application that can edit multiple documents, there could be one group
-holding global actions (e.g. quit, about, new), and one group per document
-holding actions that act on that document (e.g. save, cut/copy/paste,
-etc). Each window's menus would be constructed from a combination of the two
-action groups.</para>
-
- <para>Accelerators are handled by the GTK+ accelerator map. All actions
-are assigned an accelerator path (which normally has the form
-"&lt;Actions&gt;/group-name/action-name") and a shortcut is associated with
-this accelerator path. All menuitems and toolitems take on this accelerator
-path. The GTK+ accelerator map code makes sure that the correct shortcut is
-displayed next to the menu item.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkactiongroup">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ActionGroup</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the action group.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-object with the name specified by <parameter>name</parameter>. The name of
-the action group is used when associating keybindings with the
-actions.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkactiongroup--get-name">
- <title>gtk.ActionGroup.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the action
-group.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_name</methodname>() method returns the value
-of the "name" property that contains the name of the action group.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--get-sensitive">
- <title>gtk.ActionGroup.get_sensitive</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_sensitive</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the group is
-sensitive.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_sensitive</methodname>() method returns the
-value of the "sensitive" property. If "sensitive" is <literal>True</literal>
-the group is enabled. The constituent actions can only be logically
-sensitive (see the <link
-linkend="method-gtkaction--is-sensitive"><methodname>gtk.Action.is_sensitive()</methodname></link>
-method) if they are sensitive (see the <link
-linkend="method-gtkaction--get-sensitive"><methodname>gtk.Action.get_sensitive()</methodname></link>
-method) and their group is sensitive.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--set-sensitive">
- <title>gtk.ActionGroup.set_sensitive</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_sensitive</methodname>
- <methodparam><parameter role="keyword">sensitive</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">sensitive</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the group is
-enabled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_sensitive</methodname>() method sets the
- "sensitive" property to the value of
- <parameter>sensitive</parameter>. If <parameter>sensitive</parameter>
- is <literal>True</literal>, the <link
- linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
- is enabled.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--get-visible">
- <title>gtk.ActionGroup.get_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the group is
-visible.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_visible</methodname>() method returns the
-value of the "visible" property. If "visible" is <literal>True</literal>,
-the group is visible. The constituent actions can only be logically visible
-(see the <link
-linkend="method-gtkaction--is-visible"><methodname>gtk.Action.is_visible()</methodname></link>
-method) if they are visible (see the <link
-linkend="method-gtkaction--get-visible"><methodname>gtk.Action.get_visible()</methodname></link>
-method) and their group is visible.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--set-visible">
- <title>gtk.ActionGroup.set_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible</methodname>
- <methodparam><parameter role="keyword">visible</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">visible</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the group will be
-visible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_visible</methodname>() method sets the
-"visible" property to the value of <parameter>visible</parameter>. If
-<parameter>visible</parameter> is <literal>True</literal> the <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-will be visible.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--get-action">
- <title>gtk.ActionGroup.get_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_action</methodname>
- <methodparam><parameter role="keyword">action_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">action_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the action, or <literal>None</literal> if no
-action with that name exists.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_action</methodname>() method retrieves the
-action in the action group with the name specified by
-<parameter>action_name</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--list-actions">
- <title>gtk.ActionGroup.list_actions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_actions</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the action objects in the action
-group</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>list_action</methodname>() method returns a list
-containing the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> objects
-in the action group.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--add-action">
- <title>gtk.ActionGroup.add_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_action</methodname>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">action</parameter>&nbsp;:</term>
- <listitem><simpara>an action</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_action</methodname>() method adds the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> specified
-by <parameter>action</parameter> to the action group.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--add-action-with-accel">
- <title>gtk.ActionGroup.add_action_with_accel</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_action_with_accel</methodname>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- <methodparam><parameter role="keyword">accelerator</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">action</parameter>&nbsp;:</term>
- <listitem><simpara>the action to add</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">accelerator</parameter>&nbsp;:</term>
- <listitem><simpara>the accelerator for the action, in the format
- understood by the <link
- linkend="function-gtk--accelerator-parse"><function>gtk.accelerator_parse</function>()</link>
- function, or <literal>None</literal> to use the stock
- accelerator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_action_with_accel</methodname>() method adds
-a <link linkend="class-gtkaction"><classname>gtk.Action</classname></link>
-specified by <parameter>action</parameter> to the action group and sets up
-the accelerator specified by <parameter>accelerator</parameter>.</para>
-
- <para>If <parameter>accelerator</parameter> is
-<literal>None</literal>, this method attempts to use the accelerator
-associated with the "stock_id" property of the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>.</para>
-
- <para>Accel paths are set to
-<literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--remove-action">
- <title>gtk.ActionGroup.remove_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_action</methodname>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">action</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>remove_action</methodname>() method removes the
-<link linkend="class-gtkaction"><classname>gtk.Action</classname></link>
-specified by <parameter>action</parameter> from the action group.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--add-actions">
- <title>gtk.ActionGroup.add_actions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_actions</methodname>
- <methodparam><parameter role="keyword">entries</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">entries</parameter>&nbsp;:</term>
- <listitem><simpara>a list or tuple of action
-descriptions</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>data to pass to the action
-callbacks</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_actions</methodname>() method is a
-convenience method that creates a number of <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> objects
-based on the information in the list of action entry tuples contained in
-<parameter>entries</parameter> and adds them to the action group. The entry
-tuples can vary in size from one to six items with the following
-information:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>The name of the action. Must be specified.</simpara>
- </listitem>
- <listitem>
- <simpara>The stock id for the action. Optional with a default
-value of <literal>None</literal> if a label is specified.</simpara>
- </listitem>
- <listitem>
- <simpara>The label for the action. This field should typically be
-marked for translation, see the <link
-linkend="method-gtkactiongroup--set-translation-domain"><methodname>set_translation_domain</methodname>()</link>
-method. Optional with a default value of <literal>None</literal> if a stock
-id is specified.</simpara>
- </listitem>
- <listitem>
- <simpara>The accelerator for the action, in the format understood by
-the <link
-linkend="function-gtk--accelerator-parse"><function>gtk.accelerator_parse</function>()</link>
-function. Optional with a default value of
-<literal>None</literal>.</simpara>
- </listitem>
- <listitem>
- <simpara>The tooltip for the action. This field should typically be
-marked for translation, see the <link
-linkend="method-gtkactiongroup--set-translation-domain"><methodname>set_translation_domain</methodname>()</link>
-method. Optional with a default value of <literal>None</literal>.</simpara>
- </listitem>
- <listitem>
- <simpara>The callback function invoked when the action is
-activated. Optional with a default value of
-<literal>None</literal>.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The "activate" signals of the actions are connected to the
-callbacks and their accel paths are set to
-<literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--add-toggle-actions">
- <title>gtk.ActionGroup.add_toggle_actions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_toggle_actions</methodname>
- <methodparam><parameter role="keyword">entries</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">entries</parameter>&nbsp;:</term>
- <listitem><simpara>a list or tuple of toggle action entry
-tuples</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>data to pass to the action
-callbacks</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_toggle_actions</methodname>() method is a
-convenience method that creates a number of <link
-linkend="class-gtktoggleaction"><classname>gtk.ToggleAction</classname></link>
-objects based on the information in the list of action entry tuples
-contained in <parameter>entries</parameter> and adds them to the action
-group. The toggle action entry tuples can vary in size from one to six items
-with the following information:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>The name of the action. Must be specified.</simpara>
- </listitem>
- <listitem>
- <simpara>The stock id for the action. Optional with a default
-value of <literal>None</literal> if a label is specified.</simpara>
- </listitem>
- <listitem>
- <simpara>The label for the action. This field should typically be
-marked for translation, see the <link
-linkend="method-gtkactiongroup--set-translation-domain"><methodname>set_translation_domain</methodname>()</link>
-method. Optional with a default value of <literal>None</literal> if a stock
-id is specified.</simpara>
- </listitem>
- <listitem>
- <simpara>The accelerator for the action, in the format understood by
-the <link
-linkend="function-gtk--accelerator-parse"><function>gtk.accelerator_parse</function>()</link>
-function. Optional with a default value of
-<literal>None</literal>.</simpara>
- </listitem>
- <listitem>
- <simpara>The tooltip for the action. This field should typically be
-marked for translation, see the <link
-linkend="method-gtkactiongroup--set-translation-domain"><methodname>set_translation_domain</methodname>()</link>
-method. Optional with a default value of <literal>None</literal>.</simpara>
- </listitem>
- <listitem>
- <simpara>The callback function invoked when the action is
-activated. Optional with a default value of
-<literal>None</literal>.</simpara>
- </listitem>
- <listitem>
- <simpara>A flag indicating whether the toggle action is
-active. Optional with a default value of <literal>False</literal>.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The "activate" signals of the actions are connected to the
-callbacks and their accel paths are set to
-<literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--add-radio-actions">
- <title>gtk.ActionGroup.add_radio_actions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_radio_actions</methodname>
- <methodparam><parameter role="keyword">entries</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">on_change</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">entries</parameter>&nbsp;:</term>
- <listitem><simpara>a list or tuple of radio action entry
-tuples</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>the value of the radio action to set
-active</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">on_change</parameter>&nbsp;:</term>
- <listitem><simpara>a callback to connect to the "changed" signal
-of the first radio action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>data to pass to the
-<parameter>on_change</parameter> callback</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_radio_actions</methodname>() method is a
-convenience method that creates a number of <link
-linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link>
-objects based on the information in the list of action entry tuples
-contained in <parameter>entries</parameter> and adds them to the action
-group. The entry tuples can vary in size from one to six items with the
-following information:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>The name of the action. Must be specified.</simpara>
- </listitem>
- <listitem>
- <simpara>The stock id for the action. Optional with a default
-value of <literal>None</literal> if a label is specified.</simpara>
- </listitem>
- <listitem>
- <simpara>The label for the action. This field should typically be
-marked for translation, see the <link
-linkend="method-gtkactiongroup--set-translation-domain"><methodname>set_translation_domain</methodname>()</link>
-method. Optional with a default value of <literal>None</literal> if a stock
-id is specified.</simpara>
- </listitem>
- <listitem>
- <simpara>The accelerator for the action, in the format understood by
-the <link
-linkend="function-gtk--accelerator-parse"><function>gtk.accelerator_parse</function>()</link>
-function. Optional with a default value of
-<literal>None</literal>.</simpara>
- </listitem>
- <listitem>
- <simpara>The tooltip for the action. This field should typically be
-marked for translation, see the <link
-linkend="method-gtkactiongroup--set-translation-domain"><methodname>set_translation_domain</methodname>()</link>
-method. Optional with a default value of <literal>None</literal>.</simpara>
- </listitem>
- <listitem>
- <simpara>The value to set on the radio action. Optional with a
-default value of <literal>0</literal>. Should be specified in
-applications.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The <parameter>value</parameter> parameter specifies the radio
-action that should be set active. The "changed" signal of the first radio
-action is connected to the <parameter>on_change</parameter> callback (if
-specified and not <literal>None</literal>) and the accel paths of the
-actions are set to
-<literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--set-translation-domain">
- <title>gtk.ActionGroup.set_translation_domain</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_translation_domain</methodname>
- <methodparam><parameter role="keyword">domain</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">domain</parameter>&nbsp;:</term>
- <listitem><simpara>the translation domain to use for
-<methodname>dgettext()</methodname> calls</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_translation_domain</methodname>() method
-sets the translation domain to the string specified by
-<parameter>domain</parameter> and uses <methodname>dgettext()</methodname>
-for translating the <parameter>label</parameter> and
-<parameter>tooltip</parameter> strings of the actions added by the <link
-linkend="method-gtkactiongroup--add-actions"><methodname>add_actions</methodname>()</link>,
-<link
-linkend="method-gtkactiongroup--add-toggle-actions"><methodname>add_toggle_actions</methodname>()</link>
-and <link
-linkend="method-gtkactiongroup--add-radio-actions"><methodname>add_radio_actions</methodname>()</link>
-methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkactiongroup--translate-string">
- <title>gtk.ActionGroup.translate_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>translate_string</methodname>
- <methodparam><parameter role="keyword">string</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">string</parameter>&nbsp;:</term>
- <listitem><simpara>the string to be translated</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the translation of
-<parameter>string</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>translate_string</methodname>() method
-translates the string specified by <parameter>string</parameter> using the
-specified <function>translate_func</function>(). This is mainly intended for
-language bindings.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkactiongroup--connect-proxy">
- <title>The "connect-proxy" gtk.ActionGroup Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>actiongroup</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>proxy</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>actiongroup</parameter>&nbsp;:</term>
- <listitem><simpara>the actiongroup that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>action</parameter>&nbsp;:</term>
- <listitem><simpara>the action that is associated with
-<parameter>proxy</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>proxy</parameter>&nbsp;:</term>
- <listitem><simpara>the proxy widget associated with
-<parameter>action</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "connect-proxy" signal is emitted when the widget specified
-by <parameter>proxy</parameter> is connected to the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> specified
-by <parameter>action</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkactiongroup--disconnect-proxy">
- <title>The "disconnect-proxy" gtk.ActionGroup Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>actiongroup</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>proxy</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>actiongroup</parameter>&nbsp;:</term>
- <listitem><simpara>the actiongroup that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>action</parameter>&nbsp;:</term>
- <listitem><simpara>the action that is associated with
-<parameter>proxy</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>proxy</parameter>&nbsp;:</term>
- <listitem><simpara>the proxy widget associated with
-<parameter>action</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "disconnect-proxy" signal is emitted when the widget
-specified by <parameter>proxy</parameter> is disconnected from the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> specified
-by <parameter>action</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkactiongroup--post-activate">
- <title>The "post-activate" gtk.ActionGroup Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>actiongroup</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>actiongroup</parameter>&nbsp;:</term>
- <listitem><simpara>the actiongroup that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>action</parameter>&nbsp;:</term>
- <listitem><simpara>the action that is being
-activated</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "post-activate" signal is emitted after the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> specified
-by <parameter>action</parameter> has been activated.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkactiongroup--pre-activate">
- <title>The "pre-activate" gtk.ActionGroup Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>actiongroup</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>actiongroup</parameter>&nbsp;:</term>
- <listitem><simpara>the actiongroup that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>action</parameter>&nbsp;:</term>
- <listitem><simpara>the action that is being
-activated</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "pre-activate" signal is emitted before the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> specified
-by <parameter>action</parameter> is activated.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkadjustment.xml b/docs/reference/pygtk-gtkadjustment.xml
deleted file mode 100644
index 6c3aead1..00000000
--- a/docs/reference/pygtk-gtkadjustment.xml
+++ /dev/null
@@ -1,628 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkadjustment">
- <refnamediv>
- <refname>gtk.Adjustment</refname>
- <refpurpose>an object representing an adjustable bounded
-value</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Adjustment</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkadjustment">gtk.Adjustment</link></methodname>
- <methodparam><parameter
- role="keyword">value</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">lower</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">upper</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">step_incr</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">page_incr</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">page_size</parameter><initializer>0</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkadjustment--set-all">set_all</link></methodname>
- <methodparam><parameter
- role="keyword">value</parameter></methodparam>
- <methodparam><parameter
- role="keyword">lower</parameter></methodparam>
- <methodparam><parameter
- role="keyword">upper</parameter></methodparam>
- <methodparam><parameter
- role="keyword">step_increment</parameter></methodparam>
- <methodparam><parameter
- role="keyword">page_increment</parameter></methodparam>
- <methodparam><parameter
- role="keyword">page_size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkadjustment--changed">changed</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkadjustment--value-changed">value_changed</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkadjustment--clamp-page">clamp_page</link></methodname>
- <methodparam><parameter
- role="keyword">lower</parameter></methodparam>
- <methodparam><parameter
- role="keyword">upper</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkadjustment--get-value">get_value</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkadjustment--set-value">set_value</link></methodname>
- <methodparam><parameter
- role="keyword">value</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
-<refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkadjustment">gtk.Adjustment</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkadjustment">
- <title>gtk.Adjustment Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
-
- <note>
- <para>These properties are available in GTK+ 2.4 and above. The GTK+
- version is contained in the 3-tuple gtk.gtk_version.</para>
- </note>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"lower"</entry>
- <entry>Read-Write</entry>
- <entry>The minimum value of the adjustment. (float)</entry>
- </row>
-
- <row valign="top">
- <entry>"page-increment"</entry>
- <entry>Read-Write</entry>
- <entry>The page increment of the adjustment. (float)</entry>
- </row>
-
- <row valign="top">
- <entry>"page-size"</entry>
- <entry>Read-Write</entry>
- <entry>The page size of the adjustment. (float)</entry>
- </row>
-
- <row valign="top">
- <entry>"step-increment"</entry>
- <entry>Read-Write</entry>
- <entry>The step increment of the adjustment. (float)</entry>
- </row>
-
- <row valign="top">
- <entry>"upper"</entry>
- <entry>Read-Write</entry>
- <entry>The maximum value of the adjustment. (float)</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read-Write</entry>
- <entry>The value of the adjustment. (float)</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read-Write</entry>
- <entry>the current value (float)</entry>
- </row>
-
- <row valign="top">
- <entry>"lower"</entry>
- <entry>Read-Write</entry>
- <entry>the minimum value (float)</entry>
- </row>
-
- <row valign="top">
- <entry>"upper"</entry>
- <entry>Read-Write</entry>
- <entry>the maximum value (float)</entry>
- </row>
-
- <row valign="top">
- <entry>"step_increment"</entry>
- <entry>Read-Write</entry>
- <entry>the increment to use to make minor changes to the
-value. In a <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>
-this increment is used when the mouse is clicked on the arrows at the top
-and bottom of the scrollbar, to scroll by a small amount. (float)</entry>
- </row>
-
- <row valign="top">
- <entry>"page_increment"</entry>
- <entry>Read-Write</entry>
- <entry>the increment to use to make major changes to the
-value. In a <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>
-this increment is used when the mouse is clicked in the trough, to scroll by
-a large amount. (float)</entry>
- </row>
-
- <row valign="top">
- <entry>"page_size"</entry>
- <entry>Read-Write</entry>
- <entry>a widget specific size. In a <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>
-this is the size of the area which is currently visible. (float)</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkadjustment">
- <title>gtk.Adjustment Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkadjustment--changed">changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>adjustment</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkadjustment--value-changed">value-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>adjustment</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object contains a value which has an associated lower and upper bound,
-together with step and page increments, and a page size. It is used in
-conjunction with several PyGTK widgets, including <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>,
-<link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link>,
-and <link
-linkend="class-gtkrange"><classname>gtk.Range</classname></link> (which
-is a base class for <link
-linkend="class-gtkhscrollbar"><classname>gtk.HScrollbar</classname></link>,
-<link
-linkend="class-gtkvscrollbar"><classname>gtk.VScrollbar</classname></link>,
-<link
-linkend="class-gtkhscale"><classname>gtk.HScale</classname></link>, and
-<link
-linkend="class-gtkvscale"><classname>gtk.VScale</classname></link>).</para>
-
- <para>A <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-can be shared by multiple widgets. The <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object does not update the value itself. Instead it is left up to the
-associated widget(s) that use the <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-to control the value.</para>
-
- <para>The widget using the <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-typically calls the <link
-linkend="method-gtkadjustment--value-changed"><methodname>value_changed</methodname>()</link>
-or <link
-linkend="method-gtkadjustment--changed"><methodname>changed</methodname>()</link>
-methods after changing the value or its bounds. This results in the emission
-of the "value_changed" or "changed" signal respectively.</para>
-
- <para>A <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object contains several attributes that provide access to its value and
-bounds:</para>
- <itemizedlist>
- <listitem>
- <simpara>value</simpara>
- </listitem>
- <listitem>
- <simpara>lower</simpara>
- </listitem>
- <listitem>
- <simpara>upper</simpara>
- </listitem>
- <listitem>
- <simpara>step_increment</simpara>
- </listitem>
- <listitem>
- <simpara>page_increment</simpara>
- </listitem>
- <listitem>
- <simpara>page_size</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The attribute values can be retrieved and set similar to:</para>
-
- <programlisting>
- adjustment.upper = 25.0
- lower = adjustment.lower
-</programlisting>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkadjustment">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Adjustment</methodname>
- <methodparam><parameter
- role="keyword">value</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">lower</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">upper</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">step_incr</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">page_incr</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">page_size</parameter><initializer>0</initializer></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>the initial value.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">lower</parameter>&nbsp;:</term>
- <listitem><simpara>the minimum value.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">upper</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum value.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">step_incr</parameter>&nbsp;:</term>
- <listitem><simpara>the step increment.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">page_incr</parameter>&nbsp;:</term>
- <listitem><simpara>the page increment.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">page_size</parameter>&nbsp;:</term>
- <listitem><simpara>the page size.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new gtk.Adjustment object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para><function>gtk.Adjustment</function>() creates a new <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object with the specified attributes. Any attributes not specified are set
-to 0.0 by default.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkadjustment--set-all">
- <title>gtk.Adjustment.set_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_all</methodname>
- <methodparam><parameter
- role="keyword">value</parameter></methodparam>
- <methodparam><parameter
- role="keyword">lower</parameter></methodparam>
- <methodparam><parameter
- role="keyword">upper</parameter></methodparam>
- <methodparam><parameter
- role="keyword">step_increment</parameter></methodparam>
- <methodparam><parameter
- role="keyword">page_increment</parameter></methodparam>
- <methodparam><parameter
- role="keyword">page_size</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>the new value.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">lower</parameter>&nbsp;:</term>
- <listitem><simpara>the new minimum value.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">upper</parameter>&nbsp;:</term>
- <listitem><simpara>the new maximum value.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">step_increment</parameter>&nbsp;:</term>
- <listitem><simpara>the new step increment.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">page_increment</parameter>&nbsp;:</term>
- <listitem><simpara>the new page increment.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">page_size</parameter>&nbsp;:</term>
- <listitem><simpara>the new page size.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_all</methodname>() method sets the
-attributes of the adjustment to the specified values.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkadjustment--changed">
- <title>gtk.Adjustment.changed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>changed</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>changed</methodname>() method emits a "changed"
-signal from the adjustment. This must typically be called if any of the
-adjustment attributes other than value has changed so that the widget(s)
-using the adjustment can reflect the changes. Applications usually will not
-need to use this method since setting the attributes directly will automatically
-invoke this method.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtkadjustment--value-changed">
- <title>gtk.Adjustment.value_changed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>value_changed</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>value_changed</methodname>() method emits a
-"value_changed" signal from the adjustment. This must typically be called
-after the value attribute of the adjustment has changed. Applications
-usually will not need to use this method since setting the attribute
-directly will automatically invoke this method as will using the <link
-linkend="method-gtkadjustment--set-value"><methodname>set_value</methodname>()</link>
-method.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtkadjustment--clamp-page">
- <title>gtk.Adjustment.clamp_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clamp_page</methodname>
- <methodparam><parameter role="keyword">lower</parameter></methodparam>
- <methodparam><parameter role="keyword">upper</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">lower</parameter>&nbsp;:</term>
- <listitem>the lower value<simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">upper</parameter>&nbsp;:</term>
- <listitem><simpara>the upper value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>clamp_page</methodname>() method updates the
-adjustment value to ensure that the range between
-<parameter>lower</parameter> and <parameter>upper</parameter> is in the
-current page (i.e. between value and value + page_size). If the range is
-larger than the page size, then only the start of it will be in the current
-page. A "changed" signal will be emitted if the value is changed.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtkadjustment--get-value">
- <title>gtk.Adjustment.get_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_value</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The current value of the
-adjustment.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_value</methodname>() method gets the current
-value of the adjustment.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtkadjustment--set-value">
- <title>gtk.Adjustment.set_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_value</methodname>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>the new value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_value</methodname>() method sets the value
-of the adjustment to the specified <parameter>value</parameter>.</para>
-
- </refsect2>
-
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkadjustment--changed">
- <title>The "changed" gtk.Adjustment Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>adjustment</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the object that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "changed" signal is emitted when one (or more) of the
-adjustment attributes (except the value attribute) has changed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkadjustment--value-changed">
- <title>The "value-changed" gtk.Adjustment Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>adjustment</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the object that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "value-changed" signal is emitted when the adjustment value
-attribute has changed.</para>
-
- </refsect2>
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkalignment.xml b/docs/reference/pygtk-gtkalignment.xml
deleted file mode 100644
index 9fb07ab0..00000000
--- a/docs/reference/pygtk-gtkalignment.xml
+++ /dev/null
@@ -1,402 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkalignment">
- <refnamediv>
- <refname>gtk.Alignment</refname>
- <refpurpose>a widget that controls the alignment and size of its
-child</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Alignment</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkalignment">gtk.Alignment</link></methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">xscale</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yscale</parameter><initializer>0.0</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkalignment--set">set</link></methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xscale</parameter></methodparam>
- <methodparam><parameter
- role="keyword">yscale</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkalignment--set-padding">set_padding</link></methodname>
- <methodparam><parameter
- role="keyword">padding_top</parameter></methodparam>
- <methodparam><parameter
- role="keyword">padding_bottom</parameter></methodparam>
- <methodparam><parameter
- role="keyword">padding_left</parameter></methodparam>
- <methodparam><parameter
- role="keyword">padding_right</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkalignment--get-padding">get_padding</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-
- </classsynopsis>
-
- </refsect1>
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkalignment">gtk.Alignment</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkalignment">
- <title>gtk.Alignment Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"bottom-padding"</entry> <entry>Read/Write</entry>
- <entry>The padding to insert at the bottom of the widget. GTK+ 2.4
- and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"left-padding"</entry>
- <entry>Read/Write</entry>
- <entry>The padding to insert at the left of the widget. GTK+ 2.4
- and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"right-padding"</entry>
- <entry>Read/Write</entry>
- <entry>The padding to insert at the right of the widget. GTK+ 2.4
- and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"top-padding"</entry>
- <entry>Read/Write</entry>
- <entry>The padding to insert at the top of the widget. GTK+ 2.4
- and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"xalign"</entry>
- <entry>Read/Write</entry>
- <entry>The fraction of horizontal <emphasis>free</emphasis> space
- to the left of the child. 0.0 means no <emphasis>free</emphasis>
- space to the left, 1.0 means all <emphasis>free</emphasis> space
- to the left.</entry>
- </row>
-
- <row valign="top">
- <entry>"xscale"</entry>
- <entry>Read/Write</entry>
- <entry>The fraction of horizontal <emphasis>free</emphasis> space
-(beyond that needed by the child) that the child will absorb. 0.0 means the
-child will absorb none, 1.0 means the child will absorb all</entry>
- </row>
-
- <row valign="top">
- <entry>"yalign"</entry>
- <entry>Read/Write</entry>
- <entry>The fraction of vertical <emphasis>free</emphasis> space
- above the child. 0.0 means no <emphasis>free</emphasis> space
- above, 1.0 means all <emphasis>free</emphasis> space
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"yscale"</entry>
- <entry>Read/Write</entry>
- <entry>The fraction of vertical <emphasis>free</emphasis> space
-(beyond that needed by the child) that the child will absorb. 0.0 means the
-child will absorb none, 1.0 means the child will absorb all</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkalignment">
- <title>gtk.Alignment Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkalignment">
- <title>gtk.Alignment Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkalignment"><classname>gtk.Alignment</classname></link>
-widget controls the alignment and size of its child widget. It has four
-properties: xscale, yscale, xalign, and yalign. The scale properties are
-used to specify how much of the <emphasis>free</emphasis> (extra) space
-allocated to the <link
-linkend="class-gtkalignment"><classname>gtk.Alignment</classname></link>
-should be absorbed by the child widget. The values can range from 0.0
-(meaning the child absorbs none) to 1.0 (meaning the child absorbs all of
-the <emphasis>free</emphasis> space). If the value is 0.5, the child widget
-absorbs half the <emphasis>free</emphasis> space. The align properties are
-used to place the child widget within the available area by specifying the
-fraction of <emphasis>free</emphasis> space that will be placed above or to
-the left of the child widget. The values range from 0.0 (no
-<emphasis>free</emphasis> space above or to the left of the child) to 1.0
-(all <emphasis>free</emphasis> space above or to the left of the child). Of
-course, if the scale properties are both set to 1.0, the alignment
-properties have no effect.</para>
-
- <para>An example may make this clearer. A <link
-linkend="class-gtkimage"><classname>gtk.Button</classname></link> widget (32
-pixels wide by 32 pixels high) is placed inside a <link
-linkend="class-gtkalignment"><classname>gtk.Alignment</classname></link>
-widget (256 pixels wide by 128 pixels high) which has xalign of 0.25, yalign
-of 0.25, xscale of 0.25 and yscale of 0.25. The horizontal
-<emphasis>free</emphasis> space is 256-32=224 pixels and the vertical
-<emphasis>free</emphasis> space is 128-32=96 pixels. The button will absorb
-0.25x224=56 pixels horizontally and 0.25x96=24 pixels vertically since the
-xscale and yscale are 0.25 thus becoming 32+56=88 pixels wide by 32+24=56
-pixels high. This will leave 256-88=168 pixels of horizontal
-<emphasis>free</emphasis> space and 128-56=72 pixels of vertical
-<emphasis>free</emphasis> space. Since the xalign value is 0.25 the
-horizontal <emphasis>free</emphasis> space will be allocated as 0.25x168=42
-pixels to the left of the button and 0.72x168=126 pixels to the right.
-Likewise since the yalign is 0.25 the vertical <emphasis>free</emphasis>
-space is allocated as 0.25x72=18 pixels above the button and 0.75*72=54
-pixels below.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkalignment">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Alignment</methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">xscale</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yscale</parameter><initializer>0.0</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">xalign</parameter>&nbsp;:</term>
- <listitem><simpara>the fraction of horizontal
-<emphasis>free</emphasis> space to the left of the child widget. Ranges from
-0.0 to 1.0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">yalign</parameter>&nbsp;:</term>
- <listitem><simpara>the fraction of vertical
-<emphasis>free</emphasis> space above the child widget. Ranges from 0.0 to
-1.0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xscale</parameter>&nbsp;:</term>
- <listitem><simpara>the fraction of horizontal
-<emphasis>free</emphasis> space that the child widget absorbs, from 0.0 to
-1.0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">yscale</parameter>&nbsp;:</term>
- <listitem><simpara>the fraction of vertical
-<emphasis>free</emphasis> space that the child widget absorbs, from 0.0 to
-1.0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new alignment object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new alignment widget with the specified properties. If
-the scale and alignment parameters are not specified they default to
-0.0.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkalignment--set">
- <title>gtk.Alignment.set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set</methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xscale</parameter></methodparam>
- <methodparam><parameter
- role="keyword">yscale</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">xalign</parameter>&nbsp;:</term>
- <listitem><simpara>the fraction of horizontal
-<emphasis>free</emphasis> space to the left of the child widget. Ranges from
-0.0 to 1.0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">yalign</parameter>&nbsp;:</term>
- <listitem><simpara>the fraction of vertical
-<emphasis>free</emphasis> space above the child widget. Ranges from 0.0 to
-1.0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xscale</parameter>&nbsp;:</term>
- <listitem><simpara>the fraction of horizontal
-<emphasis>free</emphasis> space that the child widget absorbs, from 0.0 to
-1.0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">yscale</parameter>&nbsp;:</term>
- <listitem><simpara>the fraction of vertical
-<emphasis>free</emphasis> space that the child widget absorbs, from 0.0 to
-1.0</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set</methodname>() method sets the properties of
-the alignment widget to the specified values.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkalignment--set-padding">
- <title>gtk.Alignment.set_padding</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_padding</methodname>
- <methodparam><parameter
- role="keyword">padding_top</parameter></methodparam>
- <methodparam><parameter
- role="keyword">padding_bottom</parameter></methodparam>
- <methodparam><parameter
- role="keyword">padding_left</parameter></methodparam>
- <methodparam><parameter
- role="keyword">padding_right</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">padding_top</parameter>&nbsp;:</term>
- <listitem><simpara> the padding at the top of the
- widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">padding_bottom</parameter>&nbsp;:</term>
- <listitem><simpara> the padding at the bottom of the
- widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">padding_left</parameter>&nbsp;:</term>
- <listitem><simpara> the padding at the left of the
- widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">padding_right</parameter>&nbsp;:</term>
- <listitem><simpara> the padding at the right of the
- widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_padding</methodname>() method sets the
-padding around the sides of the alignment widget to the values specified by
-<parameter>padding_top</parameter>, <parameter>padding_bottom</parameter>,
-<parameter>padding_left</parameter> and
-<parameter>padding_right</parameter>. The padding adds blank space to the
-sides of the widget. For instance, this can be used to indent the child
-widget toward the right by adding padding on the left.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkalignment--get-padding">
- <title>gtk.Alignment.get_padding</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_padding</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 4-tuple containing the padding set on the
- top, bottom, left and right sides of the
- widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_padding</methodname>() method returns a
- 4-tuple containing the padding set on the sides of the widget.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkarrow.xml b/docs/reference/pygtk-gtkarrow.xml
deleted file mode 100644
index e992151d..00000000
--- a/docs/reference/pygtk-gtkarrow.xml
+++ /dev/null
@@ -1,200 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkarrow">
- <refnamediv>
- <refname>gtk.Arrow</refname>
- <refpurpose>produces an arrow pointing in one of the four cardinal
-directions.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Arrow</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkmisc">gtk.Misc</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkarrow">gtk.Arrow</link></methodname>
- <methodparam><parameter
- role="keyword">arrow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkarrow--set">set</link></methodname>
- <methodparam><parameter
- role="keyword">arrow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkmisc">gtk.Misc</link>
- +-- <link linkend="class-gtkarrow">gtk.Arrow</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkarrow">
- <title>gtk.Arrow Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkmisc">gtk.Misc Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"arrow-type"</entry>
- <entry>Read/Write</entry>
- <entry>The direction the arrow should point (gtk.ARROW_UP,
-gtk.ARROW_DOWN, gtk.ARROW_LEFT, or gtk.ARROW_RIGHT)</entry>
- </row>
-
- <row valign="top">
- <entry>"shadow-type"</entry>
- <entry>Read/Write</entry>
- <entry>Appearance of the shadow surrounding the arrow
- (<literal>gtk.SHADOW IN, gtk.SHADOW OUT, gtk.ETCHED IN, or
- gtk.ETCHED OUT</literal>)</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkarrow">
- <title>gtk.Arrow Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkarrow">
- <title>gtk.Arrow Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkarrow"><classname>gtk.Arrow</classname></link> is used to
-draw simple arrows that point in one of the four cardinal directions
-(gtk.ARROW_UP, gtk.ARROW_DOWN, gtk.ARROW_LEFT, or gtk.ARROW_RIGHT). The
-shadow style of the arrow can be one of gtk.SHADOW IN, gtk.SHADOW OUT,
-gtk.ETCHED IN, or gtk.ETCHED OUT.</para>
-
- <para>A <link
-linkend="class-gtkarrow"><classname>gtk.Arrow</classname></link> will fill
-any space alloted to it, but since it is inherited from <link
-linkend="class-gtkmisc"><classname>gtk.Misc</classname></link>, it can be
-padded and/or aligned, to fill exactly the space desired.</para>
-
- <para>Arrows are created with a call to <link
-linkend="constructor-gtkarrow"><methodname>gtk.Arrow</methodname>()</link>.
-The direction or style of an arrow can be changed after creation by using
-<link
-linkend="method-gtkarrow--set"><methodname>arrow_set</methodname>()</link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkarrow">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Arrow</methodname>
- <methodparam><parameter
- role="keyword">arrow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">arrow_type</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref linkend="gtk-arrow-type-constants"
-endterm="gtk-arrow-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>one
-of the <xref linkend="gtk-shadow-type-constants"
-endterm="gtk-shadow-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkarrow"><classname>gtk.Arrow</classname></link>
- widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new arrow widget with the specified
-<parameter>arrow_type</parameter> and
-<parameter>arrow_shadow</parameter>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkarrow--set">
- <title>gtk.Arrow.set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set</methodname>
- <methodparam><parameter
- role="keyword">arrow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">arrow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a GtkArrowType</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
-linkend="gtk-shadow-type-constants"
-endterm="gtk-shadow-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set</methodname>() method sets the
-<parameter>arrow_type</parameter> and <parameter>shadow_type</parameter> of
-the arrow widget.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkaspectframe.xml b/docs/reference/pygtk-gtkaspectframe.xml
deleted file mode 100644
index d5975a0a..00000000
--- a/docs/reference/pygtk-gtkaspectframe.xml
+++ /dev/null
@@ -1,293 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkaspectframe">
- <refnamediv>
- <refname>gtk.AspectFrame</refname>
- <refpurpose>A frame that constrains its child to a particular aspect
-ratio.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.AspectFrame</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkframe">gtk.Frame</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkaspectframe">gtk.AspectFrame</link></methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">xalign</parameter><initializer>0.5</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter><initializer>0.5</initializer></methodparam>
- <methodparam><parameter
- role="keyword">ratio</parameter><initializer>1.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">obey_child</parameter><initializer>True</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkaspectframe--set">set</link></methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">ratio</parameter><initializer>1.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">obey_child</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkframe">gtk.Frame</link>
- +-- <link linkend="class-gtkaspectframe">gtk.AspectFrame</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkaspectframe">
- <title>gtk.AspectFrame Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkframe">gtk.Frame Properties</link></para>
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"obey-child"</entry>
- <entry>Read/Write</entry>
- <entry>Make aspect ratio match that of the child widget</entry>
- </row>
-
- <row valign="top">
- <entry>"xalign"</entry>
- <entry>Read/Write</entry>
- <entry>The fraction of horizontal <emphasis>free</emphasis> space
- to the left of the child. 0.0 means no <emphasis>free</emphasis>
- space to the left, 1.0 means all <emphasis>free</emphasis> space
- to the left.</entry>
- </row>
-
- <row valign="top">
- <entry>"ratio"</entry>
- <entry>Read/Write</entry>
- <entry>The aspect ratio of the widget in the range of 0.0001 to
- 10000.0 if "obey-child" is <literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"yalign"</entry>
- <entry>Read/Write</entry>
- <entry>The fraction of vertical <emphasis>free</emphasis> space
- above the child. 0.0 means no <emphasis>free</emphasis> space
- above, 1.0 means all <emphasis>free</emphasis> space
- above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkaspectframe">
- <title>gtk.AspectFrame Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkaspectframe">
- <title>gtk.AspectFrame Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkaspectframe"><classname>gtk.AspectFrame</classname></link>
-packs a widget so that it can resize but always retains the same aspect
-ratio. For instance, one might be drawing a small preview of a larger image.
-<link
-linkend="class-gtkaspectframe"><classname>gtk.AspectFrame</classname></link>
-derives from <link
-linkend="class-gtkframe"><classname>gtk.Frame</classname></link>, so it can
-draw a label and a frame around the child. The frame will be
-"shrink-wrapped" to the size of the child.</para>
-
- <para>The aspect frame "ratio" property determines the widget
-width:height ratio. An aspect ratio of 0.5 means the width is one half the
-height; an aspect ratio of 2.0 means the width is twice the height. The
-default value for the "ratio" property is 1.0.</para>
-
- <para>The align properties are used to place the child widget within the
-available area by specifying the fraction of <emphasis>free</emphasis> space
-(space in the aspect frame that is not used by the child widget) that is
-placed above or to the left of the child widget. The values range from 0.0
-(meaning no <emphasis>free</emphasis> space above or to the left of the
-child) to 1.0 (meaning all <emphasis>free</emphasis> space above or to the
-left of the child) . The default value for both align properties is
-0.5.</para>
-
- <para>If the "obey-child" property is True (the default value), the
-"ratio" property is ignored and the aspect ratio is set by the child
-widget.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkaspectframe">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.AspectFrame</methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">xalign</parameter><initializer>0.5</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter><initializer>0.5</initializer></methodparam>
- <methodparam><parameter
- role="keyword">ratio</parameter><initializer>1.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">obey_child</parameter><initializer>True</initializer></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string used to set the aspect frame
-label</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xalign</parameter>&nbsp;:</term>
- <listitem><simpara>The fraction of horizontal
-<emphasis>free</emphasis> space to the left of the child. 0.0 means no
-<emphasis>free</emphasis> space to the left, 1.0 means all
-<emphasis>free</emphasis> space to the left.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">yalign</parameter>&nbsp;:</term>
- <listitem><simpara>The fraction of vertical
-<emphasis>free</emphasis> space above the child. 0.0 means no
-<emphasis>free</emphasis> space above, 1.0 means all
-<emphasis>free</emphasis> space above.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ratio</parameter>&nbsp;:</term>
- <listitem><simpara>the ratio of the child width to height (in the
-range 0.0001 to 10000.0) if <parameter>obey_child</parameter> is
-False</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">obey_child</parameter>&nbsp;:</term>
- <listitem><simpara>if True, <parameter>ratio</parameter> is ignored,
-and the aspect ratio is taken from the requisition of the
-child.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new aspect frame object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new aspect frame object with the specified
-<parameter>label</parameter>, <parameter>xalign</parameter> and
-<parameter>yalign</parameter> values. The default values are:
-<parameter>label</parameter>, None; <parameter>xalign</parameter>, 0.5; and,
-<parameter>yalign</parameter>, 0.5. If <parameter>obey_child</parameter> is
-True the <parameter>ratio</parameter> value is ignored. If
-<parameter>obey_child</parameter> is False, <parameter>ratio</parameter>
-sets the aspect ratio for the child widget. The default value for
-<parameter>ratio</parameter> is 1.0. The default value for
-<parameter>obey_child</parameter> is True.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkaspectframe--set">
- <title>gtk.AspectFrame.set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set</methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">ratio</parameter><initializer>1.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">obey_child</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">xalign</parameter>&nbsp;:</term>
- <listitem><simpara>The fraction of horizontal
-<emphasis>free</emphasis> space to the left of the child. 0.0 means no
-<emphasis>free</emphasis> space to the left, 1.0 means all
-<emphasis>free</emphasis> space to the left.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">yalign</parameter>&nbsp;:</term>
- <listitem><simpara>The fraction of vertical
-<emphasis>free</emphasis> space above the child. 0.0 means no
-<emphasis>free</emphasis> space above, 1.0 means all
-<emphasis>free</emphasis> space above.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ratio</parameter>&nbsp;:</term>
- <listitem><simpara>the ratio of the child width to height (in the
-range 0.0001 to 10000.0) if <parameter>obey_child</parameter> is
-False</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">obey_child</parameter>&nbsp;:</term>
- <listitem><simpara>if True, <parameter>ratio</parameter> is
-ignored, and the aspect ratio is taken from the requisition of the
-child</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set</methodname>() method changes the aspect
-frame properties to the values specified by <parameter>xalign</parameter>,
-<parameter>yalign</parameter>, <parameter>ratio</parameter> and
-<parameter>obey_child</parameter>. The default values are:
-<parameter>xalign</parameter>, 0; <parameter>yalign</parameter>, 0.0;
-<parameter>ratio</parameter>, 1.0; and, <parameter>obey_child</parameter>,
-True.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkassistant.xml b/docs/reference/pygtk-gtkassistant.xml
deleted file mode 100644
index 00d30a8d..00000000
--- a/docs/reference/pygtk-gtkassistant.xml
+++ /dev/null
@@ -1,1179 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkassistant">
- <refnamediv>
- <refname>gtk.Assistant</refname>
- <refpurpose>a widget used to guide users through multi-step operations
- (new in PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Assistant</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkwindow">gtk.Window</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname>gtk.Assistant</methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--get-current-page">get_current_page</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--set-current-page">set_current_page</link></methodname>
- <methodparam><parameter role="keyword">page_num</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--get-n-pages">get_n_pages</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--get-nth-page">get_nth_page</link></methodname>
- <methodparam><parameter role="keyword">page_num</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--prepend-page">prepend_page</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--append-page">append_page</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--insert-page">insert_page</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--set-forward-page-func">set_forward_page_func</link></methodname>
- <methodparam><parameter role="keyword">page_func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--set-page-type">set_page_type</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--get-page-type">get_page_type</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--set-page-title">set_page_title</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--get-page-title">get_page_title</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--set-page-header-image">set_page_header_image</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">pixbuf</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--get-page-header-image">get_page_header_image</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--set-page-side-image">set_page_side_image</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">pixbuf</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--get-page-side-image">get_page_side_image</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--set-page-complete">set_page_complete</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">complete</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--get-page-complete">get_page_complete</link></methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--add-action-widget">add_action_widget</link></methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--remove-action-widget">remove_action_widget</link></methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkassistant--update-buttons-state">update_buttons_state</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkwidget">gtk.Assistant</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkassistant">
- <title>gtk.Assistant Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkassistant">
- <title>gtk.Assistant Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"content-padding"</entry>
- <entry>Read</entry>
- <entry>Number of pixels around the content pages. Allowed
- values: >= 0. Default value: 1. This property is available in
- GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"header-padding"</entry>
- <entry>Read</entry>
- <entry>Number of pixels around the header. Allowed values: >=
- 0 Default value: 6. This property is available in GTK+ 2.10
- and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkassistant">
- <title>gtk.Assistant Child Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"complete"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, marks a page as complete
- (i.e.: all the required fields are filled out). GTK+ uses this
- information to control the sensitivity of the navigation
- buttons. Default value: <literal>False</literal>. This property
- is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"header-image"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
- image that is displayed in the page header. This property is
- available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"page-type"</entry>
- <entry>Read-Write</entry>
- <entry>The type of the assistant page - one of the <xref
- linkend="gtk-assistant-page-type-constants"
- endterm="gtk-assistant-page-type-constants-title"></xref> .
- Default value:
- <literal>gtk.ASSISTANT_PAGE_CONTENT</literal>. This property
- is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"sidebar-image"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
- image displayed in the sidebar for the assistant page. Set
- this to <literal>None</literal> to make the sidebar
- disappear. This property is available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"title"</entry>
- <entry>Read-Write</entry>
- <entry>The title that is displayed in the page header. If
- "title" and "header-image" are both <literal>None</literal>,
- no header is displayed. Default value:
- <literal>None</literal>. This property is available in GTK+
- 2.10 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkassistant">
- <title>gtk.Assistant Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkassistant--apply">apply</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkassistant--cancel">cancel</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkassistant--close">close</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkassistant--prepare">prepare</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>page</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
- linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
- is a widget used to guide the user through a complex operation by
- breaking it into several steps. Each step is generally handled by one
- assistant page. The assistant controls the page flow to collect the
- necessary data to complete the application task.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkassistant">
- <title>gtk.Assistant</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Assistant</methodname>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
- object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkassistant--get-current-page">
- <title>gtk.Assistant.get_current_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_current_page</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <term><parameter
-role="keyword"></parameter>&nbsp;:</term>
- <listitem><simpara>The index (starting from 0) of the current page
- in the assistant, if the assistant has no pages, -1 will be
- returned.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_current_page</methodname>() method returns
- the page number of the current page.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--set-current-page">
- <title>gtk.Assistant.set_current_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_current_page</methodname>
- <methodparam><parameter
- role="keyword">page_num</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_num</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the page to switch to, starting
- from 0. If negative, the last page will be used. If greater than
- the number of pages in the assistant, there will be no
- change.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_current_page</methodname>() method switches
- the page to the page specified by
- <parameter>page_num</parameter>. Note that this will only be necessary
- in custom buttons, as the assistant flow can be set with the <link
- linkend="method-gtkassistant--set-forward-page-func"><methodname>set_forward_page_func</methodname>()</link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--get-n-pages">
- <title>gtk.Assistant.get_n_pages</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_pages</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The number of pages in the assistant.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_n_pages</methodname>() method returns the
- number of pages in the assistant</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--get-nth-page">
- <title>gtk.Assistant.get_nth_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_nth_page</methodname>
- <methodparam><parameter role="keyword">page_num</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_num</parameter>&nbsp;:</term>
- <listitem><simpara>The index of a page in the assistant, or -1 to
- get the last page;</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The child widget, or <literal>None</literal> if
- <parameter>page_num</parameter> is out of
- bounds.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_nth_page</methodname>() method returns the
- child widget contained in the page specified by
- <parameter>page_num</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--prepend-page">
- <title>gtk.Assistant.prepend_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend_page</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the index (starting at 0) of the inserted
- page</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>prepend_page</methodname>() method prepends the
- page specified by <parameter>page</parameter> to the assistant.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--append-page">
- <title>gtk.Assistant.append_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append_page</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the index (starting at 0) of the inserted
- page</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>append_page</methodname>() method appends the
- page specified by <parameter>page</parameter> to the assistant.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--insert-page">
- <title>gtk.Assistant.insert_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_page</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the index (starting at 0) at which to insert the
- page, or -1 to append the page to the assistant</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the index (starting from 0) of the inserted
- page</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>insert_page</methodname>() method inserts the
- page specified by <parameter>page</parameter> in the assistant at the
- position index specified by <parameter>position</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--set-forward-page-func">
- <title>gtk.Assistant.set_forward_page_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_forward_page_func</methodname>
- <methodparam><parameter role="keyword">page_func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_func</parameter>&nbsp;:</term>
- <listitem><simpara>the function, or <literal>None</literal> to use
- the default function.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>user data for
- <parameter>page_func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_forward_page_func</methodname>() method sets
- the page forwarding function to be
- <parameter>page_func</parameter>. This function will be used to
- determine what will be the next page when the user presses the forward
- button. Setting <parameter>page_func</parameter> to
- <literal>None</literal> will make the assistant use the default
- forward function, which just goes to the next visible page.</para>
-
- <para>The signature of <parameter>page_func</parameter> is:</para>
-
- <programlisting>
- def page_func(current_page, user_data):
- </programlisting>
-
- <para>where <parameter>current_page</parameter> is the index of the
- current page and <parameter>user_data</parameter> is
- <parameter>data</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--set-page-type">
- <title>gtk.Assistant.set_page_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_page_type</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a page in the assistant</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the new type for
- <parameter>page</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_page_type</methodname>() method sets the
- page type, which specifies the page behavior, for the page specified
- by <parameter>page</parameter> to the value specified by
- <parameter>type</parameter>. The page type must be one of the <xref
- linkend="gtk-assistant-page-type-constants"
- endterm="gtk-assistant-page-type-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--get-page-type">
- <title>gtk.Assistant.get_page_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_type</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a page in the assistant</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the page type of
- <parameter>page</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_page_type</methodname>() method returns the
- page type of the page specified by <parameter>page</parameter>. The
- page type will be one of the <xref
- linkend="gtk-assistant-page-type-constants"
- endterm="gtk-assistant-page-type-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--set-page-title">
- <title>gtk.Assistant.set_page_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_page_title</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a page of the assistant</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>the new title for
- <parameter>page</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_page_title</methodname>() method sets the
- title for the page specified by <parameter>page</parameter> to the
- string specified by <parameter>title</parameter>. The title is
- displayed in the header area of the assistant when
- <parameter>page</parameter> is the current page.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--get-page-title">
- <title>gtk.Assistant.get_page_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_title</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a page of the assistant</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the title for
- <parameter>page</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_page_title</methodname>() method returns the
- title for the page specified by <parameter>page</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--set-page-header-image">
- <title>gtk.Assistant.set_page_header_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_page_header_image</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">pixbuf</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a page of the assistant</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>the new header image for
- <parameter>page</parameter> or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_page_header_image</methodname>() method sets
- the <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
- specified by <parameter>pixbuf</parameter> as the header image for the
- page specified by <parameter>page</parameter>. This image is displayed
- in the header area of the assistant when <parameter>page</parameter>
- is the current page. If <parameter>pixbuf</parameter> is
- <literal>None</literal> the header image will be removed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--get-page-header-image">
- <title>gtk.Assistant.get_page_header_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_header_image</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a page of the assistant</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the header image for <parameter>page</parameter>,
- or <literal>None</literal> if there's no header image for the
- page.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_page_header_image</methodname>() method
- returns the header image for the page specified by
- <parameter>page</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--set-page-side-image">
- <title>gtk.Assistant.set_page_side_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_page_side_image</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">pixbuf</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a page of the assistant</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>the new side image for
- <parameter>page</parameter> or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_page_side_image</methodname>() method sets
- the <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
- specified by <parameter>pixbuf</parameter> as the header image for the
- page specified by <parameter>page</parameter>. This image is displayed
- in the side area of the assistant when <parameter>page</parameter> is
- the current page. If <parameter>pixbuf</parameter> is
- <literal>None</literal> the side image will be removed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--get-page-side-image">
- <title>gtk.Assistant.get_page_side_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_side_image</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a page of the assistant</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the side image for <parameter>page</parameter>,
- or <literal>None</literal> if there's no side image for the
- page.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_page_side_image</methodname>() method
- returns the header image for the page specified by
- <parameter>page</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--set-page-complete">
- <title>gtk.Assistant.set_page_complete</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_page_complete</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- <methodparam><parameter role="keyword">complete</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a page of the assistant</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">complete</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the page status is
- complete.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_page_complete</methodname>() method sets the
- "complete" property of the page specified by
- <parameter>page</parameter> to the value specified by
- <parameter>complete</parameter>. If <parameter>complete</parameter> is
- <literal>True</literal> the <parameter>page</parameter> contents are
- complete. This will make the assistant update the state of its
- buttons.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--get-page-complete">
- <title>gtk.Assistant.get_page_complete</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_complete</methodname>
- <methodparam><parameter role="keyword">page</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>a page of the assistant</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>page</parameter> is complete.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_page_complete</methodname>() method returns
- the value of the "complete" property of the page specified by
- <parameter>page</parameter>. If the return value is
- <literal>True</literal>, the <parameter>page</parameter> contents are
- complete.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--add-action-widget">
- <title>gtk.Assistant.add_action_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_action_widget</methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>add_action_widget</methodname>() method adds the
- widget specified by <parameter>child</parameter> to the action area of
- the assistant.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--remove-action-widget">
- <title>gtk.Assistant.remove_action_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_action_widget</methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>remove_action_widget</methodname>() method
- removes the widget specified by <parameter>child</parameter> from the
- action area of the assistant.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkassistant--update-buttons-state">
- <title>gtk.Assistant.update_buttons_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>update_buttons_state</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>update_buttons_state</methodname>() method
- forces the assistant to recompute the state of its buttons.</para>
-
- <para>PyGTK automatically takes care of this in most situations,
- e.g. when the user goes to a different page, or when the visibility or
- completeness of a page changes.</para>
-
- <para>One situation where it can be necessary to call this function is
- when changing a value on the current page affects the future page flow
- of the assistant.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkassistant--apply">
- <title>The "apply" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>assistant</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>assistant</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
- that received the signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
- any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "apply" signal is emitted when the apply button is
- clicked. The default behavior of the <link
- linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
- is to switch to the page after the current page, unless the current
- page is the last one.</para>
-
- <para>A handler for the "apply" signal should carry out the actions
- for which the wizard has collected data. If the action takes a long
- time to complete, you might consider to put a page of type
- <literal>gtk.ASSISTANT_PAGE_PROGRESS</literal> after the confirmation
- page and handle this operation within the "prepare" signal of the
- progress page.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkassistant--cancel">
- <title>The "cancel" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>assistant</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>assistant</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
- that received the signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "cancel" signal is emitted when the cancel button is
- clicked.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkassistant--close">
- <title>The "close" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>assistant</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>assistant</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
- that received the signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "close" signal is emitted either when the close button of a
- summary page is clicked, or when the apply button in the last page in
- the flow (of type <literal>gtk.ASSISTANT_PAGE_CONFIRM</literal>) is
- clicked.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkassistant--prepare">
- <title>The "prepare" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>assistant</parameter></methodparam>
- <methodparam><parameter>page</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>assistant</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link>
- that received the signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>page</parameter>&nbsp;:</term>
- <listitem><simpara>the new page to prepare for
- display</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "prepare" signal is emitted when a new page is set as the
- assistant's current page, but before making the new page visible. A
- handler for this signal can do any preparation that are necessary
- before showing <parameter>page</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkbin.xml b/docs/reference/pygtk-gtkbin.xml
deleted file mode 100644
index 9de8dd51..00000000
--- a/docs/reference/pygtk-gtkbin.xml
+++ /dev/null
@@ -1,135 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkbin">
- <refnamediv>
- <refname>gtk.Bin</refname>
- <refpurpose>an abstract base class defining a container with just one
-child.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Bin</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbin--get-child">get_child</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkbin">
- <title>gtk.Bin Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkbin">
- <title>gtk.Bin Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkbin">
- <title>gtk.Bin Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"child"</entry>
- <entry>Read</entry>
- <entry>The child widget or <literal>None</literal> if there
-is no child.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link linkend="class-gtkbin"><classname>gtk.Bin</classname></link>
-is an abstract base class defining a widget that is a container with just
-one child. It is useful for deriving subclasses, since it provides the
-common code needed for handling a single child widget. Many PyGTK widgets
-are subclasses of <link
-linkend="class-gtkbin"><classname>gtk.Bin</classname></link>, including
-<link linkend="class-gtkwindow"><classname>gtk.Window</classname></link>,
-<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link>,
-<link linkend="class-gtkframe"><classname>gtk.Frame</classname></link>,
-<link
-linkend="class-gtkhandlebox"><classname>gtk.HandleBox</classname></link>,
-and <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkbin--get-child">
- <title>gtk.Bin.get_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_child</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a reference to the child
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_child</methodname>() method returns a
-reference to the child of the bin, or <literal>None</literal> if the bin
-contains no child widget.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkborder.xml b/docs/reference/pygtk-gtkborder.xml
deleted file mode 100644
index 59294189..00000000
--- a/docs/reference/pygtk-gtkborder.xml
+++ /dev/null
@@ -1,99 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkborder">
- <refnamediv>
- <refname>gtk.Border</refname>
- <refpurpose>an object containing data for a border (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Border</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkborder--copy">copy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkborder--free">free</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtkborder"><classname>gtk.Border</classname></link> object
-contains the integer values for the left, right, top and bottom values of a
-border. <link
-linkend="class-gtkborder"><classname>gtk.Border</classname></link> is used
-in <link linkend="class-gtkstyle"><classname>gtk.Style</classname></link>
-specifications. <link
-linkend="class-gtkborder"><classname>gtk.Border</classname></link> has two
-methods: <link
-linkend="method-gtkborder--copy"><methodname>copy</methodname>()</link> and
-<link
-linkend="method-gtkborder--free"><methodname>free</methodname>()</link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkborder--copy">
- <title>gtk.Border.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the border.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>copy</methodname>() method returns a copy of the
-border object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkborder--free">
- <title>gtk.Border.free</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>free</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <warning>
- <para>This method is deprecated and should not be used since it can
- crash your application.</para>
- </warning>
-
- <para>The <methodname>free</methodname>() method frees the memory used
- by the border.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkbox.xml b/docs/reference/pygtk-gtkbox.xml
deleted file mode 100644
index a1b4f601..00000000
--- a/docs/reference/pygtk-gtkbox.xml
+++ /dev/null
@@ -1,706 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkbox">
- <refnamediv>
- <refname>gtk.Box</refname>
- <refpurpose>an abstract base class for box containers</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Box</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbox--pack-start">pack_start</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter><initializer>True</initializer></methodparam>
- <methodparam><parameter
- role="keyword">padding</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbox--pack-end">pack_end</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter><initializer>True</initializer></methodparam>
- <methodparam><parameter
- role="keyword">padding</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbox--pack-start-defaults">pack_start_defaults</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbox--pack-end-defaults">pack_end_defaults</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbox--set-homogeneous">set_homogeneous</link></methodname>
- <methodparam><parameter
- role="keyword">homogeneous</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbox--get-homogeneous">get_homogeneous</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbox--set-spacing">set_spacing</link></methodname>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbox--get-spacing">get_spacing</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbox--reorder-child">reorder_child</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbox--query-child-packing">query_child_packing</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbox--set-child-packing">set_child_packing</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter
- role="keyword">padding</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pack_type</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkbox">
- <title>gtk.Box Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"spacing"</entry>
- <entry>Read/Write</entry>
- <entry>The amount of space between children.</entry>
- </row>
-
- <row valign="top">
- <entry>"homogeneous"</entry>
- <entry>Read/Write</entry>
- <entry>If True the children should all be the same size.</entry>
- </row>
-
- <row valign="top">
- <entry>"spacing"</entry>
- <entry>Read/Write</entry>
- <entry>The amount of space between children.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkbox">
- <title>gtk.Box Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkbox">
- <title>gtk.Box Child Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"expand"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> the child should receive
- extra space when the parent grows</entry>
- </row>
-
- <row valign="top">
- <entry>"fill"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> extra space given to the
- child should be allocated to the child; if
- <literal>False</literal> extra space given to the child should
- be used as padding</entry>
- </row>
-
- <row valign="top">
- <entry>"padding"</entry>
- <entry>Read/Write</entry>
- <entry>The amount of extra space to put between the child and
- its neighbors, in pixels</entry>
- </row>
-
- <row valign="top">
- <entry>"pack-type"</entry>
- <entry>Read/Write</entry>
- <entry>Indicates whether the child is packed with reference to
- the start (<literal>gtk.PACK_START</literal>) or end
- (<literal>gtk.PACK_END</literal>) of the parent</entry>
- </row>
-
- <row valign="top">
- <entry>"position"</entry>
- <entry>Read/Write</entry>
- <entry>The index of the child in the parent</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkbox">
- <title>gtk.Box Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> class is an
-abstract base class defining a widget that encapsulates functionality for a
-particular kind of container, one that organizes a variable number of
-widgets into a rectangular area. <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> currently has
-two derived classes, <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> and <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>.</para>
-
- <para>The rectangular area of a <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> is organized
-into either a single row or a single column of child widgets depending upon
-whether the box is of type <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> or <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>,
-respectively. Thus, all children of a <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> are allocated
-one dimension in common, which is the height of a row, or the width of a
-column.</para>
-
- <para><link linkend="class-gtkbox"><classname>gtk.Box</classname></link>
-uses a notion of packing. Packing refers to adding widgets with reference to
-a particular position in a <link
-linkend="class-gtkbox"><classname>gtk.Container</classname></link>. For a
-<link linkend="class-gtkbox"><classname>gtk.Box</classname></link>, there
-are two reference positions: the start and the end of the box. For a <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>, the start is
-defined as the top of the box and the end is defined as the bottom. For a
-<link linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> the
-start is defined as the left side and the end is defined as the right
-side.</para>
-
- <para>Repeated calls to <link
-linkend="method-gtkbox--pack-start"><methodname>pack_start</methodname>()</link>
-pack widgets into a <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> from start to
-end. The <link
-linkend="method-gtkbox--pack-end"><methodname>pack_end</methodname>()</link>
-method adds widgets from end to start. You may intersperse these calls and
-add widgets from both ends of the same <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link>.</para>
-
- <para>Because <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> is a <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>,
-you may also use <link
-linkend="method-gtkcontainer--add"><methodname>add</methodname>()</link> to
-insert widgets into the box, and they will be packed as if with the <link
-linkend="method-gtkbox--pack-start-defaults"><methodname>pack_start</methodname>()</link>
-method. Use <link
-linkend="method-gtkcontainer--remove"><methodname>remove</methodname>()</link>
-to remove widgets from the <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link>.</para>
-
- <para>The <link
-linkend="method-gtkbox--set-homogeneous"><methodname>set_homogeneous</methodname>()</link>
-method specifies whether or not all children of the <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> are forced to
-get the same amount of space.</para>
-
- <para>The <link
-linkend="method-gtkbox--set-spacing"><methodname>set_spacing</methodname>()</link>
-method determines how much space will be minimally placed between all
-children in the <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link>.</para>
-
- <para>The <link
-linkend="method-gtkbox--reorder-child"><methodname>reorder_child</methodname>()</link>
-method moves a <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> child to a
-different place in the box.</para>
-
- <para>The <link
-linkend="method-gtkbox--set-child-packing"><methodname>set_child_packing</methodname>()</link>
-method resets the expand, fill, and padding attributes of any <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> child. Use the
-<link
-linkend="method-gtkbox--query-child-packing"><methodname>query_child_packing</methodname>()</link>
-to query these properties.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkbox--pack-start">
- <title>gtk.Box.pack_start</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pack_start</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter><initializer>True</initializer></methodparam>
- <methodparam><parameter
- role="keyword">padding</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to be added to the
-box</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>True if <parameter>child</parameter> is to be
-given extra space allocated to box. The extra space will be divided evenly
-between all children of box that use this option.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
- <listitem><simpara>True if space given to
-<parameter>child</parameter> by the <parameter>expand</parameter> option is
-actually allocated to <parameter>child</parameter>, rather than just padding
-it. This parameter has no effect if <parameter>expand</parameter> is set to
-False. A child is always allocated the full height of a <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> and the full
-width of a <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>. This option
-affects the other dimension.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">padding</parameter>&nbsp;:</term>
- <listitem><simpara>extra space in pixels to put between
-<parameter>child</parameter> and its neighbors, over and above the global
-amount specified by <parameter>spacing</parameter> in <link
-linkend="class-gtkhbox"><classname>gtk.Box</classname></link>. If
-<parameter>child</parameter> is a widget at one of the reference ends of
-box, then <parameter>padding</parameter> pixels are also put between
-<parameter>child</parameter> and the reference edge of
-box.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>pack_start</methodname>() method adds
-<parameter>child</parameter> to the box, packed with reference to the start
-of box. The <parameter>child</parameter> is packed after any other child
-packed with reference to the start of box. </para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbox--pack-end">
- <title>gtk.Box.pack_end</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pack_end</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter><initializer>True</initializer></methodparam>
- <methodparam><parameter
- role="keyword">padding</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to be added to the
-box</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>True if <parameter>child</parameter> is to be
-given extra space allocated to box. The extra space will be divided evenly
-between all children of box that use this option.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
- <listitem><simpara>True if space given to
-<parameter>child</parameter> by the <parameter>expand</parameter> option is
-actually allocated to <parameter>child</parameter>, rather than just padding
-it. This parameter has no effect if <parameter>expand</parameter> is set to
-False. A child is always allocated the full height of a <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> and the full
-width of a <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>. This option
-affects the other dimension.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">padding</parameter>&nbsp;:</term>
- <listitem><simpara>extra space in pixels to put between
-<parameter>child</parameter> and its neighbors, over and above the global
-amount specified by <parameter>spacing</parameter> in <link
-linkend="class-gtkhbox"><classname>gtk.Box</classname></link>. If
-<parameter>child</parameter> is a widget at one of the reference ends of
-box, then <parameter>padding</parameter> pixels are also put between
-<parameter>child</parameter> and the reference edge of
-box.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>pack_end</methodname>() method adds
-<parameter>child</parameter> to the box, packed with reference to the end of
-the box. The <parameter>child</parameter> is packed after (away from end of)
-any other child packed with reference to the end of the box.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbox--pack-start-defaults">
- <title>gtk.Box.pack_start_defaults</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pack_start_defaults</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to be added to the
-box</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above.</para>
- </warning>
-
- <para>The <methodname>pack_start_defaults</methodname>() method adds
-<parameter>widget</parameter> to the box, packed with reference to the start
-of the box. The <parameter>widget</parameter> is packed after any other
-child widget packed with reference to the start of box. The parameters for
-packing the child widget: expand, fill, and padding are given their default
-values, True, True, and 0, respectively.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbox--pack-end-defaults">
- <title>gtk.Box.pack_end_defaults</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pack_end_defaults</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to be added to the
-box</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above.</para>
- </warning>
-
- <para>The <methodname>pack_end_defaults</methodname>() method adds
-<parameter>widget</parameter> to the box, packed with reference to the end
-of the box. The <parameter>widget</parameter> is packed after (away from the
-end of) any other child widget packed with reference to the end of the box.
-The parameters for packing the child widget: expand, fill, and padding are
-given their default values, True, True, and 0, respectively.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbox--set-homogeneous">
- <title>gtk.Box.set_homogeneous</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_homogeneous</methodname>
- <methodparam><parameter
- role="keyword">homogeneous</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">homogeneous</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> the box is
-homogeneous i.e. all children are allocated the same space otherwise the
-allocations vary for each child.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_homogeneous</methodname>() method sets the
-homogeneous (all children are allocated the same space) property of the
-box.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbox--get-homogeneous">
- <title>gtk.Box.get_homogeneous</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_homogeneous</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the box is
-homogeneous.</simpara></listitem>
- </varlistentry>
- </variablelist>
- <para>The <methodname>get_homogeneous</methodname>() method returns
-whether the box is homogeneous (all children are allocated the same space).
-See <link
-linkend="method-gtkbox--set-homogeneous"><methodname>gtk.Box.set_homogeneous()</methodname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbox--set-spacing">
- <title>gtk.Box.set_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_spacing</methodname>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
- <listitem><simpara>the number of pixels to put between
-children.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_spacing</methodname>() method sets the
-number of pixels to place between children of the box.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbox--get-spacing">
- <title>gtk.Box.get_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_spacing</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the spacing in pixels between
-children</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_spacing</methodname>() method returns the
-number of pixels used as padding between children as set by the <link
-linkend="method-gtkbox--set-spacing"><methodname>set_spacing</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbox--reorder-child">
- <title>gtk.Box.reorder_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reorder_child</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget to move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the new position for child in the children list
-of the box starting from 0. If negative, indicates the end of the
-list.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Moves child to a new position in the list of the box children.
-The list contains both widgets packed gtk.PACK_START as well as widgets
-packed gtk.PACK_END, in the order that these widgets were added to
-box.</para>
-
- <para>A widget's position in the box children list determines where
-the widget is packed into box. A child widget at some position in the list
-will be packed just after all other widgets of the same packing type that
-appear earlier in the list.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbox--query-child-packing">
- <title>gtk.Box.query_child_packing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>query_child_packing</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget to be queried for its packing
-information</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>the child's expand value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
- <listitem><simpara>the child's fill value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">padding</parameter>&nbsp;:</term>
- <listitem><simpara>the child's padding value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">pack_type</parameter>&nbsp;:</term>
- <listitem><simpara>the child's pack_type
-value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>query_child_packing</methodname>() method
-returns a tuple containing information about how <parameter>child</parameter>
-is packed into the box. The tuple members are: (expand, fill, padding,
-pack_type) where: expand and fill are 0 or 1 (corresponding to False or
-True); padding is the number of pixels of padding; and pack_type is
-gtk.PACK_START or gtk.PACK_END.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbox--set-child-packing">
- <title>gtk.Box.set_child_packing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_child_packing</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter
- role="keyword">padding</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pack_type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget to be queried for its packing
-information</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>the child's new expand
-value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
- <listitem><simpara>the child's new fill value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">padding</parameter>&nbsp;:</term>
- <listitem><simpara>the child's new padding
-value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">pack_type</parameter>&nbsp;:</term>
- <listitem><simpara>the child's new pack_type
-value</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
- <para>The <methodname>set_child_packing</methodname>() method sets the
-way child is packed into the box.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkbutton.xml b/docs/reference/pygtk-gtkbutton.xml
deleted file mode 100644
index 7f15fdef..00000000
--- a/docs/reference/pygtk-gtkbutton.xml
+++ /dev/null
@@ -1,1207 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkbutton">
- <refnamediv>
- <refname>gtk.Button</refname>
- <refpurpose>A pushbutton widget that issues a signal when
-clicked.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Button</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkbutton">gtk.Button</link></methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">stock</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">use_underline</parameter><initializer>True</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--pressed">pressed</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--released">released</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--clicked">clicked</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--enter">enter</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--leave">leave</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--set-relief">set_relief</link></methodname>
- <methodparam><parameter
- role="keyword">newstyle</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--get-relief">get_relief</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--set-label">set_label</link></methodname>
- <methodparam><parameter
- role="keyword">label</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--get-label">get_label</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--set-use-underline">set_use_underline</link></methodname>
- <methodparam><parameter
- role="keyword">use_underline</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--get-use-underline">get_use_underline</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--set-use-stock">set_use_stock</link></methodname>
- <methodparam><parameter
- role="keyword">use_stock</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--get-use-stock">get_use_stock</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--set-focus-on-click">set_focus_on_click</link></methodname>
- <methodparam><parameter
- role="keyword">focus_on_click</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--get-focus-on-click">get_focus_on_click</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--set-alignment">set_alignment</link></methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--get-alignment">get_alignment</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--set-image">set_image</link></methodname>
- <methodparam><parameter
- role="keyword">image</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbutton--get-image">get_image</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkbutton">gtk.Button</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkbutton">
- <title>gtk.Button Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"focus-on-click"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> the button grabs focus when
- it is clicked with the mouse. Default value:
-<literal>True</literal>. This property is available in GTK+ 2.4 and
-above.</entry>
- </row>
-
- <row valign="top">
- <entry>"image"</entry>
- <entry>Read/Write</entry>
- <entry>The child widget to appear next to the button text. Default
-value: <literal>None</literal>.
-This property is available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"image-position"</entry>
- <entry>Read/Write</entry>
- <entry>The position of the image relative to the text inside the
- button. One of the <xref linkend="gtk-position-type-constants"
- endterm="gtk-position-type-constants-title"></xref>. Default
- value: <literal>gtk.POS_LEFT</literal>. This property is
- available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"label"</entry>
- <entry>Read/Write</entry>
- <entry>Text of the label widget inside the button, if the button
-contains a label widget. Default value: <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"relief"</entry>
- <entry>Read/Write</entry>
- <entry>The border relief style. One of:
-<literal>gtk.RELIEF_NORMAL</literal>, <literal>gtk.RELIEF_HALF</literal> or
-<literal>gtk.RELIEF_NONE</literal>. Default value:
-<literal>gtk.RELIEF_NORMAL</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"use-stock"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, the label text is used to pick
-a stock item instead of being displayed.
-Default value: <literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"use-underline"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, an underscore in the text
-indicates the next character should be underlined and used for the mnemonic
-accelerator key if it is the first character so marked.
-Default value: <literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"xalign"</entry>
- <entry>Read/Write</entry>
- <entry>If the
- child of the button is a <link
- linkend="class-gtkmisc"><classname>gtk.Misc</classname></link> or
- <link
- linkend="class-gtkalignment"><classname>gtk.Alignment</classname></link>,
- this property can be used to control it's horizontal
- alignment. The value ranges from 0.0 to 1.0 representing the fraction
- of freespace to the left of the widget. Default value: 0.5.
-This property is available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"yalign"</entry>
- <entry>Read/Write</entry>
- <entry>If the
- child of the button is a <link
- linkend="class-gtkmisc"><classname>gtk.Misc</classname></link> or
- <link
- linkend="class-gtkalignment"><classname>gtk.Alignment</classname></link>,
- this property can be used to control it's vertical
- alignment. The value ranges from 0.0 to 1.0 representing the fraction
-of freespace above the widget. Default value: 0.5.
-This property is available in GTK+ 2.4 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkbutton">
- <title>gtk.Button Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"child-displacement-x"</entry>
- <entry>Read</entry>
- <entry>The number of pixels in the x direction to move the child
-when the button is depressed. Default value: 0</entry>
- </row>
-
- <row valign="top">
- <entry>"child-displacement-y"</entry>
- <entry>Read</entry>
- <entry>The number of pixels in the y direction to move the child
-when the button is depressed. Default value: 0</entry>
- </row>
-
- <row valign="top">
- <entry>"default-border"</entry>
- <entry>Read</entry>
- <entry>The extra space to add for
- <literal>gtk.CAN_DEFAULT</literal> buttons as a <link
- linkend="class-gtkborder"><classname>gtk.Border</classname></link></entry>
- </row>
-
- <row valign="top">
- <entry>"default-outside-border"</entry>
- <entry>Read</entry>
- <entry>The extra space to add for
- <literal>gtk.CAN_DEFAULT</literal> buttons always drawn outside
- the border as a <link
- linkend="class-gtkborder"><classname>gtk.Border</classname></link></entry>
- </row>
-
- <row valign="top">
- <entry>"displace-focus"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the "child-displacement-x" and
- "child-displacement-y" properties should also affect the focus
- rectangle. Default value: <literal>False</literal>. This property
- is available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"inner-border"</entry>
- <entry>Read</entry>
- <entry>The border between the button edges and child as a <link
- linkend="class-gtkborder"><classname>gtk.Border</classname></link>.
- This property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkbutton">
- <title>gtk.Button Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkbutton--activate">activate</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>button</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkbutton--clicked">clicked</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>button</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkbutton--enter">enter</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>button</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkbutton--leave">leave</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>button</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkbutton--pressed">pressed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>button</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkbutton--released">released</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>button</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link> widget is
-usually displayed as a pushbutton with a text label (<link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link>) though it
-can contain any valid widget. The <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link> is
-generally used to attach a callback function or method that is called when
-the button is clicked. Buttons generate signals that indicate:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>"clicked" - the user pressed and released a mouse button
-over the button</simpara>
- </listitem>
- <listitem>
- <simpara>"pressed" - the user pressed a mouse button over the
-button</simpara>
- </listitem>
- <listitem>
- <simpara>"released" - the user released a mouse button over the
-button</simpara>
- </listitem>
- <listitem>
- <simpara>"enter" - the pointer entered the button</simpara>
- </listitem>
- <listitem>
- <simpara>"leave" - the pointer left the button</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The "clicked" signal is usually the only signal that an
-application needs to handle.</para>
-
- <para>If a label is being used by the button its text (the "label"
-property) is retrieved using the <link
-linkend="method-gtkbutton--get-label"><methodname>get_label</methodname>()</link>
-method. The label text is changed using the <link
-linkend="method-gtkbutton--set-label"><methodname>set_label</methodname>()</link>
-method.</para>
-
- <para>The property ("use_underline") that tells a button to use the
-first underscore to indicate a mnemonic key is changed using the <link
-linkend="method-gtkbutton--set-use-underline"><methodname>set_use_underline</methodname>().</link>
-method. It can be retrieved using the <link
-linkend="method-gtkbutton--get-use-underline"><methodname>get_use_underline</methodname>()</link>
-method.</para>
-
- <para>The button's relief style (the "relief" property) is retrieved
-using the method <link
-linkend="method-gtkbutton--get-relief"><methodname>get_relief</methodname>()</link>.
-The relief style is set to one of <literal>gtk.RELIEF_NONE</literal>,
-<literal>gtk.RELIEF_HALF</literal> or <literal>gtk.RELIEF_NORMAL</literal>
-using the method <link
-linkend="method-gtkbutton--set-relief"><methodname>set_relief</methodname>()</link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkbutton">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Button</methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">stock</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">use_underline</parameter><initializer>True</initializer></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>the text to be displayed by the button label
-including an underscore to indicate the mnemonic character if desired or
-<literal>None</literal> if no label is required.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">stock</parameter>&nbsp;:</term>
- <listitem><simpara>the stock id identifying the stock image and text
-to be used in the button or <literal>None</literal> if no stock id is to be
-used.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">use_underline</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, an underscore in the
-text indicates the next character should be underlined and used for the
-mnemonic accelerator key if it is the first character so
-marked. Available in PyGTK 2.4 and above.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new button object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new button widget with the content depending on the
-parameters: <parameter>label</parameter>, <parameter>stock</parameter> and
-<parameter>use_underline</parameter>. The default values for
-<parameter>stock</parameter> and <parameter>label</parameter> are
-<literal>None</literal> and, in PyGTK 2.4 and above,
-<parameter>use_underline</parameter> is available and defaults to
-<literal>True</literal>. If both <parameter>label</parameter> and
-<parameter>stock</parameter> are specified <parameter>stock</parameter>
-takes precedence. If neither is specified the button is created with no
-child widget. A child widget can be added later with the <link
-linkend="method-gtkcontainer--add"><methodname>add</methodname>()</link>
-method.</para>
-
- <para>If <parameter>stock</parameter> is specified the "use-stock"
-property will be set to <literal>True</literal>.</para>
-
- <para>If <parameter>label</parameter> is specified the "label" property
-will be set with the text of the label, the "use_underline" property will be
-set to <literal>True</literal> and any characters that are preceded by an
-underscore are underlined (use two underscores to insert an underscore in a
-label). The first underscored character will become the mnemonic character
-used as the keyboard accelerator for the button when pressed simultaneously
-with the <keycap>Alt</keycap> key. In PyGTK 2.4 and above the
-"use-underline" property can be set by using the optional
-<parameter>use_underline</parameter> parameter.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkbutton--pressed">
- <title>gtk.Button.pressed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pressed</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>pressed</methodname>() method emits the
-"pressed" signal to the button.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--released">
- <title>gtk.Button.released</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>released</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>released</methodname>() method emits the
-"released" signal to the button.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--clicked">
- <title>gtk.Button.clicked</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clicked</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>clicked</methodname>() method emits the
-"clicked" signal to the button.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--enter">
- <title>gtk.Button.enter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>enter</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>enter</methodname>() method emits the "enter"
-signal to the button.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--leave">
- <title>gtk.Button.leave</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>leave</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>leave</methodname>() method emits the "leave"
-signal to the button.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--set-relief">
- <title>gtk.Button.set_relief</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_relief</methodname>
- <methodparam><parameter>newstyle</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">newstyle</parameter>&nbsp;:</term>
- <listitem>
- <simpara>one of <literal>gtk.RELIEF_NONE</literal>,
-<literal>gtk.RELIEF_NORMAL</literal> or
-<literal>gtk.RELIEF_HALF</literal></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_relief</methodname>() method sets the relief
-style of the edges of the button. Three styles exist,
-<literal>gtk.RELIEF_NORMAL</literal>, <literal>gtk.RELIEF_HALF</literal>,
-<literal>gtk.RELIEF_NONE</literal>. The default style is, as one can guess,
-<literal>gtk.RELIEF_NORMAL</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--get-relief">
- <title>gtk.Button.get_relief</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_relief</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the relief style</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_relief</methodname>() method retrieves the
-current relief style (the "relief" property) set for the button.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--set-label">
- <title>gtk.Button.set_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_label</methodname>
- <methodparam><parameter>label</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem>
- <simpara>a string to be set as the text in the button
-label</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_label</methodname>() method sets the text of
-the button label to <parameter>label</parameter> (also sets the "label"
-property). This string is also used to select the stock item if the
-"use_stock" property is <literal>True</literal> and the string references a
-stock item. Any previously set labels will be cleared.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--get-label">
- <title>gtk.Button.get_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_label</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the text of the label
-widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_label</methodname>() method retrieves the
-text from the label of the button, as set by <link
-linkend="method-gtkbutton--set-label"><methodname>set_label</methodname>()</link>
-or by the <link
-linkend="constructor-gtkbutton"><methodname>gtk.Button</methodname>()</link>
-constructor. This string is owned by the widget and must not be modified or
-freed. If the label text has not been set the return value will be
-<literal>None</literal>. This will be the case if you create an empty button
-with <link
-linkend="constructor-gtkbutton"><methodname>gtk.Button</methodname>()</link>
-to use as a container.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--set-use-underline">
- <title>gtk.Button.set_use_underline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_underline</methodname>
- <methodparam><parameter
- role="keyword">use_underline</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>use_underline</parameter>&nbsp;:</term>
- <listitem>
- <simpara><literal>True</literal> if underscores in the text
-indicate mnemonics</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_use_underline</methodname>() method sets the
-"use_underline" property to the value of
-<parameter>use_underline</parameter>. If
-<parameter>use_underline</parameter> is <literal>True</literal>, an
-underscore in the text of the button label indicates that the next character
-should be underlined and used for the mnemonic accelerator key if it is also
-the first underlined character.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--get-use-underline">
- <title>gtk.Button.get_use_underline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_underline</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara><literal>True</literal> if an underscore in the button
-label indicates the mnemonic accelerator keys.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_use_underline</methodname>() method returns
-whether the "use_underline" property is <literal>True</literal> meaning that
-an underscore in the button label indicates a mnemonic. See <link
-linkend="method-gtkbutton--set-use-underline"><methodname>set_use_underline</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--set-use-stock">
- <title>gtk.Button.set_use_stock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_stock</methodname>
- <methodparam><parameter
- role="keyword">use_stock</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>use_stock</parameter>&nbsp;:</term>
- <listitem>
- <simpara>If <literal>True</literal> the button should use a
-stock item</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_use_stock</methodname>() method sets the
-"use_stock" property to the value of <parameter>use_stock</parameter>. If
-<parameter>use_stock</parameter> is <literal>True</literal>, the label set
-on the button is used as a stock id to select the stock item for the
-button.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--get-use-stock">
- <title>gtk.Button.get_use_stock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_stock</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>the value of the "use_stock" property.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_use_stock</methodname>() method returns the
-value of the "use_stock" property. If <literal>True</literal> the button
-label is used to select a stock item instead of being used directly as the
-label text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--set-focus-on-click">
- <title>gtk.Button.set_focus_on_click</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_focus_on_click</methodname>
- <methodparam><parameter
- role="keyword">focus_on_click</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>focus_on_click</parameter>&nbsp;:</term>
- <listitem>
- <simpara>If <literal>True</literal> the button grabs focus when
- clicked with the mouse.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_focus_on_click</methodname>() method sets
-the "focus-on-click" property to the value of
-<parameter>focus_on_click</parameter>. If
-<parameter>focus_on_click</parameter> is <literal>True</literal>, the button
-grabs focus when it is clicked by the mouse.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--get-focus-on-click">
- <title>gtk.Button.get_focus_on_click</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_focus_on_click</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>the value of the "focus-on-click" property.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_focus_on_click</methodname>() method returns
-the value of the "focus-on-click" property. If <literal>True</literal> the
-button grabs focus when it is clicked by the mouse .</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--set-alignment">
- <title>gtk.Button.set_alignment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_alignment</methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>xalign</parameter>&nbsp;:</term>
- <listitem>
- <simpara>the horizontal alignment of the child widget. The value
- ranges from 0.0 to 1.0 and represents the fraction of freespace
- to the left of the child widget.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>yalign</parameter>&nbsp;:</term>
- <listitem>
- <simpara>the vertical alignment of the child widget. The value
- ranges from 0.0 to 1.0 and represents the fraction of freespace
- above the child widget.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_alignment</methodname>() method sets the
-"xalign" and "yalign" properties to the value of
-<parameter>xalign</parameter> and <parameter>yalign</parameter>
-respectively. This property has no effect unless the child is a <link
-linkend="class-gtkmisc"><classname>gtk.Misc</classname></link> or a <link
-linkend="class-gtkalignment"><classname>gtk.Alignment</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--get-alignment">
- <title>gtk.Button.get_alignment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_alignment</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>a 2-tuple containing the values of the "xalign" and
- "yalign" properties.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_alignment</methodname>() method returns the
-values of the "xalign" and "yalign" properties. See the <link linkend="method-gtkbutton--set-alignment"><methodname>set_alignment</methodname>()</link> method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--set-image">
- <title>gtk.Button.set_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_image</methodname>
- <methodparam><parameter
- role="keyword">image</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>image</parameter>&nbsp;:</term>
- <listitem>
- <simpara>the widget to set as the image for the button.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_image</methodname>() method sets the "image"
-property to the value of <parameter>image</parameter>. This property has no
-effect unless the "gtk-button-images" property is
-<literal>True</literal>. See the <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-reference for more information. Note you do not have to call the <link
-linkend="method-gtkwidget--show"><methodname>gtk.Widget.show</methodname>()</link>
-method for <parameter>image</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbutton--get-image">
- <title>gtk.Button.get_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_image</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> used as
-the button image or <literal>None</literal> if there is no image.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_image</methodname>() method returns the
-value of the "image" property. See the <link
-linkend="method-gtkbutton--set-image"><methodname>set_image</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkbutton--activate">
- <title>The "activate" gtk.Button Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>button</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>button</parameter>&nbsp;:</term>
- <listitem><simpara>the button that received the "activate"
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "activate" signal is emitted when the <link
-linkend="method-gtkwidget--activate"><methodname>gtk.Widget.activate</methodname>()</link>
-method is called. For a button it causes the "clicked" signal to be
-emitted.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkbutton--clicked">
- <title>The "clicked" gtk.Button Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>button</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>button</parameter>&nbsp;:</term>
- <listitem><simpara>the button that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "clicked" signal is emitted when the mouse button is pressed
-and released while the pointer is over the button.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkbutton--enter">
- <title>The "enter" gtk.Button Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>button</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>button</parameter>&nbsp;:</term>
- <listitem><simpara>the button that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "enter" signal is emitted when the pointer enters the
-button.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkbutton--leave">
- <title>The "leave" gtk.Button Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>button</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>button</parameter>&nbsp;:</term>
- <listitem><simpara>the button that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "leave" signal is emitted when the pointer leaves the
-button.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkbutton--pressed">
- <title>The "pressed" gtk.Button Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>button</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>button</parameter>&nbsp;:</term>
- <listitem><simpara>the button that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "pressed" signal is emitted when the mouse button is pressed
-while the pointer is over the button.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkbutton--released">
- <title>The "released" gtk.Button Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>button</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>button</parameter>&nbsp;:</term>
- <listitem><simpara>the button that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "released" signal is emitted when the button is released no
-matter where the pointer is.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkbuttonbox.xml b/docs/reference/pygtk-gtkbuttonbox.xml
deleted file mode 100644
index 9e583eb1..00000000
--- a/docs/reference/pygtk-gtkbuttonbox.xml
+++ /dev/null
@@ -1,346 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkbuttonbox">
- <refnamediv>
- <refname>gtk.ButtonBox</refname>
- <refpurpose>the base class for widgets that contain multiple
-buttons</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ButtonBox</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbox">gtk.Box</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbuttonbox--get-layout">get_layout</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbuttonbox--set-layout">set_layout</link></methodname>
- <methodparam><parameter
- role="keyword">layout_style</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbuttonbox--get-child-secondary">get_child_secondary</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkbuttonbox--set-child-secondary">set_child_secondary</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">is_secondary</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkbuttonbox">gtk.ButtonBox</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkbuttonbox">
- <title>gtk.ButtonBox Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"layout-style"</entry>
- <entry>Read/Write</entry>
- <entry>the style used to layout the buttons in the box. The layout
-styles are: <literal>gtk.BUTTONBOX_SPREAD</literal>,
-<literal>gtk.BUTTONBOX_EDGE</literal>,
-<literal>gtk.BUTTONBOX_START</literal> and
-<literal>gtk.BUTTONBOX_END</literal>.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkbuttonbox">
- <title>gtk.ButtonBox Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"child-internal-pad-x"</entry>
- <entry>Read</entry>
- <entry>The amount of padding that increases a child's size on
- the top and bottom</entry>
- </row>
-
- <row valign="top">
- <entry>"child-internal-pad-y"</entry>
- <entry>Read</entry>
- <entry>The amount of padding that increases a child's size on
- the top and bottom</entry>
- </row>
-
- <row valign="top">
- <entry>"child-min-height"</entry>
- <entry>Read</entry>
- <entry>The minimum height of buttons inside the box.</entry>
- </row>
-
- <row valign="top">
- <entry>"child-min-width"</entry>
- <entry>Read</entry>
- <entry>The minimum width of buttons inside the box.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkbuttonbox">
- <title>gtk.ButtonBox Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"secondary"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, the child appears in a secondary
-group of children, suitable for, e.g., help buttons.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkbuttonbox">
- <title>gtk.ButtonBox Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A button box is used to provide a consistent layout of buttons
-throughout an application. The <link
-linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link> is
-subclassed by the <link
-linkend="class-gtkhbuttonbox"><classname>gtk.HButtonBox</classname></link>
-and <link
-linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
-classes to provide horizontal and vertical button layouts respectively. The
-same effect could be achieved by using a <link
-linkend="class-gtkvbuttonbox"><classname>gtk.Box</classname></link> but less
-conveniently.</para>
-
- <para>A buttonbox provides one default layout and a default spacing
-value that are persistent across all widgets. The layout/spacing can then be
-altered by the programmer, or if desired, by the user to alter the 'feel' of
-a program to a small degree.</para>
-
- <para>The <link
-linkend="method-gtkbox--get-spacing"><methodname>gtk.Box.get_spacing</methodname>()</link>
-method and the <link
-linkend="method-gtkbox--set-spacing"><methodname>gtk.Box.set_spacing</methodname>()</link>
-methods retrieve and change the default number of pixels between buttons.
-The <link
-linkend="method-gtkbuttonbox--get-layout"><methodname>get_layout</methodname>()</link>
-and <link
-linkend="method-gtkbuttonbox--set-layout"><methodname>set_layout</methodname>()</link>
-methods retrieve and alter the style used to spread the buttons in a button
-box across the container. The layout styles are:
-<literal>gtk.BUTTONBOX_SPREAD</literal>,
-<literal>gtk.BUTTONBOX_EDGE</literal>,
-<literal>gtk.BUTTONBOX_START</literal> and
-<literal>gtk.BUTTONBOX_END</literal>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkbuttonbox--get-layout">
- <title>gtk.ButtonBox.get_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_layout</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the layout style used by the
-buttonbox</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_layout</methodname>() method returns the
-current value of the "layout-style" property. The possible values are:
-<literal>gtk.BUTTONBOX_SPREAD</literal>,
-<literal>gtk.BUTTONBOX_EDGE</literal>,
-<literal>gtk.BUTTONBOX_START</literal> and
-<literal>gtk.BUTTONBOX_END</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbuttonbox--set-layout">
- <title>gtk.ButtonBox.set_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_layout</methodname>
- <methodparam><parameter
- role="keyword">layout_style</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">layout_style</parameter>&nbsp;:</term>
- <listitem><simpara>the new layout style</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_layout</methodname>() method sets the
-"layout-style" property to the value in <parameter>layout_style</parameter>.
-The possible values are: <literal>gtk.BUTTONBOX_SPREAD</literal>,
-<literal>gtk.BUTTONBOX_EDGE</literal>,
-<literal>gtk.BUTTONBOX_START</literal> and
-<literal>gtk.BUTTONBOX_END</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbuttonbox--get-child-secondary">
- <title>gtk.ButtonBox.get_child_secondary</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_child_secondary</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a child button of the
-buttonbox</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the
-<parameter>child</parameter> appears in a secondary group of the button
-box.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_child_secondary</methodname>() method
-returns <literal>True</literal> if <parameter>child</parameter> should
-appear in a secondary group of children. See the <link
-linkend="method-gtkbuttonbox--set-child-secondary"><methodname>set_child_secondary</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkbuttonbox--set-child-secondary">
- <title>gtk.ButtonBox.set_child_secondary</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_child_secondary</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">is_secondary</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a child button of the
-buttonbox</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">is_secondary</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the
-<parameter>child</parameter> appears in a secondary group of the button
-box.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_child_secondary</methodname>() method sets
-whether <parameter>child</parameter> should appear in a secondary group of
-children. The typical use of a secondary child is the help button in a
-dialog that is displayed away from the main group of buttons e.g. right
-aligned.</para>
-
- <para>The secondary group appears after the other children if the
-style is <literal>gtk.BUTTONBOX_START</literal>,
-<literal>gtk.BUTTONBOX_SPREAD</literal> or
-<literal>gtk.BUTTONBOX_EDGE</literal>, and before the the other children if
-the style is <literal>gtk.BUTTONBOX_END</literal>. For horizontal button
-boxes, the definition of before/after depends on direction of the widget
-(see <link
-linkend="method-gtkwidget--set-direction"><function>gtk.Widget.set_direction()</function></link>).
-If the style is <literal>gtk.BUTTONBOX_START</literal> or
-<literal>gtk.BUTTONBOX_END</literal>, then the secondary children are
-aligned at the other end of the button box from the main children. For the
-other styles, they appear immediately next to the main children.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcalendar.xml b/docs/reference/pygtk-gtkcalendar.xml
deleted file mode 100644
index 9f04151a..00000000
--- a/docs/reference/pygtk-gtkcalendar.xml
+++ /dev/null
@@ -1,991 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcalendar">
- <refnamediv>
- <refname>gtk.Calendar</refname>
- <refpurpose>a widget that displays a calendar and allows the user to
-select a date.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Calendar</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcalendar">gtk.Calendar</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcalendar--select-month">select_month</link></methodname>
- <methodparam><parameter
- role="keyword">month</parameter></methodparam>
- <methodparam><parameter
- role="keyword">year</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcalendar--select-day">select_day</link></methodname>
- <methodparam><parameter role="keyword">day</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcalendar--mark-day">mark_day</link></methodname>
- <methodparam><parameter role="keyword">day</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcalendar--unmark-day">unmark_day</link></methodname>
- <methodparam><parameter role="keyword">day</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcalendar--clear-marks">clear_marks</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcalendar--get-display-options">get_display_options</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcalendar--set-display-options">set_display_options</link></methodname>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcalendar--display-options">display_options</link></methodname>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcalendar--get-date">get_date</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcalendar--freeze">freeze</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcalendar--thaw">thaw</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcalendar">gtk.Calendar</link>
-</synopsis>
-
- <refsect1 id="properties-gtkcalendar">
- <title>gtk.Calendar Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- <note>
- <para>These properties are available in GTK+ 2.4 and above.</para>
- </note>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"day"</entry>
- <entry>Read-Write</entry>
- <entry>The selected day (as a number between 1 and 31, or 0 to
-unselect the currently selected day).</entry>
- </row>
-
- <row valign="top">
- <entry>"month"</entry>
- <entry>Read-Write</entry>
- <entry>The selected month (as a number between 0 and 11).</entry>
- </row>
-
- <row valign="top">
- <entry>"no-month-change"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the selected month cannot be
-changed.</entry>
- </row>
-
- <row valign="top">
- <entry>"show-day-names"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, day names are
-displayed.</entry>
- </row>
-
- <row valign="top">
- <entry>"show-heading"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, a heading is
-displayed.</entry>
- </row>
-
- <row valign="top">
- <entry>"show-week-numbers"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, week numbers are
-displayed.</entry>
- </row>
-
- <row valign="top">
- <entry>"year"</entry>
- <entry>Read-Write</entry>
- <entry>The selected year.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkcalendar">
- <title>gtk.Calendar Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcalendar">
- <title>gtk.Calendar Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcalendar--day-selected">day-selected</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcalendar--day-selected-double-click">day-selected-double-click</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcalendar--month-changed">month-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcalendar--next-month">next-month</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcalendar--next-year">next-year</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcalendar--prev-month">prev-month</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcalendar--prev-year">prev-year</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkcalendar"><classname>gtk.Calendar</classname></link> is a
-widget that displays a simple calendar, one month at a time. In addition,
-the calendar can display the days of the week and navigation controls that
-allow a user to change the month and year displayed by calling the <link
-linkend="method-gtkcalendar--display-options"><methodname>display_options</methodname>()</link>
-(<link
-linkend="method-gtkcalendar--set-display-options"><methodname>set_display_options</methodname>()</link>
-in PyGTK 2.4 and above) method. The possible display options are:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_HEADING</literal></term>
- <listitem>
- <simpara>Specifies that the month and year should be
-displayed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_DAY_NAMES</literal></term>
- <listitem>
- <simpara>Specifies that three letter day descriptions should be
-present.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_NO_MONTH_CHANGE</literal></term>
- <listitem>
- <simpara>Prevents the user from switching months with the
-calendar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_WEEK_NUMBERS</literal></term>
- <listitem>
- <simpara>Displays each week numbers of the current year, down the
-left side of the calendar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_WEEK_START_MONDAY</literal></term>
- <listitem>
- <simpara>Starts the calendar week on Monday, instead of the
-default Sunday.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The month and year currently displayed are programatically
-changed by calling the <link
-linkend="method-gtkcalendar--select-month"><methodname>select_month</methodname>()</link>
-method. The exact day is selected from the displayed month using the <link
-linkend="method-gtkcalendar--select-day"><methodname>select_day</methodname>()</link>
-method.</para>
-
- <para>To place a visual marker on a particular day, use the <link
-linkend="method-gtkcalendar--mark-day"><methodname>mark_day</methodname>()</link>
-method and to remove the marker, the <link
-linkend="method-gtkcalendar--unmark-day"><methodname>unmark_day</methodname>()</link>
-method. All marks are cleared by calling the <link
-linkend="method-gtkcalendar--clear-marks"><methodname>clear_marks</methodname>()</link>
-method.</para>
-
- <para>The selected date can be retrieved from a <link
-linkend="class-gtkcalendar"><classname>gtk.Calendar</classname></link> using
-the <link
-linkend="method-gtkcalendar--get-date"><methodname>get_date</methodname>()</link>
-method. If performing many 'mark' operations, the calendar can be frozen to
-prevent flicker, using the <link
-linkend="method-gtkcalendar--freeze"><methodname>freeze</methodname>()</link>
-method, and 'thawed' again using the <link
-linkend="method-gtkcalendar--freeze"><methodname>thaw</methodname>()</link>
-method.</para>
-
- <note>
- <para>Note that month is zero-based (i.e it allowed values are 0-11) while selected_day
- is one-based (i.e. allowed values are 1-31).</para>
- </note>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcalendar">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Calendar</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a calendar object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a calendar object that displays the current month and year
-with the current day selected. The default calendar display style is:
-gtk.CALENDAR_SHOW_HEADING | gtk.CALENDAR_SHOW_DAY_NAMES that shows the days
-of the week and the month and year heading with navigation controls.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcalendar--select-month">
- <title>gtk.Calendar.select_month</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_month</methodname>
- <methodparam
- role="keyword"><parameter>month</parameter></methodparam>
- <methodparam
- role="keyword"><parameter>year</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">month</parameter>&nbsp;:</term>
- <listitem><simpara>the new month number between 0 and
-11</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">year</parameter>&nbsp;:</term>
- <listitem><simpara>the new year number</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the month is set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>select_month</methodname>() method changes the
-calendar display to the specified <parameter>month</parameter> and
-<parameter>year</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcalendar--select-day">
- <title>gtk.Calendar.select_day</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_day</methodname>
- <methodparam><parameter
- role="keyword">day</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">day</parameter>&nbsp;:</term>
- <listitem><simpara>the new day number between 1 and 31 - 0 removes
-the current selection</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>select_day</methodname>() method selects the
-specified <parameter>day</parameter> on the calendar when
-<parameter>day</parameter> has a value between 1 and 31. If
-<parameter>day</parameter> is 0 then the current day selection is
-removed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcalendar--mark-day">
- <title>gtk.Calendar.mark_day</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>mark_day</methodname>
- <methodparam><parameter
- role="keyword">day</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">day</parameter>&nbsp;:</term>
- <listitem><simpara>the number of the day to be
-marked</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>mark_day</methodname>() method marks the
-specified month <parameter>day</parameter> with a visual marker (typically
-by making the number bold). If the calendar month and year are changed the
-marked days remain marked.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcalendar--unmark-day">
- <title>gtk.Calendar.unmark_day</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unmark_day</methodname>
- <methodparam><parameter
- role="keyword">day</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">day</parameter>&nbsp;:</term>
- <listitem><simpara>the number of the day to be
-unmarked</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>unmark_day</methodname>() method unmarks the
-specified month <parameter>day</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcalendar--clear-marks">
- <title>gtk.Calendar.clear_marks</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear_marks</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>clear_marks</methodname>() method clears all
-marked days.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcalendar--get-display-options">
- <title>gtk.Calendar.get_display_options</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_display_options</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the calendar display options</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_display_options</methodname>() method
-returns the current calendar display options. See the <link
-linkend="method-gtkcalendar--set-display-options"><methodname>set_display_options</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcalendar--set-display-options">
- <title>gtk.Calendar.set_display_options</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_display_options</methodname>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>the new calendar display
-options</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_display_options</methodname>() method sets the
-calendar display options to the value specified by
-<parameter>flags</parameter>. The possible display options are a combination
-of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_HEADING</literal></term>
- <listitem>
- <simpara>Specifies that the month and year should be
-displayed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_DAY_NAMES</literal></term>
- <listitem>
- <simpara>Specifies that three letter day descriptions should be
-present.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_NO_MONTH_CHANGE</literal></term>
- <listitem>
- <simpara>Prevents the user from switching months with the
-calendar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_WEEK_NUMBERS</literal></term>
- <listitem>
- <simpara>Displays each week numbers of the current year, down
-the left side of the calendar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_WEEK_START_MONDAY</literal></term>
- <listitem>
- <simpara>Starts the calendar week on Monday, instead of the
-default Sunday.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The display options can be removed by passing 0 as the value of
-<parameter>flags</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcalendar--display-options">
- <title>gtk.Calendar.display_options</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>display_options</methodname>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>the new calendar display
-options</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and should be replaced
- by the <link
- linkend="method-gtkcalendar--set-display-options"><methodname>set_display_options</methodname>()</link>
- method.</para>
- </warning>
-
- <para>The <methodname>display_options</methodname>() method sets the
-calendar display options to the value specified by
-<parameter>flags</parameter>. The possible display options are a combination
-of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_HEADING</literal></term>
- <listitem>
- <simpara>Specifies that the month and year should be
-displayed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_DAY_NAMES</literal></term>
- <listitem>
- <simpara>Specifies that three letter day descriptions should be
-present.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_NO_MONTH_CHANGE</literal></term>
- <listitem>
- <simpara>Prevents the user from switching months with the
-calendar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_SHOW_WEEK_NUMBERS</literal></term>
- <listitem>
- <simpara>Displays each week numbers of the current year, down
-the left side of the calendar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CALENDAR_WEEK_START_MONDAY</literal></term>
- <listitem>
- <simpara>Starts the calendar week on Monday, instead of the
-default Sunday.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The display options can be removed by passing 0 as the value of
-<parameter>flags</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcalendar--get-date">
- <title>gtk.Calendar.get_date</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_date</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the year, month and
-day</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_date</methodname>() method retrieves the
-calendar's current year, month and selected day numbers as a tuple (year,
-month, day).</para>
-
- <note>
- <para>Note that month is zero-based (i.e it allowed values are 0-11) while selected_day
- is one-based (i.e. allowed values are 1-31).</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkcalendar--freeze">
- <title>gtk.Calendar.freeze</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>freeze</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>freeze</methodname>() method stops the update of
-the calendar display until the <link
-linkend="method-gtkcalendar--thaw"><methodname>thaw</methodname>()</link>
-method is called. This method is used to reduce calendar flicker when doing
-a large number of updates to the calendar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcalendar--thaw">
- <title>gtk.Calendar.thaw</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>thaw</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>thaw</methodname>() method reenables the update
-of the calendar after a <link
-linkend="method-gtkcalendar--freeze"><methodname>freeze</methodname>()</link>
-method is called. All changes made since the last <link
-linkend="method-gtkcalendar--freeze"><methodname>freeze</methodname>()</link>
-are displayed</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcalendar--day-selected">
- <title>The "day-selected" gtk.Calendar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>calendar</parameter>&nbsp;:</term>
- <listitem><simpara>the calendar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "day-selected" signal is emitted when a day is selected
-either by the user or programatically.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcalendar--day-selected-double-click">
- <title>The "day-selected-double-click" gtk.Calendar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>calendar</parameter>&nbsp;:</term>
- <listitem><simpara>the calendar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "day-selected-double-click" signal is emitted when a
-calendar day is doubled-clicked by the user.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcalendar--month-changed">
- <title>The "month-changed" gtk.Calendar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>calendar</parameter>&nbsp;:</term>
- <listitem><simpara>the calendar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "month-changed" signal is emitted when the calendar month is
-changed programatically or by the user.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcalendar--next-month">
- <title>The "next-month" gtk.Calendar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>calendar</parameter>&nbsp;:</term>
- <listitem><simpara>the calendar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "next-month" signal is emitted when the user clicks the
-"next-month" navigation control in the calendar header.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcalendar--next-year">
- <title>The "next-year" gtk.Calendar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>calendar</parameter>&nbsp;:</term>
- <listitem><simpara>the calendar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "next-year" signal is emitted when the user clicks the
-"next-year" navigation control in the calendar header.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcalendar--prev-month">
- <title>The "prev-month" gtk.Calendar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>calendar</parameter>&nbsp;:</term>
- <listitem><simpara>the calendar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "prev-month" signal is emitted when the user clicks the
-"prev-month" navigation control in the calendar header.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcalendar--prev-year">
- <title>The "prev-year" gtk.Calendar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>calendar</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>calendar</parameter>&nbsp;:</term>
- <listitem><simpara>the calendar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "prev-year" signal is emitted when the user clicks the
-"prev-year" navigation control in the calendar header.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcelleditable.xml b/docs/reference/pygtk-gtkcelleditable.xml
deleted file mode 100644
index 05a3137b..00000000
--- a/docs/reference/pygtk-gtkcelleditable.xml
+++ /dev/null
@@ -1,220 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcelleditable">
- <refnamediv>
- <refname>gtk.CellEditable</refname>
- <refpurpose>an interface for editing a TreeView cell</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.CellEditable</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcelleditable--start-editing">start_editing</link></methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcelleditable--editing-done">editing_done</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcelleditable--remove-widget">remove_widget</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcelleditable">
- <title>gtk.CellEditable Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcelleditable--editing-done">editing-done</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>celleditable</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcelleditable--remove-widget">remove-widget</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>celleditable</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkcelleditable"><classname>gtk.CellEditable</classname></link>
-is an interface that provides editing of a cell in a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-cell.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcelleditable--start-editing">
- <title>gtk.CellEditable.start_editing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>start_editing</methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>start_editing</methodname>() method begins the
-editing on a <parameter>cell_editable</parameter> widget that has been
-reparented over the treeview cell. <parameter>event</parameter> is the
-<link linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
-that began the editing process. If the editing was initiated through
-programmatic means, <parameter>event</parameter> may be
-<literal>None</literal>, .
-</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcelleditable--editing-done">
- <title>gtk.CellEditable.editing_done</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>editing_done</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>editing_done</methodname>() method emits the
-"editing_done" signal that notifies the cell renderer to update it's value
-from the cell.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcelleditable--remove-widget">
- <title>gtk.CellEditable.remove_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_widget</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The remove_widget() method emits the "remove_widget" signal that
-indicates that the cell is finished editing, and the celleditable widget may
-now be destroyed.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcelleditable--editing-done">
- <title>The "editing-done" gtk.CellEditable Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>celleditable</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>celleditable</parameter>&nbsp;:</term>
- <listitem><simpara>the celleditable that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "editing-done" signal is emitted when the <link
-linkend="method-gtkcelleditable--editing-done"><methodname>editing_done</methodname>()</link>
-method is called.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcelleditable--remove-widget">
- <title>The "remove-widget" gtk.CellEditable Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>celleditable</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>celleditable</parameter>&nbsp;:</term>
- <listitem><simpara>the celleditable that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "remove-widget" signal is emitted when the cellrenderer for
-the treeview cell has retrieved the edited information and the celleditable
-widget can be destroyed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcelllayout.xml b/docs/reference/pygtk-gtkcelllayout.xml
deleted file mode 100644
index 44ef82aa..00000000
--- a/docs/reference/pygtk-gtkcelllayout.xml
+++ /dev/null
@@ -1,385 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkcelllayout">
- <refnamediv>
- <refname>gtk.CellLayout</refname>
- <refpurpose>an interface for packing cells</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.CellLayout</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcelllayout--pack-start">pack_start</link></methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- <methodparam><parameter role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcelllayout--pack-end">pack_end</link></methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- <methodparam><parameter role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcelllayout--clear">clear</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcelllayout--set-attributes">set_attributes</link></methodname>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcelllayout--add-attribute">add_attribute</link></methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- <methodparam><parameter role="keyword">attribute</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcelllayout--set-cell-data-func">set_cell_data_func</link></methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">func_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcelllayout--clear-attributes">clear_attributes</link></methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcelllayout--reorder">reorder</link></methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This interface is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para><link
-linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
-is an interface to be implemented by all objects that want to provide a
-<link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>-like
-API for packing cells, setting attributes and data funcs. The <link
-linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
-interface is implemented by the <link
-linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>,
-<link
-linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>,
-<link
-linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
-and <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-widgets.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcelllayout--pack-start">
- <title>gtk.CellLayout.pack_start</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pack_start</methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- <methodparam><parameter role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
- <listitem><simpara>A <link linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the
- <parameter>cell</parameter> is to be given extra space that is
- allocated to the cell layout.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>pack_start</methodname>() method packs the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell</parameter> into the beginning of the cell
-layout. If the optional parameter <parameter>expand</parameter> is
-<literal>False</literal>, then <parameter>cell</parameter> is allocated no
-more space than it needs. Any unused space is divided evenly between cells
-for which <parameter>expand</parameter> is <literal>True</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcelllayout--pack-end">
- <title>gtk.CellLayout.pack_end</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pack_end</methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- <methodparam><parameter role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
- <listitem><simpara>A <link linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the
- <parameter>cell</parameter> is to be given extra space that is
- allocated to the cell layout.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>pack_end</methodname>() method adds the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell</parameter> to the end of the cell layout. If
-the optional parameter <parameter>expand</parameter> is
-<literal>False</literal>, then the <parameter>cell</parameter> is allocated
-no more space than it needs. Any unused space is divided evenly between
-cells for which <parameter>expand</parameter> is
-<literal>True</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcelllayout--clear">
- <title>gtk.CellLayout.clear</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>clear</methodname>() method unsets all the
-attribute mappings on all cell renderers in the cell layout.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcelllayout--set-attributes">
- <title>gtk.CellLayout.set_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_attributes</methodname>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>cell</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
- linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>Zero or more keyword-value arguments in the format
- attribute=column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_attributes</methodname>() method sets the
-attributes provided as a keyword argument list as the attributes of the
-<link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell</parameter>. The attributes should be supplied
-as keyword-value arguments in the format: attribute=column (e.g. text=0,
-background=1). All existing attributes are removed, and replaced with the
-new attributes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcelllayout--add-attribute">
- <title>gtk.CellLayout.add_attribute</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_attribute</methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- <methodparam><parameter role="keyword">attribute</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
- <listitem><simpara>A <link linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">attribute</parameter>&nbsp;:</term>
- <listitem><simpara>An attribute on the renderer.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>The column number in the model to get the attribute from.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_attribute</methodname>() method adds an
-attribute mapping to the list in the cell layout. The
-<parameter>column</parameter> parameter is the column of the model to get a
-value from, and the <parameter>attribute</parameter> parameter is the
-attribute of <parameter>cell</parameter> to be set from the value. So for
-example if column 2 of the model contains strings, you could have the "text"
-attribute of a <link
-linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
-get its values from column 2.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcelllayout--set-cell-data-func">
- <title>gtk.CellLayout.set_cell_data_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_cell_data_func</methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">func_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
- <listitem><simpara>A <link linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>The function to use.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">func_data</parameter>&nbsp;:</term>
- <listitem><simpara>The user data for <parameter>func</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_cell_data_func</methodname>() method sets
-the function (or method) specified by <parameter>func</parameter> to be used
-for setting the column value of the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell</parameter> instead of using the standard
-attribute mapping method. <parameter>func</parameter> may be
-<literal>None</literal> to remove the current function. The signature of
-<parameter>func</parameter> is:</para>
-
- <programlisting>
-<methodsynopsis language="python">
- <methodname>celldatafunction</methodname>
- <methodparam><parameter>celllayout</parameter></methodparam>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>model</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname>celldatamethod</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>celllayout</parameter></methodparam>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>model</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis>
-</programlisting>
-
- <para>where <parameter>celllayout</parameter> is the <link
-linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>,
-<parameter>cell</parameter> is the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-for <parameter>celllayout</parameter>, <parameter>model</parameter> is the
-<link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> and
-<parameter>iter</parameter> is the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcelllayout--clear-attributes">
- <title>gtk.CellLayout.clear_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear_attributes</methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
- <listitem><simpara>A <link linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> to clear the attribute mapping on.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>clear_attributes</methodname>() method clears
-all existing attribute mappings from the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell</parameter> previously set with the <link
-linkend="method-gtkcelllayout--set-attributes"><methodname>set_attributes</methodname>()</link>
-or <link
-linkend="method-gtkcelllayout--add-attribute"><methodname>add_attribute</methodname>()</link>
-methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcelllayout--reorder">
- <title>gtk.CellLayout.reorder</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reorder</methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
- <listitem><simpara>A <link linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link> to reorder.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>New position to insert <parameter>cell</parameter> at.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>reorder</methodname>() method re-inserts the
-<link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell</parameter> at
-<parameter>position</parameter>. Note that <parameter>cell</parameter> has
-to already be packed into <parameter>cell_layout</parameter> for this to
-function properly.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcellrenderer.xml b/docs/reference/pygtk-gtkcellrenderer.xml
deleted file mode 100644
index 267394ce..00000000
--- a/docs/reference/pygtk-gtkcellrenderer.xml
+++ /dev/null
@@ -1,790 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcellrenderer">
- <refnamediv>
- <refname>gtk.CellRenderer</refname>
- <refpurpose>a base class for objects that render on a <link
- linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.CellRenderer</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderer--get-size">get_size</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter role="keyword">cell_area</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderer--render">render</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cell_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expose_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderer--activate">activate</link></methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cell_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderer--start-editing">start_editing</link></methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cell_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderer--editing-canceled">editing_canceled</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderer--stop-editing">stop_editing</link></methodname>
- <methodparam><parameter
- role="keyword">canceled</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderer--set-fixed-size">set_fixed_size</link></methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderer--get-fixed-size">get_fixed_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcellrenderer">
- <title>gtk.CellRenderer Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"cell-background"</entry>
- <entry>Write</entry>
- <entry>The background color of the cell as a string.
-Default: None.</entry>
- </row>
-
- <row valign="top">
- <entry>"cell-background-gdk"</entry>
- <entry>Read/Write</entry>
- <entry>The background color of the cell as a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>.</entry>
- </row>
-
- <row valign="top">
- <entry>"cell-background-set"</entry>
- <entry>Read/Write</entry>
- <entry>If True the cell background color is set by this
-cellrenderer. Default: False.</entry>
- </row>
-
- <row valign="top">
- <entry>"height"</entry>
- <entry>Read/Write</entry>
- <entry>The fixed height of the cell. Allowed values >= -1.
-Default: -1.</entry>
- </row>
-
- <row valign="top">
- <entry>"is-expanded"</entry>
- <entry>Read/Write</entry>
- <entry>If True the row has children and it is expanded to show the
-children. Default: False.</entry>
- </row>
-
- <row valign="top">
- <entry>"is-expander"</entry>
- <entry>Read/Write</entry>
- <entry>If True the row has children. Default: False.</entry>
- </row>
-
- <row valign="top">
- <entry>"mode"</entry>
- <entry>Read/Write</entry>
- <entry>The editable mode of the cellrenderer. One of the <xref
- linkend="gtk-cellrenderer-mode-constants"
- endterm="gtk-cellrenderer-mode-constants-title"></xref>.
-Default: <literal>gtk.CELL_RENDERER_MODE_INERT</literal>,</entry>
- </row>
-
- <row valign="top">
- <entry>"sensitive"</entry>
- <entry>Read/Write</entry>
- <entry>If True the cell is displayed as sensitive. Available in
- GTK+ 2.6 and above. Default: True.</entry>
- </row>
-
- <row valign="top">
- <entry>"visible"</entry>
- <entry>Read/Write</entry>
- <entry>If True the cell is displayed. Default: True.</entry>
- </row>
-
- <row valign="top">
- <entry>"width"</entry>
- <entry>Read/Write</entry>
- <entry>The fixed width of the cell. Allowed values >= -1.
-Default: -1.</entry>
- </row>
-
- <row valign="top">
- <entry>"xalign"</entry>
- <entry>Read/Write</entry>
- <entry>The fraction of <emphasis>free</emphasis> space to the left
- of the cell in the range 0.0 to 1.0. Allowed values between 0 and
- 1. Default: 0.5.</entry>
- </row>
-
- <row valign="top">
- <entry>"xpad"</entry>
- <entry>Read/Write</entry>
- <entry>The amount of padding to the left and right of the
- cell. Default: 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"yalign"</entry>
- <entry>Read/Write</entry>
- <entry>The fraction of <emphasis>free</emphasis> space above the
- cell in the range 0.0 to 1.0. Allowed values between 0 and 1.
- Default: 0.5.</entry>
- </row>
-
- <row valign="top">
- <entry>"ypad"</entry>
- <entry>Read/Write</entry>
- <entry>The amount of padding above and below cell. Default:
- 0.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcellrenderer">
- <title>gtk.CellRenderer Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkcellrenderer--editing-canceled">editing-canceled</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>cellrenderer</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkcellrenderer--editing-started">editing-started</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>cellrenderer</parameter></methodparam>
- <methodparam><parameter>editable</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-is a base class for a set of objects used for rendering a cell to a <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>. The
-<link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-provides the common attributes and methods for its subclasses (<link
-linkend="class-gtkcellrendererpixbuf"><classname>gtk.CellRendererPixbuf</classname></link>,
-<link
-linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
-and <link
-linkend="class-gtkcellrenderertoggle"><classname>gtk.CellRendererToggle</classname></link>).</para>
-
- <para>The primary use of a <link
- linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
- is for drawing a certain graphical elements on a <link
- linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>. Typically,
- one cell renderer is used to draw many cells on the screen. To this
- extent, it isn't expected that a CellRenderer keep any permanent state
- around. Instead, any state is set just prior to use using the GObjects
- property system. Then, the cell is measured using the <link
- linkend="method-gtkcellrenderer--get-size"><methodname>get_size</methodname>()</link>
- method. Finally, the cell is rendered in the correct location using the
- <link
- linkend="method-gtkcellrenderer--render"><methodname>render</methodname>()</link>
- method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcellrenderer--get-size">
- <title>gtk.CellRenderer.get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cell_area</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget the renderer is rendering
-to</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">cell_area</parameter>&nbsp;:</term>
- <listitem><simpara>The area a cell will be allocated, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the xoffset, yoffset, width
-and height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_size</methodname>() method obtains the width
-and height needed to render the cell. These values are returned as part of a
-tuple containing the x_offset, y_offset, width and height.
-<methodname>get_size</methodname>() is used by view widgets to determine the
-appropriate size for the <parameter>cell_area</parameter> to be passed to
-the <link
-linkend="method-gtkcellrenderer--render"><function>gtk.CellRenderer.render()</function></link>
-method. If <parameter>cell_area</parameter> is not <literal>None</literal>,
-the x and y offsets of the cell relative to this location are returned.
-Please note that the values set in the returned width and height, as well as
-those in x_offset and y_offset are inclusive of the xpad and ypad
-properties.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellrenderer--render">
- <title>gtk.CellRenderer.render</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>render</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cell_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expose_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-to draw to</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget owning
-<parameter>window</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">background_area</parameter>&nbsp;:</term>
- <listitem><simpara>entire cell area (including tree expanders and
-maybe padding on the sides)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">cell_area</parameter>&nbsp;:</term>
- <listitem><simpara>area normally rendered by a cell
-renderer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">expose_area</parameter>&nbsp;:</term>
- <listitem><simpara>area that actually needs
-updating</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>flags that affect
-rendering</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>render</methodname>() method invokes the virtual
-render function of the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.
-The three passed-in rectangles are areas of <parameter>window</parameter>.
-Most renderers will draw within <parameter>cell_area</parameter>; the
-xalign, yalign, xpad, and ypad properties of the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-should be honored with respect to <parameter>cell_area</parameter>.
-<parameter>background_area</parameter> includes the blank space around the
-cell, and also the area containing the tree expander; so the
-<parameter>background_area</parameter> rectangles for all cells tile to
-cover the entire <parameter>window</parameter>.
-<parameter>expose_area</parameter> is a clip rectangle.</para>
-
- <para>The <parameter>flags</parameter> value is one of:
-<literal>gtk.CELL_RENDERER_SELECTED</literal>,
-<literal>gtk.CELL_RENDERER_PRELIT</literal>,
-<literal>gtk.CELL_RENDERER_INSENSITIVE</literal> or
-<literal>gtk.CELL_RENDERER_SORTED</literal></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellrenderer--activate">
- <title>gtk.CellRenderer.activate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>activate</methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cell_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>widget that received the
-event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>widget-dependent string representation of the
-event location; e.g. for <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>, a
-string representation of
-<literal>gtk.TreePath</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">background_area</parameter>&nbsp;:</term>
- <listitem><simpara>background area as passed to <link
-linkend="method-gtkcellrenderer--render"><methodname>render</methodname>()</link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">cell_area</parameter>&nbsp;:</term>
- <listitem><simpara>cell area as passed to <link
-linkend="method-gtkcellrenderer--render"><methodname>render</methodname>()</link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>render flags</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the event was
-consumed/handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>activate</methodname>() method passes an
-activate event to the cell renderer for possible processing. Some cell
-renderers may use events; for example, <link
-linkend="class-gtkcellrenderertoggle"><classname>gtk.CellRendererToggle</classname></link>
-toggles when it gets a mouse click.</para>
-
- <para>The <parameter>flags</parameter> value is one of:
-<literal>gtk.CELL_RENDERER_SELECTED</literal>,
-<literal>gtk.CELL_RENDERER_PRELIT</literal>,
-<literal>gtk.CELL_RENDERER_INSENSITIVE</literal> or
-<literal>gtk.CELL_RENDERER_SORTED</literal></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellrenderer--start-editing">
- <title>gtk.CellRenderer.start_editing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>start_editing</methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">background_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cell_area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a widget-dependent string representation of the
-event location; e.g. for <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>, a
-string representation of
-<literal>gtk.TreePath</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">background_area</parameter>&nbsp;:</term>
- <listitem><simpara>background area as passed to <link
-linkend="method-gtkcellrenderer--render"><methodname>render</methodname>()</link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">cell_area</parameter>&nbsp;:</term>
- <listitem><simpara>cell area as passed to <link
-linkend="method-gtkcellrenderer--render"><methodname>render</methodname>()</link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>render flags</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new <link
-linkend="class-gtkcelleditable"><classname>gtk.CellEditable</classname></link>,
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>start_editing</methodname>() method initiates
-the editing of a cell.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellrenderer--editing-canceled">
- <title>gtk.CellRenderer.editing_canceled</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>editing_canceled</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.6 and above. Use the
-<link
-linkend="method-gtkcellrenderer--stop-editing"><methodname>stop_editing</methodname>()</link>
-method instead.</para>
- </warning>
-
- <para>The <methodname>editing_canceled</methodname>() method causes
-the cell renderer to emit the "editing-canceled" signal. This method is for
-use only by implementations of cell renderers that need to notify the client
-program that an editing process was canceled and the changes were not
-committed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellrenderer--stop-editing">
- <title>gtk.CellRenderer.stop_editing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>stop_editing</methodname>
- <methodparam><parameter
- role="keyword">canceled</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">canceled</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the editing has been
-canceled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>stop_editing</methodname>() method informs the
-cell renderer that the editing is stopped. If
-<parameter>canceled</parameter> is <literal>True</literal>, the cell
-renderer will emit the "editing-canceled" signal. This method should be
-called by cell renderer implementations in response to the "editing-done"
-signal of <link
-linkend="class-gtkcelleditable"><classname>gtk.CellEditable</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellrenderer--set-fixed-size">
- <title>gtk.CellRenderer.set_fixed_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_fixed_size</methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the cell renderer, or
--1</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the cell renderer, or
--1</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_fixed_size</methodname>() method sets the
-renderer size to the specified <parameter>width</parameter> and
-<parameter>height</parameter>, independent of the properties set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellrenderer--get-fixed-size">
- <title>gtk.CellRenderer.get_fixed_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_fixed_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>a tuple containing the width and height of the
-cell</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_fixed_size</methodname>() method retrieves a
-tuple containing the fixed <parameter>width</parameter> and
-<parameter>height</parameter> of the cell.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcellrenderer--editing-canceled">
- <title>The "editing-canceled" gtk.CellRenderer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>cellrenderer</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>cellrenderer</parameter>&nbsp;:</term>
- <listitem><simpara>the cellrenderer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "editing-canceled" signal is emitted when the user cancels
- the process of editing a cell. For example, an editable cell renderer
- could be written to cancel editing when the user presses Escape. Also
- see the <link
- linkend="method-gtkcellrenderer--editing-canceled"><methodname>editing_canceled</methodname>()</link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcellrenderer--editing-started">
- <title>The "editing-started" gtk.CellRenderer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>cellrenderer</parameter></methodparam>
- <methodparam><parameter>editable</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>cellrenderer</parameter>&nbsp;:</term>
- <listitem><simpara>the cellrenderer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>editable</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkcelleditable"><classname>gtk.CellEditable</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>he path identifying the edited
-cell</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.6 and above.</para>
- </note>
-
- <para>The "editing-started" signal is emitted when a cell starts to be
-edited. The intended use of this signal is to do special setup on
-<parameter>editable</parameter>, e.g. adding a <link
-linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
-or setting up additional columns in a <link
-linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>.</para>
-
- <para>Note that GTK+ doesn't guarantee that cell renderers will
-continue to use the same kind of widget for editing in future releases,
-therefore you should check the type of editable before doing any specific
-setup, as in the following example:</para>
-
- <programlisting>
-def text_editing_started(cell, editable, path, data):
- if isinstance(editable, gtk.Entry):
- # ... create a GtkEntryCompletion
- completion = gtk.EntryCompletion()
- editable.set_completion(completion)
- ...
- ...
-</programlisting>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcellrendereraccel.xml b/docs/reference/pygtk-gtkcellrendereraccel.xml
deleted file mode 100644
index 19ea8546..00000000
--- a/docs/reference/pygtk-gtkcellrendereraccel.xml
+++ /dev/null
@@ -1,296 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcellrendereraccel">
-
- <refnamediv>
- <refname>gtk.CellRendererAccel</refname>
- <refpurpose>an object that renders a keyboard accelerator in a cell
- (new in PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.CellRendererAccel</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkcellrenderertext">gtk.CellRendererText</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkcellrendereraccel">gtk.CellRendererAccel</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
- +-- <link linkend="class-gtkcellrenderertext">gtk.CellRendererText</link>
- +-- <link linkend="class-gtkcellrendereraccel">gtk.CellRendererAccel</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcellrendereraccel">
- <title>gtk.CellRendererAccel Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para>
- <para><link linkend="properties-gtkcellrenderertext">gtk.CellRendererText Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"accel-key"</entry>
- <entry>Read-Write</entry>
- <entry>The keyval of the accelerator. Default value: 0. This
- property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"accel-mode"</entry>
- <entry>Read-Write</entry>
- <entry>Determines if the edited accelerators are GTK+
- accelerators. If they are, consumed modifiers are suppressed,
- only accelerators accepted by GTK+ are allowed, and the
- accelerators are rendered in the same way as they are in
- menus. one of the <xref
- linkend="gtk-cellrendereraccel-mode-constants"
- endterm="gtk-cellrendereraccel-mode-constants-title"></xref>. Default
- value:
- <literal>gtk.CELL_RENDERER_ACCEL_MODE_GTK</literal>. This
- property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"accel-mods"</entry>
- <entry>Read-Write</entry>
- <entry>The modifier mask of the accelerator. One of the <xref
- linkend="gdk-modifier-constants"
- endterm="gdk-modifier-constants-title"></xref>. This property
- is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"keycode"</entry>
- <entry>Read-Write</entry>
- <entry>The hardware keycode of the accelerator. Note that the
- hardware keycode is only relevant if the key does not have a
- keyval. Normally, the keyboard configuration should assign
- keyvals to all keys. Default value: 0. This property is
- available in GTK+ 2.10 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcellrendereraccel">
- <title>gtk.CellRendererAccel Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcellrenderertext">gtk.CellRendererText Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkcellrendereraccel--accel-cleared">accel-cleared</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>cellrendereraccel</parameter></methodparam>
- <methodparam><parameter>path_string</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkcellrendereraccel--accel-edited">accel-edited</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>cellrendereraccel</parameter></methodparam>
- <methodparam><parameter>path_string</parameter></methodparam>
- <methodparam><parameter>accel_key</parameter></methodparam>
- <methodparam><parameter>accel_mods</parameter></methodparam>
- <methodparam><parameter>hardware_keycode</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-gtkcellrendereraccel"><classname>gtk.CellRendererAccel</classname></link>
- displays a keyboard accelerator (i.e. a key combination like
- <keycombo><keycap>Control</keycap><keycap>a</keycap></keycombo>). If the
- cell renderer is editable, the accelerator can be changed by simply
- typing the new combination.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkcellrendereraccel">
- <title>gtk.CellRendererAccel</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.CellRendererAccel</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new cell renderer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkcellrendereraccel"><classname>gtk.CellRendererAccel</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcellrendereraccel--accel-cleared">
- <title>The "accel-cleared" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>cellrendereraccel</parameter></methodparam>
- <methodparam><parameter>path_string</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>cellrendereraccel</parameter>&nbsp;:</term>
- <listitem><simpara>the cellrendereraccel that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path_string</parameter>&nbsp;:</term>
- <listitem><simpara>the path identifying the row of the cleared
- cell as a string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "accel-cleared" signal is emitted when the user has removed
- the accelerator.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcellrendereraccel--accel-edited">
- <title>The "accel-edited" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>cellrendereraccel</parameter></methodparam>
- <methodparam><parameter>path_string</parameter></methodparam>
- <methodparam><parameter>accel_key</parameter></methodparam>
- <methodparam><parameter>accel_mods</parameter></methodparam>
- <methodparam><parameter>hardware_keycode</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>cellrendereraccel</parameter>&nbsp;:</term>
- <listitem><simpara>the cellrendereraccel that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path_string</parameter>&nbsp;:</term>
- <listitem><simpara>the path identifying the row of the edited cell
- as a string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>accel_key</parameter>&nbsp;:</term>
- <listitem><simpara>the new accelerator keyval </simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>accel_mods</parameter>&nbsp;:</term>
- <listitem><simpara>the new acclerator modifier
- mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>hardware_keycode</parameter>&nbsp;:</term>
- <listitem><simpara>the keycode of the new
- accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "accel-edited" signal is emitted when the user has selected
- a new accelerator.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcellrenderercombo.xml b/docs/reference/pygtk-gtkcellrenderercombo.xml
deleted file mode 100644
index 47e4d238..00000000
--- a/docs/reference/pygtk-gtkcellrenderercombo.xml
+++ /dev/null
@@ -1,147 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcellrenderercombo">
- <refnamediv>
- <refname>gtk.CellRendererCombo</refname> <refpurpose>an object that
- renders a <link
- linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>
- into a <link
- linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
- cell (new in PyGTK 2.6)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.CellRendererCombo</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcellrenderertext">gtk.CellRendererText</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcellrenderercombo">gtk.CellRendererCombo</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
- +-- <link linkend="class-gtkcellrenderertext">gtk.CellRendererText</link>
- +-- <link linkend="class-gtkcellrenderercombo">gtk.CellRendererCombo</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcellrenderercombo">
- <title>gtk.CellRendererCombo Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para>
- <para><link linkend="properties-gtkcellrenderertext">gtk.CellRendererText Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"has-entry"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>False</literal>, don't allow entering strings
-other than the given ones. Default value: <literal>True</literal>. Available
-in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"model"</entry>
- <entry>Read/Write</entry>
- <entry>The tree model containing the possible values for the combo
-box entry. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"text-column"</entry>
- <entry>Read/Write</entry>
- <entry>A column in the data source model to get the strings from.
-Allowed values: >= -1. Default value: -1. Available in GTK+ 2.6 and
-above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcellrenderercombo">
- <title>gtk.CellRendererCombo Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcellrenderertext">gtk.CellRendererText Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <link
-linkend="class-gtkcellrenderercombo"><classname>gtk.CellRendererCombo</classname></link>
-manages the rendering of a <link
-linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>
-into a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-cell.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcellrenderercombo">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.CellRendererCombo</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new cell renderer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkcellrenderercombo"><classname>gtk.CellRendererCombo</classname></link>.
-Rendering parameters are adjusted using the object properties. The object
-properties can be set globally (with <link
-linkend="method-gobject--set-property"><methodname>set_property</methodname>()</link>).
-Also, with <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>,
-you can bind a property to a value in a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.
-For example, you can bind the "text" property on the cell renderer to a
-string value in the model, thus rendering a different string in each row of
-the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcellrendererpixbuf.xml b/docs/reference/pygtk-gtkcellrendererpixbuf.xml
deleted file mode 100644
index 47a22a08..00000000
--- a/docs/reference/pygtk-gtkcellrendererpixbuf.xml
+++ /dev/null
@@ -1,164 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcellrendererpixbuf">
- <refnamediv>
- <refname>gtk.CellRendererPixbuf</refname> <refpurpose>an object that
- renders a pixbuf into a <link
- linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
- cell</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.CellRendererPixbuf</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcellrenderer">gtk.CellRenderer</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcellrendererpixbuf">gtk.CellRendererPixbuf</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
- +-- <link linkend="class-gtkcellrendererpixbuf">gtk.CellRendererPixbuf</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcellrendererpixbuf">
- <title>gtk.CellRendererPixbuf Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"follow-state"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the rendered pixbuf should be
- colorized according to the <xref
- linkend="gtk-cellrenderer-state-constants"
- endterm="gtk-cellrenderer-state-constants-title"></xref>. This
- property is available in GTK+ 2.8 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"icon-name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the themed icon to display. This property only
- has an effect if not overridden by "stock_id" or "pixbuf"
- properties. This property is available in GTK+ 2.8 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"pixbuf"</entry>
- <entry>Read/Write</entry>
- <entry>The pixbuf to render.</entry>
- </row>
-
- <row valign="top">
- <entry>"pixbuf-expander-closed"</entry>
- <entry>Read/Write</entry>
- <entry>Pixbuf for closed expander.</entry>
- </row>
-
- <row valign="top">
- <entry>"pixbuf-expander-open"</entry>
- <entry>Read/Write</entry>
- <entry>Pixbuf for open expander.</entry>
- </row>
-
- <row valign="top">
- <entry>"stock-detail"</entry>
- <entry>Read/Write</entry>
- <entry>Render detail to pass to the theme engine</entry>
- </row>
-
- <row valign="top">
- <entry>"stock-id"</entry>
- <entry>Read/Write</entry>
- <entry>The stock ID of the stock icon to render</entry>
- </row>
-
- <row valign="top">
- <entry>"stock-size"</entry>
- <entry>Read/Write</entry>
- <entry>The size of the rendered icon</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcellrendererpixbuf">
- <title>gtk.CellRendererPixbuf Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkcellrendererpixbuf"><classname>gtk.CellRendererPixbuf</classname></link>
-manages the rendering of a pixbuf into a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-cell.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcellrendererpixbuf">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.CellRendererPixbuf</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new cell renderer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkcellrendererpixbuf"><classname>gtk.CellRendererPixbuf</classname></link>.
-Rendering parameters are adjusted using the object properties. The object
-properties can be set globally (with <link
-linkend="method-gobject--set-property"><methodname>set_property</methodname>()</link>).
-Also, with <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>,
-you can bind a property to a value in a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.
-For example, you can bind the "pixbuf" property on the cell renderer to a
-pixbuf value in the model, thus rendering a different image in each row of
-the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcellrendererprogress.xml b/docs/reference/pygtk-gtkcellrendererprogress.xml
deleted file mode 100644
index 4f57e85e..00000000
--- a/docs/reference/pygtk-gtkcellrendererprogress.xml
+++ /dev/null
@@ -1,134 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcellrendererprogress">
- <refnamediv>
- <refname>gtk.CellRendererProgress</refname>
- <refpurpose>an object that renders numbers as progress bars in a <link
- linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
- (new in PyGTK 2.6)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.CellRendererProgress</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcellrenderer">gtk.CellRenderer</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcellrendererprogress">gtk.CellRendererProgress</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
- +-- <link linkend="class-gtkcellrendererprogress">gtk.CellRendererProgress</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcellrendererprogress">
- <title>gtk.CellRendererProgress Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"text"</entry>
- <entry>Read/Write</entry>
- <entry>The text in the label that will be drawn over the progress bar.
-Setting this property to <literal>None</literal> causes the default label to
-be displayed. Setting this property to an empty string causes no label to be
-displayed. Default value: <literal>None</literal>. Available in GTK+ 2.6 and
-above.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read/Write</entry>
- <entry>The percentage that the progress bar is "filled in".
-Available in GTK+ 2.6 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcellrendererprogress">
- <title>gtk.CellRendererProgress Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <link
-linkend="class-gtkcellrendererprogress"><classname>gtk.CellRendererProgress</classname></link>
-manages the rendering of a number as a progress bar in a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-cell.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcellrendererprogress">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.CellRendererProgress</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new cell renderer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkcellrendererprogress"><classname>gtk.CellRendererProgress</classname></link>.
-Rendering parameters are adjusted using the object properties. The object
-properties can be set globally (with <link
-linkend="method-gobject--set-property"><methodname>set_property</methodname>()</link>).
-Also, with <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>,
-you can bind a property to a value in a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.
-For example, you can bind the "text" property on the cell renderer to a
-string value in the model, thus rendering a different string in each row of
-the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcellrendererspin.xml b/docs/reference/pygtk-gtkcellrendererspin.xml
deleted file mode 100644
index f319fa63..00000000
--- a/docs/reference/pygtk-gtkcellrendererspin.xml
+++ /dev/null
@@ -1,155 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcellrendererspin">
-
- <refnamediv>
- <refname>gtk.CellRendererSpin</refname>
- <refpurpose>an object that renders a spin button in a cell (new in
- PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.CellRendererSpin</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkcellrenderertext">gtk.CellRendererText</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkcellrendererspin">gtk.CellRendererSpin</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
- +-- <link linkend="class-gtkcellrenderertext">gtk.CellRendererText</link>
- +-- <link linkend="class-gtkcellrendererspin">gtk.CellRendererSpin</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcellrendererspin">
- <title>gtk.CellRendererSpin Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para>
- <para><link linkend="properties-gtkcellrenderertext">gtk.CellRendererText Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"adjustment"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
- linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
- that holds the value of the spinbutton. This must be non-None
- for the cell renderer to be editable. Default value:
- None. Available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"climb-rate"</entry>
- <entry>Read-Write</entry>
- <entry>The acceleration rate when you hold down a
- button. Range: [0.0,MAXDOUBLE]. Default value: 0.0. Available
- in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"digits"</entry>
- <entry>Read-Write</entry>
- <entry>The number of decimal places to display. Range:
- [0,20]. Default value: 0. Available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcellrendererspin">
- <title>gtk.CellRendererSpin Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcellrenderertext">gtk.CellRendererText Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-gtkcellrendererspin"><classname>gtk.CellRendererSpin</classname></link>
- renders text in a cell like <link
- linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
- from which it is derived. But while <link
- linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
- offers a simple entry to edit the text, <link
- linkend="class-gtkcellrendererspin"><classname>gtk.CellRendererSpin</classname></link>
- offers a <link
- linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>
- widget. Of course, that means that the text has to be parseable as a
- floating point number.</para>
-
- <para>The range of the spinbutton is taken from the "adjustment"
- property of the cell renderer, which can be set explicitly or mapped to
- a column in the tree model. Like all properties of cellrenderers. <link
- linkend="class-gtkcellrendererspin"><classname>gtk.CellRendererSpin</classname></link>
- also has properties for the "climb-rate" and the number of "digits" to
- display. Other <link
- linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>
- properties can be set in a handler for the "<link
- linkend="signal-gtkcellrenderer--editing-started">gtk.CellRenderer.editing-started</link>"
- signal. </para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkcellrendererspin">
- <title>gtk.CellRendererSpin</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.CellRendererSpin</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkcellrendererspin"><classname>gtk.CellRendererSpin</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkcellrendererspin"><classname>gtk.CellRendererSpin</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcellrenderertext.xml b/docs/reference/pygtk-gtkcellrenderertext.xml
deleted file mode 100644
index dfb15d6f..00000000
--- a/docs/reference/pygtk-gtkcellrenderertext.xml
+++ /dev/null
@@ -1,538 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcellrenderertext">
- <refnamediv>
- <refname>gtk.CellRendererText</refname>
-
- <refpurpose>an object that renders text into a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-cell</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.CellRendererText</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcellrenderer">gtk.CellRenderer</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkcellrenderertext">gtk.CellRendererText</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderertext--set-fixed-height-from-font">set_fixed_height_from_font</link></methodname>
- <methodparam><parameter
- role="keyword">number_of_rows</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
- +-- <link linkend="class-gtkcellrenderertext">gtk.CellRendererText</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcellrenderertext">
- <title>gtk.CellRendererText Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"alignment"</entry>
- <entry>Read/Write</entry>
- <entry>Specifies how to align the lines of text using one of the
- <xref linkend="pango-alignment-constants"
- endterm="pango-alignment-constants-title"></xref> Default value:
- <literal>pango.ALIGN_LEFT</literal>. This propserty is available
- in GTK+ 2.10 and above.</entry>
- </row>
-
-
- <row valign="top">
- <entry>"attributes"</entry>
- <entry>Read/Write</entry>
- <entry>A list of style attributes to apply to the text of the
-renderer.</entry>
- </row>
-
- <row valign="top">
- <entry>"background"</entry>
- <entry>Write</entry>
- <entry>Background color as a string. Default:
- <literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"background-gdk"</entry>
- <entry>Read/Write</entry>
- <entry>Background color as a gtk.gdk.Color</entry>
- </row>
-
- <row valign="top">
- <entry>"background-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the background
-color. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"editable"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> the text can be modified by the
-user. GTK+ 2.4 and above. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"editable-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the text
-editability. GTK+ 2.4 and above. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"ellipsize"</entry>
- <entry>Read/Write</entry>
- <entry>The preferred place to ellipsize the string, if the cell
-renderer does not have enough room to display the entire string, if at all.
-GTK+ 2.6 and above. Default: <literal>pango.ELLIPSIZE_NONE</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"ellipsize-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the text
-editability. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"family"</entry>
- <entry>Read/Write</entry>
- <entry>Name of the font family, e.g. Sans, Helvetica, Times,
-Monospace. Default: <literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"family-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the font
-family. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"font"</entry>
- <entry>Read/Write</entry>
- <entry>Font description as a string. Default:
-<literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"font-desc"</entry>
- <entry>Read/Write</entry>
- <entry>Font description as a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link></entry>
- </row>
-
- <row valign="top">
- <entry>"foreground"</entry>
- <entry>Write</entry>
- <entry>Foreground color as a string. Default:
-<literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"foreground-gdk"</entry>
- <entry>Read/Write</entry>
- <entry>Foreground color as a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></entry>
- </row>
-
- <row valign="top">
- <entry>"foreground-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the foreground
-color. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"language"</entry>
- <entry>Read/Write</entry>
- <entry>The language this text is in, as an ISO code. Pango can use
-this as a hint when rendering the text. If you don't understand this parameter,
-you probably don't need it. GTK+ 2.4 and above. Default:
-<literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"language-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the
-language used to render the text. GTK+ 2.4 and above. Default:
-<literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"markup"</entry>
- <entry>Write</entry>
- <entry>Marked up text to render. Default:
-<literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"rise"</entry>
- <entry>Read/Write</entry>
- <entry>Offset of text above the baseline (below the baseline if
-rise is negative). Default: 0</entry>
- </row>
-
- <row valign="top">
- <entry>"rise-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the
-rise. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"scale"</entry>
- <entry>Read/Write</entry>
- <entry>Font scaling factor. Allowed values &gt;= 0.
-Default: 1</entry>
- </row>
-
- <row valign="top">
- <entry>"scale-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag scales the font.
-Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"single-paragraph-mode"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, keep all text in a single
-paragraph. GTK+ 2.4 and above. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"size"</entry>
- <entry>Read/Write</entry>
- <entry>Font size. Allowed values &gt;= 0. Default: 0</entry>
- </row>
-
- <row valign="top">
- <entry>"size-points"</entry>
- <entry>Read/Write</entry>
- <entry>Font size in points. Allowed values &gt;= 0.
-Default: 0</entry>
- </row>
-
- <row valign="top">
- <entry>"size-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the font
-size. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"stretch"</entry>
- <entry>Read/Write</entry>
- <entry>Font stretch. Default:
-<literal>pango.STRETCH_NORMAL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"stretch-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the font
-stretch. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"strikethrough"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> strike through the text.
-Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"strikethrough-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the
-strikethrough. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"style"</entry>
- <entry>Read/Write</entry>
- <entry>Font style. Default:
-<literal>pango.STYLE_NORMAL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"style-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the font
-style. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"text"</entry>
- <entry>Read/Write</entry>
- <entry>Text to render. Default: <literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"underline"</entry>
- <entry>Read/Write</entry>
- <entry>Style of underline for this text.
-Default: <literal>pango.UNDERLINE_NONE</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"underline-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the text
-underlining. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"variant"</entry>
- <entry>Read/Write</entry>
- <entry>Font variant. Default:
-<literal>pango.VARIANT_NORMAL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"variant-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the font
-variant. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"weight"</entry>
- <entry>Read/Write</entry>
- <entry>Font weight. Allowed values &gt;= 0. Default value:
-400</entry>
- </row>
-
- <row valign="top">
- <entry>"weight-set"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> this tag affects the font
-weight. Default: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"width-chars"</entry>
- <entry>Read/Write</entry> <entry>The desired width of the cell, in
- characters. If this property is set to -1, the width will be
- calculated automatically, otherwise the cell will request either 3
- characters or the property value, whichever is greater. GTK+ 2.6
- and above. Allowed values &gt;= -1. Default value: -1</entry>
- </row>
-
- <row valign="top">
- <entry>"wrap-mode"</entry>
- <entry>Read-Write</entry>
- <entry>Specifies how to break the string into multiple lines, if
- the cell renderer does not have enough room to display the entire
- string. This property has no effect unless the "wrap-width"
- property is set. This property is available in GTK+ 2.8 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"wrap-width"</entry>
- <entry>Read-Write</entry>
- <entry>Specifies the width at which the text is wrapped. The
- "wrap-mode" property can be used to influence at what character
- positions the line breaks can be placed. Setting "wrap-width" to
- -1 turns wrapping off. This property is available in GTK+ 2.8 and
- above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcellrenderertext">
- <title>gtk.CellRendererText Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcellrenderertext--edited">edited</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>cellrenderertext</parameter>
- </methodparam>
- <methodparam><parameter>path</parameter>
- </methodparam>
- <methodparam><parameter>new_text</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
- linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
- manages the rendering of text into a <link
- linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
- cell, using the font, color and style information provided by its
- properties. The text will be ellipsized if it is too long and the
- "ellipsize" property allows it.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcellrenderertext">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.CellRendererText</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new cell renderer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>.
-The way that text is drawn is changed using object properties. The object
-properties can be set globally (with <link
-linkend="method-gobject--set-property"><methodname>set_property</methodname>()</link>).
-Also, with <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>,
-you can bind a property to a value in a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.
-For example, you can bind the "text" property on the cell renderer to a
-string value in the model, thus rendering a different string in each row of
-the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcellrenderertext--set-fixed-height-from-font">
- <title>gtk.CellRendererText.set_fixed_height_from_font</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_fixed_height_from_font</methodname>
- <methodparam><parameter
- role="keyword">number_of_rows</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">number_of_rows</parameter>&nbsp;:</term>
- <listitem><simpara>Number of rows of text each cell renderer is
-allocated, or -1</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_fixed_height_from_font</methodname>() sets
-the height of a renderer to explicitly be determined by the "font" and
-"ypad" properties set on it. This method must be called each time these
-properties are changed to affect the height. This function is inflexible,
-and should really only be used if calculating the size of a cell is too slow
-(i.e. a massive number of cells displayed). If
-<parameter>number_of_rows</parameter> is -1, then the fixed height is unset,
-and the height is determined by the properties again.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcellrenderertext--edited">
- <title>The "edited" gtk.CellRendererText Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>cellrenderertext</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>new_text</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>cellrenderertext</parameter>&nbsp;:</term>
- <listitem><simpara>the cellrenderertext that received the
-"edited" signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>the path string of the
-cellrenderertext</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>new_text</parameter>&nbsp;:</term>
- <listitem><simpara>the new text of the
-cellrenderertext</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "edited" signal is emitted when the text in the cell has
-been edited.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcellrenderertoggle.xml b/docs/reference/pygtk-gtkcellrenderertoggle.xml
deleted file mode 100644
index bf4ea707..00000000
--- a/docs/reference/pygtk-gtkcellrenderertoggle.xml
+++ /dev/null
@@ -1,324 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkcellrenderertoggle">
- <refnamediv>
- <refname>gtk.CellRendererToggle</refname>
- <refpurpose>an object that renders a toggle button into a TreeView
-cell</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.CellRendererToggle</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcellrenderer">gtk.CellRenderer</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcellrenderertoggle">gtk.CellRendererToggle</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderertoggle--get-radio">get_radio</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderertoggle--set-radio">set_radio</link></methodname>
- <methodparam><parameter
- role="keyword">radio</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderertoggle--get-active">get_active</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcellrenderertoggle--set-active">set_active</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
- +-- <link linkend="class-gtkcellrenderertoggle">gtk.CellRendererToggle</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcellrenderertoggle">
- <title>gtk.CellRendererToggle Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"activatable"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, the toggle button can be
- activated</entry>
- </row>
-
- <row valign="top">
- <entry>"active"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, the button is active.</entry>
- </row>
-
- <row valign="top">
- <entry>"inconsistent"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, the button is in an
- inconsistent state. GTK+ 2.2 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"indicator-size"</entry>
- <entry>Read-Write</entry>
- <entry>Size of check or radio indicator. Allowed values: >= 0.
- Default value: 12.</entry>
- </row>
-
- <row valign="top">
- <entry>"radio"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, draw the toggle button as a
- radio button</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcellrenderertoggle">
- <title>gtk.CellRendererToggle Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcellrenderertoggle--toggled">toggled</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>cellrenderertoggle</parameter>
- </methodparam>
- <methodparam><parameter>path</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
- linkend="class-gtkcellrenderertoggle"><classname>gtk.CellRendererToggle</classname></link>
- manages the rendering of toggle button into a <link
- linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
- cell. The button is drawn as a radio- or checkbutton, depending on the
- "radio" property. When activated, it emits the toggled signal.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcellrenderertoggle">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.CellRendererToggle</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new cell renderer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkcellrenderertoggle"><classname>gtk.CellRendererToggle</classname></link>.
-The toggle button rendering parameters are adjusted using the object
-properties. The object properties can be set globally (with <link
-linkend="method-gobject--set-property"><methodname>set_property</methodname>()</link>).
-Also, with <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>,
-you can bind a property to a value in a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.
-For example, you can bind the "active" property on the cell renderer to a
-boolean value in the model, thus causing the check button to reflect the
-state of the model.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcellrenderertoggle--get-radio">
- <title>gtk.CellRendererToggle.get_radio</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_radio</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if we're rendering
-radio toggles rather than checkboxes</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_radio</methodname>() method returns
-<literal>True</literal> if radio toggles rather than checkboxes are being
-rendered.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellrenderertoggle--set-radio">
- <title>gtk.CellRendererToggle.set_radio</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_radio</methodname>
- <methodparam><parameter
- role="keyword">radio</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">radio</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> make the toggle look
-like a radio button</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_radio</methodname>() method sets the style
-of the toggle button. If <parameter>radio</parameter> is
-<literal>True</literal>, the cell renderer renders a radio toggle (i.e. a
-toggle in a group of mutually-exclusive toggles). If
-<literal>False</literal>, it renders a check toggle (a standalone boolean
-option). This can be set globally for the cell renderer, or changed just
-before rendering each cell in the model (for <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>, you
-set up a per-row setting using <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-to associate model columns with cell renderer properties).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellrenderertoggle--get-active">
- <title>gtk.CellRendererToggle.get_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_active</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the cell renderer is
-active.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_active</methodname>() method returns
-<literal>True</literal> if the cell renderer is active. See <link
-linkend="method-gtkcellrenderertoggle--set-active"><function>gtk.CellRendererToggle.set_active()</function></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellrenderertoggle--set-active">
- <title>gtk.CellRendererToggle.set_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_active</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>the value to set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_active</methodname>() method activates a
-cell renderer if <parameter>setting</parameter> is <literal>True</literal>
-and or deactivates a cell renderer if <parameter>setting</parameter> is
-<literal>False</literal>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcellrenderertoggle--toggled">
- <title>The "toggled" gtk.CellRendererToggle Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>cellrenderertoggle</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>cellrenderertoggle</parameter>&nbsp;:</term>
- <listitem><simpara>the cellrenderertoggle that received the
-"toggled" signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the cellrenderertoggle represented
- as a string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "toggled" signal is emitted when the toggle button in the
- cell changes state.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcellview.xml b/docs/reference/pygtk-gtkcellview.xml
deleted file mode 100644
index 4262b7ef..00000000
--- a/docs/reference/pygtk-gtkcellview.xml
+++ /dev/null
@@ -1,467 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcellview">
- <refnamediv>
- <refname>gtk.CellView</refname>
- <refpurpose>a widget displaying a single row of a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-(new in PyGTK 2.6).</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.CellView</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtkcelllayout">gtk.CellLayout</link></classname></ooclass>
-<constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcellview">gtk.CellView</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkcellview--set-model">set_model</link></methodname>
- <methodparam><parameter role="keyword">model</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkcellview--set-displayed-row">set_displayed_row</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkcellview--get-displayed-row">get_displayed_row</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkcellview--get-size-of-row">get_size_of_row</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- <methodparam><parameter role="keyword">requisition</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkcellview--set-background-color">set_background_color</link></methodname>
- <methodparam><parameter role="keyword">color</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkcellview--get-cell-renderers">get_cell_renderers</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--cell-view-new-with-text">gtk.cell_view_new_with_text</link></methodname>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--cell-view-new-with-markup">gtk.cell_view_new_with_markup</link></methodname>
- <methodparam><parameter role="keyword">markup</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--cell-view-new-with-pixbuf">gtk.cell_view_new_with_pixbuf</link></methodname>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcellview">gtk.CellView</link> (implements <link linkend="class-gtkcelllayout">gtk.CellLayout</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcellview">
- <title>gtk.CellView Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"background"</entry>
- <entry>Write</entry>
- <entry>The background color as a string. Default value:
-<literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"background-gdk"</entry>
- <entry>Read-Write</entry>
- <entry>The background color as a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>.</entry>
- </row>
-
- <row valign="top">
- <entry>"background-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, use the "background-gdk"
-property to set the background color.</entry>
- </row>
-
- <row valign="top">
- <entry>"model"</entry>
- <entry>Read-Write</entry>
- <entry>The model for cell view. Available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkcellview">
- <title>gtk.CellView Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcellview">
- <title>gtk.CellView Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <link
-linkend="class-gtkcellview"><classname>gtk.CellView</classname></link> is a
-widget that displays one row of a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>. <link
-linkend="class-gtkcellview"><classname>gtk.CellView</classname></link>
-implements the <link
-linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
-interface that provides for the addition and management of <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-objects.</para>
- </refsect1>
-
- <refsect1 id="constructor-gtkcellview">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.CellView</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkcellview"><classname>gtk.CellView</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkcellview"><classname>gtk.CellView</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcellview--set-model">
- <title>gtk.CellView.set_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_model</methodname>
- <methodparam><parameter
- role="keyword">model</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">model</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_model</methodname>() method sets the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-used by the cell view to that specified by <parameter>model</parameter>. If
-<parameter>model</parameter> is <literal>None</literal> the cell view's
-model will be unset.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellview--set-displayed-row">
- <title>gtk.CellView.set_displayed_row</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_displayed_row</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a tree path or <literal>None</literal> to unset
-the row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_displayed_row</methodname>() method sets the
-row of the model that is currently displayed to the path specified by
-<parameter>path</parameter>. If <parameter>path</parameter> is
-<literal>None</literal> the display row will be unset, and the contents of
-the cell view "stick" at their last value. This is not normally a desired
-result, but may be a needed intermediate state if say, the model for the
-cell view becomes temporarily empty.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellview--get-displayed-row">
- <title>gtk.CellView.get_displayed_row</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_displayed_row</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the path of the currently displayed row in the
-cell view's model</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_displayed_row</methodname>() method returns
-the path of the currently displayed row as set by the <link
-linkend="method-gtkcellview--set-displayed-row"><methodname>set-displayed_row</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellview--get-size-of-row">
- <title>gtk.CellView.get_size_of_row</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size_of_row</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of a row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>
-containing the required size data</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_size_of_row</methodname>() method returns a
-<link
-linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>
-containing the size required for displaying the row with the tree path
-specified by <parameter>path</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellview--set-background-color">
- <title>gtk.CellView.set_background_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_background_color</methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_background_color</methodname>() method sets
-the background color of the cell view to the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-specified by <parameter>color</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcellview--get-cell-renderers">
- <title>gtk.CellView.get_cell_renderers</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_cell_renderers</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-objects of the cell view.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_cell_renderers</methodname>() method returns
-a list containing the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-objects used by the cell view.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--cell-view-new-with-text">
- <title>gtk.cell_view_new_with_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.cell_view_new_with_text</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>a string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkcellview"><classname>gtk.CellView</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.cell_view_new_with_text</function>() function
-creates a new <link
-linkend="class-gtkcellview"><classname>gtk.CellView</classname></link> with
-a <link
-linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
-displaying the string specified by <parameter>text</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--cell-view-new-with-markup">
- <title>gtk.cell_view_new_with_markup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.cell_view_new_with_markup</methodname>
- <methodparam><parameter
- role="keyword">markup</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">markup</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing Pango markup to be
-displayed.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link linkend="class-gtkcellview"><classname>gtk.CellView</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.cell_view_new_with_markup</function>()
-function creates a new <link
-linkend="class-gtkcellview"><classname>gtk.CellView</classname></link> with
-a <link
-linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
-displaying the Pango markup specified by
-<parameter>markup</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--cell-view-new-with-pixbuf">
- <title>gtk.cell_view_new_with_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.cell_view_new_with_pixbuf</methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link linkend="class-gtkcellview"><classname>gtk.CellView</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.cell_view_new_with_pixbuf</function>()
-function creates a new <link
-linkend="class-gtkcellview"><classname>gtk.CellView</classname></link> with
-a <link
-linkend="class-gtkcellrendererpixbuf"><classname>gtk.CellRendererPixbuf</classname></link>
-displaying the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-specified by <parameter>pixbuf</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcheckbutton.xml b/docs/reference/pygtk-gtkcheckbutton.xml
deleted file mode 100644
index b1ea8042..00000000
--- a/docs/reference/pygtk-gtkcheckbutton.xml
+++ /dev/null
@@ -1,165 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcheckbutton">
- <refnamediv>
- <refname>gtk.CheckButton</refname>
- <refpurpose>a toggle button widget styled as a checkbox and label
-</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.CheckButton</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktogglebutton">gtk.ToggleButton</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcheckbutton">gtk.CheckButton</link></methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis> </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
- <synopsis>
-+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkbutton">gtk.Button</link>
- +-- <link linkend="class-gtktogglebutton">gtk.ToggleButton</link>
- +-- <link linkend="class-gtkcheckbutton">gtk.CheckButton</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcheckbutton">
- <title>gtk.CheckButton Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para>
- <para><link linkend="properties-gtktogglebutton">gtk.ToggleButton Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkcheckbutton">
- <title>gtk.CheckButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"indicator-size"</entry>
- <entry>Read/Write</entry>
- <entry>The size of the check or radio indicator</entry>
- </row>
-
- <row valign="top">
- <entry>"indicator-spacing"</entry>
- <entry>Read/Write</entry>
- <entry>The spacing around the check or radio indicator</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcheckbutton">
- <title>gtk.CheckButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktogglebutton">gtk.ToggleButton Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkcheckbutton"><classname>gtk.CheckButton</classname></link>
-places a discrete <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-next to a widget, (usually a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link>). See the
-section on <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-widgets for more information about toggle and check buttons. The signal
-('toggled') is also inherited from <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcheckbutton">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.CheckButton</methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis>
-</programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string to be used as the label text or
-None</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">use_underline</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, an underscore in the
- label text indicates the next character should be underlined and
- used for the mnemonic accelerator key if it is the first character
- so marked. Available in PyGTK 2.4 and above.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new checkbutton object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new checkbutton with a text label specified by
-<parameter>label</parameter>. If <parameter>label</parameter> is
-<literal>None</literal> or not specified then no label is created. If
-<parameter>label</parameter> contains underscore characters then the
-character following the underscore will be underlined and the character
-following the first underscore will be used as the mnemonic keyboard
-accelerator.</para>
-
- <para>In PyGTK 2.4 and above the <parameter>use_underline</parameter>
-parameter is available and defaults to <literal>True</literal>. If
-<parameter>use_underline</parameter> is set to <literal>False</literal> the
-label text will not be parsed for mnemonic characters.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcheckmenuitem.xml b/docs/reference/pygtk-gtkcheckmenuitem.xml
deleted file mode 100644
index 8912a5ed..00000000
--- a/docs/reference/pygtk-gtkcheckmenuitem.xml
+++ /dev/null
@@ -1,471 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcheckmenuitem">
- <refnamediv>
- <refname>gtk.CheckMenuItem</refname>
- <refpurpose>a menu item with a check box.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.CheckMenuItem</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkmenuitem">gtk.MenuItem</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcheckmenuitem">gtk.CheckMenuItem</link></methodname>
- <methodparam><parameter
- role="keyword">label</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcheckmenuitem--set-active">set_active</link></methodname>
- <methodparam><parameter
- role="keyword">is_active</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcheckmenuitem--get-active">get_active</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcheckmenuitem--toggled">toggled</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcheckmenuitem--set-inconsistent">set_inconsistent</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcheckmenuitem--get-inconsistent">get_inconsistent</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcheckmenuitem--set-draw-as-radio">set_draw_as_radio</link></methodname>
- <methodparam><parameter
- role="keyword">draw_as_radio</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcheckmenuitem--get-draw-as-radio">get_draw_as_radio</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkitem">gtk.Item</link>
- +-- <link linkend="class-gtkmenuitem">gtk.MenuItem</link>
- +-- <link linkend="class-gtkcheckmenuitem">gtk.CheckMenuItem</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcheckmenuitem">
- <title>gtk.CheckMenuItem Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"active"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, the menu item is checked.</entry>
- </row>
-
- <row valign="top">
- <entry>"inconsistent"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, display an "inconsistent"
-state.</entry>
- </row>
-
- <row valign="top">
- <entry>"draw-as-radio"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, display like a radio menu item.
-GTK+ 2.4 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkcheckmenuitem">
- <title>gtk.CheckMenuItem Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"indicator-size"</entry>
- <entry>Read</entry>
- <entry>The size of the check or radio indicator.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"active"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal>, the menu item is
-checked.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcheckmenuitem">
- <title>gtk.CheckMenuItem Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcheckmenuitem--toggled">toggled</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>checkmenuitem</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkcheckmenuitem"><classname>gtk.CheckMenuItem</classname></link>
-is a menu item that maintains the state of a boolean value in addition to a
-<link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>'s
-usual role in activating application code. A check box indicating the state
-of the boolean value is displayed at the left side of the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>.
-Activating the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-toggles the value.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcheckmenuitem">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.CheckMenuItem</methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string to be used as the label text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">use_underline</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, an underscore in the
-label text indicates the next character should be underlined and used for the
-mnemonic accelerator key if it is the first character so
-marked. Available in PyGTK 2.4 and above.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new checkmenuitem</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new checkmenuitem with a text label specified by
-<parameter>label</parameter>. If <parameter>label</parameter> is
-<literal>None</literal> or not specified then no label is created. If
-<parameter>label</parameter> contains underscore characters then the
-character following the underscore will be underlined and the character
-following the first underscore will be used as the mnemonic keyboard
-accelerator.</para>
-
- <para>In PyGTK 2.4 and above the <parameter>use_underline</parameter>
-parameter is available and defaults to <literal>True</literal>. If
-<parameter>use_underline</parameter> is set to <literal>False</literal> the
-label text will not be parsed for mnemonic characters.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcheckmenuitem--set-active">
- <title>gtk.CheckMenuItem.set_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_active</methodname>
- <methodparam><parameter
- role="keyword">is_active</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">is_active</parameter>&nbsp;:</term>
- <listitem><simpara>If True set the check box
-active</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_active</methodname>() method sets the active
-state of the menu item's check box according to the value of
-<parameter>is_active</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcheckmenuitem--get-active">
- <title>gtk.CheckMenuItem.get_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_active</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the menu item is
-checked (check box is active).</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_active</methodname>() method returns whether
-the check menu item is active. See <link
-linkend="method-gtkcheckmenuitem--set-active"><function>gtk.CheckMenuItem.set_active()</function></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcheckmenuitem--toggled">
- <title>gtk.CheckMenuItem.toggled</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>toggled</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The toggle() method emits the "toggled" signal on the
-checkmenuitem</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcheckmenuitem--set-inconsistent">
- <title>gtk.CheckMenuItem.set_inconsistent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_inconsistent</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> display an
-"inconsistent" third state check</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_inconsistent</methodname>() method sets the
-check box to display an "inconsistent" state if the value of
-<parameter>setting</parameter> is <literal>True</literal>. The
-"inconsistent" state display is removed if <parameter>setting</parameter> is
-<literal>False</literal>.</para>
-
- <para>An application may want to display an "inconsistent" state if
-the user has selected a range of elements (such as some text or spreadsheet
-cells) that are affected by a boolean setting, and the current values for
-those elements cannot be represented by a single checkmenuitem state. The
-<methodname>set_inconsistent</methodname>() method only affects visual
-appearance, it doesn't affect the semantics of the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcheckmenuitem--get-inconsistent">
- <title>gtk.CheckMenuItem.get_inconsistent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_inconsistent</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the checkmenuitem
-displays the "inconsistent" state</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_inconsistent</methodname>() method retrieves
-the value set by the <link
-linkend="method-gtkcheckmenuitem--set-inconsistent"><methodname>set_inconsistent()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcheckmenuitem--set-draw-as-radio">
- <title>gtk.CheckMenuItem.set_draw_as_radio</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_draw_as_radio</methodname>
- <methodparam><parameter
- role="keyword">draw_as_radio</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">draw_as_radio</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> display the check
- menu item like a radio menu item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_draw_as_radio</methodname>() method displays
-the check menu item like a radio menu item if the value of
-<parameter>draw_as_radio</parameter> is <literal>True</literal>. If
-<parameter>draw_as_radio</parameter> is <literal>False</literal> the check
-menu item is displayed as normal.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcheckmenuitem--get-draw-as-radio">
- <title>gtk.CheckMenuItem.get_draw_as_radio</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_draw_as_radio</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the checkmenuitem
- should be displayed like a radio menu item.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_draw_as_radio</methodname>() method
-retrieves the value set by the <link
-linkend="method-gtkcheckmenuitem--set-draw-as-radio"><methodname>set_draw_as_radio()</methodname></link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcheckmenuitem--toggled">
- <title>The "toggled" gtk.CheckMenuItem Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>checkmenuitem</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>checkmenuitem</parameter>&nbsp;:</term>
- <listitem><simpara>the checkmenuitem that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "toggled" signal is emitted when the checkmenuitem changes
-state.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkclipboard.xml b/docs/reference/pygtk-gtkclipboard.xml
deleted file mode 100644
index ee4d73c5..00000000
--- a/docs/reference/pygtk-gtkclipboard.xml
+++ /dev/null
@@ -1,1281 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkclipboard">
- <refnamediv>
- <refname>gtk.Clipboard</refname> <refpurpose>an object to store data to
- and retrieve data from (new in PyGTK 2.2)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Clipboard</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkclipboard">gtk.Clipboard</link></methodname>
- <methodparam><parameter role="keyword">display</parameter><initializer>gtk.gdk.display_get_default()</initializer></methodparam>
- <methodparam><parameter role="keyword">selection</parameter><initializer>"CLIPBOARD"</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--get-display">get_display</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--set-with-data">set_with_data</link></methodname>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- <methodparam><parameter role="keyword">get_func</parameter></methodparam>
- <methodparam><parameter role="keyword">clear_func</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--get-owner">get_owner</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--clear">clear</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--set-text">set_text</link></methodname>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- <methodparam><parameter role="keyword">len</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--request-contents">request_contents</link></methodname>
- <methodparam><parameter role="keyword">target</parameter></methodparam>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--request-text">request_text</link></methodname>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--request-targets">request_targets</link></methodname>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--wait-for-contents">wait_for_contents</link></methodname>
- <methodparam><parameter role="keyword">target</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--wait-for-text">wait_for_text</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--wait-is-text-available">wait_is_text_available</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--wait-for-targets">wait_for_targets</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--wait-is-target-available">wait_is_target_available</link></methodname>
- <methodparam><parameter role="keyword">target</parameter></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--set-can-store">set_can_store</link></methodname>
- <methodparam><parameter role="keyword">targets</parameter></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--store">store</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--request-image">request_image</link></methodname>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--wait-for-image">wait_for_image</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--set-image">set_image</link></methodname>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--wait-is-image-available">wait_is_image_available</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--request-rich-text">request_rich_text</link></methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--wait-for-rich-text">wait_for_rich_text</link></methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkclipboard--wait-is-rich-text-available">wait_is_rich_text_available</link></methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--clipboard-get">gtk.clipboard_get</link></methodname>
- <methodparam><parameter role="keyword">selection</parameter><initializer>"CLIPBOARD"</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkclipboard">gtk.Clipboard</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkclipboard">
- <title>gtk.Clipboard Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkclipboard--owner-change">owner-change</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>clipboard</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para> The <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
-object represents a clipboard of data shared between different processes or
-between different widgets in the same process. Each clipboard is identified
-by a name encoded as a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>. The
-<link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link> is
-basically a higher-level interface to the lower-level <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-and selection interface. The built-in atoms are:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>"PRIMARY"</simpara>
- </listitem>
- <listitem>
- <simpara>"SECONDARY"</simpara>
- </listitem>
- <listitem>
- <simpara>"CLIPBOARD"</simpara>
- </listitem>
- <listitem>
- <simpara>"BITMAP"</simpara>
- </listitem>
- <listitem>
- <simpara>"COLORMAP"</simpara>
- </listitem>
- <listitem>
- <simpara>"DRAWABLE"</simpara>
- </listitem>
- <listitem>
- <simpara>"PIXMAP"</simpara>
- </listitem>
- <listitem>
- <simpara>"STRING"</simpara>
- </listitem>
- <listitem>
- <simpara>"WINDOW"</simpara>
- </listitem>
- </itemizedlist>
-
- <para>Creating a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> from
-strings can be done with the <link
-linkend="constructor-gdkatom-intern">gtk.gdk.atom_intern</link>()
-constructor function though <literal>PyGTK</literal> will usually do the
-conversion under the covers as needed. The name of a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> can be
-retrieved using the Python <function>str</function>() function:</para>
-
- <programlisting>
- name = str(atom)
-</programlisting>
-
- <para>The default clipboard corresponds to the "CLIPBOARD" atom; another
-commonly used clipboard is the "PRIMARY" clipboard, which, in X,
-traditionally contains the currently selected text.</para>
-
-<para>To simultaneously support different formats on the clipboard, the
-clipboard mechanism allows you to provide callbacks instead of the actual
-data. When you set the contents of the clipboard, you can either supply the
-data directly (via a method like <link
-linkend="method-gtkclipboard--set-text"><methodname>set_text</methodname>()</link>),
-or you can supply a callback to be called when the data is needed (via the
-<link
-linkend="method-gtkclipboard--set-with-data"><methodname>set_with_data</methodname>()</link>
-method.) Providing a callback also avoids making unnecessary copies of the
-data.</para>
-
-<para>Along with the methods to get the clipboard contents as an arbitrary
-data chunk, there is a method to retrieve it as text, the <link
-linkend="method-gtkclipboard--wait-for-text"><methodname>wait_for_text</methodname>()</link>
-method. This method takes care of determining which formats are advertised
-by the clipboard provider, asking for the clipboard in the best available
-format and converting the results into the UTF-8 encoding. (The standard
-form for representing strings in <literal>GTK</literal>+.) </para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkclipboard">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Clipboard</methodname>
- <methodparam><parameter role="keyword">display</parameter><initializer>gtk.gdk.display_get_default()</initializer></methodparam>
- <methodparam><parameter role="keyword">selection</parameter><initializer>"CLIPBOARD"</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-for which the clipboard is to be retrieved or created.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>a string that identifies the clipboard
-to use.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the appropriate clipboard object or if no
- clipboard already exists, a new one will be created. Once a
- clipboard object has been created, it is persistent for all time and
- cannot be freed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>Returns the clipboard object for the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-specified by <parameter>display</parameter> and the selection specified by
-the string in <parameter>selection</parameter>. Cut/copy/paste menu items
-and keyboard shortcuts should use the default clipboard, returned by passing
-<literal>"CLIPBOARD"</literal> for <parameter>selection</parameter>. The
-currently-selected object or text should be provided on the clipboard
-identified by <literal>"PRIMARY"</literal>. Cut/copy/paste menu items
-conceptually copy the contents of the <literal>"PRIMARY"</literal> clipboard
-to the default clipboard, i.e. they copy the selection to what the user sees
-as the clipboard.</para>
-
- <para>See <ulink
-url="http://www.freedesktop.org/standards/clipboards-spec/clipboards.txt">
-http://www.freedesktop.org/standards/clipboards-spec/clipboards.txt</ulink>
-for a detailed discussion of the "CLIPBOARD" vs. "PRIMARY" selections under
-the X window system. On Win32 the <literal>"PRIMARY"</literal> clipboard is
-essentially ignored.</para>
-
- <para>It's possible to have arbitrarily named clipboards. If you do
-invent new clipboards, you should prefix the selection name with an
-underscore (because the ICCCM requires that nonstandard atoms are
-underscore-prefixed), and namespace it as well. For example, if your
-application called "Foo" has a special-purpose clipboard, you might call it
-"_FOO_SPECIAL_CLIPBOARD".</para>
-
- <para>In PyGTK 2.4 and above, the <parameter>display</parameter>
-argument is optional and defaults to the default display returned from the
-<link
-linkend="function-gdk--display-get-default"><function>gtk.gdk.display_get_default</function>()</link>
-function.</para>
-
- <para>In PyGTK 2.4 and above, the <parameter>selection</parameter>
-argument is optional and defaults to "CLIPBOARD".</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkclipboard--get-display">
- <title>gtk.Clipboard.get_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_display</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-associated with the clipboard</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_display</methodname>() method returns the
-<link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-associated with the clipboard.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--set-with-data">
- <title>gtk.Clipboard.set_with_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_with_data</methodname>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- <methodparam><parameter role="keyword">get_func</parameter></methodparam>
- <methodparam><parameter role="keyword">clear_func</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a list of 3-tuples containing information about
-the available forms for the clipboard data</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">get_func</parameter>&nbsp;:</term>
- <listitem><simpara>a function to call to get the actual clipboard
-data</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">clear_func</parameter>&nbsp;:</term>
- <listitem><simpara>when the clipboard contents are set again,
-this function will be called, and <parameter>get_func</parameter> will not
-be subsequently called.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>the user data to pass to
-<parameter>get_func</parameter> and
-<parameter>clear_func</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if setting the
-clipboard data succeeded. If setting the clipboard data failed the
-provided callback functions will be ignored.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_with_data</methodname>() method virtually
-sets the contents of the specified clipboard by providing a list of
-supported formats (specified by <parameter>targets</parameter>) for the
-clipboard data and a function (specified by <parameter>get_func</parameter>)
-to call to get the actual data when it is
-requested. <parameter>clear_func</parameter> is a function that is called
-when the contents of the clipboard are being changed to provide cleanup
-operations on
-<parameter>user_data</parameter>. <parameter>user_data</parameter> is passed
-to <parameter>get_func</parameter> and <parameter>clear_func</parameter>
-when they are invoked. The 3-tuples listed in <parameter>targets</parameter>
-contain the following items:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>a string representing a target supported by the
-clipboard</simpara>
- </listitem>
- <listitem>
- <simpara>a flags value used for drag and drop - a combination of:
-<literal>gtk.TARGET_SAME_APP</literal> and
-<literal>gtk.TARGET_SAME_WIDGET</literal></simpara>
- </listitem>
- <listitem>
- <simpara>an application assigned integer that is passed as a signal
-parameter to help identify the target type</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The signature of <parameter>get_func</parameter> is:</para>
-
- <programlisting>
- def get_func(clipboard, selectiondata, info, data):
-</programlisting>
-
- <para>where <parameter>clipboard</parameter> is the <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>,
-<parameter>selectiondata</parameter> is a <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-object to set with the data, <parameter>info</parameter> is the application
-assigned integer associated with a target, and <parameter>data</parameter>
-is the <parameter>user_data</parameter> argument.</para>
-
- <para>The signature of <parameter>clear_func</parameter> is:</para>
-
- <programlisting>
- def clear_func(clipboard, data):
-</programlisting>
-
- <para>where <parameter>clipboard</parameter> is the <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link> and
-<parameter>data</parameter> is the <parameter>user_data</parameter>
-argument.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--get-owner">
- <title>gtk.Clipboard.get_owner</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_owner</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the owner of the clipboard, if any; otherwise
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_owner</methodname>() method returns the
-owner set by the <methodname>set_with_owner</methodname>() method if neither
-the <link
-linkend="method-gtkclipboard--set-with-data"><methodname>set_with_data()</methodname></link>
-method nor the <link
-linkend="method-gtkclipboard--clear"><methodname>clear()</methodname></link>
-method have been subsequently called. This method returns
-<literal>None</literal> otherwise.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--clear">
- <title>gtk.Clipboard.clear</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>clear</methodname>() method clears the contents
-of the clipboard. Generally this should only be called between the time you
-call the <!--<link
-linkend="method-gtkclipboard- -set-with-owner"><methodname>set_with_owner()</methodname></link>
-or --><link
-linkend="method-gtkclipboard--set-with-data"><methodname>set_with_data()</methodname></link>,
-and when the <parameter>clear_func</parameter> you supplied is
-called. Otherwise, the clipboard may be owned by someone else.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--set-text">
- <title>gtk.Clipboard.set_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text</methodname>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- <methodparam><parameter role="keyword">len</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>a string.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">len</parameter>&nbsp;:</term>
- <listitem><simpara>the length of <parameter>text</parameter>, in
-bytes, or -1, to calculate the length.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_text</methodname>() method sets the contents
-of the clipboard to the string specified by <parameter>text</parameter>. If
-<parameter>len</parameter> is given it determines the length of
-<parameter>text</parameter> to be copied. If <parameter>len</parameter> is
-not specified it defaults to -1 and the method calculates the text
-length.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--request-contents">
- <title>gtk.Clipboard.request_contents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>request_contents</methodname>
- <methodparam><parameter role="keyword">target</parameter></methodparam>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>
-or string representing the form that the clipboard owner should convert
-the selection to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a function to call when the results are received
-(or the retrieval fails).</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to <parameter>callback</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>request_contents</methodname>() method requests
-the contents of clipboard in the form specified by
-<parameter>target</parameter>. When the results of the request are later
-received the function specified by <parameter>callback</parameter> will be
-invoked and passed the data specified by
-<parameter>user_data</parameter>. The signature of
-<parameter>callback</parameter> is:</para>
-
- <programlisting>
- def callback(clipboard, selection_data, data):
-</programlisting>
-
- <para>where <parameter>clipboard</parameter> is the <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
-that invoked callback and <parameter>selection_data</parameter> is the <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-containing the target data and <parameter>data</parameter> is
-<parameter>user_data</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--request-text">
- <title>gtk.Clipboard.request_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>request_text</methodname>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a function to call when the text is received,
-or the retrieval fails. (It will always be called
-one way or the other.)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to
-<parameter>callback</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>request_text</methodname>() method requests the
-contents of the clipboard as text. When the text is later received, it will
-be converted to UTF-8 if necessary, and <parameter>callback</parameter> will
-be called with the data specified by <parameter>user_data</parameter>. The
-signature of <parameter>callback</parameter> is:</para>
-
- <programlisting>
- def callback(clipboard, text, data):
-</programlisting>
-
- <para>where <parameter>clipboard</parameter> is the <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
-that <parameter>text</parameter> is retrieved from and
-<parameter>data</parameter> is <parameter>user_data</parameter>.
-<parameter>text</parameter> will contain the resulting text if the request
-succeeded, or the empty string if it failed. This could happen for various
-reasons, in particular if the clipboard was empty or if the contents of the
-clipboard could not be converted into text form.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--request-targets">
- <title>gtk.Clipboard.request_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>request_targets</methodname>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a function to call when the targets are received,
-or the retrieval fails. (It will always be called
-one way or the other.)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to
-<parameter>callback</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>request_targets</methodname>() method requests
-the contents of the clipboard as list of supported targets. When the list
-is later received, <parameter>callback</parameter> will be called with the
-data specified by <parameter>user_data</parameter>. The signature of
-<parameter>callback</parameter> is:</para>
-
- <programlisting>
- def callback(clipboard, targets, data):
-</programlisting>
-
- <para>where <parameter>clipboard</parameter> is the <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
-that <parameter>targets</parameter> is retrieved
-from. <parameter>targets</parameter> is a tuple containing the <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> objects
-corresponding to the targets of clipboard. <parameter>targets</parameter>
-will contain the resulting targets if the request succeeded, or an empty
-tuple if it failed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--wait-for-contents">
- <title>gtk.Clipboard.wait_for_contents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>wait_for_contents</methodname>
- <methodparam><parameter role="keyword">target</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>an atom or string representing the form into
-which the clipboard owner should convert the selection.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a newly-allocated <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-object or <literal>None</literal> if retrieving the given target
-failed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>wait_for_contents</methodname>() method requests
-the contents of the clipboard using the target specified by
-<parameter>target</parameter>. This method waits for the data to be received
-using the main loop, so events, timeouts, etc, may be dispatched during the
-wait.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--wait-for-text">
- <title>gtk.Clipboard.wait_for_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>wait_for_text</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string, or <literal>None</literal> if
-retrieving the selection data failed. (This could happen for various reasons,
-in particular if the clipboard was empty or if the contents of the
-clipboard could not be converted into text form.)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>wait_for_text</methodname>() method requests the
-contents of the clipboard as text and converts the result to UTF-8 if
-necessary. This method waits for the data to be received using the main
-loop, so events, timeouts, etc, may be dispatched during the wait.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--wait-is-text-available">
- <title>gtk.Clipboard.wait_is_text_available</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>wait_is_text_available</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> is there is text
-available.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>wait_is_text_available</methodname>() method
-tests to see if there is text available to be copied from the clipboard.
-This is done by requesting the "TARGETS" atom and checking if it contains
-any of the names: "STRING", "TEXT", "COMPOUND_TEXT", "UTF8_STRING". This
-method waits for the data to be received using the main loop, so events,
-timeouts, etc, may be dispatched during the wait.</para>
-
- <para>This method is a little faster than calling the <link
-linkend="method-gtkclipboard--wait-for-text"><methodname>wait_for_text()</methodname></link>
-since it doesn't need to retrieve the actual text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--wait-for-targets">
- <title>gtk.Clipboard.wait_for_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>wait_for_targets</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>returns a tuple containing any targets that are
-present on the clipboard or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>wait_for_targets</methodname>() method returns a
-tuple containing the targets (as <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> objects)
-that are present on the clipboard, or <literal>None</literal> if there
-aren't any targets available. This function waits for the data to be
-received using the main loop, so events, timeouts, etc, may be dispatched
-during the wait.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--wait-is-target-available">
- <title>gtk.Clipboard.wait_is_target_available</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>wait_is_target_available</methodname>
- <methodparam><parameter role="keyword">target</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>an atom or string representing the target of
-interest.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the target is
-available.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>wait_is_target_available</methodname>() method
-tests to see if the target specified by <parameter>target</parameter> is
-available to be copied from the clipboard. This method can be used to
-determine if a <guimenuitem>Paste</guimenuitem> menu item should be
-insensitive or not.</para>
-
- <para>If you want to see if there's text available on the clipboard,
-use the <link
-linkend="method-gtkclipboard--wait-is-text-available"><methodname>wait_is_text_available</methodname>()</link>
-method instead.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--set-can-store">
- <title>gtk.Clipboard.set_can_store</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_can_store</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a list of 3-tuples containing information about
-the available forms that should be stored or <literal>None</literal> to
-indicate that all forms should be stored.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_can_store</methodname>() method sets a hint
-that the <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link> can
-store the list of targets specified by <parameter>targets</parameter> can be
-stored somewhere when the application exits or when the <link
-linkend="method-gtkclipboard--store"><methodname>store</methodname>()</link>
-method is called. This value is reset when the clipboard owner
-changes. Where the clipboard data is stored is platform dependent, see the
-<link
-linkend="method-gdkdisplay--store-clipboard"><methodname>gtk.gdk.Display.store_clipboard</methodname>()</link>
-method for more information. If <parameter>targets</parameter> is
-<literal>None</literal> all target forms currently available on the
-clipboard should be stored.</para>
-
- <para>The 3-tuples listed in <parameter>targets</parameter> contain
-the following items:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>a string representing a target supported by the
-clipboard</simpara>
- </listitem>
- <listitem>
- <simpara>a flags value used for drag and drop - a combination of:
-<literal>gtk.TARGET_SAME_APP</literal> and
-<literal>gtk.TARGET_SAME_WIDGET</literal></simpara>
- </listitem>
- <listitem>
- <simpara>an application assigned integer that is passed as a signal
-parameter to help identify the target type</simpara>
- </listitem>
- </itemizedlist>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--store">
- <title>gtk.Clipboard.store</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>store</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>store</methodname>() method stores the current
-clipboard data (as specified by the <link
-linkend="method-gtkclipboard--set-can-store"><methodname>set_can_store</methodname>()</link>
-method) somewhere so that it will stay around after the application has
-quit.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--request-image">
- <title>gtk.Clipboard.request_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>request_image</methodname>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a function to call when the image is received,
-or the retrieval fails. (It will always be called
-one way or the other.)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to
-<parameter>callback</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>request_image</methodname>() method requests the
-contents of the clipboard as a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-image. When the image is later received, it will be converted to a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> and
-<parameter>callback</parameter> will be called with the data specified by
-<parameter>user_data</parameter>. The signature of
-<parameter>callback</parameter> is:</para>
-
- <programlisting>
- def callback(clipboard, pixbuf, data):
-</programlisting>
-
- <para>where <parameter>clipboard</parameter> is the <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
-that <parameter>pixbuf</parameter> is retrieved from and
-<parameter>data</parameter> is <parameter>user_data</parameter>.
-<parameter>pixbuf</parameter> will contain the resulting image data if the
-request succeeded, or <literal>None</literal> if it failed. This could
-happen for various reasons, in particular if the clipboard was empty or if
-the contents of the clipboard could not be converted into an image.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--wait-for-image">
- <title>gtk.Clipboard.wait_for_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>wait_for_image</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>,
-or <literal>None</literal> if retrieving the selection data failed.
-(This could happen for various reasons, in particular if the clipboard was
-empty or if the contents of the clipboard could not be converted into an
-image.)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>wait_for_image</methodname>() method requests
-the contents of the clipboard as an image and converts the result to a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>. This
-method waits for the data to be received using the main loop, so events,
-timeouts, etc, may be dispatched during the wait.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--set-image">
- <title>gtk.Clipboard.set_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_image</methodname>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_image</methodname>() method sets the
-contents of the clipboard to the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-specified by <parameter>pixbuf</parameter>. GTK+ will take responsibility
-for responding for requests for the image, and for converting the image into
-the requested format.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--wait-is-image-available">
- <title>gtk.Clipboard.wait_is_image_available</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>wait_is_image_available</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> is there is an image
-available.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>wait_is_image_available</methodname>() method
-tests to see if there is an image available to be copied from the clipboard.
-This is done by requesting the "TARGETS" atom and checking if it contains
-any of the supported image targets. This method waits for the data to be
-received using the main loop, so events, timeouts, etc, may be dispatched
-during the wait.</para>
-
- <para>This method is a little faster than calling the <link
-linkend="method-gtkclipboard--wait-for-image"><methodname>wait_for_image()</methodname></link>
-since it doesn't need to retrieve the actual image data.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--request-rich-text">
- <title>gtk.Clipboard.request_rich_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>request_rich_text</methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">buffer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
- to retrieve the deserialize formats from.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a function to call when the text is received,
- or the retrieval fails. (It will always be called one way or the
- other.)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to
- <parameter>callback</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>request_rich_text</methodname>() method requests
- the contents of the clipboard as rich text. When the rich text is
- later received, the function specified by
- <parameter>callback</parameter> will be called with the argument
- specified by <parameter>user_data</parameter>.</para>
-
- <para>The signature of the callback is:</para>
-
- <programlisting>
- def callback(clipboard, format, text, length, data):
- </programlisting>
-
- <para>where <parameter>format</parameter> is the atom indicating the
- text format, <parameter>text</parameter> contains the resulting rich
- text if the request succeeded, or <literal>None</literal> if it
- failed, <parameter>length</parameter> contains the length of
- <parameter>text</parameter> and <parameter>data</parameter> is
- <parameter>user_data</parameter>. This function can fail for various
- reasons, in particular if the clipboard was empty or if the contents
- of the clipboard could not be converted into rich text form.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--wait-for-rich-text">
- <title>gtk.Clipboard.wait_for_rich_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>wait_for_rich_text</methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">buffer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
- to retrieve the deserialize formats from.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the rich text as a string
- and the format string , or <literal>None</literal> if retrieving
- the selection data failed. (This could happen for various reasons,
- in particular if the clipboard was empty or if the contents of the
- clipboard could not be converted into text
- form.)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>wait_for_rich_text</methodname>() method
- requests the contents of the clipboard as rich text. This method
- waits for the data to be received using the main loop, so events,
- timeouts, etc, may be dispatched during the wait.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkclipboard--wait-is-rich-text-available">
- <title>gtk.Clipboard.wait_is_rich_text_available</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>wait_is_rich_text_available</methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">buffer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
- to retrieve the deserialize formats from.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if is there is rich
- text available, <literal>False</literal>
- otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>wait_is_rich_text_available</methodname>()
- method tests to see if there is rich text available to be pasted. This
- is done by requesting the <literal>TARGETS</literal> atom and checking
- if it contains any of the supported rich text targets. This method
- waits for the data to be received using the main loop, so events,
- timeouts, etc, may be dispatched during the wait.</para>
-
- <para>This method is a little faster than calling <link
- linkend="method-gtkclipboard--wait-for-rich-text"><methodname>wait_for_rich_text()</methodname></link>
- since it doesn't need to retrieve the actual text.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--clipboard-get">
- <title>gtk.clipboard_get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.clipboard_get</methodname>
- <methodparam><parameter
- role="keyword">selection</parameter><initializer>"CLIPBOARD"</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>a string specifying a <link
- linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>. If
- not specified it defaults to "CLIPBOARD".</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the appropriate clipboard object or if no
- clipboard already exists, a new one will be created. Once a
- clipboard object has been created, it is persistent for all time and
- cannot be freed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.clipboard_get</function>() function returns
-the <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
-specified by selection for the default <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>. See
-the <link linkend="constructor-gtkclipboard">gtk.Clipboard</link>
-constructor for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkclipboard--owner-change">
- <title>The "owner-change" gtk.Clipboard Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>clipboard</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>clipboard</parameter>&nbsp;:</term>
- <listitem><simpara>the object that received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event marking the ownership
- change.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.8 and above.</para>
- </note>
-
- <para>The "owner-changed" signal is emitted when the owner of the
- clipboard is changed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcolorbutton.xml b/docs/reference/pygtk-gtkcolorbutton.xml
deleted file mode 100644
index 51ff7d49..00000000
--- a/docs/reference/pygtk-gtkcolorbutton.xml
+++ /dev/null
@@ -1,459 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcolorbutton">
- <refnamediv>
- <refname>gtk.ColorButton</refname> <refpurpose>a button to launch a
- color selection dialog (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ColorButton</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkbutton">gtk.Button</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkcolorbutton">gtk.ColorButton</link></methodname>
- <methodparam><parameter role="keyword">color</parameter><initializer>gtk.gdk.Color(0,0,0)</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcolorbutton--set-color">set_color</link></methodname>
- <methodparam><parameter role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcolorbutton--get-color">get_color</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcolorbutton--set-alpha">set_alpha</link></methodname>
- <methodparam><parameter role="keyword">alpha</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcolorbutton--get-alpha">get_alpha</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcolorbutton--set-use-alpha">set_use_alpha</link></methodname>
- <methodparam><parameter role="keyword">use_alpha</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcolorbutton--get-use-alpha">get_use_alpha</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcolorbutton--set-title">set_title</link></methodname>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcolorbutton--get-title">get_title</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkbutton">gtk.Button</link>
- +-- <link linkend="class-gtkcolorbutton">gtk.ColorButton</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcolorbutton">
- <title>gtk.ColorButton Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"alpha"</entry>
- <entry>Read-Write</entry>
- <entry>The selected opacity value (0 fully transparent, 65535
-fully opaque). Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"color"</entry>
- <entry>Read-Write</entry>
- <entry>The selected color. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"title"</entry>
- <entry>Read-Write</entry>
- <entry>The title of the color selection dialog. Available in
- GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"use-alpha"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the color swatch on the
- button is rendered against a checkerboard background to show
- its opacity and the opacity slider is displayed in the color
- selection dialog. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkcolorbutton">
- <title>gtk.ColorButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcolorbutton">
- <title>gtk.ColorButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkcolorbutton--color-set">color-set</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>colorbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
- linkend="class-gtkcolorbutton"><classname>gtk.ColorButton</classname></link>
- is a button that displays the currently selected color and, when
- clicked, opens a <link
- linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link>
- to change the color. It's a suitable widget for selecting a color in a
- preference dialog. The <link
- linkend="class-gtkcolorbutton"><classname>gtk.ColorButton</classname></link>
- is available in PyGTK 2.4 and above.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcolorbutton">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ColorButton</methodname>
- <methodparam><parameter
- role="keyword">color</parameter><initializer>gtk.gdk.Color(0,0,0)</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>an optional <link linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to set the current color with</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new color button.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new color button with the current color set to the color
-specified by the optional <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-<parameter>color</parameter>. A color button is a small button containing a
-swatch representing the current selected color. When the button is clicked,
-a <link
-linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link>
-will open, allowing the user to select a color. The swatch will be updated
-to reflect the new color the user selects.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcolorbutton--set-color">
- <title>gtk.ColorButton.set_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_color</methodname>
- <methodparam><parameter role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>A <link linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to set the current color with.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_color</methodname>() method sets the current
- color (and the "color" property) to the color specified by the <link
- linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
- <parameter>color</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorbutton--get-color">
- <title>gtk.ColorButton.get_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_color</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
- specifying the current color.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_color</methodname>() method returns the
- value of the "color" property which is a <link
- linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
- specifying the current color in the <link
- linkend="class-gtkcolorbutton"><classname>gtk.ColorButton</classname></link>
- widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorbutton--set-alpha">
- <title>gtk.ColorButton.set_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_alpha</methodname>
- <methodparam><parameter role="keyword">alpha</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">alpha</parameter>&nbsp;:</term>
- <listitem><simpara>The opacity in the range 0 to
- 65535.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_alpha</methodname>() method sets the current
- opacity (and the "alpha" property) to the value specified by
- <parameter>alpha</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorbutton--get-alpha">
- <title>gtk.ColorButton.get_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_alpha</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the opacity in the range 0 to
- 65535.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_alpha</methodname>() method returns the
- value of the "alpha" property that contains the opacity setting.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorbutton--set-use-alpha">
- <title>gtk.ColorButton.set_use_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_alpha</methodname>
- <methodparam><parameter role="keyword">use_alpha</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">use_alpha</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the color button
- should use the alpha channel.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_use_alpha</methodname>() method sets the
- "use-alpha" property to the value of
- <parameter>use_alpha</parameter>. If <parameter>use_alpha</parameter>
- is <literal>True</literal>, the color swatch on the button is rendered
- against a checkerboard background to show its opacity and the opacity
- slider is displayed in the color selection dialog.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorbutton--get-use-alpha">
- <title>gtk.ColorButton.get_use_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_alpha</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the color sample
- should use the alpha channel</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_use_alpha</methodname>() method returns the
- value of the "use-alpha" property. If <literal>True</literal> the
- color selection dialog should use the alpha channel.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorbutton--set-title">
- <title>gtk.ColorButton.set_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_title</methodname>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the new <link
- linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link>
- title.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_title</methodname>() method sets the title
- for the color selection dialog to the string contained in
- <parameter>title</parameter>. The "title" property is also set. </para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorbutton--get-title">
- <title>gtk.ColorButton.get_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_title</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the title of the <link
- linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_title</methodname>() method returns the
- value of the "title" property that contains the title of the color
- selection dialog.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcolorbutton--color-set">
- <title>The "color-set" gtk.ColorButton Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>colorbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>colorbutton</parameter>&nbsp;:</term>
- <listitem><simpara>the colorbutton that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "color-set" signal is emitted when the user selects a
- color. When handling this signal, use the <link
- linkend="method-gtkcolorbutton--get-color"><methodname>get_color</methodname>()</link>
- and the <link
- linkend="method-gtkcolorbutton--get-alpha"><methodname>get_alpha</methodname>()</link>
- methods to find out what color was just selected.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcolorselection.xml b/docs/reference/pygtk-gtkcolorselection.xml
deleted file mode 100644
index 2f0cd263..00000000
--- a/docs/reference/pygtk-gtkcolorselection.xml
+++ /dev/null
@@ -1,661 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcolorselection">
- <refnamediv>
- <refname>gtk.ColorSelection</refname>
- <refpurpose>a widget used to select a color.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ColorSelection</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkvbox">gtk.VBox</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcolorselection">gtk.ColorSelection</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--get-has-opacity-control">get_has_opacity_control</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--set-has-opacity-control">set_has_opacity_control</link></methodname>
- <methodparam><parameter
- role="keyword">has_opacity</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--get-has-palette">get_has_palette</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--set-has-palette">set_has_palette</link></methodname>
- <methodparam><parameter
- role="keyword">has_palette</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--set-current-color">set_current_color</link></methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--set-current-alpha">set_current_alpha</link></methodname>
- <methodparam><parameter
- role="keyword">alpha</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--get-current-color">get_current_color</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--get-current-alpha">get_current_alpha</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--set-previous-color">set_previous_color</link></methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--set-previous-alpha">set_previous_alpha</link></methodname>
- <methodparam><parameter
- role="keyword">alpha</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--get-previous-color">get_previous_color</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--get-previous-alpha">get_previous_alpha</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcolorselection--is-adjusting">is_adjusting</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--color-selection-palette-from-string">gtk.color_selection_palette_from_string</link></methodname>
- <methodparam><parameter role="keyword">str</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--color-selection-palette-to-string">gtk.color_selection_palette_to_string</link></methodname>
- <methodparam><parameter role="keyword">colors</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
- <synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +--<link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkvbox">gtk.VBox</link>
- +-- <link linkend="class-gtkcolorselection">gtk.ColorSelection</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcolorselection">
- <title>gtk.ColorSelection Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"current-alpha"</entry>
- <entry>Read/Write</entry>
- <entry>The current opacity value (0 fully transparent, 65535 fully
- opaque)</entry>
- </row>
-
- <row valign="top">
- <entry>"current-color"</entry>
- <entry>Read/Write</entry>
- <entry>The current color as a <link
- linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></entry>
- </row>
-
- <row valign="top">
- <entry>"has-opacity-control"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, the color selector should allow
- setting opacity</entry>
- </row>
-
- <row valign="top">
- <entry>"has-palette"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, a palette should be used</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkcolorselection">
- <title>gtk.ColorSelection Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkcolorselection">
- <title>gtk.ColorSelection Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcolorselection">
- <title>gtk.ColorSelection Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcolorselection--color-changed">color-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>colorselection</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link>
-is a widget that is used to select a color. It consists of a color wheel and
-entry boxes for color parameters such as hue, saturation, value, red, green,
-blue, and color name and optionally an opacity control and/or a color
-palette. It is found on the standard color selection dialog box <link
-linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link>.
-The color wheel can be manipulated to set a new color or new entries can be
-made in the entry boxes. The new color is displayed next to the previous
-color. An eyedropper button is available to allow the selection of a color
-from a pixel location on the display.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcolorselection">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ColorSelection</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcolorselection--get-has-opacity-control">
- <title>gtk.ColorSelection.get_has_opacity_control</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_has_opacity_control</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the
-<parameter>colorsel</parameter> has an opacity control;
-<literal>False</literal> if it doesn't.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_opacity</methodname>() method determines
-whether the colorselection is displaying an opacity control.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorselection--set-has-opacity-control">
- <title>gtk.ColorSelection.set_has_opacity_control</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_has_opacity_control</methodname>
- <methodparam><parameter
- role="keyword">has_opacity</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">has_opacity</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> the colorselection
-will display the opacity control.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_has_opacity_control</methodname>() method
-sets the "has-opacity-control" property to the value of
-<parameter>has_opacity</parameter>. If <parameter>has_opacity</parameter> is
-<literal>True</literal> the colorselection will display the opacity control
-slider and entry box; otherwise the opacity control is not displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorselection--get-has-palette">
- <title>gtk.ColorSelection.get_has_palette</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_has_palette</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the selector has a
-palette; <literal>False</literal> if it hasn't.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_has_palette</methodname>() method returns
-the value of the "has-palette" property that determines whether the color
-selector displays a color palette.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorselection--set-has-palette">
- <title>gtk.ColorSelection.set_has_palette</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_has_palette</methodname>
- <methodparam><parameter
- role="keyword">has_palette</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">has_palette</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> the color palette is
-displayed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_has_palette</methodname>() method sets the
-"has-palette" property to the value of <parameter>has_palette</parameter>.
-If <parameter>has_palette</parameter> is True the palette will be displayed;
-otherwise the palette will be hidden.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorselection--set-current-color">
- <title>gtk.ColorSelection.set_current_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_current_color</methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to set
-the current color with.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_current_color</methodname>() method sets the
-current color to the value of <parameter>color</parameter>. The first time
-this is called, it will also set the previous color to the value of
-<parameter>color</parameter> too.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorselection--set-current-alpha">
- <title>gtk.ColorSelection.set_current_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_current_alpha</methodname>
- <methodparam><parameter
- role="keyword">alpha</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">alpha</parameter>&nbsp;:</term>
- <listitem><simpara>an integer between 0 and
-65535.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_current_alpha</methodname>() method sets the
-"current-alpha" property (the opacity) to the value of alpha. The alpha
-(opacity) is displayed in the range of 0 to 255 in the colorselection. The
-first time this is called, it will also set the previous opacity to the
-value of <parameter>alpha</parameter> too.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorselection--get-current-color">
- <title>gtk.ColorSelection.get_current_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_current_color</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-representing the current color.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_current_color</methodname>() method
-retrieves the current color in the colorselection.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorselection--get-current-alpha">
- <title>gtk.ColorSelection.get_current_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_current_alpha</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current alpha value in the range 0 to
-65535.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_current_alpha</methodname>() method returns
-the value of the "current_alpha" property that controls the opacity
-value.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorselection--set-previous-color">
- <title>gtk.ColorSelection.set_previous_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_previous_color</methodname>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to set
-the previous color with.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_previous_color</methodname>() method sets
-the 'previous' color to the value of <parameter>color</parameter>.
-Applications usually do not call this method. The first time <link
-linkend="method-gtkcolorselection--set-current-color"><methodname>set_current_color</methodname>()</link>
-the 'previous' color will be set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorselection--set-previous-alpha">
- <title>gtk.ColorSelection.set_previous_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_previous_alpha</methodname>
- <methodparam><parameter
- role="keyword">alpha</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">alpha</parameter>&nbsp;:</term>
- <listitem><simpara>an integer between 0 and
-65535.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The set_previous_alpha() method sets the 'previous' alpha to the
-value of <parameter>alpha</parameter>. Applications usually do not call this
-method. The first time <link
-linkend="method-gtkcolorselection--set-current-alpha"><methodname>set_current_alpha</methodname>()</link>
-the 'previous' alpha will be set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorselection--get-previous-color">
- <title>gtk.ColorSelection.get_previous_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_previous_color</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> with
-the previous color value.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_previous_color</methodname>() method
-retrieves the previous color value.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtkcolorselection--get-previous-alpha">
- <title>gtk.ColorSelection.get_previous_alpha</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_previous_alpha</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer between 0 and
-65535.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The get_previous_alpha() method returns the previous alpha
-value.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcolorselection--is-adjusting">
- <title>gtk.ColorSelection.is_adjusting</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_adjusting</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the user is
-currently dragging a color around, and <literal>False</literal> if the
-selection has stopped.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_adjusting</methodname>() method retrieves the
-current state of the colorselection. If True the user is in the process of
-changing the current color.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--color-selection-palette-from-string">
- <title>gtk.color_selection_palette_from_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.color_selection_palette_from_string</methodname>
- <methodparam><parameter
- role="keyword">str</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">str</parameter>&nbsp;:</term>
- <listitem><simpara>the string containing the list of
-colors</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> objects
-or <literal>None</literal> if the conversion fails</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The
-<function>gtk.color_selection_palette_from_string</function>() function
-returns a list of <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> objects
-corresponding to the color specifications in the string specified by
-<parameter>str</parameter>. str is a colon-separated list of color names
-readable by <link
-linkend="function-gdk--color-parse"><function>gtk.gtk.color_parse</function>()</link>.
-If <parameter>str</parameter> cannot be converted to a list of color this
-function returns <literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--color-selection-palette-to-string">
- <title>gtk.color_selection_palette_to_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.color_selection_palette_to_string</methodname>
- <methodparam><parameter
- role="keyword">colors</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">colors</parameter>&nbsp;:</term>
- <listitem><simpara>a list or tuple of <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-objects</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing a colon-separated list of
-<parameter>colors</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.color_selection_palette_to_string</function>()
-function returns a string containing a colon-separated list of the
-representation of the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> objects
-in <parameter>colors</parameter>.</para>
-
- <para>This function is useful to save a special palette of colors for
-a <link
-linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link>
-as a string that can later be used by calling the <link
-linkend="method-gobject--set-property"><methodname>gobject.set_property</methodname>()</link>
-method to set the "gtk-color-palette" property on the default <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-returned from the <link
-linkend="function-gtk--settings-get-default"><function>gtk.settings_get_default</function>()</link>)
-function.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcolorselection--color-changed">
- <title>The "color-changed" gtk.ColorSelection Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>colorselection</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>colorselection</parameter>&nbsp;:</term>
- <listitem><simpara>the colorselection that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "color-changed" signal is emitted when the current color in
-the colorselection changes.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcolorselectiondialog.xml b/docs/reference/pygtk-gtkcolorselectiondialog.xml
deleted file mode 100644
index 4c4bfcd0..00000000
--- a/docs/reference/pygtk-gtkcolorselectiondialog.xml
+++ /dev/null
@@ -1,165 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcolorselectiondialog">
- <refnamediv>
- <refname>gtk.ColorSelectionDialog</refname>
- <refpurpose>a standard dialog for selecting a color.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ColorSelectionDialog</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcolorselectiondialog">gtk.ColorSelectionDialog</link></methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
- +-- <link linkend="class-gtkcolorselectiondialog">gtk.ColorSelectionDialog</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcolorselectiondialog">
- <title>gtk.ColorSelectionDialog Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
- <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkcolorselectiondialog">
- <title>gtk.ColorSelectionDialog Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"colorsel"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link>
-widget contained in the dialog.</entry>
- </row>
-
- <row valign="top">
- <entry>"ok_button"</entry>
- <entry>Read</entry>
- <entry>The "OK" button contained in the dialog.</entry>
- </row>
-
- <row valign="top">
- <entry>"cancel_button"</entry>
- <entry>Read</entry>
- <entry>The "Cancel" button contained in the dialog.</entry>
- </row>
-
- <row valign="top">
- <entry>"help_button"</entry>
- <entry>Read</entry>
- <entry>The "Help" button contained in the dialog.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcolorselectiondialog">
- <title>gtk.ColorSelectionDialog Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link>
-provides a standard dialog that allows a user to select a color. The <link
-linkend="class-gtkcolorselectiondialog"><classname>gtk.ColorSelectionDialog</classname></link>
-uses an embedded <link
-linkend="class-gtkcolorselection"><classname>gtk.ColorSelection</classname></link>
-to provide color selection capability.</para>
-
- <para>Use the attributes (ok_button, cancel_button and help_button) of
-the colorselectiondialog to connect handlers to the "OK", "Cancel" and
-"Help" button "clicked" signals. The colorsel attribute provides access to
-the colorselection widget. Connect a handler to its "color-changed" signal
-to be notified when the color is changed. The current color can be retrieved
-using the <link
-linkend="method-gtkcolorselection--get-current-color"><methodname>gtk.ColorSelection.get_current_color</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcolorselectiondialog">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ColorSelectionDialog</methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>a string to be used as the dialog
-title.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new colorselectiondialog</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <classname>gtk.ColorSelectionDialog</classname>
-using the string contained in <parameter>title</parameter> as the text for
-the dialog title.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcombo.xml b/docs/reference/pygtk-gtkcombo.xml
deleted file mode 100644
index 11c77c31..00000000
--- a/docs/reference/pygtk-gtkcombo.xml
+++ /dev/null
@@ -1,435 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcombo">
- <refnamediv>
- <refname>gtk.Combo</refname>
- <refpurpose>a text entry field with a dropdown list.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Combo</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkhbox">gtk.HBox</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcombo">gtk.Combo</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcombo--set-value-in-list">set_value_in_list</link></methodname>
- <methodparam><parameter role="keyword">val</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ok_if_empty</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcombo--set-use-arrows">set_use_arrows</link></methodname>
- <methodparam><parameter role="keyword">val</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcombo--set-use-arrows-always">set_use_arrows_always</link></methodname>
- <methodparam><parameter role="keyword">val</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcombo--set-case-sensitive">set_case_sensitive</link></methodname>
- <methodparam><parameter role="keyword">val</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcombo--set-item-string">set_item_string</link></methodname>
- <methodparam><parameter
- role="keyword">item</parameter></methodparam>
- <methodparam><parameter
- role="keyword">item_value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcombo--set-popdown-strings">set_popdown_strings</link></methodname>
- <methodparam><parameter
- role="keyword">strings</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcombo--disable-activate">disable_activate</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkhbox">gtk.HBox</link>
- +-- <link linkend="class-gtkcombo">gtk.Combo</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcombo">
- <title>gtk.Combo Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"allow-empty"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, an empty value may be entered
- in this field</entry>
- </row>
- <row valign="top">
- <entry>"case-sensitive"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, list item matching is case
- sensitive</entry>
- </row>
- <row valign="top">
- <entry>"enable-arrow-keys"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, the arrow keys move through the
- list of items</entry>
- </row>
- <row valign="top">
- <entry>"enable-arrows-always"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, the arrow keys work, even if
- the entry contents are not in the list</entry>
- </row>
- <row valign="top">
- <entry>"value-in-list"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, entered values must already be
- present in the list</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkcombo">
- <title>gtk.Combo Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkcombo">
- <title>gtk.Combo Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"entry"</entry>
- <entry>Read</entry>
- <entry>the text entry widget</entry>
- </row>
-
- <row valign="top">
- <entry>"list"</entry>
- <entry>Read</entry>
- <entry>the list shown in the drop-down window</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcombo">
- <title>gtk.Combo Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>The <link
- linkend="class-gtkcombo"><classname>gtk.Combo</classname></link> is
- deprecated in GTK+ 2.4 and PyGTK 2.4 in favor of the <link
- linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>.</para>
- </note>
-
- <para>The <link
-linkend="class-gtkcombo"><classname>gtk.Combo</classname></link> widget
-consists of a single-line text entry field and a drop-down list. The
-drop-down list is displayed when the user clicks on a small arrow button to
-the right of the entry field. The drop-down list is a
-<classname>gtk.List</classname> widget and can be accessed using the list
-attribute of the <link
-linkend="class-gtkcombo"><classname>gtk.Combo</classname></link>. List
-elements can contain arbitrary widgets, but if an element is not a plain
-label, then you must use the
-<methodname>gtk.List.set_item_string</methodname>() method. This sets the
-string which will be placed in the text entry field when the item is
-selected.</para>
-
- <para>By default, the user can step through the items in the list using
-the arrow (cursor) keys, though this behavior can be turned off with the
-<link
-linkend="method-gtkcombo--set-use-arrows"><methodname>set_use_arrows</methodname>()</link>
-method. Normally the arrow keys are only active when the contents of the
-text entry field matches one of the items in the list. If the contents of
-the entry field do not match any of the list items, then pressing the arrow
-keys does nothing. However, by calling <link
-linkend="method-gtkcombo--set-use-arrows"><methodname>set_use_arrows_always</methodname>()</link>
-you can specify that the arrow keys are always active. If the contents of
-the entry field does not match any of the items in the list, then pressing
-the up or down arrow key will set the entry field to the last or first item
-in the list, respectively.</para>
-
- <para>Note the list attribute references a gtk.List which is a
-deprecated widget so the combo widget may be changed or deprecated in the
-future.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcombo">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Combo</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a combo object*</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates an new <link
-linkend="class-gtkcombo"><classname>gtk.Combo</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcombo--set-value-in-list">
- <title>gtk.Combo.set_value_in_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_value_in_list</methodname>
- <methodparam><parameter
- role="keyword">val</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ok_if_empty</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">val</parameter>&nbsp;:</term>
- <listitem><simpara>If True the value entered must match one of the
-values in the list.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">ok_if_empty</parameter>&nbsp;:</term>
- <listitem><simpara>If True an empty value is considered
-valid.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_value_in_list</methodname>() method
-specifies whether the value entered in the text entry field must match one
-of the values in the list. This method sets the "value-in-list" property to
-the value of <parameter>val</parameter> and the "allow-empty" property to
-the value of <parameter>ok_if_empty</parameter>.</para>
-
- <para>If <parameter>val</parameter> is True the user will not be able
-to perform any other action (the widget grabs the focus) until a valid value
-has been entered. If <parameter>ok_if_empty</parameter> is True an empty
-field is considered an acceptable value.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombo--set-use-arrows">
- <title>gtk.Combo.set_use_arrows</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_arrows</methodname>
- <methodparam><parameter
- role="keyword">val</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">val</parameter>&nbsp;:</term>
- <listitem><simpara>If True can be used to navigate through the
-list items</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_use_arrows</methodname>() method sets the
-"enable-use-arrows" property to the value of <parameter>val</parameter>. If
-<parameter>val</parameter> is True the arrows keys can be used to navigate
-through the list items.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombo--set-use-arrows-always">
- <title>gtk.Combo.set_use_arrows_always</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_arrows_always</methodname>
- <methodparam><parameter
- role="keyword">val</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">val</parameter>&nbsp;:</term>
- <listitem><simpara>If True the arrow keys will still work even if
-the text entry field does not match any of the list
-items.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_use_arrows_always</methodname>() method sets
-the "enable-arrows-always" property to the values of
-<parameter>val</parameter>. If <parameter>val</parameter> is True the arrow
-keys will work even if the text entry field does not match any of the list
-items.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombo--set-case-sensitive">
- <title>gtk.Combo.set_case_sensitive</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_case_sensitive</methodname>
- <methodparam><parameter
- role="keyword">val</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">val</parameter>&nbsp;:</term>
- <listitem><simpara>If True the text in the list items is case
-sensitive.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_case_sensitive</methodname>() method sets
-the "case-sensitive" property to the value of <parameter>val</parameter>. If
-<parameter>val</parameter> is True the text in the combo list items and the
-text entry field are case sensitive. The default value of
-"set-case-sensitive" is False.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtkcombo--set-item-string">
- <title>gtk.Combo.set_item_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_item_string</methodname>
- <methodparam><parameter
- role="keyword">item</parameter></methodparam>
- <methodparam><parameter
- role="keyword">item_value</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">item</parameter>&nbsp;:</term>
- <listitem><simpara>a list item</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">item_value</parameter>&nbsp;:</term>
- <listitem><simpara>a string to place in the entry field when
-<parameter>item</parameter> is selected</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_item_string</methodname>() method sets the
-string (from <parameter>item_value</parameter>) to place in the combo text
-entry field when the <parameter>item</parameter> is selected. This method is
-only needed if the list item is other than a simple label (e.g. a
-pixmap).</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtkcombo--set-popdown-strings">
- <title>gtk.Combo.set_popdown_strings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_popdown_strings</methodname>
- <methodparam><parameter
- role="keyword">strings</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">strings</parameter>&nbsp;:</term>
- <listitem><simpara>a list of strings to populate the
-list</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_popdown_strings</methodname>() method is a
-convenience method that sets the strings used in the popdown list from.
-<parameter>strings</parameter> (a Python list or tuple object).</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtkcombo--disable-activate">
- <title>gtk.Combo.disable_activate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>disable_activate</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>disable_activate</methodname>() method prevents
-the combo from showing the popup list when the entry emits the "activate"
-signal, i.e. when the <keycap>Return</keycap> key is pressed. This may be
-useful if, for example, you want the <keycap>Return</keycap> key to close a
-dialog instead. </para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcombobox.xml b/docs/reference/pygtk-gtkcombobox.xml
deleted file mode 100644
index d1eceed6..00000000
--- a/docs/reference/pygtk-gtkcombobox.xml
+++ /dev/null
@@ -1,1286 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcombobox">
- <refnamediv>
- <refname>gtk.ComboBox</refname> <refpurpose>a widget used to choose from
- a list of items (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ComboBox</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtkcelllayout">gtk.CellLayout</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkcombobox">gtk.ComboBox</link></methodname>
- <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--get-wrap-width">get_wrap_width</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--set-wrap-width">set_wrap_width</link></methodname>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--get-row-span-column">get_row_span_column</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--set-row-span-column">set_row_span_column</link></methodname>
- <methodparam><parameter role="keyword">row_span</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--get-column-span-column">get_column_span_column</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--set-column-span-column">set_column_span_column</link></methodname>
- <methodparam><parameter role="keyword">column_span</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--get-active">get_active</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--set-active">set_active</link></methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--get-active-iter">get_active_iter</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--set-active-iter">set_active_iter</link></methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--set-model">set_model</link></methodname>
- <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--get-model">get_model</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--append-text">append_text</link></methodname>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--insert-text">insert_text</link></methodname>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--prepend-text">prepend_text</link></methodname>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--remove-text">remove_text</link></methodname>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--get-active-text">get_active_text</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--popup">popup</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--popdown">popdown</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--get-popup-accessible">get_popup_accessible</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox- -get-row-separator-func">get_row_separator_func</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--set-row-separator-func">set_row_separator_func</link></methodname>
- <methodparam><parameter role="keyword">func</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--get-add-tearoffs">get_add_tearoffs</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--set-add-tearoffs">set_add_tearoffs</link></methodname>
- <methodparam><parameter role="keyword">add_tearoffs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--get-focus-on-click">get_focus_on_click</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--set-focus-on-click">set_focus_on_click</link></methodname>
- <methodparam><parameter role="keyword">focus_on_click</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--get-title">get_title</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcombobox--set-title">set_title</link></methodname>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--combo-box-new-text">gtk.combo_box_new_text</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkcombobox">gtk.ComboBox</link> (implements <link linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcombobox">
- <title>gtk.ComboBox Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"active"</entry>
- <entry>Read-Write</entry>
- <entry>The index of the item that is currently active.. If the
- model is a non-flat treemodel, and the active item is not an
- immediate child of the root of the tree, this property has the
- value of the first index of the path of the item. This
- property is available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"add-tearoffs"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> generated menus have tearoff
- menu items. Note that this only affects menu style combo
- boxes. Default value: <literal>False</literal>. Available in
- GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"column-span-column"</entry>
- <entry>Read-Write</entry>
- <entry>The TreeModel column containing the column span values.
- This property is available in GTK+ 2.4 and above</entry>
- </row>
-
- <row valign="top">
- <entry>"focus-on-click"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the combo box grabs focus
- when it is clicked with the mouse. Default value:
- <literal>True</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"has-frame"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the combo box grabs focus
- when it is clicked with the mouse. Default value:
- <literal>True</literal>. Available in GTK+ 2.6 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"model"</entry>
- <entry>Read-Write</entry>
- <entry>The TreeModel for the combo box. This property is
- available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"popup-shown"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the dropdown menu of the
- combobox is popped up. Note that this property is mainly
- useful, because it allows you to connect to the
- "notify::popup-shown" signal. Available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"row-span-column"</entry>
- <entry>Read-Write</entry>
- <entry>The TreeModel column containing the row span
- values. This property is available in GTK+ 2.4 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"tearoff-title"</entry>
- <entry>Read-Write</entry>
- <entry>A title that may be displayed by the window manager
- when the popup is torn-off. Default value: "". Available in
- GTK+ 2.10 and above</entry>
- </row>
-
- <row valign="top">
- <entry>"wrap-width"</entry>
- <entry>Read-Write</entry>
- <entry>The number of columns to use to lay out the popup
- items. This property is available in GTK+ 2.4 and
- above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkcombobox">
- <title>gtk.ComboBox Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"appears-as-list"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the combo box dropdowns
- should look like lists rather than menus.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcombobox">
- <title>gtk.ComboBox Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcelleditable">gtk.CellEditable Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkcombobox--changed">changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>combobox</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in GTK+ 2.4 and PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <link
- linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
- is a replacement for the <link
- linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>. The
- <link
- linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
- implements the <link
- linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
- interface that provides a number of useful methods for managing the
- contents. A <link
- linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
- is created with the <link
- linkend="constructor-gtkcombobox">gtk.ComboBox()</link> constructor that
- is associated with the optional <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>. If
- no <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- is specified it can be added later with the <link
- linkend="method-gtkcombobox--set-model"><methodname>set_model</methodname>()</link>
- method.</para>
-
- <para>Alternatively, the <link
- linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
- function creates a simple <link
- linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
- and associated <link
- linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
- model. A <link
- linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
- is also created and packed in the new combo box. In this simple combo
- box each list item is a text string that can be selected. The
- convenience methods <link
- linkend="method-gtkcombobox--append-text"><methodname>append_text</methodname>()</link>,
- <link
- linkend="method-gtkcombobox--prepend-text"><methodname>prepend_text</methodname>()</link>,
- <link
- linkend="method-gtkcombobox--insert-text"><methodname>insert_text</methodname>()</link>
- and <link
- linkend="method-gtkcombobox--remove-text"><methodname>remove_text</methodname>()</link>
- can be used to manage the contents of the <link
- linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>. Using
- the <link
- linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
- function is equivalent to:</para>
-
- <programlisting>
- liststore = gtk.ListStore(gobject.TYPE_STRING)
- combobox = gtk.ComboBox(liststore)
- cell = gtk.CellRendererText()
- combobox.pack_start(cell, True)
- combobox.add_attribute(cell, 'text', 0)
-</programlisting>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcombobox">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ComboBox</methodname>
- <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">model</parameter>&nbsp;:</term>
- <listitem><simpara>A valid <link linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new <link linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
- associated with the optional <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- specified by <parameter>model</parameter>. If
- <parameter>model</parameter> is not specified the combo box will not
- have an associated tree model.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcombobox--get-wrap-width">
- <title>gtk.ComboBox.get_wrap_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_wrap_width</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The wrap width.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_wrap_width</methodname>() method returns the
-value of the "wrap-width" property of the combo box as set by the <link
-linkend="method-gtkcombobox--set-wrap-width"><methodname>set_wrap_width</methodname>()</link>
-method. The wrap width is basically the preferred number of columns to use
-to lay out the popup i.e. lays out the popup items in a table with
-<parameter>width</parameter> columns.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--set-wrap-width">
- <title>gtk.ComboBox.set_wrap_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_wrap_width</methodname>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>The preferred number of columns of
-width.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_wrap_width</methodname>() method sets the
-wrap width (and the "wrap-width" property) of the combo box to the value
-specified by <parameter>width</parameter>. The wrap width is basically the
-preferred number of columns to use to lay out the popup i.e. lays out the
-popup items in a table with <parameter>width</parameter> columns.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--get-row-span-column">
- <title>gtk.ComboBox.get_row_span_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_row_span_column</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The row span column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_row_span_column</methodname>() method
-returns the value of the "row-span-column" property. The "row-span-column"
-property indicates the column in the associated <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> row
-that contains an integer that indicates how many rows the item should
-span.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--set-row-span-column">
- <title>gtk.ComboBox.set_row_span_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_row_span_column</methodname>
- <methodparam><parameter role="keyword">row_span</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row_span</parameter>&nbsp;:</term>
- <listitem><simpara>A column in the model passed during construction.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_row_span_column</methodname>() method sets
-the "row-span-column" property to the value specified by
-<parameter>row_span</parameter>. The "row-span-column" property indicates
-the column in the associated <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> row
-that contains an integer that indicates how many rows the item should
-span.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--get-column-span-column">
- <title>gtk.ComboBox.get_column_span_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_column_span_column</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The column span column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_column_span_column</methodname>() method
-returns the value of the "column-span-column" property. The
-"column-span-column" property indicates the column in the associated <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> row
-that contains an integer that indicates how many columns the item should
-span.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--set-column-span-column">
- <title>gtk.ComboBox.set_column_span_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_column_span_column</methodname>
- <methodparam><parameter role="keyword">column_span</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column_span</parameter>&nbsp;:</term>
- <listitem><simpara>A column in the model passed during construction.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_column_span_column</methodname>() method
-sets the "column-span-column" property to the value specified by
-<parameter>column_span</parameter>. The "column-span-column" property
-indicates the column in the associated <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> row
-that contains an integer that indicates how many columns the item should
-span.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--get-active">
- <title>gtk.ComboBox.get_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_active</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>An integer which is the model index of the
- currently active item, or -1 if there's no active
- item.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_active</methodname>() method returns the
- value of the "active" property which is the index in the model of the
- currently active item, or -1 if there's no active item. If the model
- is a non-flat treemodel, and the active item is not an immediate child
- of the root of the tree, this method returns the first path index of
- the active item. For example if the path of the active item is (1, 0,
- 2) this method will return 1.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--set-active">
- <title>gtk.ComboBox.set_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_active</methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>An index in the model passed during
- construction, or -1 to have no active item.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_active</methodname>() method sets the active
-item of the combo_box to the item with the model index specified by
-<parameter>index</parameter>. If <parameter>index</parameter> is -1 the
-combo box will have no active item. The "active" property is also set to the
-value of <parameter>index</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--get-active-iter">
- <title>gtk.ComboBox.get_active_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_active_iter</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- that points at the active item or <literal>None</literal> if there
- is no active item.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_active_iter</methodname>() method returns a
- <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- that points to the current active item or <literal>None</literal> if
- there is no active item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--set-active-iter">
- <title>gtk.ComboBox.set_active_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_active_iter</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>A valid <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- pointing at an item in the associated <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_active_iter</methodname>() method sets the
-current active item to be the one referenced by <parameter>iter</parameter>
-in the associated <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.
-<parameter>iter</parameter> must correspond to a path of depth one. The
-"active" property is also set by this method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--set-model">
- <title>gtk.ComboBox.set_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_model</methodname>
- <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">model</parameter>&nbsp;:</term>
- <listitem><simpara>A <link linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_model</methodname>() method sets the model
-used by the combo box to the value specified by
-<parameter>model</parameter>. The "model" property will also be set to the
-value of <parameter>model</parameter>. A previously set model will be
-unset. If <parameter>model</parameter> is <literal>None</literal> or not
-specified, the old model will be unset.</para>
-
- <note>
- <para>In PyGTK 2.4.0 the model could not be <literal>None</literal>
-and did not default to <literal>None</literal>.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--get-model">
- <title>gtk.ComboBox.get_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_model</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_model</methodname>() method returns the
-value of the "model" property which contains the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-that is acting as data source for the combo_box or <literal>None</literal>
-if no <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> is
-associated with the combo box.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--append-text">
- <title>gtk.ComboBox.append_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append_text</methodname>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>A string.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>append_text</methodname>() method appends the
-string specified by <parameter>text</parameter> to the list of strings
-stored in the combo box <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>. Note
-that you can only use this method with combo boxes constructed with the
-<link
-linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--insert-text">
- <title>gtk.ComboBox.insert_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_text</methodname>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>A model index where the
- <parameter>text</parameter> should be
- inserted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>A string.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>insert_text</methodname>() method inserts the
-string specified by <parameter>text</parameter> in the combo box <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link> at
-the index specified by <parameter>position</parameter>. Note that you can
-only use this method with combo boxes constructed with the <link
-linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--prepend-text">
- <title>gtk.ComboBox.prepend_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend_text</methodname>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>A string.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>prepend_text</methodname>() method prepends the
-string specified by <parameter>text</parameter> to the list of strings
-stored in the <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
-associated with the combo_box. Note that you can only use this method with
-combo boxes constructed with the <link
-linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--remove-text">
- <title>gtk.ComboBox.remove_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_text</methodname>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>Index of the item to remove.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>remove_text</methodname>() method removes the
-string at the index specified by <parameter>position</parameter> in the
-associated <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>. Note
-that you can only use this function with combo boxes constructed with the
-<link
-linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--get-active-text">
- <title>gtk.ComboBox.get_active_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_active_text</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The currently active text.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_active_text</methodname>() method returns
-the currently active string or <literal>None</literal> if no entry is
-selected. Note that you can only use this function with combo boxes
-constructed with the <link
-linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--popup">
- <title>gtk.ComboBox.popup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>popup</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>popup</methodname>() method pops up the menu or
- dropdown list of the combo box. This method is mostly intended for use
- by accessibility technologies; applications should have little use for
- it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--popdown">
- <title>gtk.ComboBox.popdown</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>popdown</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>popdown</methodname>() method hides the menu or
-dropdown list of the combo box. This method is mostly intended for use by
-accessibility technologies; applications should have little use for
-it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--get-popup-accessible">
- <title>gtk.ComboBox.get_popup_accessible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_popup_accessible</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the accessible object corresponding to the
-popup.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_popup_accessible</methodname>() method gets
-the accessible object corresponding to the popup. This method is mostly
-intended for use by accessibility technologies; applications should have
-little use for it.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtkcombobox- -get-row-separator-func">
- <title>gtk.ComboBox.get_row_separator_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_row_separator_func</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the current row separator
-function.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_row_separator_func</methodname>() method
-returns the current row separator function as set by the <link
-linkend="method-gtkcombobo- -set-row-separator-func"><methodname>set_row_separator_func</methodname>()</link>
-method.</para>
-
- </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gtkcombobox--set-row-separator-func">
- <title>gtk.ComboBox.set_row_separator_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_row_separator_func</methodname>
- <methodparam><parameter role="keyword">func</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>a function or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to
-<parameter>func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_row_separator_func</methodname>() method
-sets the row separator function to <parameter>func</parameter>, which is
-used to determine if a row should be drawn as a separator. If func is
-<literal>None</literal>, no separators are drawn. This is the default
-value.</para>
-
- <para>The signature of <parameter>func</parameter> is:</para>
-
- <programlisting>
- def func(model, iter, user_data):
-</programlisting>
-
- <para>where <parameter>model</parameter> is the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-used by the combo box, <parameter>iter</parameter> is a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at a row in <parameter>model</parameter> and
-<parameter>user_data</parameter> is
-<parameter>data</parameter>. <parameter>func</parameter> returns
-<literal>True</literal> if the row is a separator. A common way to implement
-<parameter>func</parameter> is to have a boolean column in
-<parameter>model</parameter>, that indicates if the row is a
-separator.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--get-add-tearoffs">
- <title>gtk.ComboBox.get_add_tearoffs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_add_tearoffs</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if menus should have a
-tearoff menuitem.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_add_tearoffs</methodname>() method returns the
-value of the "add-tearoffs" property.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--set-add-tearoffs">
- <title>gtk.ComboBox.set_add_tearoffs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_add_tearoffs</methodname>
- <methodparam><parameter role="keyword">add_tearoffs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">add_tearoffs</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> add tearoff menu items</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_add_tearoffs</methodname>() method sets the
-"add-tearoffs" property to the value of
-<parameter>add_tearoffs</parameter>. If <parameter>add_tearoffs</parameter>
-is <literal>True</literal>, the popup menu should have a tearoff menu
-item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--get-focus-on-click">
- <title>gtk.ComboBox.get_focus_on_click</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_focus_on_click</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the combo box grabs
-focus when it is clicked with the mouse.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_focus_on_click</methodname>() method returns
-the value of the "focus-on-click" property.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--set-focus-on-click">
- <title>gtk.ComboBox.set_focus_on_click</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_focus_on_click</methodname>
- <methodparam><parameter role="keyword">focus_on_click</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">focus_on_click</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the combo box grabs
-focus when clicked with the mouse.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_focus_on_click</methodname>() method sets the
-value of the "focus-on-click" property to the value of
-<parameter>focus_on_click</parameter>. If
-<parameter>focus_on_click</parameter> is <literal>True</literal> the combo
-box grabs focus when clicked with the mouse.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--get-title">
- <title>gtk.ComboBox.get_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_title</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the menu's title in tearoff
- mode..</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_title</methodname>() method returns the
- value of the "tearoff-title" property that contains the current title
- of the menu in tearoff mode. See the <link
- linkend="method-gtkcombobox--set-add-tearoffs"><methodname>set_add_tearoffs()</methodname></link>
- method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcombobox--set-title">
- <title>gtk.ComboBox.set_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_title</methodname>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>a title for the menu in tearoff
- mode.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_title</methodname>() method sets the
- "tearoff-title" property to the value of
- <parameter>title</parameter>. The "tearoff-title" property contains
- the menu's title in tearoff mode.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--combo-box-new-text">
- <title>gtk.combo_box_new_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.combo_box_new_text</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new <link
- linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
- for text items.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.combo_box_new_text</function>() function is a
-convenience function that constructs a new text combo box, which is a <link
-linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link> just
-displaying strings. If you use this function to create a text combo box, you
-should only manipulate its data source with the following convenience
-methods: <link
-linkend="method-gtkcombobox--append-text"><methodname>append_text</methodname>()</link>,
-<link
-linkend="method-gtkcombobox--insert-text"><methodname>insert_text</methodname>()</link>,
-<link
-linkend="method-gtkcombobox--prepend-text"><methodname>prepend_text</methodname>()</link>
-and <link
-linkend="method-gtkcombobox--remove-text"><methodname>remove_text</methodname>()</link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcombobox--changed">
- <title>The "changed" gtk.ComboBox Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>combobox</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>combobox</parameter>&nbsp;:</term>
- <listitem><simpara>the combo box that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "changed" signal is emitted when a new item in the combo box
-is selected.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcomboboxentry.xml b/docs/reference/pygtk-gtkcomboboxentry.xml
deleted file mode 100644
index 1301eedc..00000000
--- a/docs/reference/pygtk-gtkcomboboxentry.xml
+++ /dev/null
@@ -1,344 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkcomboboxentry">
- <refnamediv>
- <refname>gtk.ComboBoxEntry</refname> <refpurpose>a text entry field with
- a dropdown list (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ComboBoxEntry</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkcombobox">gtk.ComboBox</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtkcelllayout">gtk.CellLayout</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkcomboboxentry">gtk.ComboBoxEntry</link></methodname>
- <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">column</parameter><initializer>-1</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcomboboxentry--set-text-column">set_text_column</link></methodname>
- <methodparam><parameter role="keyword">text_column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcomboboxentry--get-text-column">get_text_column</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--combo-box-entry-new-text">gtk.combo_box_entry_new_text</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkcombobox">gtk.ComboBox</link>
- +-- <link linkend="class-gtkcomboboxentry">gtk.ComboBoxEntry</link> (implements <link linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcomboboxentry">
- <title>gtk.ComboBoxEntry Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkcombobox">gtk.ComboBox Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"text-column"</entry>
- <entry>Read-Write</entry>
- <entry>The column in the <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- to get the strings from.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkcomboboxentry">
- <title>gtk.ComboBoxEntry Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkcombobox">gtk.ComboBox Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcomboboxentry">
- <title>gtk.ComboBoxEntry Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcombobox">gtk.ComboBox Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcelleditable">gtk.CellEditable Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in GTK+ 2.4 and PyGTK 2.4 and
- above.</para> </note>
-
- <para>The <link
-linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>
-is a replacement for the <link
-linkend="class-gtkcombo"><classname>gtk.Combo</classname></link>. The <link
-linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>
-is subclassed from <link
-linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link> and
-implements the <link
-linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
-interface; refer to their descriptions for a number of useful methods and
-properties for managing the contents of a combo box entry. A <link
-linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>
-also contains a child <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> accessed by
-using the child attribute of the combo box entry:</para>
-
- <programlisting>
- entry = comboboxentry.child
-</programlisting>
-
- <para>A <link
-linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>
-is created with the <link
-linkend="constructor-gtkcomboboxentry">gtk.ComboBoxEntry()</link>
-constructor. The constructor can also be called with the optional parameters
-<parameter>model</parameter> (a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> -
-default <literal>None</literal>) and <parameter>column</parameter> (a number
-of a column in <parameter>model</parameter> - default 0). If no <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> is
-specified it can be added later with the <link
-linkend="method-gtkcombobox--set-model"><methodname>set_model</methodname>()</link>
-method. The text column can be changed using the <link
-linkend="method-gtkcomboboxentry--set-text-column"><methodname>set_text_column</methodname>()</link>
-method. A new combo box entry is created and packed with a <link
-linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
-but no attribute mappings are set on the cell renderer.</para>
-
- <para>Alternatively, the <link
-linkend="function-gtk--combo-box-entry-new-text"><function>gtk.combo_box_entry_new_text</function>()</link>
-function creates a <link
-linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>
-with an associated <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
-model and the text column attribute mapping set to 0. In this combo box
-entry each list item is a text string that can be selected. The convenience
-methods <link
-linkend="method-gtkcombobox--append-text"><methodname>gtk.ComboBox.append_text</methodname>()</link>,
-<link
-linkend="method-gtkcombobox--prepend-text"><methodname>gtk.ComboBox.prepend_text</methodname>()</link>,
-<link
-linkend="method-gtkcombobox--insert-text"><methodname>gtk.ComboBox.insert_text</methodname>()</link>
-and <link
-linkend="method-gtkcombobox--remove-text"><methodname>gtk.ComboBox.remove_text</methodname>()</link>
-can be used to manage the contents of the <link
-linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>. Using
-the <link
-linkend="function-gtk--combo-box-entry-new-text"><function>gtk.combo_box_entry_new_text</function>()</link>
-function is equivalent to:</para>
-
- <programlisting>
- liststore = gtk.ListStore(gobject.TYPE_STRING)
- comboboxentry = gtk.ComboBoxEntry(liststore, 0)
-</programlisting>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcomboboxentry">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ComboBoxEntry</methodname>
- <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">column</parameter><initializer>-1</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">model</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- to associate with the combo box entry, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>The number of the column to use for setting the
- strings of the combo box entry.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new <link
- linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>
-that has a <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> as child
-and associated with the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-specified by <parameter>model</parameter> and using the column of
-<parameter>model</parameter> specified by <parameter>column</parameter> to
-retrieve strings. If <parameter>model</parameter> was not specified it
-defaults to <literal>None</literal> but you can change the model using the
-<link
-linkend="method-gtkcombobox--set-model"><methodname>gtk.ComboBox.set_model()</methodname></link>
-method. If <parameter>column</parameter> was not specified it defaults to -1
-meaning the text column is unset but you can change it using the <link
-linkend="method-gtkcomboboxentry--set-text-column"><methodname>set_text_column</methodname>()</link>
-method. Once the text column is set either in the constructor or using the
-<link
-linkend="method-gtkcomboboxentry--set-text-column"><methodname>set_text_column</methodname>()</link>
-method it cannot be changed. A ValueError exception is thrown if
-<parameter>column</parameter> is outside the range of column numbers for
-<parameter>model</parameter>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcomboboxentry--set-text-column">
- <title>gtk.ComboBoxEntry.set_text_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text_column</methodname>
- <methodparam><parameter role="keyword">text_column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">text_column</parameter>&nbsp;:</term>
- <listitem><simpara>A column in the associated <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- to use as the data source for the strings.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_text_column</methodname>() method sets the
-"text-column" property to the value of <parameter>tree_column</parameter>
-only if the text column has not been set (that is, "text-column" is -1). The
-value of <parameter>tree_column</parameter> is the number of the tree model
-column used as the data source for the strings of the combo box
-entry.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcomboboxentry--get-text-column">
- <title>gtk.ComboBoxEntry.get_text_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text_column</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The number of the column in the associated
- <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- used as the data source for the combo box
- entry.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_text_column</methodname>() method returns
-the number of the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-column that is used as the data source for the strings of the combo box
-entry.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--combo-box-entry-new-text">
- <title>gtk.combo_box_entry_new_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.combo_box_entry_new_text</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new <link
- linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>
- widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.combo_box_entry_new_text</function>() function
-is a convenience function which constructs a new <link
-linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link>,
-just displaying strings. If you use this function to create a combo box
-entry, you should only manipulate its <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-data source with the following <link
-linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
-convenience methods: <link
-linkend="method-gtkcombobox--append-text"><methodname>gtk.ComboBox.append_text</methodname>()</link>,
-<link
-linkend="method-gtkcombobox--insert-text"><methodname>gtk.ComboBox.insert_text</methodname>()</link>,
-<link
-linkend="method-gtkcombobox--prepend-text"><methodname>gtk.ComboBox.prepend_text</methodname>()</link>
-and <link
-linkend="method-gtkcombobox--remove-text"><methodname>gtk.ComboBox.remove_text</methodname>()</link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcontainer.xml b/docs/reference/pygtk-gtkcontainer.xml
deleted file mode 100644
index df92344f..00000000
--- a/docs/reference/pygtk-gtkcontainer.xml
+++ /dev/null
@@ -1,1830 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcontainer">
- <refnamediv>
- <refname>gtk.Container</refname>
- <refpurpose>a base class for widgets that contain other
-widgets</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Container</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--set-border-width">set_border_width</link></methodname>
- <methodparam><parameter
- role="keyword">border_width</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--get-border-width">get_border_width</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--add">add</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--remove">remove</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--set-resize-mode">set_resize_mode</link></methodname>
- <methodparam><parameter
- role="keyword">resize_mode</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--get-resize-mode">get_resize_mode</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--check-resize">check_resize</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--forall">forall</link></methodname>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--foreach">foreach</link></methodname>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--get-children">get_children</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--propagate-expose">propagate_expose</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--set-focus-chain">set_focus_chain</link></methodname>
- <methodparam><parameter
- role="keyword">focusable_widgets</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--get-focus-chain">get_focus_chain</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--unset-focus-chain">unset_focus_chain</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--set-reallocate-redraws">set_reallocate_redraws</link></methodname>
- <methodparam><parameter
- role="keyword">needs_redraws</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--set-focus-child">set_focus_child</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--set-focus-vadjustment">set_focus_vadjustment</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--get-focus-vadjustment">get_focus_vadjustment</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--set-focus-hadjustment">set_focus_hadjustment</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--get-focus-hadjustment">get_focus_hadjustment</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--resize-children">resize_children</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--child-type">child_type</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--add-with-properties">add_with_properties</link></methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>first_prop_name</parameter></methodparam>
- <methodparam><parameter>first_prop_value</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--child-set">child_set</link></methodname>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>first_prop_name</parameter></methodparam>
- <methodparam><parameter>first_prop_value</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--child-get">child_get</link></methodname>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>first_prop_name</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--child-set-property">child_set_property</link></methodname>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>property_name</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcontainer--child-get-property">child_get_property</link></methodname>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>property_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcontainer--install-child-property">gtk.container_class_install_child_property</link></methodname>
- <methodparam><parameter role="keyword">property_id</parameter></methodparam>
- <methodparam><parameter role="keyword">pspec</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkcontainer--list-child-properties">gtk.container_class_list_child_properties</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--container-class-install-child-property">gtk.container_class_install_child_property</link></methodname>
- <methodparam><parameter role="keyword">klass</parameter></methodparam>
- <methodparam><parameter role="keyword">property_id</parameter></methodparam>
- <methodparam><parameter role="keyword">pspec</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--container-class-list-child-properties">gtk.container_class_list_child_properties</link></methodname>
- <methodparam><parameter role="keyword">klass</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcontainer">
- <title>gtk.Container Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
-
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"border-width"</entry>
- <entry>Read/Write</entry>
- <entry>The width of the empty border outside the containers
- children.</entry>
- </row>
-
- <row valign="top">
- <entry>"child"</entry>
- <entry>Read</entry>
- <entry>The child widget in the container</entry>
- </row>
-
- <row valign="top">
- <entry>"resize-mode"</entry>
- <entry>Read/Write</entry>
- <entry>Specify how resize events are handled. One of:
- <literal>gtk.RESIZE_PARENT</literal>,
- <literal>gtk.RESIZE_QUEUE</literal> or
- <literal>gtk.RESIZE_IMMEDIATE</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkcontainer">
- <title>gtk.Container Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="10"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"border_width"</entry>
- <entry>Read</entry>
- <entry>The width of the empty border outside the containers
-children.</entry>
- </row>
-
- <row valign="top">
- <entry>"resize_mode"</entry>
- <entry>Read</entry>
- <entry>Specify how resize events are handled. One of:
-<literal>gtk.RESIZE_PARENT</literal>, <literal>gtk.RESIZE_QUEUE</literal> or
-<literal>gtk.RESIZE_IMMEDIATE</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"focus_child"</entry>
- <entry>Read</entry>
- <entry>The child widget that has the focus</entry>
- </row>
-
- <row valign="top">
- <entry>"need_resize"</entry>
- <entry>Read</entry>
- <entry>If True the container needs resizing</entry>
- </row>
-
- <row valign="top">
- <entry>"reallocate_redraws"</entry>
- <entry>Read</entry>
- <entry>if True redraw the container when a child gets
-reallocated</entry>
- </row>
-
- <row valign="top">
- <entry>"has_focus_chain"</entry>
- <entry>Read</entry>
- <entry>If True the container had its focus chain explicitly
-set</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcontainer">
- <title>gtk.Container Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkcontainer--add">add</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>container</parameter>
- </methodparam>
- <methodparam><parameter>widget</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcontainer--check-resize">check-resize</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>container</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcontainer--remove">remove</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>container</parameter>
- </methodparam>
- <methodparam><parameter>widget</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcontainer--set-focus-child">set-focus-child</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>container</parameter>
- </methodparam>
- <methodparam><parameter>widget</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
-class provides common attributes and methods for a large number of widget
-subclasses that manage the layout of other widgets within the area of a
-window.</para>
-
- <para>A <literal>PyGTK</literal> user interface is constructed by
-nesting widgets inside widgets. Container widgets are the inner nodes in the
-resulting tree of widgets: they contain other widgets. So, for example, you
-might have a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
-containing a <link
-linkend="class-gtkframe"><classname>gtk.Frame</classname></link> containing
-a <link linkend="class-gtklabel"><classname>gtk.Label</classname></link>. If
-you wanted an image instead of a textual label inside the frame, you might
-replace the <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> widget with
-a <link linkend="class-gtkimage"><classname>gtk.Image</classname></link>
-widget.</para>
-
- <para>There are two major kinds of container widgets. Both are
-subclasses of the abstract <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
-base class.</para>
-
- <para>The first type of container widget has a single child widget and
-derives from <link
-linkend="class-gtkbin"><classname>gtk.Bin</classname></link>. These
-containers are decorators, that add some kind of functionality to the
-child. For example, a <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link> makes its
-child into a clickable button; a <link
-linkend="class-gtkframe"><classname>gtk.Frame</classname></link> draws a
-frame around its child and a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> places
-its child widget inside a top-level window.</para>
-
- <para>The second type of container can have more than one child; its
-purpose is to manage layout. This means that these containers assign sizes
-and positions to their children. For example, a <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> arranges its
-children in a horizontal row, and a <link
-linkend="class-gtktable"><classname>gtk.Table</classname></link> arranges
-the widgets it contains in a two-dimensional grid.</para>
-
- <para>To fulfill its task, a layout container must negotiate the size
-requirements with its parent and its children. This negotiation is carried
-out in two phases, size requisition and size allocation.</para>
-
- <refsect2 id='sec-ContainerSizeRequisition'>
- <title>Size Requisition</title>
-
- <para>The size requisition of a widget is it's desired width and
-height. This is represented by a <link
-linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>.</para>
-
- <para>How a widget determines its desired size depends on the
-widget. A <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link>, for
-example, requests enough space to display all its text. Container widgets
-generally base their size request on the requisitions of their
-children.</para>
-
- <para>The size requisition phase of the widget layout process operates
-top-down. It starts at a top-level widget, typically a GtkWindow. The
-top-level widget asks its child for its size requisition by calling
-gtk_widget_size_request(). To determine its requisition, the child asks its
-own children for their requisitions and so on. Finally, the top-level widget
-will get a requisition back from its child.</para>
-
- </refsect2>
-
- <refsect2 id="sec-ContainerSizeAllocation">
- <title>Size Allocation</title>
-
- <para>When the top-level widget has determined how much space its
-child would like to have, the second phase of the size negotiation, size
-allocation, begins. Depending on its configuration (see the <link
-linkend="method-gtkwindow--set-resizable"><methodname>gtk.Window.set_resizable</methodname>()</link>
-method), the top-level widget may be able to expand in order to satisfy the
-size request or it may have to ignore the size request and keep its fixed
-size. It then tells its child widget how much space it gets by calling the
-<link
-linkend="method-gtkwidget--size-allocate"><methodname>size_allocate</methodname>()</link>
-method. The child widget divides the space among its children and tells each
-child how much space it got, and so on. Under normal circumstances, a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> will
-always give its child the amount of space the child requested.</para>
-
- <para>A child's size allocation is represented by a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-that contains not only a width and height, but also a position (i.e. X and Y
-coordinates), so that containers can tell their children not only how much
-space is available, but also where they are positioned inside the space
-available to the container.</para>
-
- <para>Widgets are required to honor the size allocation they receive;
-a size request is only a request, and widgets must be able to cope with any
-size.</para>
-
- </refsect2>
-
- <refsect2 id="sec-ContainerChildProperties">
- <title>Child Properties</title>
-
- <para><link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
-introduces child properties - these are object properties that are not
-specific to either the container or the contained widget, but rather to
-their relation. Typical examples of child properties are the "position" or
-"pack-type" of a widget which is contained in a <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link>.</para>
-
- <para>Use the <link
-linkend="method-gtkcontainer--install-child-property"><methodname>install_child_property</methodname>()</link>
-method to install child properties for a container class and the <link
-linkend="method-gtkcontainer--list-child-properties"><methodname>list_child_properties</methodname>()</link>
-function to get information about existing child properties.</para>
-
- <para>To set the value of a child property, use the <link
-linkend="method-gtkcontainer--child-set-property"><methodname>child_set_property</methodname>()</link>,
-or <link
-linkend="method-gtkcontainer--child-set"><methodname>child_set</methodname>()</link>
-methods. To obtain the value of a child property, use the <link
-linkend="method-gtkcontainer--child-get-property"><methodname>child_get_property</methodname>()</link>,
-or <link
-linkend="method-gtkcontainer--child-get"><methodname>child_get</methodname>()</link>
-methods. To emit notification about child property changes, use the <link
-linkend="method-gtkwidget--child-notify"><methodname>gtk.Widget.child_notify</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcontainer--set-border-width">
- <title>gtk.Container.set_border_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_border_width</methodname>
- <methodparam><parameter
- role="keyword">border_width</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">border_width</parameter>&nbsp;:</term>
- <listitem><simpara>The amount of blank space to leave
-<emphasis>outside</emphasis> the container. Valid values are in the range
-0-65535 pixels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_border_width</methodname>() method sets the
-"border-width" property of the container. The border width of a container is
-the amount of space to leave around the outside of the container. The only
-exception to this is <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>; because
-toplevel windows can't leave space outside, they leave the space inside. The
-border is added on all sides of the container.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--get-border-width">
- <title>gtk.Container.get_border_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_border_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current border width</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_border_width</methodname>() method retrieves
-the value of the "border-width" property of the container. See <link
-linkend="method-gtkcontainer--set-border-width"><methodname>set_border_width</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--add">
- <title>gtk.Container.add</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget to be placed inside the
-container</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add</methodname>() method adds
-<parameter>widget</parameter> to the container. This method is typically
-used for simple containers such as <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>, <link
-linkend="class-gtkframe"><classname>gtk.Frame</classname></link>, or <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link> that hold
-a single child widget. For layout containers that handle multiple children
-such as <link linkend="class-gtkbox"><classname>gtk.Box</classname></link>
-or <link linkend="class-gtktable"><classname>gtk.Table</classname></link>,
-this function will pick default packing parameters that may not be correct.
-Containers that handle multiple children usually have additional methods
-such as <link
-linkend="method-gtkbox--pack-start"><methodname>gtk.Box.pack_start</methodname>()</link>
-and <link
-linkend="method-gtktable--attach"><methodname>gtk.Table.attach</methodname>()</link>
-as an alternative to <methodname>add</methodname>(). Adding a widget to a
-container usually results in the resizing and redrawing of the container
-contents.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--remove">
- <title>gtk.Container.remove</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a current child of
-<parameter>container</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove</methodname>() method removes
-<parameter>widget</parameter> from the container.
-<parameter>widget</parameter> must be inside the container. Note that the
-container will own a reference to <parameter>widget</parameter>, and that
-this may be the last reference held; so removing a widget from its container
-can cause that widget to be destroyed. If you want to use
-<parameter>widget</parameter> again, you should add a reference to
-it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--set-resize-mode">
- <title>gtk.Container.set_resize_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_resize_mode</methodname>
- <methodparam><parameter
- role="keyword">resize_mode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">resize_mode</parameter>&nbsp;:</term>
- <listitem><simpara>the new resize mode.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set-resize_mode</methodname>() method sets the
-"resize=mode" property of the container. The resize mode of a container
-determines whether a resize request will be passed to the container's parent
-(<literal>gtk.RESIZE_PARENT</literal>), queued for later execution
-(<literal>gtk.RESIZE_QUEUE</literal>) or executed immediately
-(<literal>gtk.RESIZE_IMMEDIATE</literal>).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--get-resize-mode">
- <title>gtk.Container.get_resize_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_resize_mode</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current resize mode</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The get_resize_mode() method returns the value of the
-"resize-mode" property for of the container. See <link
-linkend="method-gtkcontainer--set-resize-mode"><methodname>set_resize_mode()</methodname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--check-resize">
- <title>gtk.Container.check_resize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>check_resize</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>check_resize</methodname>() method emits the
-"check-resize" signal on the container.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--forall">
- <title>gtk.Container.forall</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forall</methodname>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a callback</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">callback_data</parameter>&nbsp;:</term>
- <listitem><simpara>the callback user data</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forall</methodname>() method arranges to invoke
-<parameter>callback</parameter> on each child of the container including
-children that are considered "internal" (implementation details of the
-container). "Internal" children generally weren't added by the user of the
-container, but were added by the container implementation itself. Most
-applications should use the <link
-linkend="method-gtkcontainer--foreach"><methodname>foreach</methodname>()</link>
-method, rather than the <methodname>forall</methodname>() method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--foreach">
- <title>gtk.Container.foreach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>foreach</methodname>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a callback</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">callback_data</parameter>&nbsp;:</term>
- <listitem><simpara>the callback user data</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>foreach</methodname>() method arranges to invoke
-<parameter>callback</parameter> on each non-internal child of the
-container.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--get-children">
- <title>gtk.Container.get_children</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_children</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the container's non-internal
-children.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_children</methodname>() method returns the
-the container's non-internal children.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--propagate-expose">
- <title>gtk.Container.propagate_expose</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>propagate_expose</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a child of the container</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>a expose event sent to the
-container</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>propagate_expose</methodname>() method sends
-synthetic expose events to all children that don't have their own <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>s when
-the container receives an expose event.</para>
-
- <para>The <link
-linkend="method-gtkcontainer--propagate-expose"><methodname>propagate_expose</methodname>()</link>
-takes care of deciding whether an expose event needs to be sent to the
-child, intersecting the event's area with the child area, and sending the
-event.</para>
-
- <para>In most cases, a container can simply either simply inherit the
-expose implementation from <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>,
-or, do some drawing and then chain to the expose implementation from <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--set-focus-chain">
- <title>gtk.Container.set_focus_chain</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_focus_chain</methodname>
- <methodparam><parameter
- role="keyword">focusable_widgets</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">focusable_widgets</parameter>&nbsp;:</term>
- <listitem><simpara>a list or tuple containing a chain of focusable
-widgets.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_focus_chain</methodname>() method sets a
-focus chain, overriding the one computed automatically by GTK. In principle
-each widget in the chain should be a descendant of the container, but this
-is not enforced by this method, since it's allowed to set the focus chain
-before you pack the widgets, or have a widget in the chain that isn't always
-packed. The necessary checks are done when the focus chain is actually
-traversed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--get-focus-chain">
- <title>gtk.Container.get_focus_chain</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_focus_chain</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list containing the widgets in the focus
-chain if the focus chain of the container has been set explicitly or None if
-no focus chain has been explicitly set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_focus_chain</methodname>() method retrieves
-the focus chain of the container, if one has been set explicitly. If no
-focus chain has been explicitly set, GTK computes the focus chain based on
-the positions of the children. In that case, the method returns None.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--unset-focus-chain">
- <title>gtk.Container.unset_focus_chain</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unset_focus_chain</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>unset_focus_chain</methodname>() method removes
-a focus chain explicitly set with <link
-linkend="method-gtkcontainer--set-focus-chain"><methodname>set_focus_chain</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--set-reallocate-redraws">
- <title>gtk.Container.set_reallocate_redraws</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_reallocate_redraws</methodname>
- <methodparam><parameter
- role="keyword">needs_redraws</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">needs_redraws</parameter>&nbsp;:</term>
- <listitem><simpara>the new value for the container's
-reallocate_redraws attribute.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_reallocate_redraws</methodname>() method
-sets the reallocate_redraws attribute of the container to the value of
-<parameter>needs_redraws</parameter>. Containers requesting reallocation
-redraws get automatically redrawn if any of their children change
-allocation.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--set-focus-child">
- <title>gtk.Container.set_focus_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_focus_child</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget that will get the
-focus.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_focus_child</methodname>() method emits the
-"set-focus-child" signal that arranges for the child widget referenced by
-<parameter>child</parameter> to get the focus and recalculates the container
-adjustments.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--set-focus-vadjustment">
- <title>gtk.Container.set_focus_vadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_focus_vadjustment</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>The new vertical focus
-adjustment</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_focus_vadjustment</methodname>() method sets
-the vertical focus adjustment to the value of
-<parameter>adjustment</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--get-focus-vadjustment">
- <title>gtk.Container.get_focus_vadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_focus_vadjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the vertical focus adjustment, or
-<literal>None</literal> if none has been set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The get_focus_vadjustment() method retrieves the vertical focus
-adjustment for the container. See the <link
-linkend="method-gtkcontainer--set-focus-vadjustment"><methodname>set_focus_vadjustment</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--set-focus-hadjustment">
- <title>gtk.Container.set_focus_hadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_focus_hadjustment</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>The new horizontal focus
-adjustment</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_focus_hadjustment</methodname>() method sets
-the horizontal focus adjustment to the value of
-<parameter>adjustment</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--get-focus-hadjustment">
- <title>gtk.Container.get_focus_hadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_focus_hadjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the horizontal focus adjustment, or
-<literal>None</literal> if none has been set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_focus_hadjustment</methodname>() method
-retrieves the horizontal focus adjustment for the container. See <link
-linkend="method-gtkcontainer--set-focus-hadjustment"><methodname>set_focus_hadjustment</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--resize-children">
- <title>gtk.Container.resize_children</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>resize_children</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>resize_children</methodname>() method causes the
-container to recalculate its size and its children's sizes.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtkcontainer--child-type">
- <title>gtk.Container.child_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>child_type</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>child_type</methodname>() method returns the
-type of the children that can be added to the container. Note that this may
-return a void type to indicate that no more children can be added, e.g. for
-a <link linkend="class-gtkpaned"><classname>gtk.Paned</classname></link>
-which already has two children or a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> that
-already has a child.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--add-with-properties">
- <title>gtk.Container.add_with_properties</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_with_properties</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>first_prop_name</parameter></methodparam>
- <methodparam><parameter>first_prop_value</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget to be added</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>first_prop_name</parameter>&nbsp;:</term>
- <listitem><simpara>the first property name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>first_prop_value</parameter>&nbsp;:</term>
- <listitem><simpara>a value for the first
-property</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional property name and value
-pairs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_with_properties</methodname>() method adds
-the child widget specified by <parameter>widget</parameter> to the container
-while allowing the setting of zero or more container child property values
-at the same time. Containers supporting add with settable child properties
-are: <link linkend="class-gtkbox"><classname>gtk.Box</classname></link>,
-<link linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link>,
-<link linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link>
-and <link
-linkend="class-gtktable"><classname>gtk.Table</classname></link>.</para>
-
- <para>For example the following adds a button to a <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link> layout
-widget and sets the child properties "x" and "y" specifying the child
-position in the layout:</para>
-
- <programlisting>
- fixed.add_with_properties(button, "x", 10, "y", 20")
-</programlisting>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--child-set">
- <title>gtk.Container.child_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>child_set</methodname>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>first_prop_name</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>child</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>first_prop_name</parameter>&nbsp;:</term>
- <listitem><simpara>the first property name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>first_prop_value</parameter>&nbsp;:</term>
- <listitem><simpara>the value of the first
-property</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional property name and value
-pairs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>child_set</methodname>() method sets the
-properties for <parameter>child</parameter> using the given property name
-and value pairs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--child-get">
- <title>gtk.Container.child_get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>child_get</methodname>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>first_prop_name</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>child</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget to get the child properties
-for</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>first_prop_name</parameter>&nbsp;:</term>
- <listitem><simpara>the first property name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional property names</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the property values
-requested</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>child_get</methodname>() method retrieves the
-requested container child properties for
-<parameter>child</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--child-set-property">
- <title>gtk.Container.child_set_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>child_set_property</methodname>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>property_name</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>child</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>property_name</parameter>&nbsp;:</term>
- <listitem><simpara>the child property name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter>&nbsp;:</term>
- <listitem><simpara>a value to associate with the
-property</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>child_set_property</methodname>() method sets
-the property name specified by <parameter>property_name</parameter> with the
-value specified in <parameter>value</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--child-get-property">
- <title>gtk.Container.child_get_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>child_get_property</methodname>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>property_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>child</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>property_name</parameter>&nbsp;:</term>
- <listitem><simpara>the child property name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the value of the child property for the
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>child_get_property</methodname>() method
-retrieves the value of the child property specified by
-<parameter>property_name</parameter> for the widget
-<parameter>child</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--install-child-property">
- <title>gtk.Container.install_child_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>install_child_property</methodname>
- <methodparam><parameter role="keyword">property_id</parameter></methodparam>
- <methodparam><parameter role="keyword">pspec</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">property_id</parameter>&nbsp;:</term>
- <listitem><simpara>an integer property ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pspec</parameter>&nbsp;:</term>
- <listitem><simpara>a tuple containing a parameter
-specifications</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>install_child_property</methodname>() method
- installs a child property for the container class using the integer ID
- specified by
- <parameter>property_id</parameter>. <parameter>pspec</parameter> is a
- tuple containing at least 5 items. The first 4 items contain the
- following parameter specification items:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>a string specifying the name of the property</simpara>
- </listitem>
- <listitem>
- <simpara>an object specifying the property type</simpara>
- </listitem>
- <listitem>
- <simpara>a string specifying the nickname for the property or
-<literal>None</literal></simpara>
- </listitem>
- <listitem>
- <simpara>a string specifying the short description for the property
-or <literal>None</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para>The last item must be a integer containing a combination of the
- <link linkend="gobject-param-constants">GObject Param Flag
- Constants</link>. Additional tuple items (if needed) are inserted
- between the fourth item and the last item depending on the property
- type:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gobject.TYPE_CHAR</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_CHAR</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_BOOLEAN</literal></term>
- <listitem>
- <simpara>default value</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_INT</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_UINT</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_LONG</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_ULONG</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_INT64</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_UINT64</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_ENUM</literal></term>
- <listitem>
- <simpara>default value</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_FLAGS</literal></term>
- <listitem>
- <simpara>default value</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_FLOAT</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_DOUBLE</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_STRING</literal></term>
- <listitem>
- <simpara>default value</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_PARAM</literal></term>
- <listitem>
- <simpara>Not applicable</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_BOXED</literal></term>
- <listitem>
- <simpara>Not applicable</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_POINTER</literal></term>
- <listitem>
- <simpara>Not applicable</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_OBJECT</literal></term>
- <listitem>
- <simpara>Not applicable</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="method-gtkcontainer--list-child-properties">
- <title>gtk.Container.list_child_properties</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_child_properties</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the list of child properties</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>list_child_properties</methodname>() method
- returns a list containing the child properties of the container
- class. See the <link
- linkend="method-gtkcontainer--install-child-property"><methodname>install_child_property</methodname>()</link>
- method for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--container-class-install-child-property">
- <title>gtk.container_class_install_child_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.container_class_install_child_property</methodname>
- <methodparam><parameter
- role="keyword">klass</parameter></methodparam>
- <methodparam><parameter role="keyword">property_id</parameter></methodparam>
- <methodparam><parameter role="keyword">pspec</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">klass</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
- class or instance.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">property_id</parameter>&nbsp;:</term>
- <listitem><simpara>an integer property ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pspec</parameter>&nbsp;:</term>
- <listitem><simpara>a tuple containing a parameter
-specification</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <warning>
- <para>This function is deprecated in PyGTK 2.10 and above.</para>
- </warning>
-
- <para>The
- <function>gtk.container_class_install_child_property</function>()
- function installs a child property for the container class specified
- by <parameter>klass</parameter> using the integer ID specified by
- <parameter>property_id</parameter>. <parameter>pspec</parameter> is a
- tuple containing at least 5 items. The first 4 items contain the
- following parameter specification items:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>a string specifying the name of the property</simpara>
- </listitem>
- <listitem>
- <simpara>an object specifying the property type</simpara>
- </listitem>
- <listitem>
- <simpara>a string specifying the nickname for the property or
-<literal>None</literal></simpara>
- </listitem>
- <listitem>
- <simpara>a string specifying the short description for the property
-or <literal>None</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para>The last item must be a integer containing a combination of the
- <link linkend="gobject-param-constants">GObject Param Flag
- Constants</link>. Additional tuple items (if needed) are inserted
- between the fourth item and the last item depending on the property
- type:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gobject.TYPE_CHAR</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_CHAR</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_BOOLEAN</literal></term>
- <listitem>
- <simpara>default value</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_INT</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_UINT</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_LONG</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_ULONG</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_INT64</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_UINT64</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_ENUM</literal></term>
- <listitem>
- <simpara>default value</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_FLAGS</literal></term>
- <listitem>
- <simpara>default value</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_FLOAT</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_DOUBLE</literal></term>
- <listitem>
- <simpara>minimum, maximum and default values</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_STRING</literal></term>
- <listitem>
- <simpara>default value</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_PARAM</literal></term>
- <listitem>
- <simpara>Not applicable</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_BOXED</literal></term>
- <listitem>
- <simpara>Not applicable</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_POINTER</literal></term>
- <listitem>
- <simpara>Not applicable</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gobject.TYPE_OBJECT</literal></term>
- <listitem>
- <simpara>Not applicable</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="function-gtk--container-class-list-child-properties">
- <title>gtk.container_class_list_child_properties</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.container_class_list_child_properties</methodname>
- <methodparam><parameter
- role="keyword">klass</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">klass</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
- class or instance.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the list of child properties</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <warning>
- <para>This function is deprecated in PyGTK 2.10 and above.</para>
- </warning>
-
- <para>The
- <function>gtk.container_class_list_child_properties</function>()
- function returns a tuple containing the child properties of the
- container class specified by <parameter>klass</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcontainer--add">
- <title>The "add" gtk.Container Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>container</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>container</parameter>&nbsp;:</term>
- <listitem><simpara>the container that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "add" signal is emitted when <parameter>widget</parameter>
-is added to the <parameter>container</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcontainer--check-resize">
- <title>The "check-resize" gtk.Container Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>container</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>container</parameter>&nbsp;:</term>
- <listitem><simpara>the container that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "check-resize" signal is emitted when the
-<methodname>check_resize</methodname>() method is called forcing the
-recalculation of the container and its children. See the <link
-linkend="method-gtkcontainer--set-resize-mode"><methodname>set_resize_mode</methodname>()</link>
-method for details.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcontainer--remove">
- <title>The "remove" gtk.Container Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>container</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>container</parameter>&nbsp;:</term>
- <listitem><simpara>the container that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "remove" signal is emitted when
-<parameter>widget</parameter> is removed from
-<parameter>container</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkcontainer--set-focus-child">
- <title>The "set-focus-child" gtk.Container Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>container</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>container</parameter>&nbsp;:</term>
- <listitem><simpara>the container that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "set-focus-child" signal is emitted when the <link
-linkend="method-gtkcontainer--set-focus-child"><methodname>set_focus_child</methodname>()</link>
-method is called. <parameter>widget</parameter> is set as the child in
-<parameter>container</parameter> with the focus.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkcurve.xml b/docs/reference/pygtk-gtkcurve.xml
deleted file mode 100644
index a606c58a..00000000
--- a/docs/reference/pygtk-gtkcurve.xml
+++ /dev/null
@@ -1,423 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkcurve">
- <refnamediv>
- <refname>gtk.Curve</refname>
- <refpurpose>allows direct editing of a curve.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Curve</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkdrawingarea">gtk.DrawingArea</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkcurve">gtk.Curve</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcurve--reset">reset</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcurve--set-gamma">set_gamma</link></methodname>
- <methodparam><parameter
- role="keyword">gamma</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcurve--set-range">set_range</link></methodname>
- <methodparam><parameter
- role="keyword">min_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">max_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">min_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">max_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcurve--get-vector">get_vector</link></methodname>
- <methodparam><parameter
- role="keyword">size</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcurve--set-vector">set_vector</link></methodname>
- <methodparam><parameter
- role="keyword">vector</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkcurve--set-curve-type">set_curve_type</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkdrawingarea">gtk.DrawingArea</link>
- +-- <link linkend="class-gtkcurve">gtk.Curve</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkcurve">
- <title>gtk.Curve Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
-
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"curve-type"</entry>
- <entry>Read/Write</entry>
- <entry>The curve type. One of linear
-(<literal>gtk.CURVE_TYPE_LINEAR</literal>), spline interpolated
-(<literal>gtk.CURVE_TYPE_SPLINE</literal>), or free-form
-(<literal>gtk.CURVE_TYPE_FREE</literal>).</entry>
- </row>
-
- <row valign="top">
- <entry>"max-x"</entry>
- <entry>Read/Write</entry>
- <entry>The maximum possible value for X</entry>
- </row>
-
- <row valign="top">
- <entry>"max-y"</entry>
- <entry>Read/Write</entry>
- <entry>The maximum possible value for Y</entry>
- </row>
-
- <row valign="top">
- <entry>"min-x"</entry>
- <entry>Read/Write</entry>
- <entry>The minimum possible value for X</entry>
- </row>
-
- <row valign="top">
- <entry>"min-y"</entry>
- <entry>Read/Write</entry>
- <entry>The minimum possible value for Y</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
-
- <refsect1 id="style-properties-gtkcurve">
- <title>gtk.Curve Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkcurve">
- <title>gtk.Curve Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkcurve--curve-type-changed">curve-type-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>curve</parameter>
- </methodparam>
- <methodparam><parameter>widget</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is considered too specialized or little-used for
-PyGTK, and will in the future be moved to some other package. If your
-application needs this widget, feel free to use it, as the widget does work
-and is useful in some applications; it's just not of general interest.
-However, it will eventually move out of the PyGTK distribution.</para>
- </note>
-
- <para>The <link
-linkend="class-gtkcurve"><classname>gtk.Curve</classname></link> widget
-allows the user to edit a curve covering a range of values. It is typically
-used to fine-tune color balances in graphics applications like the
-<application>Gimp</application>. The <link
-linkend="class-gtkcurve"><classname>gtk.Curve</classname></link> widget has
-3 modes of operation - spline, linear and free. In spline mode the user
-places points on the curve which are automatically connected together into a
-smooth curve. In linear mode the user places points on the curve which are
-connected by straight lines. In free mode the user can draw the points of
-the curve freely, and they are not connected at all.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkcurve">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Curve</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new gtk.Curve object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkcurve"><classname>gtk.Curve</classname></link>
-object</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkcurve--reset">
- <title>gtk.Curve.reset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reset</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>reset</methodname>() method resets the curve to
-a straight line from the minimum x and y values to the maximum x and y
-values (i.e. from the bottom-left to the top-right corners). The curve type
-is not changed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcurve--set-gamma">
- <title>gtk.Curve.set_gamma</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_gamma</methodname>
- <methodparam><parameter
- role="keyword">gamma</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gamma</parameter>&nbsp;:</term>
- <listitem><simpara>the gamma value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_gamma</methodname>() method recomputes the
-entire curve using the value in <parameter>gamma</parameter>. A gamma value
-of 1 results in a straight line. Values greater than 1 result in a curve
-above the straight line. Values less than 1 result in a curve below the
-straight line. The curve type is changed to
-<literal>gtk.CURVE_TYPE_FREE</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcurve--set-range">
- <title>gtk.Curve.set_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_range</methodname>
- <methodparam><parameter
- role="keyword">min_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">max_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">min_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">max_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">min_x</parameter>&nbsp;:</term>
- <listitem><simpara>the new minimum x value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">max_x</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum x value.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">min_y</parameter>&nbsp;:</term>
- <listitem><simpara>the new minimum y value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">max_y</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum y value.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_range</methodname>() method sets the
-"min-x", "min-y", "max-x" and "max-y" properties from<parameter>
-min_x</parameter>, <parameter>min_y</parameter>,<parameter>
-max_x</parameter>, and <parameter>max_y</parameter>. The curve is also reset
-with a call to <link
-linkend="method-gtkcurve--reset"><methodname>reset</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcurve--get-vector">
- <title>gtk.Curve.get_vector</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_vector</methodname>
- <methodparam><parameter
- role="keyword">size</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the number of points to return or -1 to return
-all the points in the curve.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the
-points</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_vector</methodname>() method returns a tuple
-of points representing the curve. The number of points to return is
-specified by <parameter>size</parameter>; if <parameter>size</parameter> is
--1 all the points in the curve are returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcurve--set-vector">
- <title>gtk.Curve.set_vector</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_vector</methodname>
- <methodparam><parameter
- role="keyword">vector</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">vector</parameter>&nbsp;:</term>
- <listitem><simpara>a list or tuple containing the points of the
-curve</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_vector</methodname>() method sets the curve
-using the points in <parameter>vector</parameter>. The curve type is set to
-<literal>gtk.CURVE_TYPE_FREE</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkcurve--set-curve-type">
- <title>gtk.Curve.set_curve_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_curve_type</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the new curve type:
-<literal>gtk.CURVE_TYPE_LINEAR</literal>,
-<literal>gtk.CURVE_TYPE_SPLINE</literal> or
-<literal>gtk.CURVE_TYPE_FREE</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_curve_type</methodname>() method sets the
-"curve-type" property with the value of <parameter>type</parameter>. The
-curve type must be one of <literal>gtk.CURVE_TYPE_LINEAR</literal>,
-<literal>gtk.CURVE_TYPE_SPLINE</literal> or
-<literal>gtk.CURVE_TYPE_FREE</literal>. The curve will remain unchanged
-except when changing from a free curve to a linear or spline curve, in which
-case the curve will be changed as little as possible.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkcurve--curve-type-changed">
- <title>The "curve-type-changed" gtk.Curve Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>curve</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>curve</parameter>&nbsp;:</term>
- <listitem><simpara>the curve that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "curve-type-changed" signal is emitted when the curve type
-has been changed. The curve type can be changed explicitly with a call to
-<link
-linkend="method-gtkcurve--set-curve-type"><methodname>set_curve_type</methodname>()</link>.
-It is also changed as a side-effect of calling <link
-linkend="method-gtkcurve--reset"><methodname>reset</methodname>()</link> or
-<link
-linkend="method-gtkcurve--set-gamma"><methodname>set_gamma</methodname>()</link></para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkdialog.xml b/docs/reference/pygtk-gtkdialog.xml
deleted file mode 100644
index 0dcf5a1a..00000000
--- a/docs/reference/pygtk-gtkdialog.xml
+++ /dev/null
@@ -1,914 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkdialog">
- <refnamediv>
- <refname>gtk.Dialog</refname>
- <refpurpose>popup windows for user information and action</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Dialog</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkwindow">gtk.Window</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkdialog">gtk.Dialog</link></methodname>
- <methodparam><parameter
- role="keyword">title</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">buttons</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkdialog--add-action-widget">add_action_widget</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">response_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkdialog--add-button">add_button</link></methodname>
- <methodparam><parameter
- role="keyword">button_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">response_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkdialog--add-buttons">add_buttons</link></methodname>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkdialog--set-response-sensitive">set_response_sensitive</link></methodname>
- <methodparam><parameter
- role="keyword">response_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkdialog--set-default-response">set_default_response</link></methodname>
- <methodparam><parameter
- role="keyword">response_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkdialog--set-has-separator">set_has_separator</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkdialog--get-has-separator">get_has_separator</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkdialog--response">response</link></methodname>
- <methodparam><parameter
- role="keyword">response_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkdialog--run">run</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkdialog--set-alternative-button-order">set_alternative_button_order</link></methodname>
- <methodparam><parameter
- role="keyword">new_order</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkdialog--get-response-for-widget">get_response_for_widget</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk- -alternative-dialog-button-order">gtk.alternative_dialog_button_order</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkdialog">
- <title>gtk.Dialog Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"has-separator"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, the dialog has a separator bar
-above its buttons</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkdialog">
- <title>gtk.Dialog Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"action-area-border"</entry>
- <entry>Read</entry>
- <entry>The width of the vborder around the button area in
-pixels.</entry>
- </row>
-
- <row valign="top">
- <entry>"button-spacing"</entry>
- <entry>Read</entry>
- <entry>The spacing between buttons in pixels.</entry>
- </row>
-
- <row valign="top">
- <entry>"content-area-border"</entry>
- <entry>Read</entry>
- <entry>The width of the border around the main dialog area in
-pixels.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"vbox"</entry>
- <entry>Read</entry>
- <entry>A <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link> that is the
-main container of the dialog - all the other widgets are packed in
-it.</entry>
- </row>
-
- <row valign="top">
- <entry>"action_area"</entry>
- <entry>Read</entry>
- <entry>A <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> that contains
-the buttons of the dialog.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkdialog">
- <title>gtk.Dialog Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkdialog--close">close</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>dialog</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkdialog--response">response</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>dialog</parameter>
- </methodparam>
- <methodparam><parameter>response_id</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>Dialog boxes are a convenient way to prompt the user for a small
- amount of input, e.g. to display a message, ask a question, or anything
- else that does not require extensive effort on the user's part. Dialogs
- are organized as a window split vertically. The top section is a <link
- linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>, and is
- where widgets such as a <link
- linkend="class-gtklabel"><classname>gtk.Label</classname></link> or a
- <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
- should be packed. The bottom area is known as the action_area which is
- generally used for packing buttons into the dialog which may perform
- functions such as cancel, ok, or apply. The two areas are separated by a
- <link
- linkend="class-gtkhseparator"><classname>gtk.HSeparator</classname></link>.</para>
-
- <para>The <link
- linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> boxes
- are created with a call to <link
- linkend="constructor-gtkdialog"><methodname>gtk.Dialog</methodname>()</link>()
- that sets the dialog title, some convenient flags, and adds simple
- buttons. In a newly created dialog, the two primary areas of the window
- can be accessed as the vbox and action_area attributes, as can be seen
- from the example, below. A modal dialog (that is, one which freezes the
- rest of the application from user input), can be created by passing the
- <literal>gtk.DIALOG_MODAL</literal> flag to the <link
- linkend="constructor-gtkdialog"><methodname>gtk.Dialog</methodname>()</link>
- constructor or by calling <link
- linkend="method-gtkwindow--set-modal"><methodname>set_modal</methodname>()</link>
- on the dialog.</para>
-
- <para>If you add buttons to <link
- linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> using
- <link
- linkend="constructor-gtkdialog"><methodname>gtk.Dialog</methodname>()</link>,
- <link
- linkend="method-gtkdialog--add-button"><methodname>add_button</methodname>()</link>,
- or <link
- linkend="method-gtkdialog--add-action-widget"><methodname>add_action_widget</methodname>()</link>,
- clicking the button will emit a signal called "response" with a response
- ID that you specified. PyGTK will never assign a meaning to positive
- response IDs; these are entirely user-defined. But for convenience, you
- can use the pre-defined <xref linkend="gtk-response-type-constants"
- endterm="gtk-response-type-constants-title"></xref> (these all have
- values less than zero).</para>
-
- <para>If a dialog receives a delete event, the "response" signal will be
- emitted with a response ID of
- <literal>gtk.RESPONSE_DELETE_EVENT</literal>.</para>
-
- <para>If you want to block waiting for a dialog to return before
- returning control flow to your code, you can call <link
- linkend="method-gtkdialog--run"><methodname>run</methodname>()</link>. This
- function enters a recursive main loop and waits for the user to respond
- to the dialog, returning the response ID corresponding to the button the
- user clicked.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkdialog">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Dialog</methodname>
- <methodparam><parameter
- role="keyword">title</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">buttons</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>The title of the dialog, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>The transient parent of the dialog, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>flags that control the operation of the
-dialog</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">buttons</parameter>&nbsp;:</term>
- <listitem><simpara>a tuple containing button text/response id pairs
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> with the
-title text specified by <parameter>title</parameter> (or
-<literal>None</literal> for the default title; see <link
-linkend="method-gtkwindow--set-title"><methodname>gtk.Window.set_title</methodname>()</link>)
-and transient parent window specified by <parameter>parent</parameter> (or
-<literal>None</literal> for none; see <link
-linkend="method-gtkwindow--set-transient-for"><methodname>gtk.Window.set_transient_for</methodname>()</link>).
-The <parameter>flags</parameter> argument can be used to make the dialog
-modal (<literal>gtk.DIALOG_MODAL</literal>) and/or to have it destroyed
-along with its transient parent
-(<literal>gtk.DIALOG_DESTROY_WITH_PARENT</literal>) and/or remove the
-separator (<literal>gtk.DIALOG_NO_SEPARATOR</literal>) (see the <xref
-linkend="gtk-dialog-flag-constants"
-endterm="gtk-dialog-flag-constants-title"></xref> for more
-information). After <parameter>flags</parameter>, a tuple of button
-text/response ID pairs should be listed, or <literal>None</literal> (the
-default value) if no buttons are needed. The button text can be either a
-stock ID such as <literal>gtk.STOCK_OK</literal>, or some arbitrary text. A
-response ID can be any positive number, or one of the pre-defined <xref
-linkend="gtk-response-type-constants"
-endterm="gtk-response-type-constants-title"></xref>.</para>
-
- <para>If the user clicks one of these dialog buttons, the <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> will emit
-the "response" signal with the corresponding response ID. If a <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> receives
-the "delete_event" signal, it will emit "response" with a response ID of
-<literal>gtk.RESPONSE_DELETE_EVENT</literal>. However, destroying a dialog
-does not emit the "response" signal; so be careful relying on "response"
-when using the <literal>gtk.DIALOG_DESTROY_WITH_PARENT</literal> flag.
-Buttons are added from left to right, so the first button in the list will
-be the leftmost button in the dialog.</para>
-
-<para>Here's a simple example:</para>
-<programlisting>
- dialog = gtk.Dialog("My dialog",
- main_app_window,
- gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT,
- (gtk.STOCK_CANCEL, gtk.RESPONSE_REJECT,
- gtk.STOCK_OK, gtk.RESPONSE_ACCEPT))
-</programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkdialog--add-action-widget">
- <title>gtk.Dialog.add_action_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_action_widget</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">response_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>an activatable widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">response_id</parameter>&nbsp;:</term>
- <listitem><simpara>a response ID</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_action_widget</methodname>() method adds an
-activatable widget to the action area of a <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>,
-connecting a signal handler that will emit the "response" signal on the
-dialog when the widget is activated. The widget is appended to the end of
-the dialog's action area. If you want to add a non-activatable widget,
-simply pack it into the <literal>action_area</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkdialog--add-button">
- <title>gtk.Dialog.add_button</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_button</methodname>
- <methodparam><parameter
- role="keyword">button_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">response_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">button_text</parameter>&nbsp;:</term>
- <listitem><simpara>the text of the button, or a stock
-ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">response_id</parameter>&nbsp;:</term>
- <listitem><simpara>the response ID for the
-button</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the button widget that was
-added</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_button</methodname>() method adds a button
-with the text specified by <parameter>button_text</parameter> (or a stock
-button, if <parameter>button_text</parameter> is a stock ID) and sets things
-up so that clicking the button will emit the "response" signal with the
-specified <parameter>response_id</parameter>. The button is appended to the
-end of the dialog's action area. The button widget is returned, but usually
-you don't need it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkdialog--add-buttons">
- <title>gtk.Dialog.add_buttons</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_buttons</methodname>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>one or more pairs of button
-specifiers: button text (or stock ID) and a response id</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_buttons</methodname>() method adds several
-buttons to the <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> using the
-button data passed as arguments to the method. This method is the same as
-calling the <link
-linkend="method-gtkdialog--add-button"><methodname>gtk.Dialog.add_button</methodname>()</link>
-repeatedly. The button data pairs - button text (or stock ID) and a response
-ID integer are passed individually. For example:</para>
-
- <programlisting>
- dialog.add_buttons(gtk.STOCK_OPEN, 42, "Close", gtk.RESPONSE_CLOSE)
-</programlisting>
-
- <para>will add "Open" and "Close" buttons to
-<parameter>dialog</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkdialog--set-response-sensitive">
- <title>gtk.Dialog.set_response_sensitive</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_response_sensitive</methodname>
- <methodparam><parameter
- role="keyword">response_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">response_id</parameter>&nbsp;:</term>
- <listitem><simpara>a response ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>the new value for
-sensitive</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_response_sensitive</methodname>() method
-calls the <link
-linkend="method-gtkwidget--set-sensitive"><methodname>gtk.Window.set_sensitive</methodname>()</link>
-method with the specified <parameter>response_id</parameter> for each widget
-in the dialog's action area. This method is a convenience function to
-sensitize/desensitize all dialog buttons at once.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkdialog--set-default-response">
- <title>gtk.Dialog.set_default_response</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_default_response</methodname>
- <methodparam><parameter
- role="keyword">response_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">response_id</parameter>&nbsp;:</term>
- <listitem><simpara>a response ID</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_default_response</methodname>() method sets
-the last widget in the dialog's action area with the specified
-<parameter>response_id</parameter> as the default widget for the dialog.
-Pressing <keycap>Enter</keycap> normally activates the default
-widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkdialog--set-has-separator">
- <title>gtk.Dialog.set_has_separator</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_has_separator</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> use a
-separator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_has_separator</methodname>() method sets the
-"has-separator" property to the value of <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal> (the default
-value) the dialog has a separator above the buttons.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkdialog--get-has-separator">
- <title>gtk.Dialog.get_has_separator</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_has_separator</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the value of the "has-separator"
-property</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_has_separator</methodname>() method returns
-the value of the "has-separator" property.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkdialog--response">
- <title>gtk.Dialog.response</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>response</methodname>
- <methodparam><parameter
- role="keyword">response_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">response_id</parameter>&nbsp;:</term>
- <listitem><simpara>response ID</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>response</methodname>() method emits the
-"response" signal with the value specified in
-<parameter>response_id</parameter>. This method is used to indicate that the
-user has responded to the dialog in some way; typically either you or <link
-linkend="method-gtkdialog--run"><function>gtk.Dialog.run()</function></link>
-will be monitoring the "response" signal and take appropriate action.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkdialog--run">
- <title>gtk.Dialog.run</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>run</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a response ID</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>run</methodname>() method blocks in a recursive
-main loop until the dialog either emits the "response" signal, or is
-destroyed. If the dialog is destroyed, the <methodname>run</methodname>()
-method returns <literal>gtk.RESPONSE_NONE</literal>; otherwise, it returns
-the response ID from the "response" signal emission. Before entering the
-recursive main loop, the <methodname>run</methodname>() method calls the
-<link
-linkend="method-gtkwidget--show"><methodname>gtk.Widget.show</methodname>()</link>
-on the dialog for you. Note that you still need to show any children of the
-dialog yourself.</para>
-
- <para>During the <methodname>run</methodname>() method, the default
-behavior of "delete_event" is disabled; if the dialog receives a
-"delete_event", it will not be destroyed as windows usually are, and the
-<methodname>run</methodname>() method will return
-<literal>gtk.RESPONSE_DELETE_EVENT</literal>. Also, during the
-<methodname>run</methodname>() method the dialog will be modal. You can
-force the <methodname>run</methodname>() method to return at any time by
-calling <link
-linkend="method-gtkdialog--response"><methodname>response</methodname>()</link>
-to emit the "response" signal. Destroying the dialog during the
-<methodname>run</methodname>() method is a very bad idea, because your
-post-run code won't know whether the dialog was destroyed or not.</para>
-
- <para>After the <methodname>run</methodname>() method returns, you are
-responsible for hiding or destroying the dialog as needed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkdialog--set-alternative-button-order">
- <title>gtk.Dialog.set_alternative_button_order</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_alternative_button_order</methodname>
- <methodparam><parameter
- role="keyword">new_order</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">new_order</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence containing response id
-integer values</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_alternative_button_order</methodname>()
-method sets an alternative button order for the dialog based on the sequence
-of response ids specified by <parameter>new_order</parameter>. If the
-"gtk-alternative-button-order" property of the <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object is set to <literal>True</literal>, the dialog buttons are reordered
-according to the order of the response ids passed to this method.</para>
-
- <para>By default, GTK+ dialogs use the button order advocated by the
-Gnome Human Interface Guidelines with the affirmative button at the far
-right, and the cancel button left of it. But the builtin GTK+ dialogs and
-<link
-linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>s
-do provide an alternative button order, which is more suitable on some
-platforms, e.g. Windows.</para>
-
- <para>Use this method after adding all the buttons to your dialog,
-as the following example shows:</para>
-
- <programlisting>
- settings = gtk.settings_get_default()
- settings.set_property('gtk-alternative-button-order', True)
-
- dialog = gtk.Dialog()
- cancel_button = dialog.add_button(gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL)
- ok_button = dialog.add_button(gtk.STOCK_OK, gtk.RESPONSE_OK)
- ok_button.grab_default()
- help_button = dialog.add_button(gtk.STOCK_HELP, gtk.RESPONSE_HELP)
-
- dialog.set_alternative_button_order([gtk.RESPONSE_OK, gtk.RESPONSE_CANCEL,
- gtk.RESPONSE_HELP])
-</programlisting>
-
- </refsect2>
-
- <refsect2 id="method-gtkdialog--get-response-for-widget">
- <title>gtk.Dialog.get_response_for_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_response_for_widget</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget in the action area of the
-dialog</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the response id of <parameter>widget</parameter>,
-or gtk.RESPONSE_NONE if the widget doesn't have a response id
-set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_response_for_widget</methodname>() method
-returns the response id of the widget specified by
-<parameter>widget</parameter> in the action area of the dialog.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk- -alternative-dialog-button-order">
- <title>gtk.alternative_dialog_button_order</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.alternative_dialog_button_order</methodname>
- <methodparam><parameter
- role="keyword">screen</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname> or
-<literal>None</literal> to use the default screen</link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the alternative button
-order should be used</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <function>gtk.alternative_dialog_button_order</function>()
-returns <literal>True</literal> if the alternative button order should be
-used for the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-specified by <parameter>screen</parameter>. If <parameter>screen</parameter>
-is <literal>None</literal> the default <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> is
-used.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkdialog--close">
- <title>The "close" gtk.Dialog Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>dialog</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>dialog</parameter>&nbsp;:</term>
- <listitem><simpara>the dialog that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "close" signal is emitted when the dialog is closed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkdialog--response">
- <title>The "response" gtk.Dialog Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>dialog</parameter></methodparam>
- <methodparam><parameter>response_id</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>dialog</parameter>&nbsp;:</term>
- <listitem><simpara>the dialog that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>response_id</parameter>&nbsp;:</term>
- <listitem><simpara>the response id received by the
-dialog</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "response" signal is emitted when an action_area widget is
-activated (button "clicked"), the dialog receives a delete_event or the
-application calls the <link
-linkend="method-gtkdialog--response"><methodname>response</methodname>()</link>
-method. When a delete_event triggers the "response" signal the
-<parameter>response_id</parameter> will be
-<literal>gtk.RESPONSE_NONE</literal>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkdrawingarea.xml b/docs/reference/pygtk-gtkdrawingarea.xml
deleted file mode 100644
index 3c7d5536..00000000
--- a/docs/reference/pygtk-gtkdrawingarea.xml
+++ /dev/null
@@ -1,161 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkdrawingarea">
- <refnamediv>
- <refname>gtk.DrawingArea</refname>
- <refpurpose>a widget for custom user interface elements.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.DrawingArea</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkdrawingarea">gtk.DrawingArea</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkdrawingarea">gtk.DrawingArea</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkdrawingarea">
- <title>gtk.DrawingArea Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkdrawingarea">
- <title>gtk.DrawingArea Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkdrawingarea">
- <title>gtk.DrawingArea Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkdrawingarea"><classname>gtk.DrawingArea</classname></link>
-widget is used for creating custom user interface elements. It's essentially
-a blank widget containing a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> that
-you can draw on. The contained <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> is
-accessed using the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "window"
-attribute as:</para>
-
- <programlisting>
- gdkwindow = drawingarea.window
-</programlisting>
-
- <para>Since a <link
- linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
- is a subclass of <link
- linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>,
- all of the <link
- linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
- methods are available for drawing on the <link
- linkend="class-gtkdrawingarea"><classname>gtk.DrawingArea</classname></link>'s
- gdkwindow.</para>
-
- <para>After creating a drawing area, the application may want to
-connect to:</para>
-
- <itemizedlist>
- <listitem>
- <para>Mouse and button press signals to respond to input from the
-user. Use the <link
-linkend="method-gtkwidget--add-events"><methodname>gtk.Widget.add_events</methodname>()</link>
-method to enable events you wish to receive. To receive keyboard events, you
-will need to set the <literal>gtk.CAN_FOCUS</literal> flag on the drawing
-area</para>
- </listitem>
-
- <listitem>
- <para>The "realize" signal to take any necessary actions when the
-widget is instantiated on a particular display.</para>
- </listitem>
-
- <listitem>
- <para>The "configure_event" signal to take any necessary actions
-when the widget changes size.</para>
- </listitem>
-
- <listitem>
- <para>The "expose_event" signal to handle redrawing the contents of
-the widget when a drawing area first comes on screen, or when it's covered by
-another window and then uncovered (exposed). You can also force an expose
-event by adding to the "damage region" of the drawing area's window using
-the <link
-linkend="method-gtkwidget--queue-draw-area"><methodname>gtk.Widget.queue_draw_area</methodname>()</link>
-method.</para>
- </listitem>
- </itemizedlist>
-
- <para>See the <ulink
-url="../pygtk2tutorial/ch-DrawingArea.html">Drawing
-Area</ulink> chapter in the tutorial for more information on using a <link
-linkend="class-gtkdrawingarea"><classname>gtk.DrawingArea</classname></link>.</para>
-
- <para>Sometimes a <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> is a useful
-alternative to a drawing area. You can put a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> in
-the <link linkend="class-gtkimage"><classname>gtk.Image</classname></link>
-and draw to the <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>,
-calling the <link
-linkend="method-gtkwidget--queue-draw"><methodname>gtk.Widget.queue_draw</methodname>()</link>
-method on the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> when you
-want to refresh to the screen.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkdrawingarea">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.DrawingArea</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new drawingarea widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkdrawingarea"><classname>gtk.DrawingArea</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkeditable.xml b/docs/reference/pygtk-gtkeditable.xml
deleted file mode 100644
index fe763c79..00000000
--- a/docs/reference/pygtk-gtkeditable.xml
+++ /dev/null
@@ -1,617 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkeditable">
- <refnamediv>
- <refname>gtk.Editable</refname>
- <refpurpose>an interface for text-editing widgets.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Editable</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--select-region">select_region</link></methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--get-selection-bounds">get_selection_bounds</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--insert-text">insert_text</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--delete-text">delete_text</link></methodname>
- <methodparam><parameter
- role="keyword">start_pos</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end_pos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--get-chars">get_chars</link></methodname>
- <methodparam><parameter
- role="keyword">start_pos</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end_pos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--cut-clipboard">cut_clipboard</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--copy-clipboard">copy_clipboard</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--paste-clipboard">paste_clipboard</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--delete-selection">delete_selection</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--set-position">set_position</link></methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--get-position">get_position</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--set-editable">set_editable</link></methodname>
- <methodparam><parameter
- role="keyword">is_editable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkeditable--get-editable">get_editable</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkeditable">
- <title>gtk.Editable Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkeditable--changed">changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>editable</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkeditable--delete-text">delete-text</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>editable</parameter>
- </methodparam>
- <methodparam><parameter>start</parameter>
- </methodparam>
- <methodparam><parameter>end</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkeditable--insert-text">insert-text</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>editable</parameter>
- </methodparam>
- <methodparam><parameter>new_text</parameter>
- </methodparam>
- <methodparam><parameter>new_text_length</parameter>
- </methodparam>
- <methodparam><parameter>position</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-gtkeditable"><classname>gtk.Editable</classname></link>
- is an interface for text editing widgets, such as <link
- linkend="class-gtkentry"><classname>gtk.Entry</classname></link>. The
- editable class contains methods for generically manipulating an editable
- widget, a large number of action signals used for key bindings, and
- several signals that an application can connect to to modify the
- behavior of a widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkeditable--select-region">
- <title>gtk.Editable.select_region</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_region</methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>the new start position of the
-selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>the new end position of the
-selection</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>select_region</methodname>() method selects a
-region of text from <parameter>start</parameter> up to, but not including
-<parameter>end</parameter>. If <parameter>end</parameter> is negative, then
-the selection will run from <parameter>start</parameter> to the end of the
-text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--get-selection-bounds">
- <title>gtk.Editable.get_selection_bounds</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selection_bounds</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the start and end positions
-of the selection or an empty tuple if there is no
-selection</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_selection_bounds</methodname>() method
-returns a tuple that contains the start and end positions of the selection
-if any or an empty tuple if there is no selection.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--insert-text">
- <title>gtk.Editable.insert_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_text</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the text to be inserted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the position where the text should be
-inserted</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_text</methodname>() method inserts the
-string specified by <parameter>text</parameter> at the location specified by
-<parameter>position</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--delete-text">
- <title>gtk.Editable.delete_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>delete_text</methodname>
- <methodparam><parameter
- role="keyword">start_pos</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end_pos</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">start_pos</parameter>&nbsp;:</term>
- <listitem><simpara>the start position of the text to
-delete</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_pos</parameter>&nbsp;:</term>
- <listitem><simpara>the end position of the text to
-delete</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>delete_text</methodname>() method deletes a
-sequence of characters starting from <parameter>start_pos</parameter> up to,
-but not including <parameter>end_pos</parameter>. If
-<parameter>end_pos</parameter> is negative, then the characters deleted will
-be those characters from <parameter>start_pos</parameter> to the end of the
-text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--get-chars">
- <title>gtk.Editable.get_chars</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_chars</methodname>
- <methodparam><parameter
- role="keyword">start_pos</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end_pos</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">start_pos</parameter>&nbsp;:</term>
- <listitem><simpara>the start position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_pos</parameter>&nbsp;:</term>
- <listitem><simpara>the end position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the characters from start
-to end</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_chars</methodname>() method retrieves a
-string of characters starting from <parameter>start_pos</parameter> up to,
-but not including <parameter>end_pos</parameter>. If
-<parameter>end_pos</parameter> is negative, then all the characters from
-<parameter>start_pos</parameter> to the end of the text are
-retrieved.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--cut-clipboard">
- <title>gtk.Editable.cut_clipboard</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>cut_clipboard</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>cut_clipboard</methodname>() method copies the
-characters in the current selection to the clipboard and then deletes them
-from the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--copy-clipboard">
- <title>gtk.Editable.copy_clipboard</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy_clipboard</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>copy_clipboard</methodname>() method copies the
-characters in the current selection to the clipboard</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--paste-clipboard">
- <title>gtk.Editable.paste_clipboard</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paste_clipboard</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>paste_clipboard</methodname>() method copies the
-contents of the clipboard to the widget at the cursor position.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--delete-selection">
- <title>gtk.Editable.delete_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>delete_selection</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>delete_selection</methodname>() method deletes
-the characters in the selection and releases the selection ownership</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--set-position">
- <title>gtk.Editable.set_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_position</methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the new cursor position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_position</methodname>() method sets the
-cursor position to be just before the character at the location specified by
-<parameter>position</parameter>. If <parameter>position</parameter> is less
-than 0 or greater than the number of characters in the widget the cursor is
-positioned after the last character in the widget. Note
-<parameter>position</parameter> is in characters not bytes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--get-position">
- <title>gtk.Editable.get_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_position</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the cursor position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_position</methodname>() method retrieves the
-cursor position as a character index starting from 0. If the cursor is after
-the last character the position will equal the number of characters in the
-widget. Note <parameter>position</parameter> is in characters not
-bytes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--set-editable">
- <title>gtk.Editable.set_editable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_editable</methodname>
- <methodparam><parameter
- role="keyword">is_editable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">is_editable</parameter>&nbsp;:</term>
- <listitem><simpara>if True the text can be
-edited</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_editable</methodname>() method sets the
-widget "editable" attribute of the widget to the value specified by
-<parameter>is_editable</parameter>. If <parameter>is_editable</parameter> is
-<literal>True</literal> the text can be edited; if <literal>False</literal>,
-the text cannot be edited.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeditable--get-editable">
- <title>gtk.Editable.get_editable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_editable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the text is
-editable.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_editable</methodname>() method retrieves the
-value of the widget "editable" attribute that specifies whether the text is
-editable. See <link
-linkend="method-gtkeditable--set-editable"><methodname>set_editable()</methodname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkeditable--changed">
- <title>The "changed" gtk.Editable Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>editable</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>editable</parameter>&nbsp;:</term>
- <listitem><simpara>the editable that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "changed" signal is emitted when the contents of the widget
-have changed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkeditable--delete-text">
- <title>The "delete-text" gtk.Editable Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>editable</parameter></methodparam>
- <methodparam><parameter>start</parameter></methodparam>
- <methodparam><parameter>end</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>editable</parameter>&nbsp;:</term>
- <listitem><simpara>the editable that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>start</parameter>&nbsp;:</term>
- <listitem><simpara>the start position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>end</parameter>&nbsp;:</term>
- <listitem><simpara>the end position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "delete-text" signal is emitted when text is deleted from
-the widget by the user. The default handler for this signal will normally be
-responsible for deleting the text, so by connecting to this signal and then
-stopping the signal with the <link
-linkend="method-gobject--stop-emission"><methodname>gobject.stop_emission</methodname>()</link>
-method, it is possible to prevent it from being deleted. The
-<parameter>start</parameter> and <parameter>end</parameter> parameters are
-interpreted as for <link
-linkend="method-gtkeditable--delete-text"><methodname>delete_text</methodname>()</link></para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkeditable--insert-text">
- <title>The "insert-text" gtk.Editable Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>editable</parameter></methodparam>
- <methodparam><parameter>new_text</parameter></methodparam>
- <methodparam><parameter>new_text_length</parameter></methodparam>
- <methodparam><parameter>position</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>editable</parameter>&nbsp;:</term>
- <listitem><simpara>the editable that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>new_text</parameter>&nbsp;:</term>
- <listitem><simpara>the string that is being
-inserted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>new_text_length</parameter>&nbsp;:</term>
- <listitem><simpara>the length of the new text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>position</parameter>&nbsp;:</term>
- <listitem><simpara>a pointer to the location at which the new text
-will be inserted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "insert-text" signal is emitted when text is inserted into
-the widget by the user. The default handler for this signal will normally be
-responsible for inserting the text, so by connecting to this signal and then
-stopping the signal with the <link
-linkend="method-gobject--stop-emission"><methodname>gobject.stop_emission</methodname>()</link>
-method, it is possible to prevent it from being inserted entirely. The
-<parameter>position</parameter> parameter is a <link
-linkend="class-gobjectgpointer"><classname>gobject.GPointer</classname></link>
-object containing a pointer to the insertion position - there is no way to
-access the position value from <literal>PyGTK</literal>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkentry.xml b/docs/reference/pygtk-gtkentry.xml
deleted file mode 100644
index 1d77b9a9..00000000
--- a/docs/reference/pygtk-gtkentry.xml
+++ /dev/null
@@ -1,1568 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkentry">
- <refnamediv>
- <refname>gtk.Entry</refname>
- <refpurpose>a single line text entry field.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Entry</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkeditable">gtk.Editable</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcelleditable">gtk.CellEditable</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkentry">gtk.Entry</link></methodname>
- <methodparam><parameter
- role="keyword">max</parameter><initializer>0</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--set-visibility">set_visibility</link></methodname>
- <methodparam><parameter
- role="keyword">visible</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--get-visibility">get_visibility</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--set-invisible-char">set_invisible_char</link></methodname>
- <methodparam><parameter role="keyword">ch</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--get-invisible-char">get_invisible_char</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--set-has-frame">set_has_frame</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--get-has-frame">get_has_frame</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--set-max-length">set_max_length</link></methodname>
- <methodparam><parameter role="keyword">max</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--get-max-length">get_max_length</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--set-activates-default">set_activates_default</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--get-activates-default">get_activates_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--set-width-chars">set_width_chars</link></methodname>
- <methodparam><parameter
- role="keyword">n_chars</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--get-width-chars">get_width_chars</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--set-text">set_text</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--get-text">get_text</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--get-layout">get_layout</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--get-layout-offsets">get_layout_offsets</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--set-alignment">set_alignment</link></methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--get-alignment">get_alignment</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--set-completion">set_completion</link></methodname>
- <methodparam><parameter
- role="keyword">width_chars</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkentry--get-completion">get_completion</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentry--set-inner-border">set_inner_border</link></methodname>
- <methodparam><parameter role="keyword">border</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentry--get-inner-border">get_inner_border</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkentry">gtk.Entry</link> (implements <link linkend="class-gtkeditable">gtk.Editable</link>, <link linkend="class-gtkcelleditable">gtk.CellEditable</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkentry">
- <title>gtk.Entry Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
-
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"activates-default"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> activate the default widget
- (such as the default button in a dialog) when Enter is
- pressed. Default value: <literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"cursor-position"</entry>
- <entry>Read</entry>
- <entry>The current position of the insertion cursor as a
- character index. Allowed values: [0,65535]. Default value:
- 0</entry>
- </row>
-
-
- <row valign="top">
- <entry>"editable"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> the entry contents can be
- edited. Default value: <literal>True</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"has-frame"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>False</literal> removes outside bevel from
- entry. Default value: <literal>True</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"inner-border"</entry>
- <entry>Read/Write</entry>
- <entry>The text area's border between the text and the frame
- as a gtkBorder. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"invisible-char"</entry>
- <entry>Read/Write</entry>
- <entry>The character to use when masking entry contents (when
- "visibility" is <literal>False</literal>). Default value:
- '*'.</entry>
- </row>
-
- <row valign="top">
- <entry>"max-length"</entry>
- <entry>Read/Write</entry>
- <entry>The maximum number of characters for this entry. Zero
- if no maximum. Allowed values: [0,65535] Default value:
- 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"scroll-offset"</entry>
- <entry>Read</entry>
- <entry>The number of pixels of the entry scrolled off the
- screen to the left. Allowed values: >= 0 Default value:
- 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"selection-bound"</entry>
- <entry>Read</entry>
- <entry>The position of the opposite end of the selection from
- the cursor as a character index. Allowed values: [0,65535]
- Default value: 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"text"</entry>
- <entry>Read/Write</entry>
- <entry>The contents of the entry. Default value: "".</entry>
- </row>
-
- <row valign="top">
- <entry>"truncate-multiline"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal>, pasted multi-line text is
- truncated to the first line. Default value:
- <literal>False</literal>. Available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"visibility"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>False</literal> displays the "invisible
- char" instead of the actual text (e.g. password mode). Default
- value: <literal>True</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"width-chars"</entry>
- <entry>Read/Write</entry>
- <entry>The number of characters to leave space for in the
- entry. Allowed values: >= -1. Default value: -1.</entry>
- </row>
-
- <row valign="top">
- <entry>"xalign"</entry>
- <entry>Read/Write</entry>
- <entry>The horizontal alignment ranging from 0.0 to 1.0
- representing the fraction of freespace to the left (right for
- RTL layouts) of the text. Available in GTK+ 2.4 and
- above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkentry">
- <title>gtk.Entry Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"inner-border"</entry>
- <entry>Read</entry>
- <entry>Sets the text area's border between the text and the frame
- This property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkentry">
- <title>gtk.Entry Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkeditable">gtk.Editable Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcelleditable">gtk.CellEditable Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkentry--activate">activate</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>entry</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkentry--backspace">backspace</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>entry</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkentry--copy-clipboard">copy-clipboard</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>entry</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkentry--cut-clipboard">cut-clipboard</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>entry</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkentry--delete-from-cursor">delete-from-cursor</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>entry</parameter>
- </methodparam>
- <methodparam><parameter>delete_type</parameter>
- </methodparam>
- <methodparam><parameter>count</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkentry--insert-at-cursor">insert-at-cursor</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>entry</parameter>
- </methodparam>
- <methodparam><parameter>string</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkentry--move-cursor">move-cursor</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>entry</parameter>
- </methodparam>
- <methodparam><parameter>step_size</parameter>
- </methodparam>
- <methodparam><parameter>count</parameter>
- </methodparam>
- <methodparam><parameter>extend_selection</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkentry--paste-clipboard">paste-clipboard</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>entry</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkentry--populate-popup">populate-popup</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>entry</parameter>
- </methodparam>
- <methodparam><parameter>menu</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkentry--toggle-overwrite">toggle-overwrite</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>entry</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
- linkend="class-gtkentry"><classname>gtk.Entry</classname></link> widget
- is a single line text entry widget. A fairly large set of key bindings
- are supported by default. If the entered text is longer than the
- allocation of the widget, the widget will scroll so that the cursor
- position is visible.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkentry">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Entry</methodname>
- <methodparam><parameter
- role="keyword">max</parameter><initializer>0</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">max</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum length of the entry, or 0 for no
-maximum. (other than the maximum length of entries.) The value passed in
-will be limited to the range 0-65536.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
- linkend="class-gtkentry"><classname>gtk.Entry</classname></link> widget
- with the maximum length specified by <parameter>max</parameter>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkentry--set-visibility">
- <title>gtk.Entry.set_visibility</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visibility</methodname>
- <methodparam><parameter
- role="keyword">visible</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">visible</parameter>&nbsp;:</term>
- <listitem><simpara>If False the contents are obscured using the
-"invisible-char"</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_visibility</methodname>() method sets the
- "visibility" property to the value of
- <parameter>visible</parameter>. If visible is <literal>True</literal>
- the contents of the entry are displayed as plain text. If visible is
- <literal>False</literal>, the contents are obscured by replacing the
- characters with the invisible character (specified by the
- "invisible-char" property). The characters will also be obscured when
- the text in the entry widget is copied elsewhere. The default
- invisible char is the asterisk '*', but it can be changed with <link
- linkend="method-gtkentry--set-invisible-char"><methodname>set_invisible_char</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-visibility">
- <title>gtk.Entry.get_visibility</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visibility</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the text is
-currently visible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visibility</methodname>() method retrieves
- the value of the "visibility" property that determines whether the
- text in <parameter>entry</parameter> is visible. See <link
- linkend="method-gtkentry--set-visibility"><methodname>set_visibility</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--set-invisible-char">
- <title>gtk.Entry.set_invisible_char</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_invisible_char</methodname>
- <methodparam><parameter
- role="keyword">ch</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">ch</parameter>&nbsp;:</term>
- <listitem><simpara>a Unicode character</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_invisible_char</methodname>() method sets
- the "invisible-char" property with the value of
- <parameter>ch</parameter>. The "invisible-char" is the character to
- use in place of the actual text when <link
- linkend="method-gtkentry--set-visibility"><methodname>set_visibility</methodname>()</link>
- has been called to set text visibility to
- <literal>False</literal>. i.e. this is the character used in
- "password mode" to show the user how many characters have been
- typed. The default invisible character is an asterisk ('*'). If you
- set the invisible character to 0, then the user will get no feedback
- at all; there will be no text on the screen as they type.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-invisible-char">
- <title>gtk.Entry.get_invisible_char</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_invisible_char</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current invisible char, or 0, if the entry
-does not show invisible text at all.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The get_invisible_char() method retrieves the value of the
- "invisible-char" property. The "invisible-char" is the character
- displayed in place of the real characters for entries with visibility
- set to <literal>False</literal>. See <link
- linkend="method-gtkentry--set-invisible-char"><methodname>set_invisible_char</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--set-has-frame">
- <title>gtk.Entry.set_has_frame</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_has_frame</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>If True the entry is displayed with a beveled
-frame around it.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_has_frame</methodname>() method sets the
- "has-frame" property to the value of <parameter>setting</parameter>.
- If <parameter>setting</parameter> is <literal>True</literal> the entry
- is displayed with a beveled frame around it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-has-frame">
- <title>gtk.Entry.get_has_frame</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_has_frame</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>whether the entry has a beveled
-frame</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_has_frame</methodname>() method gets the
- value of the "has-frame" property. If "has-frame" is
- <literal>True</literal> the entry will be displayed with a beveled
- frame around it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--set-max-length">
- <title>gtk.Entry.set_max_length</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_max_length</methodname>
- <methodparam><parameter
- role="keyword">max</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">max</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum length of the entry, or 0 for no
- maximum. (other than the maximum length of entries.) The value
- passed in will be clamped to the range
- 0-65536.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_max_length</methodname>() method sets the
- "max-length" property to the value of <parameter>max</parameter>. The
- "max-length" property sets the maximum allowed length of the contents
- of the widget. If the current contents are longer than the given
- length, then they will be truncated to fit. If max is 0 then there is
- no maximum length (other than 65536).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-max-length">
- <title>gtk.Entry.get_max_length</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_max_length</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the maximum allowed number of characters in
-<link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>, or 0
-if there is no maximum.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_max_length</methodname>() method retrieves
- the value of the "max-length" property that specifies the maximum
- allowed length of the text in the entry. See <link
- linkend="method-gtkentry--set-max-length"><methodname>set_max_length</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--set-activates-default">
- <title>gtk.Entry.set_activates_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_activates_default</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> activate the
-window's default widget on an <keycap>Enter</keycap>
-key press</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_activates_default</methodname>() method sets
- the "activates-default" property to the value of
- <parameter>setting</parameter>. If <parameter>setting</parameter> is
- <literal>True</literal>, pressing the <keycap>Enter</keycap> key in
- the entry will activate the default widget for the window containing
- the entry. This usually means that the dialog box containing the
- entry will be closed, since the default widget is usually one of the
- dialog buttons.</para>
-
- <para>(For experts: if <parameter>setting</parameter> is
- <literal>True</literal>, the entry calls <link
- linkend="method-gtkwindow--activate-default"><methodname>gtk.Window.activate_default</methodname>()</link>
- on the window containing the entry, in the default handler for the
- "activate" signal.)</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-activates-default">
- <title>gtk.Entry.get_activates_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_activates_default</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the entry will
-activate the default widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_activates_default</methodname>() method
- retrieves the value of the "activates-default" property which is set
- by <link
- linkend="method-gtkentry--set-activates-default"><methodname>set_activates_default</methodname>()</link>.
- If "activates-default" is <literal>True</literal> pressing the
- <keycap>Enter</keycap> key in the entry will activate the default
- widget for the window containing the entry.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--set-width-chars">
- <title>gtk.Entry.set_width_chars</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_width_chars</methodname>
- <methodparam><parameter
- role="keyword">n_chars</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">n_chars</parameter>&nbsp;:</term>
- <listitem><simpara>width in chars</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_width_chars</methodname>() method sets the
- "width-chars" property to the value of <parameter>n_char</parameter>.
- Setting the "width-chars" property changes the size request of the
- entry to be about the right size for <parameter>n_chars</parameter>
- characters. Note that it only changes the size
- <emphasis>request</emphasis>, the size can still be affected by how
- you pack the widget into containers. If <parameter>n_chars</parameter>
- is -1, the size reverts to the default entry size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-width-chars">
- <title>gtk.Entry.get_width_chars</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_width_chars</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>number of chars to request space for, or
-negative if unset</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_width_chars</methodname>() method gets the
- value of the "width-chars" property which is set by the <link
- linkend="method-gtkentry--set-width-chars"><methodname>set_width_chars</methodname>()</link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--set-text">
- <title>gtk.Entry.set_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>a string to use as the new contents of the
-entry</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_text</methodname>() method sets the "text"
- property to the value of <parameter>text</parameter>. The string in
- <parameter>text</parameter> replaces the current contents of the
- entry.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-text">
- <title>gtk.Entry.get_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the contents of the entry as a
-string</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_text</methodname>() method returns the value
- of the "text" property which is a string containing the contents of
- the entry.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-layout">
- <title>gtk.Entry.get_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_layout</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> for
-this entry</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_layout</methodname>() method gets the <link
- linkend="class-pangolayout"><classname>pango.Layout</classname></link>
- used to display the entry. The layout is useful to e.g. convert text
- positions to pixel positions, in combination with <link
- linkend="method-gtkentry--get-layout-offsets"><methodname>get_layout_offsets</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-layout-offsets">
- <title>gtk.Entry.get_layout_offsets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_layout_offsets</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the X and Y offsets of the
-pango layout</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_layout_offsets</methodname>() method obtains
- the position of the <link
- linkend="class-pangolayout"><classname>pango.Layout</classname></link>
- used to render text in the entry, in widget coordinates and returns it
- as a tuple. This method is used to line up the text in an entry with
- some other text, e.g. when using the entry to implement editable cells
- in a sheet widget. It is also useful to convert mouse events into
- coordinates inside the <link
- linkend="class-pangolayout"><classname>pango.Layout</classname></link>,
- e.g. to take some action if some part of the entry text is
- clicked.</para>
-
- <para>Note that as the user scrolls around in the entry the offsets
- will change; you'll need to connect to the "notify::scroll_offset"
- signal to track this.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--set-alignment">
- <title>gtk.Entry.set_alignment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_alignment</methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">xalign</parameter>&nbsp;:</term>
- <listitem><simpara>The horizontal alignment ranging from 0.0 to
- 1.0 representing the freespace to the left (right for RTL layouts)
- of the text.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_alignment</methodname>() method sets the
- "xalign" property to the value of <parameter>xalign</parameter>. The
- alignment controls the horizontal positioning of the contents when the
- displayed text is shorter than the width of the entry. The value of
- <parameter>xalign</parameter> is the fraction of freespace to the left
- (right in RTL layouts) of the text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-alignment">
- <title>gtk.Entry.get_alignment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_alignment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The horizontal alignment ranging from 0.0 to
- 1.0 representing the freespace to the left (right for RTL layouts)
- of the text.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_alignment</methodname>() method returns the
- value of the "xalign" property which is the fraction of freespace (if
- any) to the left (right in RTL layouts) of the text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--set-completion">
- <title>gtk.Entry.set_completion</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_completion</methodname>
- <methodparam><parameter
- role="keyword">completion</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">completion</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_completion</methodname>() method sets the
- <link
- linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
- specified by <parameter>completion</parameter> to be the auxiliary
- completion object to use with the entry. All further configuration of
- the completion mechanism is done using
- <parameter>completion</parameter> and the <link
- linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
- methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-completion">
- <title>gtk.Entry.get_completion</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_completion</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the auxiliary completion object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_completion</methodname>() method returns the
- <link
- linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
- object currently in use by the entry.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--set-inner-border">
- <title>gtk.Entry.set_inner_border</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_inner_border</methodname>
- <methodparam><parameter role="keyword">border</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">border</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkborder"><classname>gtk.Border</classname></link>,
- or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_inner_border</methodname>() method sets the
- entry's "inner-border" property to the value specified by
- <parameter>border</parameter>, or clears it if <literal>None</literal>
- is passed. The "inner-border" is the area around the entry's text, but
- inside its frame.</para>
-
- <para>If set, this property overrides the inner-border style property.
- Overriding the style-provided border is useful when you want to do
- in-place editing of some text in a canvas or list widget, where
- pixel-exact positioning of the entry is important.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentry--get-inner-border">
- <title>gtk.Entry.get_inner_border</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_inner_border</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the entry's <link
- linkend="class-gtkborder"><classname>gtk.Border</classname></link>,
- or <literal>None</literal> if none was set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_inner_border</methodname>() method returns
- the value of the entry's "inner-border" property. See <link
- linkend="method-gtkentry--set-inner-border"><methodname>set_inner_border</methodname>()</link>
- for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkentry--activate">
- <title>The "activate" gtk.Entry Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>entry</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>entry</parameter>&nbsp;:</term>
- <listitem><simpara>the entry that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "activate" signal is emitted when the entry is activated
- either by user action (pressing the <keycap>Enter</keycap> key) or
- programmatically with the <link
- linkend="method-gtkwidget--activate"><methodname>gtk.Widget.activate</methodname>()</link>
- method</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkentry--backspace">
- <title>The "backspace" gtk.Entry Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>entry</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>entry</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "backspace" signal is emitted when the
- <keysym>Backspace</keysym> key is entered from the keyboard.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkentry--copy-clipboard">
- <title>The "copy-clipboard" gtk.Entry Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>entry</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>entry</parameter>&nbsp;:</term>
- <listitem><simpara>the entry that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "copy-clipboard" signal is emitted when the selection text
- in the entry is copied to the clipboard.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkentry--cut-clipboard">
- <title>The "cut-clipboard" gtk.Entry Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>entry</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>entry</parameter>&nbsp;:</term>
- <listitem><simpara>the entry that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "cut-clipboard" signal is emitted when the selection in the
- entry is cut (removed from the entry) and placed in the
- clipboard.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkentry--delete-from-cursor">
- <title>The "delete-from-cursor" gtk.Entry Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>entry</parameter></methodparam>
- <methodparam><parameter>delete_type</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>entry</parameter>&nbsp;:</term>
- <listitem><simpara>the entry that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>delete_type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of deletion</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of deletions of the type to
-perform</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "delete-from-cursor" signal is emitted when the a deletion
- from the cursor i.e. removal o text at the cursor position, either
- before it (negative <parameter>count</parameter>) or after it
- (positive <parameter>count</parameter>). The value of
- <parameter>delete_type</parameter> can be one of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>gtk.DELETE_CHARS</simpara>
- </listitem>
- <listitem>
- <simpara>gtk.DELETE_WORD_ENDS</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.DELETE_WORDS</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.DELETE_DISPLAY_LINES</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.DELETE_DISPLAY_LINE_ENDS</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.DELETE_PARAGRAPH_ENDS</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.DELETE_PARAGRAPHS</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.DELETE_WHITESPACE</simpara>
- </listitem>
- </itemizedlist>
-
- </refsect2>
-
- <refsect2 id="signal-gtkentry--insert-at-cursor">
- <title>The "insert-at-cursor" gtk.Entry Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>entry</parameter></methodparam>
- <methodparam><parameter>string</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>entry</parameter>&nbsp;:</term>
- <listitem><simpara>the entry that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>string</parameter>&nbsp;:</term>
- <listitem><simpara>the text being inserted in the
-entry</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "insert-at-cursor" signal is emitted when text is being
- inserted in the entry.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkentry--move-cursor">
- <title>The "move-cursor" gtk.Entry Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>entry</parameter></methodparam>
- <methodparam><parameter>step</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>extend_selection</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>entry</parameter>&nbsp;:</term>
- <listitem><simpara>the entry that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>step</parameter>&nbsp;:</term>
- <listitem><simpara>the size of the step to move the
-cursor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of steps to move the
-cursor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>extend_selection</parameter>&nbsp;:</term>
- <listitem><simpara>if True extend the selection as well as moving
-the cursor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-cursor" signal is emitted when the cursor is being
- moved by <parameter>count</parameter> steps of size
- <parameter>step</parameter>. If
- <parameter>extend_selection</parameter> is <literal>True</literal> the
- selection is extended as the cursor is being moved. The value of
- <parameter>step</parameter> can be one of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>gtk.MOVEMENT_LOGICAL_POSITIONS</simpara>
- </listitem>
- <listitem>
- <simpara>gtk.MOVEMENT_VISUAL_POSITIONS</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.MOVEMENT_WORDS</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.MOVEMENT_DISPLAY_LINES</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.MOVEMENT_DISPLAY_LINE_ENDS</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.MOVEMENT_PARAGRAPH_ENDS</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.MOVEMENT_PARAGRAPHS</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.MOVEMENT_PAGES</simpara>
- </listitem>
- <listitem>
- <simpara> gtk.MOVEMENT_BUFFER_ENDS</simpara>
- </listitem>
- </itemizedlist>
-
- </refsect2>
-
- <refsect2 id="signal-gtkentry--paste-clipboard">
- <title>The "paste-clipboard" gtk.Entry Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>entry</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>entry</parameter>&nbsp;:</term>
- <listitem><simpara>the entry that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "paste-clipboard" signal is emitted when the contents of the
- clipboard are pasted into the entry.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkentry--populate-popup">
- <title>The "populate-popup" gtk.Entry Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>entry</parameter></methodparam>
- <methodparam><parameter>menu</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>entry</parameter>&nbsp;:</term>
- <listitem><simpara>the entry that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>menu</parameter>&nbsp;:</term>
- <listitem><simpara>the menu that needs
-populating</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "populate-popup" signal is emitted when the
- <parameter>menu</parameter> needs populating.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkentry--toggle-overwrite">
- <title>The "toggle-overwrite" gtk.Entry Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>entry</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>entry</parameter>&nbsp;:</term>
- <listitem><simpara>the entry that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "toggle-overwrite" signal is emitted when the internal entry
- attribute "overwrite_mode" is toggled by pressing the
- <keycap>Insert</keycap> key.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkentrycompletion.xml b/docs/reference/pygtk-gtkentrycompletion.xml
deleted file mode 100644
index fad28156..00000000
--- a/docs/reference/pygtk-gtkentrycompletion.xml
+++ /dev/null
@@ -1,1148 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkentrycompletion">
- <refnamediv>
- <refname>gtk.EntryCompletion</refname> <refpurpose>completion
- functionality for <link
- linkend="class-gtkentry"><classname>gtk.Entry</classname></link> (new in
- PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.EntryCompletion</classname></ooclass>
- <ooclass><classname><link
- linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <ooclass><classname><link
- linkend="class-gtkcelllayout">gtk.CellLayout</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
- linkend="constructor-gtkentrycompletion">gtk.EntryCompletion</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentrycompletion--get-entry">get_entry</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentrycompletion--set-model">set_model</link></methodname>
- <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentrycompletion--get-model">get_model</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentrycompletion--set-match-func">set_match_func</link></methodname>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>func_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentrycompletion--set-minimum-key-length">set_minimum_key_length</link></methodname>
- <methodparam><parameter role="keyword">length</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentrycompletion--get-minimum-key-length">get_minimum_key_length</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentrycompletion--complete">complete</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentrycompletion--insert-action-text">insert_action_text</link></methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentrycompletion--insert-action-markup">insert_action_markup</link></methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- <methodparam><parameter role="keyword">markup</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentrycompletion--delete-action">delete_action</link></methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkentrycompletion--insert-prefix">insert_prefix</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
- linkend="method-gtkentrycompletion--set-text-column">set_text_column</link></methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
- linkend="method-gtkentrycompletion--get-text-column">get_text_column</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
- linkend="method-gtkentrycompletion--set-inline-completion">set_inline_completion</link></methodname>
- <methodparam><parameter
- role="keyword">inline_completion</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
- linkend="method-gtkentrycompletion--get-inline-completion">get_inline_completion</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
- linkend="method-gtkentrycompletion--set-popup-completion">set_popup_completion</link></methodname>
- <methodparam><parameter
- role="keyword">popup_completion</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
- linkend="method-gtkentrycompletion--get-popup-completion">get_popup_completion</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
- linkend="method-gtkentrycompletion--set-popup-set-width">set_popup_set_width</link></methodname>
- <methodparam><parameter
- role="keyword">popup_set_width</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
- linkend="method-gtkentrycompletion--get-popup-set-width">get_popup_set_width</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
- linkend="method-gtkentrycompletion--set-popup-single-match">set_popup_single_match</link></methodname>
- <methodparam><parameter
- role="keyword">popup_single_match</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
- linkend="method-gtkentrycompletion--get-popup-single-match">get_popup_single_match</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkentrycompletion">gtk.EntryCompletion</link> (implements <link linkend="class-gtkcelllayout">gtk.CellLayout</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkentrycompletion">
- <title>gtk.EntryCompletion Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"inline-completion"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the common prefix should be
- inserted automatically. Default value:
- <literal>False</literal>. Available in GTK+ 2.6 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"minimum-key-length"</entry>
- <entry>Read-Write</entry>
- <entry>Minimum length of the search key in order to look up
- matches. Allowed values >= 0. Default value: 1</entry>
- </row>
-
- <row valign="top">
- <entry>"model"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- to find matches in.</entry>
- </row>
-
- <row valign="top">
- <entry>"popup-completion"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the completions should be
- shown in a popup window. Default value:
- <literal>True</literal>. Available in GTK+ 2.6 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"popup-set-width"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the completions popup window
- will be resized to the width of the entry. Default value:
- <literal>True</literal>. Available in GTK+ 2.8 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"popup-single-match"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the completions popup window
- will be for a single possible completion. Default value:
- <literal>True</literal>. Available in GTK+ 2.8 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"text-column"</entry>
- <entry>Read-Write</entry>
- <entry>The column of the model containing the strings. Allowed
- values: >= -1. Default value: -1. Available in GTK+ 2.6 and
- above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkentrycompletion">
- <title>gtk.EntryCompletion Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkentrycompletion--action-activated">action-activated</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>completion</parameter></methodparam>
- <methodparam><parameter>index</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkentrycompletion--insert-prefix">insert-prefix</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>completion</parameter></methodparam>
- <methodparam><parameter>prefix</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkentrycompletion--match-selected">match-selected</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>completion</parameter></methodparam>
- <methodparam><parameter>model</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para><link
- linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
- is an auxiliary object to be used in conjunction with <link
- linkend="class-gtkentry"><classname>gtk.Entry</classname></link> to
- provide completion functionality. It implements the <link
- linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
- interface, to allow the user to add extra cells to the popup display of
- completions.</para>
-
- <para>To add completion functionality to an entry, use the <link
- linkend="method-gtkentry--set-completion"><methodname>gtk.Entry.set_completion</methodname>()</link>
- method. In addition to regular completion matches, that will be
- inserted into the entry when they are selected, <link
- linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
- also allows "actions" to be displayed in the popup window below any
- completions. Their appearance is similar to menuitems, to differentiate
- them clearly from completion strings. When an action is selected, the
- "action-activated" signal is emitted.</para>
-
- <para>A <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- (e.g. a <link
- linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>)
- containing the completion strings is associated with the <link
- linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
- using the <link
- linkend="method-gtkentrycompletion--set-model"><methodname>set_model</methodname>()</link>
- method. The tree model column containing the completion strings can be
- set using the convenience method <link
- linkend="method-gtkentrycompletion--set-text-column"><methodname>set_text_column</methodname>()</link>
- that also creates a <link
- linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
- and packs it into the entry completion.</para>
-
- <para>Otherwise, you can create <link
- linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
- objects and pack them into the <link
- linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
- using the <link
- linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
- methods <link
- linkend="method-gtkcelllayout--pack-start"><methodname>gtk.CellLayout.pack_start</methodname>()</link>
- or <link
- linkend="method-gtkcelllayout--pack-start"><methodname>gtk.CellLayout.pack_start</methodname>()</link>. However,
- you will also have to define a match function and set it with the <link
- linkend="method-gtkentrycompletion--set-match-func"><methodname>set_match_func</methodname>()</link>
- method.</para>
-
- <para>If you wanted to create a completion list with the strings to
- insert and some additional info e.g. an icon or description you could do
- something like:</para>
-
- <programlisting>
- entry = gtk.Entry()
- completion = gtk.EntryCompletion()
- entry.set_completion(completion)
- liststore = gtk.ListStore(gobject.TYPE_STRING, gtk.gdk.Pixbuf)
- completion.set_model(liststore)
- pixbufcell = gtk.CellRendererPixbuf()
- completion.pack_start(pixbufcell)
- completion.add_attribute(pixbufcell, 'pixbuf', 1)
- # create a gtk.CellRendererText and pack it in the completion. Also set the
- # 'text' attribute
- completion.set_text_column(0)
- # load up the liststore with string - pixbuf data - assuming pixbuf created
- liststore.append(['string text', pixbuf])
-</programlisting>
-
- <para>This will create an entry that will display a pixbuf and the text
- string during completion.</para>
-
- <para>Actions are easily managed using the <link
- linkend="method-gtkentrycompletion--insert-action-text"><methodname>insert_action_text</methodname>()</link>,
- <link
- linkend="method-gtkentrycompletion--insert-action-markup"><methodname>insert_action_markup</methodname>()</link>
- and <link
- linkend="method-gtkentrycompletion--delete-action"><methodname>delete_action</methodname>()</link>
- methods.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkentrycompletion">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.EntryCompletion</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A newly created <link linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link> object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkentrycompletion--get-entry">
- <title>gtk.EntryCompletion.get_entry</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_entry</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The <link
- linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
- that the completion is attached to.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_entry</methodname>() method retrieves the
-<link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> that
-the entry completion is attached to.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--set-model">
- <title>gtk.EntryCompletion.set_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_model</methodname>
- <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">model</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- to use with the entry completion.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_model</methodname>() method sets the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-specified by <parameter>model</parameter> to be used with the entry
-completion. A previously set model will be removed before the new model
-is set. If <parameter>model</parameter> is <literal>None</literal> or not
-specified, the old model will be unset.</para>
-
- <note>
- <para>In PyGTK 2.4.0 the model could not be <literal>None</literal>
-and did not default to <literal>None</literal>.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--get-model">
- <title>gtk.EntryCompletion.get_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_model</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The current <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>,
- or <literal>None</literal> if not set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_model</methodname>() method returns the
-<link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-that the entry completion is using as data source. Returns
-<literal>None</literal> if the model is unset.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--set-match-func">
- <title>gtk.EntryCompletion.set_match_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_match_func</methodname>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>func_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>func</parameter>&nbsp;:</term>
- <listitem><simpara>A function to be used.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>func_data</parameter>&nbsp;:</term>
- <listitem><simpara>The user data for <parameter>func</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_match_func</methodname>() method sets the
-match function specified by <parameter>func</parameter>. The match function
-is used by the entry completion to determine if a row of the associated tree
-model should be in the completion list.</para>
-
- <para>The signature of the match function is:</para>
-
- <programlisting>
- def match_func(completion, key_string, iter, func_data):
-</programlisting>
-
- <para>where <parameter>completion</parameter> is the <link
-linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>
-that the match function is invoked on, <parameter>key_string</parameter> is
-the current contents of the <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> to be
-matched, <parameter>iter</parameter> is a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at a row in the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-associated with completion and <parameter>func_data</parameter> is the data
-specified when the <link
-linkend="method-gtkentrycompletion--set-match-func"><methodname>set_match_func</methodname>()</link>
-method was called. The match function should return <literal>True</literal>
-if the completion string should be displayed; otherwise,
-<literal>False</literal>.</para>
-
- <para>A simple example match function is:</para>
-
- <programlisting>
- # Assumes that the func_data is set to the number of the text column in the
- # model.
- def match_func(completion, key, iter, column):
- model = completion.get_model()
- text = model.get_value(iter, column)
- if text.startswith(key):
- return True
- return False
-</programlisting>
-
- <para>You must use the <link
-linkend="method-gtkentrycompletion--set-match-func"><methodname>set_match_func</methodname>()</link>
-method to display completions if you don't use the <link
-linkend="method-gtkentrycompletion--set-text-column"><methodname>set_text_column</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--set-minimum-key-length">
- <title>gtk.EntryCompletion.set_minimum_key_length</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_minimum_key_length</methodname>
- <methodparam><parameter role="keyword">length</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">length</parameter>&nbsp;:</term>
- <listitem><simpara>The minimum length of the key string in order
- to start completing.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_minimum_key_length</methodname>() method
-sets the minimum length of the search key to the value specified by
-<parameter>length</parameter>. This means that the key string (contents of
-the <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>)
-must be at least <parameter>length</parameter> characters before a
-completion list will be displayed. This is useful for long lists, where
-completing using a small key will take too much time and will likely return
-too large a dataset.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--get-minimum-key-length">
- <title>gtk.EntryCompletion.get_minimum_key_length</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_minimum_key_length</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The currently used minimum key
- length.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_minimum_key_length</methodname>() method
-returns the minimum key length set for the entry completion. See the
-<link
-linkend="method-gtkentrycompletion--set-minimum-key-length"><methodname>set_minimum_key_length</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--complete">
- <title>gtk.EntryCompletion.complete</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>complete</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>complete</methodname>() method requests a
-completion operation, i.e. a refiltering of the current list
-with completions, using the current key. The completion list view will be
-updated accordingly.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--insert-action-text">
- <title>gtk.EntryCompletion.insert_action_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_action_text</methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- <methodparam><parameter role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>The index in the action list where the item
- should be inserted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>The text of the item to
- insert.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>insert_action_text</methodname>() method inserts
-an action in the action item list of the entry completion at the position
-specified by <parameter>index</parameter> with the text specified by
-<parameter>text</parameter>. If you want the action item to have markup, use
-the <link
-linkend="method-gtkentrycompletion--insert-action-markup"><methodname>gtk.EntryCompletion.insert_action_markup()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--insert-action-markup">
- <title>gtk.EntryCompletion.insert_action_markup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_action_markup</methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- <methodparam><parameter role="keyword">markup</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>The index in the action list where the item
- should be inserted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">markup</parameter>&nbsp;:</term>
- <listitem><simpara>The Pango markup of the item to
- insert.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>insert_action_markup</methodname>() method
-inserts an action item in the action item list of the entry completion at
-the position specified by <parameter>index</parameter> with the Pango markup
-specified by <parameter>markup</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--delete-action">
- <title>gtk.EntryCompletion.delete_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>delete_action</methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>The index of the item to
- delete.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>delete_action</methodname>() method deletes the
-action item at the position in the action item list specified by
-<parameter>index</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--insert-prefix">
- <title>gtk.EntryCompletion.insert_prefix</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_prefix</methodname>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>insert_prefix</methodname>() method requests a
-prefix insertion.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--set-text-column">
- <title>gtk.EntryCompletion.set_text_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text_column</methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>The column in the model to get strings
- from.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_text_column</methodname>() method is a
-convenience method for setting up the most common completion scenario: a
-completion list with just strings. This method creates and adds a <link
-linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
-using the column specified by <parameter>column</parameter> as the source
-for completion strings. If you don't use this method you will have to
-install a <link
-linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
-in the entry completion and set a match function using the <link
-linkend="method-gtkentrycompletion--set-match-func"><methodname>set_match_func</methodname>()</link>
-method to display the completion strings. In GTK+ 2.6 the "text-column"
-property is set to the value of <parameter>column</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--get-text-column">
- <title>gtk.EntryCompletion.get_text_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text_column</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The column containing the text
-strings.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_text_column</methodname>() method returns
-the value of the "text-column" property. The "text-column" property contains
-the index of the column in the completion model to get strings from. See the
-<link
-linkend="method-gtkentrycompletion--set-text-column"><methodname>set_text_column</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--set-inline-completion">
- <title>gtk.EntryCompletion.set_inline_completion</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_inline_completion</methodname>
- <methodparam><parameter role="keyword">inline_completion</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">inline_completion</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> do inline
-completion</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_inline_completion</methodname>() method sets
-the "inline-completion" property to the value of
-<parameter>inline_completion</parameter>. If
-<parameter>inline_completion</parameter> is <literal>True</literal>, the
-common prefix of the possible completions should be automatically inserted
-in the entry.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--get-inline-completion">
- <title>gtk.EntryCompletion.get_inline_completion</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_inline_completion</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if automatic inline
-completion is enabled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_inline_completion</methodname>() method
-returns the value of the "inline-completion" property. If the value of the
-"inline-completion" property is <literal>True</literal> the common prefix of
-possible completions is automatically inserted in the entry.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--set-popup-completion">
- <title>gtk.EntryCompletion.set_popup_completion</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_popup_completion</methodname>
- <methodparam><parameter role="keyword">popup_completion</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">popup_completion</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> do popup
-completion.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_popup_completion</methodname>() method sets
-the "popup-completion" property to the value of
-<parameter>popup_completion</parameter>. If
-<parameter>popup_completion</parameter> is <literal>True</literal> the
-completions should be presented in a popup window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--get-popup-completion">
- <title>gtk.EntryCompletion.get_popup_completion</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_popup_completion</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if completions should
-be displayed in a popup.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_popup_completion</methodname>() method
-returns the value of the "popup-completion" property. If the value of
-"popup-completion" property is <literal>True</literal> the completions
-should be presented in a popup window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--set-popup-set-width">
- <title>gtk.EntryCompletion.set_popup_set_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_popup_set_width</methodname>
- <methodparam><parameter role="keyword">popup_set_width</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">popup_set_width</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> the completions
-popup window will be resized to the width of the
-completion.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_popup_set_width</methodname>() method sets
-the "popup-set-width" property to the value of
-<parameter>popup_set_width</parameter>. If
-<parameter>popup_set_width</parameter> is <literal>True</literal> the
-completions popup window will be resized to the width of the completion.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--get-popup-set-width">
- <title>gtk.EntryCompletion.get_popup_set_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_popup_set_width</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the completions popup
-window will be resized to the width of the completion.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_popup_set_width</methodname>() method
-returns the value of the "popup-set-width" property. If the value of
-"popup-set-width" property is <literal>True</literal> the completions popup
-window will be resized to the width of the completion.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--set-popup-single-match">
- <title>gtk.EntryCompletion.set_popup_single_match</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_popup_single_match</methodname>
- <methodparam><parameter role="keyword">popup_single_match</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">popup_single_match</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> the completions popup
-window will appear even for a single match.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_popup_single_match</methodname>() method
-sets the "popup-single-match" property to the value of
-<parameter>popup_single_match</parameter>. If
-<parameter>popup_single_match</parameter> is <literal>True</literal> the
-completions popup window will appear even for a single match.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkentrycompletion--get-popup-single-match">
- <title>gtk.EntryCompletion.get_popup_completion</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_popup_single_match</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the completions popup
-window should appear even for a single match.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_popup_single_match</methodname>() method
-returns the value of the "popup-single-match" property. If the value of
-"popup-single-match" property is <literal>True</literal> the completions
-popup window should appear even for a single match.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkentrycompletion--action-activated">
- <title>The "action-activated" gtk.EntryCompletion Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>completion</parameter></methodparam>
- <methodparam><parameter>index</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>completion</parameter>&nbsp;:</term>
- <listitem><simpara>the entry completion that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the action item that was
- activated.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "action-activated" signal is emitted when an action item is
-selected from the popup action list.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkentrycompletion--insert-prefix">
- <title>The "insert-prefix" gtk.EntryCompletion Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>completion</parameter></methodparam>
- <methodparam><parameter>prefix</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>completion</parameter>&nbsp;:</term>
- <listitem><simpara>the entry completion that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>prefix</parameter>&nbsp;:</term>
- <listitem><simpara> the common prefix of all possible
-completions</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.6 and above.</para>
- </note>
-
- <para>The "insert-prefix" signal is emitted when the inline
-auto-completion is triggered. The default behavior is to make the entry
-display the whole prefix and select the newly inserted part.</para>
-
- <para>Applications may connect to this signal in order to insert only
-a smaller part of the prefix into the entry - e.g. the entry used in the
-<link
-linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
-inserts only the part of the prefix up to the next '/'.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkentrycompletion--match-selected">
- <title>The "match-selected" gtk.EntryCompletion Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>completion</parameter></methodparam>
- <methodparam><parameter>model</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>completion</parameter>&nbsp;:</term>
- <listitem><simpara>the entry completion that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>model</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- that <parameter>iter</parameter> points into.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- pointing at the selection completion string row in
- <parameter>model</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "match-selected" signal is emitted when a completion string
-was selected from the completion list. <parameter>iter</parameter> points at
-the row in <parameter>model</parameter> that contains the completion
-string.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkeventbox.xml b/docs/reference/pygtk-gtkeventbox.xml
deleted file mode 100644
index 83a34a3d..00000000
--- a/docs/reference/pygtk-gtkeventbox.xml
+++ /dev/null
@@ -1,283 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkeventbox">
- <refnamediv>
- <refname>gtk.EventBox</refname>
- <refpurpose>a widget used to catch events for widgets which do not have
-their own window.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.EventBox</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkeventbox">gtk.EventBox</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkeventbox--get-visible-window">get_visible_window</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkeventbox--set-visible-window">set_visible_window</link></methodname>
- <methodparam><parameter>visible_window</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkeventbox--get-above-child">get_above_child</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkeventbox--set-above-child">set_above_child</link></methodname>
- <methodparam><parameter>above_child</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkeventbox">gtk.EventBox</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkeventbox">
- <title>gtk.EventBox Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"above-child"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the event-trapping window
- of the eventbox is above the window of the child widget as
- opposed to below it. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"visible-window"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the event box is visible,
- as opposed to invisible and only used to trap
- events. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkeventbox">
- <title>gtk.EventBox Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkeventbox">
- <title>gtk.EventBox Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link>
-widget is an invisible container widget that provides a window for widgets
-that do not have their own window. In GTK, widgets must have a window to be
-able to receive event signals. Those widgets that are "windowless" can use a
-<link linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link>
-to receive event signals.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkeventbox">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.EventBox</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an eventbox widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkeventbox--get-visible-window">
- <title>gtk.EventBox.get_visible_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_window</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the event box window is
-visible.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>gtk_visible_window</methodname>() method returns
-<literal>True</literal> if the event box has a visible window. See the <link
-linkend="method-gtkeventbox--set-visible-window"><methodname>set_visible_window()</methodname></link> method
-for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeventbox--set-visible-window">
- <title>gtk.EventBox.set_visible_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible_window</methodname>
- <methodparam><parameter>visible_window</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>visible_window</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the event box window is
-visible.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_visible_window</methodname>() method sets
-whether the event box uses a visible or invisible child window according to
-the value specified by <parameter>visible_window</parameter>. If
-<parameter>visible_window</parameter> is <literal>True</literal> the event
-box uses a visible child window; otherwise, an invisible child window. The
-default is to use visible windows.</para>
-
- <para>In an invisible window event box, the window that that the event
-box creates is a <literal>gtk.gdk.INPUT_ONLY</literal> window, that is
-invisible and only serves to receive events. A visible window event box
-creates a visible (<literal>gtk.gdk.INPUT_OUTPUT</literal>) window that acts
-as the parent window for all the widgets contained in the event box.</para>
-
- <para>You should generally make your event box invisible if you just
-want to trap events. Creating a visible window may cause artifacts that are
-visible to the user, especially if the user is using a theme with gradients
-or pixmaps. The main reason to create a non input-only event box is if you
-want to set the background to a different color or draw on it.</para>
-
- <note>
- <para>There is one unexpected issue for an invisible event box that
-has its window below the child. (See the <link
-linkend="method-gtkeventbox--set-above-child"><methodname>set_above_child()</methodname></link>
-method.) Since the input-only window is not an ancestor window of any
-windows that descendant widgets of the event box create, events on these
-windows aren't propagated up by the windowing system, but only by GTK+. The
-practical effect of this is if an event isn't in the event mask for the
-descendant window (see the <link
-linkend="method-gtkwidget--add-events"><methodname>gtk.Widget.add_events()</methodname></link>
-method), it won't be received by the event box.</para>
-
- <para> This problem doesn't occur for visible event boxes, because
-the event box window is actually the ancestor of the descendant windows, not
-just at the same place on the screen.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkeventbox--get-above-child">
- <title>gtk.EventBox.get_above_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_above_child</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the event box window is
-above the window of its child.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_above_child</methodname>() method returns
-the value of the "above-child" property that indicates whether the event box
-window is above or below the windows of its child. See the <link
-linkend="method-gtkeventbox--set-above-child"><methodname>set_above_child()</methodname></link>
-method for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkeventbox--set-above-child">
- <title>gtk.EventBox.set_above_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_above_child</methodname>
- <methodparam><parameter>above_child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>above_child</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the event box window is
-above the windows of its child</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_above_child</methodname>() method sets the
-"above-child" property to the value of
-<parameter>above_child</parameter>. If <parameter>above_child</parameter> is
-<literal>True</literal>, the event box window is positioned above the
-windows of its child; otherwise, below it. If the window is above, all
-events inside the event box will go to the event box. If the window is
-below, events in windows of child widgets will first got to that widget, and
-then to its parents. The default is to keep the window below the child.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkexpander.xml b/docs/reference/pygtk-gtkexpander.xml
deleted file mode 100644
index 22ddc690..00000000
--- a/docs/reference/pygtk-gtkexpander.xml
+++ /dev/null
@@ -1,713 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkexpander">
- <refnamediv>
- <refname>gtk.Expander</refname> <refpurpose>a container that can hide
- its child (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Expander</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkexpander">gtk.Expander</link></methodname>
- <methodparam><parameter role="keyword">label</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--set-expanded">set_expanded</link></methodname>
- <methodparam><parameter role="keyword">expanded</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--get-expanded">get_expanded</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--set-spacing">set_spacing</link></methodname>
- <methodparam><parameter role="keyword">spacing</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--get-spacing">get_spacing</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--set-label">set_label</link></methodname>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--get-label">get_label</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--set-use-underline">set_use_underline</link></methodname>
- <methodparam><parameter role="keyword">use_underline</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--get-use-underline">get_use_underline</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--set-use-markup">set_use_markup</link></methodname>
- <methodparam><parameter role="keyword">use_markup</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--get-use-markup">get_use_markup</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--set-label-widget">set_label_widget</link></methodname>
- <methodparam><parameter role="keyword">label_widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkexpander--get-label-widget">get_label_widget</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--expander-new-with-mnemonic">gtk.expander_new_with_mnemonic</link></methodname>
- <methodparam><parameter role="keyword">label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkexpander">gtk.Expander</link>
-</synopsis>
-
- <refsect1 id="properties-gtkexpander">
- <title>gtk.Expander Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"expanded"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the expander has been
-opened to reveal the child widget.</entry>
- </row>
-
- <row valign="top">
- <entry>"label"</entry>
- <entry>Read-Write</entry>
- <entry>The text of the expander's label.</entry>
- </row>
-
- <row valign="top">
- <entry>"label-widget"</entry>
- <entry>Read-Write</entry>
- <entry>A widget to display in place of the usual expander
-label.</entry>
- </row>
-
- <row valign="top">
- <entry>"spacing"</entry>
- <entry>Read-Write</entry>
- <entry>The space to put between the label and the child.</entry>
- </row>
-
- <row valign="top">
- <entry>"use-markup"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the text of the label
-includes Pango markup. See the <link
-linkend="function-pango--parse-markup"><function>pango.parse_markup</function>()</link>
-function.</entry>
- </row>
-
- <row valign="top">
- <entry>"use-underline"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, n underline in the text
-indicates the next character should be used for the mnemonic accelerator
-key.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkexpander">
- <title>gtk.Expander Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"expander-size"</entry>
- <entry>Read</entry>
- <entry>The size of the expander arrow.</entry>
- </row>
-
- <row valign="top">
- <entry>"expander-spacing"</entry>
- <entry>Read</entry>
- <entry>The spacing around expander arrow.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkexpander">
- <title>gtk.Expander Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkexpander--activate">activate</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>expander</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
- linkend="class-gtkexpander"><classname>gtk.Expander</classname></link>
- allows the user to hide or show its child by clicking on an expander
- triangle similar to the triangles used in a <link
- linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>.</para>
-
- <para>Normally you use an expander as you would use any other descendant
- of <link linkend="class-gtkbin"><classname>gtk.Bin</classname></link>;
- you create the child widget and use <link
- linkend="method-gtkcontainer--add"><methodname>gtk.Container.add</methodname>()</link>
- to add it to the expander. When the expander is toggled, it will take
- care of showing and hiding the child automatically.</para>
-
- <refsect2 id="expander-description-special-usage">
- <title>Special Usage</title>
-
- <para>There there are situations in which you may prefer to show and
- hide the expanded widget yourself, such as when you want to actually
- create the widget at expansion time. In this case, create a <link
- linkend="class-gtkexpander"><classname>gtk.Expander</classname></link>
- but do not add a child to it. The expander widget has the "expanded"
- property that can be used to monitor its expansion state. You should
- watch this property with a signal connection as follows:</para>
-
- <programlisting>
- expander = gtk.expander_new_with_mnemonic("_More Options")
- expander.connect("notify::expanded", expander_callback)
-
- ...
-
- def expander_callback(expander, param_spec, user_data):
- if expander.get_expanded():
- # Show or create widgets
- else:
- # Hide or destroy widgets
-</programlisting>
-
- <para>The "activate" signal can also be used to track the expansion
- though it occurs before the "expanded" property is changed so the
- logic of the <function>expander_callback</function>() function would
- have to be reversed.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkexpander">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Expander</methodname>
- <methodparam><parameter role="keyword">label</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>the text of the label or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link linkend="class-gtkexpander"><classname>gtk.Expander</classname></link> widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new expander using <parameter>label</parameter> as the
-text of the label. If <parameter>label</parameter> is
-<literal>None</literal> or not specified, no label will be created.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkexpander--set-expanded">
- <title>gtk.Expander.set_expanded</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_expanded</methodname>
- <methodparam><parameter role="keyword">expanded</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">expanded</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the child widget is
-revealed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_expanded</methodname>() method sets the
-"expanded" property to the value of <parameter>expanded</parameter>. If
-<parameter>expanded</parameter> is <literal>True</literal>, the child widget
-is revealed; if <literal>False</literal>, the child widget is hidden.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkexpander--get-expanded">
- <title>gtk.Expander.get_expanded</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_expanded</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the child is
-revealed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_expanded</methodname>() method returns the
-value of the "expanded" property. If "expanded" is <literal>True</literal>
-the child widget is revealed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkexpander--set-spacing">
- <title>gtk.Expander.set_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_spacing</methodname>
- <methodparam><parameter role="keyword">spacing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
- <listitem><simpara>the distance between the expander and child
-in pixels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_spacing</methodname>() method sets the
-"spacing" property to the value of <parameter>spacing</parameter> that sets
-is the number of pixels to place between expander and the child.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkexpander--get-spacing">
- <title>gtk.Expander.get_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_spacing</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the spacing between the expander and
-child.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_spacing</methodname>() method returns the
-value of the "spacing" property set by the <link
-linkend="method-gtkexpander--set-spacing"><methodname>set_spacing()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkexpander--set-label">
- <title>gtk.Expander.set_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_label</methodname>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string to use as the label or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_label</methodname>() method sets the "label"
-property to the value of <parameter>label</parameter> and sets the text of
-the label of the expander. Any previously set label will be cleared. If
-<parameter>label</parameter> is <literal>None</literal> the expander will
-have no label.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkexpander--get-label">
- <title>gtk.Expander.get_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_label</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the text of the label widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_label</methodname>() method returns the
-value of the "label" property that contains the text of the expander label,
-as set by the <link
-linkend="method-gtkexpander--set-label"><methodname>set_label()</methodname></link>
-method. If the label text has not been set the return value will be
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkexpander--set-use-underline">
- <title>gtk.Expander.set_use_underline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_underline</methodname>
- <methodparam><parameter role="keyword">use_underline</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">use_underline</parameter>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if underlines in the
-text indicate mnemonics</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_use_underline</methodname>() method sets the
-"use_underline" property to the value of
-<parameter>use_underline</parameter>. If
-<parameter>use_underline</parameter> is <literal>True</literal>, an
-underline in the text of the expander label indicates the next character
-should be used for the mnemonic accelerator key.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkexpander--get-use-underline">
- <title>gtk.Expander.get_use_underline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_underline</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if an embedded
-underline in the expander label indicates the mnemonic accelerator
-keys.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_use_underline</methodname>() method returns
-the value of the "use-underline" property. If "use-underline" is
-<literal>True</literal> an embedded underline in the expander label
-indicates a mnemonic. See the <link
-linkend="method-gtkexpander--set-use-underline"><methodname>set_use_underline()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkexpander--set-use-markup">
- <title>gtk.Expander.set_use_markup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_markup</methodname>
- <methodparam><parameter role="keyword">use_markup</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">use_markup</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the label's text
-should be parsed for markup</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_use_markup</methodname>() method sets the
-"use-markup" property to the value of <parameter>use_markup</parameter>. If
-<parameter>use_markup</parameter> is <literal>True</literal> the text of the
-label contains markup in the <link linkend="pango-markup-language">Pango
-text markup language</link>. See the <link
-linkend="method-gtklabel--set-markup"><methodname>gtk.Label.set_markup()</methodname></link> method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkexpander--get-use-markup">
- <title>gtk.Expander.get_use_markup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_markup</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the label's text
-will be parsed for markup</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_use_markup</methodname>() method returns the
-value of the "use-markup" property. If "use-markup" is
-<literal>True</literal>, the label's text is interpreted as marked up with
-the <link linkend="pango-markup-language">Pango text markup
-language</link>. See the <link
-linkend="method-gtkexpander--set-use-markup"><methodname>set_use_markup()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkexpander--set-label-widget">
- <title>gtk.Expander.set_label_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_label_widget</methodname>
- <methodparam><parameter role="keyword">label_widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label_widget</parameter>&nbsp;:</term>
- <listitem><simpara>the new label widget or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_label_widget</methodname>() method sets the
-expander to use the widget specified by <parameter>label_widget</parameter>
-as the label instead of a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link>. This
-widget appears embedded alongside the expander arrow. If
-<parameter>label_widget</parameter> is <literal>None</literal>, the expander
-will have no label.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkexpander--get-label-widget">
- <title>gtk.Expander.get_label_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_label_widget</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the label widget, or <literal>None</literal>
-if there is none.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_label_widget</methodname>() method retrieves
-the expander's label widget. See the <link
-linkend="method-gtkexpander--set-label-widget"><methodname>set_label_widget()</methodname></link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--expander-new-with-mnemonic">
- <title>gtk.expander_new_with_mnemonic</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.expander_new_with_mnemonic</methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara> the text of the label with an underscore in
-front of the mnemonic character or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> a new <link
-linkend="class-gtkexpander"><classname>gtk.Expander</classname></link> widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.expander_new_with_mnemonic</function>()
-function creates a new <link
-linkend="class-gtkexpander"><classname>gtk.Expander</classname></link> using
-<parameter>label</parameter> as the text of the label. If characters in
-<parameter>label</parameter> are preceded by an underscore, they are
-underlined. If you need a literal underscore character in a label, use '__'
-(two underscores). The first underlined character represents a keyboard
-accelerator called a mnemonic. Pressing <keycap>Alt</keycap> with that key
-activates the button. If <parameter>label</parameter> is
-<literal>None</literal> the expander will have no label.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkexpander--activate">
- <title>The "activate" gtk.Expander Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>expander</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>expander</parameter>&nbsp;:</term>
- <listitem><simpara>the expander that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "activate" signal is emitted when the expander is activated
- by the user clicking on the expander toggle. Using the
- "notify:expanded" signal may be more appropriate in some cases as
- noted in the <link
- linkend="expander-description-special-usage">Special Usage
- description</link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkfilechooser.xml b/docs/reference/pygtk-gtkfilechooser.xml
deleted file mode 100644
index 68aca1c3..00000000
--- a/docs/reference/pygtk-gtkfilechooser.xml
+++ /dev/null
@@ -1,2415 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkfilechooser">
- <refnamediv>
- <refname>gtk.FileChooser</refname>
- <refpurpose>an interface for choosing files used by <link
- linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>
- and <link
- linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
- (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.FileChooser</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-action">set_action</link></methodname>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-action">get_action</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-local-only">set_local_only</link></methodname>
- <methodparam><parameter role="keyword">local_only</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-local-only">get_local_only</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-select-multiple">set_select_multiple</link></methodname>
- <methodparam><parameter role="keyword">select_multiple</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-select-multiple">get_select_multiple</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-current-name">set_current_name</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-filename">get_filename</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-filename">set_filename</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--select-filename">select_filename</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--unselect-filename">unselect_filename</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--select-all">select_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--unselect-all">unselect_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-filenames">get_filenames</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-current-folder">set_current_folder</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-current-folder">get_current_folder</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-uri">get_uri</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-uri">set_uri</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--select-uri">select_uri</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--unselect-uri">unselect_uri</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-uris">get_uris</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-current-folder-uri">set_current_folder_uri</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-current-folder-uri">get_current_folder_uri</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-preview-widget">set_preview_widget</link></methodname>
- <methodparam><parameter role="keyword">preview_widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-preview-widget">get_preview_widget</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-preview-widget-active">set_preview_widget_active</link></methodname>
- <methodparam><parameter role="keyword">active</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-preview-widget-active">get_preview_widget_active</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-use-preview-label">set_use_preview_label</link></methodname>
- <methodparam><parameter role="keyword">use_label</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-use-preview-label">get_use_preview_label</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-preview-filename">get_preview_filename</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-preview-uri">get_preview_uri</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-extra-widget">set_extra_widget</link></methodname>
- <methodparam><parameter role="keyword">extra_widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-extra-widget">get_extra_widget</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--add-filter">add_filter</link></methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--remove-filter">remove_filter</link></methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--list-filters">list_filters</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-filter">set_filter</link></methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-filter">get_filter</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--add-shortcut-folder">add_shortcut_folder</link></methodname>
- <methodparam><parameter role="keyword">folder</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--remove-shortcut-folder">remove_shortcut_folder</link></methodname>
- <methodparam><parameter role="keyword">folder</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--list-shortcut-folders">list_shortcut_folders</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--add-shortcut-folder-uri">add_shortcut_folder_uri</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--remove-shortcut-folder-uri">remove_shortcut_folder_uri</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--list-shortcut-folder-uris">list_shortcut_folder_uris</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-show-hidden">set_show_hidden</link></methodname>
- <methodparam><parameter role="keyword">show_hidden</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-show-hidden">get_show_hidden</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--set-do-overwrite-confirmation">set_do_overwrite_confirmation</link></methodname>
- <methodparam><parameter role="keyword">do_overwrite_confirmation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooser--get-do-overwrite-confirmation">get_do_overwrite_confirmation</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkfilechooser">
- <title>gtk.FileChooser Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"action"</entry>
- <entry>Read-Write</entry>
- <entry>The type of operation that the file selector is
- performing - one of the <xref
- linkend="gtk-filechooser-action-constants"
- endterm="gtk-filechooser-action-constants-title"></xref>. Default
- value: <literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"do-overwrite-confirmation"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> a file chooser in
- <literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal> will present
- an overwrite confirmation dialog if the user selects a file
- name that already exists. Default value:
- <literal>False</literal>. This property is available in GTK+
- 2.8 and above</entry>
- </row>
-
- <row valign="top">
- <entry>"extra-widget"</entry>
- <entry>Read-Write</entry>
- <entry>An application supplied widget for extra options.</entry>
- </row>
-
- <row valign="top">
- <entry>"file-system-backend"</entry>
- <entry>Write-Construct</entry>
- <entry>The name of the file system backend to use.
-Default value: <literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"filter"</entry>
- <entry>Read-Write</entry>
- <entry>The current <link
-linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link>
-for selecting which files are displayed.</entry>
- </row>
-
- <row valign="top">
- <entry>"local-only"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, the selected file(s) should
-be limited to local file: URLs. Default value: <literal>True</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"preview-widget"</entry>
- <entry>Read-Write</entry>
- <entry>An application supplied widget for custom
-previews.</entry>
- </row>
-
- <row valign="top">
- <entry>"preview-widget-active"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the application supplied
-widget for custom previews should be shown. Default value:
-<literal>True</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"select-multiple"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, allow multiple files to be
- selected except if
- <literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal> is set as the
- "action" property. Default value:
-<literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"show-hidden"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, hidden files and folders
-should be displayed. Default value: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"use-preview-label"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, display a stock label with
-the name of the previewed file. Default value: <literal>True</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkfilechooser">
- <title>gtk.FileChooser Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkfilechooser--confirm-overwrite">confirm-overwrite</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>filechooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkfilechooser--current-folder-changed">current-folder-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>filechooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkfilechooser--file-activated">file-activated</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>filechooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkfilechooser--selection-changed">selection-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>filechooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkfilechooser--update-preview">update-preview</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>filechooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This interface is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para><link
-linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
-is an interface that can be implemented by file selection widgets. In PyGTK,
-the main objects that implement this interface are <link
-linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>
-and <link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>. You
-do not need to write an object that implements the <link
-linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
-interface unless you are trying to adapt an existing file selector to expose
-a standard programming interface.</para>
-
- <para><link
- linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
- has several elements to its display:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>a list of shortcut folders on the left that is divided into
-two lists by a horizontal line:</simpara>
- <itemizedlist>
- <listitem>
- <simpara>a default list of folders usually including "Home" and
-"Filesystem" with folders added using the <link
-linkend="method-gtkfilechooser--add-shortcut-folder"><methodname>add_shortcut_folder</methodname>()</link>
-or <link
-linkend="method-gtkfilechooser--add-shortcut-folder-uri"><methodname>add_shortcut_folder_uri</methodname>()</link>
-methods.</simpara>
- </listitem>
- <listitem>
- <simpara>a list of user specified shortcut folders managed using
-the "Add" and "Remove" buttons at the bottom of the file chooser.</simpara>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <simpara>the "Add" and "Remove" buttons that allow a user to add or
-remove a folder to or from the user's shortcut folder list.</simpara>
- </listitem>
- <listitem>
- <simpara>the current folder path as a series of buttons above the
-file selection window. The buttons can be clicked to jump to the associated
-ancestor folder.</simpara>
- </listitem>
- <listitem>
- <simpara>the file selection window that displays the contents of the
-current folder in alphabetical order with last modified time.</simpara>
- </listitem>
- </itemizedlist>
-
- <refsect2 id="FileNamesAndEncodings">
- <title>File Names and Encodings</title>
-
- <para>When the user is finished selecting files in a <link
- linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>,
- your program can get the selected names either as filenames or as
- URIs. For URIs, the normal escaping rules are applied if the URI
- contains non-ASCII characters. However, filenames are always returned
- in the character set specified by the result of calling the Python
- sys.getfilesystemencoding() function. On POSIX this is the actual
- on-disk encoding which might correspond to the locale settings of the
- process, or not. On Windows the file name encoding is UTF-8. Note that
- the Microsoft C library does not use UTF-8, but has separate APIs for
- current system code page and wide characters (UTF-16).</para>
-
- <important>
- <para>This means that while you can pass the result of <link
- linkend="method-gtkfilechooser--get-filename"><methodname>get_filename</methodname>()</link>
- to open() or os.open(), you may not be able to directly set it as
- the text of a <link
- linkend="class-gtklabel"><classname>gtk.Label</classname></link>
- widget unless you convert it first to UTF-8, which all PyGTK widgets
- expect. If necessary you should use the Python codecs to convert
- filenames into strings that can be passed to PyGTK widgets.</para>
- </important>
-
- </refsect2>
-
- <refsect2 id="AddingAPreviewWidget">
- <title>Adding A Preview Widget</title>
-
- <para>You can add a custom preview widget to a file chooser and get
-notification when the preview needs to be updated. To install a preview
-widget, use the <link
-linkend="method-gtkfilechooser--set-preview-widget"><methodname>set_preview_widget</methodname>()</link>
-method. Then, connect to the "update-preview" signal to be notified when
-you need to update the contents of the preview.</para>
-
- <para>Your callback should use the <link
-linkend="method-gtkfilechooser--get-preview-filename"><methodname>get_preview_filename</methodname>()</link>
-method to see what needs previewing. Once you have generated the preview for
-the corresponding file, you must call the <link
-linkend="method-gtkfilechooser--set-preview-widget-active"><methodname>set_preview_widget_active</methodname>()</link>
-method with a boolean flag that indicates whether your callback could
-successfully generate a preview. An example use of a custom preview
-is:</para>
-
- <programlisting>
- ...
- preview = gtk.Image()
-
- my_file_chooser.set_preview_widget(preview)
- my_file_chooser.connect("update-preview", update_preview_cb, preview)
- ...
-
- def update_preview_cb(file_chooser, preview):
- filename = file_chooser.get_preview_filename()
- try:
- pixbuf = gtk.gdk.pixbuf_new_from_file_at_size(filename, 128, 128)
- preview.set_from_pixbuf(pixbuf)
- have_preview = True
- except:
- have_preview = False
- file_chooser.set_preview_widget_active(have_preview)
- return
- ...
-</programlisting>
- </refsect2>
-
- <refsect2>
- <title>Adding Extra Widgets</title>
-
- <para> You can add extra widgets to a file chooser to provide options
-that are not present in the default design. For example, you can add a <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-to give the user the option to open a file in read-only mode. You can use
-the <link
-linkend="method-gtkfilechooser--set-extra-widget"><methodname>set_extra_widget</methodname>()</link>
-method to insert additional widgets in a file chooser. For example:</para>
-
- <programlisting>
- toggle = gtk.CheckButton("Open file read-only")
- toggle.show ()
- my_file_chooser.set_extra_widget(toggle)
-</programlisting>
-
- <para> If you want to set more than one extra widget in the file
-chooser, you can use a container such as a <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link> or a <link
-linkend="class-gtktable"><classname>gtk.Table</classname></link> to hold
-your widgets; then set the container as the whole extra widget.</para>
-
- </refsect2>
-
- <refsect2>
- <title>Key Bindings</title>
-
- <para>The <link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
-uses the private <classname>GtkFileChooserDefaultClass</classname> that has
-several key bindings and their associated signals. This section describes
-the available key binding signals.</para>
-
- <para>The default keys that activate the key-binding signals in GtkFileChooserDefaultClass are as follows:</para>
-
- <informaltable pgwide="1" frame="none">
- <tgroup cols="2">
- <colspec column="1" colwidth="2in"/>
- <colspec column="2" colwidth="2in"/>
- <thead>
- <row>
- <entry>Signal name</entry>
- <entry>Key</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>location-popup</entry>
- <entry>Control-L</entry>
- </row>
- <row>
- <entry>up-folder</entry>
- <entry>Alt-Up</entry>
- </row>
- <row>
- <entry>down-folder</entry>
- <entry>Alt-Down</entry>
- </row>
- <row>
- <entry>home-folder</entry>
- <entry>Alt-Home</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
-
- <para>To change these defaults to something else, you could include
-the following fragment in your <filename>.gtkrc-2.0</filename> file:</para>
-
- <programlisting>
- binding "my-own-gtkfilechooser-bindings" {
- bind "&lt;Alt&gt;&lt;Shift&gt;l" {
- "location-popup" ()
- }
- bind "&lt;Alt&gt;&lt;Shift&gt;Up" {
- "up-folder" ()
- }
- bind "&lt;Alt&gt;&lt;Shift&gt;Down" {
- "down-folder" ()
- }
- bind "&lt;Alt&gt;&lt;Shift&gt;Home" {
- "home-folder-folder" ()
- }
- }
-
- class "GtkFileChooserDefault" binding "my-own-gtkfilechooser-bindings"
-</programlisting>
-
- <para>The "GtkFileChooserDefault::location-popup" signal is used to
-make the file chooser show a "Location" dialog which the user can use to
-manually type the name of the file he wishes to select. By default this is
-bound to
-<keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>.</para>
-
- <programlisting>
- def location_popup_cb(filechooser, user_data):
-</programlisting>
-
- <para>where <parameter>filechooser</parameter> is the <link
-linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
-that received the signal, <parameter>user_data</parameter> is user data set
-when the signal handler was connected.</para>
-
- <para>The "GtkFileChooserDefault::up-folder" signal is used to make
-the file chooser go to the parent of the current folder in the file
-hierarchy. By default this is bound to
-<keycombo><keycap>Alt</keycap><keycap>Up</keycap></keycombo>.</para>
-
- <programlisting>
- def up_folder_cb(filechooser, user_data):
-</programlisting>
-
- <para>where <parameter>filechooser</parameter> is the object that
-received the signal and <parameter>user_data</parameter> is the user data
-set when the signal handler was connected.</para>
-
- <para>The "GtkFileChooserDefault::down-folder" signal is used to make
-the file chooser go to a child of the current folder in the file
-hierarchy. The subfolder that will be used is displayed in the path bar
-widget of the file chooser. For example, if the path bar is showing
-"/foo/bar/baz", then this will cause the file chooser to switch to the "baz"
-subfolder. By default this is bound to
-<keycombo><keycap>Alt</keycap><keycap>Down</keycap> </keycombo>.</para>
-
- <programlisting>
- def down_folder_cb(filechooser, user_data):
-</programlisting>
-
- <para>where <parameter>filechooser</parameter> is the object that
-received the signal and <parameter>user_data</parameter> is the user data
-set when the signal handler was connected.</para>
-
- <para>The "GtkFileChooserDefault::home-folder" signal is used to make
-the file chooser show the user's home folder in the file list. By default
-this is bound to <keycombo><keycap>Alt</keycap><keycap>Home</keycap>
-</keycombo>.</para>
-
- <programlisting>
- def home_folder_cb(filechooser, user_data):
-</programlisting>
-
- <para>where <parameter>filechooser</parameter> is the object that
-received the signal and <parameter>user_data</parameter> is the user data
-set when the signal handler was connected.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkfilechooser--set-action">
- <title>gtk.FileChooser.set_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_action</methodname>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">action</parameter>&nbsp;:</term>
- <listitem>
- <simpara>the file selection action - one of:
-<literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal>,
-<literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal>,
-<literal>gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER</literal> or
-<literal>gtk.FILE_CHOOSER_ACTION_CREATE_FOLDER</literal>.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_action</methodname>() method sets the
-"action" property to the value of <parameter>action</parameter>. The type of
-operation that that the chooser is performing is set by
-<parameter>action</parameter> causing the user interface to be changed to
-suit the selected action. The value of <parameter>action</parameter> must be
-one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></term>
- <listitem>
- <simpara>Indicates open mode. The file chooser will only let the
-user pick an existing file.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal></term>
- <listitem>
- <simpara>Indicates save mode. The file chooser will let the user
-pick an existing file, or type in a new filename.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER</literal></term>
- <listitem>
- <simpara>Indicates an open mode for selecting folders. The file
-chooser will let the user pick an existing folder.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_CHOOSER_ACTION_CREATE_FOLDER</literal></term>
- <listitem>
- <simpara>Indicates a mode for creating a new folder. The file
-chooser will let the user name an existing or new folder </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>For example, an option to create a new folder might be shown if
-the action is <literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal> but not if the
-action is <literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-action">
- <title>gtk.FileChooser.get_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_action</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem>
- <simpara>the action that is set for the file
-selector</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_action</methodname>() method returns the
-value of the "action" property that indicates the type of operation that the
-file chooser is set to perform. See the <link
-linkend="method-gtkfilechooser--set-action"><methodname>set_action()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-local-only">
- <title>gtk.FileChooser.set_local_only</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_local_only</methodname>
- <methodparam><parameter role="keyword">local_only</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">local_only</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, only local files can
-be selected</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_local_only</methodname>() method sets the
-"local-only" property to the value of <parameter>local_only</parameter>. If
-<parameter>local_only</parameter> is <literal>True</literal> (the default),
-only local files can be selected in the file selector and the selected files
-are guaranteed to be accessible through the operating system's native file
-system. Therefore, the application only needs to use the filename methods in
-<link
-linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>.
-For example, the application can use the <link
-linkend="method-gtkfilechooser--get-filename"><methodname>get_filename()</methodname></link>
-method instead of the URI method <link
-linkend="method-gtkfilechooser--get-uri"><methodname>get_uri()</methodname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-local-only">
- <title>gtk.FileChooser.get_local_only</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_local_only</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if only local files can be
-selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_local_only</methodname>() method returns the
-value of the "local-only" property that indicates whether only local files
-can be selected in the file selector. See the <link
-linkend="method-gtkfilechooser--set-local-only"><methodname>set_local_only()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-select-multiple">
- <title>gtk.FileChooser.set_select_multiple</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_select_multiple</methodname>
- <methodparam><parameter role="keyword">select_multiple</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">select_multiple</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> multiple files can be
-selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_select_multiple</methodname>() method sets
-the "select_multiple" property to the value of
-<parameter>select_multiple</parameter>. If
-<parameter>select_multiple</parameter> is <literal>True</literal>, multiple
-files can be selected in the file selector.</para>
-
- <note>
- <para>The "select-multiple" property cannot be set
-<literal>True</literal> when the file chooser action is
-<literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal> or
-<literal>gtk.FILE_CHOOSER_ACTION_CREATE_FOLDER</literal>.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-select-multiple">
- <title>gtk.FileChooser.get_select_multiple</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_select_multiple</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if multiple files can be
-selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_select_multiple</methodname>() method
-returns the value of the "select_multiple" property that indicates whether
-multiple files can be selected in the file selector. See the <link
-linkend="method-gtkfilechooser--set-select-multiple"><methodname>set_select_multiple()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-current-name">
- <title>gtk.FileChooser.set_current_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_current_name</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the filename to use, as a UTF-8
-string</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_current_name</methodname>() method sets the
-current name in the file selector to the value of
-<parameter>name</parameter>, as if entered by the user. Note that the name
-passed in here is a UTF-8 string rather than a filename. This method is
-meant for such uses as a suggested name in a "Save As..." dialog.</para>
-
- <para>If you want to preselect a particular existing file, you should
-use the <link
-linkend="method-gtkfilechooser--set-filename"><methodname>set_filename()</methodname></link>
-method instead.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-filename">
- <title>gtk.FileChooser.get_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_filename</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The currently selected filename, or
-<literal>None</literal> if no file is selected, or the selected file can't
-be represented with a local filename.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_filename</methodname>() method returns the
-filename of the currently selected file in the file selector. If multiple
-files are selected, one of the filenames will be returned at random. If the
-file chooser is in folder mode, this function returns the selected
-folder.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-filename">
- <title>gtk.FileChooser.set_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_filename</methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the filename to set as current</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if both the folder could
-be changed and the file was selected successfully, <literal>False</literal>
-otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_filename</methodname>() method sets
-<parameter>filename</parameter> as the current filename for the the file
-chooser. If the file name isn't in the current folder of the chooser, then
-the current folder of the chooser will be changed to the folder containing
-<parameter>filename</parameter>. This is equivalent to a sequence of <link
-linkend="method-gtkfilechooser--unselect-all"><methodname>unselect_all()</methodname></link>
-followed by <link
-linkend="method-gtkfilechooser--select-filename"><methodname>select_filename()</methodname></link>.</para>
-
- <para>Note that the file must exist, or nothing will be done except
-for the directory change. To pre-enter a filename for the user, as in a
-"Save as ..." dialog, use the <link
-linkend="method-gtkfilechooser--set-current-name"><methodname>set_current_name()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--select-filename">
- <title>gtk.FileChooser.select_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_filename</methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the filename to select</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if both the folder could
-be changed and the file was selected successfully, <literal>False</literal>
-otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>select_filename</methodname>() method selects
-the filename specified by <parameter>filename</parameter>. If
-<parameter>filename</parameter> isn't in the current folder of the chooser,
-then the current folder of the chooser will be changed to the folder
-containing <parameter>filename</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--unselect-filename">
- <title>gtk.FileChooser.unselect_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unselect_filename</methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the filename to unselect</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>unselect_filename</methodname>() method
-unselects the currently selected filename specified by
-<parameter>filename</parameter>. If <parameter>filename</parameter> is not
-in the current directory, does not exist, or is otherwise not currently
-selected, this method does nothing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--select-all">
- <title>gtk.FileChooser.select_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_all</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>select_all</methodname>() method selects all the
-files in the current folder of a file chooser.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--unselect-all">
- <title>gtk.FileChooser.unselect_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unselect_all</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>unselect_all</methodname>() method unselects all
- the files in the current folder of a file chooser.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-filenames">
- <title>gtk.FileChooser.get_filenames</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_filenames</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list containing the filenames of all selected
-files and subfolders in the current folder.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_filenames</methodname>() method returns a
-list containing all the selected files and subfolders in the current folder
-of the chooser. The returned names are full absolute paths. If files in the
-current folder cannot be represented as local filenames they will be
-ignored. (See the <link
-linkend="method-gtkfilechooser--get-uris"><methodname>get_uris()</methodname></link>
-method for more information)</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-current-folder">
- <title>gtk.FileChooser.set_current_folder</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_current_folder</methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the full path of the new current
-folder</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the folder could be
-changed successfully, <literal>False</literal> otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_current_folder</methodname>() method sets
-the current folder for the chooser to the local filename specified by
-<parameter>filename</parameter>. The user will be shown the full contents
-of the current folder, plus user interface elements for navigating to other
-folders.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-current-folder">
- <title>gtk.FileChooser.get_current_folder</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_current_folder</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the full path of the current folder, or
-<literal>None</literal> if the current path cannot be represented as a local
-filename.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_current_folder</methodname>() method returns
-the current folder of the chooser as a local filename. See the <link
-linkend="method-gtkfilechooser--set-current-folder"><methodname>set_current_folder()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-uri">
- <title>gtk.FileChooser.get_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_uri</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The currently selected URI, or
-<literal>None</literal> if no file is selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_uri</methodname>() method returns the URI
-for the currently selected file in the file selector. If multiple files are
-selected, one of the filenames will be returned at random. If the file
-chooser is in folder mode, this function returns the selected folder.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-uri">
- <title>gtk.FileChooser.set_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_uri</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>the URI to set as the current
-file</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if both the folder could
-be changed and the URI was successfully selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_uri</methodname>() method sets the file
-referred to by <parameter>uri</parameter> as the current file for the file
-chooser; If the file name isn't in the current folder of the chooser, then
-the current folder of the chooser will be changed to the folder containing
-<parameter>uri</parameter>. This is equivalent to the sequence of <link
-linkend="method-gtkfilechooser--unselect-all"><methodname>unselect_all()</methodname></link>
-followed by <link
-linkend="method-gtkfilechooser--select-uri"><methodname>select_uri()</methodname></link>.
-Note that the file must exist, or nothing will be done except for the
-directory change. To pre-enter a filename for the user, as in a "Save As
-..." dialog, use the <link
-linkend="method-gtkfilechooser--set-current-name"><methodname>set_current_name()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--select-uri">
- <title>gtk.FileChooser.select_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_uri</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>the URI of the file to select</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if both the folder could
-be changed and the URI was successfully selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>select_uri</methodname>() method selects the
-file referred to by <parameter>uri</parameter>. If the URI doesn't refer to
-a file in the current folder of the chooser, then the current folder of the
-chooser will be changed to the folder containing the file referenced by
-<parameter>uri</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--unselect-uri">
- <title>gtk.FileChooser.unselect_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unselect_uri</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>the URI of the file to
-unselect</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>unselect_uri</methodname>() method unselects the
-file referred to by <parameter>uri</parameter>. If the file is not in the
-current directory, does not exist, or is otherwise not currently selected,
-this method does nothing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-uris">
- <title>gtk.FileChooser.get_uris</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_uris</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list containing the URIs of all selected
-files and subfolders in the current folder.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_uris</methodname>() method returns a list
-containing all the selected files and subfolders in the current folder of
-the chooser. The returned names are full absolute URIs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-current-folder-uri">
- <title>gtk.FileChooser.set_current_folder_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_current_folder_uri</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>the URI for the new current
-folder</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the folder could be
-changed successfully, <literal>False</literal> otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_current_folder_uri</methodname>() method
-sets the current folder for the chooser to the folder referenced by
-<parameter>uri</parameter>. The user will be shown the full contents of the
-current folder, plus user interface elements for navigating to other
-folders.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-current-folder-uri">
- <title>gtk.FileChooser.get_current_folder_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_current_folder_uri</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the URI for the current
-folder.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_current_folder_uri</methodname>() method
-returns the URI reference of the current folder of the chooser. See the
-<link
-linkend="method-gtkfilechooser--set-current-folder-uri"><methodname>set_current_folder_uri()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-preview-widget">
- <title>gtk.FileChooser.set_preview_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_preview_widget</methodname>
- <methodparam><parameter role="keyword">preview_widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">preview_widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget for displaying a
-preview.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_preview_widget</methodname>() method sets
-the "preview-widget" property to the value of
-<parameter>preview_widget</parameter>. The
-<parameter>preview_widget</parameter> is used to preview the currently
-selected file. To implement a custom preview:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>set the preview widget</simpara>
- </listitem>
- <listitem>
- <simpara>connect a callback to the "selection-changed" signal of the
-file chooser</simpara>
- </listitem>
- <listitem>
- <simpara>in the callback, call the <link
-linkend="method-gtkfilechooser--get-preview-filename"><methodname>get_preview_filename()</methodname></link>
-method or the <link
-linkend="method-gtkfilechooser--get-preview-uri"><methodname>get_preview_uri()</methodname></link>
-method to retrieve the selected file name or URI</simpara>
- </listitem>
- <listitem>
- <simpara>if you can, display a preview of the selected file and set
-the preview active using the <link
-linkend="method-gtkfilechooser--set-preview-widget-active"><methodname>set_preview_widget_active()</methodname></link>
-method</simpara>
- </listitem>
- <listitem>
- <simpara>otherwise, set the preview inactive</simpara>
- </listitem>
- </itemizedlist>
-
- <para>When there is no application-supplied preview widget, or the
-application-supplied preview widget is not active, the file chooser
-may display an internally generated preview of the current file or
-it may display no preview at all.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-preview-widget">
- <title>gtk.FileChooser.get_preview_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_preview_widget</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current preview widget, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_preview_widget</methodname>() method returns
-the value of the "preview_widget" property i.e. the current preview
-widget. See the <link
-linkend="method-gtkfilechooser--set-preview-widget"><methodname>set_preview_widget()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-preview-widget-active">
- <title>gtk.FileChooser.set_preview_widget_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_preview_widget_active</methodname>
- <methodparam><parameter role="keyword">active</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">active</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, display the
-user-specified preview widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_preview_widget_active</methodname>() method
-sets the "preview_widget_active" property to the value of
-<parameter>active</parameter>. If <parameter>active</parameter> is
-<literal>True</literal>, the preview widget set by the <link
-linkend="method-gtkfilechooser--set-preview-widget"><methodname>set_preview_widget()</methodname></link>
-method should be shown for the current filename. When
-<parameter>active</parameter> is <literal>False</literal>, the file chooser
-may display an internally generated preview of the current file or it may
-display no preview at all. See the <link
-linkend="method-gtkfilechooser--set-preview-widget"><methodname>set_preview_widget()</methodname></link>
-for more details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-preview-widget-active">
- <title>gtk.FileChooser.get_preview_widget_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_preview_widget_active</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the preview widget is
-active for the current filename.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_preview_widget_active</methodname>() method
-returns the value of the "preview-widget-active" property that indicates
-whether the preview widget set by the <link
-linkend="method-gtkfilechooser--set-preview-widget"><methodname>set_preview_widget()</methodname></link>
-method should be shown for the current filename. See the <link
-linkend="method-gtkfilechooser--set-preview-widget-active"><methodname>set_preview_widget_active()</methodname></link>
-method for more details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-use-preview-label">
- <title>gtk.FileChooser.set_use_preview_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_preview_label</methodname>
- <methodparam><parameter role="keyword">use_label</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">use_label</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, display a stock label
-with the name of the previewed file</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_use_preview_label</methodname>() method sets
-the "use-preview-label" property to the value of
-<parameter>use_label</parameter>. If <parameter>use_label</parameter> is
-<literal>True</literal> (the default), the file chooser should display a
-stock label with the name of the file that is being previewed. Applications
-that want to draw the whole preview area themselves should set this to
-<literal>False</literal> and display the name themselves in their preview
-widget. See the <link
-linkend="method-gtkfilechooser--set-preview-widget"><methodname>set_preview_widget()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-use-preview-label">
- <title>gtk.FileChooser.get_use_preview_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_preview_label</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the file chooser is
-set to display a label with the name of the previewed file;
-<literal>False</literal> otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_use_preview_label</methodname>() method
-returns the value of the "use-preview-label" property that indicates whether
-a stock label should be drawn with the name of the previewed file. See the
-<link
-linkend="method-gtkfilechooser--set-use-preview-label"><methodname>set_use_preview_label()</methodname></link>
-for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-preview-filename">
- <title>gtk.FileChooser.get_preview_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_preview_filename</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the filename to preview, or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_preview_filename</methodname>() method
-returns the filename that should be previewed in a custom preview widget or
-<literal>None</literal> if no file is selected, or if the selected file
-cannot be represented as a local filename. See the <link
-linkend="method-gtkfilechooser--set-preview-widget"><methodname>set_preview_widget()</methodname></link>
-method for more details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-preview-uri">
- <title>gtk.FileChooser.get_preview_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_preview_uri</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the URI for the file to preview, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_preview_uri</methodname>() method returns
-the URI of the file that should be previewed in a custom preview widget or
-<literal>None</literal> if no file is selected. See the <link
-linkend="method-gtkfilechooser--set-preview-widget"><methodname>set_preview_widget()</methodname></link>
-method fr more details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-extra-widget">
- <title>gtk.FileChooser.set_extra_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_extra_widget</methodname>
- <methodparam><parameter role="keyword">extra_widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">extra_widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to display extra
-options</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_extra_widget</methodname>() method sets the
-"extra-widget" property to the value of
-<parameter>extra_widget</parameter>. <parameter>extra_widget</parameter> is
-an application-supplied widget used to display extra options to the
-user.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-extra-widget">
- <title>gtk.FileChooser.get_extra_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_extra_widget</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current extra widget, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_extra_widget</methodname>() method returns
-the value of the "extra-widget" property that contains either a widget used
-to display extra options to the user or <literal>None</literal> if no extra
-widget is in use. See the <link
-linkend="method-gtkfilechooser--set-extra-widget"><methodname>set_extra_widget()</methodname></link>
-for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--add-filter">
- <title>gtk.FileChooser.add_filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_filter</methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filter</parameter>&nbsp;:</term>
- <listitem><simpara>a
-<link linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_filter</methodname>() method adds the <link
-linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link>
-specified by <parameter>filter</parameter> to the list of filters that the
-user can select from. When a filter is selected, only files that are
-passed by that filter are displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--remove-filter">
- <title>gtk.FileChooser.remove_filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_filter</methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filter</parameter>&nbsp;:</term>
- <listitem><simpara>a
-<link linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>remove_filter</methodname>() method removes the
-<link
-linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link>
-specified by <parameter>filter</parameter> from the list of filters that the
-user can select from.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--list-filters">
- <title>gtk.FileChooser.list_filters</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_filters</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list containing the current set of
-user selectable filters.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>list_filters</methodname>() method returns the
-current set of user-selectable filters. See the <link
-linkend="method-gtkfilechooser--add-filter"><methodname>add_filter()</methodname></link>
-and <link
-linkend="method-gtkfilechooser--remove-filter"><methodname>remove_filter()</methodname></link>
-method for more details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-filter">
- <title>gtk.FileChooser.set_filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_filter</methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filter</parameter>&nbsp;:</term>
- <listitem><simpara>a
-<link linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_filter</methodname>() method sets the
-"filter" property to the value of <parameter>filter</parameter> and also
-sets the current filter to <parameter>filter</parameter>. Only the files
-that pass <parameter>filter</parameter> will be displayed. If the
-user-selectable list of filters is non-empty, then
-<parameter>filter</parameter> should be one of the filters in that
-list. Setting the current filter when the list of filters is empty is useful
-if you want to restrict the displayed set of files without letting the user
-change it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-filter">
- <title>gtk.FileChooser.get_filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_filter</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current filter, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_filter</methodname>() method returns the
-value of the "filter" property which is the current filter. See the <link
-linkend="method-gtkfilechooser--set-filter"><methodname>set_filter()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--add-shortcut-folder">
- <title>gtk.FileChooser.add_shortcut_folder</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_shortcut_folder</methodname>
- <methodparam><parameter role="keyword">folder</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">folder</parameter>&nbsp;:</term>
- <listitem><simpara>the filename of the folder to
-add</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the folder could be
-added successfully.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_shortcut_folder</methodname>() adds the
-folder specified by <parameter>folder</parameter> the list of shortcut
-folders in a file chooser. Shortcut folders are displayed at the upper left
-in the <link
-linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>. By
-double-clicking on a shortcut the user can open that folder directly. Note
-that shortcut folders do not get saved, as they are provided by the
-application. For example, you can use this to add a
-"/usr/share/mydrawprogram/Clipart" folder to the volume list.</para>
-
- <para>The GError exception is raised if an error occurred while adding
-the folder.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--remove-shortcut-folder">
- <title>gtk.FileChooser.remove_shortcut_folder</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_shortcut_folder</methodname>
- <methodparam><parameter role="keyword">folder</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">folder</parameter>&nbsp;:</term>
- <listitem><simpara>the filename of the folder to
-remove</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>folder</parameter> was removed from the list of
- shortcut folders.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>remove_shortcut_folder</methodname>() method
-removes the folder specified by <parameter>folder</parameter> from a file
-chooser's list of shortcut
-folders. <methodname>remove_shortcut_folder</methodname>() returns True if
-successful. See the <link
-linkend="method-gtkfilechooser--add-shortcut-folder"><methodname>add_shortcut_folder()</methodname></link>
-method for more information.</para>
-
- <para>The GError exception is raised if an error occurred while
-removing the folder.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--list-shortcut-folders">
- <title>gtk.FileChooser.list_shortcut_folders</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_shortcut_folders</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A list of shortcut folder filenames, or
-<literal>None</literal> if there are no shortcut folders.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>list_shortcut_folders</methodname>() method
-returns the list of shortcut folders in the file chooser, as set by the
-<link
-linkend="method-gtkfilechooser--add-shortcut-folder"><methodname>add_shortcut_folder</methodname>()</link>
-method or <literal>None</literal> if there are no shortcut folders. It is
-not possible to get a list of the user-specified shortcut folders.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--add-shortcut-folder-uri">
- <title>gtk.FileChooser.add_shortcut_folder_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_shortcut_folder_uri</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>the URI of the folder to add</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the folder was
-added</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_shortcut_folder_uri</methodname>() method
-adds a folder with the URI specified by <parameter>uri</parameter> to the
-list of shortcut folders in a file chooser. Note that shortcut folders do
-not get saved, as they are provided by the application. For example, you
-can use this to add a "file:///usr/share/mydrawprogram/Clipart" folder to
-the volume list. See the <link
-linkend="method-gtkfilechooser--add-shortcut-folder"><methodname>add_shortcut_folder</methodname>()</link>
-method for more details.</para>
-
- <para>The GError exception is raised if an error occurred while adding
-the folder.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--remove-shortcut-folder-uri">
- <title>gtk.FileChooser.remove_shortcut_folder_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_shortcut_folder_uri</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>URI of the folder to remove</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the folder was
-removed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>remove_shortcut_folder_uri</methodname>() method
-removes the folder with the URI specified by <parameter>uri</parameter> from
-the file chooser's list of shortcut folders.</para>
-
- <para>The GError exception is raised if an error occurred while
-removing the folder.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--list-shortcut-folder-uris">
- <title>gtk.FileChooser.list_shortcut_folder_uris</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_shortcut_folder_uris</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of shortcut folder URIs, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>list_shortcut_folder_uris</methodname>() method
-returns a list of the shortcut folders in the file chooser, as set by the
-<link
-linkend="method-gtkfilechooser--add-shortcut-folder-uri"><methodname>add_shortcut_folder_uri</methodname>()</link>
-method. It is not possible to get a list of the user-specified folder
-URIs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-show-hidden">
- <title>gtk.FileChooser.set_show_hidden</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_hidden</methodname>
- <methodparam><parameter role="keyword">show_hidden</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">show_hidden</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> hidden files and
-folders should be displayed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_show_hidden</methodname>() method sets the
-"show-hidden" property to the value of
-<parameter>show_hidden</parameter>. If <parameter>show_hidden</parameter> is
-<literal>True</literal>, hidden files and folders should be displayed in the
-file selector.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-show-hidden">
- <title>gtk.FileChooser.get_show_hidden</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_hidden</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if hidden files and
-folders are displayed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_show_hidden</methodname>() method returns
-the value of the "show-hidden" property that indicates whether hidden files
-and folders should be displayed in the file selector. See the <link
-linkend="method-gtkfilechooser--set-show-hidden"><methodname>set_show_hidden()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--set-do-overwrite-confirmation">
- <title>gtk.FileChooser.set_do_overwrite_confirmation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_do_overwrite_confirmation</methodname>
- <methodparam><parameter role="keyword">do_overwrite_confirmation</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">do_overwrite_confirmation</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> ask the user for
-confirmation before overwriting a file in save mode.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_do_overwrite_confirmation</methodname>()
-method sets the "do-overwrite-confirmation" property to the value of
-<parameter>do_overwrite_confirmation</parameter>. If
-<parameter>do_overwrite_confirmation</parameter> is <literal>True</literal>
-and the "action" property is set to
-<literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal>, the file chooser will
-present a confirmation dialog if the user attempts to overwrite an existing
-file. The default value is <literal>False</literal>.</para>
-
- <para>If all you need is the stock confirmation dialog, set the
-"do-overwrite-confirmation" property to <literal>True</literal>. You can
-override the way confirmation is done by actually handling the
-"confirm-overwrite" signal; please refer to its documentation for
-details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooser--get-do-overwrite-confirmation">
- <title>gtk.FileChooser.get_do_overwrite_confirmation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_do_overwrite_confirmation</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if hidden files and
-folders are displayed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_do_overwrite_confirmation</methodname>()
-method returns the value of the "do-overwrite-confirmation" property that
-indicates whether a user is asked for confirmation before overwriting an
-existing file. See the <link
-linkend="method-gtkfilechooser--set-do-overwrite-confirmation"><methodname>set_do_overwrite_confirmation()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkfilechooser--confirm-overwrite">
- <title>The "confirm-overwrite" gtk.FileChooser Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>filechooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>filechooser</parameter>&nbsp;:</term>
- <listitem><simpara>the filechooser widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> one of the <xref
-linkend="gtk-filechooser-confirmation-constants"
-endterm="gtk-filechooser-confirmation-constants-title"></xref>
-indicating what action GTK+ should take.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The "confirm-overwrite" signal is emitted when it is appropriate
-to present a confirmation dialog when the user has selected a file name that
-already exists. The signal is only emitted when the file chooser "action" property is set to <literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal>.</para>
-
- <para> Most applications just need to turn on the
-"do-overwrite-confirmation" property (or call the <link
-linkend="method-gtkfilechooser--set-do-overwrite-confirmation"><methodname>set_do_overwrite_confirmation</methodname>()</link>
-method), to automatically get a stock confirmation dialog. Applications
-that need to customize this behavior should do that, and also connect to
-the "confirm-overwrite" signal.</para>
-
- <para>A signal handler for this signal must return one of the <xref
-linkend="gtk-filechooser-confirmation-constants"
-endterm="gtk-filechooser-confirmation-constants-title"></xref> that
-indicates the action to take. If the handler determines that the user wants
-to select a different filename, it should return
-<literal>gtk.FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN</literal>. If it
-determines that the user is satisfied with his choice of file name, it
-should return
-<literal>gtk.FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME</literal>. On the
-other hand, if it determines that the stock confirmation dialog should be
-used, it should return
-<literal>gtkfile_CHOOSER_CONFIRMATION_CONFIRM</literal>. The following
-psuedo-code example illustrates this.</para>
-
- <programlisting>
-def confirm_overwrite_callback(chooser):
- uri = chooser.get_uri()
-
- if is_uri_read_only(uri):
- if user_wants_to_replace_read_only_file (uri):
- return gtk.FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME
- else
- return gtk.FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN
- else
- # fall back to the default dialog
- return gtk.FILE_CHOOSER_CONFIRMATION_CONFIRM
-
-...
-
-chooser = gtk.FileChooserDialog(...)
-
-chooser.set_do_overwrite_confirmation(True)
-chooser.connect("confirm-overwrite", confirm_overwrite_callback)
-
-if chooser.run() == gtk.RESPONSE_ACCEPT:
- save_to_file(chooser.get_filename()
-
-chooser.destroy()
-</programlisting>
-
- </refsect2>
-
- <refsect2 id="signal-gtkfilechooser--current-folder-changed">
- <title>The "current-folder-changed" gtk.FileChooser Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>filechooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>filechooser</parameter>&nbsp;:</term>
- <listitem><simpara>the filechooser widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "current-folder-changed" signal is emitted when the current
-folder displayed in <parameter>filechooser</parameter> is changed. Normally
-you do not need to connect to this signal, unless you need to keep track of
-which folder a file chooser is showing.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkfilechooser--file-activated">
- <title>The "file-activated" gtk.FileChooser Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>filechooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>filechooser</parameter>&nbsp;:</term>
- <listitem><simpara>the filechooser widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "file-activated" signal is emitted when the user
-double-clicks on a file (not a folder) or presses
-<keycap>Enter</keycap>. Normally you do not need to connect to this
-signal. It is used internally by <link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
-to know when to activate the default button in the dialog.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkfilechooser--selection-changed">
- <title>The "selection-changed" gtk.FileChooser Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>filechooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>filechooser</parameter>&nbsp;:</term>
- <listitem><simpara>the filechooser widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "selection-changed" signal is emitted when the file
-selection in <parameter>filechooser</parameter> is changed either by
-clicking on a filename or by changing the current folder. Normally you do
-not need to connect to this signal, as it is easier to wait for the file
-chooser to finish running, and then to get the list of selected files using
-the functions mentioned below.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkfilechooser--update-preview">
- <title>The "update-preview" gtk.FileChooser Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>filechooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>filechooser</parameter>&nbsp;:</term>
- <listitem><simpara>the filechooser widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "update-preview" signal is emitted when the preview when a
-file chooser should be regenerated. For example, this can happen when the
-currently selected file changes. You should use this signal if you want your
-file chooser to have a preview widget.</para>
-
- <para>Once you have installed a preview widget with the <link
-linkend="method-gtkfilechooser--set-preview-widget"><methodname>set_preview_widget</methodname>()</link>
-method, you should update it when this signal is emitted. You can use the
-methods <link
-linkend="method-gtkfilechooser--get-preview-filename"><methodname>get_preview_filename</methodname>()</link>
-or <link
-linkend="method-gtkfilechooser--get-preview-uri"><methodname>get_preview_uri</methodname>()</link>
-to get the name of the file to preview. Your widget may not be able to
-preview all kinds of files so your callback must call the <link
-linkend="method-gtkfilechooser--set-preview-widget-active"><methodname>set_preview_widget_active</methodname>()</link>
-to inform the file chooser if the preview was generated successfully or
-not.</para>
-
- <para>Please see the example code in the section called <link
-linkend="AddingAPreviewWidget">Adding a Preview Widget</link>.</para>
-
- <para>Also see the <link
-linkend="method-gtkfilechooser--set-preview-widget"><methodname>set_preview_widget</methodname>()</link>,
-<link
-linkend="method-gtkfilechooser--set-preview-widget-active"><methodname>set_preview_widget_active</methodname>()</link>,
-<link
-linkend="method-gtkfilechooser--set-use-preview-label"><methodname>set_use_preview_label</methodname>()</link>,
-<link
-linkend="method-gtkfilechooser--get-preview-filename"><methodname>get_preview_filename</methodname>()</link>
-and <link
-linkend="method-gtkfilechooser--get-preview-uri"><methodname>get_preview_uri</methodname>()</link>
-methods for more information</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkfilechooserbutton.xml b/docs/reference/pygtk-gtkfilechooserbutton.xml
deleted file mode 100644
index adf8a84e..00000000
--- a/docs/reference/pygtk-gtkfilechooserbutton.xml
+++ /dev/null
@@ -1,448 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkfilechooserbutton">
- <refnamediv>
- <refname>gtk.FileChooserButton</refname>
- <refpurpose>a button to launch a <link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
-(new in PyGTK 2.6)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.FileChooserButton</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkhbox">gtk.HBox</link></classname></ooclass>
-<constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkfilechooserbutton">gtk.FileChooserButton</link></methodname>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- <methodparam><parameter role="keyword">backend</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
-<constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkfilechooserbutton2">gtk.FileChooserButton</link></methodname>
- <methodparam><parameter role="keyword">dialog</parameter></methodparam>
- </constructorsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooserbutton--get-title">get_title</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooserbutton--set-title">set_title</link></methodname>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooserbutton--get-width-chars">get_width_chars</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooserbutton--set-width-chars">set_width_chars</link></methodname>
- <methodparam><parameter role="keyword">n_chars</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooserbutton--get-focus-on-click">get_focus_on_click</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilechooserbutton--set-focus-on-click">set_focus_on_click</link></methodname>
- <methodparam><parameter role="keyword">focus_on_click</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkhbox">gtk.HBox</link>
- +-- <link linkend="class-gtkfilechooserbutton">gtk.FileChooserButton</link> (implements <link linkend="class-gtkfilechooser">gtk.FileChooser</link>)</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkfilechooserbutton">
- <title>gtk.FileChooserButton Properties</title>
-
- <para><link linkend="properties-gtkfilechooser">gtk.FileChooser Properties</link></para>
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"dialog"</entry>
- <entry>Write-Construct Only</entry>
-
- <entry>The <link
- linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
- associated with the button. Available in GTK+ 2.6.</entry>
- </row>
-
- <row valign="top">
- <entry>"focus-on-click"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal> the <link
- linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link>
- button grabs focus when it is clicked with the mouse. Default
- value: <literal>True</literal>. Available in GTK+
- 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"title"</entry>
- <entry>Read-Write</entry>
-
- <entry>The string to use as the title on the <link
- linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
- associated with the button. Default value: "Select A
- File". Available in GTK+ 2.6.</entry>
- </row>
-
- <row valign="top">
- <entry>"width-chars"</entry>
- <entry>Read-Write</entry>
-
- <entry>The width of the entry and label inside the button, in
- characters. Allowed values: >= -1. Default value:
- -1. Available in GTK+ 2.6.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkfilechooserbutton">
- <title>gtk.FileChooserButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkfilechooserbutton">
- <title>gtk.FileChooserButton Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkfilechooserbutton">
- <title>gtk.FileChooserButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkfilechooser">gtk.FileChooser Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <link
- linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link>
- is a widget that lets the user select a file. It implements the <link
- linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
- interface. Visually, it is a file name with a button to bring up a <link
- linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>. The
- user can then use that dialog to change the file associated with that
- button. This widget does not support setting the "select-multiple"
- property to <literal>True</literal>. For example to create a <link
- linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link>
- and set the current folder to '/etc' use:</para>
-
- <programlisting>
- filechooserbutton = gtk.FileChooserButton('Select a File')
- filechooserbutton.set_current_folder('/etc')
-</programlisting>
-
- <para>The <link
- linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link>
- supports the <literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal> and
- <literal>gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER</literal> actions of the
- <xref linkend="gtk-filechooser-action-constants"
- endterm="gtk-filechooser-action-constants-title"></xref>.</para>
-
- <note>
- <para>The <link
- linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link>
- will ellipsize the label, and thus will thus request little horizontal
- space. To give the button more space, you should call the <link
- linkend="method-gtkwidget--size-request"><methodname>gtk.Widget.size_request</methodname>()</link>
- method, the <link
- linkend="method-gtkfilechooserbutton--set-width-chars"><methodname>set_width_chars</methodname>()</link>
- method, or pack the button in such a way that other interface elements
- give space to the widget.</para>
- </note>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkfilechooserbutton">
- <title>gtk.FileChooserButton</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.FileChooserButton</methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- <methodparam><parameter
- role="keyword">backend</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>the title of the browse dialog</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">backend</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a file system backend or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>Creates a new button widget that opens a <link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
-when clicked. The title of the <link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
-is specified by <parameter>title</parameter>. If
-<parameter>backend</parameter> is specified it is the name of a file system
-backend.</para>
-
- </refsect2>
-
- <refsect2 id="constructor-gtkfilechooserbutton2">
- <title>gtk.FileChooserButton</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.FileChooserButton</methodname>
- <methodparam><parameter
- role="keyword">dialog</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dialog</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>Creates a new button widget that opens a <link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
-specified by <parameter>dialog</parameter> when clicked.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkfilechooserbutton--get-title">
- <title>gtk.FileChooserButton.get_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_title</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the title of the <link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_title</methodname>() method returns the
-value of the "title" property which contains the title of the associated
-<link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooserbutton--set-title">
- <title>gtk.FileChooserButton.set_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_title</methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>a string to use as the title of the associated
-<link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_title</methodname>() method sets the "title"
-property to the value of <parameter>title</parameter>. The "title" property
-contains the title string of the associated <link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooserbutton--get-width-chars">
- <title>gtk.FileChooserButton.get_width_chars</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_width_chars</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <term><parameter
-role="keyword"></parameter>&nbsp;:</term>
- <listitem><simpara>the width in characters of the
-button</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_width_chars</methodname>() method returns
-the value of the "width-characters" property which contains the number of
-characters the button width should be set to.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooserbutton--set-width-chars">
- <title>gtk.FileChooserButton.set_width_chars</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_width_chars</methodname>
- <methodparam><parameter
- role="keyword">n_chars</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">n_chars</parameter>&nbsp;:</term>
- <listitem><simpara>the width in characters for the
-button</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_width_chars</methodname>() method sets the
-"width-chars" property to the value of <parameter>n_chars</parameter>. The
-"width-chars" property contains the width in characters that the button
-should be set to.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooserbutton--get-focus-on-click">
- <title>gtk.FileChooserButton.get_focus_on_click</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_focus_on_click</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the button grabs
- focus when it is clicked with the mouse.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_focus_on_click</methodname>() method returns
- the value of the "focus-on-click" property. If the return value is
- <literal>True</literal> if the button grabs focus when it is clicked
- with the mouse. See the <link
- linkend="method-gtkfilechooserbutton--set-focus-on-click"><methodname>set_focus_on_click()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilechooserbutton--set-focus-on-click">
- <title>gtk.FileChooserButton.set_focus_on_click</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_focus_on_click</methodname>
- <methodparam><parameter role="keyword">focus_on_click</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">focus_on_click</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal>, the button grabs
- focus when clicked with the mouse</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_focus_on_click</methodname>() method sets
- the "focus-on-click" property to the value of
- <parameter>focus_on_click</parameter>. If
- <parameter>focus_on_click</parameter> is <literal>True</literal>, the
- button will grab focus when it is clicked with the mouse. Making
- mouse clicks not grab focus is useful in places like toolbars where
- you don't want the keyboard focus removed from the main area of the
- application.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkfilechooserdialog.xml b/docs/reference/pygtk-gtkfilechooserdialog.xml
deleted file mode 100644
index 5602722e..00000000
--- a/docs/reference/pygtk-gtkfilechooserdialog.xml
+++ /dev/null
@@ -1,167 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkfilechooserdialog">
- <refnamediv>
- <refname>gtk.FileChooserDialog</refname> <refpurpose>a file chooser
- dialog, suitable for "File/Open" or "File/Save" commands(new in PyGTK
- 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.FileChooserDialog</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtkfilechooser">gtk.FileChooser</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkfilechooserdialog">gtk.FileChooserDialog</link></methodname>
- <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">action</parameter><initializer><literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">buttons</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">backend</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
- +-- <link linkend="class-gtkfilechooserdialog">gtk.FileChooserDialog</link> (implements <link linkend="class-gtkfilechooser">gtk.FileChooser</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkfilechooserdialog">
- <title>gtk.FileChooserDialog Properties</title>
-
- <para><link linkend="properties-gtkfilechooser">gtk.FileChooser Properties</link></para>
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
- <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkfilechooserdialog">
- <title>gtk.FileChooserDialog Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkfilechooserdialog">
- <title>gtk.FileChooserDialog Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkfilechooser">gtk.FileChooser Signal Prototypes</link></para>
-</refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para><link
- linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
- is a dialog box suitable for use with "File/Open" or "File/Save as"
- commands. This widget works by putting a <link
- linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>
- inside a <link
- linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>. It
- implements the <link
- linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
- interface, so you can use all of the <link
- linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>
- methods, signals and properties on the file chooser dialog as well as
- those for <link
- linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>.</para>
-
- <para>Note that <link
- linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>
- does not have any methods of its own. Instead, you should use the
- methods and signals that work on a <link
- linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkfilechooserdialog">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.FileChooserDialog</methodname>
- <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">action</parameter><initializer><literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">buttons</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">backend</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>The title of the dialog</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>The transient parent of the dialog, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">action</parameter>&nbsp;:</term>
- <listitem>
- <simpara>The open or save mode for the dialog - one of:
-<literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal>,
-<literal>gtk.FILE_CHOOSER_ACTION_SAVE</literal>,
-<literal>gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER</literal> or
-<literal>gtk.FILE_CHOOSER_ACTION_CREATE_FOLDER</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">buttons</parameter>&nbsp;:</term>
- <listitem><simpara>a tuple containing button label-response id pairs
- or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">backend</parameter>&nbsp;:</term>
- <listitem><simpara>The name of the specific filesystem backend to
-use.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>. The
-constructor can be invoked with the optional parameters:
-<parameter>title</parameter>, <parameter>parent</parameter>,
-<parameter>action</parameter>, <parameter>buttons</parameter> and
-<parameter>backend</parameter>. This constructor is analogous to the
-<link linkend="constructor-gtkdialog">gtk.Dialog</link>() constructor.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkfilechooserwidget.xml b/docs/reference/pygtk-gtkfilechooserwidget.xml
deleted file mode 100644
index 68bd0734..00000000
--- a/docs/reference/pygtk-gtkfilechooserwidget.xml
+++ /dev/null
@@ -1,137 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkfilechooserwidget">
- <refnamediv>
- <refname>gtk.FileChooserWidget</refname> <refpurpose>a file chooser
- widget that can be embedded in other widgets(new in PyGTK
- 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.FileChooserWidget</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkvbox">gtk.VBox</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtkfilechooser">gtk.FileChooser</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkfilechooserwidget">gtk.FileChooserWidget</link></methodname>
- <methodparam><parameter role="keyword">action</parameter><initializer><literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">backend</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkvbox">gtk.VBox</link>
- +-- <link linkend="class-gtkfilechooserwidget">gtk.FileChooserWidget</link> (implements <link linkend="class-gtkfilechooser">gtk.FileChooser</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkfilechooserwidget">
- <title>gtk.FileChooserWidget Properties</title>
-
- <para><link linkend="properties-gtkfilechooser">gtk.FileChooser Properties</link></para>
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkfilechooserwidget">
- <title>gtk.FileChooserWidget Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkfilechooserwidget">
- <title>gtk.FileChooserWidget Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkfilechooserwidget">
- <title>gtk.FileChooserWidget Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkfilechooser">gtk.FileChooser Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <link
- linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>
- is a widget suitable for selecting files. It is the main building block
- of a <link
- linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>. Most
- applications will only need to use the latter; you can use <link
- linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>
- as part of a larger window if you have special needs.</para>
-
- <para>Note that <link
- linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>
- does not have any methods, signals or properties of its own. Instead,
- you should use the methods, signals and properties of the <link
- linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkfilechooserwidget">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.FileChooserWidget</methodname>
- <methodparam><parameter role="keyword">action</parameter><initializer><literal>gtk.FILE_CHOOSER_ACTION_OPEN</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">backend</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">action</parameter>&nbsp;:</term>
- <listitem><simpara>The open or save mode for the
-widget or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">backend</parameter>&nbsp;:</term>
- <listitem><simpara>The name of the specific filesystem backend to
-use or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link>.
-This is a file chooser widget that can be embedded in custom windows, and it
-is the same widget that is used by <link
-linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link>.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkfilefilter.xml b/docs/reference/pygtk-gtkfilefilter.xml
deleted file mode 100644
index a293d713..00000000
--- a/docs/reference/pygtk-gtkfilefilter.xml
+++ /dev/null
@@ -1,530 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkfilefilter">
- <refnamediv>
- <refname>gtk.FileFilter</refname>
- <refpurpose>a filter for selecting a file subset (new in PyGTK
- 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.FileFilter</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkfilefilter">gtk.FileFilter</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilefilter--set-name">set_name</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilefilter--get-name">get_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilefilter--add-mime-type">add_mime_type</link></methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilefilter--add-pattern">add_pattern</link></methodname>
- <methodparam><parameter role="keyword">pattern</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilefilter--add-custom">add_custom</link></methodname>
- <methodparam><parameter>needed</parameter></methodparam>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilefilter--get-needed">get_needed</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilefilter--filter">filter</link></methodname>
- <methodparam><parameter role="keyword">filter_info</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfilefilter--add-pixbuf-formats">add_pixbuf_formats</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkfilefilter">gtk.FileFilter</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkfilefilter">
- <title>gtk.FileFilter Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkfilefilter">
- <title>gtk.FileFilter Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
- linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link>
- is an object that filters files based on a set of rules that it
- contains. The categories of information that <link
- linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link>
- uses to accept or reject the file are given by the <xref
- linkend="gtk-filefilter-flags-constants"
- endterm="gtk-filefilter-flags-constants-title"></xref>:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_FILENAME</literal></term>
- <listitem>
- <simpara>The full path name of the file.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_URI</literal></term>
- <listitem>
- <simpara>The URI of the file.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_DISPLAY_NAME</literal></term>
- <listitem>
- <simpara>The simple name of the file as displayed in a file
-chooser.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_MIME_TYPE</literal></term>
- <listitem>
- <simpara>The MIME type of the file.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <link
- linkend="method-gtkfilefilter--add-pattern"><methodname>add_pattern</methodname>()</link>
- method adds a rule that only uses the display name
- (<literal>gtk.FILE_FILTER_DISPLAY_NAME</literal>) for filtering. The
- <link
- linkend="method-gtkfilefilter--add-mime-type"><methodname>add_mime_type</methodname>()</link>
- method adds a rule that only uses the mime type
- (<literal>gtk.FILE_FILTER_MIME_TYPE</literal>) for filtering. To use the
- file URI (<literal>gtk.FILE_FILTER_URI</literal>) or filename
- (<literal>gtk.FILE_FILTER_FILENAME</literal>) you have to create a
- custom filter rule using a callback function that is registered with the
- <link
- linkend="method-gtkfilefilter--add-custom"><methodname>add_custom</methodname>()</link>
- method.</para>
-
- <para>The pattern rule uses file globbing to match the file display
- name:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>'*' matches any combination of characters e.g.. "a*c" matches
- "abc", "a bridge tic", "aaabbbc" and so on.</simpara>
- </listitem>
- <listitem>
- <simpara>'?' matches any single character e.g. "a?c" matches "abc",
- aZc" and so on but not "abbc".</simpara>
- </listitem>
- <listitem>
- <simpara>'[' and ']' enclose a set of characters that can be matched; ranges
-of characters can be included by separating the start and end with a dash
-(e.g. "a-z" include all the lowercase letters). e.g. "a[0-9]c" matches "a3c"
-and "a9c" but not "a28c" or "abc".</simpara>
- </listitem>
- <listitem>
- <simpara>'\' escapes the next character to allow "*", "?", "[" and "]"
- to be matched literally.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The MIME type requires an exact match (no pattern matching).</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkfilefilter">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.FileFilter</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new
-<link linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link>
-with no rules added to it. Such a filter doesn't pass any files, so it's not
-particularly useful until you add rules with the <link
-linkend="method-gtkfilefilter--add-mime-type"><methodname>add_mime_type()</methodname></link>,
-<link
-linkend="method-gtkfilefilter--add-pattern"><methodname>add_pattern()</methodname></link>
-or <link
-linkend="method-gtkfilefilter--add-custom"><methodname>add_custom()</methodname></link>
-methods. To create a filter that accepts any file, use:</para>
-
- <programlisting>
- filter = gtk.FileFilter()
- filter.add_pattern("*")
-</programlisting>
-
- <para></para>
-
-
- </refsect1>
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkfilefilter--set-name">
- <title>gtk.FileFilter.set_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_name</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the human-readable-name for the
-filter.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_name</methodname>() method sets the
-human-readable name of the filter to the string in
-<parameter>name</parameter>. The string in <parameter>name</parameter> will
-be displayed in the file chooser user interface if there is a selectable
-list of filters.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilefilter--get-name">
- <title>gtk.FileFilter.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The human-readable name of the filter,
-or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_name</methodname>() method returns the
-human-readable name for the filter or <literal>None</literal> if the name
-has not been set. See the <link
-linkend="method-gtkfilefilter--set-name"><methodname>set_name()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilefilter--add-mime-type">
- <title>gtk.FileFilter.add_mime_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_mime_type</methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mime_type</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a MIME type</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_mime_type</methodname>() method adds a rule
-allowing the mime type specified by <parameter>mime_type</parameter> to be
-matched. Sets the needs value to
-<literal>gtk.FILE_FILTER_MIME_TYPE</literal> (see the <link
-linkend="method-gtkfilefilter--get-needed"><methodname>get_needed</methodname>()</link>
-method for more information).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilefilter--add-pattern">
- <title>gtk.FileFilter.add_pattern</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_pattern</methodname>
- <methodparam><parameter role="keyword">pattern</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pattern</parameter>&nbsp;:</term>
- <listitem><simpara>a shell style glob pattern</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_pattern</methodname>() method adds a rule
-allowing the shell style glob pattern specified by
-<parameter>pattern</parameter> to filter file names. Sets the needs value to
-<literal>gtk.FILE_FILTER_DISPLAY_NAME</literal> (see the <link
-linkend="method-gtkfilefilter--get-needed"><methodname>get_needed</methodname>()</link>
-method for more information).</para>
-
- <para>The pattern rule uses file globbing to match the file display
-name:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>'*' matches any combination of characters e.g.. "a*c" matches
- "abc", "a bridge tic", "aaabbbc" and so on.</simpara>
- </listitem>
- <listitem>
- <simpara>'?' matches any single character e.g. "a?c" matches "abc",
- aZc" and so on but not "abbc".</simpara>
- </listitem>
- <listitem>
- <simpara>'[' and ']' enclose a set of characters that can be matched; ranges
-of characters can be included by separating the start and end with a dash
-(e.g. "a-z" include all the lowercase letters). e.g. "a[0-9]c" matches "a3c"
-and "a9c" but not "a28c" or "abc".</simpara>
- </listitem>
- <listitem>
- <simpara>'\' escapes the next character to allow "*", "?", "[" and "]"
- to be matched literally.</simpara>
- </listitem>
- </itemizedlist>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilefilter--add-custom">
- <title>gtk.FileFilter.add_custom</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_custom</methodname>
- <methodparam><parameter>needed</parameter></methodparam>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>needed</parameter>&nbsp;:</term>
- <listitem><simpara>a bitfield of flags indicating the information
-that the custom filter function needs.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>func</parameter>&nbsp;:</term>
- <listitem><simpara>a callback function; if the function returns
-<literal>True</literal>, then the file will be displayed.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter>&nbsp;:</term>
- <listitem><simpara>the data to pass to
-<parameter>func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_custom</methodname>() method adds a rule to
-a filter that allows files to be filtered based on a custom callback
-function specified by <parameter>func</parameter>. The bitfield
-<parameter>needed</parameter> provides information about what sorts of
-information that the filter function needs; this allows GTK+ to avoid
-retrieving expensive information when it isn't needed by the
-filter. <parameter>needed</parameter> is a combination of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_FILENAME</literal></term>
- <listitem>
- <simpara>The full path name of the file.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_URI</literal></term>
- <listitem>
- <simpara>The URI of the file.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_DISPLAY_NAME</literal></term>
- <listitem>
- <simpara>The simple name of the file as displayed in a file
-chooser.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILE_FILTER_MIME_TYPE</literal></term>
- <listitem>
- <simpara>The MIME type of the file.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The signature of <parameter>func</parameter> is:</para>
-
- <programlisting>
- def filefilterfunction(filter_info, data):
-</programlisting>
-
- <para>where <parameter>filter_info</parameter> is a 4-tuple where each
-item is either a string or <literal>None</literal>. The strings correspond
-to: the full pathname of the file, the URI of the file, the display name of
-the file and the MIME type of the file. <parameter>data</parameter> is the
-value passed in as the <parameter>data</parameter> parameter in the
-<methodname>add_custom</methodname>() method. Using a custom filter function
-is the only way to filter files based on file URIs or full file
-pathnames.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilefilter--get-needed">
- <title>gtk.FileFilter.get_needed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_needed</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a bitfield of flags indicating the needed fields
-when calling <link
-linkend="method-gtkfilefilter--filter"><methodname>filter()</methodname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_needed</methodname>() method returns the
-information that is needed by the <link
-linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link>
-to filter the file info using the <link
-linkend="method-gtkfilefilter--filter"><methodname>filter()</methodname></link></para>
-
- <para>This method is not typically used by applications; it is
-intended principally for use in the implementation of <link
-linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilefilter--filter">
- <title>gtk.FileFilter.filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>filter</methodname>
- <methodparam><parameter role="keyword">filter_info</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filter_info</parameter>&nbsp;:</term>
- <listitem><simpara>a 4-tuple containing the information
-about a file.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the file should be
-displayed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>filter</methodname>() method tests whether a file should be displayed according to the file filter rules.
-The 4-tuple <parameter>filter_info</parameter> should include
-the fields returned from the <link linkend="method-gtkfilefilter--get-needed"><methodname>get_needed()</methodname></link> method:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the full pathname of the file if needs includes
- <literal>gtk.FILE_FILTER_FILENAME</literal></simpara>
- </listitem>
- <listitem>
- <simpara>the URI of the file is needs includes
- <literal>gtk.FILE_FILTER_URI</literal></simpara>
- </listitem>
- <listitem>
- <simpara>the display name (without the path) if the file if needs
- includes <literal>gtk.FILE_FILTER_DISPLAY_NAME</literal></simpara>
- </listitem>
- <listitem>
- <simpara>the MIME type of the file if needs includes
- <literal>gtk.FILE_FILTER_MIME_TYPE</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para>This method will not typically be used by applications; it is
-intended principally for use in the implementation of <link
-linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfilefilter--add-pixbuf-formats">
- <title>gtk.FileFilter.add_pixbuf_formats</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_pixbuf_formats</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>add_pixbuf_formats</methodname>() method adds a
- rule allowing image files in the formats supported by <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkfileselection.xml b/docs/reference/pygtk-gtkfileselection.xml
deleted file mode 100644
index 9f0ffe84..00000000
--- a/docs/reference/pygtk-gtkfileselection.xml
+++ /dev/null
@@ -1,538 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkfileselection">
- <refnamediv>
- <refname>gtk.FileSelection</refname>
- <refpurpose>a dialog used to prompt the user for a file or directory
- name</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.FileSelection</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkfileselection">gtk.FileSelection</link></methodname>
- <methodparam><parameter
- role="keyword">title</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfileselection--set-filename">set_filename</link></methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfileselection--get-filename">get_filename</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfileselection--complete">complete</link></methodname>
- <methodparam><parameter
- role="keyword">pattern</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfileselection--show-fileop-buttons">show_fileop_buttons</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfileselection--hide-fileop-buttons">hide_fileop_buttons</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfileselection--get-selections">get_selections</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfileselection--set-select-multiple">set_select_multiple</link></methodname>
- <methodparam><parameter
- role="keyword">select_multiple</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfileselection--get-select-multiple">get_select_multiple</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
- +-- <link linkend="class-gtkfileselection">gtk.FileSelection</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkfileselection">
- <title>gtk.FileSelection Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
- <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
-
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"filename"</entry>
- <entry>Read/Write</entry>
- <entry>The currently selected filename.</entry>
- </row>
-
- <row valign="top">
- <entry>"select-multiple"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> allow multiple files to be
- selected.</entry>
- </row>
-
- <row valign="top">
- <entry>"show-fileops"</entry>
- <entry>Read/Write</entry>
- <entry>If <literal>True</literal> display the buttons for creating
- and manipulating files.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkfileselection">
- <title>gtk.FileSelection Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"dir_list"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget used to display the directories</entry>
- </row>
-
- <row valign="top">
- <entry>"file_list"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget used to display the files.</entry>
- </row>
-
- <row valign="top">
- <entry>"selection_entry"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> widget used
-to display the current file selection</entry>
- </row>
-
- <row valign="top">
- <entry>"selection_text"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> associated
-with the selection entry.</entry>
- </row>
-
- <row valign="top">
- <entry>"main_vbox"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link> widget that
-holds all the widgets of the <link
-linkend="class-gtkfileselection"><classname>gtk.FileSelection</classname></link>
-dialog.</entry>
- </row>
-
- <row valign="top">
- <entry>"ok_button"</entry>
- <entry>Read</entry>
- <entry>The "OK" button.</entry>
- </row>
-
- <row valign="top">
- <entry>"cancel_button"</entry>
- <entry>Read</entry>
- <entry>The "Cancel" button.</entry>
- </row>
-
- <row valign="top">
- <entry>"history_pulldown"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
-widget that provides the pulldown list of directory paths.</entry>
- </row>
-
- <row valign="top">
- <entry>"history_menu"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> part of the
-<parameter>history_pulldown</parameter></entry>
- </row>
-
- <row valign="top">
- <entry>"fileop_dialog"</entry>
- <entry>Read</entry>
- <entry>The dialog box used to display the <link
-linkend="class-gtkfileselection"><classname>gtk.FileSelection</classname></link>.
-It can be customized by adding or removing widgets from it using the
-standard <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>
-methods.</entry>
- </row>
-
- <row valign="top">
- <entry>"fileop_entry"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> in the
-fileops dialog that is created when one of the fileops buttons is
-clicked.</entry>
- </row>
-
- <row valign="top">
- <entry>"fileop_file"</entry>
- <entry>Read</entry>
- <entry>The name of the file to be operated on by the
-fileops</entry>
- </row>
-
- <row valign="top">
- <entry>"fileop_c_dir"</entry>
- <entry>Read</entry>
- <entry>The "New Folder" fileops button.</entry>
- </row>
-
- <row valign="top">
- <entry>"fileop_del_file"</entry>
- <entry>Read</entry>
- <entry>The "Delete File" fileops button</entry>
- </row>
-
- <row valign="top">
- <entry>"fileop_ren_file"</entry>
- <entry>Read</entry>
- <entry>The "Rename File" fileops button</entry>
- </row>
-
- <row valign="top">
- <entry>"button_area"</entry>
- <entry>Read</entry>
- <entry>The fileops <link
-linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link>.</entry>
- </row>
-
- <row valign="top">
- <entry>"action_area"</entry>
- <entry>Read</entry>
- <entry>A <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> that can be
-used by the application to add buttons, etc.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkfileselection">
- <title>gtk.FileSelection Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkfileselection"><classname>gtk.FileSelection</classname></link>
-should be used to retrieve file or directory names from the user. It will
-create a new dialog window containing a directory list, and a file list
-corresponding to the current working directory. The filesystem can be
-navigated using the directory list or the drop-down history menu.
-Alternatively, the <keycap>TAB</keycap> key can be used to navigate using
-filename completion - common in text based editors such as emacs and
-jed.</para>
-
- <para>File selection dialogs are created with a call to the <link
-linkend="constructor-gtkfileselection"><methodname>gtk.FileSelection</methodname>()</link>
-constructor.</para>
-
- <para>The default filename can be set using the <link
-linkend="method-gtkfileselection--set-filename"><methodname>set_filename</methodname>()</link>
-method and the selected filename retrieved using the <link
-linkend="method-gtkfileselection--get-filename"><methodname>get_filename</methodname>()</link>
-method.</para>
-
- <para>Use the <link
-linkend="method-gtkfileselection--complete"><methodname>complete</methodname>()</link>
-method to display files and directories that match a given pattern. This can
-be used for example, to show only *.txt files, or only files beginning with
-gtk*.</para>
-
- <para>Simple file operations; create directory, delete file, and rename
-file, are available from buttons at the top of the dialog. These can be
-hidden using the <link
-linkend="method-gtkfileselection--hide-fileop-buttons"><methodname>hide_fileop_buttons</methodname>()</link>
-method and shown again using the <link
-linkend="method-gtkfileselection--show-fileop-buttons"><methodname>show_fileop_buttons</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkfileselection">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.FileSelection</methodname>
- <methodparam><parameter
- role="keyword">title</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>the text to be used as the title of the
-fileselection dialog.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new fileselection dialog</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new file selection dialog. By default it will contain
-<link
-linkend="class-gtktreeview"><classname>gtk.TreeViews</classname></link>
-displaying the application's current working directory, and its file
-listing. File operation buttons that allow the user to create a directory,
-delete files and rename files, are also present.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkfileselection--set-filename">
- <title>gtk.FileSelection.set_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_filename</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>a string to set as the default file
-name.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_filename</methodname>() method sets a
-default path for the file requester. If <parameter>filename</parameter>
-includes a directory path, then the fileselection will open with that path
-as its current working directory.</para>
-
- <para>Note the encoding of <parameter>filename</parameter> is the
-on-disk encoding, which may not be UTF-8.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfileselection--get-filename">
- <title>gtk.FileSelection.get_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_filename</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>currently-selected filename in the on-disk
-encoding</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_filename</methodname>() method returns the
-selected filename in the on-disk encoding, which may or may not be the same
-as that used by GTK (UTF-8). If no file is selected then the selected
-directory path is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfileselection--complete">
- <title>gtk.FileSelection.complete</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>complete</methodname>
- <methodparam><parameter
- role="keyword">pattern</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pattern</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing a pattern which may or may
-not match any filenames in the current directory.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>complete</methodname>() method will attempt to
-match <parameter>pattern</parameter> to valid filenames or subdirectories in
-the current directory. If a match can be made, the matched filename will
-appear in the text entry field of the file selection dialog. If a partial
-match can be made, the "Files" list will contain those file names which have
-been partially matched, and the "Directories" list those directories which
-have been partially matched.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfileselection--show-fileop-buttons">
- <title>gtk.FileSelection.show_fileop_buttons</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>show_fileop_buttons</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>show_fileop_buttons</methodname>() method shows
-the fileops buttons: "New Folder", "Delete File" and "Rename File".</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfileselection--hide-fileop-buttons">
- <title>gtk.FileSelection.hide_fileop_buttons</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>hide_fileop_buttons</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>hide_fileop_buttons</methodname>() method hides
-the fileops buttons: "New Folder", "Delete File" and "Rename File".</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfileselection--get-selections">
- <title>gtk.FileSelection.get_selections</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selections</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the selected
-files.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_selections</methodname>() method retrieves a
-tuple containing the file selections the user has made in the file selection
-dialog. The first file in the list is equivalent to what the <link
-linkend="method-gtkfileselection--get-filename"><methodname>get_filename</methodname>()</link>
-method would return.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfileselection--set-select-multiple">
- <title>gtk.FileSelection.set_select_multiple</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_select_multiple</methodname>
- <methodparam><parameter
- role="keyword">select_multiple</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">select_multiple</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> the user is allowed
-to select multiple files in the file list.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_select_multiple</methodname>() method sets
-the file list selection mode according to the value of
-<parameter>select_multiple</parameter>. If
-<parameter>select_multiple</parameter> is <literal>True</literal> the user
-is allowed to select multiple files in the file list. Use the <link
-linkend="method-gtkfileselection--get-selections"><methodname>get_selections</methodname>()</link>
-method to retrieve the list of selected files.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfileselection--get-select-multiple">
- <title>gtk.FileSelection.get_select_multiple</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_select_multiple</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the user is allowed
-to select multiple files in the file list</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_select_multiple</methodname>() method
-determines whether the user is allowed to make multiple file selection in
-the file list. If the <methodname>get_select_multiple</methodname>() method
-returns <literal>True</literal> the user is allowed to select multiple files
-in the file list. See the <link
-linkend="method-gtkfileselection--set-select-multiple"><methodname>set_select_multiple</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkfixed.xml b/docs/reference/pygtk-gtkfixed.xml
deleted file mode 100644
index 731d4ca6..00000000
--- a/docs/reference/pygtk-gtkfixed.xml
+++ /dev/null
@@ -1,318 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkfixed">
- <refnamediv>
- <refname>gtk.Fixed</refname>
- <refpurpose>a container which allows you to position widgets at fixed
-coordinates</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Fixed</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkfixed">gtk.Fixed</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfixed--put">put</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfixed--move">move</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfixed--set-has-window">set_has_window</link></methodname>
- <methodparam><parameter
- role="keyword">has_window</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfixed--get-has-window">get_has_window</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkfixed">gtk.Fixed</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkfixed">
- <title>gtk.Fixed Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkfixed">
- <title>gtk.Fixed Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkfixed">
- <title>gtk.Fixed Child Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
-
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"x"</entry>
- <entry>Read/Write</entry>
- <entry>The x position of the child widget.</entry>
- </row>
-
- <row valign="top">
- <entry>"y"</entry>
- <entry>Read/Write</entry>
- <entry>The y position of the child widget.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkfixed">
- <title>gtk.Fixed Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link> widget is a
-container that can place child widgets at fixed positions and with fixed
-sizes, given in pixels. <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link> performs no
-automatic layout management. For most applications, you should not use this
-container! It keeps you from having to learn about the other PyGTK
-containers, but it results in broken applications. With <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link>, the
-following things will result in truncated text, overlapping widgets, and
-other display bugs:</para>
-
- <itemizedlist>
- <listitem>
- <para>Themes, which may change widget sizes.</para>
- </listitem>
- <listitem>
- <para>Fonts other than the one you used to write the app will of
-course change the size of widgets containing text; keep in mind that users
-may use a larger font because of difficulty reading the default, or they may
-be using Windows or the framebuffer port of PyGTK, where different fonts are
-available.</para>
- </listitem>
- <listitem>
- <para>Translation of text into other languages changes its size.
-Also, display of non-English text will use a different font in many
-cases.</para>
- </listitem>
- </itemizedlist>
-
- <para>In addition, the fixed widget can't properly be mirrored in
-right-to-left languages such as Hebrew and Arabic. i.e. normally PyGTK will
-flip the interface to put labels to the right of the thing they label, but
-it can't do that with <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link>. So your
-application will not be usable in right-to-left languages. Finally, fixed
-positioning makes it kind of annoying to add and remove GUI elements, since
-you have to reposition all the other elements. This is a long-term
-maintenance problem for your application. If you know none of these things
-are an issue for your application, and prefer the simplicity of <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link>, by all
-means use the widget. But you should be aware of the tradeoffs.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkfixed">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Fixed</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new fixed widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link>
-widget</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkfixed--put">
- <title>gtk.Fixed.put</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>put</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget being
-added*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x position of the widget
-location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y position of the widget
-location</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>put</methodname>() method adds the child widget
-specified by <parameter>widget</parameter> to the gtk.Fixed widget at the
-location specified by <parameter>x</parameter> and
-<parameter>y</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfixed--move">
- <title>gtk.Fixed.move</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the new x position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the new y position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>move</methodname>() method moves the child
-widget specified by <parameter>widget</parameter> to the location specified
-specified by <parameter>x</parameter> and <parameter>y</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfixed--set-has-window">
- <title>gtk.Fixed.set_has_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_has_window</methodname>
- <methodparam><parameter
- role="keyword">has_window</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">has_window</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> a separate window
-should be created</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_has_window</methodname>() method specifies
-whether a <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link> widget is
-created with a separate <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-according to the value of <parameter>has_window</parameter>. If
-<parameter>has_window</parameter> is <literal>True</literal> the fixed
-widget will be created with its own separate window. By default, the setting
-is <literal>False</literal> and the fixed will be created with no separate
-<link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>. This
-method must be called while the <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link> is not
-realized, for instance, immediately after the window is created.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfixed--get-has-window">
- <title>gtk.Fixed.get_has_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_has_window</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the fixed widget has
-its own window.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_has_window</methodname>() method returns
-<literal>True</literal> if the <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link> widget has
-it's own <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>. See
-the <link
-linkend="method-gtkfixed--set-has-window"><methodname>set_has_window</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkfontbutton.xml b/docs/reference/pygtk-gtkfontbutton.xml
deleted file mode 100644
index 6a702ac4..00000000
--- a/docs/reference/pygtk-gtkfontbutton.xml
+++ /dev/null
@@ -1,598 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkfontbutton">
- <refnamediv>
- <refname>gtk.FontButton</refname> <refpurpose>a button to launch a font
- selection dialog (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.FontButton</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkbutton">gtk.Button</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkfontbutton">gtk.FontButton</link></methodname>
- <methodparam><parameter role="keyword">fontname</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--get-title">get_title</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--set-title">set_title</link></methodname>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--get-use-font">get_use_font</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--set-use-font">set_use_font</link></methodname>
- <methodparam><parameter role="keyword">use_font</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--get-use-size">get_use_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--set-use-size">set_use_size</link></methodname>
- <methodparam><parameter role="keyword">use_size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--get-font-name">get_font_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--set-font-name">set_font_name</link></methodname>
- <methodparam><parameter role="keyword">fontname</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--get-show-style">get_show_style</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--set-show-style">set_show_style</link></methodname>
- <methodparam><parameter role="keyword">show_style</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--get-show-size">get_show_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkfontbutton--set-show-size">set_show_size</link></methodname>
- <methodparam><parameter role="keyword">show_size</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkbutton">gtk.Button</link>
- +-- <link linkend="class-gtkfontbutton">gtk.FontButton</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkfontbutton">
- <title>gtk.FontButton Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"font-name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the currently selected font.</entry>
- </row>
-
- <row valign="top">
- <entry>"show-size"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the selected font size will
- be shown in the label. For a more WYSIWIG way to show the
- selected size, see the "use-size" property.</entry>
- </row>
-
- <row valign="top">
- <entry>"show-style"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the name of the selected
- font style will be shown in the label. For a more WYSIWIG way
- to show the selected style, see the "use-font"
- property.</entry>
- </row>
-
- <row valign="top">
- <entry>"title"</entry>
- <entry>Read-Write</entry>
- <entry>The title of the font selection dialog.</entry>
- </row>
-
- <row valign="top">
- <entry>"use-font"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the label will be drawn in
- the selected font</entry>
- </row>
-
- <row valign="top">
- <entry>"use-size"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the label will be drawn
- with the selected font size.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkfontbutton">
- <title>gtk.FontButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkfontbutton">
- <title>gtk.FontButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkfontbutton--font-set">font-set</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>fontbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <link
-linkend="class-gtkfontbutton"><classname>gtk.FontButton</classname></link>
-is a button that displays the currently selected font and, when clicked,
-opens a <link
-linkend="class-gtkfontselectiondialog"><classname>gtk.FontSelectionDialog</classname></link>
-to change the font. A <link
-linkend="class-gtkfontbutton"><classname>gtk.FontButton</classname></link>
-can be used in a preference dialog for selecting a font.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkfontbutton">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.FontButton</methodname>
- <methodparam><parameter role="keyword">fontname</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">fontname</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the font to display in the font
-selection dialog</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new font button widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkfontbutton"><classname>gtk.FontButton</classname></link>
-that displays the font specified by <parameter>fontname</parameter> or the
-currently selected font if <parameter>fontname</parameter> is
-<literal>None</literal> or not specified.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkfontbutton--get-title">
- <title>gtk.FontButton.get_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_title</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the title string</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_title</methodname>() method returns the
-value of the "title" property that contains the title of the font selection
-dialog.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontbutton--set-title">
- <title>gtk.FontButton.set_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_title</methodname>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the font selection dialog
-title</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_title</methodname>() method sets the "title"
-property to the string specified by <parameter>title</parameter> and sets
-the title of the <link
-linkend="class-gtkfontselectiondialog"><classname>gtk.FontSelectionDialog</classname></link>
-if it exists. The "title" property contains the title of the font
-selection dialog.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontbutton--get-use-font">
- <title>gtk.FontButton.get_use_font</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_font</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if the font button
-label is written using the selected font.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_use_font</methodname>() method returns the
-value of the "use-font" property. If "use-font" is <literal>True</literal>
-the selected font is used in the label.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontbutton--set-use-font">
- <title>gtk.FontButton.set_use_font</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_font</methodname>
- <methodparam><parameter role="keyword">use_font</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">use_font</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal>, the font button label
-will be written using the font selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_use_font</methodname>() method sets the
-"use-font" property to the value specified by
-<parameter>use_font</parameter>. If <parameter>use_font</parameter> is
-<literal>True</literal>, the font button label will be written using the
-selected font.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontbutton--get-use-size">
- <title>gtk.FontButton.get_use_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the font button label
-is written using the selected size.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_use_size</methodname>() method returns the
-value of the "use-size" property. If the value of "use-size" is
-<literal>True</literal>, the font button label is written using the selected
-font size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontbutton--set-use-size">
- <title>gtk.FontButton.set_use_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_size</methodname>
- <methodparam><parameter role="keyword">use_size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">use_size</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal>, the font button label
-will be written using the selected size.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_use_size</methodname>() method sets the
-"use-size" property to the value of <literal>use_size</literal>. If
-<parameter>use_size</parameter> is <literal>True</literal>, the font button
-label will be written using the selected size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontbutton--get-font-name">
- <title>gtk.FontButton.get_font_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_font_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the font name.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_font_name</methodname>() method returns the
-value of the "font-name" property that contains the name of the currently
-selected font.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontbutton--set-font-name">
- <title>gtk.FontButton.set_font_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_font_name</methodname>
- <methodparam><parameter role="keyword">fontname</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">fontname</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the font to display in the font
-selection dialog</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the font selection
-dialog exists and the font name could be set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_font_name</methodname>() method sets the
-"font-name" property to the value of <parameter>fontname</parameter> and
-updates the currently-displayed font in the font selection dialog. Returns
-<literal>True</literal> if the font selection dialog exists and
-<parameter>fontname</parameter> could be set as its font.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontbutton--get-show-style">
- <title>gtk.FontButton.get_show_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_style</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the font style will
-be shown in the label.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_show_style</methodname>() method returns the
-value of the "show-style" property. If "show-style" is
-<literal>True</literal>, the name of the font style will be shown in the
-font button label.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontbutton--set-show-style">
- <title>gtk.FontButton.set_show_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_style</methodname>
- <methodparam><parameter role="keyword">show_style</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">show_style</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the font style
-should be displayed in the font button label.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_show_style</methodname>() method sets the
-"show-style" property tot he value of <parameter>show_style</parameter>. If
-<parameter>show_style</parameter> is <literal>True</literal>, the font style
-will be displayed along with name of the selected font in the font button
-label.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontbutton--get-show-size">
- <title>gtk.FontButton.get_show_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the font size will
-be shown in the font button label.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_show_size</methodname>() method returns the
-value of the "show-size" property. If "show-size" is
-<literal>True</literal>, the font size will be shown in the font button
-label.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontbutton--set-show-size">
- <title>gtk.FontButton.set_show_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_size</methodname>
- <methodparam><parameter role="keyword">show_size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">show_size</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the font size should
-be displayed in the font button label.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_show_size</methodname>() method sets the
-"show-size" property to to the value of <parameter>show_size</parameter>. If
-<parameter>show_size</parameter> is <literal>True</literal>, the font size
-will be displayed along with the name of the selected font in the font
-button label.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkfontbutton--font-set">
- <title>The "font-set" gtk.FontButton Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>fontbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>fontbutton</parameter>&nbsp;:</term>
- <listitem><simpara>the fontbutton that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "font-set" signal is emitted when the user selects a
-font. When handling this signal, use the <link
-linkend="method-gtkfontbutton--get-font-name"><methodname>get_font_name</methodname>()</link>
-method to find out what font was just selected.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkfontselection.xml b/docs/reference/pygtk-gtkfontselection.xml
deleted file mode 100644
index 8bf53365..00000000
--- a/docs/reference/pygtk-gtkfontselection.xml
+++ /dev/null
@@ -1,277 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkfontselection">
- <refnamediv>
- <refname>gtk.FontSelection</refname>
- <refpurpose>a widget for selecting fonts.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.FontSelection</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkvbox">gtk.VBox</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkfontselection">gtk.FontSelection</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfontselection--get-font-name">get_font_name</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfontselection--set-font-name">set_font_name</link></methodname>
- <methodparam><parameter
- role="keyword">fontname</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfontselection--get-preview-text">get_preview_text</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfontselection--set-preview-text">set_preview_text</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkvbox">gtk.VBox</link>
- +-- <link linkend="class-gtkfontselection">gtk.FontSelection</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkfontselection">
- <title>gtk.FontSelection Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
-
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"font"</entry>
- <entry>Read</entry>
- <entry>The gtk.gdk.Font that is
- currently selected. This property is deprecated.</entry>
- </row>
-
- <row valign="top">
- <entry>"font-name"</entry>
- <entry>Read/Write</entry>
- <entry>The string that names the font</entry>
- </row>
-
- <row valign="top">
- <entry>"preview-text"</entry>
- <entry>Read/Write</entry>
- <entry>The text to display in order to demonstrate the selected
- font.
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkfontselection">
- <title>gtk.FontSelection Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkfontselection">
- <title>gtk.FontSelection Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkfontselection">
- <title>gtk.FontSelection Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkfontselection"><classname>gtk.FontSelection</classname></link>
-widget lists the available fonts, styles and sizes, allowing the user to
-select a font. It is used in the <link
-linkend="class-gtkfontselectiondialog"><classname>gtk.FontSelectionDialog</classname></link>
-widget to provide a dialog box for selecting fonts. The <link
-linkend="method-gtkfontselection--set-font-name"><methodname>set_font_name</methodname>()</link>
-method sets the initial font selection. The current font selection is
-retrieved using the <link
-linkend="method-gtkfontselection--get-font-name"><methodname>get_font_name</methodname>()</link>
-method.</para>
-
- <para>The fontselection has a preview area that contains a <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> that
-displays text using the currently selected font. The preview text can be
-retrieved with the <link
-linkend="method-gtkfontselection--get-preview-text"><methodname>get_preview_text</methodname>()</link>
-method and set with the <link
-linkend="method-gtkfontselection--set-preview-text"><methodname>set_preview_text</methodname>()</link>
-method.</para>
-
- <para>Filters can be used to limit the font selections. There are 2
-filters in the <link
-linkend="class-gtkfontselection"><classname>gtk.FontSelection</classname></link>
-- a base filter and a user filter. The base filter cannot be changed by the
-user, so this can be used when the user must choose from the restricted set
-of fonts (e.g. for a terminal-type application you may want to force the
-user to select a fixed-width font). The user filter can be changed or reset
-by the user, by using the <guibutton>Reset Filter</guibutton> button or
-changing the options on the <guilabel>Filter</guilabel> page of the
-widget.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkfontselection">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.FontSelection</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new fontselection widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkfontselection"><classname>gtk.FontSelection</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkfontselection--get-font-name">
- <title>gtk.FontSelection.get_font_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_font_name</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the selected font
-name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_font_name</methodname>() method returns the
-name of the currently selected font.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontselection--set-font-name">
- <title>gtk.FontSelection.set_font_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_font_name</methodname>
- <methodparam><parameter
- role="keyword">fontname</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">fontname</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the name of a
-font</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the font could be
-set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_font_name</methodname>() method sets the
-currently selected font in the fontselection using the value of
-<parameter>fontname</parameter>. The method returns <literal>True</literal>
-if the font is found and can be selected in the fontselection.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontselection--get-preview-text">
- <title>gtk.FontSelection.get_preview_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_preview_text</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the preview
-text</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_preview_text</methodname>() method returns a
-string that contains the text displayed in the preview area entry.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontselection--set-preview-text">
- <title>gtk.FontSelection.set_preview_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_preview_text</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the new preview text
-string</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_preview_text</methodname>() method sets the
-text to be displayed in the preview area entry using the string in
-<parameter>text</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkfontselectiondialog.xml b/docs/reference/pygtk-gtkfontselectiondialog.xml
deleted file mode 100644
index a018e0f4..00000000
--- a/docs/reference/pygtk-gtkfontselectiondialog.xml
+++ /dev/null
@@ -1,318 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkfontselectiondialog">
- <refnamediv>
- <refname>gtk.FontSelectionDialog</refname>
- <refpurpose>a dialog for selecting fonts.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.FontSelectionDialog</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkfontselectiondialog">gtk.FontSelectionDialog</link></methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfontselectiondialog--get-font-name">get_font_name</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfontselectiondialog--set-font-name">set_font_name</link></methodname>
- <methodparam><parameter
- role="keyword">fontname</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfontselectiondialog--get-preview-text">get_preview_text</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkfontselectiondialog--set-preview-text">set_preview_text</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
- +-- <link linkend="class-gtkfontselectiondialog">gtk.FontSelectionDialog</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkfontselectiondialog">
- <title>gtk.FontSelectionDialog Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
- <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkfontselectiondialog">
- <title>gtk.FontSelectionDialog Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"fontsel"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkfontselection"><classname>gtk.FontSelection</classname></link>
-widget in the dialog.</entry>
- </row>
-
- <row valign="top">
- <entry>"main_vbox"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link> that contains
-all the dialog widgets</entry>
- </row>
-
- <row valign="top">
- <entry>"action_area"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> containing
-the action buttons</entry>
- </row>
-
- <row valign="top">
- <entry>"ok_button"</entry>
- <entry>Read</entry>
- <entry>The <guibutton>OK</guibutton> button</entry>
- </row>
-
- <row valign="top">
- <entry>"apply_button"</entry>
- <entry>Read</entry>
- <entry>The <guibutton>Apply</guibutton> button</entry>
- </row>
-
- <row valign="top">
- <entry>"cancel_button"</entry>
- <entry>Read</entry>
- <entry>The <guibutton>Cancel</guibutton> button</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkfontselectiondialog">
- <title>gtk.FontSelectionDialog Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkfontselectiondialog"><classname>gtk.FontSelectionDialog</classname></link>
-is a dialog box containing a <link
-linkend="class-gtkfontselection"><classname>gtk.FontSelection</classname></link>
-widget that the user can use to select a font according to the desired
-family, style and size.</para>
-
- <para>The <link
-linkend="method-gtkfontselectiondialog--set-font-name"><methodname>set_font_name</methodname>()</link>
-method sets the initial font selection. The current font selection is
-retrieved using the <link
-linkend="method-gtkfontselectiondialog--get-font-name"><methodname>get_font_name</methodname>()</link>
-method. The font selection dialog has a preview area that contains a <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> that
-displays text using the currently selected font. The preview text can be
-retrieved with the <link
-linkend="method-gtkfontselectiondialog--get-preview-text"><methodname>get_preview_text</methodname>()</link>
-method and set with the <link
-linkend="method-gtkfontselectiondialog--set-preview-text"><methodname>set_preview_text</methodname>()</link>
-method.</para>
-
- <para>Filters can be used to limit the font selections. There are 2
-filters in the <link
-linkend="class-gtkfontselectiondialog"><classname>gtk.FontSelectionDialog</classname></link>
-- a base filter and a user filter. The base filter cannot be changed by the
-user, so this can be used when the user must choose from the restricted set
-of fonts (e.g. for a terminal-type application you may want to force the
-user to select a fixed-width font). The user filter can be changed or reset
-by the user, by using the <guibutton>Reset Filter</guibutton> button or
-changing the options on the <guilabel>Filter</guilabel> page of the
-widget.</para>
-
- <note>
- <para>In GTK+ 2.2 and above the <link
-linkend="class-gtkfontselectiondialog"><classname>gtk.FontSelectionDialog</classname></link>
-does not have filters, a <guibutton>Reset Filter</guibutton> button or a
-<guilabel>Filter</guilabel> page.</para>
- </note>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkfontselectiondialog">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.FontSelectionDialog</methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>a string to be used as the dialog
-title</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new font selection dialog</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkfontselectiondialog"><classname>gtk.FontSelectionDialog</classname></link>
-with the title specified by <parameter>title</parameter>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkfontselectiondialog--get-font-name">
- <title>gtk.FontSelectionDialog.get_font_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_font_name</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the currently selected font name or None if no
-font is selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_font_name</methodname>() method returns a
-string containing the currently selected font name or None if no font name
-is selected.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontselectiondialog--set-font-name">
- <title>gtk.FontSelectionDialog.set_font_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_font_name</methodname>
- <methodparam><parameter
- role="keyword">fontname</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">fontname</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the font name to be
-set</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the font is found
-and can be selected</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_font_name</methodname>() method sets the
-current font using the value of <parameter>fontname</parameter>. The method
-returns <literal>True</literal> if the font exists and could be
-selected.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontselectiondialog--get-preview-text">
- <title>gtk.FontSelectionDialog.get_preview_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_preview_text</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the text in the preview
-area entry</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_preview_text</methodname>() method returns a
-string containing the text in the preview area entry.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkfontselectiondialog--set-preview-text">
- <title>gtk.FontSelectionDialog.set_preview_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_preview_text</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>a string used to set the text in the preview
-area entry</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_preview_text</methodname>() method sets the
-text in the preview area entry using the string specified by
-<parameter>text</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkframe.xml b/docs/reference/pygtk-gtkframe.xml
deleted file mode 100644
index b71176c0..00000000
--- a/docs/reference/pygtk-gtkframe.xml
+++ /dev/null
@@ -1,402 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkframe">
- <refnamediv>
- <refname>gtk.Frame</refname>
- <refpurpose>a bin with a decorative frame and optional
-label.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Frame</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkframe">gtk.Frame</link></methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkframe--set-label">set_label</link></methodname>
- <methodparam><parameter
- role="keyword">label</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkframe--get-label">get_label</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkframe--set-label-widget">set_label_widget</link></methodname>
- <methodparam><parameter
- role="keyword">label_widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkframe--get-label-widget">get_label_widget</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkframe--set-label-align">set_label_align</link></methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkframe--get-label-align">get_label_align</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkframe--set-shadow-type">set_shadow_type</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkframe--get-shadow-type">get_shadow_type</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkframe">gtk.Frame</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkframe">
- <title>gtk.Frame Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"label"</entry>
- <entry>Read-Write</entry>
- <entry>The text of the frame's label</entry>
- </row>
-
- <row valign="top">
- <entry>"label-widget"</entry>
- <entry>Read-Write</entry>
- <entry>The widget to display in place of the usual frame
-label.</entry>
- </row>
-
- <row valign="top">
- <entry>"label-xalign"</entry>
- <entry>Read-Write</entry>
- <entry>The horizontal alignment of the label widget in the
-range of 0.0 to 1.0</entry>
- </row>
-
- <row valign="top">
- <entry>"label-yalign"</entry>
- <entry>Read-Write</entry>
- <entry>The vertical alignment of the decoration within the
-label widget height in the range of 0.0 to 1.0</entry>
- </row>
-
- <row valign="top">
- <entry>"shadow-type"</entry>
- <entry>Read-Write</entry>
- <entry>The style of the frame's border; one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkframe">
- <title>gtk.Frame Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkframe">
- <title>gtk.Frame Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkframe"><classname>gtk.Frame</classname></link> widget is a
-<link linkend="class-gtkbin"><classname>gtk.Bin</classname></link> that
-surrounds its child with a decorative frame and an optional label. If
-present, the label is drawn in a gap in the top side of the frame. The
-position of the label can be controlled with <link
-linkend="method-gtkframe--set-label-align"><methodname>set_label_align</methodname>()</link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkframe">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Frame</methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string to use as the label text or None if no
-label is required.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new frame widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkframe"><classname>gtk.Frame</classname></link> widget with
-the label text specified by <parameter>label</parameter>. If
-<parameter>label</parameter> is <literal>None</literal> no label is
-created.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkframe--set-label">
- <title>gtk.Frame.set_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_label</methodname>
- <methodparam><parameter
- role="keyword">label</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string to be used as the label
-text</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_label</methodname>() method sets the text of
-the label as specified by <parameter>label</parameter>. If
-<parameter>label</parameter> is <literal>None</literal> the current label is
-removed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkframe--get-label">
- <title>gtk.Frame.get_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_label</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the text in the label, or
-<literal>None</literal> if there is no label widget or the label widget is
-not a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_label</methodname>() method returns the text
-in the label widget. If there is no label widget or the label widget is not
-a <link linkend="class-gtklabel"><classname>gtk.Label</classname></link> the
-method returns <literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkframe--set-label-widget">
- <title>gtk.Frame.set_label_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_label_widget</methodname>
- <methodparam><parameter
- role="keyword">label_widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">label_widget</parameter>&nbsp;:</term>
- <listitem><simpara>the new label widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_label_widget</methodname>() method set the
-label widget (usually to something other than a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> widget) for
-the frame. This widget will appear embedded in the top edge of the frame as
-a title.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkframe--get-label-widget">
- <title>gtk.Frame.get_label_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_label_widget</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the label widget, or <literal>None</literal> if
-there is no label widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_label_widget</methodname>() method retrieves
-the label widget for the frame. See <link
-linkend="method-gtkframe--set-label-widget"><methodname>set_label_widget</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkframe--set-label-align">
- <title>gtk.Frame.set_label_align</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_label_align</methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">xalign</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal alignment of the label widget
-along the top edge of the frame (in the range of 0.0 to
-1.0)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">yalign</parameter>&nbsp;:</term>
- <listitem><simpara>the vertical alignment of the decoration with
-respect to the label widget (in the range 0.0 to 1.0)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_label_align</methodname>() method sets the
-alignment of the frame's label widget and decoration (defaults are 0.0 and
-0.5) as specified by <parameter>xalign</parameter> and
-<parameter>yalign</parameter>. The <parameter>xalign</parameter> value
-specifies the fraction of free horizontal space that is allocated to the
-left of the label widget. The <parameter>yalign</parameter> value specifies
-the fraction of label widget height above the decoration.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkframe--get-label-align">
- <title>gtk.Frame.get_label_align</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_label_align</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the x and y alignments of
-the frame's label widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_label_align</methodname>() method returns a
-tuple containing the X and Y alignment of the frame's label widget and
-decoration. See the <link
-linkend="method-gtkframe--set-label-align"><methodname>set_label_align</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkframe--set-shadow-type">
- <title>gtk.Frame.set_shadow_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_shadow_type</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_shadow_type</methodname>() method sets the
-frame's shadow type to the value of <parameter>type</parameter>. The type
-must be one of: <literal>gtk.SHADOW_NONE</literal>,
-<literal>gtk.SHADOW_IN</literal>, <literal>gtk.SHADOW_OUT</literal>,
-<literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkframe--get-shadow-type">
- <title>gtk.Frame.get_shadow_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_shadow_type</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current shadow type of the
-frame.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The get_shadow_type() method retrieves the shadow type of the
-frame; one of: <literal>gtk.SHADOW_NONE</literal>,
-<literal>gtk.SHADOW_IN</literal>, <literal>gtk.SHADOW_OUT</literal>,
-<literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal>. See <link
-linkend="method-gtkframe--set-shadow-type"><methodname>set_shadow_type</methodname>()</link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkgammacurve.xml b/docs/reference/pygtk-gtkgammacurve.xml
deleted file mode 100644
index 5d5c96ef..00000000
--- a/docs/reference/pygtk-gtkgammacurve.xml
+++ /dev/null
@@ -1,180 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkgammacurve">
- <refnamediv>
- <refname>gtk.GammaCurve</refname>
- <refpurpose> subclass of <link
-linkend="class-gtkcurve"><classname>gtk.Curve</classname></link> for editing
-gamma curves.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.GammaCurve</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkvbox">gtk.VBox</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkgammacurve">gtk.GammaCurve</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkvbox">gtk.VBox</link>
- +-- <link linkend="class-gtkgammacurve">gtk.GammaCurve</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkgammacurve">
- <title>gtk.GammaCurve Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkgammacurve">
- <title>gtk.GammaCurve Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkgammacurve">
- <title>gtk.GammaCurve Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"table"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtktable"><classname>gtk.Table</classname></link>
-containing the <link
-linkend="class-gtkgammacurve"><classname>gtk.GammaCurve</classname></link>
-widgets.</entry>
- </row>
-
- <row valign="top">
- <entry>"curve"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkcurve"><classname>gtk.Curve</classname></link>
-widget.</entry>
- </row>
-
- <row valign="top">
- <entry>"gamma"</entry>
- <entry>Read</entry>
- <entry>The gamma value (float)</entry>
- </row>
-
- <row valign="top">
- <entry>"gamma_dialog"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>
-that prompts for the gamma value.</entry>
- </row>
-
- <row valign="top">
- <entry>"gamma_text"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
-containing the gamma value in the gamma dialog</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkgammacurve">
- <title>gtk.GammaCurve Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is considered too specialized or little-used for
-PyGTK, and will in the future be moved to some other package. If your
-application needs this widget, feel free to use it, as the widget does work
-and is useful in some applications; it's just not of general interest.
-However, it will eventually move out of the PyGTK distribution.</para>
- </note>
-
- <para>The <link
-linkend="class-gtkgammacurve"><classname>gtk.GammaCurve</classname></link>
-widget is a variant of <link
-linkend="class-gtkcurve"><classname>gtk.Curve</classname></link>
-specifically for editing gamma curves, which are used in graphics
-applications such as the <application>Gimp</application>. The <link
-linkend="class-gtkgammacurve"><classname>gtk.GammaCurve</classname></link>
-widget shows a curve which the user can edit with the mouse just like a
-<link linkend="class-gtkcurve"><classname>gtk.Curve</classname></link>
-widget. On the right of the curve it also displays 5 buttons, 3 of which
-change between the 3 curve modes (spline, linear and free), and the other 2
-set the curve to a particular gamma value, or reset it to a straight
-line.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkgammacurve">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.GammaCurve</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new gammacurve widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkgammacurve"><classname>gtk.GammaCurve</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkhandlebox.xml b/docs/reference/pygtk-gtkhandlebox.xml
deleted file mode 100644
index fde851fc..00000000
--- a/docs/reference/pygtk-gtkhandlebox.xml
+++ /dev/null
@@ -1,474 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkhandlebox">
- <refnamediv>
- <refname>gtk.HandleBox</refname>
- <refpurpose>a widget for detachable window portions.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.HandleBox</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkhandlebox">gtk.HandleBox</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkhandlebox--set-shadow-type">set_shadow_type</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkhandlebox--get-shadow-type">get_shadow_type</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkhandlebox--set-handle-position">set_handle_position</link></methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkhandlebox--get-handle-position">get_handle_position</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkhandlebox--set-snap-edge">set_snap_edge</link></methodname>
- <methodparam><parameter
- role="keyword">edge</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkhandlebox--get-snap-edge">get_snap_edge</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkhandlebox">gtk.HandleBox</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkhandlebox">
- <title>gtk.HandleBox Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"handle-position"</entry>
- <entry>Read-Write</entry>
- <entry>The position of the handle relative to the child
- widget; one of the <xref linkend="gtk-position-type-constants"
- endterm="gtk-position-type-constants-title"></xref>.</entry>
- </row>
-
- <row valign="top">
- <entry>"shadow-type"</entry>
- <entry>Read-Write</entry>
- <entry>The type of shadow; one of the <xref
- linkend="gtk-shadow-type-constants"
- endterm="gtk-shadow-type-constants-title"></xref>.</entry>
- </row>
-
- <row valign="top">
- <entry>"snap-edge"</entry>
- <entry>Read-Write</entry>
- <entry>The side of the handlebox that's lined up with the
- docking point to dock the handlebox; one of the <xref
- linkend="gtk-position-type-constants"
- endterm="gtk-position-type-constants-title"></xref>.</entry>
- </row>
-
- <row valign="top">
- <entry>"snap-edge-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, use the value from
- "snap-edge"; otherwise, use a value derived from
- "handle-position". Available in GTK+ 2.2 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkhandlebox">
- <title>gtk.HandleBox Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkhandlebox">
- <title>gtk.HandleBox Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkhandlebox--child-attached">child-attached</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>handlebox</parameter>
- </methodparam>
- <methodparam><parameter>widget</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkhandlebox--child-detached">child-detached</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>handlebox</parameter>
- </methodparam>
- <methodparam><parameter>widget</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkhandlebox"><classname>gtk.HandleBox</classname></link>
-widget allows a portion of a window to be "torn off". It is a bin widget
-which displays its child and a handle that the user can drag to tear off
-into a separate floating window containing the child widget. A thin ghost is
-drawn in the original location of the handlebox. The separate window can be
-dragged back to its original location to be reattached. When reattaching,
-the ghost and float window, must be aligned along one of the edges called
-the snap edge that can be specified by the application, or specified
-automatically using a reasonable default based on the handle position. The
-snap edge is automatically set as <literal>gtk.POS_TOP</literal> if the
-handle position is <literal>gtk.POS_RIGHT</literal> or
-<literal>gtk.POS_LEFT</literal>; otherwise, the snap edge will be set as
-<literal>gtk.POS_LEFT</literal>.</para>
-
- <para>To make detaching and reattaching the handlebox as minimally
-confusing as possible to the user, it is important to set the snap edge so
-that the snap edge does not move when the handlebox is detached. For
-example, if the handlebox is packed at the bottom of a <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>, then when
-the handlebox is detached, the bottom edge of the handlebox's allocation
-will remain fixed as the height of the handlebox shrinks, so the snap edge
-should be set to <literal>gtk.POS_BOTTOM</literal>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkhandlebox">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.HandleBox</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new handlebox widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkhandlebox"><classname>gtk.HandleBox</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkhandlebox--set-shadow-type">
- <title>gtk.HandleBox.set_shadow_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_shadow_type</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the shadow type:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_shadow_type</methodname>() method sets the
-type of shadow to be drawn around the border of the handle box as specified
-by <parameter>type</parameter>. The value of <parameter>type</parameter>
-must be one of: <literal>gtk.SHADOW_NONE</literal>,
-<literal>gtk.SHADOW_IN</literal>, <literal>gtk.SHADOW_OUT</literal>,
-<literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkhandlebox--get-shadow-type">
- <title>gtk.HandleBox.get_shadow_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_shadow_type</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the type of shadow currently drawn around the
-handle box.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_shadow_type</methodname>() method gets the
-type of shadow drawn around the handle box. The shadow type is one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal>. See <link
-linkend="method-gtkhandlebox--set-shadow-type"><methodname>set_shadow_type</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkhandlebox--set-handle-position">
- <title>gtk.HandleBox.set_handle_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_handle_position</methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the side of the handlebox where the handle
-should be drawn.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_handle_position</methodname>() method sets
-the side of the handlebox where the handle is drawn using the value of
-<parameter>position</parameter>. The value of
-<parameter>position</parameter> must be one of:
-<literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
-<literal>gtk.POS_TOP</literal>, <literal>gtk.POS_BOTTOM</literal></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkhandlebox--get-handle-position">
- <title>gtk.HandleBox.get_handle_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_handle_position</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current handle
-position.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_handle_position</methodname>() method gets
-the handle position of the handle box; one of:
-<literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
-<literal>gtk.POS_TOP</literal>, <literal>gtk.POS_BOTTOM</literal>. See <link
-linkend="method-gtkhandlebox--set-handle-position"><methodname>set_handle_position</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkhandlebox--set-snap-edge">
- <title>gtk.HandleBox.set_snap_edge</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_snap_edge</methodname>
- <methodparam><parameter
- role="keyword">edge</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">edge</parameter>&nbsp;:</term>
- <listitem><simpara>the edge to use as the snap edge or -1 to have
-PyGTK automatically pick the snap edge</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_snap_edge</methodname>() method sets the
-snap edge of the handlebox to the value specified by
-<parameter>edge</parameter>. The value of <parameter>edge</parameter> can be
-one of: <literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
-<literal>gtk.POS_TOP</literal>, <literal>gtk.POS_BOTTOM</literal> or -1 to
-have the snap edge automatically specified.</para>
-
- <para>The snap edge is the edge of the detached child that must be
-aligned with the corresponding edge of the "ghost" left behind when the
-child was detached to reattach the torn-off window. Usually, the snap edge
-should be chosen so that it stays in the same place on the screen when the
-handlebox is torn off. If the snap edge is not set, then an appropriate
-value will be guessed from the handle position. If the handle position is
-<literal>gtk.POS_RIGHT</literal> or <literal>gtk.POS_LEFT</literal>, then
-the snap edge will be <literal>gtk.POS_TOP</literal>, otherwise it will be
-<literal>gtk.POS_LEFT</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkhandlebox--get-snap-edge">
- <title>gtk.HandleBox.get_snap_edge</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_snap_edge</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the edge used for determining reattachment, or
--1 if the snap edge is determined (as per default) from the handle
-position.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_snap_edge</methodname>() method gets the
-edge used for determining reattachment of the handle box. The return value
-will be one of: <literal>gtk.POS_LEFT</literal>,
-<literal>gtk.POS_RIGHT</literal>, <literal>gtk.POS_TOP</literal>,
-<literal>gtk.POS_BOTTOM</literal> or -1 to indicate the snap edge is
-automatically selected. See <link
-linkend="method-gtkhandlebox--set-snap-edge"><methodname>set_snap_edge</methodname>()</link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkhandlebox--child-attached">
- <title>The "child-attached" gtk.HandleBox Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>handlebox</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>handlebox</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "child-attached" signal is emitted when the contents of the
-handlebox are reattached to the main window.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkhandlebox--child-detached">
- <title>The "child-detached" gtk.HandleBox Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>handlebox</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>handlebox</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "child-detached" signal is emitted when the contents of the
-handlebox are detached from the main window.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkhbox.xml b/docs/reference/pygtk-gtkhbox.xml
deleted file mode 100644
index ec60ad6e..00000000
--- a/docs/reference/pygtk-gtkhbox.xml
+++ /dev/null
@@ -1,124 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkhbox">
- <refnamediv>
- <refname>gtk.HBox</refname>
- <refpurpose>a horizontal container box</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.HBox</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbox">gtk.Box</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkhbox">gtk.HBox</link></methodname>
- <methodparam><parameter
- role="keyword">homogeneous</parameter><initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">spacing</parameter><initializer>0</initializer></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkhbox">gtk.HBox</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkhbox">
- <title>gtk.HBox Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkhbox">
- <title>gtk.HBox Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkhbox">
- <title>gtk.HBox Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkhbox">
- <title>gtk.HBox Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> is a
-container subclassed from <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> that organizes
-its child widgets into a single horizontal row. The <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> methods are
-used to manage the order, spacing, width and alignment of the child widgets
-though all widgets are allocated the same height.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkhbox">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.HBox</methodname>
- <methodparam><parameter
- role="keyword">homogeneous</parameter><initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">spacing</parameter><initializer>0</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">homogeneous</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> all children are given
-equal space allocations.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
- <listitem><simpara>The additional horizontal space between children
-in pixels</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new hbox widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkhbuttonbox.xml b/docs/reference/pygtk-gtkhbuttonbox.xml
deleted file mode 100644
index 3a0ead39..00000000
--- a/docs/reference/pygtk-gtkhbuttonbox.xml
+++ /dev/null
@@ -1,122 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkhbuttonbox">
- <refnamediv>
- <refname>gtk.HButtonBox</refname>
- <refpurpose>a container for arranging buttons horizontally.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.HButtonBox</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbuttonbox">gtk.ButtonBox</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkhbuttonbox">gtk.HButtonBox</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkbuttonbox">gtk.ButtonBox</link>
- +-- <link linkend="class-gtkhbuttonbox">gtk.HButtonBox</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkhbuttonbox">
- <title>gtk.HButtonBox Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
- <para><link linkend="properties-gtkbuttonbox">gtk.ButtonBox Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkhbuttonbox">
- <title>gtk.HButtonBox Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkbuttonbox">gtk.ButtonBox Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkhbuttonbox">
- <title>gtk.HButtonBox Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
- <para><link linkend="child-properties-gtkbuttonbox">gtk.ButtonBox Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkhbuttonbox">
- <title>gtk.HButtonBox Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkhbuttonbox"><classname>gtk.HButtonBox</classname></link>
-is a container subclassed from <link
-linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link>
-that is optimized for the horizontal layout of buttons. The <link
-linkend="class-gtkhbuttonbox"><classname>gtk.HButtonBox</classname></link>
-helps provide a consistent layout of buttons in an application by providing
-default values of spacing, padding and layout style as described in the
-<link
-linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link>
-reference. Buttons are packed into a <link
-linkend="class-gtkhbuttonbox"><classname>gtk.HButtonBox</classname></link>
-using the <link
-linkend="method-gtkcontainer--add"><methodname>gtk.Container.add</methodname>()</link>
-method or the <link
-linkend="method-gtkbox--pack-start"><methodname>gtk.Box.pack_start</methodname>()</link>
-and <link
-linkend="method-gtkbox--pack-end"><methodname>gtk.Box.pack_end</methodname>()</link>
-methods. The spacing between buttons can be set with the <link
-linkend="method-gtkbox--set-spacing"><methodname>gtk.Box.set_spacing</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkhbuttonbox">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.HButtonBox</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new hbuttonbox widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkhbuttonbox"><classname>gtk.HButtonBox</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkhpaned.xml b/docs/reference/pygtk-gtkhpaned.xml
deleted file mode 100644
index c82e4546..00000000
--- a/docs/reference/pygtk-gtkhpaned.xml
+++ /dev/null
@@ -1,108 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkhpaned">
- <refnamediv>
- <refname>gtk.HPaned</refname>
- <refpurpose>a container with two panes arranged
-horizontally.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.HPaned</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkpaned">gtk.Paned</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkhpaned">gtk.HPaned</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkpaned">gtk.Paned</link>
- +-- <link linkend="class-gtkhpaned">gtk.HPaned</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkhpaned">
- <title>gtk.HPaned Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkpaned">gtk.Paned Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkhpaned">
- <title>gtk.HPaned Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkpaned">gtk.Paned Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkhpaned">
- <title>gtk.HPaned Child Properties</title>
-
- <para><link linkend="child-properties-gtkpaned">gtk.Paned Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkhpaned">
- <title>gtk.HPaned Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkpaned">gtk.Paned Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkhpaned"><classname>gtk.HPaned</classname></link> is a
-container widget subclassed from <link
-linkend="class-gtkpaned"><classname>gtk.Paned</classname></link> with two
-children arranged horizontally. The division between the children can be
-adjusted by the user by dragging a handle. See the <link
-linkend="class-gtkpaned"><classname>gtk.Paned</classname></link> description
-for more information.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkhpaned">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.HPaned</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new hpaned widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkhpaned"><classname>gtk.HPaned</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkhruler.xml b/docs/reference/pygtk-gtkhruler.xml
deleted file mode 100644
index 2e4adadc..00000000
--- a/docs/reference/pygtk-gtkhruler.xml
+++ /dev/null
@@ -1,106 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkhruler">
- <refnamediv>
- <refname>gtk.HRuler</refname>
- <refpurpose>a horizontal ruler.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.HRuler</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkruler">gtk.Ruler</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkhruler">gtk.HRuler</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkruler">gtk.Ruler</link>
- +-- <link linkend="class-gtkhruler">gtk.HRuler</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkhruler">
- <title>gtk.HRuler Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkruler">gtk.Ruler Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkhruler">
- <title>gtk.HRuler Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkhruler">
- <title>gtk.HRuler Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is considered too specialized or little-used for
-PyGTK, and will in the future be moved to some other package. If your
-application needs this widget, feel free to use it, as the widget does work
-and is useful in some applications; it's just not of general interest.
-However, it will eventually move out of the PyGTK distribution.</para>
- </note>
-
- <para>The <link
-linkend="class-gtkhruler"><classname>gtk.HRuler</classname></link> widget is
-arranged horizontally creating a ruler that is used in conjunction with
-other widgets such as a text widget. The ruler is used to show the location
-of the mouse on the window and to show the size of the window in specified
-units. The available units of measurement are <literal>gtk.PIXELS</literal>
-(the default), <literal>gtk.INCHES</literal> and
-<literal>gtk.CENTIMETERS</literal>. See the <link
-linkend="class-gtkruler"><classname>gtk.Ruler</classname></link> description
-for more information on the methods that are used to manage a <link
-linkend="class-gtkhruler"><classname>gtk.HRuler</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkhruler">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.HRuler</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new hruler widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkhruler"><classname>gtk.HRuler</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkhscale.xml b/docs/reference/pygtk-gtkhscale.xml
deleted file mode 100644
index aa39dea0..00000000
--- a/docs/reference/pygtk-gtkhscale.xml
+++ /dev/null
@@ -1,117 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkhscale">
- <refnamediv>
- <refname>gtk.HScale</refname>
- <refpurpose>a horizontal slider widget for selecting a value from a
-range.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.HScale</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkscale">gtk.Scale</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkhscale">gtk.HScale</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkrange">gtk.Range</link>
- +-- <link linkend="class-gtkscale">gtk.Scale</link>
- +-- <link linkend="class-gtkhscale">gtk.HScale</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkhscale">
- <title>gtk.HScale Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkrange">gtk.Range Properties</link></para>
- <para><link linkend="properties-gtkscale">gtk.Scale Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkhscale">
- <title>gtk.HScale Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para>
- <para><link linkend="style-properties-gtkscale">gtk.Scale Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkhscale">
- <title>gtk.HScale Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkrange">gtk.Range Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkscale">gtk.Scale Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkhscale"><classname>gtk.HScale</classname></link> is
-subclassed from <link
-linkend="class-gtkscale"><classname>gtk.Scale</classname></link> to provide
-a widget that allows a user to select a value using a horizontal slider. See
-the <link linkend="class-gtkscale"><classname>gtk.Scale</classname></link>
-description for more information on the methods available to manage a <link
-linkend="class-gtkhscale"><classname>gtk.HScale</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkhscale">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.HScale</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new hscale widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkhscale"><classname>gtk.HScale</classname></link> widget
-and associates a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-specified by <parameter>adjustment</parameter>. The default value of
-<parameter>adjustment</parameter> is <literal>None</literal> which creates
-the hscale with no <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkhscrollbar.xml b/docs/reference/pygtk-gtkhscrollbar.xml
deleted file mode 100644
index 91db6630..00000000
--- a/docs/reference/pygtk-gtkhscrollbar.xml
+++ /dev/null
@@ -1,119 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkhscrollbar">
- <refnamediv>
- <refname>gtk.HScrollbar</refname>
- <refpurpose>a horizontal scrollbar widget</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.HScrollbar</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkscrollbar">gtk.Scrollbar</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkhscrollbar">gtk.HScrollbar</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkrange">gtk.Range</link>
- +-- <link linkend="class-gtkscrollbar">gtk.Scrollbar</link>
- +-- <link linkend="class-gtkhscrollbar">gtk.HScrollbar</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkhscrollbar">
- <title>gtk.HScrollbar Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkrange">gtk.Range Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkhscrollbar">
- <title>gtk.HScrollbar Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para>
- <para><link linkend="style-properties-gtkscrollbar">gtk.Scrollbar Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkhscrollbar">
- <title>gtk.HScrollbar Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkrange">gtk.Range Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkhscrollbar"><classname>gtk.HScrollbar</classname></link>
-widget is subclassed from <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link> to
-provide a horizontal scrollbar. See <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link> for
-details on the methods available for managing scrollbars. A <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-may be specified with the scrollbar at creation (or is created automatically
-if none is specified) to handle the adjustment of the scrollbar. See <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-for details.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkhscrollbar">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.HScrollbar</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-or <literal>None</literal> to automatically create an
-adjustment</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new hscrollbar widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkhscrollbar"><classname>gtk.HScrollbar</classname></link>
-with an associated <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-specified by <parameter>adjustment</parameter>. If
-<parameter>adjustment</parameter> is None or missing a new <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-will be created and associated with the scrollbar.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkhseparator.xml b/docs/reference/pygtk-gtkhseparator.xml
deleted file mode 100644
index 9fe7e6fb..00000000
--- a/docs/reference/pygtk-gtkhseparator.xml
+++ /dev/null
@@ -1,102 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkhseparator">
- <refnamediv>
- <refname>gtk.HSeparator</refname>
- <refpurpose>a horizontal separator.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.HSeparator</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkseparator">gtk.Separator</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkhseparator">gtk.HSeparator</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkseparator">gtk.Separator</link>
- +-- <link linkend="class-gtkhseparator">gtk.HSeparator</link>
-</synopsis>
-
- <refsect1 id="properties-gtkhseparator">
- <title>gtk.HSeparator Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkhseparator">
- <title>gtk.HSeparator Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkhseparator">
- <title>gtk.HSeparator Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- </refsect1>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkhseparator"><classname>gtk.HSeparator</classname></link>
-widget is a horizontal separator, used to visibly separate the widgets
-within a window. It displays a horizontal line with a shadow to make it
-appear sunken into the interface.</para>
-
- <note>
- <para>The <link
-linkend="class-gtkhseparator"><classname>gtk.HSeparator</classname></link>
-widget is not used as a separator within menus. To create a separator in a
-menu create an empty <link
-linkend="class-gtkseparatormenuitem"><classname>gtk.SeparatorMenuItem</classname></link>
-widget and add it to the menu with <link
-linkend="method-gtkmenushell--append"><methodname>gtk.MenuShell.append</methodname>()</link>.</para>
- </note>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkhseparator">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.HSeparator</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new horizontal separator
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkhseparator"><classname>gtk.HSeparator</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkiconfactory.xml b/docs/reference/pygtk-gtkiconfactory.xml
deleted file mode 100644
index d3a93a60..00000000
--- a/docs/reference/pygtk-gtkiconfactory.xml
+++ /dev/null
@@ -1,269 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkiconfactory">
- <refnamediv>
- <refname>gtk.IconFactory</refname>
- <refpurpose>an object that manages a group of icon sets.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.IconFactory</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkiconfactory">gtk.IconFactory</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconfactory--add">add</link></methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon_set</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconfactory--lookup">lookup</link></methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconfactory--add-default">add_default</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconfactory--remove-default">remove_default</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-factory-lookup-default">gtk.icon_factory_lookup_default</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter>
- </methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkiconfactory">gtk.IconFactory</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkiconfactory">
- <title>gtk.IconFactory Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkiconfactory"><classname>gtk.IconFactory</classname></link>
-manages a group of <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>s that
-manage a set of variants (for different sizes and states) of a specific
-icon. Icons in an icon factory are named by a stock ID, which is a simple
-string identifying the icon e.g "gtk-ok". Each <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> has a list
-of <link
-linkend="class-gtkiconfactory"><classname>gtk.IconFactory</classname></link>s
-derived from the current theme; those icon factories are consulted first
-when searching for an icon. If the theme doesn't set a particular icon, the
-search continues for the icon in a list of default icon factories,
-maintained by the <link
-linkend="method-gtkiconfactory--add-default"><methodname>add_default</methodname>()</link>()
-and <link
-linkend="method-gtkiconfactory--remove-default"><methodname>remove_default</methodname>()</link>()
-methods. Applications with icons should add a default icon factory with
-their icons, which will allow themes to override the icons for the
-application.</para>
-
- <para>To display an icon, always use <link
-linkend="method-gtkstyle--lookup-icon-set"><methodname>gtk.Style.lookup_icon_set</methodname>()</link>
-on the widget that will display the icon, or the convenience function <link
-linkend="method-gtkwidget--render-icon"><methodname>gtk.Widget.render_icon</methodname>()</link>.
-These functions take the theme into account when looking up the icon to use
-for a given stock ID. </para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkiconfactory">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.IconFactory</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkiconfactory"><classname>gtk.IconFactory</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkiconfactory"><classname>gtk.IconFactory</classname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkiconfactory--add">
- <title>gtk.IconFactory.add</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon_set</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>an icon name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">icon_set</parameter>&nbsp;:</term>
- <listitem><simpara>an icon set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add</methodname>() method adds the specified
-<parameter>icon_set</parameter> to the icon factory, under the name
-<parameter>stock_id</parameter>. the <parameter>stock_id</parameter> string
-should include the name of your application, e.g. "myapp-whatever-icon".
-Normally applications create a <link
-linkend="class-gtkiconfactory"><classname>gtk.IconFactory</classname></link>,
-then add it to the list of default factories with the <link
-linkend="method-gtkiconfactory--add-default"><methodname>add_default</methodname>()</link>.
-Then they pass the <parameter>stock_id</parameter> to widgets such as <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> to display
-the icon. Themes can provide an icon with the same name (such as
-"myapp-whatever-icon") to override your application's default icons. If an
-icon already existed in the icon factory for
-<parameter>stock_id</parameter>, it is unreferenced and replaced with the
-new <parameter>icon_set</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconfactory--lookup">
- <title>gtk.IconFactory.lookup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>lookup</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>an icon name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the icon set named
-<parameter>stock_id</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>lookup</methodname>() method looks up
-<parameter>stock_id</parameter> in the icon factory, returning an icon set
-if found, otherwise <literal>None</literal>. For display to the user, you
-should use <link
-linkend="method-gtkstyle--lookup-icon-set"><methodname>gtk.Style.lookup_icon_set</methodname>()</link>
-on the <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> for the
-widget that will display the icon, instead of using this function directly,
-so that themes are taken into account.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconfactory--add-default">
- <title>gtk.IconFactory.add_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_default</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>add_default</methodname>() method adds the icon
-factory to the list of icon factories searched by <link
-linkend="method-gtkstyle--lookup-icon-set"><methodname>gtk.Style.lookup_icon_set</methodname>()</link>.
-This means that, for example, <link
-linkend="method-gtkimage--set-from-stock"><methodname>gtk.Image.set_from_stock</methodname>()</link>
-will be able to find icons in the icon factory. There will normally be an
-icon factory added for each library or application that comes with icons.
-The default icon factories can be overridden by themes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconfactory--remove-default">
- <title>gtk.IconFactory.remove_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_default</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>remove_default</methodname>() method removes an
-icon factory from the list of default icon factories. Not normally used
-though you might use it for a library that can be unloaded or shut
-down.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--icon-factory-lookup-default">
- <title>gtk.icon_factory_lookup_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.icon_factory_lookup_default</methodname>
- <methodparam><parameter role="keyword">stock_id</parameter>
- </methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>the stock ID to lookup</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the icon set matching
-<parameter>stock_id</parameter> or <literal>None</literal> if no icon set
-matches</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.icon_factory_lookup_default</function>()
-function returns the <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link> that
-has the name specified by <parameter>stock_id</parameter>. If the icon set
-cannot be found the function returns <literal>None</literal>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkiconinfo.xml b/docs/reference/pygtk-gtkiconinfo.xml
deleted file mode 100644
index d1b86653..00000000
--- a/docs/reference/pygtk-gtkiconinfo.xml
+++ /dev/null
@@ -1,391 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkiconinfo">
- <refnamediv>
- <refname>gtk.IconInfo</refname> <refpurpose>object containing
- information about and icon in an icon theme (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.IconInfo</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconinfo--copy">copy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconinfo--free">free</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconinfo--get-base-size">get_base_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconinfo--get-filename">get_filename</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconinfo--get-builtin-pixbuf">get_builtin_pixbuf</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconinfo--load-icon">load_icon</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconinfo--set-raw-coordinates">set_raw_coordinates</link></methodname>
- <methodparam><parameter role="keyword">raw_coordinates</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconinfo--get-embedded-rect">get_embedded_rect</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconinfo--get-attach-points">get_attach_points</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconinfo--get-display-name">get_display_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link>
-object contains information about an icon in a <link
-linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>. A
-<link linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link>
-object is created using the <link
-linkend="method-gtkicontheme--lookup-icon"><methodname>gtk.IconTheme.lookup_icon</methodname>()</link>
-method.</para>
-
- <para>A <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> can
-be rendered with the icon using the <link
-linkend="method-gtkiconinfo--load-icon"><methodname>load_icon</methodname>()</link>
-method. If you just want to load the pixbuf of an icon you can use the <link
-linkend="method-gtkicontheme--load-icon"><methodname>gtk.IconTheme.load_icon</methodname>()</link>
-method that combines the <link
-linkend="method-gtkicontheme--lookup-icon"><methodname>gtk.IconTheme.lookup_icon</methodname>()</link>
-method and the <link
-linkend="method-gtkiconinfo--load-icon"><methodname>load_icon</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkiconinfo--copy">
- <title>gtk.IconInfo.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
- linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>copy</methodname>() method returns a copy of the
-icon info object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconinfo--free">
- <title>gtk.IconInfo.free</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>free</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <warning>
- <para>This method is deprecated and should not be used since it can
- crash your application.</para>
- </warning>
-
- <para>The <methodname>free</methodname>() method frees the icon info
-and its associated information</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconinfo--get-base-size">
- <title>gtk.IconInfo.get_base_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_base_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the base size, or 0, if no base
-size is known for the icon.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_base_size</methodname>() method returns the
-base size for the icon. The base size is a size for the icon that was
-specified by the icon theme creator. This may be different than the actual
-size of image; an example of this is small emblem icons that can be attached
-to a larger icon. These icons will be given the same base size as the larger
-icons to which they are attached.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconinfo--get-filename">
- <title>gtk.IconInfo.get_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_filename</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the filename for the icon, or
- <literal>None</literal> if the <link
- linkend="method-gtkiconinfo--get-builtin-pixbuf"><methodname>get_builtin_pixbuf()</methodname></link>
- should be used instead.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_filename</methodname>() method returns the filename for the icon. If
-the <literal>gtk.ICON_LOOKUP_USE_BUILTIN</literal> flag was passed to the
-<link
-linkend="method-gtkicontheme--lookup-icon"><methodname>gtk.IconTheme.lookup_icon()</methodname></link>
-method, there may be no filename if a builtin icon is returned. In this
-case, you should use the <link
-linkend="method-gtkiconinfo--get-builtin-pixbuf"><methodname>get_builtin_pixbuf()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconinfo--get-builtin-pixbuf">
- <title>gtk.IconInfo.get_builtin_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_builtin_pixbuf</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the built-in image pixbuf, or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_builtin_pixbuf</methodname>() method returns
-the built-in image for this icon, if any. To allow <literal>GTK+</literal>
-to use built in icon images, you must pass the
-<literal>gtk.ICON_LOOKUP_USE_BUILTIN</literal> to the <link
-linkend="method-gtkicontheme--lookup-icon"><methodname>gtk.IconTheme.lookup_icon()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconinfo--load-icon">
- <title>gtk.IconInfo.load_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>load_icon</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the icon rendered into a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.
- This may be a newly created icon or a new reference to an internal
- icon, so you must not modify the icon.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>load_icon</methodname>() method renders the icon
-previously looked up in an icon theme using the <link
-linkend="method-gtkicontheme--lookup-icon"><methodname>gtk.IconTheme.lookup_icon()</methodname></link>
-method. The icon size will be based on the size passed to the <link
-linkend="method-gtkicontheme--lookup-icon"><methodname>gtk.IconTheme.lookup_icon()</methodname></link>
-method. Note that the resulting <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> may
-not be exactly this size. An icon theme may have icons that differ slightly
-from their nominal sizes, and in addition <literal>GTK</literal>+ will avoid
-scaling icons that it considers sufficiently close to the requested size to
-maintain sharpness.</para>
-
- <para>This method raise the GError exception if an error occurs during
-rendering of the icon.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconinfo--set-raw-coordinates">
- <title>gtk.IconInfo.set_raw_coordinates</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_raw_coordinates</methodname>
- <methodparam><parameter role="keyword">raw_coordinates</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">raw_coordinates</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the coordinates of
- embedded rectangles and attached points should be returned in
- their original (unscaled) form.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_raw_coordinates</methodname>() method sets
-the internal raw_coordinates flag to the value of
-<parameter>raw_coordinates</parameter>. If
-<parameter>raw_coordinates</parameter> is <literal>True</literal>, the
-coordinates returned by the <link
-linkend="method-gtkiconinfo--get-embedded-rect"><methodname>get_embedded_rect()</methodname></link>
-and <link
-linkend="method-gtkiconinfo--get-attach-points"><methodname>get_attach_points()</methodname></link>
-methods will be returned in their original form as specified in the icon
-theme, instead of scaled appropriately for the pixbuf returned by the <link
-linkend="method-gtkiconinfo--load-icon"><methodname>load_icon()</methodname></link>
-method.</para>
-
- <para>Raw coordinates are somewhat strange; they are specified to be
-with respect to the unscaled pixmap for <literal>PNG</literal> and
-<literal>XPM</literal> icons, but for <literal>SVG</literal> icons, they are
-in a 1000x1000 coordinate space that is scaled to the final size of the
-icon. You can determine if the icon is an <literal>SVG</literal> icon by
-using the <link
-linkend="method-gtkiconinfo--get-filename"><methodname>get_filename()</methodname></link>
-method, and seeing if it is not <literal>None</literal> and ends in '.svg'.</para>
-
- <para>This method is provided primarily to allow compatibility
-wrappers for older API's, and is not expected to be useful for
-applications.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconinfo--get-embedded-rect">
- <title>gtk.IconInfo.get_embedded_rect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_embedded_rect</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
- or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_embedded_rect</methodname>() method returns
-a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-containing the coordinates of a rectangle within the icon that can be used
-for display of information such as a preview of the contents of a text file.
-See the <link
-linkend="method-gtkiconinfo--set-raw-coordinates"><methodname>set_raw_coordinates()</methodname></link>
-method for further information about the coordinate system.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconinfo--get-attach-points">
- <title>gtk.IconInfo.get_attach_points</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_attach_points</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a set of 2-tuples for the
- attach points</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_attach_points</methodname>() method returns
-a tuple containing the attach points for an icon as a set of 2-tuples. An
-attach point is a location in the icon that can be used as anchor points for
-attaching emblems or overlays to the icon.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconinfo--get-display-name">
- <title>gtk.IconInfo.get_display_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_display_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the display name for the icon or <literal>None</literal>, if
-the icon doesn't have a specified display name.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_display_name</methodname>() method returns the display name for an icon. A display name is a
-string to be used in place of the icon name in a user
-visible context like a list of icons.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkiconset.xml b/docs/reference/pygtk-gtkiconset.xml
deleted file mode 100644
index 69261c70..00000000
--- a/docs/reference/pygtk-gtkiconset.xml
+++ /dev/null
@@ -1,282 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkiconset">
- <refnamediv>
- <refname>gtk.IconSet</refname>
- <refpurpose>contains a set of variants for an icon</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.IconSet</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkiconset">gtk.IconSet</link></methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconset--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconset--render-icon">render_icon</link></methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconset--add-source">add_source</link></methodname>
- <methodparam><parameter
- role="keyword">source</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconset--get-sizes">get_sizes</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>
-contains a set of variants for a single icon. The variants provide icons of
-different sizes and for different widget states. The variants can be added
-with the <link
-linkend="method-gtkiconset--add-source"><methodname>add_source</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkiconset">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.IconSet</methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link> with
-<parameter>pixbuf</parameter> as the default fallback source image. If
-<parameter>pixbuf</parameter> is <literal>None</literal> there is no default
-fallback source image. If you don't add any additional <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link>s
-to the icon set, all variants of the icon will be created from
-<parameter>pixbuf</parameter>, using scaling, pixelation, etc. as required
-to adjust the icon size or make the icon look insensitive/prelighted.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkiconset--copy">
- <title>gtk.IconSet.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>
-identical to the first.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns a copy of the
-icon set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconset--render-icon">
- <title>gtk.IconSet.render_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>render_icon</methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">style</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> associated
-with <parameter>widget</parameter>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">direction</parameter>&nbsp;:</term>
- <listitem><simpara>the text direction; one of:
-<literal>gtk.TEXT_DIR_NONE</literal>, <literal>gtk.TEXT_DIR_LTR</literal>,
-<literal>gtk.TEXT_DIR_RTL</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">state</parameter>&nbsp;:</term>
- <listitem><simpara>the widget state; one of:
-<literal>gtk.STATE_NORMAL</literal>, <literal>gtk.STATE_ACTIVE</literal>,
-<literal>gtk.STATE_PRELIGHT</literal>,
-<literal>gtk.STATE_SELECTED</literal>,
-<literal>gtk.STATE_INSENSITIVE</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the icon size; one of:
-<literal>gtk.ICON_SIZE_INVALID</literal>,
-<literal>gtk.ICON_SIZE_MENU</literal>,
-<literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_BUTTON</literal>,
-<literal>gtk.ICON_SIZE_DND</literal>,
-<literal>gtk.ICON_SIZE_DIALOG</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that will display the icon, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>the detail to pass to the theme engine, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> to be
-displayed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>render_icon</methodname>() method renders an
-icon using <link
-linkend="method-gtkstyle--render-icon"><function>gtk.Style.render_icon()</function></link>.
-In most cases, <link
-linkend="method-gtkwidget--render-icon"><function>gtk.Widget.render_icon()</function></link>
-is better, since it automatically provides most of the arguments from the
-current widget settings. This method never returns <literal>None</literal>;
-if the icon can't be rendered (perhaps because an image file fails to load),
-a default "missing image" icon will be returned instead.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconset--add-source">
- <title>gtk.IconSet.add_source</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_source</methodname>
- <methodparam><parameter
- role="keyword">source</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">source</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_source</methodname>() method adds the <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link>
-specified by <parameter>source</parameter> to the icon set. Icon sets have
-a list of <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link>,
-which they use as base icons for rendering icons in different states and
-sizes. Icons are scaled, made to look insensitive, etc. in the <link
-linkend="method-gtkiconset--render-icon"><methodname>render_icon</methodname>()</link>
-method, but <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link> needs
-base images to work with. The base images and when to use them are described
-by a <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link>.</para>
-
- <para>An example of when you'd use this method: a web browser's
-"<guibutton>Back to Previous Page</guibutton>" icon might point in a
-different direction in Hebrew and in English; it might look different when
-insensitive; and it might change size depending on toolbar mode (small
-or large icons). So a single icon set would contain all those variants of the
-icon, and you might add a separate source for each one.</para>
-
- <para>You should nearly always add a "default" icon source with all
-fields wildcarded, which will be used as a fallback if no more specific
-source matches. <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link> always
-prefers more specific icon sources to more generic icon sources. The order
-in which you add the sources to the icon set does not matter.</para>
-
- <para>The <link
-linkend="constructor-gtkiconset"><methodname>gtk.IconSet</methodname>()</link>
-constructor creates a new icon set with a default icon source based on the
-given pixbuf.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconset--get-sizes">
- <title>gtk.IconSet.get_sizes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_sizes</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing all the icon sizes supported
-by the icon set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_sizes</methodname>() method returns a tuple
-containing all the icon sizes this icon set can render.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkiconsource.xml b/docs/reference/pygtk-gtkiconsource.xml
deleted file mode 100644
index 9b967cb8..00000000
--- a/docs/reference/pygtk-gtkiconsource.xml
+++ /dev/null
@@ -1,976 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkiconsource">
- <refnamediv>
- <refname>gtk.IconSource</refname>
- <refpurpose>a source for icon variants</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.IconSource</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkiconsource">gtk.IconSource</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--copy">copy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--free">free</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--set-filename">set_filename</link></methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--set-pixbuf">set_pixbuf</link></methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--get-filename">get_filename</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--get-pixbuf">get_pixbuf</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--set-direction-wildcarded">set_direction_wildcarded</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--set-state-wildcarded">set_state_wildcarded</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--set-size-wildcarded">set_size_wildcarded</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--get-size-wildcarded">get_size_wildcarded</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--get-state-wildcarded">get_state_wildcarded</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--get-direction-wildcarded">get_direction_wildcarded</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--set-direction">set_direction</link></methodname>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--set-state">set_state</link></methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--set-size">set_size</link></methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--get-direction">get_direction</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--get-state">get_state</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--get-size">get_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--set-state">set_icon_name</link></methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkiconsource--get-size">get_icon_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-lookup">gtk.icon_size_lookup</link></methodname>
- <methodparam><parameter
- role="keyword">icon_size</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-lookup-for-settings">gtk.icon_size_lookup_for_settings</link></methodname>
- <methodparam><parameter
- role="keyword">settings</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon_size</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-register">gtk.icon_size_register</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-register-alias">gtk.icon_size_register_alias</link></methodname>
- <methodparam><parameter
- role="keyword">alias</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-from-name">gtk.icon_size_from_name</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--icon-size-get-name">gtk.icon_size_get_name</link></methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link>
-contains a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> (or
-an image filename) that serves as the base image for one or more of the
-icons in a <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>, along
-with a specification for which icons in the icon set will be based on that
-pixbuf or image file. By default, the icon source has all parameters
-wildcarded. That is, the icon source can be used as the base icon for any
-desired text direction, widget state, or icon size.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkiconsource">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.IconSource</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link>.
-A <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link>
-contains a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> (or
-image filename) that serves as the base image for one or more of the icons
-in a <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>, along
-with a specification for which icons in the icon set will be based on that
-pixbuf or image file. By default, the icon source has all parameters
-wildcarded. That is, the icon source will be used as the base icon for any
-desired text direction, widget state, or icon size.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkiconsource--copy">
- <title>gtk.IconSource.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method creates a copy of the
-icon source.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--free">
- <title>gtk.IconSource.free</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>free</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <warning>
- <para>This method is deprecated and should not be used. Use of this
-method may cause your application to crash.</para>
- </warning>
-
- <para>The <methodname>free</methodname>() method frees a
-dynamically-allocated icon source, along with its filename, size, and pixbuf
-fields if those are not <literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--set-filename">
- <title>gtk.IconSource.set_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_filename</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the image file to use</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_filename</methodname>() method sets the name
-of the image file (specified by <parameter>filename</parameter>) to use as
-the base image when creating icon variants for a <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>. The
-filename must be absolute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--set-pixbuf">
- <title>gtk.IconSource.set_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_pixbuf</methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>the pixbuf to use as a
-source</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_pixbuf</methodname>() method sets a pixbuf
-(specified by <parameter>pixbuf</parameter>) to use as a base image when
-creating icon variants for a <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>. If an
-icon source has both a filename and a pixbuf set, the pixbuf will take
-priority.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--get-filename">
- <title>gtk.IconSource.get_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_filename</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the image filename</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_filename</methodname>() method retrieves the
-source filename, or <literal>None</literal> if none is set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--get-pixbuf">
- <title>gtk.IconSource.get_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixbuf</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the source pixbuf</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixbuf</methodname>() method retrieves the
-source pixbuf, or <literal>None</literal> if none is set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--set-direction-wildcarded">
- <title>gtk.IconSource.set_direction_wildcarded</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_direction_wildcarded</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> wildcard the text
-direction</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_direction_wildcarded</methodname>() method
-determines whether the icon source direction is wildcarded according to the
-value specified by <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal> the text direction
-is wildcarded and the icon source can be used as the base image for an icon
-in any text direction (<literal>gtk.TEXT_DIR_NONE</literal>,
-<literal>gtk.TEXT_DIR_LTR</literal> or <literal>gtk.TEXT_DIR_RTL</literal>).
-If the text direction is not wildcarded, then the text direction the icon
-source applies to should be set with the <link
-linkend="method-gtkiconsource--set-direction"><methodname>set_direction</methodname>()</link>
-method and the icon source will only be used with that text direction.
-Non-wildcarded icon sources (exact matches) are preferred over wildcarded
-icon sources. An exact match will be used when possible.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--set-state-wildcarded">
- <title>gtk.IconSource.set_state_wildcarded</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_state_wildcarded</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> wildcard the widget
-state</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_state_wildcarded</methodname>() method
-determines whether the icon source state is wildcarded according to the
-value of <parameter>setting</parameter>. If <parameter>setting</parameter>
-is <literal>True</literal> the widget state is wildcarded and the icon
-source can be used as the base image for an icon in any widget state
-(<literal>gtk.STATE_NORMAL</literal>, <literal>gtk.STATE_ACTIVE</literal>,
-<literal>gtk.STATE_PRELIGHT</literal>, <literal>gtk.STATE_SELECTED</literal>
-or <literal>gtk.STATE_INSENSITIVE</literal>). If the widget state is not
-wildcarded, then the widget state the icon source applies to should be set
-with the <link
-linkend="method-gtkiconsource--set-state"><methodname>set_state</methodname>()</link>
-method and the icon source will only be used with that specific state.
-Non-wildcarded icon sources (exact matches) are preferred over wildcarded
-icon sources. An exact match will be used when possible.</para>
-
- <para>A <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link> will
-normally transform wildcarded icon source images to produce an appropriate
-icon for a given state, for example lightening an image on prelight, but
-will not modify source images that match exactly.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--set-size-wildcarded">
- <title>gtk.IconSource.set_size_wildcarded</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_size_wildcarded</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> wildcard the widget
-state</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_size_wildcarded</methodname>() determines
-whether the icon source can be used as the basis for an icon of any size
-according to the value of <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal> the icon size is
-wildcarded and the icon source can be used as the base image for an icon of
-any size. If the size is not wildcarded, then the size the icon source
-applies to should be set with <link
-linkend="method-gtkiconsource--set-size"><function>gtk.IconSource.set_size()</function></link>
-and the icon source will only be used with that specific size.
-Non-wildcarded icon sources (exact matches) are preferred over wildcarded
-icon sources. An exact match will be used when possible.</para>
-
- <para><link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link> will
-normally scale wildcarded source images to produce an appropriate icon at a
-given size, but will not change the size of source images that match
-exactly.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--get-size-wildcarded">
- <title>gtk.IconSource.get_size_wildcarded</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size_wildcarded</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if this icon source is
-a base for any icon size variant</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_size_wildcarded</methodname>() method gets
-the value set by the <link
-linkend="method-gtkiconsource--set-size-wildcarded"><methodname>set_size_wildcarded</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--get-state-wildcarded">
- <title>gtk.IconSource.get_state_wildcarded</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_state_wildcarded</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if this icon source is
-a base for any widget state variant</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_state_wildcarded</methodname>() method gets
-the value set by the <link
-linkend="method-gtkiconsource--set-state-wildcarded"><methodname>set_state_wildcarded</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--get-direction-wildcarded">
- <title>gtk.IconSource.get_direction_wildcarded</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_direction_wildcarded</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if this icon source is
-a base for any text direction variant</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_direction_wildcarded</methodname>() method
-gets the value set by the <link
-linkend="method-gtkiconsource--set-direction-wildcarded"><methodname>set_direction_wildcarded</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--set-direction">
- <title>gtk.IconSource.set_direction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_direction</methodname>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">direction</parameter>&nbsp;:</term>
- <listitem><simpara>the text direction this icon source applies
-to</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_direction</methodname>() method sets the
-text direction according to the value of <parameter>direction</parameter>
-that the icon source is intended to be used with. The value of direction
-must be one of: <literal>gtk.TEXT_DIR_NONE</literal>,
-<literal>gtk.TEXT_DIR_LTR</literal> or
-<literal>gtk.TEXT_DIR_RTL</literal>.</para>
-
- <para>Setting the text direction on an icon source makes no difference
-if the text direction is wildcarded. Therefore, you should usually call the
-<link
-linkend="method-gtkiconsource--set-direction-wildcarded"><methodname>set_direction_wildcarded</methodname>()</link>
-method with a setting of <literal>False</literal> to un-wildcard it in
-addition to calling this function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--set-state">
- <title>gtk.IconSource.set_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_state</methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">state</parameter>&nbsp;:</term>
- <listitem><simpara>the widget state this source applies
-to</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_state</methodname>() method sets the widget
-state specified by <parameter>state</parameter> that the icon source is
-intended to be used with. The value of <parameter>state</parameter> must be
-one of: <literal>gtk.STATE_NORMAL</literal>,
-<literal>gtk.STATE_ACTIVE</literal>, <literal>gtk.STATE_PRELIGHT</literal>,
-<literal>gtk.STATE_SELECTED</literal> or
-<literal>gtk.STATE_INSENSITIVE</literal>. Setting the widget state on an
-icon source makes no difference if the state is wildcarded. Therefore, you
-should usually call the <link
-linkend="method-gtkiconsource--set-state-wildcarded"><methodname>set_state_wildcarded</methodname>()</link>
-method with a setting of <literal>False</literal> to un-wildcard it in
-addition to calling this function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--set-size">
- <title>gtk.IconSource.set_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_size</methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the icon size this source applies
-to</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_size</methodname>() method sets the icon
-size specified by <parameter>size</parameter> that the icon source is
-intended to be used with. Setting the icon size for an icon source makes no
-difference if the size is wildcarded. Therefore, you should usually call the
-<link
-linkend="method-gtkiconsource--set-size-wildcarded"><function>gtk.IconSource.set_size_wildcarded()</function></link>
-method with a setting of <literal>False</literal> to un-wildcard it in
-addition to calling this function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--get-direction">
- <title>gtk.IconSource.get_direction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_direction</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the text direction the icon source
-matches</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_direction</methodname>() method obtains the
-text direction this icon source applies to. The return value is only useful
-and meaningful if the text direction is <emphasis>not</emphasis>
-wildcarded.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--get-state">
- <title>gtk.IconSource.get_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_state</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the widget state the icon source
-matches</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_state</methodname>() method obtains the
-widget state this icon source applies to. The return value is only useful
-and meaningful if the widget state is <emphasis>not</emphasis>
-wildcarded.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--get-size">
- <title>gtk.IconSource.get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the icon size this source
-matches.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_size</methodname>() method obtains the icon
-size this source applies to. The return value is only useful and meaningful
-if the icon size is <emphasis>not</emphasis> wildcarded.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--set-icon-name">
- <title>gtk.IconSource.set_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_name</methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>an icon name
-to</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_icon_name</methodname>() method uses the
-name specified by <parameter>icon_name</parameter> to look up an icon in the
-current icon theme to use as a base image when creating icon variants for
-<link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>.</para>
-
- <para>In PyGTK 2.10 and above, <parameter>icon_name</parameter> may be
-<literal>None</literal> to unset the icon name.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconsource--get-icon-name">
- <title>gtk.IconSource.get_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_name</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the icon name or <literal>None</literal> if no
-name is set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_icon</methodname>() method returns the
- source icon name, or <literal>None</literal> if no name is set.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--icon-size-lookup">
- <title>gtk.icon_size_lookup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.icon_size_lookup</methodname>
- <methodparam><parameter
- role="keyword">icon_size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">icon_size</parameter>&nbsp;:</term>
- <listitem><simpara> an icon size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the width and height of
-the specified <parameter>icon_size</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.icon_size_lookup</function>() function returns
-a 2-tuple containing the width and height of the icon size specified by
-<parameter>icon_size</parameter>. The value of
-<parameter>icon_size</parameter> must be one of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_MENU</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_BUTTON</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_DND</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_DIALOG</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para>or an integer value returned from the <link
-linkend="function-gtk--icon-size-register"><function>gtk.icon_size_register</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--icon-size-lookup-for-settings">
- <title>gtk.icon_size_lookup_for_settings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.icon_size_lookup_for_settings</methodname>
- <methodparam><parameter
- role="keyword">settings</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon_size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">settings</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object used to determine which user preferences to use.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">icon_size</parameter>&nbsp;:</term>
- <listitem><simpara> an icon size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the width and height of
-the specified <parameter>icon_size</parameter> or <literal>None</literal>
-if <parameter>icon_size</parameter> was invalid.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.icon_size_lookup_for_settings</function>()
-function returns a 2-tuple containing the width and height of the icon size
-specified by <parameter>icon_size</parameter> of <literal>None</literal> if
-<parameter>icon_size</parameter> was not valid. The value of
-<parameter>icon_size</parameter> must be one of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_MENU</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_BUTTON</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_DND</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_DIALOG</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para>or an integer value returned from the <link
-linkend="function-gtk--icon-size-register"><function>gtk.icon_size_register</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--icon-size-register">
- <title>gtk.icon_size_register</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.icon_size_register</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the icon size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the icon size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the icon
-size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer representing the icon
-size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.icon_size_register</function>() function
-registers a new icon size for the specified <parameter>width</parameter> and
-<parameter>height</parameter> with the specified <parameter>name</parameter>
-and returns the integer used to represent the icon size.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--icon-size-register-alias">
- <title>gtk.icon_size_register_alias</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.icon_size_register_alias</methodname>
- <methodparam><parameter
- role="keyword">alias</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">alias</parameter>&nbsp;:</term>
- <listitem><simpara>an alias for
-<parameter>target</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>an integer representing an existing icon
-size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.icon_size_register_alias</function>() function
-registers the specified <parameter>alias</parameter> as another name for the
-icon size specified by <parameter>target</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--icon-size-from-name">
- <title>gtk.icon_size_from_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.icon_size_from_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a name of an existing icon
-size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the icon size associated with
-<parameter>name</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.icon_size_from_name</function>() function
-returns the integer representing the icon size associated with the specified
-<parameter>name</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--icon-size-get-name">
- <title>gtk.icon_size_get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.icon_size_get_name</methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>an integer representing an existing icon
-size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name associated with the icon size
-represented by <parameter>size</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.icon_size_get_name</function>() function
-returns the name of the icon size represented by
-<parameter>size</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkicontheme.xml b/docs/reference/pygtk-gtkicontheme.xml
deleted file mode 100644
index 50978f00..00000000
--- a/docs/reference/pygtk-gtkicontheme.xml
+++ /dev/null
@@ -1,892 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkicontheme">
- <refnamediv>
- <refname>gtk.IconTheme</refname>
- <refpurpose>look up icons by name and size (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.IconTheme</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkicontheme">gtk.IconTheme</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--set-screen">set_screen</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--set-search-path">set_search_path</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--get-search-path">get_search_path</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--append-search-path">append_search_path</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--prepend-search-path">prepend_search_path</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--set-custom-theme">set_custom_theme</link></methodname>
- <methodparam><parameter role="keyword">theme_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--has-icon">has_icon</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--lookup-icon">lookup_icon</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- <methodparam><parameter role="keyword">flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--load-icon">load_icon</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- <methodparam><parameter role="keyword">flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--list-icons">list_icons</link></methodname>
- <methodparam><parameter role="keyword">context</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--get-example-icon-name">get_example_icon_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--rescan-if-needed">rescan_if_needed</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkicontheme--get-icon-sizes">get_icon_sizes</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--icon-theme-get-default">gtk.icon_theme_get_default</link></methodname>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--icon-theme-get-for-screen">gtk.icon_theme_get_for_screen</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--icon-theme-add-builtin-icon">gtk.icon_theme_add_builtin_icon</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis>
-</programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkicontheme">gtk.IconTheme</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkicontheme">
- <title>gtk.IconTheme Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkicontheme--changed">changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>icontheme</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para><link
-linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>
-provides a facility for looking up icons by name and size. The main reason
-for using a name rather than simply providing a filename is to allow
-different icons to be used depending on what icon theme is selected by the
-user. The operation of icon themes on Linux and Unix follows the <ulink
-url="http://www.freedesktop.org/Standards/icon-theme-spec">Icon Theme
-Specification</ulink>). There is a default icon theme, named "hicolor" where
-applications should install their icons, but more additional application
-themes can be installed as operating system vendors and users choose.</para>
-
- <para>Named icons are similar to the Themeable Stock Images facility
-(see <link
-linkend="class-gtkiconfactory"><classname>gtk.IconFactory</classname></link>,
-<link linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>
-and <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link>
-for more detail), and the distinction between the two may be a bit
-confusing. A few things to keep in mind:</para>
-
- <itemizedlist>
- <listitem>
- <para>Stock images usually are used in conjunction with <link
-linkend="gtk-stock-items">Stock Items</link>, such as
-<literal>gtk.STOCK_OK</literal> or <literal>gtk.STOCK_OPEN</literal>. Named
-icons are easier to set up and therefore are more useful for new icons that
-an application wants to add, such as application icons or window
-icons.</para>
- </listitem>
- <listitem>
- <para>Stock images can only be loaded at the symbolic sizes defined
-by the standard icon sizes (see the <link
-linkend="function-gtk--icon-size-lookup"><function>gtk.icon_size_lookup</function>()</link>
-function), or by custom sizes defined by the <link
-linkend="function-gtk--icon-size-register"><function>gtk.icon_size_register</function>()</link>
-function, while named icons are more flexible and any pixel size can be
-specified.</para>
- </listitem>
- <listitem>
- <para>Because stock images are closely tied to stock items, and thus
-to actions in the user interface, stock images may come in multiple variants
-for different widget states or writing directions.</para>
- </listitem>
- </itemizedlist>
-
- <para>A good rule of thumb is that if there is a stock image for what
-you want to use, use it, otherwise use a named icon. It turns out that
-internally stock images are generally defined in terms of one or more named
-icons. (An example is icons that depend on writing direction;
-<literal>gtk.STOCK_GO_FORWARD</literal> uses the two themed icons
-"gtk-stock-go-forward-ltr" and "gtk-stock-go-forward-rtl".)</para>
-
- <para>In many cases, named themes are used indirectly, via <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> or stock
-items, rather than directly, but looking up icons directly is also
-simple. The <link
-linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>
-object acts as a database of all the icons in the current theme. You can
-create new <link
-linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>
-objects, but its much more efficient to use the standard icon theme for the
-<link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-so that the icon information is shared with other people looking up
-icons. In the case where the default screen is being used, looking up an
-icon can be as simple as:</para>
-
- <programlisting>
- icon_theme = gtk.icon_theme_get_default()
- try:
- pixbuf = icon_theme.load_icon("my-icon-name", 48, 0)
- except gobject.GError, exc:
- print "can't load icon", exc
-</programlisting>
-
- <para></para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkicontheme">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.IconTheme</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the newly created <link
-linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new icon theme object. Icon theme objects are used to
-lookup up an icon by name in a particular icon theme. Usually, you'll want
-to use the <link
-linkend="function-gtk--icon-theme-get-default"><function>gtk.icon_theme_get_default</function>()</link>
-or <link
-linkend="function-gtk--icon-theme-get-for-screen"><function>gtk.icon_theme_get_for_screen</function>()</link>
-functions rather than creating a new icon theme object from scratch.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkicontheme--set-screen">
- <title>gtk.IconTheme.set_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_screen</methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_screen</methodname>() method sets the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> for
-an icon theme to <parameter>screen</parameter>. The screen is used to track
-the user's currently configured icon theme, which might be different for
-different screens.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--set-search-path">
- <title>gtk.IconTheme.set_search_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_search_path</methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a list or tuple of directories that are
- searched for icon themes</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_search_path</methodname>() method sets the
-search path for the icon theme object to the list of directory names
-contained in <parameter>path</parameter>. When looking for an icon theme,
-<literal>GTK+</literal> will search for a subdirectory of one or more of the
-directories in <parameter>path</parameter> with the same name as the icon
-theme. (Themes from multiple of the path elements are combined to allow
-themes to be extended by adding icons in the user's home directory.)</para>
-
- <para>In addition if an icon found isn't found either in the current
-icon theme or the default icon theme, and an image file with the right name
-is found directly in one of the elements of <parameter>path</parameter>,
-then that image will be used for the icon name. (This is a legacy feature,
-and new icons should be put into the default icon theme, which is called
-"hicolor", rather than directly on the icon path.)</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--get-search-path">
- <title>gtk.IconTheme.get_search_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_search_path</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the list of directory names
- that are searched for icon themes</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_search_path</methodname>() method returns a
-tuple containing the current search path. See the <link
-linkend="method-gtkicontheme--set-search-path"><methodname>set_search_path()</methodname></link>
-method for more details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--append-search-path">
- <title>gtk.IconTheme.append_search_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append_search_path</methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a directory name to append to the icon
-path</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>append_search_path</methodname>() method appends
-the directory name specified by <parameter>path</parameter> to the search
-path. See the <link
-linkend="method-gtkicontheme--set-search-path"><methodname>set_search_path()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--prepend-search-path">
- <title>gtk.IconTheme.prepend_search_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend_search_path</methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a directory name to prepend to the icon
-path</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>prepend_search_path</methodname>() method
-prepends the directory name specified by <parameter>path</parameter> to the
-search path. See the <link
-linkend="method-gtkicontheme--set-search-path"><methodname>set_search_path()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--set-custom-theme">
- <title>gtk.IconTheme.set_custom_theme</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_custom_theme</methodname>
- <methodparam><parameter role="keyword">theme_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">theme_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of icon theme to use instead of
-the configured theme</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_custom_theme</methodname>() method sets the
-theme used by the icon theme object to the theme named by
-<parameter>theme_name</parameter> usually replacing system configured
-theme. This method cannot be called on the icon theme objects returned from
-the <link
-linkend="function-gtk--icon-theme-get-default"><function>gtk.icon_theme_get_default</function>()</link>
-and <link
-linkend="function-gtk--icon-theme-get-default"><function>gtk.icon_theme_get_default</function>()</link>
-functions.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--has-icon">
- <title>gtk.IconTheme.has_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>has_icon</methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of an icon</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the icon theme
- includes an icon for
- <parameter>icon_name</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>has_icon</methodname>() method checks whether
-the icon theme includes an icon for the icon name specified by
-<parameter>icon_name</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--lookup-icon">
- <title>gtk.IconTheme.lookup_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>lookup_icon</methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- <methodparam><parameter role="keyword">flags</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the icon to lookup</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the desired icon size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>the flags modifying the behavior of the icon
- lookup</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link>
- object containing information about the icon, or
- <literal>None</literal> if the icon wasn't found. Free with the
- <link
- linkend="method-gtkiconinfo--free"><methodname>gtk.IconInfo.free()</methodname></link>
- method</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>lookup_icon</methodname>() method looks up the
-icon specified by <parameter>icon_name</parameter>,
-<parameter>size</parameter> and <parameter>flags</parameter> and returns a
-<link linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link>
-object containing information such as the filename of the icon. The icon can
-then be rendered into a pixbuf using the <link
-linkend="method-gtkiconinfo--load-icon"><methodname>gtk.IconInfo.load_icon()</methodname></link>
-method. (the <link
-linkend="method-gtkicontheme--load-icon"><methodname>load_icon()</methodname></link>
-method combines these two steps if all you need is the pixbuf.)</para>
-
- <para>The value of flags must be a combination of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.ICON_LOOKUP_NO_SVG</literal></term>
- <listitem>
- <simpara>Never return Scalable Vector Graphics (SVG) icons, even
- if gdk-pixbuf supports them. Cannot be used together with
- <literal>gtk.ICON_LOOKUP_FORCE_SVG</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_LOOKUP_FORCE_SVG</literal></term>
- <listitem>
- <simpara> Return SVG icons, even if gdk-pixbuf doesn't support
- them. Cannot be used together with
- <literal>gtk.ICON_LOOKUP_NO_SVG</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.ICON_LOOKUP_USE_BUILTIN</literal></term>
- <listitem>
- <simpara>When passed to the <link
- linkend="method-gtkicontheme--lookup-icon"><methodname>lookup_icon</methodname>()</link>
- method includes builtin icons as well as files. For a builtin
- icon, the <link
- linkend="method-gtkiconinfo--get-filename"><methodname>gtk.IconInfo.get_filename</methodname>()</link>
- method returns <literal>None</literal> and you need to call the
- <link
- linkend="method-gtkiconinfo--get-builtin-pixbuf"><methodname>get_builtin_pixbuf</methodname>()</link>
- method.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--load-icon">
- <title>gtk.IconTheme.load_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>load_icon</methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- <methodparam><parameter role="keyword">flags</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the icon to lookup</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the desired icon size. The resulting icon may
- not be exactly this size; see the <link
- linkend="method-gtkiconinfo--load-icon"><methodname>gtk.IconInfo.load_icon()</methodname></link>
- method.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>the flags modifying the behavior of the icon
- lookup</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
- containing the rendered icon; this may be a newly created icon or
- a new reference to an internal icon, so you must not modify the
- icon.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>load_icon</methodname>() method looks up the
-icon specified by <parameter>icon_name</parameter> in an icon theme, scales
-it to the size specified by <parameter>size</parameter> and renders it into
-a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>. flags
-is a combination of: <literal>gtk.ICON_LOOKUP_FORCE_SVG</literal>,
-<literal>gtk.ICON_LOOKUP_NO_SVG</literal> and
-<literal>gtk.ICON_LOOKUP_USE_BUILTIN</literal> (see the <link
-linkend="method-gtkicontheme--lookup-icon"><methodname>lookup_icon</methodname>()</link>
-method for more details). Since this is a convenience function, if more
-details about the icon are needed, use the <link
-linkend="method-gtkicontheme--lookup-icon"><methodname>lookup_icon()</methodname></link>
-method followed by the <link
-linkend="method-gtkiconinfo--load-icon"><methodname>GtkIconInfo.load_icon()</methodname></link>
-method.</para>
-
- <para>This method raise the GError exception if an error occurs during
-rendering of the icon.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--list-icons">
- <title>gtk.IconTheme.list_icons</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_icons</methodname>
- <methodparam><parameter role="keyword">context</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">context</parameter>&nbsp;:</term>
- <listitem><simpara>a string identifying a particular type of icon,
- or <literal>None</literal> to list all icons.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the names of all the
-icons in the theme.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>list_icons</methodname>() method lists the icons
-in the current icon theme. Only a subset of the icons can be listed by
-providing a string specified by <parameter>context</parameter>. The set of
-values for the context string is system dependent, but will typically
-include such values as 'apps' and 'mimetypes'.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--get-example-icon-name">
- <title>gtk.IconTheme.get_example_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_example_icon_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of an example icon or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_example_icon_name</methodname>() method
-returns the name of an icon that is representative of the current theme (for
-instance, to use when presenting a list of themes to the user.)</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--rescan-if-needed">
- <title>gtk.IconTheme.rescan_if_needed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>rescan_if_needed</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the icon theme has
- changed and needed to be reloaded.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>rescan_if_needed</methodname>() method checks to
-see if the icon theme has changed; if it has, any currently cached
-information is discarded and will be reloaded next time the icon theme is
-accessed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkicontheme--get-icon-sizes">
- <title>gtk.IconTheme.get_icon_sizes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_sizes</methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of an icon</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the sizes that the icon is
-available in.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_icon_sizes</methodname>() method returns a
-tuple containing the sizes available for the icon named by
-<parameter>icon_name</parameter>. A size of -1 means the icon is
-scalable. If the icon is not found an empty tuple is returned.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--icon-theme-get-default">
- <title>gtk.icon_theme_get_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.icon_theme_get_default</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A unique <link
- linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>
- associated with the default <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>. This
- icon theme is associated with the screen and can be used as long
- as the screen is open.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.icon_them_get_default</function>() function
-returns the icon theme for the default screen. See the <link
-linkend="function-gtk--icon-theme-get-for-screen"><function>gtk.icon_theme_get_for_screen</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--icon-theme-get-for-screen">
- <title>gtk.icon_theme_get_for_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.icon_theme_get_for_screen</methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
- object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A unique <link
- linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>
- associated with the default <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>. This
- icon theme is associated with the screen and can be used as long
- as the screen is open.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.icon_theme_get_for_screen</function>()
-function returns the icon theme object associated with the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-specified by <parameter>screen</parameter>. If this function has not
-previously been called for the given screen, a new icon theme object will be
-created and associated with the screen. Icon theme objects are fairly
-expensive to create, so using this function is usually a better choice than
-calling the <link linkend="constructor-gtkicontheme">gtk.IconTheme</link>()
-constructor and setting the screen yourself; by using this function a single
-icon theme object will be shared between users.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--icon-theme-add-builtin-icon">
- <title>gtk.icon_theme_add_builtin_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.icon_theme_add_builtin_icon</methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara> the name of the icon to
- register</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara> the size at which to register the icon
- (different images can be registered for the same icon name at
- different sizes.)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
- that contains the image to use for
- <parameter>icon_name</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.icon_theme_add_builtin_icon</function>()
-function registers a built-in icon for icon theme lookups using
-<parameter>icon_name</parameter> as the icon name,
-<parameter>size</parameter> as the icon size and
-<parameter>pixbuf</parameter> as the icon image. The idea of built-in icons
-is to allow an application or library that uses themed icons to function
-without requiring specific icon files to be present in the file system. For
-instance, the default images for all of <literal>GTK+</literal>'s stock
-icons are registered as built-icons.</para>
-
- <para>In general, if you use
-<function>gtk.icon_theme_add_builtin_icon</function>() you should also
-install the icon in the icon theme, so that the icon is generally
-available. This function will generally be used with pixbufs loaded via the
-<link
-linkend="function-gdk--pixbuf-new-from-inline"><function>gtk.gdk.pixbuf_new_from_inline</function>()</link>
-function.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkicontheme--changed">
- <title>The "changed" gtk.IconTheme Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>icontheme</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>icontheme</parameter>&nbsp;:</term>
- <listitem><simpara>the icontheme that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The "changed" signal is emitted when the current icon theme is
-switched or <literal>GTK+</literal> detects that a change has occurred in
-the contents of the current icon theme.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkiconview.xml b/docs/reference/pygtk-gtkiconview.xml
deleted file mode 100644
index 63e9d8be..00000000
--- a/docs/reference/pygtk-gtkiconview.xml
+++ /dev/null
@@ -1,2408 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkiconview">
- <refnamediv>
- <refname>gtk.IconView</refname>
- <refpurpose>a widget which displays a list of icons in a grid (new in
-PyGTK 2.6)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.IconView</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtkcelllayout">gtk.CellLayout</link></classname></ooclass>
-<constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkiconview">gtk.IconView</link></methodname>
- <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-model">set_model</link></methodname>
- <methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-model">get_model</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-text-column">set_text_column</link></methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-text-column">get_text_column</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-markup-column">set_markup_column</link></methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-markup-column">get_markup_column</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-pixbuf-column">set_pixbuf_column</link></methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-pixbuf-column">get_pixbuf_column</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-path-at-pos">get_path_at_pos</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-item-at-pos">get_item_at_pos</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-cursor">set_cursor</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- <methodparam><parameter role="keyword">cell</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">start_editing</parameter><initializer>False</initializer></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-cursor">get_cursor</link></methodname>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--selected-foreach">selected_foreach</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-selection-mode">set_selection_mode</link></methodname>
- <methodparam><parameter role="keyword">mode</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-selection-mode">get_selection_mode</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-orientation">set_orientation</link></methodname>
- <methodparam><parameter role="keyword">orientation</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-orientation">get_orientation</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-columns">set_columns</link></methodname>
- <methodparam><parameter role="keyword">columns</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-columns">get_columns</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-columns">set_item_width</link></methodname>
- <methodparam><parameter role="keyword">item_width</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-columns">get_item_width</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-columns">set_spacing</link></methodname>
- <methodparam><parameter role="keyword">spacing</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-columns">get_spacing</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-columns">set_row_spacing</link></methodname>
- <methodparam><parameter role="keyword">row_spacing</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-columns">get_row_spacing</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-columns">set_column_spacing</link></methodname>
- <methodparam><parameter role="keyword">column_spacing</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-columns">get_column_spacing</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-columns">set_margin</link></methodname>
- <methodparam><parameter role="keyword">margin</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-columns">get_margin</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--select-path">select_path</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--unselect-path">unselect_path</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--path-is-selected">path_is_selected</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-selected-items">get_selected_items</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--select-all">select_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--unselect-all">unselect_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--item-activated">item_activated</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--scroll-to-path">scroll_to_path</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- <methodparam><parameter role="keyword">use_align</parameter></methodparam>
- <methodparam><parameter role="keyword">row_align</parameter></methodparam>
- <methodparam><parameter role="keyword">col_align</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-visible-range">get_visible_range</link></methodname>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--enable-model-drag-source">enable_model_drag_source</link></methodname>
- <methodparam><parameter role="keyword">start_button_mask</parameter></methodparam>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- <methodparam><parameter role="keyword">actons</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--enable-model-drag-dest">enable_model_drag_dest</link></methodname>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- <methodparam><parameter role="keyword">actions</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--unset-model-drag-source">unset_model_drag_source</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--unset-model-drag-dest">unset_model_drag_dest</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-reorderable">set_reorderable</link></methodname>
- <methodparam><parameter role="keyword">reorderable</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-reorderable">get_reorderable</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--set-drag-dest-item">set_drag_dest_item</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- <methodparam><parameter role="keyword">pos</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-drag-dest-item">get_drag_dest_item</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--get-dest-item-at-pos">get_dest_item_at_pos</link></methodname>
- <methodparam><parameter role="keyword">drag_x</parameter></methodparam>
- <methodparam><parameter role="keyword">drag_y</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkiconview--create-drag-icon">create_drag_icon</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkiconview">gtk.IconView</link> (implements <link linkend="class-gtkcelllayout">gtk.CellLayout</link>)</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkiconview">
- <title>gtk.IconView Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"column-spacing"</entry>
- <entry>Read-Write</entry>
-
- <entry>The space (in pixels) inserted between grid
-columns. Allowed values: >= 0. Default value: 6.
-Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"columns"</entry>
- <entry>Read-Write</entry>
-
- <entry>The number of columns in a row. If it is -1, the number
-of columns will be chosen automatically to fill the available width.
-Allowed values: >= -1. Default value: -1.
-Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"item-width"</entry>
- <entry>Read-Write</entry>
-
- <entry>The width used for each item. If it is -1 the width the
-largest item is used. Allowed values: >= -1. Default value: -1.
-Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"margin"</entry>
- <entry>Read-Write</entry>
-
- <entry>The space (in pixels) inserted at the edges of the
-icon view. Allowed values: >= 0. Default value: 6.
-Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"markup-column"</entry>
- <entry>Read-Write</entry>
-
- <entry>The number of the model column containing markup
-information to be displayed. If this property and the "text-column" property
-are both set to column numbers, this overrides the text column. If both are
-set to -1, no text is displayed. Allowed values: >= -1. Default value: -1.
-Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"model"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-for the icon view. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"orientation"</entry>
- <entry>Read-Write</entry>
- <entry>How the text and icon of each item are positioned
-relative to each other. Default value:
-<literal>gtk.ORIENTATION_VERTICAL</literal>. Available in GTK+ 2.6 and
-above.</entry>
- </row>
-
- <row valign="top">
- <entry>"pixbuf-column"</entry>
- <entry>Read-Write</entry>
-
- <entry>The number of the model column containing the pixbufs
-that are displayed. Setting this property to -1 turns off the display of
-pixbufs. Allowed values: >= -1. Default value: -1. Available in GTK+ 2.6 and
-above.</entry>
- </row>
-
- <row valign="top">
- <entry>"reorderable"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal> the icon view is reorderable.
-Default value: <literal>False</literal>.
-Available in GTK+ 2.8 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"row-spacing"</entry>
- <entry>Read-Write</entry>
-
- <entry>The space (in pixels) inserted between grid rows.
-Allowed values: >= 0. Default value: 6.
-Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"selection-mode"</entry>
- <entry>Read-Write</entry>
-
- <entry>The selection mode of the icon view. If the mode is
-<literal>gtk.SELECTION_MULTIPLE</literal>, rubberband selection is enabled,
-for the other modes, only keyboard selection is possible. Default value:
-<literal>gtk.SELECTION_SINGLE</literal>. Available in GTK+ 2.6 and
-above.</entry>
- </row>
-
- <row valign="top">
- <entry>"spacing"</entry>
- <entry>Read-Write</entry>
-
- <entry>The space (in pixels) inserted between cells of an item.
-Allowed values: >= 0. Default value: 0.
-Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"text-column"</entry>
- <entry>Read-Write</entry>
-
- <entry>The number of the model column containing the text that
-is displayed. If this property and the "markup-column" property are both set
-to -1, no text is displayed. Allowed values: >= -1. Default value:
--1. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkiconview">
- <title>gtk.IconView Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"selection-box-alpha"</entry>
- <entry>Read</entry>
-
- <entry>The opacity of the selection box. Default value:
-64. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"selection-box-color"</entry>
- <entry>Read</entry>
-
- <entry>The color of the selection box. Available in GTK+ 2.6
-and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkiconview">
- <title>gtk.IconView Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkiconview--activate-cursor-item">activate-cursor-item</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkiconview--item-activated">item-activated</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkiconview--move-cursor">move-cursor</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>step</parameter></methodparam>
- <methodparam><parameter>number</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkiconview--select-all">select-all</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkiconview--select-cursor-item">select-cursor-item</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkiconview--selection-changed">selection-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkiconview--set-scroll-adjustments">set-scroll-adjustments</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>hadj</parameter></methodparam>
- <methodparam><parameter>vadj</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkiconview--toggle-cursor-item">toggle-cursor-item</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkiconview--unselect-all">unselect-all</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <link
-linkend="class-gtkiconview"><classname>gtk.IconView</classname></link>
-widget provides an alternative view of a <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
-model. It displays the model as a grid of icons with labels. Like <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>, you
-can select one or multiple items (depending on the selection mode, see the
-<link
-linkend="method-gtkiconview--set-selection-mode"><methodname>set_selection_mode</methodname>()</link>
-method for more information). In addition to selection with the arrow keys,
-<link linkend="class-gtkiconview"><classname>gtk.IconView</classname></link>
-supports rubberband selection, which is controlled by dragging the
-pointer.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkiconview">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.IconView</methodname>
- <methodparam><parameter
- role="keyword">model</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">model</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkiconview"><classname>gtk.IconView</classname></link>
-widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkiconview"><classname>gtk.IconView</classname></link>
-widget. If <parameter>model</parameter> is specified and not
-<literal>None</literal> it should specify a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> to
-be used as the model.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkiconview--set-model">
- <title>gtk.IconView.set_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_model</methodname>
- <methodparam><parameter
- role="keyword">model</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">model</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_model</methodname>() method sets the "model"
-property to the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-specified by <parameter>model</parameter>. If <parameter>model</parameter>
-is <literal>None</literal> the old model will be unset.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-model">
- <title>gtk.IconView.get_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_model</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-used by the cell view or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_model</methodname>() method returns the
-value of the "model" property which contains the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-used by the cell view. If no model is being used this method returns
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-text-column">
- <title>gtk.IconView.set_text_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text_column</methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>The index of a column in the
-model or -1 to unset the column</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_text_column</methodname>() method sets the
-"text-column" property to the value of <parameter>column</parameter> which
-should be the index of a column in the model containing strings to be used
-for text. If <parameter>column</parameter> is -1 the text column is
-unset.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-text-column">
- <title>gtk.IconView.get_text_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text_column</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The index of a model's column or -1 if
-unset.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_text_column</methodname>() method returns
-the value of the "text-column" property which contains the index of the
-column in the model that provides strings to be used for text. If the
-"text-column" property contains -1 then no column is used for text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-markup-column">
- <title>gtk.IconView.set_markup_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_markup_column</methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>The index of a column in the model or -1.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_markup_column</methodname>() method sets the
-"markup-column" property to the value specified by
-<parameter>column</parameter>. The "markup-column" property indicates the
-index of a column in the model to be used for markup information. If
-<parameter>column</parameter> is -1 the markup column will be unset. If the
-markup column is set, it overrides the text column set by the <link
-linkend="method-gtkiconview--set-text-column"><methodname>set_text_column</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-markup-column">
- <title>gtk.IconView.get_markup_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_markup_column</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the index of the model column containing markup
-or -1.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_markup_column</methodname> method returns
-the value of the "markup-column" property which contains the index of the
-column in the model that contains the Pango markup for text. if the
-"markup-column" property is -1, the markup column is unset.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-pixbuf-column">
- <title>gtk.IconView.set_pixbuf_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_pixbuf_column</methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the index of a model column or
--1</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_pixbuf_column</methodname>() method sets the
-"pixbuf-column" property to the value of <parameter>column</parameter>. If
-column >= 0 the icon view <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-objects will be retrieved from the specified column. If
-<parameter>column</parameter> is -1 then no pixbufs will be used,</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-pixbuf-column">
- <title>gtk.IconView.get_pixbuf_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixbuf_column</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The index of a column in the model or
--1</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_pixbuf_column</methodname>() returns the
-value of the "pixbuf-column" property which contains the index of the model
-column use to to retrieve <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-objects to display. If the "pixbuf-column" property is -1 no pixbufs will be
-retrieved.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-path-at-pos">
- <title>gtk.IconView.get_path_at_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_path_at_pos</methodname>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the path at the specified point or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_path_at_pos</methodname>() method returns
-the model path of the icon located at the coordinates specified by
-(<parameter>x</parameter>, <parameter>y</parameter>). This method returns
-<literal>None</literal> if there is no icon at the specified
-location.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-item-at-pos">
- <title>gtk.IconView.get_item_at_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_item_at_pos</methodname>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple comtaining the path and the cell
-renderer at the specified point or <literal>None</literal> if the is no item
-at the position.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_item_at_pos</methodname>() method returns a
-2-tuple containing the model path and cell renderer of the icon located at
-the coordinates specified by (<parameter>x</parameter>,
-<parameter>y</parameter>). This method returns <literal>None</literal> if
-there is no item at the specified location.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-cursor">
- <title>gtk.IconView.set_cursor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_cursor</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cell</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">start_editing</parameter><initializer>False</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a tree path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start_editing</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the specified cell
-should start being edited</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_cursor</methodname>() method sets the
-current keyboard focus to be at the location specified by
-<parameter>path</parameter>, and selects it. This is useful when you want to
-focus the user's attention on a particular item. If
-<parameter>cell</parameter> is not <literal>None</literal>, then focus is
-given to the specified cell. Additionally, if
-<parameter>start_editing</parameter> is <literal>True</literal>, then
-editing should be started in the specified cell.</para>
-
- <para>This method is often followed by <link
- linkend="method-gtkwidget--grab-focus"><methodname>gtk.Widget.grab_focus</methodname>()</link>
- in order to give keyboard focus to the icon view. Please note that editing
- can only happen when the icon view is realized.</para>
-
- <note>
- <para>In PyGTK 2.8 <parameter>cell</parameter> and
- <parameter>start_editing</parameter> must be specified. Also
- <parameter>cell</parameter> cannot be <literal>None</literal>.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-cursor">
- <title>gtk.IconView.get_cursor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_cursor</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the current cursor path
-and cell renderer or <literal>None</literal> if the cursor isn't
-set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_cursor</methodname>() method returns a
-2-tuple containing the model path and <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-at the current cursor location. This method returns <literal>None</literal>
-if the cursor is not set. If no cell renderer has focus then
-<literal>None</literal> will be returned for the cell renderer value.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--selected-foreach">
- <title>gtk.IconView.selected_foreach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>selected_foreach</methodname>
- <methodparam><parameter
- role="keyword">func</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>a callback function or
-method.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>User data to pass to
-<parameter>func</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>selected_foreach</methodname>() method calls the
-callback function or method specified by <parameter>func</parameter> for
-each selected icon. The signature of <parameter>func</parameter> is:</para>
-
- <programlisting>
- def func(<parameter>iconview</parameter>, <parameter>path</parameter>, <parameter>user_data</parameter>):
-</programlisting>
-
- <para>where <parameter>iconview</parameter> is the <link
-linkend="class-gtkiconview"><classname>gtk.IconView</classname></link>,
-<parameter>path</parameter> is the tree path of the icon row and
-<parameter>user_data</parameter> is data.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-selection-mode">
- <title>gtk.IconView.set_selection_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_selection_mode</methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mode</parameter>&nbsp;:</term>
- <listitem><simpara>The selection mode.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_selection_mode</methodname>() method sets
-the "selection-mode" property to the value of
-<parameter>mode</parameter>. <parameter>mode</parameter> should be one of
-the <xref linkend="gtk-selection-mode-constants"
-endterm="gtk-selection-mode-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-selection-mode">
- <title>gtk.IconView.get_selection_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selection_mode</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the selection mode.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_selection_mode</methodname>() method returns
-the value of the "selection-mode" property which contains one of the <xref
-linkend="gtk-selection-mode-constants"
-endterm="gtk-selection-mode-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-orientation">
- <title>gtk.IconView.set_orientation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_orientation</methodname>
- <methodparam><parameter
- role="keyword">orientation</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">orientation</parameter>&nbsp;:</term>
- <listitem><simpara>the relative position of the icon and
-text.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_orientation</methodname>() method sets the
-"orientation" property to the value of
-<parameter>orientation</parameter>. <parameter>orientation</parameter>
-should contain one of the <xref linkend="gtk-orientation-constants"
-endterm="gtk-orientation-constants-title"></xref>. The "orientation"
-property indicates the relative positioning of the icon and text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-orientation">
- <title>gtk.IconView.get_orientation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_orientation</methodname>
- <methodparam><parameter
- role="keyword"></parameter></methodparam>
- <methodparam><parameter
- role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the relative position of the icon and
-text.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_orientation</methodname>() method returns
-the value of the "orientation" property that indicates the relative position
-between the icon and text. See the <link
-linkend="method-gtkiconview--set-orientation"><methodname>set_orientation</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-columns">
- <title>gtk.IconView.set_columns</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_columns</methodname>
- <methodparam><parameter
- role="keyword">columns</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">columns</parameter>&nbsp;:</term>
- <listitem><simpara>the number of columns in a row.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_columns</methodname>() method sets the
-"columns" property to the value of
-<parameter>columns</parameter>. <parameter>columns</parameter> should
-contain the number of columns to be displayed in each row or -1 to fit as
-many columns as possible per row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-columns">
- <title>gtk.IconView.get_columns</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_columns</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of columns per row or
--1.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_columns</methodname>() method returns the
-value of the "columns" property that indicates the number of columns per
-row. See the <link
-linkend="method-gtkiconview--set-columns"><methodname>set_columns</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-item-width">
- <title>gtk.IconView.set_item_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_item_width</methodname>
- <methodparam><parameter
- role="keyword">item_width</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">item_width</parameter>&nbsp;:</term>
- <listitem><simpara>The space used to display an item or -1 to use
-the width of the largest item.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_item_width</methodname>() method sets the
-"item-width" property to the value of
-<parameter>item_width</parameter>. <parameter>item_width</parameter> should
-contain the maximum space (in pixels) to use to display an item in the icon
-view or -1 to use the width of the largest item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-item-width">
- <title>gtk.IconView.get_item_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_item_width</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the space available for displaying an
-item or -1.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_item_width</methodname>() method returns the
-value of the "item-width" property that contains the space available for
-displaying an item. See the <link
-linkend="method-gtkiconview--set-item-width"><methodname>set_item_width</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-spacing">
- <title>gtk.IconView.set_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_spacing</methodname>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
- <listitem><simpara>The space between the cells of an item in the
-icon view</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_spacing</methodname>() method sets the
-"spacing" property to the value of
-<parameter>spacing</parameter>. <parameter>spacing</parameter> should
-contain the space in pixels that is inserted between the cells of an item in
-the icon view.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-spacing">
- <title>gtk.IconView.get_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_spacing</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the space in pixels that is inserted between
-cells in the icon view.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_spacing</methodname>() method returns the
-value of the "spacing" property that contains the space in pixels that is
-inserted between the cells of an item in the icon view. See the <link
-linkend="method-gtkiconview--set-spacing"><methodname>set_spacing</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-row-spacing">
- <title>gtk.IconView.set_row_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_row_spacing</methodname>
- <methodparam><parameter
- role="keyword">row_spacing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row_spacing</parameter>&nbsp;:</term>
- <listitem><simpara>the space between rows in the icon
-view.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_row_spacing</methodname>() method sets the
-"row-spacing" property to the value of
-<parameter>row_spacing</parameter>. <parameter>row_spacing</parameter>
-should contain the space in pixels to be inserted between rows in the icon
-view..</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-row-spacing">
- <title>gtk.IconView.get_row_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_row_spacing</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the space between rows in the icon
-view.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_row_spacing</methodname>() method returns
-the value of the "row-spacing" property that contains the space in pixels
-inserted between the rows in the icon view. See the <link
-linkend="method-gtkiconview--set-row-spacing"><methodname>set_row_spacing</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-column-spacing">
- <title>gtk.IconView.set_column_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_column_spacing</methodname>
- <methodparam><parameter
- role="keyword">column_spacing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column_spacing</parameter>&nbsp;:</term>
- <listitem><simpara>The space inserted between columns in the icon
-view</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_column_spacing</methodname>() method sets
-the "column-spacing" property to the value of
-<parameter>column_spacing</parameter>. <parameter>column_spacing</parameter>
-should contain the space in pixels to be inserted between columns in the
-icon view.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-column-spacing">
- <title>gtk.IconView.get_column_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_column_spacing</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the space between columns in the icon
-view.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_column_spacing</methodname>() method returns
-the value of the "column-spacing" property that contains the space in pixels
-between the columns in the icon view. See the <link
-linkend="method-gtkiconview--set-column-spacing"><methodname>set_column_spacing</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-margin">
- <title>gtk.IconView.set_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_margin</methodname>
- <methodparam><parameter
- role="keyword">margin</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">margin</parameter>&nbsp;:</term>
- <listitem><simpara>the space inserted at the edges of the icon
-view.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_margin</methodname>() method sets the
-"margin" property to the value of
-<parameter>margin</parameter>. <parameter>margin</parameter> should contain
-the space in pixels to be inserted at the edges of the icon view.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-margin">
- <title>gtk.IconView.get_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_margin</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the space inserted at the edges of the icon
-view.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_margin</methodname>() method returns the
-value of the "margin" property that continas the space in pixels inserted at
-the edges of the icon view. See the <link
-linkend="method-gtkiconview--set-margin"><methodname>set_margin</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--select-path">
- <title>gtk.IconView.select_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_path</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path indicating the icon to be
-selected</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>select_path</methodname> method selects the icon
-with the tree path specified by <parameter>path</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--unselect-path">
- <title>gtk.IconView.unselect_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unselect_path</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path indicating the icon to be
-unselected</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para> The <methodname>unselect_path</methodname> method unselects the
-icon with the tree path specified by <parameter>path</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--path-is-selected">
- <title>gtk.IconView.path_is_selected</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>path_is_selected</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path of an icon.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>path</parameter> is selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>path_is_selected</methodname>() method returns
-<literal>True</literal> if the icon with the tree path specified by
-<parameter>path</parameter> is selected.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-selected-items">
- <title>gtk.IconView.get_selected_items</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selected_items</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the paths of the selected
-icons.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_selected_items</methodname>() method returns
-a list of the paths of the selected icons.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--select-all">
- <title>gtk.IconView.select_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_all</methodname>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>select_all</methodname>() method selects all the
-icons if the selection mode is set to
-<literal>gtk.SELECTION_MULTIPLE</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--unselect-all">
- <title>gtk.IconView.unselect_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unselect_all</methodname>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>unselect_all</methodname>() method unselects all
-the icons.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--item-activated">
- <title>gtk.IconView.item_activated</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>item_activated</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a tree path pointing to an icon
-row.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>item_activated</methodname>() method activates
-the icon pointed to by the path specified by
-<parameter>path</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--scroll-to-path">
- <title>gtk.IconView.scroll_to_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>scroll_to_path</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use_align</parameter></methodparam>
- <methodparam><parameter
- role="keyword">row_align</parameter></methodparam>
- <methodparam><parameter
- role="keyword">col_align</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the item to move
-to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">use_align</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> use the alignment
-arguments</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">row_align</parameter>&nbsp;:</term>
- <listitem><simpara>the vertical alignment of the item specified by
-<parameter>path</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">col_align</parameter>&nbsp;:</term>
- <listitem><simpara>The horizontal alignment of the item specified
-by <parameter>path</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>scroll_to_path</methodname>() method moves the
- alignments of the icon view to the position specified by
- <parameter>path</parameter>. <parameter>row_align</parameter> determines
- where the row is placed, and <parameter>col_align</parameter> determines
- where column is placed. Both are expected to be between 0.0 and 1.0. 0.0
- means left/top alignment, 1.0 means right/bottom alignment, 0.5 means
- center.</para>
-
- <para>If <parameter>use_align</parameter> is <literal>False</literal>,
- then the alignment arguments are ignored, and the icon view does the
- minimum amount of work to scroll the item onto the screen. This means that
- the item will be scrolled to the edge closest to its current position. If
- the item is currently visible on the screen, nothing is done.</para>
-
- <para>This method only works if the model is set, and
- <parameter>path</parameter> is a valid row on the model. If the model
- changes before the icon view is realized, the centered path will be
- modified to reflect this change.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-visible-range">
- <title>gtk.IconView.get_visible_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_range</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the start and end paths of
-the visible region or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_visible_range</methodname>() method returns
-a 2-tuple containing the start and end paths for the visible region in the
-iconview. If no valid paths are available this method returns
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--enable-model-drag-source">
- <title>gtk.IconView.enable_model_drag_source</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>enable_model_drag_source</methodname>
- <methodparam><parameter
- role="keyword">start_button_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">actions</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start_button_mask</parameter>&nbsp;:</term>
- <listitem><simpara>the mask of buttons allowed to start drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of 3-tuples containing target
-information that the drag will support</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">actions</parameter>&nbsp;:</term>
- <listitem><simpara>the combination of possible <xref
- linkend="gdk-drag-action-constants"
- endterm="gdk-drag-action-constants-title"></xref> for a drag
- from the iconview</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>enable_model_drag_source</methodname>() method
- enables the iconview to be used as a drag source for automatic
- DND. <parameter>start_button_mask</parameter> specifies a combination of
- the <xref linkend="gdk-modifier-constants"
- endterm="gdk-modifier-constants-title"></xref> that can start the
- drag. <parameter>targets</parameter> is a sequence (tuple or list) of
- 3-tuples each containing target information: a string representing the drag
- type, target flags (a combination of <literal>gtk.TARGET_SAME_APP</literal>
- and <literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an
- application assigned integer ID used for identification
- purposes. <parameter>actions</parameter> is a combination of the <xref
- linkend="gdk-drag-action-constants"
- endterm="gdk-drag-action-constants-title"></xref> supported by the
- iconview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--enable-model-drag-dest">
- <title>gtk.IconView.enable_model_drag_dest</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>enable_model_drag_dest</methodname>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">actions</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of 3-tuples containing target
-information that the iconview will support for a drag drop</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">actions</parameter>&nbsp;:</term>
- <listitem><simpara>the combination of possible <xref
- linkend="gdk-drag-action-constants"
- endterm="gdk-drag-action-constants-title"></xref> for a drag
- drop onto to the iconview</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>enable_model_drag_dest</methodname>() method
-enables the iconview to be a destination for a drag
-drop. <parameter>targets</parameter> is a sequence (tuple or list) of
-3-tuples each containing target information: a string representing the drag
-type, target flags (a combination of <literal>gtk.TARGET_SAME_APP</literal>
-and <literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an application
-assigned integer ID used for identification
-purposes. <parameter>actions</parameter> is a combination of the <xref
-linkend="gdk-drag-action-constants"
-endterm="gdk-drag-action-constants-title"></xref> supported by the
-iconview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--unset-model-drag-source">
- <title>gtk.IconView.unset_model_drag_source</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unset_model_drag_source</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>unset_model_drag_source</methodname>() method
- undoes the effect of the <link
- linkend="method-gtkiconview--enable-model-drag-source"><methodname>enable_model_drag_source</methodname>()</link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--unset-model-drag-dest">
- <title>gtk.IconView.unset_model_drag_dest</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unset_model_drag_dest</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>unset_model_drag_dest</methodname>() method
- undoes the effect of the <link
- linkend="method-gtkiconview--enable-model-drag-dest"><methodname>enable_model_drag_dest</methodname>()</link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-reorderable">
- <title>gtk.IconView.set_reorderable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_reorderable</methodname>
- <methodparam><parameter
- role="keyword">reorderable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">reorderable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the items are
-reorderable.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_reorderable</methodname>() method sets the
-"reorderable" property to the value of
-<parameter>reorderable</parameter>. If <parameter>reorderable</parameter> is
-<literal>True</literal> the user can reorder the model by dragging and
-dropping rows. The developer can listen to these changes by connecting to
-the model's "row_inserted" and "row_deleted" signals.</para>
-
- <para>This method does not give you any degree of control over the
- order -- any reordering is allowed. If more control is needed, you should
- probably handle drag and drop manually.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-reorderable">
- <title>gtk.IconView.get_reorderable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_reorderable</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the iconview list
-can be reordered.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_reorderable</methodname>() method returns
-the value of the "reorderable" property. If "reorderable" is
-<literal>True</literal> the user can reorder iconview using
-drag-and-drop.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--set-drag-dest-item">
- <title>gtk.IconView.set_drag_dest_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_drag_dest_item</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pos</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the item to highlight, or
-<literal>None</literal> .</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pos</parameter>&nbsp;:</term>
- <listitem><simpara>specifies where to drop, relative to the
-item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_drag_dest_item</methodname>() method
-highlights for feedback the item specified by
-<parameter>path</parameter>. <literal>pos</literal> is one of the <xref
-linkend="gtk-iconview-drop-position-constants"
-endterm="gtk-iconview-drop-position-constants-title"></xref> that specifies
-where the drop is to take place relative to the receiving item.</para>
-
-<para>In PyGTK 2.10 and above, <parameter>path</parameter> may be
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-drag-dest-item">
- <title>gtk.IconView.get_drag_dest_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_drag_dest_item</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the path of the highlighted
-item and one of the <xref
-linkend="gtk-iconview-drop-position-constants"
-endterm="gtk-iconview-drop-position-constants-title"></xref> specifying the
-relative drop location or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_drag_dest_item</methodname>() method returns
-a 2-tuple containing the path of the highlighted item and one of the <xref
-linkend="gtk-iconview-drop-position-constants"
-endterm="gtk-iconview-drop-position-constants-title"></xref> specifying the
-drop location relative to the receiving item. If there is no highlighted
-item, this method returns <literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--get-dest-item-at-pos">
- <title>gtk.IconView.get_dest_item_at_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_dest_item_at_pos</methodname>
- <methodparam><parameter
- role="keyword">drag_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">drag_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">drag_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">drag_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the path of the highlighted
-item and a relative drop location.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_dest_item_at_pos</methodname>() method
-returns a 2-tuple containing the path of the highlighted item at the
-location specified by <parameter>drag_x</parameter> and
-<parameter>drag_y</parameter> and the drop location relative to the
-receiving item. If there is no highlighted item, this method returns
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkiconview--create-drag-icon">
- <title>gtk.IconView.create_drag_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_drag_icon</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> of the
-drag icon.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>create_drag_icon</methodname>() method returns a
-<link linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-representation of the item at the location specified by
-<parameter>path</parameter>. The return image can be used for a drag
-icon.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkiconview--activate-cursor-item">
- <title>The "activate-cursor-item" gtk.IconView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>iconview</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal
-was handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "activate-cursor-item" signal is emitted when an icon is
-selected and the <keycap>Enter</keycap> key is pressed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkiconview--item-activated">
- <title>The "item-activated" gtk.IconView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>iconview</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>the path to the activated icon
-item.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "item-activated" signal is emitted when an icon item is
-activated by the user double clicking an icon item, pressing the
-<keycap>Enter</keycap> key when an icon item is selected or via a call to
-the <link
-linkend="method-gtkiconview--item-activated"><methodname>item_activated</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkiconview--move-cursor">
- <title>The "move-cursor" gtk.IconView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>step</parameter></methodparam>
- <methodparam><parameter>number</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>iconview</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>step</parameter>&nbsp;:</term>
- <listitem><simpara>the step size to move the cursor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>number</parameter>&nbsp;:</term>
- <listitem><simpara>the number of steps to move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal
-was handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-cursor" signal is emitted when the cursor is moved
-using the keyboard keys: <keycap>Up</keycap>, <keycap>Down</keycap>,
-<keycombo><keycap>Control</keycap><keycap>p</keycap> </keycombo>,
-<keycombo><keycap>Control</keycap><keycap>n</keycap> </keycombo>,
-<keycap>Home</keycap>, <keycap>End</keycap>, <keycap>Page_Up</keycap>,
-<keycap>Page_Down</keycap>, <keycap>Right</keycap>, <keycap>Left</keycap>
-with various <keycap>Shift</keycap> and <keycap>Control</keycap>
-combinations. <parameter>step</parameter> will be one of the <xref
-linkend="gtk-movement-step-constants"
-endterm="gtk-movement-step-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkiconview--select-all">
- <title>The "select-all" gtk.IconView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>iconview</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "select-all" signal is emitted when all icon items are
-selected by pressing <keycombo><keycap>Control</keycap><keycap>a</keycap>
-</keycombo>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkiconview--select-cursor-item">
- <title>The "select-cursor-item" gtk.IconView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>iconview</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "select-cursor-item" signal is emitted when the icon item
-at the cursor is selected by the user pressing the <keycap>Space</keycap>
-key.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkiconview--selection-changed">
- <title>The "selection-changed" gtk.IconView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>iconview</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "selection-changed" signal is emitted when the selection is
-changed either by user action or program method calls.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkiconview--set-scroll-adjustments">
- <title>The "set-scroll-adjustments" gtk.IconView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>hadj</parameter></methodparam>
- <methodparam><parameter>vadj</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>iconview</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>hadj</parameter>&nbsp;:</term>
- <listitem><simpara>the new horizontal <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>vadj</parameter>&nbsp;:</term>
- <listitem><simpara>the new vertical <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "set-scroll-adjustments" signal is emitted when the new
-horizontal and veritcal scroll <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-objects are set.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkiconview--toggle-cursor-item">
- <title>The "toggle-cursor-item" gtk.IconView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>iconview</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "toggle-cursor-item" signal is emitted when the user presses
-<keycombo><keycap>Control</keycap><keycap>Space</keycap> </keycombo>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkiconview--unselect-all">
- <title>The "unselect-all" gtk.IconView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>iconview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>iconview</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "unselect-all" signal is emitted when the user presses
-<keycombo><keycap>Control</keycap><keycap>Shift</keycap><keycap>a</keycap>
-</keycombo>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkimage.xml b/docs/reference/pygtk-gtkimage.xml
deleted file mode 100644
index bbf2f5b0..00000000
--- a/docs/reference/pygtk-gtkimage.xml
+++ /dev/null
@@ -1,1163 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkimage">
- <refnamediv>
- <refname>gtk.Image</refname>
- <refpurpose>A widget displaying an image
-</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Image</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkmisc">gtk.Misc</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkimage">gtk.Image</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--set-from-pixmap">set_from_pixmap</link></methodname>
- <methodparam><parameter
- role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--set-from-image">set_from_image</link></methodname>
- <methodparam><parameter
- role="keyword">gdk_image</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--set-from-file">set_from_file</link></methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--set-from-pixbuf">set_from_pixbuf</link></methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--set-from-stock">set_from_stock</link></methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--set-from-icon-set">set_from_icon_set</link></methodname>
- <methodparam><parameter
- role="keyword">icon_set</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--set-from-animation">set_from_animation</link></methodname>
- <methodparam><parameter
- role="keyword">animation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--get-storage-type">get_storage_type</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--get-pixmap">get_pixmap</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--get-image">get_image</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--get-pixbuf">get_pixbuf</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--get-stock">get_stock</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--get-icon-set">get_icon_set</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--get-animation">get_animation</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--get-icon-name">get_icon_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--set-from-icon-name">set_from_icon_name</link></methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--set-pixel-size">set_pixel_size</link></methodname>
- <methodparam><parameter
- role="keyword">pixel_size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--get-pixel-size">get_pixel_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimage--clear">clear</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--image-new-from-stock">gtk.image_new_from_stock</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--image-new-from-icon-set">gtk.image_new_from_icon_set</link></methodname>
- <methodparam><parameter role="keyword">icon_set</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--image-new-from-animation">gtk.image_new_from_animation</link></methodname>
- <methodparam><parameter role="keyword">animation</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--image-new-from-animation">gtk.image_new_from_icon_name</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkmisc">gtk.Misc</link>
- +-- <link linkend="class-gtkimage">gtk.Image</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkimage">
- <title>gtk.Image Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkmisc">gtk.Misc Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"file"</entry>
- <entry>Write</entry>
-
- <entry>A filename containing the image data. Default value:
-<literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"icon-name"</entry>
- <entry>Read-Write</entry>
-
- <entry>The name of the icon in the icon theme. If the icon
-theme is changed, the image will be updated automatically. Default value:
-<literal>None</literal>. Available in GTK 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"icon-set"</entry>
- <entry>Read-Write</entry>
- <entry>the <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link> to
-display</entry>
- </row>
-
- <row valign="top">
- <entry>"icon-size"</entry>
- <entry>Read-Write</entry>
-
- <entry>the size to use for a stock icon, named icon or icon
-set. Allowed values: >= 0. Default value: 4</entry>
- </row>
-
- <row valign="top">
- <entry>"image"</entry>
- <entry>Read-Write</entry>
- <entry>a <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> to
-display</entry>
- </row>
-
- <row valign="top">
- <entry>"mask"</entry>
- <entry>Read-Write</entry>
- <entry>a bitmap <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> to
-use with a <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> or a
-<link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link></entry>
- </row>
-
- <row valign="top">
- <entry>"pixbuf"</entry>
- <entry>Read-Write</entry>
- <entry>the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-to display</entry>
- </row>
-
- <row valign="top">
- <entry>"pixbuf-animation"</entry>
- <entry>Read-Write</entry>
- <entry>the <link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>
-to display</entry>
- </row>
-
- <row valign="top">
- <entry>"pixel-size"</entry>
- <entry>Read-Write</entry>
-
- <entry>a fixed size overriding the "icon-size" property for
-images of type <literal>gtk.IMAGE_ICON_NAME</literal>. Allowed values: >=
--1. Default value: -1. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"pixmap"</entry>
- <entry>Read-Write</entry>
- <entry>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> to
-display</entry>
- </row>
-
- <row valign="top">
- <entry>"stock"</entry>
- <entry>Read-Write</entry>
- <entry>the stock ID for a stock image to display. Default
-value: <literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"storage-type"</entry>
- <entry>Read</entry>
-
- <entry>the type of the image data; one of the <xref
-linkend="gtk-image-type-constants"
-endterm="gtk-image-type-constants-title"></xref>:
-<literal>gtk.IMAGE_EMPTY</literal>, <literal>gtk.IMAGE_PIXMAP</literal>,
-<literal>gtk.IMAGE_IMAGE</literal>, <literal>gtk.IMAGE_PIXBUF</literal>,
-<literal>gtk.IMAGE_STOCK</literal>, <literal>gtk.IMAGE_ICON_SET</literal> or
-<literal>gtk.IMAGE_ANIMATION</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkimage">
- <title>gtk.Image Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkimage">
- <title>gtk.Image Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> widget
-displays an image. Various kinds of objects can be displayed as an image;
-usually, you would load a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-("pixel buffer") from a file, and then display it. The convenience method
-<link
-linkend="method-gtkimage--set-from-file"><methodname>set_from_file</methodname>()</link>
-will read the file and automatically create a pixbuf that is added to the
-<link linkend="class-gtkimage"><classname>gtk.Image</classname></link>
-widget. If the file isn't loaded successfully, the image will contain a
-"broken image" icon similar to that used in many web browsers. If you want
-to handle errors in loading the file yourself, for example by displaying an
-error message, then load the image with <link
-linkend="function-gdk--pixbuf-new-from-file"><methodname>gtk.gdk.pixbuf_new_from_file</methodname>()</link>,
-then add it to the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> with the
-<link
-linkend="method-gtkimage--set-from-pixbuf"><methodname>set_from_pixbuf</methodname>()</link>
-method. The image file may contain an animation; if so, the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> will
-display an animation (<link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>)
-instead of a static image.</para>
-
- <para><link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> is a
-subclass of <link
-linkend="class-gtkmisc"><classname>gtk.Misc</classname></link>, which
-implies that you can align it (center, left, right) and add padding to it,
-using the <link
-linkend="class-gtkmisc"><classname>gtk.Misc</classname></link> methods.
-<link linkend="class-gtkimage"><classname>gtk.Image</classname></link> is a
-"no window" widget (has no <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-its own), so by default does not receive events. If you want to receive
-events on the image, such as button clicks, place the image inside a <link
-linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link>, then
-connect to the event signals on the event box.</para>
-
- <para>When handling events on the event box, keep in mind that
-coordinates in the image may be different from event box coordinates due to
-the alignment and padding settings on the image (see <link
-linkend="class-gtkmisc"><classname>gtk.Misc</classname></link>). The
-simplest way to solve this is to set the alignment to 0.0 (left/top), and
-set the padding to zero. Then the origin of the image will be the same as
-the origin of the event box.</para>
-
- <para>Sometimes an application will want to avoid depending on external
-data files, such as image files. GTK+ comes with a program to avoid this,
-called <command>gdk-pixbuf-csource</command>. This program allows you to
-convert an image into a C variable declaration, which can then be loaded
-into a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> using
-the <link
-linkend="function-gdk--pixbuf-new-from-inline"><function>gtk.gdk.pixbuf_new_from_inline</function>()</link>
-function. This can also be used in <literal>PyGTK</literal> by modifying the
-output using an editor or the <command>sed</command> command as
-follows:</para>
-
- <programlisting>
- gdk-pixbuf-csource imagefile | \
- sed -n -e 's/{/[/' -e 's/};/]/' -e '/".*"/p' >outfile
-</programlisting>
-
- <para>You can edit <filename>outfile</filename> into a Python file where
-it will be evaluated to a list containing a string. The string can be used
-directly with the <link
-linkend="function-gdk--pixbuf-new-from-inline"><function>gtk.gdk.pixbuf_new_from_inline</function>()</link>
-function to create a pixbuf that can be used in a <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkimage">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Image</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a newly created <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>
-widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new empty <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkimage--set-from-pixmap">
- <title>gtk.Image.set_from_pixmap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_pixmap</methodname>
- <methodparam><parameter
- role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixmap</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">mask</parameter>&nbsp;:</term>
- <listitem><simpara>a bitmap <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_from_pixmap</methodname>() method sets the
-image data from <parameter>pixmap</parameter> using
-<parameter>mask</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--set-from-image">
- <title>gtk.Image.set_from_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_image</methodname>
- <methodparam><parameter
- role="keyword">gdk_image</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">gdk_image</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">mask</parameter>&nbsp;:</term>
- <listitem><simpara>a bitmap <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_from_image</methodname>() method sets the
-image data from <parameter>image</parameter> using
-<parameter>mask</parameter>. A <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> is a
-client-side image buffer in the pixel format of the current display. If
-<parameter>image</parameter> is <literal>None</literal> the current image
-data will be removed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--set-from-file">
- <title>gtk.Image.set_from_file</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_file</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>a filename or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_from_file</methodname>() method sets the
-image data from the contents of the file named
-<parameter>filename</parameter>. If the file isn't found or can't be loaded,
-the resulting <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> will
-display a "broken image" icon. This function never returns None, it always
-returns a valid <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> widget. If
-the file contains an animation, the image will contain an animation. If
-<parameter>filename</parameter> is <literal>None</literal> the current image
-data will be removed.</para>
-
- <para>If you need to detect failures to load the file, use <link
-linkend="function-gdk--pixbuf-new-from-file"><methodname>gtk.gdk.pixbuf_new_from_file</methodname>()</link>
-to load the file yourself, then create the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> from the
-pixbuf. (Or for animations, use the <link
-linkend="constructor-gdkpixbufanimation">gtk.gdk.PixbufAnimation</link>()
-constructor.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--set-from-pixbuf">
- <title>gtk.Image.set_from_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_pixbuf</methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_from_pixbuf</methodname>() method sets the
-image data using <parameter>pixbuf</parameter>. Note that this function just
-creates an <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> from
-<parameter>pixbuf</parameter>. The <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> created
-will not react to state changes. Should you want that, you should use the
-<link
-linkend="method-gtkimage--set-from-icon-set"><methodname>set_from_icon_set</methodname>()</link>
-method If <parameter>pixbuf</parameter> is <literal>None</literal> the
-current image data will be removed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--set-from-stock">
- <title>gtk.Image.set_from_stock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_stock</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>a stock icon name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>a stock icon size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_from_stock</methodname>() method sets the
-image data from the stock item identified by
-<parameter>stock_id</parameter>. Sample stock icon names are
-<literal>gtk.STOCK_OPEN</literal> and <literal>gtk.STOCK_OK</literal>.
-Stock icon sizes are <literal>gtk.ICON_SIZE_MENU</literal>,
-<literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_BUTTON</literal>,
-<literal>gtk.ICON_SIZE_DND</literal> and
-<literal>gtk.ICON_SIZE_DIALOG</literal>. If the stock icon name isn't known,
-a "broken image" icon will be displayed instead. You can register your own
-stock icon names, see the <link
-linkend="method-gtkiconfactory--add-default"><methodname>gtk.IconFactory.add_default</methodname>()</link>
-and <link
-linkend="method-gtkiconfactory--add"><methodname>gtk.IconFactory.add</methodname>()</link>
-methods.</para>
-
- <para>The stock icons are described in the <link
-linkend="gtk-stock-items">Stock Items</link> reference.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--set-from-icon-set">
- <title>gtk.Image.set_from_icon_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_icon_set</methodname>
- <methodparam><parameter
- role="keyword">icon_set</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_set</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>a stock icon size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_from_icon_set</methodname>() method sets the
-image data from icon_set with the size specified by
-<parameter>size</parameter>. Stock icon sizes are
-<literal>gtk.ICON_SIZE_MENU</literal>,
-<literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_BUTTON</literal>,
-<literal>gtk.ICON_SIZE_DND</literal> and
-<literal>gtk.ICON_SIZE_DIALOG</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--set-from-animation">
- <title>gtk.Image.set_from_animation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_animation</methodname>
- <methodparam><parameter
- role="keyword">animation</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">animation</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_from_animation</methodname>() method sets
-the image data from <parameter>animation</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--get-storage-type">
- <title>gtk.Image.get_storage_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_storage_type</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the type of the image representation being
-used</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_storage_type</methodname>() method gets the
-type of representation being used by the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> to store
-image data. If the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> has no
-image data, the return value will be <literal>gtk.IMAGE_EMPTY</literal>. The
-image type is one of: <literal>gtk.IMAGE_EMPTY</literal>,
-<literal>gtk.IMAGE_PIXMAP</literal>, <literal>gtk.IMAGE_IMAGE</literal>,
-<literal>gtk.IMAGE_PIXBUF</literal>, <literal>gtk.IMAGE_STOCK</literal>,
-<literal>gtk.IMAGE_ICON_SET</literal> or
-<literal>gtk.IMAGE_ANIMATION</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--get-pixmap">
- <title>gtk.Image.get_pixmap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixmap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the pixmap (or
-<literal>None</literal>) and the mask (or
-<literal>None</literal>)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixmap</methodname>() method returns a tuple
-containing the pixmap and mask being displayed by the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>. Either or
-both the pixmap and mask may be <literal>None</literal>. If the storage type
-of the image is not either <literal>gtk.IMAGE_EMPTY</literal> or
-<literal>gtk.IMAGE_PIXMAP</literal> the ValueError exception will be
-raised.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--get-image">
- <title>gtk.Image.get_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_image</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> and a
-mask bitmap</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_image</methodname>() method returns a tuple
-containing the <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> and
-mask being displayed by the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>. One or
-both of the <link
-linkend="class-gdkimage"><classname>gtk.gdk.Image</classname></link> and
-mask may be <literal>None</literal>. If the storage type of the image is not
-either of <literal>gtk.IMAGE_EMPTY</literal> or
-<literal>gtk.IMAGE_IMAGE</literal> the ValueError exception will be
-raised.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--get-pixbuf">
- <title>gtk.Image.get_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixbuf</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the displayed pixbuf, or
-<literal>None</literal> if the image is empty</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixbuf</methodname>() method gets the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> being
-displayed by the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>. The return
-value may be None if no image data is set. If the storage type of the image
-is not either <literal>gtk.IMAGE_EMPTY</literal> or
-<literal>gtk.IMAGE_PIXBUF</literal> the ValueError exception will be
-raised.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--get-stock">
- <title>gtk.Image.get_stock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_stock</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the stock icon name and the
-stock icon size of the image data</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_stock</methodname>() method returns a tuple
-containing the stock icon identifier (may be <literal>None</literal>) and
-size being displayed by the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>. The size
-will be one of: <literal>gtk.ICON_SIZE_MENU</literal>,
-<literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_BUTTON</literal>,
-<literal>gtk.ICON_SIZE_DND</literal> or
-<literal>gtk.ICON_SIZE_DIALOG</literal>. If the storage type of the image is
-not either <literal>gtk.IMAGE_EMPTY</literal> or
-<literal>gtk.IMAGE_STOCK</literal> the ValueError exception will be
-raised.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--get-icon-set">
- <title>gtk.Image.get_icon_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_set</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link> and a
-stock icon size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_icon_set</methodname>() method returns a
-tuple containing the icon set (may be <literal>None</literal>) and size
-being displayed by the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>. The size
-will be one of: <literal>gtk.ICON_SIZE_MENU</literal>,
-<literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_BUTTON</literal>,
-<literal>gtk.ICON_SIZE_DND</literal> or
-<literal>gtk.ICON_SIZE_DIALOG</literal>. If the storage type of the image is
-not either <literal>gtk.IMAGE_EMPTY</literal> or
-<literal>gtk.IMAGE_ICON_SET</literal> the ValueError exception will be
-raised.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--get-animation">
- <title>gtk.Image.get_animation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_animation</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the displayed animation, or
-<literal>None</literal> if the image is empty</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_animation</methodname>() method gets the
-<link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>
-(may be None if there is no image data) being displayed by the <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>. If the
-storage type of the image is not either <literal>gtk.IMAGE_EMPTY</literal>
-or <literal>gtk.IMAGE_ANIMATION</literal> the ValueError exception will be
-raised.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--get-icon-name">
- <title>gtk.Image.get_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_name</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the name and size of the
-displayed icon.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_icon_name</methodname>() method returns a
-2-tuple containing the values of the "icon-name" and "icon-size" properties
-respectively if the "icon-name" property is not <literal>None</literal>. If
-the "icon-name" property is <literal>None</literal> the 2-tuple returned
-will be:</para>
-
- <programlisting>
- (None, &lt;enum GTK_ICON_SIZE_INVALID of type GtkIconSize&gt;)
-</programlisting>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--set-from-icon-name">
- <title>gtk.Image.set_from_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_icon_name</methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>an icon name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>a stock icon size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_from_icon_name</methodname>() method sets
-the "icon-name" and "icon-size" properties to the values of
-<parameter>icon_name</parameter> and <parameter>size</parameter>
-respectively. <parameter>icon_name</parameter> should be the name of an icon
-in the current icon theme. If <parameter>icon_name</parameter> isn't known,
-a "broken image" icon will be displayed instead. If the current icon theme
-is changed, the icon will be updated appropriately.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--set-pixel-size">
- <title>gtk.Image.set_pixel_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_pixel_size</methodname>
- <methodparam><parameter
- role="keyword">pixel_size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">pixel_size</parameter>&nbsp;:</term>
- <listitem><simpara>the new pixel size to be used for named
-icons</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_pixel_size</methodname>() method sets the
-"pixel-size" property to the value specified by
-<parameter>pixel_size</parameter>. If the pixel size is set to a value != -1
-the "pixel-size" property is used instead of the icon size set by the <link
-linkend="method-gtkimage--set-from-icon-name"><methodname>set_from_icon_name</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--get-pixel-size">
- <title>gtk.Image.get_pixel_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixel_size</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the pixel size used for named
-icons.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_pixel_size</methodname>() method returns the
-value of the "pixel-size" property which specifies the pixel size to be used
-for named icons.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimage--clear">
- <title>gtk.Image.clear</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear</methodname>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>clear</methodname>() method removes the current
-image, if any, and resets the "storage-type", "mask" and "icon-size"
-properties. One of the "file", "icon-name", "icon-set", "image", "pixbuf",
-"pixbuf-animation", "pixmap" or "stock" will be reset if there was an
-existing image.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--image-new-from-stock">
- <title>gtk.image_new_from_stock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.image_new_from_stock</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>a stock icon name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>an integer representing an icon
-size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkimage"><classname>gtk.Image</classname></link>
- displaying the stock icon</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.image_new_from_stock</function>() function
-returns a new <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> displaying
-the stock icon specified by <parameter>stock_id</parameter> with the
-specified <parameter>size</parameter>. Sample stock icon names are
-<literal>gtk.STOCK_OPEN</literal>, <literal>gtk.STOCK_OK</literal> - see the
-<link
-linkend="method-gtkimage--set-from-stock"><methodname>set_from_stock</methodname>()</link>
-method for detailed information on the <literal>PyGTK</literal> stock icons.
-. Sample stock sizes are <literal>gtk.ICON_SIZE_MENU</literal>,
-<literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal> - see the <link linkend="function-gtk--icon-size-lookup"><function>gtk.icon_size_lookup</function>()</link> function for more detail. If the stock icon name isn't
-known, a "broken image" icon will be displayed instead. You can register
-your own stock icon names, see the <link
-linkend="method-gtkiconfactory--add-default"><methodname>gtk.IconFactory.add_default</methodname>()</link>
-and <link
-linkend="method-gtkiconfactory--add"><methodname>gtk.IconFactory.add</methodname>()</link>
-methods.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--image-new-from-icon-set">
- <title>gtk.image_new_from_icon_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.image_new_from_icon_set</methodname>
- <methodparam><parameter
- role="keyword">icon_set</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_set</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>an integer representing an icon
-size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.image_new_from_icon_set</function>() function
-returns a new <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> created
-from the <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link>
-specified by <parameter>icon_set</parameter> with the specified
-<parameter>size</parameter>. Sample stock sizes are
-<literal>gtk.ICON_SIZE_MENU</literal>,
-<literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal> - see the <link
-linkend="function-gtk--icon-size-lookup"><function>gtk.icon_size_lookup</function>()</link>
-function for more detail. Instead of using this function, usually it's
-better to create a <link
-linkend="class-gtkiconfactory"><classname>gtk.IconFactory</classname></link>,
-put your icon sets in the icon factory, add the icon factory to the list of
-default factories with the <link
-linkend="method-gtkiconfactory--add-default"><methodname>add_default</methodname>()</link>
-method, and then use the <link
-linkend="function-gtk--image-new-from-stock"><function>gtk.image_new_from_stock</function>()</link>
-function. This will allow themes to override the icon you ship with your
-application.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--image-new-from-animation">
- <title>gtk.image_new_from_animation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.image_new_from_animation</methodname>
- <methodparam><parameter
- role="keyword">animation</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">animation</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.image_new_from_animation</function>() function
-returns a new <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> object
-containing the <link
-linkend="class-gdkpixbufanimation"><classname>gtk.gdk.PixbufAnimation</classname></link>
-specified by <parameter>animation</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--image-new-from-icon_name">
- <title>gtk.image_new_from_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.image_new_from_icon_name</methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>an icon name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>a stock icon size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link>
-widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.image_new_from_icon_name</function>() function
-returns a new <link
-linkend="class-gtkimage"><classname>gtk.Image</classname></link> object
-displaying the named theme icon specified by
-<parameter>icon_name</parameter> with the icon size specified by
-<parameter>size</parameter>. If the icon name isn't known, a "broken image"
-icon will be displayed instead. If the current icon theme is changed, the
-icon will be updated appropriately. The "icon-name" and "icon-size"
-properties are also set by this function.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkimagemenuitem.xml b/docs/reference/pygtk-gtkimagemenuitem.xml
deleted file mode 100644
index a82ea5e8..00000000
--- a/docs/reference/pygtk-gtkimagemenuitem.xml
+++ /dev/null
@@ -1,212 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkimagemenuitem">
- <refnamediv>
- <refname>gtk.ImageMenuItem</refname>
- <refpurpose>a menuitem that displays an image with an accel
-label</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ImageMenuItem</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkmenuitem">gtk.MenuItem</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkimagemenuitem">gtk.ImageMenuItem</link></methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">accel_group</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimagemenuitem--set-image">set_image</link></methodname>
- <methodparam><parameter
- role="keyword">image</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimagemenuitem--get-image">get_image</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkitem">gtk.Item</link>
- +-- <link linkend="class-gtkmenuitem">gtk.MenuItem</link>
- +-- <link linkend="class-gtkimagemenuitem">gtk.ImageMenuItem</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkimagemenuitem">
- <title>gtk.ImageMenuItem Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"image"</entry>
- <entry>Read-Write</entry>
- <entry>the child widget that is next to the text in the menu
-item</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkimagemenuitem">
- <title>gtk.ImageMenuItem Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkimagemenuitem">
- <title>gtk.ImageMenuItem Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkimagemenuitem"><classname>gtk.ImageMenuItem</classname></link>
-widget is a subclass of <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> that
-contains an image widget and a <link
-linkend="class-gtkaccellabel"><classname>gtk.AccelLabel</classname></link>
-though a <link
-linkend="class-gtkimagemenuitem"><classname>gtk.ImageMenuItem</classname></link>
-can be created that has no image and an empty label.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkimagemenuitem">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ImageMenuItem</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">accel_group</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>the stock icon ID or <literal>None</literal> if
-no image is needed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_group</parameter>&nbsp;:</term>
- <listitem><simpara>the accel group to add the accel label mnemonic
-to</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkimagemenuitem"><classname>gtk.ImageMenuItem</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkimagemenuitem"><classname>gtk.ImageMenuItem</classname></link>
-with a stock label and image specified by <parameter>stock_id</parameter>.
-If <parameter>stock_id</parameter> is not a stock item then the image will
-be the "broken image" and the label text will be the string in
-<parameter>stock_id</parameter>. The label text will be parsed for
-underscore characters to indicate the mnemonic character for the
-accelerator.</para>
-
- <para>If <parameter>stock_id</parameter> specifies a stock item and
-<parameter>accel_group</parameter> specifies a <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-the accelerator is added to <parameter>accel_group</parameter>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkimagemenuitem--set-image">
- <title>gtk.ImageMenuItem.set_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_image</methodname>
- <methodparam><parameter
- role="keyword">image</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">image</parameter>&nbsp;:</term>
- <listitem><simpara>a widget to set as the image for the menu
-item.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_image</methodname>() method sets the image
-of the image menu item to the widget specified in
-<parameter>image</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimagemenuitem--get-image">
- <title>gtk.ImageMenuItem.get_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_image</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the image in the image menu
-item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_image</methodname>() method gets the widget
-that is currently set as the image of image menu item. See <link
-linkend="method-gtkimagemenuitem--set-image"><methodname>set_image</methodname>()</link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkimcontext.xml b/docs/reference/pygtk-gtkimcontext.xml
deleted file mode 100644
index be20a3cb..00000000
--- a/docs/reference/pygtk-gtkimcontext.xml
+++ /dev/null
@@ -1,771 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkimcontext">
- <refmeta>
- <refentrytitle>gtk.IMContext</refentrytitle>
- <manvolnum>3</manvolnum>
- <refmiscinfo>PyGTK Docs</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>gtk.IMContext</refname>
- <refpurpose>an abstract base class defining a generic input method
-interface</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.IMContext</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimcontext--set-client-window">set_client_window</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimcontext--get-preedit-string">get_preedit_string</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimcontext--filter-keypress">filter_keypress</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimcontext--focus-in">focus_in</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimcontext--focus-out">focus_out</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimcontext--reset">reset</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimcontext--set-cursor-location">set_cursor_location</link></methodname>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimcontext--set-use-preedit">set_use_preedit</link></methodname>
- <methodparam><parameter
- role="keyword">use_preedit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimcontext--set-surrounding">set_surrounding</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter role="keyword">len</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cursor_index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimcontext--get-surrounding">get_surrounding</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimcontext--delete-surrounding">delete_surrounding</link></methodname>
- <methodparam><parameter
- role="keyword">offset</parameter></methodparam>
- <methodparam><parameter
- role="keyword">n_chars</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkimcontext">gtk.IMContext</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkimcontext">
- <title>gtk.IMContext Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkimcontext--commit">commit</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter>
- </methodparam>
- <methodparam><parameter>string</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkimcontext--delete-surrounding">delete-surrounding</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter>
- </methodparam>
- <methodparam><parameter>offset</parameter>
- </methodparam>
- <methodparam><parameter>n_chars</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkimcontext--preedit-changed">preedit-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkimcontext--preedit-end">preedit-end</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkimcontext--preedit-start">preedit-start</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkimcontext--retrieve-surrounding">retrieve-surrounding</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkimcontext"><classname>gtk.IMContext</classname></link> is
-an abstract base class used to provide objects to manage the context for
-input methods used to support text input in various natural languages. The
-character input for some languages (e.g. Chinese, Japanese and Korean)
-cannot be easily input using standard keyboards so multiple keystrokes are
-used to input a single character. Input methods are used to help this
-process by providing feedback of the characters input and managing the
-context and valid combinations. The<link
-linkend="class-gtkimcontext"><classname>gtk.IMContext</classname></link>
-subclasses manage the required context information for applications and
-widgets such as the <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> and <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>
-widgets.</para>
-
- <para>The <link
-linkend="class-gtkimcontext"><classname>gtk.IMContext</classname></link>
-manages the context of the text surrounding the cursor and the preedit text
-that provides feedback about the in-process multiple character
-composition.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkimcontext--set-client-window">
- <title>gtk.IMContext.set_client_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_client_window</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>the client window. This may be
-<literal>None</literal> to indicate that the previous client window no
-longer exists.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_client_window</methodname>() method set the
-client window for the input context; this is the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> in
-which the input appears. This window is used in order to correctly position
-status windows, and may also be used for purposes internal to the input
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimcontext--get-preedit-string">
- <title>gtk.IMContext.get_preedit_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_preedit_string</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the preedit string, the
-attribute list and the position of cursor (in bytes) within the preedit
-string.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_preedit_string</methodname>() method returns
-a tuple containing: the current preedit string for the input context, a list
-of attributes to apply to the string and the cursor position within the
-string. This string should be displayed inserted at the insertion
-point.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimcontext--filter-keypress">
- <title>gtk.IMContext.filter_keypress</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>filter_keypress</methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>the key event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the input method
-handled the keystroke.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>filter_keypress</methodname>() method allows an
-input method to internally handle a key press event. If this function
-returns <literal>True</literal>, then no further processing should be done
-for this keystroke.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimcontext--focus-in">
- <title>gtk.IMContext.focus_in</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>focus_in</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>focus_in</methodname>() method notifies the
-input method that the widget to which this input context corresponds has
-gained focus. The input method may, for example, change the displayed
-feedback to reflect this change.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimcontext--focus-out">
- <title>gtk.IMContext.focus_out</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>focus_out</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>focus_out</methodname>() method notifies the
-input method that the widget to which this input context corresponds has
-lost focus. The input method may, for example, change the displayed feedback
-or reset the context state to reflect this change.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimcontext--reset">
- <title>gtk.IMContext.reset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reset</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>reset</methodname>() method notifies the input
-method that a significant change in context (such as a change in cursor
-position) has been made. This will typically cause the input method to clear
-the preedit state.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimcontext--set-cursor-location">
- <title>gtk.IMContext.set_cursor_location</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_cursor_location</methodname>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>new location</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_cursor_location</methodname>() method
-notifies the input method that a change in cursor position has been
-made.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimcontext--set-use-preedit">
- <title>gtk.IMContext.set_use_preedit</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_preedit</methodname>
- <methodparam><parameter
- role="keyword">use_preedit</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">use_preedit</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the IM context
-should use the preedit string.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_use_preedit</methodname>() method sets the
-use preedit setting to the value of use_preedit. If
-<parameter>use_preedit</parameter> is <literal>True</literal> (the default)
-the IM context should use the preedit string to display feedback. If
-<parameter>use_preedit</parameter> is <literal>False</literal> the IM
-context may use some other method to display feedback, such as displaying it
-in a child of the root window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimcontext--set-surrounding">
- <title>gtk.IMContext.set_surrounding</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_surrounding</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">len</parameter></methodparam>
- <methodparam><parameter
- role="keyword">cursor_index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the text surrounding the insertion point, as
-UTF-8. the preedit string should not be included within
-it.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">len</parameter>&nbsp;:</term>
- <listitem><simpara>the length of <parameter>text</parameter>, or
--1 to calculate the length of
-<parameter>text</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">cursor_index</parameter>&nbsp;:</term>
- <listitem><simpara>the byte index of the insertion cursor within
-<parameter>text</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_surrounding</methodname>() method sets
-surrounding context around the insertion point and preedit string. This
-function is expected to be called in response to the "retrieve_surrounding"
-signal, and will likely have no effect if called at other times.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimcontext--get-surrounding">
- <title>gtk.IMContext.get_surrounding</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_surrounding</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the UTF-8 encoded string of
-text holding context around the insertion point and the byte index of the
-insertion cursor within the string, or None if no surrounding context was
-retrieved.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_surrounding</methodname>() method returns a
-tuple containing the text surrounding the cursor and the byte index of the
-cursor within the text. Input methods typically want context in order to
-constrain input text based on existing text; this is important for languages
-such as Thai where only some sequences of characters are allowed.</para>
-
- <para>This function is implemented by emitting the
-"retrieve_surrounding" signal on the input method; in response to this
-signal, a widget should provide as much context as is available, up to an
-entire paragraph, by calling <link
-linkend="method-gtkimcontext--set-surrounding"><methodname>set_surrounding</methodname>()</link>.
-Note that there is no obligation for a widget to respond to the
-"retrieve_surrounding" signal, so input methods must be prepared to function
-without context.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkimcontext--delete-surrounding">
- <title>gtk.IMContext.delete_surrounding</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>delete_surrounding</methodname>
- <methodparam><parameter
- role="keyword">offset</parameter></methodparam>
- <methodparam><parameter
- role="keyword">n_chars</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">offset</parameter>&nbsp;:</term>
- <listitem><simpara>the offset from cursor position in chars; a
-negative value means start before the cursor.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">n_chars</parameter>&nbsp;:</term>
- <listitem><simpara>the number of characters to
-delete.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
-handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The delete_surrounding() method asks the widget that the input
-context is attached to to delete characters around the cursor position by
-emitting the "delete_surrounding" signal. Note that
-<parameter>offset</parameter> and <parameter>n_chars</parameter> are in
-characters not in bytes, which differs from the usage other places in the
-<link
-linkend="class-gtkimcontext"><classname>gtk.IMContext</classname></link>
-class.</para>
-
- <para>In order to use this function, you should first call <link
-linkend="method-gtkimcontext--get-surrounding"><methodname>get_surrounding</methodname>()</link>
-to get the current context, and call this function immediately afterward to
-make sure that you know what you are deleting. You should also account for
-the fact that even if the signal was handled, the input context might not
-have deleted all the characters that were requested to be deleted.</para>
-
- <para>This function is used by an input method that wants to make
-substitutions in the existing text in response to new input. It is not useful
-for applications.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkimcontext--commit">
- <title>The "commit" gtk.IMContext Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter></methodparam>
- <methodparam><parameter>string</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>imcontext</parameter>&nbsp;:</term>
- <listitem><simpara>the imcontext that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>string</parameter>&nbsp;:</term>
- <listitem><simpara>the text to be committed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "commit" signal is emitted when the text is ready to be
-displayed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkimcontext--delete-surrounding">
- <title>The "delete-surrounding" gtk.IMContext Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>imcontext</parameter>&nbsp;:</term>
- <listitem><simpara>the imcontext that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>offset</parameter>&nbsp;:</term>
- <listitem><simpara>the offset from the cursor position of the text
-to be deleted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>n_chars</parameter>&nbsp;:</term>
- <listitem><simpara>the number of characters to be
-deleted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
-handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "delete-surrounding" signal is emitted when the input method
-needs to delete the context text.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkimcontext--preedit-changed">
- <title>The "preedit-changed" gtk.IMContext Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>imcontext</parameter>&nbsp;:</term>
- <listitem><simpara>the imcontext that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "preedit-changed" signal is emitted when the preedit text
-has changed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkimcontext--preedit-end">
- <title>The "preedit-end" gtk.IMContext Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>imcontext</parameter>&nbsp;:</term>
- <listitem><simpara>the imcontext that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "preedit-end" signal is emitted when preediting is
-completed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkimcontext--preedit-start">
- <title>The "preedit-start" gtk.IMContext Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>imcontext</parameter>&nbsp;:</term>
- <listitem><simpara>the imcontext that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "preedit-start" signal is emitted when preediting is
-started.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkimcontext--retrieve-surrounding">
- <title>The "retrieve-surrounding" gtk.IMContext Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>imcontext</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>imcontext</parameter>&nbsp;:</term>
- <listitem><simpara>the imcontext that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
-handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "retrieve-surrounding" signal is emitted when the input
-method requires the context surrounding the cursor. The callback should set
-the input method surrounding context by calling the <link
-linkend="method-gtkimcontext--set-surrounding"><methodname>set_surrounding</methodname>()</link>
-method. The method returns <literal>True</literal> if the signal was handled
-by the callback.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkimcontextsimple.xml b/docs/reference/pygtk-gtkimcontextsimple.xml
deleted file mode 100644
index b39671b6..00000000
--- a/docs/reference/pygtk-gtkimcontextsimple.xml
+++ /dev/null
@@ -1,133 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkimcontextsimple">
- <refnamediv>
- <refname>gtk.IMContextSimple</refname>
- <refpurpose>an input method context object that supports "simple" input
-methods</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.IMContextSimple</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkimcontext">gtk.IMContext</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkimcontextsimple">gtk.IMContextSimple</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
-
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkimcontextsimple- -add-table">add_table</link></methodname>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- <methodparam><parameter role="keyword">max_seq_len</parameter></methodparam>
- <methodparam><parameter role="keyword">n_seqs</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkimcontext">gtk.IMContext</link>
- +-- <link linkend="class-gtkimcontextsimple">gtk.IMContextSimple</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkimcontextsimple">
- <title>gtk.IMContextSimple Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkimcontext">gtk.IMContext Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkimcontextsimple"><classname>gtk.IMContextSimple</classname></link>
-class is a subclass of <link
-linkend="class-gtkimcontext"><classname>gtk.IMContext</classname></link>
-that provides context support for "simple" input methods. <link
-linkend="class-gtkimcontextsimple"><classname>gtk.IMContextSimple</classname></link>
-does direct keysym to unicode translation and table-driven
-composition.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkimcontextsimple">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.IMContextSimple</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkimcontextsimple"><classname>gtk.IMContextSimple</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkimcontextsimple"><classname>gtk.IMContextSimple</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtkimcontextsimple- -add-table">
- <title>gtk.IMContextSimple.add_table</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>add_table</methodname>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- <methodparam><parameter role="keyword">max_seq_len</parameter></methodparam>
- <methodparam><parameter role="keyword">n_seqs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>the table</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">max_seq_len</parameter>&nbsp;:</term>
- <listitem><simpara>Maximum length of a sequence in the table
-(cannot be greater than <literal>GTK_MAX_COMPOSE_LEN</literal>)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">n_seqs</parameter>&nbsp;:</term>
- <listitem><simpara>number of sequences in the table</simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-Adds an additional table to search to the input context.
-Each row of the table consists of <parameter>max_seq_len</parameter> key symbols
-followed by two <literal>guint16</literal> interpreted as the high and low
-words of a <literal>gunicode</literal> value. Tables are searched starting
-from the last added.
-</para>
-<para>
-The table must be sorted in dictionary order on the
-numeric value of the key symbol fields. (Values beyond
-the length of the sequence should be zero.)
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkimmulticontext.xml b/docs/reference/pygtk-gtkimmulticontext.xml
deleted file mode 100644
index 35a1b612..00000000
--- a/docs/reference/pygtk-gtkimmulticontext.xml
+++ /dev/null
@@ -1,117 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkimmulticontext">
- <refnamediv>
- <refname>gtk.IMMulticontext</refname>
- <refpurpose>an input method context object that manages the use of
-multiple input method contexts for a widget</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.IMMulticontext</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkimcontext">gtk.IMContext</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkimmulticontext">gtk.IMMulticontext</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkimmulticontext--append-menuitems">append_menuitems</link></methodname>
- <methodparam><parameter
- role="keyword">menushell</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkimcontext">gtk.IMContext</link>
- +-- <link linkend="class-gtkimmulticontext">gtk.IMMulticontext</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkimmulticontext">
- <title>gtk.IMMulticontext Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkimcontext">gtk.IMContext Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkimmulticontext"><classname>gtk.IMMulticontext</classname></link>
-class is a subclass of <link
-linkend="class-gtkimcontext"><classname>gtk.IMContext</classname></link>
-that manages the use of multiple input method contexts for a widget
-including the ability to switch between contexts on the fly. A <link
-linkend="class-gtkimmulticontext"><classname>gtk.IMMulticontext</classname></link>
-object will proxy the method calls and signals to and from the object
-implementing the input method.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkimmulticontext">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.IMMulticontext</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkimmulticontext"><classname>gtk.IMMulticontext</classname>
-object</link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkimmulticontext"><classname>gtk.IMMulticontext</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkimmulticontext--append-menuitems">
- <title>gtk.IMMulticontext.append_menuitems</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append_menuitems</methodname>
- <methodparam><parameter
- role="keyword">menushell</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">menushell</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkmenushell"><classname>gtk.MenuShell</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>append_menuitems</methodname>() method adds
-menuitems for various available input methods to a menu; the menuitems, when
-selected, will switch the input method for the context and the global
-default input method.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkinputdialog.xml b/docs/reference/pygtk-gtkinputdialog.xml
deleted file mode 100644
index 2dd72fe3..00000000
--- a/docs/reference/pygtk-gtkinputdialog.xml
+++ /dev/null
@@ -1,245 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkinputdialog">
- <refnamediv>
- <refname>gtk.InputDialog</refname>
- <refpurpose>a dialog for configuring devices for the XInput
-extension.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.InputDialog</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkinputdialog">gtk.InputDialog</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
- +-- <link linkend="class-gtkinputdialog">gtk.InputDialog</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkinputdialog">
- <title>gtk.InputDialog Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
- <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkinputdialog">
- <title>gtk.InputDialog Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkinputdialog">
- <title>gtk.InputDialog Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkinputdialog--disable-device">disable-device</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>inputdialog</parameter>
- </methodparam>
- <methodparam><parameter>deviceid</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkinputdialog--enable-device">enable-device</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>inputdialog</parameter>
- </methodparam>
- <methodparam><parameter>deviceid</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is considered too specialized or little-used for
-PyGTK, and will in the future be moved to some other package. If your
-application needs this widget, feel free to use it, as the widget does work
-and is useful in some applications; it's just not of general interest.
-However, it will eventually move out of the PyGTK distribution.</para>
- </note>
-
- <para><link
-linkend="class-gtkinputdialog"><classname>gtk.InputDialog</classname></link>
-displays a dialog which allows the user to configure XInput extension
-devices. For each device, they can control the mode of the device (disabled,
-screen-relative, or window-relative), the mapping of axes to coordinates,
-and the mapping of the devices macro keys to key press events. <link
-linkend="class-gtkinputdialog"><classname>gtk.InputDialog</classname></link>
-contains two buttons to which the application can connect; one for closing
-the dialog, and one for saving the changes. No actions are bound to these by
-default. The changes that the user makes take effect immediately.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkinputdialog">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.InputDialog</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkinputdialog"><classname>gtk.InputDialog</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkinputdialog"><classname>gtk.InputDialog</classname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkinputdialog--disable-device">
- <title>The "disable-device" gtk.InputDialog Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>inputdialog</parameter></methodparam>
- <methodparam><parameter>deviceid</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>inputdialog</parameter>&nbsp;:</term>
- <listitem><simpara>the inputdialog that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>deviceid</parameter>&nbsp;:</term>
- <listitem><simpara>the ID of the newly disabled
-device.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "disable-device" signal is emitted when the user changes the
-mode of a device from a <literal>gtk.gdk.MODE_SCREEN</literal> or
-<literal>gtk.gdk.MODE_WINDOW</literal> to
-<literal>gtk.gdk.MODE_ENABLED</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkinputdialog--enable-device">
- <title>The "enable-device" gtk.InputDialog Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>inputdialog</parameter></methodparam>
- <methodparam><parameter>deviceid</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>inputdialog</parameter>&nbsp;:</term>
- <listitem><simpara>the inputdialog that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>deviceid</parameter>&nbsp;:</term>
- <listitem><simpara>the ID of the newly disabled
-device.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "enable-device" signal is emitted when the user changes the
-mode of a device from <literal>gtk.gdk.MODE_DISABLED</literal> to a
-<literal>gtk.gdk.MODE_SCREEN</literal> or
-<literal>gtk.gdk.MODE_WINDOW</literal>. </para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkinvisible.xml b/docs/reference/pygtk-gtkinvisible.xml
deleted file mode 100644
index a4cdb8de..00000000
--- a/docs/reference/pygtk-gtkinvisible.xml
+++ /dev/null
@@ -1,178 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkinvisible">
- <refnamediv>
- <refname>gtk.Invisible</refname>
- <refpurpose>internally-used widget which is not displayed.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Invisible</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkinvisible">gtk.Invisible</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkinvisible--set-screen">set_screen</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkinvisible--get-screen">get_screen</link></methodname>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkinvisible">gtk.Invisible</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkinvisible">
- <title>gtk.Invisible Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"screen"</entry>
- <entry>Read-Write</entry>
- <entry>The screen where this window will be displayed.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkinvisible">
- <title>gtk.Invisible Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkinvisible">
- <title>gtk.Invisible Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkinvisible"><classname>gtk.Invisible</classname></link>
-widget is used internally in GTK, and is probably not useful for application
-developers. It is used for reliable pointer grabs and selection handling in
-the code for drag-and-drop.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkinvisible">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Invisible</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkinvisible"><classname>gtk.Invisible</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkinvisible"><classname>gtk.Invisible</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkinvisible--set-screen">
- <title>gtk.Invisible.set_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_screen</methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
- object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_screen</methodname>() method sets the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-(specified by <parameter>screen</parameter>) where the <link
-linkend="class-gtkinvisible"><classname>gtk.Invisible</classname></link>
-object will be displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkinvisible--get-screen">
- <title>gtk.Invisible.get_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_screen</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term> <term><parameter
- role="keyword"></parameter>&nbsp;:</term> <listitem><simpara>the
- associated <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_screen</methodname>() method returns the
-associated <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-object.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkitem.xml b/docs/reference/pygtk-gtkitem.xml
deleted file mode 100644
index 290d99a5..00000000
--- a/docs/reference/pygtk-gtkitem.xml
+++ /dev/null
@@ -1,280 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkitem">
- <refnamediv>
- <refname>gtk.Item</refname>
- <refpurpose>abstract base class for <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Item</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkitem--select">select</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkitem--deselect">deselect</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkitem--toggle">toggle</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkitem">gtk.Item</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkitem">
- <title>gtk.Item Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkitem">
- <title>gtk.Item Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkitem">
- <title>gtk.Item Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkitem--deselect">deselect</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>item</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkitem--select">select</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>item</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkitem--toggle">toggle</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>item</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkitem"><classname>gtk.Item</classname></link> widget is an
-abstract base class for <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkitem--select">
- <title>gtk.Item.select</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>select</methodname>() method emits the "select"
-signal on the item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkitem--deselect">
- <title>gtk.Item.deselect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>deselect</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>deselect</methodname>() method emits the
-"deselect" signal on the item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkitem--toggle">
- <title>gtk.Item.toggle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>toggle</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>toggle</methodname>() method emits the "toggle"
-signal on the item.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkitem--deselect">
- <title>The "deselect" gtk.Item Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>item</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>item</parameter>&nbsp;:</term>
- <listitem><simpara>the item that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "deselect" signal is emitted when the item is
-deselected.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkitem--select">
- <title>The "select" gtk.Item Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>item</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>item</parameter>&nbsp;:</term>
- <listitem><simpara>the item that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "select" signal is emitted when the item is selected.
-</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkitem--toggle">
- <title>The "toggle" gtk.Item Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>item</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>item</parameter>&nbsp;:</term>
- <listitem><simpara>the item that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "toggle" signal is emitted when the item is toggled.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkitemfactory.xml b/docs/reference/pygtk-gtkitemfactory.xml
deleted file mode 100644
index 8f1e984b..00000000
--- a/docs/reference/pygtk-gtkitemfactory.xml
+++ /dev/null
@@ -1,676 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkitemfactory">
- <refnamediv>
- <refname>gtk.ItemFactory</refname>
- <refpurpose>creates menus, menubars and option menus from a data
-description.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ItemFactory</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkitemfactory">gtk.ItemFactory</link></methodname>
- <methodparam><parameter
- role="keyword">container_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_group</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkitemfactory--construct">construct</link></methodname>
- <methodparam><parameter
- role="keyword">container_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkitemfactory--get-item">get_item</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkitemfactory--get-widget">get_widget</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkitemfactory--get-widget-by-action">get_widget_by_action</link></methodname>
- <methodparam><parameter
- role="keyword">action</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkitemfactory--get-item-by-action">get_item_by_action</link></methodname>
- <methodparam><parameter
- role="keyword">action</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkitemfactory--create-items">create_items</link></methodname>
- <methodparam><parameter
- role="keyword">entries</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkitemfactory--delete-item">delete_item</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkitemfactory--popup">popup</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mouse_button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter><initializer>GDK_CURRENT_TIME</initializer></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--item-factory-from-widget">gtk.item_factory_from_widget</link></methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--item-factory-path-from-widget">gtk.item_factory_path_from_widget</link></methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkitemfactory">gtk.ItemFactory</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkitemfactory">
- <title>gtk.ItemFactory Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkitemfactory">
- <title>gtk.ItemFactory Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <warning>
- <para><link
-linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
-is deprecated in PyGTK 2.4 and above. The <link
-linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>
-should be used instead.</para>
- </warning>
-
- <para>The <link
-linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
-provides a convenient way to create and manage menus, menubars and option
-menus from a data description. The data description is a tuple or list
-containing a list of entry tuples that each describe an individual menu,
-menuitem, etc. Each entry tuple may contain the following entry fields
-though only the path must be specified; the other fields are
-optional:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>A path that defines the logical position of the menu or
-menuitem in the menu hierarchy. a path is similar to a file path in that it
-starts with a slash (/) character and all components are joined by a slash
-(/) character. The last component may have an underscore that indicates that
-the following character is to be used as the accelerator mnemonic.</simpara>
- </listitem>
- <listitem>
- <simpara>An accelerator that defines a key sequence that will
-activate the menuitem. The key sequence is a set of zero or more modifiers
-followed by a single key. The modifier keys are:</simpara>
-
- <variablelist>
- <varlistentry>
- <term>"&lt;alt&gt;"</term>
- <listitem>
- <simpara><keycap>Alt-L</keycap>or
-<keycap>Alt-R</keycap></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;ctl&gt;"</term>
- <term>"&lt;ctrl&gt;"</term>
- <term>"&lt;control&gt;"</term>
- <listitem>
- <simpara><keycap>Ctrl-L</keycap>or
-<keycap>Ctrl-R</keycap></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;shift&gt;"</term>
- <term>"&lt;shft&gt;"</term>
- <listitem>
- <simpara><keycap>Shift-L</keycap>or
-<keycap>Shift-R</keycap></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </listitem>
- <listitem>
- <simpara>A callback function or method that will be invoked when the
-menu item is activated or the accelerator key sequence is pressed. The
-callback function is defined as either:</simpara>
-
- <programlisting>
- def callback(callback_data, callback_action, widget)
- def callback(callback_action, widget)
-</programlisting>
-
- <simpara>where <parameter>callback_action</parameter> is the
-callback action defined below, <parameter>callback_data</parameter> is the
-data passed with the <link
-linkend="method-gtkitemfactory--create-items"><methodname>create_items</methodname>()</link>
-method and <parameter>widget</parameter> is the menuitem widget. The second
-definition must be used if no <parameter>callback_data</parameter> argument
-is specified by the call to <link
-linkend="method-gtkitemfactory--create-items"><methodname>create_items</methodname>()</link>.</simpara>
- </listitem>
- <listitem>
- <simpara>A callback action that is an arbitrary integer
-value.</simpara>
- </listitem>
- <listitem>
- <simpara>An item type is a string describing the type of the
-item:</simpara>
-
- <variablelist>
- <varlistentry>
- <term>"None"</term>
- <term>""</term>
- <term>"Item"</term>
- <listitem>
- <simpara>a simple menu item</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;Title&gt;"</term>
- <listitem>
- <simpara>a title item</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;ImageItem&gt;"</term>
- <listitem>
- <simpara>an image item</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;StockItem&gt;"</term>
- <listitem>
- <simpara>an item holding a stock image</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;CheckItem&gt;"</term>
- <listitem>
- <simpara>a check item</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;ToggleItem&gt;"</term>
- <listitem>
- <simpara>a toggle item</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;RadioItem&gt;"</term>
- <listitem>
- <simpara>a radio item</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>&lt;path&gt;</term>
- <listitem>
- <simpara>the path of a radio item group to add item
-to</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;Separator&gt;"</term>
- <listitem>
- <simpara>a separator</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;Tearoff&gt;"</term>
- <listitem>
- <simpara>a tearoff separator</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;Branch&gt;"</term>
- <listitem>
- <simpara>an item to hold sub items</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"&lt;LastBranch&gt;"</term>
- <listitem>
- <simpara>a right justified item to hold sub items</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </listitem>
- <listitem>
- <simpara>extra data that is either a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> or a
-stock ID</simpara>
- </listitem>
- </itemizedlist>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkitemfactory">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ItemFactory</methodname>
- <methodparam><parameter
- role="keyword">container_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_group</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">container_type</parameter>&nbsp;:</term>
- <listitem><simpara>the kind of menu to create; one of: <link
-linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>, <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> or <link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the new item factory, a string of the
-form <literal>"&lt;name&gt;"</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_group</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-to which the accelerators for the menu items will be added, or
-<literal>None</literal> to create a new one</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkitemfactory--construct">
- <title>gtk.ItemFactory.construct</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>construct</methodname>
- <methodparam><parameter
- role="keyword">container_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">container_type</parameter>&nbsp;:</term>
- <listitem><simpara>the kind of menu to create; one of: <link
-linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>, <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> or <link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the item factory, a string of the
-form <literal>"&lt;name&gt;"</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_group</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-to which the accelerators for the menu items will be added, or
-<literal>None</literal> to create a new one</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>construct</methodname>() method initializes an
-item factory.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkitemfactory--get-item">
- <title>gtk.ItemFactory.get_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_item</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path to the menu item</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the menu item with the specified
-<parameter>path</parameter>, or <literal>None</literal> if
-<parameter>path</parameter> doesn't lead to a menu item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_item</methodname>() method returns the menu
-item that corresponds to <parameter>path</parameter>. If the widget
-corresponding to <parameter>path</parameter> is a menu item that opens a
-submenu, then the item is returned. If you are interested in the submenu,
-use the <link
-linkend="method-gtkitemfactory--get-widget"><methodname>get_widget</methodname>()</link>
-method instead.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkitemfactory--get-widget">
- <title>gtk.ItemFactory.get_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_widget</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path to the widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the widget associated with the specified
-<parameter>path</parameter>, or <literal>None</literal> if
-<parameter>path</parameter> doesn't lead to a widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_widget</methodname>() method returns the
-widget that corresponds to <parameter>path</parameter>. If the widget
-corresponding to <parameter>path</parameter> is a menu item that opens a
-submenu, then the submenu is returned. If you are interested in the menu
-item, use <link
-linkend="method-gtkitemfactory--get-item"><methodname>get_item</methodname>()</link>
-instead.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkitemfactory--get-widget-by-action">
- <title>gtk.ItemFactory.get_widget_by_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_widget_by_action</methodname>
- <methodparam><parameter
- role="keyword">action</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">action</parameter>&nbsp;:</term>
- <listitem><simpara>a callback action value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the widget that corresponds to the given
-action, or <literal>None</literal> if no widget was
-found</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_widget_by_action</methodname>() method
-returns the widget that is associated with the specified
-<parameter>action</parameter>. If there are multiple items with the same
-<parameter>action</parameter>, the result is undefined.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkitemfactory--get-item-by-action">
- <title>gtk.ItemFactory.get_item_by_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_item_by_action</methodname>
- <methodparam><parameter
- role="keyword">action</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">action</parameter>&nbsp;:</term>
- <listitem><simpara>a callback action value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the menu item that corresponds to the specified
-<parameter>action</parameter>, or <literal>None</literal> if no menu item
-was found</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_item_by_action</methodname>() returns the
-menu item that is associated with the specified
-<parameter>action</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkitemfactory--create-items">
- <title>gtk.ItemFactory.create_items</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_items</methodname>
- <methodparam><parameter
- role="keyword">entries</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">entries</parameter>&nbsp;:</term>
- <listitem><simpara>a tuple or list of item factory
-entries</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">callback_data</parameter>&nbsp;:</term>
- <listitem><simpara>optional data passed to the callback functions
-of all entries</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>create_items</methodname>() method creates the
-menu items from the specified item factory <parameter>entries</parameter>.
-If no <parameter>callback_data</parameter> is specified it will not be
-passed to the callback functions i.e the callback functions will be passed
-one less argument.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkitemfactory--delete-item">
- <title>gtk.ItemFactory.delete_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>delete_item</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>delete_item</methodname>() method deletes the
-menu item that was created with the specified
-<parameter>path</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkitemfactory--popup">
- <title>gtk.ItemFactory.popup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>popup</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mouse_button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter><initializer>0L</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">mouse_button</parameter>&nbsp;:</term>
- <listitem><simpara>the mouse button that was pressed to initiate
-this action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>an optional timestamp for this action; default
-is 0L which means use the current time</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>popup</methodname>() method pops up the menu
-constructed from the item factory at the specified location
-(<parameter>x</parameter>, <parameter>y</parameter>). This method is
-generally invoked in response to a "button_press_event" so the arguments are
-retrieved from the event information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--item-factory-from-widget">
- <title>gtk.item_factory_from_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.item_factory_from_widget</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
- that created <parameter>widget</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.item_factory_from_widget</function>() function
-returns the <link
-linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
-object that created the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> specified
-by <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--item-factory-path-from-widget">
- <title>gtk.item_factory_path_from_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.item_factory_path_from_widget</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the full path to the <link
-linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
-that created <parameter>widget</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.item_factory_path_from_widget</function>()
-function returns the full path to the <link
-linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
-that created the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> specified
-by <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtklabel.xml b/docs/reference/pygtk-gtklabel.xml
deleted file mode 100644
index 72272ee0..00000000
--- a/docs/reference/pygtk-gtklabel.xml
+++ /dev/null
@@ -1,1745 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtklabel">
- <refnamediv>
- <refname>gtk.Label</refname>
- <refpurpose>a widget that displays a limited amount of read-only
-text</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Label</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkmisc">gtk.Misc</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtklabel">gtk.Label</link></methodname>
- <methodparam><parameter
- role="keyword">str</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-text">set_text</link></methodname>
- <methodparam><parameter role="keyword">str</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-text">get_text</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-attributes">set_attributes</link></methodname>
- <methodparam><parameter
- role="keyword">attrs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-attributes">get_attributes</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-label">set_label</link></methodname>
- <methodparam><parameter role="keyword">str</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-label">get_label</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-markup">set_markup</link></methodname>
- <methodparam><parameter role="keyword">str</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-use-markup">set_use_markup</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-use-markup">get_use_markup</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-use-underline">set_use_underline</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-use-underline">get_use_underline</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-markup-with-mnemonic">set_markup_with_mnemonic</link></methodname>
- <methodparam><parameter role="keyword">str</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-mnemonic-keyval">get_mnemonic_keyval</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-mnemonic-widget">set_mnemonic_widget</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-mnemonic-widget">get_mnemonic_widget</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-text-with-mnemonic">set_text_with_mnemonic</link></methodname>
- <methodparam><parameter role="keyword">str</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-justify">set_justify</link></methodname>
- <methodparam><parameter
- role="keyword">jtype</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-justify">get_justify</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-pattern">set_pattern</link></methodname>
- <methodparam><parameter
- role="keyword">pattern</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-line-wrap">set_line_wrap</link></methodname>
- <methodparam><parameter
- role="keyword">wrap</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-line-wrap">get_line_wrap</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-selectable">set_selectable</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-selectable">get_selectable</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--select-region">select_region</link></methodname>
- <methodparam><parameter
- role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end_offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-selection-bounds">get_selection_bounds</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-layout">get_layout</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-layout-offsets">get_layout_offsets</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-ellipsize">set_ellipsize</link></methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-ellipsize">get_ellipsize</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-width-chars">set_width_chars</link></methodname>
- <methodparam><parameter
- role="keyword">n_chars</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-width-chars">get_width_chars</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-single-line-mode">set_single_line_mode</link></methodname>
- <methodparam><parameter
- role="keyword">single_line_mode</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-single-line-mode">get_single_line_mode</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-single-line-mode">get_max_width_chars</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-single-line-mode">set_max_width_chars</link></methodname>
- <methodparam><parameter
- role="keyword">n_chars</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--get-angle">get_angle</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklabel--set-angle">set_angle</link></methodname>
- <methodparam><parameter
- role="keyword">angle</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkmisc">gtk.Misc</link>
- +-- <link linkend="class-gtklabel">gtk.Label</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtklabel">
- <title>gtk.Label Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkmisc">gtk.Misc Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"angle"</entry>
- <entry>Read-Write</entry>
- <entry>The angle that the baseline of the label makes with the
-horizontal, in degrees, measured counterclockwise. An angle of 90 reads from
-from bottom to top, an angle of 270, from top to bottom. Ignored if the label
-is selectable, wrapped, or ellipsized. Allowed values: [0,360]
-Default value: 0. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"attributes"</entry>
- <entry>Read-Write</entry>
- <entry>A list of Pango style attributes to apply to the text
-of the label.</entry>
- </row>
-
- <row valign="top">
- <entry>"cursor-position"</entry>
- <entry>Read</entry>
- <entry>The current position of the insertion cursor in
-chars. Allowed values: >= 0. Default value: 0</entry>
- </row>
-
- <row valign="top">
- <entry>"ellipsize"</entry>
- <entry>Read-Write</entry>
-
- <entry>The preferred place to ellipsize the string, if the
-label does not have enough room to display the entire string, specified as
-one of the <xref linkend="pango-ellipsize-mode-constants"
-endterm="pango-ellipsize-mode-constants-title"></xref>. Note that setting
-this property to a value other than <literal>pango.ELLIPSIZE_NONE</literal>
-has the side-effect that the label requests only enough space to display the
-ellipsis "...". In particular, this means that ellipsizing labels don't work
-well in notebook tabs, unless the tab's "tab-expand" property is set to
-<literal>True</literal>. Other means to set a label's width are with the
-<link
-linkend="method-gtkwidget--set-size-request"><methodname>gtk.Widget.set_size_request</methodname>()</link>
-and <link
-linkend="method-gtklabel--set-width-chars"><methodname>set_width_chars</methodname>()</link>
-methods. Default value: <literal>pango.ELLIPSIZE_NONE</literal>. Available
-in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"justify"</entry>
- <entry>Read-Write</entry>
- <entry>The alignment of the lines in the text of the label
-relative to each other. The possible values are:
-<literal>gtk.JUSTIFY_LEFT</literal>, <literal>gtk.JUSTIFY_RIGHT</literal>,
-<literal>gtk.JUSTIFY_CENTER</literal>, <literal>gtk.JUSTIFY_FILL</literal>.
-This does NOT affect the alignment of the label within its
-allocation. Default value: <literal>gtk.JUSTIFY_LEFT</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"label"</entry>
- <entry>Read-Write</entry>
- <entry>The text of the label. Default value:
-<literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"max-width-chars"</entry>
- <entry>Read-Write</entry>
- <entry>The desired maximum width of the label, in characters.
-If this property is set to -1, the width will be calculated automatically,
-otherwise the label will request space for no more than the requested number
-of characters. If the "width-chars" property is set to a positive value, then
-the "max-width-chars" property is ignored. Allowed values: >= -1.
-Default value: -1. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"mnemonic-keyval"</entry>
- <entry>Read</entry>
- <entry>The mnemonic accelerator key for this label. Default
-value: 16777215</entry>
- </row>
-
- <row valign="top">
- <entry>"mnemonic-widget"</entry>
- <entry>Read-Write</entry>
- <entry>The widget to be activated when the label's mnemonic
-key is pressed.</entry>
- </row>
-
- <row valign="top">
- <entry>"pattern"</entry>
- <entry>Write</entry>
- <entry>A string with _ characters in positions used to
-identify to characters in the text to underline. Default value:
-<literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"selectable"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the label text can be
-selected with the mouse. Default value: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"selection-bound"</entry>
- <entry>Read</entry>
- <entry>The position of the opposite end of the selection from
-the cursor in chars. Allowed values: >= 0. Default value: 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"single-line-mode"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal> the label is in single line
-mode. In single line mode, the height of the label does not depend on the
-actual text, it is always set to ascent + descent of the font. This can be
-an advantage in situations where resizing the label because of text changes
-would be distracting, e.g. in a statusbar. Default value:
-<literal>False</literal>. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"use-markup"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the text of the label
-includes XML markup. Default value: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"use-underline"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, an underscore in the text
-indicates the next character should be used for the mnemonic accelerator
-key. Default value: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"width-chars"</entry>
- <entry>Read-Write</entry>
-
- <entry>The desired width of the label, in characters. If this
-property is set to -1, the width will be calculated automatically, otherwise
-the label will request either 3 characters or the property value, whichever
-is greater. Allowed values: >= -1. Default value: -1. Available in GTK+
-2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"wrap"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, wrap lines if the text
-becomes too wide. Default value: <literal>False</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtklabel">
- <title>gtk.Label Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtklabel">
- <title>gtk.Label Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtklabel--copy-clipboard">copy-clipboard</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>label</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtklabel--move-cursor">move-cursor</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>label</parameter>
- </methodparam>
- <methodparam><parameter>step</parameter>
- </methodparam>
- <methodparam><parameter>count</parameter>
- </methodparam>
- <methodparam><parameter>extend_selection</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtklabel--populate-popup">populate-popup</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>label</parameter>
- </methodparam>
- <methodparam><parameter>menu</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> is a widget
-class that displays a limited amount of read-only text. Labels are used by
-several widgets (e.g. <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link>, and its
-subclasses, <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>,
-etc.) to provide text display as well as by applications to display
-messages, etc, to the user. Most of the functionality of a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> is directed
-at modifying the style and layout of the text within the widget allocation.
-A <link linkend="class-gtklabel"><classname>gtk.Label</classname></link> is
-a "windowless" object which means that it cannot receive events directly. A
-<link linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link>
-can be used to provide event handling capabilities to a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> widget if
-needed.</para>
-
- <refsect2>
- <title>Mnemonics</title>
-
- <para>Label text may be specified with embedded underscore characters
-that are used to indicate that the following character should be underlined
-and used as the mnemonic accelerator (if it's the first underlined
-character). The <link
-linkend="method-gtklabel--set-text-with-mnemonic"><methodname>set_text_with_mnemonic</methodname>()</link>
-method is used to parse the label text for a mnemonic characters. Mnemonics
-automatically activate any activatable widget the label is inside, such as a
-<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link>; if
-the label is not inside an activatable widget, you have to tell the label
-about the target using the <link
-linkend="method-gtklabel--set-mnemonic-widget"><methodname>set_mnemonic_widget</methodname>()</link>
-method. Here's a simple example where the label is inside a button:</para>
-
- <programlisting>
- # Pressing Alt+H will activate this button
- button = gtk.Button()
- label = gtk.Label("_Hello")
- label.set_use_underline(True)
- button.add(label)
-</programlisting>
-
- <para>As a convenience you can create a button with a mnemonic label
-as follows:</para>
-
- <programlisting>
- # Pressing Alt+H will activate this button
- button = gtk.Button(label="_Hello", use_underline=True)
-</programlisting>
-
- <para>To create a mnemonic for a widget alongside the label, such as a
-<link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>, you
-have to point the label at the entry with the <link
-linkend="method-gtklabel--set-mnemonic-widget"><methodname>set_mnemonic_widget</methodname>()</link>
-method:</para>
-
- <programlisting>
- # Pressing Alt+H will focus the entry
- entry = gtk.Entry()
- label = gtk.Label("_Hello")
- label.set_use_underline(True)
- label.set_mnemonic_widget(entry)
-</programlisting>
-
- </refsect2>
-
- <refsect2>
- <title>Markup (styled text)</title>
-
- <para>To make it easy to format text in a label (changing colors, fonts,
-etc.), the label text can be provided in the <link
-linkend="pango-markup-language">Pango markup format</link> which is a simple
-XML markup format. The <link
-linkend="method-gtklabel--set-markup"><methodname>gtk.Label.set_markup</methodname>()</link>
-method sets the label using text in valid markup format (e.g. '&lt;', '&gt;'
-and '&amp;' characters must be replaced by &amp;lt;, &amp;gt; and &amp;amp;
-respectively. For example:</para>
-
- <programlisting>
- label = gtk.Label()
- label.set_markup("&lt;small&gt;Small text&lt;/small&gt;");
-</programlisting>
-
- <para>The markup passed to the <link
-linkend="method-gtklabel--set-markup"><methodname>set_markup</methodname>()</link>
-method must be valid. For example, the literal &lt;&gt;&amp; characters must
-be escaped as &amp;lt;, &amp;gt;, and &amp;amp;. If you pass text obtained
-from the user, file, or a network to the <link
-linkend="method-gtklabel--set-markup"><methodname>set_markup</methodname>()</link>
-method, you'll want to escape it with the Python Library
-<function>xml.sax.saxutils.escape</function>() function.</para>
-
- <para>Markup strings are just a convenient way to set the <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-on a label. Using the <link
-linkend="method-gtklabel--set-attributes"><methodname>set_attributes</methodname>()</link>
-method may be a simpler way to set attributes in some cases. Be careful
-though; <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-tends to cause internationalization problems, unless you're applying
-attributes to the entire string because specifying the start_index and
-end_index for a <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-requires knowledge of the exact string being displayed, so translations will
-cause problems.</para>
-
- </refsect2>
-
- <refsect2>
- <title>Selectable labels</title>
-
- <para>Labels can be made selectable with the <link
-linkend="method-gtklabel--set-selectable"><methodname>set_selectable</methodname>()</link>
-method. Selectable labels allow the user to copy the label contents to the
-clipboard. Only labels that contain useful-to-copy information such as error
-messages should be made selectable.</para>
-
- </refsect2>
-
- <refsect2>
- <title>Text layout</title>
-
- <para>A label can contain any number of paragraphs, but will have
-performance problems if it contains more than a small number. Paragraphs are
-separated by newlines or other paragraph separators understood by
-Pango.</para>
-
- <para>Labels can automatically wrap text if you call the <link
-linkend="method-gtklabel--set-line-wrap"><methodname>set_line_wrap</methodname>()</link>
-method.</para>
-
- <para>The <link
-linkend="method-gtklabel--set-justify"><methodname>set_justify</methodname>()</link>
-method sets how the lines in a label align with one another. If you want to
-set how the label as a whole aligns in its available space, see the <link
-linkend="method-gtkmisc--set-alignment"><methodname>gtk.Misc.set_alignment</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1 id="constructor-gtklabel">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Label</methodname>
- <methodparam><parameter
- role="keyword">str</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">str</parameter>&nbsp;:</term>
- <listitem><simpara>The text of the label or <literal>None</literal>
-for a blank label</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> with the
-text specified by <parameter>str</parameter> inside it. You can pass
-<literal>None</literal> to get a blank label.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtklabel--set-text">
- <title>gtk.Label.set_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text</methodname>
- <methodparam><parameter
- role="keyword">str</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">str</parameter>&nbsp;:</term>
- <listitem><simpara>The new text for the
-label.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_text</methodname>() method sets the text
-within the <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> widget. It
-replaces any text that was there before and will clear any previously set
-mnemonic accelerators.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-text">
- <title>gtk.Label.get_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the text in the label
-widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_text</methodname>() method fetches the text
-from a label widget, as displayed on the screen. This does not include any
-Pango markup or embedded underscore characters indicating mnemonics. (See
-<link
-linkend="method-gtklabel--get-label"><methodname>get_label</methodname>()</link>).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-attributes">
- <title>gtk.Label.set_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_attributes</methodname>
- <methodparam><parameter
- role="keyword">attrs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">attrs</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_attributes</methodname>() method applies a
-<link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-list of attributes to the label text. The attributes set with this function
-will be ignored if either the "use-underline" or "use-markup" attributes is
-<literal>True</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-attributes">
- <title>gtk.Label.get_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_attributes</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the attribute list, or <literal>None</literal>
-if no attributes were set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_attributes</methodname>() method returns the
-attribute list that was set on the label using <link
-linkend="method-gtklabel--set-attributes"><methodname>set_attributes</methodname>()</link>,
-if any. This function does not reflect attributes that come from the labels
-markup (see <link
-linkend="method-gtklabel--set-markup"><methodname>set_markup</methodname>()</link>).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-label">
- <title>gtk.Label.set_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_label</methodname>
- <methodparam><parameter
- role="keyword">str</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">str</parameter>&nbsp;:</term>
- <listitem><simpara>the new text (including mnemonics or markup) to
-set for the label</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_label</methodname>() method sets the text of
-the label. The label is parsed for embedded underscores and Pango markup
-depending on the values of the "use-underline" and "use-markup"
-properties.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-label">
- <title>gtk.Label.get_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_label</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the text of the label
-widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_label</methodname>() method returns the text
-from a label widget including any Pango markup and embedded underscores
-indicating mnemonics. (See <link
-linkend="method-gtklabel--get-text"><methodname>get_text</methodname>()</link>
-that just returns the text).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-markup">
- <title>gtk.Label.set_markup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_markup</methodname>
- <methodparam><parameter
- role="keyword">str</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">str</parameter>&nbsp;:</term>
- <listitem><simpara>a markup string</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_markup</methodname>() method parses
-<parameter>str</parameter>, which is marked up with the Pango text markup
-language, and sets the label's text and attribute list.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-use-markup">
- <title>gtk.Label.set_use_markup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_markup</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the label's text
-should be parsed for markup.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_use_markup</methodname>() method sets the
-"use-markup" property to the value of <parameter>setting</parameter>. If
-<literal>True</literal> the text of the label should be parsed as
-markup.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-use-markup">
- <title>gtk.Label.get_use_markup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_markup</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the label's text
-will be parsed for markup.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_user_markup</methodname>() method returns
-the value of the "use-markup" property. If <literal>True</literal> the
-label's text is parsed as markup. See <link
-linkend="method-gtklabel--set-use-markup"><methodname>set_use_markup</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-use-underline">
- <title>gtk.Label.set_use_underline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_underline</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> underscores in the
-text indicate mnemonics</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_use_underline</methodname>() method sets the
-"use-underline" property to the value of <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal>, an underscore in
-the text indicates the next character should be used for the mnemonic
-accelerator key.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-use-underline">
- <title>gtk.Label.get_use_underline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_underline</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if an embedded
-underscore in the label indicates the mnemonic
-accelerator.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_use_underline</methodname>() method returns
-the value of the "use-underline" property. If <literal>True</literal> an
-embedded underscore in the label indicates the next character is a mnemonic.
-See <link
-linkend="method-gtklabel--set-use-underline"><methodname>set_use_underline</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-markup-with-mnemonic">
- <title>gtk.Label.set_markup_with_mnemonic</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_markup_with_mnemonic</methodname>
- <methodparam><parameter
- role="keyword">str</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">str</parameter>&nbsp;:</term>
- <listitem><simpara>a markup string including embedded
-underscores</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_markup_with_mnemonic</methodname>() method
-parses <parameter>str</parameter> as markup, setting the label's text and
-attribute list based on the parse results. If characters in
-<parameter>str</parameter> are preceded by an underscore, they are
-underlined indicating that they represent a mnemonic accelerator. The
-mnemonic key can be used to activate another widget, chosen automatically,
-or explicitly using the <link
-linkend="method-gtklabel--set-mnemonic-widget"><methodname>set_mnemonic_widget</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-mnemonic-keyval">
- <title>gtk.Label.get_mnemonic_keyval</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_mnemonic_keyval</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a keyval, or the void symbol
-keyval</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_mnemonic_keyval</methodname>() method
-returns the value of the "mnemonic-keyval" property that contains the keyval
-used for the mnemonic accelerator if one has been set on the label. If there
-is no mnemonic set up it returns the void symbol keyval.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-mnemonic-widget">
- <title>gtk.Label.set_mnemonic_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_mnemonic_widget</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to be activated when the mnemonic is
-pressed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_mnemonic_widget</methodname>() method sets
-the "mnemonic-widget" property using the value of
-<parameter>widget</parameter>. This method associates the label mnemonic
-with a widget that will be activated when the mnemonic accelerator is
-pressed. When the label is inside a widget (like a <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link> or a
-<link linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link>
-tab) it is automatically associated with the correct widget, but sometimes
-(i.e. when the target is a <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> next to the
-label) you need to set it explicitly using this function. The target widget
-will be activated by emitting "mnemonic_activate" on it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-mnemonic-widget">
- <title>gtk.Label.get_mnemonic_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_mnemonic_widget</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the target of the label's mnemonic, or
-<literal>None</literal> if none has been set and the default algorithm will
-be used.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_mnemonic_widget</methodname>() method
-retrieves the value of the "mnemonic-widget" property which is the target of
-the mnemonic accelerator of this label. See <link
-linkend="method-gtklabel--set-mnemonic-widget"><methodname>set_mnemonic_widget</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-text-with-mnemonic">
- <title>gtk.Label.set_text_with_mnemonic</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text_with_mnemonic</methodname>
- <methodparam><parameter
- role="keyword">str</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">str</parameter>&nbsp;:</term>
- <listitem><simpara>the label text with embedded underscore
-characters indicating the mnemonic characters</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_text_with_mnemonic</methodname>() method
-sets the label's text from the string <parameter>str</parameter>. If
-characters in <parameter>str</parameter> are preceded by an underscore, they
-are underlined indicating that they represent a mnemonic accelerator. The
-mnemonic key can be used to activate another widget, chosen automatically,
-or explicitly using the <link
-linkend="method-gtklabel--set-mnemonic-widget"><methodname>set_mnemonic_widget</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-justify">
- <title>gtk.Label.set_justify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_justify</methodname>
- <methodparam><parameter
- role="keyword">jtype</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">jtype</parameter>&nbsp;:</term>
- <listitem><simpara>justification type</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_justify</methodname>() method sets the
-alignment of the lines in the text of the label relative to each other using
-the value of <parameter>jtype</parameter>. The possible values of
-<parameter>jtype</parameter> are: <literal>gtk.JUSTIFY_LEFT</literal>,
-<literal>gtk.JUSTIFY_RIGHT</literal>, <literal>gtk.JUSTIFY_CENTER</literal>
-and <literal>gtk.JUSTIFY_FILL</literal>. <literal>gtk.JUSTIFY_LEFT</literal>
-is the default value when the widget is first created. If you want to set
-the alignment of the label as a whole, use the <link
-linkend="method-gtkmisc--set-alignment"><methodname>gtk.Misc.set_alignment</methodname>()</link>
-method instead. The <link
-linkend="method-gtklabel--set-justify"><methodname>set_justify</methodname>()</link>
-has no effect on labels containing only a single line.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-justify">
- <title>gtk.Label.get_justify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_justify</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the label justification</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_justify</methodname>() method returns the
-justification of the label; one of: <literal>gtk.JUSTIFY_LEFT</literal>,
-<literal>gtk.JUSTIFY_RIGHT</literal>, <literal>gtk.JUSTIFY_CENTER</literal>
-or <literal>gtk.JUSTIFY_FILL</literal>. See <link
-linkend="method-gtklabel--set-justify"><methodname>set_justify</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-pattern">
- <title>gtk.Label.set_pattern</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_pattern</methodname>
- <methodparam><parameter
- role="keyword">pattern</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pattern</parameter>&nbsp;:</term>
- <listitem><simpara>the pattern of underlines</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_pattern</methodname>() method sets the
-"pattern" property with the value of <parameter>pattern</parameter>. The
-pattern contains an underscore or space for each character in the label
-text. Any characters omitted are assumed to be spaces. For example, if the
-label text is "XXX Label" and the pattern is "___" then only the "XXX" will
-be underlined.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-line-wrap">
- <title>gtk.Label.set_line_wrap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_line_wrap</methodname>
- <methodparam><parameter
- role="keyword">wrap</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">wrap</parameter>&nbsp;:</term>
- <listitem><simpara>if True the label lines will wrap if too big
-for the widget size.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_wrap</methodname>() method sets the "wrap"
-property tot he value of <parameter>wrap</parameter>. If
-<parameter>wrap</parameter> is <literal>True</literal> the label text will
-wrap if it is wider than the widget size; otherwise, the text gets cut off
-at the edge of the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-line-wrap">
- <title>gtk.Label.get_line_wrap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line_wrap</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the lines of the
-label are automatically wrapped.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_line_wrap</methodname>() method returns the
-value of the "wrap" property. If "wrap" is <literal>True</literal> the lines
-in the label are automatically wrapped. See <link
-linkend="method-gtklabel--set-line-wrap"><methodname>set_line_wrap</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-selectable">
- <title>gtk.Label.set_selectable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_selectable</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> allow the text in
-the label to be selected</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_selectable</methodname>() method sets the
-"selectable" property with the value of <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal> the user is
-allowed to select text from the label, for copy-and-paste.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-selectable">
- <title>gtk.Label.get_selectable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selectable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the user can select
-the label text</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_selectable</methodname>() method gets the
-value of the "selectable" property set by the <link
-linkend="method-gtklabel--set-selectable"><methodname>set_selectable</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--select-region">
- <title>gtk.Label.select_region</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_region</methodname>
- <methodparam><parameter
- role="keyword">start_offset</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end_offset</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">start_offset</parameter>&nbsp;:</term>
- <listitem><simpara>start offset in characters</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_offset</parameter>&nbsp;:</term>
- <listitem><simpara>end offset in characters</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>select_region</methodname>() method selects a
-range of characters in the label, if the label is selectable. The selected
-region is the range of characters between
-<parameter>start_offset</parameter> and <parameter>end_offset</parameter>.
-See <link
-linkend="method-gtklabel--set-selectable"><methodname>set_selectable</methodname>()</link>.
-If the label is not selectable, this method has no effect. If
-<parameter>start_offset</parameter> or <parameter>end_offset</parameter> are
--1, then the end of the label will be substituted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-selection-bounds">
- <title>gtk.Label.get_selection_bounds</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selection_bounds</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the start and end character
-offsets of the selection</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_selection_bounds</methodname>() method
-returns a tuple that contains the start and end character offsets of the
-selected text in the label if the selection exists. If there is no selection
-or the label is not selectable, an empty tuple is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-layout">
- <title>gtk.Label.get_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_layout</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> for
-this label</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_layout</methodname>() method returns the
-<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-used to display the label. The layout is useful to e.g. convert text
-positions to pixel positions, in combination with <link
-linkend="method-gtklabel--get-layout-offsets"><methodname>get_layout_offsets</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-layout-offsets">
- <title>gtk.Label.get_layout_offsets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_layout_offsets</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the X offset of the layout,
-or <literal>None</literal> and the Y offset of layout, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_layout_offsets</methodname>() method returns
-a tuple containing the coordinates where the label will draw the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-representing the text in the label. This method is useful for converting
-mouse events into coordinates inside the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>, e.g.
-to take some action if some part of the label is clicked. Of course you will
-need to create a <link
-linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link> to
-receive the events, and pack the label inside it, since labels are a
-"windowless" (<literal>gtk.NO_WINDOW</literal>) widget. Remember when using
-the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-functions you need to convert to and from pixels using
-<function>pango.PIXELS()</function> or
-<literal>pango.SCALE</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-ellipsize">
- <title>gtk.Label.set_ellipsize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_ellipsize</methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mode</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="pango-ellipsize-mode-constants"
- endterm="pango-ellipsize-mode-constants-title"></xref> to
- use</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_ellipsize</methodname>() method sets the
-"ellipsize" property to the value of
-<parameter>mode</parameter>. <parameter>mode</parameter> should be one of
-the <xref linkend="pango-ellipsize-mode-constants"
-endterm="pango-ellipsize-mode-constants-title"></xref>. The "ellipsize"
-property specifies if and where an ellipse should be used if there is not
-enough room for the label text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-ellipsize">
- <title>gtk.Label.get_ellipsize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_ellipsize</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current ellipsize mode</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_ellipsize</methodname>() method returns the
-value of the "ellipsize" property which contains one of the <xref
-linkend="pango-ellipsize-mode-constants"
-endterm="pango-ellipsize-mode-constants-title"></xref>. The "ellipsize"
-property specifies if and where an ellipse should be used if there is not
-enough room for the label text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-width-chars">
- <title>gtk.Label.set_width_chars</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_width_chars</methodname>
- <methodparam><parameter
- role="keyword">n_chars</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">n_chars</parameter>&nbsp;:</term>
- <listitem><simpara> the new desired width, in
-characters.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_width_chars</methodname>() method sets the
-"width-chars" property to the value of <parameter>n_chars</parameter>. The
-"width-chars" property specifies the desired width of the label in
-characters.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-width-chars">
- <title>gtk.Label.get_width_chars</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_width_chars</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the desired width of the label in
-characters.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_width_chars</methodname>() method returns
-the value of the "width-chars" property that specifies the desired width of
-the label in characters.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-single-line-mode">
- <title>gtk.Label.set_single_line_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_single_line_mode</methodname>
- <methodparam><parameter
- role="keyword">single_line_mode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">single_line_mode</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the label is in
-single line mode.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_single_line_mode</methodname>() method sets
-the "single-line-mode" property to the value of
-<parameter>single_line_mode</parameter>. If
-<parameter>single_line_mode</parameter> is <literal>True</literal> the label
-is in single line mode where the height of the label does not depend on the
-actual text, it is always set to ascent + descent of the font.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-single-line-mode">
- <title>gtk.Label.get_single_line_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_single_line_mode</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_single_line_mode</methodname>() method
-returns the value of the "single-line-mode" property. See the <link
-linkend="method-gtklabel--set-single-line-mode"><methodname>set_single_line_mode</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-max-width-chars">
- <title>gtk.Label.set_max_width_chars</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_max_width_chars</methodname>
- <methodparam><parameter
- role="keyword">n_chars</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">n_chars</parameter>&nbsp;:</term>
- <listitem><simpara> the new desired maximum width, in
-characters.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_max_width_chars</methodname>() method sets
-the "max-width-chars" property to the value of
-<parameter>n_chars</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-max-width-chars">
- <title>gtk.Label.get_max_width_chars</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_max_width_chars</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_max_width_chars</methodname>() method
-returns the value of the "max-width-chars" property which is the desired
-maximum width of the label in characters.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--set-angle">
- <title>gtk.Label.set_angle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_angle</methodname>
- <methodparam><parameter
- role="keyword">angle</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">angle</parameter>&nbsp;:</term>
- <listitem><simpara> the angle that the baseline of the label makes
-with the horizontal, in degrees, measured counterclockwise</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_angle</methodname>() method sets the "angle"
-property to the value of
-<parameter>angle</parameter>. <parameter>angle</parameter> is the angle of
-rotation for the label. An angle of 90 reads from from bottom to top, an
-angle of 270, from top to bottom. The angle setting for the label is ignored
-if the label is selectable, wrapped, or ellipsized.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklabel--get-angle">
- <title>gtk.Label.get_angle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_angle</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_angle</methodname>() method returns the
-value of the "angle" property. See the <link
-linkend="method-gtklabel--set-angle"><methodname>set_angle</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtklabel--copy-clipboard">
- <title>The "copy-clipboard" gtk.Label Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>label</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>label</parameter>&nbsp;:</term>
- <listitem><simpara>the label that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "copy-clipboard" signal is emitted when text is copied from
-the label to the clipboard.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtklabel--move-cursor">
- <title>The "move-cursor" gtk.Label Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>label</parameter></methodparam>
- <methodparam><parameter>step</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>extend_selection</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>label</parameter>&nbsp;:</term>
- <listitem><simpara>the label that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>step</parameter>&nbsp;:</term>
- <listitem><simpara>the step size of the move:
-<literal>gtk.MOVEMENT_LOGICAL_POSITIONS</literal>,
-<literal>gtk.MOVEMENT_VISUAL_POSITIONS</literal>,
-<literal>gtk.MOVEMENT_WORDS</literal>,
-<literal>gtk.MOVEMENT_DISPLAY_LINES</literal>,
-<literal>gtk.MOVEMENT_DISPLAY_LINE_ENDS</literal>,
-<literal>gtk.MOVEMENT_PARAGRAPHS</literal>,
-<literal>gtk.MOVEMENT_PARAGRAPH_ENDS</literal>,
-<literal>gtk.MOVEMENT_PAGES</literal> and
-<literal>gtk.MOVEMENT_BUFFER_ENDS</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of steps to
-take</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>extend_selection</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> extend the range of
- the selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-cursor" signal is emitted when the cursor is being
-moved <parameter>count</parameter> steps or size <literal>step</literal>.
-The step size is one of:</para>
-
- <programlisting>
- gtk.MOVEMENT_LOGICAL_POSITIONS, move by graphemes
- gtk.MOVEMENT_VISUAL_POSITIONS, move by graphemes
- gtk.MOVEMENT_WORDS, move by words
- gtk.MOVEMENT_DISPLAY_LINES, move by lines(wrapped lines)
- gtk.MOVEMENT_DISPLAY_LINE_ENDS, move to line ends(wrapped lines)
- gtk.MOVEMENT_PARAGRAPHS, move by paragraphs(newline-ended lines)
- gtk.MOVEMENT_PARAGRAPH_ENDS, move to ends of a paragraph
- gtk.MOVEMENT_PAGES, move by pages
- gtk.MOVEMENT_BUFFER_ENDS move to ends of the buffer
-</programlisting>
-
- <para>If <parameter>extend_selection</parameter> is
-<literal>True</literal> the selection will be extended to include the text
-moved over.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtklabel--populate-popup">
- <title>The "populate-popup" gtk.Label Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>label</parameter></methodparam>
- <methodparam><parameter>menu</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>label</parameter>&nbsp;:</term>
- <listitem><simpara>the label that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>menu</parameter>&nbsp;:</term>
- <listitem><simpara>the menu to be populated</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "populate-popup" signal is emitted when a menu needs to be
-populated on the fly.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtklayout.xml b/docs/reference/pygtk-gtklayout.xml
deleted file mode 100644
index c5ceee4f..00000000
--- a/docs/reference/pygtk-gtklayout.xml
+++ /dev/null
@@ -1,603 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtklayout">
- <refnamediv>
- <refname>gtk.Layout</refname>
- <refpurpose>infinite scrollable area containing child widgets and custom
-drawing</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Layout</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtklayout">gtk.Layout</link></methodname>
- <methodparam><parameter
- role="keyword">hadjustment</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">vadjustment</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklayout--put">put</link></methodname>
- <methodparam><parameter
- role="keyword">child_widget</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklayout--move">move</link></methodname>
- <methodparam><parameter
- role="keyword">child_widget</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklayout--set-size">set_size</link></methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklayout--get-size">get_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklayout--get-hadjustment">get_hadjustment</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklayout--get-vadjustment">get_vadjustment</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklayout--set-hadjustment">set_hadjustment</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtklayout--set-vadjustment">set_vadjustment</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtklayout">gtk.Layout</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtklayout">
- <title>gtk.Layout Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"hadjustment"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-for the horizontal position.</entry>
- </row>
-
- <row valign="top">
- <entry>"height"</entry>
- <entry>Read-Write</entry>
- <entry>the layout height</entry>
- </row>
-
- <row valign="top">
- <entry>"vadjustment"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-for the vertical position.</entry>
- </row>
-
- <row valign="top">
- <entry>"width"</entry>
- <entry>Read-Write</entry>
- <entry>the layout width</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtklayout">
- <title>gtk.Layout Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtklayout">
- <title>gtk.Layout Child Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"x"</entry>
- <entry>Read-Write</entry>
- <entry>the X position of the child</entry>
- </row>
-
- <row valign="top">
- <entry>"y"</entry>
- <entry>Read-Write</entry>
- <entry>the Y position of the child</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"bin_window"</entry>
- <entry>Read</entry>
- <entry>the window of a layout to draw into</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtklayout">
- <title>gtk.Layout Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtklayout--set-scroll-adjustments">set-scroll-adjustments</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>layout</parameter>
- </methodparam>
- <methodparam><parameter>hadjustment</parameter>
- </methodparam>
- <methodparam><parameter>vadjustment</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtklayout"><classname>gtk.Layout</classname></link> is a
-simple container widget similar to the <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link> container
-widget. Like the <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link> the <link
-linkend="class-gtklayout"><classname>gtk.Layout</classname></link> places a
-child widget at a specific position within the container. The <link
-linkend="class-gtklayout"><classname>gtk.Layout</classname></link> offers
-two features beyond the <link
-linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link>
-widget:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>a very large width and height for the container - limited
-by the size of an unsigned integer.</simpara>
- </listitem>
- <listitem>
- <simpara>horizontal and vertical adjustments can be specified for
-use with scrollbars, etc.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The <link
-linkend="class-gtklayout"><classname>gtk.Layout</classname></link> can also
-be drawn on similar to drawing on a <link
-linkend="class-gtkdrawingarea"><classname>gtk.DrawingArea</classname></link>.
-When handling expose events on a <link
-linkend="class-gtklayout"><classname>gtk.Layout</classname></link>, you must
-draw to the window specified by the <literal>bin_window</literal> attribute
-rather than the widget <literal>window</literal> attribute.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtklayout">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Layout</methodname>
- <methodparam><parameter
- role="keyword">hadjustment</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">vadjustment</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">hadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>horizontal adjustment, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">vadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>vertical adjustment, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtklayout"><classname>gtk.Layout</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtklayout"><classname>gtk.Layout</classname></link>. Usually
-the <parameter>hadjustment</parameter> and
-<parameter>vadjustment</parameter> arguments are not specified or are
-specified as <literal>None</literal>, so that new adjustments are
-created.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtklayout--put">
- <title>gtk.Layout.put</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>put</methodname>
- <methodparam><parameter
- role="keyword">child_widget</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">child_widget</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position of child
-widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position of child
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>put</methodname>() method adds
-<parameter>child_widget</parameter> to the layout and places its upper, left
-corner at the position specified by <parameter>x</parameter> and
-<parameter>y</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklayout--move">
- <title>gtk.Layout.move</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move</methodname>
- <methodparam><parameter
- role="keyword">child_widget</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">child_widget</parameter>&nbsp;:</term>
- <listitem><simpara>a current child of the
-layout</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position to move
-<parameter>child_widget</parameter> to</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position to move
-<parameter>child_widget</parameter> to</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>move</methodname>() method moves a current child
-of the layout (specified by <parameter>child_widget</parameter>) to the new
-position specified by <parameter>x</parameter> and <parameter>y</parameter>.
-The upper, left corner of <parameter>child_widget</parameter> will be placed
-at (<parameter>x</parameter>, <parameter>y</parameter>).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklayout--set-size">
- <title>gtk.Layout.set_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_size</methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>width of the layout area</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>height of the layout area</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_size</methodname>() method sets the size of
-the virtual area of the layout to the values specified by
-<parameter>width</parameter> and <parameter>height</parameter>. The "width"
-and "height" properties are also set by this method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklayout--get-size">
- <title>gtk.Layout.get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the width and height set on
-<parameter>layout</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_size</methodname>() method returns a tuple
-that contains the width and height of the virtual size that has been set on
-the layout. See <link
-linkend="method-gtklayout--set-size"><methodname>set_size</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklayout--get-hadjustment">
- <title>gtk.Layout.get_hadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_hadjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a horizontal adjustment</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_hadjustment</methodname>() method returns
-the value of the "hadjustment" property that contains the horizontal
-adjustment object associated with the layout. This function should only be
-called after the layout has been placed in a <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>
-or has otherwise been configured for scrolling. See <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>,
-<link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>,
-<link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklayout--get-vadjustment">
- <title>gtk.Layout.get_vadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_vadjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a vertical adjustment</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_vadjustment</methodname>() method returns
-the "vadjustment" property that contains the vertical adjustment object
-associated with the layout. This function should only be called after the
-layout has been placed in a <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>
-or has otherwise been configured for scrolling. See <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>,
-<link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>,
-<link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklayout--set-hadjustment">
- <title>gtk.Layout.set_hadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_hadjustment</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a horizontal adjustment</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_hadjustment</methodname>() method sets the
-horizontal adjustment for the layout (and the "hadjustment" property) to the
-value of <parameter>adjustment</parameter>. See <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>,
-<link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>,
-<link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklayout--set-vadjustment">
- <title>gtk.Layout.set_vadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_vadjustment</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a vertical adjustment</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_vadjustment</methodname>() method sets the
-vertical adjustment for the layout (and the "vadjustment" property) to the
-value of <parameter>adjustment</parameter>. See <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>,
-<link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>,
-<link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-for details.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtklayout--set-scroll-adjustments">
- <title>The "set-scroll-adjustments" gtk.Layout Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>layout</parameter></methodparam>
- <methodparam><parameter>hadjustment</parameter></methodparam>
- <methodparam><parameter>vadjustment</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>layout</parameter>&nbsp;:</term>
- <listitem><simpara>the layout that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>hadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal adjustment associated with the
-layout.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>vadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal adjustment associated with the
-layout.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "set-scroll-adjustments" signal is emitted when one of the
-adjustments associated with a layout is changed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtklinkbutton.xml b/docs/reference/pygtk-gtklinkbutton.xml
deleted file mode 100644
index 690021e5..00000000
--- a/docs/reference/pygtk-gtklinkbutton.xml
+++ /dev/null
@@ -1,292 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtklinkbutton">
-
- <refnamediv>
- <refname>gtk.LinkButton</refname>
- <refpurpose>a button bound to a URL (new in PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.LinkButton</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkbutton">gtk.Button</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtklinkbutton">gtk.LinkButton</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- <methodparam><parameter role="keyword">label</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtklinkbutton--get-uri">get_uri</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtklinkbutton--set-uri">set_uri</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--link-button-set-uri-hook">gtk.link_button_set_uri_hook</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkbutton">gtk.Button</link>
- +-- <link linkend="class-gtklinkbutton">gtk.LinkButton</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtklinkbutton">
- <title>gtk.LinkButton Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"uri"</entry>
- <entry>Read-Write</entry>
- <entry>The URI bound to this button. Available in GTK+
- 2.10.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtklinkbutton">
- <title>gtk.LinkButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtklinkbutton">
- <title>gtk.LinkButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>The <link
- linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link>
- is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>A <link
- linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link>
- is a <link
- linkend="class-gtkbutton"><classname>gtk.Button</classname></link> with
- a hyperlink, similar to the one used by web browsers, that triggers an
- action when clicked. It is useful to show quick links to
- resources.</para>
-
- <para>A link button is created by calling the <link
- linkend="constructor-gtklinkbutton">gtk.LinkButton</link>
- constructor. The URI you pass to the constructor is used as a label for
- the widget.</para>
-
- <para>The URI bound to a <link
- linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link>
- can be set specifically using the <link
- linkend="method-gtklinkbutton--set-uri"><methodname>set_uri</methodname>()</link>)
- method, and retrieved using the <link
- linkend="method-gtklinkbutton--get-uri"><methodname>get_uri</methodname>()</link>
- method.</para>
-
- <para><link
- linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link>
- offers a global hook, which is called when the used clicks on it: see
- the <link
- linkend="function-gtk--link-button-set-uri-hook"><function>gtk.link_button_set_uri_hook</function>()</link>
- function.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtklinkbutton">
- <title>gtk.LinkButton</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.LinkButton</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- <methodparam><parameter role="keyword">label</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>a valid URI</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>the text of the button or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new link button widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link>
- with the URI specified by <parameter>uri</parameter> as its text if
- <parameter>label</parameter> is <literal>None</literal>. If
- <parameter>label</parameter> is not <literal>None</literal>, it is
- used as the text of the button.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtklinkbutton--get-uri">
- <title>gtk.LinkButton.get_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_uri</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the associated URI.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_uri</methodname>() method returns the URI
- set using the <link
- linkend="method-gtklinkbutton--set-uri"><methodname>gtk.LinkButton.set_uri()</methodname></link>
- method or the <link
- linkend="constructor-gtklinkbutton">gtk.LinkButton</link>()
- constructor.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtklinkbutton--set-uri">
- <title>gtk.LinkButton.set_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_uri</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>a valid URI</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_uri</methodname>() method sets the string
- specified by <parameter>uri</parameter> as the URI the <link
- linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link>
- points to.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--link-button-set-uri-hook">
- <title>gtk.link_button_set_uri_hook</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.link_button_set_uri_hook</methodname>
- <methodparam><parameter
- role="keyword">func</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>a function called each time a <link
- linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link>
- is clicked, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to be passed to
- <parameter>func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <function>gtk.link_button_set_uri_hook</function>() function
- sets <parameter>func</parameter> as the function that should be
- invoked every time a user clicks a <link
- linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link>.
- This function is called before every callback registered for the
- "clicked" signal. If <parameter>func</parameter> is
- <literal>None</literal> the current callback function will be
- removed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkliststore.xml b/docs/reference/pygtk-gtkliststore.xml
deleted file mode 100644
index 238be882..00000000
--- a/docs/reference/pygtk-gtkliststore.xml
+++ /dev/null
@@ -1,860 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkliststore">
- <refnamediv>
- <refname>gtk.ListStore</refname>
- <refpurpose>a list model to use with a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ListStore</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktreemodel">gtk.TreeModel</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktreedragsource">gtk.TreeDragSource</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktreedragdest">gtk.TreeDragDest</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktreesortable">gtk.TreeSortable</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkliststore">gtk.ListStore</link></methodname>
- <methodparam><parameter>column_type</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </constructorsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkliststore--set-column-types">set_column_types</link></methodname>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkliststore--set-value">set_value</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- <methodparam><parameter
- role="keyword">value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkliststore--set">set</link></methodname>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>column_num</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkliststore--remove">remove</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkliststore--insert">insert</link></methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- <methodparam><parameter
- role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkliststore--insert-before">insert_before</link></methodname>
- <methodparam><parameter
- role="keyword">sibling</parameter></methodparam>
- <methodparam><parameter
- role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkliststore--insert-after">insert_after</link></methodname>
- <methodparam><parameter
- role="keyword">sibling</parameter></methodparam>
- <methodparam><parameter
- role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkliststore--prepend">prepend</link></methodname>
- <methodparam><parameter
- role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkliststore--append">append</link></methodname>
- <methodparam><parameter
- role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkliststore--clear">clear</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkliststore--iter-is-valid">iter_is_valid</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkliststore--reorder">reorder</link></methodname>
- <methodparam><parameter>new_order</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkliststore--swap">swap</link></methodname>
- <methodparam><parameter
- role="keyword">a</parameter></methodparam>
- <methodparam><parameter
- role="keyword">b</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkliststore--move-after">move_after</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkliststore--move-before">move_before</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkliststore">gtk.ListStore</link> (implements <link linkend="class-gtktreemodel">gtk.TreeModel</link>, <link linkend="class-gtktreedragsource">gtk.TreeDragSource</link>, <link linkend="class-gtktreedragdest">gtk.TreeDragDest</link>, <link linkend="class-gtktreesortable">gtk.TreeSortable</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkliststore">
- <title>gtk.ListStore Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktreemodel">gtk.TreeModel Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktreesortable">gtk.TreeSortable Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
-object is a list model for use with a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget. It implements the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-interface, the <link
-linkend="class-gtktreesortable"><classname>gtk.TreeSortable</classname></link>
-and the tree drag and drop interfaces.</para>
-
- <para>The <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
-objects support the Python mapping and iterator protocols. See the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-Description and the <ulink
-url="http://www.pygtk.org/pygtk2tutorial/sec-TreeModelInterface.html#sec-PythonProtocolSupport">PyGTK
-tutorial</ulink> for more information.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkliststore">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ListStore</methodname>
- <methodparam><parameter>column_type</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>column_type</parameter>&nbsp;:</term>
- <listitem><simpara>the column type of the first
-column</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>optional types for succeeding
-columns</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new list store as with one or more columns with the type
-specified by the arguments passed to the constructor. For example,
-<literal>gtk.ListStore(gobject.TYPE_INT, gobject.TYPE_STRING,
-gtk.gdk.Pixbuf);</literal> will create a new <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
-with three columns, of type int, string and <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-respectively. The built-in <link
-linkend="class-gobject"><classname>GObject</classname></link> types
-are:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>gobject.TYPE_BOOLEAN</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_BOXED</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_CHAR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_DOUBLE</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_ENUM</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_FLAGS</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_FLOAT</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_INT</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_INT64</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_INTERFACE</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_INVALID</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_LONG</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_NONE</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_OBJECT</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_PARAM</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_POINTER</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_PYOBJECT</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_STRING</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_UCHAR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_UINT</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_UINT64</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gobject.TYPE_ULONG</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para>The column types can be any <link
-linkend="class-gobject"><classname>GObject</classname></link> type including
-those that are PyGTK objects or application defined objects that are
-subclassed from the <link
-linkend="class-gobject"><classname>GObject</classname></link> class.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkliststore--set-column-types">
- <title>gtk.ListStore.set_column_types</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>set_column_types</methodname>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of the first column</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>zero or more type specifications</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_column_types</methodname>() method sets the
-liststore columns to the types specified by <parameter>type</parameter> and
-any additional type parameters. This method is meant primarily for classes
-that inherit from <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>,
-and should only be used when constructing a new <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>.
-It will not function after a row has been added, or a method on the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-interface is called.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--set-value">
- <title>gtk.ListStore.set_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_value</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- <methodparam><parameter
- role="keyword">value</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a valid <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> for
-the row being modified</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the column number to
-modify</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>the new value for the cell</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_value</methodname>() method sets the data in
-the cell specified by <parameter>iter</parameter> and
-<parameter>column</parameter>. The type of <parameter>value</parameter> must
-be convertible to the type of the column.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--set">
- <title>gtk.ListStore.set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set</methodname>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>column_num</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara> A valid <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> for
-the row being modified</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>column_num</parameter>&nbsp;:</term>
- <listitem><simpara>the number of the column to
-modify</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter>&nbsp;:</term>
- <listitem><simpara>the new cell value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional optional sets of column number -
-value pairs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set</methodname>() method sets the value of one
-or more cells in the row referenced by <parameter>iter</parameter>. The
-argument list should contain integer column numbers, each followed by the
-value to be set (the value must be convertible to the type of the cell
-column). For example, to set column 0 with type
-<literal>gobject.TYPE_STRING</literal> to "Foo", you would write:</para>
- <programlisting>
- liststore.set(iter, 0, "Foo")
-</programlisting>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--remove">
- <title>gtk.ListStore.remove</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>A valid <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> for
-the row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>iter</parameter> is still valid.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove</methodname>() method removes the row
-specified by <parameter>iter</parameter> from the list store and returns
-True if <parameter>iter</parameter> is still valid. After being removed,
-<parameter>iter</parameter> is set to be the next valid row, or is
-invalidated if it pointed to the last row.</para>
-
- <note>
- <para>Prior to PyGTK 2.4 this method returned a new <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> that
-is a copy of <parameter>iter</parameter>.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--insert">
- <title>gtk.ListStore.insert</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert</methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- <methodparam><parameter
- role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the integer position to insert the new
-row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an optional list or tuple containing ordered
-column values to set on the row or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the new row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert</methodname>() method creates a new row
-at the location specified by <parameter>position</parameter>. If
-<parameter>position</parameter> is larger than the number of rows on the
-list, then the new row will be appended to the list. The row will be empty
-if <parameter>row</parameter> is not specified or is
-<literal>None</literal>. If <parameter>row</parameter> is specified it must
-contain a list or tuple of ordered column values (e.g.
-[<literal>gobject.TYPE_STRING</literal>,
-<literal>gobject.TYPE_INT</literal>]) that are used to set the values in the
-cells of the new row. Alternatively, the application can fill in row cell
-values using the <link
-linkend="method-gtkliststore--set"><methodname>set</methodname>()</link> or
-<link
-linkend="method-gtkliststore--set-value"><methodname>set_value</methodname>()</link>
-methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--insert-before">
- <title>gtk.ListStore.insert_before</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_before</methodname>
- <methodparam><parameter
- role="keyword">sibling</parameter></methodparam>
- <methodparam><parameter
- role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">sibling</parameter>&nbsp;:</term>
- <listitem><simpara>A valid <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an optional list or tuple containing ordered
-column values to set on the row or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the new row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_before</methodname>() method inserts a
-new row before the row specified by the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-<parameter>sibling</parameter>. The row will be empty if
-<parameter>row</parameter> is not specified or is <literal>None</literal>.
-If <parameter>row</parameter> is specified it must contain a list or tuple
-of ordered column values (e.g. [<literal>gobject.TYPE_STRING</literal>,
-<literal>gobject.TYPE_INT</literal>]) that are used to set the values in the
-cells of the new row. Alternatively, the application can fill in row cell
-values using the <link
-linkend="method-gtkliststore--set"><methodname>set</methodname>()</link> or
-<link
-linkend="method-gtkliststore--set-value"><methodname>set_value</methodname>()</link>
-methods.</para>
-
- <para>In PyGTK 2.4, if <parameter>sibling</parameter> is
-<literal>None</literal> the row will be appended to the liststore.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--insert-after">
- <title>gtk.ListStore.insert_after</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_after</methodname>
- <methodparam><parameter
- role="keyword">sibling</parameter></methodparam>
- <methodparam><parameter
- role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">sibling</parameter>&nbsp;:</term>
- <listitem><simpara>A valid <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an optional list or tuple containing ordered
-column values to set on the row or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the new row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_after</methodname>() method inserts a new
-row after the row specified by the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-<parameter>sibling</parameter>. The row will be empty if
-<parameter>row</parameter> is not specified or is <literal>None</literal>.
-If <parameter>row</parameter> is specified it must contain a list or tuple
-of ordered column values (e.g. [<literal>gobject.TYPE_STRING</literal>,
-<literal>gobject.TYPE_INT</literal>]) that are used to set the values in the
-cells of the new row. Alternatively, the application can fill in row cell
-values using the <link
-linkend="method-gtkliststore--set"><methodname>set</methodname>()</link> or
-<link
-linkend="method-gtkliststore--set-value"><methodname>set_value</methodname>()</link>
-methods.</para>
-
- <para>In PyGTK 2.4, if <parameter>sibling</parameter> is
-<literal>None</literal> the row will be prepended to the liststore.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--prepend">
- <title>gtk.ListStore.prepend</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend</methodname>
- <methodparam><parameter
- role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an optional list or tuple containing ordered
-column values to set on the row or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the new row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>prepend</methodname>() method prepends a new row
-to the liststore. The row will be empty if <parameter>row</parameter> is not
-specified or is <literal>None</literal>. If <parameter>row</parameter> is
-specified it must contain a list or tuple of ordered column values (e.g.
-[<literal>gobject.TYPE_STRING</literal>,
-<literal>gobject.TYPE_INT</literal>]) that are used to set the values in the
-cells of the new row. Alternatively, the application can fill in row cell
-values using the <link
-linkend="method-gtkliststore--set"><methodname>set</methodname>()</link> or
-<link
-linkend="method-gtkliststore--set-value"><methodname>set_value</methodname>()</link>
-methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--append">
- <title>gtk.ListStore.append</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append</methodname>
- <methodparam><parameter
- role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an optional list or tuple containing ordered
-column values to set on the row or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the new row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>append</methodname>() method appends a new row
-to the liststore. The row will be empty if <parameter>row</parameter> is not
-specified or is <literal>None</literal>. If <parameter>row</parameter> is
-specified it must contain a list or tuple of ordered column values (e.g.
-[<literal>gobject.TYPE_STRING</literal>,
-<literal>gobject.TYPE_INT</literal>]) that are used to set the values in the
-cells of the new row. Alternatively, the application can fill in row cell
-values using the <link
-linkend="method-gtkliststore--set"><methodname>set</methodname>()</link> or
-<link
-linkend="method-gtkliststore--set-value"><methodname>set_value</methodname>()</link>
-methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--clear">
- <title>gtk.ListStore.clear</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>clear</methodname>() method removes all rows
-from the liststore.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--iter-is-valid">
- <title>gtk.ListStore.iter_is_valid</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_is_valid</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the iter is valid,
- <literal>False</literal> if the iter is invalid.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <warning>
- <para>This method is slow. Only use it for debugging and/or testing
-purposes.</para>
- </warning>
-
- <para>The <methodname>iter_is_valid</methodname>() method checks if
-the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-specified by <parameter>iter</parameter> is a valid iter for this <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--reorder">
- <title>gtk.ListStore.reorder</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reorder</methodname>
- <methodparam><parameter>new_order</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>new_order</parameter>&nbsp;:</term>
- <listitem><simpara>a list of integers mapping the new position of
- each child to its old position before the re-ordering,
- i.e. <parameter>new_order</parameter><literal>[newpos] =
- oldpos</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>reorder</methodname>() method reorders the <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
-items to follow the order indicated by
-<parameter>new_order</parameter>. Note that this method only works with
-unsorted stores.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--swap">
- <title>gtk.ListStore.swap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>swap</methodname>
- <methodparam><parameter role="keyword">a</parameter></methodparam>
- <methodparam><parameter role="keyword">b</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">a</parameter>&nbsp;:</term> <listitem><simpara>A
- <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">b</parameter>&nbsp;:</term>
- <listitem><simpara>Another <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>swap</methodname>() method swaps the liststore
-rows specified by the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>s
-<parameter>a</parameter> and <parameter>b</parameter>. Note that this method
-only works with unsorted stores.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--move-after">
- <title>gtk.ListStore.move_after</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_after</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>move_after</methodname>() method moves the
-liststore row referenced by <parameter>iter</parameter> to the position
-after the row referenced by <parameter>position</parameter>. Note that this
-method only works with unsorted stores. If <parameter>position</parameter>
-is <literal>None</literal>, the row referenced by
-<parameter>iter</parameter> will be moved to the start of the list.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkliststore--move-before">
- <title>gtk.ListStore.move_before</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_before</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>,
- or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>move_before</methodname>() method moves the
-liststore row referenced by <parameter>iter</parameter> to the position
-before the row referenced by <parameter>position</parameter>. Note that this
-method only works with unsorted stores. If <parameter>position</parameter>
-is <literal>None</literal>, the row referenced by
-<parameter>iter</parameter> will be moved to the end of the list.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkmenu.xml b/docs/reference/pygtk-gtkmenu.xml
deleted file mode 100644
index afd7bb40..00000000
--- a/docs/reference/pygtk-gtkmenu.xml
+++ /dev/null
@@ -1,1007 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkmenu">
- <refnamediv>
- <refname>gtk.Menu</refname>
- <refpurpose>a drop down menu widget.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Menu</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkmenushell">gtk.MenuShell</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkmenu">gtk.Menu</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--popup">popup</link></methodname>
- <methodparam><parameter
- role="keyword">parent_menu_shell</parameter></methodparam>
- <methodparam><parameter
- role="keyword">parent_menu_item</parameter></methodparam>
- <methodparam><parameter
- role="keyword">func</parameter></methodparam>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">activate_time</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--reposition">reposition</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--popdown">popdown</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--get-active">get_active</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--set-active">set_active</link></methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--set-accel-group">set_accel_group</link></methodname>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--get-accel-group">get_accel_group</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--set-accel-path">set_accel_path</link></methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--attach-to-widget">attach_to_widget</link></methodname>
- <methodparam><parameter
- role="keyword">attach_widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detach_func</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--detach">detach</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--get-attach-widget">get_attach_widget</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--set-tearoff-state">set_tearoff_state</link></methodname>
- <methodparam><parameter
- role="keyword">torn_off</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--get-tearoff-state">get_tearoff_state</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--set-title">set_title</link></methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--get-title">get_title</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenu--reorder-child">reorder_child</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkmenu--set-screen">set_screen</link></methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkmenu--attach">attach</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">left_attach</parameter></methodparam>
- <methodparam><parameter
- role="keyword">right_attach</parameter></methodparam>
- <methodparam><parameter
- role="keyword">top_attach</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bottom_attach</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkmenu--set-monitor">set_monitor</link></methodname>
- <methodparam><parameter
- role="keyword">monitor_num</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkmenushell">gtk.MenuShell</link>
- +-- <link linkend="class-gtkmenu">gtk.Menu</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkmenu">
- <title>gtk.Menu Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkmenushell">gtk.MenuShell Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"tearoff-state"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the menu is torn-off. Default
-value: <literal>False</literal>. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"tearoff-title"</entry>
- <entry>Read-Write</entry>
- <entry>A title that may be displayed by the window manager
-when this menu is torn-off. Default value: "".</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkmenu">
- <title>gtk.Menu Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <note>
- <para>These properties are available in GTK+ 2.4 and above.</para>
- </note>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"horizontal-offset"</entry>
- <entry>Read</entry>
- <entry>When the menu is a submenu, position it this number of pixels offset horizontally. Default value: -2.</entry>
- </row>
-
- <row valign="top">
- <entry>"horizontal-padding"</entry>
- <entry>Read</entry>
- <entry>Extra space at the left and right edges of the menu</entry>
- </row>
-
- <row valign="top">
- <entry>"vertical-offset"</entry>
- <entry>Read</entry>
- <entry>When the menu is a submenu, position it this number of pixels offset vertically. Default value: 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"vertical-padding"</entry>
- <entry>Read</entry>
- <entry>Extra space at the top and bottom of the menu. Allowed
-values: >= 0. Default value: 1.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkmenu">
- <title>gtk.Menu Child Properties</title>
-
- <note>
- <para>These properties are available in GTK+ 2.4 and above.</para>
- </note>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"bottom-attach"</entry>
- <entry>Read-Write</entry>
- <entry>The row number to attach the bottom of the child
- to. Allowed values: >= -1. Default value: -1.</entry>
- </row>
-
- <row valign="top">
- <entry>"left-attach"</entry>
- <entry>Read-Write</entry>
- <entry>The column number to attach the left side of the child
-to. Allowed values: >= -1. Default value: -1.</entry>
- </row>
-
- <row valign="top">
- <entry>"right-attach"</entry>
- <entry>Read-Write</entry>
- <entry>The column number to attach the right side of the child
-to. Allowed values: >= -1. Default value: -1.</entry>
- </row>
-
- <row valign="top">
- <entry>"top-attach"</entry>
- <entry>Read-Write</entry>
- <entry>The row number to attach the top of the child to. Allowed
-values: >= -1. Default value: -1.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkmenu">
- <title>gtk.Menu Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkmenushell">gtk.MenuShell Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkmenu--move-scroll">move-scroll</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>menu</parameter></methodparam>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> is a <link
-linkend="class-gtkmenushell"><classname>gtk.MenuShell</classname></link>
-that implements a drop down menu consisting of a list of <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-objects which can be navigated and activated by the user to perform
-application functions. A <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> is most
-commonly dropped down by activating a <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> in a
-<link linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>
-or popped up by activating a <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> in
-another <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>. A <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> can also be
-popped up by activating a <link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>.
-Other composite widgets such as the <link
-linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link> can
-pop up a <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> as well.
-Applications can display a <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> as a popup
-menu by calling the <link
-linkend="method-gtkmenu--popup"><methodname>popup</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkmenu">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Menu</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkmenu--popup">
- <title>gtk.Menu.popup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>popup</methodname>
- <methodparam><parameter
- role="keyword">parent_menu_shell</parameter></methodparam>
- <methodparam><parameter
- role="keyword">parent_menu_item</parameter></methodparam>
- <methodparam><parameter
- role="keyword">func</parameter></methodparam>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">activate_time</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">parent_menu_shell</parameter>&nbsp;:</term>
- <listitem><simpara>the menu shell containing the triggering menu
-item or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">parent_menu_item</parameter>&nbsp;:</term>
- <listitem><simpara>the menu item whose activation triggered the
-popup or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>a user supplied function used to position the
-menu or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">button</parameter>&nbsp;:</term>
- <listitem><simpara>the mouse button which was pressed to initiate
-the event. </simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">activate_time</parameter>&nbsp;:</term>
- <listitem><simpara>the time at which the activation event
-occurred.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>optional data to be passed to
- <parameter>func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>popup</methodname>() method displays a menu and
- makes it available for selection. Applications can use this function
- to display context-sensitive menus, and will typically supply
- <literal>None</literal> for the
- <parameter>parent_menu_shell</parameter>,
- <parameter>parent_menu_item</parameter> and
- <parameter>func</parameter> parameters. The default menu positioning
- function will position the menu at the current pointer position. The
- <parameter>button</parameter> and <parameter>activate_time</parameter>
- values should be the mouse button that was pressed to trigger the menu
- popup and the time the button was pressed. These values can usually
- be retrieved from the "button_press_event".</para>
-
- <para>The signature of <parameter>func</parameter> is:</para>
-
- <programlisting>
- def func(menu, user_data):
-</programlisting>
-
- <para>where <parameter>user_data</parameter> is
- <parameter>data</parameter> if not
- <literal>None</literal>. <parameter>func</parameter> should return a
- 3-tuple containing the x and y coordinates of the position to draw the
- menu and a boolean that, if <literal>True</literal>, indicates that
- the menu should be pushed in to be completely inside the screen
- instead of just clamped to the size of the screen.</para>
-
- <note>
- <para>Prior to PyGTK 2.10 this method did not accept the
- <parameter>data</parameter> parameter and the signature of
- <parameter>func</parameter> was:</para>
-
- <programlisting>
- def func(menu, user_data):
- </programlisting>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--reposition">
- <title>gtk.Menu.reposition</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reposition</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>reposition</methodname>() method repositions the
-menu on the screen according to the internal position function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--popdown">
- <title>gtk.Menu.popdown</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>popdown</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>popdown</methodname>() method removes the menu
-from the screen.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--get-active">
- <title>gtk.Menu.get_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_active</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> that
-was last selected in the menu. If a selection has not yet been made, the
-first menu item is selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_active</methodname>() method returns the
-selected menu item from the menu. This is used by the <link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--set-active">
- <title>gtk.Menu.set_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_active</methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the menu item to select. Index
-values start from 0.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_active</methodname>() method selects the
-menu item within the menu at the location specified by
-<parameter>index</parameter>. This is used by the <link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
-and is not useful for applications.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--set-accel-group">
- <title>gtk.Menu.set_accel_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_accel_group</methodname>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_group</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_accel_group</methodname>() method associates
-the <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-specified by <parameter>accel_group</parameter> with the menu. The
-accelerator group should also be added to all windows using this menu by
-calling the <link
-linkend="method-gtkwindow--add-accel-group"><methodname>gtk.Window.add_accel_group</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--get-accel-group">
- <title>gtk.Menu.get_accel_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_accel_group</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-associated with the menu. </simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_accel_group</methodname>() method returns
-the <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-that holds the global accelerators for the menu.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--set-accel-path">
- <title>gtk.Menu.set_accel_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_accel_path</methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_path</parameter>&nbsp;:</term>
- <listitem><simpara>a valid accelerator path</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_accel_path</methodname>() method sets an
-accelerator path (specified by <parameter>accel_path</parameter>) for this
-menu to be used to construct accelerator paths for its menu items. This is a
-convenience method used to avoid calling the <link
-linkend="method-gtkmenuitem--set-accel-path"><methodname>gtk.MenuItem.set_accel_path</methodname>()</link>
-method on each menu item that should support runtime user changeable
-accelerators. Instead, by just calling <link
-linkend="method-gtkmenu--set-accel-path"><methodname>set_accel_path</methodname>()</link>
-on their parent, each menu item of this menu, that contains a label
-describing its purpose, automatically gets an accel path assigned. For
-example, calling:</para>
-
- <programlisting>
- menu.set_accel_path("&lt;main&gt;/File")
-</programlisting>
-
- <para>for a menu containing menu items "New" and "Exit", will assign
-its items the accel paths: <literal>"&lt;main&gt;/File/New"</literal> and
-<literal>"&lt;main&gt;/File/Exit"</literal>. Assigning accel paths to menu
-items enables the user to change their accelerators at runtime.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--attach-to-widget">
- <title>gtk.Menu.attach_to_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>attach_to_widget</methodname>
- <methodparam><parameter
- role="keyword">attach_widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detach_func</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">attach_widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that the menu will be attached
-to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">detach_func</parameter>&nbsp;:</term>
- <listitem><simpara>the user supplied callback function that will
-be called when the menu calls the <link
-linkend="method-gtkmenu--detach"><methodname>detach</methodname>()</link>
-method.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>attach_to_widget</methodname>() method attaches
-the menu to the widget specified by <parameter>attach_widget</parameter> and
-provides a callback function specified by <parameter>detach_func</parameter>
-that will be invoked when the menu calls the <link
-linkend="method-gtkmenu--detach"><methodname>detach</methodname>()</link>
-method during its destruction. Attaching a menu to a widget associates the
-menu with a widget similar to setting a parent. This is mainly used for
-associating popup menus with a widget and a submenu with a menuitem.</para>
-
- <para>The signature of <parameter>detach</parameter> is:</para>
-
- <programlisting>
-def detach_cb(widget, menu):
-</programlisting>
-
- <para>where <parameter>widget</parameter> is the
-<parameter>attach_widget</parameter> and <parameter>menu</parameter> is the
-menu being detached.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--detach">
- <title>gtk.Menu.detach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>detach</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>detach</methodname>() method detaches the menu
-from the widget to which it had been attached. See <link
-linkend="method-gtkmenu--attach-to-widget"><methodname>attach_to_widget</methodname>()</link>.
-</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--get-attach-widget">
- <title>gtk.Menu.get_attach_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_attach_widget</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the widget that the menu is attached
-to.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_attach_widget</methodname>() method returns
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-that the menu is attached to.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--set-tearoff-state">
- <title>gtk.Menu.set_tearoff_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tearoff_state</methodname>
- <methodparam><parameter
- role="keyword">torn_off</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">torn_off</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal>, the menu is
-displayed as a tearoff menu.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_tearoff_state</methodname>() method sets the
-tearoff state of the menu to the value of <parameter>torn_off</parameter>.
-If <parameter>torn_off</parameter> is <literal>True</literal> the menu is
-displayed as a tearoff menu; if <parameter>torn_off</parameter> is
-<literal>False</literal> the menu is displayed as a drop down menu which
-persists as long as the menu is active.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--get-tearoff-state">
- <title>gtk.Menu.get_tearoff_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tearoff_state</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the menu is
-currently torn off.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tearoff_state</methodname>() method returns
-whether the menu is torn off. See <link
-linkend="method-gtkmenu--set-tearoff-state"><methodname>set_tearoff_state</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--set-title">
- <title>gtk.Menu.set_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_title</methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the title for the
-menu.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_title</methodname>() method sets the title
-text (from the value of <parameter>title</parameter>) to be used for the
-menu when it is shown as a tearoff menu.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--get-title">
- <title>gtk.Menu.get_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_title</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the title of the menu, or
-<literal>None</literal> if the menu has no title set on
-it.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_title</methodname>() method returns the
-title of the menu or <literal>None</literal> of no title is set. See <link
-linkend="method-gtkmenu--set-title"><methodname>set_title</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--reorder-child">
- <title>gtk.Menu.reorder_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reorder_child</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> to
-move.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the new position to place child. Positions are
-numbered starting from 0</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>reorder_child</methodname>() method moves the
-menuitem specified by <parameter>child</parameter> to a new position within
-the menu specified by <parameter>position</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--set-screen">
- <title>gtk.Menu.set_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_screen</methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>,
- or <literal>None</literal> if the screen should be determined by
- the widget the menu is attached to.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_screen</methodname>() method sets the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-specified by <parameter>screen</parameter> on which the menu will be
-displayed. If <parameter>screen</parameter> is <literal>None</literal> the
-screen is determined by the widget that the menu is attached to.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--attach">
- <title>gtk.Menu.attach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>attach</methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- <methodparam><parameter role="keyword">left_attach</parameter></methodparam>
- <methodparam><parameter role="keyword">right_attach</parameter></methodparam>
- <methodparam><parameter role="keyword">top_attach</parameter></methodparam>
- <methodparam><parameter role="keyword">bottom_attach</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">left_attach</parameter>&nbsp;:</term>
- <listitem><simpara>The column number to attach the left side of
- the item to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">right_attach</parameter>&nbsp;:</term>
- <listitem><simpara>The column number to attach the right side of
- the item to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">top_attach</parameter>&nbsp;:</term>
- <listitem><simpara>The row number to attach the top of the item
- to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">bottom_attach</parameter>&nbsp;:</term>
- <listitem><simpara>The row number to attach the bottom of the item
- to.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>attach</methodname>() method adds a new <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-specified by <parameter>child</parameter> to a (table) menu. The number of
-'cells' that an item will occupy is specified by
-<parameter>left_attach</parameter>, <parameter>right_attach</parameter>,
-<parameter>top_attach</parameter> and
-<parameter>bottom_attach</parameter>. These each represent the leftmost,
-rightmost, uppermost and lower column and row numbers of the table.
-(Columns and rows are indexed from zero).</para>
-
- <para>Note that this function is not related to the <link
-linkend="method-gtkmenu--detach"><methodname>detach()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenu--set-monitor">
- <title>gtk.Menu.set_monitor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_monitor</methodname>
- <methodparam><parameter role="keyword">monitor_num</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">monitor_num</parameter>&nbsp;:</term>
- <listitem><simpara>the number of the monitor on which the menu
- should be popped up</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_monitor</methodname>() method informs
-<literal>GTK</literal>+ on which monitor a menu should be popped up. See
-the <link
-linkend="method-gdkscreen--get-monitor-geometry"><methodname>gtk.gdk.Screen.get_monitor_geometry()</methodname></link>
-method for more information.</para>
-
- <para>This method should be called from a menu positioning function if
-the menu should not appear on the same monitor as the pointer. This
-information can't be reliably inferred from the coordinates returned by a
-menu positioning function, since, for very long menus, these coordinates may
-extend beyond the monitor boundaries or even the screen boundaries.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkmenu--move-scroll">
- <title>The "move_scroll" gtk.Menu Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menu</parameter></methodparam>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menu</parameter>&nbsp;:</term>
- <listitem><simpara>the menu that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of scroll that is requested</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.2 and above.</para>
- </note>
-
- <para>The "move_scroll" signal is emitted when the user attempts to
-scroll the menu. <parameter>type</parameter> should be one of the <xref
-linkend="gtk-scroll-step-constants"
-endterm="gtk-scroll-step-constants-title"></xref>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkmenubar.xml b/docs/reference/pygtk-gtkmenubar.xml
deleted file mode 100644
index 7c112470..00000000
--- a/docs/reference/pygtk-gtkmenubar.xml
+++ /dev/null
@@ -1,301 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkmenubar">
- <refnamediv>
- <refname>gtk.MenuBar</refname>
- <refpurpose>a widget that displays <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-widgets horizontally</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.MenuBar</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkmenushell">gtk.MenuShell</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkmenubar">gtk.MenuBar</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenubar--set-pack-direction">set_pack_direction</link></methodname>
- <methodparam><parameter
- role="keyword">pack_dir</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenubar--get-pack-direction">get_pack_direction</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenubar--set-child-pack-direction">set_child_pack_direction</link></methodname>
- <methodparam><parameter
- role="keyword">child_pack_dir</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenubar--get-child-pack-direction">get_child_pack_direction</link></methodname>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkmenushell">gtk.MenuShell</link>
- +-- <link linkend="class-gtkmenubar">gtk.MenuBar</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkmenubar">
- <title>gtk.MenuBar Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkmenushell">gtk.MenuShell Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"child-pack-direction"</entry>
- <entry>Read-Write</entry>
- <entry>The pack direction of the menubar. It determines how
-the widgets contained in child menuitems are arranged.
-Default value: <literal>gtk.PACK_DIRECTION_LTR</literal>.
-Available in GTK+ 2.8 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"pack-direction"</entry>
- <entry>Read-Write</entry>
- <entry>The pack direction of the menubar. It determines how
-menuitems are arranged in the menubar.
-Default value: <literal>gtk.PACK_DIRECTION_LTR</literal>.
-Available in GTK+ 2.8 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkmenubar">
- <title>gtk.MenuBar Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"internal-padding"</entry>
- <entry>Read</entry>
- <entry>Amount of border space between the menubar shadow and
-the menu items</entry>
- </row>
-
- <row valign="top">
- <entry>"shadow-type"</entry>
- <entry>Read</entry>
- <entry>The style of bevel around the menubar</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkmenubar">
- <title>gtk.MenuBar Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkmenushell">gtk.MenuShell Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link> is a
-subclass of <link
-linkend="class-gtkmenushell"><classname>gtk.MenuShell</classname></link>
-which contains one or more <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-widgets. A <link
-linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>
-displays the menu items horizontally in an application window or
-dialog.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkmenubar">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.MenuBar</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkmenubar--set-pack-direction">
- <title>gtk.MenuBar.set_pack_direction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_pack_direction</methodname>
- <methodparam><parameter
- role="keyword">pack_dir</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pack_dir</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
-linkend="gtk-pack-direction-constants"
-endterm="gtk-pack-direction-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_pack_direction</methodname>() sets the
-"pack-direction" property to the value of
-<parameter>pack_dir</parameter>. <parameter>pack_dir</parameter> must be one
-of the <xref linkend="gtk-pack-direction-constants"
-endterm="gtk-pack-direction-constants-title"></xref> that specify how
-menuitems are arranged in the menubar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenubar--get-pack-direction">
- <title>gtk.MenuBar.get_pack_direction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pack_direction</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current pack direction of the
-menubar.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_pack_direction</methodname>() method returns
-the value of the "pack-direction" property that specifies the arrangement
-of menuitems in the menubar. See the <xref
-linkend="gtk-pack-direction-constants"
-endterm="gtk-pack-direction-constants-title"></xref> for more
-information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenubar--set-child-pack-direction">
- <title>gtk.MenuBar.set_child_pack_direction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_child_pack_direction</methodname>
- <methodparam><parameter
- role="keyword">child_pack_dir</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child_pack_dir</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
-linkend="gtk-pack-direction-constants"
-endterm="gtk-pack-direction-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_child_pack_direction</methodname>() method
-sets the "child-pack-direction" property to the value of
-<parameter>child_pack_dir</parameter>. <parameter>child_pack_dir</parameter>
-must be one of the <xref linkend="gtk-pack-direction-constants"
-endterm="gtk-pack-direction-constants-title"></xref> that specify how
-menuitems are arranged in the child menuitems of the menubar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenubar--get-child-pack-direction">
- <title>gtk.MenuBar.get_child_pack_direction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_child_pack_direction</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current child pack
-direction</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_child_pack_direction</methodname>() method
-returns the value of the "child-pack-direction" property that specifies the
-arrangement of menuitems in thechild menuitems of the menubar. See the <xref
-linkend="gtk-pack-direction-constants"
-endterm="gtk-pack-direction-constants-title"></xref> for more
-information.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkmenuitem.xml b/docs/reference/pygtk-gtkmenuitem.xml
deleted file mode 100644
index 725e7550..00000000
--- a/docs/reference/pygtk-gtkmenuitem.xml
+++ /dev/null
@@ -1,698 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkmenuitem">
- <refnamediv>
- <refname>gtk.MenuItem</refname>
- <refpurpose>the widget used for an item in menus</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.MenuItem</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkitem">gtk.Item</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkmenuitem">gtk.MenuItem</link></methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenuitem--set-submenu">set_submenu</link></methodname>
- <methodparam><parameter
- role="keyword">submenu</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenuitem--get-submenu">get_submenu</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenuitem--remove-submenu">remove_submenu</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenuitem--select">select</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenuitem--deselect">deselect</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenuitem--activate">activate</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenuitem--toggle-size-request">toggle_size_request</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenuitem--toggle-size-allocate">toggle_size_allocate</link></methodname>
- <methodparam><parameter
- role="keyword">allocation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenuitem--set-right-justified">set_right_justified</link></methodname>
- <methodparam><parameter
- role="keyword">right_justified</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenuitem--get-right-justified">get_right_justified</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenuitem--set-accel-path">set_accel_path</link></methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkitem">gtk.Item</link>
- +-- <link linkend="class-gtkmenuitem">gtk.MenuItem</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkmenuitem">
- <title>gtk.MenuItem Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkmenuitem">
- <title>gtk.MenuItem Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"arrow-spacing"</entry>
- <entry>Read</entry>
- <entry>Space between label and arrow. Allowed values: >= 0.
- Default value: 10</entry>
- </row>
-
- <row valign="top">
- <entry>"horizontal-padding"</entry>
- <entry>Read</entry>
- <entry>Padding to left and right of the menu item. Allowed
- values: >= 0. Default value: 3</entry>
- </row>
-
- <row valign="top">
- <entry>"selected-shadow-type"</entry>
- <entry>Read</entry>
- <entry>The shadow type when the item is selected. Default
- value: <literal>gtk.SHADOW_NONE</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"toggle-spacing"</entry>
- <entry>Read</entry>
- <entry>Space between icon and label. Allowed values: >= 0.
- Default value: 5</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkmenuitem">
- <title>gtk.MenuItem Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkmenuitem--activate">activate</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>menuitem</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkmenuitem--activate-item">activate-item</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>menuitem</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkmenuitem--toggle-size-allocate">toggle-size-allocate</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>menuitem</parameter>
- </methodparam>
- <methodparam><parameter>allocation</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkmenuitem--toggle-size-request">toggle-size-request</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>menuitem</parameter>
- </methodparam>
- <methodparam><parameter>requisition</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-widget implements the appearance and behavior of menu items. The <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> and
-its derived widget subclasses are the only valid children of menus.</para>
-
- <para>When menu items are selected and activated by a user they
-can:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>display a popup menu if they have an associated
-submenu</simpara>
- </listitem>
- <listitem>
- <simpara>invoke an associated function or method</simpara>
- </listitem>
- </itemizedlist>
-
- <para>As a <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> is a
-subclass of <link
-linkend="class-gtkbin"><classname>gtk.Bin</classname></link> it can hold any
-valid child widget.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkmenuitem">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.MenuItem</methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string to be used as the text of the menu item
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">use_underline</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, an underscore in the
-label text indicates the next character should be underlined and used for the
-mnemonic accelerator key if it is the first character so
-marked. Available in PyGTK 2.4 and above.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-widget and sets the text of the menu item label to the value of
-<parameter>label</parameter>. If <parameter>label</parameter> is
-<literal>None</literal> no label is created for the menu item. The text of
-label is parsed for underscore characters that indicate that the next
-character is a mnemonic accelerator.</para>
-
- <para>In PyGTK 2.4 and above the <parameter>use_underline</parameter>
-parameter is available and defaults to <literal>True</literal>. If
-<parameter>use_underline</parameter> is set to <literal>False</literal> the
-label text will not be parsed for mnemonic characters.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkmenuitem--set-submenu">
- <title>gtk.MenuItem.set_submenu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_submenu</methodname>
- <methodparam><parameter
- role="keyword">submenu</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">submenu</parameter>&nbsp;:</term>
- <listitem><simpara>the menu to use as the
-submenu</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_submenu</methodname>() method sets the menu
-specified by <parameter>submenu</parameter> as the submenu for the menu
-item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenuitem--get-submenu">
- <title>gtk.MenuItem.get_submenu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_submenu</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the submenu for this menu item, or
-<literal>None</literal> if there is no submenu.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_submenu</methodname>() method returns the
-submenu widget associated with this menu item. If there is no submenu this
-method returns <literal>None</literal>. See <link
-linkend="method-gtkmenuitem--set-submenu"><methodname>set_submenu</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenuitem--remove-submenu">
- <title>gtk.MenuItem.remove_submenu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_submenu</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>remove_submenu</methodname>() method removes the
-submenu associated with the menu item.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtkmenuitem--select">
- <title>gtk.MenuItem.select</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>select</methodname>() method emits the "select"
-signal on the menu item.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtkmenuitem--deselect">
- <title>gtk.MenuItem.deselect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>deselect</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>deselect</methodname>() method emits the
-"deselect" signal on the menu item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenuitem--activate">
- <title>gtk.MenuItem.activate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>activate</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>activate</methodname>() method emits the
-"activate" signal on the menu item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenuitem--toggle-size-request">
- <title>gtk.MenuItem.toggle_size_request</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>toggle_size_request</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the size requisition</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>toggle_size_request</methodname>() method emits
-the "toggle-size-request" signal on the menuitem and returns the size
-requested for the menuitem.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenuitem--toggle-size-allocate">
- <title>gtk.MenuItem.toggle_size_allocate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>toggle_size_allocate</methodname>
- <methodparam><parameter
- role="keyword">allocation</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">allocation</parameter>&nbsp;:</term>
- <listitem><simpara>the allocation size for the menu
-item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>toggle_size_allocate</methodname>() method emits
-the "toggle-size-allocate" signal on the menu item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenuitem--set-right-justified">
- <title>gtk.MenuItem.set_right_justified</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_right_justified</methodname>
- <methodparam><parameter
- role="keyword">right_justified</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">right_justified</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the menu item will
-appear at the far right if added to a menu bar.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_right_justified</methodname>() method sets
-the justification of the menu item according to the value of
-<parameter>right_justified</parameter>. If
-<parameter>right_justified</parameter> is <literal>True</literal> the menu
-item will appear at the right side of a menu bar. If the widget layout is
-reversed for a right-to-left language like Hebrew or Arabic,
-right-justified-menu-items appear on the left.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenuitem--get-right-justified">
- <title>gtk.MenuItem.get_right_justified</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_right_justified</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the menu item will
-appear at the far right if added to a menu bar.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_right_justified</methodname>() method gets
-the justification of the menu item. If <literal>True</literal> the menu item
-appears justified at the right side of the menu bar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenuitem--set-accel-path">
- <title>gtk.MenuItem.set_accel_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_accel_path</methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_path</parameter>&nbsp;:</term>
- <listitem><simpara>the accelerator path, corresponding to this
-menu item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_accel_path</methodname>() method sets the
-accelerator path on the menu item. The accelerator path provides access to
-the menu item's accelerator allowing user changes to be identified and saved
-to persistent storage. See also the <link
-linkend="method-gtkmenu--set-accel-path"><methodname>gtk.Menu.set_accel_path</methodname>()</link>
-method for a more convenient variant of this function. This method is a
-convenience wrapper that handles calling <link
-linkend="method-gtkwidget--set-accel-path"><methodname>gtk.Widget.set_accel_path</methodname>()</link>
-with the appropriate accelerator group for the menu item.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkmenuitem--activate">
- <title>The "activate" gtk.MenuItem Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menuitem</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menuitem</parameter>&nbsp;:</term>
- <listitem><simpara>the menuitem that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "activate" signal is emitted when the menu item is
-activated.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkmenuitem--activate-item">
- <title>The "activate-item" gtk.MenuItem Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menuitem</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menuitem</parameter>&nbsp;:</term>
- <listitem><simpara>the menuitem that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "activate-item" signal is emitted when the menu item is
-activated, but also if the menu item has a submenu. For normal applications,
-the relevant signal is "activate".</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkmenuitem--toggle-size-allocate">
- <title>The "toggle-size-allocate" gtk.MenuItem Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menuitem</parameter></methodparam>
- <methodparam><parameter>allocation</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menuitem</parameter>&nbsp;:</term>
- <listitem><simpara>the menuitem that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>allocation</parameter>&nbsp;:</term>
- <listitem><simpara>the size allocation for the
-menuitem</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "toggle-size-allocate" signal is emitted when the size
-allocation is changed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkmenuitem--toggle-size-request">
- <title>The "toggle-size-request" gtk.MenuItem Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menuitem</parameter></methodparam>
- <methodparam><parameter>requisition</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menuitem</parameter>&nbsp;:</term>
- <listitem><simpara>the menuitem that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>requisition</parameter>&nbsp;:</term>
- <listitem><simpara>the pointer to the location to put the size
-request</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "toggle-size-request" signal is emitted when a new size
-request is needed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkmenushell.xml b/docs/reference/pygtk-gtkmenushell.xml
deleted file mode 100644
index 63fbaf1d..00000000
--- a/docs/reference/pygtk-gtkmenushell.xml
+++ /dev/null
@@ -1,829 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkmenushell">
- <refnamediv>
- <refname>gtk.MenuShell</refname>
- <refpurpose>a base class for menu objects.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.MenuShell</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenushell--append">append</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenushell--prepend">prepend</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenushell--insert">insert</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenushell--deactivate">deactivate</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenushell--select-item">select_item</link></methodname>
- <methodparam><parameter
- role="keyword">menu_item</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenushell--deselect">deselect</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenushell--activate-item">activate_item</link></methodname>
- <methodparam><parameter
- role="keyword">menu_item</parameter></methodparam>
- <methodparam><parameter
- role="keyword">force_deactivate</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenushell--select-first">select_first</link></methodname>
- <methodparam><parameter
- role="keyword">search_sensitive</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenushell--cancel">cancel</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenushell--set-take-focus">set_take_focus</link></methodname>
- <methodparam><parameter
- role="keyword">take_focus</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmenushell--get-take-focus">get_take_focus</link></methodname>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkmenushell">gtk.MenuShell</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkmenushell">
- <title>gtk.MenuShell Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"take-focus"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the menu and its submenus grab
-the keyboard focus on popup. Default value: <literal>True</literal>.
-Available in GTK+ 2.8 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkmenushell">
- <title>gtk.MenuShell Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkmenushell">
- <title>gtk.MenuShell Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkmenushell--activate-current">activate-current</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter>
- </methodparam>
- <methodparam><parameter>force_hide</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkmenushell--cancel">cancel</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkmenushell--cycle-focus">cycle-focus</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter>
- </methodparam>
- <methodparam><parameter>direction</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkmenushell--deactivate">deactivate</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkmenushell--move-current">move-current</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter>
- </methodparam>
- <methodparam><parameter>direction</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkmenushell--selection-done">selection-done</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkmenushell"><classname>gtk.MenuShell</classname></link> is
-the abstract base class used to derive the <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> and <link
-linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>
-subclasses. A <link
-linkend="class-gtkmenushell"><classname>gtk.MenuShell</classname></link> is
-a container of <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-objects arranged in a list which can be navigated, selected, and activated
-by the user to perform application functions. A <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> can
-have a submenu associated with it, allowing for nested hierarchical
-menus.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkmenushell--append">
- <title>gtk.MenuShell.append</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> to
-add.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>append</methodname>() method adds a new <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-specified by <parameter>child</parameter> to the end of the menu shell's
-item list.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenushell--prepend">
- <title>gtk.MenuShell.prepend</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> to
-add.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>prepend</methodname>() method adds a new <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-specified by <parameter>child</parameter> to the beginning of the menu
-shell's item list.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenushell--insert">
- <title>gtk.MenuShell.insert</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> to
-add.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>The position in the item list where child
-should be added. Positions are numbered starting from
-0.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert</methodname>() method adds a new <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-specified by <parameter>child</parameter> to the menu shell's item list at
-the position specified by <parameter>position</parameter>. </para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenushell--deactivate">
- <title>gtk.MenuShell.deactivate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>deactivate</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>deactivate</methodname>() method deactivates the
-menu shell. Typically this results in the menu shell being removed from the
-screen.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenushell--select-item">
- <title>gtk.MenuShell.select_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_item</methodname>
- <methodparam><parameter
- role="keyword">menu_item</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">menu_item</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> to
-select.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>select_item</methodname>() method selects the
-menu item specified by <parameter>menu_item</parameter> from the menu
-shell.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenushell--deselect">
- <title>gtk.MenuShell.deselect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>deselect</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>deselect</methodname>() method deselects the
-currently selected item from the menu shell, if any.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenushell--activate-item">
- <title>gtk.MenuShell.activate_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>activate_item</methodname>
- <methodparam><parameter
- role="keyword">menu_item</parameter></methodparam>
- <methodparam><parameter
- role="keyword">force_deactivate</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">menu_item</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> to
-activate.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">force_deactivate</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal>, force the
-deactivation of the menu shell after the menu item is
-activated.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>activate_item</methodname>() method activates
-the menu item specified by<parameter> menu_item</parameter>. If
-<parameter>force_deactivate</parameter> is <literal>True</literal> the
-menushell is forcibly deactivated after<parameter> menu_item</parameter> is
-activated.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenushell--select-first">
- <title>gtk.MenuShell.select_first</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_first</methodname>
- <methodparam><parameter role="keyword">search_sensitive</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">search_sensitive</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, search for the
- first selectable menu item, otherwise select nothing if the first
- item isn't sensitive.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>select_first</methodname>() method selects the
-first visible or selectable child of the menu shell if
-<parameter>search_sensitive</parameter> is <literal>True</literal>. Don't
-select tearoff items unless the only item is a tearoff item. If
-<parameter>search_sensitive</parameter> is <literal>False</literal> select
-nothing if the first item isn't sensitive.
-<parameter>search_sensitive</parameter> should be <literal>False</literal>
-if the menu is being popped up initially.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenushell--cancel">
- <title>gtk.MenuShell.cancel</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>cancel</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>cancel</methodname>() method cancels the
-selection within the menu shell.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenushell--set-take-focus">
- <title>gtk.MenuShell.set_take_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_take_focus</methodname>
- <methodparam><parameter role="keyword">take_focus</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">take_focus</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the menu shell should
-take the keyboard focus on popup.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_take_focus</methodname>() method sets the
-"take-focus" property to the value of <parameter>take_focus</parameter>. If
-<parameter>take_focus</parameter> is <literal>True</literal> the menu shell
-will take the keyboard focus so that it will receive all keyboard events to
-enable keyboard navigation in menus.</para>
-
- <para>Setting the "take-focus" property to <literal>False</literal> is
-useful only for special applications like virtual keyboard implementations
-which should not take keyboard focus.</para>
-
- <para>The "take-focus" state of a menu or menu bar is automatically
-propagated to submenus whenever a submenu is popped up, so you don't have to
-worry about recursively setting it for your entire menu hierarchy. Only when
-programmatically picking a submenu and popping it up manually, should the
-"take-focus" property of the submenu be set explicitly.</para>
-
- <para>Note that setting it to False has side-effects:</para>
-
- <itemizedlist>
- <listitem>
- <para>If the focus is in some other app, it keeps the focus and
-keyboard navigation in the menu doesn't work. Consequently, keyboard
-navigation on the menu will only work if the focus is on some toplevel owned
-by the onscreen keyboard.</para>
- </listitem>
-
- <listitem>
- <para>To avoid confusing the user, menus with the "take-focus"
-property set to <literal>False</literal> should not display mnemonics or
-accelerators, since they may not work.</para>
- </listitem>
- </itemizedlist>
-
- <para>Also see the <link
-linkend="function-gdk--keyboard-grab"><function>gtk.gdk.keyboard_grab</function>()</link>
-function for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenushell--get-take-focus">
- <title>gtk.MenuShell.get_take_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_take_focus</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the men shell will
-take keyboard foucs on popup.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_take_focus</methodname>() method returns the
-value of the "take-focus" property. See the <link
-linkend="method-gtkmenushell--set-take-focus"><methodname>set_take_focus</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkmenushell--activate-current">
- <title>The "activate-current" gtk.MenuShell Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter></methodparam>
- <methodparam><parameter>force_hide</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menushell</parameter>&nbsp;:</term>
- <listitem><simpara>the menushell that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>force_hide</parameter>&nbsp;:</term>
- <listitem><simpara>if True, hide the menu after activating the
-menu item.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "activate-current" signal is emitted to activate the current
-menu item in the menushell.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkmenushell--cancel">
- <title>The "cancel" gtk.MenuShell Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menushell</parameter>&nbsp;:</term>
- <listitem><simpara>the menushell that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "cancel" signal is emitted to cancel the selection in the
-menushell. Also causes the "<link
-linkend="signal-gtkmenushell--selection-done">selection-done</link>" signal
-to be emitted. </para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkmenushell--cycle-focus">
- <title>The "cycle-focus" gtk.MenuShell Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menushell</parameter>&nbsp;:</term>
- <listitem><simpara>the menushell that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>direction</parameter>&nbsp;:</term>
- <listitem><simpara>the direction to cycle the focus; one of:
-<literal>gtk.DIR_TAB_FORWARD</literal>,
-<literal>gtk.DIR_TAB_BACKWARD</literal>, <literal>gtk.DIR_UP</literal>,
-<literal>gtk.DIR_DOWN</literal>, <literal>gtk.DIR_LEFT</literal> or
-<literal>gtk.DIR_RIGHT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "cycle-focus" signal is emitted when an action occurs requesting the focus move to the next menubar.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkmenushell--deactivate">
- <title>The "deactivate" gtk.MenuShell Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menushell</parameter>&nbsp;:</term>
- <listitem><simpara>the menushell that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "deactivate" signal is emitted when the menushell is
-deactivated.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkmenushell--move-current">
- <title>The "move-current" gtk.MenuShell Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter></methodparam>
- <methodparam><parameter>direction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menushell</parameter>&nbsp;:</term>
- <listitem><simpara>the menushell that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>direction</parameter>&nbsp;:</term>
- <listitem><simpara>the direction to move; one of:
-<literal>gtk.MENU_DIR_PARENT</literal>,
-<literal>gtk.MENU_DIR_CHILD</literal>, <literal>gtk.MENU_DIR_NEXT</literal>
-or <literal>gtk.MENU_DIR_PREV</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-current" signal is emitted when the current menu item
-is to be moved in the direction specified by
-<parameter>direction</parameter> which is one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.MENU_DIR_PARENT</literal></term>
- <listitem>
- <simpara>To the parent menu shell.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MENU_DIR_CHILD</literal></term>
- <listitem>
- <simpara>To the submenu, if any, associated with the
-item.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MENU_DIR_NEXT</literal></term>
- <listitem>
- <simpara>To the next menu item.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MENU_DIR_PREV</literal></term>
- <listitem>
- <simpara>To the previous menu item.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="signal-gtkmenushell--selection-done">
- <title>The "selection-done" gtk.MenuShell Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menushell</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menushell</parameter>&nbsp;:</term>
- <listitem><simpara>the menushell that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "selection-done" signal is emitted when a selection has been
-completed within a menu shell.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkmenutoolbutton.xml b/docs/reference/pygtk-gtkmenutoolbutton.xml
deleted file mode 100644
index baef3581..00000000
--- a/docs/reference/pygtk-gtkmenutoolbutton.xml
+++ /dev/null
@@ -1,363 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkmenutoolbutton">
- <refnamediv>
- <refname>gtk.MenuToolButton</refname>
- <refpurpose>A <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-containing a button with an additional dropdown menu (new in PyGTK
-2.6)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.MenuToolButton</classname></ooclass>
- <ooclass><classname><link linkend="class-gtktoolbutton">gtk.ToolButton</link></classname></ooclass>
-<constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkmenutoolbutton1">gtk.MenuToolButton</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </constructorsynopsis>
-<constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkmenutoolbutton2">gtk.MenuToolButton</link></methodname>
- <methodparam><parameter role="keyword">icon_widget</parameter></methodparam>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- </constructorsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkmenutoolbutton--set-menu">set_menu</link></methodname>
- <methodparam><parameter role="keyword">menu</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkmenutoolbutton--get-menu">get_menu</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkmenutoolbutton--set-arrow-tooltip">set_arrow_tooltip</link></methodname>
- <methodparam><parameter role="keyword">tooltips</parameter></methodparam>
- <methodparam><parameter role="keyword">tip_text</parameter></methodparam>
- <methodparam><parameter role="keyword">tip_private</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtktoolitem">gtk.ToolItem</link>
- +-- <link linkend="class-gtktoolbutton">gtk.ToolButton</link>
- +-- <link linkend="class-gtkmenutoolbutton">gtk.MenuToolButton</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkmenutoolbutton">
- <title>gtk.MenuToolButton Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para>
- <para><link linkend="properties-gtktoolbutton">gtk.ToolButton Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"menu"</entry>
- <entry>Read-Write</entry>
- <entry>The dropdown <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkmenutoolbutton">
- <title>gtk.MenuToolButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtktoolbutton">gtk.ToolButton Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkmenutoolbutton">
- <title>gtk.MenuToolButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktoolbutton">gtk.ToolButton Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkmenutoolbutton--show-menu">show-menu</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>menutoolbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
-is a <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> that
-contains a button and a small additional button with an arrow. When clicked,
-the arrow button pops up a dropdown menu.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkmenutoolbutton1">
- <title>gtk.MenuToolButton</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.MenuToolButton</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
-using from the stock item specified by <parameter>stock_id</parameter>. The
-new <link
-linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
-will contain the icon and label associated with
-<parameter>stock_id</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="constructor-gtkmenutoolbutton2">
- <title>gtk.MenuToolButton</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.MenuToolButton</methodname>
- <methodparam><parameter
- role="keyword">icon_widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">label</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget that will be used as icon widget,
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string that will be used as label, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
-using the icon specified by <parameter>icon_widget</parameter> and the label
-specified by <parameter>label</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkmenutoolbutton--set-menu">
- <title>gtk.MenuToolButton.set_menu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_menu</methodname>
- <methodparam><parameter
- role="keyword">menu</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">menu</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkmenu"><classname>gtk.Menu</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_menu</methodname>() method sets the "menu"
-property to the <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> specified by
-<parameter>menu</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenutoolbutton--get-menu">
- <title>gtk.MenuToolButton.get_menu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_menu</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the associated <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_menu</methodname>() method returns the value
-of the "menu" property that contains the associated <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmenutoolbutton--set-arrow-tooltip">
- <title>gtk.MenuToolButton.set_arrow_tooltip</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_arrow_tooltip</methodname>
- <methodparam><parameter
- role="keyword">tooltips</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tip_private</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tooltips</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tip_text</parameter>&nbsp;:</term>
- <listitem><simpara>The text to use as the tooltip or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tip_private</parameter>&nbsp;:</term>
- <listitem><simpara>Opitonal private tooltip text or
-<literal>None</literal>. Defaults to
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_arrow_tooltip</methodname>() method sets the
-tooltip data specified by <parameter>tip_text</parameter> for the arrow
-button using the <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
-object specified by <parameter>tooltips</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkmenutoolbutton--show-menu">
- <title>The "show-menu" gtk.MenuToolButton Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>menutoolbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>menutoolbutton</parameter>&nbsp;:</term>
- <listitem><simpara>the menutoolbutton that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.6 and above.</para>
- </note>
-
- <para>The "show-menu" signal is emitted before the dropdown menu is
-displayed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkmessagedialog.xml b/docs/reference/pygtk-gtkmessagedialog.xml
deleted file mode 100644
index 8528393c..00000000
--- a/docs/reference/pygtk-gtkmessagedialog.xml
+++ /dev/null
@@ -1,469 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkmessagedialog">
- <refnamediv>
- <refname>gtk.MessageDialog</refname>
- <refpurpose>a convenient message window</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.MessageDialog</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkmessagedialog">gtk.MessageDialog</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">type</parameter><initializer><literal>gtk.MESSAGE_INFO</literal></initializer></methodparam>
- <methodparam><parameter
- role="keyword">buttons</parameter><initializer><literal>gtk.BUTTONS_NONE</literal></initializer></methodparam>
- <methodparam><parameter
- role="keyword">message_format</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkmessagedialog--set-markup">set_markup</link></methodname>
- <methodparam><parameter
- role="keyword">str</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkmessagedialog--format-secondary-text">format_secondary_text</link></methodname>
- <methodparam><parameter
- role="keyword">message_format</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkmessagedialog--format-secondary-markup">format_secondary_markup</link></methodname>
- <methodparam><parameter
- role="keyword">message_format</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkmessagedialog--set-image">set_image</link></methodname>
- <methodparam><parameter role="keyword">image</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
- +-- <link linkend="class-gtkmessagedialog">gtk.MessageDialog</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkmessagedialog">
- <title>gtk.MessageDialog Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
- <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"buttons"</entry>
- <entry>Write-Construct</entry>
- <entry>The buttons shown in the message dialog. One of the
-<xref linkend="gtk-buttons-type-constants"
-endterm="gtk-buttons-type-constants-title"></xref>:
-<literal>gtk.BUTTONS_NONE</literal>,
-<literal>gtk.BUTTONS_OK</literal>,
-<literal>gtk.BUTTONS_CLOSE</literal>,
-<literal>gtk.BUTTONS_CANCEL</literal>,
-<literal>gtk.BUTTONS_YES_NO</literal>,
-<literal>gtk.BUTTONS_OK_CANCEL</literal>. Default value:
-<literal>gtk.BUTTONS_NONE</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"image"</entry>
- <entry>Read-Write</entry>
- <entry>The image for this dialog. Available in GTK+
- 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"message-type"</entry>
- <entry>Read-Write-Construct</entry>
- <entry>The type of message. One of the
-<xref linkend="gtk-message-type-constants"
-endterm="gtk-message-type-constants-title"></xref>:
-<literal>gtk.MESSAGE_INFO</literal>, <literal>gtk.MESSAGE_WARNING</literal>,
-<literal>gtk.MESSAGE_QUESTION</literal> or
-<literal>gtk.MESSAGE_ERROR</literal>. Default value:
-<literal>gtk.MESSAGE_INFO</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"secondary-text"</entry>
- <entry>Read-Write</entry>
- <entry>The secondary text of the message dialog. Default
- value: <literal>None</literal>. Available in GTK+
- 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"secondary-use-markup"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the secondary text of the
- dialog includes Pango markup. See the <link
- linkend="function-pango--parse-markup"><function>pango.parse_markup</function>()</link>
- function. Default value: <literal>False</literal>. Available
- in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"text"</entry>
- <entry>Read-Write</entry>
- <entry>The primary text of the message dialog. If the dialog
- has a secondary text, this will appear as the title. Default
- value: <literal>None</literal>. Available in GTK+
- 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"use-markup"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the primary text of the
- dialog includes Pango markup. See the <link
- linkend="function-pango--parse-markup"><function>pango.parse_markup</function>()</link>
- function. Default value: <literal>False</literal>. Available
- in GTK+ 2.10.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkmessagedialog">
- <title>gtk.MessageDialog Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"message-border"</entry>
- <entry>Read-Write</entry>
- <entry>The width of border around the label and image in the
-message dialog. Allowed values: >= 0. Default value: 12.</entry>
- </row>
-
- <row valign="top">
- <entry>"use-separator"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> draw a separator line between
- the message label and the buttons in the dialog. This property is
- available in GTK+ 2.4 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"image"</entry>
- <entry>Read</entry>
- <entry>The stock ID image</entry>
- </row>
-
- <row valign="top">
- <entry>"label"</entry>
- <entry>Read</entry>
- <entry>The label widget that contains the message
-text.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkmessagedialog">
- <title>gtk.MessageDialog Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>
-presents a dialog with an image representing the type of message (Error,
-Question, etc.) alongside some message text. It's simply a convenience
-widget; you could construct the equivalent of <link
-linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>
-from <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> without
-too much effort, but <link
-linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>
-saves time.</para>
-
- <para>The <link
-linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>
-types are listed in the <xref linkend="gtk-message-type-constants"
-endterm="gtk-message-type-constants-title"></xref>.</para>
-
- <para>A selection of predefined button sets is available for use in a
-message dialog. See the <xref linkend="gtk-buttons-type-constants"
-endterm="gtk-buttons-type-constants-title"></xref>.</para>
-
- <para>See the <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> reference
-page for additional methods to be used with the <link
-linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkmessagedialog">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.MessageDialog</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">type</parameter><initializer><literal>gtk.MESSAGE_INFO</literal></initializer></methodparam>
- <methodparam><parameter
- role="keyword">buttons</parameter><initializer><literal>gtk.BUTTONS_NONE</literal></initializer></methodparam>
- <methodparam><parameter
- role="keyword">message_format</parameter><initializer>None</initializer></methodparam>
-</constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>the transient parent, or None if
-none</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>the dialog flags - a combination of:
-<literal>gtk.DIALOG_MODAL</literal>,
-<literal>gtk.DIALOG_DESTROY_WITH_PARENT</literal> or 0 for no
-flags</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of message:
-<literal>gtk.MESSAGE_INFO</literal>, <literal>gtk.MESSAGE_WARNING</literal>,
-<literal>gtk.MESSAGE_QUESTION</literal> or
-<literal>gtk.MESSAGE_ERROR</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">buttons</parameter>&nbsp;:</term>
- <listitem><simpara>the predefined set of buttons to use:
-<literal>gtk.BUTTONS_NONE</literal>, <literal>gtk.BUTTONS_OK</literal>,
-<literal>gtk.BUTTONS_CLOSE</literal>, <literal>gtk.BUTTONS_CANCEL</literal>,
-<literal>gtk.BUTTONS_YES_NO</literal>,
-<literal>gtk.BUTTONS_OK_CANCEL</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">message_format</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the message text or
-None</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>,
-which is a simple dialog with an icon indicating the dialog type (error,
-warning, etc.) specified by <parameter>type</parameter> and some text
-(<parameter>message_format</parameter>) the user may want to see.
-<parameter>parent</parameter> if specified indicates the transient parent of
-the dialog. The <parameter>flags</parameter> allow the specification special
-dialog characteristics: make the dialog modal
-(<literal>gtk.DIALOG_MODAL</literal>) and destroy the dialog when the parent is
-destroyed (<literal>gtk.DIALOG_DESTROY_WITH_PARENT</literal>). When the user
-clicks a button a "response" signal is emitted with response IDs.
-<parameter>buttons</parameter> specifies the set of predefined buttons to
-use: <literal>gtk.BUTTONS_NONE</literal>, <literal>gtk.BUTTONS_OK</literal>,
-<literal>gtk.BUTTONS_CLOSE</literal>, <literal>gtk.BUTTONS_CANCEL</literal>,
-<literal>gtk.BUTTONS_YES_NO</literal>,
-<literal>gtk.BUTTONS_OK_CANCEL</literal>. See <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> for more
-details.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkmessagedialog--set-markup">
- <title>gtk.MessageDialog.set_markup</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>set_markup</methodname>
- <methodparam><parameter role="keyword">str</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">str</parameter>&nbsp;:</term>
- <listitem><simpara>a markup string (see the <link
- linkend="pango-markup-language">Pango markup language</link>
- reference)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_markup</methodname>() method sets the text
-of the message dialog to the contents of <parameter>str</parameter>. If
-<parameter>str</parameter> contains text marked up with Pango markup (see
-<xref linkend="pango-markup-language"></xref>), it will be displayed with
-those attributes. Note the '&lt;', '&gt;' and '&amp;' characters must be
-replaced with '&amp;lt;', '&amp;gt;' and '&amp;amp;' respectively to be
-displayed literally.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmessagedialog--format-secondary-text">
- <title>gtk.MessageDialog.format_secondary_text</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>format_secondary_text</methodname>
- <methodparam><parameter role="keyword">message_format</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">message_format</parameter>&nbsp;:</term>
- <listitem><simpara>The text to be displayed as the secondary text
-or <literal>None</literal></simpara>.</listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>format_secondary_text</methodname>() method sets
-the secondary text of the message dialog to the text specified by
-<parameter>message_format</parameter>. Note that setting a secondary text
-makes the primary text bold, unless you have provided explicit
-markup.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmessagedialog--format-secondary-markup">
- <title>gtk.MessageDialog.format_secondary_markup</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>format_secondary_markup</methodname>
- <methodparam><parameter role="keyword">message_format</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">message_format</parameter>&nbsp;:</term>
- <listitem><simpara>A string containing the pango markup to use as
-secondary text.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>format_secondary_markup</methodname>() method
-sets the secondary text to the markup text specified by
-<parameter>message_format</parameter>. Note that setting a secondary text
-makes the primary text become bold, unless you have provided explicit
-markup.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmessagedialog--set-image">
- <title>gtk.MessageDialog.set_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_image</methodname>
- <methodparam><parameter role="keyword">image</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">image</parameter>&nbsp;:</term>
- <listitem><simpara>the image widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_image</methodname>() method sets the
- dialog's image to the <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
- specified by <parameter>image</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkmisc.xml b/docs/reference/pygtk-gtkmisc.xml
deleted file mode 100644
index 1e8b6715..00000000
--- a/docs/reference/pygtk-gtkmisc.xml
+++ /dev/null
@@ -1,246 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkmisc">
- <refnamediv>
- <refname>gtk.Misc</refname>
- <refpurpose>a base class for widgets with alignments and
-padding.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Misc</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmisc--set-alignment">set_alignment</link></methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmisc--get-alignment">get_alignment</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmisc--set-padding">set_padding</link></methodname>
- <methodparam><parameter
- role="keyword">xpad</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ypad</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkmisc--get-padding">get_padding</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkmisc">gtk.Misc</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkmisc">
- <title>gtk.Misc Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"xalign"</entry>
- <entry>Read-Write</entry>
- <entry>The horizontal alignment, from 0.0 to 1.0</entry>
- </row>
- <row valign="top">
- <entry>"xpad"</entry>
- <entry>Read-Write</entry>
- <entry>The amount of space to add on the left and right of the
-widget, in pixels</entry>
- </row>
- <row valign="top">
- <entry>"yalign"</entry>
- <entry>Read-Write</entry>
- <entry>The vertical alignment, from 0.0 to 1.0</entry>
- </row>
- <row valign="top">
- <entry>"ypad"</entry>
- <entry>Read-Write</entry>
- <entry>The amount of space to add above and below the widget,
-in pixels</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkmisc">
- <title>gtk.Misc Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkmisc">
- <title>gtk.Misc Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkmisc"><classname>gtk.Misc</classname></link> widget is an
-abstract widget used to derive subclasses which have alignment and padding
-attributes. The horizontal and vertical padding attributes allow extra space
-to be added around the widget. The horizontal and vertical alignment
-attributes enable the widget to be positioned within its allocated area. The
-alignment values represent the fraction of available free space (allocation
-minus the widget size) to place to the left or above the widget for x and y
-alignment respectively. Note that if the widget is added to a container in
-such a way that it expands automatically to fill its allocated area, the
-alignment settings will have no effect.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkmisc--set-alignment">
- <title>gtk.Misc.set_alignment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_alignment</methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">xalign</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal alignment</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">yalign</parameter>&nbsp;:</term>
- <listitem><simpara>the vertical alignment</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_alignment</methodname>() method sets the
-alignment of the widget in its allocated space. <parameter>xalign</parameter>
-sets the fraction (0.0-1.0) of free space (horizontal allocation minus
-widget width) to place to the left of the widget.
-<parameter>yalign</parameter> sets the fraction (0.0-1.0) of free space
-(vertical allocation minus widget height) to place above the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmisc--get-alignment">
- <title>gtk.Misc.get_alignment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_alignment</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the X and Y alignments of the
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_alignment</methodname>() method returns a
-tuple containing the X and Y alignments of the widget within its allocation.
-See <link
-linkend="method-gtkmisc--set-alignment"><methodname>set_alignment</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmisc--set-padding">
- <title>gtk.Misc.set_padding</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_padding</methodname>
- <methodparam><parameter
- role="keyword">xpad</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ypad</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">xpad</parameter>&nbsp;:</term>
- <listitem><simpara>the amount of space to add on the left and
-right of the widget, in pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ypad</parameter>&nbsp;:</term>
- <listitem><simpara>the amount of space to add on the top and
-bottom of the widget, in pixels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_padding</methodname>() method sets the
-amount of space to add around the widget. The <parameter>xpad</parameter>
-value specifies the number of pixels of padding to add to the left and right
-of the widget. The <parameter>yalign</parameter> value specifies the number
-of pixels to add above and below the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkmisc--get-padding">
- <title>gtk.Misc.get_padding</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_padding</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the horizontal and vertical
-padding in pixels for the widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_padding</methodname>() method returns a
-tuple containing the padding in the horizontal and vertical directions of
-the widget. See <link
-linkend="method-gtkmisc--set-padding"><methodname>set_padding</methodname>()</link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtknotebook.xml b/docs/reference/pygtk-gtknotebook.xml
deleted file mode 100644
index 3bcc0c94..00000000
--- a/docs/reference/pygtk-gtknotebook.xml
+++ /dev/null
@@ -1,2455 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtknotebook">
- <refnamediv>
- <refname>gtk.Notebook</refname>
- <refpurpose>a tabbed notebook container.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Notebook</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtknotebook">gtk.Notebook</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--append-page">append_page</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--append-page-menu">append_page_menu</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">menu_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--prepend-page">prepend_page</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--prepend-page-menu">prepend_page_menu</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">menu_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--insert-page">insert_page</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--insert-page-menu">insert_page_menu</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">menu_label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter><initializer>-1</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--remove-page">remove_page</link></methodname>
- <methodparam><parameter
- role="keyword">page_num</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--get-current-page">get_current_page</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--get-nth-page">get_nth_page</link></methodname>
- <methodparam><parameter
- role="keyword">page_num</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtknotebook--get-n-pages">get_n_pages</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--page-num">page_num</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--set-current-page">set_current_page</link></methodname>
- <methodparam><parameter
- role="keyword">page_num</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--next-page">next_page</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--prev-page">prev_page</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--set-show-border">set_show_border</link></methodname>
- <methodparam><parameter
- role="keyword">show_border</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--get-show-border">get_show_border</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--set-show-tabs">set_show_tabs</link></methodname>
- <methodparam><parameter
- role="keyword">show_tabs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--get-show-tabs">get_show_tabs</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--set-tab-pos">set_tab_pos</link></methodname>
- <methodparam><parameter role="keyword">pos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--get-tab-pos">get_tab_pos</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--set-scrollable">set_scrollable</link></methodname>
- <methodparam><parameter
- role="keyword">scrollable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--get-scrollable">get_scrollable</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--popup-enable">popup_enable</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--popup-disable">popup_disable</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--get-tab-label">get_tab_label</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--set-tab-label">set_tab_label</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--set-tab-label-text">set_tab_label_text</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--get-tab-label-text">get_tab_label_text</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--get-menu-label">get_menu_label</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--set-menu-label">set_menu_label</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">menu_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--set-menu-label-text">set_menu_label_text</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">menu_text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--get-menu-label-text">get_menu_label_text</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--query-tab-label-packing">query_tab_label_packing</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--set-tab-label-packing">set_tab_label_packing</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pack_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtknotebook--reorder-child">reorder_child</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtknotebook--set-group-id">set_group_id</link></methodname>
- <methodparam><parameter role="keyword">group_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtknotebook--get-group-id">get_group_id</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtknotebook--get-tab-reorderable">get_tab_reorderable</link></methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtknotebook--set-tab-reorderable">set_tab_reorderable</link></methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- <methodparam><parameter role="keyword">reorderable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtknotebook--get-tab-detachable">get_tab_detachable</link></methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtknotebook--set-tab-detachable">set_tab_detachable</link></methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- <methodparam><parameter role="keyword">detachable</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtknotebook">gtk.Notebook</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtknotebook">
- <title>gtk.Notebook Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"enable-popup"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, pressing the right mouse
- button on the notebook pops up a menu that you can use to go
- to a page. Default value: <literal>False</literal>.</entry>
- </row>
- <row valign="top">
- <entry>"group-id"</entry>
- <entry>Read-Write</entry>
- <entry>Group ID for tabs drag and drop. Allowed values: >=
- -1. Default value: -1.</entry>
- </row>
-
- <row valign="top">
- <entry>"homogeneous"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, tabs should have
- homogeneous sizes. Default value:
- <literal>False</literal>.</entry>
- </row>
- <row valign="top">
- <entry>"page"</entry>
- <entry>Read-Write</entry>
- <entry>The index of the current page. Allowed values: >= 0.
- Default value: 0.</entry>
- </row>
- <row valign="top">
- <entry>"scrollable"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, scroll arrows are added if
- there are too many tabs to fit. Default value:
- <literal>False</literal>.</entry>
- </row>
- <row valign="top">
- <entry>"show-border"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the border should be shown.
- Default value: <literal>True</literal>.</entry>
- </row>
- <row valign="top">
- <entry>"show-tabs"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, tabs should be shown.
- Default value: <literal>True</literal>.</entry>
- </row>
- <row valign="top">
- <entry>"tab-border"</entry>
- <entry>Write</entry>
- <entry>The width of the border around the tab labels. Default
- value: 2.</entry>
- </row>
- <row valign="top">
- <entry>"tab-hborder"</entry>
- <entry>Read-Write</entry>
- <entry>The width of the horizontal border of tab labels.
- Default value: 2.</entry>
- </row>
- <row valign="top">
- <entry>"tab-pos"</entry>
- <entry>Read-Write</entry>
- <entry>The side of the notebook that holds the tabs - one of
- the <xref linkend="gtk-position-type-constants"
- endterm="gtk-position-type-constants-title"></xref>:
- <literal>gtk.POS_LEFT</literal>,
- <literal>gtk.POS_RIGHT</literal>,
- <literal>gtk.POS_TOP</literal> or
- <literal>gtk.POS_BOTTOM</literal>. Default value:
- <literal>gtk.POS_TOP</literal>.</entry>
- </row>
- <row valign="top">
- <entry>"tab-vborder"</entry>
- <entry>Read-Write</entry>
- <entry>The width of the vertical border of tab labels.
- Default value: 2,</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtknotebook">
- <title>gtk.Notebook Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"arrow-spacing"</entry>
- <entry>Read-Write</entry>
- <entry>The "arrow-size" property defines the spacing between
- the scroll arrows and the tabs. Allowed values: >= 0.
- Default value: 0. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"has-backward-stepper"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the standard backward arrow
- button is displayed. Default value:
- <literal>True</literal>. Available in GTK+ 2.4 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"has-forward-stepper"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the standard forward arrow
- button is displayed. Default value:
- <literal>True</literal>. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"has-secondary-backward-stepper"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> a second backward arrow
- button is displayed on the opposite end of the tab
- area. Default value: <literal>False</literal>. Available in
- GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"has-secondary-forward-stepper"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> a second forward arrow
- button is displayed on the opposite end of the tab
- area. Default value: <literal>False</literal>. Available in
- GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"tab-curvature"</entry>
- <entry>Read-Write</entry>
- <entry>The "tab-curvature" property defines size of tab
- curvature. Allowed values: >= 0. Default value: 1. Available
- in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"tab-overlap"</entry>
- <entry>Read-Write</entry>
- <entry>The "tab-overlap" property defines size of tab overlap
- area. Default value: 2. Available in GTK+ 2.10.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtknotebook">
- <title>gtk.Notebook Child Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"detachable"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>True</literal> the tab is detachable.
- Default value: <literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"menu-label"</entry>
- <entry>Read-Write</entry>
- <entry>The string displayed in the child's menu entry.
- Default value: <literal>None</literal></entry>
- </row>
- <row valign="top">
- <entry>"position"</entry>
- <entry>Read-Write</entry>
- <entry>The index of the child in the parent. Allowed values:
- >= -1 Default value: 0.</entry>
- </row>
- <row valign="top">
- <entry>"tab-expand"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, expand the child's tabs.
- Default value: <literal>False</literal>.</entry>
- </row>
- <row valign="top">
- <entry>"tab-fill"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the child's tab should fill
- the allocated area. Default value:
- <literal>True</literal>.</entry>
- </row>
- <row valign="top">
- <entry>"tab-label"</entry>
- <entry>Read-Write</entry>
- <entry>The string displayed on the child's tab label. Default
- value: <literal>None</literal>.</entry>
- </row>
- <row valign="top">
- <entry>tab-pack""</entry>
- <entry>Read-Write</entry>
- <entry>A pack type indicating whether the child is packed with
- reference to the start or end of the parent - one of the <xref
- linkend="gtk-pack-type-constants"
- endterm="gtk-pack-type-constants-title"></xref>:
- <literal>gtk.PACK_START</literal> or
- <literal>gtk.PACK_END</literal>. Default value:
- <literal>gtk.PACK_START</literal>.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"tab_pos"</entry>
- <entry>Read</entry>
- <entry>The side of the notebook that holds the tabs:
-<literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
-<literal>gtk.POS_TOP</literal> or <literal>gtk.POS_BOTTOM</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtknotebook">
- <title>gtk.Notebook Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtknotebook--change-current-page">change-current-page</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter>
- </methodparam>
- <methodparam><parameter>offset</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtknotebook--focus-tab">focus-tab</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter>
- </methodparam>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>"<link
-linkend="signal-gtknotebook--move-focus-out">move-focus-out</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter>
- </methodparam>
- <methodparam><parameter>direction_type</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>"<link linkend="signal-gtknotebook--page-added">page-added</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter>
- </methodparam>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>page_num</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>"<link linkend="signal-gtknotebook--page-removed">page-removed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter>
- </methodparam>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>page_num</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>"<link linkend="signal-gtknotebook--page-reordered">page-reordered</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter>
- </methodparam>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>page_num</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>"<link
-linkend="signal-gtknotebook--select-page">select-page</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter>
- </methodparam>
- <methodparam><parameter>move_focus</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtknotebook--switch-page">switch-page</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter>
- </methodparam>
- <methodparam><parameter>page</parameter></methodparam>
- <methodparam><parameter>page_num</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link>
-widget is a <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
-whose children are overlapping pages that can be switched between by using
-tab labels along one edge. There are many configuration options for the
-<link
-linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link>. You
-can choose on which edge the tabs appear (see <link
-linkend="method-gtknotebook--set-tab-pos"><methodname>set_tab_pos</methodname>()</link>);
-whether the notebook should be made bigger or scrolling arrows added if
-there are too many tabs to fit (see <link
-linkend="method-gtknotebook--set-scrollable"><methodname>set_scrollable</methodname>()</link>);
-and, whether there will be a popup menu allowing the users to switch pages.
-(see <link
-linkend="method-gtknotebook--popup-enable"><methodname>popup_enable</methodname>()</link>,
-<link
-linkend="method-gtknotebook--popup-disable"><methodname>popup_disable</methodname>()</link>).</para>
-
- <para>The <link
-linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link> is
-particularly useful for displaying a large number of application controls
-that can be grouped into several functional areas. The typical example is
-the user preferences dialog in some applications. For example, a notebook
-page can be setup for each of font selection, color selection, formating,
-etc.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtknotebook">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Notebook</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the newly created <link
-linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link>
-widget with no pages.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtknotebook--append-page">
- <title>gtk.Notebook.append_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append_page</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to use as
-the contents of the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tab_label</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to be
-used as the label for the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>in PyGTK 2.0 and 2.2 returns
- <literal>None</literal>. In PyGTK 2.4 and above returns the index
- number of the page in the notebook</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>append_page</methodname>() method appends a page
-to the notebook using the widget specified by <parameter>child</parameter>
-and the widget specified by <parameter>tab_label</parameter> as the label on
-the tab.</para>
-
- <para>In PyGTK 2.4 and above <parameter>tab_label</parameter> can be
-<literal>None</literal> to use a default label. Also if
-<parameter>tab_label</parameter> is not specified it will default to
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--append-page-menu">
- <title>gtk.Notebook.append_page_menu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append_page_menu</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">menu_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to use as
-the contents of the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tab_label</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to be
-used as the label for the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">menu_label</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to use as a label for the
-page-switch menu, if that is enabled.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>in PyGTK 2.0 and 2.2 returns
- <literal>None</literal>. In PyGTK 2.4 and above returns the index
- number of the page in the notebook</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>append_page_menu</methodname>() method appends a
-page to the notebook and specifying the widget to use as the label in the
-popup menu. <parameter>child</parameter> specifies the widget to use as the
-contents of the page; <parameter>tab_label</parameter> specifies the widget
-to be used as the tab label; and, <parameter>menu_label</parameter>
-specifies the widget to use in the popup menu.</para>
-
- <para>In PyGTK 2.4 and above <parameter>tab_label</parameter> can be
-<literal>None</literal> to use a default label. If
-<parameter>tab_label</parameter> is a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> or
-<literal>None</literal> and <parameter>menu_label</parameter> is
-<literal>None</literal> then the menu label will have the same text as the
-tab label. Otherwise, <parameter>menu_label</parameter> must be specified
-and not <literal>None</literal>. These parameters will default to
-<literal>None</literal> in PyGTK 2.4 as well.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--prepend-page">
- <title>gtk.Notebook.prepend_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend_page</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to use as
-the contents of the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tab_label</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to be
-used as the label for the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>in PyGTK 2.0 and 2.2 returns
- <literal>None</literal>. In PyGTK 2.4 and above returns the index
- number of the page in the notebook</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>prepend_page</methodname>() method prepends a
-page to the notebook. <parameter>child</parameter> specifies the widget to
-use as the contents of the page and <parameter>tab_label</parameter>
-specifies the widget to be used as the tab label.</para>
-
- <para>In PyGTK 2.4 and above <parameter>tab_label</parameter> can be
-<literal>None</literal> to use a default label. Also if
-<parameter>tab_label</parameter> is not specified it will default to
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--prepend-page-menu">
- <title>gtk.Notebook.prepend_page_menu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend_page_menu</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">menu_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to use as
-the contents of the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tab_label</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to be
-used as the label for the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">menu_label</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to use as a label for the
-page-switch menu, if that is enabled.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>in PyGTK 2.0 and 2.2 returns
- <literal>None</literal>. In PyGTK 2.4 and above returns the index
- number of the page in the notebook</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>prepend_page_menu</methodname>() method prepends
-a page to the notebook specifying the widget to use as the label in the
-popup menu. <parameter>child</parameter> specifies the widget to use as the
-contents of the page; <parameter>tab_label</parameter> specifies the widget
-to use as the tab label; and, <parameter>menu_label</parameter> specifies
-the widget to use in the popup menu.</para>
-
- <para>In PyGTK 2.4 and above <parameter>tab_label</parameter> can be
-<literal>None</literal> to use a default label. If
-<parameter>tab_label</parameter> is a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> or
-<literal>None</literal> and <parameter>menu_label</parameter> is
-<literal>None</literal> then the menu label will have the same text as the
-tab label. Otherwise, <parameter>menu_label</parameter> must be specified
-and not <literal>None</literal>. These parameters will default to
-<literal>None</literal> in PyGTK 2.4 as well.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--insert-page">
- <title>gtk.Notebook.insert_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_page</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to use as
-the contents of the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tab_label</parameter>&nbsp;:</term> <listitem><simpara>the
-<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to
-be used as the label for the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the index (starting at 0) at which to insert
-the page, or -1 to append the page after all other
-pages.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>in PyGTK 2.0 and 2.2 returns
- <literal>None</literal>. In PyGTK 2.4 and above returns the index
- number of the page in the notebook</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_page</methodname>() method inserts a page
-into the notebook at the location specified by
-<parameter>position</parameter> (0 is the first page).
-<parameter>child</parameter> is the widget to use as the contents of the
-page and <parameter>tab_label</parameter> specifies the widget to be used as
-the tab label. If <parameter>position</parameter> is -1 the page is appended
-to the notebook. In PyGTK 2.4 and above if <parameter>tab_label</parameter>
-is <literal>None</literal> a default label if "page N" is used.</para>
-
- <para>In PyGTK 2.4 and above <parameter>tab_label</parameter> can be
-<literal>None</literal> to use a default label. Also if
-<parameter>tab_label</parameter> is not specified it will default to
-<literal>None</literal>.</para>
-
- <para>In Pygtk 2.4 and above <parameter>position</parameter> will
-default to -1 if not specified.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--insert-page-menu">
- <title>gtk.Notebook.insert_page_menu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_page_menu</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">menu_label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to use as
-the contents of the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tab_label</parameter>&nbsp;:</term>
- <listitem><simpara>the
-<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to
-be used as the label for the page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">menu_label</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to use as a label for the
-page-switch menu, if that is enabled.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the index (starting at 0) at which to insert
-the page, or -1 to append the page after all other
-pages.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>in PyGTK 2.0 and 2.2 returns
- <literal>None</literal>. In PyGTK 2.4 and above returns the index
- number of the page in the notebook</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_page_menu</methodname>() method inserts a
-page into the notebook at the location specified by
-<parameter>position</parameter>. <parameter>child</parameter> specifies the
-widget to use as the contents of the page; <parameter>tab_label</parameter>
-specifies the widget to use as the tab label; and
-<parameter>menu_label</parameter> specifies the widget to use as the label
-in the popup menu.</para>
-
- <para>In PyGTK 2.4 and above <parameter>tab_label</parameter> can be
-<literal>None</literal> to use a default label. If
-<parameter>tab_label</parameter> is a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> or
-<literal>None</literal> and <parameter>menu_label</parameter> is
-<literal>None</literal> then the menu label will have the same text as the
-tab label. Otherwise, <parameter>menu_label</parameter> must be specified
-and not <literal>None</literal>. These parameters will default to
-<literal>None</literal> in PyGTK 2.4 as well.</para>
-
- <para>In Pygtk 2.4 and above <parameter>position</parameter> will
-default to -1 if not specified.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--remove-page">
- <title>gtk.Notebook.remove_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_page</methodname>
- <methodparam><parameter
- role="keyword">page_num</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_num</parameter>&nbsp;:</term>
- <listitem><simpara>the index of a notebook page, starting from 0.
-If -1, the last page will be removed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove_page</methodname>() method removes from
-the notebook the page at the location specified by
-<parameter>index</parameter>. The value of <parameter>index</parameter>
-starts from 0. If <parameter>index</parameter> is -1 the last page of the
-notebook will be removed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-current-page">
- <title>gtk.Notebook.get_current_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_current_page</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the index (starting from 0) of the current page
-in the notebook. If the notebook has no pages, then -1 will be
-returned.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_current_page</methodname>() method returns
-the page index of the current page numbered from 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-nth-page">
- <title>gtk.Notebook.get_nth_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_nth_page</methodname>
- <methodparam><parameter
- role="keyword">page_num</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_num</parameter>&nbsp;:</term>
- <listitem><simpara>the index of a page in the
-notebook</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the child widget, or <literal>None</literal> if
-<parameter>page_num</parameter> is out of bounds.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_nth_page</methodname>() method returns the
-child widget contained in the page with the index specified by
-<parameter>page_num</parameter>. If <parameter>page_num</parameter> is out
-of bounds for the page range of the notebook this method returns
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-n-pages">
- <title>gtk.Notebook.get_n_pages</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_pages</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of pages in the
- notebook.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_n_pages</methodname>() method returns the
-number of pages in a notebook.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--page-num">
- <title>gtk.Notebook.page_num</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>page_num</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the index of the page containing
-<parameter>child</parameter>, or -1 if <parameter>child</parameter> is not
-in the notebook.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>page_num</methodname>() method returns the index
-of the page which contains the widget specified by
-<parameter>child</parameter> or <literal>None</literal> if no page contains
-<parameter>child</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-current-page">
- <title>gtk.Notebook.set_current_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_current_page</methodname>
- <methodparam><parameter
- role="keyword">page_num</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_num</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the page to switch to, starting
-from 0. If negative, the last page will be used. If greater than the number
-of pages in the notebook, nothing will be done.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_current_page</methodname>() method switches
-to the page number specified by <parameter>page_num</parameter>. If
-<parameter>page_num</parameter> is negative the last page is
-selected.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--next-page">
- <title>gtk.Notebook.next_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>next_page</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>next_page</methodname>() method switches to the
-next page. Nothing happens if the current page is the last page.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--prev-page">
- <title>gtk.Notebook.prev_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prev_page</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>prev_page</methodname>() method switches to the
-previous page. Nothing happens if the current page is the first page.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-show-border">
- <title>gtk.Notebook.set_show_border</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_border</methodname>
- <methodparam><parameter
- role="keyword">show_border</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">show_border</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> a bevel should be
-drawn around the notebook.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>show_border</methodname>() method sets the
-"show-border" property to the value of <parameter>show_border</parameter>.
-If <parameter>show_border</parameter> is <literal>True</literal> a bevel
-will be drawn around the notebook pages. This only has a visual effect when
-the tabs are not shown. See <link
-linkend="method-gtknotebook--set-show-tabs"><methodname>set_show_tabs</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-show-border">
- <title>gtk.Notebook.get_show_border</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_border</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the bevel should be
-drawn</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_show_border</methodname>() method returns
-the value of the "show-border" property. If "show-border" is
-<literal>True</literal> a bevel will be drawn around the notebook pages when
-tabs are not shown. See <link
-linkend="method-gtknotebook--set-show-border"><methodname>set_show_border</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-show-tabs">
- <title>gtk.Notebook.set_show_tabs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_tabs</methodname>
- <methodparam><parameter
- role="keyword">show_tabs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">show_tabs</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the tabs should be
-shown.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_show_tabs</methodname>() method sets the
-"show-tabs" property to the value of <parameter>show_tabs</parameter>. If
-<parameter>show_tabs</parameter> is <literal>True</literal> the notebook
-tabs will be displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-show-tabs">
- <title>gtk.Notebook.get_show_tabs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_tabs</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the tabs are
-shown</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_show_tabs</methodname>() method returns the
-value of the "show-tabs" property. If "show-tabs" is <literal>True</literal>
-the tabs of the notebook are shown. See <link
-linkend="method-gtknotebook--set-show-tabs"><methodname>set_show_tabs</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-tab-pos">
- <title>gtk.Notebook.set_tab_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tab_pos</methodname>
- <methodparam><parameter
- role="keyword">pos</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pos</parameter>&nbsp;:</term>
- <listitem><simpara>the edge to draw the tabs at:
-<literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
-<literal>gtk.POS_TOP</literal> or
-<literal>gtk.POS_BOTTOM</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_tab_pos</methodname>() method sets the edge
-at which the tabs for switching pages in the notebook are drawn as specified
-by <parameter>pos</parameter>. The value of <parameter>pos</parameter> can
-be one of: <literal>gtk.POS_LEFT</literal>,
-<literal>gtk.POS_RIGHT</literal>, <literal>gtk.POS_TOP</literal> or
-<literal>gtk.POS_BOTTOM</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-tab-pos">
- <title>gtk.Notebook.get_tab_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tab_pos</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the edge at which the tabs are
-drawn</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tab_pos</methodname>() method returns the
-edge at which the tabs for switching pages in the notebook are drawn. The
-return value is one of: <literal>gtk.POS_LEFT</literal>,
-<literal>gtk.POS_RIGHT</literal>, <literal>gtk.POS_TOP</literal> or
-<literal>gtk.POS_BOTTOM</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-scrollable">
- <title>gtk.Notebook.set_scrollable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_scrollable</methodname>
- <methodparam><parameter
- role="keyword">scrollable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">scrollable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> scroll arrows should
-be added</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_scrollable</methodname>() method sets the
-"scrollable" property to the value specified by
-<parameter>scrollable</parameter>. If <parameter>scrollable</parameter> is
-<literal>True</literal> the tab label area will have arrows for scrolling if
-there are too many tabs to fit in the area.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-scrollable">
- <title>gtk.Notebook.get_scrollable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_scrollable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if arrows for scrolling
-are enabled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_scrollable</methodname>() method returns the
-value of the "scrollable" property. If "scrollable" is
-<literal>True</literal> the tab label area has scrolling arrows enabled and
-displayed if there are too many tabs to fit in the display area. See <link
-linkend="method-gtknotebook--set-scrollable"><methodname>set_scrollable</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--popup-enable">
- <title>gtk.Notebook.popup_enable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>popup_enable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>popup_enable</methodname>() method enables the
-popup menu: if the user clicks with the right mouse button on the tabs, a
-menu with all the pages will be popped up.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--popup-disable">
- <title>gtk.Notebook.popup_disable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>popup_disable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>popup_disable</methodname>() method disables the
-popup menu.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-tab-label">
- <title>gtk.Notebook.get_tab_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tab_label</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a widget contained in a notebook
-page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the tab label widget for the page containing
-<parameter>child</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tab_label</methodname>() method returns the
-tab label widget for the page containing the widget
-<parameter>child</parameter>. <literal>None</literal> is returned if
-<parameter>child</parameter> is not in the notebook.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-tab-label">
- <title>gtk.Notebook.set_tab_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tab_label</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a widget contained in a notebook
-page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tab_label</parameter>&nbsp;:</term>
- <listitem><simpara>the tab label widget to
-use or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_tab_label</methodname>() method replaces the
-tab label for the notebook page containing <parameter>child</parameter> with
-the widget specified by <parameter>tab_label</parameter>.</para>
-
- <para>In PyGTK 2.4 and above <parameter>tab_label</parameter> can be
-<literal>None</literal> to use a default label. Also if
-<parameter>tab_label</parameter> is not specified it will default to
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-tab-label-text">
- <title>gtk.Notebook.set_tab_label_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tab_label_text</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tab_text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a widget contained in a notebook
-page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tab_text</parameter>&nbsp;:</term>
- <listitem><simpara>the new label text</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_tab_label_text</methodname>() method creates
-a new label with the text specified by <parameter>tab_text</parameter> and
-sets it as the tab label for the page containing
-<parameter>child</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-tab-label-text">
- <title>gtk.Notebook.get_tab_label_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tab_label_text</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a widget contained in a notebook
-page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>value: the text of the tab label, or
-<literal>None</literal> if the tab label widget is not a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> or
-<parameter>child</parameter> is not in a notebook page.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tab_label_text</methodname>() retrieves the
-text of the tab label for the page containing <parameter>child</parameter>.
-This method returns <literal>None</literal> if <parameter>child</parameter>
-is not in a notebook page or the page tab label is not a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link>
-widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-menu-label">
- <title>gtk.Notebook.get_menu_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_menu_label</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a widget contained in a notebook
-page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the menu label, or <literal>None</literal> if
-the notebook page does not have a menu label other than the default (the tab
-label) or if child is not in a notebook page.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_menu_label</methodname>() method retrieves
-the menu label widget of the page containing <parameter>child</parameter>.
-If <parameter>child</parameter> is not in a notebook page or the menu label
-has not been set (it defaults to the tab label), this method returns
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-menu-label">
- <title>gtk.Notebook.set_menu_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_menu_label</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">menu_label</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a widget contained in a notebook
-page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">menu_label</parameter>&nbsp;:</term>
- <listitem><simpara>a widget to be used as the new menu
-label</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_menu_label</methodname>() replaces the menu
-label for the page containing <parameter>child</parameter> with the widget
-specified by <parameter>menu_label</parameter>.</para>
-
- <para>In PyGTK 2.4 and above <parameter>menu_label</parameter> can be
-<literal>None</literal> to use a default label. Also if
-<parameter>menu_label</parameter> is not specified it will default to
-<literal>None</literal>. See the <link
-linkend="method-gtknotebook--append-page-menu"><methodname>append_page_menu</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-menu-label-text">
- <title>gtk.Notebook.set_menu_label_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_menu_label_text</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">menu_text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a widget contained in a notebook
-page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">menu_text</parameter>&nbsp;:</term>
- <listitem><simpara>the new menu label text</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_menu_label_text</methodname>() method
-creates a new label widget and replaces the menu label of the page
-containing<parameter>child</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-menu-label-text">
- <title>gtk.Notebook.get_menu_label_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_menu_label_text</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a child widget of a notebook
-page.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>value: the text of the tab label, or
-<literal>None</literal> if the widget does not have a menu label other than
-the default menu label, or the menu label widget is not a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> or
-<parameter>child</parameter> is not contained in a notebook
-page.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_menu_label_text</methodname>() method
-retrieves the text of the menu label for the page containing
-<parameter>child</parameter>. If <parameter>child</parameter> is not in a
-notebook page or the menu label is not a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link> widget or
-the menu label has not been set (it default to the tab label), the return
-value is <literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--query-tab-label-packing">
- <title>gtk.Notebook.query_tab_label_packing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>query_tab_label_packing</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing: the expand value, the fill
-value and the pack type</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>query_tab_label_packing</methodname>() method
-returns a tuple containing the packing attributes (expand, fill, pack type)
-for the tab label of the page containing <parameter>child</parameter>. If
-the expand attribute is <literal>True</literal> the tab can expand to take
-up the free space in the tab area. If fill is <literal>True</literal> the
-label widget in the tab can use up all the space in the tab. The pack type
-can be one of <literal>gtk.PACK_START</literal> or
-<literal>gtk.PACK_END</literal> to specify whether the tab is packed to the
-left or right if tabs are on the top or bottom edge (top or bottom if the
-tabs are on the left or right edge).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-tab-label-packing">
- <title>gtk.Notebook.set_tab_label_packing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tab_label_packing</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pack_type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a widget contained in a notebook
-page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the tab can expand
-to fill the free space in the tab area</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the label widget can
-fill the space in the tab</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">pack_type</parameter>&nbsp;:</term>
- <listitem><simpara>the position of the tab:
-<literal>gtk.PACK_START</literal> or
-<literal>gtk.PACK_END</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_tab_label_packing</methodname>() method sets
-the packing parameters for the tab label of the page containing
-<parameter>child</parameter>. If <parameter>expand</parameter> is
-<literal>True</literal> the tab can expand to take up the free space in the
-tab area. If <parameter>fill</parameter> is <literal>True</literal> the
-label widget in the tab can use up all the space in the tab. The
-<parameter>pack_type</parameter> can be one of
-<literal>gtk.PACK_START</literal> or <literal>gtk.PACK_END</literal> to
-specify whether the tab is packed to the left or right if tabs are on the
-top or bottom edge (top or bottom if the tabs are on the left or right
-edge).See <link
-linkend="method-gtkbox--pack-start"><methodname>gtk.Box.pack_start</methodname>()</link>
-for the exact meaning of the parameters.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--reorder-child">
- <title>gtk.Notebook.reorder_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reorder_child</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the child widget to move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the page that
-<parameter>child</parameter> is to move to, or -1 to move to the
-end</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>reorder_child</methodname>() method reorders
-the notebook pages so that <parameter>child</parameter> appears in the page
-whose index is specified by <parameter>position</parameter>. If
-<parameter>position</parameter> is greater than or equal to the number of
-children in the list or negative, <parameter>child</parameter> will be moved
-to the end of the list.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-group-id">
- <title>gtk.Notebook.set_group_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_group_id</methodname>
- <methodparam><parameter role="keyword">group_id</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">group_id</parameter>&nbsp;:</term>
- <listitem><simpara>a group identifier, or -1 to unset
- it</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_group_id</methodname>() method sets the
- group identifier for the notebook to the value specified by
- <parameter>group_id</parameter>. Notebooks sharing the same group
- identifier will be able to exchange tabs via drag and drop. A notebook
- with group identifier -1 will not be able to exchange tabs with any
- other notebook.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-group-id">
- <title>gtk.Notebook.get_group_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_group_id</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the group identifier, or -1 if none is
- set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_group_id</methodname>() method returns the
- current group identifier for the notebook.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-tab-reorderable">
- <title>gtk.Notebook.get_tab_reorderable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tab_reorderable</methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a child <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the tab is
- reorderable.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_tab_reorderable</methodname>() method
- returns <literal>True</literal> if the tab can be reordered via drag
- and drop.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-tab-reorderable">
- <title>gtk.Notebook.set_tab_reorderable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tab_reorderable</methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- <methodparam><parameter role="keyword">reorderable</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a child <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">reorderable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the tab is
- reorderable.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_tab_reorderable</methodname>() method sets
- the "reorderable" property of <parameter>child</parameter> to the
- value of <parameter>reorderable</parameter>. If
- <parameter>reorderable</parameter> is <literal>True</literal>, the
- notebook tab can be reordered via drag and drop.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--get-tab-detachable">
- <title>gtk.Notebook.get_tab_detachable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tab_detachable</methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a child <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the tab is
- detachable.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_tab_detachable</methodname>() method returns
- the value of the "detachable" property of
- <parameter>child</parameter>. The method returns
- <parameter>True</parameter> if the tab contents can be detached from
- <parameter>notebook</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtknotebook--set-tab-detachable">
- <title>gtk.Notebook.set_tab_detachable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tab_detachable</methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- <methodparam><parameter role="keyword">detachable</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a child <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detachable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the tab is
- detachable or not</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_tab_detachable</methodname>() method sets
- the "detachable" property of <parameter>child</parameter> to the value
- specified by <parameter>detachable</parameter>. If
- <parameter>detachable</parameter> is <literal>True</literal>,
- <parameter>child</parameter> can be moved from this notebook to
- another notebook or widget.</para>
-
- <para>Note that two notebooks must share a common group identifier
- (see the <link
- linkend="method-gtknotebook--set-group-id"><methodname>set_group_id</methodname>()</link>
- method) to allow automatic tabs interchange between them.</para>
-
- <para>If you want a widget to interact with a notebook through DnD
- (i.e.: accept dragged tabs from it) it must be set as a drop
- destination and accept the target "gtk.NOTEBOOK_TAB". The notebook
- will fill the selection with a reference to the child
- widget that corresponds to the dropped tab.</para>
-
- <para>If you want a notebook to accept drags from other widgets, you
- will have to set your own DnD code to do it.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtknotebook--change-current-page">
- <title>The "change-current-page" gtk.Notebook Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter></methodparam>
- <methodparam><parameter>offset</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>notebook</parameter>&nbsp;:</term>
- <listitem><simpara>the notebook that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>offset</parameter>&nbsp;:</term>
- <listitem><simpara>the count of pages to move (negative count is
-backward)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "change-current-page" signal is emitted when the page
-forward or page backward request is issued.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtknotebook--focus-tab">
- <title>The "focus-tab" gtk.Notebook Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter></methodparam>
- <methodparam><parameter>type</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>notebook</parameter>&nbsp;:</term>
- <listitem><simpara>the notebook that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of tab:
-<literal>gtk.NOTEBOOK_TAB_FIRST</literal> or
-<literal>gtk.NOTEBOOK_TAB_LAST</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
-handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "focus-tab" signal is emitted when the focus is changed by
-tabbing.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtknotebook--move-focus-out">
- <title>The "move-focus-out" gtk.Notebook Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter></methodparam>
- <methodparam><parameter>direction_type</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>notebook</parameter>&nbsp;:</term>
- <listitem><simpara>the notebook that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>direction_type</parameter>&nbsp;:</term>
- <listitem><simpara>the direction type of the focus move:
-<literal>gtk.DIR_TAB_FORWARD</literal>,
-<literal>gtk.DIR_TAB_BACKWARD</literal>, <literal>gtk.DIR_UP</literal>,
-<literal>gtk.DIR_DOWN</literal>, <literal>gtk.DIR_LEFT</literal> or
-<literal>gtk.DIR_RIGHT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-focus-out" signal is emitted when the focus is moved
-out of the notebook with the specified
-<parameter>direction_type</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtknotebook--page-added">
- <title>The "page-added" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter></methodparam>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>page_num</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>notebook</parameter>&nbsp;:</term>
- <listitem><simpara>the notebook that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>child</parameter>&nbsp;:</term>
- <listitem><simpara>the child <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
- affected</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>page_num</parameter>&nbsp;:</term>
- <listitem><simpara>the new page number for
- <parameter>child</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The "page-added" signal is emitted when a page is added to the
- notebook.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtknotebook--page-removed">
- <title>The "page-removed" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter></methodparam>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>page_num</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>notebook</parameter>&nbsp;:</term>
- <listitem><simpara>the notebook that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>child</parameter>&nbsp;:</term>
- <listitem><simpara>the child <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
- affected</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>page_num</parameter>&nbsp;:</term>
- <listitem><simpara>the new page number for
- <parameter>child</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The "page-removed" signal is emitted after a page is removed
- from the notebook.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtknotebook--page-reordered">
- <title>The "page-reordered" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter></methodparam>
- <methodparam><parameter>child</parameter></methodparam>
- <methodparam><parameter>page_num</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>notebook</parameter>&nbsp;:</term>
- <listitem><simpara>the notebook that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>child</parameter>&nbsp;:</term>
- <listitem><simpara>the child <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
- affected</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>page_num</parameter>&nbsp;:</term>
- <listitem><simpara>the new page number for
- <parameter>child</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The "page-reordered" signal is emitted when a page has been
- reordered.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtknotebook--select-page">
- <title>The "select-page" gtk.Notebook Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter></methodparam>
- <methodparam><parameter>move_focus</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>notebook</parameter>&nbsp;:</term>
- <listitem><simpara>the notebook that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>move_focus</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> move the
-focus to a child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
-handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "select-page" signal is emitted when a new child page is
-selected.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtknotebook--switch-page">
- <title>The "switch-page" gtk.Notebook Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>notebook</parameter></methodparam>
- <methodparam><parameter>page</parameter></methodparam>
- <methodparam><parameter>page_num</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>notebook</parameter>&nbsp;:</term>
- <listitem><simpara>the notebook that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>page</parameter>&nbsp;:</term>
- <listitem><simpara>the new current page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>page_num</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the new current
-page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "switch-page" signal is emitted when the notebook page is
-changed. Note the <parameter>page</parameter> parameter is a GPointer and
-not usable within PyGTK. Use the <parameter>page_num</parameter> parameter
-to retrieve the new current page using the <link
-linkend="method-gtknotebook--get-nth-page"><methodname>get_nth_page</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkobject.xml b/docs/reference/pygtk-gtkobject.xml
deleted file mode 100644
index fc225137..00000000
--- a/docs/reference/pygtk-gtkobject.xml
+++ /dev/null
@@ -1,673 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkobject">
- <refnamediv>
- <refname>gtk.Object</refname>
- <refpurpose>the base class of the PyGTK type hierarchy.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Object</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkobject--flags">flags</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkobject--set-flags">set_flags</link></methodname>
- <methodparam><parameter>flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkobject--unset-flags">unset_flags</link></methodname>
- <methodparam><parameter>flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkobject--destroy">destroy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--bindings-activate">gtk.bindings_activate</link></methodname>
- <methodparam><parameter
- role="keyword">object</parameter></methodparam>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">modifiers</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--bindings-activate-event">gtk.bindings_activate_event</link></methodname>
- <methodparam><parameter
- role="keyword">object</parameter></methodparam>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--binding-entry-add-signal">gtk.binding_entry_add_signal</link></methodname>
- <methodparam><parameter>object</parameter></methodparam>
- <methodparam><parameter>keyval</parameter></methodparam>
- <methodparam><parameter>modifiers</parameter></methodparam>
- <methodparam><parameter>signal_name</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--binding-entry-remove">gtk.binding_entry_remove</link></methodname>
- <methodparam><parameter
- role="keyword">class_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">modifiers</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkobject">
- <title>gtk.Object Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"user-data"</entry>
- <entry>Read-Write</entry>
- <entry>Anonymous User Data Pointer</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkobject">
- <title>gtk.Object Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkobject--destroy">destroy</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>object</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> is the
-base class for all widgets, and for a few non-widget objects such as <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.
-<link linkend="class-gtkobject"><classname>gtk.Object</classname></link>
-predates <link
-linkend="class-gobject"><classname>GObject</classname></link>; non-widgets
-that derive from <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> rather
-than <link linkend="class-gobject"><classname>GObject</classname></link> do
-so for backward compatibility reasons.</para>
-
- <para>The "destroy" signal, emitted by the <link
-linkend="method-gtkobject--destroy"><methodname>destroy</methodname>()</link>
-method asks all code owning a GTK reference to the object to release its GTK
-reference. So, for example, if you call
-<methodname>window.destroy</methodname>() where
-<parameter>window</parameter> is a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>, GTK will
-release the GTK reference count that it owns; if you call
-<methodname>button.destroy</methodname>() where button is a <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link>,
-<parameter>button</parameter> will be removed from its parent container and
-the parent container will release its GTK reference to
-<parameter>button</parameter>. Because these GTK references are released,
-calling <link
-linkend="method-gtkobject--destroy"><methodname>destroy</methodname>()</link>
-should result in freeing all memory associated with an object (finalizing
-it) if the GTK reference count reaches zero. However, in PyGTK the GTK
-objects are wrapped in a Python object that has its own reference counting
-mechanism. The <link
-linkend="method-gtkobject--destroy"><methodname>destroy</methodname>()</link>
-method does not affect the Python reference counts. The GTK object
-associated with a Python object will not be released until the Python object
-reference count reaches zero. Therefore, calling the <link
-linkend="method-gtkobject--destroy"><methodname>destroy</methodname>()</link>
-method will not result in the finalization of the GTK object until the
-Python object is finalized. In the case mentioned above if a <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link> is
-destroyed using the <link
-linkend="method-gtkobject--destroy"><methodname>destroy</methodname>()</link>
-method, it will be removed from its container and unmapped and unrealized
-but it will not be finalized because the Python wrapper object will still
-exist and hold a reference.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkobject--flags">
- <title>gtk.Object.flags</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>flags</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the flags set for the
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>flags</methodname>() method returns the value of
-the flags for the object. The flags returned will include both the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> flags and
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-flags.</para>
-
- <para>The <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> flags
-are:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.IN_DESTRUCTION</literal></term>
- <listitem>
- <simpara>the object is currently being destroyed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FLOATING</literal></term>
- <listitem>
- <simpara>the object is orphaned.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RESERVED_1</literal></term>
- <listitem>
- <simpara>reserved for future use</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RESERVED_2</literal></term>
- <listitem>
- <simpara>reserved for future use</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> flags
-are:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TOPLEVEL</literal></term>
- <listitem>
- <simpara>widgets without a real parent (e.g. <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> and <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>) have this
-flag set throughout their lifetime. Toplevel widgets always contain their
-own <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.NO_WINDOW</literal></term>
- <listitem>
- <simpara>a widget that does not provide its own <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.
-Visible action (e.g. drawing) is performed on the parent's <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.REALIZED</literal></term>
- <listitem>
- <simpara>the widget has an associated <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MAPPED</literal></term>
- <listitem>
- <simpara>the widget can be displayed on the screen.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.VISIBLE</literal></term>
- <listitem>
- <simpara>the widget will be mapped as soon as its parent is
-mapped.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SENSITIVE</literal></term>
- <listitem>
- <simpara>The sensitivity of a widget determines whether it will
-receive certain events (e.g. button or key presses). One requirement for the
-widget's sensitivity is to have this flag set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.PARENT_SENSITIVE</literal></term>
- <listitem>
- <simpara>This is the second requirement for the widget's
-sensitivity. Once a widget has <literal>gtk.SENSITIVE</literal> and
-<literal>gtk.PARENT_SENSITIVE set</literal>, its state is effectively
-sensitive.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CAN_FOCUS</literal></term>
- <listitem>
- <simpara>the widget is able to handle focus grabs.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.HAS_FOCUS</literal></term>
- <listitem>
- <simpara>the widget has the focus - assumes that
-<literal>gtk.CAN_FOCUS</literal> is set</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.CAN_DEFAULT</literal></term>
- <listitem>
- <simpara>the widget is allowed to receive the default
-action.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.HAS_DEFAULT</literal></term>
- <listitem>
- <simpara>the widget currently will receive the default
-action.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.HAS_GRAB</literal></term>
- <listitem>
- <simpara>the widget is in the grab_widgets stack, and will be
-the preferred one for receiving events.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RC_STYLE</literal></term>
- <listitem>
- <simpara>the widgets style has been looked up through the RC
-mechanism. It does not imply that the widget actually had a style defined
-through the RC mechanism.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.COMPOSITE_CHILD</literal></term>
- <listitem>
- <simpara>the widget is a composite child of its
-parent.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.NO_REPARENT</literal></term>
- <listitem>
- <simpara>unused</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.APP_PAINTABLE</literal></term>
- <listitem>
- <simpara>set on widgets whose window the application directly
-draws on, in order to keep GTK from overwriting the drawn stuff.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.RECEIVES_DEFAULT</literal></term>
- <listitem>
- <simpara>the widget when focused will receive the default action
-and have <literal>gtk.HAS_DEFAULT</literal> set even if there is a different
-widget set as default.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.DOUBLE_BUFFERED</literal></term>
- <listitem>
- <simpara>exposes done on the widget should be
-double-buffered.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="method-gtkobject--set-flags">
- <title>gtk.Object.set_flags</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_flags</methodname>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> and <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> flags to
-be set on this object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_flags</methodname>() method sets the object
-flags according to the value of <parameter>flags</parameter>. See <link
-linkend="method-gtkobject--flags"><methodname>flags</methodname>()</link>
-for a description of the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> and <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> flags
-that can be set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkobject--unset-flags">
- <title>gtk.Object.unset_flags</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unset_flags</methodname>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> and <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> flags to
-be unset on this object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>unset_flags</methodname>() method unsets the
-object flags according to the value of <parameter>flags</parameter>. See
-<link
-linkend="method-gtkobject--flags"><methodname>flags</methodname>()</link>
-for a description of the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> and <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> flags
-that can be unset.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkobject--destroy">
- <title>gtk.Object.destroy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>destroy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>destroy</methodname>() method emits the
-"destroy" signal notifying all reference holders that they should release
-the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--bindings-activate">
- <title>gtk.bindings_activate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.bindings_activate</methodname>
- <methodparam><parameter
- role="keyword">object</parameter></methodparam>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">modifiers</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">object</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> to
-activate the bindings on</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>a key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">modifiers</parameter>&nbsp;:</term>
- <listitem><simpara>a modifier mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword"></parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the binding could be
-activated</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.bindings_activate</function>() function
-activates the bindings associated with the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> specified
-by object with the key value specified by <parameter>keyval</parameter> and
-the modifier mask specified by <parameter>modifiers</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--bindings-activate-event">
- <title>gtk.bindings_activate_event</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.bindings_activate_event</methodname>
- <methodparam><parameter
- role="keyword">object</parameter></methodparam>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">object</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> to
-activate the bindings on</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a matching key
- binding was found</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.bindings_activate_event</function>() function
-looks up key bindings for the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link> specified
-by <parameter>object</parameter> to find one matching the key <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
-specified by <parameter>event</parameter>, and if one was found, activate
-it.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--binding-entry-add-signal">
- <title>gtk.binding_entry_add_signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.binding_entry_add_signal</methodname>
- <methodparam><parameter>object</parameter></methodparam>
- <methodparam><parameter>keyval</parameter></methodparam>
- <methodparam><parameter>modifiers</parameter></methodparam>
- <methodparam><parameter>signal_name</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>object</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link>
-class the binding entry will be associated with</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>keyval</parameter>&nbsp;:</term>
- <listitem><simpara>the key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>modifiers</parameter>&nbsp;:</term>
- <listitem><simpara>the modifier mask</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>signal_name</parameter>&nbsp;:</term>
- <listitem><simpara>the signal name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>zero or more pairs of value type-value
-pairs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.binding_entry_add_signal</function>() function
-adds a binding (specified by <parameter>keyval</parameter> and
-<parameter>modifiers</parameter>) to the binding set of the object class
-derived from <parameter>object</parameter>. The signal specified by
-<parameter>signal_name</parameter> will be emitted with the optional
-arguments specified by the argument pairs denoted by ... that are value type
-and value. This function is used when creating a new widget class to set up
-key bindings.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--binding-entry-remove">
- <title>gtk.binding_entry_remove</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.binding_entry_remove</methodname>
- <methodparam><parameter
- role="keyword">class_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">modifiers</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">class_type</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkobject"><classname>gtk.Object</classname></link>
-class the binding entry will be removed from</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>the key value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">modifiers</parameter>&nbsp;:</term>
- <listitem><simpara>the modifier mask</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <function>gtk.binding_entry_remove</function>() function
-removes the binding (specified by <parameter>keyval</parameter> and
-<parameter>modifiers</parameter>) from the binding set of the object class
-specified by <parameter>class_type</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkobject--destroy">
- <title>The "destroy" gtk.Object Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>object</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>object</parameter>&nbsp;:</term>
- <listitem><simpara>the object that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "destroy" signal is emitted when the references for the
-object should be destroyed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkoptionmenu.xml b/docs/reference/pygtk-gtkoptionmenu.xml
deleted file mode 100644
index 6216015a..00000000
--- a/docs/reference/pygtk-gtkoptionmenu.xml
+++ /dev/null
@@ -1,370 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkoptionmenu">
- <refnamediv>
- <refname>gtk.OptionMenu</refname>
- <refpurpose>a widget used to provide a list of valid choices.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.OptionMenu</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbutton">gtk.Button</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkoptionmenu">gtk.OptionMenu</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkoptionmenu--get-menu">get_menu</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkoptionmenu--set-menu">set_menu</link></methodname>
- <methodparam><parameter
- role="keyword">menu</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkoptionmenu--remove-menu">remove_menu</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkoptionmenu--get-history">get_history</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkoptionmenu--set-history">set_history</link></methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkbutton">gtk.Button</link>
- +-- <link linkend="class-gtkoptionmenu">gtk.OptionMenu</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkoptionmenu">
- <title>gtk.OptionMenu Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"menu"</entry>
- <entry>Read-Write</entry>
- <entry>The menu of options.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkoptionmenu">
- <title>gtk.OptionMenu Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"indicator-size"</entry>
- <entry>Read</entry>
- <entry>The size of the dropdown indicator</entry>
- </row>
- <row valign="top">
- <entry>"indicator-spacing"</entry>
- <entry>Read</entry>
- <entry>The spacing around the indicator.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkoptionmenu">
- <title>gtk.OptionMenu Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkoptionmenu--changed">changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>optionmenu</parameter>
- </methodparam>
- <methodparam><parameter>user_param1</parameter>
- </methodparam>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <warning>
- <para><link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
-is deprecated in PyGTK 2.4; use the <link
-linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
-instead.</para>
- </warning>
-
- <para>A <link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
-is a widget allows the user to choose from a list of valid choices from an
-associated menu. The <link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
-displays the last selected choice. When activated (clicked) the <link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
-displays a popup <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> which allows
-the user to make a new choice. Using a <link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
-is simple:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>build a <link
-linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> using <link
-linkend="constructor-gtkmenu"><methodname>gtk.Menu</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara>then append menu items to it using <link
-linkend="method-gtkmenushell--append"><methodname>gtk.MenuShell.append</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara>associate the menu with the option menu using <link
-linkend="method-gtkoptionmenu--set-menu"><methodname>set_menu</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara>set the selected menu item with <link
-linkend="method-gtkoptionmenu--set-history"><methodname>set_history</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara>connect to the "changed" signal on the option menu; in the
-"changed" signal</simpara>
- </listitem>
- <listitem>
- <simpara>check the new selected menu item with <link
-linkend="method-gtkoptionmenu--get-history"><methodname>get_history</methodname>()</link>.</simpara>
- </listitem>
- </itemizedlist>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkoptionmenu">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.OptionMenu</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new optionmenu widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkoptionmenu--get-menu">
- <title>gtk.OptionMenu.get_menu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_menu</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a menu widget or <literal>None</literal> if no
-menu is associated</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_menu</methodname>() method returns the menu
-that is associated with the optionmenu or <literal>None</literal> if no menu
-is associated.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkoptionmenu--set-menu">
- <title>gtk.OptionMenu.set_menu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_menu</methodname>
- <methodparam><parameter
- role="keyword">menu</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">menu</parameter>&nbsp;:</term>
- <listitem><simpara>a menu to be associated with the
-optionmenu</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_menu</methodname>() method associates the
-<link linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> widget
-specified by <parameter>menu</parameter> with the optionmenu thus providing
-the way for a user to select a new choice. A simple menu, avoiding the use
-of tearoff menu items, submenus, and accelerators, should be used.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkoptionmenu--remove-menu">
- <title>gtk.OptionMenu.remove_menu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_menu</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>remove_menu</methodname>() method removes the
-currently associated menu from the optionmenu.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkoptionmenu--get-history">
- <title>gtk.OptionMenu.get_history</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_history</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the index of the selected menu item, or -1 if
-there are no menu items</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_history</methodname>() method returns the
-index of the currently selected menu item or -1 if there are no menu items.
-The menu items are numbered from top to bottom, starting with 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkoptionmenu--set-history">
- <title>gtk.OptionMenu.set_history</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_history</methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the menu item to display as the
-selected optionmenu choice</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_history</methodname>() method selects the
-menu item specified by <parameter>index</parameter> as the displayed
-optionmenu choice.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkoptionmenu--changed">
- <title>The "changed" gtk.OptionMenu Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>optionmenu</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>optionmenu</parameter>&nbsp;:</term>
- <listitem><simpara>the optionmenu that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "changed" signal is emitted when a new optionmenu choice is
-made.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkpagesetup.xml b/docs/reference/pygtk-gtkpagesetup.xml
deleted file mode 100644
index 682e5947..00000000
--- a/docs/reference/pygtk-gtkpagesetup.xml
+++ /dev/null
@@ -1,817 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkpagesetup">
-
- <refnamediv>
- <refname>gtk.PageSetup</refname>
- <refpurpose>an object that stores page setup information (new in PyGTK
- 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.PageSetup</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkpagesetup">gtk.PageSetup</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--copy">copy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--get-orientation">get_orientation</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--set-orientation">set_orientation</link></methodname>
- <methodparam><parameter role="keyword">orientation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--get-paper-size">get_paper_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--set-paper-size">set_paper_size</link></methodname>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--get-top-margin">get_top_margin</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--set-top-margin">set_top_margin</link></methodname>
- <methodparam><parameter role="keyword">margin</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--get-bottom-margin">get_bottom_margin</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--set-bottom-margin">set_bottom_margin</link></methodname>
- <methodparam><parameter role="keyword">margin</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--get-left-margin">get_left_margin</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--set-left-margin">set_left_margin</link></methodname>
- <methodparam><parameter role="keyword">margin</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--get-right-margin">get_right_margin</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--set-right-margin">set_right_margin</link></methodname>
- <methodparam><parameter role="keyword">margin</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--set-paper-size-and-default-margins">set_paper_size_and_default_margins</link></methodname>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--get-paper-width">get_paper_width</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--get-paper-height">get_paper_height</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--get-page-width">get_page_width</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetup--get-page-height">get_page_height</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--print-run-page-setup-dialog">gtk.print_run_page_setup_dialog</link></methodname>
- <methodparam><parameter role="keyword">parent</parameter></methodparam>
- <methodparam><parameter role="keyword">page_setup</parameter></methodparam>
- <methodparam><parameter role="keyword">settings</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkpagesetup">gtk.PageSetup</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkpagesetup">
- <title>gtk.PageSetup Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This class is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>A <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
- object stores the page size, orientation and margins. The idea is that
- you can get one of these from the page setup dialog and then pass it to
- the <link
- linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
- when printing. The benefit of splitting this out of the <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- is that these affect the actual layout of the page, and thus need to be
- set long before user prints.</para>
-
- <para>The margins specified in this object are the "print margins",
- i.e. the parts of the page that the printer cannot print on. These are
- different from the layout margins that a word processor uses; they are
- typically used to determine the minimal size for the layout
- margins.</para>
-
- <para>To obtain a <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
- use the <link
- linkend="constructor-gtkpagesetup">gtk.PageSetup()</link> constructor
- to get the defaults, or use the <link
- linkend="function-gtk--print-run-page-setup-dialog"><function>gtk.print_run_page_setup_dialog</function>()</link>
- function to show the page setup dialog and receive the resulting page
- setup. An example page setup function is:</para>
-
- <programlisting>
- def do_page_setup():
- if settings == None:
- settings = gtk.PrintSettings()
-
- page_setup = gtk.print_run_page_setup_dialog(main_window, page_setup,
- settings)
- </programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkpagesetup">
- <title>gtk.PageSetup</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.PageSetup</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkpagesetup--copy">
- <title>gtk.PageSetup.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of this page setup</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>copy</methodname>() method copies this <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--get-orientation">
- <title>gtk.PageSetup.get_orientation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_orientation</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the page orientation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_orientation</methodname>() method returns
- the page orientation of the <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>. The
- return value must be one of the <xref
- linkend="gtk-page-orientation-constants"
- endterm="gtk-page-orientation-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--set-orientation">
- <title>gtk.PageSetup.set_orientation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_orientation</methodname>
- <methodparam><parameter role="keyword">orientation</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">orientation</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="gtk-page-orientation-constants"
- endterm="gtk-page-orientation-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_orientation</methodname>() method sets the
- page orientation of the <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
- to the value specified by <parameter>orientation</parameter>. The
- value of <parameter>orientation</parameter> must be one of the <xref
- linkend="gtk-page-orientation-constants"
- endterm="gtk-page-orientation-constants-title"></xref></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--get-paper-size">
- <title>gtk.PageSetup.get_paper_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_paper_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the paper size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_paper_size</methodname>() method gets the
- paper size of the <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--set-paper-size">
- <title>gtk.PageSetup.set_paper_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_paper_size</methodname>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_paper_size</methodname>() method sets the
- paper size of the page setup without changing the margins. See the
- <link
- linkend="method-gtkpagesetup--set-paper-size-and-default-margins"><methodname>set_paper_size_and_default_margins</methodname>()</link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--get-top-margin">
- <title>gtk.PageSetup.get_top_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_top_margin</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value - one of the
- <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the top margin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_top_margin</methodname>() method returns the
- top margin in units of <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--set-top-margin">
- <title>gtk.PageSetup.set_top_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_top_margin</methodname>
- <methodparam><parameter role="keyword">margin</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">margin</parameter>&nbsp;:</term>
- <listitem><simpara>the new top margin in units of
- <parameter>unit</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the units for <parameter>margin</parameter> -
- one of the <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_top_margin</methodname>() method sets the
- top margin of the page setup to the value specified by
- <parameter>margin</parameter> in the units specified by
- <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--get-bottom-margin">
- <title>gtk.PageSetup.get_bottom_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_bottom_margin</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return
- value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the bottom margin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_bottom_margin</methodname>() method gets the
- bottom margin in units of <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--set-bottom-margin">
- <title>gtk.PageSetup.set_bottom_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_bottom_margin</methodname>
- <methodparam><parameter role="keyword">margin</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">margin</parameter>&nbsp;:</term>
- <listitem><simpara>the new bottom margin in units of
- <parameter>unit</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the units for <parameter>margin</parameter> -
- one of the <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_bottom_margin</methodname>() method sets the
- bottom margin of the page setup to the value specified by
- <parameter>margin</parameter> using the units specified by
- <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--get-left-margin">
- <title>gtk.PageSetup.get_left_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_left_margin</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return
- value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the left margin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_left_margin</methodname>() method gets the
- left margin in units of <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--set-left-margin">
- <title>gtk.PageSetup.set_left_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_left_margin</methodname>
- <methodparam><parameter role="keyword">margin</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">margin</parameter>&nbsp;:</term>
- <listitem><simpara>the new left margin in units of
- <parameter>unit</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the units for <parameter>margin</parameter> -
- one of the <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_left_margin</methodname>() method sets the
- left margin of the page setup to the value specified by
- <parameter>margin</parameter> using the units specified by
- <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--get-right-margin">
- <title>gtk.PageSetup.get_right_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_right_margin</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value</simpara> - one
- of the <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the right margin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_right_margin</methodname>() method gets the
- right margin in units of <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--set-right-margin">
- <title>gtk.PageSetup.set_right_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_right_margin</methodname>
- <methodparam><parameter role="keyword">margin</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">margin</parameter>&nbsp;:</term>
- <listitem><simpara>the new right margin in units of
- <parameter>unit</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the units for <parameter>margin</parameter> -
- one of the <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_right_margin</methodname>() method sets the
- right margin of the page setup to the value specified by
- <parameter>margin</parameter> using the units specified by
- <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--set-paper-size-and-default-margins">
- <title>gtk.PageSetup.set_paper_size_and_default_margins</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_paper_size_and_default_margins</methodname>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The
- <methodname>set_paper_size_and_default_margins</methodname>() method
- sets the paper size of the page setup to the value specified by
- <parameter>size</parameter> and modifies the margins according to the
- new paper size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--get-paper-width">
- <title>gtk.PageSetup.get_paper_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_paper_width</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value - one of the
- <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the paper width.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_paper_width</methodname>() method returns
- the paper width in units of <parameter>unit</parameter>.</para>
-
- <para>Note that this function takes orientation, but not margins into
- consideration. See the <link
- linkend="method-gtkpagesetup--get-page-width"><methodname>get_page_width()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--get-paper-height">
- <title>gtk.PageSetup.get_paper_height</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_paper_height</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value - one of the
- <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the paper height.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_paper_height</methodname>() method returns
- the paper height in units of <parameter>unit</parameter>.</para>
-
- <para>Note that this function takes orientation, but not margins into
- consideration. See the <link
- linkend="method-gtkpagesetup--get-page-height"><methodname>get_page_height()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--get-page-width">
- <title>gtk.PageSetup.get_page_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_width</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value - one of the
- <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the page width.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_page_width</methodname>() method returns the
- page width in units of <parameter>unit</parameter>.</para>
-
- <para>Note that this function takes orientation and margins into
- consideration. See the <link
- linkend="method-gtkpagesetup--get-paper-width"><methodname>get_paper_width()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetup--get-page-height">
- <title>gtk.PageSetup.get_page_height</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_height</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value - one of the
- <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the page height.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_page_height</methodname>() method returns
- the page height in units of <parameter>unit</parameter>.</para>
-
- <para>Note that this function takes orientation and margins into
- consideration. See the <link
- linkend="method-gtkpagesetup--get-paper-height"><methodname>get_paper_height()</methodname></link>
- method.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--print-run-page-setup-dialog">
- <title>gtk.print_run_page_setup_dialog</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.print_run_page_setup_dialog</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter
- role="keyword">page_setup</parameter></methodparam>
- <methodparam><parameter
- role="keyword">settings</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>transient parent, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">page_setup</parameter>&nbsp;:</term>
- <listitem><simpara>an existing <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>,
- or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">settings</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Runs a page setup dialog, letting the user modify the values
- from page_setup. If the user cancels the dialog, the returned <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
- is identical to the passed in page_setup, otherwise it contains the
- modifications done in the dialog.</para>
-
- <para>Note that this function may use a recursive mainloop to show the
- page setup dialog.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkpagesetupunixdialog.xml b/docs/reference/pygtk-gtkpagesetupunixdialog.xml
deleted file mode 100644
index 793d5fd4..00000000
--- a/docs/reference/pygtk-gtkpagesetupunixdialog.xml
+++ /dev/null
@@ -1,260 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkpagesetupunixdialog">
-
- <refnamediv>
- <refname>gtkunixprint.PageSetupUnixDialog</refname>
- <refpurpose>a dialog for setting up a printer page on Unix (new in
- PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtkunixprint.PageSetupUnixDialog</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkpagesetupunixdialog">gtkunixprint.PageSetupUnixDialog</link></methodname>
- <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetupunixdialog--set-page-setup">set_page_setup</link></methodname>
- <methodparam><parameter role="keyword">page_setup</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetupunixdialog--get-page-setup">get_page_setup</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetupunixdialog--set-print-settings">set_print_settings</link></methodname>
- <methodparam><parameter role="keyword">print_settings</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpagesetupunixdialog--get-print-settings">get_print_settings</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
- +-- <link linkend="class-gtkpagesetupunixdialog">gtkunixprint.PageSetupUnixDialog</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkpagesetupunixdialog">
- <title>gtkunixprint.PageSetupUnixDialog Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
- <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkpagesetupunixdialog">
- <title>gtkunixprint.PageSetupUnixDialog Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkpagesetupunixdialog">
- <title>gtkunixprint.PageSetupUnixDialog Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This class is available for Unix systems in PyGTK 2.10 and
- above.</para>
- </note>
-
- <para>The <link
- linkend="class-gtkpagesetupunixdialog"><classname>gtkunixprint.PageSetupUnixDialog</classname></link>
- object implements a page setup dialog for platforms, like Unix, that
- don't provide a native page setup dialog. It can be used very much like
- any other PyGTK dialog, at the cost of the portability offered by the
- high-level printing API.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkpagesetupunixdialog">
- <title>gtkunixprint.PageSetupUnixDialog</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtkunixprint.PageSetupUnixDialog</methodname>
- <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>the title of the dialog, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>the transient parent of the dialog, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
- linkend="class-gtkpagesetupunixdialog"><classname>gtkunixprint.PageSetupUnixDialog</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new page setup dialog with the optional title
- specified by <parameter>title</parameter> and optionally using the
- <link
- linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
- specified by <parameter>parent</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkpagesetupunixdialog--set-page-setup">
- <title>gtkunixprint.PageSetupUnixDialog.set_page_setup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_page_setup</methodname>
- <methodparam><parameter role="keyword">page_setup</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_setup</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_page_setup</methodname>() method uses the
- <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
- specified by <parameter>page_setup</parameter> to set the page setup
- values for the dialog.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetupunixdialog--get-page-setup">
- <title>gtkunixprint.PageSetupUnixDialog.get_page_setup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_setup</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current page setup</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_page_setup</methodname>() method returns the
- current page setup values from the dialog as a <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetupunixdialog--set-print-settings">
- <title>gtkunixprint.PageSetupUnixDialog.set_print_settings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_print_settings</methodname>
- <methodparam><parameter role="keyword">print_settings</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">print_settings</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_print_settings</methodname>() method
- installs the <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- specified by print_settings as the print settings for the
- dialog.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpagesetupunixdialog--get-print-settings">
- <title>gtkunixprint.PageSetupUnixDialog.get_print_settings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_print_settings</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current print settings</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_print_settings</methodname>() method returns
- the current print settings from the dialog.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkpaned.xml b/docs/reference/pygtk-gtkpaned.xml
deleted file mode 100644
index d5076860..00000000
--- a/docs/reference/pygtk-gtkpaned.xml
+++ /dev/null
@@ -1,970 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkpaned">
- <refnamediv>
- <refname>gtk.Paned</refname>
- <refpurpose>a base class for widgets with two adjustable
-panes</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Paned</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkpaned--add1">add1</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkpaned--add2">add2</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkpaned--pack1">pack1</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">resize</parameter><initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">shrink</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkpaned--pack2">pack2</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">resize</parameter><initializer>True</initializer></methodparam>
- <methodparam><parameter
- role="keyword">shrink</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkpaned--get-position">get_position</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkpaned--set-position">set_position</link></methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkpaned--compute-position">compute_position</link></methodname>
- <methodparam><parameter
- role="keyword">allocation</parameter></methodparam>
- <methodparam><parameter
- role="keyword">child1_req</parameter></methodparam>
- <methodparam><parameter
- role="keyword">child2_req</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpaned--get-child1">get_child1</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpaned--get-child2">get_child2</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkpaned">gtk.Paned</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkpaned">
- <title>gtk.Paned Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"max-position"</entry>
- <entry>Read-Write</entry>
- <entry>The largest possible value for the position property.
-This property is derived from the size and shrinkability of the widget's
-children. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"min-position"</entry>
- <entry>Read-Write</entry>
- <entry>The smallest possible value for the position property.
-This property is derived from the size and shrinkability of the widget's
-children. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"position"</entry>
- <entry>Read-Write</entry>
- <entry>The position of the paned separator in pixels (0 means
-all the way to the left or top).</entry>
- </row>
-
- <row valign="top">
- <entry>"position-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the "position" property is
-valid.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkpaned">
- <title>gtk.Paned Child Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"resize"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the child expands and
-shrinks along with the paned widget. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"shrink"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the child can be made
-smaller than its requisition. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkpaned">
- <title>gtk.Paned Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"handle-size"</entry>
- <entry>Read</entry>
- <entry>The width of the handle</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkpaned">
- <title>gtk.Paned Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkpaned--accept-position">accept-position</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>"<link
-linkend="signal-gtkpaned--cancel-position">cancel-position</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>"<link
-linkend="signal-gtkpaned--cycle-child-focus">cycle-child-focus</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>reversed</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>"<link
-linkend="signal-gtkpaned--cycle-handle-focus">cycle-handle-focus</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>reversed</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>"<link
-linkend="signal-gtkpaned--move-handle">move-handle</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>scrolltype</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>"<link
-linkend="signal-gtkpaned--toggle-handle-focus">toggle-handle-focus</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
-
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
-linkend="class-gtkpaned"><classname>gtk.Paned</classname></link> is the base
-class for widgets with two panes, arranged either horizontally (<link
-linkend="class-gtkhpaned"><classname>gtk.HPaned</classname></link>) or
-vertically (<link
-linkend="class-gtkvpaned"><classname>gtk.VPaned</classname></link>). Child
-widgets are added to the panes of the widget with the <link
-linkend="method-gtkpaned--pack1"><methodname>pack1</methodname>()</link> and
-<link
-linkend="method-gtkpaned--pack2"><methodname>pack2</methodname>()</link>
-methods. The division between the two children is set by default from the
-size requests of the children, but it can be adjusted by the user.</para>
-
- <para>A paned widget draws a separator between the two child widgets and
-a small handle that the user can drag to adjust the division. It does not
-draw any relief around the children or around the separator. (The space in
-which the separator located is called the gutter.) Often, it is useful to
-put each child inside a <link
-linkend="class-gtkframe"><classname>gtk.Frame</classname></link> with the
-shadow type set to <literal>gtk.SHADOW_IN</literal> so that the gutter
-appears as a ridge.</para>
-
- <para>Each child has two options that can be set, resize and shrink. If
-resize is <literal>True</literal>, when the <link
-linkend="class-gtkpaned"><classname>gtk.Paned</classname></link> is resized,
-that child will expand or shrink along with the paned widget. If shrink is
-<literal>True</literal>, the child can be made smaller than it's
-requisition. Setting shrink to <literal>False</literal> allows the
-application to set a minimum size. If resize is <literal>False</literal> for
-both children, the resizing behaves as if resize is <literal>True</literal>
-for both children. The application can set the position of the slider by
-calling the <link
-linkend="method-gtkpaned--set-position"><methodname>set_position</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkpaned--add1">
- <title>gtk.Paned.add1</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add1</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to add</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add1</methodname>() method adds the widget
-specified by <parameter>child</parameter> to the top or left pane with the
-default packing parameters (resize is <literal>False</literal> and shrink is
-<literal>True</literal>). See the <link
-linkend="method-gtkpaned--pack1"><methodname>pack1</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpaned--add2">
- <title>gtk.Paned.add2</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add2</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to add</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add2</methodname>() method adds the widget
-specified by <parameter>child</parameter> to the bottom or right pane with
-the default packing parameters (resize is <literal>True</literal> and shrink
-is <literal>True</literal>). See the <link
-linkend="method-gtkpaned--pack2"><methodname>pack2</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpaned--pack1">
- <title>gtk.Paned.pack1</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pack1</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">resize</parameter><initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">shrink</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to add</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">resize</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>
-<parameter>child</parameter> should resize when the paned is
-resized</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">shrink</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>
-<parameter>child</parameter> can be made smaller than its
-minimum size request</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>pack1</methodname>() method adds the widget
-specified by <parameter>child</parameter> to the top or left pane with the
-parameters specified by <parameter>resize</parameter> and
-<parameter>shrink</parameter>. If <parameter>resize</parameter> is
-<literal>True</literal> <parameter>child</parameter> should be resized when
-the paned widget is resized. If <parameter>shrink</parameter> is
-<literal>True</literal> <parameter>child</parameter> can be made smaller
-than its minimum size request.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpaned--pack2">
- <title>gtk.Paned.pack2</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pack2</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">resize</parameter><initializer>True</initializer></methodparam>
- <methodparam><parameter
- role="keyword">shrink</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to add</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">resize</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>
-<parameter>child</parameter> should resize when the paned is
-resized</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">shrink</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>
-<parameter>child</parameter> can be made smaller than its
-minimum size request</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>pack2</methodname>() method adds the widget
-specified by <parameter>child</parameter> to the bottom or right pane with
-the parameters specified by <parameter>resize</parameter> and
-<parameter>shrink</parameter>. If <parameter>resize</parameter> is
-<literal>True</literal> <parameter>child</parameter> should be resized when
-the paned widget is resized. If <parameter>shrink</parameter> is
-<literal>True</literal> <parameter>child</parameter> can be made smaller
-than its minimum size request.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpaned--get-position">
- <title>gtk.Paned.get_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_position</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the position of the divider</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_position</methodname>() method returns the
-position of the divider in pixels between the two panes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpaned--set-position">
- <title>gtk.Paned.set_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_position</methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the new pixel position of divider, a negative
-value means that the position is unset.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_position</methodname>() method sets the
-position of the divider between the two panes to the value specified by
-<parameter>position</parameter> and sets the "position-set" property to
-<literal>True</literal> if <parameter>position</parameter> is non-negative.
-If <parameter>position</parameter> is negative the divider position will be
-recalculated by the paned widget using the child widget requisitions and the
-"position-set" property will be set to <literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpaned--compute-position">
- <title>gtk.Paned.compute_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>compute_position</methodname>
- <methodparam><parameter
- role="keyword">allocation</parameter></methodparam>
- <methodparam><parameter
- role="keyword">child1_req</parameter></methodparam>
- <methodparam><parameter
- role="keyword">child2_req</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">allocation</parameter>&nbsp;:</term>
- <listitem><simpara>the total space allocation in pixels for the
-paned widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">child1_req</parameter>&nbsp;:</term>
- <listitem><simpara>the minimum space in pixels required for the
-left or top child widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">child2_req</parameter>&nbsp;:</term>
- <listitem><simpara>the minimum space in pixels required for the
-right or bottom child widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>compute_position</methodname>() method computes
-the position of the separator according to the specification of the
-parameters: <parameter>allocation</parameter>,
-<parameter>child1_req</parameter> and <parameter>child2_req</parameter>. The
-calculation is affected by the packing parameters of the child widgets
-depending on whether they can resize and shrink. This method is used by
-subclasses of <link
-linkend="class-gtkpaned"><classname>gtk.Paned</classname></link> and is
-usually not needed by applications. the <link
-linkend="method-gtkwidget--queue-resize"><methodname>gtk.Widget.queue_resize</methodname>()</link>
-method must be called after this method to have the resizing
-displayed.</para>
-
- <para>The minimum position is 0 if child1's shrink value is
-<literal>True</literal> or the value of <parameter>child1_req</parameter>,
-if <literal>False</literal>. The maximum position is the value of
-<parameter>allocation</parameter> if child2's shrink value is True, or the
-value of (<parameter>allocation</parameter> -
-<parameter>child2_req</parameter>), if <literal>False</literal>. The final
-calculated position will be between the minimum and maximum
-positions.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpaned--get-child1">
- <title>gtk.Paned.get_child1</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_child1</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the first child, or<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_child1</methodname>() method returns the
-first child of the paned widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpaned--get-child2">
- <title>gtk.Paned.get_child2</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_child2</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the second child, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_child2</methodname>() method returns
-the second child of the paned widget.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkpaned--accept-position">
- <title>The "accept-position" gtk.Paned Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>paned</parameter>&nbsp;:</term>
- <listitem><simpara>the paned that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
-handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "accept-position" signal is emitted when
-<parameter>paned</parameter> has the focus and any of the
-<keycap>Return</keycap>, <keycap>Enter</keycap>, <keycap>Space</keycap> keys
-are pressed. This will also cause the child widget with the focus to be
-activated.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkpaned--cancel-position">
- <title>The "cancel-position" gtk.Paned Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>paned</parameter>&nbsp;:</term>
- <listitem><simpara>the paned that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
-handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "cancel-position" signal is emitted when the
-<keycap>Esc</keycap> key is pressed while <parameter>paned</parameter> has
-the focus.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkpaned--cycle-child-focus">
- <title>The "cycle-child-focus" gtk.Paned Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>reversed</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>paned</parameter>&nbsp;:</term>
- <listitem><simpara>the paned that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>reversed</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the focus cycle
-direction should be reversed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
-handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "cycle-child-focus" signal is emitted when
-<keycap>F6</keycap> or <keycombo
-action="simul"><keycap>Shift</keycap><keycap>F6</keycap> </keycombo> is
-pressed while <parameter>paned</parameter> has the focus.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkpaned--cycle-handle-focus">
- <title>The "cycle-handle-focus" gtk.Paned Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>reversed</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>paned</parameter>&nbsp;:</term>
- <listitem><simpara>the paned that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>reversed</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the focus cycle
-direction should be reversed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
-handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "cycle-handle-focus" signal is emitted when
-<parameter>paned</parameter> has the focus and any of the
-<keycap>Tab</keycap>,
-<keycombo action="simul"><keycap>Ctrl</keycap><keycap>Tab</keycap>
- </keycombo>, <keycombo action="simul"><keycap>Shift</keycap><keycap>Tab</keycap>
- </keycombo> or
-<keycombo action="simul"><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>Tab</keycap>
- </keycombo> keys combinations are pressed. <keycap>Tab</keycap> and
-<keycombo action="simul"><keycap>Ctrl</keycap><keycap>Tab</keycap>
- </keycombo> set <parameter>reversed</parameter> to
-<literal>False</literal> while
-<keycombo action="simul"><keycap>Shift</keycap><keycap>Tab</keycap>
- </keycombo> and <keycombo action="simul"><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>Tab</keycap>
- </keycombo> set <parameter>reversed</parameter> to
-<literal>True</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkpaned--move-handle">
- <title>The "move-handle" gtk.Paned Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>scrolltype</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>paned</parameter>&nbsp;:</term>
- <listitem><simpara>the paned that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>scrolltype</parameter>&nbsp;:</term>
- <listitem><simpara>the scroll type:
-<literal>gtk.SCROLL_NONE</literal>, <literal>gtk.SCROLL_JUMP</literal>,
-<literal>gtk.SCROLL_STEP_BACKWARD</literal>,
-<literal>gtk.SCROLL_STEP_FORWARD</literal>,
-<literal>gtk.SCROLL_PAGE_BACKWARD</literal>,
-<literal>gtk.SCROLL_PAGE_FORWARD</literal>,
-<literal>gtk.SCROLL_STEP_UP</literal>,
-<literal>gtk.SCROLL_STEP_DOWN</literal>,
-<literal>gtk.SCROLL_PAGE_UP</literal>,
-<literal>gtk.SCROLL_PAGE_DOWN</literal>,
-<literal>gtk.SCROLL_STEP_LEFT</literal>,
-<literal>gtk.SCROLL_STEP_RIGHT</literal>,
-<literal>gtk.SCROLL_PAGE_LEFT</literal>,
-<literal>gtk.SCROLL_PAGE_RIGHT</literal>,
-<literal>gtk.SCROLL_START</literal> or
-<literal>gtk.SCROLL_END</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
-handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-handle" signal is emitted when
-<parameter>paned</parameter> has the focus and one of the following key
-combinations is pressed to move the separator:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><keycombo><keycap>Left
-Arrow</keycap></keycombo></simpara>
- </listitem>
- <listitem>
- <simpara><keycombo><keycap>Right
-Arrow</keycap></keycombo></simpara>
- </listitem>
- <listitem>
- <simpara><keycombo><keycap>Up Arrow</keycap></keycombo></simpara>
- </listitem>
- <listitem>
- <simpara><keycombo><keycap>Down
-Arrow</keycap></keycombo></simpara>
- </listitem>
- <listitem>
- <simpara><keycombo><keycap>Page Up</keycap></keycombo></simpara>
- </listitem>
- <listitem>
- <simpara><keycombo><keycap>Page Down</keycap></keycombo></simpara>
- </listitem>
- <listitem>
- <simpara><keycombo><keycap>Home</keycap></keycombo></simpara>
- </listitem>
- <listitem>
- <simpara><keycombo><keycap>End</keycap></keycombo></simpara>
- </listitem>
- </itemizedlist>
-
- <para>The value of <parameter>scrolltype</parameter> is one of:
-<literal>gtk.SCROLL_NONE</literal>, <literal>gtk.SCROLL_JUMP</literal>,
-<literal>gtk.SCROLL_STEP_BACKWARD</literal>,
-<literal>gtk.SCROLL_STEP_FORWARD</literal>,
-<literal>gtk.SCROLL_PAGE_BACKWARD</literal>,
-<literal>gtk.SCROLL_PAGE_FORWARD</literal>,
-<literal>gtk.SCROLL_STEP_UP</literal>,
-<literal>gtk.SCROLL_STEP_DOWN</literal>,
-<literal>gtk.SCROLL_PAGE_UP</literal>,
-<literal>gtk.SCROLL_PAGE_DOWN</literal>,
-<literal>gtk.SCROLL_STEP_LEFT</literal>,
-<literal>gtk.SCROLL_STEP_RIGHT</literal>,
-<literal>gtk.SCROLL_PAGE_LEFT</literal>,
-<literal>gtk.SCROLL_PAGE_RIGHT</literal>,
-<literal>gtk.SCROLL_START</literal> or <literal>gtk.SCROLL_END</literal>.
-The default handler for this signal moves the separator if the separator has
-the focus.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkpaned--toggle-handle-focus">
- <title>The "toggle-handle-focus" gtk.Paned Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>paned</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>paned</parameter>&nbsp;:</term>
- <listitem><simpara>the paned that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
-handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "toggle-handle-focus" signal is emitted when
-<parameter>paned</parameter> has the focus and <keycap>F8</keycap> is
-pressed to give the focus to or take the focus from the separator
-handle.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkpapersize.xml b/docs/reference/pygtk-gtkpapersize.xml
deleted file mode 100644
index b4cf24b6..00000000
--- a/docs/reference/pygtk-gtkpapersize.xml
+++ /dev/null
@@ -1,686 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkpapersize">
-
- <refnamediv>
- <refname>gtk.PaperSize</refname>
- <refpurpose>an object providing support for named paper sizes (new in
- PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.PaperSize</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkpapersize">gtk.PaperSize</link></methodname>
- <methodparam><parameter role="keyword">name</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--copy">copy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--is-equal">is_equal</link></methodname>
- <methodparam><parameter role="keyword">size2</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--get-name">get_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--get-display-name">get_display_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--get-ppd-name">get_ppd_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--get-width">get_width</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--get-height">get_height</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--is-custom">is_custom</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--set-size">set_size</link></methodname>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--get-default-top-margin">get_default_top_margin</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--get-default-bottom-margin">get_default_bottom_margin</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--get-default-left-margin">get_default_left_margin</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkpapersize--get-default-right-margin">get_default_right_margin</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
-
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--paper-size-new-from-ppd">gtk.paper_size_new_from_ppd</link></methodname>
- <methodparam><parameter role="keyword">ppd_name</parameter></methodparam>
- <methodparam><parameter role="keyword">ppd_display_name</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--paper-size-new-custom">gtk.paper_size_new_cutom</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">display_name</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--paper-size-get-default">gtk.paper_size_get_default</link></methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This class is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>A <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
- handles paper sizes. It uses the standard called "PWG 5101.1-2002 PWG:
- Standard for Media Standardized Names" to name the paper sizes (and to
- get the data for the page sizes). The common standard paper sizes are
- named by the <xref linkend="gtk-paper-name-constants"
- endterm="gtk-paper-name-constants-title"></xref>. In addition to
- standard paper sizes, <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
- allows to construct custom paper sizes with arbitrary dimensions.</para>
-
- <para>The <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
- object stores not only the dimensions (width and height) of a paper size
- and its name, it also provides default print margins. </para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkpapersize">
- <title>gtk.PaperSize</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.PaperSize</methodname>
- <methodparam><parameter role="keyword">name</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a paper size name, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
- object by parsing a PWG 5101.1-2002 PWG paper name. </para>
-
- <para>If <parameter>name</parameter> is <literal>None</literal>, the
- default paper size is returned, see
- <function>paper_size_get_default</function>().</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkpapersize--copy">
- <title>gtk.PaperSize.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of <parameter>other</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>copy</methodname>() method copies an existing <link linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--is-equal">
- <title>gtk.PaperSize.is_equal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_equal</methodname>
- <methodparam><parameter role="keyword">size2</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">size2</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
- object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if this paper size and
- <parameter>size2</parameter> represent the same paper
- size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>is_equal</methodname>() method returns the
- result of comparing this paper size to the <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
- specified by <parameter>size2</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--get-name">
- <title>gtk.PaperSize.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the paper size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_name</methodname>() method returns the name
- of the paper size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--get-display-name">
- <title>gtk.PaperSize.get_display_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_display_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the human-readable name of the paper
- size.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_display_name</methodname>() method returns
- the human-readable name of the paper size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--get-ppd-name">
- <title>gtk.PaperSize.get_ppd_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_ppd_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the PPD name of the paper
- size or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_ppd_name</methodname>() method returns the
- PPD name of the paper size, which may be
- <literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--get-width">
- <title>gtk.PaperSize.get_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_width</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value - one of the
- <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the paper width</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_width</methodname>() method returns the
- paper width of the paper size, in units of
- <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--get-height">
- <title>gtk.PaperSize.get_height</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_height</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value - one of the
- <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the paper height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_height</methodname>() method returns the
- paper height of the paper size, in units of
- <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--is-custom">
- <title>gtk.PaperSize.is_custom</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_custom</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the paper size is a
- custom paper size.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_custom</methodname>() method returns
- <literal>True</literal> if paper size is not a standard paper
- size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--set-size">
- <title>gtk.PaperSize.set_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_size</methodname>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the new width in units of
- <parameter>unit</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the new height in units of
- <parameter>unit</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for <parameter>width</parameter> and
- <parameter>height</parameter> - one of the <xref
- linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_size</methodname>() method changes the
- dimensions of the paper size to <parameter>width</parameter> x
- <parameter>height</parameter> in the units specified by
- <literal>unit</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--get-default-top-margin">
- <title>gtk.PaperSize.get_default_top_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_top_margin</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value - one of the
- <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default top margin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_default_top_margin</methodname>() method
- returns the default top margin for the <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--get-default-bottom-margin">
- <title>gtk.PaperSize.get_default_bottom_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_bottom_margin</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value - one of the
- <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default bottom margin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_default_bottom_margin</methodname>() method
- gets the default bottom margin for the paper size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--get-default-left-margin">
- <title>gtk.PaperSize.get_default_left_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_left_margin</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value - one of the
- <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default left margin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_default_left_margin</methodname>() method
- gets the default left margin for the paper size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkpapersize--get-default-right-margin">
- <title>gtk.PaperSize.get_default_right_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_right_margin</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value - one of the
- <xref linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default right margin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_default_right_margin</methodname>() method
- gets the default right margin for the paper size.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--paper-size-new-from-ppd">
- <title>gtk.paper_size_new_from_ppd</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.paper_size_new_from_ppd</methodname>
- <methodparam><parameter role="keyword">ppd_name</parameter></methodparam>
- <methodparam><parameter role="keyword">ppd_display_name</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">>ppd_name</parameter>&nbsp;:</term>
- <listitem><simpara>a PPD paper name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ppd_display_name</parameter>&nbsp;:</term>
- <listitem><simpara>the corresponding human-readable
- name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the paper width, in points</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the paper height in points</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <function>paper_size new__from_ppd</function>() function
- creates a new <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
- object by using PPD information. If <parameter>ppd_name</parameter>
- is not a recognized PPD paper name,
- <parameter>ppd_display_name</parameter>, <parameter>width</parameter>
- and <parameter>height</parameter> are used to construct a custom <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
- object.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--paper-size-new-custom">
- <title>gtk.paper_size_new_custom</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.paper_size_new_custom</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">display_name</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">>name</parameter>&nbsp;:</term>
- <listitem><simpara>the paper name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">display_name</parameter>&nbsp;:</term>
- <listitem><simpara>the corresponding human-readable
- name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the paper width, in units of
- <parameter>unit</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the paper height in units of
- <parameter>unit</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the units - one of the <xref
- linkend="gtk-unit-constants"
- endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <function>paper_size_new_custom</function>() function
- creates a new <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
- object with the given parameters.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--paper-size-get-default">
- <title>gtk.paper_size_get_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.paper_size_get_default</methodname>
- <methodparam><parameter
- role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the default paper
- size.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <function>paper_size_get_default</function>() function
- returns the name of the default paper size, which depends on the
- current locale.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkplug.xml b/docs/reference/pygtk-gtkplug.xml
deleted file mode 100644
index 6fc084c2..00000000
--- a/docs/reference/pygtk-gtkplug.xml
+++ /dev/null
@@ -1,303 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkplug">
- <refnamediv>
- <refname>gtk.Plug</refname>
- <refpurpose>A toplevel window for embedding into other
-processes.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Plug</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkwindow">gtk.Window</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkplug">gtk.Plug</link></methodname>
- <methodparam><parameter
- role="keyword">socket_id</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkplug--construct">construct</link></methodname>
- <methodparam><parameter
- role="keyword">socket_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkplug--get-id">get_id</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--plug-new-for-display">gtk.plug_new_for_display</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- <methodparam><parameter role="keyword">socket_id</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkplug">gtk.Plug</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkplug">
- <title>gtk.Plug Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkplug">
- <title>gtk.Plug Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkplug">
- <title>gtk.Plug Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkplug--embedded">embedded</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>plug</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>Together with <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link>, <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> provides the
-ability to embed widgets from one process into another process in a fashion
-that is transparent to the user. One process creates a <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link> widget
-and, passes the ID of that widgets window to the other process, which then
-creates a <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> with that
-window ID. Any widgets contained in the <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> then will
-appear inside the first applications window.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkplug">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Plug</methodname>
- <methodparam><parameter
- role="keyword">socket_id</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">socket_id</parameter>&nbsp;:</term>
- <listitem><simpara> the window ID of the socket, or
-0.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> widget inside
-the <link linkend="class-gtksocket"><classname>gtk.Socket</classname></link>
-identified by <parameter>socket_id</parameter>. If
-<parameter>socket_id</parameter> is 0, the plug is left "unplugged" and can
-later be plugged into a <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link> by the
-<link
-linkend="method-gtksocket--add-id"><methodname>gtk.Socket.add_id</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkplug--construct">
- <title>gtk.Plug.construct</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>construct</methodname>
- <methodparam><parameter
- role="keyword">socket_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">socket_id</parameter>&nbsp;:</term>
- <listitem><simpara>the window ID of the
-socket</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is <emphasis>not</emphasis> available in PyGTK 2.2
-and above.</para>
- </warning>
-
- <para>The <methodname>construct</methodname>() method finishes the
-initialization of plug for the <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link>
-identified by <parameter>socket_id</parameter>. This method will generally
-only be used by subclasses of <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkplug--get-id">
- <title>gtk.Plug.get_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_id</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the window ID for the plug</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_id</methodname>() method returns the window
-ID of the <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> widget, which
-can be used to embed this window inside another window, for instance with
-<link
-linkend="method-gtksocket--add-id"><methodname>gtk.Socket.add_id</methodname>()</link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--plug-new-for-display">
- <title>gtk.plug_new_for_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.plug_new_for_display</methodname>
- <methodparam><parameter
- role="keyword">display</parameter></methodparam>
- <methodparam><parameter
- role="keyword">socket_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
- associated with
- <parameter>socket_id's</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">socket_id</parameter>&nbsp;:</term>
- <listitem><simpara> the window ID of the socket's
- window.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkplug"><classname>gtk.Plug</classname></link>
- object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <function>gtk.plug_new_for_display</function>() function
-creates a new plug widget inside the <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link> specified
-by <parameter>socket_id</parameter> on the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-specified by display.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkplug--embedded">
- <title>The "embedded" gtk.Plug Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>plug</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>plug</parameter>&nbsp;:</term>
- <listitem><simpara>the plug that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "embedded" signal is emitted when the plug window is
-reparented to the socket window.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkprintcontext.xml b/docs/reference/pygtk-gtkprintcontext.xml
deleted file mode 100644
index 9e3c4aed..00000000
--- a/docs/reference/pygtk-gtkprintcontext.xml
+++ /dev/null
@@ -1,428 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkprintcontext">
-
- <refnamediv>
- <refname>gtk.PrintContext</refname>
- <refpurpose>Encapsulates context for drawing pages (new in PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.PrintContext</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintcontext--get-cairo-context">get_cairo_context</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintcontext--get-page-setup">get_page_setup</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintcontext--get-width">get_width</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintcontext--get-height">get_height</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintcontext--get-dpi-x">get_dpi_x</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintcontext--get-dpi-y">get_dpi_y</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintcontext--get-pango-fontmap">get_pango_fontmap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintcontext--create-pango-context">create_pango_context</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintcontext--create-pango-layout">create_pango_layout</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintcontext--set-cairo-context">set_cairo_context</link></methodname>
- <methodparam><parameter role="keyword">cr</parameter></methodparam>
- <methodparam><parameter role="keyword">dpi_x</parameter></methodparam>
- <methodparam><parameter role="keyword">dpi_y</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkprintcontext">gtk.PrintContext</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkprintcontext">
- <title>gtk.PrintContext Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
- encapsulates context information that is required when drawing pages for
- printing, such as the cairo context and important parameters like page
- size and resolution. It also lets you easily create <link
- linkend="class-pangolayout"><classname>pango.Layout</classname></link>
- and <link
- linkend="class-pangocontext"><classname>pango.Context</classname></link>
- objects that match the font metrics of the cairo surface.</para>
-
- <para><link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
- objects gets passed to the "begin-print", "end-print",
- "request-page-setup" and "draw-page" signals on the <link
- linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>.</para>
-
-<example>
-<title>Using <link
-linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
-in a "draw-page" callback</title>
-<programlisting>
-def draw_page(operation, context, page_nr):
- cr = context.get_cairo_context()
-
- # Draw a red rectangle, as wide as the paper (inside the margins)
- cr.set_source_rgb(1.0, 0, 0)
- cr.rectangle(0, 0, context.get_width(), 50)
-
- cr.fill()
-
- # Draw some lines
- cr.move_to(20, 10)
- cr.line_to(40, 20)
- cr.arc(60, 60, 20, 0, M_PI)
- cr.line_to(80, 20)
-
- cr.set_source_rgb(0, 0, 0)
- cr.set_line_width(5)
- cr.set_line_cap(cairo.LINE_CAP_ROUND)
- cr.set_line_join(cairo.LINE_JOIN_ROUND)
-
- cr.stroke()
-
- # Draw some text
- layout = context.create_layout()
- layout.set_text("Hello World! Printing is easy")
- desc = pango.FontDescription("sans 28")
- layout.set_font_description(desc)
-
- cr.move_to(30, 20)
- layout.layout_path()
-
- # Font Outline
- cr.set_source_rgb(0.93, 1.0, 0.47)
- cr.set_line_width(0.5)
- cr.stroke_preserve()
-
- # Font Fill
- cr.set_source_rgb(0, 0.0, 1.0)
- cr.fill()
-</programlisting>
-</example>
-
-<para>Printing support was added in GTK+ 2.10.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkprintcontext--get-cairo-context">
- <title>gtk.PrintContext.get_cairo_context</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_cairo_context</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the cairo context</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_cairo_context</methodname>() method returns
- the cairo context that is associated with the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintcontext--get-page-setup">
- <title>gtk.PrintContext.get_page_setup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_setup</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the page setup</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_page_setup</methodname>() method returns the
- <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
- that determines the page dimensions of the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintcontext--get-width">
- <title>gtk.PrintContext.get_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_width</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_width</methodname>() method returns the width
- of the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>,
- in pixels.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintcontext--get-height">
- <title>gtk.PrintContext.get_height</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_height</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_height</methodname>() method returns the
- width of the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>,
- in pixels.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintcontext--get-dpi-x">
- <title>gtk.PrintContext.get_dpi_x</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_dpi_x</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the horizontal resolution</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_dpi_x</methodname>() method returns the
- horizontal resolution of the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>,
- in dots per inch.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintcontext--get-dpi-y">
- <title>gtk.PrintContext.get_dpi_y</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_dpi_y</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the vertical resolution</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_dpi_y</methodname>() method returns the
- vertical resolution of the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>,
- in dots per inch.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintcontext--get-pango-fontmap">
- <title>gtk.PrintContext.get_pango_fontmap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pango_fontmap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the font map</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The method returns a <link
- linkend="class-pangofontmap"><classname>pango.FontMap</classname></link>
- that is suitable for use with the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintcontext--create-pango-context">
- <title>gtk.PrintContext.create_pango_context</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_pango_context</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-pangocontext"><classname>pango.Context</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>create_pango_context</methodname>() method
- creates a new <link
- linkend="class-pangocontext"><classname>pango.Context</classname></link>
- that can be used with the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintcontext--create-pango-layout">
- <title>gtk.PrintContext.create_pango_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_pango_layout</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link linkend="class-pangolayout"><classname>pango.Layout</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>create_pango_layout</methodname>() method
- creates a new <link
- linkend="class-pangolayout"><classname>pango.Layout</classname></link>
- that is suitable for use with the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintcontext--set-cairo-context">
- <title>gtk.PrintContext.set_cairo_context</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_cairo_context</methodname>
- <methodparam><parameter role="keyword">cr</parameter></methodparam>
- <methodparam><parameter role="keyword">dpi_x</parameter></methodparam>
- <methodparam><parameter role="keyword">dpi_y</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cr</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dpi_x</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">dpi_y</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_cairo_context</methodname>() method sets the
- CairoContext specified by <parameter>cr</parameter> as the cairo
- context for the print context. <parameter>dpi_x</parameter> and
- <parameter>dpi_y</parameter> specify the horizontal and vertical
- resolution of the print context.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkprinter.xml b/docs/reference/pygtk-gtkprinter.xml
deleted file mode 100644
index 6a544acc..00000000
--- a/docs/reference/pygtk-gtkprinter.xml
+++ /dev/null
@@ -1,671 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkprinter">
-
- <refnamediv>
- <refname>gtkunixprint.Printer</refname>
- <refpurpose>an object representing a print in Unix (new in PyGTK
- 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtkunixprint.Printer</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
-
-<!-- NOT IMPLEMENTED
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkprinter">gtkunixprint.Printer</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">backend</parameter></methodparam>
- <methodparam><parameter role="keyword">is_virtual</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter- -get-backend">get_backend</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--get-name">get_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--get-state-message">get_state_message</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--get-description">get_description</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--get-location">get_location</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--get-icon-name">get_icon_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--get-job-count">get_job_count</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--is-active">is_active</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--is-virtual">is_virtual</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--is-default">is_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--compare">compare</link></methodname>
- <methodparam><parameter role="keyword">b</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--accepts-pdf">accepts_pdf</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprinter--accepts-ps">accepts_ps</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkprinter">gtkunixprint.Printer</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkprinter">
- <title>gtkunixprint.Printer Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"accepts-pdf"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>if <literal>True</literal> this printer can accept
- PDF. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"accepts-ps"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>if <literal>True</literal> this printer can accept
- PostScript. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"backend"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The backend for the printer. Not currently useful in
- PyGTK. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"icon-name"</entry>
- <entry>Read</entry>
- <entry>The icon name to use for the printer. Default value:
- <literal>None</literal>. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"is-virtual"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>False</literal> this represents a real
- hardware printer. Default value:
- <literal>False</literal>. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"job-count"</entry>
- <entry>Read</entry>
- <entry>The number of jobs queued in the printer. Allowed
- values: >= 0. Default value: 0. Available in GTK+
- 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"location"</entry>
- <entry>Read</entry>
- <entry>The location of the printer. Default value:
- <literal>None</literal>. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"name"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The name of the printer. Default value:
- <literal>None</literal>. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"state-message"</entry>
- <entry>Read</entry>
- <entry>A string giving the current state of the printer.
- Default value: <literal>None</literal>. Available in GTK+
- 2.10.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkprinter">
- <title>gtkunixprint.Printer Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkprinter--details-acquired">details-acquired</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>printer</parameter></methodparam>
- <methodparam><parameter>success</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This class is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>A <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>
- object represents a printer. You only need to deal directly with
- printers if you use the non-portable <link
- linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>
- API.</para>
-
- <para>A <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>
- allows you to get status information about the printer, such as its
- description, its location, the number of queued jobs, etc. Most
- importantly, a <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>
- object can be used to create a <link
- linkend="class-gtkprintjob"><classname>gtkunixprint.PrintJob</classname></link>
- object, that lets you print to the printer.</para>
-
- </refsect1>
-
-<!-- NOT IMPLEMENTED
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkprinter">
- <title>gtkunixprint.Printer</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtkunixprint.Printer</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">backend</parameter></methodparam>
- <methodparam><parameter role="keyword">is_virtual</parameter></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the printer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">backend</parameter>&nbsp;:</term>
- <listitem><simpara>a <literal>GtkPrintBackend</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">is_virtual</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-END NOT IMPLEMENTED -->
-
- <refsect1>
- <title>Methods</title>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtkprinter- -get-backend">
- <title>gtkunixprint.Printer.get_backend</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_backend</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the backend of <parameter>printer</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_backend</methodname>() method returns the backend of the printer.</para>
-
- </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gtkprinter--get-name">
- <title>gtkunixprint.Printer.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the printer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_name</methodname>() method returns the name
- of the printer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprinter--get-state-message">
- <title>gtkunixprint.Printer.get_state_message</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_state_message</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the state message of the
- printer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_state_message</methodname>() method returns
- the state message describing the current state of the printer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprinter--get-description">
- <title>gtkunixprint.Printer.get_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_description</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the description of the
- printer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_description</methodname>() method returns
- the description of the printer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprinter--get-location">
- <title>gtkunixprint.Printer.get_location</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_location</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the location of the printer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_location</methodname>() method returns a
- description of the location of the printer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprinter--get-icon-name">
- <title>gtkunixprint.Printer.get_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the icon name for the printer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_icon_name</methodname>() method returns the
- name of the icon to use for the printer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprinter--get-job-count">
- <title>gtkunixprint.Printer.get_job_count</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_job_count</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of jobs on the printer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_job_count</methodname>() method returns the
- number of jobs currently queued on the printer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprinter--is-active">
- <title>gtkunixprint.Printer.is_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_active</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the printer is active</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>is_active</methodname>() method returns
- <literal>True</literal> if the printer is currently active (i.e.
- accepts new jobs).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprinter--is-virtual">
- <title>gtkunixprint.Printer.is_virtual</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_virtual</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the printer is
- virtual</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>is_virtual</methodname>() method returns
- <literal>True</literal> if the printer is virtual (i.e. does not
- represent actual printer hardware, but something like a CUPS
- class).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprinter--is-default">
- <title>gtkunixprint.Printer.is_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_default</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the printer is the default</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>is_default</methodname>() method returns
- <literal>True</literal> if the printer is the default printer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprinter--compare">
- <title>gtkunixprint.Printer.compare</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>compare</methodname>
- <methodparam><parameter role="keyword">b</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">b</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer indicating the result of the
- comparison of the <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>
- names.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The compare() method compares the name of the printer to the
- name of the <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>
- specified by <parameter>b</parameter> and returns:</para>
-
- <itemizedlist>
- <listitem>
- <para>a negative integer if the name of the printer is less than
- the name of <parameter>b</parameter>.</para>
- </listitem>
- <listitem>
- <para>a negative integer if the name of the printer is the same as
- the name of <parameter>b</parameter>.</para>
- </listitem>
- <listitem>
- <para>a positive integer if the name of the printer is greater
- than the name of <parameter>b</parameter>.</para>
- </listitem>
- </itemizedlist>
-
- </refsect2>
-
- <refsect2 id="method-gtkprinter--accepts-pdf">
- <title>gtkunixprint.Printer.accepts_pdf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>accepts_pdf</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the printer accepts
- PDF</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns whether the printer accepts input in PDF format.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprinter--accepts-ps">
- <title>gtkunixprint.Printer.accepts_ps</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>accepts_ps</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the printer accepts
- PostScript</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns whether the printer accepts input in PostScript
- format.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkprinter--details-acquired">
- <title>The "details-acquired" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>printer</parameter></methodparam>
- <methodparam><parameter>success</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>printer</parameter>&nbsp;:</term>
- <listitem><simpara>the printer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>success</parameter>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the details were
- successfully acquired</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "details-acquired" signal is emitted in response to a
- request for detailed information about a printer from the print
- backend. The success parameter indicates if the information was
- actually obtained.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkprintjob.xml b/docs/reference/pygtk-gtkprintjob.xml
deleted file mode 100644
index a9e7cfb9..00000000
--- a/docs/reference/pygtk-gtkprintjob.xml
+++ /dev/null
@@ -1,548 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkprintjob">
-
- <refnamediv>
- <refname>gtkunixprint.PrintJob</refname>
- <refpurpose>an object that represents a print job (new in PyGTK
- 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtkunixprint.PrintJob</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkprintjob">gtkunixprint.PrintJob</link></methodname>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- <methodparam><parameter role="keyword">printer</parameter></methodparam>
- <methodparam><parameter role="keyword">settings</parameter></methodparam>
- <methodparam><parameter role="keyword">page_setup</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintjob--get-settings">get_settings</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintjob--get-printer">get_printer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintjob--get-title">get_title</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintjob--get-status">get_status</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintjob--set-source-file">set_source_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintjob--get-surface">get_surface</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintjob--set-track-print-status">set_track_print_status</link></methodname>
- <methodparam><parameter role="keyword">track_status</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintjob--get-track-print-status">get_track_print_status</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintjob--send">send</link></methodname>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkprintjob">gtkunixprint.PrintJob</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkprintjob">
- <title>gtkunixprint.PrintJob Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"page-setup"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The Page Setup. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"printer"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The Printer to print the job to. Available in GTK+
- 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"settings"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The Printer Settings. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"title"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>Title of the print job. Default value:
- <literal>None</literal>. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"track-print-status"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>True</literal> the print job will continue
- to emit status-changed signals after the print data has been
- sent to the printer or print server. Available in GTK+
- 2.10.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkprintjob">
- <title>gtkunixprint.PrintJob Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintjob--status-changed">status-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>printjob</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This class is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>A <link
- linkend="class-gtkprintjob"><classname>gtkunixprint.PrintJob</classname></link>
- object represents a job that is sent to a printer. You only need to deal
- directly with print jobs if you use the non-portable <link
- linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>
- API.</para>
-
- <para>Use the <link
- linkend="method-gtkprintjob--get-surface"><methodname>get_surface</methodname>()</link>
- method to obtain the cairo surface onto which the pages must be
- drawn. Use the <link
- linkend="method-gtkprintjob--send"><methodname>send</methodname>()</link>
- method to send the finished job to the printer. If you don't use cairo
- <link
- linkend="class-gtkprintjob"><classname>gtkunixprint.PrintJob</classname></link>
- also supports printing of manually generated postscript, via the <link
- linkend="method-gtkprintjob--set-source-file"><methodname>set_source_file</methodname>()</link>
- method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkprintjob">
- <title>gtkunixprint.PrintJob</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtkunixprint.PrintJob</methodname>
- <methodparam><parameter role="keyword">title</parameter></methodparam>
- <methodparam><parameter role="keyword">printer</parameter></methodparam>
- <methodparam><parameter role="keyword">settings</parameter></methodparam>
- <methodparam><parameter role="keyword">page_setup</parameter></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>the job title</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">printer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">settings</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">page_setup</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkprintjob"><classname>gtkunixprint.PrintJob</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkprintjob"><classname>gtkunixprint.PrintJob</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkprintjob--get-settings">
- <title>gtkunixprint.PrintJob.get_settings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_settings</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the settings of the print
- job</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_settings</methodname>() method returns the
- <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- of the print job.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintjob--get-printer">
- <title>gtkunixprint.PrintJob.get_printer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_printer</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the printer of the print
- job</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_printer</methodname>() method returns the
- <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>
- of the print job.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintjob--get-title">
- <title>gtkunixprint.PrintJob.get_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_title</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the title of the print job</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_title</methodname>() method returns the
- print job title.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintjob--get-status">
- <title>gtkunixprint.PrintJob.get_status</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_status</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the status of the print
- job</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_status</methodname>() method returns the
- status of the print job.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintjob--set-source-file">
- <title>gtkunixprint.PrintJob.set_source_file</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_source_file</methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the file to be printed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>False</literal> if an error
- occurred</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_source_file</methodname>() method makes the
- <link
- linkend="class-gtkprintjob"><classname>gtkunixprint.PrintJob</classname></link>
- send the existing document specified by
- <parameter>filename</parameter> to the printing system. The file can
- be in any format understood by the platforms printing system
- (typically PostScript, but on many platforms PDF may work too).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintjob--get-surface">
- <title>gtkunixprint.PrintJob.get_surface</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_surface</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the cairo surface of the print
- job</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_surface</methodname>() method returns a
- cairo surface onto which the pages of the print job should be
- rendered.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintjob--set-track-print-status">
- <title>gtkunixprint.PrintJob.set_track_print_status</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_track_print_status</methodname>
- <methodparam><parameter role="keyword">track_status</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">track_status</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> track the status of
- the print job after sending</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_track_print_status</methodname>() method
- enable or disables tracking of the print job status based on the value
- specified by <parameter>track_status</parameter>. If
- <parameter>track_status</parameter> is <literal>True</literal>, the
- print job 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.</para>
-
- <para>This method is often implemented using some form of polling, so
- tracking should not be enabled unless needed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintjob--get-track-print-status">
- <title>gtkunixprint.PrintJob.get_track_print_status</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_track_print_status</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if print job status
- will be reported after printing</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_track_print_status</methodname>() method
- returns wheter jobs will be tracked after printing. For details, see
- the <link
- linkend="method-gtkprintjob--set-track-print-status"><methodname>set_track_print_status()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintjob--send">
- <title>gtkunixprint.PrintJob.send</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>send</methodname>
- <methodparam><parameter role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>the function to call when the job
- completes</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data that gets passed to
- <parameter>callback</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>False</literal> if an error
- occurred</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>send</methodname>() method sends the print job
- off to the printer and registers the function specified by
- <parameter>callback</parameter> ro be called when the job
- completes.</para>
-
- <para>The signature of <parameter>callback</parameter> is:</para>
-
- <programlisting>
-def callback(print_job, data, errormsg):
- </programlisting>
-
- <para>where <parameter>data</parameter> is
- <parameter>user_data</parameter> and <parameter>errormsg</parameter>
- is a message indicating what problem has occurred or
- <literal>None</literal> if no error has occurred.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkprintjob--status-changed">
- <title>The "status-changed" Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>gtkprintjob</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>gtkprintjob</parameter>&nbsp;:</term>
- <listitem><simpara>the gtkprintjob that received the
- signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
- any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "status-changed" signal is emitted when the status of a job
- changes. The signal handler can use the <link
- linkend="method-gtkprintjob--get-status"><methodname>get_status</methodname>()</link>
- method to obtain the new status.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkprintoperation.xml b/docs/reference/pygtk-gtkprintoperation.xml
deleted file mode 100644
index 98fd792f..00000000
--- a/docs/reference/pygtk-gtkprintoperation.xml
+++ /dev/null
@@ -1,1709 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkprintoperation">
-
- <refnamediv>
- <refname>gtk.PrintOperation</refname>
- <refpurpose>a high-level printing API (new in PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.PrintOperation</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtkprintoperationpreview">gtk.PrintOperationPreview</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkprintoperation">gtk.PrintOperation</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-default-page-setup">set_default_page_setup</link></methodname>
- <methodparam><parameter role="keyword">default_page_setup</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--get-default-page-setup">get_default_page_setup</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-print-settings">set_print_settings</link></methodname>
- <methodparam><parameter role="keyword">print_settings</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--get-print-settings">get_print_settings</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-job-name">set_job_name</link></methodname>
- <methodparam><parameter role="keyword">job_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-n-pages">set_n_pages</link></methodname>
- <methodparam><parameter role="keyword">n_pages</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-current-page">set_current_page</link></methodname>
- <methodparam><parameter role="keyword">current_page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-use-full-page">set_use_full_page</link></methodname>
- <methodparam><parameter role="keyword">full_page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-unit">set_unit</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-export-filename">set_export_filename</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-track-print-status">set_track_print_status</link></methodname>
- <methodparam><parameter role="keyword">track_status</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-show-progress">set_show_progress</link></methodname>
- <methodparam><parameter role="keyword">show_progress</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-allow-async">set_allow_async</link></methodname>
- <methodparam><parameter role="keyword">allow_async</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--set-custom-tab-label">set_custom_tab_label</link></methodname>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--run">run</link></methodname>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--get-error">get_error</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--get-status">get_status</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--get-status-string">get_status_string</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--is-finished">is_finished</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperation--cancel">cancel</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkprintoperation">gtk.PrintOperation</link> (implements <link linkend="class-gtkprintoperationpreview">gtk.PrintOperationPreview</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkprintoperation">
- <title>gtk.PrintOperation Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"allow-async"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the print operation may run
- asynchronously or not. Some systems don't support asynchronous
- printing, but those that do will return
- <literal>gtk.PRINT_OPERATION_RESULT_IN_PROGRESS</literal> as the
- status, and emit the done signal when the operation is actually
- done. This property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"current-page"</entry>
- <entry>Read-Write</entry>
- <entry>The current page in the document. If this is set before
- <link
- linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>,
- the user will be able to select to print only the current page.
- Note that this only makes sense for pre-paginated documents. This
- property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"custom-tab-label"</entry>
- <entry>Read-Write</entry>
- <entry>Used as the label of the tab containing custom widgets.
- Note that this property may be ignored on some platforms. If this
- is <literal>None</literal>, GTK+ uses a default label. This
- property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"default-page-setup"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
- used by default. This page setup will be used by <link
- linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>,
- but it can be overridden on a per-page basis by connecting to the
- "request-page-setup" signal. This property is available in GTK+
- 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"export-filename"</entry>
- <entry>Read-Write</entry>
- <entry>The name of a file 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. This property is available
- in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"job-name"</entry>
- <entry>Read-Write</entry>
- <entry>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. This
- property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"n-pages"</entry>
- <entry>Read-Write</entry>
- <entry>The number of pages in the document. This
- <emphasis>must</emphasis> be set to a positive number before the
- rendering starts. It may be set in a "begin-print" signal hander.
- Note that the page numbers passed to the "request-page-setup" and
- "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
- <parameter>n_pages</parameter> - 1. This property is available in
- GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"print-settings"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- used for initializing the dialog. Setting this property is
- typically used to re-establish print settings from a previous
- print operation, see the <link
- linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
- method. This property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"show-progress"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> show a progress dialog during
- the print operation. This property is available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"status"</entry>
- <entry>Read</entry>
- <entry>The status of the print operation. This property is
- available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"status-string"</entry>
- <entry>Read</entry>
- <entry>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 <link
- linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link>.
- See the "status" property for a status value that is suitable for
- programmatic use. This property is available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"track-print-status"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, 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. This property
- is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"unit"</entry>
- <entry>Read-Write</entry>
- <entry>The transformation for the cairo context obtained from
- <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
- is set up in such a way that distances are measured in units of
- <parameter>unit</parameter>. This property is available in GTK+
- 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"use-full-page"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the transformation for the
- cairo context obtained from <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
- 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). This property is available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkprintoperation">
- <title>gtk.PrintOperation Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkprintoperationpreview">gtk.PrintOperationPreview Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperation--begin-print">begin-print</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperation--create-custom-widget">create-custom-widget</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperation--custom-widget-apply">custom-widget-apply</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperation--done">done</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>result</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperation--draw-page">draw-page</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>page_nr</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperation--end-print">end-print</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperation--paginate">paginate</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>printoperation</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperation--preview">preview</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>preview</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>parent</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperation--request-page-setup">request-page-setup</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>page_nr</parameter></methodparam>
- <methodparam><parameter>setup</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperation--status-changed">status-changed</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>printoperation</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
- is the high-level, portable printing API. It looks a bit different than
- other GTK+ dialogs such as the <link
- linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>,
- since some platforms don't expose enough infrastructure to implement a
- good print dialog. On such platforms, <link
- linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
- uses the native print dialog. On platforms which do not provide a native
- print dialog, GTK+ uses its own, see <link
- linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>.</para>
-
- <para>The typical way to use the high-level printing API is to create a
- <link
- linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
- object with the <link
- linkend="constructor-gtkprintoperation"><methodname>gtk.PrintOperation</methodname></link>
- constructor when the user selects to print. Then you set some properties
- on it, e.g. the page size, any <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- from previous print operations, the number of pages, the current page,
- etc.</para>
-
- <para>Then you start the print operation by calling the <link
- linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
- method. 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 <link
- linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>,
- the main one being "draw-page", which you are supposed to catch and
- render the page on the provided <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
- using Cairo.</para>
-
-<example>
-<title>The high-level printing API</title>
-<programlisting>
-settings = None
-
-def do_print():
- print = gtk.PrintOperation()
-
- if settings != None:
- print.set_print_settings(settings)
-
- print.connect("begin_print", begin_print)
- print.connect("draw_page", draw_page)
-
- res = print.run(gtk.PRINT_OPERATION_ACTION_PRINT_DIALOG, main_window)
-
- if res == gtk.PRINT_OPERATION_RESULT_APPLY:
- settings = print.get_print_settings()
-</programlisting>
-</example>
-
-<para>Printing support was added in GTK+ 2.10.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkprintoperation">
- <title>gtk.PrintOperation</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.PrintOperation</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkprintoperation--set-default-page-setup">
- <title>gtk.PrintOperation.set_default_page_setup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_default_page_setup</methodname>
- <methodparam><parameter role="keyword">default_page_setup</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">default_page_setup</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>,
- or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_default_page_setup</methodname>() method
- makes <parameter>default_page_setup</parameter> the default page
- setup.</para>
-
- <para>This page setup will be used by the <link
- linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
- method, but it can be overridden on a per-page basis by connecting to
- the "request-page-setup" signal.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--get-default-page-setup">
- <title>gtk.PrintOperation.get_default_page_setup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_page_setup</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default page setup</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_default_page_setup</methodname>() method
- returns the default page setup, see the <link
- linkend="method-gtkprintoperation--set-default-page-setup"><methodname>gtk.PrintOperation.set_default_page_setup()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--set-print-settings">
- <title>gtk.PrintOperation.set_print_settings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_print_settings</methodname>
- <methodparam><parameter role="keyword">print_settings</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">print_settings</parameter>&nbsp;:</term>
- <listitem><simpara><link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>,
- or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_print_settings</methodname>() method sets
- the print settings. This is typically used to re-establish print
- settings from a previous print operation, see the <link
- linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--get-print-settings">
- <title>gtk.PrintOperation.get_print_settings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_print_settings</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current print settings.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_print_settings</methodname>() method returns
- the current print settings.</para>
-
- <para>Note that the return value is <literal>None</literal> until
- either the <link
- linkend="method-gtkprintoperation--set-print-settings"><methodname>gtk.PrintOperation.set_print_settings()</methodname></link>
- or <link
- linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
- methods have been called.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--set-job-name">
- <title>gtk.PrintOperation.set_job_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_job_name</methodname>
- <methodparam><parameter role="keyword">job_name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">job_name</parameter>&nbsp;:</term>
- <listitem><simpara>a string that identifies the print
- job</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_job_name</methodname>() method sets the name
- of the print job. The name is used to identify the job (e.g. in
- monitoring applications like eggcups).</para>
-
- <para>If you don't set a job name, GTK+ picks a default one by
- numbering successive print jobs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--set-n-pages">
- <title>gtk.PrintOperation.set_n_pages</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_n_pages</methodname>
- <methodparam><parameter role="keyword">n_pages</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">n_pages</parameter>&nbsp;:</term>
- <listitem><simpara>the number of pages</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_n_pages</methodname>() >method sets the
- number of pages in the document. </para>
-
- <para>This <emphasis>must</emphasis> be set to a positive number
- before the rendering starts. It may be set in a "begin-print" signal
- hander.</para>
-
- <para>Note that the page numbers passed to the "request-page-setup"
- and "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
- <parameter>n_pages</parameter> - 1.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--set-current-page">
- <title>gtk.PrintOperation.set_current_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_current_page</methodname>
- <methodparam><parameter role="keyword">current_page</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">current_page</parameter>&nbsp;:</term>
- <listitem><simpara>the current page, 0-based</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_current_page</methodname>() method sets the
- current page.</para>
-
- <para>If this is called before <link
- linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>,
- the user will be able to select to print only the current page.</para>
-
- <para>Note that this only makes sense for pre-paginated
- documents.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--set-use-full-page">
- <title>gtk.PrintOperation.set_use_full_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_full_page</methodname>
- <methodparam><parameter role="keyword">full_page</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">full_page</parameter>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to set up the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
- for the full page</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_use_full_page</methodname>() method sets the
- "full-page" property to the value of
- <parameter>full_page</parameter>. If <parameter>full_page</parameter>
- is <literal>True</literal>, the transformation for the cairo context
- obtained from <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
- 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).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--set-unit">
- <title>gtk.PrintOperation.set_unit</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_unit</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit to use</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_unit</methodname>() method sets up the
- transformation for the cairo context such distances are measured in
- units of <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--set-export-filename">
- <title>gtk.PrintOperation.set_export_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_export_filename</methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the filename for the exported file</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_export_filename</methodname>() method sets
- up the <link
- linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
- to generate a file instead of showing the print dialog. The intended
- use of this method is for implementing "Export to PDF"
- actions. Currently, PDF is the only supported format.</para>
-
- <para>"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.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--set-track-print-status">
- <title>gtk.PrintOperation.set_track_print_status</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_track_print_status</methodname>
- <methodparam><parameter role="keyword">track_status</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">track_status</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> track status after
- printing</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_track_print_status</methodname>() method
- sets the "track-print-status" to the value of
- <parameter>track_status</parameter>. If
- <parameter>track_status</parameter> is <literal>True</literal>, 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.</para>
-
- <para>This method is often implemented using some form of polling, so
- it should not be enabled unless needed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--set-show-progress">
- <title>gtk.PrintOperation.set_show_progress</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_progress</methodname>
- <methodparam><parameter role="keyword">show_progress</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">show_progress</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> show a progress
- dialog</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_show_progress</methodname>() method sets the
- "show-progress" property to the value of
- <parameter>show_progress</parameter>. If
- <parameter>show_progress</parameter> is <literal>True</literal>, the
- print operation will show a progress dialog during the print
- operation.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--set-allow-async">
- <title>gtk.PrintOperation.set_allow_async</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_allow_async</methodname>
- <methodparam><parameter role="keyword">allow_async</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">allow_async</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> allow asynchronous
- operation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_allow_async</methodname>() method sets the
- "allow-async" to the value of <parameter>allow_async</parameter>. If
- <parameter>allow_async</parameter> is <literal>True</literal> the
- <link
- linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
- may return before the print operation is completed. Note that some
- platforms may not allow asynchronous operation.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--set-custom-tab-label">
- <title>gtk.PrintOperation.set_custom_tab_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_custom_tab_label</methodname>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_custom_tab_label</methodname>() method sets
- the label for the tab holding custom widgets.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--run">
- <title>gtk.PrintOperation.run</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>run</methodname>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">action</parameter>&nbsp;:</term>
- <listitem><simpara>the action to start - one of the <xref
- linkend="gtk-print-operation-action-constants"
- endterm="gtk-print-operation-action-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>Transient parent of the dialog, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the result of the print operation - one of the
- <xref linkend="gtk-print-operation-result-constants"
- endterm="gtk-print-operation-result-constants-title"></xref>. A
- return value of
- <literal>gtk.PRINT_OPERATION_RESULT_APPLY</literal> indicates that
- the printing was completed successfully. In this case, it is a
- good idea to obtain the used print settings with the <link
- linkend="method-gtkprintoperation--get-print-settings"><methodname>gtk.PrintOperation.get_print_settings()</methodname></link>
- method and store them for reuse with the next print operation. A
- value of <literal>gtk.PRINT_OPERATION_RESULT_IN_PROGRESS</literal>
- means the operation is running asynchronously, and will emit the
- "done" signal when done.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>run</methodname>() method runs the print
- operation, by first letting the user modify print settings in the
- print dialog, and then print the document.</para>
-
- <para>Normally that this method does not return until the rendering of
- all pages is complete. You can connect to the "status-changed" signal
- to obtain some information about the progress of the print operation.
- Furthermore, it may use a recursive mainloop to show the print
- dialog.</para>
-
- <para>If you call the <link
- linkend="method-gtkprintoperation--set-allow-async"><methodname>gtk.PrintOperation.set_allow_async()</methodname></link>
- method or set the "allow-async" property the operation will run
- asyncronously if this is supported on the platform. The "done" signal
- will be emitted with the operation results when the operation is done
- (i.e. when the dialog is canceled, or when the print succeeds or
- fails).</para>
-
- <para><informalexample><programlisting>
- if settings != None:
- print.set_print_settings( settings)
-
- if page_setup != None:
- print.set_default_page_setup(page_setup)
-
- print.connect( "begin-print", begin_print, data)
- print.connect("draw-page", draw_page, data)
-
- res = print.run(gtk.PRINT_OPERATION_ACTION_PRINT_DIALOG, parent)
-
- if res == gtkprint_OPERATION_RESULT_ERROR:
- error_dialog = gtk.MessageDialog(parent,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR,
- gtk.BUTTONS_CLOSE,
- "Error printing file:\n")
- error_dialog.connect("response", lambda w,id: w.destroy())
- error_dialog.show()
- elif res == gtk.PRINT_OPERATION_RESULT_APPLY:
- settings = print.get_print_settings()
- </programlisting></informalexample></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--get-error">
- <title>gtk.PrintOperation.get_error</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_error</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the error message or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_error</methodname>() method returns the
- error message or <literal>None</literal>. Call this when the result of
- a print operation is
- <literal>gtk.PRINT_OPERATION_RESULT_ERROR</literal>, either as
- returned by the <link
- linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
- method, or in the "done" signal handler.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--get-status">
- <title>gtk.PrintOperation.get_status</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_status</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the status of the print
- operation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_status</methodname>() method returns the
- status of the print operation as one of the <xref
- linkend="gtk-print-status-constants"
- endterm="gtk-print-status-constants-title"></xref>. Also see the <link
- linkend="method-gtkprintoperation--get-status-string"><methodname>gtk.PrintOperation.get_status_string()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--get-status-string">
- <title>gtk.PrintOperation.get_status_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_status_string</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string representation of the status of the
- print operation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_status_string</methodname>() method 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 <link
- linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link>.</para>
-
- <para>Use the <link
- linkend="method-gtkprintoperation--get-status"><methodname>gtk.PrintOperation.get_status()</methodname></link>
- method to obtain a status value that is suitable for
- programmatic use.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--is-finished">
- <title>gtk.PrintOperation.is_finished</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_finished</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if the print operation
- is finished.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The method returns True if the print operation is
- completed. This is a convenience method to find out if the print
- operation is finished, either successfully
- (<literal>gtk.PRINT_STATUS_FINISHED</literal>) or unsuccessfully
- (<literal>gtk.PRINT_STATUS_FINISHED_ABORTED</literal>).</para>
-
- <note>
- <para>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.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperation--cancel">
- <title>gtk.PrintOperation.cancel</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>cancel</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>cancel</methodname>() method cancels a running
- print operation. This method may be called from a "begin-print",
- "paginate" or "draw-page" signal handler to stop the currently running
- print operation.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkprintoperation--begin-print">
- <title>The "begin-print" gtk.PrintOperation Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>operation</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
- on which the signal was emitted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
- for the current operation</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "begin-print" signal is emitted after the user has finished
- changing print settings in the dialog, before the actual rendering
- starts.</para>
-
- <para>A typical use for this signal is to use the parameters from the
- <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
- and paginate the document accordingly, and then set the number of
- pages with <link
- linkend="method-gtkprintoperation--set-n-pages"><methodname>gtk.PrintOperation.set_n_pages()</methodname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkprintoperation--create-custom-widget">
- <title>The "create-custom-widget" gtk.PrintOperation Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>operation</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A custom widget that gets embedded in the print
- dialog, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "create-custom-widget" signal is 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.</para>
-
- <para>The print dialog owns the returned widget, and its lifetime
- isn't controlled by the app. However, the widget is guaranteed to stay
- around until the "custom-widget-apply" signal is emitted on the
- operation. Then you can read out any information you need from the
- widgets.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkprintoperation--custom-widget-apply">
- <title>The "custom-widget-apply" gtk.PrintOperation Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>operation</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the custom widget added in create-custom-widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "custom-widget-apply" signal is emitted right before
- "begin-print" if you added a custom widget in the
- "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.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkprintoperation--done">
- <title>The "done" gtk.PrintOperation Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>result</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>operation</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>result</parameter>&nbsp;:</term>
- <listitem><simpara>the result of the print operation</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "done" signal is emitted when the print operation run has
- finished doing everything required for
- printing. <parameter>result</parameter> (one of the <xref
- linkend="gtk-print-operation-result-constants"
- endterm="gtk-print-operation-result-constants-title"></xref>) gives
- you information about what happened during the run. If
- <parameter>result</parameter> is
- <literal>gtk.PRINT_OPERATION_RESULT_ERROR</literal> then you can call
- the <link
- linkend="method-gtkprintoperation--get-error"><methodname>gtk.PrintOperation.get_error()</methodname></link>
- method for more information.</para>
-
- <para>If you enabled print status tracking then the <link
- linkend="method-gtkprintoperation--is-finished"><methodname>gtk.PrintOperation.is_finished()</methodname></link>
- method may still return <literal>False</literal> after this was
- emitted.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkprintoperation--draw-page">
- <title>The "draw-page" gtk.PrintOperation Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>page_nr</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>operation</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link> for the current operation</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>page_nr</parameter>&nbsp;:</term>
- <listitem><simpara>the number of the currently printed page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "draw-page" signal is emitted for every page that is
- printed. The signal handler must render the
- <parameter>page_nr</parameter>'s page onto the cairo context obtained
- from <parameter>context</parameter> using <link
- linkend="method-gtkprintcontext--get-cairo-context"><methodname>gtk.PrintContext.get_cairo_context()</methodname></link>.</para>
-
- <para><informalexample><programlisting>
-def draw_page(operation, context, page_nr, user_data):
- cr = context.get_cairo_context()
- width = context.get_width()
-
- cr.rectangle(0, 0, width, HEADER_HEIGHT)
-
- cr.set_source_rgb(0.8, 0.8, 0.8);
- cr.fill()
-
- layout = context.create_pango_layout()
-
- desc = pango.FontDescription("sans 14")
- layout.set_font_description(desc)
-
- layout.set_text("some text")
- layout.set_width(width)
- layout.set_alignment(pango.ALIGN_CENTER)
-
- x,layout_height = layout.get_size()
- text_height = layout_height / pango.SCALE
-
- cr.move_to(width / 2, (HEADER_HEIGHT - text_height) / 2)
- cr.show_layout(layout)
- </programlisting></informalexample></para>
-
- <para>Use the <link
- linkend="method-gtkprintoperation--set-use-full-page"><methodname>gtk.PrintOperation.set_use_full_page()</methodname></link>
- and <link
- linkend="method-gtkprintoperation--set-unit"><methodname>gtk.PrintOperation.set_unit()</methodname></link>
- methods before starting the print operation to set up the
- transformation of the cairo context according to your
- needs.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkprintoperation--end-print">
- <title>The "end-print" gtk.PrintOperation Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>operation</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link> for the current operation</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "end-print" signal is emitted after all pages have been
- rendered. A handler for this signal can clean up any resources that
- have been allocated in the "begin-print" handler.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkprintoperation--paginate">
- <title>The "paginate" gtk.PrintOperation Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>printoperation</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>printoperation</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
- for the current operation</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "paginate" signal is emitted after the "begin-print" signal,
- but before the actual rendering starts. It keeps getting emitted until
- it returns <literal>False</literal>.</para>
-
- <para>This signal is intended to be used for paginating the document
- in small chunks, to avoid blocking the user interface for a long
- time. The signal handler should update the number of pages using the
- <link
- linkend="method-gtkprintoperation--set-n-pages"><methodname>gtk.PrintOperation.set_n_pages</methodname>()</link>
- method, and return <literal>True</literal> if the document has been
- completely paginated.</para>
-
- <para>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.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkprintoperation--preview">
- <title>The "preview" gtk.PrintOperation Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>preview</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>parent</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>operation</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>preview</parameter>&nbsp;:</term>
- <listitem><simpara>the <literal>GtkPrintPreviewOperation</literal> for the current operation</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link> that will be used</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>parent</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkwindow"><classname>gtk.Window</classname></link> to use as window parent, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the listener wants to take over control of the preview</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "preview" signal is emitted when a preview is requested from
- the native dialog. If you handle this you must set the cairo context
- on the printing context.</para>
-
- <para>If you don't override this, a default implementation using an
- external viewer will be used.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkprintoperation--request-page-setup">
- <title>The "request-page-setup" gtk.PrintOperation Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>context</parameter></methodparam>
- <methodparam><parameter>page_nr</parameter></methodparam>
- <methodparam><parameter>setup</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>operation</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link> for the current operation</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>page_nr</parameter>&nbsp;:</term>
- <listitem><simpara>the number of the currently printed page</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>setup</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "request-page-setup" signal is emitted once for every page
- that is printed, to give the application a chance to modify the page
- setup. Any changes done to <parameter>setup</parameter> will be in
- force only for printing this page.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkprintoperation--status-changed">
- <title>The "status-changed" gtk.PrintOperation Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>operation</parameter></methodparam>
- <methodparam><parameter>printoperation</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>operation</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>printoperation</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "status-changed" signal is emitted at between the various
- phases of the print operation. See the <xref
- linkend="gtk-print-status-constants"
- endterm="gtk-print-status-constants-title"></xref> for the phases that
- are being discriminated. Use the <link
- linkend="method-gtkprintoperation--get-status"><methodname>gtk.PrintOperation.get_status</methodname>()</link>
- method to find out the current status.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkprintoperationpreview.xml b/docs/reference/pygtk-gtkprintoperationpreview.xml
deleted file mode 100644
index cac5d18d..00000000
--- a/docs/reference/pygtk-gtkprintoperationpreview.xml
+++ /dev/null
@@ -1,236 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkprintoperationpreview">
-
- <refnamediv>
- <refname>gtk.PrintOperationPreview</refname>
- <refpurpose>an interface for printing preview (new in PyGTK
- 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.PrintOperationPreview</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperationpreview--render-page">render_page</link></methodname>
- <methodparam><parameter role="keyword">page_nr</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperationpreview--end-preview">end_preview</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintoperationpreview--is-selected">is_selected</link></methodname>
- <methodparam><parameter role="keyword">page_nr</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkprintoperationpreview">
- <title>gtk.PrintOperationPreview Signal Prototypes</title>
-
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperationpreview--got-page-size">got-page-size</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>printoperationpreview</parameter></methodparam>
- <methodparam><parameter>printcontext</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkprintoperationpreview--ready">ready</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>printoperationpreview</parameter></methodparam>
- <methodparam><parameter>printcontext</parameter></methodparam>
- <methodparam><parameter>pagesetup</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-gtkprintoperationpreview"><classname>gtk.PrintOperationPreview</classname></link>
- is an interface implemented by <link
- linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
- for previewing pages before printing.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkprintoperationpreview--render-page">
- <title>gtk.PrintOperationPreview.render_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>render_page</methodname>
- <methodparam><parameter role="keyword">page_nr</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_nr</parameter>&nbsp;:</term>
- <listitem><simpara>the number of the page to be
- previewed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperationpreview--end-preview">
- <title>gtk.PrintOperationPreview.end_preview</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>end_preview</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintoperationpreview--is-selected">
- <title>gtk.PrintOperationPreview.is_selected</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_selected</methodname>
- <methodparam><parameter role="keyword">page_nr</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_nr</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>page_nr</parameter> is the currently selected
- page</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if the page with the number
- specified by <parameter>page_nr</parameter> is currently
- selected.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkprintoperationpreview--got-page-size">
- <title>The "got-page-size" gtk.PrintOperationPreview Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>printoperationpreview</parameter></methodparam>
- <methodparam><parameter>printcontext</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>printoperationpreview</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>printcontext</parameter>&nbsp;:</term>
- <listitem><simpara>the print context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="signal-gtkprintoperationpreview--ready">
- <title>The "ready" gtk.PrintOperationPreview Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>printoperationpreview</parameter></methodparam>
- <methodparam><parameter>printcontext</parameter></methodparam>
- <methodparam><parameter>pagesetup</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>printoperationpreview</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>printcontext</parameter>&nbsp;:</term>
- <listitem><simpara>the print context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>pagesetup</parameter>&nbsp;:</term>
- <listitem><simpara>the page setup</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkprintsettings.xml b/docs/reference/pygtk-gtkprintsettings.xml
deleted file mode 100644
index 061cd626..00000000
--- a/docs/reference/pygtk-gtkprintsettings.xml
+++ /dev/null
@@ -1,1954 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkprintsettings">
-
- <refnamediv>
- <refname>gtk.PrintSettings</refname>
- <refpurpose>Stores print settings (new in PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.PrintSettings</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkprintsettings">gtk.PrintSettings</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--copy">copy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--has-key">has_key</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get">get</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set">set</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--unset">unset</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--foreach">foreach</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-bool">get_bool</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-bool">set_bool</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-double">get_double</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-double-with-default">get_double_with_default</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">def</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-double">set_double</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-length">get_length</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-length">set_length</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-int">get_int</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-int-with-default">get_int_with_default</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">def</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-int">set_int</link></methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-printer">get_printer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-printer">set_printer</link></methodname>
- <methodparam><parameter role="keyword">printer</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-orientation">get_orientation</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-orientation">set_orientation</link></methodname>
- <methodparam><parameter role="keyword">orientation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-paper-size">get_paper_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-paper-size">set_paper_size</link></methodname>
- <methodparam><parameter role="keyword">paper_size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-paper-width">get_paper_width</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-paper-width">set_paper_width</link></methodname>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-paper-height">get_paper_height</link></methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-paper-height">set_paper_height</link></methodname>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-use-color">get_use_color</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-use-color">set_use_color</link></methodname>
- <methodparam><parameter role="keyword">use_color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-collate">get_collate</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-collate">set_collate</link></methodname>
- <methodparam><parameter role="keyword">collate</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-reverse">get_reverse</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-reverse">set_reverse</link></methodname>
- <methodparam><parameter role="keyword">reverse</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-duplex">get_duplex</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-duplex">set_duplex</link></methodname>
- <methodparam><parameter role="keyword">duplex</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-quality">get_quality</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-quality">set_quality</link></methodname>
- <methodparam><parameter role="keyword">quality</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-n-copies">get_n_copies</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-n-copies">set_n_copies</link></methodname>
- <methodparam><parameter role="keyword">num_copies</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-number-up">get_number_up</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-number-up">set_number_up</link></methodname>
- <methodparam><parameter role="keyword">number_up</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-resolution">get_resolution</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-resolution">set_resolution</link></methodname>
- <methodparam><parameter role="keyword">resolution</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-scale">get_scale</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-scale">set_scale</link></methodname>
- <methodparam><parameter role="keyword">scale</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-print-pages">get_print_pages</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-print-pages">set_print_pages</link></methodname>
- <methodparam><parameter role="keyword">pages</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-page-ranges">get_page_ranges</link></methodname>
- <methodparam><parameter role="keyword">num_ranges</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-page-ranges">set_page_ranges</link></methodname>
- <methodparam><parameter role="keyword">page_ranges</parameter></methodparam>
- <methodparam><parameter role="keyword">num_ranges</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-page-set">get_page_set</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-page-set">set_page_set</link></methodname>
- <methodparam><parameter role="keyword">page_set</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-default-source">get_default_source</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-default-source">set_default_source</link></methodname>
- <methodparam><parameter role="keyword">default_source</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-media-type">get_media_type</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-media-type">set_media_type</link></methodname>
- <methodparam><parameter role="keyword">media_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-dither">get_dither</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-dither">set_dither</link></methodname>
- <methodparam><parameter role="keyword">dither</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-finishings">get_finishings</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-finishings">set_finishings</link></methodname>
- <methodparam><parameter role="keyword">finishings</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--get-output-bin">get_output_bin</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintsettings--set-output-bin">set_output_bin</link></methodname>
- <methodparam><parameter role="keyword">output_bin</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkprintsettings">gtk.PrintSettings</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkprintsettings">
- <title>gtk.PrintSettings Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- object represents the settings of a print dialog in a system-independent
- way. The main use for this object is that once you've printed you can
- get a settings object that represents the settings the user chose, and
- the next time you print you can pass that object in so that the user
- doesn't have to re-set all his settings. </para>
-
- <para>Its also possible to enumerate the settings so that you can easily
- save the settings for the next time your app runs, or even store them in
- a document. The predefined keys try to use shared values as much as
- possible so that moving such a document between systems still
- works.</para>
-
- <para>Printing support was added in GTK+ 2.10.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkprintsettings">
- <title>gtk.PrintSettings</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.PrintSettings</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- object.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkprintsettings--copy">
- <title>gtk.PrintSettings.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a newly allocated copy of the print
- settings</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns a copy of this <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--has-key">
- <title>gtk.PrintSettings.has_key</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>has_key</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if
- <parameter>key</parameter> has a value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal>, if a value is associated with
- <parameter>key</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get">
- <title>gtk.PrintSettings.get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the string value for
- <parameter>key</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Looks up the string value associated with
- <parameter>key</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set">
- <title>gtk.PrintSettings.set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>a string value, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Associates <parameter>value</parameter> with
- <parameter>key</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--unset">
- <title>gtk.PrintSettings.unset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unset</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Removes any value associated with <parameter>key</parameter>.
- This has the same effect as setting the value to
- <literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--foreach">
- <title>gtk.PrintSettings.foreach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>foreach</methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>the function to call</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data for
- <parameter>func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Calls <parameter>func</parameter> for each key-value pair.</para>
-
- <para>The signature of <parameter>func</parameter> is:</para>
-
- <programlisting>
- def func(key, value, data):
- </programlisting>
-
- <para>where <parameter>key</parameter> and
- <parameter>value</parameter> are the key-value pair and
- <parameter>data</parameter> is
- <parameter>user_data</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-bool">
- <title>gtk.PrintSettings.get_bool</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_bool</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if
- <parameter>key</parameter> maps to a true
- value.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the boolean represented by the value that is associated
- with <parameter>key</parameter>. </para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-bool">
- <title>gtk.PrintSettings.set_bool</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_bool</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>a boolean</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets <parameter>key</parameter> to the boolean value specified
- by <parameter>value</parameter>..</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-double">
- <title>gtk.PrintSettings.get_double</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_double</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the double value of
- <parameter>key</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the double value associated with
- <parameter>key</parameter>, or 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-double-with-default">
- <title>gtk.PrintSettings.get_double_with_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_double_with_default</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">def</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">def</parameter>&nbsp;:</term>
- <listitem><simpara>the default value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the floating point number associated with
- <parameter>key</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the floating point number represented by the value that
- is associated with <parameter>key</parameter>, or
- <parameter>def</parameter> if the value does not represent a floating
- point number.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-double">
- <title>gtk.PrintSettings.set_double</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_double</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>a double value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets <parameter>key</parameter> to the given double
- value.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-length">
- <title>gtk.PrintSettings.get_length</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_length</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit of the return value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the length value of <parameter>key</parameter>,
- converted to <parameter>unit</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value associated with <parameter>key</parameter>,
- interpreted as a length. The returned value is converted to the units
- specified by <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-length">
- <title>gtk.PrintSettings.set_length</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_length</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>a length</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit of
- <parameter>length</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Associates a length in units of <parameter>unit</parameter> with
- <parameter>key</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-int">
- <title>gtk.PrintSettings.get_int</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_int</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the integer value of
- <parameter>key</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the integer value of <parameter>key</parameter>, or
- 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-int-with-default">
- <title>gtk.PrintSettings.get_int_with_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_int_with_default</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">def</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">def</parameter>&nbsp;:</term>
- <listitem><simpara>the default value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the integer value of
- <parameter>key</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of <parameter>key</parameter>, interpreted as
- an integer, or the default value specified by
- <parameter>def</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-int">
- <title>gtk.PrintSettings.set_int</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_int</methodname>
- <methodparam><parameter role="keyword">key</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">key</parameter>&nbsp;:</term>
- <listitem><simpara>a key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>an integer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets <parameter>key</parameter> to the given integer
- value.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-printer">
- <title>gtk.PrintSettings.get_printer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_printer</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the printer name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Convenience method to obtain the value of the "printer"
- key.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-printer">
- <title>gtk.PrintSettings.set_printer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_printer</methodname>
- <methodparam><parameter role="keyword">printer</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">printer</parameter>&nbsp;:</term>
- <listitem><simpara>the printer name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Convenience function to set the "printer" key the value
- specified by <parameter>printer</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-orientation">
- <title>gtk.PrintSettings.get_orientation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_orientation</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the orientation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Get the value of the "orientation" key, converted to one of the
- <xref linkend="gtk-page-orientation-constants"
- endterm="gtk-page-orientation-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-orientation">
- <title>gtk.PrintSettings.set_orientation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_orientation</methodname>
- <methodparam><parameter role="keyword">orientation</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">orientation</parameter>&nbsp;:</term>
- <listitem><simpara>a page orientation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "orientation" key to one of the <xref
- linkend="gtk-page-orientation-constants"
- endterm="gtk-page-orientation-constants-title"></xref> specified by
- <parameter>orientation</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-paper-size">
- <title>gtk.PrintSettings.get_paper_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_paper_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the paper size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets the value of the "paper-format" key, converted to a <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-paper-size">
- <title>gtk.PrintSettings.set_paper_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_paper_size</methodname>
- <methodparam><parameter role="keyword">paper_size</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">paper_size</parameter>&nbsp;:</term>
- <listitem><simpara>a paper size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "paper-format", "paper-width" and
- "paper-height" keys using the <link
- linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
- specified by <parameter>paper_size</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-paper-width">
- <title>gtk.PrintSettings.get_paper_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_paper_width</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the unit for the return value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the paper width, in units of
- <parameter>unit</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Retuens the value of the "printer-width" key converted to the
- units specified by <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-paper-width">
- <title>gtk.PrintSettings.set_paper_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_paper_width</methodname>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the paper width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the units of <parameter>width</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "printer-width" key using the units
- specified by <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-paper-height">
- <title>gtk.PrintSettings.get_paper_height</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_paper_height</methodname>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the units for the return
- value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the paper height, in units of
- <parameter>unit</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets the value of the "paper-height" key converted to the units
- specified by <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-paper-height">
- <title>gtk.PrintSettings.set_paper_height</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_paper_height</methodname>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- <methodparam><parameter role="keyword">unit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the paper height</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
- <listitem><simpara>the units of
- <parameter>height</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "paper-height" key using the units
- specified by <parameter>unit</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-use-color">
- <title>gtk.PrintSettings.get_use_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_color</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>whether to use color</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "use-color" key. If
- <literal>True</literal> color will be used when printing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-use-color">
- <title>gtk.PrintSettings.set_use_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_color</methodname>
- <methodparam><parameter role="keyword">use_color</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">use_color</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> use
- color</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "use-color" key to the value specified by
- <parameter>use_color</parameter>. If <parameter>use_color</parameter>
- is <literal>True</literal> color will be used when printing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-collate">
- <title>gtk.PrintSettings.get_collate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_collate</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the printed pages
- are to be collated</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "collate" key.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-collate">
- <title>gtk.PrintSettings.set_collate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_collate</methodname>
- <methodparam><parameter role="keyword">collate</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">collate</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, collate the
- output</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "collate" key. If
- <parameter>collate</parameter> is <literal>True</literal> the output
- pages will be collated.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-reverse">
- <title>gtk.PrintSettings.get_reverse</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_reverse</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the order of the
- printed pages shoudl be reversed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "reverse" key.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-reverse">
- <title>gtk.PrintSettings.set_reverse</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_reverse</methodname>
- <methodparam><parameter role="keyword">reverse</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">reverse</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> reverse the
- output</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "reverse" key. If
- <parameter>reverse</parameter> is <literal>True</literal> the output
- pages willl be reversed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-duplex">
- <title>gtk.PrintSettings.get_duplex</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_duplex</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the "duplex" key.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "duplex" key - one of the <xref
- linkend="gtk-print-duplex-constants"
- endterm="gtk-print-duplex-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-duplex">
- <title>gtk.PrintSettings.set_duplex</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_duplex</methodname>
- <methodparam><parameter role="keyword">duplex</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">duplex</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="gtk-print-duplex-constants"
- endterm="gtk-print-duplex-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "duplex"
- key. <parameter>duplexp</parameter> must be one of the <xref
- linkend="gtk-print-duplex-constants"
- endterm="gtk-print-duplex-constants-title"></xref></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-quality">
- <title>gtk.PrintSettings.get_quality</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_quality</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the print quality</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "quality" key.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-quality">
- <title>gtk.PrintSettings.set_quality</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_quality</methodname>
- <methodparam><parameter role="keyword">quality</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">quality</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="gtk-print-quality-constants"
- endterm="gtk-print-quality-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "quality"
- key. <parameter>quality</parameter> must be one of the <xref
- linkend="gtk-print-quality-constants"
- endterm="gtk-print-quality-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-n-copies">
- <title>gtk.PrintSettings.get_n_copies</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_copies</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of copies to print</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "n-copies" key.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-n-copies">
- <title>gtk.PrintSettings.set_n_copies</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_n_copies</methodname>
- <methodparam><parameter role="keyword">num_copies</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">num_copies</parameter>&nbsp;:</term>
- <listitem><simpara>the number of copies</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "n-copies" key to the value specified by
- <parameter>num_copies</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-number-up">
- <title>gtk.PrintSettings.get_number_up</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_number_up</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of pages per sheet</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "number-up" key which specifies the
- number of pages per sheet.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-number-up">
- <title>gtk.PrintSettings.set_number_up</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_number_up</methodname>
- <methodparam><parameter role="keyword">number_up</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">number_up</parameter>&nbsp;:</term>
- <listitem><simpara>the number of pages per sheet</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "number-up"
- key. <parameter>number_up</parameter> specifies the number of document
- pages to be printed per sheet.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-resolution">
- <title>gtk.PrintSettings.get_resolution</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_resolution</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the resolution in dpi</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "resolution" key in dpi.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-resolution">
- <title>gtk.PrintSettings.set_resolution</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_resolution</methodname>
- <methodparam><parameter role="keyword">resolution</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">resolution</parameter>&nbsp;:</term>
- <listitem><simpara>the resolution in dpi</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "resolution" key in dpi.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-scale">
- <title>gtk.PrintSettings.get_scale</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_scale</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the scale in percent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "scale" key as a float number.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-scale">
- <title>gtk.PrintSettings.set_scale</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_scale</methodname>
- <methodparam><parameter role="keyword">scale</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">scale</parameter>&nbsp;:</term>
- <listitem><simpara>the scale in percent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "scale" key using the float number
- specified by <parameter>scale</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-print-pages">
- <title>gtk.PrintSettings.get_print_pages</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_print_pages</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>which pages to print</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "print-pages" key as one if the <xref
- linkend="gtk-print-pages-constants"
- endterm="gtk-print-pages-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-print-pages">
- <title>gtk.PrintSettings.set_print_pages</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_print_pages</methodname>
- <methodparam><parameter role="keyword">pages</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pages</parameter>&nbsp;:</term>
- <listitem><simpara>one if the <xref
- linkend="gtk-print-pages-constants"
- endterm="gtk-print-pages-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "print-pages" key to one of the <xref
- linkend="gtk-print-pages-constants"
- endterm="gtk-print-pages-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-page-ranges">
- <title>gtk.PrintSettings.get_page_ranges</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_ranges</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of [age ranges as
- 2-tuples</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "page-ranges" key as a list of
- 2-tuples containing the start and end page numbers of each
- range.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-page-ranges">
- <title>gtk.PrintSettings.set_page_ranges</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_page_ranges</methodname>
- <methodparam><parameter role="keyword">page_ranges</parameter></methodparam>
- <methodparam><parameter role="keyword">num_ranges</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_ranges</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of page range
- 2-tuples</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "page-ranges" key to the value of
- <parameter>page_ranges</parameter> which should be a sequence of
- 2-tuples containing the start and end page numbers of each page
- range.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-page-set">
- <title>gtk.PrintSettings.get_page_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_set</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the set of pages to print</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "page-set" key which is one of the
- <xref linkend="gtk-page-set-constants"
- endterm="gtk-page-set-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-page-set">
- <title>gtk.PrintSettings.set_page_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_page_set</methodname>
- <methodparam><parameter role="keyword">page_set</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_set</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="gtk-page-set-constants"
- endterm="gtk-page-set-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "page-set" key to the value specified by
- <parameter>page_set</parameter> which should be one of the <xref
- linkend="gtk-page-set-constants"
- endterm="gtk-page-set-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-default-source">
- <title>gtk.PrintSettings.get_default_source</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_source</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default source</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "default-source" key.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-default-source">
- <title>gtk.PrintSettings.set_default_source</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_default_source</methodname>
- <methodparam><parameter role="keyword">default_source</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">default_source</parameter>&nbsp;:</term>
- <listitem><simpara>the default source</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "default-source" key to the string
- specified by <parameter>default_source</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-media-type">
- <title>gtk.PrintSettings.get_media_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_media_type</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the media type</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "media-type" key.</para>
-
- <para>The set of media types is defined in PWG 5101.1-2002 PWG.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-media-type">
- <title>gtk.PrintSettings.set_media_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_media_type</methodname>
- <methodparam><parameter role="keyword">media_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">media_type</parameter>&nbsp;:</term>
- <listitem><simpara>the media type</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "media-type" key.</para>
-
- <para>The set of media types is defined in PWG 5101.1-2002 PWG.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-dither">
- <title>gtk.PrintSettings.get_dither</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_dither</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the dithering that is used</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "dither" key.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-dither">
- <title>gtk.PrintSettings.set_dither</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_dither</methodname>
- <methodparam><parameter role="keyword">dither</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dither</parameter>&nbsp;:</term>
- <listitem><simpara>the dithering that is used</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "dither" key to the string specified by
- <parameter>dither</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-finishings">
- <title>gtk.PrintSettings.get_finishings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_finishings</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the finishings</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "finishings" key.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-finishings">
- <title>gtk.PrintSettings.set_finishings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_finishings</methodname>
- <methodparam><parameter role="keyword">finishings</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">finishings</parameter>&nbsp;:</term>
- <listitem><simpara>the finishings</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "finishings" key to the string specified
- by <parameter>finishings</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--get-output-bin">
- <title>gtk.PrintSettings.get_output_bin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_output_bin</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the output bin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "output-bin" key.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintsettings--set-output-bin">
- <title>gtk.PrintSettings.set_output_bin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_output_bin</methodname>
- <methodparam><parameter role="keyword">output_bin</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">output_bin</parameter>&nbsp;:</term>
- <listitem><simpara>the output bin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the value of the "output-bin" key to the value specified by
- <parameter>output_bin</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkprintunixdialog.xml b/docs/reference/pygtk-gtkprintunixdialog.xml
deleted file mode 100644
index 527b1f5e..00000000
--- a/docs/reference/pygtk-gtkprintunixdialog.xml
+++ /dev/null
@@ -1,467 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkprintunixdialog">
-
- <refnamediv>
- <refname>gtkunixprint.PrintUnixDialog</refname>
- <refpurpose>an dialog for selecting a printer in Unix (new in PyGTK
- 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtkunixprint.PrintUnixDialog</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkprintunixdialog">gtkunixprint.PrintUnixDialog</link></methodname>
- <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintunixdialog--set-page-setup">set_page_setup</link></methodname>
- <methodparam><parameter role="keyword">page_setup</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintunixdialog--get-page-setup">get_page_setup</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintunixdialog--set-current-page">set_current_page</link></methodname>
- <methodparam><parameter role="keyword">current_page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintunixdialog--get-current-page">get_current_page</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintunixdialog--set-settings">set_settings</link></methodname>
- <methodparam><parameter role="keyword">settings</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintunixdialog--get-settings">get_settings</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintunixdialog--get-selected-printer">get_selected_printer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintunixdialog--add-custom-tab">add_custom_tab</link></methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- <methodparam><parameter role="keyword">tab_label</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkprintunixdialog--set-manual-capabilities">set_manual_capabilities</link></methodname>
- <methodparam><parameter role="keyword">capabilities</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
- +-- <link linkend="class-gtkprintunixdialog">gtkunixprint.PrintUnixDialog</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkprintunixdialog">
- <title>gtkunixprint.PrintUnixDialog Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
- <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"current-page"</entry>
- <entry>Read-Write</entry>
- <entry>The current page in the document. Allowed values: >=
- -1. Default value: -1. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"page-setup"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
- to use. Available in GTK+ 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"print-settings"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- used for initializing the dialog. Available in GTK+
- 2.10.</entry>
- </row>
-
- <row valign="top">
- <entry>"selected-printer"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>
- that is selected. Available in GTK+ 2.10.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkprintunixdialog">
- <title>gtkunixprint.PrintUnixDialog Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkprintunixdialog">
- <title>gtkunixprint.PrintUnixDialog Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para></para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkprintunixdialog">
- <title>gtkunixprint.PrintUnixDialog</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtkunixprint.PrintUnixDialog</methodname>
- <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>The title of the dialog, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>The transient parent of the dialog, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkprintunixdialog--set-page-setup">
- <title>gtkunixprint.PrintUnixDialog.set_page_setup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_page_setup</methodname>
- <methodparam><parameter role="keyword">page_setup</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">page_setup</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_page_setup</methodname>() method sets the
- "page-setup" property to the <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
- specified by <parameter>page_setup</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintunixdialog--get-page-setup">
- <title>gtkunixprint.PrintUnixDialog.get_page_setup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_page_setup</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the page setup of the
- dialog.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_page_setup</methodname>() method returns the
- <link
- linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
- that is used by the <link
- linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintunixdialog--set-current-page">
- <title>gtkunixprint.PrintUnixDialog.set_current_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_current_page</methodname>
- <methodparam><parameter role="keyword">current_page</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">current_page</parameter>&nbsp;:</term>
- <listitem><simpara>the current page number.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_current_page</methodname>() method sets the
- "current-page" property ot the value specified by
- <parameter>current_page</parameter>. If
- <parameter>current_page</parameter> is not -1 (the default value), the
- current page choice for the range of pages to print is enabled.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintunixdialog--get-current-page">
- <title>gtkunixprint.PrintUnixDialog.get_current_page</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_current_page</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current page of the dialog</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_current_page</methodname>() method returns
- the current page of the <link
- linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintunixdialog--set-settings">
- <title>gtkunixprint.PrintUnixDialog.set_settings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_settings</methodname>
- <methodparam><parameter role="keyword">settings</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">settings</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>,
- or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_settings</methodname>() method sets the
- <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- for the <link
- linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>. Typically,
- this is used to restore saved print settings from a previous print
- operation before the print dialog is shown.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintunixdialog--get-settings">
- <title>gtkunixprint.PrintUnixDialog.get_settings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_settings</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- object with the values from the dialog</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_settings</methodname>() method returns a new
- <link
- linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
- object that represents the current values in the print dialog.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintunixdialog--get-selected-printer">
- <title>gtkunixprint.PrintUnixDialog.get_selected_printer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selected_printer</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the currently selected
- printer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_selected_printer</methodname>() method
- returns the currently selected <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintunixdialog--add-custom-tab">
- <title>gtkunixprint.PrintUnixDialog.add_custom_tab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_custom_tab</methodname>
- <methodparam><parameter role="keyword">child</parameter></methodparam>
- <methodparam><parameter role="keyword">tab_label</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tab_label</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>add_custom_tab</methodname>() method adds a tab
- to the dialog using the <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
- specified by <parameter>child</parameter> for the contents and
- <parameter>tab_label</parameter> for the label.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprintunixdialog--set-manual-capabilities">
- <title>gtkunixprint.PrintUnixDialog.set_manual_capabilities</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_manual_capabilities</methodname>
- <methodparam><parameter role="keyword">capabilities</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">capabilities</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="unixprint-print-capabilities-constants"
- endterm="unixprint-print-capabilities-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>set_manual_capabilities</methodname>() method
- lets you specify the printing capabilities your application supports
- using the <xref linkend="unixprint-print-capabilities-constants"
- endterm="unixprint-print-capabilities-title"></xref> specified by
- <parameter>capabilities</parameter>. For example, if the application
- can handle scaling the output then it should pass
- <literal>gtkunixprint.PRINT_CAPABILITY_SCALE</literal>. If it doesn't
- pass that, the dialog will only let you select the scale if the
- printing system automatically handles scaling.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkprogressbar.xml b/docs/reference/pygtk-gtkprogressbar.xml
deleted file mode 100644
index f5d23849..00000000
--- a/docs/reference/pygtk-gtkprogressbar.xml
+++ /dev/null
@@ -1,505 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkprogressbar">
- <refnamediv>
- <refname>gtk.ProgressBar</refname>
- <refpurpose>a widget which indicates progress visually.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ProgressBar</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkprogress">gtk.Progress</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkprogressbar">gtk.ProgressBar</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkprogressbar--pulse">pulse</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkprogressbar--set-text">set_text</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkprogressbar--set-fraction">set_fraction</link></methodname>
- <methodparam><parameter
- role="keyword">fraction</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkprogressbar--set-pulse-step">set_pulse_step</link></methodname>
- <methodparam><parameter
- role="keyword">fraction</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkprogressbar--set-orientation">set_orientation</link></methodname>
- <methodparam><parameter
- role="keyword">orientation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkprogressbar--get-text">get_text</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkprogressbar--get-fraction">get_fraction</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkprogressbar--get-pulse-step">get_pulse_step</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkprogressbar--get-orientation">get_orientation</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkprogressbar--set-ellipsize">set_ellipsize</link></methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkprogressbar--get-ellipsize">get_ellipsize</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkprogress">gtk.Progress</link>
- +-- <link linkend="class-gtkprogressbar">gtk.ProgressBar</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkprogressbar">
- <title>gtk.ProgressBar Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkprogress">gtk.Progress Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"discrete-blocks"</entry>
- <entry>Read-Write</entry>
- <entry>The number of discrete blocks in a progress bar (when shown
- in the discrete style)</entry>
- </row>
-
- <row valign="top">
- <entry>"ellipsize"</entry>
- <entry>Read-Write</entry>
- <entry>The preferred place to ellipsize the string, if the
- progressbar does not have enough room to display the entire
- string, specified as one of the <xref
- linkend="pango-ellipsize-mode-constants"
- endterm="pango-ellipsize-mode-constants-title"></xref>. Note that
- setting this property to a value other than
- <literal>pango.ELLIPSIZE_NONE</literal> has the side-effect that
- the progressbar requests only enough space to display the ellipsis
- "...". Another means to set a progressbar's width is the <link
- linkend="method-gtkwidget--set-size-request"><methodname>gtk.Widget.set_size_request()</methodname></link>.
- This property is available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"fraction"</entry>
- <entry>Read-Write</entry>
- <entry>The fraction of total work that has been completed</entry>
- </row>
-
- <row valign="top">
- <entry>"orientation"</entry>
- <entry>Read-Write</entry>
- <entry>The orientation and growth direction of the progress
-bar - one of the <xref
-linkend="gtk-progressbar-orientation-constants"
-endterm="gtk-progressbar-orientation-constants-title"></xref>:
-<literal>gtk.PROGRESS_LEFT_TO_RIGHT</literal>,
-<literal>gtk.PROGRESS_RIGHT_TO_LEFT</literal>,
-<literal>gtk.PROGRESS_BOTTOM_TO_TOP</literal>,
-<literal>gtk.PROGRESS_TOP_TO_BOTTOM</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"pulse-step"</entry>
- <entry>Read-Write</entry>
- <entry>The fraction of total progress to move the bouncing
-block when pulsed</entry>
- </row>
-
- <row valign="top">
- <entry>"text"</entry>
- <entry>Read-Write</entry>
- <entry>The text to be displayed in the progress bar</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkprogressbar">
- <title>gtk.ProgressBar Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkprogressbar">
- <title>gtk.ProgressBar Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkprogressbar"><classname>gtk.ProgressBar</classname></link>
-is typically used to display the progress of a long running operation. It
-provides a visual clue that processing is underway. The <link
-linkend="class-gtkprogressbar"><classname>gtk.ProgressBar</classname></link>
-can be used in two different modes: percentage mode and activity
-mode.</para>
-
- <para>When an application can determine how much work needs to take
-place (e.g. read a fixed number of bytes from a file) and can monitor its
-progress, it can use the <link
-linkend="class-gtkprogressbar"><classname>gtk.ProgressBar</classname></link>
-in percentage mode and the user sees a growing bar indicating the percentage
-of the work that has been completed. In this mode, the application is
-required to call the <link
-linkend="method-gtkprogressbar--set-fraction"><methodname>set_fraction</methodname>()</link>
-method periodically to update the progress bar.</para>
-
- <para>When an application has no accurate way of knowing the amount of
-work to do, it can use the <link
-linkend="class-gtkprogressbar"><classname>gtk.ProgressBar</classname></link>
-in activity mode, which shows activity by a block moving back and forth
-within the progress area. In this mode, the application is required to call
-the <link
-linkend="method-gtkprogressbar--pulse"><methodname>pulse</methodname>()</link>
-method periodically to update the progress bar.</para>
-
- <para>There is quite a bit of flexibility provided to control the
-appearance of the <link
-linkend="class-gtkprogressbar"><classname>gtk.ProgressBar</classname></link>.
-Methods are provided to control the orientation of the bar, optional text
-can be displayed along with the bar, and the step size used in activity mode
-can be set.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkprogressbar">
- <title>Constructor</title>
-
-<programlisting><constructorsynopsis language="python">
- <methodname>gtk.ProgressBar</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkprogressbar"><classname>gtk.ProgressBar</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkprogressbar"><classname>gtk.Progressbar</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkprogressbar--pulse">
- <title>gtk.ProgressBar.pulse</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pulse</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>pulse</methodname>() method nudges the
-progressbar to indicate that some progress has been made, but you don't know
-how much. This method also changes progress bar mode to "activity mode,"
-where a block bounces back and forth. Each call to the <link
-linkend="method-gtkprogressbar--pulse"><methodname>pulse</methodname>()</link>
-method causes the block to move by a little bit (the amount of movement per
-pulse is determined by the <link
-linkend="method-gtkprogressbar--set-pulse-step"><methodname>set_pulse_step</methodname>()</link>
-method).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprogressbar--set-text">
- <title>gtk.ProgressBar.set_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>a UTF-8 string</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_text</methodname>() method superimposes the
-text specified by <parameter>text</parameter> on the progress bar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprogressbar--set-fraction">
- <title>gtk.ProgressBar.set_fraction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_fraction</methodname>
- <methodparam><parameter
- role="keyword">fraction</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">fraction</parameter>&nbsp;:</term>
- <listitem><simpara>the fraction of the task that's been
-completed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_fraction</methodname>() method causes the
-progress bar to "fill in" the portion of the bar specified by
-<parameter>fraction</parameter>. The value of
-<parameter>fraction</parameter> should be between 0.0 and 1.0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprogressbar--set-pulse-step">
- <title>gtk.ProgressBar.set_pulse_step</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_pulse_step</methodname>
- <methodparam><parameter
- role="keyword">fraction</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">fraction</parameter>&nbsp;:</term>
- <listitem><simpara>a value between 0.0 and
-1.0</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_pulse_step</methodname>() method sets the
-portion (specified by <parameter>fraction</parameter>) of the total progress
-bar length to move the bouncing block for each call to the <link
-linkend="method-gtkprogressbar--pulse"><methodname>pulse</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprogressbar--set-orientation">
- <title>gtk.ProgressBar.set_orientation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_orientation</methodname>
- <methodparam><parameter
- role="keyword">orientation</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">orientation</parameter>&nbsp;:</term>
- <listitem><simpara>the orientation of the progress
-bar</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_orientation</methodname>() method switches
-the progress bar to a different orientation as specified by the value of
-<parameter>orientation</parameter>. The value of
-<parameter>orientation</parameter> must be one of the <xref
-linkend="gtk-progressbar-orientation-constants"
-endterm="gtk-progressbar-orientation-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprogressbar--get-text">
- <title>gtk.ProgressBar.get_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the text, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_text</methodname>() method returns the text
-superimposed on the progress bar. If there is no superimposed text this
-method returns <literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprogressbar--get-fraction">
- <title>gtk.ProgressBar.get_fraction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_fraction</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a fraction from 0.0 to 1.0</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_fraction</methodname>() method returns the
-current fraction of the task that's been set by the <link
-linkend="method-gtkprogressbar--set-fraction"><methodname>set_fraction</methodname>()</link>
-method .</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprogressbar--get-pulse-step">
- <title>gtk.ProgressBar.get_pulse_step</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pulse_step</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a fraction from 0.0 to 1.0</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pulse_step</methodname>() method returns the
-pulse step set with the <link
-linkend="method-gtkprogressbar--set-pulse-step"><methodname>set_pulse_step</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprogressbar--get-orientation">
- <title>gtk.ProgressBar.get_orientation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_orientation</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the orientation of the progress
-bar</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_orientation</methodname>() method returns
-the current progress bar orientation. See the <link
-linkend="method-gtkprogressbar--set-orientation"><methodname>set_orientation</methodname>()</link>
-method for information about the orientation values.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprogressbar--set-ellipsize">
- <title>gtk.ProgressBar.set_ellipsize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_ellipsize</methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">mode</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
-linkend="pango-ellipsize-mode-constants"
-endterm="pango-ellipsize-mode-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_ellipsize</methodname>() method sets the
-mode used to ellipsize (add an ellipsis "...") the text if there is not
-enough space to render the entire string to the value specified by
-<parameter>mode</parameter>. <parameter>mode</parameter> must be one of the
-<xref linkend="pango-ellipsize-mode-constants"
-endterm="pango-ellipsize-mode-constants-title"></xref></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkprogressbar--get-ellipsize">
- <title>gtk.ProgressBar.get_ellipsize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_ellipsize</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the mode used to ellipsize
-text</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_ellipsize</methodname>() method returns the
-mode used to ellipsize text when there is not enough space. See the <link
-linkend="method-gtkprogressbar--set-ellipsize"><methodname>set_ellipsize</methodname>()</link>
-method for information.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkradioaction.xml b/docs/reference/pygtk-gtkradioaction.xml
deleted file mode 100644
index 7f7209f5..00000000
--- a/docs/reference/pygtk-gtkradioaction.xml
+++ /dev/null
@@ -1,341 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkradioaction">
- <refnamediv>
- <refname>gtk.RadioAction</refname>
-
- <refpurpose>an action that can be grouped so that only one can be
- active (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.RadioAction</classname></ooclass>
- <ooclass><classname><link linkend="class-gtktoggleaction">gtk.ToggleAction</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkradioaction">gtk.RadioAction</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- <methodparam><parameter role="keyword">tooltip</parameter></methodparam>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkradioaction--set-group">set_group</link></methodname>
- <methodparam><parameter role="keyword">group</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkradioaction--get-group">get_group</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkradioaction--get-current-value">get_current_value</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkaction">gtk.Action</link>
- +-- <link linkend="class-gtktoggleaction">gtk.ToggleAction</link>
- +-- <link linkend="class-gtkradioaction">gtk.RadioAction</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkradioaction">
- <title>gtk.RadioAction Properties</title>
-
- <para><link linkend="properties-gtkaction">gtk.Action Properties</link></para>
- <para><link linkend="properties-gtktoggleaction">gtk.ToggleAction Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"current-value"</entry>
- <entry>Read-Write</entry>
- <entry>The value property of the currently active member of the
- group to which this action belongs. This property is available in
- GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"group"</entry>
- <entry>Write</entry>
- <entry>Sets a new group for a radio action. This property is
- available in GTK+ 2.4 and above</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read-Write</entry>
-
- <entry>The value is an arbitrary integer which can be used as
- a convenient way to determine which action in the group is
- currently active in an "activate" or "changed" signal
- handler. See the <link
- linkend="method-gtkradioaction--get-current-value"><methodname>get_current_value</methodname>()</link>
- and the <link
- linkend="method-gtkactiongroup--add-radio-actions"><methodname>gtk.ActionGroup.add_radio_actions</methodname>()</link>
- methods for convenient ways to get and set this property. This
- property is available in GTK+ 2.4 and above</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkradioaction">
- <title>gtk.RadioAction Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkaction">gtk.Action Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktoggleaction">gtk.ToggleAction Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkradioaction--changed">changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>radioaction</parameter></methodparam>
- <methodparam><parameter>current</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link>
-is a subclass of <link
-linkend="class-gtktoggleaction"><classname>gtk.ToggleAction</classname></link>
-and similar to <link
-linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>.
-A number of radio actions can be linked together so that only one may be
-active at any one time.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkradioaction">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.RadioAction</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- <methodparam><parameter role="keyword">tooltip</parameter></methodparam>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter role="keyword">value</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>A unique name for the action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>The label displayed in menu items and on
- buttons</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tooltip</parameter>&nbsp;:</term>
- <listitem><simpara>A tooltip for this action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>The stock icon to display in widgets representing
- this action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>A unique integer value that <link
- linkend="method-gtkradioaction--get-current-value"><methodname>get_current_value()</methodname></link>
- should return if this action is selected.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link>
-object suing the properties specified by: <parameter>name</parameter>,
-<parameter>label</parameter>, <parameter>tooltip</parameter>,
-<parameter>stock_id</parameter> and <parameter>value</parameter>. To add the
-action to a <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-and set the accelerator for the action, call the <link
-linkend="method-gtkactiongroup--add-action-with-accel"><methodname>gtk.ActionGroup.add_action_with_accel()</methodname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkradioaction--set-group">
- <title>gtk.RadioAction.set_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_group</methodname>
- <methodparam><parameter role="keyword">group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">group</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
- linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link> or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_group</methodname>() method sets the radio
-group for the radio action to the same group as the <link
-linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link>
-specified by <parameter>group</parameter> i.e. the radio action joins the
-group.</para>
-
- <para>In PyGTK 2.6.2 and above, if <parameter>group</parameter> is
-<literal>None</literal> the radio action is removed from its current
-group.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkradioaction--get-group">
- <title>gtk.RadioAction.get_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_group</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list containing the radio actions in the
- group or <parameter>None</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_group</methodname>() method returns a list
-containing the group that the radio action belongs to or
-<literal>None</literal> if the radio action is not part of a group.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkradioaction--get-current-value">
- <title>gtk.RadioAction.get_current_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_current_value</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The value of the currently active group
- member</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_current_value</methodname>() method returns
-the "value" property of the the currently active member of the group that
-the radio action belongs to.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkradioaction--changed">
- <title>The "changed" gtk.RadioAction Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>radioaction</parameter></methodparam>
- <methodparam><parameter>current</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>radioaction</parameter>&nbsp;:</term>
- <listitem><simpara>the radioaction that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>current</parameter>&nbsp;:</term>
- <listitem><simpara>the currently active <link
- linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link>
- in the group</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "changed" signal is emitted on every member of a radio group
-when the active member is changed. The signal gets emitted after the
-"activate" signals for the previous and current active members.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkradiobutton.xml b/docs/reference/pygtk-gtkradiobutton.xml
deleted file mode 100644
index 11e7fb83..00000000
--- a/docs/reference/pygtk-gtkradiobutton.xml
+++ /dev/null
@@ -1,323 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkradiobutton">
- <refnamediv>
- <refname>gtk.RadioButton</refname>
- <refpurpose>a choice of one of multiple check buttons.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.RadioButton</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcheckbutton">gtk.CheckButton</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkradiobutton">gtk.RadioButton</link></methodname>
- <methodparam><parameter
- role="keyword">group</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">label</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkradiobutton--get-group">get_group</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkradiobutton--set-group">set_group</link></methodname>
- <methodparam><parameter
- role="keyword">group</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkbutton">gtk.Button</link>
- +-- <link linkend="class-gtktogglebutton">gtk.ToggleButton</link>
- +-- <link linkend="class-gtkcheckbutton">gtk.CheckButton</link>
- +-- <link linkend="class-gtkradiobutton">gtk.RadioButton</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkradiobutton">
- <title>gtk.RadioButton Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para>
- <para><link linkend="properties-gtktogglebutton">gtk.ToggleButton Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"group"</entry>
- <entry>Write</entry>
- <entry>The group that the radiobutton is in.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkradiobutton">
- <title>gtk.RadioButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para>
- <para><link linkend="style-properties-gtkcheckbutton">gtk.CheckButton Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkradiobutton">
- <title>gtk.RadioButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktogglebutton">gtk.ToggleButton Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkradiobutton--group-changed">group-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>radiobutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A single <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-performs the same basic function as a <link
-linkend="class-gtkcheckbutton"><classname>gtk.CheckButton</classname></link>,
-as it's position in the object hierarchy reflects. It is only when multiple
-radio buttons are grouped together that they become a different user
-interface component in their own right. Every radio button is a member of
-some group of radio buttons. When one is selected, all other radio buttons
-in the same group are deselected. A <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-is used to give the user a choice of one of many options.</para>
-
- <para>Radio button widgets are created with <link
-linkend="constructor-gtkradiobutton">gtk.RadioButton</link>() passing
-<literal>None</literal> as the <parameter>group</parameter> (first) argument
-if this is the first radio button in a group. In subsequent calls, pass a
-reference to a <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-as the first argument to specify the group. The second (optional) argument
-to <link linkend="constructor-gtkradiobutton">gtk.RadioButton</link>() is a
-label that is used to specify the text of the button. The label text is
-parsed for mnemonic characters (preceded by an underscore) to specify an
-accelerator for the radiobutton. See <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-and <link
-linkend="class-gtkaccellabel"><classname>gtk.AccelLabel</classname></link>
-for more information on mnemonic accelerators.</para>
-
- <para>To retrieve the group a <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-is assigned to, use the <link
-linkend="method-gtkradiobutton--get-group"><methodname>get_group</methodname>()</link>
-method. To remove a <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-from one group and make it part of a new one, use the <link
-linkend="method-gtkradiobutton--set-group"><methodname>set_group</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkradiobutton">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.RadioButton</methodname>
- <methodparam><parameter
- role="keyword">group</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">label</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">group</parameter>&nbsp;:</term>
- <listitem><simpara>an existing <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string to use as the button text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">use_underline</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, an underscore in the
-label text indicates the next character should be underlined and used for the
-mnemonic accelerator key if it is the first character so
-marked. Available in PyGTK 2.4 and above.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-widget with the label text specified by <parameter>label</parameter>, adding
-it to the same group as <parameter>group</parameter>.
-<parameter>label</parameter> is parsed for underscore characters that
-indicate mnemonic accelerators. If <parameter>label</parameter> is
-<literal>None</literal>, no label is created. If
-<parameter>group</parameter> is <literal>None</literal>, the new radiobutton
-becomes the first member of a new radiobutton group.</para>
-
- <para>In PyGTK 2.4 and above the <parameter>use_underline</parameter>
-parameter is available and defaults to <literal>True</literal>. If
-<parameter>use_underline</parameter> is set to <literal>False</literal> the
-label text will not be parsed for mnemonic characters.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkradiobutton--get-group">
- <title>gtk.RadioButton.get_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_group</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the list of radiobuttons in the same group that
-contains the radiobutton or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_group</methodname>() method returns the list
-of radiobuttons that are in the same group as the radiobutton or
-<literal>None</literal> if the radiobutton is not in a group.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkradiobutton--set-group">
- <title>gtk.RadioButton.set_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_group</methodname>
- <methodparam><parameter
- role="keyword">group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">group</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
- whose group the radiobutton will be added to or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_group</methodname>() method adds the
-radiobutton to the group of the radiobutton specified by
-<parameter>group</parameter>.</para>
-
- <para>In PyGTK 2.6.2 and above, if <parameter>group</parameter> is
-<literal>None</literal> the radiobutton is removed from its current
-group.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkradiobutton--group-changed">
- <title>The "group-changed" gtk.RadioButton Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>radiobutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>radiobutton</parameter>&nbsp;:</term>
- <listitem><simpara>the radiobutton that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "group-changed" signal is emitted when a <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-is added to or removed from the group.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkradiomenuitem.xml b/docs/reference/pygtk-gtkradiomenuitem.xml
deleted file mode 100644
index 90a7ed3c..00000000
--- a/docs/reference/pygtk-gtkradiomenuitem.xml
+++ /dev/null
@@ -1,294 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkradiomenuitem">
- <refnamediv>
- <refname>gtk.RadioMenuItem</refname>
- <refpurpose>a choice from multiple check menu items.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.RadioMenuItem</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcheckmenuitem">gtk.CheckMenuItem</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkradiomenuitem">gtk.RadioMenuItem</link></methodname>
- <methodparam><parameter role="keyword">group</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">label</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkradiomenuitem--get-group">get_group</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkradiomenuitem--set-group">set_group</link></methodname>
- <methodparam><parameter
- role="keyword">group</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkitem">gtk.Item</link>
- +-- <link linkend="class-gtkmenuitem">gtk.MenuItem</link>
- +-- <link linkend="class-gtkcheckmenuitem">gtk.CheckMenuItem</link>
- +-- <link linkend="class-gtkradiomenuitem">gtk.RadioMenuItem</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkradiomenuitem">
- <title>gtk.RadioMenuItem Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkcheckmenuitem">gtk.CheckMenuItem Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"group"</entry>
- <entry>Write</entry>
- <entry>The radio menu item whose group this widget belongs to.
- This property is available in GTK+ 2.8 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkradiomenuitem">
- <title>gtk.RadioMenuItem Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para>
- <para><link linkend="style-properties-gtkcheckmenuitem">gtk.CheckMenuItem Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkradiomenuitem">
- <title>gtk.RadioMenuItem Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcheckmenuitem">gtk.CheckMenuItem Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkradiomenuitem--group-changed">group-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>radiomenuitem</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
-widget is a check menu item that belongs to a group. Only one of the radio
-menu items in a group can be selected.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkradiomenuitem">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.RadioMenuItem</methodname>
- <methodparam><parameter role="keyword">group</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">label</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">group</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
-whose group the new radiomenuitem should be added to, or
-<literal>None</literal> if a new group should be
-created</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string to be used as the label text or
-<literal>None</literal> if no label is needed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">use_underline</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, an underscore in the
-label text indicates the next character should be underlined and used for the
-mnemonic accelerator key if it is the first character so
-marked. Available in PyGTK 2.4 and above.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
-containing a label with its text specified by <parameter>label</parameter>.
-<parameter>label</parameter> will be parsed for underscores that indicate
-the mnemonic accelerator for the radiomenuitem. The radiomenuitem will be
-added to the group containing the <link
-linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
-specified by <parameter>group</parameter>. If <parameter>group</parameter>
-is <literal>None</literal>, a new group will be created to hold the new
-radiomenuitem. If <parameter>label</parameter> is <literal>None</literal>
-the radiomenuitem is created without a label.</para>
-
- <para>In PyGTK 2.4 and above the <parameter>use_underline</parameter>
-parameter is available and defaults to <literal>True</literal>. If
-<parameter>use_underline</parameter> is set to <literal>False</literal> the
-label text will not be parsed for mnemonic characters.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkradiomenuitem--get-group">
- <title>gtk.RadioMenuItem.get_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_group</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the list of radiomenuitems in the same group
-that contains the radiomenuitem</simpara> or
- <literal> None</literal></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_group</methodname>() method returns the list
-of <link
-linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>s
-that are in the same group as the radiomenuitem or <literal>None</literal>
-if the radiomenuitem is not in a group.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkradiomenuitem--set-group">
- <title>gtk.RadioMenuItem.set_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_group</methodname>
- <methodparam><parameter
- role="keyword">group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">group</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
-whose group the radiomenuitem will be added to or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_group</methodname>() method adds the
-radiomenuitem to the group of the <link
-linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
-specified by <parameter>group</parameter>.</para>
-
- <para>In PyGTK 2.6.2 and above, if <parameter>group</parameter> is
-<literal>None</literal> the radiomenuitem will be removed from its current
-group.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkradiomenuitem--group-changed">
- <title>The "group-changed" gtk.RadioMenuItem Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>radiomenuitem</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>radiomenuitem</parameter>&nbsp;:</term>
- <listitem><simpara>the radiomenuitem that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "group-changed" signal is emitted when a <link
-linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
-is added to or removed from the group.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkradiotoolbutton.xml b/docs/reference/pygtk-gtkradiotoolbutton.xml
deleted file mode 100644
index 7bac5e60..00000000
--- a/docs/reference/pygtk-gtkradiotoolbutton.xml
+++ /dev/null
@@ -1,224 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkradiotoolbutton">
- <refnamediv>
- <refname>gtk.RadioToolButton</refname> <refpurpose>a toolbar item that
- contains a radio button (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.RadioToolButton</classname></ooclass>
- <ooclass><classname><link linkend="class-gtktoggletoolbutton">gtk.ToggleToolButton</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkradiotoolbutton">gtk.RadioToolButton</link></methodname>
- <methodparam><parameter role="keyword">group</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkradiotoolbutton--set-group">set_group</link></methodname>
- <methodparam><parameter role="keyword">group</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkradiotoolbutton--get-group">get_group</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtktoolitem">gtk.ToolItem</link>
- +-- <link linkend="class-gtktoolbutton">gtk.ToolButton</link>
- +-- <link linkend="class-gtktoggletoolbutton">gtk.ToggleToolButton</link>
- +-- <link linkend="class-gtkradiotoolbutton">gtk.RadioToolButton</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkradiotoolbutton">
- <title>gtk.RadioToolButton Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para>
- <para><link linkend="properties-gtktoolbutton">gtk.ToolButton Properties</link></para>
- <para><link linkend="properties-gtktoggletoolbutton">gtk.ToggleToolButton Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"group"</entry>
- <entry>Write</entry>
- <entry>Sets a new group for a radio tool button. This property
- is available in GTK+ 2.4 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkradiotoolbutton">
- <title>gtk.RadioToolButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtktoolbutton">gtk.ToolButton Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkradiotoolbutton">
- <title>gtk.RadioToolButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktoolbutton">gtk.ToolButton Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktoggletoolbutton">gtk.ToggleToolButton Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>
-is a <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> that
-contains a radio button, that is, a button that is part of a group of toggle
-buttons where only one button can be active at a time. Use the <link
-linkend="constructor-gtkradiotoolbutton">gtk.RadioToolButton</link>()
-constructor to create a new <link
-linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkradiotoolbutton">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.RadioToolButton</methodname>
- <methodparam><parameter role="keyword">group</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">group</parameter>&nbsp;:</term>
- <listitem><simpara>an existing <link
- linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara> the name of a stock item</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>,
-adding it to the same group as the <link
-linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>
-specified by <parameter>group</parameter> if it is not
-<literal>None</literal>. The new <link
-linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>
-will contain an icon and label from the stock item specified by
-<parameter>stock_id</parameter> if it is not <literal>None</literal>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkradiotoolbutton--set-group">
- <title>gtk.RadioToolButton.set_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_group</methodname>
- <methodparam><parameter role="keyword">group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">group</parameter>&nbsp;:</term>
- <listitem><simpara>an existing <link
- linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname> or <literal>None</literal>.</link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_group</methodname>() method adds the radio
-tool button to the same group as the <link
-linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>
-specified by <parameter>group</parameter>.</para>
-
- <para>In PyGTK 2.6.2 and above, if <parameter>group</parameter> is
-<literal>None</literal> the radiotoolbutton will be removed from its current
-group.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkradiotoolbutton--get-group">
- <title>gtk.RadioToolButton.get_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_group</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list containing the <link
- linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>s
- in the group</simpara> or <parameter> None</parameter></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_group</methodname>() method returns a list
-containing the <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-objects that are in the same group as the radio tool button or
-<literal>None</literal> if the radiotoolbutton is not in a group.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkrange.xml b/docs/reference/pygtk-gtkrange.xml
deleted file mode 100644
index e2ce9918..00000000
--- a/docs/reference/pygtk-gtkrange.xml
+++ /dev/null
@@ -1,790 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkrange">
- <refnamediv>
- <refname>gtk.Range</refname>
- <refpurpose>a base class for widgets that allow a user to set a value in
-a range.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Range</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrange--set-update-policy">set_update_policy</link></methodname>
- <methodparam><parameter
- role="keyword">policy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrange--get-update-policy">get_update_policy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrange--set-adjustment">set_adjustment</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrange--get-adjustment">get_adjustment</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrange--set-inverted">set_inverted</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrange--get-inverted">get_inverted</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrange--set-increments">set_increments</link></methodname>
- <methodparam><parameter
- role="keyword">step</parameter></methodparam>
- <methodparam><parameter
- role="keyword">page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrange--set-range">set_range</link></methodname>
- <methodparam><parameter role="keyword">min</parameter></methodparam>
- <methodparam><parameter role="keyword">max</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrange--set-value">set_value</link></methodname>
- <methodparam><parameter
- role="keyword">value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrange--get-value">get_value</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkrange">gtk.Range</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkrange">
- <title>gtk.Range Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"adjustment"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
- linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
- that contains the current value of this range object</entry>
- </row>
-
- <row valign="top">
- <entry>"inverted"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the slider movement is
- reversed e.g right-to-left instead of left-to-right</entry>
- </row>
-
- <row valign="top">
- <entry>"lower-stepper-sensitivity"</entry>
- <entry>Read-Write</entry>
- <entry>The sensitivity policy for the stepper that points to the
- adjustment's lower side</entry>
- </row>
-
- <row valign="top">
- <entry>"update-policy"</entry>
- <entry>Read-Write</entry>
- <entry>How the range should be updated on the screen:
- <literal>gtk.UPDATE_CONTINUOUS</literal>,
- <literal>gtk.UPDATE_DISCONTINUOUS</literal>,
- <literal>gtk.UPDATE_DELAYED</literal>.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkrange">
- <title>gtk.Range Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"activate-slider"</entry>
- <entry>Read</entry>
- <entry>With this option set to <literal>True</literal>,
- sliders will be drawn <literal>ACTIVE</literal> and with
- shadow <literal>IN</literal> while they are dragged</entry>
- </row>
-
- <row valign="top">
- <entry>"arrow-displacement-x"</entry>
- <entry>Read</entry>
- <entry>The distance horizontally to move the arrow when the
- button is depressed</entry>
- </row>
-
- <row valign="top">
- <entry>"arrow-displacement-y"</entry>
- <entry>Read</entry>
- <entry>The distance vertically to move the arrow when the
- button is depressed</entry>
- </row>
-
- <row valign="top">
- <entry>"slider-width"</entry>
- <entry>Read</entry>
- <entry>The width of scrollbar or scale thumb</entry>
- </row>
-
- <row valign="top">
- <entry>"stepper-size"</entry>
- <entry>Read</entry>
- <entry>The length of step buttons at ends</entry>
- </row>
-
- <row valign="top">
- <entry>"stepper-spacing"</entry>
- <entry>Read</entry>
- <entry>The spacing between step buttons and thumb</entry>
- </row>
-
- <row valign="top">
- <entry>"trough-border"</entry>
- <entry>Read</entry>
- <entry>The spacing between thumb or steppers and outer trough
- bevel</entry>
- </row>
-
- <row valign="top">
- <entry>"trough-side-details"</entry>
- <entry>Read</entry>
- <entry>This property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"trough-under-steppers"</entry>
- <entry>Read</entry>
- <entry>if <literal>True</literal> draw the trough across the
- full length of the range or to exclude the steppers and their
- spacing. Note that setting the "stepper-spacing" style
- property to any value &gt; 0 will automatically enable
- "trough-under-steppers" too. This property is available in
- GTK+ 2.10 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkrange">
- <title>gtk.Range Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkrange--adjust-bounds">adjust-bounds</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>range</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkrange--change-value">change-value</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>range</parameter></methodparam>
- <methodparam><parameter>scroll</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- <methodparam><parameter>arg1</parameter></methodparam>
- <methodparam><parameter>arg2</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkrange--move-slider">move-slider</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>range</parameter></methodparam>
- <methodparam><parameter>scrolltype</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkrange--value-changed">value-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>range</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkrange"><classname>gtk.Range</classname></link> is the base
-class for the <link
-linkend="class-gtkscale"><classname>gtk.Scale</classname></link> and <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>
-widgets. The <link
-linkend="class-gtkrange"><classname>gtk.Range</classname></link> provides
-the common functionality for these widgets that allow a user to set a value
-in a range of values. The <link
-linkend="class-gtkscale"><classname>gtk.Scale</classname></link> works in
-conjunction with a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-which provides the range information.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkrange--set-update-policy">
- <title>gtk.Range.set_update_policy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_update_policy</methodname>
- <methodparam><parameter
- role="keyword">policy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">policy</parameter>&nbsp;:</term>
- <listitem><simpara>the update policy:
-<literal>gtk.UPDATE_CONTINUOUS</literal>,
-<literal>gtk.UPDATE_DISCONTINUOUS</literal>,
-<literal>gtk.UPDATE_DELAYED</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_update_policy</methodname>() method sets the
-"update-policy" property to the value specified by
-<parameter>policy</parameter>. The update policy has the following values
-and effects:</para>
-
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.UPDATE_CONTINUOUS</literal></term>
- <listitem>
- <simpara>anytime the range slider is moved, the range value will
-change and the "value_changed" signal will be emitted.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UPDATE_DELAYED</literal></term>
- <listitem>
- <simpara>the value will be updated after a brief timeout where
-no slider motion occurs, so value changes are delayed slightly rather than
-continuously updated.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UPDATE_DISCONTINUOUS</literal></term>
- <listitem>
- <simpara>the value will only be updated when the user releases
-the button and ends the slider drag operation.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrange--get-update-policy">
- <title>gtk.Range.get_update_policy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_update_policy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current update policy</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_update_policy</methodname>() method gets the
-value of the "update-policy" property. The update policy is one of:
-<literal>gtk.UPDATE_CONTINUOUS</literal>,
-<literal>gtk.UPDATE_DISCONTINUOUS</literal> or
-<literal>gtk.UPDATE_DELAYED</literal>. See the <link
-linkend="method-gtkrange--set-update-policy"><methodname>set_update_policy</methodname>()</link>
-method for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrange--set-adjustment">
- <title>gtk.Range.set_adjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_adjustment</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_adjustment</methodname>() method sets the
-"adjustment" property to the value specified by
-<parameter>adjustment</parameter>. The <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-is used as the "model" object for this range widget.
-<parameter>adjustment</parameter> indicates the current range value, the
-minimum and maximum range values, the step and page increments used for
-keybindings and scrolling, and the page size. The page size is normally 0
-for <link linkend="class-gtkscale"><classname>gtk.Scale</classname></link>
-and nonzero for <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>,
-and indicates the size of the visible area of the widget being scrolled. The
-page size affects the size of the scrollbar slider.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrange--get-adjustment">
- <title>gtk.Range.get_adjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_adjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_adjustment</methodname>() method returns the
-value of the "adjustment" property. See the <link
-linkend="method-gtkrange--set-adjustment"><methodname>set_adjustment</methodname>()</link>
-method for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrange--set-inverted">
- <title>gtk.Range.set_inverted</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_inverted</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> invert the
-range</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_inverted</methodname>() method sets the
-"inverted" property to the value specified by
-<parameter>setting</parameter>. If <parameter>setting</parameter> is
-<literal>True</literal> the normal motion of the range widget is reversed.
-Ranges normally move from lower to higher values as the slider moves from
-top to bottom or left to right. Inverted ranges have higher values at the
-top or left rather than on the bottom or right.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrange--get-inverted">
- <title>gtk.Range.get_inverted</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_inverted</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the range is
-inverted</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_inverted</methodname>() method returns the
-value of the "inverted" property that was set by the <link
-linkend="method-gtkrange--set-inverted"><methodname>set_inverted</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrange--set-increments">
- <title>gtk.Range.set_increments</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_increments</methodname>
- <methodparam><parameter
- role="keyword">step</parameter></methodparam>
- <methodparam><parameter
- role="keyword">page</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">step</parameter>&nbsp;:</term>
- <listitem><simpara>the step size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>the page size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_increments</methodname>() method sets the
-step and page sizes for the range to the values specified by
-<parameter>step</parameter> and <parameter>page</parameter> respectively.
-The step size is used when the user clicks the <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>
-arrows or moves <link
-linkend="class-gtkscale"><classname>gtk.Scale</classname></link> via the
-arrow keys. The page size is used for example when moving via <keycap>Page
-Up</keycap> or <keycap>Page Down</keycap> keys.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrange--set-range">
- <title>gtk.Range.set_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_range</methodname>
- <methodparam><parameter
- role="keyword">min</parameter></methodparam>
- <methodparam><parameter
- role="keyword">max</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">min</parameter>&nbsp;:</term>
- <listitem><simpara>the minimum range value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">max</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum range value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_range</methodname>() method sets the minimum
-and maximum allowable values for the <link
-linkend="class-gtkrange"><classname>gtk.Range</classname></link> to that
-values specified by <parameter>min</parameter> and
-<parameter>max</parameter> respectively. If the range has a non-zero page
-size, it is also forced to be between <parameter>min</parameter> and
-<parameter>max</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrange--set-value">
- <title>gtk.Range.set_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_value</methodname>
- <methodparam><parameter
- role="keyword">value</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>the new value of the range</simpara></listitem>
- </varlistentry>
- </variablelist>
-
-
- <para>The <methodname>set_value</methodname>() method sets the current
-value of the range to the value specified by <parameter>value</parameter>.
-<parameter>value</parameter> will be forced inside the minimum or maximum
-range values. The range emits the "value_changed" signal if the value
-changes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrange--get-value">
- <title>gtk.Range.get_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_value</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current value of the
-range.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_value</methodname>() method gets the current
-value of the range.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkrange--adjust-bounds">
- <title>The "adjust-bounds" gtk.Range Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>range</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>range</parameter>&nbsp;:</term>
- <listitem><simpara>the range that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter>&nbsp;:</term>
- <listitem><simpara>the value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "adjust-bounds" signal is emitted when the range is adjusted
-by user action. Note the value can be more or less than the range since it
-depends on the mouse position.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkrange--change-value">
- <title>The "change-value" gtk.Range Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>range</parameter></methodparam>
- <methodparam><parameter>scroll</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>range</parameter>&nbsp;:</term>
- <listitem><simpara>the range that received the signal. the object
- which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>scroll</parameter>&nbsp;:</term>
- <listitem><simpara>the type of scroll action that was performed -
- one of the <xref linkend="gtk-scroll-type-constants"
- endterm="gtk-scroll-type-constants-title"></xref>..</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter>&nbsp;:</term>
- <listitem><simpara>the new value resulting from the scroll
- action.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to prevent other
- handlers from being invoked for the signal or
- <literal>False</literal> to propagate the signal
- further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.6 and above.</para>
- </note>
-
- <para>The "change-value" signal is emitted when a scroll action is
- performed on a range. It allows an application to determine the type
- of scroll event that occurred and the resultant new value. The
- application can handle the event itself and return
- <literal>True</literal> to prevent further processing. Or, by
- returning <literal>False</literal>, it can pass the event to other
- handlers until the default GTK+ handler is reached.</para>
-
- <para>The value parameter is unrounded. An application that overrides
- the "change-value" signal is responsible for clamping the value to the
- desired number of decimal digits.</para>
-
- <para>It is not possible to use delayed update policies in an
- overridden "change-value" handler.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkrange--move-slider">
- <title>The "move-slider" gtk.Range Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>range</parameter></methodparam>
- <methodparam><parameter>scrolltype</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>range</parameter>&nbsp;:</term>
- <listitem><simpara>the range that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>scrolltype</parameter>&nbsp;:</term>
- <listitem><simpara>the scroll type issued because a key was
- pressed by the user; one of the <xref
- linkend="gtk-scroll-type-constants"
- endterm="gtk-scroll-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-slider" signal is emitted when the user presses a key
-(e.g. <keycap>Page Up</keycap>, <keycap>Home</keycap>, <keycap>Right
-Arrow</keycap>) to move the slider.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkrange--value-changed">
- <title>The "value-changed" gtk.Range Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>range</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>range</parameter>&nbsp;:</term>
- <listitem><simpara>the range that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "value-changed" signal is emitted when the range value is
-changed either programmatically or by user action.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkrcstyle.xml b/docs/reference/pygtk-gtkrcstyle.xml
deleted file mode 100644
index 2222f2dd..00000000
--- a/docs/reference/pygtk-gtkrcstyle.xml
+++ /dev/null
@@ -1,979 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkrcstyle">
- <refnamediv>
- <refname>gtk.RcStyle</refname>
- <refpurpose>an object holding resource styles</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.RcStyle</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkrcstyle--copy">copy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-add-default-file">gtk.rc_add_default_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-set-default-files">gtk.rc_set_default_files</link></methodname>
- <methodparam><parameter role="keyword">filenames</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-default-files">gtk.rc_get_default_files</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-style-by-paths">gtk.rc_get_style_by_paths</link></methodname>
- <methodparam><parameter role="keyword">settings</parameter></methodparam>
- <methodparam><parameter role="keyword">widget_path</parameter></methodparam>
- <methodparam><parameter role="keyword">class_path</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-reparse-all-for-settings">gtk.rc_reparse_all_for_settings</link></methodname>
- <methodparam><parameter role="keyword">settings</parameter></methodparam>
- <methodparam><parameter role="keyword">force_load</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-reset-styles">gtk.rc_reset_styles</link></methodname>
- <methodparam><parameter role="keyword">settings</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-parse">gtk.rc_parse</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-parse-string">gtk.rc_parse_string</link></methodname>
- <methodparam><parameter role="keyword">rc_string</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-reparse-all">gtk.rc_reparse_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-find-module-in-path">gtk.rc_find_module_in_path</link></methodname>
- <methodparam><parameter role="keyword">module_file</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-theme-dir">gtk.rc_get_theme_dir</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-module-dir">gtk.rc_get_module_dir</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-im-module-path">gtk.rc_get_im_module_path</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--rc-get-im-module-file">gtk.rc_get_im_module_file</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkrcstyle">gtk.RcStyle</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkrcstyle">
- <title>gtk.RcStyle Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><literal>PyGTK</literal> via <literal>GTK+</literal> provides
-resource file mechanism for configuring various aspects of the operation of
-a program at runtime.</para>
-
- <title>Default files</title>
-
- <para>An application can cause <literal>GTK+</literal> to parse a
-specific RC file by calling the <link
-linkend="function-gtk--rc-parse"><function>gtk.rc_parse</function>()</link>
-function. In addition to this, certain files will be read at the end of
-<literal>GTK+</literal> initialization. Unless modified, the files looked
-for will be <filename>&lt;SYSCONFDIR&gt;/gtk-2.0/gtkrc</filename> and
-.gtkrc-2.0 in the users home directory. (&lt;SYSCONFDIR&gt; defaults to
-<filename>/usr/local/etc</filename>.) The set of these default files can be
-retrieved with the <link
-linkend="function-gtk--rc-get-default-files"><function>gtk.rc_get_default_files</function>()</link>
-function and modified with the <link
-linkend="function-gtk--rc-add-default-file"><function>gtk.rc_add_default_file</function>()</link>
-and <link
-linkend="function-gtk--rc-set-default-files"><function>gtk.rc_set_default_files</function>()</link>
-functions. Additionally, the <envar>GTK_RC_FILES</envar> environment
-variable can be set to a list of files in order to overwrite the set of
-default files at runtime.</para>
-
- <para>For each RC file, in addition to the file itself,
-<literal>GTK+</literal> will look for a locale-specific file that will be
-parsed after the main file. For instance, if <envar>LANG</envar> is set to
-<literal>ja_JP.ujis</literal>, when loading the default file
-<filename>~/.gtkrc</filename> then <literal>GTK+</literal> looks for
-<filename>~/.gtkrc.ja_JP</filename> and <filename>~/.gtkrc.ja</filename>,
-and parses the first of those that exists.</para>
-
-<title>Pathnames and patterns</title>
-
-<para>A resource file defines a number of styles and key bindings and
-attaches them to particular widgets. The attachment is done by the widget,
-widget_class, and class declarations. As an example of such a
-statement:</para>
-
- <programlisting>
- widget "mywindow.*.GtkEntry" style "my-entry-class"
-</programlisting>
-
-<para>attaches the style "my-entry-class" to all widgets whose widget class
-matches the pattern "mywindow.*.GtkEntry". The patterns here are given in
-the standard shell glob syntax. The "?" wildcard matches any character,
-while "*" matches zero or more of any character. The three types of matching
-are against the widget path, the class path and the class hierarchy. Both
-the widget and the class paths consists of a "." separated list of all the
-parents of the widget and the widget itself from outermost to innermost. The
-difference is that in the widget path, the name assigned by the <link
-linkend="method-gtkwidget--set-name"><methodname>set_name</methodname>()</link>
-method is used if present, otherwise the class name of the widget, while for
-the widget path, the class name is always used. So, if you have a <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> named
-"myentry", inside of a of a window named "mywindow", then the widget path
-is: "mwindow.GtkHBox.myentry" while the class path is:
-"GtkWindow.GtkHBox.GtkEntry".</para>
-
-<para>Matching against class is a little different. The pattern match is
-done against all class names in the widgets class hierarchy (not the layout
-hierarchy) in sequence, so the pattern:</para>
-
- <programlisting>
- class "GtkButton" style "my-style"
-</programlisting>
-
- <para>will match not just <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link> widgets,
-but also <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-and <link
-linkend="class-gtkcheckbutton"><classname>gtk.CheckButton</classname></link>
-widgets, since those classes derive from <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link>.</para>
-
- <title>Toplevel declarations</title>
-
-<para>An RC file is a text file which is composed of a sequence of
-declarations. '#' characters delimit comments and the portion of a line
-after a '#' is ignored when parsing an RC file. The possible toplevel
-declarations are:</para>
-
- <variablelist>
- <varlistentry>
- <term>binding&nbsp;<parameter>name</parameter>&nbsp;{&nbsp;...&nbsp;}</term>
- <listitem>
- <simpara>Declares a binding set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>class&nbsp;<parameter>pattern</parameter>&nbsp;[&nbsp;style&nbsp;|&nbsp;binding&nbsp;[&nbsp;:&nbsp;priority&nbsp;]]&nbsp;<parameter>name</parameter></term>
- <listitem>
- <simpara>Specifies a style or binding set for a particular branch
-of the inheritance hierarchy.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>include&nbsp;<parameter>filename</parameter></term>
- <listitem>
- <simpara>Parses another file at this point. If
-<parameter>filename</parameter> is not an absolute filename, it is searched
-in the directories of the currently open RC files. <literal>GTK+</literal>
-also tries to load a locale-specific variant of the included file.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>module_path&nbsp;<parameter>path</parameter></term>
- <listitem>
- <simpara>Sets a path (a list of directories separated by colons)
-that will be searched for theme engines referenced in RC files.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>pixmap_path&nbsp;<parameter>path</parameter></term>
- <listitem>
- <simpara>Sets a path (a list of directories separated by colons)
-that will be searched for pixmaps referenced in RC files.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>style&nbsp;<parameter>name</parameter>&nbsp;[&nbsp;=&nbsp;<parameter>parent</parameter>&nbsp;]&nbsp;{&nbsp;...&nbsp;}</term>
- <listitem>
- <simpara>Declares a style.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>widget&nbsp;<parameter>pattern</parameter>&nbsp;[&nbsp;style&nbsp;|&nbsp;binding&nbsp;[&nbsp;:&nbsp;priority&nbsp;]]&nbsp;<parameter>name</parameter></term>
- <listitem>
- <simpara>Specifies a style or binding set for a particular group
-of widgets by matching on the widget pathname.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>widget_class&nbsp;<parameter>pattern</parameter>&nbsp;[&nbsp;style&nbsp;|&nbsp;binding&nbsp;[&nbsp;:&nbsp;priority&nbsp;]]&nbsp;<parameter>name</parameter></term>
- <listitem>
- <simpara>Specifies a style or binding set for a particular group
-of widgets by matching on the class pathname.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <title>Styles</title>
-
- <para>A RC style is specified by a style declaration in a RC file, and
-then bound to widgets with a <literal>widget</literal>,
-<literal>widget_class</literal>, or <literal>class</literal> declaration.
-All styles applying to a particular widget are composited together with
-widget declarations overriding <literal>widget_class</literal> declarations
-which, in turn, override <literal>class</literal> declarations. Within each
-type of declaration, later declarations override earlier ones. Within a
-style declaration, the possible elements are:</para>
-
- <variablelist role="old">
- <varlistentry>
- <term>bg[<parameter>state</parameter>]&nbsp;=&nbsp;<parameter>color</parameter></term>
- <listitem>
- <simpara>Sets the color used for the background of most
-widgets.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>fg[<parameter>state</parameter>]&nbsp;=&nbsp;<parameter>color</parameter></term>
- <listitem>
- <simpara>Sets the color used for the foreground of most
-widgets.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>base[<parameter>state</parameter>]&nbsp;=&nbsp;<parameter>color</parameter></term>
- <listitem>
- <simpara>Sets the color used for the background of widgets
-displaying editable text. This color is used for the background of, among
-others, <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link> and
-<link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>text[<parameter>state</parameter>]&nbsp;=&nbsp;<parameter>color</parameter></term>
- <listitem>
- <simpara>Sets the color used for foreground of widgets using
-<parameter>base</parameter> for the background color.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>bg_pixmap[<parameter>state</parameter>]&nbsp;=&nbsp;<parameter>pixmap</parameter></term>
- <listitem>
- <simpara> Sets a background pixmap to be used in place of the
-<literal>bg</literal> color (or for <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>, in
-place of the <literal>base</literal> color). The special value
-"&lt;parent&gt;" may be used to indicate that the widget should use the same
-background pixmap as its parent. The special value "&lt;none&gt;" may be
-used to indicate no background pixmap.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>font&nbsp;=&nbsp;<parameter>font</parameter></term>
- <listitem>
- <simpara>Sets the font for a widget. font must be a XLFD font
-description, e.g.
-"-*-helvetica-medium-r-normal--10-*-*-*-*-*-*-*".</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>fontset&nbsp;=&nbsp;<parameter>font</parameter></term>
- <listitem>
- <simpara>Sets the fontset for a widget. Overrides any font
-declarations. font must be a comma-separated list of XLFD font descriptions,
-e.g. "-JIS-Fixed-Medium-R-Normal--26-180-100-100-C-240,
--JIS-Fixed-Medium-R-Normal--26-180-100-100-C-120,
--GB-Fixed-Medium-R-Normal--26-180-100-100-C-240,
--Adobe-Courier-Bold-R-Normal--25-180-100-100-M-150".</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>font_name&nbsp;=&nbsp;<parameter>font</parameter></term>
- <listitem>
- <simpara>Sets the font for a widget. Overrides any
-<literal>font</literal> or <literal>fontset</literal> declarations.
-<parameter>font</parameter> must be a Pango font name, e.g. "Sans Italic
-10".</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>stock["<parameter>stock-id</parameter>"]&nbsp;=&nbsp;{&nbsp;<parameter>icon&nbsp;source&nbsp;specifications</parameter>&nbsp;}</term>
- <listitem>
- <simpara>Defines the icon for a stock item.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>engine&nbsp;"<parameter>engine</parameter>"&nbsp;{&nbsp;<parameter>engine-specific&nbsp;settings</parameter>&nbsp;}</term>
- <listitem>
- <simpara>Defines the engine to be used when drawing with this
-style.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>class</parameter>::<parameter>property</parameter>&nbsp;=&nbsp;<parameter>value</parameter></term>
- <listitem>
- <simpara>Sets a <link
-linkend="widget-style-properties">style property</link> for a widget
-class.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The colors and background pixmaps are specified as a function of
-the state of the widget. The states are:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>NORMAL</literal></term>
- <listitem>
- <simpara>A color used for a widget in its normal state.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>ACTIVE</literal></term>
- <listitem>
- <simpara>A variant of the <literal>NORMAL</literal> color used
-when the widget is in the <literal>gtk.STATE_ACTIVE</literal> state, and
-also for the trough of a <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>,
-tabs of a <link
-linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link> other
-than the current tab and similar areas. Frequently, this should be a darker
-variant of the <literal>NORMAL</literal> color.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>PRELIGHT</literal></term>
- <listitem>
- <simpara>A color used for widgets in the
-<literal>gtk.STATE_PRELIGHT</literal> state. This state is the used for
-<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link> and
-<link linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-widgets that have the mouse cursor over them, and for their
-children.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>SELECTED</literal></term>
- <listitem>
- <simpara>A color used to highlight data selected by the user. for
-instance, the selected items in a list widget, and the selection in an
-editable widget.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>INSENSITIVE</literal></term>
- <listitem>
- <simpara>A color used for the background of widgets that have been
-set insensitive with the <link
-linkend="method-gtkwidget--set-sensitive"><methodname>set_sensitive</methodname>()</link>
-method.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>Colors can be specified as a string containing a color name (from
-the X color database <filename>/usr/lib/X11/rgb.txt</filename>), in one of
-the hexadecimal forms <literal>#rrrrggggbbbb</literal>,
-<literal>#rrrgggbbb</literal>, <literal>#rrggbb</literal>, or
-<literal>#rgb</literal>, where <literal>r</literal>, <literal>g</literal>
-and <literal>b</literal> are hex digits, or they can be specified as a
-triplet <literal>{ r, g, b}</literal>, where <literal>r</literal>,
-<literal>g</literal> and <literal>b</literal> are either integers in the
-range 0-65635 or floats in the range 0.0-1.0.</para>
-
-<para>In a stock definition, icon sources are specified as a 4-tuple of
-image filename, text direction, widget state, and size, in that order. Each
-icon source specifies an image filename to use with a given direction,
-state, and size. The * character can be used as a wildcard, and if
-direction-state-size are omitted they default to *. So for example, the
-following specifies different icons to use for left-to-right and
-right-to-left languages:</para>
-
- <programlisting>
- stock["my-stock-item"] =
- {
- { "itemltr.png", LTR, *, * },
- { "itemrtl.png", RTL, *, * }
- }
-</programlisting>
-
- <para>This could be abbreviated as follows:</para>
-
- <programlisting>
- stock["my-stock-item"] =
- {
- { "itemltr.png", LTR },
- { "itemrtl.png", RTL }
- }
-</programlisting>
-
- <para>You can specify custom icons for specific sizes, as
-follows:</para>
-
- <programlisting>
- stock["my-stock-item"] =
- {
- { "itemmenusize.png", *, *, "gtk-menu" },
- { "itemtoolbarsize.png", *, *, "gtk-large-toolbar" }
- { "itemgeneric.png" } /* implicit *, *, * as a fallback */
- }
-</programlisting>
-
- <para>The sizes that come with <literal>GTK+</literal> itself are
-"gtk-menu", "gtk-small-toolbar", "gtk-large-toolbar", "gtk-button",
-"gtk-dialog". Applications can define other sizes. It's also possible to use
-custom icons for a given state, for example:</para>
-
- <programlisting>
- stock["my-stock-item"] =
- {
- { "itemprelight.png", *, PRELIGHT },
- { "iteminsensitive.png", *, INSENSITIVE },
- { "itemgeneric.png" } /* implicit *, *, * as a fallback */
- }
-</programlisting>
-
- <para>When selecting an icon source to use, <literal>GTK+</literal> will
-consider text direction most important, state second, and size third. It
-will select the best match based on those criteria. If an attribute matches
-exactly (e.g. you specified <literal>PRELIGHT</literal> or specified the
-size), <literal>GTK+</literal> won't modify the image; if the attribute
-matches with a wildcard, <literal>GTK+</literal> will scale or modify the
-image to match the state and size the user requested.</para>
-
- <title>Key bindings</title>
-
-<para>Key bindings allow the user to specify actions to be taken on
-particular key presses. The form of a binding set declaration is:</para>
-
- <programlisting>
- binding name {
- bind key {
- signalname (param, ...)
- ...
- }
- ...
- }
-</programlisting>
-
- <para><parameter>key</parameter> is a string consisting of a series of
-modifiers followed by the name of a key. The modifiers can be:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>&lt;alt&gt;</simpara>
- </listitem>
- <listitem>
- <simpara>&lt;control&gt;</simpara>
- </listitem>
- <listitem>
- <simpara>&lt;mod1&gt;</simpara>
- </listitem>
- <listitem>
- <simpara>&lt;mod2&gt;</simpara>
- </listitem>
- <listitem>
- <simpara>&lt;mod3&gt;</simpara>
- </listitem>
- <listitem>
- <simpara>&lt;mod4&gt;</simpara>
- </listitem>
- <listitem>
- <simpara>&lt;mod5&gt;</simpara>
- </listitem>
- <listitem>
- <simpara>&lt;release&gt;</simpara>
- </listitem>
- <listitem>
- <simpara>&lt;shft&gt;</simpara>
- </listitem>
- <listitem>
- <simpara>&lt;shift&gt;</simpara>
- </listitem>
- </itemizedlist>
-
- <para>&lt;shft&gt; is an alias for &lt;shift&gt; and &lt;alt&gt; is an
-alias for &lt;mod1&gt;.</para>
-
- <para>The action that is bound to the key is a sequence of signal names
-(strings) followed by parameters for each signal. The signals must be action
-signals. Each parameter can be a float, integer, string, or unquoted string
-representing an enumeration value. The types of the parameters specified
-must match the types of the parameters of the signal. Binding sets are
-connected to widgets in the same manner as styles, with one addition. A
-priority can be specified for each pattern, and within each type of pattern,
-binding sets override other binding sets first by priority, and only then by
-order of specification. (Later overrides earlier). The priorities that can
-be specified are (highest to lowest):</para>
-
- <itemizedlist>
- <listitem>
- <simpara>highest</simpara>
- </listitem>
- <listitem>
- <simpara>rc</simpara>
- </listitem>
- <listitem>
- <simpara>theme</simpara>
- </listitem>
- <listitem>
- <simpara>application</simpara>
- </listitem>
- <listitem>
- <simpara>gtk</simpara>
- </listitem>
- <listitem>
- <simpara>lowest</simpara>
- </listitem>
- </itemizedlist>
-
- <para><literal>rc</literal> is the default for bindings read from an RC
-file, <literal>theme</literal> is the default for bindings read from theme
-RC files, <literal>application</literal> should be used for bindings an
-application sets up, and <literal>gtk</literal> is used for bindings that
-<literal>GTK+</literal> creates internally.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkrcstyle--copy">
- <title>gtk.RcStyle.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkrcstyle"><classname>gtk.RcStyle</classname></link> that is
-a copy of the rcstyle</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The copy() method returns a new <link
-linkend="class-gtkrcstyle"><classname>gtk.RcStyle</classname></link> that is
-a copy of the RC style. This method will correctly copy an RC style that is
-a member of a class derived from <link
-linkend="class-gtkrcstyle"><classname>gtk.RcStyle</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--rc-add-default-file">
- <title>gtk.rc_add_default_file</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_add_default_file</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a file containing resource
-data</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_add_default_file</function>() function adds
-the file specified by <parameter>filename</parameter> to the list of files
-to be parsed for resource data.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-set-default-files">
- <title>gtk.rc_set_default_files</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_set_default_files</methodname>
- <methodparam><parameter
- role="keyword">filenames</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">filenames</parameter>&nbsp;:</term>
- <listitem><simpara>a list of filenames</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_set_default_files</function>() function
-sets the list of files (specified by <parameter>filenames</parameter>) that
-will be parsed for resource information.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-get-default-files">
- <title>gtk.rc_get_default_files</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_get_default_files</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current list of resource
-files</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_get_default_files</function>() function
-returns a list of filenames (as set by the <link
-linkend="function-gtk--rc-set-default-files"><function>gtk.rc_set_default_files</function>()</link>
-function) that will be parsed for resource data.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-get-style-by-paths">
- <title>gtk.rc_get_style_by_paths</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_get_style_by_paths</methodname>
- <methodparam><parameter
- role="keyword">settings</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">class_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">settings</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">widget_path</parameter>&nbsp;:</term>
- <listitem><simpara>the widget path to use when looking up the
-style</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">class_path</parameter>&nbsp;:</term>
- <listitem><simpara>the class path to use when looking up the
-style</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a type that will be used along with parent
-types of this type when matching against class styles, or
-<literal>gobject.TYPE_NONE</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> created by
-matching with the supplied paths, or <literal>None</literal> if nothing
-matching was specified and the default style should be
-used.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_get_style_by_paths</function>() function
-returns a <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> created
-from styles defined in a RC file by providing the raw components used in
-matching. This function may be useful when creating pseudo-widgets that
-should be themed like widgets but don't actually have corresponding
-<literal>PyGTK</literal> widgets. An example of this would be items inside a
-<literal>GNOME</literal> canvas widget.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-reparse-all-for-settings">
- <title>gtk.rc_reparse_all_for_settings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_reparse_all_for_settings</methodname>
- <methodparam><parameter
- role="keyword">settings</parameter></methodparam>
- <methodparam><parameter
- role="keyword">force_load</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">settings</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">force_load</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> reparse the RC files
-even if they haven't changed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the files were
-reparsed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_reparse_all_for_settings</function>()
-function reparses the files associated with the <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object specified by <parameter>settings</parameter> if any of the files have
-changed and <parameter>force_load</parameter> is <literal>False</literal>
-and . If <parameter>force_load</parameter> is <literal>True</literal> the
-files are always reparsed.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-reset-styles">
- <title>gtk.rc_reset_styles</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_reset_styles</methodname>
- <methodparam><parameter role="keyword">settings</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">settings</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.rc_reset_styles</function>() function returns
-a <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link>. This
-function computes the styles for all widgets that use the <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object specified by <parameter>settings</parameter>. (There is one <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object per <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>, see
-the <link
-linkend="function-gtk--settings-get-for-screen"><function>gtk.settings_get_for_screen</function>()</link>
-function). It is useful when some global parameter has changed that affects
-the appearance of all widgets, because when a widget gets a new style, it
-will both redraw and recompute any cached information about its
-appearance. As an example, it is used when the default font size set by the
-operating system changes. Note that this function doesn't affect widgets
-that have a style set explicitly on them with the <link
-linkend="method-gtkwidget--set-style"><methodname>gtk.Widget.set_style</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-parse">
- <title>gtk.rc_parse</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_parse</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a file to parse for resource
-data</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_parse</function>() function parses the file
-specified by <parameter>filename</parameter> for resource data.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-parse-string">
- <title>gtk.rc_parse_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_parse_string</methodname>
- <methodparam><parameter
- role="keyword">rc_string</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">rc_string</parameter>&nbsp;:</term>
- <listitem><simpara>a string to parse for resource
-data</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_parse_string</function>() function parses
-the string specified by <parameter>rc_string</parameter> for resource
-data.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-reparse-all">
- <title>gtk.rc_reparse_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_reparse_all</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the files were
-reparsed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_reparse_all</function>() function discards
-all style data and reparses all the RC files for resource data if any of
-them have changed.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-find-module-in-path">
- <title>gtk.rc_find_module_in_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_find_module_in_path</methodname>
- <methodparam><parameter
- role="keyword">module_file</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">module_file</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a theme engine</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the filename of the theme engine or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_find_module_in_path</function>() function
-searches for a theme engine named by <parameter>module_file</parameter>.
-This function is not useful for applications and should not be used.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-get-theme-dir">
- <title>gtk.rc_get_theme_dir</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_get_theme_dir</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the themes
-directory</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_get_theme_dir</function>() function returns
-the name of the directory where themes should be installed.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-get-module-dir">
- <title>gtk.rc_get_module_dir</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_get_module_dir</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the theme engines directory
-name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_get_module_dir</function>() function
-returns the name of the directory where <literal>PyGTK</literal> searches
-for theme engines.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-get-im-module-path">
- <title>gtk.rc_get_im_module_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_get_im_module_path</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the IM modules path</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_get_im_module_path</function>() function
-returns the path where <literal>PyGTK</literal> searches for IM
-modules.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--rc-get-im-module-file">
- <title>gtk.rc_get_im_module_file</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.rc_get_im_module_file</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the IM modules
-file</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.rc_get_im_module_file</function>() function
-returns the name of the <literal>PyGTK</literal> IM modules file.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkrecentchooser.xml b/docs/reference/pygtk-gtkrecentchooser.xml
deleted file mode 100644
index f138ea17..00000000
--- a/docs/reference/pygtk-gtkrecentchooser.xml
+++ /dev/null
@@ -1,1273 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkrecentchooser">
-
- <refnamediv>
- <refname>gtk.RecentChooser</refname>
- <refpurpose>an interface implemented by <link
- linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>,
- <link
- linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link>
- and <link
- linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link> (new in PyGTK 2.10)
- </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.RecentChooser</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-show-private">set_show_private</link></methodname>
- <methodparam><parameter role="keyword">show_private</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-show-private">get_show_private</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-show-not-found">set_show_not_found</link></methodname>
- <methodparam><parameter role="keyword">show_not_found</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-show-not-found">get_show_not_found</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-select-multiple">set_select_multiple</link></methodname>
- <methodparam><parameter role="keyword">select_multiple</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-select-multiple">get_select_multiple</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-limit">set_limit</link></methodname>
- <methodparam><parameter role="keyword">limit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-limit">get_limit</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-local-only">set_local_only</link></methodname>
- <methodparam><parameter role="keyword">local_only</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-local-only">get_local_only</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-show-tips">set_show_tips</link></methodname>
- <methodparam><parameter role="keyword">show_tips</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-show-tips">get_show_tips</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-show-numbers">set_show_numbers</link></methodname>
- <methodparam><parameter role="keyword">show_numbers</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-show-numbers">get_show_numbers</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-show-icons">set_show_icons</link></methodname>
- <methodparam><parameter role="keyword">show_icons</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-show-icons">get_show_icons</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-sort-type">set_sort_type</link></methodname>
- <methodparam><parameter role="keyword">sort_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-sort-type">get_sort_type</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-sort-func">set_sort_func</link></methodname>
- <methodparam><parameter role="keyword">sort_func</parameter></methodparam>
- <methodparam><parameter role="keyword">sort_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-current-uri">set_current_uri</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-current-uri">get_current_uri</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-current-item">get_current_item</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--select-uri">select_uri</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--unselect-uri">unselect_uri</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--select-all">select_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--unselect-all">unselect_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-items">get_items</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-uris">get_uris</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--add-filter">add_filter</link></methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--remove-filter">remove_filter</link></methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--list-filters">list_filters</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--set-filter">set_filter</link></methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchooser--get-filter">get_filter</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gtkrecentchooser">gtk.RecentChooser</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkrecentchooser">
- <title>gtk.RecentChooser Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"filter"</entry>
- <entry>Read-Write</entry>
- <entry>The current <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
- for selecting which resources are displayed</entry>
- </row>
-
- <row valign="top">
- <entry>"limit"</entry>
- <entry>Read-Write</entry>
- <entry>The maximum number of items to be displayed</entry>
- </row>
-
- <row valign="top">
- <entry>"local-only"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>True</literal> the selected resource(s) should
- be limited to local file: URIs</entry>
- </row>
-
- <row valign="top">
- <entry>"recent-manager"</entry>
- <entry>Write-Construct Only</entry>
- <entry>The RecentManager object to use</entry>
- </row>
-
- <row valign="top">
- <entry>"select-multiple"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>True</literal> allow multiple items to be
- selected</entry>
- </row>
-
- <row valign="top">
- <entry>"show-icons"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>True</literal> there should be an icon near the
- item</entry>
- </row>
-
- <row valign="top">
- <entry>"show-not-found"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>True</literal> the items pointing to
- unavailable resources should be displayed</entry>
- </row>
-
- <row valign="top">
- <entry>"show-private"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>True</literal> the private items should be
- displayed</entry>
- </row>
-
- <row valign="top">
- <entry>"show-tips"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>True</literal> there should be a tooltip on the
- item</entry>
- </row>
-
- <row valign="top">
- <entry>"sort-type"</entry>
- <entry>Read-Write</entry>
- <entry>The sorting order of the items displayed - one of the <xref
- linkend="gtk-recent-sort-type-constants"
- endterm="gtk-recent-sort-type-constants-title"></xref></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkrecentchooser">
- <title>gtk.RecentChooser Signal Prototypes</title>
-
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkrecentchooser--item-activated">item-activated</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>chooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkrecentchooser--selection-changed">selection-changed</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>chooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>
- is an interface that can be implemented by widgets displaying the list
- of recently used files. In PyGTK, the main objects that implement this
- interface are <link
- linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>,
- <link
- linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>
- and <link
- linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link>.</para>
-
- <para>Recently used files are supported since GTK+ 2.10.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkrecentchooser--set-show-private">
- <title>gtk.RecentChooser.set_show_private</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_private</methodname>
- <methodparam><parameter role="keyword">show_private</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">show_private</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> show private
- items</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the "show-private" property to the value of
- <parameter>show_private</parameter>. If
- <parameter>show_private</parameter> is <literal>True</literal> show
- recently used resources marked registered as private.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-show-private">
- <title>gtk.RecentChooser.get_show_private</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_private</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the recent chooser
- should show private items.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if recently used resources
- registered as private should be displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--set-show-not-found">
- <title>gtk.RecentChooser.set_show_not_found</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_not_found</methodname>
- <methodparam><parameter role="keyword">show_not_found</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">show_not_found</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> show the local items
- we didn't find</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the "show-not'found" property to the value specified by
- <parameter>show_not_found</parameter>. If
- <parameter>show_not_found</parameter> is <literal>True</literal>,
- display the recently used resources that it didn't find. This only
- applies to local resources.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-show-not-found">
- <title>gtk.RecentChooser.get_show_not_found</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_not_found</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the resources not
- found should be displayed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if the recently used resources
- that were not found shoudl be shown.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--set-select-multiple">
- <title>gtk.RecentChooser.set_select_multiple</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_select_multiple</methodname>
- <methodparam><parameter role="keyword">select_multiple</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">select_multiple</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> more than one item
- can be selected</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the "select-multiple" property to the value of
- <parameter>select_multiple</parameter>. If
- <parameter>select_mulitple</parameter> is <literal>True</literal>
- multiple items can be selected.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-select-multiple">
- <title>gtk.RecentChooser.get_select_multiple</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_select_multiple</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if more than one item
- can be selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if multiple items can be
- selected.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--set-limit">
- <title>gtk.RecentChooser.set_limit</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_limit</methodname>
- <methodparam><parameter role="keyword">limit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">limit</parameter>&nbsp;:</term>
- <listitem><simpara>a positive integer, or -1 for all items</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the number of items that should be returned by the <link
- linkend="method-gtkrecentchooser--get-items"><methodname>gtk.RecentChooser.get_items()</methodname></link>
- and <link
- linkend="method-gtkrecentchooser--get-uris"><methodname>gtk.RecentChooser.get_uris()</methodname></link>
- methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-limit">
- <title>gtk.RecentChooser.get_limit</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_limit</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A positive integer, or -1 meaning that all
- items are returned.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the number of items that can be returned by the <link
- linkend="method-gtkrecentchooser--get-items"><methodname>gtk.RecentChooser.get_items()</methodname></link>
- and <link
- linkend="method-gtkrecentchooser--get-uris"><methodname>gtk.RecentChooser.get_uris()</methodname></link>
- methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--set-local-only">
- <title>gtk.RecentChooser.set_local_only</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_local_only</methodname>
- <methodparam><parameter role="keyword">local_only</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">local_only</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> only local files can
- be shown</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the "local-only" property to the value of
- <parameter>local_only</parameter>. If
- <parameter>local_only</parameter> is <literal>True</literal> only
- local resources, that is resources using the file:// URI scheme,
- should be shown in the recently used resources selector. If
- <parameter>local_only</parameter> is <literal>True</literal> (the
- default) then the resources shown are guaranteed to be accessible
- through the operating system native file system.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-local-only">
- <title>gtk.RecentChooser.get_local_only</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_local_only</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if only local resources
- should be shown.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if only local resources should
- be shown in the recently used resources selector. See the <link
- linkend="method-gtkrecentchooser--set-local-only"><methodname>gtk.RecentChooser.set_local_only()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--set-show-tips">
- <title>gtk.RecentChooser.set_show_tips</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_tips</methodname>
- <methodparam><parameter role="keyword">show_tips</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">show_tips</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> tooltips should be
- shown</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the "show-tips" property to the value of
- <parameter>show_tips</parameter>. If <parameter>show_tips</parameter>
- is <literal>True</literal>, show a tooltips on the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-show-tips">
- <title>gtk.RecentChooser.get_show_tips</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_tips</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the recent chooser
- should show tooltips.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if tooltips should be
- displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--set-show-numbers">
- <title>gtk.RecentChooser.set_show_numbers</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_numbers</methodname>
- <methodparam><parameter role="keyword">show_numbers</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">show_numbers</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> show
- numbers</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the "show-number" property to the value of
- <parameter>show_numbers</parameter>. If
- <parameter>show_numbers</parameter> is <literal>True</literal>, show
- recently used resources prepended by a unique number.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-show-numbers">
- <title>gtk.RecentChooser.get_show_numbers</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_numbers</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the recent chooser
- should show display numbers.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if recently used resources
- should be displayed prepended by a unique number.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--set-show-icons">
- <title>gtk.RecentChooser.set_show_icons</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_icons</methodname>
- <methodparam><parameter role="keyword">show_icons</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">show_icons</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> show an icon near
- the resource</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the "show-icon" property to the value of
- <parameter>show_icon</parameter>. If <parameter>show_icon</parameter>
- is <literal>True</literal>, show an icon near the resource when
- displaying it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-show-icons">
- <title>gtk.RecentChooser.get_show_icons</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_icons</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the icons should be
- displayed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if an icon should be shown near
- the resource.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--set-sort-type">
- <title>gtk.RecentChooser.set_sort_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_sort_type</methodname>
- <methodparam><parameter role="keyword">sort_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">sort_type</parameter>&nbsp;:</term>
- <listitem><simpara>the sort order that the chooser should use -
- one of the <xref linkend="gtk-recent-sort-type-constants"
- endterm="gtk-recent-sort-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the sorting order of the recently used resources list to
- the value specified by sort_type which must be one of the <xref
- linkend="gtk-recent-sort-type-constants"
- endterm="gtk-recent-sort-type-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-sort-type">
- <title>gtk.RecentChooser.get_sort_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_sort_type</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the sorting order - one of the <xref
- linkend="gtk-recent-sort-type-constants"
- endterm="gtk-recent-sort-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value set by the <link
- linkend="method-gtkrecentchooser--set-sort-type"><methodname>gtk.RecentChooser.set_sort_type()</methodname>
- method.</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--set-sort-func">
- <title>gtk.RecentChooser.set_sort_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_sort_func</methodname>
- <methodparam><parameter role="keyword">sort_func</parameter></methodparam>
- <methodparam><parameter role="keyword">sort_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">sort_func</parameter>&nbsp;:</term>
- <listitem><simpara>the comparison function</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">sort_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to <parameter>sort_func</parameter>, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the comparison function specified by
- <parameter>sort_func</parameter> to be used when sorting. If the
- "sort-type" property is set to
- <literal>gtk.RECENT_SORT_CUSTOM</literal>, the chooser will sort using
- this function.</para>
-
- <para>The signature of the comparison function is:</para>
-
- <programlisting>
- def sort_func(a, b, data):
- </programlisting>
-
- <para>where <parameter>a</parameter> and <parameter>b</parameter> are
- two <link
- linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
- objects and <parameter>data</parameter> is
- <parameter>sort_data</parameter>. <parameter>sort_func</parameter>
- should return a positive integer if the first item comes before the
- second, zero if the two items are equal and a negative integer if the
- first item comes after the second.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--set-current-uri">
- <title>gtk.RecentChooser.set_current_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_current_uri</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>a URI</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the URI was
- found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets <parameter>uri</parameter> as the current URI. Raises the
- gobject.GError exception when an error occurs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-current-uri">
- <title>gtk.RecentChooser.get_current_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_current_uri</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a URI.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the currently selected URI.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-current-item">
- <title>gtk.RecentChooser.get_current_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_current_item</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
- object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the <link
- linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
- for the currently selected item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--select-uri">
- <title>gtk.RecentChooser.select_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_uri</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>a URI</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>uri</parameter> was found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Selects <parameter>uri</parameter>. Raises the gobject.GError
- exception when an error occurs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--unselect-uri">
- <title>gtk.RecentChooser.unselect_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unselect_uri</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>a URI</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Unselects <parameter>uri</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--select-all">
- <title>gtk.RecentChooser.select_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_all</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Selects all the items inside <parameter>chooser</parameter>, if
- the "select-multiple" property is <literal>True</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--unselect-all">
- <title>gtk.RecentChooser.unselect_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unselect_all</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Unselects all the items.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-items">
- <title>gtk.RecentChooser.get_items</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_items</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A list of <link
- linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
- objects.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the list of recently used resources in form of <link
- linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
- objects.</para>
-
- <para>The return value of this function is affected by the "sort-type"
- and "limit" properties.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-uris">
- <title>gtk.RecentChooser.get_uris</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_uris</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A list of strings.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns a list of the URIs of the recently used
- resources.</para>
-
- <para>The return value of this function is affected by the "sort-type"
- and "limit" properties>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--add-filter">
- <title>gtk.RecentChooser.add_filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_filter</methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Adds <parameter>filter</parameter> to the list of <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
- objects.</para>
-
- <para>If no previous filter objects were defined, this method will
- call the <link
- linkend="method-gtkrecentchooser--set-filter"><methodname>gtk.RecentChooser.set_filter()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--remove-filter">
- <title>gtk.RecentChooser.remove_filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_filter</methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Removes <parameter>filter</parameter> from the list of <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
- objects.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--list-filters">
- <title>gtk.RecentChooser.list_filters</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_filters</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A list of <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
- objects..</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns a list of the <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
- objects.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--set-filter">
- <title>gtk.RecentChooser.set_filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_filter</methodname>
- <methodparam><parameter role="keyword">filter</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets <parameter>filter</parameter> as the current <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
- object used by the recent chooser to filter the displayed recently
- used resources.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchooser--get-filter">
- <title>gtk.RecentChooser.get_filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_filter</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
- object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the currently used <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
- object.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkrecentchooser--item-activated">
- <title>The "item-activated" gtk.RecentChooser Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>chooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>chooser</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>This signal is emitted when the user "activates" a recent item
- in the recent chooser. This can happen by double-clicking on an item
- in the recently used resources list, or by pressing
- <keycap>Enter</keycap>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkrecentchooser--selection-changed">
- <title>The "selection-changed" gtk.RecentChooser Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>chooser</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>chooser</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>This signal is emitted when there is a change in the set of
- selected recently used resources. This can happen when a user
- modifies the selection with the mouse or the keyboard, or when
- explicitly calling methods to change the selection.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkrecentchooserdialog.xml b/docs/reference/pygtk-gtkrecentchooserdialog.xml
deleted file mode 100644
index b5840783..00000000
--- a/docs/reference/pygtk-gtkrecentchooserdialog.xml
+++ /dev/null
@@ -1,197 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkrecentchooserdialog">
-
- <refnamediv>
- <refname>gtk.RecentChooserDialog</refname>
- <refpurpose>Displays recently used files in a dialog (new in PyGTK
- 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.RecentChooserDialog</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtkrecentchooser">gtk.RecentChooser</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkrecentchooserdialog">gtk.RecentChooserDialog</link></methodname>
- <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">manager</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">buttons</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
- +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
- +-- <link linkend="class-gtkrecentchooserdialog">gtk.RecentChooserDialog (implements <link linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>)</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkrecentchooserdialog">
- <title>gtk.RecentChooserDialog Properties</title>
-
- <para><link linkend="properties-gtkrecentchooser">gtk.RecentChooser Properties</link></para>
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
- <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkrecentchooserdialog">
- <title>gtk.RecentChooserDialog Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkrecentchooserdialog">
- <title>gtk.RecentChooserDialog Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkrecentchooser">gtk.RecentChooser Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>
- is a dialog box suitable for displaying the recently used documents.
- This widgets works by putting a <link
- linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>
- inside a <link
- linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>. It
- exposes the <link
- linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>
- interface, so you can use all the <link
- linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>
- methods on the recent chooser dialog as well as those for <link
- linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>.</para>
-
- <para>Note that <link
- linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>
- does not have any methods of its own. Instead, you should use the
- methods that work on a <link
- linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>.</para>
-
- <example id="gtkrecentchooser-typical-usage">
- <title>Typical usage</title>
-
- <para>In the simplest of cases, you can use the following code to use
- a <link
- linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>
- to select a recently used file:</para>
-
- <programlisting>
- dialog = gtk.RecentChooserDialog("Recent Documents", parent_window, None,
- (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
- gtk.STOCK_OPEN, gtk.RESPONSE_ACCEPT))
-
- if dialog.run() == gtk.RESPONSE_ACCEPT:
- info = dialog.get_current_item ()
- open_file(info.get_uri())
- dialog.destroy()
- </programlisting>
- </example>
-
- <para>Recently used files are supported since GTK+ 2.10.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkrecentchooserdialog">
- <title>gtk.RecentChooserDialog</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.RecentChooserDialog</methodname>
- <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">manager</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">buttons</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>Title of the dialog, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>Transient parent of the dialog, or
- <literal>None</literal>,</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">manager</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>,
- or <literal>None</literal>,</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">buttons</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of text-response
- pairs</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>
- with the title text specified by <parameter>title</parameter> (or
- <literal>None</literal> for the default title; see <link
- linkend="method-gtkwindow--set-title"><methodname>gtk.Window.set_title</methodname>()</link>)
- and transient parent window specified by <parameter>parent</parameter>
- (or <literal>None</literal> for none; see <link
- linkend="method-gtkwindow--set-transient-for"><methodname>gtk.Window.set_transient_for</methodname>()</link>).
- <parameter>manager</parameter> specifies a <link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
- object (or <literal>None</literal>). <parameter>buttons</parameter> is
- a sequence of button text/response ID pairs should be listed, or
- <literal>None</literal> (the default value) if no buttons are
- needed. The button text can be either a stock ID such as
- <literal>gtk.STOCK_OK</literal>, or some arbitrary text. A response
- ID can be any positive number, or one of the pre-defined <xref
- linkend="gtk-response-type-constants"
- endterm="gtk-response-type-constants-title"></xref>. This constructor
- is analogous to <link
- linkend="constructor-gtkdialog"><methodname>gtk.Dialog</methodname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkrecentchoosermenu.xml b/docs/reference/pygtk-gtkrecentchoosermenu.xml
deleted file mode 100644
index c2df99f9..00000000
--- a/docs/reference/pygtk-gtkrecentchoosermenu.xml
+++ /dev/null
@@ -1,224 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkrecentchoosermenu">
-
- <refnamediv>
- <refname>gtk.RecentChooserMenu</refname>
- <refpurpose>Displays recently used files in a menu (new in PyGTK
- 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.RecentChooserMenu</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkmenu">gtk.Menu</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtkrecentchooser">gtk.RecentChooser</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkrecentchoosermenu">gtk.RecentChooserMenu</link></methodname>
- <methodparam><parameter role="keyword">manager</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchoosermenu--get-show-numbers">get_show_numbers</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentchoosermenu--set-show-numbers">set_show_numbers</link></methodname>
- <methodparam><parameter role="keyword">show_numbers</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkmenushell">gtk.MenuShell</link>
- +-- <link linkend="class-gtkmenu">gtk.Menu</link>
- +-- <link linkend="class-gtkrecentchoosermenu">gtk.RecentChooserMenu</link> (implements <link linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkrecentchoosermenu">
- <title>gtk.RecentChooserMenu Properties</title>
-
- <para><link linkend="properties-gtkrecentchooser">gtk.RecentChooser Properties</link></para>
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkmenushell">gtk.MenuShell Properties</link></para>
- <para><link linkend="properties-gtkmenu">gtk.Menu Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"show-numbers"</entry>
- <entry>Read-Write</entry>
- <entry>Whether the first ten items in the menu should be prepended by
-a number acting as a unique mnemonic.
-This property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkrecentchoosermenu">
- <title>gtk.RecentChooserMenu Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkmenu">gtk.Menu Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkrecentchoosermenu">
- <title>gtk.RecentChooserMenu Child Properties</title>
-
- <para><link linkend="child-properties-gtkmenu">gtk.Menu Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkrecentchoosermenu">
- <title>gtk.RecentChooserMenu Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkmenushell">gtk.MenuShell Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkmenu">gtk.Menu Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkrecentchooser">gtk.RecentChooser Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
-<para>
-<link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link> is a widget suitable for displaying recently used files
-inside a menu. It can be used to set a sub-menu of a <link linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> using
-<link linkend="method-gtkmenuitem--set-submenu"><methodname>gtk.MenuItem.set_submenu()</methodname></link>, or as the menu of a <link linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>.
-</para>
-
-<para>
-Note that <link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link> does not have any methods of its own. Instead,
-you should use the functions that work on a <link linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>.
-</para>
-
-<para>
-Recently used files are supported since GTK+ 2.10.
-</para>
-
-
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkrecentchoosermenu">
- <title>gtk.RecentChooserMenu</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.RecentChooserMenu</methodname>
- <methodparam><parameter role="keyword">manager</parameter></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">manager</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link>, bound to <parameter>manager</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link> widget using <parameter>manager</parameter> as
- the underlying recently used resources manager.</para>
-
- <para>This is useful if you have implemented your own recent manager,
- or if you have a customized instance of a <link linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
- object or if you wish to share a common <link linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link> object
- among multiple <link linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link> widgets.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkrecentchoosermenu--get-show-numbers">
- <title>gtk.RecentChooserMenu.get_show_numbers</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_numbers</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if numbers should be shown.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value set by <link linkend="method-gtkrecentchoosermenu--set-show-numbers"><methodname>gtk.RecentChooserMenu.set_show_numbers()</methodname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentchoosermenu--set-show-numbers">
- <title>gtk.RecentChooserMenu.set_show_numbers</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_numbers</methodname>
- <methodparam><parameter role="keyword">show_numbers</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">show_numbers</parameter>&nbsp;:</term>
- <listitem><simpara>whether to show numbers</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets whether a number should be added to the items of <parameter>menu</parameter>. The
- numbers are shown to provide a unique character for a mnemonic to
- be used inside the menu item's label. Only the first the items
- get a number to avoid clashes.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkrecentchooserwidget.xml b/docs/reference/pygtk-gtkrecentchooserwidget.xml
deleted file mode 100644
index f19a4668..00000000
--- a/docs/reference/pygtk-gtkrecentchooserwidget.xml
+++ /dev/null
@@ -1,139 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkrecentchooserwidget">
-
- <refnamediv>
- <refname>gtk.RecentChooserWidget</refname>
- <refpurpose>Displays recently used files (new in PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.RecentChooserWidget</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkvbox">gtk.VBox</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtkrecentchooser">gtk.RecentChooser</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkrecentchooserwidget">gtk.RecentChooserWidget</link></methodname>
- <methodparam><parameter role="keyword">manager</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkvbox">gtk.VBox</link>
- +-- <link linkend="class-gtkrecentchooserwidget">gtk.RecentChooserWidget</link> (implements <link linkend="class-gtkrecentchooser">gtk.RecentChooser</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkrecentchooserwidget">
- <title>gtk.RecentChooserWidget Properties</title>
-
- <para><link linkend="properties-gtkrecentchooser">gtk.RecentChooser Properties</link></para>
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkrecentchooserwidget">
- <title>gtk.RecentChooserWidget Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkrecentchooserwidget">
- <title>gtk.RecentChooserWidget Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkrecentchooserwidget">
- <title>gtk.RecentChooserWidget Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkrecentchooser">gtk.RecentChooser Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>
- is a widget suitable for selecting recently used files. It is the main
- building block of a <link
- linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>.
- Most applications will only need to use the latter; you can use <link
- linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>
- as part of a larger window if you have special needs.</para>
-
- <para>Note that <link
- linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>
- does not have any methods of its own. Instead, you should use the
- methods that work on a <link
- linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>.</para>
-
- <para>Recently used files are supported since GTK+ 2.10.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkrecentchooserwidget">
- <title>gtk.RecentChooserWidget</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.RecentChooserWidget</methodname>
- <methodparam><parameter role="keyword">manager</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">manager</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>
- with an optional <link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>.</para>
-
- <para>This is useful if you have implemented your own recent manager,
- or if you have a customized instance of a <link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
- object.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkrecentfilter.xml b/docs/reference/pygtk-gtkrecentfilter.xml
deleted file mode 100644
index 6d181c47..00000000
--- a/docs/reference/pygtk-gtkrecentfilter.xml
+++ /dev/null
@@ -1,509 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkrecentfilter">
-
- <refnamediv>
- <refname>gtk.RecentFilter</refname>
- <refpurpose>A filter for selecting a subset of recently used files
- (new in PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.RecentFilter</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkrecentfilter">gtk.RecentFilter</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentfilter--set-name">set_name</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentfilter--get-name">get_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentfilter--add-mime-type">add_mime_type</link></methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentfilter--add-pattern">add_pattern</link></methodname>
- <methodparam><parameter role="keyword">pattern</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentfilter--add-pixbuf-formats">add_pixbuf_formats</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentfilter--add-application">add_application</link></methodname>
- <methodparam><parameter role="keyword">application</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentfilter--add-group">add_group</link></methodname>
- <methodparam><parameter role="keyword">group</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentfilter--add-age">add_age</link></methodname>
- <methodparam><parameter role="keyword">days</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentfilter--add-custom">add_custom</link></methodname>
- <methodparam><parameter role="keyword">needed</parameter></methodparam>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentfilter--get-needed">get_needed</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentfilter--filter">filter</link></methodname>
- <methodparam><parameter role="keyword">filter_info</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkrecentfilter">gtk.RecentFilter</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkrecentfilter">
- <title>gtk.RecentFilter Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkrecentfilter">
- <title>gtk.RecentFilter Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
- can be used to restrict the files being shown in a <link
- linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>.
- Files can be filtered based on their name (with the <link
- linkend="method-gtkrecentfilter--add-pattern"><methodname>gtk.RecentFilter.add_pattern()</methodname></link>
- method), on their mime type (with the <link
- linkend="method-gtkfilefilter--add-mime-type"><methodname>gtk.FileFilter.add_mime_type()</methodname></link>
- method), on the application that has registered them (with the <link
- linkend="method-gtkrecentfilter--add-application"><methodname>gtk.RecentFilter.add_application()</methodname></link>
- method), or by a custom filter function (with the <link
- linkend="method-gtkrecentfilter--add-custom"><methodname>gtk.RecentFilter.add_custom()</methodname></link>
- method).</para>
-
- <para>Filtering by mime type handles aliasing and subclassing of mime
- types; e.g. a filter for "text/plain" also matches a file with mime type
- "application/rtf", since "application/rtf" is a subclass of
- "text/plain". Note that <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
- allows wildcards for the subtype of a mime type, so you can e.g. filter
- for "image/*".</para>
-
- <para>Normally, filters are used by adding them to a <link
- linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>,
- see the <link
- linkend="method-gtkrecentchooser--add-filter"><methodname>gtk.RecentChooser.add_filter()</methodname></link>
- method, but it is also possible to manually use a filter on a file with
- the <link
- linkend="method-gtkrecentfilter--filter"><methodname>gtk.RecentFilter.filter()</methodname></link>
- method.</para>
-
- <para>Recently used files are supported since GTK+ 2.10.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkrecentfilter">
- <title>gtk.RecentFilter</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.RecentFilter</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new <link
- linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
- with no rules added to it. Such a filter does not accept any recently
- used resources, so is not particularly useful until you add rules with
- the <link
- linkend="method-gtkrecentfilter--add-pattern"><methodname>gtk.RecentFilter.add_pattern()</methodname></link>,
- <link
- linkend="method-gtkrecentfilter--add-mime-type"><methodname>gtk.RecentFilter.add_mime_type()</methodname></link>,
- <link
- linkend="method-gtkrecentfilter--add-application"><methodname>gtk.RecentFilter.add_application()</methodname></link>,
- <link
- linkend="method-gtkrecentfilter--add-age"><methodname>gtk.RecentFilter.add_age()</methodname></link>
- methods. To create a filter that accepts any recently used resource,
- use:</para>
-
- <para><informalexample><programlisting>
- filter = gtk.RecentFilter()
- filter.add_pattern("*")
- </programlisting></informalexample></para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkrecentfilter--set-name">
- <title>gtk.RecentFilter.set_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_name</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the human readable name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the human-readable name of the filter; this is the string
- that will be displayed in the recently used resources selector user
- interface if there is a selectable list of filters.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentfilter--get-name">
- <title>gtk.RecentFilter.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the filter, or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the human-readable name for the filter. See the <link
- linkend="method-gtkrecentfilter--set-name"><methodname>gtk.RecentFilter.set_name()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentfilter--add-mime-type">
- <title>gtk.RecentFilter.add_mime_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_mime_type</methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mime_type</parameter>&nbsp;:</term>
- <listitem><simpara>a MIME type</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Adds a rule that filters resources based on their registered
- MIME type.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentfilter--add-pattern">
- <title>gtk.RecentFilter.add_pattern</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_pattern</methodname>
- <methodparam><parameter role="keyword">pattern</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pattern</parameter>&nbsp;:</term>
- <listitem><simpara>a file pattern</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Adds a rule that filters resources based on a pattern matching
- their display name.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentfilter--add-pixbuf-formats">
- <title>gtk.RecentFilter.add_pixbuf_formats</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_pixbuf_formats</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Adds a rule that filters image files based on the formats
- supported by <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentfilter--add-application">
- <title>gtk.RecentFilter.add_application</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_application</methodname>
- <methodparam><parameter role="keyword">application</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">application</parameter>&nbsp;:</term>
- <listitem><simpara>an application name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Adds a rule that filters resources based on the name of the
- application that has registered them.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentfilter--add-group">
- <title>gtk.RecentFilter.add_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_group</methodname>
- <methodparam><parameter role="keyword">group</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">group</parameter>&nbsp;:</term>
- <listitem><simpara>a group name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Adds a rule that filters resources based on the name of the
- group to which they belong</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentfilter--add-age">
- <title>gtk.RecentFilter.add_age</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_age</methodname>
- <methodparam><parameter role="keyword">days</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">days</parameter>&nbsp;:</term>
- <listitem><simpara>number of days</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Adds a rule that filters resources based on their age -
- that is, the number of days elapsed since they were last
- modified.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentfilter--add-custom">
- <title>gtk.RecentFilter.add_custom</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_custom</methodname>
- <methodparam><parameter role="keyword">needed</parameter></methodparam>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">needed</parameter>&nbsp;:</term>
- <listitem><simpara>a combination of the <xref
- linkend="gtk-recent-filter-flags-constants"
- endterm="gtk-recent-filter-flags-constants-title"></xref>
- indicating the information that the custom filter function
- needs.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>callback function; if the function returns <literal>True</literal>, then
- the file will be displayed.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>data to pass to <parameter>func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Adds a rule to a filter that filters resources based on a custom
- callback function. <parameter>needed</parameter> is a combination of
- the <xref linkend="gtk-recent-filter-flags-constants"
- endterm="gtk-recent-filter-flags-constants-title"></xref> which
- provides information about what sorts of information that the filter
- function needs; this allows PyGTK to avoid retrieving expensive
- information when it isn't needed by the filter.</para>
-
- <para>The signature of the filter function is:</para>
-
- <programlisting>
- def func(filterinfo, user_data):
- </programlisting>
-
- <para>where <parameter>filterinfo</parameter> is a dict containing the
- info requested by <parameter>needed</parameter> as key-value pairs and
- <parameter>user_data</parameter> is <parameter>data</parameter>. The
- possible <parameter>filterinfo</parameter> keys are: "uri",
- "display_name", "mime_type", "applications", "age" and
- "groups".</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentfilter--get-needed">
- <title>gtk.RecentFilter.get_needed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_needed</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a combination of the <xref
- linkend="gtk-recent-filter-flags-constants"
- endterm="gtk-recent-filter-flags-constants-title"></xref>
- indicating what fields are used for filtering when calling the
- <link
- linkend="method-gtkrecentfilter--filter"><methodname>gtk.RecentFilter.filter()</methodname></link>
- method</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns a combination of the <xref
- linkend="gtk-recent-filter-flags-constants"
- endterm="gtk-recent-filter-flags-constants-title"></xref> indicating
- what fields are used for filtering.</para>
-
- <para>This method will not typically be used by applications; it is
- intended principally for use in the implementation of <link
- linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentfilter--filter">
- <title>gtk.RecentFilter.filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>filter</methodname>
- <methodparam><parameter role="keyword">filter_info</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filter_info</parameter>&nbsp;:</term>
- <listitem><simpara>a filter info dict containing information about
- a recently used resource</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the file should be
- displayed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if a file should be displayed.
- <parameter>filter_info</parameter> is a dict that should include the
- key-value pairs as specified by the return flags from the <link
- linkend="method-gtkrecentfilter--get-needed"><methodname>gtk.RecentFilter.get_needed()</methodname></link>
- method. The possible <parameter>filter_info</parameter> keys are:
- "uri", "display_name", "mime_type", "applications", "age" and
- "groups".</para>
-
- <para>This method will not typically be used by applications; it is
- intended principally for use in the implementation of <link
- linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkrecentinfo.xml b/docs/reference/pygtk-gtkrecentinfo.xml
deleted file mode 100644
index 177a8462..00000000
--- a/docs/reference/pygtk-gtkrecentinfo.xml
+++ /dev/null
@@ -1,681 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkrecentinfo">
-
- <refnamediv>
- <refname>gtk.RecentInfo</refname>
- <refpurpose>information found when looking up an entry of the recently
- used files list. (new in PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.RecentInfo</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-uri">get_uri</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-display-name">get_display_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-description">get_description</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-mime-type">get_mime_type</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-added">get_added</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-modified">get_modified</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-visited">get_visited</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-private-hint">get_private_hint</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-application-info">get_application_info</link></methodname>
- <methodparam><parameter role="keyword">app_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-applications">get_applications</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--last-application">last_application</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--has-application">has_application</link></methodname>
- <methodparam><parameter role="keyword">app_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-groups">get_groups</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--has-group">has_group</link></methodname>
- <methodparam><parameter role="keyword">group_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-icon">get_icon</link></methodname>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-short-name">get_short_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-uri-display">get_uri_display</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--get-age">get_age</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--is-local">is_local</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--exists">exists</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentinfo--match">match</link></methodname>
- <methodparam><parameter role="keyword">info_b</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
- linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
- contains the information about an entry in a <link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkrecentinfo--get-uri">
- <title>gtk.RecentInfo.get_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_uri</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the URI of the resource.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the URI of the resource.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-display-name">
- <title>gtk.RecentInfo.get_display_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_display_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the display name of the
- resource.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the name of the resource. If none has been defined, the
- basename of the resource is obtained.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-description">
- <title>gtk.RecentInfo.get_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_description</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the description of the
- resource.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the (short) description of the resource.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-mime-type">
- <title>gtk.RecentInfo.get_mime_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_mime_type</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the MIME type of the
- resource.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the MIME type of the resource.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-added">
- <title>gtk.RecentInfo.get_added</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_added</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of seconds elapsed from system's
- Epoch when the resource was added to the list, or -1 on
- failure.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the timestamp (seconds from system's Epoch) when the
- resource was added to the recently used resources list.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-modified">
- <title>gtk.RecentInfo.get_modified</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_modified</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of seconds elapsed from system's
- Epoch when the resource was last modified, or -1 on
- failure.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the timestamp (seconds from system's Epoch) when the
- resource was last modified.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-visited">
- <title>gtk.RecentInfo.get_visited</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visited</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of seconds elapsed from system's
- Epoch when the resource was last visited, or -1 on
- failure.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the timestamp (seconds from system's Epoch) when the
- resource was last visited.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-private-hint">
- <title>gtk.RecentInfo.get_private_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_private_hint</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the private flag was
- found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the value of the "private" flag. Resources in the
- recently used list that have this flag set to <literal>True</literal>
- should only be displayed by the applications that have registered
- them.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-application-info">
- <title>gtk.RecentInfo.get_application_info</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_application_info</methodname>
- <methodparam><parameter role="keyword">app_name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">app_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the application that has registered
- this item</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple (containing the command line, the
- number of times this item was registered and the timestamp this
- item was last registered for this application) if an application
- named <parameter>app_name</parameter> has registered this resource
- inside the recently used list, or <literal>None</literal>
- otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns a 3-tuple containg the data regarding the application
- that has registered this resource. The 3-tuple contains the command
- line, the number of times this item was registered and the timestamp
- this item was last registered for this application</para>
-
- <para>If the command line contains any escape characters defined
- inside the storage specification, they will be expanded.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-applications">
- <title>gtk.RecentInfo.get_applications</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_applications</methodname>
- <methodparam><parameter role="keyword">length</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of application name
- strings.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the list of applications that have registered this
- resource.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--last-application">
- <title>gtk.RecentInfo.last_application</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>last_application</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an application name.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the name of the last application that has registered the
- recently used resource.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--has-application">
- <title>gtk.RecentInfo.has_application</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>has_application</methodname>
- <methodparam><parameter role="keyword">app_name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">app_name</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing an application
- name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if an application with
- the name <parameter>app_name</parameter> was found,
- <literal>False</literal> otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Checks whether an application registered this resource using
- <parameter>app_name</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-groups">
- <title>gtk.RecentInfo.get_groups</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_groups</methodname>
- <methodparam><parameter role="keyword">length</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of group names.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns a list containing the names of all groups registered
- for the recently used item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--has-group">
- <title>gtk.RecentInfo.has_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>has_group</methodname>
- <methodparam><parameter role="keyword">group_name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">group_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a group</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the group was
- found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Checks whether <parameter>group_name</parameter> appears inside
- the groups registered for the recently used item.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-icon">
- <title>gtk.RecentInfo.get_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon</methodname>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the size of the icon in
- pixels</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
- containing the icon, or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Retrieves the icon of size <parameter>size</parameter>
- associated to the resource MIME type.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-short-name">
- <title>gtk.RecentInfo.get_short_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_short_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the short name as a UTF-8 string</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Computes a valid UTF-8 string that can be used as the name of
- the item in a menu or list. For example, calling this function on an
- item that refers to "file:///foo/bar.txt" will yield "bar.txt".</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-uri-display">
- <title>gtk.RecentInfo.get_uri_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_uri_display</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a UTF-8 string containing the resource's URI or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets a displayable version of the resource's URI.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--get-age">
- <title>gtk.RecentInfo.get_age</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_age</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a positive integer containing the number of
- days elapsed since the time this resource was last
- modified.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the number of days elapsed since the last update of the
- resource.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--is-local">
- <title>gtk.RecentInfo.is_local</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_local</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the resource is
- local.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Checks whether the resource is local or not by looking at the
- scheme of its URI.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--exists">
- <title>gtk.RecentInfo.exists</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>exists</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the resource
- exists</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Checks whether the resource still exists. At the moment this
- check is done only on resources pointing to local files.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentinfo--match">
- <title>gtk.RecentInfo.match</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>match</methodname>
- <methodparam><parameter role="keyword">info_b</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">info_b</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>info_b</parameter> matches this recent
- info.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Checks if <parameter>info_b</parameter> matches this recent
- info.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkrecentmanager.xml b/docs/reference/pygtk-gtkrecentmanager.xml
deleted file mode 100644
index de3f2fbb..00000000
--- a/docs/reference/pygtk-gtkrecentmanager.xml
+++ /dev/null
@@ -1,719 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkrecentmanager">
-
- <refnamediv>
- <refname>gtk.RecentManager</refname>
- <refpurpose>manages recently used files (new in PyGTK
- 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.RecentManager</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkrecentmanager">gtk.RecentManager</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentmanager--set-screen">set_screen</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentmanager--add-item">add_item</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentmanager--add-full">add_full</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- <methodparam><parameter role="keyword">recent_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentmanager--remove-item">remove_item</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentmanager--lookup-item">lookup_item</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentmanager--has-item">has_item</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentmanager--move-item">move_item</link></methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- <methodparam><parameter role="keyword">new_uri</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentmanager--set-limit">set_limit</link></methodname>
- <methodparam><parameter role="keyword">limit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentmanager--get-limit">get_limit</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentmanager--get-items">get_items</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkrecentmanager--purge-items">purge_items</link></methodname>
- </methodsynopsis>
- </classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--recent-manager-get-default">gtk.recent_manager_get_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--recent-manager-get-for-screen">gtk.recent_manager_get_for_screen</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkrecentmanager">gtk.RecentManager</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkrecentmanager">
- <title>gtk.RecentManager Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"filename"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The full path to the file to be used to store and read the
- recently used resources list This property is available in GTK+
- 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"limit"</entry>
- <entry>Read-Write</entry>
- <entry>The maximum number of items to be returned by the <link
- linkend="method-gtkrecentmanager--get-items"><methodname>gtk.RecentManager.get_items()</methodname></link>
- function. This property is available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"size"</entry>
- <entry>Read</entry>
- <entry>The size of the recently used resources list. This
- property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkrecentmanager">
- <title>gtk.RecentManager Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkrecentmanager--changed">changed</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>recent_manager</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
- provides a facility for adding, removing and looking up recently used
- files. Each recently used file is identified by its URI, and has
- meta-data associated to it, like the names and command lines of the
- applications that have registered it, the number of time each
- application has registered the same file, the mime type of the file and
- whether the file should be displayed only by the applications that have
- registered it.</para>
-
- <para>The <link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
- acts like a database of all the recently used files. You can create new
- <link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
- objects, but it is more efficient to use the standard recent manager for
- the <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
- so that information about the recently used files is shared with other
- people using them. In case the default screen is being used, adding a
- new recently used file is as simple as:</para>
-
-<informalexample>
- <programlisting>
- manager = gtk.recent_manager_get_default()
- manager.add_item(file_uri)
- </programlisting>
-</informalexample>
-
-<para>While looking up a recently used file is as simple as:</para>
-
-<informalexample>
- <programlisting>
- manager = gtk.recent_manager_get_default()
- try:
- info = manager.lookup_item(file_uri)
- except gobject.GError:
- print "Could not find the file: ", file_uri
- </programlisting>
-</informalexample>
-
-<para>Recently used files are supported since GTK+ 2.10.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkrecentmanager">
- <title>gtk.RecentManager</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.RecentManager</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A newly created <link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
- object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates a new recent manager object. Recent manager objects are
- used to handle the list of recently used resources. A <link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
- object monitors the recently used resources list, and emits the
- "changed" signal each time something inside the list changes.</para>
-
- <para><link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
- objects are expansive: be sure to create them only when needed. You
- should use the <link
- linkend="function-gtk--recent-manager-get-for-screen"><function>gtk.recent_manager_get_for_screen</function>()</link>
- or the <link
- linkend="function-gtk--recent-manager-get-default"><function>gtk.recent_manager_get_default</function>()</link>
- functions instead.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkrecentmanager--set-screen">
- <title>gtk.RecentManager.set_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_screen</methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the screen for a recent manager; the screen is used to
- track the user's currently configured recently used documents
- storage.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentmanager--add-item">
- <title>gtk.RecentManager.add_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_item</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>a valid URI</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the new item was
- successfully added to the recently used resources
- list</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Adds a new resource, pointed by <parameter>uri</parameter>, into
- the recently used resources list.</para>
-
- <para>This method automatically retrieves some of the needed metadata
- and sets other metadata to common default values.</para>
-
- <para>See the <link
- linkend="method-gtkrecentmanager--add-full"><methodname>gtk.RecentManager.add_full()</methodname></link>
- method if you want to explicitly define the metadata for the resource
- pointed by <parameter>uri</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentmanager--add-full">
- <title>gtk.RecentManager.add_full</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_full</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- <methodparam><parameter role="keyword">recent_data</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>a valid URI</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">recent_data</parameter>&nbsp;:</term>
- <listitem><simpara>a dict containing metadata of the
- resource</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the new item was
- successfully added to the recently used resources
- list.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Adds a new resource, pointed by <parameter>uri</parameter>, into
- the recently used resources list, using the metadata specified inside
- the dict passed in <parameter>recent_data</parameter>.</para>
-
- <para>The passed URI will be used to identify this resource inside the
- list.</para>
-
- <para>In order to register the new recently used resource, metadata
- about the resource must be passed as well as the URI. The metadata is
- stored in a dict, which must contain the MIME type of the resource
- pointed by the URI ("mime_type"), the name of the application that is
- registering the item ("app_name"), and a command line to be used when
- launching the item ("app_exec").</para>
-
- <para>Optionally, the <parameter>recent_data</parameter> dict might
- contain a UTF-8 string to be used when viewing the item instead of the
- last component of the URI ("display_name"), a short description of the
- item ("description"), whether the item should be considered private -
- that is, should be displayed only by the applications that have
- registered it("is_private") or a list of the groups that the item
- belongs to ("groups").</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentmanager--remove-item">
- <title>gtk.RecentManager.remove_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_item</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>the URI of the item you wish to remove</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the item pointed by
- <parameter>uri</parameter> has been successfully removed by the
- recently used resources list.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Removes a resource pointed by <parameter>uri</parameter> from
- the recently used resources list handled by a recent manager. Raises
- the gobject.GError when an error occurs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentmanager--lookup-item">
- <title>gtk.RecentManager.lookup_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>lookup_item</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>a URI</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
- object containing information about the resource pointed by
- <parameter>uri</parameter>, or <literal>None</literal> if the URI
- was not registered in the recently used resources
- list.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Searches for a URI inside the recently used resources list, and
- returns a <link
- linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
- object containing information about the resource like its MIME type,
- or its display name. Raises the gobject.GError when an error
- occurs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentmanager--has-item">
- <title>gtk.RecentManager.has_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>has_item</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>a URI</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the resource was
- found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Checks whether there is a recently used resource registered with
- <parameter>uri</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentmanager--move-item">
- <title>gtk.RecentManager.move_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_item</methodname>
- <methodparam><parameter role="keyword">uri</parameter></methodparam>
- <methodparam><parameter role="keyword">new_uri</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
- <listitem><simpara>the URI of a recently used resource</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">new_uri</parameter>&nbsp;:</term>
- <listitem><simpara>the new URI of the recently used resource, or <literal>None</literal> to
- remove the item pointed by <parameter>uri</parameter> in the list</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> on
- success.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Changes the location of a recently used resource from
- <parameter>uri</parameter> to <parameter>new_uri</parameter>.</para>
-
- <para>Please note that this function will not affect the resource
- pointed by the URIs, but only the URI used in the recently used
- resources list. Raises the gobject.GError when an error occurs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentmanager--set-limit">
- <title>gtk.RecentManager.set_limit</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_limit</methodname>
- <methodparam><parameter role="keyword">limit</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">limit</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum number of items to return, or
- -1.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the maximum number of item that the <link
- linkend="method-gtkrecentmanager--get-items"><methodname>gtk.RecentManager.get_items()</methodname></link>
- function should return. If <parameter>limit</parameter> is set to -1,
- then return all the items.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentmanager--get-limit">
- <title>gtk.RecentManager.get_limit</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_limit</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of items to return, or -1 for every
- item.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the maximum number of items that the <link
- linkend="method-gtkrecentmanager--get-items"><methodname>gtk.RecentManager.get_items()</methodname></link>
- method should return.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentmanager--get-items">
- <title>gtk.RecentManager.get_items</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_items</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of <link
- linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
- objects.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the list of recently used resources as <link
- linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
- objects.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrecentmanager--purge-items">
- <title>gtk.RecentManager.purge_items</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>purge_items</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of items that have been removed from
- the recently used resources list.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Purges every item from the recently used resources list. Raises
- the gobject.GError when an error occurs.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--recent-manager-get-default">
- <title>gtk.recent_manager_get_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.recent_manager_get_default</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A unique <link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
- associated with the default screen. This recent manager is
- associated to the screen and can be used as long as the screen is
- open.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets the recent manager for the default screen. See the <link
- linkend="function-gtk--recent-manager-get-for-screen"><function>gtk.recent_manager_get_for_screen</function>()</link>
- function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--recent-manager-get-for-screen">
- <title>gtk.recent_manager_get_for_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.recent_manager_get_for_screen</methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A unique <link
- linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
- associated with the given screen. This recent manager is
- associated to the with the screen and can be used as long as the
- screen is open.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets the recent manager object associated with
- <parameter>screen</parameter>; if this function has not previously
- been called for the given screen, a new recent manager object will be
- created and associated with the screen. Recent manager objects are
- fairly expensive to create, so using this function is usually a better
- choice than calling the <link
- linkend="constructor-gtkrecentmanager">gtk.RecentManager</link>()
- constructor and setting the screen yourself; by using this function a
- single recent manager object will be shared between users.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkrecentmanager--changed">
- <title>The "changed" gtk.RecentManager Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>recent_manager</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>recent_manager</parameter>&nbsp;:</term>
- <listitem><simpara>the recent manager</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>Emitted when the current recently used resources manager changes
- its contents.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkrequisition.xml b/docs/reference/pygtk-gtkrequisition.xml
deleted file mode 100644
index c7ce2666..00000000
--- a/docs/reference/pygtk-gtkrequisition.xml
+++ /dev/null
@@ -1,125 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkrequisition">
- <refnamediv>
- <refname>gtk.Requisition</refname>
- <refpurpose>an object containing information about the desired space
-requirements of a widget.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Requisition</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrequisition--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkrequisition--free">free</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"width"</entry>
- <entry>Read-Write</entry>
- <entry>the desired width of the widget</entry>
- </row>
-
- <row valign="top">
- <entry>"height"</entry>
- <entry>Read-Write</entry>
- <entry>the desired height of the widget</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>
-holds the information about the desired space requirements (width and
-height) of a widget. A <link
-linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>
-object has <literal>width</literal> and <literal>height</literal> attributes
-that can be read and written.</para>
-
- <note>
- <para>There appears to be no way to create or use a <link
-linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>
-in PyGTK other than as an argument in the handler for the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--size-request">size-request</link>" signal.</para>
- </note>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkrequisition--copy">
- <title>gtk.Requisition.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the <link
-linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns a copy of the
-<link
-linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkrequisition--free">
- <title>gtk.Requisition.free</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>free</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <warning>
- <para>This method is deprecated and should not be used since it can
- crash your application.</para>
- </warning>
-
- <para>The <methodname>free</methodname>() method frees the resources
-allocated to the <link
-linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkruler.xml b/docs/reference/pygtk-gtkruler.xml
deleted file mode 100644
index d5ce0e42..00000000
--- a/docs/reference/pygtk-gtkruler.xml
+++ /dev/null
@@ -1,308 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkruler">
- <refnamediv>
- <refname>gtk.Ruler</refname>
- <refpurpose>a base class for horizontal or vertical rulers</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Ruler</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkruler--set-metric">set_metric</link></methodname>
- <methodparam><parameter
- role="keyword">metric</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkruler--set-range">set_range</link></methodname>
- <methodparam><parameter
- role="keyword">lower</parameter></methodparam>
- <methodparam><parameter
- role="keyword">upper</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- <methodparam><parameter
- role="keyword">max_size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkruler--draw-ticks">draw_ticks</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkruler--draw-pos">draw_pos</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkruler--get-metric">get_metric</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkruler--get-range">get_range</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkruler">gtk.Ruler</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkruler">
- <title>gtk.Ruler Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"lower"</entry>
- <entry>Read-Write</entry>
- <entry>the lower limit of the ruler</entry>
- </row>
-
- <row valign="top">
- <entry>"max-size"</entry>
- <entry>Read-Write</entry>
- <entry>the maximum size of the ruler</entry>
- </row>
-
- <row valign="top">
- <entry>"metric"</entry>
- <entry>Read-Write</entry>
- <entry>The metric used for the ruler. This property is available
- in GTK+ 2.8 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"position"</entry>
- <entry>Read-Write</entry>
- <entry>the position of the mark on the ruler</entry>
- </row>
-
- <row valign="top">
- <entry>"upper"</entry>
- <entry>Read-Write</entry>
- <entry>the upper limit of the ruler</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkruler">
- <title>gtk.Ruler Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkruler">
- <title>gtk.Ruler Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is considered too specialized or little-used for
-PyGTK and GTK+, and will in the future be moved to some other package. If
-your application needs this widget, feel free to use it, as the widget does
-work and is useful in some applications; it's just not of general interest.
-However, it will eventually move out of the PyGTK and GTK+
-distribution.</para>
- </note>
-
- <para>The <link
-linkend="class-gtkruler"><classname>gtk.Ruler</classname></link> widget is a
-base class for horizontal and vertical rulers. Rulers are used to show the
-mouse pointer's location in a window. Within the ruler a small triangle
-indicates the location of the mouse relative to the horizontal or vertical
-ruler. See <link
-linkend="class-gtkhruler"><classname>gtk.HRuler</classname></link> to learn
-about horizontal rulers. See <link
-linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link> to learn
-about vertical rulers.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkruler--set-metric">
- <title>gtk.Ruler.set_metric</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_metric</methodname>
- <methodparam><parameter
- role="keyword">metric</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">metric</parameter>&nbsp;:</term>
- <listitem><simpara>the measurement units</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_metric</methodname>() method sets the
-measurement units of the ruler to the value specified by
-<parameter>metric</parameter>. Available units are
-<literal>gtk.PIXELS</literal>, <literal>gtk.INCHES</literal>, or
-<literal>gtk.CENTIMETERS</literal>. The default unit of measurement is
-<literal>gtk.PIXELS</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkruler--set-range">
- <title>gtk.Ruler.set_range</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>set_range</methodname>
- <methodparam><parameter role="keyword">lower</parameter></methodparam>
- <methodparam><parameter role="keyword">upper</parameter></methodparam>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- <methodparam><parameter role="keyword">max_size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">lower</parameter>&nbsp;:</term>
- <listitem><simpara>the upper limit of the ruler</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">upper</parameter>&nbsp;:</term>
- <listitem><simpara>the lower limit of the ruler</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the position of the mark on the ruler</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">max_size</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum size of the rule</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_range</methodname>() method sets the range
-of the ruler to the values specified by <parameter>lower</parameter>,
-<parameter>upper</parameter>, <parameter>position</parameter> and
-<parameter>max_size</parameter> (all values are floats).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkruler--draw-ticks">
- <title>gtk.Ruler.draw_ticks</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_ticks</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>draw_ticks</methodname>() method is overridden
-by the <link
-linkend="class-gtkruler"><classname>gtk.Ruler</classname></link> subclasses
-(<link linkend="class-gtkhruler"><classname>gtk.HRuler</classname></link>
-and <link
-linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link>) to draw
-the tick marks on the ruler. This method is not used by applications.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkruler--draw-pos">
- <title>gtk.Ruler.draw_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_pos</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>draw_pos</methodname>() method is overridden by
-the <link linkend="class-gtkruler"><classname>gtk.Ruler</classname></link>
-subclasses (<link
-linkend="class-gtkhruler"><classname>gtk.HRuler</classname></link> and <link
-linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link>) to draw
-the position mark on the ruler. This method is not used by
-applications.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkruler--get-metric">
- <title>gtk.Ruler.get_metric</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_metric</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the measurement units currently used for the
-ruler</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_metric</methodname>() method returns the
-units used for a <link
-linkend="class-gtkruler"><classname>gtk.Ruler</classname></link>. See the
-<link
-linkend="method-gtkruler--set-metric"><methodname>set_metric</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkruler--get-range">
- <title>gtk.Ruler.get_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_range</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>>&nbsp;:</term>
- <listitem><simpara>a tuple containing: the lower limit of the
-ruler, the upper limit of the ruler, the current position of the mark on the
-ruler and the maximum size of the ruler used when calculating the space to
-leave for the text.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_range</methodname>() method returns a tuple
-containing the values indicating the range and current position of a <link
-linkend="class-gtkruler"><classname>gtk.Ruler</classname></link>. See the
-<link
-linkend="method-gtkruler--set-range"><methodname>set_range</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkscale.xml b/docs/reference/pygtk-gtkscale.xml
deleted file mode 100644
index 2e077dbc..00000000
--- a/docs/reference/pygtk-gtkscale.xml
+++ /dev/null
@@ -1,455 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkscale">
- <refnamediv>
- <refname>gtk.Scale</refname>
- <refpurpose>a base class for the scale widgets.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Scale</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkrange">gtk.Range</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscale--set-digits">set_digits</link></methodname>
- <methodparam><parameter
- role="keyword">digits</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscale--get-digits">get_digits</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscale--set-draw-value">set_draw_value</link></methodname>
- <methodparam><parameter
- role="keyword">draw_value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscale--get-draw-value">get_draw_value</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscale--set-value-pos">set_value_pos</link></methodname>
- <methodparam><parameter role="keyword">pos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscale--get-value-pos">get_value_pos</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscale--get-layout">get_layout</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscale--get-layout-offsets">get_layout_offsets</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkrange">gtk.Range</link>
- +-- <link linkend="class-gtkscale">gtk.Scale</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkscale">
- <title>gtk.Scale Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkrange">gtk.Range Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"digits"</entry>
- <entry>Read-Write</entry>
- <entry>The number of decimal places that are displayed in the
-value</entry>
- </row>
-
- <row valign="top">
- <entry>"draw-value"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the current value is
-displayed as a string next to the slider</entry>
- </row>
-
- <row valign="top">
- <entry>"value-pos"</entry>
- <entry>Read-Write</entry>
- <entry>The position in which the current value is displayed:
-<literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
-<literal>gtk.POS_TOP</literal> or <literal>gtk.POS_BOTTOM</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkscale">
- <title>gtk.Scale Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"slider-length"</entry>
- <entry>Read</entry>
- <entry>The length of scale's slider</entry>
- </row>
-
- <row valign="top">
- <entry>"value-spacing"</entry>
- <entry>Read</entry>
- <entry>The space between value text and the slider or trough
- area</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkscale">
- <title>gtk.Scale Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkrange">gtk.Range Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkscale--format-value">format-value</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>scale</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkscale"><classname>gtk.Scale</classname></link> widget is
-an abstract base class, used only for deriving the subclasses <link
-linkend="class-gtkhscale"><classname>gtk.HScale</classname></link> and <link
-linkend="class-gtkvscale"><classname>gtk.VScale</classname></link>. A <link
-linkend="class-gtkscale"><classname>gtk.Scale</classname></link> is a slider
-control used to select a numeric value. Since <link
-linkend="class-gtkscale"><classname>gtk.Scale</classname></link> is a
-subclass of <link
-linkend="class-gtkrange"><classname>gtk.Range</classname></link>, see the
-<link linkend="class-gtkrange"><classname>gtk.Range</classname></link>
-methods for additional methods. To set the value of a scale, you would
-normally use <link
-linkend="method-gtkrange--set-value"><methodname>set_value</methodname>()</link>.
-To detect changes to the value, you would normally use the "value_changed"
-signal.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkscale--set-digits">
- <title>gtk.Scale.set_digits</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_digits</methodname>
- <methodparam><parameter
- role="keyword">digits</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">digits</parameter>&nbsp;:</term>
- <listitem><simpara>the number of decimal places to
-display</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_digits</methodname>() method sets the
-"digits" property to the value specified by <parameter>digits</parameter>.
-The value of <parameter>digits</parameter> specifies the number of decimal
-places that are displayed in the value. The value of the adjustment is also
-rounded off to this number of digits if "draw-value" is
-<literal>True</literal>, so the retrieved value matches the value the user
-sees. If the "draw-value" property has been set to <literal>False</literal>
-by using the <link
-linkend="method-gtkscale--set-draw-value"><methodname>set_draw_value</methodname>()</link>
-method, the adjustment value will not be rounded at all.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscale--get-digits">
- <title>gtk.Scale.get_digits</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_digits</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of decimal places that are
-displayed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_digits</methodname>() method returns the
-value of the "digits" property that indicates the number of decimal places
-that are displayed in the value.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscale--set-draw-value">
- <title>gtk.Scale.set_draw_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_draw_value</methodname>
- <methodparam><parameter
- role="keyword">draw_value</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">draw_value</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> draw the current
-value next to the slider</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_draw_value</methodname>() method sets the
-"draw-value" property to the value specified by
-<parameter>draw_value</parameter>. If <parameter>draw_value</parameter> is
-<parameter>True</parameter> the current value is displayed next to the
-slider.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscale--get-draw-value">
- <title>gtk.Scale.get_draw_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_draw_value</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the current value is
-to be drawn next to the slider</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_draw_value</methodname>() method returns the
-value of the "draw-value" property. If "draw-value" is
-<literal>True</literal> the current scale value is drawn next to the
-slider.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscale--set-value-pos">
- <title>gtk.Scale.set_value_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_value_pos</methodname>
- <methodparam><parameter
- role="keyword">pos</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pos</parameter>&nbsp;:</term>
- <listitem><simpara>the position where the current value is
-displayed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_value_pos</methodname>() method sets the
-value of the "value-pos" property to the value specified by
-<parameter>pos</parameter>. The value of <parameter>pos</parameter> must be
-one of: <literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
-<literal>gtk.POS_TOP</literal> or <literal>gtk.POS_BOTTOM</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscale--get-value-pos">
- <title>gtk.Scale.get_value_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_value_pos</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the position where the current value is
-displayed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_value_pos</methodname>() method returns the
-value of the "value-pos" property. See the <link
-linkend="method-gtkscale--set-value-pos"><methodname>set_value_pos</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscale--get-layout">
- <title>gtk.Scale.get_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_layout</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-pangolayout"><classname>pango.Layout</classname></link>
- for this scale or <literal>None</literal> if the draw_value
- property is <literal>False</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_layout</methodname>() method returns the
-<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-used to display the scale.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscale--get-layout-offsets">
- <title>gtk.Scale.get_layout_offsets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_layout_offsets</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the coordinates where the
- scale will draw the <link
- linkend="class-pangolayout"><classname>pango.Layout</classname></link>
- representing the text in the scale</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_layout_offsets</methodname>() method returns
-a 2-tuple containing the coordinates where the scale will draw the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-representing the text in the scale. Remember when using the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-function you need to convert to and from pixels using the <link
-linkend="function-pango--PIXELS"><function>pango.PIXELS</function>()</link>
-function or <literal>pango.SCALE</literal>. If the "draw-value" property is
-<literal>False</literal>, the return values are undefined.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkscale--format-value">
- <title>The "format-value" gtk.Scale Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>scale</parameter></methodparam>
- <methodparam><parameter>value</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>scale</parameter>&nbsp;:</term>
- <listitem><simpara>the scale that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter>&nbsp;:</term>
- <listitem><simpara>the value to be formatted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string representing
- <parameter>value</parameter> for display</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "format-value" signal is emitted when the scale is being
-redrawn with a value displayed. The "format-value" signal handler should
-return a formatted string containing <parameter>value</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkscrollbar.xml b/docs/reference/pygtk-gtkscrollbar.xml
deleted file mode 100644
index 2ccbce1f..00000000
--- a/docs/reference/pygtk-gtkscrollbar.xml
+++ /dev/null
@@ -1,160 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkscrollbar">
- <refnamediv>
- <refname>gtk.Scrollbar</refname>
- <refpurpose>a base class for scrollbar widgets.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Scrollbar</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkrange">gtk.Range</link></classname></ooclass>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkrange">gtk.Range</link>
- +-- <link linkend="class-gtkscrollbar">gtk.Scrollbar</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkscrollbar">
- <title>gtk.Scrollbar Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkrange">gtk.Range Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkscrollbar">
- <title>gtk.Scrollbar Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"fixed-slider-length"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> don't change the slider
-size, just lock it to the minimum length</entry>
- </row>
-
- <row valign="top">
- <entry>"has-backward-stepper"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> display the standard
-backward arrow button</entry>
- </row>
-
- <row valign="top">
- <entry>"has-forward-stepper"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> display the standard forward
-arrow button</entry>
- </row>
-
- <row valign="top">
- <entry>"has-secondary-backward-stepper"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> display a second backward
-arrow button on the opposite end of the scrollbar</entry>
- </row>
-
- <row valign="top">
- <entry>"has-secondary-forward-stepper"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> display a secondary forward
-arrow button on the opposite end of the scrollbar</entry>
- </row>
-
- <row valign="top">
- <entry>min-slider-length""</entry>
- <entry>Read</entry>
- <entry>The minimum length of scrollbar slider</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkscrollbar">
- <title>gtk.Scrollbar Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkrange">gtk.Range Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>
-widget is an abstract base class for <link
-linkend="class-gtkhscrollbar"><classname>gtk.HScrollbar</classname></link>
-and <link
-linkend="class-gtkvscrollbar"><classname>gtk.VScrollbar</classname></link>.
-The position of the thumb in a scrollbar is controlled by the scroll
-adjustments. The <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link> uses the attributes in an adjustment (see <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>) as follows:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the <literal>adjustment.lower</literal> attribute is the
-minimum value of the scroll region</simpara>
- </listitem>
- <listitem>
- <simpara>the <literal>adjustment.upper</literal> attribute is the
-maximum value of the scroll region</simpara>
- </listitem>
- <listitem>
- <simpara>the <literal>adjustment.value</literal> attribute
-represents the position of the scrollbar, which must be between
-<literal>adjustment.lower</literal> and <literal>adjustment.upper</literal>
-- <literal>adjustment.page_size</literal></simpara>
- </listitem>
- <listitem>
- <simpara>the <literal>adjustment.page_size</literal> attribute
-represents the size of the visible scrollable area</simpara>
- </listitem>
- <listitem>
- <simpara>the <literal>adjustment.step_increment</literal> attribute
-is the distance to scroll when the small stepper arrows are clicked</simpara>
- </listitem>
- <listitem>
- <simpara>the <literal>adjustment.page_increment</literal> attribute
-is the distance to scroll when the <keycap>Page Up</keycap> or <keycap>Page
-Down</keycap> keys are pressed</simpara>
- </listitem>
- </itemizedlist>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkscrolledwindow.xml b/docs/reference/pygtk-gtkscrolledwindow.xml
deleted file mode 100644
index 44569704..00000000
--- a/docs/reference/pygtk-gtkscrolledwindow.xml
+++ /dev/null
@@ -1,1050 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkscrolledwindow">
- <refnamediv>
- <refname>gtk.ScrolledWindow</refname>
- <refpurpose>adds scrollbars to its child widget.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ScrolledWindow</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkscrolledwindow">gtk.ScrolledWindow</link></methodname>
- <methodparam><parameter
- role="keyword">hadjustment</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">vadjustment</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--set-hadjustment">set_hadjustment</link></methodname>
- <methodparam><parameter
- role="keyword">hadjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--set-vadjustment">set_vadjustment</link></methodname>
- <methodparam><parameter
- role="keyword">vadjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--get-hadjustment">get_hadjustment</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--get-vadjustment">get_vadjustment</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--get-hscrollbar">get_hscrollbar</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--get-vscrollbar">get_vscrollbar</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--set-policy">set_policy</link></methodname>
- <methodparam><parameter
- role="keyword">hscrollbar_policy</parameter></methodparam>
- <methodparam><parameter
- role="keyword">vscrollbar_policy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--get-policy">get_policy</link></methodname>
- <methodparam><parameter
- role="keyword">hscrollbar_policy</parameter></methodparam>
- <methodparam><parameter
- role="keyword">vscrollbar_policy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--set-placement">set_placement</link></methodname>
- <methodparam><parameter
- role="keyword">window_placement</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--get-placement">get_placement</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--set-shadow-type">set_shadow_type</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--get-shadow-type">get_shadow_type</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkscrolledwindow--add-with-viewport">add_with_viewport</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkscrolledwindow">gtk.ScrolledWindow</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkscrolledwindow">
- <title>gtk.ScrolledWindow Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"hadjustment"</entry>
- <entry>Read-Write-Construct</entry>
- <entry>The <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-for the horizontal position.</entry>
- </row>
-
- <row valign="top">
- <entry>hscrollbar-policy""</entry>
- <entry>Read-Write</entry>
- <entry>The horizontal scrollbar display policy; one of:
-<literal>gtk.POLICY_ALWAYS</literal>,
-<literal>gtk.POLICY_AUTOMATIC</literal> or
-<literal>gtk.POLICY_NEVER</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"shadow-type"</entry>
- <entry>Read-Write</entry>
- <entry>The style of bevel around the contents; one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"vadjustment"</entry>
- <entry>Read-Write-Construct</entry>
- <entry>The <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-for the vertical position.</entry>
- </row>
-
- <row valign="top">
- <entry>"vscrollbar-policy"</entry>
- <entry>Read-Write</entry>
- <entry>The vertical scrollbar display policy; one of:
-<literal>gtk.POLICY_ALWAYS</literal>,
-<literal>gtk.POLICY_AUTOMATIC</literal> or
-<literal>gtk.POLICY_NEVER</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"window-placement"</entry>
- <entry>Read-Write</entry>
- <entry>Where the contents are located with respect to the
-scrollbars; one of: <literal>gtk.CORNER_TOP_LEFT</literal>,
-<literal>gtk.CORNER_BOTTOM_LEFT</literal>,
-<literal>gtk.CORNER_TOP_RIGHT</literal>,
-<literal>gtk.CORNER_BOTTOM_RIGHT</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"window-placement-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> "window-placement" should be
- used to determine the location of the contents with respect to the
- scrollbars.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkscrolledwindow">
- <title>gtk.ScrolledWindow Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"scrollbar-spacing"</entry>
- <entry>Read</entry>
-
- <entry>The number of pixels between the scrollbars and the
- scrolled window. Available in <literal>GTK+</literal> 2.2 and
- above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkscrolledwindow">
- <title>gtk.ScrolledWindow Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkscrolledwindow--move-focus-out">move-focus-out</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>scrolledwindow</parameter></methodparam>
- <methodparam><parameter>direction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkscrolledwindow--scroll-child">scroll-child</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>scrolledwindow</parameter></methodparam>
- <methodparam><parameter>scrolltype</parameter></methodparam>
- <methodparam><parameter>horizontal</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>
-is a subclass of <link
-linkend="class-gtkbin"><classname>gtk.Bin</classname></link> that adds
-scrollbars to a single child widget and optionally draws a beveled frame
-around the child widget. The scrolled window can work in two ways:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>Some widgets have native scrolling support using "slots" to
-hold <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-objects. Widgets with native scroll support include <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>,
-<link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>, and
-<link
-linkend="class-gtklayout"><classname>gtk.Layout</classname></link>.</simpara>
- </listitem>
- <listitem>
- <simpara>Widgets that lack native scrolling support use the <link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link>
-widget that acts as an adapter class, implementing scrollability for child
-widgets that lack their own scrolling capabilities. Use <link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link> to
-scroll child widgets such as <link
-linkend="class-gtktable"><classname>gtk.Table</classname></link>, <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link>, and so
-on.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>If a widget has native scrolling abilities, it can be added to the
-<link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>
-with the <link
-linkend="method-gtkcontainer--add"><methodname>gtk.Container.add</methodname>()</link>
-method. If a widget does not, you must first add the widget to a <link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link>, then
-add the <link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link> to
-the scrolled window. The convenience method <link
-linkend="method-gtkscrolledwindow--add-with-viewport"><methodname>add_with_viewport</methodname>()</link>
-does exactly this, so you can ignore the presence of the viewport.</para>
-
- <para>The position of the scrollbars is controlled by the scroll
-adjustments. The <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>
-uses the attributes in an adjustment (see <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>)
-as follows:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the <literal>adjustment.lower</literal> attribute is the
-minimum value of the scroll region</simpara>
- </listitem>
- <listitem>
- <simpara>the <literal>adjustment.upper</literal> attribute is the
-maximum value of the scroll region</simpara>
- </listitem>
- <listitem>
- <simpara>the <literal>adjustment.value</literal> attribute
-represents the position of the scrollbar, which must be between
-<literal>adjustment.lower</literal> and <literal>adjustment.upper</literal>
-- <literal>adjustment.page_size</literal></simpara>
- </listitem>
- <listitem>
- <simpara>the <literal>adjustment.page_size</literal> attribute
-represents the size of the visible scrollable area</simpara>
- </listitem>
- <listitem>
- <simpara>the <literal>adjustment.step_increment</literal> attribute
-is the distance to scroll when the small stepper arrows are
-clicked</simpara>
- </listitem>
- <listitem>
- <simpara>the <literal>adjustment.page_increment</literal> attribute
-is the distance to scroll when the <keycap>Page Up</keycap> or <keycap>Page
-Down</keycap> keys are pressed</simpara>
- </listitem>
- </itemizedlist>
-
- <para>If a <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>
-doesn't behave quite as you would like, or doesn't have exactly the right
-layout, it's very possible to set up your own scrolling with <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link> and
-for example a <link
-linkend="class-gtktable"><classname>gtk.Table</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkscrolledwindow">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ScrolledWindow</methodname>
- <methodparam><parameter role="keyword">hadjustment</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">vadjustment</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">hadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-or None</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">vadjustment</parameter>&nbsp;:</term> <listitem><simpara>a
-vertical <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-or None</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new scrolled window with the horizontal and vertical
-<link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-specified by <parameter>hadjustment</parameter> and
-<parameter>vadjustment</parameter> respectively. These will be shared with
-the scrollbars and the child widget to keep the bars in sync with the child.
-If <parameter>hadjustment</parameter> and <parameter>vadjustment</parameter>
-are <literal>None</literal> or not specified the scrolled window will create
-them for you.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkscrolledwindow--set-hadjustment">
- <title>gtk.ScrolledWindow.set_hadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_hadjustment</methodname>
- <methodparam><parameter
- role="keyword">hadjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">hadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_hadjustment</methodname>() method sets the
-horizontal adjustment (and the "hadjustment" property) to the value of
-<parameter>hadjustment</parameter>. <parameter>hadjustment</parameter> must
-be a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--set-vadjustment">
- <title>gtk.ScrolledWindow.set_vadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_vadjustment</methodname>
- <methodparam><parameter
- role="keyword">vadjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">vadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the vertical <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_vadjustment</methodname>() method sets the
-vertical adjustment (and the "vadjustment" property) to the value of
-<parameter>vadjustment</parameter>. <parameter>vadjustment</parameter> must
-be a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--get-hadjustment">
- <title>gtk.ScrolledWindow.get_hadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_hadjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the horizontal <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_hadjustment</methodname>() method returns
-the value of the "hadjustment" property which is a reference to the
-horizontal adjustment.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--get-vadjustment">
- <title>gtk.ScrolledWindow.get_vadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_vadjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the vertical <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_vadjustment</methodname>() method returns
-the value of the "vadjustment" property which is a reference to the vertical
-adjustment.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--get-hscrollbar">
- <title>gtk.ScrolledWindow.get_hscrollbar</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_hscrollbar</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The horizontal scrollbar of the scrolled window
-or <literal>None</literal> if it does not exist.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_hscrollbar</methodname>() method returns the
-<link
-linkend="class-gtkhscrollbar"><classname>gtk.HScrollbar</classname></link>
-for the scrolled window or <literal>None</literal> if there is no horizontal
-scrollbar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--get-vscrollbar">
- <title>gtk.ScrolledWindow.get_vscrollbar</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_vscrollbar</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The vertical scrollbar of the scrolled window
-or <literal>None</literal> if it does not exist.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_vscrollbar</methodname>() method returns the
-<link
-linkend="class-gtkvscrollbar"><classname>gtk.VScrollbar</classname></link>
-for the scrolled window or <literal>None</literal> if there is no vertical
-scrollbar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--set-policy">
- <title>gtk.ScrolledWindow.set_policy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_policy</methodname>
- <methodparam><parameter
- role="keyword">hscrollbar_policy</parameter></methodparam>
- <methodparam><parameter
- role="keyword">vscrollbar_policy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">hscrollbar_policy</parameter>&nbsp;:</term>
- <listitem><simpara>the policy for the horizontal
-scrollbar</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">vscrollbar_policy</parameter>&nbsp;:</term>
- <listitem><simpara>the policy for the vertical
-scrollbar</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_policy</methodname>() method sets the
-"hscrollbar_policy" and "vscrollbar_policy" properties to the value of
-<parameter>hscrollbar_policy</parameter> and
-<parameter>vscrollbar_policy</parameter> respectively. The policy determines
-when the scrollbar should be displayed. The policy value is one of:</para>
-
- <variablelist>
- <varlistentry>
- <term>gtk.POLICY_ALWAYS</term>
- <listitem>
- <simpara>the scrollbar is always present</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>gtk.POLICY_AUTOMATIC</term>
- <listitem>
- <simpara>the scrollbar is present only if needed i.e. the
-contents are larget than the window</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>gtk.POLICY_NEVER</term>
- <listitem>
- <simpara>the scrollbar is never present</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--get-policy">
- <title>gtk.ScrolledWindow.get_policy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_policy</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>>&nbsp;:</term>
- <listitem><simpara>a tuple containing the horizontal and vertical
-scrollbar policies</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_policy</methodname>() method returns a tuple
-containing the horizontal and vertical scrollbar policies. See the <link
-linkend="method-gtkscrolledwindow--set-policy"><methodname>set_policy</methodname>()</link> method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--set-placement">
- <title>gtk.ScrolledWindow.set_placement</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_placement</methodname>
- <methodparam><parameter
- role="keyword">window_placement</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">window_placement</parameter>&nbsp;:</term>
- <listitem><simpara>the placement of the contents with respect to
-the scrollbars</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_placement</methodname>() method sets the
-"window-placement" property to the value specified by
-<parameter>window_placement</parameter>. The window placement determines the
-location of the child widget with respect to the scrollbars.
-<parameter>window_placement</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term>gtk.CORNER_TOP_LEFT</term>
- <listitem>
- <simpara>Place the scrollbars on the right and bottom of the
-widget (default behavior).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>gtk.CORNER_BOTTOM_LEFT</term>
- <listitem>
- <simpara>Place the scrollbars on the top and right of the
-widget.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>gtk.CORNER_TOP_RIGHT</term>
- <listitem>
- <simpara>Place the scrollbars on the left and bottom of the
-widget.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>gtk.CORNER_BOTTOM_RIGHT</term>
- <listitem>
- <simpara>Place the scrollbars on the top and left of the
-widget.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--get-placement">
- <title>gtk.ScrolledWindow.get_placement</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_placement</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current placement
-value.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_placement</methodname>() method returns the
-value of the "window-placement" property that determines the placement of
-the scrollbars with respect to the scrolled window. See the <link
-linkend="method-gtkscrolledwindow--set-placement"><methodname>set_placement</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--set-shadow-type">
- <title>gtk.ScrolledWindow.set_shadow_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_shadow_type</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the kind of bevel shadow to draw around the
-scrolled window contents</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_shadow_type</methodname>() method sets the
-value of the "shadow-type" property to the value of
-<parameter>shadow_type</parameter>. <parameter>shadow_type</parameter>
-determines the type of bevel shadow drawn around the contents of the
-scrolled window. The shadow type must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term>gtk.SHADOW_NONE</term>
- <listitem>
- <simpara>No outline.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>gtk.SHADOW_IN</term>
- <listitem>
- <simpara>The outline is beveled inward.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>gtk.SHADOW_OUT</term>
- <listitem>
- <simpara>The outline is beveled outward.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>gtk.SHADOW_ETCHED_IN</term>
- <listitem>
- <simpara>The outline is an inward etched bevel.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>gtk.SHADOW_ETCHED_OUT</term>
- <listitem>
- <simpara>The outline is an outward etched bevel.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--get-shadow-type">
- <title>gtk.ScrolledWindow.get_shadow_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_shadow_type</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current shadow type</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_shadow_type</methodname>() method returns
-the value of the "shadow-type" property that determines the shadow type of
-the scrolled window. See the <link
-linkend="method-gtkscrolledwindow--set-shadow-type"><methodname>set_shadow_type</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkscrolledwindow--add-with-viewport">
- <title>gtk.ScrolledWindow.add_with_viewport</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_with_viewport</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to be scrolled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_with_viewport</methodname>() method is used
-to add a widget (specified by <parameter>child</parameter>) without native
-scrolling capabilities to the scrolled window. This is a convenience
-function that is equivalent to adding <parameter>child</parameter> to a
-<link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link>, then
-adding the viewport to the scrolled window. If a child has native scrolling
-(e.g. <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>,
-<link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>,
-<link linkend="class-gtklayout"><classname>gtk.Layout</classname></link>),
-use <link
-linkend="method-gtkcontainer--add"><methodname>gtk.Container.add</methodname>()</link>
-instead of this method.</para>
-
- <para>The viewport scrolls the child by moving its <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>,
-and takes the size of the child to be the size of its toplevel <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.
-This will be wrong for most widgets that support native scrolling. For
-example, if you add a widget such as <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> with
-a viewport, the whole widget will scroll, including the column
-headings.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkscrolledwindow--move-focus-out">
- <title>The "move-focus-out" gtk.ScrolledWindow Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>scrolledwindow</parameter></methodparam>
- <methodparam><parameter>direction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>scrolledwindow</parameter>&nbsp;:</term>
- <listitem><simpara>the scrolledwindow that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>direction</parameter>&nbsp;:</term>
- <listitem><simpara>the direction that the focus is moving either
-<literal>gtk.DIR_TAB_FORWARD</literal> or
-<literal>gtk.DIR_TAB_BACKWARD</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-focus-out" signal is emitted when the user presses
-<keycombo action="simul"><keycap>Control</keycap><keycap>Tab</keycap>
-</keycombo> or <keycombo
-action="simul"><keycap>Control</keycap><keycap>Shift</keycap><keycap>Tab</keycap>
-</keycombo> to move the focus out of the scrolled window. The
-<parameter>direction</parameter> is either
-<literal>gtk.DIR_TAB_FORWARD</literal> or
-<literal>gtk.DIR_TAB_BACKWARD</literal></para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkscrolledwindow--scroll-child">
- <title>The "scroll-child" gtk.ScrolledWindow Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>scrolledwindow</parameter></methodparam>
- <methodparam><parameter>scrolltype</parameter></methodparam>
- <methodparam><parameter>horizontal</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>scrolledwindow</parameter>&nbsp;:</term>
- <listitem><simpara>the scrolledwindow that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>scrolltype</parameter>&nbsp;:</term>
- <listitem><simpara>the scroll type; one of:
-<literal>gtk.SCROLL_STEP_BACKWARD</literal>,
-<literal>gtk.SCROLL_STEP_FORWARD</literal>,
-<literal>gtk.SCROLL_PAGE_BACKWARD</literal>,
-<literal>gtk.SCROLL_PAGE_FORWARD</literal>,
-<literal>gtk.SCROLL_PAGE_UP</literal>,
-<literal>gtk.SCROLL_PAGE_DOWN</literal>, <literal>gtk.SCROLL_START</literal>
-or <literal>gtk.SCROLL_END</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>horizontal</parameter>&nbsp;:</term>
- <listitem><simpara>if True scroll in the horizontal
-direction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "scroll-child" signal is emitted when the child widget is
-being scrolled by a keyboard action. The default key bindings with resulting
-<parameter>scrolltype</parameter> and <parameter>horizontal</parameter>
-arguments are:</para>
-
- <variablelist>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Control</keycap>
- <keycap>Left&nbsp;Arrow</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_STEP_BACKWARD</literal> -
-horizontal</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Control</keycap>
- <keycap>Right&nbsp;Arrow</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_STEP_FORWARD</literal> -
-horizontal</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Control</keycap>
- <keycap>Up&nbsp;Arrow</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_STEP_BACKWARD</literal> -
-vertical</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Control</keycap>
- <keycap>Down&nbsp;Arrow</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_STEP_FORWARD</literal> -
-vertical</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Control</keycap>
- <keycap>Page&nbsp;Up</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_PAGE_BACKWARD</literal> -
-horizontal</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Control</keycap>
- <keycap>Page&nbsp;Down</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_PAGE_FORWARD</literal> -
-horizontal</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Page&nbsp;Up</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_PAGE_BACKWARD</literal> -
-vertical</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Page&nbsp;Down</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_PAGE_FORWARD</literal> -
-vertical</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Control</keycap>
- <keycap>Home</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_START</literal> -
-horizontal</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Control</keycap>
- <keycap>End</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_END</literal> -
-horizontal</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Home</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_START</literal> -
-vertical</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>End</keycap>
- </keycombo></term>
- <listitem>
- <simpara><literal>gtk.SCROLL_END</literal> - vertical</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkselectiondata.xml b/docs/reference/pygtk-gtkselectiondata.xml
deleted file mode 100644
index 5fa5e4d8..00000000
--- a/docs/reference/pygtk-gtkselectiondata.xml
+++ /dev/null
@@ -1,1027 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkselectiondata">
- <refnamediv>
- <refname>gtk.SelectionData</refname>
- <refpurpose>an object that stores information about a
-selection</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.SelectionData</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--set">set</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">format</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--set-text">set_text</link></methodname>
- <methodparam><parameter role="keyword">str</parameter></methodparam>
- <methodparam><parameter role="keyword">len</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--get-text">get_text</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--get-targets">get_targets</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--targets-include-text">targets_include_text</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--tree-set-row-drag-data">tree_set_row_drag_data</link></methodname>
- <methodparam><parameter
- role="keyword">tree_model</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--tree-get-row-drag-data">tree_get_row_drag_data</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--set-pixbuf">set_pixbuf</link></methodname>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--get-pixbuf">get_pixbuf</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--set-uris">set_uris</link></methodname>
- <methodparam><parameter role="keyword">uris</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--get-uris">get_uris</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkselectiondata--targets-include-image">targets_include_image</link></methodname>
- <methodparam><parameter role="keyword">writable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkselectiondata--targets-include-rich-text">targets_include_rich_text</link></methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkselectiondata--targets-include-uri">targets_include_uri</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--selection-owner-set-for-display">gtk.selection_owner_set_for_display</link></methodname>
- <methodparam><parameter role="keyword">display</parameter></methodparam>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- <methodparam><parameter role="keyword">selection</parameter></methodparam>
- <methodparam><parameter role="keyword">time</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--target-list-add-image-targets">gtk.target_list_add_image_targets</link></methodname>
- <methodparam><parameter role="keyword">list</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">info</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">writable</parameter><initializer>False</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--target-list-add-text-targets">gtk.target_list_add_text_targets</link></methodname>
- <methodparam><parameter role="keyword">list</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">info</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--target-list-add-uri-targets">gtk.target_list_add_uri_targets</link></methodname>
- <methodparam><parameter role="keyword">list</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">info</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--target-list-add-rich-text-targets">gtk.target_list_add_rich_text_targets</link></methodname>
- <methodparam><parameter role="keyword">list</parameter></methodparam>
- <methodparam><parameter role="keyword">info</parameter></methodparam>
- <methodparam><parameter role="keyword">deserializable</parameter></methodparam>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--targets-include-image">gtk.targets_include_image</link></methodname>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- <methodparam><parameter role="keyword">writable</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--targets-include-rich-text">gtk.targets_include_rich_text</link></methodname>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--targets-include-text">gtk.targets_include_text</link></methodname>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--targets-include-uri">gtk.targets_include_uri</link></methodname>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- </methodsynopsis>
-</programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"selection"</entry>
- <entry>Read</entry>
- <entry>A <link linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> indicating the selection type (e.g. "PRIMARY").</entry>
- </row>
-
- <row valign="top">
- <entry>"target"</entry>
- <entry>Read</entry>
- <entry>A <link linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> indicating the selection target type (e.g. "TARGETS").</entry>
- </row>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>A <link linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> indicating the selection data type (e.g. "STRING").</entry>
- </row>
-
- <row valign="top">
- <entry>"format"</entry>
- <entry>Read</entry>
- <entry>The unit length of the data in bits (e.g. 8 for a
-string or 32 of an integer).</entry>
- </row>
-
- <row valign="top">
- <entry>"data"</entry>
- <entry>Read</entry>
- <entry>The data as a string.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-object is used to store information about a chunk of data associated with a
-selection. In PyGTK the selection data is always a string so the application
-will have to provide functions to convert the data to and from a string to
-support data types other than strings and targets. The string and targets
-types are directly supported using the <link
-linkend="method-gtkselectiondata--set-text"><methodname>set_text</methodname>()</link>,
-<link
-linkend="method-gtkselectiondata--get-text"><methodname>get_text</methodname>()</link>
-and <link
-linkend="method-gtkselectiondata--get-targets"><methodname>get_targets</methodname>()</link>
-methods.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkselectiondata--set">
- <title>gtk.SelectionData.set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">format</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> or string
-that specifies a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">format</parameter>&nbsp;:</term>
- <listitem><simpara>the number of bits in a
-unit</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the
-data</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set</methodname>() method sets the data for a
-selection in the <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-object. <parameter>data</parameter> is a string containing the data to be
-set; <parameter>format</parameter> is the number of bits in a unit of the
-data (e.g. integer data has a format of 32 on most systems; string data
-format is 8); and, <parameter>type</parameter> is a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link> or a
-string that specifies a <link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--set-text">
- <title>gtk.SelectionData.set_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text</methodname>
- <methodparam><parameter
- role="keyword">str</parameter></methodparam>
- <methodparam><parameter
- role="keyword">len</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">str</parameter>&nbsp;:</term>
- <listitem><simpara>a string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">len</parameter>&nbsp;:</term>
- <listitem><simpara>the length of <parameter>str</parameter>, or -1
-if <parameter>str</parameter> for the full length.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if the selection was
-successfully set; otherwise, <literal>False</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_text</methodname>() method sets the contents
-of the selection from the string specified by <parameter>str</parameter>.
-The string is converted to the form specified by the
-<literal>selection_data.target</literal> attribute. This method returns True
-if the selection data was successfully set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--get-text">
- <title>gtk.SelectionData.get_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing the converted text, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_text</methodname>() method returns the
-contents of the selection data as a string.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--get-targets">
- <title>gtk.SelectionData.get_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_targets</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a list of targets (<link
-linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>s) or
-<literal>None</literal> if no valid targets are
-available.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_targets</methodname>() method returns a
-tuple containing a list of valid targets for the selection as a list of
-<link linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>s or
-None if there are no valid targets.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--targets-include-text">
- <title>gtk.SelectionData.targets_include_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>targets_include_text</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the selection data
-holds a list of targets, and a suitable target for text is
-included.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>targets_include_text</methodname>() method
-returns <literal>True</literal> if any of the selection data targets can be
-used to provide text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--tree-set-row-drag-data">
- <title>gtk.SelectionData.tree_set_row_drag_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>tree_set_row_drag_data</methodname>
- <methodparam><parameter
- role="keyword">tree_model</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">tree_model</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a row in
-<parameter>tree_model</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-had the proper target type to allow us to set a tree
-row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>tree_set_row_drag_data</methodname>() method
-sets the selection data of target type <literal>GTK_TREE_MODEL_ROW</literal>
-for the row (specified by <parameter>path</parameter>) in the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-(specified by tree_model). Normally used in a "<link
-linkend="signal-gtkwidget--drag-data-get">drag-data-get</link>" signal
-handler.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--tree-get-row-drag-data">
- <title>gtk.SelectionData.tree_get_row_drag_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>tree_get_row_drag_data</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> and
-one of its rows.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>tree_get_row_drag_data</methodname>() method
-returns a tuple containing a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> and
-a row from that <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-from selection data of target type <literal>GTK_TREE_MODEL_ROW</literal>.
-Normally called from a "<link
-linkend="signal-gtkwidget--drag-data-received">drag-data-received</link>"
-signal handler. This method can only be used if the selection data
-originates from the same process that's calling this method, because a
-pointer to the tree model is being passed around. In the "<link
-linkend="signal-gtkwidget--drag-data-received">drag-data-received</link>"
-signal handler, you can assume that selection data of type
-<literal>"GTK_TREE_MODEL_ROW"</literal> is from the current process.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--set-pixbuf">
- <title>gtk.SelectionData.set_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_pixbuf</methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if the selection was
-successfully set; otherwise, <literal>False</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_pixbuf</methodname>() method sets the
-contents of the selection from the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-specified by <parameter>pixbuf</parameter>. This method returns
-<literal>True</literal> if the selection data was successfully set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--get-pixbuf">
- <title>gtk.SelectionData.get_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixbuf</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>if the selection data contained a recognized
-image type and it could be converted to a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>, a
-newly allocated pixbuf is returned, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_pixbuf</methodname>() method returns the
-contents of the selection data as a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> if
-possible.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--set-uris">
- <title>gtk.SelectionData.set_uris</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_uris</methodname>
- <methodparam><parameter
- role="keyword">uris</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">uris</parameter>&nbsp;:</term>
- <listitem><simpara>a list of strings holding
-URIs</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if the selection was
-successfully set; otherwise, <literal>False</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_uris</methodname>() method sets the contents
-of the selection from the list of URIs specified by
-<parameter>uris</parameter>. This method returns <literal>True</literal> if
-the selection data was successfully set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--get-uris">
- <title>gtk.SelectionData.get_uris</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_uris</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of URIs, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_uris</methodname>() method returns the
-contents of the selection data as a list of URIs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--targets-include-image">
- <title>gtk.SelectionData.targets_include_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>targets_include_image</methodname>
- <methodparam><parameter
- role="keyword">writable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">writable</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> only accept targets
-that GTK+ can convert a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if the selection has a
-list of targets that includes an image target.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>targets_include_image</methodname>() method
-returns <literal>True</literal> if the selection targets include an image
-target.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--targets-include-rich-text">
- <title>gtk.SelectionData.targets_include_rich_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>targets_include_rich_text</methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">buffer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a suitable target
- for rich text is included in the selectiondata
- targets.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Determines if any of the selectiondata targets can be used to
- provide rich text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkselectiondata--targets-include-uri">
- <title>gtk.SelectionData.targets_include_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>targets_include_uri</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a suitable target
- for uris is included in the selectiondata
- targets.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Determines if any of the selectiondata targets can be used to
- provide a list of URIs.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--selection-owner-set-for-display">
- <title>gtk.selection_owner_set_for_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.selection_owner_set_for_display</methodname>
- <methodparam><parameter
- role="keyword">display</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">display</parameter>&nbsp;:</term>
- <listitem><simpara> the <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
- where the selection is set</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the new selection owner (a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>),
- or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>
- or string representing a selection target</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp used to claim the
- selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the operation
- succeeded</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.selection_owner_set_for_display</function>()
-function claims ownership of the selection specified by
-<parameter>selection</parameter> for the widget specified by
-<parameter>widget</parameter> on the <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-specified by <parameter>display</parameter>. If
-<parameter>widget</parameter> is <literal>None</literal>, the ownership of
-the selection is released.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--target-list-add-image-targets">
- <title>gtk.target_list_add_image_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.target_list_add_image_targets</methodname>
- <methodparam><parameter
- role="keyword">list</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">info</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">writable</parameter><initializer>False</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">list</parameter>&nbsp;:</term>
- <listitem><simpara>A sequence of target entry tuples or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">info</parameter>&nbsp;:</term>
- <listitem><simpara>an application specified ID that will be
-passed back to the application</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">writable</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal>, only add targets
-for image formats that a pixbuf can be converted to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new list concatenating
-<parameter>list</parameter> and the built-in image targets supported by
-<link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.target_list_add_image_targets</function>()
-function adds the image target tuples supported by <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-to the list of target entry tuples specified by
-<parameter>list</parameter>. <literal>info</literal> is used as the info
-field of the target entry tuples.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--target-list-add-text-targets">
- <title>gtk.target_list_add_text_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.target_list_add_text_targets</methodname>
- <methodparam><parameter
- role="keyword">list</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">info</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">list</parameter>&nbsp;:</term>
- <listitem><simpara>A sequence of target entry tuples or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">info</parameter>&nbsp;:</term>
- <listitem><simpara>an application specified ID that will be
-passed back to the application</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new list concatenating
-<parameter>list</parameter> and the built-in text targets supported by
-<link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.target_list_add_text_targets</function>()
-function adds the text target tuples supported by <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-to the list of target entry tuples specified by
-<parameter>list</parameter>. <literal>info</literal> is used as the info
-field of the target entry tuples.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--target-list-add-uri-targets">
- <title>gtk.target_list_add_uri_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.target_list_add_uri_targets</methodname>
- <methodparam><parameter
- role="keyword">list</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">info</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">list</parameter>&nbsp;:</term>
- <listitem><simpara>A sequence of target entry tuples or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">info</parameter>&nbsp;:</term>
- <listitem><simpara>an application specified ID that will be
-passed back to the application</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new list concatenating
-<parameter>list</parameter> and the built-in URI targets supported by
-<link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.target_list_add_uri_targets</function>()
-function adds the URI target tuples supported by <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-to the list of target entry tuple specified by
-<parameter>list</parameter>. <literal>info</literal> is used as the info
-field of the target entry tuples.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--targets-include-uri">
- <title>gtk.targets_include_uri</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.targets_include_uri</methodname>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a list of target strings</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if targets includes a
- uri target.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Determines if any of the targets in
- <parameter>targets</parameter> can be used to provide an uri
- list.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--targets-include-text">
- <title>gtk.targets_include_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.targets_include_text</methodname>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a list of target strings</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if targets includes a
- text target.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Determines if any of the targets in
- <parameter>targets</parameter> can be used to provide text.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--targets-include-rich-text">
- <title>gtk.targets_include_rich_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.targets_include_rich_text</methodname>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">buffer</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a list of target strings</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">buffer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Determines if any of the targets in
- <parameter>targets</parameter> can be used to provide rich
- text.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--targets-include-image">
- <title>gtk.targets_include_image</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.targets_include_image</methodname>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">writable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a list of target strings</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">writable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> accept only targets
- for which GTK+ knows how to convert a pixbuf into the
- format</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>targets</parameter> include a suitable target for
- images</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Determines if any of the targets in targets can be used to
- provide a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--target-list-add-rich-text-targets">
- <title>gtk.target_list_add_rich_text_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.target_list_add_rich_text_targets</methodname>
- <methodparam><parameter role="keyword">list</parameter></methodparam>
- <methodparam><parameter role="keyword">info</parameter></methodparam>
- <methodparam><parameter role="keyword">deserializable</parameter></methodparam>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">list</parameter>&nbsp;:</term>
- <listitem><simpara>a list of targets</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">info</parameter>&nbsp;:</term>
- <listitem><simpara>an ID that will be passed back to the
- application</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">deserializable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, deserializable rich
- text formats will be added, otherwise, serializable formats will
- be added.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">buffer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a target list with the rich text targets
- registered with <parameter>buffer</parameter> appended to
- <parameter>list</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Appends the rich text targets registered with the <link
- linkend="method-gtktextbuffer--register-serialize-format"><methodname>register_serialize_format</methodname>()</link>
- or <link
- linkend="method-gtktextbuffer--register-deserialize-format"><methodname>register_deserialize_format</methodname>()</link>
- methods to the target list. All targets are added with the same
- <parameter>info</parameter>.
-
-list</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkseparator.xml b/docs/reference/pygtk-gtkseparator.xml
deleted file mode 100644
index 23fad7e0..00000000
--- a/docs/reference/pygtk-gtkseparator.xml
+++ /dev/null
@@ -1,69 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkseparator">
- <refnamediv>
- <refname>gtk.Separator</refname>
- <refpurpose>a base class for visual separator widgets.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<classsynopsis language="python">
- <ooclass><classname>gtk.Separator</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
-</classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkseparator">gtk.Separator</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkseparator">
- <title>gtk.Separator Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkseparator">
- <title>gtk.Separator Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkseparator">
- <title>gtk.Separator Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkseparator"><classname>gtk.Separator</classname></link>
-widget is an abstract base class, used only for deriving the subclasses
-<link
-linkend="class-gtkhseparator"><classname>gtk.HSeparator</classname></link>
-and <link
-linkend="class-gtkvseparator"><classname>gtk.VSeparator</classname></link>.
-A separator is a visual delimiter between widgets.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkseparatormenuitem.xml b/docs/reference/pygtk-gtkseparatormenuitem.xml
deleted file mode 100644
index e91c2b97..00000000
--- a/docs/reference/pygtk-gtkseparatormenuitem.xml
+++ /dev/null
@@ -1,100 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkseparatormenuitem">
- <refnamediv>
- <refname>gtk.SeparatorMenuItem</refname>
- <refpurpose>a separator used in menus.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.SeparatorMenuItem</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkmenuitem">gtk.MenuItem</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkseparatormenuitem">gtk.SeparatorMenuItem</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkitem">gtk.Item</link>
- +-- <link linkend="class-gtkmenuitem">gtk.MenuItem</link>
- +-- <link linkend="class-gtkseparatormenuitem">gtk.SeparatorMenuItem</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkseparatormenuitem">
- <title>gtk.SeparatorMenuItem Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkseparatormenuitem">
- <title>gtk.SeparatorMenuItem Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkseparatormenuitem">
- <title>gtk.SeparatorMenuItem Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkseparatormenuitem"><classname>gtk.SeparatorMenuItem</classname></link>
-is a separator used to group items within a menu. It displays a horizontal
-line with a shadow to make it appear sunken into the interface.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkseparatormenuitem">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.SeparatorMenuItem</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkseparatormenuitem"><classname>gtk.SeparatorMenuItem</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkseparatormenuitem"><classname>gtk.SeparatorMenuItem</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkseparatortoolitem.xml b/docs/reference/pygtk-gtkseparatortoolitem.xml
deleted file mode 100644
index be81a5f0..00000000
--- a/docs/reference/pygtk-gtkseparatortoolitem.xml
+++ /dev/null
@@ -1,212 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkseparatortoolitem">
- <refnamediv>
- <refname>gtk.SeparatorToolItem</refname>
- <refpurpose>a toolbar item that separates groups of other toolbar
-items (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.SeparatorToolItem</classname></ooclass>
- <ooclass><classname><link linkend="class-gtktoolitem">gtk.ToolItem</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkseparatortoolitem">gtk.SeparatorToolItem</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkseparatortoolitem--get-draw">get_draw</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkseparatortoolitem--set-draw">set_draw</link></methodname>
- <methodparam><parameter role="keyword">draw</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtktoolitem">gtk.ToolItem</link>
- +-- <link linkend="class-gtkseparatortoolitem">gtk.SeparatorToolItem</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkseparatortoolitem">
- <title>gtk.SeparatorToolItem Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"draw"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, the separator is
- drawn. Available in GTK+ 2.4.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkseparatortoolitem">
- <title>gtk.SeparatorToolItem Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkseparatortoolitem">
- <title>gtk.SeparatorToolItem Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>
-is a <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> that
-separates groups of other <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-objects. Depending on the theme, a <link
-linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>
-will often look like a vertical line on horizontally docked toolbars.</para>
-
- <para>If the <link
-linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>
-is set to expand (using the <link
-linkend="method-gtktoolitem--set-expand"><methodname>gtk.ToolItem.set_expand</methodname>()</link>
-method) and the "draw" property is <literal>False</literal>, a <link
-linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>
-will act as a "spring" that forces other items to the ends of the
-toolbar.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkseparatortoolitem">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.SeparatorToolItem</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>
-
-Since: 2.4</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Create a new <link
-linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkseparatortoolitem--get-draw">
- <title>gtk.SeparatorToolItem.get_draw</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_draw</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>separator_tool_item</parameter> is drawn as a line, or
- just blank.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_draw</methodname>() method returns
-<literal>True</literal> if the separator tool item is drawn as a line or
-<literal>False</literal>, if it's just blank. See the <link
-linkend="method-gtkseparatortoolitem--set-draw"><methodname>set_draw()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkseparatortoolitem--set-draw">
- <title>gtk.SeparatorToolItem.set_draw</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_draw</methodname>
- <methodparam><parameter role="keyword">draw</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">draw</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the <link
- linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>
- is drawn as a vertical line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_draw</methodname>() method sets the "draw"
-property to the value of <parameter>draw</parameter>. If
-<parameter>draw</parameter> is <literal>True</literal> the <link
-linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>
-is drawn as a vertical line; if <literal>False</literal>, just blank.
-Setting the "draw" property to <literal>False</literal> along with passing
-True to the <link
-linkend="method-gtktoolitem--set-expand"><methodname>gtk.ToolItem.set_expand</methodname>()</link>
-is useful to create an item that forces following items to the end of the
-toolbar.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtksettings.xml b/docs/reference/pygtk-gtksettings.xml
deleted file mode 100644
index b94b7436..00000000
--- a/docs/reference/pygtk-gtksettings.xml
+++ /dev/null
@@ -1,740 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtksettings">
- <refnamediv>
- <refname>gtk.Settings</refname>
- <refpurpose>an object that contains the global settings for the
-widgets on a <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Settings</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
-
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtksettings- -install-property">install_property</link></methodname>
- <methodparam><parameter role="keyword">pspec</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtksettings- -install-property-parser">install_property_parser</link></methodname>
- <methodparam><parameter role="keyword">pspec</parameter></methodparam>
- <methodparam><parameter role="keyword">parser</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtksettings- -set-property-value">set_property_value</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">svalue</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtksettings--set-string-property">set_string_property</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">v_string</parameter></methodparam>
- <methodparam><parameter
- role="keyword">origin</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtksettings--set-long-property">set_long_property</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">v_long</parameter></methodparam>
- <methodparam><parameter
- role="keyword">origin</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtksettings--set-double-property">set_double_property</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">v_double</parameter></methodparam>
- <methodparam><parameter
- role="keyword">origin</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--settings-get-default">gtk.settings_get_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--settings-get-for-screen">gtk.settings_get_for_screen</link></methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </methodsynopsis>
-</programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtksettings">gtk.Settings</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtksettings">
- <title>gtk.Settings Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"color-hash"</entry>
- <entry>Read</entry>
- <entry>Holds a hash table representation of the
- gtk-color-scheme setting, mapping color names to <link
- linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>s.
- This property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-alternative-button-order"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, buttons in dialogs should
-use the alternative button order. Available in GTK+ 2.6 and above. Default
-value: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-button-images"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, stock icons should be shown
-in buttons. Available in GTK+ 2.4 and above.
-Default value: <literal>True</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-can-change-accels"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the menu accelerators can
-be changed by pressing a key over the menu item. Default
-value: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-color-palette"</entry>
- <entry>Read-Write</entry>
- <entry>The palette to use in the color selector.
-Default value: "black:white:gray50:red:purple:blue:light blue:green:yellow:orange:lavender:brown:goldenrod4:dodger blue:pink:light green:gray10:gray30:gray75:gray90"</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-color-scheme"</entry>
- <entry>Read-Write</entry>
- <entry>A palette of named colors for use in themes. The format of
- the string is:
-<programlisting>
-name1: color1
-name2: color2
-...
-</programlisting>
-Color names must be acceptable as identifiers in the <link
-linkend="class-gtkrcstyle"><classname>gtk.RcStyle</classname></link> syntax,
-and color specifications must be in the format accepted by the <link
-linkend="function-gdk--color-parse"><function>gtk.gdk.color_parse</function>()</link>
-function. Note that due to the way the color tables from different sources
-are merged, color specifications will be converted to hexadecimal form when
-getting this property. Default value: ''. This property is available in
-GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-cursor-blink"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the cursor should
-blink. Default value: <literal>True</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-cursor-blink-time"</entry>
- <entry>Read-Write</entry>
- <entry>The length of the cursor blink cycle, in
-milliseconds. Allowed values: >= 100. Default value: 1200</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-cursor-theme-name"</entry>
- <entry>Read-Write</entry>
- <entry>Name of the cursor theme to use, or
- <literal>None</literal> to use the default theme. Default
- value: <literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-cursor-theme-size"</entry>
- <entry>Read-Write</entry>
- <entry>Size to use for cursors, or 0 to use the default
- size. Allowed values: [0,128]. Default value: 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-dnd-drag-threshold"</entry>
- <entry>Read-Write</entry>
- <entry>The number of pixels the cursor can move before
-dragging starts. Allowed values: >= 1. Default value: 8</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-double-click-distance"</entry>
- <entry>Read-Write</entry>
- <entry>The maximum distance allowed between two clicks for
-them to be considered a double click (in pixels). Available in GTK+ 2.4
-and above. Allowed values: >= 0. Default value: 5</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-double-click-time"</entry>
- <entry>Read-Write</entry>
- <entry>The maximum time allowed between two clicks for them to
-be considered a double click (in milliseconds). Allowed values: >= 0.
-Default value: 250</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-enable-animations"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> enable toolkit-wide
- animations. Default value: <literal>True</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-entry-password-hint-timeout"</entry>
- <entry>Read-Write</entry>
- <entry>How long to show the last input character in hidden
- entries. This value is in milliseconds. 0 disables showing the
- last char. 600 is a good value for enabling it. Default value:
- 0. This property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-entry-select-on-focus"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, select the contents of an
-entry when it is focused. Default value: <literal>True</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-fallback-icon-theme"</entry>
- <entry>Read-Write</entry>
- <entry>Name of a icon theme to fall back to. Default value:
- <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-font-name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the default font to use.
-Default value: "Sans 10"</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-icon-sizes"</entry>
- <entry>Read-Write</entry>
- <entry>The list of icon sizes
-(gtk-menu=16,16;gtk-button=20,20...).
-Default value: <literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-icon-theme-name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the icon theme to use. Available in
-GTK+ 2.4 and above. Default value: "hicolor"</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-key-theme-name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the key theme RC file to load.
-Default value: <literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-label-select-on-focus"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> select the contents of a
- selectable label when it is focused. Default value:
- <literal>True</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-menu-bar-accel"</entry>
- <entry>Read-Write</entry>
- <entry>The keybinding to activate the menu bar. Default
- value: "F10"</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-menu-bar-popup-delay"</entry>
- <entry>Read-Write</entry>
- <entry>The delay before the submenus of a menu bar appear.
- Allowed values: >= 0. Default value: 0 Available in GTK+ 2.2
- and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-menu-images"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> images should be shown in
- menus. Default value: <literal>True</literal>. Available in
- GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-menu-popdown-delay"</entry>
- <entry>Read-Write</entry>
- <entry>The time before hiding a submenu when the pointer is
- moving toward the submenu. Allowed values: >= 0. Default
- value: 1000. Available in GTK+ 2.2 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-menu-popup-delay"</entry>
- <entry>Read-Write</entry>
- <entry>Minimum time the pointer must stay over a menu item
- before the submenu appears. Allowed values: >= 0. Default
- value: 225. Available in GTK+ 2.2 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-modules"</entry>
- <entry>Read-Write</entry>
- <entry>The list of currently active GTK modules. Default
- value: <literal>None</literal>. Available in GTK+ 2.6 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-scrolled-window-placement"</entry>
- <entry>Read-Write</entry>
- <entry>Where the contents of scrolled windows are located with
- respect to the scrollbars, if not overridden by the scrolled
- window's own placement. Default value:
- <literal>gtk.CORNER_TOP_LEFT</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-show-input-method-menu"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the context menus of entries
- and text views should offer to change the input
- method. Default value: <literal>True</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-show-unicode-menu"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the context menus of entries
- and text views should offer to insert control
- characters. Default value: <literal>True</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-split-cursor"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, two cursors should be
- displayed for mixed left-to-right and right-to-left text.
- Default value: <literal>True</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-theme-name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the theme RC file to load. Default value:
- "Raleigh"</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-timeout-expand"</entry>
- <entry>Read-Write</entry>
- <entry>Expand value for timeouts, when a widget is expanding a
- new region. Allowed values: >= 0. Default value: 500.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-timeout-initial"</entry>
- <entry>Read-Write</entry>
- <entry>Starting value for timeouts, when button is
- pressed. Allowed values: >= 0. Default value: 200.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-timeout-repeat"</entry>
- <entry>Read-Write</entry>
- <entry>Repeat value for timeouts, when button is
- pressed. Allowed values: >= 0. Default value: 20.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-toolbar-icon-size"</entry>
- <entry>Read-Write</entry>
- <entry>the toolbar icon size - one of:
- <literal>gtk.ICON_SIZE_MENU</literal>,
- <literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal>,
- <literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>,
- <literal>gtk.ICON_SIZE_BUTTON</literal>,
- <literal>gtk.ICON_SIZE_DND</literal> or
- <literal>gtk.ICON_SIZE_DIALOG</literal>. Default value:
- <literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-toolbar-style"</entry>
- <entry>Read-Write</entry>
- <entry>The toolbar display style - one of:
- <literal>gtk.TOOLBAR_ICONS</literal>,
- <literal>gtk.TOOLBAR_TEXT</literal>,
- <literal>gtk.TOOLBAR_BOTH</literal> or
- <literal>gtk.TOOLBAR_BOTH_HORIZ</literal>. Default value:
- <literal>gtk.TOOLBAR_BOTH</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-touchscreen-mode"</entry>
- <entry>Read-Write</entry>
- <entry>When True, there are no motion notify events delivered
- on this screen, and widgets can't use the pointer hovering
- them for any essential functionality. Default value:
- <literal>False</literal>. This property is available in GTK+
- 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-xft-antialias"</entry>
- <entry>Read-Write</entry>
- <entry>Whether to antialias Xft fonts; 0=no, 1=yes,
- -1=default. Default value: -1. Available in GTK+ 2.4 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-xft-dpi"</entry>
- <entry>Read-Write</entry>
- <entry>Resolution for Xft, in 1024 * dots/inch. -1 to use
- default value. Allowed values: [-1,1048576]. Default value:
- -1. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-xft-hinting"</entry>
- <entry>Read-Write</entry>
- <entry>Whether to hint Xft fonts; 0=no, 1=yes, -1=default.
- Default value: -1. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-xft-hintstyle"</entry>
- <entry>Read-Write</entry>
- <entry>What degree of hinting to use; none, slight, medium, or
- full. Default value: <literal>None</literal>. Available in
- GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gtk-xft-rgba"</entry>
- <entry>Read-Write</entry>
- <entry>Type of subpixel antialiasing; none, rgb, bgr, vrgb,
- vbgr. Default value: <literal>None</literal>. Available in
- GTK+ 2.4 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object stores the values of the global settings associated with a <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>. The
-<link linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object for the default <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> can
-be retrieved using the <link
-linkend="function-gtk--settings-get-default"><function>gtk.settings_get_default</function>()</link>
-function. The <link
-linkend="method-gtkwidget--get-settings"><methodname>gtk.Widget.get_settings</methodname>()</link>
-method returns the <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object of the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> that
-the widget is displayed on.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtksettings- -install-property">
- <title>gtk.Settings.install_property</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>install_property</methodname>
- <methodparam><parameter role="keyword">pspec</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pspec</parameter>&nbsp;:</term>
- <listitem><simpara>a GParamSpec*</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gtksettings- -install-property-parser">
- <title>gtk.Settings.install_property_parser</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>install_property_parser</methodname>
- <methodparam><parameter role="keyword">pspec</parameter></methodparam>
- <methodparam><parameter role="keyword">parser</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pspec</parameter>&nbsp;:</term>
- <listitem><simpara>a GParamSpec*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">parser</parameter>&nbsp;:</term>
- <listitem><simpara>a GtkRcPropertyParser</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
-
- <refsect2 id="method-gtksettings- -set-property-value">
- <title>gtk.Settings.set_property_value</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>set_property_value</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">svalue</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a const-gchar*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">svalue</parameter>&nbsp;:</term>
- <listitem><simpara>a const-GtkSettingsValue*</simpara></listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-END NOTIMPLEMENTED -->
-
- <refsect2 id="method-gtksettings--set-string-property">
- <title>gtk.Settings.set_string_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_string_property</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">v_string</parameter></methodparam>
- <methodparam><parameter
- role="keyword">origin</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the property to
-set</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">v_string</parameter>&nbsp;:</term>
- <listitem><simpara>the string value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">origin</parameter>&nbsp;:</term>
- <listitem><simpara>the string value of the
-origin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_string_property</methodname>() method sets
-the property named <parameter>name</parameter> to the string value specified
-by <parameter>v_string</parameter> at the string origin specified by
-<parameter>origin</parameter>. <parameter>origin</parameter> is an
-application specified string like "filename:linenumber" or
-"myapp:widgetname".</para>
-
- </refsect2>
-
- <refsect2 id="method-gtksettings--set-long-property">
- <title>gtk.Settings.set_long_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_long_property</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">v_long</parameter></methodparam>
- <methodparam><parameter
- role="keyword">origin</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the property to
-set</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">v_long</parameter>&nbsp;:</term>
- <listitem><simpara>the long value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">origin</parameter>&nbsp;:</term>
- <listitem><simpara>the string value of the
-origin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_long_property</methodname>() method sets the
-property named <parameter>name</parameter> to the long value specified by
-<parameter>v_long</parameter> at the string origin specified by
-<parameter>origin</parameter>. <parameter>origin</parameter> is an
-application specified string like "filename:linenumber" or
-"myapp:widgetname".</para>
-
- </refsect2>
-
- <refsect2 id="method-gtksettings--set-double-property">
- <title>gtk.Settings.set_double_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_double_property</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">v_double</parameter></methodparam>
- <methodparam><parameter
- role="keyword">origin</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the property to
-set</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">v_double</parameter>&nbsp;:</term>
- <listitem><simpara>the double value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">origin</parameter>&nbsp;:</term>
- <listitem><simpara>the string value of the
-origin</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_double_property</methodname>() method sets
-the property named <parameter>name</parameter> to the double value specified
-by <parameter>v_long</parameter> at the string origin specified by
-<parameter>origin</parameter>. <parameter>origin</parameter> is an
-application specified string like "filename:linenumber" or
-"myapp:widgetname".</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--settings-get-default">
- <title>gtk.settings_get_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.settings_get_default</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the singleton <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.settings_get_default</function> function
-returns the singleton <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--settings-get-for-screen">
- <title>gtk.settings_get_for_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.settings_get_for_screen</methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
- object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
- object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <function>gtk.settings_get_for_screen</function>() function
-returns the singleton <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object for the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-specified by <parameter>screen</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtksizegroup.xml b/docs/reference/pygtk-gtksizegroup.xml
deleted file mode 100644
index 73ae329f..00000000
--- a/docs/reference/pygtk-gtksizegroup.xml
+++ /dev/null
@@ -1,349 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtksizegroup">
- <refnamediv>
- <refname>gtk.SizeGroup</refname>
- <refpurpose>an object that groups widgets so they request the same
-size</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.SizeGroup</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtksizegroup">gtk.SizeGroup</link></methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtksizegroup--set-mode">set_mode</link></methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtksizegroup--get-mode">get_mode</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtksizegroup--set-ignore-hidden">set_ignore_hidden</link></methodname>
- <methodparam><parameter
- role="keyword">ignore_hidden</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtksizegroup--get-ignore-hidden">get_ignore_hidden</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtksizegroup--add-widget">add_widget</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtksizegroup--remove-widget">remove_widget</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtksizegroup">gtk.SizeGroup</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtksizegroup">
- <title>gtk.SizeGroup Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"ignore-hidden"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, hidden widgets are ignored
-when determining the size of the group.
-Default value: <literal>False</literal>.
-Available in GTK+ 2.8 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"mode"</entry>
- <entry>Read-Write</entry>
- <entry>The directions in which the size group effects the
-requested sizes of its component widgets - one of the <xref
-linkend="gtk-sizegroup-mode-constants"
-endterm="gtk-sizegroup-mode-constants-title"></xref>.
-Default value: <literal>gtk.SIZE_GROUP_HORIZONTAL</literal>.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtksizegroup">
- <title>gtk.SizeGroup Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
-linkend="class-gtksizegroup"><classname>gtk.SizeGroup</classname></link>
-provides a mechanism for grouping a number of widgets together so they all
-request the same amount of space. This is typically useful when you want a
-column of widgets to have the same size, but you can't use a <link
-linkend="class-gtktable"><classname>gtk.Table</classname></link> widget. The
-size requested for each widget in a <link
-linkend="class-gtksizegroup"><classname>gtk.SizeGroup</classname></link> is
-the maximum of the sizes that would have been requested for each widget in
-the size group if they were not in the size group. The mode of the size
-group (see <link
-linkend="method-gtksizegroup--set-mode"><methodname>set_mode</methodname>()</link>
-and the <xref linkend="gtk-sizegroup-mode-constants"
-endterm="gtk-sizegroup-mode-constants-title"></xref>) determines whether
-this applies to the horizontal size, the vertical size, or both
-sizes:</para>
-
- <para>Note that size groups only affect the amount of space requested,
-not the size that the widgets finally receive. If you want the widgets in a
-<link
-linkend="class-gtksizegroup"><classname>gtk.SizeGroup</classname></link> to
-actually be the same size, you need to pack them in such a way that they get
-the size they request and not more. For example, if you are packing your
-widgets into a table, you would not include the <literal>gtk.FILL</literal>
-flag. <link
-linkend="class-gtksizegroup"><classname>gtk.SizeGroup</classname></link>
-objects are referenced by each widget in the size group, so once you have
-added all widgets to a <link
-linkend="class-gtksizegroup"><classname>gtk.SizeGroup</classname></link>. If
-the widgets in the size group are subsequently destroyed, then they will be
-removed from the size group and drop their references on the size group;
-when all widgets have been removed, the size group will be freed.</para>
-
- <para>Widgets can be part of multiple size groups; PyGTK will compute
-the horizontal size of a widget from the horizontal requisition of all
-widgets that can be reached from the widget by a chain of size groups of
-type <literal>gtk.SIZE_GROUP_HORIZONTAL</literal> or
-<literal>gtk.SIZE_GROUP_BOTH</literal>, and the vertical size from the
-vertical requisition of all widgets that can be reached from the widget by a
-chain of size groups of type <literal>gtk.SIZE_GROUP_VERTICAL</literal> or
-<literal>gtk.SIZE_GROUP_BOTH</literal>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtksizegroup">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.SizeGroup</methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mode</parameter>&nbsp;:</term>
- <listitem><simpara>the mode for the new size
-group.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtksizegroup"><classname>gtk.SizeGroup</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtksizegroup"><classname>gtk.SizeGroup</classname></link>
-with the mode specified by the value of <parameter>mode</parameter> which is
-one of the <xref linkend="gtk-sizegroup-mode-constants"
-endterm="gtk-sizegroup-mode-constants-title"></xref>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtksizegroup--set-mode">
- <title>gtk.SizeGroup.set_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_mode</methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mode</parameter>&nbsp;:</term>
- <listitem><simpara>the mode to set for the size
-group.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_mode</methodname>() method sets the "mode"
-property of the size group to the value specified by
-<parameter>mode</parameter>. The "mode" of the size group determines whether
-the widgets in the size group should all have the same horizontal
-requisition (see the <xref linkend="gtk-sizegroup-mode-constants"
-endterm="gtk-sizegroup-mode-constants-title"></xref>).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtksizegroup--get-mode">
- <title>gtk.SizeGroup.get_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_mode</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current mode of the size
-group.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_mode</methodname>() method returns the value
-of the "mode" property of the size group. See the <link
-linkend="method-gtksizegroup--set-mode"><methodname>set_mode</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtksizegroup--set-ignore-hidden">
- <title>gtk.SizeGroup.set_ignore_hidden</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_ignore_hidden</methodname>
- <methodparam><parameter
- role="keyword">ignore_hidden</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">ignore_hidden</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> hidden widgets should
-be ignored when calculating the size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_ignore_hidden</methodname>() method sets the
-"ignore-hidden" property to the value of
-<parameter>ignore_hidden</parameter>. If
-<parameter>ignore_hidden</parameter> is <literal>True</literal> invisible
-widgets will be ignored when calculating size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtksizegroup--get-ignore-hidden">
- <title>gtk.SizeGroup.get_ignore_hidden</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_ignore_hidden</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if hidden widgets are
-ignored in size calculations.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_ignore_hidden</methodname>() method returns
-the value of the "ignore-hidden" property of the size group. If
-"ignore-hidden" is <literal>True</literal>, invisible widgets are ignored in
-size calculations.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtksizegroup--add-widget">
- <title>gtk.SizeGroup.add_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_widget</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to
-add</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_widget</methodname>() method adds the widget
-specified by <parameter>widget</parameter> to the <link
-linkend="class-gtksizegroup"><classname>gtk.SizeGroup</classname></link>.
-The requisition of the widget will then be determined as the maximum of its
-requisition and the requisition of the other widgets in the size group.
-Whether this applies horizontally, vertically, or in both directions depends
-on the mode of the size group. See the <link
-linkend="method-gtksizegroup--set-mode"><methodname>set_mode</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtksizegroup--remove-widget">
- <title>gtk.SizeGroup.remove_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_widget</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to
-remove</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The remove_widget() method removes the widget specified by
-widget from the <link
-linkend="class-gtksizegroup"><classname>gtk.SizeGroup</classname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtksocket.xml b/docs/reference/pygtk-gtksocket.xml
deleted file mode 100644
index e0edfe28..00000000
--- a/docs/reference/pygtk-gtksocket.xml
+++ /dev/null
@@ -1,316 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtksocket">
- <refnamediv>
- <refname>gtk.Socket</refname>
- <refpurpose>a container for widgets from other processes.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Socket</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtksocket">gtk.Socket</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtksocket--add-id">add_id</link></methodname>
- <methodparam><parameter
- role="keyword">window_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtksocket--get-id">get_id</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtksocket">gtk.Socket</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtksocket">
- <title>gtk.Socket Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtksocket">
- <title>gtk.Socket Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtksocket">
- <title>gtk.Socket Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtksocket--plug-added">plug-added</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>socket</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtksocket--plug-removed">plug-removed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>socket</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>Together with a <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link>, a <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link> provides
-the ability to embed widgets from one process into another process in a
-fashion that is transparent to the user. One process creates a <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link> widget
-and, passes the that widget's window ID to the other process, which then
-creates a <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> with that
-window ID. Any widgets contained in the <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> then will
-appear inside the first applications window. The socket's window ID is
-obtained by using the <link
-linkend="method-gtksocket--get-id"><methodname>get_id</methodname>()</link>
-method. Before using this function, the socket must have been realized, and
-added to its parent.</para>
-
- <para>When PyGTK is notified that the embedded window has been
-destroyed, then it will destroy the socket as well. You should always,
-therefore, be prepared for your sockets to be destroyed at any time when the
-main event loop is running. The communication between a <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link> and a
-<link linkend="class-gtkplug"><classname>gtk.Plug</classname></link> follows
-the XEmbed protocol.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtksocket">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Socket</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtksocket--add-id">
- <title>gtk.Socket.add_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_id</methodname>
- <methodparam><parameter
- role="keyword">window_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">window_id</parameter>&nbsp;:</term>
- <listitem><simpara>the window ID of a client participating in the
-XEMBED protocol.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_id</methodname>() method adds an XEMBED
-client specified by <parameter>window_id</parameter>, such as a <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link>, to the <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link>. The
-client may be in the same process or in a different process.</para>
- <para>
-To embed a <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> in a <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link>, you can
-either:</para>
-
- <itemizedlist>
- <listitem>
- <para>create the <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> by calling
-<link linkend="constructor-gtkplug">gtk.Plug</link>(), then call <link
-linkend="method-gtkplug--get-id"><methodname>gtk.Plug.get_id</methodname>()</link>
-to get the window ID of the plug, and finally pass that to the <link
-linkend="method-gtksocket--add-id"><function>gtk.Socket.add_id()</function></link>;
-or,</para>
- </listitem>
- <listitem>
- <para>call the <link
-linkend="method-gtksocket--get-id"><function>gtk.Socket.get_id()</function></link>
-method to get the window ID for the socket, then create the <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> by calling
-<link linkend="constructor-gtkplug">gtk.Plug</link>() passing in that ID.
-The <link linkend="class-gtksocket"><classname>gtk.Socket</classname></link>
-must have already be added into a toplevel window before you can make this
-call.</para>
- </listitem>
- </itemizedlist>
-
- </refsect2>
-
- <refsect2 id="method-gtksocket--get-id">
- <title>gtk.Socket.get_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_id</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the window ID for the
-socket</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_id</methodname>() method gets the window ID
-of a <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link> widget,
-which can then be used to create a client embedded inside the socket, for
-instance with <link linkend="constructor-gtkplug">gtk.Plug</link>(). The
-<link linkend="class-gtksocket"><classname>gtk.Socket</classname></link>
-must have already be added into a toplevel window before you can make this
-call.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtksocket--plug-added">
- <title>The "plug-added" gtk.Socket Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>socket</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>socket</parameter>&nbsp;:</term>
- <listitem><simpara>the socket that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "plug-added" signal is emitted when a plug is added to the
-socket.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtksocket--plug-removed">
- <title>The "plug-removed" gtk.Socket Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>socket</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>socket</parameter>&nbsp;:</term>
- <listitem><simpara>the socket that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the <link
- linkend="class-gtksocket"><classname>gtk.Socket</classname></link>
- should not be destroyed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "plug-removed" signal is emitted when a plug is removed from
-the socket. The default action is to destroy the <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link> widget,
-so if you want to reuse it you must add a signal handler that returns
-<literal>True</literal>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkspinbutton.xml b/docs/reference/pygtk-gtkspinbutton.xml
deleted file mode 100644
index 79de7526..00000000
--- a/docs/reference/pygtk-gtkspinbutton.xml
+++ /dev/null
@@ -1,1250 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkspinbutton">
- <refnamediv>
- <refname>gtk.SpinButton</refname>
- <refpurpose>retrieve an integer or floating-point number from the
-user.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.SpinButton</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkentry">gtk.Entry</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkspinbutton">gtk.SpinButton</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">climb_rate</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">digits</parameter><initializer>0</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--configure">configure</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- <methodparam><parameter
- role="keyword">climb_rate</parameter></methodparam>
- <methodparam><parameter
- role="keyword">digits</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--set-adjustment">set_adjustment</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--get-adjustment">get_adjustment</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--set-digits">set_digits</link></methodname>
- <methodparam><parameter
- role="keyword">digits</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--get-digits">get_digits</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--set-increments">set_increments</link></methodname>
- <methodparam><parameter
- role="keyword">step</parameter></methodparam>
- <methodparam><parameter
- role="keyword">page</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--get-increments">get_increments</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--set-range">set_range</link></methodname>
- <methodparam><parameter role="keyword">min</parameter></methodparam>
- <methodparam><parameter role="keyword">max</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--get-range">get_range</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--get-value">get_value</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--get-value-as-int">get_value_as_int</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--set-value">set_value</link></methodname>
- <methodparam><parameter
- role="keyword">value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--set-update-policy">set_update_policy</link></methodname>
- <methodparam><parameter
- role="keyword">policy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--get-update-policy">get_update_policy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--set-numeric">set_numeric</link></methodname>
- <methodparam><parameter
- role="keyword">numeric</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--get-numeric">get_numeric</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--spin">spin</link></methodname>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- <methodparam><parameter
- role="keyword">increment</parameter><initializer>1.0</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--set-wrap">set_wrap</link></methodname>
- <methodparam><parameter
- role="keyword">wrap</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--get-wrap">get_wrap</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--set-snap-to-ticks">set_snap_to_ticks</link></methodname>
- <methodparam><parameter
- role="keyword">snap_to_ticks</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--get-snap-to-ticks">get_snap_to_ticks</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkspinbutton--update">update</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkentry">gtk.Entry</link> (implements <link linkend="class-gtkeditable">gtk.Editable</link>, <link linkend="class-gtkcelleditable">gtk.CellEditable</link>)
- +-- <link linkend="class-gtkspinbutton">gtk.SpinButton</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkspinbutton">
- <title>gtk.SpinButton Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkentry">gtk.Entry Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"adjustment"</entry>
- <entry>Read-Write</entry>
- <entry>The adjustment that holds the value of the
-spinbutton</entry>
- </row>
-
- <row valign="top">
- <entry>"climb-rate"</entry>
- <entry>Read-Write</entry>
- <entry>The acceleration rate when you hold down a
-button</entry>
- </row>
-
- <row valign="top">
- <entry>"digits"</entry>
- <entry>Read-Write</entry>
- <entry>The number of decimal places to display</entry>
- </row>
-
- <row valign="top">
- <entry>"numeric"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, non-numeric characters
-should be ignored</entry>
- </row>
-
- <row valign="top">
- <entry>"snap-to-ticks"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, erroneous values are
-automatically changed to a spin button's nearest step increment</entry>
- </row>
-
- <row valign="top">
- <entry>"update-policy"</entry>
- <entry>Read-Write</entry>
- <entry>either <literal>gtk.UPDATE_ALWAYS</literal> (the spin
-button should update always), or <literal>gtk.UPDATE_IF_VALID</literal> the
-spin button should update only when the value is legal)</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read-Write</entry>
- <entry>the current value</entry>
- </row>
-
- <row valign="top">
- <entry>"wrap"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, a spin button should wrap
-upon reaching its limits</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkspinbutton">
- <title>gtk.SpinButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkentry">gtk.Entry Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"shadow-type"</entry>
- <entry>Read</entry>
- <entry>the shadow type of the spinbutton - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>
-or <literal>gtk.SHADOW_ETCHED_OUT</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkspinbutton">
- <title>gtk.SpinButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkentry">gtk.Entry Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkeditable">gtk.Editable Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcelleditable">gtk.CellEditable Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkspinbutton--change-value">change-value</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>spinbutton</parameter></methodparam>
- <methodparam><parameter>scrolltype</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkspinbutton--input">input</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>spinbutton</parameter></methodparam>
- <methodparam><parameter>value_ptr</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkspinbutton--output">output</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>spinbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkspinbutton--value-changed">value-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>spinbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkspinbutton--wrapped">wrapped</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>spinbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>
-is a subclass of <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> that
-provides a way for a user to set the value of some numeric attribute within
-a predefined range. Rather than having to directly type a number into a
-<link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>, a
-<link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>
-allows the user to click on one of two arrows to increment or decrement the
-displayed value. A value can still be typed in and validated. A <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>
-uses a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-to specify the range and value of interest. See the <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-section for more details about an adjustment's properties.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkspinbutton">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.SpinButton</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">climb_rate</parameter><initializer>0.0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">digits</parameter><initializer>0</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-or None to create a new adjustment</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">climb_rate</parameter>&nbsp;:</term>
- <listitem><simpara>the acceleration factor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">digits</parameter>&nbsp;:</term>
- <listitem><simpara>the number of decimal places to
-display</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkspinbutton"><classname>gtk.SpinButton</classname></link>
-widget using the <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-specified by <parameter>adjustment</parameter>, the acceleration factor
-specified by <parameter>climb_rate</parameter> and displaying the number of
-decimals specified by <parameter>digits</parameter>. If
-<parameter>adjustment</parameter> is <literal>None</literal> or is not
-specified a new <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-will be created. If <parameter>climb_rate</parameter> is not specified it
-defaults to 0.0. If <parameter>digits</parameter> is not specified it
-defaults to 0.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkspinbutton--configure">
- <title>gtk.SpinButton.configure</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>configure</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- <methodparam><parameter
- role="keyword">climb_rate</parameter></methodparam>
- <methodparam><parameter
- role="keyword">digits</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-or None to create a new adjustment</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">climb_rate</parameter>&nbsp;:</term>
- <listitem><simpara>the acceleration factor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">digits</parameter>&nbsp;:</term>
- <listitem><simpara>the number of decimal places to
-display</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>configure</methodname>() method changes the
-properties of an existing spin button by associating the <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-specified by <parameter>adjustment</parameter>, setting the acceleration
-rate to the c value specified by <parameter>climb_rate</parameter> and
-setting the number of decimal places to display to the value specified by
-<parameter>digits</parameter>. If <parameter>adjustment</parameter> is
-<literal>None</literal> a new <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-will be created. </para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--set-adjustment">
- <title>gtk.SpinButton.set_adjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_adjustment</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-to replace the existing adjustment</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_adjustment</methodname>() method sets the
-"adjustment" property to the value specified by
-<parameter>adjustment</parameter> replacing the current adjustment object
-associated with the spinbutton.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--get-adjustment">
- <title>gtk.SpinButton.get_adjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_adjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object associated with the spinbutton</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_adjustment</methodname>() method returns the
-value of the "adjustment" property.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--set-digits">
- <title>gtk.SpinButton.set_digits</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_digits</methodname>
- <methodparam><parameter
- role="keyword">digits</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">digits</parameter>&nbsp;:</term>
- <listitem><simpara>the number of decimal places to be displayed
-for the spin button's value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_digits</methodname>() method sets the
-"digits" property to the value specified by <parameter>digits</parameter>.
-The value of "digits" determines the number of decimal places (up to 20
-digits) to be displayed by the spinbutton.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--get-digits">
- <title>gtk.SpinButton.get_digits</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_digits</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current number of decimal places to be
-displayed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_digits</methodname>() method returns the
-value of the "digits" property. The value of "digits" determines the number
-of decimal places the spinbutton displays. See the <link
-linkend="method-gtkspinbutton--set-digits"><methodname>set_digits</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--set-increments">
- <title>gtk.SpinButton.set_increments</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_increments</methodname>
- <methodparam><parameter
- role="keyword">step</parameter></methodparam>
- <methodparam><parameter
- role="keyword">page</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">step</parameter>&nbsp;:</term>
- <listitem><simpara>increment applied for each
-<mousebutton>left</mousebutton> mousebutton press.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">page</parameter>&nbsp;:</term>
- <listitem><simpara>increment applied for each
-<mousebutton>middle</mousebutton> mousebutton press.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_increments</methodname>() method sets the
-<literal>step_increment</literal> and <literal>page_increment</literal>
-attributes of the <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-associated with the spinbutton to the values specified by
-<parameter>step</parameter> and <parameter>page</parameter> respectively.
-These affect how quickly the value changes when the spin button's arrows are
-activated.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--get-increments">
- <title>gtk.SpinButton.get_increments</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_increments</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the step and page
-increments</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_increments</methodname>() method returns a
-tuple containing the values of the <literal>step_increment</literal> and
-<literal>page_increment</literal> attributes of the <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-associated with the spinbutton. See the <link
-linkend="method-gtkspinbutton--set-increments"><methodname>set_increments</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--set-range">
- <title>gtk.SpinButton.set_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_range</methodname>
- <methodparam><parameter
- role="keyword">min</parameter></methodparam>
- <methodparam><parameter
- role="keyword">max</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">min</parameter>&nbsp;:</term>
- <listitem><simpara>the minimum allowable
-value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">max</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum allowable
-value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_range</methodname>() method sets the minimum
-and maximum allowable values for spinbutton by setting the
-<literal>lower</literal> and <literal>upper</literal> attributes of the
-associated <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-to the values of <parameter>min</parameter> and <parameter>max</parameter>
-respectively.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--get-range">
- <title>gtk.SpinButton.get_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_range</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the minimum and maximum
-allowed values</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_range</methodname>() method returns a tuple
-containing the range allowed for the spinbutton. See the <link
-linkend="method-gtkspinbutton--set-range"><methodname>set_range</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--get-value">
- <title>gtk.SpinButton.get_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_value</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the value of the
-spin_button</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_value</methodname>() method returns the
-value of the "value" property of the spinbutton (really the
-<literal>value</literal> attribute of the associated <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--get-value-as-int">
- <title>gtk.SpinButton.get_value_as_int</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_value_as_int</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the value of the spinbutton as an
-integer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_value_as_int</methodname>() method returns
-the value of the spinbutton represented as an integer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--set-value">
- <title>gtk.SpinButton.set_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_value</methodname>
- <methodparam><parameter
- role="keyword">value</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>the new value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_value</methodname>() method sets the value
-of the "value" property to the value specified by
-<parameter>value</parameter> (sets the <literal>value</literal> attribute of
-the associated <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--set-update-policy">
- <title>gtk.SpinButton.set_update_policy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_update_policy</methodname>
- <methodparam><parameter
- role="keyword">policy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">policy</parameter>&nbsp;:</term>
- <listitem><simpara>the new update policy</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_update_policy</methodname>() method sets the
-"update-policy" property to the value of <parameter>policy</parameter>. The
-value of <parameter>policy</parameter> is either of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.UPDATE_ALWAYS</literal></term>
- <listitem>
- <simpara>the value is always displayed.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UPDATE_IF_VALID</literal></term>
- <listitem>
- <simpara>the value is only displayed if it is valid within the
-bounds of the spinbutton's <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--get-update-policy">
- <title>gtk.SpinButton.get_update_policy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_update_policy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current update policy</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_update_policy</methodname>() method returns
-the value of the "update-policy" property that determines the update
-behavior of a spin button. See the <link
-linkend="method-gtkspinbutton--set-update-policy"><methodname>set_update_policy</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--set-numeric">
- <title>gtk.SpinButton.set_numeric</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_numeric</methodname>
- <methodparam><parameter
- role="keyword">numeric</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">numeric</parameter>&nbsp;:</term>
- <listitem><simpara>a flag indicating if only numeric entry is
-allowed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_numeric</methodname>() method sets the value
-of the "numeric" property to the value of <parameter>numeric</parameter>. If
-<parameter>numeric</parameter> is <literal>True</literal> only numeric text
-can be typed into the spin button.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--get-numeric">
- <title>gtk.SpinButton.get_numeric</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_numeric</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if only numeric text
-can be entered</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_numeric</methodname>() method returns the
-value of the "numeric" preoperty. See the <link
-linkend="method-gtkspinbutton--set-numeric"><methodname>set_numeric</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--spin">
- <title>gtk.SpinButton.spin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>spin</methodname>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- <methodparam><parameter
- role="keyword">increment</parameter><initializer>1.0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">direction</parameter>&nbsp;:</term>
- <listitem><simpara>the direction to spin.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">increment</parameter>&nbsp;:</term>
- <listitem><simpara>the step increment to apply in the specified
-direction.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>spin</methodname>() method increments or
-decrements a spin button's value in the direction specified by
-<parameter>direction</parameter> with a step size specified by
-<parameter>increment</parameter>. The value of
-<parameter>increment</parameter> is only used if direction is
-<literal>gtk.SPIN_USER_DEFINED</literal>. The value of
-<parameter>direction</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.SPIN_STEP_FORWARD</literal></term>
- <listitem>
- <simpara>forward by step_increment</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_STEP_BACKWARD</literal></term>
- <listitem>
- <simpara>backward by step_increment</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_PAGE_FORWARD</literal></term>
- <listitem>
- <simpara>forward by step_increment</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_PAGE_BACKWARD</literal></term>
- <listitem>
- <simpara>backward by step_increment</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_HOME</literal></term>
- <listitem>
- <simpara>move to minimum value</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_END</literal></term>
- <listitem>
- <simpara>move to maximum value</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SPIN_USER_DEFINED</literal></term>
- <listitem>
- <simpara>add <parameter>increment</parameter> to the
-value</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--set-wrap">
- <title>gtk.SpinButton.set_wrap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_wrap</methodname>
- <methodparam><parameter
- role="keyword">wrap</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">wrap</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> wrapping is
-performed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_wrap</methodname>() method sets the "wrap"
-property to the value of <parameter>wrap</parameter>. If
-<parameter>wrap</parameter> is <literal>True</literal> the spin button value
-wraps around to the opposite limit when the upper or lower limit of the
-range is exceeded.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--get-wrap">
- <title>gtk.SpinButton.get_wrap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_wrap</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the spin button
-wraps</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_wrap</methodname>() method returns the value
-of the "wrap" property. If the value of "wrap" is <literal>True</literal>
-the spinbutton's value wraps around to the opposite limit when the upper or
-lower limit of the range is exceeded. See the <link
-linkend="method-gtkspinbutton--set-wrap"><methodname>set_wrap</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--set-snap-to-ticks">
- <title>gtk.SpinButton.set_snap_to_ticks</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_snap_to_ticks</methodname>
- <methodparam><parameter
- role="keyword">snap_to_ticks</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">snap_to_ticks</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> invalid values
-should be corrected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_snap_to_ticks</methodname>() method sets the
-"snap-to-ticks" property to the value of
-<parameter>snap_to_ticks</parameter>. If
-<parameter>snap_to_ticks</parameter> is <literal>True</literal> values are
-corrected to the nearest step increment when a spin button is activated
-after providing an invalid value.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--get-snap-to-ticks">
- <title>gtk.SpinButton.get_snap_to_ticks</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_snap_to_ticks</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if values are snapped
-to the nearest step.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_snap_to_ticks</methodname>() method returns
-the value of the "snap-to-ticks" property. If the value of "snap-to-ticks"
-is <literal>True</literal> the input values are corrected to the nearest
-step. See the <link
-linkend="method-gtkspinbutton--set-snap-to-ticks"><methodname>set_snap_to_ticks</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkspinbutton--update">
- <title>gtk.SpinButton.update</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>update</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>update</methodname>() method manually forces an
-update of the spin button.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkspinbutton--change-value">
- <title>The "change-value" gtk.SpinButton Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>spinbutton</parameter></methodparam>
- <methodparam><parameter>scrolltype</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>spinbutton</parameter>&nbsp;:</term>
- <listitem><simpara>the spinbutton that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>scrolltype</parameter>&nbsp;:</term>
- <listitem><simpara>the scrolltype:
-<literal>gtk.SCROLL_STEP_UP</literal>,
-<literal>gtk.SCROLL_STEP_DOWN</literal>,
-<literal>gtk.SCROLL_PAGE_UP</literal>, <literal>gtk.SCROLL_PAGE_DOWN,
-<literal>gtk.SCROLL_START</literal> or
-<literal>gtk.SCROLL_END</literal></literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "change-value" signal is emitted when the spinbutton value is
-changed by keyboard action using the <keycombo><keycap>Up Arrow</keycap>
-</keycombo>, <keycombo><keycap>Down Arrow</keycap> </keycombo>,
-<keycombo><keycap>Page Up</keycap> </keycombo>, <keycombo><keycap>Page
-Down</keycap> </keycombo>, <keycombo
-action="simul"><keycap>Control</keycap><keycap>Page Up</keycap> </keycombo>
-or <keycombo action="simul"><keycap>Control</keycap><keycap>Page
-Down</keycap> </keycombo> keys.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkspinbutton--input">
- <title>The "input" gtk.SpinButton Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>spinbutton</parameter></methodparam>
- <methodparam><parameter>value_ptr</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>spinbutton</parameter>&nbsp;:</term>
- <listitem><simpara>the spinbutton that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value_ptr</parameter>&nbsp;:</term>
- <listitem><simpara>a pointer to the value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the input value was
- retrieved and handled; <literal>False</literal> if not handled and
- -1 if an error occurred during processing.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "input" signal is emitted when the value changes. The
-value_ptr is a GPointer to the value that cannot be accessed from PyGTK.
-This signal cannot be handled in PyGTK.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkspinbutton--output">
- <title>The "output" gtk.SpinButton Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>spinbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>spinbutton</parameter>&nbsp;:</term>
- <listitem><simpara>the spinbutton that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if no further
- processing is required.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "output" signal is emitted when the spinbutton display value
-is changed either by setting a new value or changing the digits and on
-realizing the widget. Returns <literal>True</literal> if the handler
-successfully set the text and no further processing is required.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkspinbutton--value-changed">
- <title>The "value-changed" gtk.SpinButton Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>spinbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>spinbutton</parameter>&nbsp;:</term>
- <listitem><simpara>the spinbutton that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "value-changed" signal is emitted when any of the settings (i.e. value, digits) that change the display of the spinbutton are changed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkspinbutton--wrapped">
- <title>The "wrapped" gtk.SpinButton Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>spinbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>spinbutton</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal
- the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "wrapped" signal is emitted right after the spinbutton wraps
- from its maximum to minimum value or vice-versa.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkstatusbar.xml b/docs/reference/pygtk-gtkstatusbar.xml
deleted file mode 100644
index a8d68129..00000000
--- a/docs/reference/pygtk-gtkstatusbar.xml
+++ /dev/null
@@ -1,506 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkstatusbar">
- <refmeta>
- <refentrytitle>gtk.Statusbar</refentrytitle>
- <manvolnum>3</manvolnum>
- <refmiscinfo>PyGTK Docs</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>gtk.Statusbar</refname>
- <refpurpose>report messages of minor importance to the user.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Statusbar</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkhbox">gtk.HBox</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkstatusbar">gtk.Statusbar</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstatusbar--get-context-id">get_context_id</link></methodname>
- <methodparam><parameter
- role="keyword">context_description</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstatusbar--push">push</link></methodname>
- <methodparam><parameter
- role="keyword">context_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstatusbar--pop">pop</link></methodname>
- <methodparam><parameter
- role="keyword">context_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstatusbar--remove">remove</link></methodname>
- <methodparam><parameter
- role="keyword">context_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">message_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstatusbar--set-has-resize-grip">set_has_resize_grip</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstatusbar--get-has-resize-grip">get_has_resize_grip</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkhbox">gtk.HBox</link>
- +-- <link linkend="class-gtkstatusbar">gtk.Statusbar</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkstatusbar">
- <title>gtk.Statusbar Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"has-resize-grip"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, the statusbar has a grip
- for resizing the toplevel window. Available in GTK+ 2.4 and
- above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkstatusbar">
- <title>gtk.Statusbar Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"shadow-type"</entry>
- <entry>Read</entry>
- <entry>The style of bevel around the statusbar text</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkstatusbar">
- <title>gtk.Statusbar Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkstatusbar">
- <title>gtk.Statusbar Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkstatusbar--text-popped">text-popped</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>statusbar</parameter></methodparam>
- <methodparam><parameter>context_id</parameter></methodparam>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkstatusbar--text-pushed">text-pushed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>statusbar</parameter></methodparam>
- <methodparam><parameter>context_id</parameter></methodparam>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link> is
-usually placed along the bottom of an application's main <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>. It may
-provide a regular commentary of the application's status (as is usually the
-case in a web browser, for example), or may be used to simply output a
-message when the status changes, (when an upload is complete in an
-<literal>FTP</literal> client, for example). It may also have a resize grip
-(a triangular area in the lower right corner) which can be clicked on to
-resize the window containing the statusbar. Status bars in PyGTK maintain a
-stack of messages. The message at the top of the each bar's stack is the one
-that will currently be displayed.</para>
-
- <para>Any messages added to a statusbar's stack must specify a
-<literal>context_id</literal> that is used to uniquely identify the source
-of a message. The <literal>context_id</literal> can be generated by the
-<link
-linkend="method-gtkstatusbar--get-context-id"><methodname>get_context_id</methodname>()</link>
-method, and associated with a context message. An existing context_id can be
-retrieved using the context message using the <link
-linkend="method-gtkstatusbar--get-context-id"><methodname>get_context_id</methodname>()</link>
-method. Note that messages are stored in a stack, and when choosing which
-message to display, the stack structure is adhered to, regardless of the
-context identifier of a message.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkstatusbar">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Statusbar</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkstatusbar--get-context-id">
- <title>gtk.Statusbar.get_context_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_context_id</methodname>
- <methodparam><parameter
- role="keyword">context_description</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">context_description</parameter>&nbsp;:</term>
- <listitem><simpara>a string identifying the context for the
-message</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer context
-identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_context_id</methodname>() method returns a
-new or existing context identifier, given a description of the actual
-context specified by <parameter>context_description</parameter>. In effect,
-<methodname>get_context_id</methodname>() both registers and retrieves a
-context identifier.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusbar--push">
- <title>gtk.Statusbar.push</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>push</methodname>
- <methodparam><parameter
- role="keyword">context_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">context_id</parameter>&nbsp;:</term>
- <listitem><simpara>a context identifier</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the message text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an integer message
-identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>push</methodname>() method pushes a new message
-specified by <parameter>text</parameter> with the specified
-<parameter>context_id</parameter> onto a statusbar's stack and returns a
-message id that that can be used with the <link
-linkend="method-gtkstatusbar--remove"><methodname>remove</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusbar--pop">
- <title>gtk.Statusbar.pop</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pop</methodname>
- <methodparam><parameter
- role="keyword">context_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">context_id</parameter>&nbsp;:</term>
- <listitem><simpara>a context identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>pop</methodname>() method removes the top
-message with the specified <parameter>context_id</parameter> from the
-statusbar's stack.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusbar--remove">
- <title>gtk.Statusbar.remove</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove</methodname>
- <methodparam><parameter
- role="keyword">context_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">message_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">context_id</parameter>&nbsp;:</term>
- <listitem><simpara>the context identifier</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">message_id</parameter>&nbsp;:</term>
- <listitem><simpara>the message identifier</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove</methodname>() method removes the message
-with the specified <parameter>message_id</parameter> and
-<parameter>context_id</parameter> from the statusbar's message stack.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusbar--set-has-resize-grip">
- <title>gtk.Statusbar.set_has_resize_grip</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_has_resize_grip</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> a resize grip is
-displayed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_has_resize_grip</methodname>() method sets
-the internal "has_resize_grip" property to the value specified by
-<parameter>setting</parameter>. If <parameter>setting</parameter> is
-<literal>True</literal> a resize grip is displayed on the statusbar</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusbar--get-has-resize-grip">
- <title>gtk.Statusbar.get_has_resize_grip</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_has_resize_grip</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a resize grip is
-displayed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_has_resize_grip</methodname>() method
-returns the value of the internal "has_resize_grip" property that determines
-if a resize grip is displayed on the statusbar.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkstatusbar--text-popped">
- <title>The "text-popped" gtk.Statusbar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>statusbar</parameter></methodparam>
- <methodparam><parameter>context_id</parameter></methodparam>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>statusbar</parameter>&nbsp;:</term>
- <listitem><simpara>the statusbar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>context_id</parameter>&nbsp;:</term>
- <listitem><simpara>the context identifier of the top
-message</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>the string containing the top message
-text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "text-popped" signal is emitted when a message is removed
-from the statusbar message stack. Note the text and context_id are for the
-top message on the statusbar stack not the message that was actually
-removed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkstatusbar--text-pushed">
- <title>The "text-pushed" gtk.Statusbar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>statusbar</parameter></methodparam>
- <methodparam><parameter>context_id</parameter></methodparam>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>statusbar</parameter>&nbsp;:</term>
- <listitem><simpara>the statusbar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>context_id</parameter>&nbsp;:</term>
- <listitem><simpara>the context identifier of the message
-added</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>the string containing the message
-text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "text-pushed" signal is emitted when a message is added to
-the statusbar message stack.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkstatusicon.xml b/docs/reference/pygtk-gtkstatusicon.xml
deleted file mode 100644
index 0b32318a..00000000
--- a/docs/reference/pygtk-gtkstatusicon.xml
+++ /dev/null
@@ -1,1065 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkstatusicon">
-
- <refnamediv>
- <refname>gtk.StatusIcon</refname>
- <refpurpose>display an icon in the system tray (new in PyGTK
- 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.StatusIcon</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkstatusicon">gtk.StatusIcon</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--set-from-pixbuf">set_from_pixbuf</link></methodname>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--set-from-file">set_from_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--set-from-stock">set_from_stock</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--set-from-icon-name">set_from_icon_name</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--get-storage-type">get_storage_type</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--get-pixbuf">get_pixbuf</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--get-stock">get_stock</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--get-icon-name">get_icon_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--get-size">get_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--set-tooltip">set_tooltip</link></methodname>
- <methodparam><parameter role="keyword">tooltip_text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--set-visible">set_visible</link></methodname>
- <methodparam><parameter role="keyword">visible</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--get-visible">get_visible</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--set-blinking">set_blinking</link></methodname>
- <methodparam><parameter role="keyword">blinking</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--get-blinking">get_blinking</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--is-embedded">is_embedded</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--get-geometry">get_geometry</link></methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- <methodparam><parameter role="keyword">area</parameter></methodparam>
- <methodparam><parameter role="keyword">orientation</parameter></methodparam>
- </methodsynopsis>
-</classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--status-icon-new-from-pixbuf">gtk.status_icon_new_from_pixbuf</link></methodname>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--status-icon-new-from-file">gtk.status_icon_new_from_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--status-icon-new-from-stock">gtk.status_icon_new_from_stock</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--status-icon-new-from-icon-name">gtk.status_icon_new_from_icon_name</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--status-icon-position-menu">gtk.status_icon_position_menu</link></methodname>
- <methodparam><parameter>menu</parameter></methodparam>
- <methodparam><parameter>statusicon</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkstatusicon">gtk.StatusIcon</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkstatusicon">
- <title>gtk.StatusIcon Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"blinking"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>True</literal> the status icon is
- blinking. Default value: <literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"file"</entry>
- <entry>Write</entry>
- <entry>Filename to load and display. Default value:
- <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"icon-name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the icon from the icon theme. Default value:
- <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"pixbuf"</entry>
- <entry>Read-Write</entry>
- <entry>A <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
- to display.</entry>
- </row>
-
- <row valign="top">
- <entry>"size"</entry>
- <entry>Read</entry>
- <entry>The size of the icon. Default value: 0.</entry>
- </row>
-
- <row valign="top">
- <entry>"stock"</entry>
- <entry>Read-Write</entry>
- <entry>Stock ID for a stock image to display. Default value:
- <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"storage-type"</entry>
- <entry>Read</entry>
- <entry>The representation being used for image data. Default
- value: <literal>gtk.IMAGE_EMPTY</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"visible"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the status icon is
- visible. Default value: <literal>True</literal>.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkstatusicon">
- <title>gtk.StatusIcon Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkstatusicon--activate">activate</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>status_icon</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkstatusicon--popup-menu">popup-menu</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>status_icon</parameter></methodparam>
- <methodparam><parameter>button</parameter></methodparam>
- <methodparam><parameter>activate_time</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkstatusicon--size-changed">size-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>status_icon</parameter></methodparam>
- <methodparam><parameter>size</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The "system tray" or notification area is normally used for
- transient icons that indicate some special state. For example, a system
- tray icon might appear to tell the user that they have new mail, or have
- an incoming instant message, or something along those lines. The basic
- idea is that creating an icon in the notification area is less annoying
- than popping up a dialog.</para>
-
- <para>A <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link>
- object can be used to display an icon in a "system tray". The icon can
- have a tooltip, and the user can interact with it by activating it or
- popping up a context menu. Critical information should not solely be
- displayed in a <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link>,
- since it may not be visible (e.g. when the user doesn't have a
- notification area on his panel). This can be checked with the <link
- linkend="method-gtkstatusicon--is-embedded"><methodname>gtk.StatusIcon.is_embedded()</methodname></link>
- method.</para>
-
- <para>On X11, the implementation follows the freedesktop.org "System
- Tray" <ulink
- url="http://www.freedesktop.org/wiki/Standards/systemtray-spec">specification</ulink>.
- Implementations of the "tray" side of this specification can be found
- e.g. in the GNOME and KDE panel applications.</para>
-
- <para>Note that a <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link>
- is <emphasis>not</emphasis> a widget, but just a <link
- linkend="class-gobject"><classname>gobject.GObject</classname></link>.
- Making it a widget would be impractical, since the system tray on Win32
- doesn't allow to embed arbitrary widgets.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtkstatusicon">
- <title>gtk.StatusIcon</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.StatusIcon</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Creates an empty status icon object.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkstatusicon--set-from-pixbuf">
- <title>gtk.StatusIcon.set_from_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_pixbuf</methodname>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
- or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Makes <parameter>status_icon</parameter> display
- <parameter>pixbuf</parameter>. See the <link
- linkend="function-gtk--status-icon-new-from-pixbuf"><function>gtk.status_icon_new_from_pixbuf</function>()</link>
- function for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--set-from-file">
- <title>gtk.StatusIcon.set_from_file</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_file</methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>a filename</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Makes <parameter>status_icon</parameter> display the file
- <parameter>filename</parameter>. See the <link
- linkend="function-gtk--status-icon-new-from-file"><function>gtk.status_icon_new_from_file</function>()</link>
- function for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--set-from-stock">
- <title>gtk.StatusIcon.set_from_stock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_stock</methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>a stock icon id</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Makes <parameter>status_icon</parameter> display the stock icon
- with the id <parameter>stock_id</parameter>. See the <link
- linkend="function-gtk--status-icon-new-from-stock"><function>gtk.status_icon_new_from_stock</function>()</link>
- function for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--set-from-icon-name">
- <title>gtk.StatusIcon.set_from_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_from_icon_name</methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>an icon name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Makes <parameter>status_icon</parameter> display the icon named
- <parameter>icon_name</parameter> from the current icon theme. See the
- <link
- linkend="function-gtk--status-icon-new-from-icon-name"><function>gtk.status_icon_new_from_icon_name</function>()</link>
- function for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--get-storage-type">
- <title>gtk.StatusIcon.get_storage_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_storage_type</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the image representation being used - one of
- the <xref linkend="gtk-image-type-constants"
- endterm="gtk-image-type-constants-title"></xref>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets the type of representation being used by the <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link>
- to store image data. If the <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link>
- has no image data, the return value will be
- <literal>gtk.IMAGE_EMPTY</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--get-pixbuf">
- <title>gtk.StatusIcon.get_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixbuf</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the displayed pixbuf, or
- <literal>None</literal> if the image is
- empty.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets the <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
- being displayed by the <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link>.
- The storage type of the status icon must be
- <literal>gtk.IMAGE_EMPTY</literal> or
- <literal>gtk.IMAGE_PIXBUF</literal> (see the <link
- linkend="method-gtkstatusicon--get-storage-type"><methodname>gtk.StatusIcon.get_storage_type()</methodname></link>
- method).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--get-stock">
- <title>gtk.StatusIcon.get_stock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_stock</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>stock id of the displayed stock icon, or
- <literal>None</literal> if the image is
- empty.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets the id of the stock icon being displayed by the <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link>.
- The storage type of the status icon must be
- <literal>gtk.IMAGE_EMPTY</literal> or
- <literal>gtk.IMAGE_STOCK</literal> (see the <link
- linkend="method-gtkstatusicon--get-storage-type"><methodname>gtk.StatusIcon.get_storage_type()</methodname></link>
- method).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--get-icon-name">
- <title>gtk.StatusIcon.get_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>name of the displayed icon, or
- <literal>None</literal> if the image is
- empty.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets the name of the icon being displayed by the <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link>.
- The storage type of the status icon must be
- <literal>gtk.IMAGE_EMPTY</literal> or
- <literal>gtk.IMAGE_ICON_NAME</literal> (see the <link
- linkend="method-gtkstatusicon--get-storage-type"><methodname>gtk.StatusIcon.get_storage_type()</methodname></link>
- method).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--get-size">
- <title>gtk.StatusIcon.get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the size that is available for the
- image</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets the size in pixels that is available for the image. Stock
- icons and named icons adapt their size automatically if the size of
- the notification area changes. For other storage types, the
- "size-changed" signal can be used to react to size changes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--set-tooltip">
- <title>gtk.StatusIcon.set_tooltip</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tooltip</methodname>
- <methodparam><parameter role="keyword">tooltip_text</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tooltip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the tooltip of the status icon.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--set-visible">
- <title>gtk.StatusIcon.set_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible</methodname>
- <methodparam><parameter role="keyword">visible</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">visible</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> show the status
- icon, if <literal>False</literal> hide it</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Shows or hides a status icon.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--get-visible">
- <title>gtk.StatusIcon.get_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the status icon is
- visible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if the status icon is visible.
- Note that being visible does not guarantee that the user can actually
- see the icon, see also the <link
- linkend="method-gtkstatusicon--is-embedded"><methodname>gtk.StatusIcon.is_embedded()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--set-blinking">
- <title>gtk.StatusIcon.set_blinking</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_blinking</methodname>
- <methodparam><parameter role="keyword">blinking</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">blinking</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> turn blinking on, if
- <literal>False</literal> turn it off</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Makes the status icon start or stop blinking. Note that
- blinking user interface elements may be problematic for some users,
- and thus may be turned off, in which case this setting has no
- effect.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--get-blinking">
- <title>gtk.StatusIcon.get_blinking</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_blinking</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the icon is
- blinking</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if the icon is blinking, see the
- <link
- linkend="method-gtkstatusicon--set-blinking"><methodname>gtk.StatusIcon.set_blinking()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--is-embedded">
- <title>gtk.StatusIcon.is_embedded</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_embedded</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the status icon is
- embedded in a notification area.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if the status icon is embedded
- in a notification area.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstatusicon--get-geometry">
- <title>gtk.StatusIcon.get_geometry</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_geometry</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple (containing the screen, area occupied
- by the status icon and the panel orientation) or
- None.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns information in a 3-tuple about the location of the
- status icon on screen. The 3-tuple contains the <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>,
- the area occupied by the status icon as a <link
- linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
- and the orientation of the panel containing the statis icon - one of
- the <xref linkend="gtk-orientation-constants"
- endterm="gtk-orientation-constants-title"></xref>. This information
- can be used to e.g. position popups like notification bubbles. See
- the <link
- linkend="function-gtk--status-icon-position-menu"><function>gtk.status_icon_position_menu</function>()</link>
- function for a more convenient alternative for positioning
- menus.</para>
-
- <para>Note that some platforms do not provide this information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--status-icon-new-from-pixbuf">
- <title>gtk.status_icon_new_from_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.status_icon_new_from_pixbuf</methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a status icon displaying <parameter>pixbuf</parameter>.
- The image will be scaled down to fit in the available space in the
- notification area, if necessary.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--status-icon-new-from-file">
- <title>gtk.status_icon_new_from_file</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.status_icon_new_from_file</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a status icon displaying the image in the file specified
- by <parameter>filename</parameter>. The image will be scaled down to
- fit in the available space in the notification area, if
- necessary.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--status-icon-new-from-stock">
- <title>gtk.status_icon_new_from_stock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.status_icon_new_from_stock</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>a stock icon id</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a status icon displaying a stock icon. Sample stock icon
- names are <literal>gtk.STOCK_OPEN</literal>,
- <literal>gtk.STOCK_QUIT</literal>. You can register your own stock
- icon names, see the <link
- linkend="method-gtkiconfactory--add-default"><methodname>gtk.IconFactory.add_default</methodname>()</link>
- and <link
- linkend="method-gtkiconfactory--add"><methodname>gtk.IconFactory.add</methodname>()</link>
- methods.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--status-icon-new-from-icon-name">
- <title>gtk.status_icon_new_from_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.status_icon_new_from_icon_name</methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>an icon name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a status icon displaying an icon from the current icon
- theme. If the current icon theme is changed, the icon will be updated
- appropriately.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--status-icon-position-menu">
- <title>gtk.status_icon_position_menu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.status_icon_position_menu</methodname>
- <methodparam><parameter>menu</parameter></methodparam>
- <methodparam><parameter>statusicon</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>menu</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkmenu"><classname>gtk.Menu</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>statusicon</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple containing the x and y coordinates
- for the menu and a boolean indicating whether the menu should be
- pushed in to be completely inside the screen instead of just
- clamped to the size to the screen.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Menu positioning function to use with the <link
- linkend="method-gtkmenu--popup"><methodname>popup</methodname>()</link>
- method to position <parameter>menu</parameter> aligned to
- <parameter>statusicon</parameter> .</para>
-
- <para>Eample use of this function is:</para>
-
- <programlisting>
- menu.popup(None, None, gtk.status_icon_position_menu,
- event.button, event.time, statusicon)
- </programlisting>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkstatusicon--activate">
- <title>The "activate" gtk.StatusIcon Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>status_icon</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>status_icon</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>Gets emitted when the user activates the status icon. If and
- how status icons can be activated is platform-dependent.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkstatusicon--popup-menu">
- <title>The "popup-menu" gtk.StatusIcon Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>status_icon</parameter></methodparam>
- <methodparam><parameter>button</parameter></methodparam>
- <methodparam><parameter>activate_time</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>status_icon</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>button</parameter>&nbsp;:</term>
- <listitem><simpara>the button that was pressed, or 0 if the
- signal is not emitted in response to a button press event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>activate_time</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp of the event that
- triggered the signal emission</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>Gets emitted when the user brings up the context menu of the
- status icon. Whether status icons can have context menus and how these
- are activated is platform-dependent.</para>
-
- <para>The <parameter>button</parameter> and
- <parameter>activate_timeout</parameter> parameters should be passed as
- the last two arguments to the <link
- linkend="method-gtkmenu--popup"><methodname>gtk.Menu.popup()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkstatusicon--size-changed">
- <title>The "size-changed" gtk.StatusIcon Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>status_icon</parameter></methodparam>
- <methodparam><parameter>size</parameter></methodparam>
- <methodparam><parameter>statusicon</parameter></methodparam>
- <methodparam><parameter>arg1</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>status_icon</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>size</parameter>&nbsp;:</term>
- <listitem><simpara>the new size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the icon was updated
- for the new size. Otherwise, GTK+ will scale the icon as
- necessary.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>Gets emitted when the size available for the image changes,
- e.g. because the notification area got resized.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkstyle.xml b/docs/reference/pygtk-gtkstyle.xml
deleted file mode 100644
index 689c1f89..00000000
--- a/docs/reference/pygtk-gtkstyle.xml
+++ /dev/null
@@ -1,2948 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkstyle">
- <refnamediv>
- <refname>gtk.Style</refname>
- <refpurpose>an object that hold style information for widgets</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Style</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkstyle">gtk.Style</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--attach">attach</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--detach">detach</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--set-background">set_background</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--apply-default-background">apply_default_background</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">set_bg</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--lookup-icon-set">lookup_icon_set</link></methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--render-icon">render_icon</link></methodname>
- <methodparam><parameter
- role="keyword">source</parameter></methodparam>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-hline">paint_hline</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x1</parameter></methodparam>
- <methodparam><parameter role="keyword">x2</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-vline">paint_vline</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">y1</parameter></methodparam>
- <methodparam><parameter role="keyword">y2</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-shadow">paint_shadow</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-polygon">paint_polygon</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter
- role="keyword">points</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-arrow">paint_arrow</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter
- role="keyword">arrow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-diamond">paint_diamond</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-box">paint_box</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-flat-box">paint_flat_box</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-check">paint_check</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-option">paint_option</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-tab">paint_tab</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-shadow-gap">paint_shadow_gap</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_side</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_width</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-box-gap">paint_box_gap</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_side</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_width</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-extension">paint_extension</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_side</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-focus">paint_focus</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-slider">paint_slider</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">orientation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-handle">paint_handle</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">orientation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-expander">paint_expander</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expander_style</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-layout">paint_layout</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">layout</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkstyle--paint-resize-grip">paint_resize_grip</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter
- role="keyword">edge</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkstyle">gtk.Style</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="attributes-gtkstyle">
- <title>Attributes</title>
-
- <note>
- <para>Even though the following attributes that are arrays of <link
- linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>,
- <link linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>
- or <link
- linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
- objects are read-only, the individual array items are
- read-write.</para>
- </note>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"fg"</entry>
- <entry>Read</entry>
- <entry>An array of <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>s to be
-used for the foreground colors in each widget state.</entry>
- </row>
-
- <row valign="top">
- <entry>"bg"</entry>
- <entry>Read</entry>
- <entry>An array of <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>s to be
-used for the background colors in each widget state.</entry>
- </row>
-
- <row valign="top">
- <entry>"light"</entry>
- <entry>Read</entry>
- <entry>An array of <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>s to be
-used for the light colors in each widget state. The light colors are
-slightly lighter than the bg colors and used for creating shadows.</entry>
- </row>
-
- <row valign="top">
- <entry>"dark"</entry>
- <entry>Read</entry>
- <entry>An array of <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>s to be
-used for the dark colors in each widget state. The dark colors are slightly
-darker than the bg colors and used for creating shadows.</entry>
- </row>
-
- <row valign="top">
- <entry>"mid"</entry>
- <entry>Read</entry>
- <entry>An array of <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>s to be
-used for the mid colors (between light and dark) in each widget
-state</entry>
- </row>
-
- <row valign="top">
- <entry>"text"</entry>
- <entry>Read</entry>
- <entry>An array of <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>s to be
-used for the text colors in each widget state.</entry>
- </row>
-
- <row valign="top">
- <entry>"base"</entry>
- <entry>Read</entry>
- <entry>An array of <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>s to be
-used for the base colors in each widget state.</entry>
- </row>
-
- <row valign="top">
- <entry>"text_aa"</entry>
- <entry>Read</entry>
- <entry>An array of <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>s to be
-used for the anti-aliased text colors in each widget state.</entry>
- </row>
-
- <row valign="top">
- <entry>"black"</entry>
- <entry>Read-Write</entry>
- <entry>A <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> that is
-used for the black color.</entry>
- </row>
-
- <row valign="top">
- <entry>"white"</entry>
- <entry>Read-Write</entry>
- <entry>A <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> that is
-used for the white color.</entry>
- </row>
-
- <row valign="top">
- <entry>"font_desc"</entry>
- <entry>Read</entry>
- <entry>A <classname>pango.FontDescription</classname> used as
-the default text font.</entry>
- </row>
-
- <row valign="top">
- <entry>"xthickness"</entry>
- <entry>Read</entry>
- <entry>The thickness of lines drawn vertically.</entry>
- </row>
-
- <row valign="top">
- <entry>"ythickness"</entry>
- <entry>Read</entry>
- <entry>The thickness of lines drawn horizontally.</entry>
- </row>
-
- <row valign="top">
- <entry>"fg_gc"</entry>
- <entry>Read</entry>
- <entry>An array of graphics contexts (<link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) for drawing
-using the fg colors.</entry>
- </row>
-
- <row valign="top">
- <entry>"bg_gc"</entry>
- <entry>Read</entry>
- <entry>An array of graphics contexts (<link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) for drawing
-using the bg colors.</entry>
- </row>
-
- <row valign="top">
- <entry>"light_gc"</entry>
- <entry>Read</entry>
- <entry>An array of graphics contexts (<link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) for drawing
-using the light colors.</entry>
- </row>
-
- <row valign="top">
- <entry>"dark_gc"</entry>
- <entry>Read</entry>
- <entry>An array of graphics contexts (<link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) for drawing
-using the dark colors.</entry>
- </row>
-
- <row valign="top">
- <entry>"mid_gc"</entry>
- <entry>Read</entry>
- <entry>An array of graphics contexts (<link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) for drawing
-using the mid colors.</entry>
- </row>
-
- <row valign="top">
- <entry>"text_gc"</entry>
- <entry>Read</entry>
- <entry>An array of graphics contexts (<link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) for drawing
-using the text colors.</entry>
- </row>
-
- <row valign="top">
- <entry>"base_gc"</entry>
- <entry>Read</entry>
- <entry>An array of graphics contexts (<link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) for drawing
-using the base colors.</entry>
- </row>
-
- <row valign="top">
- <entry>"text_aa_gc"</entry>
- <entry>Read</entry>
- <entry>An array of graphics contexts (<link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) for drawing
-using the anti-aliased text colors.</entry>
- </row>
-
- <row valign="top">
- <entry>"black_gc"</entry>
- <entry>Read-Write</entry>
- <entry>A graphics context (<link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) for drawing
-using the black color.</entry>
- </row>
-
- <row valign="top">
- <entry>"white_gc"</entry>
- <entry>Read-Write</entry>
- <entry>A graphics context (<link
-linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link>) for drawing
-using the white color.</entry>
- </row>
-
- <row valign="top">
- <entry>"bg_pixmap"</entry>
- <entry>Read</entry>
- <entry>An array of <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link> to
-be used for the background stippling in each widget state.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkstyle">
- <title>gtk.Style Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkstyle--realize">realize</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>style</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkstyle--unrealize">unrealize</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>style</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> object
-encapsulates the information that provides the look and feel for a widget.
-Each <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> has an
-associated <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> object that
-is used when rendering that widget. Usually the <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> for a
-widget is the same as the default style that is set by GTK and modified the
-theme engine. A <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> holds
-information for the five possible widget states though not every widget
-supports all five states:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.STATE_NORMAL</literal></term>
- <listitem>
- <simpara>The state of a sensitive widget that is not active and
-does not have the focus</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.STATE_ACTIVE</literal></term>
- <listitem>
- <simpara>The state of a sensitive widget when it is active e.g. a
-button that is pressed but not yet released</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.STATE_PRELIGHT</literal></term>
- <listitem>
- <simpara>The state of a sensitive widget that has the focus e.g. a
-button that has the mouse pointer over it.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.STATE_SELECTED</literal></term>
- <listitem>
- <simpara>The state of a widget that is selected e.g. selected text
-in a <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
-widget</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.STATE_INSENSITIVE</literal></term>
- <listitem>
- <simpara>The state of a widget that is insensitive and will not
-respond to any events e.g. cannot be activated, selected or
-prelit.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>A <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> contains
-the read-only attributes described in the above <link
-linkend="attributes-gtkstyle">section</link>.</para>
-
- <para>Usually applications should not need to use or modify the <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> of their
-widgets.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkstyle">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Style</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkstyle--copy">
- <title>gtk.Style.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns a copy of the
-style object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--attach">
- <title>gtk.Style.attach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>attach</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>attach</methodname>() method adapts a style to
-the specified <parameter>window</parameter>. This process allocates the
-colors and creates the graphics contexts for the style specializing them to
-a particular visual and colormap. A new <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> may be
-created if the style has already been adapted to a window with a different
-style and colormap.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--detach">
- <title>gtk.Style.detach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>detach</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>detach</methodname>() method detaches the style and frees its resources if it is no longer attached.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--set-background">
- <title>gtk.Style.set_background</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_background</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_background</methodname>() method sets the
-background of <parameter>window</parameter> to the background color or
-pixmap of the style for the widget state specified by
-<parameter>state_type</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--apply-default-background">
- <title>gtk.Style.apply_default_background</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>apply_default_background</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">set_bg</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">set_bg</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> use the bg_pixmap
-for the widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>the widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>the clipping area</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>apply_default_background</methodname>() method
-sets the background of the specified <parameter>window</parameter> in the
-area specified by <parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. The
-background color is derived from the bg_gc of the style with the state
-specified by <parameter>state_type</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping area for the application of the background.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--lookup-icon-set">
- <title>gtk.Style.lookup_icon_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>lookup_icon_set</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>a stock ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkiconset"><classname>gtk.IconSet</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>lookup_icon_set</methodname>() method looks in
-the <link
-linkend="class-gtkiconfactory"><classname>gtk.IconFactory</classname></link>
-list associated with the style and the default icon factory for the stock
-icon specified by <parameter>stock_id</parameter>. If the stock icon iconset
-is found it is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--render-icon">
- <title>gtk.Style.render_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>render_icon</methodname>
- <methodparam><parameter
- role="keyword">source</parameter></methodparam>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">source</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkiconsource"><classname>gtk.IconSource</classname></link>
-specifying the icon to render</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">direction</parameter>&nbsp;:</term>
- <listitem><simpara>a text direction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">state</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the size to render the icon at. A size of -1
-means render at the size of the source and don't scale.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a style detail</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>render_icon</methodname>() method renders the
-icon specified by <parameter>source</parameter> at the specified
-<parameter>size</parameter> for the specified widget
-<parameter>state</parameter> according to the given parameters and returns
-the result in a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-hline">
- <title>gtk.Style.paint_hline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_hline</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x1</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x2</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>the rectangle that clips the
-output</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x1</parameter>&nbsp;:</term>
- <listitem><simpara>the starting x coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x2</parameter>&nbsp;:</term>
- <listitem><simpara>the ending x coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y coordinate</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_hline</methodname>() method draws a
-horizontal line from (<parameter>x1</parameter>, <parameter>y</parameter>)
-to (<parameter>x2</parameter>, <parameter>y</parameter>) in
-<parameter>window</parameter> using the specified
-<parameter>state_type</parameter> of the style. If
-<parameter>area</parameter> is not <literal>None</literal> the line is
-clipped by the rectangle specified by <parameter>area</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-vline">
- <title>gtk.Style.paint_vline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_vline</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y1</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y2</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>the rectangle to which the output is
-clipped</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y1</parameter>&nbsp;:</term>
- <listitem><simpara>the starting y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y2</parameter>&nbsp;:</term>
- <listitem><simpara>the ending y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x coordinate</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_vline</methodname>() method draws a
-vertical line from (<parameter>x</parameter>, <parameter>y1</parameter>) to
-(<parameter>x</parameter>, <parameter>y2</parameter>) in
-<parameter>window</parameter> using the specified
-<parameter>state_type</parameter> of the style. If
-<parameter>area</parameter> is not <literal>None</literal> the line is
-clipped by the rectangle specified by <parameter>area</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-shadow">
- <title>gtk.Style.paint_shadow</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_shadow</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>*</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a type of shadow - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>the rectangle to which the output is
-clipped</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_shadow</methodname>() method draws a
-shadow of the specified <parameter>shadow_type</parameter> on the specified
-<parameter>window</parameter> with the size specified by
-<parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> the shadow is
-clipped to the rectangle' area. <parameter>state_type</parameter> specifies
-the style state to use for drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-polygon">
- <title>gtk.Style.paint_polygon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_polygon</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter
- role="keyword">points</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">points</parameter>&nbsp;:</term>
- <listitem><simpara>a list or tuple containing point (x, y)
-tuples</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the polygon should
-be filled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_polygon</methodname>() method draws a
-polygon on the specified <parameter>window</parameter> with the shadow type
-specified by <parameter>shadow_type</parameter> connecting the points
-specified by <parameter>points</parameter>. If <parameter>area</parameter>
-is not <literal>None</literal> it specifies a clipping rectangle. The style
-state specified by <parameter>state_type</parameter> determines the graphics
-context to use while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-arrow">
- <title>gtk.Style.paint_arrow</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_arrow</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter
- role="keyword">arrow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">fill</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>the widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">arrow_type</parameter>&nbsp;:</term>
- <listitem><simpara>an arrow type - one of:
-<literal>gtk.ARROW_UP</literal>, <literal>gtk.ARROW_DOWN</literal>,
-<literal>gtk.ARROW_LEFT</literal>,
-<literal>gtk.ARROW_RIGHT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the arrow should be
-filled</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The<methodname> paint_arrow</methodname>() method draws an arrow
-of the type specified by <parameter>arrow_type</parameter> on the specified
-<parameter>window</parameter> with the shadow type specified by
-<parameter>shadow_type</parameter> with the location and size specified by
-<parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-diamond">
- <title>gtk.Style.paint_diamond</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_diamond</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_diamond</methodname>() method draws a
-diamond on the specified <parameter>window</parameter> with the shadow type
-specified by <parameter>shadow_type</parameter> and the location and size
-specified by <parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-box">
- <title>gtk.Style.paint_box</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_box</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_box</methodname>() method draws a box on
-the specified <parameter>window</parameter> with the shadow type specified
-by <parameter>shadow_type</parameter> and the location and size specified by
-<parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-flat-box">
- <title>gtk.Style.paint_flat_box</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_flat_box</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_flat_box</methodname>() method draws a
-flat box (no shadow) on the specified <parameter>window</parameter> with
-the location and size specified by <parameter>x</parameter>,
-<parameter>y</parameter>, <parameter>width</parameter> and
-<parameter>height</parameter>. If <parameter>area</parameter> is not
-<literal>None</literal> it specifies a clipping rectangle. The style state
-specified by <parameter>state_type</parameter> determines the graphics
-context to use while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-check">
- <title>gtk.Style.paint_check</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_check</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_check</methodname>() method draws a check
-on the specified <parameter>window</parameter> with the shadow type
-specified by <parameter>shadow_type</parameter> and the location and size
-specified by <parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-option">
- <title>gtk.Style.paint_option</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_option</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_option</methodname>() method draws an
-option menu item on the specified <parameter>window</parameter> with the
-shadow type specified by <parameter>shadow_type</parameter> and the location
-and size specified by <parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-tab">
- <title>gtk.Style.paint_tab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_tab</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_tab</methodname>() method draws a tab on
-the specified <parameter>window</parameter> with the shadow type specified
-by <parameter>shadow_type</parameter> and the location and size specified by
-<parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-shadow-gap">
- <title>gtk.Style.paint_shadow_gap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_shadow_gap</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_side</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_width</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">gap_side</parameter>&nbsp;:</term>
- <listitem><simpara>a position - one of:
-<literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
-<literal>gtk.POS_TOP</literal>,
-<literal>gtk.POS_BOTTOM</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">gap_x</parameter>&nbsp;:</term>
- <listitem><simpara>the x position of the gap</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">gap_width</parameter>&nbsp;:</term>
- <listitem><simpara>the gap width</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_shadow_gap</methodname>() method draws a
-shadow with a gap on the specified <parameter>window</parameter> with the
-shadow type specified by <parameter>shadow_type</parameter> and the location
-and size specified by <parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. The gap
-position and width is specified by <parameter>gap_side</parameter>,
-<parameter>gap_x</parameter> and <parameter>gap_width</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-box-gap">
- <title>gtk.Style.paint_box_gap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_box_gap</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_side</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_width</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">gap_side</parameter>&nbsp;:</term>
- <listitem><simpara>a position - one of:
-<literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
-<literal>gtk.POS_TOP</literal>,
-<literal>gtk.POS_BOTTOM</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">gap_x</parameter>&nbsp;:</term>
- <listitem><simpara>the x position of the gap</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">gap_width</parameter>&nbsp;:</term>
- <listitem><simpara>the gap width</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_box_gap</methodname>() method draws a box
-with a gap on the specified <parameter>window</parameter> with the shadow
-type specified by <parameter>shadow_type</parameter> and the location and
-size specified by <parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. The gap
-position and width is specified by <parameter>gap_side</parameter>,
-<parameter>gap_x</parameter> and <parameter>gap_width</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-extension">
- <title>gtk.Style.paint_extension</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_extension</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">gap_side</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">gap_side</parameter>&nbsp;:</term>
- <listitem><simpara>a position - one of:
-<literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
-<literal>gtk.POS_TOP</literal>,
-<literal>gtk.POS_BOTTOM</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_extension</methodname>() method draws an
-extension on the specified <parameter>window</parameter> with the shadow
-type specified by <parameter>shadow_type</parameter> and the location and
-size specified by <parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. The
-extension position is specified by <parameter>gap_side</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-focus">
- <title>gtk.Style.paint_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_focus</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_focus</methodname>() method draws a focus
-indicator on the specified <parameter>window</parameter> with the location
-and size specified by <parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-slider">
- <title>gtk.Style.paint_slider</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_slider</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">orientation</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">orientation</parameter>&nbsp;:</term>
- <listitem><simpara>a position - one of:
-<literal>gtk.ORIENTATION_HORIZONTAL</literal> or
-<literal>gtk.ORIENTATION_VERTICAL</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_slider</methodname>() method draws a
-slider with the specified <parameter>orientation</parameter> on the
-specified <parameter>window</parameter> with the shadow type specified by
-<parameter>shadow_type</parameter> and the location and size specified by
-<parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-handle">
- <title>gtk.Style.paint_handle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_handle</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">shadow_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- <methodparam><parameter
- role="keyword">orientation</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">shadow_type</parameter>&nbsp;:</term>
- <listitem><simpara>a shadow type - one of:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>,
-<literal>gtk.SHADOW_ETCHED_OUT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">orientation</parameter>&nbsp;:</term>
- <listitem><simpara>a position - one of:
-<literal>gtk.ORIENTATION_HORIZONTAL</literal> or
-<literal>gtk.ORIENTATION_VERTICAL</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_handle</methodname>() method draws a
-handle with the specified <parameter>orientation</parameter> on the
-specified <parameter>window</parameter> with the shadow type specified by
-<parameter>shadow_type</parameter> and the location and size specified by
-<parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-expander">
- <title>gtk.Style.paint_expander</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_expander</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expander_style</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">expander_style</parameter>&nbsp;:</term>
- <listitem><simpara>an expander style - one of:
-<literal>gtk.EXPANDER_COLLAPSED</literal>,
-<literal>gtk.EXPANDER_SEMI_COLLAPSED</literal>,
-<literal>gtk.EXPANDER_SEMI_EXPANDED</literal> or
-<literal>gtk.EXPANDER_EXPANDED</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_expander</methodname>() method draws an
-expander with the specified <parameter>expander_style</parameter> on the
-specified <parameter>window</parameter> at the location specified by
-<parameter>x</parameter>, <parameter>y</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-layout">
- <title>gtk.Style.paint_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_layout</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">layout</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">use_text</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> use the text
-graphics context for drawing</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">layout</parameter>&nbsp;:</term>
- <listitem><simpara>a <classname>Pango.Layout</classname> object
-containing the text to display</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_layout</methodname>() method draws the
-text in a <classname>pango.Layout</classname> specified by
-<parameter>layout</parameter> on the specified <parameter>window</parameter>
-at the location specified by <parameter>x</parameter> and
-<parameter>y</parameter>. If text is <literal>True</literal> use the text
-graphics context of the style for drawing, otherwise use the fg graphics
-context. If <parameter>area</parameter> is not <literal>None</literal> it
-specifies a clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkstyle--paint-resize-grip">
- <title>gtk.Style.paint_resize_grip</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paint_resize_grip</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">state_type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter></methodparam>
- <methodparam><parameter
- role="keyword">edge</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">state_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a clipping rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>a detail string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">edge</parameter>&nbsp;:</term>
- <listitem><simpara>the edge in which to draw the resize grip,
-currently only <literal>gtk.WINDOW_EDGE_SOUTH_EAST</literal> is
-implemented</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y location</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>paint_resize_grip</methodname>() method draws a
-resize grip at the specified <parameter>edge</parameter> on the specified
-<parameter>window</parameter> with the location and size specified by
-<parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter>. If
-<parameter>area</parameter> is not <literal>None</literal> it specifies a
-clipping rectangle. The widget state specified by
-<parameter>state_type</parameter> determines the graphics context to use
-while drawing. Currently the grip can only be drawn at the
-<literal>gtk.WINDOW_EDGE_SOUTH_EAST</literal> (lower right) edge.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkstyle--realize">
- <title>The "realize" gtk.Style Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>style</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>style</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the
- signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>Emitted when the style has been initialized for a particular
- colormap and depth. Connecting to this signal is probably seldom
- useful since most of the time applications and widgets only deal with
- styles that have been already realized.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkstyle--unrealize">
- <title>The "unrealize" gtk.Style Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>style</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>style</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the
- signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>Emitted when the aspects of the style specific to a particular
- colormap and depth are being cleaned up. A connection to this signal
- can be useful if a widget wants to cache objects like a <link
- linkend="class-gdkgc"><classname>gtk.gdk.GC</classname></link> as
- object data on <link
- linkend="class-gtkstyle"><classname>gtk.Style</classname></link>.
- This signal provides a convenient place to free such cached
- objects.</para>
-
- </refsect2>
-
-</refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktable.xml b/docs/reference/pygtk-gtktable.xml
deleted file mode 100644
index d6dd568b..00000000
--- a/docs/reference/pygtk-gtktable.xml
+++ /dev/null
@@ -1,761 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktable">
- <refnamediv>
- <refname>gtk.Table</refname>
- <refpurpose>layout widgets in a two-dimensional array</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Table</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtktable">gtk.Table</link></methodname>
- <methodparam><parameter
- role="keyword">rows</parameter><initializer>1</initializer></methodparam>
- <methodparam><parameter
- role="keyword">columns</parameter><initializer>1</initializer></methodparam>
- <methodparam><parameter
- role="keyword">homogeneous</parameter><initializer>False</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--resize">resize</link></methodname>
- <methodparam><parameter
- role="keyword">rows</parameter></methodparam>
- <methodparam><parameter
- role="keyword">columns</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--attach">attach</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">left_attach</parameter></methodparam>
- <methodparam><parameter
- role="keyword">right_attach</parameter></methodparam>
- <methodparam><parameter
- role="keyword">top_attach</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bottom_attach</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xoptions</parameter><initializer>gtk.EXPAND|gtk.FILL</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yoptions</parameter><initializer>gtk.EXPAND|gtk.FILL</initializer></methodparam>
- <methodparam><parameter
- role="keyword">xpadding</parameter><initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">ypadding</parameter><initializer>0</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--set-row-spacing">set_row_spacing</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--get-row-spacing">get_row_spacing</link></methodname>
- <methodparam><parameter role="keyword">row</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--set-col-spacing">set_col_spacing</link></methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--get-col-spacing">get_col_spacing</link></methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--set-row-spacings">set_row_spacings</link></methodname>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--get-default-row-spacing">get_default_row_spacing</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--set-col-spacings">set_col_spacings</link></methodname>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--get-default-col-spacing">get_default_col_spacing</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--set-homogeneous">set_homogeneous</link></methodname>
- <methodparam><parameter
- role="keyword">homogeneous</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktable--get-homogeneous">get_homogeneous</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtktable">gtk.Table</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktable">
- <title>gtk.Table Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"column-spacing"</entry>
- <entry>Read-Write</entry>
- <entry>The amount of space between two adjacent
-columns</entry>
- </row>
-
- <row valign="top">
- <entry>"homogeneous"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the table cells are all the
-same width or height</entry>
- </row>
-
- <row valign="top">
- <entry>"n-columns"</entry>
- <entry>Read-Write</entry>
- <entry>The number of columns in the table</entry>
- </row>
-
- <row valign="top">
- <entry>"n-rows"</entry>
- <entry>Read-Write</entry>
- <entry>The number of rows in the table</entry>
- </row>
-
- <row valign="top">
- <entry>"row-spacing"</entry>
- <entry>Read-Write</entry>
- <entry>The amount of space between two adjacent rows</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtktable">
- <title>gtk.Table Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtktable">
- <title>gtk.Table Child Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"bottom-attach"</entry>
- <entry>Read-Write</entry>
- <entry>The lowest row of the child</entry>
- </row>
-
- <row valign="top">
- <entry>"left-attach"</entry>
- <entry>Read-Write</entry>
- <entry>The leftmost column of the child</entry>
- </row>
-
- <row valign="top">
- <entry>"right-attach"</entry>
- <entry>Read-Write</entry>
- <entry>The rightmost column of the child</entry>
- </row>
-
- <row valign="top">
- <entry>"top-attach"</entry>
- <entry>Read-Write</entry>
- <entry>The uppermost row of the child</entry>
- </row>
-
- <row valign="top">
- <entry>"x-options"</entry>
- <entry>Read-Write</entry>
- <entry>the horizontal behavior of the child - a combination
-of: <literal>gtk.EXPAND</literal>, <literal>gtk.SHRINK</literal> and
-<literal>gtk.FILL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"x-padding"</entry>
- <entry>Read-Write</entry>
- <entry>Extra space added between the child widget and its left
-and right neighbors, in pixels</entry>
- </row>
-
- <row valign="top">
- <entry>"y-options"</entry>
- <entry>Read-Write</entry>
- <entry>the vertical behavior of the child - a combination of:
-<literal>gtk.EXPAND</literal>, <literal>gtk.SHRINK</literal> and
-<literal>gtk.FILL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"y-padding"</entry>
- <entry>Read-Write</entry>
- <entry>Extra space added between the child widget and its top
-and bottom neighbors, in pixels</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <refsect1 id="signal-prototypes-gtktable">
- <title>gtk.Table Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtktable"><classname>gtk.Table</classname></link> manages a
-group of widgets that are arranged in rows and columns, making it easy to
-align many widgets next to each other, horizontally and vertically. Tables
-are created with a call to <link
-linkend="constructor-gtktable">gtk.Table</link>(). The size of a table can
-be changed using the <link
-linkend="method-gtktable--resize"><methodname>resize</methodname>()</link>
-method.</para>
-
- <para>Widgets can be added to a table using the <link
-linkend="method-gtktable--attach"><methodname>attach</methodname>()</link>
-method. To alter the space of the row next to a specific row, use the <link
-linkend="method-gtktable--set-row-spacing"><methodname>set_row_spacing</methodname>()</link>
-method, and for a column, the <link
-linkend="method-gtktable--set-col-spacing"><methodname>set_col_spacing</methodname>()</link>
-method. The gaps between all rows or columns can be changed by calling the
-<link
-linkend="method-gtktable--set-row-spacings"><methodname>set_row_spacings</methodname>()</link>
-or <link
-linkend="method-gtktable--set-col-spacings"><methodname>set_col_spacings</methodname>()</link>
-methods respectively. The <link
-linkend="method-gtktable--set-homogeneous"><methodname>set_homogeneous</methodname>()</link>
-method changes the setting that determines whether all cells in the table
-will resize themselves to the size of the largest widget in the
-table.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktable">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Table</methodname>
- <methodparam><parameter
- role="keyword">rows</parameter><initializer>1</initializer></methodparam>
- <methodparam><parameter
- role="keyword">columns</parameter><initializer>1</initializer></methodparam>
- <methodparam><parameter
- role="keyword">homogeneous</parameter><initializer>False</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rows</parameter>&nbsp;:</term>
- <listitem><simpara>the number of rows</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">columns</parameter>&nbsp;:</term>
- <listitem><simpara>the number of columns</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">homogeneous</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> all table cells will
-be the same size as the largest cell</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktable"><classname>gtk.Table</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtktable"><classname>gtk.Table</classname></link> widget with
-the number of rows and columns specified by the value of
-<parameter>rows</parameter> and <parameter>columns</parameter> respectively.
-The value of <parameter>rows</parameter> and <parameter>columns</parameter>
-must be in the range 0 .. 65535. If <parameter>homogeneous</parameter> is
-<literal>True</literal> the table cells will all be the same size as the
-largest cell. If <parameter>rows</parameter> or
-<parameter>columns</parameter> are not specified they default to 1.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktable--resize">
- <title>gtk.Table.resize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>resize</methodname>
- <methodparam><parameter
- role="keyword">rows</parameter></methodparam>
- <methodparam><parameter
- role="keyword">columns</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rows</parameter>&nbsp;:</term>
- <listitem><simpara>The new number of rows.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">columns</parameter>&nbsp;:</term>
- <listitem><simpara>The new number of columns.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>resize</methodname>() method changes the size of
-the table as specified by the parameters, <parameter>rows</parameter> and
-<parameter>columns</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktable--attach">
- <title>gtk.Table.attach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>attach</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">left_attach</parameter></methodparam>
- <methodparam><parameter
- role="keyword">right_attach</parameter></methodparam>
- <methodparam><parameter
- role="keyword">top_attach</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bottom_attach</parameter></methodparam>
- <methodparam><parameter role="keyword">xoptions</parameter>
- <initializer><literal>gtk.EXPAND</literal>|<literal>gtk.FILL</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">yoptions</parameter>
- <initializer><literal>gtk.EXPAND</literal>|<literal>gtk.FILL</literal></initializer></methodparam>
- <methodparam><parameter role="keyword">xpadding</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter role="keyword">ypadding</parameter>
- <initializer>0</initializer></methodparam>
-</methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to add.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">left_attach</parameter>&nbsp;:</term>
- <listitem><simpara>the column number to attach the left side of a
-child widget to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">right_attach</parameter>&nbsp;:</term>
- <listitem><simpara>the column number to attach the right side of a
-child widget to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">top_attach</parameter>&nbsp;:</term>
- <listitem><simpara>the row number to attach the top side of a
-child widget to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">bottom_attach</parameter>&nbsp;:</term>
- <listitem><simpara>the row number to attach the bottom side of a
-child widget to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xoptions</parameter>&nbsp;:</term>
- <listitem><simpara>used to specify the properties of the child
-widget when the table is resized horizontally.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">yoptions</parameter>&nbsp;:</term>
- <listitem><simpara>used to specify the properties of the child
-widget when the table is resized vertically.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xpadding</parameter>&nbsp;:</term>
- <listitem><simpara>the amount of padding to add on the left and
-right of the widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ypadding</parameter>&nbsp;:</term>
- <listitem><simpara>the amount of padding to add above and below
-the widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>attach</methodname>() method adds the widget
-specified by <parameter>child</parameter> to the table. The number of
-'cells' that a widget will occupy is specified by:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><parameter>left_attach</parameter> - the column to the
-left of the widget</simpara>
- </listitem>
- <listitem>
- <simpara><parameter>right_attach</parameter> - the column to the
-right of the widget</simpara>
- </listitem>
- <listitem>
- <simpara><parameter>top_attach</parameter> - the row above the
-widget and</simpara>
- </listitem>
- <listitem>
- <simpara><parameter>bottom_attach</parameter> - the row below the
-widget</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The <parameter>xoptions</parameter> and
-<parameter>yoptions</parameter> determine the expansion properties of the
-widget in the horizontal and vertical directions respectively (the default
-value is <literal>gtk.FILL</literal>|<literal>gtk.EXPAND</literal>). The
-value of the options is a combination of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.EXPAND</literal></term>
- <listitem>
- <simpara>the table cell should expand to take up any extra space
-that has been allocated to the table.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.SHRINK</literal></term>
- <listitem>
- <simpara>the widget should shrink when the table cell
-shrinks.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.FILL</literal></term>
- <listitem>
- <simpara>the widget should fill the space allocated to
-it in the table cell.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <parameter>xpadding</parameter> and <parameter>ypadding</parameter> parameters determine the extra padding added around the widget. By default these are 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktable--set-row-spacing">
- <title>gtk.Table.set_row_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_row_spacing</methodname>
- <methodparam><parameter
- role="keyword">row</parameter></methodparam>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>the row number whose spacing will be
-changed.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
- <listitem><simpara>the number of pixels of added
-spacing</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_row_spacing</methodname>() method sets the
-spacing in pixels (specified by <parameter>spacing</parameter>) between the
-specified <parameter>row</parameter> and the following row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktable--get-row-spacing">
- <title>gtk.Table.get_row_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_row_spacing</methodname>
- <methodparam><parameter
- role="keyword">row</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>a row in the table, 0 indicates the first
-row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the row spacing</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_row_spacing</methodname>() method returns
-the amount of space between the specified <parameter>row</parameter>, and
-the following row. See the <link
-linkend="method-gtktable--set-row-spacing"><methodname>set_row_spacing</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktable--set-col-spacing">
- <title>gtk.Table.set_col_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_col_spacing</methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the column number whose spacing will be
-changed.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
- <listitem><simpara>the number of pixels of added
-spacing</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_col_spacing</methodname>() method sets the
-spacing in pixels (specified by <parameter>spacing</parameter>) between the
-specified <parameter>column</parameter> and the following column.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktable--get-col-spacing">
- <title>gtk.Table.get_col_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_col_spacing</methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>a column in the table, 0 indicates the first
-column</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the column spacing</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_col_spacing</methodname>() returns the
-amount of space between the specified <parameter>column</parameter>, and the
-following column. See the <link
-linkend="method-gtktable--set-col-spacing"><methodname>set_col_spacing</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktable--set-row-spacings">
- <title>gtk.Table.set_row_spacings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_row_spacings</methodname>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
- <listitem><simpara>the number of pixels of space to place between
-every row in the table.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_row_spacings</methodname>() method sets the
-"row-spacing" property, that determines the space between every row in
-table, to the value of <parameter>spacing</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktable--get-default-row-spacing">
- <title>gtk.Table.get_default_row_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_row_spacing</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default row spacing</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_default_row_spacing</methodname>() method
-returns the value of the "row-spacing" property that specifies the default
-row spacing for the table i.e. the spacing that will be used for newly added
-rows. (See the <link
-linkend="method-gtktable--set-row-spacings"><methodname>set_row_spacings</methodname>()</link>)</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktable--set-col-spacings">
- <title>gtk.Table.set_col_spacings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_col_spacings</methodname>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
- <listitem><simpara>the number of pixels of space to place between
-every column in the table.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_col_spacings</methodname>() method sets the
-"column-spacing" property, that determines the space between every column in
-table, to the value of <parameter>spacing</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktable--get-default-col-spacing">
- <title>gtk.Table.get_default_col_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_col_spacing</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default column spacing</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_default_col_spacing</methodname>() method
-returns the value of the "column-spacing" property to the default column
-spacing for the table i.e. the spacing that will be used for newly added
-columns. (See the <link
-linkend="method-gtktable--set-col-spacings"><methodname>set_col_spacings</methodname>()</link>)</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktable--set-homogeneous">
- <title>gtk.Table.set_homogeneous</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_homogeneous</methodname>
- <methodparam><parameter
- role="keyword">homogeneous</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">homogeneous</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> all cells will be
-the same size as the largest cell</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_homogeneous</methodname>() method sets the
-"homogeneous" property to the value of <parameter>homogeneous</parameter>. If
-homogeneous is <literal>True</literal> all cells will be the same size as the
-largest cell.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktable--get-homogeneous">
- <title>gtk.Table.get_homogeneous</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_homogeneous</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the cells are all
-set to the same size</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_homogeneous</methodname>() method returns the
-value of the "homogeneous" property. If the value of "homogeneous" is
-<literal>True</literal> all cells are set to the same width and height. (See
-the <link
-linkend="method-gtktable--set-homogeneous"><methodname>set_homogeneous</methodname>()</link>
-method)</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktearoffmenuitem.xml b/docs/reference/pygtk-gtktearoffmenuitem.xml
deleted file mode 100644
index e4793bd3..00000000
--- a/docs/reference/pygtk-gtktearoffmenuitem.xml
+++ /dev/null
@@ -1,111 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktearoffmenuitem">
- <refnamediv>
- <refname>gtk.TearoffMenuItem</refname>
- <refpurpose>a menu item used to tear off and reattach its
-menu.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TearoffMenuItem</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkmenuitem">gtk.MenuItem</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktearoffmenuitem">gtk.TearoffMenuItem</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkitem">gtk.Item</link>
- +-- <link linkend="class-gtkmenuitem">gtk.MenuItem</link>
- +-- <link linkend="class-gtktearoffmenuitem">gtk.TearoffMenuItem</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktearoffmenuitem">
- <title>gtk.TearoffMenuItem Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtktearoffmenuitem">
- <title>gtk.TearoffMenuItem Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktearoffmenuitem">
- <title>gtk.TearoffMenuItem Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link>
-is a special <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> which
-is used to tear off and reattach its menu. When its menu is shown normally,
-the <link
-linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link>
-is drawn as a dotted line indicating that the menu can be torn off.
-Activating it causes its menu to be torn off and displayed in its own window
-as a tearoff menu. When its menu is shown as a tearoff menu, the <link
-linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link>
-is drawn as a dotted line which has a left pointing arrow graphic indicating
-that the tearoff menu can be reattached. Activating it will remove the
-tearoff menu window.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktearoffmenuitem">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TearoffMenuItem</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktextattributes.xml b/docs/reference/pygtk-gtktextattributes.xml
deleted file mode 100644
index 89b1fbd4..00000000
--- a/docs/reference/pygtk-gtktextattributes.xml
+++ /dev/null
@@ -1,353 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktextattributes">
- <refnamediv>
- <refname>gtk.TextAttributes</refname>
- <refpurpose>an object containing the attributes set on some
-text</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TextAttributes</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktextattributes">gtk.TextAttributes</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextattributes--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextattributes--copy-values">copy_values</link></methodname>
- <methodparam><parameter role="keyword">dest</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"bg_color"</entry>
- <entry>Read</entry>
- <entry>The background color</entry>
- </row>
-
- <row valign="top">
- <entry>"fg_color"</entry>
- <entry>Read</entry>
- <entry>The foreground color</entry>
- </row>
-
- <row valign="top">
- <entry>"bg_stipple"</entry>
- <entry>Read</entry>
- <entry>The background stipple bitmap</entry>
- </row>
-
- <row valign="top">
- <entry>"fg_stipple"</entry>
- <entry>Read</entry>
- <entry>The foreground stipple bitmap</entry>
- </row>
-
- <row valign="top">
- <entry>"rise"</entry>
- <entry>Read</entry>
- <entry>The subscript or superscript rise</entry>
- </row>
-
- <row valign="top">
- <entry>"underline"</entry>
- <entry>Read</entry>
- <entry>The style of underline - one of:
-<literal>pango.UNDERLINE_NONE</literal>,
-<literal>pango.UNDERLINE_SINGLE</literal>,
-<literal>pango.UNDERLINE_DOUBLE</literal>,
-<literal>pango.UNDERLINE_LOW</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"strikethrough"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> strikethrough the text</entry>
- </row>
-
- <row valign="top">
- <entry>"draw_bg"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> some background attributes
-are set</entry>
- </row>
-
- <row valign="top">
- <entry>"justification"</entry>
- <entry>Read</entry>
- <entry>The type of justification - one of:
-<literal>gtk.JUSTIFY_LEFT</literal>, <literal>gtk.JUSTIFY_RIGHT</literal>,
-<literal>gtk.JUSTIFY_CENTER</literal>,
-<literal>gtk.JUSTIFY_FILL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"direction"</entry>
- <entry>Read</entry>
- <entry>The text direction - one of:
-<literal>gtk.TEXT_DIR_NONE</literal>, <literal>gtk.TEXT_DIR_LTR</literal>,
-<literal>gtk.TEXT_DIR_RTL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"font"</entry>
- <entry>Read</entry>
- <entry>A <classname>pango.FontDescription</classname></entry>
- </row>
-
- <row valign="top">
- <entry>"font_scale"</entry>
- <entry>Read</entry>
- <entry>The scale of the font e.g. 2.5</entry>
- </row>
-
- <row valign="top">
- <entry>"left_margin"</entry>
- <entry>Read</entry>
- <entry>The width of the left margin in pixels</entry>
- </row>
-
- <row valign="top">
- <entry>"indent"</entry>
- <entry>Read</entry>
- <entry>The width of the paragraph indent in pixels</entry>
- </row>
-
- <row valign="top">
- <entry>"right_margin"</entry>
- <entry>Read</entry>
- <entry>The width of the right margin</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels_above_lines"</entry>
- <entry>Read</entry>
- <entry>The number of pixels space above a paragraph</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels_below_lines"</entry>
- <entry>Read</entry>
- <entry>The number of pixels space below a paragraph</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels_inside_wrap"</entry>
- <entry>Read</entry>
- <entry>The number of pixels of space between wrapped lines in
-a paragraph</entry>
- </row>
-
- <row valign="top">
- <entry>"tabs"</entry>
- <entry>Read</entry>
- <entry>A set of tabs contained in a
-<classname>pango.TabArray</classname></entry>
- </row>
-
- <row valign="top">
- <entry>"wrap_mode"</entry>
- <entry>Read</entry>
- <entry>The wrap mode - one of: <literal>gtk.WRAP_NONE</literal>,
- <literal>gtk.WRAP_CHAR</literal>,
- <literal>gtk.WRAP_WORD</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"language"</entry>
- <entry>Read</entry>
- <entry>The <classname>pango.Language</classname> object
-describing the text language</entry>
- </row>
-
- <row valign="top">
- <entry>"invisible"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the text is hidden (Not
-implemented in PyGTK2)</entry>
- </row>
-
- <row valign="top">
- <entry>"bg_full_height"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the background is fit to the
-full line height</entry>
- </row>
-
- <row valign="top">
- <entry>"editable"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the text is editable</entry>
- </row>
-
- <row valign="top">
- <entry>"realized"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the text has been
-realized</entry>
- </row>
-
- <row valign="top">
- <entry>"pad1"</entry>
- <entry>Read</entry>
- <entry></entry>
- </row>
-
- <row valign="top">
- <entry>"pad2"</entry>
- <entry>Read</entry>
- <entry></entry>
- </row>
-
- <row valign="top">
- <entry>"pad3"</entry>
- <entry>Read</entry>
- <entry></entry>
- </row>
-
- <row valign="top">
- <entry>"pad4"</entry>
- <entry>Read</entry>
- <entry></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-object holds a set of attributes that describe the properties of a section
-of text. A <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-object is usually obtained by calling either of the <link
-linkend="method-gtktextiter--get-attributes"><methodname>gtk.TextIter.get_attributes</methodname>()</link>
-or <link
-linkend="method-gtktextview--get-default-attributes"><methodname>gtk.TextView.get_default_attributes</methodname>()</link>
-methods to retrieve the attributes in effect.</para>
-
- <para>A <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-object created with <link
-linkend="constructor-gtktextattributes">gtk.TextAttributes</link>() cannot
-be applied within PyGTK because there is no way to set the attributes.
-Likewise, the <link
-linkend="method-gtktextattributes--copy"><methodname>copy</methodname>()</link>
-and <link
-linkend="method-gtktextattributes--copy-values"><methodname>copy_values</methodname>()</link>
-methods can create a new copy or copy the attributes but there are no
-methods in PyGTK that take a <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-object as an argument. The most effective way to use a <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-object is to read its attributes and use them to set the properties of a
-<link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktextattributes">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TextAttributes</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-object, that contains a set of attributes of some text.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktextattributes--copy">
- <title>gtk.TextAttributes.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method copies the text
-attributes and returns a new <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextattributes--copy-values">
- <title>gtk.TextAttributes.copy_values</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy_values</methodname>
- <methodparam><parameter
- role="keyword">dest</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dest</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-whose attributes will be set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy_values</methodname>() method copies the
-values from the <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-object to <parameter>dest</parameter> so that <parameter>dest</parameter>
-has the same values. Frees existing values in
-<parameter>dest</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktextbuffer.xml b/docs/reference/pygtk-gtktextbuffer.xml
deleted file mode 100644
index c9d9daa1..00000000
--- a/docs/reference/pygtk-gtktextbuffer.xml
+++ /dev/null
@@ -1,3943 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktextbuffer">
- <refnamediv>
- <refname>gtk.TextBuffer</refname>
- <refpurpose>stores attributed text for display in a <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TextBuffer</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktextbuffer">gtk.TextBuffer</link></methodname>
- <methodparam><parameter role="keyword">table</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-line-count">get_line_count</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-char-count">get_char_count</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-tag-table">get_tag_table</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--set-text">set_text</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--insert">insert</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--insert-at-cursor">insert_at_cursor</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--insert-interactive">insert_interactive</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--insert-interactive-at-cursor">insert_interactive_at_cursor</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--insert-range">insert_range</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--insert-range-interactive">insert_range_interactive</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--insert-with-tags">insert_with_tags</link></methodname>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter role="keyword">...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--insert-with-tags-by-name">insert_with_tags_by_name</link></methodname>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--delete">delete</link></methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--delete-interactive">delete_interactive</link></methodname>
- <methodparam><parameter
- role="keyword">start_iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end_iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-text">get_text</link></methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- <methodparam><parameter
- role="keyword">include_hidden_chars</parameter>
- <initializer><literal>True</literal></initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-slice">get_slice</link></methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- <methodparam><parameter
- role="keyword">include_hidden_chars</parameter>
- <initializer><literal>True</literal></initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--insert-pixbuf">insert_pixbuf</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--insert-child-anchor">insert_child_anchor</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anchor</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--create-child-anchor">create_child_anchor</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--create-mark">create_mark</link></methodname>
- <methodparam><parameter
- role="keyword">mark_name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">where</parameter></methodparam>
- <methodparam><parameter role="keyword">left_gravity</parameter>
- <initializer><literal>False</literal></initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--move-mark">move_mark</link></methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- <methodparam><parameter
- role="keyword">where</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--delete-mark">delete_mark</link></methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-mark">get_mark</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--move-mark-by-name">move_mark_by_name</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">where</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--delete-mark-by-name">delete_mark_by_name</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-insert">get_insert</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-selection-bound">get_selection_bound</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--place-cursor">place_cursor</link></methodname>
- <methodparam><parameter
- role="keyword">where</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--place-cursor">select_range</link></methodname>
- <methodparam><parameter
- role="keyword">ins</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bound</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--apply-tag">apply_tag</link></methodname>
- <methodparam><parameter role="keyword">tag</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--remove-tag">remove_tag</link></methodname>
- <methodparam><parameter role="keyword">tag</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--apply-tag-by-name">apply_tag_by_name</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--remove-tag-by-name">remove_tag_by_name</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--remove-all-tags">remove_all_tags</link></methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--create-tag">create_tag</link></methodname>
- <methodparam><parameter>tag_name</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-iter-at-line-offset">get_iter_at_line_offset</link></methodname>
- <methodparam><parameter
- role="keyword">line_number</parameter></methodparam>
- <methodparam><parameter
- role="keyword">char_offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-iter-at-line-index">get_iter_at_line_index</link></methodname>
- <methodparam><parameter
- role="keyword">line_number</parameter></methodparam>
- <methodparam><parameter
- role="keyword">byte_index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-iter-at-offset">get_iter_at_offset</link></methodname>
- <methodparam><parameter
- role="keyword">char_offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-iter-at-line">get_iter_at_line</link></methodname>
- <methodparam><parameter
- role="keyword">line_number</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-start-iter">get_start_iter</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-end-iter">get_end_iter</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-bounds">get_bounds</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-iter-at-mark">get_iter_at_mark</link></methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-iter-at-child-anchor">get_iter_at_child_anchor</link></methodname>
- <methodparam><parameter
- role="keyword">anchor</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-modified">get_modified</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--set-modified">set_modified</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--add-selection-clipboard">add_selection_clipboard</link></methodname>
- <methodparam><parameter role="keyword">clipboard</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--remove-selection-clipboard">remove_selection_clipboard</link></methodname>
- <methodparam><parameter role="keyword">clipboard</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--cut-clipboard">cut_clipboard</link></methodname>
- <methodparam><parameter role="keyword">clipboard</parameter></methodparam>
- <methodparam><parameter role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--copy-clipboard">copy_clipboard</link></methodname>
- <methodparam><parameter role="keyword">clipboard</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--paste-clipboard">paste_clipboard</link></methodname>
- <methodparam><parameter role="keyword">clipboard</parameter></methodparam>
- <methodparam><parameter role="keyword">override_location</parameter></methodparam>
- <methodparam><parameter role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--get-selection-bounds">get_selection_bounds</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--delete-selection">delete_selection</link></methodname>
- <methodparam><parameter
- role="keyword">interactive</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--begin-user-action">begin_user_action</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--end-user-action">end_user_action</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextbuffer--end-user-action">backspace</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interactive</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--get-has-selection">get_has_selection</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--get-copy-target-list">get_copy_target_list</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--get-paste-target-list">get_paste_target_list</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--register-serialize-format">register_serialize_format</link></methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--register-serialize-tagset">register_serialize_tagset</link></methodname>
- <methodparam><parameter role="keyword">tagset_name</parameter><initializer>NULL</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--register-deserialize-format">register_deserialize_format</link></methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--register-deserialize-tagset">register_deserialize_tagset</link></methodname>
- <methodparam><parameter role="keyword">tagset_name</parameter><initializer>NULL</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--unregister-serialize-format">unregister_serialize_format</link></methodname>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--unregister-deserialize-format">unregister_deserialize_format</link></methodname>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--deserialize-set-can-create-tags">deserialize_set_can_create_tags</link></methodname>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- <methodparam><parameter role="keyword">can_create_tags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--deserialize-get-can-create-tags">deserialize_get_can_create_tags</link></methodname>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--get-serialize-formats">get_serialize_formats</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--get-deserialize-formats">get_deserialize_formats</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--serialize">serialize</link></methodname>
- <methodparam><parameter role="keyword">content_buffer</parameter></methodparam>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- <methodparam><parameter role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextbuffer--deserialize">deserialize</link></methodname>
- <methodparam><parameter role="keyword">content_buffer</parameter></methodparam>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtktextbuffer">gtk.TextBuffer</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktextbuffer">
- <title>gtk.TextBuffer Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"copy-target-list"</entry>
- <entry>Read</entry>
- <entry>The list of targets this buffer supports for clipboard
- copying and as DND source. This property is available in GTK+
- 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"cursor-position"</entry>
- <entry>Read</entry>
- <entry>The position of the insert mark (as offset from the
- beginning of the buffer). It is useful for getting notified
- when the cursor moves. Allowed values: >= 0. Default value:
- 0. This property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"has-selection"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the buffer has some text
- currently selected. Default value:
- <literal>False</literal>. This property is available in GTK+
- 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"paste-target-list"</entry>
- <entry>Read</entry>
- <entry>The list of targets this buffer supports for clipboard
- pasting and as DND destination. This property is available in
- GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"tag-table"</entry>
- <entry>Read-Write-Construct Only</entry>
- <entry>The <link
- linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
- associated with the textbuffer. Available in GTK+ 2.2 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"text"</entry>
- <entry>Read-Write</entry>
- <entry>The text content of the buffer. Without child widgets
- and images, see the <link
- linkend="method-gtktextbuffer--get-text"><methodname>gtk.TextBuffer.get_text()</methodname></link>
- method for more information. Default value: "". This property
- is available in GTK+ 2.8 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"tag_table"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
-associated with the textbuffer.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktextbuffer">
- <title>gtk.TextBuffer Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--apply-tag">apply-tag</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>start</parameter></methodparam>
- <methodparam><parameter>end</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--begin-user-action">begin-user-action</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--changed">changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--delete-range">delete-range</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>start</parameter></methodparam>
- <methodparam><parameter>end</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--end-user-action">end-user-action</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--insert-child-anchor">insert-child-anchor</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>anchor</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--insert-pixbuf">insert-pixbuf</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>pixbuf</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--insert-text">insert-text</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>length</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--mark-deleted">mark-deleted</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>textmark</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--mark-set">mark-set</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>textmark</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--modified-changed">modified-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextbuffer--remove-tag">remove-tag</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>start</parameter></methodparam>
- <methodparam><parameter>end</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-is the core component of the PyGTK text editing system. A <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-contains the text, pixbufs and child widget anchors that are displayed in
-one or more <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>
-widgets. A <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-has an associated <link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
-that contains the <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> objects
-that can be used to set attributes on the text in the textbuffer.</para>
-
- <para>A <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-can be automatically created when creating a <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link> or it
-can be created with the <link
-linkend="constructor-gtktextbuffer">gtk.TextBuffer</link>() constructor and
-associated with a <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link> using
-the <link
-linkend="method-gtktextview--set-buffer"><methodname>set_buffer</methodname>()</link>
-method or the <link linkend="constructor-gtktextview">gtk.TextView</link>()
-constructor.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktextbuffer">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TextBuffer</methodname>
- <methodparam><parameter role="keyword">table</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">table</parameter>&nbsp;:</term>
- <listitem><simpara>a tag table, or None to create a new
-one</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new text buffer object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktextbuffer--get-line-count">
- <title>gtk.TextBuffer.get_line_count</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line_count</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of lines in the
-buffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_line_count</methodname>() method returns the
-number of lines in the buffer. This value is cached, so the function is very
-fast.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-char-count">
- <title>gtk.TextBuffer.get_char_count</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_char_count</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of characters in the
-buffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_char_count</methodname>() method returns the
-number of characters in the buffer; note that characters and bytes are not
-the same, you can't e.g. expect the contents of the buffer in string form to
-be this many bytes long. The character count is cached, so this function is
-very fast.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-tag-table">
- <title>gtk.TextBuffer.get_tag_table</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tag_table</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the buffer's tag table</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tag_table</methodname>() method returns the
-<link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
-object associated with the textbuffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--set-text">
- <title>gtk.TextBuffer.set_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>UTF-8 text to insert</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_text</methodname>() method replaces the
-current contents of the textbuffer with the contents of
-<parameter>text</parameter>. <parameter>text</parameter> must be valid
-UTF-8.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--insert">
- <title>gtk.TextBuffer.insert</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying a position in the buffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>UTF-8 format text to
-insert</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert</methodname>() method inserts the
-contents of <parameter>text</parameter> into the textbuffer at the position
-specified by <parameter>iter</parameter>. The "insert_text" signal is
-emitted and the text insertion actually occurs in the default handler for
-the signal. <parameter>iter</parameter> is invalidated when insertion occurs
-(because the buffer contents change), but the default signal handler
-revalidates it to point to the end of the inserted text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--insert-at-cursor">
- <title>gtk.TextBuffer.insert_at_cursor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_at_cursor</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>some text in UTF-8 format</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_at_cursor</methodname>() method is a
-convenience method that calls the <link
-linkend="method-gtktextbuffer--insert"><methodname>insert</methodname>()</link>
-method, using the current cursor position as the insertion point.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--insert-interactive">
- <title>gtk.TextBuffer.insert_interactive</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_interactive</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying a position in
-<parameter>buffer</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>some UTF-8 text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">default_editable</parameter>&nbsp;:</term>
- <listitem><simpara>default editability of
-buffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the text was
-actually inserted</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_interactive</methodname>() method is
-similar to the <link
-linkend="method-gtktextbuffer--insert"><methodname>insert</methodname>()</link>
-method, except the insertion of <parameter>text</parameter> at
-<parameter>iter</parameter> will not occur if <parameter>iter</parameter> is
-at a non-editable location in the buffer. A location is non-editable if a
-<link linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
-applied at that location has its "editable" attribute set to
-<literal>False</literal> or the <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link> used
-by the user is set non-editable. Usually you want to prevent insertions at
-locations if the insertion results from a user action (is
-interactive).</para>
-
- <para><parameter>default_editable</parameter> indicates the
-editability of text that doesn't have a tag affecting editability applied to
-it. Typically the result of the <link
-linkend="method-gtktextview--get-editable"><methodname>gtk.TextView.get_editable</methodname>()</link>
-method is appropriate here.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--insert-interactive-at-cursor">
- <title>gtk.TextBuffer.insert_interactive_at_cursor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_interactive_at_cursor</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>text in UTF-8 format</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">default_editable</parameter>&nbsp;:</term>
- <listitem><simpara>default editability of
-buffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the text was
-actually inserted</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_interactive_at_cursor</methodname>()
-method calls the <link
-linkend="method-gtktextbuffer--insert-interactive"><methodname>insert_interactive</methodname>()</link>
-method to insert <parameter>text</parameter> at the cursor (insert)
-position. <parameter>default_editable</parameter> indicates the editability
-of text that doesn't have a tag affecting editability applied to it.
-Typically the result of the <link
-linkend="method-gtktextview--get-editable"><methodname>gtk.TextView.get_editable</methodname>()</link>
-method is appropriate here.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--insert-range">
- <title>gtk.TextBuffer.insert_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_range</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying a position in the
-textbuffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying a position in a (possibly different) <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying another position in the same buffer as
-<parameter>start</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_range</methodname>() method copies text,
-tags, and pixbufs (but not child anchors) between
-<parameter>start</parameter> and <parameter>end</parameter> (the order of
-<parameter>start</parameter> and <parameter>end</parameter> doesn't matter)
-form a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-and inserts the copy at <parameter>iter</parameter>. Used instead of simply
-getting/inserting text because it preserves images and tags. If
-<parameter>start</parameter> and <parameter>end</parameter> are in a
-different buffer from <parameter>buffer</parameter>, the two buffers must
-share the same tag table. This method is implemented via emissions of the
-"insert_text" and "apply_tag" signals.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--insert-range-interactive">
- <title>gtk.TextBuffer.insert_range_interactive</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_range_interactive</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying a position in the
-textbuffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying a position in a (possibly different) <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying another position in the same buffer as
-<parameter>start</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">default_editable</parameter>&nbsp;:</term>
- <listitem><simpara>default editability of the
-buffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if an insertion was
-possible at <parameter>iter</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_range_interactive</methodname>() method
-is similar to the <link
-linkend="method-gtktextbuffer--insert-range"><methodname>insert_range</methodname>()</link>
-method, except the insertion of <parameter>text</parameter> at
-<parameter>iter</parameter> will not occur if the insertion position is
-non-editable. A location is non-editable if a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> applied
-at that location has its "editable" attribute set to
-<literal>False</literal> or the <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link> used
-by the user is set non-editable. The <parameter>default_editable</parameter>
-parameter indicates whether the text is editable at
-<parameter>iter</parameter> if no tags enclosing <parameter>iter</parameter>
-affect editability. Typically the result of the <link
-linkend="method-gtktextview--get-editable"><methodname>gtk.TextView.get_editable</methodname>()</link>
-method is appropriate here.</para>
-
- </refsect2>
-
-
- <refsect2 id="method-gtktextbuffer--insert-with-tags">
- <title>gtk.TextBuffer.insert_with_tags</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_with_tags</methodname>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying a position in <parameter>buffer</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>UTF-8 text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>one or more optional <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> objects
-to apply to <parameter>text</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_with_tags</methodname>() method inserts
-the specified <parameter>text</parameter> into the textbuffer at the
-location specified by <parameter>iter</parameter>, applying any optional
-tags following the first two parameters to the newly-inserted text. This
-method is a convenience method that is equivalent to calling the <link
-linkend="method-gtktextbuffer--insert"><methodname>insert</methodname>()</link>
-method, then the <link
-linkend="method-gtktextbuffer--apply-tag"><methodname>apply_tag</methodname>()</link>
-method on the inserted text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--insert-with-tags-by-name">
- <title>gtk.TextBuffer.insert_with_tags_by_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_with_tags_by_name</methodname>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying a position in <parameter>buffer</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>UTF-8 text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>one or more optional <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> names
-to apply to <parameter>text</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_with_tags_by_name</methodname>() method
-is similar to the <link
-linkend="method-gtktextbuffer--insert-with-tags"><methodname>insert_with_tags</methodname>()</link>
-method, but uses tag names instead of tag objects.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--delete">
- <title>gtk.TextBuffer.delete</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>delete</methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying a position in the textbuffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying another position in the textbuffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>delete</methodname>() method deletes the text
-between <parameter>start</parameter> and <parameter>end</parameter>. The
-order of <parameter>start</parameter> and <parameter>end</parameter> is not
-actually relevant as the <methodname>delete</methodname>() method will
-reorder them. This method emits the "delete_range" signal, and the default
-handler of that signal deletes the text. Because the textbuffer is modified,
-all outstanding iterators become invalid after calling this function;
-however, <parameter>start</parameter> and <parameter>end</parameter> will be
-re-initialized to point to the location where text was deleted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--delete-interactive">
- <title>gtk.TextBuffer.delete_interactive</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>delete_interactive</methodname>
- <methodparam><parameter
- role="keyword">start_iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end_iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">start_iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the start of the text to delete</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the end of the text to delete</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">default_editable</parameter>&nbsp;:</term>
- <listitem><simpara>whether the buffer is editable by
-default</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if some text was
-actually deleted</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>delete_interactive</methodname>() method deletes
-all <emphasis>editable</emphasis> text in the given range. This method calls
-the <link
-linkend="method-gtktextbuffer--delete"><methodname>delete</methodname>()</link>
-method for each editable sub-range of
-[<parameter>start</parameter>,<parameter>end</parameter>).
-<parameter>start</parameter> and <parameter>end</parameter> are revalidated
-to point to the location of the last deleted range, or left untouched if no
-text was deleted. A range of <parameter>text</parameter> is non-editable if
-a <link linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
-applied to that range has its "editable" attribute set to
-<literal>False</literal> or the <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link> used
-by the user is set non-editable. The <parameter>default_editable</parameter>
-parameter indicates whether <parameter>text</parameter> is editable if no
-tags enclosing any part of <parameter>text</parameter> affect editability.
-Typically the result of the <link
-linkend="method-gtktextview--get-editable"><methodname>gtk.TextView.get_editable</methodname>()</link>
-method is appropriate here.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-text">
- <title>gtk.TextBuffer.get_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text</methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- <methodparam><parameter
- role="keyword">include_hidden_chars</parameter>
- <initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the start of a range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the end of a range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">include_hidden_chars</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> include invisible
-text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the text in the range</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_text</methodname>() method returns the text
-in the specified range
-[<parameter>start</parameter>,<parameter>end</parameter>). Undisplayed text
-(text marked with tags that set the invisibility attribute) are excluded if
-<parameter>include_hidden_chars</parameter> is <literal>False</literal>.
-<methodname>get_text</methodname>() does not return characters representing
-embedded images, so byte and character indexes into the returned string do
-<emphasis>not</emphasis> correspond to byte and character indexes into the
-buffer. Contrast this behavior with the <link
-linkend="method-gtktextbuffer--get-slice"><methodname>get_slice</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-slice">
- <title>gtk.TextBuffer.get_slice</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_slice</methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- <methodparam><parameter
- role="keyword">include_hidden_chars</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the start of a range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the end of a range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">include_hidden_chars</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> include invisible
-text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the contents of the range including text and
-indicators for pixbufs and child anchors</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_slice</methodname>() method returns the text
-in the range [<parameter>start</parameter>,<parameter>end</parameter>).
-Undisplayed text (text marked with tags that set the invisibility attribute)
-is excluded if <parameter>include_hidden_chars</parameter> is
-<literal>False</literal>. The returned string includes a 0xFFFC character
-whenever the textbuffer contains embedded images or child anchors, so byte
-and character indexes into the returned string <emphasis>do</emphasis>
-correspond to byte and character indexes into the buffer. Contrast this
-behavior with the <link
-linkend="method-gtktextbuffer--get-text"><methodname>get_text</methodname>()</link>
-method. Note that 0xFFFC can occur in normal text as well, so it is not a
-reliable indicator that a pixbuf or widget is in the buffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--insert-pixbuf">
- <title>gtk.TextBuffer.insert_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_pixbuf</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the location to insert the pixbuf</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_pixbuf</methodname>() method inserts an
-image specified by <parameter>pixbuf</parameter> into the text buffer at the
-location specified by <parameter>iter</parameter>. The image will be counted
-as one character in character counts, and when obtaining the buffer contents
-as a string, will be represented by the Unicode "object replacement
-character" 0xFFFC. Note that the "slice" variants for obtaining portions of
-the buffer as a string include this character for pixbufs, but the "text"
-variants do not. e.g. see the <link
-linkend="method-gtktextbuffer--get-slice"><methodname>get_slice</methodname>()</link>
-and <link
-linkend="method-gtktextbuffer--get-text"><methodname>get_text</methodname>()</link>
-methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--insert-child-anchor">
- <title>gtk.TextBuffer.insert_child_anchor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_child_anchor</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anchor</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the location to insert the anchor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">anchor</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_child_anchor</methodname>() method
-inserts a child widget anchor specified by <parameter>anchor</parameter>
-into the textbuffer at the location specified by
-<parameter>iter</parameter>. The anchor will be counted as one character in
-character counts, and when obtaining the buffer contents as a string, will
-be represented by the Unicode "object replacement character" 0xFFFC. Note
-that the "slice" variants for obtaining portions of the buffer as a string
-include this character for child anchors, but the "text" variants do not.
-e.g. see the <link
-linkend="method-gtktextbuffer--get-slice"><methodname>get_slice</methodname>()</link>
-and <link
-linkend="method-gtktextbuffer--get-text"><methodname>get_text</methodname>()</link>
-methods. The <link
-linkend="method-gtktextbuffer--create-child-anchor"><methodname>create_child_anchor</methodname>()</link>
-is a more convenient alternative to this function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--create-child-anchor">
- <title>gtk.TextBuffer.create_child_anchor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_child_anchor</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying a location in the buffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new child anchor</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>create_child_anchor</methodname>() method is a
-convenience function that creates a child anchor with the <link
-linkend="constructor-gtktextchildanchor">gtk.TextChildAnchor</link>()
-constructor and inserts it into the textbuffer at the location specified by
-<parameter>iter</parameter> with the <link
-linkend="method-gtktextbuffer--insert-child-anchor"><methodname>insert_child_anchor</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--create-mark">
- <title>gtk.TextBuffer.create_mark</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_mark</methodname>
- <methodparam><parameter
- role="keyword">mark_name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">where</parameter></methodparam>
- <methodparam><parameter
- role="keyword">left_gravity</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">mark_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name for the new mark, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">where</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the location to place the mark</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">left_gravity</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the mark has left
-gravity</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>create_mark</methodname>() method creates a mark
-with the name specified by <parameter>mark_name</parameter> at the position
-specified by <parameter>where</parameter> and left gravity specified by
-<parameter>left_gravity</parameter>. If <parameter>mark_name</parameter> is
-<literal>None</literal>, the mark is anonymous; otherwise, the mark can be
-retrieved by name using the <link
-linkend="method-gtktextbuffer--get-mark"><methodname>get_mark</methodname>()</link>
-method. If a mark has left gravity, and text is inserted at the mark's
-current location, the mark will be moved to the left of the newly-inserted
-text. If the mark has right gravity (<parameter>left_gravity</parameter> =
-<literal>False</literal>), the mark will end up on the right of
-newly-inserted text. The standard left-to-right cursor is a mark with right
-gravity (when you type, the cursor stays on the right side of the text
-you're typing). Marks are owned by the buffer and go away when the buffer
-does. This method emits the "mark_set" signal as notification of the mark's
-initial placement.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--move-mark">
- <title>gtk.TextBuffer.move_mark</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_mark</methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- <methodparam><parameter
- role="keyword">where</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mark</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">where</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying a new location for <parameter>mark</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>move_mark</methodname>() method moves the <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-specified by <parameter>mark</parameter> to the new location specified by
-<parameter>where</parameter>.This method emits the "mark_set" signal as
-notification of the move.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--delete-mark">
- <title>gtk.TextBuffer.delete_mark</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>delete_mark</methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mark</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link> in
-the textbuffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>delete_mark</methodname>() method deletes the
-<link linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-specified by <parameter>mark</parameter>, so that it's no longer located
-anywhere in the textbuffer. Most operations on <parameter>mark</parameter>
-become invalid and there is no way to undelete a mark. The <link
-linkend="method-gtktextmark--get-deleted"><methodname>get_deleted</methodname>()</link>
-method will return <literal>True</literal> after this method has been called
-on a mark to indicate that a mark no longer belongs to a textbuffer. The
-"mark_deleted" signal will be emitted as notification after the mark is
-deleted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-mark">
- <title>gtk.TextBuffer.get_mark</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_mark</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a mark name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>, or
-None</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The get_mark() method returns the mark named
-<parameter>name</parameter> in the textbuffer, or <literal>None</literal> if
-no such mark exists in the buffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--move-mark-by-name">
- <title>gtk.TextBuffer.move_mark_by_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_mark_by_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">where</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a mark</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">where</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the new location for mark</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>move_mark_by_name</methodname>() method moves
-the mark named <parameter>name</parameter> (which must exist) to the
-textbuffer location specified by <parameter>where</parameter>. See the <link
-linkend="method-gtktextbuffer--move-mark"><methodname>move_mark</methodname>()</link>
-method for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--delete-mark-by-name">
- <title>gtk.TextBuffer.delete_mark_by_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>delete_mark_by_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a mark in
-<parameter>buffer</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>delete_mark_by_name</methodname>() method
-deletes the mark (which must exist) named <parameter>name</parameter>. See
-the <link
-linkend="method-gtktextbuffer--delete-mark"><methodname>delete_mark</methodname>()</link>
-for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-insert">
- <title>gtk.TextBuffer.get_insert</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_insert</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the insertion point mark</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_insert</methodname>() method returns the
-mark that represents the cursor (insertion point). Equivalent to calling the
-<link
-linkend="method-gtktextbuffer--get-mark"><methodname>get_mark</methodname>()</link>
-method to get the mark named "insert", but very slightly more efficient, and
-involving less typing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-selection-bound">
- <title>gtk.TextBuffer.get_selection_bound</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selection_bound</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the selection bound mark</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_selection_bound</methodname>() method
-returns the mark that represents the selection bound. Equivalent to calling
-the <link
-linkend="method-gtktextbuffer--get-mark"><methodname>get_mark</methodname>()</link>
-method to get the mark named "selection_bound", but very slightly more
-efficient, and involving less typing. The currently-selected text in a
-textbuffer is the region between the "selection_bound" and "insert" marks.
-If "selection_bound" and "insert" are in the same place, then there is no
-current selection. The <link
-linkend="method-gtktextbuffer--get-selection-bounds"><methodname>get_selection_bounds</methodname>()</link>
-method is a convenience method for handling the selection, if you just
-want to know whether there's a selection and what its bounds are.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--place-cursor">
- <title>gtk.TextBuffer.place_cursor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>place_cursor</methodname>
- <methodparam><parameter
- role="keyword">where</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">where</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying where to put the cursor</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>place_cursor</methodname>() method moves the
-"insert" and "selection_bound" marks simultaneously to the location
-specified by <parameter>where</parameter>. If you move them to the same
-place in two steps with the <link
-linkend="method-gtktextbuffer--move-mark"><methodname>move_mark</methodname>()</link>
-method, you will temporarily select a region in between their old and new
-locations, which is inefficient. This method moves them as a unit, which can
-be optimized.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--select-range">
- <title>gtk.TextBuffer.select_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_range</methodname>
- <methodparam><parameter
- role="keyword">ins</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bound</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">ins</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying where to put the "insert" mark</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">bound</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying where to put the "selection_bound" mark</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>select_range</methodname>() method moves the
-"insert" and "selection_bound" marks simultaneously to the locations
-specified by <parameter>ins</parameter> and <parameter>bound</parameter>
-respectively. If you move them to the same place in two steps with the
-<link
-linkend="method-gtktextbuffer--move-mark"><methodname>move_mark</methodname>()</link>
-method, you will temporarily select a region in between their old and new
-locations, which is inefficient. This method moves them as a unit, which can
-be optimized.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--apply-tag">
- <title>gtk.TextBuffer.apply_tag</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>apply_tag</methodname>
- <methodparam><parameter
- role="keyword">tag</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the start of the range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the end of the range</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>apply_tag</methodname>() method emits the
-"apply-tag" signal that causes the <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
-specified by <parameter>tag</parameter> to be applied to the range of text
-between <parameter>start</parameter> and <parameter>end</parameter> by the
-default signal handler. <parameter>start</parameter> and
-<parameter>end</parameter> do not have to be in order.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--remove-tag">
- <title>gtk.TextBuffer.remove_tag</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_tag</methodname>
- <methodparam><parameter
- role="keyword">tag</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the start of the range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the end of the range</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>delete_tag</methodname>() method emits the
-"remove_tag" signal that causes the default handler for the signal to remove
-all occurrences of the <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
-specified by <parameter>tag</parameter> from the text in the range between
-<parameter>start</parameter> and <parameter>end</parameter>.
-<parameter>start</parameter> and <parameter>end</parameter> don't have to be
-in order.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--apply-tag-by-name">
- <title>gtk.TextBuffer.apply_tag_by_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>apply_tag_by_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the start of the range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the end of the range</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>apply_tag_by_name</methodname>() method calls
-the <link
-linkend="method-gtktexttagtable--lookup"><methodname>gtk.TextTagTable.lookup</methodname>()</link>
-method on the textbuffer's tag table to find the <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> with
-the specified <parameter>name</parameter>, then calls the <link
-linkend="method-gtktextbuffer--apply-tag"><methodname>apply_tag</methodname>()</link>
-method to apply that tag to the text in the range between
-<parameter>start</parameter> and <parameter>end</parameter>.
-<parameter>start</parameter> and <parameter>end</parameter> don't have to be
-in order.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--remove-tag-by-name">
- <title>gtk.TextBuffer.remove_tag_by_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_tag_by_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the start of the range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the end of the range</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>delete_tag_by_name</methodname>() method calls
-the <link
-linkend="method-gtktexttagtable--lookup"><methodname>gtk.TextTagTable.lookup</methodname>()</link>
-method on the textbuffer's tag table to find the <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>, then
-calls the <link
-linkend="method-gtktextbuffer--remove-tag"><methodname>remove_tag</methodname>()</link>
-method to remove that that tag from the text in the range between
-<parameter>start</parameter> and <parameter>end</parameter>.
-<parameter>start</parameter> and <parameter>end</parameter> don't have to be
-in order.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--remove-all-tags">
- <title>gtk.TextBuffer.remove_all_tags</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_all_tags</methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the start of the range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specifying the end of the range</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove_all_tags</methodname>() method removes
-all tags in the text in the range between <parameter>start</parameter> and
-<parameter>end</parameter>. Be careful with this function; it could remove
-tags added in code unrelated to the code you're currently writing. That is,
-using this function is probably a bad idea if you have two or more unrelated
-code sections that add tags. <parameter>start</parameter> and
-<parameter>end</parameter> don't have to be in order.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--create-tag">
- <title>gtk.TextBuffer.create_tag</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_tag</methodname>
- <methodparam><parameter>tag_name</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>tag_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the new tag, or
-<literal>None</literal> if the tag is anonymous</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>one or more property_name= value pairs
-</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new tag</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>create_tag</methodname>() method creates a tag
-with the name specified by <parameter>tag_name</parameter> and adds it to
-the tag table for the textbuffer. If one or more
-<literal>property_name=value</literal> pairs are available they are used to
-set the properties of the tag. Note the <literal>property_name</literal>
-must be specified using underscores instead of dashes e.g. use
-pixels_above_lines=10 instead of pixels-above-lines=10. This method is
-equivalent to calling the <link
-linkend="constructor-gtktexttag">gtk.TextTag</link>() constructor and then
-adding the tag to the buffer's tag table with the <link
-linkend="method-gtktexttagtable--add"><methodname>gtk.TextTagTable.add</methodname>()</link>
-method. If <parameter>tag_name</parameter> is <literal>None</literal>, the
-tag is anonymous. If <parameter>tag_name</parameter> is
-non-<literal>None</literal>, a tag called <parameter>tag_name</parameter>
-must not already exist in the tag table for this buffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-iter-at-line-offset">
- <title>gtk.TextBuffer.get_iter_at_line_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_at_line_offset</methodname>
- <methodparam><parameter
- role="keyword">line_number</parameter></methodparam>
- <methodparam><parameter
- role="keyword">char_offset</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">line_number</parameter>&nbsp;:</term>
- <listitem><simpara>the line number counting from
-0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">char_offset</parameter>&nbsp;:</term>
- <listitem><simpara>the char offset from start of
-line</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The<methodname> get_iter_at_line_offset</methodname>() returns
-an iterator pointing to the position specified by
-<parameter>char_offset</parameter> within the line specified by
-<parameter>line_number</parameter>. The <parameter>char_offset</parameter>
-must exist, offsets off the end of the line are not allowed. Note specify
-<emphasis>characters</emphasis>, not bytes; UTF-8 may encode one character
-as multiple bytes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-iter-at-line-index">
- <title>gtk.TextBuffer.get_iter_at_line_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_at_line_index</methodname>
- <methodparam><parameter
- role="keyword">line_number</parameter></methodparam>
- <methodparam><parameter
- role="keyword">byte_index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">line_number</parameter>&nbsp;:</term>
- <listitem><simpara>the line number counting from
-0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">byte_index</parameter>&nbsp;:</term>
- <listitem><simpara>the byte index from start of
-line</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter_at_line_index</methodname>() method
-returns an iterator pointing to the position specified by
-<parameter>byte_index</parameter> within the line specified by
-<parameter>line_number</parameter>. <parameter>byte_index</parameter> must
-be the start of a UTF-8 character, and must not be beyond the end of the
-line. Note specify <emphasis>bytes</emphasis>, not characters; UTF-8 may
-encode one character as multiple bytes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-iter-at-offset">
- <title>gtk.TextBuffer.get_iter_at_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_at_offset</methodname>
- <methodparam><parameter
- role="keyword">char_offset</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">char_offset</parameter>&nbsp;:</term>
- <listitem><simpara>the char offset from start of buffer, counting
-from 0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter_at_offset</methodname>() method returns
-an iterator pointing to the location specified by
-<parameter>char_offset</parameter> characters from the start of the entire
-buffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-iter-at-line">
- <title>gtk.TextBuffer.get_iter_at_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_at_line</methodname>
- <methodparam><parameter
- role="keyword">line_number</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">line_number</parameter>&nbsp;:</term>
- <listitem><simpara>line number counting from
-0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter_at_line</methodname>() method returns
-an iterator pointing to the start of the line specified by
-<parameter>line_number</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-start-iter">
- <title>gtk.TextBuffer.get_start_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_start_iter</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_start_iter</methodname>() method returns an
-iterator pointing at the location of the first position in the text buffer.
-This is the same as using the <link
-linkend="method-gtktextbuffer--get-iter-at-offset"><methodname>get_iter_at_offset</methodname>()</link>
-with an argument of 0.
-</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-end-iter">
- <title>gtk.TextBuffer.get_end_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_end_iter</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_end_iter</methodname>() method returns an
-iterator pointing at the "end iterator," one past the last valid character
-in the text buffer. If passed to the <link
-linkend="method-gtktextiter--get-char"><methodname>gtk.TextIter.get_char</methodname>()</link>
-method, the end iterator has a character value of 0. The entire buffer lies
-in the range from the first position in the buffer (call the <link
-linkend="method-gtktextbuffer--get-start-iter"><methodname>get_start_iter</methodname>()</link>
-method to get character position 0) to the end iterator.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-bounds">
- <title>gtk.TextBuffer.get_bounds</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_bounds</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link> objects
-that point at the first and last positions in the buffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_bounds</methodname>() method returns a tuple
-containing the first and last iterators in the buffer, i.e. the entire
-buffer lies within the range.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-iter-at-mark">
- <title>gtk.TextBuffer.get_iter_at_mark</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_at_mark</methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mark</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link> in
-the textbuffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter_at_mark</methodname>() method returns
-an iterator that points at the current position of
-<parameter>mark</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-iter-at-child-anchor">
- <title>gtk.TextBuffer.get_iter_at_child_anchor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_at_child_anchor</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anchor</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">anchor</parameter>&nbsp;:</term>
- <listitem><simpara>a child anchor that appears in the
-textbuffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter_at_child_anchor</methodname>() method
-returns an iterator that points at the location of
-<parameter>anchor</parameter> within the textbuffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-modified">
- <title>gtk.TextBuffer.get_modified</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_modified</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the buffer has been
-modified</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_modified</methodname>() method returns
-<literal>True</literal> if the buffer has been modified since the last call
-to the <link
-linkend="method-gtktextbuffer--set-modified"><methodname>set_modified</methodname>()</link>
-method set the modification flag to <literal>False</literal>. Used for
-example to enable a "save" function in a text editor.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--set-modified">
- <title>gtk.TextBuffer.set_modified</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_modified</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>the modification flag
-setting</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_modified</methodname>() method sets the
-modification flag of the textbuffer to the value specified by
-<parameter>setting</parameter>. The modification flag is used to keep track
-of whether the buffer has been modified since the last time it was saved.
-Whenever the buffer is saved to disk, call this method with a
-<parameter>setting</parameter> of <literal>False</literal>. When the buffer
-is modified, it will automatically set the modification flag to
-<parameter>True</parameter> and emit a "modified_changed" signal.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--add-selection-clipboard">
- <title>gtk.TextBuffer.add_selection_clipboard</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_selection_clipboard</methodname>
- <methodparam><parameter role="keyword">clipboard</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">clipboard</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>add_selection_clipboard</methodname>() method
-adds the <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
-specified by <parameter>clipboard</parameter> to the list of clipboards in
-which the selection contents of the buffer are available. In most cases,
-<parameter>clipboard</parameter> will be the
-<literal>gtk.gdk.SELECTION_PRIMARY</literal> clipboard</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--remove-selection-clipboard">
- <title>gtk.TextBuffer.remove_selection_clipboard</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_selection_clipboard</methodname>
- <methodparam><parameter role="keyword">clipboard</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">clipboard</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
- added to the buffer by the <link
- linkend="method-gtktextbuffer--add-selection-clipboard"><methodname>add_selection_clipboard()</methodname></link>
- method.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>remove_selection_clipboard</methodname>() method
-removes the <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
-added with the <link
-linkend="method-gtktextbuffer--add-selection-clipboard"><methodname>add_selection_clipboard</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--cut-clipboard">
- <title>gtk.TextBuffer.cut_clipboard</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>cut_clipboard</methodname>
- <methodparam><parameter role="keyword">clipboard</parameter></methodparam>
- <methodparam><parameter role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">clipboard</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
- object to cut to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">default_editable</parameter>&nbsp;:</term>
- <listitem><simpara>the default editability of the
- buffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>cut_clipboard</methodname>() method copies the
-currently-selected text to the <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
-specified by <parameter>clipboard</parameter>, then deletes said text if
-it's editable as specified by
-<parameter>default_editable</parameter>. Typically the result of the <link
-linkend="method-gtktextview--get-editable"><methodname>gtk.TextView.get_editable</methodname>()</link>
-method is appropriate here.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--copy-clipboard">
- <title>gtk.TextBuffer.copy_clipboard</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy_clipboard</methodname>
- <methodparam><parameter role="keyword">clipboard</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">clipboard</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
- object to copy to.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>copy_clipboard</methodname>() method copies the
-currently-selected text to the <link
-linkend="class-gtkclipboard"><classname>gtk.ClipBoard</classname></link>
-specified by <parameter>clipboard</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--paste-clipboard">
- <title>gtk.TextBuffer.paste_clipboard</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>paste_clipboard</methodname>
- <methodparam><parameter role="keyword">clipboard</parameter></methodparam>
- <methodparam><parameter role="keyword">override_location</parameter></methodparam>
- <methodparam><parameter role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">clipboard</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
- to paste from</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">override_location</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
- specifying the location to insert pasted text, or
- <literal>None</literal> for at the cursor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">default_editable</parameter>&nbsp;:</term>
- <listitem><simpara>the default editability of the
- buffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>paste_clipboard</methodname>() method pastes the
-contents of the <link
-linkend="class-gtkclipboard"><classname>gtk.ClipBoard</classname></link>
-specified by <parameter>clipboard</parameter> at the insertion point, or at
-the location specified by <parameter>override_location</parameter> (if not
-<literal>None</literal>). (Note: pasting is asynchronous, that is, we'll
-ask for the paste data and return, and at some point later after the main
-loop runs, the paste data will be inserted.)</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-selection-bounds">
- <title>gtk.TextBuffer.get_selection_bounds</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selection_bounds</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link> objects pointing to the selection start and end or an empty tuple if there is no
-selection</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_selection_bounds</methodname>() method
-returns a tuple containing iterators that point at the start and end of the
-selection, if any. If there is no selection an empty tuple is
-returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--delete-selection">
- <title>gtk.TextBuffer.delete_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>delete_selection</methodname>
- <methodparam><parameter
- role="keyword">interactive</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">interactive</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the deletion is
-caused by user interaction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">default_editable</parameter>&nbsp;:</term>
- <listitem><simpara>if <parameter>True</parameter> the buffer is
-editable by default</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if there was a
-non-empty selection to delete</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>delete_selection</methodname>() method deletes
-the text in the range between the "insert" and "selection_bound" marks, i.e.
-the currently-selected text. If <parameter>interactive</parameter> is
-<literal>True</literal>, the editability of the selection will be considered
-(users can't delete uneditable text) and default_editable is used to
-determine the default editability of the textbuffer usually as a result of a
-call to the <link
-linkend="method-gtktextview--get-editable"><methodname>gtk.TextView.get_editable</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--begin-user-action">
- <title>gtk.TextBuffer.begin_user_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>begin_user_action</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>begin_user_action</methodname>() method is
-called to indicate that the textbuffer operations until a call to the <link
-linkend="method-gtktextbuffer--end-user-action"><methodname>end_user_action</methodname>()</link>
-method are part of a single user-visible operation. The operations between
-the <methodname>begin_user_action</methodname>() and <link
-linkend="method-gtktextbuffer--end-user-action"><methodname>end_user_action</methodname>()</link>
-methods can then be grouped when creating an undo stack. <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-maintains a count of calls to the
-<methodname>begin_user_action</methodname>() method that have not been
-closed with a call to the <link
-linkend="method-gtktextbuffer--end-user-action"><methodname>end_user_action</methodname>()</link>
-method, and emits the "begin_user_action" and "end_user_action" signals only
-for the outermost pair of calls. This allows you to chain user
-actions.</para>
-
- <para>The "interactive" textbuffer mutation methods, such as the <link
-linkend="method-gtktextbuffer--insert-interactive"><methodname>insert_interactive</methodname>()</link>
-method, automatically call the begin and end user action methods around the
-textbuffer operations they perform, so there's no need to add extra calls if
-you user action consists solely of a single call to one of those
-methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--end-user-action">
- <title>gtk.TextBuffer.end_user_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>end_user_action</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>end_user_action</methodname>() method should be
-paired with a call to the <link
-linkend="method-gtktextbuffer--begin-user-action"><methodname>begin_user_action</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--backspace">
- <title>gtk.TextBuffer.backspace</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backspace</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">interactive</parameter></methodparam>
- <methodparam><parameter
- role="keyword">default_editable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">interactive</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the deletion is
-caused by user interaction</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">default_editable</parameter>&nbsp;:</term>
- <listitem><simpara>if <parameter>True</parameter> the buffer is
-editable by default</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the buffer was
-modified</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>backspace</methodname>() method performs the
-appropriate action as if the user hit the delete key with the cursor at the
-position specified by <parameter>iter</parameter>. In the normal case a
-single character will be deleted, but when combining accents are involved,
-more than one character can be deleted, and when precomposed character and
-accent combinations are involved, less than one character will be
-deleted.</para>
-
- <para>Because the buffer is modified, all outstanding iterators become
-invalid after calling this function; however, <parameter>iter</parameter>
-will be re-initialized to point to the location where text was
-deleted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-has-selection">
- <title>gtk.TextBuffer.get_has_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_has_selection</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if there is text
- selected</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Indicates whether the buffer has some text currently
- selected.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-copy-target-list">
- <title>gtk.TextBuffer.get_copy_target_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_copy_target_list</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the targets each represented as a
- 3-tuple containing the target name, a combination of the <xref
- linkend="gtk-target-flags-constants"
- endterm="gtk-target-flags-constants-title"></xref> and an
- application assigned integer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method returns the list of targets this text buffer can
- provide for copying and as DND source. The targets in the list are
- added with <literal>info</literal> values from the <xref
- linkend="gtk-textbuffer-target-info-constants"
- endterm="gtk-textbuffer-target-info-constants-title"></xref>, using
- the <link
- linkend="function-gtk--target-list-add-rich-text-targets"><function>gtk.target_list_add_rich_text_targets</function>()</link>
- and <link
- linkend="function-gtk--target-list-add-text-targets"><function>gtk.target_list_add_text_targets</function>()</link>
- functions.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-paste-target-list">
- <title>gtk.TextBuffer.get_paste_target_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_paste_target_list</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of the targets each represented as a
- 3-tuple containing the target name, a combination of the <xref
- linkend="gtk-target-flags-constants"
- endterm="gtk-target-flags-constants-title"></xref> and an
- application assigned integer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method returns the list of targets this text buffer supports
- for pasting and as DND destination. The targets in the list are
- added with <literal>info</literal> values from the <xref
- linkend="gtk-textbuffer-target-info-constants"
- endterm="gtk-textbuffer-target-info-constants-title"></xref>, using
- the <link
- linkend="function-gtk--target-list-add-rich-text-targets"><function>gtk.target_list_add_rich_text_targets</function>()</link>
- and <link
- linkend="function-gtk--target-list-add-text-targets"><function>gtk.target_list_add_text_targets</function>()</link>
- functions.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--register-serialize-format">
- <title>gtk.TextBuffer.register_serialize_format</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>register_serialize_format</methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mime_type</parameter>&nbsp;:</term>
- <listitem><simpara>the format's mime-type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">function</parameter>&nbsp;:</term>
- <listitem><simpara>the serialize function to register</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara><literal>function</literal>'s user_data</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the newly registered format's
- mime-type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method registers a rich text serialization
- <literal>function</literal> along with its
- <literal>mime_type</literal> with the passed
- <literal>buffer</literal>.</para>
-
- <para>The signature of function is:</para>
-
- <programlisting>
- def function(register_buf, content_buf, start, end, data):
- </programlisting>
-
- <para>where <parameter>register_buf</parameter> is the textbuffer that
- the format is registered with, <parameter>content_buf</parameter> is
- the textbuffer containing the text to be serialized,
- <parameter>start</parameter> and <parameter>end</parameter> are
- textiters bounding the text to be serialized and
- <parameter>data</parameter> is
- <parameter>user_data</parameter>. <parameter>function</parameter>
- should return the serialized data.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--register-serialize-tagset">
- <title>gtk.TextBuffer.register_serialize_tagset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>register_serialize_tagset</methodname>
- <methodparam><parameter role="keyword">tagset_name</parameter><initializer>NULL</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tagset_name</parameter>&nbsp;:</term>
- <listitem><simpara>an optional tagset name, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the newly registered format's
- mime-type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method registers GTK+'s internal rich text serialization
- format with this textbuffer. The internal format does not comply to
- any standard rich text format and only works between <link
- linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
- instances. It is capable of serializing all of a text buffer's tags
- and embedded pixbufs.</para>
-
- <para>This method is just a wrapper around <link
- linkend="method-gtktextbuffer--register-serialize-format"><methodname>gtk.TextBuffer.register_serialize_format()</methodname></link>. The
- <literal>mime_type</literal> used for registering is
- "application/x-gtk-text-buffer-rich-text", or
- "application/x-gtk-text-buffer-rich-text;format=<literal>tagset_name</literal>"
- if a <literal>tagset_name</literal> was passed.</para>
-
- <para>The <literal>tagset_name</literal> can be used to restrict the
- transfer of rich text to buffers with compatible sets of tags, in
- order to avoid unknown tags from being pasted. It is probably the
- common case to pass a non-<literal>None</literal> tagset here,
- since the <literal>None</literal> tagset requires the receiving buffer
- to deal with with pasting of arbitrary tags.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--register-deserialize-format">
- <title>gtk.TextBuffer.register_deserialize_format</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>register_deserialize_format</methodname>
- <methodparam><parameter role="keyword">mime_type</parameter></methodparam>
- <methodparam><parameter role="keyword">function</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mime_type</parameter>&nbsp;:</term>
- <listitem><simpara>the format's mime-type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">function</parameter>&nbsp;:</term>
- <listitem><simpara>the deserialize function to register</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara><literal>function</literal>'s user_data</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the newly registered format's
- mime-type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method registers a rich text deserialization
- <literal>function</literal> along with its
- <literal>mime_type</literal> with the passed
- <literal>buffer</literal>.</para>
-
- <para>The signature of function is:</para>
-
- <programlisting>
- def function(register_buf, content_buf, iter, data, create_tags, udata):
- </programlisting>
-
- <para>where <parameter>register_buf</parameter> is the textbuffer that
- the format is registered with, <parameter>content_buf</parameter> is
- the textbuffer that data will be deserialized into,
- <parameter>iter</parameter> is a textiter indicating the start of the
- deserialized data in <parameter>content_buf</parameter>, create_tags
- is a boolean indicating if tags should be created during
- deserializtion and <parameter>udata</parameter> is
- <parameter>user_data</parameter>. <parameter>function</parameter>
- should return <literal>True</literal> if the data was successfully
- deserialized.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--register-deserialize-tagset">
- <title>gtk.TextBuffer.register_deserialize_tagset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>register_deserialize_tagset</methodname>
- <methodparam><parameter role="keyword">tagset_name</parameter><initializer>NULL</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tagset_name</parameter>&nbsp;:</term>
- <listitem><simpara>an optional tagset name, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the newly registered format's
- mime-type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method registers GTK+'s internal rich text serialization
- format with this buffer. See the <link
- linkend="method-gtktextbuffer--register-serialize-tagset"><methodname>gtk.TextBuffer.register_serialize_tagset()</methodname></link>
- method for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--unregister-serialize-format">
- <title>gtk.TextBuffer.unregister_serialize_format</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unregister_serialize_format</methodname>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">format</parameter>&nbsp;:</term>
- <listitem><simpara>a target string representing a registered rich
- text format.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method unregisters a rich text format that was previously
- registered using the <link
- linkend="method-gtktextbuffer--register-serialize-format"><methodname>gtk.TextBuffer.register_serialize_format()</methodname></link>
- or <link
- linkend="method-gtktextbuffer--register-serialize-tagset"><methodname>gtk.TextBuffer.register_serialize_tagset()</methodname></link>
- methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--unregister-deserialize-format">
- <title>gtk.TextBuffer.unregister_deserialize_format</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unregister_deserialize_format</methodname>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">format</parameter>&nbsp;:</term>
- <listitem><simpara>a target string representing a registered rich
- text format.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method unregisters a rich text format that was previously
- registered using the <link
- linkend="method-gtktextbuffer--register-deserialize-format"><methodname>gtk.TextBuffer.register_deserialize_format()</methodname></link>
- or <link
- linkend="method-gtktextbuffer--register-deserialize-tagset"><methodname>gtk.TextBuffer.register_deserialize_tagset()</methodname></link>
- methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--deserialize-set-can-create-tags">
- <title>gtk.TextBuffer.deserialize_set_can_create_tags</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>deserialize_set_can_create_tags</methodname>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- <methodparam><parameter role="keyword">can_create_tags</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">format</parameter>&nbsp;:</term>
- <listitem><simpara>a target string representing a registered rich
- text format</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">can_create_tags</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> deserializing
- <parameter>format</parameter> may create tags</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Use this method to allow a rich text deserialization function to
- create new tags in the receiving buffer. Note that using this method
- is almost always a bad idea, because the rich text functions you
- register should know how to map the rich text format they handle to
- your text buffers set of tags.</para>
-
- <para>The ability of creating new (arbitrary!) tags in the receiving
- buffer is meant for special rich text formats like the internal one
- that is registered using <link
- linkend="method-gtktextbuffer--register-deserialize-tagset"><methodname>gtk.TextBuffer.register_deserialize_tagset()</methodname></link>,
- because that format is essentially a dump of the internal structure of
- the source buffer, including its tag names.</para>
-
- <para>You should allow creation of tags only if you know what you are
- doing, e.g. if you defined a tagset name for your application suite's
- text buffers and you know that it's fine to receive new tags from
- these buffers, because you know that your application can handle the
- newly created tags.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--deserialize-get-can-create-tags">
- <title>gtk.TextBuffer.deserialize_get_can_create_tags</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>deserialize_get_can_create_tags</methodname>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">format</parameter>&nbsp;:</term>
- <listitem><simpara>a target string representing a registered rich
- text format</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if deserializing
- <parameter>format</parameter> may create tags</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method returns the value set with the <link
- linkend="method-gtktextbuffer--deserialize-set-can-create-tags"><methodname>gtk.TextBuffer.deserialize_set_can_create_tags()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-serialize-formats">
- <title>gtk.TextBuffer.get_serialize_formats</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_serialize_formats</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of target strings representing the
- registered formats.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method returns a list of the rich text serialize formats
- registered using the <link
- linkend="method-gtktextbuffer--register-serialize-format"><methodname>gtk.TextBuffer.register_serialize_format()</methodname></link>
- or <link
- linkend="method-gtktextbuffer--register-serialize-tagset"><methodname>gtk.TextBuffer.register_serialize_tagset()</methodname></link>
- methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--get-deserialize-formats">
- <title>gtk.TextBuffer.get_deserialize_formats</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_deserialize_formats</methodname>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of target strings representing the
- registered formats.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method returns the rich text deserialize formats registered
- using the <link
- linkend="method-gtktextbuffer--register-deserialize-format"><methodname>gtk.TextBuffer.register_deserialize_format()</methodname></link>
- or <link
- linkend="method-gtktextbuffer--register-deserialize-tagset"><methodname>gtk.TextBuffer.register_deserialize_tagset()</methodname></link>
- methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--serialize">
- <title>gtk.TextBuffer.serialize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>serialize</methodname>
- <methodparam><parameter role="keyword">content_buffer</parameter></methodparam>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- <methodparam><parameter role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">content_buffer</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
- to serialize</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">format</parameter>&nbsp;:</term>
- <listitem><simpara>the rich text format to use for
- serializing</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>start of block of text to
- serialize</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>end of block of test to
- serialize</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the serialized data, encoded as
- <literal>format</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method serializes the portion of text between <literal>start</literal>
- and <literal>end</literal> in the rich text format represented by <literal>format</literal>.</para>
-
- <para>The formats to be used must be registered using the <link
- linkend="method-gtktextbuffer--register-serialize-format"><methodname>gtk.TextBuffer.register_serialize_format()</methodname></link>
- or <link
- linkend="method-gtktextbuffer--register-serialize-tagset"><methodname>gtk.TextBuffer.register_serialize_tagset()</methodname></link>
- methods beforehand.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextbuffer--deserialize">
- <title>gtk.TextBuffer.deserialize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>deserialize</methodname>
- <methodparam><parameter role="keyword">content_buffer</parameter></methodparam>
- <methodparam><parameter role="keyword">format</parameter></methodparam>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">content_buffer</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
- to deserialize into</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">format</parameter>&nbsp;:</term>
- <listitem><simpara>the rich text format to use for
- deserializing</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>insertion point for the deserialized
- text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>data to deserialize</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> on success,
- <literal>False</literal> otherwise.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>This method deserializes rich text in format
- <literal>format</literal> and inserts it at <literal>iter</literal> in
- <parameter>content_buffer</parameter>.</para>
-
- <para>The formats to be used must be registered using the <link
- linkend="method-gtktextbuffer--register-deserialize-format"><methodname>gtk.TextBuffer.register_deserialize_format()</methodname></link>
- or <link
- linkend="method-gtktextbuffer--register-deserialize-tagset"><methodname>gtk.TextBuffer.register_deserialize_tagset()</methodname></link>
- methods beforehand.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktextbuffer--apply-tag">
- <title>The "apply-tag" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>start</parameter></methodparam>
- <methodparam><parameter>end</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>texttag</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> being
-applied</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-pointing to the start of the range of text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-pointing to the end of the range of text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "apply-tag" signal is emitted when
-<parameter>texttag</parameter> is applied to the text in
-<parameter>textbuffer</parameter> in the range specified by
-<parameter>start</parameter> and <parameter>end</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextbuffer--begin-user-action">
- <title>The "begin-user-action" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "begin-user-action" signal is emitted on the first call to
-the <link
-linkend="method-gtktextbuffer--begin-user-action"><methodname>begin_user_action</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextbuffer--changed">
- <title>The "changed" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "changed" signal is emitted when text is inserted in
-<parameter>textbuffer</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextbuffer--delete-range">
- <title>The "delete-range" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>start</parameter></methodparam>
- <methodparam><parameter>end</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-pointing to the start of the range of text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-pointing to the end of the range of text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "delete-range" signal is emitted when the text in the range
-specified by <parameter>start</parameter> and <parameter>end</parameter> is
-to be deleted.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextbuffer--end-user-action">
- <title>The "end-user-action" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "end-user-action" signal is emitted when the call to the
-<link
-linkend="method-gtktextbuffer--end-user-action"><methodname>end_user_action</methodname>()</link>
-method reduces the user action count to zero i.e. undoes the first call to
-the <link
-linkend="method-gtktextbuffer--begin-user-action"><methodname>begin_user_action</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextbuffer--insert-child-anchor">
- <title>The "insert-child-anchor" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>anchor</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>anchor</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "insert-child-anchor" signal is emitted when
-<parameter>anchor</parameter> is inserted into
-<parameter>textbuffer</parameter> at the location specified by
-<parameter>iter</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextbuffer--insert-pixbuf">
- <title>The "insert-pixbuf" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>pixbuf</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "insert-pixbuf" signal is emitted when
-<parameter>pixbuf</parameter> is inserted into
-<parameter>textbuffer</parameter> at the location specified by
-<parameter>iter</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextbuffer--insert-text">
- <title>The "insert-text" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>text</parameter></methodparam>
- <methodparam><parameter>length</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>text</parameter>&nbsp;:</term>
- <listitem><simpara>the text inserted in
-<parameter>textbuffer</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>length</parameter>&nbsp;:</term>
- <listitem><simpara>the length of the text inserted in
-<parameter>textbuffer</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "insert-text" signal is emitted when
-<parameter>text</parameter> of the size specified by
-<parameter>length</parameter> is inserted into
-<parameter>textbuffer</parameter> at the location specified by
-<parameter>iter</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextbuffer--mark-deleted">
- <title>The "mark-deleted" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>textmark</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>textmark</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
- that is being deleted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "mark-deleted" signal is emitted when
-<parameter>textmark</parameter> is being deleted from
-<parameter>textbuffer</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextbuffer--mark-set">
- <title>The "mark-set" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-pointing at the location where <parameter>textmark</parameter> will be
-set.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>textmark</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
- that is being set</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "mark-set" signal is emitted when
-<parameter>textmark</parameter> is being set at the location specified by
-<parameter>iter</parameter> in <parameter>textbuffer</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextbuffer--modified-changed">
- <title>The "modified-changed" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "modified-changed" signal is emitted when the modification
-flag is changed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextbuffer--remove-tag">
- <title>The "remove-tag" gtk.TextBuffer Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textbuffer</parameter></methodparam>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>start</parameter></methodparam>
- <methodparam><parameter>end</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textbuffer</parameter>&nbsp;:</term>
- <listitem><simpara>the textbuffer that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>texttag</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> being
-removed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>start</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-pointing to the start of the range of text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>end</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
- pointing to the end of the range of text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "remove-tag" signal is emitted when
-<parameter>texttag</parameter> is being removed from the
-<parameter>textbuffer</parameter> text in the range specified by
-<parameter>start</parameter> and <parameter>end</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktextchildanchor.xml b/docs/reference/pygtk-gtktextchildanchor.xml
deleted file mode 100644
index 73e8086d..00000000
--- a/docs/reference/pygtk-gtktextchildanchor.xml
+++ /dev/null
@@ -1,142 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktextchildanchor">
- <refnamediv>
- <refname>gtk.TextChildAnchor</refname>
- <refpurpose>a location in a textbuffer for placing widgets</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TextChildAnchor</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktextchildanchor">gtk.TextChildAnchor</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextchildanchor--get-widgets">get_widgets</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextchildanchor--get-deleted">get_deleted</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtktextchildanchor">gtk.TextChildAnchor</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktextchildanchor">
- <title>gtk.TextChildAnchor Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>
-provides a location in a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-for placing child widgets in a <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.
-Since a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-can be associated with more than one <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link> a
-<link
-linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>
-can have a different child widget inserted for each textview it is displayed
-in.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktextchildanchor">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TextChildAnchor</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>.
-Usually you would then insert it into a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-with the <link
-linkend="method-gtktextbuffer--insert-child-anchor"><methodname>gtk.TextBuffer.insert_child_anchor</methodname>()</link>
-method. To perform the creation and insertion in one step, use the
-convenience method <link
-linkend="method-gtktextbuffer--create-child-anchor"><methodname>gtk.TextBuffer.create_child_anchor</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktextchildanchor--get-widgets">
- <title>gtk.TextChildAnchor.get_widgets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_widgets</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of widgets anchored at the child
-anchor</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_widgets</methodname>() method returns a list
-of all widgets anchored at this child anchor from all the associated
-textviews.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextchildanchor--get-deleted">
- <title>gtk.TextChildAnchor.get_deleted</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_deleted</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the child anchor has
-been deleted from its textbuffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_deleted</methodname>() method returns
-<literal>True</literal> if the child anchor has been deleted from its
-textbuffer.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktextiter.xml b/docs/reference/pygtk-gtktextiter.xml
deleted file mode 100644
index 004dcb32..00000000
--- a/docs/reference/pygtk-gtktextiter.xml
+++ /dev/null
@@ -1,3110 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktextiter">
- <refnamediv>
- <refname>gtk.TextIter</refname>
- <refpurpose>an object pointing at a location in a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TextIter</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-buffer">get_buffer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--copy">copy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-offset">get_offset</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-line">get_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-line-offset">get_line_offset</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-line-index">get_line_index</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-visible-line-offset">get_visible_line_offset</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-visible-line-index">get_visible_line_index</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-char">get_char</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-slice">get_slice</link></methodname>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-text">get_text</link></methodname>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-visible-slice">get_visible_slice</link></methodname>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-visible-text">get_visible_text</link></methodname>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-pixbuf">get_pixbuf</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-marks">get_marks</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-child-anchor">get_child_anchor</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-toggled-tags">get_toggled_tags</link></methodname>
- <methodparam><parameter
- role="keyword">toggled_on</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--begins-tag">begins_tag</link></methodname>
- <methodparam><parameter role="keyword">tag</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--ends-tag">ends_tag</link></methodname>
- <methodparam><parameter role="keyword">tag</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--toggles-tag">toggles_tag</link></methodname>
- <methodparam><parameter role="keyword">tag</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--has-tag">has_tag</link></methodname>
- <methodparam><parameter role="keyword">tag</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-tags">get_tags</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--editable">editable</link></methodname>
- <methodparam><parameter
- role="keyword">default_setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--can-insert">can_insert</link></methodname>
- <methodparam><parameter
- role="keyword">default_editability</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--starts-word">starts_word</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--ends-word">ends_word</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--inside-word">inside_word</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--starts-sentence">starts_sentence</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--ends-sentence">ends_sentence</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--inside-sentence">inside_sentence</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--starts-line">starts_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--ends-line">ends_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--is-cursor-position">is_cursor_position</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-chars-in-line">get_chars_in_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-bytes-in-line">get_bytes_in_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-attributes">get_attributes</link></methodname>
- <methodparam><parameter
- role="keyword">values</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--get-language">get_language</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--is-end">is_end</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--is-start">is_start</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-char">forward_char</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-char">backward_char</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-chars">forward_chars</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-chars">backward_chars</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-line">forward_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-line">backward_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-lines">forward_lines</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-lines">backward_lines</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-word-ends">forward_word_ends</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-word-starts">backward_word_starts</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-word-end">forward_word_end</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-word-start">backward_word_start</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-cursor-position">forward_cursor_position</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-cursor-position">backward_cursor_position</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-cursor-positions">forward_cursor_positions</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-cursor-positions">backward_cursor_positions</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-sentence-start">backward_sentence_start</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-sentence-end">forward_sentence_end</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-sentence-starts">backward_sentence_starts</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-sentence-ends">forward_sentence_ends</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextiter--forward-visible-word-ends">forward_visible_word_ends</link></methodname>
- <methodparam><parameter role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextiter--backward-visible-word-starts">backward_visible_word_starts</link></methodname>
- <methodparam><parameter role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextiter--forward-visible-word-end">forward_visible_word_end</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextiter--backward-visible-word-start">backward_visible_word_start</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-visible-cursor-position">forward_visible_cursor_position</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-visible-cursor-position">backward_visible_cursor_position</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-visible-cursor-positions">forward_visible_cursor_positions</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-visible-cursor-positions">backward_visible_cursor_positions</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-visible-line">forward_visible_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-visible-line">backward_visible_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-visible-lines">forward_visible_lines</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-visible-lines">backward_visible_lines</link></methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--set-offset">set_offset</link></methodname>
- <methodparam><parameter
- role="keyword">char_offset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--set-line">set_line</link></methodname>
- <methodparam><parameter
- role="keyword">line_number</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--set-line-offset">set_line_offset</link></methodname>
- <methodparam><parameter
- role="keyword">char_on_line</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--set-line-index">set_line_index</link></methodname>
- <methodparam><parameter
- role="keyword">byte_on_line</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-to-end">forward_to_end</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-to-line-end">forward_to_line_end</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--set-visible-line-offset">set_visible_line_offset</link></methodname>
- <methodparam><parameter
- role="keyword">char_on_line</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--set-visible-line-index">set_visible_line_index</link></methodname>
- <methodparam><parameter
- role="keyword">byte_on_line</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--forward-to-tag-toggle">forward_to_tag_toggle</link></methodname>
- <methodparam><parameter role="keyword">tag</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-to-tag-toggle">backward_to_tag_toggle</link></methodname>
- <methodparam><parameter role="keyword">tag</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextiter--forward-find-char">forward_find_char</link></methodname>
- <methodparam><parameter role="keyword">pred</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- <methodparam><parameter role="keyword">limit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextiter--backward-find-char">backward_find_char</link></methodname>
- <methodparam><parameter role="keyword">pred</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- <methodparam><parameter role="keyword">limit</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextiter--forward-search">forward_search</link></methodname>
- <methodparam><parameter role="keyword">str</parameter></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- <methodparam><parameter
- role="keyword">limit</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--backward-search">backward_search</link></methodname>
- <methodparam><parameter role="keyword">str</parameter></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- <methodparam><parameter
- role="keyword">limit</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--equal">equal</link></methodname>
- <methodparam><parameter role="keyword">rhs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--compare">compare</link></methodname>
- <methodparam><parameter role="keyword">rhs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--in-range">in_range</link></methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextiter--order">order</link></methodname>
- <methodparam><parameter
- role="keyword">second</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-points to a position between two characters in a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>.
-A <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link> is
-usually created using a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-method and are invalidated when the number of characters in the <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-changes (with some exceptions when inserting or deleting) including
-inserting or deleting pixbufs or child anchors. There are a huge number of
-<link linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-methods mostly dealing with moving the textiter location in the textbuffer,
-checking the location or retrieving text or objects at a location.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktextiter--get-buffer">
- <title>gtk.TextIter.get_buffer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_buffer</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the textbuffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_buffer</methodname>() method returns the
-<link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-object this iterator is associated with.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--copy">
- <title>gtk.TextIter.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the textiter</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method creates a copy of the
-textiter.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-offset">
- <title>gtk.TextIter.get_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_offset</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a character offset</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_offset</methodname>() method returns the
-character offset of the textiter. Each character in a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-has an offset, starting with 0 for the first character in the textbuffer.
-Use <link
-linkend="method-gtktextbuffer--get-iter-at-offset"><methodname>gtk.TextBuffer.get_iter_at_offset</methodname>()</link>
-to convert an offset back into a textiter.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-line">
- <title>gtk.TextIter.get_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a line number</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_line</methodname>() method returns the line
-number containing the textiter. Lines in a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-are numbered beginning with 0 for the first line.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-line-offset">
- <title>gtk.TextIter.get_line_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line_offset</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the offset from the start of the
-line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_line_offset</methodname>() method returns
-the character offset of the textiter location, counting from the start of
-the line containing the textiter location. The first character on the line
-has offset 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-line-index">
- <title>gtk.TextIter.get_line_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line_index</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of bytes from the start of the
-line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_line_offset</methodname>() method returns
-the byte index of the textiter location, counting from the start of the line
-containing the textiter location. Remember that <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-encodes text in UTF-8, and that characters can require a variable number of
-bytes to represent.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-visible-line-offset">
- <title>gtk.TextIter.get_visible_line_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_line_offset</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the offset in visible characters from the start
-of the line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visible_line_offset</methodname>() method
-returns the offset in characters of the textiter location from the start of
-the line containing the textiter location, not counting characters that are
-invisible due to tags with the "invisible" attribute set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-visible-line-index">
- <title>gtk.TextIter.get_visible_line_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_line_index</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a byte index from the start of the
-line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visible_line_index</methodname>() method
-returns the byte index of the textiter location from the start of the line,
-not counting bytes that are invisible due to tags with the "invisible"
-attribute set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-char">
- <title>gtk.TextIter.get_char</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_char</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a Unicode character, or 0 if the textiter is
-not dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_char</methodname>() method returns the
-Unicode character at this textiter location. If the textiter points at a
-non-character element, such as an image embedded in the buffer, the Unicode
-"unknown" character 0xFFFC is returned. If invoked on the end textiter, zero
-is returned; zero is not a valid Unicode character. So you can write a loop
-which ends when the <link
-linkend="method-gtktextiter--get-char"><methodname>get_char</methodname>()</link>
-method returns 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-slice">
- <title>gtk.TextIter.get_slice</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_slice</methodname>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>the textiter at the end of a
-range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a slice of text from the
-textbuffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_slice</methodname>() method returns the text
-in the range between the locations specified by the textiter and
-<parameter>end</parameter>. A "slice" is an array of characters encoded in
-UTF-8 format, including the Unicode "unknown" character 0xFFFC for iterable
-non-character elements in the textbuffer, such as images. Because images
-are encoded in the slice, byte and character offsets in the returned array
-will correspond to byte offsets in the textbuffer. Note that 0xFFFC can
-occur in normal text as well, so it is not a reliable indicator that a
-pixbuf or widget is in the textbuffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-text">
- <title>gtk.TextIter.get_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text</methodname>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>textiter at end of a range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>array of characters from the
-buffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_text</methodname>() method returns the text
-in the range between the locations specified by the textiter and
-<parameter>end</parameter>. If the range contains non-text elements such as
-images, the character and byte offsets in the returned string will not
-correspond to character and byte offsets in the textbuffer. If you want the
-offsets to correspond, use the <link
-linkend="method-gtktextiter--get-slice"><methodname>get_slice</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-visible-slice">
- <title>gtk.TextIter.get_visible_slice</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_slice</methodname>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>textiter at end of range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a slice of visible text from the
-textbuffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visible_slice</methodname>() method is
-similar to the <link
-linkend="method-gtktextiter--get-slice"><methodname>get_slice</methodname>()</link>
-method, but invisible text is excluded. Invisible text is text with the
-"invisible" attribute set on it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-visible-text">
- <title>gtk.TextIter.get_visible_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_text</methodname>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>textiter at end of range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string containing visible text from the
-textbuffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visible_text</methodname>() method is
-similar to the <link
-linkend="method-gtktextiter--get-text"><methodname>get_text</methodname>()</link>,
-but invisible text is excluded. Invisible text is text with the "invisible"
-attribute set on it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-pixbuf">
- <title>gtk.TextIter.get_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixbuf</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a pixbuf or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixbuf</methodname>() method returns the
-<link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-object at the textiter location, if any; otherwise, <literal>None</literal>
-is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-marks">
- <title>gtk.TextIter.get_marks</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_marks</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-objects</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_marks</methodname>() method returns a list
-of all <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-objects at the textiter location. Because marks don't take up any "space" in
-the buffer, multiple marks can exist in the same location. The returned list
-is not in any meaningful order.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-child-anchor">
- <title>gtk.TextIter.get_child_anchor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_child_anchor</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a child anchor or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_child_anchor</methodname>() method returns
-the <link
-linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>
-at the textiter location, if any; otherwise, <literal>None</literal> is
-returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-toggled-tags">
- <title>gtk.TextIter.get_toggled_tags</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_toggled_tags</methodname>
- <methodparam><parameter
- role="keyword">toggled_on</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">toggled_on</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> get toggled-on tags;
-otherwise get toggle-off tags</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of tags toggled at this
-point</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_toggled_tags</methodname>() method returns a
-list of <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> objects
-that are toggled on or off at this point. If
-<parameter>toggled_on</parameter> is <literal>True</literal>, the list
-contains tags that are toggled on. If a tag is toggled on at the textiter
-location, some non-empty range of characters following the textiter has that
-tag applied to it. If a tag is toggled off, then some non-empty range
-following the textiter location does not have the tag applied to it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--begins-tag">
- <title>gtk.TextIter.begins_tag</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>begins_tag</methodname>
- <methodparam><parameter role="keyword">tag</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter is the
-start of a range tagged with <parameter>tag</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>begins_tag</methodname>() method returns
-<literal>True</literal> if <parameter>tag</parameter> is toggled on at
-exactly this point. If <parameter>tag</parameter> is
-<literal>None</literal>, this method returns <literal>True</literal> if any
-tag is toggled on at this point. Note that the<methodname>
-begins_tag</methodname>() method returns <literal>True</literal> only if the
-textiter location is the <emphasis>start</emphasis> of the tagged range; the
-<link
-linkend="method-gtktextiter--has-tag"><methodname>has_tag</methodname>()</link>
-indicates if a textiter location is <emphasis>within</emphasis> a tagged
-range.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--ends-tag">
- <title>gtk.TextIter.ends_tag</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ends_tag</methodname>
- <methodparam><parameter role="keyword">tag</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter is the
-end of a range tagged with <parameter>tag</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>ends_tag</methodname>() method returns
-<literal>True</literal> if <parameter>tag</parameter> is toggled off at the
-location the textiter points to. If <parameter>tag</parameter> is
-<literal>None</literal>, this method returns <literal>True</literal> if any
-tag is toggled off at this point. Note that the
-<methodname>ends_tag</methodname>() returns <literal>True</literal> only if
-the textiter location is the <emphasis>end</emphasis> of the tagged range;
-the <link
-linkend="method-gtktextiter--has-tag"><methodname>has_tag</methodname>()</link>
-indicates if a textiter location is <emphasis>within</emphasis> a tagged
-range.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--toggles-tag">
- <title>gtk.TextIter.toggles_tag</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>toggles_tag</methodname>
- <methodparam><parameter
- role="keyword">tag</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>tag</parameter> is toggled on or off at the textiter
-location</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>toggles_tag</methodname>() method returns
-<literal>True</literal> if a range of text with <parameter>tag</parameter>
-applied to it begins <emphasis>or</emphasis> ends at the textiter location.
-If <parameter>tag</parameter> is <literal>None</literal> this method returns
-<literal>True</literal> if any tag begins or ends at the textiter
-location.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--has-tag">
- <title>gtk.TextIter.has_tag</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>has_tag</methodname>
- <methodparam><parameter
- role="keyword">tag</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location is tagged with <parameter>tag</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>has_tag</methodname>() method returns
-<literal>True</literal> if the textiter location is within a range of text
-tagged with <parameter>tag</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-tags">
- <title>gtk.TextIter.get_tags</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tags</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
-objects</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tags</methodname>() method returns a list of
-tags that apply to the textiter location, in ascending order of priority
-(highest-priority tags are last).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--editable">
- <title>gtk.TextIter.editable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>editable</methodname>
- <methodparam><parameter
- role="keyword">default_setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">default_setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the text is editable
-by default</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location is inside an editable range or text</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>editable</methodname>() method returns
-<literal>True</literal> if the character at the textiter location is within
-an editable range of text. Non-editable text is "locked" and can't be
-changed by the user via a <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>. This
-method is a convenience wrapper around the <link
-linkend="method-gtktextiter--get-attributes"><methodname>get_attributes</methodname>()</link>
-method. If no tags applied to this text location affect editability, the
-value of <parameter>default_setting</parameter> will be returned.</para>
-
- <para>Do not use this method to determine if text can be inserted at
-the textiter location. For insertion you don't want to know if the char at
-the textiter location is inside an editable range of text, you want to know
-whether a new character inserted at the textiter location would be inside an
-editable range of text. Use the <link
-linkend="method-gtktextiter--can-insert"><methodname>can_insert</methodname>()</link>
-method to determine if text can be inserted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--can-insert">
- <title>gtk.TextIter.can_insert</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>can_insert</methodname>
- <methodparam><parameter
- role="keyword">default_editability</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">default_editability</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the text is editable
-by default</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if text inserted at
-<parameter>iter</parameter> would be editable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>can_insert</methodname>() method considers the
-default editability of the buffer, and the tags that affect editability, to
-determine if text inserted at the textiter location would be editable. If
-so, the user should be allowed to insert text at the textiter location. The
-<link
-linkend="method-gtktextbuffer--insert-interactive"><methodname>gtk.TextBuffer.insert_interactive</methodname>()</link>
-uses this function to determine if insertions are allowed at a given
-position.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--starts-word">
- <title>gtk.TextIter.starts_word</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>starts_word</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location is at the start of a word</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>starts_word</methodname>() method returns
-<literal>True</literal> if the textiter location begins a natural-language
-word. Word breaks are determined by Pango and should be correct for nearly
-any language (if not, the correct fix would be to the Pango word break
-algorithms).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--ends-word">
- <title>gtk.TextIter.ends_word</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ends_word</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location is at the end of a word</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>ends_word</methodname>() method returns
-<literal>True</literal> if the textiter location ends a natural-language
-word. Word breaks are determined by Pango and should be correct for nearly
-any language (if not, the correct fix would be to the Pango word break
-algorithms).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--inside-word">
- <title>gtk.TextIter.inside_word</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>inside_word</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location is inside a word</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>inside_word</methodname>() method returns
-<literal>True</literal> if the textiter location is inside a
-natural-language word (as opposed to say inside some whitespace). Word
-breaks are determined by Pango and should be correct for nearly any language
-(if not, the correct fix would be to the Pango word break
-algorithms).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--starts-sentence">
- <title>gtk.TextIter.starts_sentence</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>starts_sentence</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location is at the start of a sentence.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>starts_sentence</methodname>() method returns
-<literal>True</literal> if the textiter location begins a sentence.
-Sentence boundaries are determined by Pango and should be correct for nearly
-any language (if not, the correct fix would be to the Pango text boundary
-algorithms).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--ends-sentence">
- <title>gtk.TextIter.ends_sentence</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ends_sentence</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location is at the end of a sentence.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>ends_sentence</methodname>() method returns
-<literal>True</literal> if the textiter location ends a sentence. Sentence
-boundaries are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango text boundary
-algorithms).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--inside-sentence">
- <title>gtk.TextIter.inside_sentence</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>inside_sentence</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location is inside a sentence.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>inside_sentence</methodname>() method returns
-<literal>True</literal> if the textiter location is inside a sentence (as
-opposed to in between two sentences, e.g. after a period and before the
-first letter of the next sentence). Sentence boundaries are determined by
-Pango and should be correct for nearly any language (if not, the correct fix
-would be to the Pango text boundary algorithms).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--starts-line">
- <title>gtk.TextIter.starts_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>starts_line</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location begins a line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>starts_line</methodname>() method returns
-<literal>True</literal> if the textiter location begins a paragraph, i.e. if
-the <link
-linkend="method-gtktextiter--get-line-offset"><methodname>.get_line_offset</methodname>()</link>
-method would return 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--ends-line">
- <title>gtk.TextIter.ends_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ends_line</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location is at the end of a line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>ends_line</methodname>() method returns
-<literal>True</literal> if the textiter location points to the start of the
-paragraph delimiter characters for a line (delimiters will be either a
-newline, a carriage return, a carriage return followed by a newline, or a
-Unicode paragraph separator character). Note that an textiter pointing to
-the \n of a \r\n pair will not be counted as the end of a line, the line
-ends before the \r. The end textiter is considered to be at the end of a
-line, even though there are no paragraph delimiter chars there.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--is-cursor-position">
- <title>gtk.TextIter.is_cursor_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_cursor_position</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the cursor can be
-placed at the textiter location</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_cursor_position</methodname>() method returns
-<literal>True</literal> if the cursor can be placed at the textiter
-location. See the <link
-linkend="method-gtktextiter--forward-cursor-position"><methodname>forward_cursor_position</methodname>()</link>
-method for details on what a cursor position is.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-chars-in-line">
- <title>gtk.TextIter.get_chars_in_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_chars_in_line</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of characters in the
-line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_chars_in_line</methodname>() method returns
-the number of characters in the line containing the textiter location,
-including the paragraph delimiters.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-bytes-in-line">
- <title>gtk.TextIter.get_bytes_in_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_bytes_in_line</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of bytes in the
-line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_bytes_in_line</methodname>() method returns
-the number of bytes in the line containing the textiter location, including
-the paragraph delimiters.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-attributes">
- <title>gtk.TextIter.get_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_attributes</methodname>
- <methodparam><parameter
- role="keyword">values</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">values</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-object to be filled in</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>values</parameter> was modified</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_attributes</methodname>() method computes
-the effect of any tags applied to the textiter location and applies those
-attributes to the <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>
-object specified by <parameter>values</parameter> (which should be
-initialized to the default settings you wish to use if no tags are in
-effect). Typically the default attributes are obtained from the <link
-linkend="method-gtktextview--get-default-attributes"><methodname>gtk.TextView.get_default_attributes</methodname>()</link>
-method. If any tags affected <parameter>values</parameter>, the method
-returns <literal>True</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--get-language">
- <title>gtk.TextIter.get_language</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_language</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the pango language in effect at the textiter
-location</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_language</methodname>() method is a
-convenience wrapper around the <link
-linkend="method-gtktextiter--get-attributes"><methodname>get_attributes</methodname>()</link>
-method, that returns the language in effect at the textiter location. If no
-tags affecting language apply to the textiter location, the return value is
-identical to that of the <function>gtk.get_default_language()</function>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--is-end">
- <title>gtk.TextIter.is_end</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_end</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter is the
-end textiter</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_end</methodname>() method returns
-<literal>True</literal> if the textiter is the end textiter, i.e. one past
-the last dereferenceable textiter in the buffer. The
-<methodname>is_end</methodname>() method is the most efficient way to check
-whether an textiter is the end textiter.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--is-start">
- <title>gtk.TextIter.is_start</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_start</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location is at the start of the textbuffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_start</methodname>() method returns
-<literal>True</literal> if the textiter location is at the start of the
-textbuffer, that is if the textiter location has a character offset of
-0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-char">
- <title>gtk.TextIter.forward_char</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_char</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_char</methodname>() method moves the
-textiter location forward by one character offset and returns
-<literal>True</literal> if the textiter location moved and the new location
-is dereferenceable. Note that images embedded in the buffer occupy 1
-character slot, so the <methodname>forward_char</methodname>() method may
-actually move onto an image instead of a character, if you have images in
-your buffer. If the textiter location is the end textiter or one character
-before it, the textiter location will now point at the end textiter, and the
-<methodname>forward_char</methodname>() method returns
-<literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-char">
- <title>gtk.TextIter.backward_char</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_char</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the textiter location moved and is
-not the start textiter</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_char</methodname>() method moves the
-textiter location backward by one character offset and returns
-<literal>True</literal> if the textiter location moved. If the old textiter
-location was the first in the buffer (character offset 0), the
-<methodname>backward_char</methodname>() method returns
-<literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-chars">
- <title>gtk.TextIter.forward_chars</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_chars</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of characters to move, may be
-negative</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_chars</methodname>() method moves the
-textiter location forward <parameter>count</parameter> characters if
-possible. If the textiter location would move past the start or end of the
-buffer, the location moves to the start or end of the textbuffer. The
-<methodname>forward_chars</methodname>() method returns
-<literal>True</literal> if the new position of the resulting textiter
-location is different from its original position, and is dereferenceable
-(the last textiter in the buffer is not dereferenceable). If
-<parameter>count</parameter> is 0, the function does nothing and returns
-<literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-chars">
- <title>gtk.TextIter.backward_chars</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_chars</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of characters to move, may be
-negative</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_chars</methodname>() method moves the
-textiter location backward forward <parameter>count</parameter> characters,
-if possible. If the textiter location would move past the start or end of
-the buffer, the location moves to the start or end of the textbuffer. The
-<methodname>backward_chars</methodname>() method returns
-<literal>True</literal> if the new position of the resulting textiter
-location is different from its original position, and is dereferenceable
-(the last textiter in the buffer is not dereferenceable). If
-<parameter>count</parameter> is 0, the function does nothing and returns
-<literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-line">
- <title>gtk.TextIter.forward_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_line</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location can be dereferenced</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_line</methodname>() method moves the
-textiter location to the start of the next line and returns
-<literal>True</literal> if the textiter location moved to a dereferenceable
-position, and <literal>False</literal> if the textiter location moved to the
-end of the buffer, or if the textiter location was originally at the end of
-the buffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-line">
- <title>gtk.TextIter.backward_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_line</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_line</methodname>() method moves the
-textiter location to the start of the previous line and returns
-<literal>True</literal> if the textiter location was moved. If the textiter
-location was at the textbuffer start, this method returns
-<literal>False</literal>. For example if the textiter location was already
-on line 0, but not at the start of the line, the textiter location is
-snapped to the start of the line and the method returns
-<literal>True</literal>.</para>
-
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-lines">
- <title>gtk.TextIter.forward_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_lines</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of lines to move forward, may be
-negative</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_lines</methodname>() method moves the
-textiter location forward <parameter>count</parameter> lines, if possible.
-If the textiter location would move past the start or end of the buffer, the
-location moves to the start or end of the textbuffer. The method
-returns:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>True</literal> if the textiter moved to a
-dereferenceable position; or,</simpara>
- </listitem>
- <listitem>
- <simpara><literal>False</literal> if the textiter location didn't
-move, or moved onto the end textiter or if <parameter>count</parameter> was
-0.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>If <parameter>count</parameter> is negative, the textiter
-location moves backward by <parameter>count</parameter> lines.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-lines">
- <title>gtk.TextIter.backward_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_lines</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of lines to move backward, may be
-negative</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved to a dereferenceable position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_lines</methodname>() method moves the
-textiter location backward by <parameter>count</parameter> lines, if
-possible. If the textiter location would move past the start or end of the
-buffer, the location moves to the start or end of the textbuffer. The
-method returns:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>True</literal> if the textiter moved to a
-dereferenceable position; or,</simpara>
- </listitem>
- <listitem>
- <simpara><literal>False</literal> if the textiter location didn't
-move, or moved onto the end textiter or if <parameter>count</parameter> was
-0.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>If <parameter>count</parameter> is negative, the textiter
-location moves forward by <parameter>count</parameter> lines.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-word-ends">
- <title>gtk.TextIter.forward_word_ends</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_word_ends</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of times to
-move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and is not the end textiter</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_word_ends</methodname>() method calls
-the <link
-linkend="method-gtktextiter--forward-word-end"><methodname>forward_word_end</methodname>()</link>
-method up to <parameter>count</parameter> times or the <link
-linkend="method-gtktextiter--backward-word-starts"><methodname>backward_word_starts</methodname>()</link>
-method if <parameter>count</parameter> is negative. The method returns
-<literal>True</literal> if the textiter location changed and the resulting
-location is not at the end of the textbuffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-word-starts">
- <title>gtk.TextIter.backward_word_starts</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_word_starts</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of times to
-move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and is not the end textiter</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_word_starts(</methodname>) method calls the
-<link
-linkend="method-gtktextiter--backward-word-start"><methodname>backward_word_start</methodname>()</link>
-method up to <parameter>count</parameter> times or the <link
-linkend="method-gtktextiter--forward-word-ends"><methodname>forward_word_ends</methodname>()</link>
-method if <parameter>count</parameter> is negative. The method returns
-<literal>True</literal> if the textiter location changed and the resulting
-location is not at the end of the textbuffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-word-end">
- <title>gtk.TextIter.forward_word_end</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_word_end</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved to a dereferenceable position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_word_end</methodname>() method moves the
-textiter location forward to the next word end. If the textiter location is
-currently on a word end, the location moves forward to the next one after
-that. Word breaks are determined by Pango and should be correct for nearly
-any language (if not, the correct fix would be to the Pango word break
-algorithms). The method returns True if the textiter location moved to a
-dereferenceable position</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-word-start">
- <title>gtk.TextIter.backward_word_start</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_word_start</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_word_start</methodname>() method moves
-the textiter location backward to the previous word start. If the textiter
-location is currently on a word start, the location moves backward to the
-next one before that. Word breaks are determined by Pango and should be
-correct for nearly any language (if not, the correct fix would be to the
-Pango word break algorithms). The method returns <literal>True</literal> if
-the textiter location moved.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-cursor-position">
- <title>gtk.TextIter.forward_cursor_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_cursor_position</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if we moved and the new
-position is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_cursor_position</methodname>() method
-moves the textiter location forward by a single cursor position. Cursor
-positions are (unsurprisingly) positions where the cursor can appear.
-Surprisingly, there may not be a cursor position between all characters. The
-most common example for European languages would be a carriage
-return/newline sequence. For some Unicode characters, the equivalent of say
-the letter "a" with an accent mark will be represented as two characters,
-first the letter then a "combining mark" that causes the accent to be
-rendered; so the cursor can't go between those two characters. The method
-returns <literal>True</literal> if the textiter location changed and the
-resulting location is not at the end of the textbuffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-cursor-position">
- <title>gtk.TextIter.backward_cursor_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_cursor_position</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if we moved and the new
-position is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_cursor_position</methodname>() method
-is similar to the <link
-linkend="method-gtktextiter--forward-cursor-position"><methodname>forward_cursor_position</methodname>()</link>
-method, except the location moves backward.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-cursor-positions">
- <title>gtk.TextIter.forward_cursor_positions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_cursor_positions</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of positions to
-move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and the new position is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_cursor_positions</methodname>() method
-moves up to <parameter>count</parameter> cursor positions. See the <link
-linkend="method-gtktextiter--forward-cursor-position"><methodname>forward_cursor_position</methodname>()</link>
-method for more details. The method returns <literal>True</literal> if the
-textiter moved to a dereferenceable location.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-cursor-positions">
- <title>gtk.TextIter.backward_cursor_positions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_cursor_positions</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of positions to
-move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and the new position is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_cursor_positions</methodname>() method
-moves the textiter location up to <parameter>count</parameter> cursor
-positions. See the <link
-linkend="method-gtktextiter--forward-cursor-position"><methodname>forward_cursor_position</methodname>()</link>
-method for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-sentence-start">
- <title>gtk.TextIter.backward_sentence_start</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_sentence_start</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_sentence_start</methodname>() method
-moves the textiter location backward to the previous sentence start. If the
-textiter location is already at the start of a sentence, the location moves
-backward to the next one. Sentence boundaries are determined by Pango and
-should be correct for nearly any language (if not, the correct fix would be
-to the Pango text boundary algorithms).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-sentence-end">
- <title>gtk.TextIter.forward_sentence_end</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_sentence_end</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and is not the end textiter</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_sentence_end</methodname>() method moves
-the textiter location forward to the next sentence end. (If the textiter
-location is at the end of a sentence, the location moves to the next end of
-sentence.) Sentence boundaries are determined by Pango and should be
-correct for nearly any language (if not, the correct fix would be to the
-Pango text boundary algorithms). The method returns <literal>True</literal>
-if the textiter location changed and the resulting location is not at the
-end of the textbuffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-sentence-starts">
- <title>gtk.TextIter.backward_sentence_starts</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_sentence_starts</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of sentences to
-move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and is not the end textiter</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_sentence_starts</methodname>() method
-calls the <link
-linkend="method-gtktextiter--backward-sentence-start"><methodname>backward_sentence_start</methodname>()</link>
-method (or the <link
-linkend="method-gtktextiter--forward-sentence-end"><methodname>forward_sentence_end</methodname>()</link>()
-method if count is negative) up to <parameter>count</parameter> times, or
-until it returns <literal>False</literal>. If <parameter>count</parameter>
-is negative, the location moves forward instead of backward. The method
-returns <literal>True</literal> if the textiter location changed and the
-resulting location is not at the end of the textbuffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-sentence-ends">
- <title>gtk.TextIter.forward_sentence_ends</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_sentence_ends</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of sentences to
-move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and is not the end textiter</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_sentence_ends</methodname>() method
-calls the <link
-linkend="method-gtktextiter--forward-sentence-end"><methodname>forward_sentence_end</methodname>()</link>
-method <parameter>count</parameter> times (or until the <link
-linkend="method-gtktextiter--forward-sentence-end"><methodname>forward_sentence_end</methodname>()</link>
-method returns <literal>False</literal>). If <parameter>count</parameter> is
-negative, the location moves backward instead of forward. The method returns
-<literal>True</literal> if the textiter location changed and the resulting
-location is not at the end of the textbuffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-visible-word-ends">
- <title>gtk.TextIter.forward_visible_word_ends</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_visible_word_ends</methodname>
- <methodparam><parameter role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of times to move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter moved
- and is not the end iterator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>forward_visible_word_ends</methodname>() method
-calls the <link
-linkend="method-gtktextiter--forward-visible-word-end"><methodname>forward_visible_word_end()</methodname></link>
-method the number of times specified by <parameter>count</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-visible-word-starts">
- <title>gtk.TextIter.backward_visible_word_starts</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_visible_word_starts</methodname>
- <methodparam><parameter role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of times to move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter moved
- and is not the end iterator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>backward_visible_word_starts</methodname>()
-method calls the <link
-linkend="method-gtktextiter--backward-visible-word-start"><methodname>backward_visible_word_start()</methodname></link>
-method the number of times specified by <parameter>count</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-visible-word-end">
- <title>gtk.TextIter.forward_visible_word_end</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_visible_word_end</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter moved
- and is not the end iterator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>forward_visible_word_end</methodname>() method
-moves the textiter forward to the next visible word end. (If the textiter is
-currently on a word end, it moves forward to the next one after that.) Word
-breaks are determined by Pango and should be correct for nearly any language
-(if not, the correct fix would be to the Pango word break
-algorithms).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-visible-word-start">
- <title>gtk.TextIter.backward_visible_word_start</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_visible_word_start</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter moved
- and is not the end iterator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>backward_visible_word_start</methodname>()
-method moves the textiter backward to the previous visible word start. (If
-textiter is currently on a word start, it moves backward to the next one
-after that.) Word breaks are determined by Pango and should be correct for
-nearly any language (if not, the correct fix would be to the Pango word
-break algorithms).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-visible-cursor-position">
- <title>gtk.TextIter.forward_visible_cursor_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_visible_cursor_position</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if we moved and the new
-position is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>forward_visible_cursor_position</methodname>()
-method moves the textiter location forward by a single visible cursor
-position. Cursor positions are (unsurprisingly) positions where the cursor
-can appear. Surprisingly, there may not be a cursor position between all
-characters. The most common example for European languages would be a
-carriage return/newline sequence. For some Unicode characters, the
-equivalent of say the letter "a" with an accent mark will be represented as
-two characters, first the letter then a "combining mark" that causes the
-accent to be rendered; so the cursor can't go between those two
-characters. The method returns <literal>True</literal> if the textiter
-location changed and the resulting location is not at the end of the
-textbuffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-visible-cursor-position">
- <title>gtk.TextIter.backward_visible_cursor_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_visible_cursor_position</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if we moved and the new
-position is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>backward_visible_cursor_position</methodname>()
-method is similar to the <link
-linkend="method-gtktextiter--forward-visible-cursor-position"><methodname>forward_visible_cursor_position</methodname>()</link>
-method, except the location moves backward.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-visible-cursor-positions">
- <title>gtk.TextIter.forward_visible_cursor_positions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_visible_cursor_positions</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of positions to
-move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and the new position is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>forward_visible_cursor_positions</methodname>()
-method moves up to <parameter>count</parameter> visible cursor
-positions. See the <link
-linkend="method-gtktextiter--forward-visible-cursor-position"><methodname>forward_visible_cursor_position</methodname>()</link>
-method for more details. The method returns <literal>True</literal> if the
-textiter moved to a dereferenceable location.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-visible-cursor-positions">
- <title>gtk.TextIter.backward_visible_cursor_positions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_visible_cursor_positions</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of positions to
-move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and the new position is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>backward_visible_cursor_positions</methodname>()
-method moves the textiter location up to <parameter>count</parameter>
-visible cursor positions. See the <link
-linkend="method-gtktextiter--forward-visible-cursor-position"><methodname>forward_visible_cursor_position</methodname>()</link>
-method for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-visible-line">
- <title>gtk.TextIter.forward_visible_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_visible_line</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location can be dereferenced</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>forward_visible_line</methodname>() method moves
-the textiter location to the start of the next visible line and returns
-<literal>True</literal> if the textiter location moved to a dereferenceable
-position, and <literal>False</literal> if the textiter location moved to the
-end of the buffer, or if the textiter location was originally at the end of
-the buffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-visible-line">
- <title>gtk.TextIter.backward_visible_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_visible_line</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>backward_visible_line</methodname>() method
-moves the textiter location to the start of the previous visible line and
-returns <literal>True</literal> if the textiter location was moved. If the
-textiter location was at the textbuffer start, this method returns
-<literal>False</literal>. For example if the textiter location was already
-on line 0, but not at the start of the line, the textiter location is
-snapped to the start of the line and the method returns
-<literal>True</literal>.</para>
-
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-visible-lines">
- <title>gtk.TextIter.forward_visible_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_visible_lines</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of visible lines to move forward,
-may be negative</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved and is dereferenceable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>forward_visible_lines</methodname>() method
-moves the textiter location forward <parameter>count</parameter> visible
-lines, if possible. If the textiter location would move past the start or
-end of the buffer, the location moves to the start or end of the textbuffer.
-The method returns:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>True</literal> if the textiter moved to a
-dereferenceable position; or,</simpara>
- </listitem>
- <listitem>
- <simpara><literal>False</literal> if the textiter location didn't
-move, or moved onto the end textiter or if <parameter>count</parameter> was
-0.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>If <parameter>count</parameter> is negative, the textiter
-location moves backward by <parameter>count</parameter> visible lines.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-visible-lines">
- <title>gtk.TextIter.backward_visible_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_visible_lines</methodname>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of visible lines to move backward,
-may be negative</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location moved to a dereferenceable position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>backward_visible_lines</methodname>() method
-moves the textiter location backward by <parameter>count</parameter> lines,
-if possible. If the textiter location would move past the start or end of
-the buffer, the location moves to the start or end of the textbuffer. The
-method returns:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>True</literal> if the textiter moved to a
-dereferenceable position; or,</simpara>
- </listitem>
- <listitem>
- <simpara><literal>False</literal> if the textiter location didn't
-move, or moved onto the end textiter or if <parameter>count</parameter> was
-0.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>If <parameter>count</parameter> is negative, the textiter
-location moves forward by <parameter>count</parameter> visible lines.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--set-offset">
- <title>gtk.TextIter.set_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_offset</methodname>
- <methodparam><parameter
- role="keyword">char_offset</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">char_offset</parameter>&nbsp;:</term>
- <listitem><simpara>a character number</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_offset</methodname>() method sets the
-textiter location to point to the location that is
-<parameter>char_offset</parameter> counts from the start of the textbuffer
-(starting with 0).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--set-line">
- <title>gtk.TextIter.set_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_line</methodname>
- <methodparam><parameter
- role="keyword">line_number</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">line_number</parameter>&nbsp;:</term>
- <listitem><simpara>a line number (counted from
-0)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_line</methodname>() method sets the textiter
-location to the start of the line specified by
-<parameter>line_number</parameter>. If <parameter>line_number</parameter>
-is negative or larger than the number of lines in the textbuffer, the method
-moves the textiter location to the start of the last line in the
-buffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--set-line-offset">
- <title>gtk.TextIter.set_line_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_line_offset</methodname>
- <methodparam><parameter
- role="keyword">char_on_line</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">char_on_line</parameter>&nbsp;:</term>
- <listitem><simpara>a character offset relative to the start of the
-textiter location's current line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_line_offset</methodname>() method moves the
-textiter location within a line, to the new <emphasis>character</emphasis>
-(not byte) offset specified by <parameter>char_on_line</parameter>. The
-character offset must be less than or equal to the number of characters in
-the line; if equal, the textiter location moves to the start of the next
-line. See the <link
-linkend="method-gtktextiter--set-line-index"><methodname>set_line_index</methodname>()</link>
-method if you have a byte index rather than a character offset.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--set-line-index">
- <title>gtk.TextIter.set_line_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_line_index</methodname>
- <methodparam><parameter
- role="keyword">byte_on_line</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">byte_on_line</parameter>&nbsp;:</term>
- <listitem><simpara>a byte index relative to the start of the
-textiter location's current line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_line_index</methodname>() method is similar
-to the <link
-linkend="method-gtktextiter--set-line-offset"><methodname>set_line_offset</methodname>()</link>,
-but works with a <emphasis>byte</emphasis> index instead of a character
-index. The given byte index must be at the start of a character, it can't be
-in the middle of a UTF-8 encoded character.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-to-end">
- <title>gtk.TextIter.forward_to_end</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_to_end</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>forward_to_end</methodname>() method moves the
-textiter location forward to the "end textiter," that points one past the
-last valid character in the buffer. The <link
-linkend="method-gtktextiter--get-char"><methodname>get_char</methodname>()</link>
-method called on the end textiter returns 0, which is convenient for writing
-loops.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-to-line-end">
- <title>gtk.TextIter.forward_to_line_end</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_to_line_end</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if we moved and the new
-location is not the end textiter</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_to_line_end</methodname>() method moves
-the textiter to point to the paragraph delimiter characters at the end of
-the current line. The paragraph delimiter characters are a newline, a
-carriage return, a carriage return-newline in sequence, or the Unicode
-paragraph separator character. If the textiter is already at the paragraph
-delimiter characters, moves to the paragraph delimiter characters for the
-next line. If the textiter location is on the last line in the buffer, which
-does not end in paragraph delimiters, moves to the end textiter (end of the
-last line), and returns <literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--set-visible-line-offset">
- <title>gtk.TextIter.set_visible_line_offset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible_line_offset</methodname>
- <methodparam><parameter
- role="keyword">char_on_line</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">char_on_line</parameter>&nbsp;:</term>
- <listitem><simpara>a character offset</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_visible_char_offset</methodname>() method is
-similar to the <link
-linkend="method-gtktextiter--set-line-offset"><methodname>set_line_offset</methodname>()</link>
-method, but the offset is in visible characters, i.e. text with the
-invisible attribute set is not counted in the offset.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--set-visible-line-index">
- <title>gtk.TextIter.set_visible_line_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible_line_index</methodname>
- <methodparam><parameter
- role="keyword">byte_on_line</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">byte_on_line</parameter>&nbsp;:</term>
- <listitem><simpara>a byte index</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_visible_line_index</methodname>() method is
-similar to the <link
-linkend="method-gtktextiter--set-line-index"><methodname>set_line_index</methodname>()</link>
-method, but the index is in visible bytes, i.e. text with the attribute set
-is not counted in the index.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-to-tag-toggle">
- <title>gtk.TextIter.forward_to_tag_toggle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_to_tag_toggle</methodname>
- <methodparam><parameter
- role="keyword">tag</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a tag toggle was
-found after the textiter location</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_to_tag_toggle</methodname>() method
-moves the textiter location forward to the next toggle (on or off) of the
-<link linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
-specified by <parameter>tag</parameter>, or to the next toggle of any tag if
-<parameter>tag</parameter> is <literal>None</literal>. If no matching tag
-toggles are found, this method returns <literal>False</literal> and sets the
-textiter location to the end of the textbuffer; otherwise, returns
-<literal>True</literal>. The
-<methodname>forward_to_tag_toggle</methodname>() method does not recognize
-toggles located at the textiter location, only toggles after the textiter
-location.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-to-tag-toggle">
- <title>gtk.TextIter.backward_to_tag_toggle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_to_tag_toggle</methodname>
- <methodparam><parameter
- role="keyword">tag</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a tag toggle was
-found before the textiter location</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_to_tag_toggle</methodname>() method
-moves the textiter location backward to the next toggle (on or off) of the
-<link linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
-specified by <parameter>tag</parameter>, or to the next toggle of any tag if
-<parameter>tag</parameter> is <literal>None</literal>. If no matching tag
-toggles are found, this method returns <literal>False</literal> and sets the
-textiter location to the start of the textbuffer; otherwise, returns
-<literal>True</literal>. The
-<methodname>backward_to_tag_toggle</methodname>() method does not recognize
-toggles located at the textiter location, only toggles before the textiter
-location.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-find-char">
- <title>gtk.TextIter.forward_find_char</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_find_char</methodname>
- <methodparam><parameter role="keyword">pred</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- <methodparam><parameter role="keyword">limit</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pred</parameter>&nbsp;:</term>
- <listitem><simpara>a function to be called on each
- character</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data for
- <parameter>pred</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">limit</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
- pointing at a position to end the search, or
- <literal>None</literal> for the end of the
- buffer.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a match was
- found</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>forward_find_char</methodname>() method advances
-the textiter, calling the function specified by <parameter>pred</parameter>
-on each character. If <parameter>pred</parameter> returns
-<literal>True</literal>, <methodname>forward_find_char</methodname> stops
-scanning and returns <literal>True</literal>. If <parameter>pred</parameter>
-never returns <literal>True</literal>, the textiter location is set to
-<parameter>limit</parameter> or the end textiter, if
-<parameter>limit</parameter> is <literal>None</literal>.</para>
-
- <warning>
- <para> This method is likely to be very slow since the Python
-function <parameter>pred</parameter> is called for every character.</para>
- </warning>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-find-char">
- <title>gtk.TextIter.backward_find_char</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_find_char</methodname>
- <methodparam><parameter role="keyword">pred</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- <methodparam><parameter role="keyword">limit</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pred</parameter>&nbsp;:</term>
- <listitem><simpara>a function to be called on each
- character</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data for <parameter>pred</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">limit</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
- pointing at a position to end the search, or
- <literal>None</literal> for the beginning of the
- buffer.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a match was
- found</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>backward_find_char</methodname>() method is
-similar to the <link
-linkend="method-gtktextiter--forward-find-char"><methodname>forward_find_char()</methodname></link>
-method, but goes backward from the textiter location.</para>
-
- <warning>
- <para> This method is likely to be very slow since the Python
-function <parameter>pred</parameter> is called for every character.</para>
- </warning>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--forward-search">
- <title>gtk.TextIter.forward_search</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_search</methodname>
- <methodparam><parameter
- role="keyword">str</parameter></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- <methodparam><parameter role="keyword">limit</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">str</parameter>&nbsp;:</term>
- <listitem><simpara>a search string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>the flags affecting how the search is
-done</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">limit</parameter>&nbsp;:</term>
- <listitem><simpara>a bound for the search, or
-<literal>None</literal> to set the bound to the end of the buffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-objects pointing at the start and end locations of the
-match</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_search</methodname>() method searches
-forward for the text string specified by <parameter>str</parameter> and
-returns a tuple containing <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-objects that point at the start and end locations of the match. The search
-will stop at the location specified by <parameter>limit</parameter> or the
-end of the textbuffer if <parameter>limit</parameter> is
-<literal>None</literal> or is not specified. Note that a search is a linear
-or O(n) operation, so you may wish to use <parameter>limit</parameter> to
-avoid locking up your UI when searching large buffers.</para>
-
- <para>If the <literal>gtk.TEXT_SEARCH_VISIBLE_ONLY</literal> flag is
-present, the match may have invisible text interspersed in
-<parameter>str</parameter> (i.e. <parameter>str</parameter> will be a
-possibly-noncontiguous subsequence of the matched range). Likewise, if
-<literal>gtk.TEXT_SEARCH_TEXT_ONLY</literal> is present, the match may have
-pixbufs or child anchors mixed inside the matched range. If these flags are
-not given, the match must be exact i.e. the special 0xFFFC character in
-<parameter>str</parameter> will match embedded pixbufs or child
-widgets.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--backward-search">
- <title>gtk.TextIter.backward_search</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_search</methodname>
- <methodparam><parameter
- role="keyword">str</parameter></methodparam>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- <methodparam><parameter role="keyword">limit</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">str</parameter>&nbsp;:</term>
- <listitem><simpara>a search string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>the flags affecting the
-search</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">limit</parameter>&nbsp;:</term>
- <listitem><simpara>a bound for the search, or
-<literal>None</literal> to set the bound to the end of the
-buffer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>start of match and end of
-match</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_search</methodname>() method is the
-same as the <link
-linkend="method-gtktextiter--forward-search"><methodname>forward_search</methodname>()</link>
-method, except searches backward.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--equal">
- <title>gtk.TextIter.equal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>equal</methodname>
- <methodparam><parameter
- role="keyword">rhs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rhs</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiters point
-to the same place in the buffer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>equal</methodname>() method tests if the
-textiter specified by <parameter>rhs</parameter> points to the same location
-in the textbuffer as the textiter.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--compare">
- <title>gtk.TextIter.compare</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>compare</methodname>
- <methodparam><parameter
- role="keyword">rhs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rhs</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>-1 if the textiter location is less than the
-<parameter>rhs</parameter> location, 1 if the textiter location is greater,
-0 if they are equal</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>compare</methodname>() method returns:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>-1 if the textiter location is less than the location of
-the textiter specified by <parameter>rhs</parameter>;</simpara>
- </listitem>
- <listitem>
- <simpara>1 if the textiter location is greater than the location
-of the textiter specified by <parameter>rhs</parameter>; and,</simpara>
- </listitem>
- <listitem>
- <simpara>0 if the textiter location is equal to the location of
-the textiter specified by <parameter>rhs</parameter>.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>Ordering is in character offset order, i.e. the first character
-in the buffer is less than the second character in the buffer.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--in-range">
- <title>gtk.TextIter.in_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>in_range</methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>the start of the text
-range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>the end of the text range</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textiter
-location is in the text range</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>in_range</methodname>() method returns
-<literal>True</literal> if the textiter location is in the text range
-specified by the <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-objects <parameter>start</parameter> and <parameter>end</parameter>.
-<parameter>start</parameter> and <parameter>end</parameter> must be in
-ascending order.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextiter--order">
- <title>gtk.TextIter.order</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>order</methodname>
- <methodparam><parameter
- role="keyword">second</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">second</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The order() method swaps the locations of
-<parameter>first</parameter> and <parameter>second</parameter> if
-<parameter>second</parameter> comes before <parameter>first</parameter> in
-the buffer. This method can be used to ensure that
-<parameter>first</parameter> and <parameter>second</parameter> are in
-sequence. Most text buffer methods that take a range call this
-automatically, so there's no real reason to call it yourself in those cases.
-There are some exceptions, such as the <link
-linkend="method-gtktextiter--in-range"><methodname>in_range</methodname>()</link>,
-that expect a pre-sorted range.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktextmark.xml b/docs/reference/pygtk-gtktextmark.xml
deleted file mode 100644
index 2decf4fc..00000000
--- a/docs/reference/pygtk-gtktextmark.xml
+++ /dev/null
@@ -1,226 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktextmark">
- <refnamediv>
- <refname>gtk.TextMark</refname>
- <refpurpose>a position in a textbuffer that is preserved across
-textbuffer modifications</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TextMark</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextmark--set-visible">set_visible</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextmark--get-visible">get_visible</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextmark--get-name">get_name</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextmark--get-deleted">get_deleted</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextmark--get-buffer">get_buffer</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextmark--get-left-gravity">get_left_gravity</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtktextmark">gtk.TextMark</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktextmark">
- <title>gtk.TextMark Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link> is
-like a bookmark in a textbuffer - it preserves a position in the text. You
-can get an iterator corresponding to a textmark by using the <link
-linkend="method-gtktextbuffer--get-iter-at-mark"><methodname>gtk.TextBuffer.get_iter_at_mark</methodname>()</link>
-method. Unlike iterators, textmarks remain valid across buffer modifications
-(e.g. when text is inserted or deleted). When text containing a textmark is
-deleted, the textmark remains in the position originally occupied by the
-deleted text. When text is inserted at a textmark, a textmark with left
-gravity will be moved to the beginning of the newly-inserted text, and a
-textmark with right gravity will be moved to the end. Textmarks optionally
-have names that can be used to avoid passing the <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-object around. Textmarks are typically created using the <link
-linkend="method-gtktextbuffer--create-mark"><methodname>gtk.TextBuffer.create_mark</methodname>()</link>
-method. A <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-has two built-in <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-objects named: <literal>insert</literal> and
-<literal>selection_bound</literal> which refer to the insertion point and
-the boundary of the selection (these may refer to the same location).</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktextmark--set-visible">
- <title>gtk.TextMark.set_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the textmark is
-visible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para> The <methodname>set_visible</methodname>() method sets the
-visibility of the textmark to the value specified by
-<parameter>setting</parameter>. If <parameter>setting</parameter> is
-<literal>True</literal> the textmark will be visible as a vertical bar. The
-insertion point is normally visible but most textmarks are not visible by
-default. The text widget uses a visible textmark to indicate where a drop
-will occur when dragging-and-dropping text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextmark--get-visible">
- <title>gtk.TextMark.get_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textmark is
-visible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visible</methodname>() method returns
-<literal>True</literal> if the textmark is visible (i.e. a vertical bar is
-displayed for it)</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextmark--get-name">
- <title>gtk.TextMark.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the textmark name or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_name</methodname>() method returns the
-textmark name or <literal>None</literal> if the textmark is
-anonymous.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextmark--get-deleted">
- <title>gtk.TextMark.get_deleted</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_deleted</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textmark is
-deleted</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_deleted</methodname>() method returns
-<literal>True</literal> if the textmark has been removed from its textbuffer
-with <link
-linkend="method-gtktextbuffer--delete-mark"><methodname>gtk.TextBuffer.delete_mark</methodname>()</link>.
-Textmarks can't be used once deleted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextmark--get-buffer">
- <title>gtk.TextMark.get_buffer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_buffer</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the textmark's <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_buffer</methodname>() method returns the
-<link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-object the textmark is located inside, or <literal>None</literal> if the
-textmark is deleted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextmark--get-left-gravity">
- <title>gtk.TextMark.get_left_gravity</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_left_gravity</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textmark has
-left gravity</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_left_gravity</methodname>() method returns
-True if the textmark has left gravity.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktexttag.xml b/docs/reference/pygtk-gtktexttag.xml
deleted file mode 100644
index 006c2a28..00000000
--- a/docs/reference/pygtk-gtktexttag.xml
+++ /dev/null
@@ -1,793 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktexttag">
- <refnamediv>
- <refname>gtk.TextTag</refname>
- <refpurpose>an object used to apply attributes to text in a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TextTag</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktexttag">gtk.TextTag</link></methodname>
- <methodparam><parameter role="keyword">name</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktexttag--get-priority">get_priority</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktexttag--set-priority">set_priority</link></methodname>
- <methodparam><parameter
- role="keyword">priority</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktexttag--event">event</link></methodname>
- <methodparam><parameter
- role="keyword">event_object</parameter></methodparam>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtktexttag">gtk.TextTag</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktexttag">
- <title>gtk.TextTag Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"background"</entry>
- <entry>Write</entry>
- <entry>The background color as a string</entry>
- </row>
-
- <row valign="top">
- <entry>"background-full-height"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the background color fills
-the entire line height</entry>
- </row>
-
- <row valign="top">
- <entry>"background-full-height-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects background
-height</entry>
- </row>
-
- <row valign="top">
- <entry>"background-gdk"</entry>
- <entry>Read-Write</entry>
- <entry>The background color as a (possibly unallocated) <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></entry>
- </row>
-
- <row valign="top">
- <entry>"background-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the
-background color</entry>
- </row>
-
- <row valign="top">
- <entry>"background-stipple"</entry>
- <entry>Read-Write</entry>
- <entry>The bitmap to use as a mask when drawing the text
-background</entry>
- </row>
-
- <row valign="top">
- <entry>"background-stipple-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the
-background stipple</entry>
- </row>
-
- <row valign="top">
- <entry>"direction"</entry>
- <entry>Read-Write</entry>
- <entry>The text direction:
-<literal>gtk.TEXT_DIR_NONE</literal>, <literal>gtk.TEXT_DIR_LTR</literal> or
-<literal>gtk.TEXT_DIR_RTL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"editable"</entry>
- <entry>Read-Write</entry>
- <entry>It <literal>True</literal> the text can be modified by
-the user</entry>
- </row>
-
- <row valign="top">
- <entry>"editable-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects text
-editability</entry>
- </row>
-
- <row valign="top">
- <entry>"family"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the font family, e.g. Sans, Helvetica,
-Times, Monospace</entry>
- </row>
-
- <row valign="top">
- <entry>"family-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the font
-family</entry>
- </row>
-
- <row valign="top">
- <entry>"font"</entry>
- <entry>Read-Write</entry>
- <entry>The font description as a string, e.g. "Sans Italic
-12"</entry>
- </row>
-
- <row valign="top">
- <entry>"font-desc"</entry>
- <entry>Read-Write</entry>
- <entry>The font description as a pango.FontDescription
-object</entry>
- </row>
-
- <row valign="top">
- <entry>"foreground"</entry>
- <entry>Write</entry>
- <entry>The foreground color as a string</entry>
- </row>
-
- <row valign="top">
- <entry>"foreground-gdk"</entry>
- <entry>Read-Write</entry>
- <entry>The foreground color as a (possibly unallocated) <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link></entry>
- </row>
-
- <row valign="top">
- <entry>"foreground-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the
-foreground color</entry>
- </row>
-
- <row valign="top">
- <entry>"foreground-stipple"</entry>
- <entry>Read-Write</entry>
- <entry>The bitmap to use as a mask when drawing the text
-foreground</entry>
- </row>
-
- <row valign="top">
- <entry>"foreground-stipple-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the
-foreground stipple</entry>
- </row>
-
- <row valign="top">
- <entry>"indent"</entry>
- <entry>Read-Write</entry>
- <entry>The amount to indent the paragraph, in pixels</entry>
- </row>
-
- <row valign="top">
- <entry>"indent-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects
-indentation</entry>
- </row>
-
- <row valign="top">
- <entry>"invisible"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this text is hidden</entry>
- </row>
-
- <row valign="top">
- <entry>"invisible-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects text
-visibility</entry>
- </row>
-
- <row valign="top">
- <entry>"justification"</entry>
- <entry>Read-Write</entry>
- <entry>The text justification:
-<literal>gtk.JUSTIFY_LEFT</literal>, <literal>gtk.JUSTIFY_RIGHT</literal>,
-<literal>gtk.JUSTIFY_CENTER</literal> or
-<literal>gtk.JUSTIFY_FILL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"justification-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects paragraph
-justification</entry>
- </row>
-
- <row valign="top">
- <entry>"language"</entry>
- <entry>Read-Write</entry>
- <entry>The language this text is in, as an ISO code. Pango can
-use this as a hint when rendering the text. If you don't understand this
-parameter, you probably don't need it.</entry>
- </row>
-
- <row valign="top">
- <entry>"language-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the
-language the text is rendered as</entry>
- </row>
-
- <row valign="top">
- <entry>"left-margin"</entry>
- <entry>Read-Write</entry>
- <entry>The width of the left margin in pixels</entry>
- </row>
-
- <row valign="top">
- <entry>"left-margin-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the left
-margin</entry>
- </row>
-
- <row valign="top">
- <entry>"name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the texttag or <literal>None</literal> if
-anonymous</entry>
- </row>
-
- <row valign="top">
- <entry>"paragraph-background"</entry>
- <entry>Write</entry>
- <entry>The paragraph background color as a string. This
- property is available in GTK+ 2.8 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"paragraph-background-gdk"</entry>
- <entry>Read-Write</entry>
- <entry>The paragraph background color as a as a (possibly
- unallocated) <link
- linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>.
- This property is available in GTK+ 2.8 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"paragraph-background-set"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>True</literal> this tag affects the
- paragraph background color</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels-above-lines"</entry>
- <entry>Read-Write</entry>
- <entry>The number of pixels of blank space above
-paragraphs</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels-above-lines-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the number
-of pixels above lines</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels-below-lines"</entry>
- <entry>Read-Write</entry>
- <entry>The number of pixels of blank space below
-paragraphs</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels-below-lines-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the number
-of pixels above lines</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels-inside-wrap"</entry>
- <entry>Read-Write</entry>
- <entry>The number of pixels of blank space between wrapped
-lines in a paragraph</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels-inside-wrap-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the number
-of pixels between wrapped lines</entry>
- </row>
-
- <row valign="top">
- <entry>"right-margin"</entry>
- <entry>Read-Write</entry>
- <entry>The width of the right margin in pixels</entry>
- </row>
-
- <row valign="top">
- <entry>"right-margin-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the right
-margin</entry>
- </row>
-
- <row valign="top">
- <entry>"rise"</entry>
- <entry>Read-Write</entry>
- <entry>The offset of text above the baseline (below the
-baseline if rise is negative) in pixels</entry>
- </row>
-
- <row valign="top">
- <entry>"rise-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the
-rise</entry>
- </row>
-
- <row valign="top">
- <entry>"scale"</entry>
- <entry>Read-Write</entry>
- <entry>The font size as a scale factor relative to the default
-font size. This properly adapts to theme changes etc. so is recommended.
-Pango predefines some scales such as
-<literal>pango.SCALE_XX_SMALL</literal>,
-<literal>pango.SCALE_X_SMALL</literal>,
-<literal>pango.SCALE_SMALL</literal>, <literal>pango.SCALE_MEDIUM</literal>,
-<literal>pango.SCALE_LARGE</literal>,
-<literal>pango.SCALE_X_LARGE</literal>,
-<literal>pango.SCALE_XX_LARGE</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"scale-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag scales the font
-size by a factor</entry>
- </row>
-
- <row valign="top">
- <entry>"size"</entry>
- <entry>Read-Write</entry>
- <entry>The font size in Pango units.</entry>
- </row>
-
- <row valign="top">
- <entry>"size-points"</entry>
- <entry>Read-Write</entry>
- <entry>The font size in points</entry>
- </row>
-
- <row valign="top">
- <entry>"size-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the font
-size</entry>
- </row>
-
- <row valign="top">
- <entry>"stretch"</entry>
- <entry>Read-Write</entry>
- <entry>The font stretch - one of:
-<literal>pango.STRETCH_ULTRA_CONDENSED</literal>,
-<literal>pango.STRETCH_EXTRA_CONDENSED</literal>,
-<literal>pango.STRETCH_CONDENSED</literal>,
-<literal>pango.STRETCH_SEMI_CONDENSED</literal>,
-<literal>pango.STRETCH_NORMAL</literal>,
-<literal>pango.STRETCH_SEMI_EXPANDED</literal>,
-<literal>pango.STRETCH_EXPANDED</literal>,
-<literal>pango.STRETCH_EXTRA_EXPANDED</literal>,
-<literal>pango.STRETCH_ULTRA_EXPANDED</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"stretch-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the font
-stretch</entry>
- </row>
-
- <row valign="top">
- <entry>"strikethrough"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, strike through the
-text</entry>
- </row>
-
- <row valign="top">
- <entry>"strikethrough-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects
-strikethrough</entry>
- </row>
-
- <row valign="top">
- <entry>"style"</entry>
- <entry>Read-Write</entry>
- <entry>The font style - one of:
-<literal>pango.STYLE_NORMAL</literal>,
-<literal>pango.STYLE_OBLIQUE</literal> or
-<literal>pango.STYLE_ITALIC</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"style-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the font
-style</entry>
- </row>
-
- <row valign="top">
- <entry>"tabs"</entry>
- <entry>Read-Write</entry>
- <entry>The custom tabs for this text</entry>
- </row>
-
- <row valign="top">
- <entry>"tabs-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects
-tabs</entry>
- </row>
-
- <row valign="top">
- <entry>"underline"</entry>
- <entry>Read-Write</entry>
- <entry>The style of underline for this text:
-<literal>pango.UNDERLINE_NONE</literal>,
-<literal>pango.UNDERLINE_SINGLE</literal>,
-<literal>pango.UNDERLINE_DOUBLE</literal> or
-<literal>pango.UNDERLINE_LOW</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"underline-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects
-underlining</entry>
- </row>
-
- <row valign="top">
- <entry>"variant"</entry>
- <entry>Read-Write</entry>
- <entry>The font variant - either
-<literal>pango.VARIANT_NORMAL</literal> or
-<literal>pango.VARIANT_SMALL_CAPS</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"variant-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the font
-variant</entry>
- </row>
-
- <row valign="top">
- <entry>"weight"</entry>
- <entry>Read-Write</entry>
- <entry>The font weight as an integer:
-<literal>pango.WEIGHT_ULTRALIGHT</literal> = 200,
-<literal>pango.WEIGHT_LIGHT</literal> = 300,
-<literal>pango.WEIGHT_NORMAL</literal> = 400,
-<literal>pango.WEIGHT_BOLD</literal> = 700,
-<literal>pango.WEIGHT_ULTRABOLD</literal> = 800,
-<literal>pango.WEIGHT_HEAVY</literal> = 900.</entry>
- </row>
-
- <row valign="top">
- <entry>"weight-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects the font
-weight</entry>
- </row>
-
- <row valign="top">
- <entry>"wrap-mode"</entry>
- <entry>Read-Write</entry>
- <entry>The wrap mode of the text:
-<literal>gtk.WRAP_NONE</literal>, <literal>gtk.WRAP_CHAR</literal> or
-<literal>gtk.WRAP_WORD</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"wrap-mode-set"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, this tag affects line wrap
-mode</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktexttag">
- <title>gtk.TextTag Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtktexttag--event">event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> object
-holds attributes that can be applied to a range of text in a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>.
-A texttag can be associated with more than one <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-by adding it to the <link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
-objects of the textbuffers. The attributes of a texttag can be set using the
-<link
-linkend="method-gobject--set-property"><methodname>GObject.set_property</methodname>()</link>
-method or as part of texttag creation using the <link
-linkend="method-gtktextbuffer--create-tag"><methodname>gtk.TextBuffer.create_tag</methodname>()</link>
-method. Since not every attribute property of a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> may be
-set each attribute property has a boolean property that indicates whether
-the attribute property is set by this texttag. Therefore before retrieving
-an attribute value from a texttag you have to check if the associated
-boolean property of the attribute property is
-<literal>True</literal>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktexttag">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TextTag</methodname>
- <methodparam><parameter
- role="keyword">name</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>tag name, or <literal>None</literal> if the
-texttag is anonymous</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> with
-the name specified by <parameter>name</parameter>. If
-<parameter>name</parameter> is <literal>None</literal> the texttag will be
-anonymous. The texttag attributes are configured using the <link
-linkend="method-gobject--set-property"><methodname>GObject.set_property</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktexttag--get-priority">
- <title>gtk.TextTag.get_priority</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_priority</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the texttag's priority.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The get_priority() method returns the priority or the
-texttag.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktexttag--set-priority">
- <title>gtk.TextTag.set_priority</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_priority</methodname>
- <methodparam><parameter
- role="keyword">priority</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">priority</parameter>&nbsp;:</term>
- <listitem><simpara>the new priority</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_priority</methodname>() method sets the
-priority of a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> to the
-value specified by <parameter>priority</parameter>. Valid priorities start
-at 0 and go to one less than the value returned by the <link
-linkend="method-gtktexttagtable--get-size"><methodname>gtk.TextTagTable.get_size</methodname>()</link>
-method. Each texttag in a table has a unique priority; setting the priority
-of one texttag shifts the priorities of all the other texttags in the table
-to maintain a unique priority for each texttag. Higher priority tags "win"
-if two texttags both set the same text attribute for a range of text. When
-adding a texttag to a <link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>,
-it will be assigned the highest priority in the table by default; so
-normally the precedence of a set of texttags is the order in which they were
-added to the table, or created with the <link
-linkend="method-gtktextbuffer--create-tag"><methodname>gtk.TextBuffer.create_tag</methodname>()</link>
-method, that adds the texttag to the buffer's table automatically.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktexttag--event">
- <title>gtk.TextTag.event</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>event</methodname>
- <methodparam><parameter
- role="keyword">event_object</parameter></methodparam>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">event_object</parameter>&nbsp;:</term>
- <listitem><simpara>the object that received the event, such as a
-widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>the event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>the location where the event was
-received</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the result of signal emission (whether the
-event was handled)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>event</methodname>() method emits the "event"
-signal on the <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> for the
-widget specified by <parameter>event_object</parameter> with the event
-specified by <parameter>event</parameter> at the textbuffer location
-specified by <parameter>iter</parameter>. This method returns
-<literal>True</literal> if the event was handled.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktexttag--event">
- <title>The "event" gtk.TextTag Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>texttag</parameter>&nbsp;:</term>
- <listitem><simpara>the texttag that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received
-<parameter>event</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-pointing to the location where the event was received</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "event" signal is emitted when an event occurs in a range of
-text that is enclosed in the <parameter>texttag</parameter>. The widget that
-the event occurred in is specified by <parameter>widget</parameter>.
-<parameter>iter</parameter> holds the location that the event occurred at
-and <parameter>event</parameter> describes the event.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktexttagtable.xml b/docs/reference/pygtk-gtktexttagtable.xml
deleted file mode 100644
index acdc3e54..00000000
--- a/docs/reference/pygtk-gtktexttagtable.xml
+++ /dev/null
@@ -1,443 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktexttagtable">
- <refnamediv>
- <refname>gtk.TextTagTable</refname>
- <refpurpose>A collection of <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> objects
-that can be used together</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TextTagTable</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktexttagtable">gtk.TextTagTable</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktexttagtable--add">add</link></methodname>
- <methodparam><parameter role="keyword">tag</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktexttagtable--remove">remove</link></methodname>
- <methodparam><parameter role="keyword">tag</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktexttagtable--lookup">lookup</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktexttagtable--foreach">foreach</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktexttagtable--get-size">get_size</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtktexttagtable">gtk.TextTagTable</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktexttagtable">
- <title>gtk.TextTagTable Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtktexttagtable--tag-added">tag-added</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>texttagtable</parameter></methodparam>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtktexttagtable--tag-changed">tag-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>texttagtable</parameter></methodparam>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>size_changed</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtktexttagtable--tag-removed">tag-removed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>texttagtable</parameter></methodparam>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
-object holds a set of <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> objects
-for use with a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>.
-Usually a <link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
-is created automatically when a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-is created but a standalone <link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
-can be created using the <link
-linkend="constructor-gtktexttagtable">gtk.TextTagTable</link>() constructor.
-A <link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
-can be passed as an argument to the <link
-linkend="constructor-gtktextbuffer">gtk.TextBuffer</link>() constructor to
-associate an existing <link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
-rather than creating a new one. This is useful when several textbuffers need
-to use the same texttags.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktexttagtable">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TextTagTable</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>.
-The table contains no tags by default.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktexttagtable--add">
- <title>gtk.TextTagTable.add</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add</methodname>
- <methodparam><parameter
- role="keyword">tag</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add</methodname>() method adds a texttag to the
-texttagtable. The texttag is assigned the highest priority in the
-texttagtable. A <literal>ValueError</literal> exception is raised if
-<parameter>tag</parameter> is in a texttag table already, or has the same
-name as another texttag in the texttagtable.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktexttagtable--remove">
- <title>gtk.TextTagTable.remove</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove</methodname>
- <methodparam><parameter
- role="keyword">tag</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove</methodname>() method removes a texttag
-from the texttagtable.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktexttagtable--lookup">
- <title>gtk.TextTagTable.lookup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>lookup</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a texttag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The texttag, or <literal>None</literal> if none
-by that name is in the texttagtable.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>lookup</methodname>() method looks in the
-texttagtable for a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> with
-the name specified by <parameter>name</parameter> and returns it if found.
-This method returns <literal>None</literal> if <parameter>name</parameter>
-does not identify a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> in the
-texttagtable.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktexttagtable--foreach">
- <title>gtk.TextTagTable.foreach</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>foreach</methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>a function to call on each texttag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to
- <parameter>func</parameter> or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>foreach</methodname>() method calls the function
-specified by <parameter>func</parameter> on each texttag in the text tag
-table passing the user data specified by <parameter>data</parameter>. The
-signature of <parameter>func</parameter> is:</para>
-
- <programlisting>
- def func(texttag, user_data):
-</programlisting>
-
- <para>where <parameter>texttag</parameter> is a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> in the
-text tag table and <parameter>user_data</parameter> is
-<parameter>data</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktexttagtable--get-size">
- <title>gtk.TextTagTable.get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of texttags in the
-texttagtable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_size</methodname>() method returns the size
-of the texttagtable (number of texttags).</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktexttagtable--tag-added">
- <title>The "tag-added" gtk.TextTagTable Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>texttagtable</parameter></methodparam>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>texttagtable</parameter>&nbsp;:</term>
- <listitem><simpara>the texttagtable that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>texttag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "tag-added" signal is emitted when the <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
-specified by <parameter>texttag</parameter> is added to
-<parameter>texttagtable</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktexttagtable--tag-changed">
- <title>The "tag-changed" gtk.TextTagTable Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>texttagtable</parameter></methodparam>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>size_changed</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>texttagtable</parameter>&nbsp;:</term>
- <listitem><simpara>the texttagtable that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>texttag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>size_changed</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> a
-<parameter>texttag</parameter> property has changed that may affect the size
-of the text enclosed by the texttag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "tag-changed" signal is emitted when a property of the <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
-specified by <parameter>texttag</parameter> is changed. If
-<parameter>size_changed</parameter> is <literal>True</literal> the text
-enclosed by <parameter>texttag</parameter> will change size.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktexttagtable--tag-removed">
- <title>The "tag-removed" gtk.TextTagTable Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>texttagtable</parameter></methodparam>
- <methodparam><parameter>texttag</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>texttagtable</parameter>&nbsp;:</term>
- <listitem><simpara>the texttagtable that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>texttag</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "tag-removed" signal is emitted when the <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
-specified by <parameter>texttag</parameter> is removed from
-<parameter>texttagtable</parameter></para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktextview.xml b/docs/reference/pygtk-gtktextview.xml
deleted file mode 100644
index 2330395b..00000000
--- a/docs/reference/pygtk-gtktextview.xml
+++ /dev/null
@@ -1,3462 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktextview">
- <refnamediv>
- <refname>gtk.TextView</refname>
- <refpurpose>a widget that displays the contents of a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TextView</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktextview">gtk.TextView</link></methodname>
- <methodparam><parameter
- role="keyword">buffer</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-buffer">set_buffer</link></methodname>
- <methodparam><parameter
- role="keyword">buffer</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-buffer">get_buffer</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--scroll-to-iter">scroll_to_iter</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">within_margin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use_align</parameter><initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">xalign</parameter><initializer>0.5</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter><initializer>0.5</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--scroll-to-mark">scroll_to_mark</link></methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- <methodparam><parameter
- role="keyword">within_margin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use_align</parameter><initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">xalign</parameter><initializer>0.5</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter><initializer>0.5</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--scroll-mark-onscreen">scroll_mark_onscreen</link></methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--move-mark-onscreen">move_mark_onscreen</link></methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--place-cursor-onscreen">place_cursor_onscreen</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-visible-rect">get_visible_rect</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-cursor-visible">set_cursor_visible</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-cursor-visible">get_cursor_visible</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-iter-location">get_iter_location</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-iter-at-location">get_iter_at_location</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-line-yrange">get_line_yrange</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-line-at-y">get_line_at_y</link></methodname>
- <methodparam><parameter
- role="keyword">target_iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--buffer-to-window-coords">buffer_to_window_coords</link></methodname>
- <methodparam><parameter role="keyword">win</parameter></methodparam>
- <methodparam><parameter
- role="keyword">buffer_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">buffer_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--window-to-buffer-coords">window_to_buffer_coords</link></methodname>
- <methodparam><parameter role="keyword">win</parameter></methodparam>
- <methodparam><parameter
- role="keyword">window_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">window_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-window">get_window</link></methodname>
- <methodparam><parameter role="keyword">win</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-window-type">get_window_type</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-border-window-size">set_border_window_size</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-border-window-size">get_border_window_size</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--forward-display-line">forward_display_line</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--backward-display-line">backward_display_line</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--forward-display-line-end">forward_display_line_end</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--backward-display-line-start">backward_display_line_start</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--starts-display-line">starts_display_line</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--move-visually">move_visually</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--add-child-at-anchor">add_child_at_anchor</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anchor</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--add-child-in-window">add_child_in_window</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">which_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xpos</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ypos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--move-child">move_child</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xpos</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ypos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-wrap-mode">set_wrap_mode</link></methodname>
- <methodparam><parameter
- role="keyword">wrap_mode</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-wrap-mode">get_wrap_mode</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-editable">set_editable</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-editable">get_editable</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextview--set-overwrite">set_overwrite</link></methodname>
- <methodparam><parameter
- role="keyword">overwrite</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextview--get-overwrite">get_overwrite</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextview--set-accepts-tab">set_accepts_tab</link></methodname>
- <methodparam><parameter
- role="keyword">accepts_tab</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktextview--get-accepts-tab">get_accepts_tab</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-pixels-above-lines">set_pixels_above_lines</link></methodname>
- <methodparam><parameter
- role="keyword">pixels_above_lines</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-pixels-above-lines">get_pixels_above_lines</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-pixels-below-lines">set_pixels_below_lines</link></methodname>
- <methodparam><parameter
- role="keyword">pixels_below_lines</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-pixels-below-lines">get_pixels_below_lines</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-pixels-inside-wrap">set_pixels_inside_wrap</link></methodname>
- <methodparam><parameter
- role="keyword">pixels_inside_wrap</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-pixels-inside-wrap">get_pixels_inside_wrap</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-justification">set_justification</link></methodname>
- <methodparam><parameter
- role="keyword">justification</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-justification">get_justification</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-left-margin">set_left_margin</link></methodname>
- <methodparam><parameter
- role="keyword">left_margin</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-left-margin">get_left_margin</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-right-margin">set_right_margin</link></methodname>
- <methodparam><parameter
- role="keyword">right_margin</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-right-margin">get_right_margin</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-indent">set_indent</link></methodname>
- <methodparam><parameter
- role="keyword">indent</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-indent">get_indent</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--set-tabs">set_tabs</link></methodname>
- <methodparam><parameter
- role="keyword">tabs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-tabs">get_tabs</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview--get-default-attributes">get_default_attributes</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktextview- -get-iter-at-position">get_iter_at_position</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
-END OF NOT IMPLEMENTED -->
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtktextview">gtk.TextView</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktextview">
- <title>gtk.TextView Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"accepts-tab"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, pressing
-<keycap>Tab</keycap> will result in a tab character being entered; otherwise
-the focus will be moved. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"buffer"</entry>
- <entry>Read-Write</entry>
-
- <entry>The buffer that is displayed. Available in GTK+ 2.4 and
-above.</entry>
- </row>
-
- <row valign="top">
- <entry>"cursor-visible"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the insertion cursor is
-shown</entry>
- </row>
-
- <row valign="top">
- <entry>"editable"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the text can be modified by
-the user by default</entry>
- </row>
-
- <row valign="top">
- <entry>"indent"</entry>
- <entry>Read-Write</entry>
- <entry>The default amount to indent the paragraph, in
-pixels</entry>
- </row>
-
- <row valign="top">
- <entry>"justification"</entry>
- <entry>Read-Write</entry>
- <entry>The default text justification:
-<literal>gtk.JUSTIFY_LEFT</literal>, <literal>gtk.JUSTIFY_RIGHT</literal>,
-<literal>gtk.JUSTIFY_CENTER</literal> or
-<literal>gtk.JUSTIFY_FILL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"left-margin"</entry>
- <entry>Read-Write</entry>
- <entry>The default width of the left margin in pixels</entry>
- </row>
-
- <row valign="top">
- <entry>"overwrite"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, the entered text overwrites
- existing contents. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels-above-lines"</entry>
- <entry>Read-Write</entry>
- <entry>The default number of pixels of blank space above
-paragraphs</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels-below-lines"</entry>
- <entry>Read-Write</entry>
- <entry>The default number of pixels of blank space below
-paragraphs</entry>
- </row>
-
- <row valign="top">
- <entry>"pixels-inside-wrap"</entry>
- <entry>Read-Write</entry>
- <entry>The default number of pixels of blank space between
-wrapped lines in a paragraph</entry>
- </row>
-
- <row valign="top">
- <entry>"right-margin"</entry>
- <entry>Read-Write</entry>
- <entry>The default width of the right margin in pixels</entry>
- </row>
-
- <row valign="top">
- <entry>"tabs"</entry>
- <entry>Read-Write</entry>
- <entry>The default custom tabs</entry>
- </row>
-
- <row valign="top">
- <entry>"wrap-mode"</entry>
- <entry>Read-Write</entry>
- <entry>The default wrap mode:
-<literal>gtk.WRAP_NONE</literal>, <literal>gtk.WRAP_CHAR</literal> or
-<literal>gtk.WRAP_WORD</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtktextview">
- <title>gtk.TextView Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"error-underline-color"</entry>
- <entry>Read-Write</entry>
-
- <entry>The <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> with
-which to draw error-indication underlines. Available in GTK+ 2.4 and
-above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktextview">
- <title>gtk.TextView Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--backspace">backspace</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--copy-clipboard">copy-clipboard</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--cut-clipboard">cut-clipboard</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--delete-from-cursor">delete-from-cursor</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>delete_type</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--insert-at-cursor">insert-at-cursor</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>string</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--move-cursor">move-cursor</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>step_size</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>extend_selection</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--move-focus">move-focus</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>direction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--move-viewport">move-viewport</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>scrollstep</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--page-horizontally">page-horizontally</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>extend_selection</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--paste-clipboard">paste-clipboard</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--populate-popup">populate-popup</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>menu</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--select-all">select-all</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>select</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--set-anchor">set-anchor</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--set-scroll-adjustments">set-scroll-adjustments</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>hadjustment</parameter></methodparam>
- <methodparam><parameter>vadjustment</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktextview--toggle-overwrite">toggle-overwrite</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1 id="description-gtktextview">
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>
-widget provides the display for the contents of a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-object. A textview provides a set of attributes for the default display of
-text from a textbuffer. The attributes set by <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> objects
-override the attributes set on a <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>
-widget. Since a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-can be associated with multiple <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>
-widgets each having a different set of default attributes, the display of
-the same text in different textview widgets can be quite different except
-for those attributes that are overridden by texttags.</para>
-
- <para>A <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>
-widget has several <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-widgets most of which are not displayed by default:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_WIDGET</literal></term>
- <listitem>
- <simpara>The widget window</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_TEXT</literal></term>
- <listitem>
- <simpara>The window that holds the text</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_LEFT</literal></term>
- <listitem>
- <simpara>The left border window - not displayed by
-default</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_RIGHT</literal></term>
- <listitem>
- <simpara>The right border window - not displayed by
-default</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_TOP</literal></term>
- <listitem>
- <simpara>The top border window - not displayed by
-default</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_BOTTOM</literal></term>
- <listitem>
- <simpara>The bottom border window - not displayed by
-default</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_PRIVATE</literal></term>
- <listitem>
- <simpara>An internal inaccessible <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The border windows are not created until they are given a size by
-using the <link
-linkend="method-gtktextview--set-border-window-size"><methodname>set_border_window_size</methodname>()</link>
-method.</para>
-
- <para>Depending on the wrap mode of the textview a textbuffer line may be
-displayed as more than one screen display line. The textview has methods to
-navigate through the display lines.</para>
-
- <para>A <link
-linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>
-in a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-provides a place for a <literal>PyGTK</literal> widget to be placed in a
-<link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>. Each
-textview displaying the same textbuffer with a child anchor must have a
-different widget placed at that child anchor. In addition, a widget can be
-placed at a specific location in one of the above <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>
-windows using the <link
-linkend="method-gtktextview--add-child-in-window"><methodname>add_child_in_window</methodname>()</link>
-method. The widget will be clipped to the window boundaries if it is larger
-than the window or located where it extends beyond the window
-boundaries.</para>
-
- <para>A <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link> has a
-default popup menu that includes the usual cut, copy and paste
-capabilities. In PyGTK 2.2 <link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
-objects are supported so your program can access the contents of the cut,
-copy and paste clipboard through the
-<literal>gdk.SELECTION_CLIPBOARD</literal> clipboard. Also the selected text
-in a <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link> is
-available on the <literal>gdk.SELECTION_PRIMARY</literal> clipboard.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktextview">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TextView</methodname>
- <methodparam><parameter
- role="keyword">buffer</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">buffer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>
-widget displaying the <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-specified by <parameter>buffer</parameter>. If <parameter>buffer</parameter>
-is <literal>None</literal>, a new <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-will be created. One textbuffer can be shared among many widgets.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktextview--set-buffer">
- <title>gtk.TextView.set_buffer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_buffer</methodname>
- <methodparam><parameter
- role="keyword">buffer</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">buffer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_buffer</methodname>() method sets the <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-specified by <parameter>buffer</parameter> as the textbuffer being displayed
-by the textview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-buffer">
- <title>gtk.TextView.get_buffer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_buffer</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_buffer</methodname>() method returns the
-<link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
-being displayed by this textview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--scroll-to-iter">
- <title>gtk.TextView.scroll_to_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>scroll_to_iter</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">within_margin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use_align</parameter><initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">xalign</parameter><initializer>0.5</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter><initializer>0.5</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">within_margin</parameter>&nbsp;:</term>
- <listitem><simpara>the margin as a [0.0,0.5) fraction of screen
-size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">use_align</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> use the alignment
-arguments; if <literal>False</literal>, just get <parameter>iter</parameter>
-on screen</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xalign</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal alignment of
-<parameter>iter</parameter> within visible area.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">yalign</parameter>&nbsp;:</term>
- <listitem><simpara>the vertical alignment of
-<parameter>iter</parameter> within visible area</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if scrolling
-occurred</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>scroll_to_iter</methodname>() method scrolls the
-textview so that the <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-location specified by <parameter>iter</parameter> is on the screen in the
-position indicated by <parameter>xalign</parameter> and
-<parameter>yalign</parameter>. If <parameter>use_align</parameter> is
-<literal>True</literal> the alignments specify the fraction of screen space
-to the left of or above the location of <parameter>iter</parameter>. If
-<parameter>use_align</parameter> is <literal>False</literal>, the text
-scrolls the minimal distance to get <parameter>iter</parameter> on screen,
-possibly not scrolling at all. The effective screen for purposes of this
-method is reduced by a margin of size specified by
-<parameter>within_margin</parameter>.</para>
-
- <note>
- <para>This method uses the currently-computed height of the lines in
-the text buffer. The line heights are computed in an idle handler so this
-method may not have the desired effect if it's called before the height
-computations are complete. To avoid oddness, consider using the <link
-linkend="method-gtktextview--scroll-to-mark"><methodname>scroll_to_mark</methodname>()</link>
-method that saves a point to be scrolled to after line validation.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--scroll-to-mark">
- <title>gtk.TextView.scroll_to_mark</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>scroll_to_mark</methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- <methodparam><parameter
- role="keyword">within_margin</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use_align</parameter><initializer>False</initializer></methodparam>
- <methodparam><parameter
- role="keyword">xalign</parameter><initializer>0.5</initializer></methodparam>
- <methodparam><parameter
- role="keyword">yalign</parameter><initializer>0.5</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mark</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">within_margin</parameter>&nbsp;:</term>
- <listitem><simpara>the margin as a [0.0,0.5) fraction of screen
-size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">use_align</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> use the alignment
-arguments; if <literal>False</literal>, just get <parameter>mark</parameter>
-on screen</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xalign</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal alignment of
-<parameter>mark</parameter> within the visible area.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">yalign</parameter>&nbsp;:</term>
- <listitem><simpara>the vertical alignment of
-<parameter>mark</parameter> within the visible area</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>scroll_to_mark</methodname>() method scrolls the
-textview so that the <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-location specified by <parameter>mark</parameter> is on the screen in the
-position specified by <parameter>xalign</parameter> and
-<parameter>yalign</parameter>. If <parameter>use_align</parameter> is
-<literal>True</literal> the alignments specify the fraction of screen space
-to the left of or above the location of <parameter>mark</parameter>. If
-<parameter>use_align</parameter> is <literal>False</literal>, the text
-scrolls the minimal distance to get <parameter>mark</parameter> on screen,
-possibly not scrolling at all. The effective screen for purposes of this
-function is reduced by a margin of size specified by
-<parameter>within_margin</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--scroll-mark-onscreen">
- <title>gtk.TextView.scroll_mark_onscreen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>scroll_mark_onscreen</methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mark</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link> in
-the textbuffer for textview</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>scroll_mark_onscreen</methodname>() method
-scrolls the textview the minimum distance to place the <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-location specified by <parameter>mark</parameter> within the visible area of
-the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--move-mark-onscreen">
- <title>gtk.TextView.move_mark_onscreen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_mark_onscreen</methodname>
- <methodparam><parameter
- role="keyword">mark</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mark</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>mark</parameter> moved (wasn't already
-on screen)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>move_mark_onscreen</methodname>() moves the
-<link linkend="class-gtktextmark"><classname>gtk.TextMark</classname></link>
-location specified by <parameter>mark</parameter> to a location within the
-currently-visible text area of the textview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--place-cursor-onscreen">
- <title>gtk.TextView.place_cursor_onscreen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>place_cursor_onscreen</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the cursor had to be
-moved.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>place_cursor_onscreen</methodname>() method
-moves the cursor to a new location within the currently visible region of
-the buffer, if it isn't there already.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-visible-rect">
- <title>gtk.TextView.get_visible_rect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_rect</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visible_rect</methodname>() method returns a
-<link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-containing the coordinates of the currently-visible region of the buffer.
-The rectangle is in buffer coordinates that can be converted to window
-coordinates with the <link
-linkend="method-gtktextview--buffer-to-window-coords"><methodname>buffer_to_window_coords</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-cursor-visible">
- <title>gtk.TextView.set_cursor_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_cursor_visible</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> show the insertion
-cursor</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_cursor_visible</methodname>() method sets
-the "cursor-visible" property to the value of
-<parameter>setting</parameter>. If <parameter>setting</parameter> is
-<literal>True</literal> the cursor is visible; if <literal>False</literal>,
-it is not. A buffer with no editable text probably shouldn't have a visible
-cursor, so you may want to turn the cursor off.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-cursor-visible">
- <title>gtk.TextView.get_cursor_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_cursor_visible</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the insertion mark
-is visible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_cursor_visible</methodname>() method returns
-the value of the "cursor-visible" property that determines if the insertion
-point is visible.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-iter-location">
- <title>gtk.TextView.get_iter_location</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_location</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-containing the bounds of the character at
-<parameter>iter</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter_location</methodname>() method returns
-a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-that contains the character at the location specified by
-<parameter>iter</parameter>. The rectangle position is in buffer coordinates
-that can be converted to window coordinates with the <link
-linkend="method-gtktextview--buffer-to-window-coords"><methodname>buffer_to_window_coords</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-iter-at-location">
- <title>gtk.TextView.get_iter_at_location</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_at_location</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>x position, in buffer
-coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>y position, in buffer
-coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter_at_location</methodname>() method
-returns a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link> that
-points at the location specified by the buffer coordinates
-<parameter>x</parameter> and <parameter>y</parameter>. Buffer coordinates
-are coordinates for the entire buffer, not just the currently-displayed
-portion. Window coordinates from an event, must be converted to buffer
-coordinates with the <link
-linkend="method-gtktextview--window-to-buffer-coords"><methodname>window_to_buffer_coords</methodname>()</link>
-method before using them with this method.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtktextview- -get-iter-at-position">
- <title>gtk.TextView.get_iter_at_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_at_position</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>x position, in buffer
-coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>y position, in buffer
-coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link> and
-an integer indicating where in the grapheme the user clicked. It will either
-be zero, or the number of characters in the grapheme. 0 represents the
-trailing edge of the grapheme.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_iter_at_position</methodname>() method
-returns a 2-tuple containing a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link> that
-points at the location specified by the buffer coordinates
-<parameter>x</parameter> and <parameter>y</parameter> and an integer
-indicating where in the grapheme the user clicked. It will either be zero,
-or the number of characters in the grapheme. 0 represents the trailing edge
-of the grapheme.</para>
-
- <para>Buffer coordinates are coordinates for the entire buffer, not
-just the currently-displayed portion. Window coordinates from an event,
-must be converted to buffer coordinates with the <link
-linkend="method-gtktextview- -window-to-buffer-coords"><methodname>window_to_buffer_coords</methodname>()</link>
-method before using them with this method.</para>
-
- <para>Note that this method is different from the <link
-linkend="method-gtktextview- -get-iter-at-location"><methodname>get_iter_at_location</methodname>()</link>
-method that returns cursor locations, i.e. positions between
-characters.</para>
-
- </refsect2>
-END OF NOT IMPLEMENTED -->
-
- <refsect2 id="method-gtktextview--get-line-yrange">
- <title>gtk.TextView.get_line_yrange</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line_yrange</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a y coordinate and a
-height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_line_yrange</methodname>() method locates
-the line containing the <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-specified by <parameter>iter</parameter> and returns a tuple containing the
-y coordinate of the top of the line and the height of the line. The
-coordinate is a buffer coordinate that can be converted to window
-coordinates with the <link
-linkend="method-gtktextview--buffer-to-window-coords"><methodname>buffer_to_window_coords</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-line-at-y">
- <title>gtk.TextView.get_line_at_y</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line_at_y</methodname>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>a y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-pointing at the line start and the top coordinate of the
-line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_line_at_y</methodname>() method returns a
-tuple containing:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link>
-pointing at the start of the line with the vertical coordinate specified by
-<parameter>y</parameter> and,</simpara>
- </listitem>
- <listitem>
- <simpara>the vertical coordinate of the top edge of the
-line.</simpara>
- </listitem>
- </itemizedlist>
-
- <para><parameter>y</parameter> is in buffer coordinates that can be
-converted from window coordinates with the <link
-linkend="method-gtktextview--window-to-buffer-coords"><methodname>window_to_buffer_coords</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--buffer-to-window-coords">
- <title>gtk.TextView.buffer_to_window_coords</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>buffer_to_window_coords</methodname>
- <methodparam><parameter
- role="keyword">win</parameter></methodparam>
- <methodparam><parameter
- role="keyword">buffer_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">buffer_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">win</parameter>&nbsp;:</term>
- <listitem><simpara>one of the textview windows except
-<literal>gtk.TEXT_WINDOW_PRIVATE</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">buffer_x</parameter>&nbsp;:</term>
- <listitem><simpara>buffer x coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">buffer_y</parameter>&nbsp;:</term>
- <listitem><simpara>buffer y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the window x and y
-coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>buffer_to_window_coords</methodname>() method
-returns a tuple containing the x and y coordinates for the window specified
-by <parameter>win</parameter> that correspond to the textbuffer coordinates
-specified by <parameter>buffer_x</parameter> and
-<parameter>buffer_y</parameter>. See the above <link
-linkend="description-gtktextview">description</link> for more details on
-textview window types.</para>
-
- <note>
- <para>You can't convert coordinates for a non-existing window (see
-the <link
-linkend="method-gtktextview--set-border-window-size"><methodname>set_border_window_size</methodname>()</link>
-method).</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--window-to-buffer-coords">
- <title>gtk.TextView.window_to_buffer_coords</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>window_to_buffer_coords</methodname>
- <methodparam><parameter
- role="keyword">win</parameter></methodparam>
- <methodparam><parameter
- role="keyword">window_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">window_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">win</parameter>&nbsp;:</term>
- <listitem><simpara>a textview window except
-<literal>gtk.TEXT_WINDOW_PRIVATE</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">window_x</parameter>&nbsp;:</term>
- <listitem><simpara>window x coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">window_y</parameter>&nbsp;:</term>
- <listitem><simpara>window y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the textbuffer x and y
-coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>window_to_buffer_coords</methodname>() method
-returns a tuple containing the textbuffer x and y coordinates corresponding
-to the <parameter>window_x</parameter> and<parameter> window_y</parameter>
-coordinates in the window specified by <parameter>win</parameter>, See the
-above <link linkend="description-gtktextview">description</link> for more
-details on textview window types.</para>
-
- <note>
- <para>You can't convert coordinates for a non-existing window (see
-the <link
-linkend="method-gtktextview--set-border-window-size"><methodname>set_border_window_size</methodname>()</link>)
-method.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-window">
- <title>gtk.TextView.get_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_window</methodname>
- <methodparam><parameter
- role="keyword">win</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">win</parameter>&nbsp;:</term>
- <listitem><simpara>a textview window type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_window</methodname>() method returns the
-<link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-corresponding to an area of the textview specified by
-<parameter>win</parameter>:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_WIDGET</literal></term>
- <listitem>
- <simpara>The widget window</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_TEXT</literal></term>
- <listitem>
- <simpara>The window that holds the text</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_LEFT</literal></term>
- <listitem>
- <simpara>The left border window - not displayed by
-default</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_RIGHT</literal></term>
- <listitem>
- <simpara>The right border window - not displayed by
-default</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_TOP</literal></term>
- <listitem>
- <simpara>The top border window - not displayed by
-default</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_BOTTOM</literal></term>
- <listitem>
- <simpara>The bottom border window - not displayed by
-default</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TEXT_WINDOW_PRIVATE</literal></term>
- <listitem>
- <simpara>An internal inaccessible <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>This method returns <literal>None</literal> if the window is
-nonexistent i.e. if its width or height is 0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-window-type">
- <title>gtk.TextView.get_window_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_window_type</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>a window type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the window type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_window_type</methodname>() method returns
-the type of the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-specified by <parameter>window</parameter>. This method is used to find out
-what window type an event corresponds to. If you connect to an event signal
-on the textview, this method can be called on
-<literal>event.window</literal> to see what window type it was. See the
-<link
-linkend="method-gtktextview--get-window"><methodname>get_window</methodname>()</link>
-method for more details on window types.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-border-window-size">
- <title>gtk.TextView.set_border_window_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_border_window_size</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a textview border window
-type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the width or height of the
-window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_border_window_size</methodname>() method
-sets the width of a <literal>gtk.TEXT_WINDOW_LEFT</literal> or
-<literal>gtk.TEXT_WINDOW_RIGHT</literal> window, or the height of a
-<literal>gtk.TEXT_WINDOW_TOP</literal> or
-<literal>gtk.TEXT_WINDOW_BOTTOM</literal> window. This method automatically
-destroys the corresponding window if the size is set to 0, and creates the
-window if the size is set to non-zero. This method can only be used for the
-"border windows", it doesn't work with the
-<literal>gtk.TEXT_WINDOW_WIDGET</literal>,
-<literal>gtk.TEXT_WINDOW_TEXT</literal>, or
-<literal>gtk.TEXT_WINDOW_PRIVATE</literal> windows.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-border-window-size">
- <title>gtk.TextView.get_border_window_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_border_window_size</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>a textview border window
-type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the width or height of the textview border
-window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_border_window_size</methodname>() method
-returns the width or height of the border window of the type specified by
-<parameter>type</parameter>. See the <link
-linkend="method-gtktextview--set-border-window-size"><methodname>set_border_window_size</methodname>()</link>
-method for more details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--forward-display-line">
- <title>gtk.TextView.forward_display_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_display_line</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>iter</parameter> was moved and is not on the end
-iterator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_display_line</methodname>() method moves
-the location of <parameter>iter</parameter> forward by one display line. A
-textview display line is different from a textbuffer line. Textbuffer lines
-are paragraphs and are separated by newlines or other paragraph separator
-characters. Display lines are created by line-wrapping a textbuffer line. If
-wrapping is turned off, display lines and textbuffer lines will be the same.
-Display lines are divided differently for each textview, since they depend
-on the textview's width and the textview's default wrap mode. Paragraphs are
-the same in all views, since they depend on the contents of the <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>.
-This method returns <literal>True</literal> if the location of
-<parameter>iter</parameter> moves to a dereferenceable position (i.e. not
-the end position).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--backward-display-line">
- <title>gtk.TextView.backward_display_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_display_line</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>iter</parameter> was moved</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_display_line</methodname>() method
-moves the location of <parameter>iter</parameter> backward by one display
-line. A textview display line is different from a textbuffer line. Textview
-lines are paragraphs and are separated by newlines or other paragraph
-separator characters. Display lines are created by line-wrapping a
-textbuffer line. If wrapping is turned off, display lines and textbuffer
-lines will be the same. Display lines are divided differently for each
-textview, since they depend on the textview's width and the textview's
-default wrap mode. Paragraphs are the same in all views, since they depend
-on the contents of the <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>.
-This method returns <literal>True</literal> if the location of
-<parameter>iter</parameter> moves to a dereferenceable position (i.e. not
-the end position).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--forward-display-line-end">
- <title>gtk.TextView.forward_display_line_end</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>forward_display_line_end</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>iter</parameter> was moved and is not on the end
-iterator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>forward_display_line_end</methodname>() method
-moves the location of <parameter>iter</parameter> forward to the next
-display line end. A textview display line is different from a textbuffer
-line. Textbuffer lines are paragraphs and are separated by newlines or other
-paragraph separator characters. Display lines are created by line-wrapping a
-textbuffer line. If wrapping is turned off, display lines and textbuffer
-lines will be the same. Display lines are divided differently for each
-textview, since they depend on the textview's width and the textview's
-default wrap mode. Paragraphs are the same in all views, since they depend
-on the contents of the <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>.
-This method returns <literal>True</literal> if the location of
-<parameter>iter</parameter> moves to a dereferenceable position (i.e. not
-the end position).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--backward-display-line-start">
- <title>gtk.TextView.backward_display_line_start</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>backward_display_line_start</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>iter</parameter> was moved</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>backward_display_line_start</methodname>()
-method moves the location of <parameter>iter</parameter> backward to the
-next display line start. A textview display line is different from a
-textbuffer line. Textbuffer lines are paragraphs and are separated by newlines
-or other paragraph separator characters. Display lines are created by
-line-wrapping a textbuffer line. If wrapping is turned off, display lines
-and textbuffer lines will be the same. Display lines are divided differently
-for each textview, since they depend on the textview's width and the
-textview's default wrap mode. Paragraphs are the same in all views, since
-they depend on the contents of the <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>.
-This method returns <literal>True</literal> if the location of
-<parameter>iter</parameter> moves to a dereferenceable position (i.e. not
-the end position).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--starts-display-line">
- <title>gtk.TextView.starts_display_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>starts_display_line</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the location of
-<parameter>iter</parameter> is at the beginning of a display
-line</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>starts_display_line</methodname>() method
-returns <literal>True</literal> if the location of
-<parameter>iter</parameter> is at the start of a display line. See the <link
-linkend="method-gtktextview--forward-display-line"><methodname>forward_display_line</methodname>()</link>
-method for an explanation of display lines vs. textbuffer lines
-(paragraphs).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--move-visually">
- <title>gtk.TextView.move_visually</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_visually</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">count</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextiter"><classname>gtk.TextIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of characters to move (may be
-negative)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>iter</parameter> moved and is not on the end
-iterator</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The<methodname> move_visually</methodname>() method moves the
-location of <parameter>iter</parameter> by <parameter>count</parameter>
-cursor positions. If count is negative the location moves against the
-normal text direction. Note a cursor position move may move over multiple
-characters when multiple characters combine to form one grapheme.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--add-child-at-anchor">
- <title>gtk.TextView.add_child_at_anchor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_child_at_anchor</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">anchor</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">anchor</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>
-in the textview's <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_child_at_anchor</methodname>() method adds
-the widget specified by <parameter>child</parameter> in the textview, at the
-<link
-linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>
-specified by <parameter>anchor</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--add-child-in-window">
- <title>gtk.TextView.add_child_in_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_child_in_window</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">which_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xpos</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ypos</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">which_window</parameter>&nbsp;:</term>
- <listitem><simpara>the textview window
-<parameter>child</parameter> should appear in</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xpos</parameter>&nbsp;:</term>
- <listitem><simpara>the X position of <parameter>child</parameter>
-in window coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ypos</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position of <parameter>child</parameter>
-in window coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_child_in_window</methodname>() method adds
-the widget specified by <parameter>child</parameter> at the fixed
-coordinates specified by <parameter>xpos</parameter> and
-<parameter>ypos</parameter> in one of the text widget's windows specified by
-<parameter>which_window</parameter>. The window must have nonzero size (see
-the <link
-linkend="method-gtktextview--set-border-window-size"><methodname>set_border_window_size</methodname>()</link>
-method).</para>
-
- <note>
- <para>The <parameter>child</parameter> coordinates are given
-relative to the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-specified by <parameter>which_window</parameter>, and these coordinates have
-no sane relationship to scrolling. When placing <parameter>child</parameter>
-in a <literal>gtk.TEXT_WINDOW_WIDGET</literal> window, scrolling is
-irrelevant, <parameter>child</parameter> floats above all scrollable areas.
-However, placing <parameter>child</parameter> in one of the scrollable
-windows (a border windows or the text window), you'll need to compute the
-correct position of <parameter>child</parameter> in textbuffer coordinates
-any time scrolling occurs or textbuffer changes occur, and then call the
-<link
-linkend="method-gtktextview--move-child"><methodname>move_child</methodname>()</link>
-method to update the child's position. Unfortunately there's no good way to
-detect that scrolling has occurred, using the current API; a possible hack
-would be to update all child positions when the scroll adjustments change or
-the text buffer changes.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--move-child">
- <title>gtk.TextView.move_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_child</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- <methodparam><parameter
- role="keyword">xpos</parameter></methodparam>
- <methodparam><parameter
- role="keyword">ypos</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>a child widget in the
-textview</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">xpos</parameter>&nbsp;:</term>
- <listitem><simpara>the new X position in window
-coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">ypos</parameter>&nbsp;:</term>
- <listitem><simpara>the new Y position in window
-coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>move_child</methodname>() method moves the
-position of <parameter>child</parameter> to the location (in its current
-window) specified by <parameter>xpos</parameter> and
-<parameter>ypos</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-wrap-mode">
- <title>gtk.TextView.set_wrap_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_wrap_mode</methodname>
- <methodparam><parameter
- role="keyword">wrap_mode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">wrap_mode</parameter>&nbsp;:</term>
- <listitem><simpara>a wrap mode value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_wrap_mode</methodname>() method sets the
-"wrap-mode" property of the textview to the value specified by
-<parameter>wrap_mode</parameter>. The value of wrap_mode can be one of:
-<literal>gtk.WRAP_NONE</literal>, <literal>gtk.WRAP_CHAR</literal> or
-<literal>gtk.WRAP_WORD</literal>. The "wrap-mode" property defines the wrap
-mode for text that is not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "wrap_mode" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-wrap-mode">
- <title>gtk.TextView.get_wrap_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_wrap_mode</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the line wrap setting</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_wrap_mode</methodname>() method returns the
-value of the "wrap-mode" property. The value of "wrap-mode" can be one of:
-<literal>gtk.WRAP_NONE</literal>, <literal>gtk.WRAP_CHAR</literal> or
-<literal>gtk.WRAP_WORD</literal>. The "wrap-mode" property defines the wrap
-mode for text that is not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "wrap_mode" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-editable">
- <title>gtk.TextView.set_editable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_editable</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the text is editable
-by default</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_editable</methodname>() method sets the
-"editable" property to the value of <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal> the text in
-textview is editable by default. The "editable" property determines the
-editability of the <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link> text
-that is not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "editable" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-editable">
- <title>gtk.TextView.get_editable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_editable</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><parameter>True</parameter> if text is editable
-by default</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_editable</methodname>() method returns the
-value of the "editable" property. The "editable" property determines the
-editability of the <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link> text
-that is not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "editable" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-overwrite">
- <title>gtk.TextView.set_overwrite</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_overwrite</methodname>
- <methodparam><parameter role="keyword">overwrite</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">overwrite</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> turn on overwrite
- mode; if <literal>False</literal> turn it off</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_overwrite</methodname>() method sets the
-"overwrite" property to the value of <parameter>overwrite</parameter>. If
-<parameter>overwrite</parameter> is <literal>True</literal>, inserted text
-overwrites the existing text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-overwrite">
- <title>gtk.TextView.get_overwrite</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_overwrite</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the textview is in
- overwrite mode</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_overwrite</methodname>() method returns the
-value of the "overwrite" property. see the <link
-linkend="method-gtktextview--set-overwrite"><methodname>set_overwrite</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-accepts-tab">
- <title>gtk.TextView.set_accepts_tab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_accepts_tab</methodname>
- <methodparam><parameter role="keyword">accepts_tab</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">accepts_tab</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> pressing the
- <keycap>Tab</keycap> key should insert a tab character; if
- <literal>False</literal>, pressing the <keycap>Tab</keycap> key
- should move the keyboard focus.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_accepts_tab</methodname>() method sets the
-"accepts_tab" property to the value of
-<parameter>accepts_tab</parameter>. If <parameter>accepts_tab</parameter> is
-<literal>True</literal> a tab character is inserted. If
-<parameter>accepts_tab</parameter> is <literal>False</literal> the keyboard
-focus is moved to the next widget in the focus chain.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-accepts-tab">
- <title>gtk.TextView.get_accepts_tab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_accepts_tab</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if pressing the
- <keycap>Tab</keycap> key inserts a tab character,
- <literal>False</literal> if pressing the <keycap>Tab</keycap> key
- moves the keyboard focus.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_accepts_tab</methodname>() method returns
-the value of the "accepts_tab" property. See the <link
-linkend="method-gtktextview--set-accepts-tab"><methodname>set_accepts_tab()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-pixels-above-lines">
- <title>gtk.TextView.set_pixels_above_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_pixels_above_lines</methodname>
- <methodparam><parameter
- role="keyword">pixels_above_lines</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">pixels_above_lines</parameter>&nbsp;:</term>
- <listitem><simpara>the number of pixels above
-paragraphs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_pixels_above_lines</methodname>() method
-sets the "pixels-above-lines" property to the value of
-<parameter>pixels_above_lines</parameter>. The "pixels-above-lines" property
-determines the number of blank pixels to place above textbuffer lines
-(paragraphs) in the textview for text that is not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "pixels-above-lines" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-pixels-above-lines">
- <title>gtk.TextView.get_pixels_above_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixels_above_lines</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default number of pixels above
-paragraphs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixels_above_lines</methodname>() method
-returns the value of the "pixels-above-lines" property. The
-"pixels-above-lines" property determines the number of pixels to put above
-textbuffer lines (paragraphs) in the textview for text that is not
-influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "pixels-above-lines" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-pixels-below-lines">
- <title>gtk.TextView.set_pixels_below_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_pixels_below_lines</methodname>
- <methodparam><parameter
- role="keyword">pixels_below_lines</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">pixels_below_lines</parameter>&nbsp;:</term>
- <listitem><simpara>the default number of pixels below
-paragraphs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_pixels_below_lines</methodname>() method
-sets the "pixels-below-lines" property to the value of
-<parameter>pixels_below_lines</parameter>. The "pixels-below-lines" property
-determines the number of blank pixels to place below textbuffer lines
-(paragraphs) in the textview for text that is not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "pixels-below-lines" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-pixels-below-lines">
- <title>gtk.TextView.get_pixels_below_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixels_below_lines</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default number of blank pixels below
-paragraphs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixels_below_lines</methodname>() method
-returns the value of the "pixels-below-lines" property. The
-"pixels-below-lines" property determines the number of pixels to put below
-textbuffer lines (paragraphs) in the textview for text that is not
-influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "pixels-below-lines" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-pixels-inside-wrap">
- <title>gtk.TextView.set_pixels_inside_wrap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_pixels_inside_wrap</methodname>
- <methodparam><parameter
- role="keyword">pixels_inside_wrap</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">pixels_inside_wrap</parameter>&nbsp;:</term>
- <listitem><simpara>the default number of pixels between wrapped
-lines</simpara></listitem>
- </varlistentry>
- </variablelist>
- <para>The <methodname>set_pixels_inside_wrap</methodname>() method
-sets the "pixels-inside_wrap" property to the value of
-<parameter>pixels_inside_wrap</parameter>. The "pixels-inside_wrap" property
-determines the number of blank pixels to place between wrapped textbuffer
-lines (inside paragraphs) for text that is not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "pixels-inside_wrap" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-pixels-inside-wrap">
- <title>gtk.TextView.get_pixels_inside_wrap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixels_inside_wrap</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default number of pixels of blank space
-between wrapped lines</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixels_inside_wrap</methodname>() method
-returns the value of the "pixels-inside-wrap" property. The
-"pixels-inside-wrap" property determines the number of pixels to put between
-wrapped textbuffer lines (inside paragraphs) for text that is not influenced
-by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "pixels-inside-wrap" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-justification">
- <title>gtk.TextView.set_justification</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_justification</methodname>
- <methodparam><parameter
- role="keyword">justification</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">justification</parameter>&nbsp;:</term>
- <listitem><simpara>the text justification</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_justification</methodname>() method sets the
-"justification" property to the value of
-<parameter>justification</parameter>. The value of justification must be one
-of: <literal>gtk.JUSTIFY_LEFT</literal>,
-<literal>gtk.JUSTIFY_RIGHT</literal>, <literal>gtk.JUSTIFY_CENTER</literal>
-or <literal>gtk.JUSTIFY_FILL</literal>. The "justification" property
-determines the justification of text in the textview that is not influenced
-by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-set its "justification" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-justification">
- <title>gtk.TextView.get_justification</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_justification</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default justification</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_justification</methodname>() method returns
-the value of the "justification" property. the default justification of
-paragraphs in <parameter>text_view</parameter>. The value of "justification"
-must be one of: <literal>gtk.JUSTIFY_LEFT</literal>,
-<literal>gtk.JUSTIFY_RIGHT</literal>, <literal>gtk.JUSTIFY_CENTER</literal>
-or <literal>gtk.JUSTIFY_FILL</literal>. The "justification" property
-determines the justification of text in the textview that is not influenced
-by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-set its "justification" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-left-margin">
- <title>gtk.TextView.set_left_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_left_margin</methodname>
- <methodparam><parameter
- role="keyword">left_margin</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">left_margin</parameter>&nbsp;:</term>
- <listitem><simpara>the default left margin in pixels</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_left_margin</methodname>() method sets the
-"left-margin" property to the value of <parameter>left_margin</parameter>.
-The "left-margin"property determines the number of pixels of space for the
-left margin of text that is not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "left_margin" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-left-margin">
- <title>gtk.TextView.get_left_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_left_margin</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default left margin in
-pixels</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_left_margin</methodname>() method returns
-the value of the "left_margin" property. The "left-margin"property
-determines the number of pixels of space for the left margin of text that
-is not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "left_margin" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-right-margin">
- <title>gtk.TextView.set_right_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_right_margin</methodname>
- <methodparam><parameter
- role="keyword">right_margin</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">right_margin</parameter>&nbsp;:</term>
- <listitem><simpara>the default right margin in
-pixels</simpara></listitem>
- </varlistentry>
- </variablelist>
- <para>The <methodname>set_right_margin</methodname>() method sets the
-"right-margin" property to the value of <parameter>right_margin</parameter>.
-The "right-margin"property determines the number of pixels of space for the
-right margin of text that is not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "right_margin" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-right-margin">
- <title>gtk.TextView.get_right_margin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_right_margin</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default right margin in
-pixels</simpara></listitem>
- </varlistentry>
- </variablelist>
- <para>The <methodname>get_right_margin</methodname>() method returns
-the value of the "right_margin" property. The "right-margin"property
-determines the number of pixels of space for the right margin of text that
-is not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "right_margin" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-indent">
- <title>gtk.TextView.set_indent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_indent</methodname>
- <methodparam><parameter
- role="keyword">indent</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">indent</parameter>&nbsp;:</term>
- <listitem><simpara>the default indentation in
-pixels</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_indent</methodname>() method sets the
-"indent" property to the value of <parameter>indent</parameter>. The
-"indent" property determines the indentation for textview paragraphs that
-are not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "indent" attribute. The indentation may be negative.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-indent">
- <title>gtk.TextView.get_indent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_indent</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default number of pixels of
-indentation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_indent</methodname>() method returns the
-value of the "indent" property. The "indent" property determines the
-indentation for textview paragraphs that are not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "indent" attribute. The indentation may be negative.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--set-tabs">
- <title>gtk.TextView.set_tabs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tabs</methodname>
- <methodparam><parameter
- role="keyword">tabs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tabs</parameter>&nbsp;:</term>
- <listitem><simpara>the default tabs as a <link
-linkend="class-pangotabarray"><classname>pango.TabArray</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_tabs</methodname>() method sets the "tabs"
-property to a copy of the value of <parameter>tabs</parameter>. The "tabs"
-property contains the custom tab stops for the textview paragraphs that are
-not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "tabs" attribute.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-tabs">
- <title>gtk.TextView.get_tabs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tabs</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of default tab array, or
-<literal>None</literal> if "standard" tabs are used</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tabs</methodname>() method returns the value
-of the "tabs" property. The "tabs" property contains the custom tab stops
-for the textview paragraphs that are not influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> that
-sets its "tabs" attribute. The returned value will be
-<literal>None</literal> if "standard" (8-space) tabs are used.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktextview--get-default-attributes">
- <title>gtk.TextView.get_default_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_attributes</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_default_attributes</methodname>() method
-returns a copy of the default <link
-linkend="class-gtktextattributes"><classname>gtk.TextAttributes</classname></link>.
-These attributes are used for text unless the text is influenced by a <link
-linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>.
-You'd typically pass the default attributes in to the <link
-linkend="method-gtktextiter--get-attributes"><methodname>gtk.TextIter.get_attributes</methodname>()</link>
-method to get the attributes in effect at a given text position.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktextview--backspace">
- <title>The "backspace" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.10 and above.</para>
- </note>
-
- <para>The "backspace" signal is emitted when the
- <keycap>Backspace</keycap> key is pressed.</para>
-
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--copy-clipboard">
- <title>The "copy-clipboard" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "copy-clipboard" signal is emitted when a selection is
-copied to the clipboard from <parameter>textview</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--cut-clipboard">
- <title>The "cut-clipboard" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "cut-clipboard" signal is emitted when a selection is cut
-from <parameter>textview</parameter> to the clipboard.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--delete-from-cursor">
- <title>The "delete-from-cursor" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>delete_type</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>delete_type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of deletion</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of deletions to
-do</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "delete-from-cursor" signal is emitted when a deletion of
-the type specified by <parameter>delete_type</parameter> is initiated by
-user action (e.g. pressing the <keycap>Delete</keycap> or
-<keycap>Backspace</keycap> keys). The value of
-<parameter>delete_type</parameter> must be one of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>gtk.DELETE_CHARS</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.DELETE_WORD_ENDS</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.DELETE_WORDS</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.DELETE_DISPLAY_LINES</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.DELETE_DISPLAY_LINE_ENDS</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.DELETE_PARAGRAPH_ENDS</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.DELETE_PARAGRAPHS</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.DELETE_WHITESPACE</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para><parameter>count</parameter> specifies the number of times that
-deletion should be applied.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--insert-at-cursor">
- <title>The "insert-at-cursor" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>string</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>string</parameter>&nbsp;:</term>
- <listitem><simpara>the text to be inserted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "insert-at-cursor" signal is emitted when
-<parameter>string</parameter> is being inserted in
-<parameter>textview</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--move-cursor">
- <title>The "move-cursor" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>step_size</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>extend_selection</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>step_size</parameter>&nbsp;:</term>
- <listitem><simpara>the step size to move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of steps to
-move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>extend_selection</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> extend the
-selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-cursor" signal is emitted when the cursor is moved by
-<parameter>count</parameter> steps of <parameter>step_size</parameter>. If
-<parameter>extend_selection</parameter> is <literal>True</literal> the
-selection is extended by the cursor movement. The value of step_size must be
-one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_LOGICAL_POSITIONS</literal></term>
- <listitem>
- <simpara>move by graphemes</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_VISUAL_POSITIONS</literal></term>
- <listitem>
- <simpara>move by graphemes</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_WORDS</literal></term>
- <listitem>
- <simpara>move by words</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_DISPLAY_LINES</literal></term>
- <listitem>
- <simpara>move by lines(wrapped lines)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_DISPLAY_LINE_ENDS</literal></term>
- <listitem>
- <simpara>move to line ends(wrapped lines)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_PARAGRAPHS</literal></term>
- <listitem>
- <simpara>move by paragraphs(newline-ended lines)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_PARAGRAPH_ENDS</literal></term>
- <listitem>
- <simpara>move to ends of a paragraph</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_PAGES</literal></term>
- <listitem>
- <simpara>move by pages</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.MOVEMENT_BUFFER_ENDS</literal></term>
- <listitem>
- <simpara>move to ends of the buffer</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--move-focus">
- <title>The "move-focus" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>direction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>direction</parameter>&nbsp;:</term>
- <listitem><simpara>the direction to move the
-focus</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-focus" signal is emitted when the focus moves from
-<parameter>textview</parameter> in the direction specified by
-<parameter>direction</parameter> that must be one of:
-<literal>gtk.DIR_TAB_FORWARD</literal>,
-<literal>gtk.DIR_TAB_BACKWARD</literal>, <literal>gtk.DIR_UP</literal>,
-<literal>gtk.DIR_DOWN</literal>, <literal>gtk.DIR_LEFT</literal> or
-<literal>gtk.DIR_RIGHT</literal></para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--move-viewport">
- <title>The "move-viewport" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>scrollstep</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>scrollstep</parameter>&nbsp;:</term>
- <listitem><simpara>the size of the scroll step:
- <literal>gtk.SCROLL_STEPS</literal>,
- <literal>gtk.SCROLL_PAGES</literal>,
- <literal>gtk.SCROLL_ENDS</literal>,
- <literal>gtk.SCROLL_HORIZONTAL_STEPS</literal>,
- <literal>gtk.SCROLL_HORIZONTAL_PAGES</literal> or
- <literal>gtk.SCROLL_HORIZONTAL_ENDS</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of scroll steps of size
- <parameter>scrollstep</parameter> to take</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "move-viewport" signal is emitted when the viewport is being
-moved usually as the result of user action in moving the cursor or using
-the scrollbars.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--page-horizontally">
- <title>The "page-horizontally" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>extend_selection</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of pages to
-move</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>extend_selection</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> extend the
-selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "page-horizontally" signal is emitted when user initiates
-horizontal paging by pressing one of the key combinations:</para>
-
- <variablelist>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Control</keycap>
- <keycap>Page&nbsp;Up</keycap>
- </keycombo></term>
- <listitem>
- <simpara>Page horizontally with
-<parameter>extend_selection</parameter> set to
-<literal>False</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycombo action="simul"><keycap>Shift</keycap>
- <keycap>Control</keycap>
- <keycap>Page&nbsp;Up</keycap>
- </keycombo></term>
- <listitem>
- <simpara>Page horizontally with
-<parameter>extend_selection</parameter> set to
-<literal>True</literal></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--paste-clipboard">
- <title>The "paste-clipboard" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "paste-clipboard" signal is emitted when the contents of the
-clipboard are pasted into <parameter>textview</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--populate-popup">
- <title>The "populate-popup" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>menu</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>menu</parameter>&nbsp;:</term>
- <listitem><simpara>the menu to populate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "populate-popup" signal is emitted when the popup menu
-(specified by <parameter>menu</parameter>) associated with
-<parameter>textview</parameter> needs to be populated.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--select-all">
- <title>The "select-all" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>select</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>select</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> select the buffer
- contents; otherwise deselect the buffer
- contents</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
-
- <note>
- <para>This signal is available in GTK+ 2.2 and above.</para>
- </note>
-
- <para>The "select-all" signal is emitted when the user presses one
-of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><keycombo
-action='simul'><keycap>Control</keycap><keycap>a</keycap></keycombo> or
-<keycombo
-action='simul'><keycap>Control</keycap><keycap>/</keycap></keycombo> to
-select all text in a buffer</simpara>
- </listitem>
- <listitem>
- <simpara><keycombo
-action='simul'><keycap>Control</keycap><keycap>\</keycap></keycombo> to
-deselect all text in a buffer</simpara>
- </listitem>
- </itemizedlist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--set-anchor">
- <title>The "set-anchor" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "set-anchor" signal is emitted when an application calls the
-<link
-linkend="method-gobject--emit"><methodname>GObject.emit()</methodname>()</link>
-method on textview with "set-anchor" as the signal.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--set-scroll-adjustments">
- <title>The "set-scroll-adjustments" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>hadjustment</parameter></methodparam>
- <methodparam><parameter>vadjustment</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>hadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal adjustment</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>vadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the vertical adjustment</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "set-scroll-adjustments" signal is emitted when one or both
-adjustments (specified by <parameter>hadjustment</parameter> and
-<parameter>vadjustment</parameter>) are set on
-<parameter>textview</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktextview--toggle-overwrite">
- <title>The "toggle-overwrite" gtk.TextView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>textview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>textview</parameter>&nbsp;:</term>
- <listitem><simpara>the textview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "toggle-overwrite" signal is emitted when the user presses
-the <keycap>Insert</keycap> key.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktoggleaction.xml b/docs/reference/pygtk-gtktoggleaction.xml
deleted file mode 100644
index 7cd5976c..00000000
--- a/docs/reference/pygtk-gtktoggleaction.xml
+++ /dev/null
@@ -1,350 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtktoggleaction">
- <refnamediv>
- <refname>gtk.ToggleAction</refname> <refpurpose>an action which can be
- toggled between two states (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ToggleAction</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkaction">gtk.Action</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtktoggleaction">gtk.ToggleAction</link></methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- <methodparam><parameter role="keyword">tooltip</parameter></methodparam>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoggleaction--toggled">toggled</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoggleaction--set-active">set_active</link></methodname>
- <methodparam><parameter role="keyword">is_active</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoggleaction--get-active">get_active</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoggleaction--set-draw-as-radio">set_draw_as_radio</link></methodname>
- <methodparam><parameter role="keyword">draw_as_radio</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoggleaction--get-draw-as-radio">get_draw_as_radio</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkaction">gtk.Action</link>
- +-- <link linkend="class-gtktoggleaction">gtk.ToggleAction</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktoggleaction">
- <title>gtk.ToggleAction Properties</title>
-
- <para><link linkend="properties-gtkaction">gtk.Action Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"active"</entry>
- <entry>Read-Write</entry>
- <entry>If the toggle action should be active in or not. This
- property is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"draw-as-radio"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the proxies for this action
- look like radio action proxies. Available in GTK+ 2.4 and
- above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktoggleaction">
- <title>gtk.ToggleAction Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkaction">gtk.Action Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtktoggleaction--toggled">toggled</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>toggleaction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtktoggleaction"><classname>gtk.ToggleAction</classname></link>
-which is a subclass of <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link>
-corresponds roughly to a <link
-linkend="class-gtkcheckmenuitem"><classname>gtk.CheckMenuItem</classname></link>. It
-has an "active" state specifying whether the action has been checked or
-not.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktoggleaction">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ToggleAction</methodname>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- <methodparam><parameter role="keyword">tooltip</parameter></methodparam>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a unique name for the action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>the label displayed in menu items and on
-buttons</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tooltip</parameter>&nbsp;:</term>
- <listitem><simpara>a tooltip for the action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>the stock icon to display in widgets representing
-the action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktoggleaction"><classname>gtk.ToggleAction</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtktoggleaction"><classname>gtk.ToggleAction</classname></link>
-object. To add the action to a <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-and set the accelerator for the action, call the <link
-linkend="method-gtkactiongroup--add-action-with-accel"><methodname>gtk.ActionGroup.add_action_with_accel()</methodname></link>
-method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktoggleaction--toggled">
- <title>gtk.ToggleAction.toggled</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>toggled</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>toggled</methodname>() method emits the
-"toggled" signal on the toggle action.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoggleaction--set-active">
- <title>gtk.ToggleAction.set_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_active</methodname>
- <methodparam><parameter role="keyword">is_active</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">is_active</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the action should be
- checked</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_active</methodname>() method sets the
-checked state on the toggle action.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoggleaction--get-active">
- <title>gtk.ToggleAction.get_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_active</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the toggle action is
- checked</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_active</methodname>() method returns
-<literal>True</literal> if the toggle action is checked.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoggleaction--set-draw-as-radio">
- <title>gtk.ToggleAction.set_draw_as_radio</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_draw_as_radio</methodname>
- <methodparam><parameter role="keyword">draw_as_radio</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">draw_as_radio</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the action should
- have proxies like a radio action</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_draw_as_radio</methodname>() method sets the
-"draw-as-radio" property to the value of
-<parameter>draw_as_radio</parameter>. If
-<parameter>draw_as_radio</parameter> is <literal>True</literal> the action
-should have proxies like a radio action.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoggleaction--get-draw-as-radio">
- <title>gtk.ToggleAction.get_draw_as_radio</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_draw_as_radio</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the action should
- have proxies like a radio action.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_draw_as_radio</methodname>() method returns
-the value of the "draw-as-radio" property. If "draw-as-radio" is
-<literal>True</literal> the action should have proxies like a radio
-action.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktoggleaction--toggled">
- <title>The "toggled" gtk.ToggleAction Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>toggleaction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>toggleaction</parameter>&nbsp;:</term>
- <listitem><simpara>the toggleaction that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "toggled" signal is emitted when the toggle action changes
-its active state.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktogglebutton.xml b/docs/reference/pygtk-gtktogglebutton.xml
deleted file mode 100644
index 123fe341..00000000
--- a/docs/reference/pygtk-gtktogglebutton.xml
+++ /dev/null
@@ -1,463 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktogglebutton">
- <refnamediv>
- <refname>gtk.ToggleButton</refname>
- <refpurpose>a button that retains its state</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ToggleButton</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbutton">gtk.Button</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktogglebutton">gtk.ToggleButton</link></methodname>
- <methodparam><parameter role="keyword">label</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktogglebutton--set-mode">set_mode</link></methodname>
- <methodparam><parameter
- role="keyword">draw_indicator</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktogglebutton--get-mode">get_mode</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktogglebutton--set-active">set_active</link></methodname>
- <methodparam><parameter
- role="keyword">is_active</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktogglebutton--get-active">get_active</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktogglebutton--toggled">toggled</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktogglebutton--set-inconsistent">set_inconsistent</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktogglebutton--get-inconsistent">get_inconsistent</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkbutton">gtk.Button</link>
- +-- <link linkend="class-gtktogglebutton">gtk.ToggleButton</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktogglebutton">
- <title>gtk.ToggleButton Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"active"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the toggle button should be
-pressed in.</entry>
- </row>
-
- <row valign="top">
- <entry>"draw-indicator"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the toggle part of the
-button is displayed.</entry>
- </row>
-
- <row valign="top">
- <entry>"inconsistent"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the toggle button is in an
-"in between" state.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtktogglebutton">
- <title>gtk.ToggleButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"draw_indicator"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal>, the toggle part of the
-button is displayed.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktogglebutton">
- <title>gtk.ToggleButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtktogglebutton--toggled">toggled</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>togglebutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-is a <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link> that has
-two stable states: 'pressed-in' ("on" or "active") and "normal" ("off" or
-"inactive"). The state changes to the alternate state each time the
-togglebutton is clicked. The state of a <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-can be set specifically using the <link
-linkend="method-gtktogglebutton--set-active"><methodname>set_active</methodname>()</link>
-method, and retrieved using the <link
-linkend="method-gtktogglebutton--get-active"><methodname>get_active</methodname>()</link>
-method. To simply switch the state of a toggle button, use the <link
-linkend="method-gtktogglebutton--toggled"><methodname>toggled</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktogglebutton">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ToggleButton</methodname>
- <methodparam><parameter role="keyword">label</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_underline</parameter>
- <initializer>True</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>the text to be displayed by the button label
-including an underscore to indicate the mnemonic character if desired or
-<literal>None</literal> if no label is required.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">use_underline</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, an underscore in the
-label text indicates the next character should be underlined and used for the
-mnemonic accelerator key if it is the first character so
-marked. Available in PyGTK 2.4 and above.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-widget with the text label specified by <parameter>label</parameter>.
-<parameter>label</parameter> will be parsed for underscore characters that
-indicate mnemonic accelerators. If <parameter>label</parameter> is
-<literal>None</literal> or not specified, no label will be created.</para>
-
- <para>In PyGTK 2.4 and above the <parameter>use_underline</parameter>
-parameter is available and defaults to <literal>True</literal>. If
-<parameter>use_underline</parameter> is set to <literal>False</literal> the
-label text will not be parsed for mnemonic characters.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktogglebutton--set-mode">
- <title>gtk.ToggleButton.set_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_mode</methodname>
- <methodparam><parameter
- role="keyword">draw_indicator</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">draw_indicator</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> display the button
-as an indicator with a label; if <literal>False</literal> just display as a
-normal button</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_mode</methodname>() method sets the
-"draw-indicator" property to the value of<parameter>
-draw_indicator</parameter>. If <parameter>draw_indicator</parameter> is
-<literal>True</literal> the button is displayed as an indicator with a
-label; otherwise, the button is displayed as a normal button.</para>
-
- <para>This method only affects subclasses of <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-like <link
-linkend="class-gtkcheckbutton"><classname>gtk.CheckButton</classname></link>
-and <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktogglebutton--get-mode">
- <title>gtk.ToggleButton.get_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_mode</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the button is
-displayed as an indicator with a label; <literal>False</literal> if
-displayed as a normal button.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_mode</methodname>() method returns the value
-of the "draw-indicator" property. If "draw-indicator" is
-<literal>True</literal> the button is displayed as an indicator with a
-label; if <literal>False</literal>, the button is displayed as a normal
-button. See the <link
-linkend="method-gtktogglebutton--set-mode"><methodname>set_mode</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktogglebutton--set-active">
- <title>gtk.ToggleButton.set_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_active</methodname>
- <methodparam><parameter
- role="keyword">is_active</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">is_active</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the togglebutton
-state is active ("on")</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_active</methodname>() method sets the
-"active" property to the value of <parameter>is_active</parameter>. If
-<parameter>is_active</parameter> is <literal>True</literal> the <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-is 'pressed in', and if <literal>False</literal> it's 'normal'. This method
-causes the "toggled" signal to be emitted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktogglebutton--get-active">
- <title>gtk.ToggleButton.get_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_active</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the togglebutton is
-active</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_active</methodname>() method returns the
-value of the "active" property. If "active" is <literal>True</literal> the
-togglebutton is 'pressed in'; if <literal>False</literal>, it's
-'normal'.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktogglebutton--toggled">
- <title>gtk.ToggleButton.toggled</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>toggled</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>toggled</methodname>() method emits the
-"toggled" signal on the togglebutton.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktogglebutton--set-inconsistent">
- <title>gtk.ToggleButton.set_inconsistent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_inconsistent</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the state is
-inconsistent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_inconsistent</methodname>() method sets the
-"inconsistent" property to the value of <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal> the togglebutton
-is displayed in the inconsistent state - an "in between" state. This method
-is useful if the user has selected a range of elements (such as some text or
-spreadsheet cells) that are affected by a toggle button, and the current
-values in that range are inconsistent and you want to indicate that by
-setting the toggle button to an "in between" display. Normally you would
-turn off the inconsistent state again if the user clicks the toggle
-button.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktogglebutton--get-inconsistent">
- <title>gtk.ToggleButton.get_inconsistent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_inconsistent</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the state is
-inconsistent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_inconsistent</methodname>() method returns
-the value of the "inconsistent" property. If "inconsistent" is
-<literal>True</literal> the togglebutton is displayed in an 'in between'
-state. See the <link
-linkend="method-gtktogglebutton--set-inconsistent"><methodname>set_inconsistent</methodname>()</link>
-method for more details.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktogglebutton--toggled">
- <title>The "toggled" gtk.ToggleButton Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>togglebutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>togglebutton</parameter>&nbsp;:</term>
- <listitem><simpara>the togglebutton that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "toggled" signal is emitted when the togglebutton state
-changes either programmatically or by user action.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktoggletoolbutton.xml b/docs/reference/pygtk-gtktoggletoolbutton.xml
deleted file mode 100644
index 4c4002be..00000000
--- a/docs/reference/pygtk-gtktoggletoolbutton.xml
+++ /dev/null
@@ -1,266 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtktoggletoolbutton">
- <refnamediv>
- <refname>gtk.ToggleToolButton</refname>
-
- <refpurpose>A <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-containing a toggle button (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ToggleToolButton</classname></ooclass>
- <ooclass><classname><link linkend="class-gtktoolbutton">gtk.ToolButton</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtktoggletoolbutton">gtk.ToggleToolButton</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoggletoolbutton--set-active">set_active</link></methodname>
- <methodparam><parameter role="keyword">is_active</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoggletoolbutton--get-active">get_active</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtktoolitem">gtk.ToolItem</link>
- +-- <link linkend="class-gtktoolbutton">gtk.ToolButton</link>
- +-- <link linkend="class-gtktoggletoolbutton">gtk.ToggleToolButton</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktoggletoolbutton">
- <title>gtk.ToggleToolButton Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para>
- <para><link linkend="properties-gtktoolbutton">gtk.ToolButton Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"active"</entry>
- <entry>Read-Write</entry>
- <entry>If the toggle tool button should be pressed in or not.
- This property is available in GTK+ 2.8 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtktoggletoolbutton">
- <title>gtk.ToggleToolButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtktoolbutton">gtk.ToolButton Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktoggletoolbutton">
- <title>gtk.ToggleToolButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktoolbutton">gtk.ToolButton Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtktoggletoolbutton--toggled">toggled</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>toggletoolbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>
-is a <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> that
-contains a toggle button. Use the <link
-linkend="constructor-gtktoggletoolbutton">gtk.ToggleToolButton</link>()
-constructor to create a new <link
-linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktoggletoolbutton">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ToggleToolButton</methodname>
- <methodparam><parameter role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a stock item</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a newly created <link linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>. If
-<parameter>stock_id</parameter> is not <literal>None</literal> the toggle
-tool button contains the image and text from the specified stock
-item.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktoggletoolbutton--set-active">
- <title>gtk.ToggleToolButton.set_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_active</methodname>
- <methodparam><parameter role="keyword">is_active</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">is_active</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the toggle tool
- button is active</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_active</methodname>() method sets the status
-of the toggle tool button to the value specified by
-<parameter>is_active</parameter>. If <parameter>is_active</parameter> is
-<literal>True</literal> the <link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-is 'pressed in' (active). This method causes the toggled signal to be
-emitted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoggletoolbutton--get-active">
- <title>gtk.ToggleToolButton.get_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_active</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the toggle tool
- button is pressed in (active)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_active</methodname>() method returns
-<literal>True</literal> if the toggle tool button is pressed in (active) and
-<literal>False</literal> if it is raised.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktoggletoolbutton--toggled">
- <title>The "toggled" gtk.ToggleToolButton Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>toggletoolbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>toggletoolbutton</parameter>&nbsp;:</term>
- <listitem><simpara>the toggletoolbutton that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "toggled" signal is emitted when the toggle tool button
-changes state.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktoolbar.xml b/docs/reference/pygtk-gtktoolbar.xml
deleted file mode 100644
index 3a452745..00000000
--- a/docs/reference/pygtk-gtktoolbar.xml
+++ /dev/null
@@ -1,2570 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktoolbar">
- <refnamediv>
- <refname>gtk.Toolbar</refname>
- <refpurpose>a bar holding buttons and other widgets.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Toolbar</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktoolbar">gtk.Toolbar</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbar--insert">insert</link></methodname>
- <methodparam><parameter role="keyword">item</parameter></methodparam>
- <methodparam><parameter role="keyword">pos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbar--get-item-index">get_item_index</link></methodname>
- <methodparam><parameter role="keyword">item</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbar--get-n-items">get_n_items</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbar--get-nth-item">get_nth_item</link></methodname>
- <methodparam><parameter role="keyword">n</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbar--get-drop-index">get_drop_index</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbar--set-drop-highlight-item">set_drop_highlight_item</link></methodname>
- <methodparam><parameter role="keyword">tool_item</parameter></methodparam>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbar--set-show-arrow">set_show_arrow</link></methodname>
- <methodparam><parameter role="keyword">show_arrow</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbar--get-show-arrow">get_show_arrow</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbar--get-relief-style">get_relief_style</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--append-item">append_item</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--prepend-item">prepend_item</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--insert-item">insert_item</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--insert-stock">insert_stock</link></methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--append-space">append_space</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--prepend-space">prepend_space</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--insert-space">insert_space</link></methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--remove-space">remove_space</link></methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--append-element">append_element</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--prepend-element">prepend_element</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--insert-element">insert_element</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--append-widget">append_widget</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--prepend-widget">prepend_widget</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--insert-widget">insert_widget</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--set-orientation">set_orientation</link></methodname>
- <methodparam><parameter
- role="keyword">orientation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--set-style">set_style</link></methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--set-icon-size">set_icon_size</link></methodname>
- <methodparam><parameter
- role="keyword">icon_size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--set-tooltips">set_tooltips</link></methodname>
- <methodparam><parameter
- role="keyword">enable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--unset-style">unset_style</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--unset-icon-size">unset_icon_size</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--get-orientation">get_orientation</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--get-style">get_style</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--get-icon-size">get_icon_size</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktoolbar--get-tooltips">get_tooltips</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtktoolbar">gtk.Toolbar</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktoolbar">
- <title>gtk.Toolbar Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"icon-size"</entry>
- <entry>Read-Write</entry>
- <entry>The size of the icons in a toolbar is normally determined
- by the "toolbar-icon-size" setting. When this property is set, it
- overrides the setting. This should only be used for
- special-purpose toolbars, normal application toolbars should
- respect the user preferences for the size of icons. This property
- is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"icon-size-set"</entry>
- <entry>Read-Write</entry>
- <entry>if <literal>True</literal> the icon-size property has
- been set. This property is available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"orientation"</entry>
- <entry>Read-Write</entry>
- <entry>The orientation of the toolbar:
-<literal>gtk.ORIENTATION_HORIZONTAL</literal> or
-<literal>gtk.ORIENTATION_VERTICAL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"show-arrow"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> an arrow should be shown
-if the toolbar doesn't fit. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"toolbar-style"</entry>
- <entry>Read-Write</entry>
- <entry>The toolbar style:
-<literal>gtk.TOOLBAR_ICONS</literal>, <literal>gtk.TOOLBAR_TEXT</literal>,
-<literal>gtk.TOOLBAR_BOTH</literal> or
-<literal>gtk.TOOLBAR_BOTH_HORIZ</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"tooltips"</entry>
- <entry>Read-Write</entry>
- <entry>If the tooltips of the toolbar should be active or not.
- This property is available in GTK+ 2.8 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtktoolbar">
- <title>gtk.Toolbar Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"button-relief"</entry>
- <entry>Read</entry>
- <entry>The type of bevel around toolbar buttons:
-<literal>gtk.RELIEF_NORMAL</literal>, <literal>gtk.RELIEF_HALF</literal> or
-<literal>gtk.RELIEF_NONE</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"internal-padding"</entry>
- <entry>Read</entry>
- <entry>The amount of border space between the toolbar shadow
-and the buttons</entry>
- </row>
-
- <row valign="top">
- <entry>"max-child-expand"</entry>
- <entry>Read</entry>
- <entry>Maximum amount of space an expandable item will be given</entry>
- </row>
-
- <row valign="top">
- <entry>"shadow-type"</entry>
- <entry>Read</entry>
- <entry>The style of bevel around the toolbar:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>
-or <literal>gtk.SHADOW_ETCHED_OUT</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"space-size"</entry>
- <entry>Read</entry>
- <entry>The size of spacers</entry>
- </row>
-
- <row valign="top">
- <entry>"space-style"</entry>
- <entry>Read</entry>
- <entry>The spacer style:
-<literal>gtk.TOOLBAR_SPACE_EMPTY</literal> or
-<literal>gtk.TOOLBAR_SPACE_LINE</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtktoolbar">
- <title>gtk.Toolbar Child Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"expand"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the item should receive
-extra space when the toolbar grows. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- </tbody>
- <row valign="top">
- <entry>"homogeneous"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the item should be the
-same size as other homogeneous items. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktoolbar">
- <title>gtk.Toolbar Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtktoolbar--focus-home-or-end">focus-home-or-end</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>toolbar</parameter></methodparam>
- <methodparam><parameter>focus_home</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktoolbar--move-focus">move-focus</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>toolbar</parameter></methodparam>
- <methodparam><parameter>dir</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtktoolbar--orientation-changed">orientation-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>toolbar</parameter></methodparam>
- <methodparam><parameter>orientation</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtktoolbar--popup-context-menu">popup-context-menu</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>toolbar</parameter></methodparam>
- <methodparam><parameter>x</parameter></methodparam>
- <methodparam><parameter>y</parameter></methodparam>
- <methodparam><parameter>button</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtktoolbar--style-changed">style-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>toolbar</parameter></methodparam>
- <methodparam><parameter>style</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link> is a
-subclass of <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
-that holds and manages a set of buttons and widgets in a horizontal or
-vertical bar. A <link
-linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link> is
-usually used in an application as an alternative to a menu to provide a more
-direct means to activate dialogs or set options. Items in the toolbar can be
-visibly grouped by adding space between the elements. The toolbar style can
-be set to display only icons, only text or both icons and text. Each toolbar
-item has an associated <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> to
-provide a brief description of the items purpose.</para>
-
- <para>In <literal>PyGTK</literal> 2.4 the interface of the <link
-linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link> has
-changed to take advantage of the new <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-widgets. The following describes the new features.</para>
-
- <para>A toolbar can contain instances of a subclass of <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-(<link
-linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>,
-<link
-linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>,
-<link
-linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>
-and <link
-linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>). To
-add a <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> to
-the a toolbar, use the <link
-linkend="method-gtktoolbar--insert"><methodname>insert</methodname>()</link>
-method. To remove an item from the toolbar use the <link
-linkend="method-gtkcontainer--remove"><methodname>gtk.Container.remove</methodname>()</link>
-method. To add a button to the toolbar, add an instance of <link
-linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>. Toolbar
-items can be visually grouped by adding instances of <link
-linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>
-to the toolbar. If a <link
-linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>
-has the "expand" property set to <literal>True</literal> and the "draw"
-property set to <literal>False</literal> the effect is to force all
-following items to the end of the toolbar. Creating a context menu for the
-toolbar can be done by connecting to the "popup-context-menu" signal.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktoolbar">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Toolbar</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link>
-widget.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktoolbar--insert">
- <title>gtk.Toolbar.insert</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert</methodname>
- <methodparam><parameter role="keyword">item</parameter></methodparam>
- <methodparam><parameter role="keyword">pos</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">item</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pos</parameter>&nbsp;:</term>
- <listitem><simpara>the position of the new item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above</para>
- </note>
-
- <para>The <methodname>insert</methodname>() method inserts the <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-specified by <parameter>item</parameter> into the toolbar at the position
-specified by <parameter>pos</parameter>. If <parameter>pos</parameter> is 0
-<parameter>item</parameter> is prepended to the start of the toolbar. If
-<parameter>pos</parameter> is negative, <parameter>item</parameter> is
-appended to the end of the toolbar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--get-item-index">
- <title>gtk.Toolbar.get_item_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_item_index</methodname>
- <methodparam><parameter role="keyword">item</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">item</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
- that is a child of the toolbar</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the position of item on the
- toolbar.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above</para>
- </note>
-
- <para>The <methodname>get_item_index</methodname>() method returns the
-position (starting from 0) on the toolbar of the <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-specified by <parameter>item</parameter>. It is an error
-if <parameter>item</parameter> is not a child of the toolbar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--get-n-items">
- <title>gtk.Toolbar.get_n_items</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_items</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of items on the
- toolbar</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above</para>
- </note>
-
- <para>The <methodname>get_n_items</methodname>() method returns the
-number of items on the toolbar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--get-nth-item">
- <title>gtk.Toolbar.get_nth_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_nth_item</methodname>
- <methodparam><parameter role="keyword">n</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">n</parameter>&nbsp;:</term>
- <listitem><simpara>a position on the toolbar</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The <link
- linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
- on the toolbar at position <parameter>n</parameter>, or
- <literal>None</literal> if there isn't an item at position
- <parameter>n</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above</para>
- </note>
-
- <para>The <methodname>get_nth_item</methodname>() method returns the
-toolbar <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> at
-the position specified by <parameter>n</parameter>, or
-<literal>None</literal> if the toolbar does not contain an item at position
-<parameter>n</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--get-drop-index">
- <title>gtk.Toolbar.get_drop_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_drop_index</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x coordinate of a point on the
- toolbar</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y coordinate of a point on the
- toolbar</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The toolbar position corresponding to the point
- (<parameter>x</parameter>,
- <parameter>y</parameter>).</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above</para>
- </note>
-
- <para>The <methodname>get_drop_index</methodname>() method returns the
-position on the toolbar corresponding to the point specified by
-<parameter>x</parameter> and <parameter>y</parameter>. This is useful when
-dragging items to the toolbar. This method returns the position index where
-a new item should be inserted.</para>
-
- <para>The <parameter>x</parameter> and <parameter>y</parameter>
-coordinates are relative to the toolbar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--set-drop-highlight-item">
- <title>gtk.Toolbar.set_drop_highlight_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_drop_highlight_item</methodname>
- <methodparam><parameter role="keyword">tool_item</parameter></methodparam>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">tool_item</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>,
- or <literal>None</literal> to turn off
- highlighting</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>a position index on the toolbar</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above</para>
- </note>
-
- <para>The <methodname>set_drop_highlight_item</methodname>() method
-highlights the toolbar to give an idea of what it would look like if the
-<link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-specified by <parameter>tool_item</parameter> was added at the position
-specified by <parameter>index</parameter>. If
-<parameter>tool_item</parameter> is <literal>None</literal>, highlighting is
-turned off and <parameter>index</parameter> is ignored.</para>
-
- <para>The <parameter>tool_item</parameter> passed to this method must
-not be part of any widget hierarchy. When an item is set as drop highlight
-item it can not added to any widget hierarchy or used as highlight item for
-another toolbar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--set-show-arrow">
- <title>gtk.Toolbar.set_show_arrow</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_show_arrow</methodname>
- <methodparam><parameter role="keyword">show_arrow</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">show_arrow</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, show an arrow to
- indicate menu overflow</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above</para>
- </note>
-
- <para>The <methodname>set_show_arrow</methodname>() method sets the
-"show-arrow" property to the value of <parameter>show_arrow</parameter>. If
-<parameter>show_arrow</parameter> is <literal>True</literal> an arrow is
-displayed (for an overflow menu) when the toolbar doesn't have room for all
-items on it. Items that are not displayed due to a lack of room are
-available through the overflow menu.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--get-show-arrow">
- <title>gtk.Toolbar.get_show_arrow</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_show_arrow</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if an overflow menu can
- be used</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above</para>
- </note>
-
- <para>The <methodname>get_show_arrow</methodname>() method returns the
-value of the "show-arrow" property. If "show-arrow" is
-<literal>True</literal> the toolbar has an overflow menu. See the <link
-linkend="method-gtktoolbar--set-show-arrow"><methodname>set_show_arrow()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--get-relief-style">
- <title>gtk.Toolbar.get_relief_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_relief_style</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the relief style of buttons on the
- toolbar</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above</para>
- </note>
-
- <para>The <methodname>get_relief_style</methodname>() method returns
-the relief style of buttons on the toolbar. See the <link
-linkend="method-gtkbutton--set-relief"><methodname>gtk.Button.set_relief()</methodname></link>
-method for more information. The return value will be one of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>gtk.RELIEF_NORMAL</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.RELIEF_HALF</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.RELIEF_NONE</literal></simpara>
- </listitem>
- </itemizedlist>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--append-item">
- <title>gtk.Toolbar.append_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append_item</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the text label or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_private_text</parameter>&nbsp;:</term>
- <listitem><simpara>the private tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">icon</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a callback function or method or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>a user data object or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>append_item</methodname>() method adds a new
-<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link> to
-the end (right or bottom) of the toolbar with:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the label specified by
-<parameter>text</parameter>,</simpara>
- </listitem>
- <listitem>
- <simpara>the <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> text
-and private text specified by <parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> respectively and</simpara>
- </listitem>
- <listitem>
- <simpara>an icon (or any <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>)
-specified by <parameter>icon</parameter>.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>A reference to the new button is returned. When the button is
-clicked the function or method specified by <parameter>callback</parameter>
-will be called with the user data specified by
-<parameter>user_data</parameter>. All or any of the arguments can have the
-value <parameter>None</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--prepend-item">
- <title>gtk.Toolbar.prepend_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend_item</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the text label or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_private_text</parameter>&nbsp;:</term>
- <listitem><simpara>the private tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">icon</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a callback function or method or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>a user data object or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>prepend_item</methodname>() method adds a new
-<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link> to
-the beginning (left or top) of the toolbar with:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the label specified by
-<parameter>text</parameter>,</simpara>
- </listitem>
- <listitem>
- <simpara>the <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> text
-and private text specified by <parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> respectively and</simpara>
- </listitem>
- <listitem>
- <simpara>an icon (or any <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>)
-specified by <parameter>icon</parameter>.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>A reference to the new button is returned. When the button is
-clicked the function or method specified by <parameter>callback</parameter>
-will be called with the user data specified by
-<parameter>user_data</parameter>. All or any of the arguments can have the
-value <parameter>None</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--insert-item">
- <title>gtk.Toolbar.insert_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_item</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the text label or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_private_text</parameter>&nbsp;:</term>
- <listitem><simpara>the private tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">icon</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a callback function or method or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>a user data object or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>The position to insert the button or -1 to
-append</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>insert_item</methodname>() method inserts a new
-<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link> the
-toolbar at the position specified by <parameter>position</parameter>
-with:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the label specified by
-<parameter>text</parameter>,</simpara>
- </listitem>
- <listitem>
- <simpara>the <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> text
-and private text specified by <parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> respectively and</simpara>
- </listitem>
- <listitem>
- <simpara>an icon (or any <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>)
-specified by <parameter>icon</parameter>.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>A reference to the new button is returned. When the button is
-clicked the function or method specified by <parameter>callback</parameter>
-will be called with the user data specified by
-<parameter>user_data</parameter>. All or any of the arguments (except
-<parameter>position</parameter>) can have the value
-<parameter>None</parameter>. If <parameter>position</parameter> is negative
-the button will be appended to the toolbar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--insert-stock">
- <title>gtk.Toolbar.insert_stock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_stock</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>the ID of the stock item to use as the button
-label and icon</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_private_text</parameter>&nbsp;:</term>
- <listitem><simpara>the private tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a callback function or method or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>a user data object or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>The position to insert the button or -1 to
-append</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>insert_stock</methodname>() method inserts a new
-<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link> the
-toolbar at the position specified by <parameter>position</parameter>
-with:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the stock item specified by
-<parameter>stock_id</parameter> used for the label text and icon,</simpara>
- </listitem>
- <listitem>
- <simpara>the <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> text
-and private text specified by <parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> respectively.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>A reference to the new button is returned. When the button is
-clicked the function or method specified by <parameter>callback</parameter>
-will be called with the user data specified by
-<parameter>user_data</parameter>. All or any of the arguments (except
-<parameter>position</parameter>) can have the value
-<parameter>None</parameter>. If <parameter>position</parameter> is negative
-the button will be appended to the toolbar. If
-<parameter>stock_id</parameter> is not a known stock item ID, it's inserted
-verbatim, except that underscores are used to mark mnemonic
-accelerators.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--append-space">
- <title>gtk.Toolbar.append_space</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append_space</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>append_space</methodname>() method appends a
-space to the end of the toolbar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--prepend-space">
- <title>gtk.Toolbar.prepend_space</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend_space</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>prepend_space</methodname>() method prepends a
-space to the beginning of the toolbar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--insert-space">
- <title>gtk.Toolbar.insert_space</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_space</methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>The position to insert the space or -1 to
-append</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>insert_space</methodname>() method inserts a
-space at the specified <parameter>position</parameter> in the
-toolbar.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--remove-space">
- <title>gtk.Toolbar.remove_space</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_space</methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the space to
-remove.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>remove_space</methodname>() method removes a
-space from the specified <parameter>position</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--append-element">
- <title>gtk.Toolbar.append_element</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append_element</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of <parameter>widget</parameter> - one
-of: <literal>gtk.TOOLBAR_CHILD_SPACE</literal>,
-<literal>gtk.TOOLBAR_CHILD_BUTTON</literal>,
-<literal>gtk.TOOLBAR_CHILD_TOGGLEBUTTON</literal>,
-<literal>gtk.TOOLBAR_CHILD_RADIOBUTTON</literal> or
-<literal>gtk.TOOLBAR_CHILD_WIDGET</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the text label or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_private_text</parameter>&nbsp;:</term>
- <listitem><simpara>the private tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">icon</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a callback function or method or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>a user data object or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new toolbar element as a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>append_element</methodname>() method adds a new
-element of the specified <parameter>type</parameter> to the end (right or
-bottom) of the toolbar with the <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> text
-and private text specified by <parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> respectively. The behavior of
-the method depends on the type of element being added:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_WIDGET</literal></term>
- <listitem>
- <simpara>The specified <parameter>widget</parameter> is the
-element added to the toolbar. The <parameter>text</parameter>,
-<parameter>icon</parameter>, <parameter>callback</parameter> and
-<parameter>user_data</parameter> arguments are ignored.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_BUTTON</literal></term>
- <listitem>
- <simpara>The string specified by <parameter>text</parameter> and
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-specified by <parameter>icon</parameter> are used to create the label for a
-<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link> to
-add to the toolbar. The function or method specified by
-<parameter>callback</parameter> and the object specified by
-<parameter>user_data</parameter> are connected to the button's "clicked"
-signal. The <parameter>widget</parameter> argument must have the value
-<literal>None</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_TOGGLEBUTTON</literal></term>
- <listitem>
- <simpara>The string specified by <parameter>text</parameter> and
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-specified by <parameter>icon</parameter> are used to create the label for a
-<link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-to add to the toolbar. The function or method specified by
-<parameter>callback</parameter> and the object specified by
-<parameter>user_data</parameter> are connected to the button's "clicked"
-signal. The <parameter>widget</parameter> argument must have the value
-<literal>None</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_RADIOBUTTON</literal></term>
- <listitem>
- <simpara>The string specified by <parameter>text</parameter> and
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-specified by <parameter>icon</parameter> are used to create the label for a
-<link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-to add to the toolbar. The <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-specified by <parameter>widget</parameter> is used to set the group for the
-radiobutton. If <parameter>widget</parameter> is <literal>None</literal> a
-new radiobutton group is created. The function or method specified by
-<parameter>callback</parameter> and the object specified by
-<parameter>user_data</parameter> are connected to the button's "clicked"
-signal.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_SPACE</literal></term>
- <listitem>
- <simpara>A space element is added to the toolbar. The
-<parameter>widget</parameter> argument must have the value
-<literal>None</literal>. The <parameter>text</parameter>,
-<parameter>icon</parameter>, <parameter>tooltip_text</parameter>,
-<parameter>tooltip_private_text</parameter>, <parameter>callback</parameter>
-and <parameter>user_data</parameter> arguments are ignored.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <parameter>text</parameter>, <parameter>icon</parameter>,
-<parameter>callback</parameter>, <parameter>user_data</parameter>,
-<parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> arguments may have the value
-<parameter>None</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--prepend-element">
- <title>gtk.Toolbar.prepend_element</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend_element</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of <parameter>widget</parameter> - one
-of: <literal>gtk.TOOLBAR_CHILD_SPACE</literal>,
-<literal>gtk.TOOLBAR_CHILD_BUTTON</literal>,
-<literal>gtk.TOOLBAR_CHILD_TOGGLEBUTTON</literal>,
-<literal>gtk.TOOLBAR_CHILD_RADIOBUTTON</literal> or
-<literal>gtk.TOOLBAR_CHILD_WIDGET</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the text label or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_private_text</parameter>&nbsp;:</term>
- <listitem><simpara>the private tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">icon</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a callback function or method or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>a user data object or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new toolbar element as a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>prepend_element</methodname>() method adds a new
-element of the specified <parameter>type</parameter> to the beginning (left
-or top) of the toolbar with the <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> text
-and private text specified by <parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> respectively. The behavior of
-the method depends on the type of element being added:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_WIDGET</literal></term>
- <listitem>
- <simpara>The widget specified by <parameter>widget</parameter>
-is the element added to the toolbar, otherwise <parameter>widget</parameter>
-should be <literal>None</literal>. The <parameter>text</parameter>,
-<parameter>icon</parameter>, <parameter>callback</parameter> and
-<parameter>user_data</parameter> arguments are ignored.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_BUTTON</literal></term>
- <listitem>
- <simpara>The string specified by <parameter>text</parameter> and
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-specified by <parameter>icon</parameter> are used to create the label for a
-<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link> to
-add to the toolbar. The function or method specified by
-<parameter>callback</parameter> and the object specified by
-<parameter>user_data</parameter> are connected to the button's "clicked"
-signal. The <parameter>widget</parameter> argument must have the value
-<literal>None</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_TOGGLEBUTTON</literal></term>
- <listitem>
- <simpara>The string specified by <parameter>text</parameter> and
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-specified by <parameter>icon</parameter> are used to create the label for a
-<link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-to add to the toolbar. The function or method specified by
-<parameter>callback</parameter> and the object specified by
-<parameter>user_data</parameter> are connected to the button's "clicked"
-signal. The <parameter>widget</parameter> argument must have the value
-<literal>None</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_RADIOBUTTON</literal></term>
- <listitem>
- <simpara>The string specified by <parameter>text</parameter> and
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-specified by <parameter>icon</parameter> are used to create the label for a
-<link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-to add to the toolbar. The <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-specified by <parameter>widget</parameter> is used to set the group for the
-radiobutton. If <parameter>widget</parameter> is <literal>None</literal> a
-new radiobutton group is created. The function or method specified by
-<parameter>callback</parameter> and the object specified by
-<parameter>user_data</parameter> are connected to the button's "clicked"
-signal.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_SPACE</literal></term>
- <listitem>
- <simpara>A space element is added to the toolbar. The
-<parameter>widget</parameter> argument must have the value
-<literal>None</literal>. The <parameter>text</parameter>,
-<parameter>icon</parameter>, <parameter>tooltip_text</parameter>,
-<parameter>tooltip_private_text</parameter>, <parameter>callback</parameter>
-and <parameter>user_data</parameter> arguments are ignored.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <parameter>text</parameter>, <parameter>icon</parameter>,
-<parameter>callback</parameter>, <parameter>user_data</parameter>,
-<parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> arguments may have the value
-<parameter>None</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--insert-element">
- <title>gtk.Toolbar.insert_element</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_element</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- <methodparam><parameter
- role="keyword">callback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">user_data</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of <parameter>widget</parameter> - one
-of: <literal>gtk.TOOLBAR_CHILD_SPACE</literal>,
-<literal>gtk.TOOLBAR_CHILD_BUTTON</literal>,
-<literal>gtk.TOOLBAR_CHILD_TOGGLEBUTTON</literal>,
-<literal>gtk.TOOLBAR_CHILD_RADIOBUTTON</literal> or
-<literal>gtk.TOOLBAR_CHILD_WIDGET</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the text label or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_private_text</parameter>&nbsp;:</term>
- <listitem><simpara>the private tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">icon</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
- <listitem><simpara>a callback function or method or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>a user data object or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the position to insert the new element
-at.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new toolbar element as a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>insert_element</methodname>() method adds a new
-element of the specified <parameter>type</parameter> at the specified
-<parameter>position</parameter> in the toolbar with the <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> text
-and private text specified by <parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> respectively. The behavior of
-the method depends on the type of element being added:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_WIDGET</literal></term>
- <listitem>
- <simpara>The widget specified by <parameter>widget</parameter>
-is the element added to the toolbar, otherwise <parameter>widget</parameter>
-should be <literal>None</literal>. The <parameter>text</parameter>,
-<parameter>icon</parameter>, <parameter>callback</parameter> and
-<parameter>user_data</parameter> arguments are ignored.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_BUTTON</literal></term>
- <listitem>
- <simpara>The string specified by <parameter>text</parameter> and
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-specified by <parameter>icon</parameter> are used to create the label for a
-<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link> to
-add to the toolbar. The function or method specified by
-<parameter>callback</parameter> and the object specified by
-<parameter>user_data</parameter> are connected to the button's "clicked"
-signal. The <parameter>widget</parameter> argument must have the value
-<literal>None</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_TOGGLEBUTTON</literal></term>
- <listitem>
- <simpara>The string specified by <parameter>text</parameter> and
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-specified by <parameter>icon</parameter> are used to create the label for a
-<link
-linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
-to add to the toolbar. The function or method specified by
-<parameter>callback</parameter> and the object specified by
-<parameter>user_data</parameter> are connected to the button's "clicked"
-signal. The <parameter>widget</parameter> argument must have the value
-<literal>None</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_RADIOBUTTON</literal></term>
- <listitem>
- <simpara>The string specified by <parameter>text</parameter> and
-the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-specified by <parameter>icon</parameter> are used to create the label for a
-<link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-to add to the toolbar. The <link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-specified by <parameter>widget</parameter> is used to set the group for the
-radiobutton. If <parameter>widget</parameter> is <literal>None</literal> a
-new radiobutton group is created. The function or method specified by
-<parameter>callback</parameter> and the object specified by
-<parameter>user_data</parameter> are connected to the button's "clicked"
-signal.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TOOLBAR_CHILD_SPACE</literal></term>
- <listitem>
- <simpara>A space element is added to the toolbar. The
-<parameter>widget</parameter> argument must have the value
-<literal>None</literal>. The <parameter>text</parameter>,
-<parameter>icon</parameter>, <parameter>tooltip_text</parameter>,
-<parameter>tooltip_private_text</parameter>, <parameter>callback</parameter>
-and <parameter>user_data</parameter> arguments are ignored.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <parameter>text</parameter>, <parameter>icon</parameter>,
-<parameter>callback</parameter>, <parameter>user_data</parameter>,
-<parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> arguments may have the value
-<parameter>None</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--append-widget">
- <title>gtk.Toolbar.append_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append_widget</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to add to
-the toolbar.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_private_text</parameter>&nbsp;:</term>
- <listitem><simpara>the private tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>append_widget</methodname>() method adds the
-specified <parameter>widget</parameter> to the end (right or bottom) of the
-toolbar. <parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> specify the tooltip text and
-private text respectively.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--prepend-widget">
- <title>gtk.Toolbar.prepend_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend_widget</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to add to
-the toolbar.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_private_text</parameter>&nbsp;:</term>
- <listitem><simpara>the private tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>prepend_widget</methodname>() method adds the
-specified <parameter>widget</parameter> to the start (left or top) of the
-toolbar. <parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> specify the tooltip text and
-private text respectively.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--insert-widget">
- <title>gtk.Toolbar.insert_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_widget</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tooltip_private_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> to add to
-the toolbar.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">tooltip_private_text</parameter>&nbsp;:</term>
- <listitem><simpara>the private tooltip text or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the position to insert this widget
-at.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>insert_widget</methodname>() method adds the
-specified <parameter>widget</parameter> at the specified
-<parameter>position</parameter> in the toolbar.
-<parameter>tooltip_text</parameter> and
-<parameter>tooltip_private_text</parameter> specify the tooltip text and
-private text respectively.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--set-orientation">
- <title>gtk.Toolbar.set_orientation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_orientation</methodname>
- <methodparam><parameter
- role="keyword">orientation</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">orientation</parameter>&nbsp;:</term>
- <listitem><simpara>the new orientation either
-<literal>gtk.ORIENTATION_HORIZONTAL</literal> or
-<literal>gtk.ORIENTATION_VERTICAL</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_orientation</methodname>() method sets the
-"orientation" property to the value of <parameter>orientation</parameter>.
-The value of orientation is either
-<literal>gtk.ORIENTATION_HORIZONTAL</literal> or
-<literal>gtk.ORIENTATION_VERTICAL</literal></para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--set-style">
- <title>gtk.Toolbar.set_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_style</methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">style</parameter>&nbsp;:</term>
- <listitem><simpara>the new style - one of:
-<literal>gtk.TOOLBAR_ICONS</literal>, <literal>gtk.TOOLBAR_TEXT</literal>,
-<literal>gtk.TOOLBAR_BOTH</literal> or
-<literal>gtk.TOOLBAR_BOTH_HORIZ</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_style</methodname>() method sets the
-"toolbar-style" property to the value of <parameter>style</parameter>. The
-value of <parameter>style</parameter> must be one of the <xref
-linkend="gtk-toolbar-style-constants"
-endterm="gtk-toolbar-style-constants-title"></xref>. Setting the style
-overrides the user preferences for the toolbar style.</para>
-
- <note>
- <para>A <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> label
-will not be displayed if the toolbar style is
-<literal>gtk.TOOLBAR_BOTH_HORIZ</literal> and the <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-"is-important" property is <literal>False</literal> (the default). See the
-<link
-linkend="method-gtktoolitem--set-is-important"><methodname>gtk.ToolItem.set_is_important</methodname>()</link>
-method for more information.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--set-icon-size">
- <title>gtk.Toolbar.set_icon_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_size</methodname>
- <methodparam><parameter
- role="keyword">icon_size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">icon_size</parameter>&nbsp;:</term>
- <listitem><simpara>The size of stock icons in the toolbar - one
-of: <literal>gtk.ICON_SIZE_MENU</literal>,
-<literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_BUTTON</literal>,
-<literal>gtk.ICON_SIZE_DND</literal> or
-<literal>gtk.ICON_SIZE_DIALOG</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>set_icon_size</methodname>() method sets the
-size of stock icons in the toolbar to the value specified by
-<parameter>icon_size</parameter>. The value of
-<parameter>icon_size</parameter> must be one of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_MENU</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_BUTTON</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_DND</literal>, or</simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.ICON_SIZE_DIALOG</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para>This method can be called both before and after adding the
-icons. Setting the icon size will override the user preferences for the
-default icon size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--set-tooltips">
- <title>gtk.Toolbar.set_tooltips</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tooltips</methodname>
- <methodparam><parameter
- role="keyword">enable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">enable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> tooltips should be
-used</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_tooltips</methodname>() method enables or
-disables tooltips for the toolbar depending on the value of
-<parameter>enable</parameter>. If <parameter>enable</parameter> is
-<literal>True</literal>, tooltips will be used.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--unset-style">
- <title>gtk.Toolbar.unset_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unset_style</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>unset_style</methodname>() method unsets a
-toolbar style set with the <link
-linkend="method-gtktoolbar--set-style"><methodname>set_style</methodname>()</link>
-method, allowing the user preferences to determine the toolbar style.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--unset-icon-size">
- <title>gtk.Toolbar.unset_icon_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unset_icon_size</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <warning>
- <para>This method is deprecated in PyGTK 2.4 and above</para>
- </warning>
-
- <para>The <methodname>unset_icon_size</methodname>() method unsets
-toolbar icon size set with the <link
-linkend="method-gtktoolbar--set-icon-size"><methodname>set_icon_size</methodname>()</link>,
-allowing the user preferences to determine the icon size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--get-orientation">
- <title>gtk.Toolbar.get_orientation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_orientation</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the orientation</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_orientation</methodname>() method returns
-the value of the "orientation" property that determines the current
-orientation of the toolbar. See the <link
-linkend="method-gtktoolbar--set-orientation"><methodname>set_orientation</methodname>()</link>
-method for more details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--get-style">
- <title>gtk.Toolbar.get_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_style</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current toolbar style</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_style</methodname>() method returns the
-value of the "toolbar-style" property. See the <link
-linkend="method-gtktoolbar--set-style"><methodname>set_style</methodname>()</link>
-method for more details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--get-icon-size">
- <title>gtk.Toolbar.get_icon_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_size</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current icon size for the icons on the
-toolbar.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_icon_size</methodname>() method returns the
-current icon size for the toolbar. See the <link
-linkend="method-gtktoolbar--set-icon-size"><methodname>set_icon_size</methodname>()</link>
-method for more details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbar--get-tooltips">
- <title>gtk.Toolbar.get_tooltips</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tooltips</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if tooltips are
-enabled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tooltips</methodname>() method returns
-<literal>True</literal> if tooltips are enabled. See the <link
-linkend="method-gtktoolbar--set-tooltips"><methodname>set_tooltips</methodname>()</link>
-method for more details.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktoolbar--focus-home-or-end">
- <title>The "focus-home-or-end" gtk.Toolbar Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>toolbar</parameter></methodparam>
- <methodparam><parameter>focus_home</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>toolbar</parameter>&nbsp;:</term>
- <listitem><simpara>the <link linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link> which emitted the signal
- the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>focus_home</parameter>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the first item
- should be focused</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled, <literal>False</literal> if not</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>A keybinding signal used internally by GTK+. This signal can't
- be used in application code</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktoolbar--move-focus">
- <title>The "move-focus" gtk.Toolbar Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>toolbar</parameter></methodparam>
- <methodparam><parameter>dir</parameter></methodparam>
- <methodparam><parameter>arg1</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>toolbar</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link>
- which emitted the signal the object which received the
- signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>dir</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="gtk-direction-type-constants"
- endterm="gtk-direction-type-constants-title"></xref></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled, <literal>False</literal> if not</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>A keybinding signal used internally by GTK+. This signal can't
- be used in application code.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktoolbar--orientation-changed">
- <title>The "orientation-changed" gtk.Toolbar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>toolbar</parameter></methodparam>
- <methodparam><parameter>orientation</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>toolbar</parameter>&nbsp;:</term>
- <listitem><simpara>the toolbar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>orientation</parameter>&nbsp;:</term>
- <listitem><simpara>the new orientation</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "orientation-changed" signal is emitted when the
-<parameter>orientation</parameter> of <parameter>toolbar</parameter> is
-changed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktoolbar--popup-context-menu">
- <title>The "popup-context-menu" gtk.Toolbar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>toolbar</parameter></methodparam>
- <methodparam><parameter>x</parameter></methodparam>
- <methodparam><parameter>y</parameter></methodparam>
- <methodparam><parameter>button</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>toolbar</parameter>&nbsp;:</term>
- <listitem><simpara>the toolbar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>x</parameter>&nbsp;:</term>
- <listitem><simpara>the x coordinate of the mouse
-event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>y</parameter>&nbsp;:</term>
- <listitem><simpara>the u coordinate of the mouse
-event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>button</parameter>&nbsp;:</term>
- <listitem><simpara>the number of the mouse button</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "popup-context-menu" signal is emitted when the user
-right-clicks the toolbar or uses the keybinding to display a popup
-menu. Application developers should handle this signal if they want to
-display a context menu on the toolbar. The context-menu should appear at the
-coordinates given by <parameter>x</parameter> and
-<parameter>y</parameter>. The mouse button number is given by the
-<parameter>button</parameter> parameter. If the menu was popped up using the
-keyboard, <parameter>button</parameter> is -1.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktoolbar--style-changed">
- <title>The "style-changed" gtk.Toolbar Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>toolbar</parameter></methodparam>
- <methodparam><parameter>style</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>toolbar</parameter>&nbsp;:</term>
- <listitem><simpara>the toolbar that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>style</parameter>&nbsp;:</term>
- <listitem><simpara>the new style</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "style-changed" signal is emitted when the
-<parameter>style</parameter> of <parameter>toolbar</parameter> is
-changed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktoolbutton.xml b/docs/reference/pygtk-gtktoolbutton.xml
deleted file mode 100644
index 9cd01e11..00000000
--- a/docs/reference/pygtk-gtktoolbutton.xml
+++ /dev/null
@@ -1,736 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtktoolbutton">
- <refnamediv>
- <refname>gtk.ToolButton</refname> <refpurpose>a <link
- linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
- subclass that displays buttons (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ToolButton</classname></ooclass>
- <ooclass><classname><link linkend="class-gtktoolitem">gtk.ToolItem</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtktoolbutton">gtk.ToolButton</link></methodname>
- <methodparam><parameter role="keyword">icon_widget</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">label</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtktoolbutton2">gtk.ToolButton</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--set-label">set_label</link></methodname>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--get-label">get_label</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--set-use-underline">set_use_underline</link></methodname>
- <methodparam><parameter role="keyword">use_underline</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--get-use-underline">get_use_underline</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--set-stock-id">set_stock_id</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--get-stock-id">get_stock_id</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--set-icon-name">set_icon_name</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--get-icon-name">get_icon_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--set-icon-widget">set_icon_widget</link></methodname>
- <methodparam><parameter role="keyword">icon_widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--get-icon-widget">get_icon_widget</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--set-label-widget">set_label_widget</link></methodname>
- <methodparam><parameter role="keyword">label_widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolbutton--get-label-widget">get_label_widget</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtktoolitem">gtk.ToolItem</link>
- +-- <link linkend="class-gtktoolbutton">gtk.ToolButton</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktoolbutton">
- <title>gtk.ToolButton Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"icon-name"</entry>
- <entry>Read-Write</entry>
- <entry>The themed icon name to display in the item. This
-property only has an effect if not overridden by "label", "icon-widget" or
-"stock-id" properties. Default value: <literal>None</literal>.
-Available in GTK+ 2.8 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"icon-widget"</entry>
- <entry>Read-Write</entry>
- <entry>The icon widget to display in the item.
-Default value: <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"label"</entry>
- <entry>Read-Write</entry>
- <entry>The text to show in the item.
-Default value: <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"label-widget"</entry>
- <entry>Read-Write</entry>
- <entry>The widget to use as the item label instead of
-"label". Default value: <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"stock-id"</entry>
- <entry>Read-Write</entry>
- <entry>The stock icon displayed on the item if "label" and
-"label-widget" are <literal>None</literal>.
-Default value: <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"use-underline"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, an underline in the "label"
-property indicates that the next character should be used for the mnemonic
-accelerator key in the overflow menu.
-Default value: <literal>False</literal>.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtktoolbutton">
- <title>gtk.ToolButton Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="3.5in"/>
- <tbody>
-
- <row valign="top">
- <entry>"icon-spacing"</entry>
- <entry>Read-Write</entry>
- <entry>Spacing in pixels between the icon and label</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktoolbutton">
- <title>gtk.ToolButton Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtktoolbutton--clicked">clicked</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>toolbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>
-is a sub class of <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> that
-contains a button. Use the <link
-linkend="constructor-gtktoolbutton">gtk.ToolButton</link>() constructor to
-create a new <link
-linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>
-specifying a widget to use as the icon and a label for the
-text. Alternatively use the other <link
-linkend="constructor-gtktoolbutton2">gtk.ToolButton</link>() constructor to
-create a <link
-linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>
-from a stock item.</para>
-
- <para>The label of a <link
-linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>
-is determined by the properties "label_widget", "label", and "stock_id". If
-"label_widget" specifies a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>, that
-widget is used as the label. If "label-widget" is <literal>None</literal>,
-then the string in "label" is used as the label. If both "label-widget" and
-"label" are <literal>None</literal>, the label is determined by the stock
-item specified by "stock-id". Finally, if "label-widget", "label" and
-"stock-id" are all <literal>None</literal>, the button does not have a
-label.</para>
-
- <para>The icon of a <link
-linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>
-is determined by the properties "icon-widget" and "stock-id". If
-"icon-widget" specifies a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>, that
-widget is used as the icon. If "icon-widget" is <literal>None</literal>, the
-icon is determined by the stock item specified by "stock-id". If both
-"icon-widget" and "stock-id" are <literal>None</literal>, the button does
-not have an icon.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <refsect2 id="constructor-gtktoolbutton">
- <title>gtk.ToolButton</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ToolButton</methodname>
- <methodparam><parameter role="keyword">icon_widget</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">label</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">icon_widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
- that will be used as the icon widget, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string that will be used as the label, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new <link
- linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>
-optionally using the icon specified by <parameter>icon_widget</parameter>
-and the label text specified by <parameter>label</parameter>. If both
-<parameter>icon_widget</parameter> and <parameter>label</parameter> are
-<literal>None</literal>, the tool button will be empty.</para>
-
- </refsect2>
-
- <refsect2 id="constructor-gtktoolbutton2">
- <title>gtk.ToolButton</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ToolButton</methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>a string that specifies a stock
- item</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new <link
- linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>
-using the stock item specified by <parameter>stock_id</parameter> to
-determine the icon and label text. It is an error if
-<parameter>stock_id</parameter> is not a name of a stock item.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktoolbutton--set-label">
- <title>gtk.ToolButton.set_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_label</methodname>
- <methodparam><parameter role="keyword">label</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">label</parameter>&nbsp;:</term>
- <listitem><simpara>a string that will be used as label, or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_label</methodname>() method sets the "label"
-property to the value of <parameter>label</parameter>. If the "label_widget"
-property is <literal>None</literal>, label will be used as the label of the
-tool button.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbutton--get-label">
- <title>gtk.ToolButton.get_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_label</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The label, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_label</methodname>() method returns the
-value of the "label" property that is used as the label of the tool button
-if the "label-widget" property is <literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbutton--set-use-underline">
- <title>gtk.ToolButton.set_use_underline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_underline</methodname>
- <methodparam><parameter role="keyword">use_underline</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">use_underline</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, an underline in the
- label string specifies a mnemonic key for the overflow
- menu</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_use_underline</methodname>() method sets the
-"use-underline" property to the value of
-<parameter>use_underline</parameter>. If
-<parameter>use_underline</parameter> is <literal>True</literal>, an
-underline in the "label" property indicates that the next character should
-be used for the mnemonic accelerator key in the overflow menu. For example,
-if the label property is "_Open" and <parameter>use_underline</parameter> is
-<literal>True</literal>, the label on the tool button will be "Open" and the
-item on the overflow menu will have an underlined 'O'. Labels shown on tool
-buttons never have mnemonics on them; this property only affects the menu
-item on the overflow menu.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbutton--get-use-underline">
- <title>gtk.ToolButton.get_use_underline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_underline</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if underscores in the
- "label" property are used as mnemonics on menu items on the
- overflow menu.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_use_underline</methodname>() method returns
-the value of the "use-underline" property. If "use-underline" is
-<literal>True</literal>, underscores in the label property are used as
-mnemonics on menu items on the overflow menu. See the <link
-linkend="method-gtktoolbutton--set-use-underline"><methodname>set_use_underline()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbutton--set-stock-id">
- <title>gtk.ToolButton.set_stock_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_stock_id</methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>a name of a stock item, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_stock_id</methodname>() method sets the
-"stock-id" property to the value of <parameter>stock_id</parameter>. The
-stock item specified by <parameter>stock_id</parameter> is used to determine
-the icon and label if not overridden by the "label" and "icon-widget"
-properties. See the <link
-linkend="constructor-gtktoolbutton2">gtk.ToolButton</link>() constructor for
-more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbutton--get-stock-id">
- <title>gtk.ToolButton.get_stock_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_stock_id</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the stock item.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_stock_id</methodname>() method returns the
-value of the "stock-id" property that contains the name of a stock item or
-<literal>None</literal>. See the <link
-linkend="constructor-gtktoolbutton2">gtk.ToolButton</link>() constructor for
-more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbutton--set-icon-name">
- <title>gtk.ToolButton.set_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_name</methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>a name of a themed icon, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_icon_name</methodname>() method sets the
-"icon-name" property to the value of <parameter>icon_name</parameter>. The
-themed icon name specified by <parameter>icon_name</parameter> is used to
-determine the icon for the toolbutton if not overridden by the "label",
-"stock-id" and "icon-widget" properties. See the <link
-linkend="constructor-gtktoolbutton2">gtk.ToolButton</link>() constructor for
-more information.</para>
-
-<para>In PyGTK 2.10 and above, <parameter>icon_name</parameter> may be
-<literal>None</literal> to unset the icon name.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbutton--get-icon-name">
- <title>gtk.ToolButton.get_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the stock item.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_icon_name</methodname>() method returns the
-value of the "icon_name" property that contains the name of a themed icon or
-<literal>None</literal>. See the <link
-linkend="constructor-gtktoolbutton2">gtk.ToolButton</link>() constructor for
-more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbutton--set-icon-widget">
- <title>gtk.ToolButton.set_icon_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_widget</methodname>
- <methodparam><parameter role="keyword">icon_widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">icon_widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget used as icon, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_icon_widget</methodname>() method sets the
-"icon-widget" property to the value of
-<parameter>icon_widget</parameter>. If <parameter>icon_widget</parameter>
-specifies a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>, it is
-used as the icon of the tool button. If <parameter>icon_widget</parameter>
-is <literal>None</literal> the icon is determined by the "stock_id"
-property. If the "stock_id" property is also <literal>None</literal>, the
-tool button will not have an icon.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbutton--get-icon-widget">
- <title>gtk.ToolButton.get_icon_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_widget</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The widget used as icon on
- <parameter>button</parameter>, or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_icon_widget</methodname>() method returns
-the value of the "icon-widget" property that contains the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> used as
-the icon on the tool button. See the <link
-linkend="method-gtktoolbutton--set-icon-widget"><methodname>set_icon_widget()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbutton--set-label-widget">
- <title>gtk.ToolButton.set_label_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_label_widget</methodname>
- <methodparam><parameter role="keyword">label_widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">label_widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget used as the label, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_label_widget</methodname>() method sets the
-"label-widget" property to the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> specified
-by <parameter>label_widget</parameter> that will be used as the label for
-the tool button. If <parameter>label_widget</parameter> is
-<literal>None</literal> the "label" property is used as label. If
-"label-widget" and "label" are both <literal>None</literal>, the label in
-the stock item determined by the "stock_id" property is used as the
-label. If "label-widget", "label" and "stock_id" are all
-<literal>None</literal>, the tool button will not have a label.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolbutton--get-label-widget">
- <title>gtk.ToolButton.get_label_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_label_widget</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The widget used as label on
- <parameter>button</parameter>, or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_label_widget</methodname>() method returns
-the value of the "label-widget" property that is used as the label on the
-tool button. See the <link
-linkend="method-gtktoolbutton--set-label-widget"><methodname>gtk.ToolButton.set_label_widget()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktoolbutton--clicked">
- <title>The "clicked" gtk.ToolButton Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>toolbutton</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>toolbutton</parameter>&nbsp;:</term>
- <listitem><simpara>the toolbutton that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "clicked" signal is emitted when the tool button is clicked
-with the mouse or activated with the keyboard.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktoolitem.xml b/docs/reference/pygtk-gtktoolitem.xml
deleted file mode 100644
index b5f152ad..00000000
--- a/docs/reference/pygtk-gtktoolitem.xml
+++ /dev/null
@@ -1,1167 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtktoolitem">
- <refnamediv>
- <refname>gtk.ToolItem</refname> <refpurpose>the base class of widgets
- that can be added to <link
- linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link>
- (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.ToolItem</classname></ooclass>
- <ooclass><classname><link linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtktoolitem">gtk.ToolItem</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--set-homogeneous">set_homogeneous</link></methodname>
- <methodparam><parameter role="keyword">homogeneous</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--get-homogeneous">get_homogeneous</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--set-expand">set_expand</link></methodname>
- <methodparam><parameter role="keyword">expand</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--get-expand">get_expand</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--set-tooltip">set_tooltip</link></methodname>
- <methodparam><parameter role="keyword">tooltips</parameter></methodparam>
- <methodparam><parameter role="keyword">tip_text</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">tip_private</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--set-use-drag-window">set_use_drag_window</link></methodname>
- <methodparam><parameter role="keyword">use_drag_window</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--get-use-drag-window">get_use_drag_window</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--set-visible-horizontal">set_visible_horizontal</link></methodname>
- <methodparam><parameter role="keyword">visible_horizontal</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--get-visible-horizontal">get_visible_horizontal</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--set-visible-vertical">set_visible_vertical</link></methodname>
- <methodparam><parameter role="keyword">visible_vertical</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--get-visible-vertical">get_visible_vertical</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--set-is-important">set_is_important</link></methodname>
- <methodparam><parameter role="keyword">is_important</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--get-is-important">get_is_important</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--get-icon-size">get_icon_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--get-orientation">get_orientation</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--get-toolbar-style">get_toolbar_style</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--get-relief-style">get_relief_style</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--retrieve-proxy-menu-item">retrieve_proxy_menu_item</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--set-proxy-menu-item">set_proxy_menu_item</link></methodname>
- <methodparam><parameter role="keyword">menu_item_id</parameter></methodparam>
- <methodparam><parameter role="keyword">menu_item</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--get-proxy-menu-item">get_proxy_menu_item</link></methodname>
- <methodparam><parameter role="keyword">menu_item_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktoolitem--rebuild-menu">rebuild_menu</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtktoolitem">gtk.ToolItem</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktoolitem">
- <title>gtk.ToolItem Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <note>
- <para>These properties are available in GTK+ 2.4 and above.</para>
- </note>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"is-important"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, the toolbar item is
-considered important and the toolbar buttons show text in
-<literal>gtk.TOOLBAR_BOTH_HORIZ</literal> mode. Default value:
-<literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"visible-horizontal"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, the toolbar item is visible
-when the toolbar is in a horizontal orientation. Default value:
-<literal>True</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"visible-vertical"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, the toolbar item is visible
-when the toolbar is in a vertical orientation. Default value:
-<literal>True</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtktoolitem">
- <title>gtk.ToolItem Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktoolitem">
- <title>gtk.ToolItem Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtktoolitem--create-menu-proxy">create-menu-proxy</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>toolitem</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktoolitem--set-tooltip">set-tooltip</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>toolitem</parameter></methodparam>
- <methodparam><parameter>tooltips</parameter></methodparam>
- <methodparam><parameter>tip_text</parameter></methodparam>
- <methodparam><parameter>tip_private</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktoolitem--toolbar-reconfigured">toolbar-reconfigured</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>toolitem</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> is a
-widget that can appear on a <link
-linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link>. To
-create a toolbar item that contains something else than a button, use the
-<link linkend="constructor-gtktoolitem">gtk.ToolItem</link>() constructor
-then use the <link
-linkend="method-gtkcontainer--add"><methodname>gtk.Container.add</methodname>()</link>
-method to add a child widget to the tool item.</para>
-
- <para>To create and use toolbar items that contain buttons, see the
-<link
-linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>,
-<link
-linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>
-and <link
-linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>
-classes. See the <link
-linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link> class
-for a description of the toolbar widget.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktoolitem">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.ToolItem</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
- linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new empty <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktoolitem--set-homogeneous">
- <title>gtk.ToolItem.set_homogeneous</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_homogeneous</methodname>
- <methodparam><parameter role="keyword">homogeneous</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">homogeneous</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the tool item is the
- same size as other homogeneous items</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_homogeneous</methodname>() method sets the
-homogeneous setting of the tool item to the value of
-<parameter>homogeneous</parameter>. If <parameter>homogeneous</parameter> is
-<literal>True</literal> the tool item is to be allocated the same size as
-other homogeneous items. The effect is that all homogeneous items will have
-the same width as the widest of the items.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--get-homogeneous">
- <title>gtk.ToolItem.get_homogeneous</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_homogeneous</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the item is the same
- size as other homogeneous items.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_homogeneous</methodname>() method returns
-the setting of the homogeneous setting of the tool item. If
-<literal>True</literal> the tool item is the same size as other homogeneous
-items. See the <link
-linkend="method-gtktoolitem--set-homogeneous"><methodname>set_homogeneous()</methodname></link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--set-expand">
- <title>gtk.ToolItem.set_expand</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_expand</methodname>
- <methodparam><parameter role="keyword">expand</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> the tool item is
- allocated extra space when available</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_expand</methodname>() method sets the expand
-setting of the tool item to the value of <parameter>expand</parameter>. If
-<parameter>expand</parameter> is <literal>True</literal> the tool item is
-allocated extra space when there is more room on the toolbar than needed for
-the items. The effect is that the item gets bigger when the toolbar gets
-bigger and smaller when the toolbar gets smaller.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--get-expand">
- <title>gtk.ToolItem.get_expand</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_expand</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the tool item is
- allocated extra space when available.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_expand</methodname>() method returns the
-value of the expand setting of the tool item. If <literal>True</literal> the
-tool item is allocated extra space. See the <link
-linkend="method-gtktoolitem--set-expand"><methodname>gtk.ToolItem.set_expand()</methodname></link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--set-tooltip">
- <title>gtk.ToolItem.set_tooltip</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tooltip</methodname>
- <methodparam><parameter role="keyword">tooltips</parameter></methodparam>
- <methodparam><parameter role="keyword">tip_text</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">tip_private</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tooltips</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
- linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
- object to be used</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the text to be used as tooltip text for the
- tool item or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">tip_private</parameter>&nbsp;:</term>
- <listitem><simpara>the text to be used as private tooltip
- text or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_tooltip</methodname>() method sets the <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
-object specified by <parameter>tooltips</parameter> to be used for the tool
-item with the tooltip text specified by <parameter>tip_text</parameter> and
-the private text specified by <parameter>tip_private</parameter>. See the
-<link
-linkend="method-gtktooltips--set-tip"><methodname>gtk.Tooltips.set_tip()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--set-use-drag-window">
- <title>gtk.ToolItem.set_use_drag_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_use_drag_window</methodname>
- <methodparam><parameter role="keyword">use_drag_window</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">use_drag_window</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the tool item has a
- drag window.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_use_drag_window</methodname>() method
-determines whether the tool item has a drag window according to the value of
-<parameter>use_drag_window</parameter>. If
-<parameter>use_drag_window</parameter> is <literal>True</literal> the
-toolitem can be used as a drag source through the <link
-linkend="method-gtkwidget--drag-source-set"><methodname>gtk.Widget.drag_source_set()</methodname></link>
-method. When the tool item has a drag window it will intercept all events,
-even those that would otherwise be sent to a child of the tool item</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--get-use-drag-window">
- <title>gtk.ToolItem.get_use_drag_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_use_drag_window</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the tool item uses a
- drag window.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_use_drag_window</methodname>() returns the
-setting that determines if the tool item has a drag window. See the <link
-linkend="method-gtktoolitem--set-use-drag-window"><methodname>set_use_drag_window()</methodname></link>
-for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--set-visible-horizontal">
- <title>gtk.ToolItem.set_visible_horizontal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible_horizontal</methodname>
- <methodparam><parameter role="keyword">visible_horizontal</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">visible_horizontal</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the tool item is
- visible when in horizontal mode</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_visible_horizontal</methodname>() method
-sets the "visible-horizontal" property to the value of
-<parameter>visible_horizontal</parameter>. If
-<parameter>visible_horizontal</parameter> is <literal>True</literal>, the
-tool item is visible when the toolbar is docked horizontally.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--get-visible-horizontal">
- <title>gtk.ToolItem.get_visible_horizontal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_horizontal</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the tool item is
- visible on toolbars that are docked
- horizontally.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_visible_horizontal</methodname>() method
-returns the value of the "visible-horizontal" property. If
-"visible-horizontal" is <literal>True</literal>, the tool item is visible on
-toolbars that are docked horizontally.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--set-visible-vertical">
- <title>gtk.ToolItem.set_visible_vertical</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible_vertical</methodname>
- <methodparam><parameter role="keyword">visible_vertical</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">visible_vertical</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the tool item is
- visible when the toolbar is in vertical mode</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_visible_vertical</methodname>() method sets
-the "visible-vertical" property to the value of
-<parameter>visible_vertical</parameter>. If
-<parameter>visible_vertical</parameter> is <literal>True</literal>, the tool
-item is visible when the toolbar is docked vertically. Some tool items, such
-as text entries, are too wide to be useful on a vertically docked
-toolbar. If <parameter>visible_vertical</parameter> is
-<literal>False</literal> the tool item will not appear on toolbars that are
-docked vertically.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--get-visible-vertical">
- <title>gtk.ToolItem.get_visible_vertical</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_vertical</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the tool item is visible when the
- toolbar is docked vertically</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_visible_vertical</methodname>() method
-returns the value of the "visible-vertical" property. If "visible-vertical"
-is <literal>True</literal>, the tool item is visible when the toolbar is
-docked vertically. See the <link
-linkend="method-gtktoolitem--set-visible-vertical"><methodname>set_visible_vertical()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--set-is-important">
- <title>gtk.ToolItem.set_is_important</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_is_important</methodname>
- <methodparam><parameter role="keyword">is_important</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">is_important</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the tool item
- should be considered important</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_is_important</methodname>() method sets the
-"is-important" property to the value of
-<parameter>is_important</parameter>. If <parameter>is_important</parameter>
-is <literal>True</literal> the tool item should be considered important. The
-<link
-linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>
-class uses this property to determine whether to show its label when the
-toolbar style is <literal>gtk.TOOLBAR_BOTH_HORIZ</literal>. The result is
-that only tool buttons with the "is_important" property set have labels, an
-effect known as "priority text".</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--get-is-important">
- <title>gtk.ToolItem.get_is_important</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_is_important</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the tool item is
- considered important.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_is_important</methodname>() method returns
-the value of the "is-important" property. If "is-important" is
-<literal>True</literal>, the tool item is considered important. See the
-<link
-linkend="method-gtktoolitem--set-is-important"><methodname>set_is_important()</methodname></link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--get-icon-size">
- <title>gtk.ToolItem.get_icon_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the icon size used for the tool
- item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_icon_size</methodname>() method returns the
-icon size used for the tool item. Custom subclasses of <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-should call this method to find out what size icons they should use. The
-return value should be one of: <literal>gtk.ICON_SIZE_MENU</literal>,
-<literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal>,
-<literal>gtk.ICON_SIZE_BUTTON</literal>,
-<literal>gtk.ICON_SIZE_DND</literal>,
-<literal>gtk.ICON_SIZE_DIALOG</literal> or an integer value returned from
-the <link
-linkend="function-gtk--icon-size-register"><function>gtk.icon_size_register</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--get-orientation">
- <title>gtk.ToolItem.get_orientation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_orientation</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the orientation used for the tool
- item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_orientation</methodname>() method returns
-the orientation used for the tool item. Custom subclasses of <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-should call this method to find out what size icons they should use. The
-return value should be either <literal>gtk.ORIENTATION_HORIZONTAL</literal>
-or <literal>gtk.ORIENTATION_VERTICAL</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--get-toolbar-style">
- <title>gtk.ToolItem.get_toolbar_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_toolbar_style</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the toolbar style used for the tool
- item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_toolbar_style</methodname>() method returns
-the toolbar style used for the tool item. Custom subclasses of <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-should call this method in the "<link
-linkend="signal-gtktoolitem--toolbar-reconfigured">toolbar-reconfigured</link>"
-signal handler to find out in what style the toolbar is displayed and change
-themselves accordingly.</para>
-
- <para>Possibilities are:</para>
-
- <itemizedlist>
- <listitem>
- <para><literal>gtk.TOOLBAR_BOTH</literal>, meaning the tool item
-should show both an icon and a label, stacked vertically</para>
- </listitem>
- <listitem>
- <para><literal>gtk.TOOLBAR_ICONS</literal>, meaning the toolbar
-shows only icons</para>
- </listitem>
- <listitem>
- <para><literal>gtk.TOOLBAR_TEXT</literal>, meaning the tool item
-should only show text</para>
- </listitem>
- <listitem>
- <para><literal>gtk.TOOLBAR_BOTH_HORIZ</literal>, meaning the tool
-item should show both an icon and a label, arranged horizontally..</para>
- </listitem>
- </itemizedlist>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--get-relief-style">
- <title>gtk.ToolItem.get_relief_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_relief_style</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the relief style used for the tool
- item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_relief_style</methodname>() method returns
-the relief style of the tool item. See the <link
-linkend="method-gtkbutton--set-relief"><methodname>gtk.Button.set_relief</methodname>()</link>
-method for more information. Custom subclasses of <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-should call this method in the handler of the <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-"<link
-linkend="signal-gtktoolitem--toolbar-reconfigured">toolbar-reconfigured</link>"
-signal to find out the relief style of buttons.</para>
-
- <para>The return value should be one of:
-<literal>gtk.RELIEF_NORMAL</literal>, <literal>gtk.RELIEF_HALF</literal> or
-<literal>gtk.RELIEF_NONE</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--retrieve-proxy-menu-item">
- <title>gtk.ToolItem.retrieve_proxy_menu_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>retrieve_proxy_menu_item</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The <link linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> that is going to appear in the
-overflow menu for the tool item</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>retrieve_proxy_menu_item</methodname>() method
-returns the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> that
-was last set by the <link
-linkend="method-gtktoolitem--set-proxy-menu-item"><methodname>set_proxy_menu_item()</methodname></link>
-method, i.e. the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> that
-is going to appear in the overflow menu.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--set-proxy-menu-item">
- <title>gtk.ToolItem.set_proxy_menu_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_proxy_menu_item</methodname>
- <methodparam><parameter role="keyword">menu_item_id</parameter></methodparam>
- <methodparam><parameter role="keyword">menu_item</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">menu_item_id</parameter>&nbsp;:</term>
- <listitem><simpara>a string used to identify
- <parameter>menu_item</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">menu_item</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
- to be used in the overflow menu or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_proxy_menu_item</methodname>() method sets
-the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-specified by <parameter>menu_item</parameter> to be used in the toolbar
-overflow menu. <parameter>menu_item_id</parameter> is used to identify the
-caller of this method and should also be used with the <link
-linkend="method-gtktoolitem--get-proxy-menu-item"><methodname>get_proxy_menu_item()</methodname></link>
-method. If <parameter>menu_item</parameter> is <literal>None</literal> the
-tool item will not appear in the overflow menu.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--get-proxy-menu-item">
- <title>gtk.ToolItem.get_proxy_menu_item</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_proxy_menu_item</methodname>
- <methodparam><parameter role="keyword">menu_item_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">menu_item_id</parameter>&nbsp;:</term>
- <listitem><simpara>a string used to identify the menu
- item</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The <link
- linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
- matching <parameter>menu_item_id</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_proxy_menu_item</methodname>() method
-returns the <link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
-corresponding to the string specified by <parameter>menu_item_id</parameter>
-as passed to the <link
-linkend="method-gtktoolitem--set-proxy-menu-item"><methodname>set_proxy_menu_item()</methodname></link>
-method.</para>
-
- <para>Custom subclasses of <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-should use this method to update their menu item when the <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
-changes. Forcing a match with <parameter>menu_item_id</parameter> ensures
-that a <link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> will
-not inadvertently change a menu item that they did not create.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktoolitem--rebuild-menu">
- <title>gtk.ToolItem.rebuild_menu</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>rebuild_menu</methodname>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>rebuild_menu</methodname>() method ignals to the
-toolbar that the overflow menu item has changed. If the overflow menu is
-visible when this method it called, the menu will be rebuilt. The method
-must be called when the tool item changes what it will do in response to the
-"create_menu_proxy" signal.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktoolitem--create-menu-proxy">
- <title>The "create-menu-proxy" gtk.ToolItem Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>toolitem</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>toolitem</parameter>&nbsp;:</term>
- <listitem><simpara>the toolitem that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "create-menu-proxy" signal is emitted when the toolbar is
-displaying an overflow menu and is trying to determine if
-<parameter>toolitem</parameter> should appear in the overflow menu. In
-response <parameter>toolitem</parameter> should either</para>
-
- <itemizedlist>
- <listitem>
- <para>call the <link
-linkend="method-gtktoolitem--set-proxy-menu-item"><methodname>set_proxy_menu_item</methodname>()</link>
-method specifying <parameter>menu_item</parameter> as
-<literal>None</literal> and return <literal>True</literal> to indicate that
-the item should not appear in the overflow menu</para>
- </listitem>
- <listitem>
- <para>call the <link
-linkend="method-gtktoolitem--set-proxy-menu-item"><methodname>set_proxy_menu_item</methodname>()</link>
-method with a new menu item and return <literal>True</literal>, or</para>
- </listitem>
- <listitem>
- <para>return <literal>False</literal> to indicate that the signal
-was not handled by the item. This means that the item will not appear in the
-overflow menu unless a later handler installs a menu item.</para>
- </listitem>
- </itemizedlist>
-
- <para>The toolbar may cache the result of this signal. When the tool
-item changes how it will respond to this signal it must call the <link
-linkend="method-gtktoolitem--rebuild-menu"><methodname>rebuild_menu</methodname>()</link>)
-method to invalidate the cache and ensure that the toolbar rebuilds its
-overflow menu.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktoolitem--set-tooltip">
- <title>The "set-tooltip" gtk.ToolItem Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>toolitem</parameter></methodparam>
- <methodparam><parameter>tooltips</parameter></methodparam>
- <methodparam><parameter>tip_text</parameter></methodparam>
- <methodparam><parameter>tip_private</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>toolitem</parameter>&nbsp;:</term>
- <listitem><simpara>the toolitem that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>tooltips</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>tip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>tip_private</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip private text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "set-tooltip" signal is emitted when the tool item's tooltip
-changes. Application developers can use the <link
-linkend="method-gtktoolitem--set-tooltip"><methodname>set_tooltip</methodname>()</link>
-method to set the item's tooltip.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktoolitem--toolbar-reconfigured">
- <title>The "toolbar-reconfigured" gtk.ToolItem Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>toolitem</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>toolitem</parameter>&nbsp;:</term>
- <listitem><simpara>the toolitem that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "toolbar-reconfigured" signal is emitted when some property
-of the toolbar that the item is a child of changes. For custom subclasses of
-<link
-linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>, the
-default handler of this signal uses the methods:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><link
-linkend="method-gtktoolbar--get-orientation"><methodname>gtk.Toolbar.get_orientation</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-gtktoolbar--get-style"><methodname>gtk.Toolbar.get_style</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-gtktoolbar--get-icon-size"><methodname>gtk.Toolbar.get_icon_size</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-gtktoolbar--get-relief-style"><methodname>gtk.Toolbar.get_relief_style</methodname>()</link></simpara>
- </listitem>
- </itemizedlist>
-
- <para>to find out what the toolbar should look like and change
-themselves accordingly.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktooltips.xml b/docs/reference/pygtk-gtktooltips.xml
deleted file mode 100644
index 7938224d..00000000
--- a/docs/reference/pygtk-gtktooltips.xml
+++ /dev/null
@@ -1,343 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktooltips">
- <refnamediv>
- <refname>gtk.Tooltips</refname>
- <refpurpose>add tips to your widgets.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Tooltips</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktooltips">gtk.Tooltips</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktooltips--enable">enable</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktooltips--disable">disable</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktooltips--set-tip">set_tip</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tip_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tip_private</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktooltips--force-window">force_window</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--tooltips-data-get">gtk.tooltips_data_get</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtktooltips">gtk.Tooltips</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktooltips">
- <title>gtk.Tooltips Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"tip_window"</entry>
- <entry>Read</entry>
- <entry>The window that the tooltip is displayed in.</entry>
- </row>
-
- <row valign="top">
- <entry>"tip_label"</entry>
- <entry>Read</entry>
- <entry>The label that displays the tooltip text.</entry>
- </row>
-
- <row valign="top">
- <entry>"active_tips_data"</entry>
- <entry>Read</entry>
- <entry>The data associated with the active tooltip.</entry>
- </row>
-
- <row valign="top">
- <entry>"tips_data_list"</entry>
- <entry>Read</entry>
- <entry>A list containing the data associated with the tooltips in a tooltips group. For each tooltip the data is a tuple containing:
-the tooltip object, the associated widget, the tooltip text and the tooltip
-private text.</entry>
- </row>
-
- <row valign="top">
- <entry>"delay"</entry>
- <entry>Read</entry>
- <entry>The delay between the mouse pausing over the widget and
-the display of the tooltip in msec.</entry>
- </row>
-
- <row valign="top">
- <entry>"enabled"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the tooltips are
-enabled</entry>
- </row>
-
- <row valign="top">
- <entry>"use_sticky_delay"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> shorten the delay for
-showing a tooltip on another widget is already showing a tooltip.</entry>
- </row>
-
- <row valign="top">
- <entry>"timer_tag"</entry>
- <entry>Read</entry>
- <entry>The tag of the timeout handler used for the
-delay.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktooltips">
- <title>gtk.Tooltips Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>Tooltips are the messages that appear next to a widget when the
-mouse pointer is held over it for a short amount of time. They are
-especially helpful for adding more verbose descriptions of things such as
-buttons in a toolbar. An individual tooltip belongs to a group of tooltips.
-A group is created with a call to the <link
-linkend="constructor-gtktooltips">gtk.Tooltips</link>() constructor. Every
-tooltip in the group can then be turned off with a call to the <link
-linkend="method-gtktooltips--disable"><methodname>disable</methodname>()</link>
-method and enabled with the <link
-linkend="method-gtktooltips--enable"><methodname>enable</methodname>()</link>
-method. To assign a tip to a particular <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>, use the
-<link
-linkend="method-gtktooltips--set-tip"><methodname>set_tip</methodname>()</link>
-method.</para>
-
- <note>
- <para>Tooltips can only be set on widgets which have their own X
-window. To check if a widget has its own window use
-<literal>widget.flags()&amp;gtk.NO_WINDOW</literal>. To add a tooltip to a
-widget that doesn't have its own window, place the widget inside a <link
-linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link> and
-add a tooltip to the eventbox instead.</para>
- </note>
-
- <para>The default appearance of all tooltips in a program is determined
-by the current theme that the user has selected. Information about the
-tooltip (if any) associated with an arbitrary widget can be retrieved using
-the <link
-linkend="function-gtk--tooltips-data-get"><function>gtk.tooltips_data_get</function>()</link>
-function.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktooltips">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Tooltips</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates an empty <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
-group.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktooltips--enable">
- <title>gtk.Tooltips.enable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>enable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>enable</methodname>() method enables a group of
-tooltips. A tooltip will be displayed over its associated widget when
-the mouse pointer pauses over the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktooltips--disable">
- <title>gtk.Tooltips.disable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>disable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>disable</methodname>() method disables a group
-of tooltips. A tooltip will not be displayed over its associated widget when
-the mouse pointer pauses over the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktooltips--set-tip">
- <title>gtk.Tooltips.set_tip</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>set_tip</methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- <methodparam><parameter role="keyword">tip_text</parameter></methodparam>
- <methodparam><parameter role="keyword">tip_private</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tip_text</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tip_private</parameter>&nbsp;:</term>
- <listitem><simpara>the tooltip private text for context sensitive display</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_tips</methodname>() method creates a tooltip
-for the specified <parameter>widget</parameter>. The text specified by
-<parameter>tooltip_text</parameter> will be displayed when the mouse pointer
-pauses over <parameter>widget</parameter> if the tooltips are
-enabled..</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktooltips--force-window">
- <title>gtk.Tooltips.force_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>force_window</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>force_window</methodname>() method ensures that
-the window used for displaying the given tooltips is created. Applications
-should never have to call this function, since PyGTK takes care of
-this.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--tooltips-data-get">
- <title>gtk.tooltips_data_get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.tooltips_data_get</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the tooltip data associated
-with <parameter>widget</parameter> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.tooltips_data_get</function>() function
-returns a tuple containing the tooltip data associated with
-<parameter>widget</parameter>. The tuple contains:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> group
-containing the tooltip</simpara>
- </listitem>
- <listitem>
- <simpara>the widget</simpara>
- </listitem>
- <listitem>
- <simpara>the tooltip text string</simpara>
- </listitem>
- <listitem>
- <simpara>the tooltip private text string or
-<literal>None</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para>If <parameter>widget</parameter> does not have an associated
-tooltip this function returns <literal>None</literal>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreedragdest.xml b/docs/reference/pygtk-gtktreedragdest.xml
deleted file mode 100644
index 300012e4..00000000
--- a/docs/reference/pygtk-gtktreedragdest.xml
+++ /dev/null
@@ -1,135 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktreedragdest">
- <refnamediv>
- <refname>gtk.TreeDragDest</refname>
- <refpurpose>an interface that manages the data transfer for a
-destination of a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> drag
-and drop operation</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeDragDest</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreedragdest--drag-data-received">drag_data_received</link></methodname>
- <methodparam><parameter
- role="keyword">dest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">selection_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreedragdest--row-drop-possible">row_drop_possible</link></methodname>
- <methodparam><parameter
- role="keyword">dest_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">selection_data</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtktreedragdest"><classname>gtk.TreeDragDest</classname></link>
-is an interface for checking and receiving the data for the destination of a
-<link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-drag and drop operation.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreedragdest--drag-data-received">
- <title>gtk.TreeDragDest.drag_data_received</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_data_received</methodname>
- <methodparam><parameter
- role="keyword">dest</parameter></methodparam>
- <methodparam><parameter
- role="keyword">selection_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dest</parameter>&nbsp;:</term>
- <listitem><simpara>the row to drop the data in front
-of</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">selection_data</parameter>&nbsp;:</term>
- <listitem><simpara>the data to drop</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a new row was
-created before position <parameter>dest</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_data_received</methodname>() method asks
-the <link
-linkend="class-gtktreedragdest"><classname>gtk.TreeDragDest</classname></link>
-to insert a row before the path <parameter>dest</parameter>, deriving the
-contents of the row from <parameter>selection_data</parameter>. If
-<parameter>dest</parameter> is outside the tree so that inserting before it
-is impossible, <literal>False</literal> will be returned. Also,
-<literal>False</literal> may be returned if the new row is not created for
-some model-specific reason.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreedragdest--row-drop-possible">
- <title>gtk.TreeDragDest.row_drop_possible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>row_drop_possible</methodname>
- <methodparam><parameter
- role="keyword">dest_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">selection_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">dest_path</parameter>&nbsp;:</term>
- <listitem><simpara>a destination row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">selection_data</parameter>&nbsp;:</term>
- <listitem><simpara>the data being dragged</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if a drop is possible before
-<parameter>dest_path</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>row_drop_possible</methodname>() method
-determines if a drop is possible before the tree path specified by
-<parameter>dest_path</parameter> and at the same depth as
-<parameter>dest_path</parameter>. That is, can we drop the data specified by
-<parameter>selection_data</parameter> at that location.
-<parameter>dest_path</parameter> does not have to exist but the return value
-will almost certainly be <literal>False</literal> if the parent of
-<parameter>dest_path</parameter> doesn't exist, though.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreedragsource.xml b/docs/reference/pygtk-gtktreedragsource.xml
deleted file mode 100644
index 6d86a221..00000000
--- a/docs/reference/pygtk-gtktreedragsource.xml
+++ /dev/null
@@ -1,158 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktreedragsource">
- <refnamediv>
- <refname>gtk.TreeDragSource</refname>
- <refpurpose>an interface that manages the source data transfer for a
-<link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-drag and drop operation</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeDragSource</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreedragsource--row-draggable">row_draggable</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreedragsource--drag-data-delete">drag_data_delete</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreedragsource--drag-data-get">drag_data_get</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">selection_data</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link linkend="class-gtktreedragsource"><classname>gtk.TreeDragSource</classname></link> is an interface that provides for the management of the source data for a <link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> drag and drop operation.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreedragsource--row-draggable">
- <title>gtk.TreeDragSource.row_draggable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>row_draggable</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the row from which the user is initiating a
-drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the row can be
-dragged</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>row_draggable</methodname>() method asks the
-<link
-linkend="class-gtktreedragsource"><classname>gtk.TreeDragSource</classname></link>
-if the row specified by <parameter>path</parameter> can be used as the
-source of a DND operation. If the <link
-linkend="class-gtktreedragsource"><classname>gtk.TreeDragSource</classname></link>
-doesn't implement this interface, the row is assumed draggable.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreedragsource--drag-data-delete">
- <title>gtk.TreeDragSource.drag_data_delete</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_data_delete</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the row that was being
-dragged</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the row was
-successfully deleted</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_data_delete</methodname>() method asks the
-<link
-linkend="class-gtktreedragsource"><classname>gtk.TreeDragSource</classname></link>
-to delete the row specified by <parameter>path</parameter>, because it was
-moved somewhere else via drag-and-drop. This method returns
-<literal>False</literal> if the deletion fails because
-<parameter>path</parameter> no longer exists, or for some other
-model-specific reason.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreedragsource--drag-data-get">
- <title>gtk.TreeDragSource.drag_data_get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_data_get</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">selection_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the row that was dragged</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">selection_data</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-to fill with data from the dragged row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if data of the required
-type was provided</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_data_get</methodname>() method asks the
-<link
-linkend="class-gtktreedragsource"><classname>gtk.TreeDragSource</classname></link>
-to fill in the selection data object specified by
-<parameter>selection_data</parameter> with a representation of the row
-specified by <parameter>path</parameter>. The
-<parameter>selection_data</parameter> target attribute gives the required
-type of the data. </para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreeiter.xml b/docs/reference/pygtk-gtktreeiter.xml
deleted file mode 100644
index 0da7820c..00000000
--- a/docs/reference/pygtk-gtktreeiter.xml
+++ /dev/null
@@ -1,121 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktreeiter">
- <refnamediv>
- <refname>gtk.TreeIter</refname>
- <refpurpose>An object that points at a path in a <link linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeIter</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeiter--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeiter--free">free</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> is an
-object that points at a path in a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>. A
-<link linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-is created using one of the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> or
-<link
-linkend="class-gtktreemodelsort"><classname>gtk.TreeModelSort</classname></link>
-methods:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><link
-linkend="method-gtktreemodel--get-iter"><methodname>gtk.TreeModel.get_iter</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-gtktreemodel--get-iter-from-string"><methodname>gtk.TreeModel.get_iter_from_string</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-gtktreemodel--get-iter-first"><methodname>gtk.TreeModel.get_iter_first</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-gtktreemodel--get-iter-root"><methodname>gtk.TreeModel.get_iter_root</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-gtktreemodel--iter-children"><methodname>gtk.TreeModel.iter_children</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-gtktreemodel--iter-parent"><methodname>gtk.TreeModel.iter_parent</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-gtktreemodelsort--convert-child-iter-to-iter"><methodname>gtk.TreeModelSort.convert_child_iter_to_iter</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-gtktreemodelsort--convert-iter-to-child-iter"><methodname>gtk.TreeModelSort.convert_child_iter_to_child_iter</methodname>()</link></simpara>
- </listitem>
- </itemizedlist>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreeiter--copy">
- <title>gtk.TreeIter.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the treeiter.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns a copy of the
-treeiter. This iter must be freed with the <link
-linkend="method-gtktreeiter--free"><methodname>free</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeiter--free">
- <title>gtk.TreeIter.free</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>free</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <warning>
- <para>This method is deprecated and should not be used since it can
- crash your application.</para>
- </warning>
-
- <para>The <methodname>free</methodname>() method frees a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</para>
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreemodel.xml b/docs/reference/pygtk-gtktreemodel.xml
deleted file mode 100644
index a1b766f0..00000000
--- a/docs/reference/pygtk-gtktreemodel.xml
+++ /dev/null
@@ -1,1579 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktreemodel">
- <refnamediv>
- <refname>gtk.TreeModel</refname>
- <refpurpose>the tree interface used by <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeModel</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--get-flags">get_flags</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--get-n-columns">get_n_columns</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--get-column-type">get_column_type</link></methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--get-iter">get_iter</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--get-iter-from-string">get_iter_from_string</link></methodname>
- <methodparam><parameter
- role="keyword">path_string</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodel--get-string-from-iter">get_string_from_iter</link></methodname>
- <methodparam><parameter>iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--get-iter-root">get_iter_root</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--get-iter-first">get_iter_first</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--get-path">get_path</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--get-value">get_value</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--iter-next">iter_next</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--iter-children">iter_children</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--iter-has-child">iter_has_child</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--iter-n-children">iter_n_children</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--iter-nth-child">iter_nth_child</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter role="keyword">n</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--iter-parent">iter_parent</link></methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--ref-node">ref_node</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--unref-node">unref_node</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--get">get</link></methodname>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>column</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--foreach">foreach</link></methodname>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--row-changed">row_changed</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--row-inserted">row_inserted</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--row-has-child-toggled">row_has_child_toggled</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodel--row-deleted">row_deleted</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodel--rows-reordered">rows_reordered</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- <methodparam><parameter role="keyword">new_order</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodel--filter-new">filter_new</link></methodname>
- <methodparam><parameter role="keyword">root</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
-
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--tree-row-reference-inserted">gtk.tree_row_reference_inserted</link></methodname>
- <methodparam><parameter
- role="keyword">proxy</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--tree-row-reference-deleted">gtk.tree_row_reference_deleted</link></methodname>
- <methodparam><parameter
- role="keyword">proxy</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktreemodel">
- <title>gtk.TreeModel Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtktreemodel--row-changed">row-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreemodel--row-deleted">row-deleted</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreemodel--row-has-child-toggled">row-has-child-toggled</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreemodel--row-inserted">row-inserted</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreemodel--rows-reordered">rows-reordered</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>new_order</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-interface defines a generic tree interface for use by the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget. It is an abstract interface, and is designed to be usable with any
-appropriate data structure. The programmer just has to implement this
-interface on their own data type for it to be viewable by a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget.</para>
-
- <para>The model is represented as a hierarchical tree of strongly-typed,
-columned data. In other words, the model can be seen as a tree where every
-node has different values depending on which column is being queried. The
-type of data found in a column is determined by using the Python or GObject
-type system (i.e. gobject.TYPE_INT, gtk.BUTTON, gobject.TYPE_STRING, etc.).
-The types are homogeneous per column across all nodes. It is important to
-note that this interface only provides a way of examining a model and
-observing changes. The implementation of each individual model decides how
-and if changes are made.</para>
-
- <para>In order to make life simpler for programmers who do not need to
-write their own specialized model, two generic models are provided: the
-<link
-linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link> and
-the <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>. To
-use these, the developer simply pushes data into these models as necessary.
-These models provide the data structure as well as all appropriate tree
-interfaces. As a result, implementing drag and drop, sorting, and storing
-data is trivial. For the vast majority of trees and lists, these two models
-are sufficient.</para>
-
- <para>Models are accessed on a node-column level of granularity. One can
-query for the value of a model at a certain node and a certain column on
-that node. A particular node in a model is referenced using a path or a
-<link linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-object. Most of the interface consists of operations on a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</para>
-
- <para>A path is essentially a potential node. It is a location on a
-model that may or may not actually correspond to a node on a specific model.
-A path can be converted into either an array of unsigned integers or a
-string. The string form is a list of numbers separated by a colon. Each
-number refers to the offset at that level. Thus, the path "0" refers to the
-root node and the path "2:4" refers to the fifth child of the third
-node.</para>
-
- <para>By contrast, a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> is a
-reference to a specific node on a specific model. One can convert a path to
-a treeiter by calling <link
-linkend="method-gtktreemodel--get-iter"><methodname>get_iter</methodname>()</link>.
-These treeiters are the primary way of accessing a model and are similar to
-the textiters used by <link
-linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>.
-The model interface defines a set of operations using them for navigating
-the model.</para>
-
- <para>It is expected that models fill in the treeiter with private data.
-For example, the <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
-model, which is internally a simple linked list, stores a list node in one
-of the pointers. The <link
-linkend="class-gtktreemodelsort"><classname>gtk.TreeModelSort</classname></link>
-stores an array and an offset in two of the pointers. Additionally, there is
-an integer field. This field is generally filled with a unique stamp per
-model. This stamp is for catching errors resulting from using invalid
-treeiters with a model.</para>
-
- <para>The lifecycle of a treeiter can be a little confusing at first.
-treeiters are expected to always be valid for as long as the model is
-unchanged (and doesn't emit a signal). The model is considered to own all
-outstanding treeiters and nothing needs to be done to free them from the
-user's point of view. Additionally, some models guarantee that an treeiter
-is valid for as long as the node it refers to is valid (most notably the
-<link
-linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link> and
-<link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>).
-Although generally uninteresting, as one always has to allow for the case
-where treeiters do not persist beyond a signal, some very important
-performance enhancements were made in the sort model. As a result, the
-<literal>gtk.TREE_MODEL_ITERS_PERSIST</literal> flag was added to indicate
-this behavior.</para>
-
- <para>A <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-object supports some of the Python Mapping protocol that allows you to
-retrieve a <link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
-object representing a row in the model. You can also set the values in a row
-using the same protocol. For example, you can retrieve the second row of a
-<link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-using any of:</para>
-
- <programlisting>
- treemodelrow = model[1]
- treemodelrow = model[(1,)]
- treemodelrow = model['1']
- treemodelrow = model["1"]
-</programlisting>
-
- <para>Also if the model has two columns both containing strings then the
-following will set the values of the third row.</para>
-
- <programlisting>
- model[(2,)] = ('new string value', 'string 2')
-</programlisting>
-
- <para>You can also retrieve the number of top level items in the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> by
-using the Python <function>len</function>() function:</para>
-
- <programlisting>
- n_rows = len(model)
-</programlisting>
-
- <para>A <link
-linkend="class-pygtktreemodelrowiter"><classname>gtk.TreeModelRowIter</classname></link>
-object can be retrieved for iterating over the top level rows of a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> by
-calling the Python <function>iter</function>() function:</para>
-
- <programlisting>
- treemodelrowiter = iter(model)
-</programlisting>
-
- <para>See the <ulink
-url="http://www.pygtk.org/pygtk2tutorial/sec-TreeModelInterface.html#sec-PythonProtocolSupport">PyGTK
-tutorial</ulink> for more information.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreemodel--get-flags">
- <title>gtk.TreeModel.get_flags</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_flags</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the flags supported by this
-interface.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_flags</methodname>() method returns a set of
-flags supported by this interface. The flags are a bitwise combination
-of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.TREE_MODEL_ITERS_PERSIST</literal></term>
- <listitem>
- <simpara>Treeiters survive all signals emitted by the
-tree.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.TREE_MODEL_LIST_ONLY</literal></term>
- <listitem>
- <simpara>The model is a list only, and never has
-children</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The flags supported should not change during the lifecycle of
-the tree_model.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--get-n-columns">
- <title>gtk.TreeModel.get_n_columns</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_n_columns</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The number of columns.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_n_columns</methodname>() method returns the
-number of columns supported by the treemodel.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--get-column-type">
- <title>gtk.TreeModel.get_column_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_column_type</methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>the column index.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the type of the column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_column_type</methodname>() method returns
-the type of the column.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--get-iter">
- <title>gtk.TreeModel.get_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> that
-points at <parameter>path</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter</methodname>() method returns a new
-<link linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to <parameter>path</parameter>. This method raises a
-<literal>ValueError</literal> exception if <parameter>path</parameter> is
-not a valid tree path.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--get-iter-from-string">
- <title>gtk.TreeModel.get_iter_from_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_from_string</methodname>
- <methodparam><parameter
- role="keyword">path_string</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">path_string</parameter>&nbsp;:</term>
- <listitem><simpara>a string representation of a
-path.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> that
-points at the path represented by
-<parameter>path_string</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter_from_string</methodname>() method
-returns a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the path represented by <parameter>path_string</parameter>, if
-it exists. This method raises a <literal>ValueError</literal> exception if
-<parameter>path_string</parameter> does not represent a valid tree
-path.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--get-string-from-iter">
- <title>gtk.TreeModel.get_string_from_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_string_from_iter</methodname>
- <methodparam><parameter>iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>An <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A string representation of iter</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_string_from_iter</methodname>() method
-returns a string representation of the path pointed to by
-<parameter>iter</parameter>. This string is a ':' separated list of
-numbers. For example, "4:10:0:3" would be an acceptable return value for
-this string.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--get-iter-root">
- <title>gtk.TreeModel.get_iter_root</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter_root</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> that
-points at the first path in the treemodel or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter_root</methodname>() method returns a
-<link linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the path "0" or <literal>None</literal> if the tree is
-empty.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--get-iter-first">
- <title>gtk.TreeModel.get_iter_first</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>get_iter_first</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> that points at the first path in the treemodel or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iter_first</methodname>() method returns a
-<link linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the path "0" or <literal>None</literal> if the tree is
-empty.</para>
-
-</refsect2>
-
- <refsect2 id="method-gtktreemodel--get-path">
- <title>gtk.TreeModel.get_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_path</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the tree path referenced by
-<parameter>iter</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_path</methodname>() method returns the tree
-path referenced by <parameter>iter</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--get-value">
- <title>gtk.TreeModel.get_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_value</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the column value to
-retrieve.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a value.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_value</methodname>() method returns the
-value at <parameter>column</parameter> at the path pointed to by
-<parameter>iter</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--iter-next">
- <title>gtk.TreeModel.iter_next</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_next</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- pointing at the next row or <literal>None</literal> if there is no
- next row.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>iter_next</methodname>() method returns a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the row at the current level after the row referenced by
-<parameter>iter</parameter>. If there is no next row,
-<literal>None</literal> is returned. <parameter>iter</parameter> is
-unchanged.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--iter-children">
- <title>gtk.TreeModel.iter_children</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_children</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the parent</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> to be
-set to the first child or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>iter_children</methodname>() method returns a
-new <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the first child of <parameter>parent</parameter>. If
-<parameter>parent</parameter> has no children, <literal>None</literal> is
-returned. <parameter>parent</parameter> will remain a valid node after this
-method has been called.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--iter-has-child">
- <title>gtk.TreeModel.iter_has_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_has_child</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> to
-test for children.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>iter</parameter> has children.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>iter_has_child</methodname>() method returns
-<literal>True</literal> if <parameter>iter</parameter> has children, or
-<literal>False</literal> otherwise.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--iter-n-children">
- <title>gtk.TreeModel.iter_n_children</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_n_children</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of children of
-<parameter>iter</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>iter_n_children</methodname>() method returns
-the number of children that <parameter>iter</parameter> has. As a special
-case, if <parameter>iter</parameter> is <literal>None</literal>, then the
-number of top level nodes is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--iter-nth-child">
- <title>gtk.TreeModel.iter_nth_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_nth_child</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter role="keyword">n</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> to
-get the child from, or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">n</parameter>&nbsp;:</term>
- <listitem><simpara>Then index of the desired
-child.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> that
-is set to the nth child or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>iter_nth_child</methodname>() method returns a
-new <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the child of <parameter>parent</parameter>, with the index
-specified by <parameter>n</parameter>. The first index is 0. If
-<parameter>n</parameter> is too big, or <parameter>parent</parameter> has no
-children, this method returns <literal>None</literal>.
-<parameter>parent</parameter> will remain a valid node after this function
-has been called. As a special case, if <parameter>parent</parameter> is
-<literal>None</literal>, then the treeiter points to the
-<parameter>n</parameter>th root node.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--iter-parent">
- <title>gtk.TreeModel.iter_parent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_parent</methodname>
- <methodparam><parameter
- role="keyword">child</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">child</parameter>&nbsp;:</term>
- <listitem><simpara>The <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> set
-to the parent of <parameter>child</parameter> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>iter_parent</methodname>() method returns a
-<link linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the parent of <parameter>child</parameter>. If
-<parameter>child</parameter> is at the top level, and doesn't have a parent,
-then <literal>None</literal> is returned. <parameter>child</parameter> will
-remain a valid node after this method has been called.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--ref-node">
- <title>gtk.TreeModel.ref_node</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ref_node</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>ref_node</methodname>() method lets the
-treemodel ref the node that <parameter>iter</parameter> points to. This is
-an optional method for models to implement. To be more specific, models may
-ignore this call as it exists primarily for performance reasons. This
-function is primarily meant as a way for views to let the caching model know
-when nodes are being displayed (and hence, whether or not to cache that
-node.) For example, a file-system based model would not want to keep the
-entire file-hierarchy in memory, just the sections that are currently being
-displayed by every current view. A model should be expected to be able to
-get a treeiter independent of it's reffed state.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--unref-node">
- <title>gtk.TreeModel.unref_node</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unref_node</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>unref_node</methodname>() method lets the
-treemodel unref the node that <parameter>iter</parameter> points to. This is
-an optional method for models to implement. To be more specific, models may
-ignore this call as it exists primarily for performance reasons. For more
-information on what this means, see the <link
-linkend="method-gtktreemodel--ref-node"><methodname>ref_node</methodname>()</link>
-method. Please note that nodes that are deleted are not unreffed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--get">
- <title>gtk.TreeModel.get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get</methodname>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>column</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- pointing at the row to retrieve data value
- from</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>column</parameter>&nbsp;:</term>
- <listitem><simpara>a column number</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>zero or more column numbers</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the column
- values</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get</methodname>() method returns a tuple
-containing the values of one or more cells in the row referenced by the
-<link linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-specified by <parameter>iter</parameter>. column specifies the first column
-number to retrieve a value from. The additional arguments should contain
-integer column numbers for additional column values. For example, to get
-values from columns 0 and 3, you would write:</para>
-
- <programlisting>
- value0, value3 = treemodel_get(iter, 0, 3)
- </programlisting>
-
- <para></para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtktreemodel- -get-valist">
- <title>gtk.TreeModel.get_valist</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>get_valist</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- <methodparam><parameter role="keyword">var_args</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a row in <parameter>tree_model</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">var_args</parameter>&nbsp;:</term>
- <listitem><simpara><type>va_list</type> of column/return location pairs</simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-See <link linkend="method-gtktreemodel- -get"><function>gtk.TreeModel.get()</function></link>, this version takes a <type>va_list</type>
-for language bindings to use.
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gtktreemodel--foreach">
- <title>gtk.TreeModel.foreach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>foreach</methodname>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>func</parameter>&nbsp;:</term>
- <listitem><simpara>a function to be called on each
-row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_data</parameter>&nbsp;:</term>
- <listitem><simpara>the user data to passed to
-<parameter>func</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>foreach</methodname>() method calls
-<parameter>func</parameter> on each node in model in a depth-first fashion.
-<parameter>user_data</parameter> is passed to <parameter>func</parameter>
-each time it is called. If <parameter>func</parameter> returns
-<literal>True</literal>, then the operation ceases, and
-<methodname>foreach</methodname>() returns.</para>
- <para>The signature of <parameter>func</parameter> is:</para>
- <programlisting>
- def func(model, path, iter, user_data)
-</programlisting>
- <para>where <parameter>model</parameter> is the treemodel,
-<parameter>path</parameter> is the current path, and
-<parameter>iter</parameter> is a treeiter pointing to
-<parameter>path</parameter>.</para>
- <para>If <parameter>func</parameter> is an object method its signature
-will be:</para>
- <programlisting>
- def func(self, model, path, iter, user_data)
-</programlisting>
- <para></para>
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--row-changed">
- <title>gtk.TreeModel.row_changed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>row_changed</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path pointing to the changed
-row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the changed row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>row_changed</methodname>() method emits the
-"row-changed" signal on the treemodel with the parameters
-<parameter>path</parameter> and <parameter>iter</parameter> that are the
-path and a treeiter pointing to the path of the changed row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--row-inserted">
- <title>gtk.TreeModel.row_inserted</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>row_inserted</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path pointing to the inserted
-row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the inserted row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>row_inserted</methodname>() method emits the
-"row-inserted" signal on the treemodel with the parameters
-<parameter>path</parameter> and <parameter>iter</parameter> that are the
-path and a treeiter pointing to the path of the inserted row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--row-has-child-toggled">
- <title>gtk.TreeModel.row_has_child_toggled</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>row_has_child_toggled</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path pointing to the changed
-row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the changed row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>row_has_child_toggled</methodname>() method
-emits the "row-has-child-toggled" signal on the treemodel with the
-parameters <parameter>path</parameter> and <parameter>iter</parameter> that
-are the path and a treeiter pointing to the path of the changed row. This
-should be called by models after the child state of a node changes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--row-deleted">
- <title>gtk.TreeModel.row_deleted</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>row_deleted</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path pointing to the previous location of the
-deleted row.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>row_deleted</methodname>() method emits the
-"row-deleted" signal on the treemodel. This should be called by models after
-a row has been removed. The location pointed to by
-<parameter>path</parameter> should be the location that the deleted row was
-at. It may not be a valid location anymore.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--rows-reordered">
- <title>gtk.TreeModel.rows_reordered</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>rows_reordered</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">new_order</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>A tree path pointing to the tree node whose
- children have been reordered, or <literal>None</literal> or () or
- "" to indicate the top level node.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>A valid <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- pointing to the node whose children have been reordered, or
- <literal>None</literal> to indicate the top level
- node.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">new_order</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of integers containing the new
-indexes of the children, i.e. the former child <literal>n</literal> is now
-at the position specified by
-<parameter>new_order</parameter><literal>[n]</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>rows_reordered</methodname>() method emits the
-"rows_reordered" signal on the tree model. This method should be called by a
-tree model when its rows have been reordered. If <parameter>iter</parameter>
-is <literal>None</literal> to indicate that the top level rows have been
-reordered, <parameter>path</parameter> should be <literal>None</literal> or
-() or "".</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodel--filter-new">
- <title>gtk.TreeModel.filter_new</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>filter_new</methodname>
- <methodparam><parameter role="keyword">root</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">root</parameter>&nbsp;:</term>
- <listitem><simpara>a tree path or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>filter_new</methodname>() method creates a new
-<link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>,
-with the tree model as the child_model and the virtual root specified by
-<parameter>root</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--tree-row-reference-inserted">
- <title>gtk.tree_row_reference_inserted</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.tree_row_reference_inserted</methodname>
- <methodparam><parameter
- role="keyword">proxy</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">proxy</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gobject"><classname>GObject</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a row position that was
-inserted</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.tree_row_reference_inserted</function>()
-function lets a set of row references know that the model emitted the
-"row_inserted" signal for the row specified by
-<parameter>path</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--tree-row-reference-deleted">
- <title>gtk.tree_row_reference_deleted</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.tree_row_reference_deleted</methodname>
- <methodparam><parameter
- role="keyword">proxy</parameter></methodparam>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">proxy</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gobject"><classname>GObject</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a row position that was
-deleted</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.tree_row_reference_deleted</function>()
-function lets a set of row references know that the model emitted the
-"row_deleted" signal for the row specified by
-<parameter>path</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktreemodel--row-changed">
- <title>The "row-changed" gtk.TreeModel Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treemodel</parameter>&nbsp;:</term>
- <listitem><simpara>the treemodel that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>a path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at <parameter>path</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "row-changed" signal is emitted when the row specified by
-<parameter>path</parameter> and pointed to by <parameter>iter</parameter>
-has changed in the <parameter>treemodel</parameter>. Usually, this means
-that one or more column values have changed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreemodel--row-deleted">
- <title>The "row-deleted" gtk.TreeModel Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treemodel</parameter>&nbsp;:</term>
- <listitem><simpara>the treemodel that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>a path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "row-deleted" signal is emitted when the row that was
-specified by <parameter>path</parameter> is deleted from
-<parameter>treemodel</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreemodel--row-has-child-toggled">
- <title>The "row-has-child-toggled" gtk.TreeModel Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treemodel</parameter>&nbsp;:</term>
- <listitem><simpara>the treemodel that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>a path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at <parameter>path</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "row-has-child-toggled" signal is emitted when the child
-state of the row specified by <parameter>path</parameter> and pointed to by
-<parameter>iter</parameter> has changed in
-<parameter>treemodel</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreemodel--row-inserted">
- <title>The "row-inserted" gtk.TreeModel Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treemodel</parameter>&nbsp;:</term>
- <listitem><simpara>the treemodel that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>a path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at <parameter>path</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "row-inserted" signal is emitted when the row specified by
-<parameter>path</parameter> and pointed to by <parameter>iter</parameter> is
-inserted into <parameter>treemodel</parameter>. The row referenced by
-<parameter>iter</parameter> will be empty so using the <link
-linkend="method-gtktreemodel--get-value"><methodname>get_value</methodname>()</link>
-method will always return <literal>None</literal>. Connect to the
-"row-changed" signal if you want to track value changes.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreemodel--rows-reordered">
- <title>The "rows-reordered" gtk.TreeModel Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>new_order</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treemodel</parameter>&nbsp;:</term>
- <listitem><simpara>the treemodel that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>a path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at <parameter>path</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>new_order</parameter>&nbsp;:</term>
- <listitem><simpara>an array of reordered row
-numbers</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "rows-reordered" signal is emitted when the
-<parameter>treemodel</parameter> child rows of the row specified by
-<parameter>path</parameter> and pointed to by <parameter>iter</parameter>
-are reordered. <parameter>new_order</parameter> is an array of node index
-numbers representing the new order of the rows. The value of
-<parameter>new_order</parameter> cannot be retrieved in PyGTK because it is
-passed as an opaque pointer (<link
-linkend="class-gobjectgpointer"><classname>gobject.GPointer</classname></link>)
-value. <parameter>iter</parameter> may be <literal>None</literal> and
-<parameter>path</parameter> an empty tuple to indicate that the top level
-rows were reordered.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreemodelfilter.xml b/docs/reference/pygtk-gtktreemodelfilter.xml
deleted file mode 100644
index 82de68c6..00000000
--- a/docs/reference/pygtk-gtktreemodelfilter.xml
+++ /dev/null
@@ -1,542 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtktreemodelfilter">
- <refnamediv>
- <refname>gtk.TreeModelFilter</refname>
-
- <refpurpose>a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-which hides parts of an underlying tree (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeModelFilter</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtktreemodel">gtk.TreeModel</link></classname></ooclass>
- <ooclass><classname><link linkend="class-gtktreedragsource">gtk.TreeDragSource</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelfilter--set-visible-func">set_visible_func</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelfilter- -set-modify-func">set_modify_func</link></methodname>
- <methodparam><parameter role="keyword">types</parameter></methodparam>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelfilter--set-visible-column">set_visible_column</link></methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelfilter--get-model">get_model</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelfilter--convert-child-iter-to-iter">convert_child_iter_to_iter</link></methodname>
- <methodparam><parameter role="keyword">child_iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelfilter--convert-iter-to-child-iter">convert_iter_to_child_iter</link></methodname>
- <methodparam><parameter role="keyword">filter_iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelfilter--convert-child-path-to-path">convert_child_path_to_path</link></methodname>
- <methodparam><parameter role="keyword">child_path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelfilter--convert-path-to-child-path">convert_path_to_child_path</link></methodname>
- <methodparam><parameter role="keyword">filter_path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelfilter--refilter">refilter</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelfilter--clear-cache">clear_cache</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtktreemodelfilter">gtk.TreeModelFilter</link> (implements <link linkend="class-gtktreemodel">gtk.TreeModel</link>, <link linkend="class-gtktreedragsource">gtk.TreeDragSource</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktreemodelfilter">
- <title>gtk.TreeModelFilter Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"child-model"</entry>
- <entry>Read-Write-Construct Only</entry>
-
- <entry>The <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> for
-the filtermodel to filter. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"virtual-root"</entry>
- <entry>Read-Write-Construct Only</entry>
-
- <entry>The virtual root (relative to the child model) for this
-filtermodel. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktreemodelfilter">
- <title>gtk.TreeModelFilter Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktreemodel">gtk.TreeModel Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtktreemodelfilter"><classname>gtk.TreeModelFilter</classname></link>
-is a tree model which wraps another tree model, and can do the following
-things:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>Filter specific rows, based on data from a "visible
-column", a column storing booleans indicating whether the row should be
-filtered or not, or based on the return value of a "visible function", which
-gets a <parameter>model</parameter>, <parameter>iter</parameter> and
-<parameter>user_data</parameter> and returns a boolean indicating whether
-the row should be filtered or not.</simpara>
- </listitem>
- <listitem>
- <simpara>Modify the "appearance" of the model, using a modify
-function. This is extremely powerful and allows for just changing some
-values and also for creating a completely different synthetic model based on
-the child model. For example, you can create a model with columns
-synthesized from the data in the child model.</simpara>
- </listitem>
- <listitem>
- <simpara>Set a different root node, also known as a "virtual
-root". You can pass in a tree path indicating the root node for the filter
-at construction time.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>A <link linkend="class-gtktreemodelfilter"><classname>gtk.TreeModelFilter</classname></link> is
-created using the <link linkend="method-gtktreemodel--filter-new"><methodname>gtk.TreeModel.filter_new</methodname>()</link> method. For example:</para>
-
- <programlisting>
- liststore = gtk.ListStore(gobject.TYPE_INT, gobject.TYPE_STRING)
- modelfilter = liststore.filter_new()
-</programlisting>
-
- <para>The <link
-linkend="class-gtktreemodelfilter"><classname>gtk.TreeModelFilter</classname></link>
-objects support the Python mapping and iterator protocols. See the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-Description and the <ulink
-url="http://www.pygtk.org/pygtk2tutorial/sec-TreeModelInterface.html#sec-PythonProtocolSupport">PyGTK
-tutorial</ulink> for more information.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreemodelfilter--set-visible-func">
- <title>gtk.TreeModelFilter.set_visible_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible_func</methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>a function called to determine the visibility
- of a row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>User data to pass to
- <literal>func</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_visible_func</methodname>() method sets the
-visible function used when filtering the rows of the treemodel filter to the
-value of <parameter>func</parameter>. <parameter>data</parameter> is the
-user data that is passed to func (see below). This method will fail if the
-<link
-linkend="method-gtktreemodelfilter--set-visible-column"><methodname>set_visible_column</methodname>()</link>
-method has already been called. The visible function signature is:</para>
-
- <programlisting>
- def visible_func(model, iter, user_data):
-</programlisting>
-
- <para>where <parameter>model</parameter> is the child <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>,
-<parameter>iter</parameter> is a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at a row in model and <parameter>user_data</parameter> is the data
-parameter. The function should return <literal>True</literal> if the row
-should be visible.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelfilter- -set-modify-func">
- <title>gtk.TreeModelFilter.set_modify_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_modify_func</methodname>
- <methodparam><parameter role="keyword">types</parameter></methodparam>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">types</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence containing the column
- types</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>a function that is called to provide the data
- for a specific row and column</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to the modify function, or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_modify_func</methodname>() method uses the
-list of column types specified by <parameter>types</parameter> and the
-function specified by <parameter>func</parameter> to provide a synthetic
-model based on the child model of the <link
-linkend="class-gtktreemodelfilter"><classname>gtk.TreeModelFilter</classname></link>. <parameter>data</parameter>
-is passed to <parameter>func</parameter> when it is
-called. <parameter>func</parameter> is called for each data access to return
-the data which should be displayed at the location specified using the
-parameters of the modify function.</para>
-
- <para>The signature of func is:</para>
-
- <programlisting>
- def func(<parameter>model</parameter>, <parameter>iter</parameter>, <parameter>column</parameter>, <parameter>user_data</parameter>)
-</programlisting>
-
- <para>where <parameter>model</parameter> is the <link
-linkend="class-gtktreemodelfilter"><classname>gtk.TreeModelFilter</classname></link>,
-<parameter>iter</parameter> is a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at a row in <parameter>model</parameter>,
-<parameter>column</parameter> is the column number to provide the value for
-and <parameter>user_data</parameter> is
-<parameter>data</parameter>. <parameter>func</parameter> should returns the
-generated value for the specified location in
-<parameter>model</parameter>.</para>
-
- <note>
- <para>This method must be called before the <link
-linkend="class-gtktreemodelfilter"><classname>gtk.TreeModelFilter</classname></link>
-is associated with a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> and
-before either of the <link
-linkend="method-gtktreemodel--get-n-columns"><methodname>gtk.TreeModel.get_n_columns</methodname>()</link>
-or <link
-linkend="method-gtktreemodel--get-column-type"><methodname>gtk.TreeModel.get_column_type</methodname>()</link>
-methods are called. Also this method can only be called once - there is no
-way to change the modify function once it is set.</para>
- </note>
-
- <para>Since <parameter>func</parameter> is called for every access to
-a value in <parameter>model</parameter>, it will be slow for models with a
-large number of rows and/or columns.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelfilter--set-visible-column">
- <title>gtk.TreeModelFilter.set_visible_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible_column</methodname>
- <methodparam><parameter role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the number of the column containing the visible
- information.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_visible_column</methodname>() method sets
-the visible column setting to the value of
-<parameter>column</parameter>. The visible column setting contains the
-number of the "child-model" column that is used to determine the visibility
-of the model rows. The specified column should be a column of type
-<literal>gobject.TYPE_BOOLEAN</literal>, where <literal>True</literal> means
-that a row is visible, and <literal>False</literal>, not visible. This
-method will fail if the <link
-linkend="method-gtktreemodelfilter--set-visible-func"><methodname>set_visible_func</methodname>()</link>
-method has already been called.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelfilter--get-model">
- <title>gtk.TreeModelFilter.get_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_model</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the child <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_model</methodname>() method returns the
-child <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> of
-the treemodel filter</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelfilter--convert-child-iter-to-iter">
- <title>gtk.TreeModelFilter.convert_child_iter_to_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>convert_child_iter_to_iter</methodname>
- <methodparam><parameter role="keyword">child_iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">child_iter</parameter>&nbsp;:</term>
- <listitem><simpara>A valid <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- pointing to a row on the child model.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- pointing to a row in the treemodel filter.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>convert_child_iter_to_iter</methodname>() method
-returns a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the row in the treemodel filter that corresponds to the child
-treemodel row pointed to by the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-specified by <parameter>child_iter</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelfilter--convert-iter-to-child-iter">
- <title>gtk.TreeModelFilter.convert_iter_to_child_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>convert_iter_to_child_iter</methodname>
- <methodparam><parameter role="keyword">filter_iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">filter_iter</parameter>&nbsp;:</term>
- <listitem><simpara>A valid <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- pointing to a row in the treemodel filter.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- pointing to a row in the child treemodel.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>convert_iter_to_child_iter</methodname>() method
-a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the row in the child treemodel that corresponds to the treemodel
-filter row pointed to by the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-specified by <parameter>filter_iter</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelfilter--convert-child-path-to-path">
- <title>gtk.TreeModelFilter.convert_child_path_to_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>convert_child_path_to_path</methodname>
- <methodparam><parameter role="keyword">child_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">child_path</parameter>&nbsp;:</term>
- <listitem><simpara>a tree path in the child treemodel to
- convert.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a treemodel filter tree path, or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>convert_child_path_to_path</methodname>() method
-returns a treemodel filter tree path that corresponds to the child treemodel
-tree path specified by <parameter>child_path</parameter>. If
-<parameter>child_path</parameter> isn't a valid path on the child model,
-<literal>None</literal> is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelfilter--convert-path-to-child-path">
- <title>gtk.TreeModelFilter.convert_path_to_child_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>convert_path_to_child_path</methodname>
- <methodparam><parameter role="keyword">filter_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">filter_path</parameter>&nbsp;:</term>
- <listitem><simpara>a treemodel filter tree path to
- convert.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a child treemodel tree path, or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>convert_path_to_child_path</methodname>() method
-returns a child treemodel tree path that corresponds to the treemodel filter
-tree path specified by <parameter>filter_path</parameter>. If
-<parameter>filter_path</parameter> does not point to a row in the child
-model, <literal>None</literal> is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelfilter--refilter">
- <title>gtk.TreeModelFilter.refilter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>refilter</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>refilter</methodname>() method emits the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-"<link linkend="signal-gtktreemodel--row-changed">row-changed</link>" signal
-for each row in the child model, thereby causing the filter to re-evaluate
-whether a row is visible or not.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelfilter--clear-cache">
- <title>gtk.TreeModelFilter.clear_cache</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear_cache</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>clear_cache</methodname>() method clears the
-treemodel filter of any cached iterators that haven't been reffed with the
-<link
-linkend="method-gtktreemodel--ref-node"><methodname>gtk.TreeModel.ref_node()</methodname></link>. This
-might be useful if the child model being filtered is static (and doesn't
-change often) and there has been a lot of unreffed access to nodes. As a
-side effect of this function, all unreffed iters will be invalid. This
-method should almost never be called by an application.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreemodelsort.xml b/docs/reference/pygtk-gtktreemodelsort.xml
deleted file mode 100644
index df981913..00000000
--- a/docs/reference/pygtk-gtktreemodelsort.xml
+++ /dev/null
@@ -1,425 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktreemodelsort">
- <refnamediv>
- <refname>gtk.TreeModelSort</refname>
- <refpurpose>a tree model that is a sorted version of a child <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeModelSort</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktreemodel">gtk.TreeModel</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktreesortable">gtk.TreeSortable</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktreemodelsort">gtk.TreeModelSort</link></methodname>
- <methodparam><parameter
- role="keyword">child_model</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodelsort--get-model">get_model</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodelsort--convert-child-path-to-path">convert_child_path_to_path</link></methodname>
- <methodparam><parameter
- role="keyword">child_path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodelsort--convert-child-iter-to-iter">convert_child_iter_to_iter</link></methodname>
- <methodparam><parameter
- role="keyword">sort_iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">child_iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodelsort--convert-path-to-child-path">convert_path_to_child_path</link></methodname>
- <methodparam><parameter
- role="keyword">sorted_path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodelsort--convert-iter-to-child-iter">convert_iter_to_child_iter</link></methodname>
- <methodparam><parameter
- role="keyword">child_iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">sorted_iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodelsort--reset-default-sort-func">reset_default_sort_func</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreemodelsort--clear-cache">clear_cache</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelsort--iter-is-valid">iter_is_valid</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtktreemodelsort">gtk.TreeModelSort</link> (implements <link linkend="class-gtktreemodel">gtk.TreeModel</link>, <link linkend="class-gtktreesortable">gtk.TreeSortable</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktreemodelsort">
- <title>gtk.TreeModelSort Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"model"</entry>
- <entry>Read-Write-Construct</entry>
- <entry>The child model for the <link
-linkend="class-gtktreemodelsort"><classname>gtk.TreeModelSort</classname></link>
-to sort.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktreemodelsort">
- <title>gtk.TreeModelSort Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktreesortable">gtk.TreeSortable Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktreemodel">gtk.TreeModel Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktreemodelsort"><classname>gtk.TreeModelSort</classname></link>
-is a sorted model of its child model. A <link
-linkend="class-gtktreemodelsort"><classname>gtk.TreeModelSort</classname></link>
-implements the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-interface and the <link
-linkend="class-gtktreesortable"><classname>gtk.TreeSortable</classname></link>
-interface to manage the sort functions.</para>
-
- <para>The <link
-linkend="class-gtktreemodelsort"><classname>gtk.TreeModelSort</classname></link>
-objects support the Python mapping and iterator protocols. See the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-Description and the <ulink
-url="http://www.pygtk.org/pygtk2tutorial/sec-TreeModelInterface.html#sec-PythonProtocolSupport">PyGTK
-tutorial</ulink> for more information.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktreemodelsort">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TreeModelSort</methodname>
- <methodparam><parameter
- role="keyword">child_model</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">child_model</parameter>&nbsp;:</term>
- <listitem><simpara>a child <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>,
-with <parameter>child_model</parameter> as the child model.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreemodelsort--get-model">
- <title>gtk.TreeModelSort.get_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_model</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the "child model" being
-sorted</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_model</methodname>() method returns the
-model that the <link
-linkend="class-gtktreemodelsort"><classname>gtk.TreeModelSort</classname></link>
-is sorting.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelsort--convert-child-path-to-path">
- <title>gtk.TreeModelSort.convert_child_path_to_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>convert_child_path_to_path</methodname>
- <methodparam><parameter
- role="keyword">child_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">child_path</parameter>&nbsp;:</term>
- <listitem><simpara>A child tree path to
-convert</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new tree path in the treemodelsort, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>convert_child_path_to_path</methodname>() method
-converts the path in the child model specified by
-<parameter>child_path</parameter> to a path relative to the treemodelsort.
-That is, <parameter>child_path</parameter> points to a path in the child
-model. The returned path will point to the same row in the sorted model.
-If <parameter>child_path</parameter> isn't a valid path on the child model,
-then <literal>None</literal> is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelsort--convert-child-iter-to-iter">
- <title>gtk.TreeModelSort.convert_child_iter_to_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>convert_child_iter_to_iter</methodname>
- <methodparam><parameter
- role="keyword">sort_iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">child_iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">sort_iter</parameter>&nbsp;:</term>
- <listitem><simpara><literal>None</literal> or a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> for
-backward compatibility.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">child_iter</parameter>&nbsp;:</term>
- <listitem><simpara>A valid <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to a row on the child model</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the same path in the sorted model.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>convert_child_iter_to_iter</methodname>() method
-returns a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> that
-points to the row in the treemodelsort that corresponds to the row pointed
-to by <parameter>child_iter</parameter>. <parameter>sort_iter</parameter>
-parameter should be <literal>None</literal> but can specify a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> for
-backward compatibility.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelsort--convert-path-to-child-path">
- <title>gtk.TreeModelSort.convert_path_to_child_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>convert_path_to_child_path</methodname>
- <methodparam><parameter
- role="keyword">sorted_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">sorted_path</parameter>&nbsp;:</term>
- <listitem><simpara>a path in the sorted model</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new path in the child model, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>convert_path_to_child_path</methodname>() method
-returns a path in the child model that refers to the same row as the path in
-the sorted model specified by <parameter>sorted_path</parameter>. That is,
-<parameter>sorted_path</parameter> points to a location in treemodelsort and
-the returned path will point to the same location in the child model. If
-<parameter>sorted_path</parameter> does not point to a location in the child
-model, <literal>None</literal> is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelsort--convert-iter-to-child-iter">
- <title>gtk.TreeModelSort.convert_iter_to_child_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>convert_iter_to_child_iter</methodname>
- <methodparam><parameter
- role="keyword">child_iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">sorted_iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">child_iter</parameter>&nbsp;:</term>
- <listitem><simpara><literal>None</literal> or a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> for
-backward compatibility.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">sorted_iter</parameter>&nbsp;:</term>
- <listitem><simpara>A valid <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to a row on
-<parameter>tree_model_sort</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> that
-points to a row in the child model</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>convert_iter_to_child_iter</methodname>() method
-returns a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> that
-points to the row in the child model that is the same row pointed to by
-<parameter>sorted_iter</parameter> in the treemodelsort.
-<parameter>child_iter</parameter> should be <literal>None</literal> but can
-specify a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> for
-backward compatibility.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelsort--reset-default-sort-func">
- <title>gtk.TreeModelSort.reset_default_sort_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reset_default_sort_func</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>reset_default_sort_func</methodname>() method
-resets the default sort function to be in the 'unsorted' state. That is, it
-is in the same order as the child model. It will re-sort the model to be in
-the same order as the child model only if the <link
-linkend="class-gtktreemodelsort"><classname>gtk.TreeModelSort</classname></link>
-is in 'unsorted' state.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelsort--clear-cache">
- <title>gtk.TreeModelSort.clear_cache</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear_cache</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>clear_cache</methodname>() method clears the
-treemodelsort of any cached iterators that haven't been reffed with the
-<link
-linkend="method-gtktreemodel--ref-node"><methodname>ref_node</methodname>()</link>
-method. This might be useful if the child model being sorted is static (and
-doesn't change often) and there has been a lot of unreffed access to nodes.
-As a side effect of this function, all unreffed <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-objects will be invalid.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreemodelsort--iter-is-valid">
- <title>gtk.TreeModelSort.iter_is_valid</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_is_valid</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>A <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>iter</parameter> is valid</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>iter_is_valid</methodname>() method checks if
-the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-specified by <parameter>iter</parameter> is valid for the treemodel
-sort.</para>
-
- <warning>
- <para>This method is slow. Only use it for debugging and/or testing
-purposes.</para>
- </warning>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreerowreference.xml b/docs/reference/pygtk-gtktreerowreference.xml
deleted file mode 100644
index c03214aa..00000000
--- a/docs/reference/pygtk-gtktreerowreference.xml
+++ /dev/null
@@ -1,234 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtktreerowreference">
- <refnamediv>
- <refname>gtk.TreeRowReference</refname>
-
- <refpurpose>an object maintaining a persistent reference to a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-row (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeRowReference</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtktreerowreference">gtk.TreeRowReference</link></methodname>
- <methodparam><parameter role="keyword">model</parameter></methodparam>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreerowreference--get-path">get_path</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreerowreference--get-model">get_model</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreerowreference--valid">valid</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreerowreference--copy">copy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreerowreference--free">free</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtktreerowreference"><classname>gtk.TreeRowReference</classname></link>
-is an object that points to a row in a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-similar to a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>. A
-<link
-linkend="class-gtktreerowreference"><classname>gtk.TreeRowReference</classname></link>,
-unlike a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>,
-maintains a persistent reference in spite of changes in the model.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktreerowreference">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TreeRowReference</methodname>
- <methodparam><parameter role="keyword">model</parameter></methodparam>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">model</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a valid tree path to monitor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreerowreference"><classname>gtk.TreeRowReference</classname></link>,
- or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a row reference pointing to the treemodel row specified by
-<parameter>model</parameter> and <parameter>path</parameter>. This reference
-will continue pointing to the node in spite of changes in
-<parameter>model</parameter>. It listens to all signals emitted by
-<parameter>model</parameter>, and updates its path appropriately. If
-<parameter>path</parameter> isn't a valid path in
-<parameter>model</parameter>, <literal>None</literal> is returned.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreerowreference--get-path">
- <title>gtk.TreeRowReference.get_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_path</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A current path, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_path</methodname>() method returns the path
-that the row reference currently points to, or <literal>None</literal> if
-the path pointed to is no longer valid.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreerowreference--get-model">
- <title>gtk.TreeRowReference.get_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_model</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the model, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_model</methodname>() method returns the
-model that the row reference currently monitors, or <literal>None</literal>
-if the model is not set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreerowreference--valid">
- <title>gtk.TreeRowReference.valid</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>valid</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the row reference
- points to a valid path.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>valid</methodname>() method returns
-<literal>True</literal> if the row reference is not <literal>None</literal>
-and refers to a current valid path.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreerowreference--copy">
- <title>gtk.TreeRowReference.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the row reference</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>copy</methodname>() method returns a copy of the
-tree row reference.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreerowreference--free">
- <title>gtk.TreeRowReference.free</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>free</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <warning>
- <para>This method is deprecated and should not be used since it may
-crash your application.</para>
- </warning>
-
- <para>The free() method frees the tree row reference. The row
-reference may be <literal>None</literal>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreeselection.xml b/docs/reference/pygtk-gtktreeselection.xml
deleted file mode 100644
index 81334a2d..00000000
--- a/docs/reference/pygtk-gtktreeselection.xml
+++ /dev/null
@@ -1,827 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktreeselection">
- <refnamediv>
- <refname>gtk.TreeSelection</refname>
- <refpurpose>the selection object for <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeSelection</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--set-mode">set_mode</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--get-mode">get_mode</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--set-select-function">set_select_function</link></methodname>
- <methodparam><parameter
- role="keyword">func</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">full</parameter>
- <initializer>False</initializer></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeselection- -get-user-data">get_user_data</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--get-tree-view">get_tree_view</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--get-selected">get_selected</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeselection--get-selected-rows">get_selected_rows</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeselection--count-selected-rows">count_selected_rows</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--selected-foreach">selected_foreach</link></methodname>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--select-path">select_path</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--unselect-path">unselect_path</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--select-iter">select_iter</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--unselect-iter">unselect_iter</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--path-is-selected">path_is_selected</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--iter-is-selected">iter_is_selected</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--select-all">select_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--unselect-all">unselect_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeselection--select-range">select_range</link></methodname>
- <methodparam><parameter
- role="keyword">start_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end_path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeselection--unselect-range">unselect_range</link></methodname>
- <methodparam><parameter
- role="keyword">start_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end_path</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtktreeselection">gtk.TreeSelection</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktreeselection">
- <title>gtk.TreeSelection Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtktreeselection--changed">changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeselection</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtktreeselection"><classname>gtk.TreeSelection</classname></link>
-object is a helper object to manage the selection for a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget. The <link
-linkend="class-gtktreeselection"><classname>gtk.TreeSelection</classname></link>
-object is automatically created when a new <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget is created, and cannot exist independent of this widget. The primary
-reason the <link
-linkend="class-gtktreeselection"><classname>gtk.TreeSelection</classname></link>
-object exists is for cleanliness of code and API. That is, there is no
-conceptual reason all these functions could not be methods on the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget instead of a separate function. The <link
-linkend="class-gtktreeselection"><classname>gtk.TreeSelection</classname></link>
-object is retrieved from a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> by
-calling the <link
-linkend="method-gtktreeview--get-selection"><methodname>gtk.TreeView.get_selection</methodname>()</link>
-method. It can be manipulated to check the selection status of the tree, as
-well as select and deselect individual rows. Selection is done completely on
-the view side. As a result, multiple views of the same model can have
-completely different selections. Additionally, you cannot change the
-selection of a row on the model that is not currently displayed by the view
-without expanding its parents first.</para>
-
- <para>One of the important things to remember when monitoring the
-selection of a view is that the "changed" signal is mostly a hint. That is,
-it may only emit one signal when a range of rows is selected. Additionally,
-it may on occasion emit a "changed" signal when nothing has happened (mostly
-as a result of programmers calling the <link
-linkend="method-gtktreeselection--select-path"><methodname>select_path</methodname>()</link>
-or <link
-linkend="method-gtktreeselection--select-iter"><methodname>select_iter</methodname>()</link>
-methods on an already selected row).</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreeselection--set-mode">
- <title>gtk.TreeSelection.set_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_mode</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the selection mode</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_mode</methodname>() method sets the
-selection mode of the treeselection to the mode specified by
-<parameter>type</parameter>. The value of <parameter>type</parameter> must
-be one of: <literal>gtk.SELECTION_NONE</literal>,
-<literal>gtk.SELECTION_SINGLE</literal>,
-<literal>gtk.SELECTION_BROWSE</literal> or
-<literal>gtk.SELECTION_MULTIPLE</literal>. See the <xref
-linkend="gtk-selection-mode-constants"
-endterm="gtk-selection-mode-constants-title"></xref> description for more
-detail.</para>
-
- <para>If the previous type was
-<literal>gtk.SELECTION_MULTIPLE</literal>, then the anchor is kept selected,
-if it was previously selected.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--get-mode">
- <title>gtk.TreeSelection.get_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_mode</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current selection mode</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_mode</methodname>() method returns the
-selection mode for treeselection. See the <link
-linkend="method-gtktreeselection--set-mode"><methodname>set_mode</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--set-select-function">
- <title>gtk.TreeSelection.set_select_function</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_select_function</methodname>
- <methodparam><parameter
- role="keyword">func</parameter></methodparam>
- <methodparam><parameter
- role="keyword">data</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">full</parameter><initializer>False</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>func</parameter>&nbsp;:</term>
- <listitem><simpara>the selection function.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter>&nbsp;:</term>
- <listitem><simpara>the selection function's
-data.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>full</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>
- <parameter>func</parameter> will be passed a full set of
- args</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_selection_function</methodname>() method
-sets the selection function to <parameter>func</parameter> (a function or
-method). If the selection function is set, it is called before any node is
-selected or unselected, giving some control over which nodes are selected.
-The selection function should return <literal>True</literal> if the state of
-the node may be toggled, and <literal>False</literal> if the state of the
-node should be left unchanged. The signature of the selection function
-callback is:</para>
-
-<programlisting>
- <methodsynopsis language="python">
- <methodname>selectfunction</methodname>
- <methodparam><parameter>info</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>selectmethod</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>info</parameter></methodparam>
- </methodsynopsis>
-</programlisting>
-
-<para>where <parameter>info</parameter> is a tuple containing a path or a
-path and <parameter>data</parameter> if <parameter>data</parameter> was
-passed to the <link
-linkend="method-gtktreeselection--set-select-function"><methodname>set_select_function</methodname>()</link>
-method.</para>
-
-<para>In PyGTK 2.10 and above if the additional optional parameter
-<parameter>full</parameter> is <literal>True</literal> the signature of
-<parameter>func</parameter> should be:</para>
-
-<programlisting>
-<methodsynopsis language="python">
- <methodname>selectfunction</methodname>
- <methodparam><parameter>selection</parameter></methodparam>
- <methodparam><parameter>model</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>path_currently_selected</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname>selectmethod</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>selection</parameter></methodparam>
- <methodparam><parameter>model</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>is_selected</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis>
-</programlisting>
-
- <para>where <parameter>selection</parameter> is the <link
- linkend="class-gtktreeselection"><classname>gtk.TreeSelection</classname></link>,
- <parameter>model</parameter> is the <link
- linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
- used by the <link
- linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
- associated with selection, <parameter>path</parameter> is the path of
- the selected row, <parameter>is_selected</parameter> is
- <literal>True</literal> if the row is currently selected and
- <parameter>user_data</parameter> is <parameter>data</parameter> if any
- (may not be present if <parameter>data</parameter> was
- <literal>None</literal>). If <parameter>func</parameter> is a method
- then <parameter>self</parameter> is the object that the method is
- called upon.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtktreeselection- -get-user-data">
- <title>gtk.TreeSelection.get_user_data</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>get_user_data</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the user data.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Returns the user data for the selection function.
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gtktreeselection--get-tree-view">
- <title>gtk.TreeSelection.get_tree_view</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tree_view</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tree_iter</methodname>() method returns the
-tree view associated with the treeselection.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--get-selected">
- <title>gtk.TreeSelection.get_selected</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selected</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing a reference to the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> and
-a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the currently selected node.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_selected</methodname>() method returns a
-2-tuple containing the treemodel and a treeiter pointing to the selected node
-in the treemodel if the treeselection is set to
-<literal>gtk.SELECTION_SINGLE</literal> or
-<literal>gtk.SELECTION_BROWSE</literal>. The returned <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> will
-be <literal>None</literal> if there is no row selected. This method will not
-work if you use <parameter>selection</parameter> is
-<literal>gtk.SELECTION_MULTIPLE</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--get-selected-rows">
- <title>gtk.TreeSelection.get_selected_rows</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selected_rows</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the tree model and a list
- of the tree paths of all selected rows.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_selected_rows</methodname>() method returns
-a 2-tuple containing a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> and
-a list of the tree paths of all selected rows. Additionally, if you are
-planning on modifying the tree model after calling this method, you may want
-to convert the returned list into a list of <link
-linkend="class-gtktreerowreference"><classname>gtk.TreeRowReference</classname></link>
-objects. To do this, you can use the <link
-linkend="constructor-gtktreerowreference">gtk.TreeRowReference</link>()
-constructor.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--count-selected-rows">
- <title>gtk.TreeSelection.count_selected_rows</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>count_selected_rows</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The number of rows selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>count_selected_rows</methodname>() method
-returns the number of rows that have been selected.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--selected-foreach">
- <title>gtk.TreeSelection.selected_foreach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>selected_foreach</methodname>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>func</parameter>&nbsp;:</term>
- <listitem><simpara>the function or method to call for each
-selected node.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter>&nbsp;:</term>
- <listitem><simpara>the user data to pass to
-<parameter>func</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>selected_foreach</methodname>() method calls the
-function or method specified by <parameter>func</parameter> for each
-selected node passing the user data specified by
-<parameter>data</parameter>. The signature of <parameter>func</parameter>
-is:</para>
-
- <programlisting>
-<methodsynopsis language="python">
- <methodname>foreachfunction</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname>foreachmethod</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
-</programlisting>
-
- <para>where <parameter>treemodel</parameter> is the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-being viewed, <parameter>path</parameter> is the path of the selected row,
-<parameter>iter</parameter> is a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the selected row and <parameter>...</parameter> is the user data
-if any (may not be present if <parameter>data</parameter> was
-<literal>None</literal>). If <parameter>func</parameter> is a method then
-<parameter>self</parameter> is the object that the method is called
-upon.</para>
-
- <note>
- <para>You cannot modify the tree or selection in the callback
-function.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--select-path">
- <title>gtk.TreeSelection.select_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_path</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the tree path to be
-selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>select_path</methodname>() method selects the
-row at <parameter>path</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--unselect-path">
- <title>gtk.TreeSelection.unselect_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unselect_path</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the tree path to be
-unselected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>unselect_path</methodname>() method unselects
-the row at <parameter>path</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--select-iter">
- <title>gtk.TreeSelection.select_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_iter</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> to be
-selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>select_iter</methodname>() method selects the
-row pointed to by the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-specified by <parameter>iter</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--unselect-iter">
- <title>gtk.TreeSelection.unselect_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unselect_iter</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> to be
-unselected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>unselect_iter</methodname>() method unselects
-the row pointed to by the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-specified by <parameter>iter</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--path-is-selected">
- <title>gtk.TreeSelection.path_is_selected</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>path_is_selected</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>A tree path to check if
-selected.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>path</parameter> is selected.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>path_is_selected</methodname>() method returns
-<literal>True</literal> if the row pointed to by <parameter>path</parameter>
-is currently selected. If <parameter>path</parameter> does not point to a
-valid location, <literal>False</literal> is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--iter-is-selected">
- <title>gtk.TreeSelection.iter_is_selected</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_is_selected</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if the row pointed to
-by <parameter>iter</parameter> is selected</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>iter_is_selected</methodname>() method returns
-<literal>True</literal> if the row pointed to by <parameter>iter</parameter>
-is currently selected.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--select-all">
- <title>gtk.TreeSelection.select_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_all</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>select_all</methodname>() method selects all the
-nodes. The treeselection is must be set to
-<literal>gtk.SELECTION_MULTIPLE</literal> mode.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--unselect-all">
- <title>gtk.TreeSelection.unselect_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unselect_all</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>unselect_all</methodname>() method unselects all
-the nodes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--select-range">
- <title>gtk.TreeSelection.select_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>select_range</methodname>
- <methodparam><parameter
- role="keyword">start_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">start_path</parameter>&nbsp;:</term>
- <listitem><simpara>the initial node path of the
-range.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end_path</parameter>&nbsp;:</term>
- <listitem><simpara>the final node path of the
-range.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>select_range</methodname>() method selects a
-range of nodes specified by the tree paths
-<parameter>start_path</parameter> and <parameter>end_path</parameter>
-inclusive.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeselection--unselect-range">
- <title>gtk.TreeSelection.unselect_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unselect_range</methodname>
- <methodparam><parameter>start_path</parameter></methodparam>
- <methodparam><parameter>end_path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>start_path</parameter>&nbsp;:</term>
- <listitem><simpara>The initial node of the
- range.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>end_path</parameter>&nbsp;:</term>
- <listitem><simpara>The final node of the
- range.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>unselect_range</methodname>() method unselects
-the range of nodes specified by the tree paths
-<parameter>start_path</parameter> and <parameter>end_path</parameter>
-inclusive.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktreeselection--changed">
- <title>The "changed" gtk.TreeSelection Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeselection</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeselection</parameter>&nbsp;:</term>
- <listitem><simpara>the treeselection that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "changed" signal is emitted when the selection has
-changed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreesortable.xml b/docs/reference/pygtk-gtktreesortable.xml
deleted file mode 100644
index e8b2a2bd..00000000
--- a/docs/reference/pygtk-gtktreesortable.xml
+++ /dev/null
@@ -1,402 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktreesortable">
- <refnamediv>
- <refname>gtk.TreeSortable</refname>
- <refpurpose>an interface for sorting a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeSortable</classname></ooclass>
- <ooclass><classname>gobject.GInterface</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreesortable--sort-column-changed">sort_column_changed</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreesortable--get-sort-column-id">get_sort_column_id</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreesortable--set-sort-column-id">set_sort_column_id</link></methodname>
- <methodparam><parameter
- role="keyword">sort_column_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">order</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreesortable--set-sort-func">set_sort_func</link></methodname>
- <methodparam><parameter>sort_column_id</parameter></methodparam>
- <methodparam><parameter>sort_func</parameter></methodparam>
- <methodparam><parameter>user_data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreesortable--set-default-sort-func">set_default_sort_func</link></methodname>
- <methodparam><parameter>sort_func</parameter></methodparam>
- <methodparam><parameter>user_data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreesortable--has-default-sort-func">has_default_sort_func</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktreesortable">
- <title>gtk.TreeSortable Signal Prototypes</title>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtktreesortable--sort-column-changed">sort-column-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>treesortable</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtktreesortable"><classname>gtk.TreeSortable</classname></link>
-interface provide the common methods for a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> to
-implement a sorted model for a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>. See
-the <link
-linkend="class-gtktreemodelsort"><classname>gtk.TreeModelSort</classname></link>
-for an example of a treemodel that implements the <link
-linkend="class-gtktreesortable"><classname>gtk.TreeSortable</classname></link>
-interface. The key element of the interface is a "sort column ID" which is
-an arbitrary integer value referring to a sort function and associated user
-data. A sort column ID must be greater than or equal to zero. A usable sort
-column ID is created by using the <link
-linkend="method-gtktreesortable--set-sort-func"><methodname>set_sort_func</methodname>()</link>
-method. The sort column ID can then be used for sorting a <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link> or
-<link
-linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link>
-using the <link
-linkend="method-gtktreesortable--set-sort-column-id"><methodname>set_sort_column_id</methodname>()</link>
-method.</para>
-
- <para>The <link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link> and
-<link
-linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link>
-objects automatically setup sort column IDs corresponding to the columns in
-the store. These sort column IDs are associated with an internal comparison
-function that handles the fundamental types:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>gboolean</simpara>
- </listitem>
- <listitem>
- <simpara>str</simpara>
- </listitem>
- <listitem>
- <simpara>int</simpara>
- </listitem>
- <listitem>
- <simpara>long</simpara>
- </listitem>
- <listitem>
- <simpara>float</simpara>
- </listitem>
- </itemizedlist>
-
- <note>
- <para>Once a sort column ID has been set on a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-implementing the <link
-linkend="class-gtktreesortable"><classname>gtk.TreeSortable</classname></link>
-interface it cannot be returned to the original unsorted state. You can
-change the sort function or use a default sort function but you cannot set
-the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> to
-have no sort function.</para>
- </note>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreesortable--sort-column-changed">
- <title>gtk.TreeSortable.sort_column_changed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>sort_column_changed</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>sort_column_changed</methodname>() method emits
-the "sort_column_changed" signal on the treesortable object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreesortable--get-sort-column-id">
- <title>gtk.TreeSortable.get_sort_column_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_sort_column_id</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the sort column id and the
-sort type: <literal>gtk.SORT_ASCENDING</literal> or
-<literal>gtk.SORT_DESCENDING</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_sort_column_id</methodname>() method returns
-a tuple containing the current sort column ID and the sort type (either
-<literal>gtk.SORT_ASCENDING</literal> or
-<literal>gtk.SORT_DESCENDING</literal>), if applicable. If the sort column
-ID is not set, then the tuple <literal>(-2, 0)</literal> is returned. If the
-sort column ID is set to -1 indicating the default sort function is to be
-used this method returns (<literal>None</literal>,
-<literal>None</literal>)</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreesortable--set-sort-column-id">
- <title>gtk.TreeSortable.set_sort_column_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_sort_column_id</methodname>
- <methodparam><parameter
- role="keyword">sort_column_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">order</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">sort_column_id</parameter>&nbsp;:</term>
- <listitem><simpara>the sort column id to set</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">order</parameter>&nbsp;:</term>
- <listitem><simpara>the sort order:
- <literal>gtk.SORT_ASCENDING</literal> or
- <literal>gtk.SORT_DESCENDING</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_sort_column_id</methodname>() method sets
-the current sort comparison function to that associated with the sort column
-ID specified by <parameter>sort_column_id</parameter> with the sort order
-type specified by <parameter>order</parameter>. The value of order must be
-either: <literal>gtk.SORT_ASCENDING</literal> or
-<literal>gtk.SORT_DESCENDING</literal>. The treesortable will resort itself
-to reflect this change, after emitting a "sort_column_changed" signal.</para>
-
- <para>If <parameter>sort_column_id</parameter> is -1, then the default
-sort function will be used, if it is set. If a default sort function is not
-set then the sort column ID is not changed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreesortable--set-sort-func">
- <title>gtk.TreeSortable.set_sort_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_sort_func</methodname>
- <methodparam><parameter>sort_column_id</parameter></methodparam>
- <methodparam><parameter>sort_func</parameter></methodparam>
- <methodparam><parameter>user_data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>sort_column_id</parameter>&nbsp;:</term>
- <listitem><simpara>the sort column id to set the function
-for</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>sort_func</parameter>&nbsp;:</term>
- <listitem><simpara>The sorting function</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_data</parameter>&nbsp;:</term>
- <listitem><simpara>the user data to pass to the sort func, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_sort_func</methodname>() method sets the
-comparison function (or method) used when sorting on the sort column ID
-specified by <parameter>column_id</parameter> to the value specified by
-<parameter>sort_func</parameter>. If the current sort column id of the
-treesortable is the same as <parameter>sort_column_id</parameter>, the model
-will be resorted. The signature of the comparison function (or method)
-is:</para>
-
- <programlisting>
-<methodsynopsis language="python">
- <methodname>comparefunction</methodname>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>iter1</parameter></methodparam>
- <methodparam><parameter>iter2</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname>comparemethod</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>treemodel</parameter></methodparam>
- <methodparam><parameter>iter1</parameter></methodparam>
- <methodparam><parameter>iter2</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis>
-</programlisting>
-
- <para>where <parameter>treemodel</parameter> is the tree model
-implementing the <link
-linkend="class-gtktreesortable"><classname>gtk.TreeSortable</classname></link>
-interface, <parameter>iter1</parameter> and <parameter>iter2</parameter>
-point at the rows to compare and <parameter>user_data</parameter> is the
-user data specified in <methodname>set_sort_func</methodname>() or
-<parameter>None</parameter>. If <parameter>sort_func</parameter> is a method
-then <parameter>self</parameter> is the object associated with the
-method.</para>
-
- <para>The comparison callback should return -1 if the
-<parameter>iter1</parameter> row should come before the
-<parameter>iter2</parameter> row, 0 if the rows are equal, or 1 if the
-<parameter>iter1</parameter> row should come after the
-<parameter>iter2</parameter> row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreesortable--set-default-sort-func">
- <title>gtk.TreeSortable.set_default_sort_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_default_sort_func</methodname>
- <methodparam><parameter>sort_func</parameter></methodparam>
- <methodparam><parameter>user_data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>sort_func</parameter>&nbsp;:</term>
- <listitem><simpara>the sorting function</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_data</parameter>&nbsp;:</term>
- <listitem><simpara>the user data to pass to
-<parameter>sort_func</parameter>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_default_sort_func</methodname>() method sets
-the default comparison function (or method) to the value of
-<parameter>sort_func</parameter>. If the current sort column id of the
-treesortable is -1 (the <link
-linkend="method-gtktreesortable--get-sort-column-id"><methodname>get_sort_column_id</methodname>()</link>
-method returns (None, None)), then the model will be resorted using the
-<parameter>sort_func</parameter>. See the <link
-linkend="method-gtktreesortable--set-sort-func"><methodname>set_sort_func</methodname>()</link>
-method for more details on the signature of the comparison function.</para>
-
-<para>In Pygtk 2.10, <parameter>sort_func</parameter> can be
-<literal>None</literal> to have no default comparison function. This means
-that once the model has been sorted, it can't go back to the default
-state. In this case, when the current sort column id of sortable is -1, the
-model will be unsorted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreesortable--has-default-sort-func">
- <title>gtk.TreeSortable.has_default_sort_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>has_default_sort_func</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if the model has a
-default sort function</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>has_default_sort_func</methodname>() method
-returns <literal>True</literal> if the model has a default sort function.
-This is used primarily by <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-to determine if a model can go back to the default state, or not.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktreesortable--sort-column-changed">
- <title>The "sort-column-changed" gtk.TreeSortable Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treesortable</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treesortable</parameter>&nbsp;:</term>
- <listitem><simpara>the treesortable that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "sort-column-changed" signal is emitted when the <link
-linkend="method-gtktreesortable--sort-column-changed"><methodname>sort_column_changed</methodname>()</link>
-method is called or the sort column is changed using the <link
-linkend="method-gtktreesortable--set-sort-column-id"><methodname>set_sort_column_id</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreestore.xml b/docs/reference/pygtk-gtktreestore.xml
deleted file mode 100644
index bb9bd097..00000000
--- a/docs/reference/pygtk-gtktreestore.xml
+++ /dev/null
@@ -1,878 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktreestore">
- <refnamediv>
- <refname>gtk.TreeStore</refname>
- <refpurpose>a model for tree widgets with columns</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeStore</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktreemodel">gtk.TreeModel</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktreedragsource">gtk.TreeDragSource</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktreedragdest">gtk.TreeDragDest</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktreesortable">gtk.TreeSortable</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktreestore">gtk.TreeStore</link></methodname>
- <methodparam><parameter>...</parameter></methodparam>
- </constructorsynopsis>
-
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtktreestore- -set-column-types">set_column_types</link></methodname>
- <methodparam><parameter role="keyword">n_columns</parameter></methodparam>
- <methodparam><parameter role="keyword">types</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreestore--set-value">set_value</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- <methodparam><parameter
- role="keyword">value</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreestore--set">set</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter role="keyword">...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreestore--remove">remove</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreestore--insert">insert</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- <methodparam><parameter role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreestore--insert-before">insert_before</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter
- role="keyword">sibling</parameter></methodparam>
- <methodparam><parameter role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreestore--insert-after">insert_after</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter
- role="keyword">sibling</parameter></methodparam>
- <methodparam><parameter role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreestore--prepend">prepend</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreestore--append">append</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter role="keyword">row</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreestore--is-ancestor">is_ancestor</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">descendant</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreestore--iter-depth">iter_depth</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreestore--clear">clear</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreestore--iter-is-valid">iter_is_valid</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreestore--reorder">reorder</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter
- role="keyword">new_order</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreestore--swap">swap</link></methodname>
- <methodparam><parameter
- role="keyword">a</parameter></methodparam>
- <methodparam><parameter
- role="keyword">b</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreestore--move-after">move_after</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreestore--move-before">move_before</link></methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtktreestore">gtk.TreeStore</link> (implements <link linkend="class-gtktreemodel">gtk.TreeModel</link>, <link linkend="class-gtktreedragsource">gtk.TreeDragSource</link>, <link linkend="class-gtktreedragdest">gtk.TreeDragDest</link>, <link linkend="class-gtktreesortable">gtk.TreeSortable</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktreestore">
- <title>gtk.TreeStore Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktreesortable">gtk.TreeSortable Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtktreemodel">gtk.TreeModel Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link> is
-a model for multi-columned tree widgets. A <link
-linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link> is
-a subclass of <link linkend="class-gobject">gobject.GObject</link> and
-implements the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>,
-<link
-linkend="class-gtktreedragsource"><classname>gtk.TreeDragSource</classname></link>,
-<link
-linkend="class-gtktreedragdest"><classname>gtk.TreeDragDest</classname></link>
-and <link
-linkend="class-gtktreesortable"><classname>gtk.TreeSortable</classname></link>
-interfaces.</para>
-
- <para>The <link
-linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link>
-objects support the Python mapping and iterator protocols. See the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-Description and the <ulink
-url="http://www.pygtk.org/pygtk2tutorial/sec-TreeModelInterface.html#sec-PythonProtocolSupport">PyGTK
-tutorial</ulink> for more information.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktreestore">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TreeStore</methodname>
- <methodparam><parameter>...</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>one or more column types</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new tree store as with one or more columns each of the
-types passed in. As an example:</para>
-
- <programlisting>
- gtk.TreeStore(gobject.TYPE_INT, gobject.TYPE_STRING, gtk.gdk.Pixbuf)
-</programlisting>
-
- <para>will create a new <link
-linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link>
-with three columns, of type <type>int</type>, <type>string</type> and <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-respectively.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtktreestore- -set-column-types">
- <title>gtk.TreeStore.set_column_types</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>set_column_types</methodname>
- <methodparam><parameter role="keyword">n_columns</parameter></methodparam>
- <methodparam><parameter role="keyword">types</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">n_columns</parameter>&nbsp;:</term>
- <listitem><simpara>Number of columns for the tree store</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">types</parameter>&nbsp;:</term>
- <listitem><simpara>An array of <literal>GType</literal> types, one for each column</simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-This function is meant primarily for <literal>GObjects</literal> that inherit from
-<link linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link>, and should only be used when constructing a new
-<link linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link>. It will not function after a row has been added,
-or a method on the <link linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> interface is called.
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gtktreestore--set-value">
- <title>gtk.TreeStore.set_value</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_value</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- <methodparam><parameter
- role="keyword">value</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> for
-the row being modified</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the column number to
-modify</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">value</parameter>&nbsp;:</term>
- <listitem><simpara>a new value for the cell</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_value</methodname>() method sets the data in
-the cell specified by <parameter>iter</parameter> and
-<parameter>column</parameter> to the value specified by
-<parameter>value</parameter>. The type of <parameter>value</parameter> must
-be convertible to the type of the column.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--set">
- <title>gtk.TreeStore.set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set</methodname>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> for
-the row being modified</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>one or more column ID-value
-pairs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set</methodname>() method sets the value of one
-or more cells in the row referenced by <parameter>iter</parameter>. The
-argument list following <parameter>iter</parameter> should contain pairs of
-integer column numbers followed by the value to be set. For example, to set
-column 0 with type <literal>gobject.TYPE_STRING</literal> to "Foo", you
-would write:</para>
-
- <programlisting>
- store.set(iter, 0, "Foo")
-</programlisting>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--remove">
- <title>gtk.TreeStore.remove</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>None</literal> in PyGTK 2.0. Returns
- <literal>True</literal> in PyGTK 2.2 and above if
- <parameter>iter</parameter> is still valid.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove</methodname>() method removes the row
-pointed to by <parameter>iter</parameter> from the treestore. After being
-removed, <parameter>iter</parameter> is set to the next valid row at that
-level, or invalidated if it previously pointed to the last one.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--insert">
- <title>gtk.TreeStore.insert</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- <methodparam><parameter role="keyword">row</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the position to insert the new
-row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an optional list or tuple containing column
-values (in order) to set on the row or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the new row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert</methodname>() method inserts a new row
-at <parameter>position</parameter>. If <parameter>parent</parameter> is not
-<literal>None</literal>, then the row will be made a child of
-<parameter>parent</parameter>. Otherwise, the row will be created at the
-toplevel. If <parameter>position</parameter> is larger than the number of
-rows at that level, then the new row will be inserted to the end of the
-list. This method returns a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the new row. If <parameter>row</parameter> is not
-<literal>None</literal> it must be a tuple or list containing ordered column
-values that are used to set values in the columns of the row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--insert-before">
- <title>gtk.TreeStore.insert_before</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_before</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter
- role="keyword">sibling</parameter></methodparam>
- <methodparam><parameter role="keyword">row</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">sibling</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>an optional list or tuple containing ordered
-column values to set on the row or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the new row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_before</methodname>() method inserts a
-new row before the row pointed to by <parameter>sibling</parameter>. If
-<parameter>sibling</parameter> is <literal>None</literal>, then the row will
-be appended to the children of the row pointed to by
-<parameter>parent</parameter>. If <parameter>parent</parameter> and
-<parameter>sibling</parameter> are <literal>None</literal>, the row will be
-appended to the toplevel. If both <parameter>sibling</parameter> and
-<parameter>parent</parameter> are set, then <parameter>parent</parameter>
-must be the parent of <parameter>sibling</parameter>. When
-<parameter>sibling</parameter> is set, <parameter>parent</parameter> is
-optional. This method returns a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the new row. If <parameter>row</parameter> is not
-<literal>None</literal> it must be a tuple or list containing ordered column
-values that are used to set values in the columns of the row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--insert-after">
- <title>gtk.TreeStore.insert_after</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_after</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter
- role="keyword">sibling</parameter></methodparam>
- <methodparam><parameter role="keyword">row</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">sibling</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>a tuple or list containing ordered column
-values to be set in the new row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the new row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_after</methodname>() method inserts a new
-row after the row pointed to by <parameter>sibling</parameter>. If
-<parameter>sibling</parameter> is <literal>None</literal>, then the row will
-be prepended to the beginning of the children of
-<parameter>parent</parameter>. If <parameter>parent</parameter> and
-<parameter>sibling</parameter> are <literal>None</literal>, then the row
-will be prepended to the toplevel. If both <parameter>sibling</parameter>
-and <parameter>parent</parameter> are set, <parameter>parent</parameter>
-must be the parent of <parameter>sibling</parameter>. When
-<parameter>sibling</parameter> is set, <parameter>parent</parameter> is
-optional. This method returns a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the new row. If <parameter>row</parameter> is not
-<literal>None</literal> it must be a tuple or list containing ordered column
-values that are used to set values in the columns of the row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--prepend">
- <title>gtk.TreeStore.prepend</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>prepend</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter role="keyword">row</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>a tuple or list containing ordered column
-values to be set in the new row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the new row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>prepend</methodname>() method prepends a new row
-to the treestore. If <parameter>parent</parameter> is not
-<literal>None</literal>, the new row will be prepended before the first
-child of <parameter>parent</parameter>, otherwise it will prepend a row to
-the top level. This method returns a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the new row. If <parameter>row</parameter> is not
-<literal>None</literal> it must be a tuple or list containing ordered column
-values that are used to set values in the columns of the row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--append">
- <title>gtk.TreeStore.append</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- <methodparam><parameter role="keyword">row</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">row</parameter>&nbsp;:</term>
- <listitem><simpara>a tuple or list containing ordered column
-values to be set in the new row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the new row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>append</methodname>() method appends a new row
-to the treestore. If <parameter>parent</parameter> is not
-<literal>None</literal>, the new row will be prepended after the last child
-of <parameter>parent</parameter>, otherwise it will append a row to the top
-level. This method returns a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the new row. If <parameter>row</parameter> is not
-<literal>None</literal> it must be a tuple or list containing ordered column
-values that are used to set values in the columns of the row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--is-ancestor">
- <title>gtk.TreeStore.is_ancestor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_ancestor</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">descendant</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">descendant</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if
-<parameter>iter</parameter> is an ancestor of
-<parameter>descendant</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
- <para>The <methodname>is_ancestor</methodname>() method returns
-<literal>True</literal> if the row pointed to by <parameter>iter</parameter>
-is an ancestor of the row pointed to by <parameter>descendant</parameter>.
-That is, <parameter>iter</parameter> is the parent (or grandparent or
-great-grandparent) of <parameter>descendant</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--iter-depth">
- <title>gtk.TreeStore.iter_depth</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_depth</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the depth of
-<parameter>iter</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>iter_depth</methodname>() method returns the
-depth of the row pointed to by <parameter>iter</parameter>. This will be 0
-for anything on the root level, 1 for anything down a level, etc.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--clear">
- <title>gtk.TreeStore.clear</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>clear</methodname>() method removes all rows
-from the treestore.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--iter-is-valid">
- <title>gtk.TreeStore.iter_is_valid</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_is_valid</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>iter</parameter> is valid for the tree
- store,</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>iter_is_valid</methodname>() method returns
-<literal>True</literal> if <parameter>iter</parameter> is a valid <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> for
-the tree store.</para>
-
- <warning>
- <para>This function is slow. Only use it for debugging and/or
-testing purposes.</para>
- </warning>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--reorder">
- <title>gtk.TreeStore.reorder</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reorder</methodname>
- <methodparam><parameter role="keyword">parent</parameter></methodparam>
- <methodparam><parameter role="keyword">new_order</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">new_order</parameter>&nbsp;:</term>
- <listitem><simpara>a list of integers mapping the new position of
- each child to its old position before the re-ordering,
- i.e. <parameter>new_order</parameter><literal>[newpos] =
- oldpos</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>reorder</methodname>() method reorders the
-children of the tree store node pointed to by <parameter>parent</parameter>
-to match the order of the list of row numbers contained in
-<parameter>new_order</parameter>. Note that this method only works with
-unsorted stores.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--swap">
- <title>gtk.TreeStore.swap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>swap</methodname>
- <methodparam><parameter role="keyword">a</parameter></methodparam>
- <methodparam><parameter role="keyword">b</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">a</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">b</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>swap</methodname>() method swaps the tree store
-nodes pointed to by <parameter>a</parameter> and <parameter>b</parameter> in
-the same level of the tree store. Note that this method only works with
-unsorted stores.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--move-after">
- <title>gtk.TreeStore.move_after</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_after</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>a second <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>move_after</methodname>() method moves the tree
-store node specified by <parameter>iter</parameter> to the position after
-the node specified by
-<parameter>position</parameter>. <parameter>iter</parameter> and
-<parameter>position</parameter> should be in the same level. Note that this
-method only works with unsorted stores. If <parameter>position</parameter>
-is <literal>None</literal>, <parameter>iter</parameter> will be moved to the
-start of the level.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreestore--move-before">
- <title>gtk.TreeStore.move_before</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_before</methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- <methodparam><parameter role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The move_before() method moves the tree store node pointed to by
-<parameter>iter</parameter> to the position before the node specified by
-<parameter>position</parameter>. <parameter>iter</parameter> and
-<parameter>position</parameter> should be in the same level. Note that this
-method only works with unsorted stores. If <parameter>position</parameter>
-is <literal>None</literal>, <parameter>iter</parameter> will be moved to the
-end of the level.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreeview.xml b/docs/reference/pygtk-gtktreeview.xml
deleted file mode 100644
index 8ee228cf..00000000
--- a/docs/reference/pygtk-gtktreeview.xml
+++ /dev/null
@@ -1,4245 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktreeview">
- <refnamediv>
- <refname>gtk.TreeView</refname>
- <refpurpose>a widget for displaying both trees and lists.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeView</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktreeview">gtk.TreeView</link></methodname>
- <methodparam><parameter
- role="keyword">model</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-model">get_model</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-model">set_model</link></methodname>
- <methodparam><parameter
- role="keyword">model</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-selection">get_selection</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-hadjustment">get_hadjustment</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-hadjustment">set_hadjustment</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-vadjustment">get_vadjustment</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-vadjustment">set_vadjustment</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-headers-visible">get_headers_visible</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-headers-visible">set_headers_visible</link></methodname>
- <methodparam><parameter
- role="keyword">headers_visible</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--columns-autosize">columns_autosize</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-headers-clickable">set_headers_clickable</link></methodname>
- <methodparam><parameter
- role="keyword">active</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-rules-hint">set_rules_hint</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-rules-hint">get_rules_hint</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--append-column">append_column</link></methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--remove-column">remove_column</link></methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--insert-column">insert_column</link></methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--insert-column-with-attributes">insert_column_with_attributes</link></methodname>
- <methodparam><parameter>position</parameter></methodparam>
- <methodparam><parameter>title</parameter></methodparam>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--insert-column-with-data-func">insert_column_with_data_func</link></methodname>
- <methodparam><parameter>position</parameter></methodparam>
- <methodparam><parameter>title</parameter></methodparam>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-column">get_column</link></methodname>
- <methodparam><parameter role="keyword">n</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-columns">get_columns</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--move-column-after">move_column_after</link></methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- <methodparam><parameter
- role="keyword">base_column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-expander-column">set_expander_column</link></methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-expander-column">get_expander_column</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--set-column-drag-function">set_column_drag_function</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--scroll-to-point">scroll_to_point</link></methodname>
- <methodparam><parameter
- role="keyword">tree_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tree_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--scroll-to-cell">scroll_to_cell</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use_align</parameter></methodparam>
- <methodparam><parameter
- role="keyword">row_align</parameter></methodparam>
- <methodparam><parameter
- role="keyword">col_align</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--row-activated">row_activated</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--expand-all">expand_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--collapse-all">collapse_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--expand-to-path">expand_to_path</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--expand-row">expand_row</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">open_all</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--collapse-row">collapse_row</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--map-expanded-rows">map_expanded_rows</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--row-expanded">row_expanded</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-reorderable">set_reorderable</link></methodname>
- <methodparam><parameter
- role="keyword">reorderable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-reorderable">get_reorderable</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-cursor">set_cursor</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">focus_column</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">start_editing</parameter><initializer>False</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--set-cursor-on-cell">set_cursor_on_cell</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">focus_column</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">focus_cell</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">start_editing</parameter><initializer>False</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-cursor">get_cursor</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-bin-window">get_bin_window</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-path-at-pos">get_path_at_pos</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-cell-area">get_cell_area</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-background-area">get_background_area</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-visible-rect">get_visible_rect</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--widget-to-tree-coords">widget_to_tree_coords</link></methodname>
- <methodparam><parameter>wx</parameter></methodparam>
- <methodparam><parameter>wy</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--tree-to-widget-coords">tree_to_widget_coords</link></methodname>
- <methodparam><parameter>tx</parameter></methodparam>
- <methodparam><parameter>ty</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--enable-model-drag-source">enable_model_drag_source</link></methodname>
- <methodparam><parameter
- role="keyword">start_button_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">actions</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--enable-model-drag-dest">enable_model_drag_dest</link></methodname>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">actions</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--unset-rows-drag-source">unset_rows_drag_source</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--unset-rows-drag-dest">unset_rows_drag_dest</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-drag-dest-row">set_drag_dest_row</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter role="keyword">pos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-drag-dest-row">get_drag_dest_row</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-dest-row-at-pos">get_dest_row_at_pos</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--create-row-drag-icon">create_row_drag_icon</link></methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-enable-search">set_enable_search</link></methodname>
- <methodparam><parameter
- role="keyword">enable_search</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-enable-search">get_enable_search</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-search-column">get_search_column</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-search-column">set_search_column</link></methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview- -get-search-equal-func">get_search_equal_func</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--set-search-equal-func">set_search_equal_func</link></methodname>
- <methodparam><parameter role="keyword">func</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview- -set-destroy-count-func">set_destroy_count_func</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- <methodparam><parameter role="keyword">destroy</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-fixed-height-mode">get_fixed_height_mode</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-fixed-height-mode">set_fixed_height_mode</link></methodname>
- <methodparam><parameter
- role="keyword">enable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-hover-selection">get_hover_selection</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-hover-selection">set_hover_selection</link></methodname>
- <methodparam><parameter
- role="keyword">hover</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--get-hover-expand">get_hover_expand</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeview--set-hover-expand">set_hover_expand</link></methodname>
- <methodparam><parameter
- role="keyword">expand</parameter></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview- -get-row-separator-func">get_row_separator_func</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--set-row-separator-func">set_row_separator_func</link></methodname>
- <methodparam><parameter role="keyword">func</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--get-visible-range">get_visible_range</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--get-headers-clickable">get_headers_clickable</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--get-search-entry">get_search_entry</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--set-search-entry">set_search_entry</link></methodname>
- <methodparam><parameter role="keyword">entry</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--set-search-position-func">set_search_position_func</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--set-rubber-banding">set_rubber_banding</link></methodname>
- <methodparam><parameter role="keyword">enable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--get-rubber-banding">get_rubber_banding</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--get-grid-lines">get_grid_lines</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--set-grid-lines">set_grid_lines</link></methodname>
- <methodparam><parameter role="keyword">grid_lines</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--get-enable-tree-lines">get_enable_tree_lines</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeview--set-enable-tree-lines">set_enable_tree_lines</link></methodname>
- <methodparam><parameter role="keyword">enabled</parameter></methodparam> </methodsynopsis>
-
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtktreeview">gtk.TreeView</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktreeview">
- <title>gtk.TreeView Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"enable-grid-lines"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> grid lines should be drawn
- in the tree view</entry>
- </row>
-
- <row valign="top">
- <entry>"enable-search"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the user can search through
-columns interactively. Default value: <literal>True</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"enable-tree-lines"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> tree lines should be drawn
- in the tree view</entry>
- </row>
-
- <row valign="top">
- <entry>"expander-column"</entry>
- <entry>Read-Write</entry>
- <entry>The column for the expander</entry>
- </row>
-
- <row valign="top">
- <entry>"fixed-height-mode"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, assume all rows have the
-same height thereby speeding up display. Default value:
-<literal>False</literal>. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"hadjustment"</entry>
- <entry>Read-Write</entry>
- <entry>The horizontal Adjustment for the widget</entry>
- </row>
-
- <row valign="top">
- <entry>"headers-clickable"</entry>
- <entry>Write</entry>
- <entry>If <literal>True</literal>, the column headers respond
-to click events. Default value: <literal>False</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"headers-visible"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, show the column header
-buttons. Default value: <literal>True</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"hover-expand"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, rows expand or collapse if
-the pointer moves over them. This mode is primarily intended for treeviews
-in popups, e.g. in <link
-linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link> or
-<link
-linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>. Default
-value: <literal>False</literal>. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"hover-selection"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, the selected row follows
-the pointer. Currently, this works only for the selection modes
-<literal>gtk.SELECTION_SINGLE</literal> and
-<literal>gtk.SELECTION_BROWSE</literal>. This mode is primarily intended for
-treeviews in popups, e.g. in <link
-linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link> or
-<link
-linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link>. Default
-value: <literal>False</literal>. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"level-indentation"</entry>
- <entry>Read-Write</entry>
- <entry>Extra indentation for each level</entry>
- </row>
-
- <row valign="top">
- <entry>"model"</entry>
- <entry>Read-Write</entry>
- <entry>The model for the tree view</entry>
- </row>
-
- <row valign="top">
- <entry>"reorderable"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the view is
-reorderable. Default value: <literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"rubber-banding"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> enable selection of multiple
- items by dragging the mouse pointer</entry>
- </row>
-
- <row valign="top">
- <entry>"rules-hint"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, hint to the theme engine to
-draw rows in alternating colors. Default value:
-<literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"search-column"</entry>
- <entry>Read-Write</entry>
- <entry>The model column to search when searching through
-code. Allowed values: >= -1. Default value: -1</entry>
- </row>
-
- <row valign="top">
- <entry>"show-expanders"</entry>
- <entry>Read-Write</entry>
- <entry>View has expanders</entry>
- </row>
-
- <row valign="top">
- <entry>"vadjustment"</entry>
- <entry>Read-Write</entry>
- <entry>The vertical Adjustment for the widget</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtktreeview">
- <title>gtk.TreeView Style Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"allow-rules"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal>, allow drawing of
-alternating color rows. Default value: <literal>True</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"even-row-color"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-to use for even rows. Available in GTK+ 2.2 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"expander-size"</entry>
- <entry>Read</entry>
- <entry>The size of the expander arrow. Allowed values: >= 0.
-Default value: 12</entry>
- </row>
-
- <row valign="top">
- <entry>"grid-line-pattern"</entry>
- <entry>Read</entry>
- <entry>Dash pattern used to draw the tree view grid lines</entry>
- </row>
-
- <row valign="top">
- <entry>"grid-line-width"</entry>
- <entry>Read</entry>
- <entry>Width, in pixels, of the tree view grid lines</entry>
- </row>
-
- <row valign="top">
- <entry>"horizontal-separator"</entry>
- <entry>Read</entry>
- <entry>The horizontal space between cells. Must be an even
-number. Allowed values: >= 0. Default value: 2</entry>
- </row>
-
- <row valign="top">
- <entry>"indent-expanders"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal>, the expanders are
-indented.</entry>
- </row>
-
- <row valign="top">
- <entry>"odd-row-color"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-to use for odd rows. Available in GTK+ 2.2 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"row-ending-details"</entry>
- <entry>Read</entry>
- <entry>Enable extended row background theming</entry>
- </row>
-
- <row valign="top">
- <entry>"tree-line-pattern"</entry>
- <entry>Read</entry>
- <entry>Dash pattern used to draw the tree view lines</entry>
- </row>
-
- <row valign="top">
- <entry>"tree-line-width"</entry>
- <entry>Read</entry>
- <entry>Width, in pixels, of the tree view lines</entry>
- </row>
-
- <row valign="top">
- <entry>"vertical-separator"</entry>
- <entry>Read</entry>
- <entry>The vertical space between cells. Must be an even
-number. Allowed values: >= 0. Default value: 2</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktreeview">
- <title>gtk.TreeView Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--columns-changed">columns-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--cursor-changed">cursor-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--expand-collapse-cursor-row">expand-collapse-cursor-row</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>logical</parameter></methodparam>
- <methodparam><parameter>expand</parameter></methodparam>
- <methodparam><parameter>open_all</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--move-cursor">move-cursor</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>step</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--row-activated">row-activated</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>view_column</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--row-collapsed">row-collapsed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--row-expanded">row-expanded</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--select-all">select-all</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--select-cursor-parent">select-cursor-parent</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--select-cursor-row">select-cursor-row</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>start_editing</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--set-scroll-adjustments">set-scroll-adjustments</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>hadjustment</parameter></methodparam>
- <methodparam><parameter>vadjustment</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--start-interactive-search">start-interactive-search</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--test-collapse-row">test-collapse-row</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--test-expand-row">test-expand-row</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--toggle-cursor-row">toggle-cursor-row</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtktreeview--unselect-all">unselect-all</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget is used to display the contents of any model implementing the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-interface. The tree models provided standard with <literal>GTK+</literal>
-and <literal>PyGTK</literal> are:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="class-gtktreemodelsort"><classname>gtk.TreeModelSort</classname></link></simpara>
- </listitem>
- </itemizedlist>
-
- <para>In addition, <literal>PyGTK</literal> provides <link
-linkend="class-pygtkgenerictreemodel"><classname>gtk.GenericTreeModel</classname></link>
-that allows you to create your own tree model entirely in Python.</para>
-
- <para>The <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> uses
-columns and cell renderers to actually display the model information.
-<literal>GTK+</literal> and <literal>PyGTK</literal> provides the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-to manage the display of a column and the following cell renderers:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><link
-linkend="class-gtkcellrendererpixbuf"><classname>gtk.CellRendererPixbuf</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="class-gtkcellrenderertoggle"><classname>gtk.CellRendererToggle</classname></link></simpara>
- </listitem>
- </itemizedlist>
-
- <para>In addition, <literal>PyGTK</literal> provides the <link
-linkend="class-pygtkgenericcellrenderer"><classname>gtk.GenericCellRenderer</classname></link>
-that allows you to create your own cell renderers entirely in Python.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktreeview">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TreeView</methodname>
- <methodparam><parameter role="keyword">model</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">model</parameter>&nbsp;:</term>
- <listitem><simpara>the tree model to display</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A new <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget displaying the model specified by <parameter>model</parameter>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreeview--get-model">
- <title>gtk.TreeView.get_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_model</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>, or
-<literal>None</literal> if none is currently being
-used.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_model</methodname>() method returns the
-value of the "model" property containing the model the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> is
-displaying or <literal>None</literal> there is no the model.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-model">
- <title>gtk.TreeView.set_model</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_model</methodname>
- <methodparam><parameter role="keyword">model</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">model</parameter>&nbsp;:</term>
- <listitem><simpara>the new tree model to use with the
-treeview</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_model</methodname>() method sets the "model"
-property for the treeview to the value of <parameter>model</parameter>. If
-the treeview already has a model set, this method will remove it before
-setting the new model. If <parameter>model</parameter> is
-<literal>None</literal>, it will unset the old model.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-selection">
- <title>gtk.TreeView.get_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_selection</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A <link
-linkend="class-gtktreeselection"><classname>gtk.TreeSelection</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_selection</methodname>() method returns the
-current <link
-linkend="class-gtktreeselection"><classname>gtk.TreeSelection</classname></link>
-associated with the treeview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-hadjustment">
- <title>gtk.TreeView.get_hadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_hadjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object, or <literal>None</literal> if none is currently being
-used.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_hadjustment</methodname>() method returns
-the value of the "hadjustment" property that contains the current horizontal
-<link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object or <literal>None</literal> (if no horizontal adjustment is being
-used).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-hadjustment">
- <title>gtk.TreeView.set_hadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_hadjustment</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-to set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_hadjustment</methodname>() method sets the
-"hadjustment" property to the value of <parameter>adjustment</parameter>
-that must be a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-vadjustment">
- <title>gtk.TreeView.get_vadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_vadjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object, or <literal>None</literal> if none is currently being
-used.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_vadjustment</methodname>() method returns
-the value of the "vadjustment" property that contains the horizontal <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-or None if there is no vertical adjustment.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-vadjustment">
- <title>gtk.TreeView.set_vadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_vadjustment</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-to set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_vadjustment</methodname>() method sets the
-"vadjustment" property to the value of <parameter>adjustment</parameter>.
-The new <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-replaces the current vertical adjustment.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-headers-visible">
- <title>gtk.TreeView.get_headers_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_headers_visible</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the headers are
-visible.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_headers_visible</methodname>() method
-returns the value of the "headers-visible" property. If "headers-visible" is
-<literal>True</literal> the headers on the treeview are visible.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-headers-visible">
- <title>gtk.TreeView.set_headers_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_headers_visible</methodname>
- <methodparam><parameter
- role="keyword">headers_visible</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">headers_visible</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the headers are
-visible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_headers_visible</methodname>() method sets
-the "headers-visible" property to the value of
-<parameter>headers_visible</parameter>. If
-<parameter>headers_visible</parameter> is <literal>True</literal> the
-headers will be displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--columns-autosize">
- <title>gtk.TreeView.columns_autosize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>columns_autosize</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>columns_autosize</methodname>() method resizes
-all columns to their optimal width. Only works after the treeview has been
-realized.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-headers-clickable">
- <title>gtk.TreeView.set_headers_clickable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_headers_clickable</methodname>
- <methodparam><parameter
- role="keyword">active</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">active</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the headers are
-clickable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_headers_clickable</methodname>() method sets
-the "headers-clickable" property to the value of
-<parameter>active</parameter>. If <parameter>active</parameter> is
-<literal>True</literal> the column title buttons can be clicked.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-rules-hint">
- <title>gtk.TreeView.set_rules_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_rules_hint</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the tree requires
-reading across rows</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_rules_hint</methodname>() method sets the
-"rules-hint" property to the value of <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal> it indicates that
-the user interface for your application requires users to read across tree
-rows and associate cells with one another. By default, the tree will be
-rendered with alternating row colors. Do <emphasis>not</emphasis> use it
-just because you prefer the appearance of the ruled tree; that's a question
-for the theme. Some themes will draw tree rows in alternating colors even
-when rules are turned off, and users who prefer that appearance all the time
-can choose those themes. You should call this method only as a
-<emphasis>semantic</emphasis> hint to the theme engine that your tree makes
-alternating colors useful from a functional standpoint (since it has lots of
-columns, generally).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-rules-hint">
- <title>gtk.TreeView.get_rules_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_rules_hint</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if rules are useful for
-the user of this tree</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_rules_hint</methodname>() returns the value
-of the "rules-hint" property. See the <link
-linkend="method-gtktreeview--set-rules-hint"><methodname>set_rules_hint</methodname>()</link>
-method for more information on the use of "rules-hint".</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--append-column">
- <title>gtk.TreeView.append_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append_column</methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-to add.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of columns in
-<parameter>tree_view</parameter> after appending.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>append_column</methodname>() method appends the
-specified <parameter>column</parameter> to the list of columns and returns
-the new number of columns in the treeview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--remove-column">
- <title>gtk.TreeView.remove_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_column</methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-to remove.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of columns in the treeview after the
-column removal.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove_column</methodname>() method removes the
-specified <parameter>column</parameter> from the treeview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--insert-column">
- <title>gtk.TreeView.insert_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_column</methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-to be inserted.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>the position to insert
-<parameter>column</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of columns in the treeview after the
-insertion.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_column</methodname>() method inserts the
-specified <parameter>column</parameter> into the treeview at the location
-specified by <parameter>position</parameter>. If
-<parameter>position</parameter> is -1, then the column is inserted at the
-end.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--insert-column-with-attributes">
- <title>gtk.TreeView.insert_column_with_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_column_with_attributes</methodname>
- <methodparam><parameter>position</parameter></methodparam>
- <methodparam><parameter>title</parameter></methodparam>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>position</parameter>&nbsp;:</term>
- <listitem><simpara>the position to insert the new column
-in.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>title</parameter>&nbsp;:</term>
- <listitem><simpara>the title to set the header
-to.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>cell</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>optional keyword-value
-arguments</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-that was inserted.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_column_with_attributes</methodname>()
-method creates a new <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-and inserts it into the treeview at the location specified by
-<parameter>position</parameter> with the column title specified by
-<parameter>title</parameter> and using the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell</parameter>. If <parameter>position</parameter>
-is -1, then the newly created column is inserted at the end. The column is
-initialized with the optional attributes passed as keyword-value pairs (e.g.
-text=0, foreground=2). See the <link
-linkend="method-gtktreeviewcolumn--add-attribute"><methodname>gtk.TreeViewColumn.add_attribute</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--insert-column-with-data-func">
- <title>gtk.TreeView.insert_column_with_data_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_column_with_data_func</methodname>
- <methodparam><parameter>position</parameter></methodparam>
- <methodparam><parameter>title</parameter></methodparam>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>position</parameter>&nbsp;:</term>
- <listitem><simpara>the position to insert, -1 for
-append</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>title</parameter>&nbsp;:</term>
- <listitem><simpara>the column title</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>cell</parameter>&nbsp;:</term>
- <listitem><simpara>a cell renderer for the
-column</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>func</parameter>&nbsp;:</term>
- <listitem><simpara>the function or method to set attributes of the
-cell renderer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter>&nbsp;:</term>
- <listitem><simpara>the data to pass with
-<parameter>func</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of columns in the treeview after the
-insertion</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_column_with_data_func</methodname>()
-method is a convenience function that inserts a new column into the treeview
-at the location specified by <parameter>position</parameter> with the
-specified <parameter>title</parameter> and the cell renderer specified by
-<parameter>cell</parameter> and using the function or method specified by
-<parameter>func</parameter> to set cell renderer attributes (normally using
-data from the model). The signature of func is:</para>
-
- <programlisting>
-<methodsynopsis language="python">
- <methodname>celldatafunction</methodname>
- <methodparam><parameter>column</parameter></methodparam>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>model</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname>celldatamethod</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>column</parameter></methodparam>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>model</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis>
-</programlisting>
-
- <para>where <parameter>column</parameter> is the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-in the treeview, <parameter>cell</parameter> is the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-for <parameter>column</parameter>, <parameter>model</parameter> is the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> for
-the treeview and <parameter>iter</parameter> is the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the row. See the <link
-linkend="method-gtktreeviewcolumn--set-cell-data-func"><methodname>gtk.TreeViewColumn.set_cell_data_func</methodname>()</link>
-and <link
-linkend="method-gtktreeviewcolumn--pack-start"><methodname>gtk.TreeViewColumn.pack_start</methodname>()</link>
-methods for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-column">
- <title>gtk.TreeView.get_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_column</methodname>
- <methodparam><parameter role="keyword">n</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">n</parameter>&nbsp;:</term>
- <listitem><simpara>the position of the column, counting from
-0.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>,
-or <literal>None</literal> if the position is outside the range of
-columns.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_column</methodname>() method returns the
-<link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-at the specified <parameter>position</parameter> in the treeview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-columns">
- <title>gtk.TreeView.get_columns</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_columns</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-s</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_columns</methodname>() method returns a list
-of all the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-objects currently in the treeview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--move-column-after">
- <title>gtk.TreeView.move_column_after</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_column_after</methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- <methodparam><parameter
- role="keyword">base_column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-to be moved.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">base_column</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-<parameter>column</parameter> is to be after, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>move_column_after</methodname>() method moves
-the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-specified by <parameter>column</parameter> to be after the treeview column
-specified by <parameter>base_column</parameter>. If
-<parameter>base_column</parameter> is <literal>None</literal>, then
-<parameter>column</parameter> is placed in the first position.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-expander-column">
- <title>gtk.TreeView.set_expander_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_expander_column</methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the column to draw the expander arrow at
-or<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_expander_column</methodname>() method sets
-the "expander-column" property to the value of <parameter>column</parameter>
-which must be a <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-in the treeview. If <parameter>column</parameter> is
-<literal>None</literal>, then the expander arrow is always at the first
-visible column.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-expander-column">
- <title>gtk.TreeView.get_expander_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_expander_column</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the expander column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_expander_column</methodname>() method
-returns the value of the "expander-column" property that contains the
-current expander column i.e. the column that has the expander arrow drawn
-next to it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-column-drag-function">
- <title>gtk.TreeView.set_column_drag_function</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>set_column_drag_function</methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>A function to determine which columns are reorderable, or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>User data to be passed to <parameter>func</parameter>, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_column_drag_function</methodname>() method
-sets the user function specified by <parameter>func</parameter> for
-determining where a column may be dropped when dragged. The user function is
-called on every column pair in turn at the beginning of a column drag to
-determine where a drop can take place. The signature of
-<parameter>func</parameter> is:</para>
-
- <programlisting>
- def func(<parameter>tree_view</parameter>, <parameter>column</parameter>, <parameter>prev_column</parameter>, <parameter>next_column</parameter>, <parameter>data</parameter>)
-</programlisting>
-
- <para>where <parameter>tree_view</parameter> is the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>,
-<parameter>column</parameter> is the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-being dragged, prev_column and next_column are the two <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-objects bracketing the drop spot, and <parameter>data</parameter> is
-<parameter>user_data</parameter>. If <parameter>prev_column</parameter> or
-<parameter>next_column</parameter> is <literal>None</literal>, then the drop
-is at an edge. If <parameter>func</parameter> is <literal>None</literal>,
-the user drag function is removed and the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-reverts to the default behavior of allowing any reorderable column to be
-dropped anywhere.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--scroll-to-point">
- <title>gtk.TreeView.scroll_to_point</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>scroll_to_point</methodname>
- <methodparam><parameter
- role="keyword">tree_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">tree_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tree_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of new top-left pixel of
-visible area, or -1</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">tree_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of new top-left pixel of
-visible area, or -1</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>scroll_to_point</methodname>() method scrolls
-the treeview so that the top-left corner of the visible area is at the
-location specified by <parameter>tree_x</parameter> and
-<parameter>tree_y</parameter>, where <parameter>tree_x</parameter> and
-<parameter>tree_y</parameter> are specified in tree window coordinates. The
-treeview must be realized before this method is called. If it isn't, you
-should use the <link
-linkend="method-gtktreeview--scroll-to-cell"><methodname>scroll_to_cell</methodname>()</link>
-method instead. If either <parameter>tree_x</parameter> or
-<parameter>tree_y</parameter> are -1, there is no scrolling in that
-direction.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--scroll-to-cell">
- <title>gtk.TreeView.scroll_to_cell</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>scroll_to_cell</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter role="keyword">column</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">use_align</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter role="keyword">row_align</parameter>
- <initializer>0.0</initializer></methodparam>
- <methodparam><parameter role="keyword">col_align</parameter>
- <initializer>0.0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the row to move
-to</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-to move horizontally to, or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">use_align</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> use the alignment
-arguments</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">row_align</parameter>&nbsp;:</term>
- <listitem><simpara>the vertical alignment of the row specified by
-<parameter>path</parameter>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">col_align</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal alignment of the column
-specified by <parameter>column</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>scroll_to_cell</methodname>() method scrolls the
-treeview display to the position specified by <parameter>column</parameter>
-and <parameter>path</parameter>. If <parameter>column</parameter> is
-<literal>None</literal>, no horizontal scrolling occurs. The alignment
-parameters specified by <parameter>row_align</parameter> and
-<parameter>col_align</parameter> determines where
-<parameter>column</parameter> is placed within the treeview. The values of
-<parameter>col_align</parameter> and <parameter>row_align</parameter> range
-from 0.0 to 1.0. The alignment values specify the fraction of display space
-that is to the left of or above the cell. If
-<parameter>use_align</parameter> is <literal>False</literal>, the alignment
-arguments are ignored, and the tree does the minimum amount of work to
-scroll the cell onto the screen. This means that the cell will be scrolled
-to the edge closest to it's current position. If the cell is currently
-visible on the screen, nothing is done. This method only works if the model
-is set, and <parameter>path</parameter> is a valid row in the model.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--row-activated">
- <title>gtk.TreeView.row_activated</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>row_activated</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the tree path of the row of the cell to be
-activated.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-of the cell to be activated.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>row_activated</methodname>() method activates
-the cell determined by <parameter>path</parameter> and
-<parameter>column</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--expand-all">
- <title>gtk.TreeView.expand_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>expand_all</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>expand_all</methodname>() method recursively
-expands all nodes in the treeview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--collapse-all">
- <title>gtk.TreeView.collapse_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>collapse_all</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>collapse_all</methodname>() method recursively
-collapses all visible, expanded nodes in the treeview.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--expand-to-path">
- <title>gtk.TreeView.expand_to_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>expand_to_path</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>a path to a row.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>expand_to_row</methodname>() method expands the
-row with the tree path specified by <parameter>path</parameter>. This will
-also expand all parent rows of <parameter>path</parameter> as
-necessary.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--expand-row">
- <title>gtk.TreeView.expand_row</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>expand_row</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">open_all</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path to a row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">open_all</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> recursively expand,
-otherwise just expand immediate children</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>expand_row</methodname>() method opens the row
-specified by <parameter>path</parameter> so its children are visible. If
-<parameter>open_all</parameter> is <literal>True</literal> all rows are
-expanded, otherwise only the immediate children of
-<parameter>path</parameter> are expanded.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--collapse-row">
- <title>gtk.TreeView.collapse_row</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>collapse_row</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path to a row</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>collapse_row</methodname>() method collapses the
-row specified by <parameter>path</parameter> (hides its child rows, if they
-exist).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--map-expanded-rows">
- <title>gtk.TreeView.map_expanded_rows</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>map_expanded_rows</methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>A function to be called</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>User data to be passed to the function.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>map_expanded_rows</methodname>() method calls
-the function specified by <parameter>func</parameter> on all expanded rows
-passing <parameter>data</parameter> as an argument.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--row-expanded">
- <title>gtk.TreeView.row_expanded</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>row_expanded</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>the path to a row to test the expansion
-state.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<literal>path</literal> is expanded.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>row_expanded</methodname>() method returns
-<literal>True</literal> if the node pointed to by
-<parameter>path</parameter> is expanded.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-reorderable">
- <title>gtk.TreeView.set_reorderable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_reorderable</methodname>
- <methodparam><parameter
- role="keyword">reorderable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">reorderable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the tree can be
-reordered.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_reorderable</methodname>() method sets the
-"reorderable" property to the value of <parameter>reorderable</parameter>.
-This method is a convenience method to allow you to reorder models that
-support the <link
-linkend="class-gtktreedragsource"><classname>gtk.TreeDragSource</classname></link>
-and the <link
-linkend="class-gtktreedragdest"><classname>gtk.TreeDragDest</classname></link>
-interfaces. Both <link
-linkend="class-gtktreestore"><classname>gtk.TreeStore</classname></link> and
-<link
-linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
-support these. If <parameter>reorderable</parameter> is
-<literal>True</literal>, then the user can reorder the model by dragging and
-dropping rows. The application can listen to these changes by connecting to
-the model's signals.</para>
-
- <note>
- <para>This function does not give you any degree of control over the
-order -- any reordering is allowed. If more control is needed, you should
-probably handle drag and drop manually.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-reorderable">
- <title>gtk.TreeView.get_reorderable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_reorderable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the tree can be
-reordered.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_reorderable</methodname>() method returns
-the value of the "reorderable" property that determines if the user can
-reorder the tree via drag-and-drop. See the <link
-linkend="method-gtktreeview--set-reorderable"><methodname>set_reorderable</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-cursor">
- <title>gtk.TreeView.set_cursor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_cursor</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">focus_column</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">start_editing</parameter><initializer>False</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a tree path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">focus_column</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>,
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_editing</parameter>&nbsp;:</term>
- <listitem><simpara><literal>if True</literal> the specified cell
-should start being edited.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_cursor</methodname>() method sets the
-current keyboard focus to be at the row specified by
-<parameter>path</parameter>, and selects it. This is useful when you want to
-focus the user's attention on a particular row. If
-<parameter>column</parameter> is not <literal>None</literal>, then focus is
-given to the specified column. Additionally, if
-<parameter>column</parameter> is specified, and
-<parameter>start_editing</parameter> is <literal>True</literal>, then
-editing should be started in the specified cell. This method is often
-followed by the <link
-linkend="method-gtkwidget--grab-focus"><methodname>gtk.Widget.grab_focus</methodname>()</link>
-method to give keyboard focus to the treeview. Please note that editing can
-only happen when the widget is realized.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-cursor-on-cell">
- <title>gtk.TreeView.set_cursor_on_cell</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_cursor_on_cell</methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- <methodparam><parameter role="keyword">focus_column</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">focus_cell</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">start_editing</parameter><initializer>False</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>a tree path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>focus_column</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>,
- or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>focus_cell</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>,
- or <literal>None</literal></simpara></listitem> </varlistentry>
- <varlistentry>
- <term><parameter>start_editing</parameter>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the specified cell
- should start being edited.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_cursor_on_cell</methodname>() method sets
-the current keyboard focus to be at the node specified by
-<parameter>path</parameter>, and selects it. This is useful when you want
-to focus the user's attention on a particular row. If
-<parameter>focus_column</parameter> is specified, focus is given to that
-column. If <parameter>focus_column</parameter> and
-<parameter>focus_cell</parameter> are specified, and
-<parameter>focus_column</parameter> contains 2 or more editable or
-activatable cells, then focus is given to the cell specified by
-<parameter>focus_cell</parameter>. Additionally, if
-<parameter>focus_column</parameter> is specified, and
-<parameter>start_editing</parameter> is <literal>True</literal>, editing
-should be started in the specified cell. This method is often followed by
-the <link
-linkend="method-gtkwidget--grab-focus"><methodname>gtk.Widget.grab_focus</methodname>()</link>
-method in order to give keyboard focus to the widget. Please note that
-editing can only happen when the widget is realized.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-cursor">
- <title>gtk.TreeView.get_cursor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_cursor</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the current cursor path and
-focus column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_cursor</methodname>() method returns a tuple
-containing the current path and focus column. If the cursor isn't currently
-set, the current path will be <literal>None</literal>. If no column
-currently has focus, the current focus column will be
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-bin-window">
- <title>gtk.TreeView.get_bin_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_bin_window</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_bin_window</methodname>() method returns the
-window that the treeview renders to or <literal>None</literal> if the
-treeview is not realized yet. This is used primarily to compare to the
-<literal>event.window</literal> attribute to confirm that the event on the
-treeview is on the right window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-path-at-pos">
- <title>gtk.TreeView.get_path_at_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_path_at_pos</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>The x position to be
-identified.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>The y position to be
-identified.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing: a tree path; a <link
- linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
- object; the X coordinate relative to the cell; and, the Y
- coordinate relative to the cell. If there is no path at the
- position <literal>None</literal> is returned.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_path_at_pos</methodname>() method returns a
-tuple containing:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the path at the specified point
-(<parameter>x</parameter>, <parameter>y</parameter>), relative to widget
-coordinates</simpara>
- </listitem>
- <listitem>
- <simpara>the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-at that point</simpara>
- </listitem>
- <listitem>
- <simpara>the X coordinate relative to the cell
-background</simpara>
- </listitem>
- <listitem>
- <simpara>the Y coordinate relative to the cell
-background</simpara>
- </listitem>
- </itemizedlist>
-
- <para><parameter>x</parameter> and <parameter>y</parameter> are
-relative to the coordinates of an event on the treeview only when
-<literal>event.window==treeview.get_bin_window()</literal>. It is primarily
-used for popup menus. This method is only meaningful if the treeview is
-realized. This method returns <literal>None</literal> if there is no path at
-the position.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-cell-area">
- <title>gtk.TreeView.get_cell_area</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_cell_area</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a tree path for the row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-for the column</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>rectangle</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_cell_area</methodname>() method returns the
-bounding <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-in tree window coordinates for the cell at the row specified by
-<parameter>path</parameter> and the column specified by
-<parameter>column</parameter>. If <parameter>path</parameter> points to a
-path not currently displayed, the <parameter>y</parameter> and
-<parameter>height</parameter> attributes of the rectangle will be 0. The sum
-of all cell rects does not cover the entire tree; there are extra pixels in
-between rows, for example. The returned rectangle is equivalent to the
-<parameter>cell_area</parameter> passed to the <link
-linkend="method-gtkcellrenderer--render"><methodname>gtk.CellRenderer.render</methodname>()</link>
-method. This method is only valid if the treeview is realized.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-background-area">
- <title>gtk.TreeView.get_background_area</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_background_area</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a tree path for the row,</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-for the column</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a rectangle</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_background_area</methodname>() method
-returns the bounding <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-in tree window coordinates for the cell at the row specified by
-<parameter>path</parameter> and the column specified by
-<parameter>column</parameter>. If <parameter>path</parameter> points to a
-node not found in the tree, the <parameter>y</parameter> and
-<parameter>height</parameter> attributes of the rectangle will be 0. The
-returned rectangle is equivalent to the
-<parameter>background_area</parameter> passed to the <link
-linkend="method-gtkcellrenderer--render"><methodname>gtk.CellRenderer.render</methodname>()</link>.
-These background areas tile to cover the entire tree window (except for the
-area used for header buttons). Contrast with the
-<parameter>cell_area</parameter>, returned by the <link
-linkend="method-gtktreeview--get-cell-area"><methodname>get_cell_area</methodname>()</link>
-method, that returns only the cell itself, excluding the surrounding borders
-and the tree expander area.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-visible-rect">
- <title>gtk.TreeView.get_visible_rect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_rect</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a rectangle</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visible_rect</methodname>() method returns
-the bounding <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-for the currently visible region of the treeview widget, in tree
-coordinates. Convert to widget coordinates with the <link
-linkend="method-gtktreeview--tree-to-widget-coords"><methodname>tree_to_widget_coords</methodname>()</link>.
-Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire
-scrollable area of the tree.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--widget-to-tree-coords">
- <title>gtk.TreeView.widget_to_tree_coords</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>widget_to_tree_coords</methodname>
- <methodparam><parameter>wx</parameter></methodparam>
- <methodparam><parameter>wy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>wx</parameter>&nbsp;:</term>
- <listitem><simpara>the widget X coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>wy</parameter>&nbsp;:</term>
- <listitem><simpara>the widget Y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the tree X and Y
-coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>widget_to_tree_coords</methodname>() method
-returns a tuple containing the tree X and Y coordinates for the widget
-coordinates specified by <parameter>wx</parameter> and
-<parameter>wy</parameter>. The tree coordinates cover the full scrollable
-area of the tree.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--tree-to-widget-coords">
- <title>gtk.TreeView.tree_to_widget_coords</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>tree_to_widget_coords</methodname>
- <methodparam><parameter>tx</parameter></methodparam>
- <methodparam><parameter>ty</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>tx</parameter>&nbsp;:</term>
- <listitem><simpara>tree X coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>ty</parameter>&nbsp;:</term>
- <listitem><simpara>tree Y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the widget X and Y
-coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>tree_to_widget_coords</methodname>() method
-returns a tuple containing the widget coordinates for the tree coordinates
-specified by <parameter>tx</parameter> and <parameter>ty</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--enable-model-drag-source">
- <title>gtk.TreeView.enable_model_drag_source</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>enable_model_drag_source</methodname>
- <methodparam><parameter
- role="keyword">start_button_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">actions</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">start_button_mask</parameter>&nbsp;:</term>
- <listitem><simpara>the bitmask of buttons that can start the
-drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of tuples containing target
-data</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">actions</parameter>&nbsp;:</term>
- <listitem><simpara>the possible actions for a
-drag</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>enable_model_drag_source</methodname>() method
- sets the treeview to start a drag operation when the user click and
- drags on a row. The value of <parameter>start_button_mask</parameter>
- is a combination of the<xref linkend="gdk-modifier-constants"
- endterm="gdk-modifier-constants-title"></xref>.</para>
-
- <para><parameter>targets</parameter> is a sequence (list or tuple) of
- tuples that contain information about the targets. The target data
- contains a string representing the drag type, target flags (a
- combination of the <xref linkend="gtk-target-flags-constants"
- endterm="gtk-target-flags-constants-title"></xref>) and an application
- assigned integer ID used for identification purposes.</para>
-
- <para>The value of <parameter>actions</parameter> is one of the <xref
- linkend="gdk-drag-action-constants"
- endterm="gdk-drag-action-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--enable-model-drag-dest">
- <title>gtk.TreeView.enable_model_drag_dest</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>enable_model_drag_dest</methodname>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">actions</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of tuples containing target
-data</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">actions</parameter>&nbsp;:</term>
- <listitem><simpara>the possible actions for a
-drag</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>enable_model_drag_dest</methodname>() method
- sets the treeview to receive a drag drop.</para>
-
- <para><parameter>targets</parameter> is a sequence (list or tuple) of
- tuples that contain information about the targets. The target data
- contains a string representing the drag type, target flags (a
- combination of <literal>gtk.TARGET_SAME_APP</literal> and
- <literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an
- application assigned integer ID used for identification
- purposes.</para>
-
- <para>The value of <parameter>actions</parameter> is one of the <xref
- linkend="gdk-drag-action-constants"
- endterm="gdk-drag-action-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--unset-rows-drag-source">
- <title>gtk.TreeView.unset_rows_drag_source</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unset_rows_drag_source</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>unset_rows_drag_source</methodname>() method
-unsets the drag source information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--unset-rows-drag-dest">
- <title>gtk.TreeView.unset_rows_drag_dest</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unset_rows_drag_dest</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>unset_rows_drag_dest</methodname>() method
-unsets the drag destination information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-drag-dest-row">
- <title>gtk.TreeView.set_drag_dest_row</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_drag_dest_row</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pos</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a tree path of the row to highlight, or
- <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pos</parameter>&nbsp;:</term>
- <listitem><simpara>a drop position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_drag_dest_row</methodname>() method sets the
-treeview drag destination row to the value specified by
-<parameter>path</parameter> with the drop position specified by
-<parameter>pos</parameter>. The value of <parameter>pos</parameter> must be
-one of: <literal>gtk.TREE_VIEW_DROP_BEFORE</literal>,
-<literal>gtk.TREE_VIEW_DROP_AFTER</literal>,
-<literal>gtk.TREE_VIEW_DROP_INTO_OR_BEFORE</literal> or
-<literal>gtk.TREE_VIEW_DROP_INTO_OR_AFTER</literal>.</para>
-
-<para>In PyGTK 2.10 and above, <parameter>path</parameter> may be
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-drag-dest-row">
- <title>gtk.TreeView.get_drag_dest_row</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_drag_dest_row</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the tree path and the drop
- position relative to the tree path or <literal>
- None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_drag_dest_row</methodname>() method returns
-a 2-tuple containing the path of the drag destination row and a drop
-position relative to the destination row. The drop position is one of:
-<literal>gtk.TREE_VIEW_DROP_BEFORE</literal>,
-<literal>gtk.TREE_VIEW_DROP_AFTER</literal>,
-<literal>gtk.TREE_VIEW_DROP_INTO_OR_BEFORE</literal> or
-<literal>gtk.TREE_VIEW_DROP_INTO_OR_AFTER</literal>. This method returns
-<literal>None</literal> if no drag destination row is set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-dest-row-at-pos">
- <title>gtk.TreeView.get_dest_row_at_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_dest_row_at_pos</methodname>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x coordinate of the
-position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y coordinate of the
-position</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the path of the row and
-the drop position at the position specified by <parameter>x</parameter> and
-<parameter>y</parameter> or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_dest_row_at_pos</methodname>() method
-returns a 2-tuple containing the path of the row and the drop position
-relative to the row of the position specified by <parameter>x</parameter>
-and <parameter>y</parameter>. The drop position is one of:
-<literal>gtk.TREE_VIEW_DROP_BEFORE</literal>,
-<literal>gtk.TREE_VIEW_DROP_AFTER</literal>,
-<literal>gtk.TREE_VIEW_DROP_INTO_OR_BEFORE</literal> or
-<literal>gtk.TREE_VIEW_DROP_INTO_OR_AFTER</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--create-row-drag-icon">
- <title>gtk.TreeView.create_row_drag_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_row_drag_icon</methodname>
- <methodparam><parameter
- role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a tree path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new pixmap of the drag
-icon.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>create_row_drag_icon</methodname>() method
-creates a <link
-linkend="class-gdkpixmap"><classname>gtk.gdk.Pixmap</classname></link>
-representation of the row specified by <parameter>path</parameter>. This
-image is used for a drag icon.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-enable-search">
- <title>gtk.TreeView.set_enable_search</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_enable_search</methodname>
- <methodparam><parameter
- role="keyword">enable_search</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">enable_search</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the user can search
-interactively</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_enable_search</methodname>() method sets the
-"enable-search" property to the value of
-<parameter>enable_search</parameter>. If
-<parameter>enable_search</parameter> is <literal>True</literal> the user can
-type in text to search through the tree interactively.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-enable-search">
- <title>gtk.TreeView.get_enable_search</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_enable_search</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the user can search
-interactively</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_enable_search</methodname>() method returns
-the value of the "enable-search" property. If "enable-search" is
-<literal>True</literal> the tree allows interactive searching.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-search-column">
- <title>gtk.TreeView.get_search_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_search_column</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the column the interactive search code
-searches.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_search_column</methodname>() method returns
-the value of the "search-column" property that is the column searched by
-the interactive search code.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-search-column">
- <title>gtk.TreeView.set_search_column</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_search_column</methodname>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the column to search</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_search_column</methodname>() method sets the
-"search-column" property to the value of <parameter>column</parameter>. The
-value of <parameter>column</parameter> is the column where the interactive
-search code should search. Additionally, this method turns on interactive
-searching (see the <link
-linkend="method-gtktreeview--set-enable-search"><methodname>set_enable_search</methodname>()</link>
-method).</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtktreeview- -get-search-equal-func">
- <title>gtk.TreeView.get_search_equal_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_search_equal_func</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the currently used compare function for the
- search code.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_search_equal_func</methodname>() method
-returns the compare function currently in use. This method returns None if
-the default <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-search equal function is being used. See the <link
-linkend="method-gtktreeview- -set-search-equal-func"><methodname>set_search_equal_func</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gtktreeview--set-search-equal-func">
- <title>gtk.TreeView.set_search_equal_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_search_equal_func</methodname>
- <methodparam><parameter role="keyword">func</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>the compare function to use during the search or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to <parameter>func</parameter>, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_search_equal_func</methodname>() method sets
-the compare function for the interactive search capabilities to the function
-specified by <parameter>func</parameter>. If
-<parameter>user_data</parameter> is specified and not
-<literal>None</literal>, it is passed to <parameter>func</parameter>. If
-<parameter>func</parameter> is <literal>None</literal>, the default <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-search equal function will be used. The signature of
-<parameter>func</parameter> is:</para>
-
- <programlisting>
- def func(<parameter>model</parameter>, <parameter>column</parameter>, <parameter>key</parameter>, <parameter>iter</parameter>, <parameter>data</parameter>)
-</programlisting>
-
- <para>where <parameter>model</parameter> is the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> of
-the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>,
-<parameter>column</parameter> is the number of the column being searched
-(see the <link
-linkend="method-gtktreeview--set-search-column"><methodname>set_search_column</methodname>()</link>
-method for more information), <parameter>key</parameter> is the string being
-searched for, <parameter>iter</parameter> is a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the current candidate row and <parameter>data</parameter> is the
-context data <parameter>user_data</parameter>. <parameter>func</parameter>
-should return <literal>False</literal> to indicate that the row matches the
-search criteria.</para>
-
- </refsect2>
-
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtktreeview- -set-destroy-count-func">
- <title>gtk.TreeView.set_destroy_count_func</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>set_destroy_count_func</methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter></methodparam>
- <methodparam><parameter role="keyword">destroy</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>Function to be called when a view row is destroyed, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>User data to be passed to <parameter>func</parameter>, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">destroy</parameter>&nbsp;:</term>
- <listitem><simpara>Destroy notifier for <parameter>data</parameter>, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-This function should almost never be used. It is meant for private use by
-ATK for determining the number of visible children that are removed when the
-user collapses a row, or a row is deleted.
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gtktreeview--get-fixed-height-mode">
- <title>gtk.TreeView.get_fixed_height_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_fixed_height_mode</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if fixed height mode
-is enabled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_fixed_height_mode</methodname>() method
-returns the value of the "fixed-height-mode" property. If the
-"fixed-height-mode" property is <literal>True</literal>, all rows are
-assumed to be the same height.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-fixed-height-mode">
- <title>gtk.TreeView.set_fixed_height_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_fixed_height_mode</methodname>
- <methodparam><parameter
- role="keyword">enable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">enable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> enable fixed height
-mode.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_fixed_height_mode</methodname>() method sets
-the "fixed-height-mode" property to the value of
-<parameter>enable</parameter>. If <parameter>enable</parameter> is
-<literal>True</literal> all rows are assumed to have the same height which
-speeds up <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-displays. Only enable this option if all rows are the same height and all
-columns are of type <literal>gtk.TREE_VIEW_COLUMN_FIXED</literal> (see the
-<xref linkend="gtk-treeviewcolumn-sizing-constants"
-endterm="gtk-treeviewcolumn-sizing-constants-title"></xref>).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-hover-selection">
- <title>gtk.TreeView.get_hover_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_hover_selection</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if hover selection
-mode is enabled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_hover_selection</methodname>() method
-returns the value of the "hover-selection" property. If the
-"hover-selection" property is <literal>True</literal> the selected row
-follows the pointer. See the <link
-linkend="method-gtktreeview--set-hover-selection"><methodname>set_hover_selection</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-hover-selection">
- <title>gtk.TreeView.set_hover_selection</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_hover_selection</methodname>
- <methodparam><parameter
- role="keyword">hover</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">hover</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> enable hover
-selection mode.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname></methodname>() method sets the
-"hover-selection" property to the value of <parameter>hover</parameter>. If
-<parameter>hover</parameter> is <literal>True</literal> the hover selection
-mode is enables and the selected row follows the pointer. Currently, this
-works only for the selection modes <literal>gtk.SELECTION_SINGLE</literal>
-and <literal>gtk.SELECTION_BROWSE</literal> (see the <xref
-linkend="gtk-selection-mode-constants"
-endterm="gtk-selection-mode-constants-title"></xref>).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-hover-expand">
- <title>gtk.TreeView.get_hover_expand</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_hover_expand</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if hover expand mode is
-enabled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_hover_expand</methodname>() method returns
-the value of the "hover-expand" property. If the "hover-expand" property is
-<literal>True</literal> rows expand or collapse if the pointer moves over
-them.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-hover-expand">
- <title>gtk.TreeView.set_hover_expand</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_hover_expand</methodname>
- <methodparam><parameter
- role="keyword">expand</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> enable hover expand
-mode.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_hover_expand</methodname>() method sets the
-"hover-expand" property to the value of <parameter>expand</parameter>. If
-<parameter>expand</parameter> is <literal>True</literal>, rows expand or
-collapse if the pointer moves over them. </para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-row-separator-func">
- <title>gtk.TreeView.set_row_separator_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_row_separator_func</methodname>
- <methodparam><parameter role="keyword">func</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">user_data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>the row separator function or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">user_data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to <parameter>func</parameter>, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_row_separator_func</methodname>() method
-sets the row separator function to the function specified by
-<parameter>func</parameter>. The row separator function is used to determine
-if a row should be displayed as a separator. If
-<parameter>user_data</parameter> is specified and not
-<literal>None</literal>, it is passed to <parameter>func</parameter>. If
-<parameter>func</parameter> is <literal>None</literal>, no separators will
-be drawn. The signature of <parameter>func</parameter> is:</para>
-
- <programlisting>
- def func(<parameter>model</parameter>, <parameter>iter</parameter>, <parameter>data</parameter>)
-</programlisting>
-
- <para>where <parameter>model</parameter> is the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> of
-the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>,
-<parameter>iter</parameter> is a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing to the current candidate row and <parameter>data</parameter> is the
-context data <parameter>user_data</parameter>. <parameter>func</parameter>
-should return <literal>True</literal> to indicate that the row is a
-separator.</para>
-
- <para>A common way to implement this is to have a boolean column in
- <parameter>model</parameter>, whose values <parameter>func</parameter>
- returns.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-visible-range">
- <title>gtk.TreeView.get_visible_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible_range</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the start and end paths of
-the visible region or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_visible_range</methodname>() method returns
-a 2-tuple containing the start and end paths for the visible region in the
-treeview. If no valid paths are available this method returns
-<literal>None</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-headers-clickable">
- <title>gtk.TreeView.get_headers_clickable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_headers_clickable</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if all header columns
- are clickable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if all header columns are
- clickable.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-search-entry">
- <title>gtk.TreeView.get_search_entry</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_search_entry</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the entry currently in use as the search
- entry.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the <link
- linkend="class-gtkentry"><classname>gtk.Entry</classname></link> which
- is currently in use as the interactive search entry for the treeview.
- In case the built-in entry is being used, <literal>None</literal> will
- be returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-search-entry">
- <title>gtk.TreeView.set_search_entry</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_search_entry</methodname>
- <methodparam><parameter role="keyword">entry</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">entry</parameter>&nbsp;:</term>
- <listitem><simpara>the entry the interactive search code of the
- treeview should use or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the entry which the interactive search code will use for
- this treeview. This is useful when you want to provide a search entry
- in our interface at all time at a fixed position. Passing
- <literal>None</literal> for <parameter>entry</parameter> will make the
- interactive search code use the built-in popup entry again.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-search-position-func">
- <title>gtk.TreeView.set_search_position_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_search_position_func</methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>the function to use to position the search
- dialog, or <literal>None</literal> to use the default search
- position function</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to
- <parameter>func</parameter>, or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the function to use when positioning the search dialog. The
- signature of <parameter>func</parameter> is:</para>
-
- <programlisting>
- def func(treeview, search_dialog, user_data):
- </programlisting>
-
- <para>where <parameter>search_dialog</parameter> is the dialog to be
- positioned and <parameter>user_data</parameter> is
- <parameter>data</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-rubber-banding">
- <title>gtk.TreeView.set_rubber_banding</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_rubber_banding</methodname>
- <methodparam><parameter role="keyword">enable</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">enable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> enable rubber
- banding</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Enables or disables rubber banding. If the selection mode is
- <literal>gtk.SELECTION_MULTIPLE</literal>, rubber banding will allow
- the user to select multiple rows by dragging the mouse.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-rubber-banding">
- <title>gtk.TreeView.get_rubber_banding</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_rubber_banding</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if rubber banding is
- enabled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns whether rubber banding is enabled. If the selection
- mode is <literal>gtk.SELECTION_MULTIPLE</literal>, rubber banding will
- allow the user to select multiple rows by dragging the mouse.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-grid-lines">
- <title>gtk.TreeView.get_grid_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_grid_lines</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="gtk-treeview-grid-lines-constants"
- endterm="gtk-treeview-grid-lines-constants-title"></xref>
- indicating which grid lines are enabled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns which grid lines are enabled.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-grid-lines">
- <title>gtk.TreeView.set_grid_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_grid_lines</methodname>
- <methodparam><parameter role="keyword">grid_lines</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">grid_lines</parameter>&nbsp;:</term>
- <listitem><simpara>one of the <xref
- linkend="gtk-treeview-grid-lines-constants"
- endterm="gtk-treeview-grid-lines-constants-title"></xref>
- indicating which grid lines to enable.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets which grid lines to draw.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--get-enable-tree-lines">
- <title>gtk.TreeView.get_enable_tree_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_enable_tree_lines</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if tree lines are
- drawn.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns <literal>True</literal> if tree lines are drawn.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeview--set-enable-tree-lines">
- <title>gtk.TreeView.set_enable_tree_lines</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_enable_tree_lines</methodname>
- <methodparam><parameter role="keyword">enabled</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">enabled</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> enable tree line
- drawing.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets whether to draw lines interconnecting the expanders. This
- does not have any visible effects for lists.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktreeview--columns-changed">
- <title>The "columns-changed" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "columns-changed" signal is emitted when a column has been
-added to, removed from or moved in <parameter>treeview</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--cursor-changed">
- <title>The "cursor-changed" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "cursor-changed" signal is emitted when the cursor moves or
-is set.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--expand-collapse-cursor-row">
- <title>The "expand-collapse-cursor-row" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>logical</parameter></methodparam>
- <methodparam><parameter>expand</parameter></methodparam>
- <methodparam><parameter>open_all</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>logical</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>
-</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>expand</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the row should be
-expanded</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>open_all</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> recursively expand
-all children</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "expand-collapse-cursor-row" signal is emitted when the row
-at the cursor needs to be expanded or collapsed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--move-cursor">
- <title>The "move-cursor" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>step</parameter></methodparam>
- <methodparam><parameter>count</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>step</parameter>&nbsp;:</term>
- <listitem><simpara>the movement step size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>count</parameter>&nbsp;:</term>
- <listitem><simpara>the number of steps to
-take</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-cursor" signal is emitted when the user moves the
-cursor using the <keycap>Right</keycap>, <keycap>Left</keycap>,
-<keycap>Up</keycap> or <keycap>Down</keycap> arrow keys or the
-<keycap>Page Up</keycap>, <keycap>Page Down</keycap>, <keycap>Home</keycap>
-and <keycap>End</keycap> keys.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--row-activated">
- <title>The "row-activated" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>view_column</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the activated
-row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>view_column</parameter>&nbsp;:</term>
- <listitem><simpara>the column in the activated
-row</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "row-activated" signal is emitted when the <link
-linkend="method-gtktreeview--row-activated"><methodname>row_activated</methodname>()</link>
-method is called or the user double clicks a <parameter>treeview</parameter>
-row. "row-activated" is also emitted when a non-editable row is selected and
-one of the keys: <keycap>Space</keycap>, <keycombo
-action="simul"><keycap>Shift</keycap><keycap>Space</keycap> </keycombo>,
-<keycap>Return</keycap> or <keycap>Enter</keycap> is pressed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--row-collapsed">
- <title>The "row-collapsed" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- pointing to the row that collapsed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the row that
-collapsed</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "row-collapsed" signal is emitted when a row is collapsed by
-user of programmatic action.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--row-expanded">
- <title>The "row-expanded" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
- pointing to the row that expanded</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the row that
-expanded</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "row-expanded" signal is emitted when a row is expanded via
-user or programmatic action.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--select-all">
- <title>The "select-all" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "select-all" signal is emitted when the user presses
-<keycombo action="simul"><keycap>Control</keycap><keycap>a</keycap>
- </keycombo> or <keycombo action="simul"><keycap>Control</keycap><keycap>/</keycap>
- </keycombo>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--select-cursor-parent">
- <title>The "select-cursor-parent" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "select-cursor-parent" signal is emitted when the user
-presses <keycombo action="simul"><keycap>Backspace</keycap></keycombo> while
-a row has the cursor.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--select-cursor-row">
- <title>The "select-cursor-row" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>start_editing</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>start_editing</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the cell editing is
-started</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "select-cursor-row" signal is emitted when a non-editable
-row is selected and one of the keys: <keycap>Space</keycap>, <keycombo
-action="simul"><keycap>Shift</keycap><keycap>Space</keycap></keycombo>,
-<keycap>Return</keycap> or <keycap>Enter</keycap> is pressed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--set-scroll-adjustments">
- <title>The "set-scroll-adjustments" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>hadjustment</parameter></methodparam>
- <methodparam><parameter>vadjustment</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>hadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a horizontal <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>vadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a vertical <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "set-scroll-adjustments" signal is emitted when new
-horizontal or vertical adjustments are set on the
-<parameter>treeview</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--start-interactive-search">
- <title>The "start-interactive-search" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "start-interactive-search" signal is emitted when the user
-presses <keycombo action="simul"><keycap>Control</keycap><keycap>f</keycap>
-</keycombo>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--test-collapse-row">
- <title>The "test-collapse-row" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the row to test.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the row to be
-tested</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the row should be
- collapsed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "test-collapse-row" signal is emitted when the row pointed
-to by <parameter>iter</parameter> and <parameter>path</parameter> is to be
-collapsed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--test-expand-row">
- <title>The "test-expand-row" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iter</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the row to test.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter>&nbsp;:</term>
- <listitem><simpara>the path of the row to
-test</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the row should be
- expanded.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "test-expand-row" signal is emitted when the row pointed to
-by <parameter>iter</parameter> and <parameter>path</parameter> is to be
-expanded.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--toggle-cursor-row">
- <title>The "toggle-cursor-row" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "toggle-cursor-row" signal is emitted when the user presses
-<keycombo action="simul"><keycap>Control</keycap><keycap>Space</keycap>
-</keycombo>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtktreeview--unselect-all">
- <title>The "unselect-all" gtk.TreeView Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeview</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeview</parameter>&nbsp;:</term>
- <listitem><simpara>the treeview that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the signal was
- handled.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "unselect-all" signal is emitted when the user presses
-<keycombo
-action="simul"><keycap>Shift</keycap><keycap>Control</keycap><keycap>a</keycap>
-</keycombo> or <keycombo
-action="simul"><keycap>Shift</keycap><keycap>Control</keycap><keycap>/</keycap>
-</keycombo>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtktreeviewcolumn.xml b/docs/reference/pygtk-gtktreeviewcolumn.xml
deleted file mode 100644
index 34d7c2bd..00000000
--- a/docs/reference/pygtk-gtktreeviewcolumn.xml
+++ /dev/null
@@ -1,1868 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtktreeviewcolumn">
- <refnamediv>
- <refname>gtk.TreeViewColumn</refname>
- <refpurpose>a visible column in a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeViewColumn</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtktreeviewcolumn">gtk.TreeViewColumn</link></methodname>
- <methodparam><parameter>title</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter>cell_renderer</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--pack-start">pack_start</link></methodname>
- <methodparam><parameter
- role="keyword">cell</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--pack-end">pack_end</link></methodname>
- <methodparam><parameter
- role="keyword">cell</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--clear">clear</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-cell-renderers">get_cell_renderers</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--add-attribute">add_attribute</link></methodname>
- <methodparam><parameter
- role="keyword">cell_renderer</parameter></methodparam>
- <methodparam><parameter
- role="keyword">attribute</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-attributes">set_attributes</link></methodname>
- <methodparam><parameter>cell_renderer</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-cell-data-func">set_cell_data_func</link></methodname>
- <methodparam><parameter>cell_renderer</parameter></methodparam>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>func_data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--clear-attributes">clear_attributes</link></methodname>
- <methodparam><parameter
- role="keyword">cell_renderer</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-spacing">set_spacing</link></methodname>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-spacing">get_spacing</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-visible">set_visible</link></methodname>
- <methodparam><parameter
- role="keyword">visible</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-visible">get_visible</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-resizable">set_resizable</link></methodname>
- <methodparam><parameter
- role="keyword">resizable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-resizable">get_resizable</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-sizing">set_sizing</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-sizing">get_sizing</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-width">get_width</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-fixed-width">get_fixed_width</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-fixed-width">set_fixed_width</link></methodname>
- <methodparam><parameter
- role="keyword">fixed_width</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-min-width">set_min_width</link></methodname>
- <methodparam><parameter
- role="keyword">min_width</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-min-width">get_min_width</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-max-width">set_max_width</link></methodname>
- <methodparam><parameter
- role="keyword">max_width</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-max-width">get_max_width</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--clicked">clicked</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-title">set_title</link></methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-title">get_title</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeviewcolumn--set-expand">set_expand</link></methodname>
- <methodparam><parameter
- role="keyword">expand</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeviewcolumn--get-expand">get_expand</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-clickable">set_clickable</link></methodname>
- <methodparam><parameter
- role="keyword">active</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-clickable">get_clickable</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-widget">set_widget</link></methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-widget">get_widget</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-alignment">set_alignment</link></methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-alignment">get_alignment</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-reorderable">set_reorderable</link></methodname>
- <methodparam><parameter
- role="keyword">reorderable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-reorderable">get_reorderable</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-sort-column-id">set_sort_column_id</link></methodname>
- <methodparam><parameter
- role="keyword">sort_column_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-sort-column-id">get_sort_column_id</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-sort-indicator">set_sort_indicator</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-sort-indicator">get_sort_indicator</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--set-sort-order">set_sort_order</link></methodname>
- <methodparam><parameter
- role="keyword">order</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--get-sort-order">get_sort_order</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--cell-set-cell-data">cell_set_cell_data</link></methodname>
- <methodparam><parameter
- role="keyword">tree_model</parameter></methodparam>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">is_expander</parameter></methodparam>
- <methodparam><parameter
- role="keyword">is_expanded</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--cell-get-size">cell_get_size</link></methodname>
- <methodparam><parameter>cell_area</parameter><initializer>(0,0,0,0)</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--cell-is-visible">cell_is_visible</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeviewcolumn--focus-cell">focus_cell</link></methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreeviewcolumn--cell-get-position">cell_get_position</link></methodname>
- <methodparam><parameter role="keyword">cell_renderer</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtktreeviewcolumn--queue-resize">queue_resize</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtktreeviewcolumn">gtk.TreeViewColumn</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtktreeviewcolumn">
- <title>gtk.TreeViewColumn Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"alignment"</entry>
- <entry>Read-Write</entry>
- <entry>The alignment of the column header text or
-widget</entry>
- </row>
-
- <row valign="top">
- <entry>"clickable"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the header can be
-clicked</entry>
- </row>
-
- <row valign="top">
- <entry>"expand"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the column can expand to
-take extra available space. Available in GTK+ 2.4 and above</entry>
- </row>
-
- <row valign="top">
- <entry>"fixed-width"</entry>
- <entry>Read-Write</entry>
- <entry>The current fixed width of the column</entry>
- </row>
-
- <row valign="top">
- <entry>"max-width"</entry>
- <entry>Read-Write</entry>
- <entry>The maximum allowed width of the column</entry>
- </row>
-
- <row valign="top">
- <entry>"min-width"</entry>
- <entry>Read-Write</entry>
- <entry>The minimum allowed width of the column</entry>
- </row>
-
- <row valign="top">
- <entry>"reorderable"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the column can be reordered
-around the headers</entry>
- </row>
-
- <row valign="top">
- <entry>"resizable"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the user can resize the
-column</entry>
- </row>
-
- <row valign="top">
- <entry>"sizing"</entry>
- <entry>Read-Write</entry>
- <entry>The resize mode of the column:
-<literal>gtk.TREE_VIEW_COLUMN_GROW_ONLY</literal>,
-<literal>gtk.TREE_VIEW_COLUMN_AUTOSIZE</literal> or
-<literal>gtk.TREE_VIEW_COLUMN_FIXED</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"sort-indicator"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, how a sort
-indicator</entry>
- </row>
-
- <row valign="top">
- <entry>"sort-order"</entry>
- <entry>Read-Write</entry>
- <entry>The sort direction the sort indicator should indicate:
-<literal>gtk.SORT_ASCENDING</literal> or
-<literal>gtk.SORT_DESCENDING</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"spacing"</entry>
- <entry>Read-Write</entry>
- <entry>Space which is inserted between cells</entry>
- </row>
-
- <row valign="top">
- <entry>"title"</entry>
- <entry>Read-Write</entry>
- <entry>The title to appear in the column header</entry>
- </row>
-
- <row valign="top">
- <entry>"visible"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, display the column</entry>
- </row>
-
- <row valign="top">
- <entry>"widget"</entry>
- <entry>Read-Write</entry>
- <entry>The widget to put in the column header button instead
-of the column title</entry>
- </row>
-
- <row valign="top">
- <entry>"width"</entry>
- <entry>Read</entry>
- <entry>The current width of the column</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtktreeviewcolumn">
- <title>gtk.TreeViewColumn Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtktreeviewcolumn--clicked">clicked</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>treeviewcolumn</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-object is a visible column in a <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
-widget. A <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-manages the display of the header and the cells using a <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</para>
-
- <para>In PyGTK 2.4 <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-implementes the <link
-linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
-interface.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtktreeviewcolumn">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.TreeViewColumn</methodname>
- <methodparam><parameter>title</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter>cell_renderer</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>title</parameter>&nbsp;:</term>
- <listitem><simpara>the header title string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>cell_renderer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>zero or more <literal>attribute=column</literal>
-pairs</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A newly created <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-with the header string specified by <parameter>title</parameter> and using
-the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell_renderer</parameter>. Zero or more
-<literal>attribute=column</literal> pairs may be added to specify from which
-tree model column to retrieve the attribute value. For example:</para>
-
- <programlisting>
- column = gtk.TreeViewColumn('Column Title', cell_renderer, text=0, foreground=1)
-</programlisting>
-
- <para>will retrieve the 'text' attribute values for the cell renderer
-from column 0 in the treemodel and the 'foreground' attribute values from
-column 1. See the <link
-linkend="method-gtktreeviewcolumn--add-attribute"><methodname>add_attribute</methodname>()</link>
-method for more detail.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreeviewcolumn--pack-start">
- <title>gtk.TreeViewColumn.pack_start</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pack_start</methodname>
- <methodparam><parameter
- role="keyword">cell</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>
-<parameter>cell</parameter> is to be given the extra space allocated to the
-cell box.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>pack_start</methodname>() method packs the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell</parameter> into the beginning column. If
-<parameter>expand</parameter> is <literal>True</literal>, then the
-<parameter>cell</parameter> is allocated a share of all available space that
-the column is allocated. Note <parameter>expand</parameter> defaults to
-<literal>True</literal> in PyGTK 2.4.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--pack-end">
- <title>gtk.TreeViewColumn.pack_end</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pack_end</methodname>
- <methodparam><parameter
- role="keyword">cell</parameter></methodparam>
- <methodparam><parameter
- role="keyword">expand</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>
-<parameter>cell</parameter> is to be given the extra space allocated to the
-cell box.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>pack_end</methodname>() method packs the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell</parameter> into the column. If
-<parameter>expand</parameter> is <literal>True</literal>, then the
-<parameter>cell</parameter> is allocated a share of all available space that
-the column is allocated. Note <parameter>expand</parameter> defaults to
-<literal>True</literal> in PyGTK 2.4.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--clear">
- <title>gtk.TreeViewColumn.clear</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>clear</methodname>() method unsets all the
-mappings on all renderers on the column.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-cell-renderers">
- <title>gtk.TreeViewColumn.get_cell_renderers</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_cell_renderers</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-objects</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_cell_renderers</methodname>() method returns
-a list containing all the cell renderers in the column, in no particular
-order.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--add-attribute">
- <title>gtk.TreeViewColumn.add_attribute</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_attribute</methodname>
- <methodparam><parameter
- role="keyword">cell_renderer</parameter></methodparam>
- <methodparam><parameter
- role="keyword">attribute</parameter></methodparam>
- <methodparam><parameter
- role="keyword">column</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">cell_renderer</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-to set attributes on</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">attribute</parameter>&nbsp;:</term>
- <listitem><simpara>an attribute on the
-renderer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">column</parameter>&nbsp;:</term>
- <listitem><simpara>the column position on the model to get the
-attribute from.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_attribute</methodname>() method adds an
-attribute mapping to the list in the tree column. The
-<parameter>column</parameter> is the column of the tree model to get a value
-from, and the <parameter>attribute</parameter> is the parameter on
-<parameter>cell_renderer</parameter> to be set from the value. So for
-example if column 2 of the model contains strings, you could have the "text"
-attribute of a <link
-linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
-get its values from column 2.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-attributes">
- <title>gtk.TreeViewColumn.set_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_attributes</methodname>
- <methodparam><parameter>cell_renderer</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>cell_renderer</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-we're setting the attributes of</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>zero or more
-<literal>attribute=column</literal> pairs</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_attributes</methodname>() method sets the
-attribute locations of the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell_renderer</parameter> using the
-<literal>attribute=column</literal> pairs (e.g. text=0, foreground=1). See
-the <link
-linkend="method-gtktreeviewcolumn--add-attribute"><methodname>add_attribute</methodname>()</link>
-method for more detail. All existing cell attributes are removed, and
-replaced with the new attributes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-cell-data-func">
- <title>gtk.TreeViewColumn.set_cell_data_func</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_cell_data_func</methodname>
- <methodparam><parameter>cell_renderer</parameter></methodparam>
- <methodparam><parameter>func</parameter></methodparam>
- <methodparam><parameter>func_data</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>cell_renderer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>func</parameter>&nbsp;:</term>
- <listitem><simpara>the function or method to
-use.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>func_data</parameter>&nbsp;:</term>
- <listitem><simpara>the user data to pass when calling
-<parameter>func</parameter>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_cell_data_func</methodname>() method sets
-the data function (or method) to use for the column <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-specified by <parameter>cell_renderer</parameter>. This function (or method)
-is used instead of the standard attribute mappings for setting the column
-values, and should set the attributes of the cell renderer as appropriate.
-<parameter>func</parameter> may be <literal>None</literal> to remove the
-current data function. The signature of <parameter>func</parameter>
-is:</para>
-
- <programlisting>
-<methodsynopsis language="python">
- <methodname>celldatafunction</methodname>
- <methodparam><parameter>column</parameter></methodparam>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>model</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname>celldatamethod</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>column</parameter></methodparam>
- <methodparam><parameter>cell</parameter></methodparam>
- <methodparam><parameter>model</parameter></methodparam>
- <methodparam><parameter>iter</parameter></methodparam>
- <methodparam><parameter>user_data</parameter></methodparam>
- </methodsynopsis>
-</programlisting>
-
- <para>where <parameter>column</parameter> is the <link
-linkend="class-gtktreeviewcolumn"><classname>gtk.TreeViewColumn</classname></link>
-in the treeview, <parameter>cell</parameter> is the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-for <parameter>column</parameter>, <parameter>model</parameter> is the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> for
-the treeview and <parameter>iter</parameter> is the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the row.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--clear-attributes">
- <title>gtk.TreeViewColumn.clear_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clear_attributes</methodname>
- <methodparam><parameter
- role="keyword">cell_renderer</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">cell_renderer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-to clear the attribute mapping on.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>clear_attributes</methodname>() method clears
-all existing attributes previously set with the <link
-linkend="method-gtktreeviewcolumn--set-attributes"><methodname>set_attributes</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-spacing">
- <title>gtk.TreeViewColumn.set_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_spacing</methodname>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
- <listitem><simpara>the distance between cell renderers in
-pixels.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_spacing</methodname>() method sets the
-spacing field of the treeview column, which is the number of pixels to place
-between cell renderers packed into it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-spacing">
- <title>gtk.TreeViewColumn.get_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_spacing</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the spacing of the treeview
-column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_spacing</methodname>() method returns the
-spacing of the treeview column.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-visible">
- <title>gtk.TreeViewColumn.set_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_visible</methodname>
- <methodparam><parameter
- role="keyword">visible</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">visible</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the treeview column
-is visible.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_visible</methodname>() method sets the
-"visible" property to the value of <parameter>visible</parameter>. If
-<parameter>visible</parameter> is <literal>True</literal> the treeview
-column is visible</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-visible">
- <title>gtk.TreeViewColumn.get_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visible</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the column is
-visible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visible</methodname>() method returns the
-value of the "visible" property. If "visible" is <literal>True</literal> the
-treeview column is visible.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-resizable">
- <title>gtk.TreeViewColumn.set_resizable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_resizable</methodname>
- <methodparam><parameter
- role="keyword">resizable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">resizable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the column can be
-resized</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_resizable</methodname>() method sets the
-"resizable" property to the value of <parameter>resizable</parameter>. If
-<parameter>resizable</parameter> is <literal>True</literal> the user can
-explicitly resize the column by grabbing the outer edge of the column
-button. If <parameter>resizable</parameter> is <literal>True</literal> and
-the sizing mode of the column is
-<literal>gtk.TREE_VIEW_COLUMN_AUTOSIZE</literal>, the sizing mode is changed
-to <literal>gtk.TREE_VIEW_COLUMN_GROW_ONLY</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-resizable">
- <title>gtk.TreeViewColumn.get_resizable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_resizable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if the treeview column
-can be resized.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_resizable</methodname>() method returns the
-value of the "resizable" property. If "resizable" is
-<literal>True</literal>, the treeview column can be resized by the
-user.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-sizing">
- <title>gtk.TreeViewColumn.set_sizing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_sizing</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>The treeview column sizing:
-<literal>gtk.TREE_VIEW_COLUMN_GROW_ONLY</literal>,
-<literal>gtk.TREE_VIEW_COLUMN_AUTOSIZE</literal> or
-<literal>gtk.TREE_VIEW_COLUMN_FIXED</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_sizing</methodname>() method sets the
-"sizing" property to the value of <parameter>type</parameter>. The value of
-type must be one of the <xref linkend="gtk-treeviewcolumn-sizing-constants"
-endterm="gtk-treeviewcolumn-sizing-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-sizing">
- <title>gtk.TreeViewColumn.get_sizing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_sizing</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the treeview column sizing
-type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_sizing</methodname>() method returns the
-value of the "sizing" property that contains the current type of the
-treeview column sizing mode. See the <link
-linkend="method-gtktreeviewcolumn--set-sizing"><methodname>set_sizing</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-width">
- <title>gtk.TreeViewColumn.get_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current width of the treeview
-column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_width</methodname>() method returns the
-value of the "width" property that contains the current size of the treeview
-column in pixels.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-fixed-width">
- <title>gtk.TreeViewColumn.get_fixed_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_fixed_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the fixed width of the treeview
-column</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_fixed_width</methodname>() method returns
-the value of the "fixed-width" property that contains the fixed width of the
-treeview column i.e. the width of the treeview column only if the sizing
-type is <literal>gtk.TREE_VIEW_COLUMN_FIXED</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-fixed-width">
- <title>gtk.TreeViewColumn.set_fixed_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_fixed_width</methodname>
- <methodparam><parameter
- role="keyword">fixed_width</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">fixed_width</parameter>&nbsp;:</term>
- <listitem><simpara>the size to set the treeview column to. Must be
-greater than 0.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_fixed_width</methodname>() method sets the
-"fixed-width" property to the value of <parameter>fixed_width</parameter>.
-The value of <parameter>fixed_width</parameter> is the size of the column in
-pixels. This is meaningful only if the sizing type is
-<literal>gtk.TREE_VIEW_COLUMN_FIXED</literal>. The size of the column is
-clamped to the min and max width for the column. Please note that the min
-and max width of the column doesn't actually affect the "fixed_width"
-property of the widget, just the actual size when displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-min-width">
- <title>gtk.TreeViewColumn.set_min_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_min_width</methodname>
- <methodparam><parameter
- role="keyword">min_width</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">min_width</parameter>&nbsp;:</term>
- <listitem><simpara>the minimum width of the treeview column in
-pixels, or -1.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_min_width</methodname>() method sets the
-"min-width" property to the value of <parameter>min_width</parameter>. The
-value of <parameter>min_width</parameter> is the minimum width of the
-treeview column. If <parameter>min_width</parameter> is -1, then the
-minimum width is unset.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-min-width">
- <title>gtk.TreeViewColumn.get_min_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_min_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the minimum width of the treeview
-column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_min_width</methodname>() method returns the
-value of the "min-width" property that contains the minimum width in pixels
-of the treeview column, or -1 if no minimum width is set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-max-width">
- <title>gtk.TreeViewColumn.set_max_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_max_width</methodname>
- <methodparam><parameter
- role="keyword">max_width</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">max_width</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum width of the column in pixels, or
--1.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_max_width</methodname>() method sets the
-"max-width" property to the value of <parameter>max_width</parameter>. The
-value of <parameter>max_width</parameter> becomes the maximum width of the
-treeview column. If <parameter>max_width</parameter> is -1, then the
-maximum width is unset. Note, the column can actually be wider than max
-width if it's the last column in a view. In this case, the column expands to
-fill any extra space.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-max-width">
- <title>gtk.TreeViewColumn.get_max_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_max_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the maximum width of the treeview
-column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_max_width</methodname>() method returns the
-value of the "max-width" property that contains the maximum width in pixels
-of the treeview column, or -1 if no maximum width is set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--clicked">
- <title>gtk.TreeViewColumn.clicked</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>clicked</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>clicked</methodname>() method emits the
-"clicked" signal on the treeview column. The treeview column must be
-clickable.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-title">
- <title>gtk.TreeViewColumn.set_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_title</methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>the title string of the treeview
-column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_title</methodname>() method sets the "title"
-property to the value of <parameter>title</parameter>. The "title" property
-contains the string that is used to set the treeview column title. If a
-custom widget has been set (see the <link
-linkend="method-gtktreeviewcolumn--set-widget"><methodname>set_widget</methodname>()</link>
-method), this value is ignored.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-title">
- <title>gtk.TreeViewColumn.get_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_title</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the title of the column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_title</methodname>() method returns the
-value of the "title" property that contains the treeview column
-title.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-expand">
- <title>gtk.TreeViewColumn.set_expand</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_expand</methodname>
- <methodparam><parameter role="keyword">expand</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the column expands
- to take extra space if available.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_expand</methodname>() method sets the
-"expand" property to the value of <parameter>expand</parameter>. If expand
-is <literal>True</literal> the column expands to take available extra
-space. This space is shared equally among all columns that have their
-"expand" property set to <literal>True</literal>. If no column has this
-option set, then the last column gets all extra space. By default, every
-column is created with this <literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-expand">
- <title>gtk.TreeViewColumn.get_expand</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_expand</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if the column
- expands</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_expand</methodname>() method returns the
-value of the "expand" property. If "expand is <literal>True</literal> if the
-column expands to take any available space.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-clickable">
- <title>gtk.TreeViewColumn.set_clickable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_clickable</methodname>
- <methodparam><parameter
- role="keyword">active</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">active</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the treeview column
-header can be clicked</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_clickable</methodname>() method sets the
-"clickable" property to the value of <parameter>active</parameter>. If
-<parameter>active</parameter> is <literal>True</literal> the header can take
-keyboard focus, and be clicked.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-clickable">
- <title>gtk.TreeViewColumn.get_clickable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_clickable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the user can click
-the column header.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_clickable</methodname>() method returns the
-value of the "clickable" property. If "clickable" is <literal>True</literal>
-the user can click on the header for the treeview column.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-widget">
- <title>gtk.TreeViewColumn.set_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_widget</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a child <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_widget</methodname>() method sets the widget
-in the header to be <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-widget">
- <title>gtk.TreeViewColumn.get_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_widget</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> in the
-column header, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_widget</methodname>() method returns the
-<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> in
-the button on the column header. If a custom widget has not been set using
-the <link
-linkend="method-gtktreeviewcolumn--set-widget"><methodname>set_widget</methodname>()</link>
-method <literal>None</literal> is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-alignment">
- <title>gtk.TreeViewColumn.set_alignment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_alignment</methodname>
- <methodparam><parameter
- role="keyword">xalign</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">xalign</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal alignment, in the range 0.0 to
-1.0 inclusive.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_alignment</methodname>() method sets the
-"alignment" property to the value of <parameter>xalign</parameter>.
-<parameter>xalign</parameter> specifies the alignment of the title or custom
-widget inside the column header. The alignment value specifies the fraction
-of free space to the left of the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-alignment">
- <title>gtk.TreeViewColumn.get_alignment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_alignment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current alignment of the treeview
-column.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_alignment</methodname>() method returns the
-value of the "alignment" property that contains the current horizontal
-alignment of the treeview column. See the <link
-linkend="method-gtktreeviewcolumn--set-alignment"><methodname>set_alignment</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-reorderable">
- <title>gtk.TreeViewColumn.set_reorderable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_reorderable</methodname>
- <methodparam><parameter
- role="keyword">reorderable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">reorderable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the column can be
-reordered.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_reorderable</methodname>() method sets the
-"reorderable" property to the value of <parameter>reorderable</parameter>.
-If <parameter>reorderable</parameter> is <literal>True</literal>, the column
-can be reordered by the end user dragging the header.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-reorderable">
- <title>gtk.TreeViewColumn.get_reorderable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_reorderable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the treeview column
-can be reordered by the user.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_reorderable</methodname>() method returns
-the value of the "reorderable" property. If "reorderable" is
-<literal>True</literal> the treeview column can be reordered by the
-user.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-sort-column-id">
- <title>gtk.TreeViewColumn.set_sort_column_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_sort_column_id</methodname>
- <methodparam><parameter
- role="keyword">sort_column_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">sort_column_id</parameter>&nbsp;:</term>
- <listitem><simpara>the logical column ID of the model to sort
-on or -1.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_sort_column_id</methodname>() method is a
-convenience method that sets the column's sort column ID to the value
-specified by <parameter>sort_column_id</parameter> (an integer value). The
-treeview model sorts on the <parameter>sort_column_id</parameter> when this
-treeview column is selected for sorting. This method also makes the treeview
-column header clickable. If <parameter>sort_column_id</parameter> is -1
-sorting using the treeview column is disabled.</para>
-
- <para>This method sets up a number of callbacks that manage the
-sorting of the tree model when the column header is clicked. These callbacks
-provide toggling of the sort order, enabling the sort indicator and so
-on.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-sort-column-id">
- <title>gtk.TreeViewColumn.get_sort_column_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_sort_column_id</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current column ID for this column, or -1 if
-this column can't be used for sorting.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_sort_column_id</methodname>() method returns
-the logical column ID that the model sorts on when this column is selected
-for sorting. See the <link
-linkend="method-gtktreeviewcolumn--set-sort-column-id"><methodname>set_sort_column_id</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-sort-indicator">
- <title>gtk.TreeViewColumn.set_sort_indicator</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_sort_indicator</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> display an indicator
-that the column is sorted</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_sort_indicator</methodname>() method sets
-the "sort-indicator" property to the value of
-<parameter>setting</parameter>. If <parameter>setting</parameter> is
-<literal>True</literal> an arrow is displayed in the header button when the
-column is sorted. Call the <link
-linkend="method-gtktreeviewcolumn--set-sort-order"><methodname>set_sort_order</methodname>()</link>
-to change the direction of the arrow.</para>
-
- <note>
- <para>If the <link
-linkend="method-gtktreeviewcolumn--set-sort-column-id"><methodname>set_sort_column_id</methodname>()</link>
-convenience method has been called the visibility of the sort indicator will
-be managed automatically. See the <link
-linkend="method-gtktreeviewcolumn--set-sort-order"><methodname>set_sort_order</methodname>()</link>
-method for more information.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-sort-indicator">
- <title>gtk.TreeViewColumn.get_sort_indicator</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_sort_indicator</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the sort indicator
-arrow is displayed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_sort_indicator</methodname>() method returns
-the value of the "sort-indicator" property. If "sort-indicator" is
-<literal>True</literal> an arrow is displayed in the header button when the
-column is sorted.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--set-sort-order">
- <title>gtk.TreeViewColumn.set_sort_order</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_sort_order</methodname>
- <methodparam><parameter
- role="keyword">order</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">order</parameter>&nbsp;:</term>
- <listitem><simpara>the sort order that the sort indicator should
-indicate</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_sort_order</methodname>() method set the "sort-order" property to the
-value of order. The value of order must be either:
-<literal>gtk.SORT_ASCENDING</literal> or
-<literal>gtk.SORT_DESCENDING</literal>. This method changes the appearance
-of the sort indicator.</para>
-
- <note>
- <para>This method <emphasis>does not</emphasis> actually sort the
-model. Use the <link
-linkend="method-gtktreeviewcolumn--set-sort-column-id"><methodname>set_sort_column_id</methodname>()</link>
-method if you want automatic sorting support. This method is primarily for
-custom sorting behavior, and should be used in conjunction with the <link
-linkend="method-gtktreesortable--set-sort-column-id"><methodname>set_sort_column_id</methodname>()</link>
-method to do that. For custom models, the mechanism will vary.</para>
- </note>
-
- <para>The sort indicator changes direction to indicate normal sort or
-reverse sort. Of course, you must have the sort indicator enabled to see
-anything when calling this method; see the <link
-linkend="method-gtktreeviewcolumn--set-sort-indicator"><methodname>set_sort_indicator</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--get-sort-order">
- <title>gtk.TreeViewColumn.get_sort_order</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_sort_order</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the sort order the sort indicator is
-indicating</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_sort_order</methodname>() method returns the
-value of the "sort-order" property that indicates in which direction the
-treeview column is sorted. See the <link
-linkend="method-gtktreeviewcolumn--set-sort-order"><methodname>set_sort_order</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--cell-set-cell-data">
- <title>gtk.TreeViewColumn.cell_set_cell_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>cell_set_cell_data</methodname>
- <methodparam><parameter
- role="keyword">tree_model</parameter></methodparam>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- <methodparam><parameter
- role="keyword">is_expander</parameter></methodparam>
- <methodparam><parameter
- role="keyword">is_expanded</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">tree_model</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> to
-get the cell renderer's attributes from.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> to
-get the cell renderer's attributes from.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">is_expander</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the row has
-children</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">is_expanded</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the row has visible
-children</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>cell_set_cell_data</methodname>() method sets
-the cell renderer attributes based on the specified
-<parameter>tree_model</parameter> and <parameter>iter</parameter>. That is,
-for every attribute mapping in the treeview column, it will get a value from
-the set column in the <parameter>iter</parameter>, and use that value to set
-the attribute on the cell renderer. If <parameter>is_expander</parameter> is
-<literal>True</literal> the tree model row has children that may or may not
-be displayed. If <parameter>is_expanded</parameter> is
-<literal>True</literal> the tree model row has children that are
-displayed.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--cell-get-size">
- <title>gtk.TreeViewColumn.cell_get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>cell_get_size</methodname>
- <methodparam><parameter>cell_area</parameter><initializer>(0,0,0,0)</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>cell_area</parameter>&nbsp;:</term>
- <listitem><simpara>an optional 4-tuple or 4-list or <link
- linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
- specifying the area allocated for a cell in the
- column</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing five values: a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-holding the area a cell in the column will be allocated; the x offset of the
-cell; the y offset of the cell; the cell width; and, the cell
-height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>cell_get_size</methodname>() method returns a
-tuple containing:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-holding the area a cell in the treeview column will be allocated.</simpara>
- </listitem>
- <listitem>
- <simpara>the x offset of the cell relative to
-<parameter>cell_area</parameter>.</simpara>
- </listitem>
- <listitem>
- <simpara>the y offset of the cell relative to
-<parameter>cell_area</parameter>.</simpara>
- </listitem>
- <listitem>
- <simpara>the width of the cell.</simpara>
- </listitem>
- <listitem>
- <simpara>the height of the cell.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>This method is used primarily by the <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--cell-is-visible">
- <title>gtk.TreeViewColumn.cell_is_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>cell_is_visible</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal>, if any of the cells
-packed into the treeview column are currently visible</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>cell_is_visible</methodname>() method returns
-<literal>True</literal> if any of the cells packed into the treeview column
-are visible. For this to be meaningful, you must first initialize the cells
-with the <link
-linkend="method-gtktreeviewcolumn--cell-set-cell-data"><methodname>cell_set_cell_data</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--focus-cell">
- <title>gtk.TreeViewColumn.focus_cell</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>focus_cell</methodname>
- <methodparam><parameter role="keyword">cell</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cell</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>focus_cell</methodname>() method sets the
-current keyboard focus to be at <parameter>cell</parameter>, if the column
-contains 2 or more editable and activatable cells.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--cell-get-position">
- <title>gtk.TreeViewColumn.cell_get_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>cell_get_position</methodname>
- <methodparam><parameter role="keyword">cell_renderer</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cell_renderer</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the horizontal position
- and size of a cell or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>cell_get_position</methodname>() method returns
-the horizontal position and size of the cell specified by
-<parameter>cell_renderer</parameter>. If the cell is not found in the
-column, <literal>None</literal> is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtktreeviewcolumn--queue-resize">
- <title>gtk.TreeViewColumn.queue_resize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>queue_resize</methodname>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>queue_resize</methodname>() method flags the
- column, and the cell renderers added to this column, to have their sizes
- renegotiated.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtktreeviewcolumn--clicked">
- <title>The "clicked" gtk.TreeViewColumn Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>treeviewcolumn</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>treeviewcolumn</parameter>&nbsp;:</term>
- <listitem><simpara>the treeviewcolumn that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "clicked" signal is emitted when the user clicks on the
-<parameter>treeviewcolumn</parameter> header button.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkuimanager.xml b/docs/reference/pygtk-gtkuimanager.xml
deleted file mode 100644
index 9648be5f..00000000
--- a/docs/reference/pygtk-gtkuimanager.xml
+++ /dev/null
@@ -1,1334 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-gtkuimanager">
- <refnamediv>
- <refname>gtk.UIManager</refname>
-
- <refpurpose>construct menus and toolbars from an XML
- description (new in PyGTK 2.4)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.UIManager</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkuimanager">gtk.UIManager</link></methodname>
- <methodparam></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--set-add-tearoffs">set_add_tearoffs</link></methodname>
- <methodparam><parameter role="keyword">add_tearoffs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--get-add-tearoffs">get_add_tearoffs</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--insert-action-group">insert_action_group</link></methodname>
- <methodparam><parameter role="keyword">action_group</parameter></methodparam>
- <methodparam><parameter role="keyword">pos</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--remove-action-group">remove_action_group</link></methodname>
- <methodparam><parameter role="keyword">action_group</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--get-action-groups">get_action_groups</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--get-accel-group">get_accel_group</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--get-widget">get_widget</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--get-toplevels">get_toplevels</link></methodname>
- <methodparam><parameter role="keyword">types</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--get-action">get_action</link></methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--add-ui-from-string">add_ui_from_string</link></methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--add-ui-from-file">add_ui_from_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--add-ui">add_ui</link></methodname>
- <methodparam><parameter role="keyword">merge_id</parameter></methodparam>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- <methodparam><parameter role="keyword">top</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--remove-ui">remove_ui</link></methodname>
- <methodparam><parameter role="keyword">merge_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--get-ui">get_ui</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--ensure-update">ensure_update</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkuimanager--new-merge-id">new_merge_id</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkuimanager">gtk.UIManager</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkuimanager">
- <title>gtk.UIManager Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"add-tearoffs"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, regular menus have tearoff
-menu items. Note that this only affects regular menus. Generated popup menus
-never have tearoff menu items. Available in <literal>GTK+</literal> 2.4 and
-above.</entry>
- </row>
-
- <row valign="top">
- <entry>"ui"</entry>
- <entry>Read-Write</entry>
- <entry>An XML string describing the merged UI.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkuimanager">
- <title>gtk.UIManager Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkuimanager--actions-changed">actions-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkuimanager--add-widget">add-widget</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkuimanager--connect-proxy">connect-proxy</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkuimanager--disconnect-proxy">disconnect-proxy</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkuimanager--post-activate">post-activate</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkuimanager--pre-activate">pre-activate</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>
-constructs a user interface (menus and toolbars) from one or more UI
-definitions, which reference actions from one or more action groups.</para>
-
- <refsect2 id="XML-UI">
- <title>UI Definitions</title>
-
- <para>The UI definitions are specified in an XML format which can be
-roughly described by the following DTD.</para>
-
- <programlisting>
-&lt;!ELEMENT ui (menubar|toolbar|popup|accelerator)* &gt;
-&lt;!ELEMENT menubar (menuitem|separator|placeholder|menu)* &gt;
-&lt;!ELEMENT menu (menuitem|separator|placeholder|menu)* &gt;
-&lt;!ELEMENT popup (menuitem|separator|placeholder|menu)* &gt;
-&lt;!ELEMENT toolbar (toolitem|separator|placeholder)* &gt;
-&lt;!ELEMENT placeholder (menuitem|toolitem|separator|placeholder|menu)* &gt;
-&lt;!ELEMENT menuitem EMPTY &gt;
-&lt;!ELEMENT toolitem EMPTY &gt;
-&lt;!ELEMENT separator EMPTY &gt;
-&lt;!ELEMENT accelerator EMPTY &gt;
-&lt;!ATTLIST menubar name #IMPLIED &gt;
-&lt;!ATTLIST toolbar name #IMPLIED &gt;
-&lt;!ATTLIST popup name #IMPLIED &gt;
-&lt;!ATTLIST placeholder name #IMPLIED &gt;
-&lt;!ATTLIST menu name #IMPLIED
- action #REQUIRED
- position (top|bot) #IMPLIED &gt;
-&lt;!ATTLIST menuitem name #IMPLIED
- action #REQUIRED
- position (top|bot) #IMPLIED &gt;
-&lt;!ATTLIST toolitem name #IMPLIED
- action #REQUIRED
- position (top|bot) #IMPLIED &gt;
-&lt;!ATTLIST accelerator name #IMPLIED
- action #REQUIRED &gt;
-</programlisting>
-
- <para>There are some additional restrictions beyond those specified in
-the DTD, e.g. every toolitem must have a toolbar in its ancestry and every
-menuitem must have a menubar or popup in its ancestry. Since a GMarkup
-parser is used to parse the UI description, it must not only be valid XML,
-but valid GMarkup. If a name is not specified, it defaults to the action. If
-an action is not specified either, the element name is used.</para>
-
- <example>
- <title>A UI definition</title>
-
- <programlisting>
-&lt;ui&gt;
- &lt;menubar&gt;
- &lt;menu name="FileMenu" action="FileMenuAction"&gt;
- &lt;menuitem name="New" action="New2Action" /&gt;
- &lt;placeholder name="FileMenuAdditions" /&gt;
- &lt;/menu&gt;
- &lt;menu name="JustifyMenu" action="JustifyMenuAction"&gt;
- &lt;menuitem name="Left" action="justify-left"/&gt;
- &lt;menuitem name="Centre" action="justify-center"/&gt;
- &lt;menuitem name="Right" action="justify-right"/&gt;
- &lt;menuitem name="Fill" action="justify-fill"/&gt;
- &lt;/menu&gt;
- &lt;/menubar&gt;
- &lt;toolbar action="toolbar1"&gt;
- &lt;placeholder name="JustifyToolItems"&gt;
- &lt;separator/&gt;
- &lt;toolitem name="Left" action="justify-left"/&gt;
- &lt;toolitem name="Centre" action="justify-center"/&gt;
- &lt;toolitem name="Right" action="justify-right"/&gt;
- &lt;toolitem name="Fill" action="justify-fill"/&gt;
- &lt;separator/&gt;
- &lt;/placeholder&gt;
- &lt;/toolbar&gt;
-&lt;/ui&gt;
-</programlisting>
- </example>
-
- <para>The constructed widget hierarchy is very similar to the element
-tree of the XML, with the exception that placeholders are merged into their
-parents. The correspondence of XML elements to widgets should be almost
-obvious:</para>
-
- <variablelist>
- <varlistentry>
- <term>menubar</term>
- <listitem>
- <simpara>a <link
- linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>toolbar</term>
- <listitem>
- <simpara>a <link
- linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>popup</term>
- <listitem>
- <simpara>a toplevel <link
- linkend="class-gtkmenu"><classname>gtk.Menu</classname></link></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>menu</term>
- <listitem>
- <simpara>a <link
- linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>
- attached to a menuitem</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>menuitem</term>
- <listitem>
- <simpara>a <link
- linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>
- subclass, the exact type depends on the action</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>toolitem</term>
- <listitem>
- <simpara>a <link
- linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
- subclass, the exact type depends on the action</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>separator</term>
- <listitem>
- <simpara>a <link
- linkend="class-gtkseparatormenuitem"><classname>gtk.SeparatorMenuItem</classname></link>
- or <link
- linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>accelerator</term>
- <listitem>
- <simpara>a keyboard accelerator</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "position" attribute determines where a constructed widget
-is positioned with respect to its siblings in the partially constructed
-tree. If it is "top", the widget is prepended, otherwise it is
-appended.</para>
-
- </refsect2>
-
- <refsect2>
- <title>UI Merging</title>
-
- <para>The most remarkable feature of <link
-linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link> is
-that it can overlay a set of menuitems and toolitems over another one, and
-demerge them later.</para>
-
- <para>Merging is done based on the name of the XML elements. Each
-element is identified by a path which consists of the names of its
-ancestors, separated by slashes. For example, the menuitem named "Left" in
-the example above has the path
-<filename>/ui/menubar/JustifyMenu/Left</filename> and the toolitem with the
-same name has path
-<filename>/ui/toolbar1/JustifyToolItems/Left</filename>.</para>
-
- </refsect2>
-
- <refsect2>
- <title>Accelerators</title>
-
- <para>Every action has an accelerator path. Accelerators are installed
-together with menuitem proxies, but they can also be explicitly added with
-&lt;accelerator&gt; elements in the UI definition. This makes it possible to
-have accelerators for actions even if they have no visible proxies.</para>
-
- </refsect2>
-
- <refsect2>
- <title>Smart Separators</title>
-
- <para>The separators created by <link
-linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link> are
-"smart", i.e. they do not show up in the UI unless they end up between two
-visible menu or tool items. Separators which are located at the very
-beginning or end of the menu or toolbar containing them, or multiple
-separators next to each other, are hidden. This is a useful feature, since
-the merging of UI elements from multiple sources can make it hard or
-impossible to determine in advance whether a separator will end up in such
-an unfortunate position.</para>
-
- </refsect2>
-
- <refsect2>
- <title>Empty Menus</title>
-
- <para>Submenus pose similar problems to separators in connection with
-merging. It is impossible to know in advance whether they will end up empty
-after merging. <link
-linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>
-offers two ways to treat empty submenus:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>make them disappear by hiding the menu item they're
- attached to</simpara>
- </listitem>
- <listitem>
- <simpara>add an insensitive "Empty" item</simpara>
- </listitem>
- </itemizedlist>
-
- <para>The behavior is chosen based on the "is_important" property of
-the action to which the submenu is associated.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkuimanager">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.UIManager</methodname>
- <methodparam></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new ui manager object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkuimanager--set-add-tearoffs">
- <title>gtk.UIManager.set_add_tearoffs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_add_tearoffs</methodname>
- <methodparam><parameter role="keyword">add_tearoffs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">add_tearoffs</parameter>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if tearoff menu items
- are added to regular menus</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_tearoffs</methodname>() method sets the
-"add_tearoffs" property to the value of
-<parameter>add_tearoffs</parameter>. If <parameter>add_tearoffs</parameter>
-is <literal>True</literal> regular menus generated by this <link
-linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>
-will have tearoff menu items.</para>
-
- <para>Note that this only affects regular menus. Generated popup menus
-never have tearoff menu items.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--get-add-tearoffs">
- <title>gtk.UIManager.get_add_tearoffs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_add_tearoffs</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if tearoff menu items
- are added</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_add_tearoffs</methodname>() method returns
-the value of the "add-tearoffs" property. If "add-tearoffs" is
-<literal>True</literal> regular menus generated will have tearoff menu
-items.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--insert-action-group">
- <title>gtk.UIManager.insert_action_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_action_group</methodname>
- <methodparam><parameter role="keyword">action_group</parameter></methodparam>
- <methodparam><parameter role="keyword">pos</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">action_group</parameter>&nbsp;:</term>
- <listitem><simpara>the action group to be
- inserted</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pos</parameter>&nbsp;:</term>
- <listitem><simpara>the position at which the group will be
- inserted. If <parameter>pos</parameter> is negative
- <parameter>action_group</parameter> is inserted at the end of the
- list.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>insert_action_group</methodname>() method
-inserts the <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-specified by <parameter>action_group</parameter> into the list of associated
-action groups at the position specified by
-<parameter>pos</parameter>. Actions in earlier groups hide actions with the
-same name in later groups.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--remove-action-group">
- <title>gtk.UIManager.remove_action_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_action_group</methodname>
- <methodparam><parameter role="keyword">action_group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">action_group</parameter>&nbsp;:</term>
- <listitem><simpara>the action group to be
- removed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>remove_action_group</methodname>() method
-removes the <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-specified by <parameter>action_group</parameter> from the list of
-associated action groups.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--get-action-groups">
- <title>gtk.UIManager.get_action_groups</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_action_groups</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of associated action
- groups.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_action_groups</methodname>() method returns
-the list of associated <link
-linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link>
-objects.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--get-accel-group">
- <title>gtk.UIManager.get_accel_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_accel_group</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_accel_group</methodname>() method returns
-the associated <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--get-widget">
- <title>gtk.UIManager.get_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_widget</methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the widget found by following the path, or
- <literal>None</literal> if no widget was
- found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_widget</methodname>() method looks up a
-widget by following the path specified by <parameter>path</parameter>. The
-path consists of the names specified in the XML description of the UI.
-separated by '/'. Elements that don't have a name or action attribute in
-the XML (e.g. &lt;popup&gt;) can be addressed by their XML element name
-(e.g. "popup"). The root element ("/ui") can be omitted in the path.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--get-toplevels">
- <title>gtk.UIManager.get_toplevels</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_toplevels</methodname>
- <methodparam><parameter role="keyword">types</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">types</parameter>&nbsp;:</term>
- <listitem><simpara>specifies the types of toplevel widgets to
- include. Allowed types are
- <literal>gtk.UI_MANAGER_MENUBAR</literal>,
- <literal>gtk.UI_MANAGER_TOOLBAR</literal> and
- <literal>gtk.UI_MANAGER_POPUP</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of all toplevel widgets of the requested
- types.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_toplevels</methodname>() method returns a
-list of all toplevel widgets of the types specified by
-<parameter>types</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--get-action">
- <title>gtk.UIManager.get_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_action</methodname>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the action whose proxy widget is found by
- following the path, or <literal>None</literal> if no widget was
- found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_action</methodname>() method looks up a
-<link linkend="class-gtkaction"><classname>gtk.Action</classname></link> by
-following a path. See the <link
-linkend="method-gtkuimanager--get-widget"><methodname>get_widget()</methodname></link>
-method for more information about paths.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--add-ui-from-string">
- <title>gtk.UIManager.add_ui_from_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_ui_from_string</methodname>
- <methodparam><parameter role="keyword">buffer</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">buffer</parameter>&nbsp;:</term>
- <listitem><simpara>the string to parse</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The merge id for the merged UI. The merge id
- can be used to unmerge the UI with the <link
- linkend="method-gtkuimanager--remove-ui"><methodname>remove_ui()</methodname></link>
- method.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_ui_from_string</methodname>() method parses
-the string specified by <parameter>buffer</parameter> that contains a <link
-linkend="XML-UI">UI definition</link> and merges it with the current
-contents of the ui manager. An enclosing &lt;ui&gt; element is added if it
-is missing.</para>
-
- <para>This method raise the GError exception if an error occurs during
-the parsing of the string.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--add-ui-from-file">
- <title>gtk.UIManager.add_ui_from_file</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_ui_from_file</methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the file to parse</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The merge id for the merged UI. The merge id
- can be used to unmerge the UI with the <link
- linkend="method-gtkuimanager--remove-ui"><methodname>gtk.UIManager.remove_ui()</methodname></link>
- method.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_ui_from_file</methodname>() method parses
-the file specified by <parameter>filename</parameter> that contains a <link
-linkend="XML-UI">UI definition</link> and merges it with the current
-contents of the ui manager.</para>
-
- <para>This method raise the GError exception if an error occurs during
-the parsing of the file.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--add-ui">
- <title>gtk.UIManager.add_ui</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_ui</methodname>
- <methodparam><parameter role="keyword">merge_id</parameter></methodparam>
- <methodparam><parameter role="keyword">path</parameter></methodparam>
- <methodparam><parameter role="keyword">name</parameter></methodparam>
- <methodparam><parameter role="keyword">action</parameter></methodparam>
- <methodparam><parameter role="keyword">type</parameter></methodparam>
- <methodparam><parameter role="keyword">top</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">merge_id</parameter>&nbsp;:</term>
- <listitem><simpara>the merge id for the merged UI, see <link
- linkend="method-gtkuimanager--new-merge-id"><methodname>new_merge_id()</methodname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">path</parameter>&nbsp;:</term>
- <listitem><simpara>a path where the element should be
- added</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name for the added UI
- element</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">action</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the action to be proxied, or
- <literal>None</literal> to add a separator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of UI element to
- add.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">top</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the UI element is
- added before its siblings, otherwise it is added after its
- siblings.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_ui</methodname>() method adds a UI element
-of the type specified by <parameter>type</parameter> to the current contents
-of the ui manager at the location specified by
-<parameter>path</parameter>. Note that path must not start with "/ui" though
-"ui" is acceptable. For example "/menubar" or "ui/menubar" is acceptable but
-"/ui/menubar" is not. <parameter>type</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_AUTO</literal></term>
- <listitem>
- <simpara>The type of the UI element (menuitem, toolitem or
-separator) is set according to the context.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_MENUBAR</literal></term>
- <listitem>
- <simpara>A menubar. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_MENU</literal></term>
- <listitem>
- <simpara>A menu.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_TOOLBAR</literal></term>
- <listitem>
- <simpara>A toolbar.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_PLACEHOLDER</literal></term>
- <listitem>
- <simpara>A placeholder.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_POPUP</literal></term>
- <listitem>
- <simpara>A popup menu.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_MENUITEM</literal></term>
- <listitem>
- <simpara>A menuitem.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_TOOLITEM</literal></term>
- <listitem>
- <simpara>A toolitem.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_SEPARATOR</literal></term>
- <listitem>
- <simpara>A separator.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.UI_MANAGER_ACCELERATOR</literal></term>
- <listitem>
- <simpara>An accelerator.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--remove-ui">
- <title>gtk.UIManager.remove_ui</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_ui</methodname>
- <methodparam><parameter role="keyword">merge_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">merge_id</parameter>&nbsp;:</term>
- <listitem><simpara>a merge id</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>remove_ui</methodname>() method unmerges the
-part of the ui manager content identified by
-<parameter>merge_id</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--get-ui">
- <title>gtk.UIManager.get_ui</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_ui</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>A string containing an XML representation of
- the merged UI.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_ui</methodname>() method creates a <link
-linkend="XML-UI">UI definition</link> of the merged UI.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--ensure-update">
- <title>gtk.UIManager.ensure_update</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ensure_update</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>ensure_update</methodname>() method makes sure
-that all pending updates to the UI have been completed. This may
-occasionally be necessary, since <link
-linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>
-updates the UI in an idle function. A typical example where this method is
-useful is to enforce that the menubar and toolbar have been added to the
-main window before showing it:</para>
-
- <informalexample>
- <programlisting>
- window.add(vbox)
- merge.connect("add_widget", add_widget, vbox)
- merge.add_ui_from_file("my-menus")
- merge.add_ui_from_file("my-toolbars")
- merge.ensure_update()
- window.show()
-</programlisting>
- </informalexample>
-
- </refsect2>
-
- <refsect2 id="method-gtkuimanager--new-merge-id">
- <title>gtk.UIManager.new_merge_id</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>new_merge_id</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an unused merge id.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>new_merge_id</methodname>() method returns an
-unused merge id, suitable for use with the <link
-linkend="method-gtkuimanager--add-ui"><methodname>add_ui()</methodname></link>
-method. The returned merge ids are monotonically increasing integer
-values.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkuimanager--actions-changed">
- <title>The "actions-changed" gtk.UIManager Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>uimanager</parameter>&nbsp;:</term>
- <listitem><simpara>the uimanager that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "actions-changed" signal is emitted when the set of actions
-changes.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkuimanager--add-widget">
- <title>The "add-widget" gtk.UIManager Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>uimanager</parameter>&nbsp;:</term>
- <listitem><simpara>the uimanager that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the added widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "add-widget" signal is emitted for each generated menubar
-and toolbar. The added widget is specified by
-<parameter>widget</parameter>. It is not emitted for generated popup menus,
-which can be retrieved by the <link
-linkend="method-gtkuimanager--get-widget"><methodname>get_widget</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkuimanager--connect-proxy">
- <title>The "connect-proxy" gtk.UIManager Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>uimanager</parameter>&nbsp;:</term>
- <listitem><simpara>the uimanager that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>action</parameter>&nbsp;:</term>
- <listitem><simpara>the action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the proxy widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "connect-proxy" signal is emitted after connecting the proxy
-widget specified by <parameter>widget</parameter> to the <link
-linkend="class-gtkaction"><classname>gtk.Action</classname></link> specified
-by <parameter>action</parameter> in the group. This is intended for simple
-customizations for which a custom action class would be too clumsy,
-e.g. showing tooltips for menuitems in the statusbar.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkuimanager--disconnect-proxy">
- <title>The "disconnect-proxy" gtk.UIManager Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>uimanager</parameter>&nbsp;:</term>
- <listitem><simpara>the uimanager that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>action</parameter>&nbsp;:</term>
- <listitem><simpara>the action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the proxy widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "disconnect-proxy" signal is emitted when
-<parameter>widget</parameter> is disconnected from
-<parameter>action</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkuimanager--post-activate">
- <title>The "post-activate" gtk.UIManager Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>uimanager</parameter>&nbsp;:</term>
- <listitem><simpara>the uimanager that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>action</parameter>&nbsp;:</term>
- <listitem><simpara>the action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "post-activate" signal is emitted after
-<parameter>action</parameter> is activated. This signal is intended for
-applications to get notification after any action is activated.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkuimanager--pre-activate">
- <title>The "pre-activate" gtk.UIManager Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>uimanager</parameter></methodparam>
- <methodparam><parameter>action</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>uimanager</parameter>&nbsp;:</term>
- <listitem><simpara>the uimanager that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>action</parameter>&nbsp;:</term>
- <listitem><simpara>the action</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "pre-activate" signal is emitted before
-<parameter>action</parameter> is activated. This signal is intended for
-applications to get notification before any action is activated.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkvbox.xml b/docs/reference/pygtk-gtkvbox.xml
deleted file mode 100644
index 113f46ea..00000000
--- a/docs/reference/pygtk-gtkvbox.xml
+++ /dev/null
@@ -1,129 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkvbox">
- <refnamediv>
- <refname>gtk.VBox</refname>
- <refpurpose>a vertical container box</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.VBox</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbox">gtk.Box</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkvbox">gtk.VBox</link></methodname>
- <methodparam><parameter role="keyword">homogeneous</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter role="keyword">spacing</parameter>
- <initializer>0</initializer></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkvbox">gtk.VBox</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkvbox">
- <title>gtk.VBox Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkvbox">
- <title>gtk.VBox Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkvbox">
- <title>gtk.VBox Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkvbox">
- <title>gtk.VBox Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link> is a
-container subclassed from <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> that organizes
-its child widgets into a single column. The <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> methods are
-used to manage the arrangement, spacing, height, and alignment of the <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link> child widgets
-though all are allocated the same width.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkvbox">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.VBox</methodname>
- <methodparam><parameter role="keyword">homogeneous</parameter>
- <initializer>False</initializer></methodparam>
- <methodparam><parameter role="keyword">spacing</parameter>
- <initializer>0</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">homogeneous</parameter>&nbsp;:</term>
- <listitem><simpara>if True all child widgets are given equal space
-allocations.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
- <listitem><simpara>the additional vertical space between child
-widgets in pixels.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkvbox"><classname>gtk.VBox</classname></link> widget with
-the spacing between child widgets specified by
-<parameter>spacing</parameter>. If <parameter>homogeneous</parameter> is True
-all child widgets are allocated the same space.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkvbuttonbox.xml b/docs/reference/pygtk-gtkvbuttonbox.xml
deleted file mode 100644
index 73f77969..00000000
--- a/docs/reference/pygtk-gtkvbuttonbox.xml
+++ /dev/null
@@ -1,131 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkvbuttonbox">
- <refnamediv>
- <refname>gtk.VButtonBox</refname>
- <refpurpose>a container for arranging buttons vertically.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.VButtonBox</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbuttonbox">gtk.ButtonBox</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkvbuttonbox">gtk.VButtonBox</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbox">gtk.Box</link>
- +-- <link linkend="class-gtkbuttonbox">gtk.ButtonBox</link>
- +-- <link linkend="class-gtkvbuttonbox">gtk.VButtonBox</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkvbuttonbox">
- <title>gtk.VButtonBox Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkbox">gtk.Box Properties</link></para>
- <para><link linkend="properties-gtkbuttonbox">gtk.ButtonBox Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkvbuttonbox">
- <title>gtk.VButtonBox Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkbuttonbox">gtk.ButtonBox Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkvbuttonbox">
- <title>gtk.VButtonBox Child Properties</title>
-
- <para><link linkend="child-properties-gtkbox">gtk.Box Child Properties</link></para>
- <para><link linkend="child-properties-gtkbuttonbox">gtk.ButtonBox Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkvbuttonbox">
- <title>gtk.VButtonBox Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
-is a container subclassed from <link
-linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link>
-that is optimized for the vertical layout of buttons. The <link
-linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
-helps provide a consistent layout of buttons in an application by supplying
-default values of spacing, padding and layout style (see the <link
-linkend="class-gtkbuttonbox"><classname>gtk.ButtonBox</classname></link>
-reference for more detail). Buttons are packed into a <link
-linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
-using the <link
-linkend="method-gtkcontainer--add"><methodname>gtk.Container.add</methodname>()</link>)
-method. The <link
-linkend="method-gtkbox--pack-start"><methodname>pack_start</methodname>()</link>
-and <link
-linkend="method-gtkbox--pack-end"><methodname>pack_end</methodname>()</link>
-methods can also be used but they work just like the <link
-linkend="method-gtkcontainer--add"><methodname>gtk.Container.add</methodname>()</link>)
-method i.e. they pack the button in a way that depends on the current layout
-style and on whether the button has had the <link
-linkend="method-gtkbuttonbox--set-child-secondary"><methodname>gtk.ButtonBox.set_child_secondary</methodname>()</link>
-method called on it. The spacing between buttons can be set with the <link
-linkend="method-gtkbox--set-spacing"><methodname>gtk.Box.set_spacing</methodname>()</link>
-method. The arrangement and layout of the buttons can be changed with the
-<link
-linkend="method-gtkbuttonbox--set-layout"><methodname>gtk.ButtonBox.set_layout</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkvbuttonbox">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.VButtonBox</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link>
-widget</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkviewport.xml b/docs/reference/pygtk-gtkviewport.xml
deleted file mode 100644
index e6d79f96..00000000
--- a/docs/reference/pygtk-gtkviewport.xml
+++ /dev/null
@@ -1,425 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkviewport">
- <refnamediv>
- <refname>gtk.Viewport</refname>
- <refpurpose>a widget displaying a portion of a larger
-widget.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Viewport</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkviewport">gtk.Viewport</link></methodname>
- <methodparam><parameter role="keyword">hadjustment</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">vadjustment</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkviewport--get-hadjustment">get_hadjustment</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkviewport--get-vadjustment">get_vadjustment</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkviewport--set-hadjustment">set_hadjustment</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkviewport--set-vadjustment">set_vadjustment</link></methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkviewport--set-shadow-type">set_shadow_type</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkviewport--get-shadow-type">get_shadow_type</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkviewport">gtk.Viewport</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkviewport">
- <title>gtk.Viewport Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"hadjustment"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-that determines the values of the horizontal position for this
-viewport.</entry>
- </row>
-
- <row valign="top">
- <entry>"shadow-type"</entry>
- <entry>Read-Write</entry>
- <entry>The type of shadowed box around the viewport:
-<literal>gtk.SHADOW_NONE</literal>, <literal>gtk.SHADOW_IN</literal>,
-<literal>gtk.SHADOW_OUT</literal>, <literal>gtk.SHADOW_ETCHED_IN</literal>
-or <literal>gtk.SHADOW_ETCHED_OUT</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"vadjustment"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-that determines the values of the vertical position for this
-viewport.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkviewport">
- <title>gtk.Viewport Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkviewport">
- <title>gtk.Viewport Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkviewport--set-scroll-adjustments">set-scroll-adjustments</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>viewport</parameter></methodparam>
- <methodparam><parameter>hadjustment</parameter></methodparam>
- <methodparam><parameter>vadjustment</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link>
-widget provides a view into a portion of a larger widget. A <link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link> is
-usually used to provide adjustment capability for a widget to be used in a
-<link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>.
-For example, a label widget doesn't have any adjustments (does not support
-the "set-scroll-adjustments" signal) and would need a viewport when added to
-a <link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>
-to make the scrollbars functional. See the <link
-linkend="method-gtkscrolledwindow--add-with-viewport"><methodname>gtk.ScrolledWindow.add_with_viewport</methodname>()</link>
-method for more information.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkviewport">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Viewport</methodname>
- <methodparam><parameter role="keyword">hadjustment</parameter>
- <initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">vadjustment</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">hadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a horizontal adjustment.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">vadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a vertical adjustment.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link> with
-the horizontal and vertical adjustments specified by
-<parameter>hadjustment</parameter> and <parameter>vadjustment</parameter>
-respectively. If <parameter>hadjustment</parameter> or
-<parameter>vadjustment</parameter> is <literal>None</literal> a new
-adjustment will be created.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkviewport--get-hadjustment">
- <title>gtk.Viewport.get_hadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_hadjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the horizontal adjustment</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_hadjustment</methodname>() method returns
-the value of the "hadjustment" property that contains the horizontal <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-of the viewport.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkviewport--get-vadjustment">
- <title>gtk.Viewport.get_vadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_vadjustment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the vertical adjustment</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_vadjustment</methodname>() method returns
-the value of the "vadjustment" property that contains the vertical <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-of the viewport.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkviewport--set-hadjustment">
- <title>gtk.Viewport.set_hadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_hadjustment</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_hadjustment</methodname>() method sets the
-"hadjustment" property to the value of <parameter>adjustment</parameter>
-that becomes the horizontal adjustment of the viewport.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkviewport--set-vadjustment">
- <title>gtk.Viewport.set_vadjustment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_vadjustment</methodname>
- <methodparam><parameter
- role="keyword">adjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_vadjustment</methodname>() method sets the
-"vadjustment" property to the value of <parameter>adjustment</parameter>
-that becomes the vertical adjustment of the viewport.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkviewport--set-shadow-type">
- <title>gtk.Viewport.set_shadow_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_shadow_type</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the new shadow type.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_shadow_type</methodname>() method sets the
-"shadow-type" property to the value of <parameter>type</parameter>. The
-value of <parameter>type</parameter> must be one of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>gtk.SHADOW_NONE</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.SHADOW_IN</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.SHADOW_OUT</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.SHADOW_ETCHED_IN</literal></simpara>
- </listitem>
- <listitem>
- <simpara><literal>gtk.SHADOW_ETCHED_OUT</literal></simpara>
- </listitem>
- </itemizedlist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkviewport--get-shadow-type">
- <title>gtk.Viewport.get_shadow_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_shadow_type</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the shadow type</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_shadow_type</methodname>() method returns
-the value of the "shadow-type" property that contains the shadow type of the
-<link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link>. See
-the <link
-linkend="method-gtkviewport--set-shadow-type"><methodname>set_shadow_type</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkviewport--set-scroll-adjustments">
- <title>The "set-scroll-adjustments" gtk.Viewport Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>viewport</parameter></methodparam>
- <methodparam><parameter>hadjustment</parameter></methodparam>
- <methodparam><parameter>vadjustment</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>viewport</parameter>&nbsp;:</term>
- <listitem><simpara>the viewport that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>hadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the horizontal <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>vadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>the vertical <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "set-scroll-adjustments" signal is emitted when one or both
-of the horizontal and vertical <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-objects is changed.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkvpaned.xml b/docs/reference/pygtk-gtkvpaned.xml
deleted file mode 100644
index 9fde4ae5..00000000
--- a/docs/reference/pygtk-gtkvpaned.xml
+++ /dev/null
@@ -1,109 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkvpaned">
- <refnamediv>
- <refname>gtk.VPaned</refname>
- <refpurpose>A container with two panes arranged vertically.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.VPaned</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkpaned">gtk.Paned</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkvpaned">gtk.VPaned</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkpaned">gtk.Paned</link>
- +-- <link linkend="class-gtkvpaned">gtk.VPaned</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkvpaned">
- <title>gtk.VPaned Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
- <para><link linkend="properties-gtkpaned">gtk.Paned Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkvpaned">
- <title>gtk.VPaned Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkpaned">gtk.Paned Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="child-properties-gtkvpaned">
- <title>gtk.VPaned Child Properties</title>
-
- <para><link linkend="child-properties-gtkpaned">gtk.Paned Child Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkvpaned">
- <title>gtk.VPaned Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkpaned">gtk.Paned Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkvpaned"><classname>gtk.VPaned</classname></link> widget is
-a container widget subclassed from <link
-linkend="class-gtkpaned"><classname>gtk.Paned</classname></link> with two
-child widgets arranged vertically. The division between the two child
-widgets can be adjusted by the user by dragging a handle. See the <link
-linkend="class-gtkpaned"><classname>gtk.Paned</classname></link> description
-for more details.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkvpaned">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.VPaned</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkvpaned"><classname>gtk.VPaned</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkhpaned"><classname>gtk.HPaned</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkvruler.xml b/docs/reference/pygtk-gtkvruler.xml
deleted file mode 100644
index d842aa67..00000000
--- a/docs/reference/pygtk-gtkvruler.xml
+++ /dev/null
@@ -1,108 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkvruler">
- <refnamediv>
- <refname>gtk.VRuler</refname>
- <refpurpose>a vertical ruler.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.VRuler</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkruler">gtk.Ruler</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkvruler">gtk.VRuler</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkruler">gtk.Ruler</link>
- +-- <link linkend="class-gtkvruler">gtk.VRuler</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkvruler">
- <title>gtk.VRuler Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkruler">gtk.Ruler Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkvruler">
- <title>gtk.VRuler Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkvruler">
- <title>gtk.VRuler Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This widget is considered too specialized or little-used for
-PyGTK, and will in the future be moved to some other package. If your
-application needs this widget, feel free to use it, as the widget does work
-and is useful in some applications; it's just not of general interest.
-However, it will eventually move out of the PyGTK distribution.</para>
- </note>
-
- <para>The <link
-linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link> widget is
-arranged vertically creating a ruler that is used in conjunction with other
-widgets such as a text widget. The ruler is used to show the location of the
-mouse on the window and to show the size of the window in specified units.
-The available units of measurement are <literal>gtk.PIXELS</literal> (the
-default), <literal>gtk.INCHES</literal> and
-<literal>gtk.CENTIMETERS</literal>. See the <link
-linkend="class-gtkruler"><classname>gtk.Ruler</classname></link> description
-for more information on the methods that are used to manage a <link
-linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkvruler">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.VRuler</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkvscale.xml b/docs/reference/pygtk-gtkvscale.xml
deleted file mode 100644
index 2ace18e9..00000000
--- a/docs/reference/pygtk-gtkvscale.xml
+++ /dev/null
@@ -1,119 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkvscale">
- <refnamediv>
- <refname>gtk.VScale</refname>
- <refpurpose>a vertical slider widget used to select a value from a
-range.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.VScale</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkscale">gtk.Scale</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkvscale">gtk.VScale</link></methodname>
- <methodparam><parameter role="keyword">adjustment</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkrange">gtk.Range</link>
- +-- <link linkend="class-gtkscale">gtk.Scale</link>
- +-- <link linkend="class-gtkvscale">gtk.VScale</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkvscale">
- <title>gtk.VScale Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkrange">gtk.Range Properties</link></para>
- <para><link linkend="properties-gtkscale">gtk.Scale Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkvscale">
- <title>gtk.VScale Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para>
- <para><link linkend="style-properties-gtkscale">gtk.Scale Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkvscale">
- <title>gtk.VScale Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkrange">gtk.Range Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkscale">gtk.Scale Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkvscale"><classname>gtk.VScale</classname></link> is
-subclassed from <link
-linkend="class-gtkscale"><classname>gtk.Scale</classname></link> to provide
-a widget that allows a user to select a value using a horizontal slider. See
-the <link linkend="class-gtkscale"><classname>gtk.Scale</classname></link>
-description for more information on the methods available to manage a <link
-linkend="class-gtkvscale"><classname>gtk.VScale</classname></link>.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkvscale">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.VScale</methodname>
- <methodparam><parameter role="keyword">adjustment</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-gtkvscale"><classname>gtk.VScale</classname></link>
- widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkvscale"><classname>gtk.VScale</classname></link> widget
-and associates a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-specified by <parameter>adjustment</parameter> with it. The default value of
-<parameter>adjustment</parameter> is <literal>None</literal> which creates
-the vscale with no <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkvscrollbar.xml b/docs/reference/pygtk-gtkvscrollbar.xml
deleted file mode 100644
index e58b2e4c..00000000
--- a/docs/reference/pygtk-gtkvscrollbar.xml
+++ /dev/null
@@ -1,123 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkvscrollbar">
- <refnamediv>
- <refname>gtk.VScrollbar</refname>
- <refpurpose>a vertical scrollbar</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.VScrollbar</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkscrollbar">gtk.Scrollbar</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkvscrollbar">gtk.VScrollbar</link></methodname>
- <methodparam><parameter role="keyword">adjustment</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkrange">gtk.Range</link>
- +-- <link linkend="class-gtkscrollbar">gtk.Scrollbar</link>
- +-- <link linkend="class-gtkvscrollbar">gtk.VScrollbar</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkvscrollbar">
- <title>gtk.VScrollbar Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkrange">gtk.Range Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkvscrollbar">
- <title>gtk.VScrollbar Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
- <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para>
- <para><link linkend="style-properties-gtkscrollbar">gtk.Scrollbar Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkvscrollbar">
- <title>gtk.VScrollbar Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkrange">gtk.Range Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkvscrollbar"><classname>gtk.VScrollbar</classname></link>
-widget is subclassed from <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link> to
-provide a horizontal scrollbar. See the <link
-linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>
-reference for details on the methods available for managing vertical
-scrollbars. A <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-may be specified for the scrollbar at creation (or is created automatically
-if <literal>None</literal> is specified) to handle the adjustment of the
-scrollbar. See the <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-method for more details.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkvscrollbar">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.VScrollbar</methodname>
- <methodparam><parameter role="keyword">adjustment</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>adjustment</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkvscrollbar"><classname>gtk.VScrollbar</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkvscrollbar"><classname>gtk.VScrollbar</classname></link>
-with an associated <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-specified by <parameter>adjustment</parameter>. If
-<parameter>adjustment</parameter> is <literal>None</literal> or missing a
-new <link
-linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
-object will be created and associated with the scrollbar.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkvseparator.xml b/docs/reference/pygtk-gtkvseparator.xml
deleted file mode 100644
index 717dbe73..00000000
--- a/docs/reference/pygtk-gtkvseparator.xml
+++ /dev/null
@@ -1,93 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkvseparator">
- <refnamediv>
- <refname>gtk.VSeparator</refname>
- <refpurpose>a vertical separator.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname><link
-linkend="constructor-gtkvseparator">gtk.VSeparator</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkseparator">gtk.Separator</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-gtkvseparator">gtk.VSeparator</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkseparator">gtk.Separator</link>
- +-- <link linkend="class-gtkvseparator">gtk.VSeparator</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkvseparator">
- <title>gtk.VSeparator Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkvseparator">
- <title>gtk.VSeparator Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkvseparator">
- <title>gtk.VSeparator Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkvseparator"><classname>gtk.VSeparator</classname></link>
-widget is a vertical separator, used to group the widgets within a window.
-It displays a vertical line with a shadow to make it appear sunken into the
-interface. </para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkvseparator">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.VSeparator</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkvseparator"><classname>gtk.VSeparator</classname></link>
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkvseparator"><classname>gtk.VSeparator</classname></link>
-widget.</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkwidget.xml b/docs/reference/pygtk-gtkwidget.xml
deleted file mode 100644
index 546e2b00..00000000
--- a/docs/reference/pygtk-gtkwidget.xml
+++ /dev/null
@@ -1,9737 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkwidget">
- <refnamediv>
- <refname>gtk.Widget</refname>
- <refpurpose>the base class for all <literal>PyGTK</literal>
-widgets</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Widget</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-allocation">get_allocation</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-check-threshold">drag_check_threshold</link></methodname>
- <methodparam><parameter
- role="keyword">start_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">current_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">current_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-get-data">drag_get_data</link></methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-highlight">drag_highlight</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-unhighlight">drag_unhighlight</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-dest-set">drag_dest_set</link></methodname>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">actions</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-dest-set-proxy">drag_dest_set_proxy</link></methodname>
- <methodparam><parameter
- role="keyword">proxy_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">protocol</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use_coordinates</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-dest-unset">drag_dest_unset</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-dest-find-target">drag_dest_find_target</link></methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target_list</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-dest-get-target-list">drag_dest_get_target_list</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-dest-set-target-list">drag_dest_set_target_list</link></methodname>
- <methodparam><parameter
- role="keyword">target_list</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-dest-add-image-targets">drag_dest_add_image_targets</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-dest-add-text-targets">drag_dest_add_text_targets</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-dest-add-uri-targets">drag_dest_add_uri_targets</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-source-set">drag_source_set</link></methodname>
- <methodparam><parameter
- role="keyword">start_button_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">actions</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-source-unset">drag_source_unset</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-source-set-icon">drag_source_set_icon</link></methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">mask</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-source-set-icon-pixbuf">drag_source_set_icon_pixbuf</link></methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-source-set-icon-stock">drag_source_set_icon_stock</link></methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-source-set-icon-name">drag_source_set_icon_name</link></methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-source-add-text-targets">drag_source_add_text_targets</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-source-add-image-targets">drag_source_add_image_targets</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-source-add-uri-targets">drag_source_add_uri_targets</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--drag-begin">drag_begin</link></methodname>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">actions</parameter></methodparam>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--grab-add">grab_add</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--grab-remove">grab_remove</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--rc-get-style">rc_get_style</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--selection-owner-set">selection_owner_set</link></methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--selection-add-target">selection_add_target</link></methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- <methodparam><parameter
- role="keyword">info</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--selection-add-targets">selection_add_targets</link></methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--selection-clear-targets">selection_clear_targets</link></methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--selection-convert">selection_convert</link></methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--selection-remove-all">selection_remove_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--destroy">destroy</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--unparent">unparent</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--show">show</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--show-now">show_now</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--hide">hide</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--show-all">show_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--hide-all">hide_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--set-no-show-all">set_no_show_all</link></methodname>
- <methodparam><parameter role="keyword">no_show_all</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--get-no-show-all">get_no_show_all</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--map">map</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--unmap">unmap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--realize">realize</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--unrealize">unrealize</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--queue-draw">queue_draw</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--queue-draw-area">queue_draw_area</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--queue-resize">queue_resize</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--queue-resize-no-redraw">queue_resize_no_redraw</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--size-request">size_request</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--size-allocate">size_allocate</link></methodname>
- <methodparam><parameter
- role="keyword">allocation</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-child-requisition">get_child_requisition</link></methodname>
- <methodparam><parameter
- role="keyword">requisition</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--add-accelerator">add_accelerator</link></methodname>
- <methodparam><parameter
- role="keyword">accel_signal</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_mods</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--remove-accelerator">remove_accelerator</link></methodname>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_mods</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-accel-path">set_accel_path</link></methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--can-activate-accel">can_activate_accel</link></methodname>
- <methodparam><parameter>signal_id</parameter></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget- -list-accel-closures">list_accel_closures</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--mnemonic-activate">mnemonic_activate</link></methodname>
- <methodparam><parameter
- role="keyword">group_cycling</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--event">event</link></methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--send-expose">send_expose</link></methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--activate">activate</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-scroll-adjustments">set_scroll_adjustments</link></methodname>
- <methodparam><parameter
- role="keyword">hadjustment</parameter></methodparam>
- <methodparam><parameter
- role="keyword">vadjustment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--reparent">reparent</link></methodname>
- <methodparam><parameter
- role="keyword">new_parent</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--intersect">intersect</link></methodname>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--region-intersect">region_intersect</link></methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--freeze-child-notify">freeze_child_notify</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--child-notify">child_notify</link></methodname>
- <methodparam><parameter
- role="keyword">child_property</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--thaw-child-notify">thaw_child_notify</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--is-focus">is_focus</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--grab-focus">grab_focus</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--grab-default">grab_default</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-name">set_name</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-name">get_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-state">set_state</link></methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-sensitive">set_sensitive</link></methodname>
- <methodparam><parameter
- role="keyword">sensitive</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-app-paintable">set_app_paintable</link></methodname>
- <methodparam><parameter
- role="keyword">app_paintable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-double-buffered">set_double_buffered</link></methodname>
- <methodparam><parameter
- role="keyword">double_buffered</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-redraw-on-allocate">set_redraw_on_allocate</link></methodname>
- <methodparam><parameter
- role="keyword">redraw_on_allocate</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-parent">set_parent</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-parent-window">set_parent_window</link></methodname>
- <methodparam><parameter
- role="keyword">parent_window</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-child-visible">set_child_visible</link></methodname>
- <methodparam><parameter
- role="keyword">is_visible</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-child-visible">get_child_visible</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-parent">get_parent</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-parent-window">get_parent_window</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--child-focus">child_focus</link></methodname>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-size-request">set_size_request</link></methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--get-size-request">get_size_request</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-events">set_events</link></methodname>
- <methodparam><parameter
- role="keyword">events</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--add-events">add_events</link></methodname>
- <methodparam><parameter
- role="keyword">events</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-extension-events">set_extension_events</link></methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-extension-events">get_extension_events</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-toplevel">get_toplevel</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-ancestor">get_ancestor</link></methodname>
- <methodparam><parameter
- role="keyword">widget_type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-colormap">get_colormap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-visual">get_visual</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--get-screen">get_screen</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--has-screen">has_screen</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--get-display">get_display</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--get-root-window">get_root_window</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-settings">get_settings</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--get-clipboard">get_clipboard</link></methodname>
- <methodparam><parameter role="keyword">selection</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-accessible">get_accessible</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-colormap">set_colormap</link></methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-events">get_events</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-pointer">get_pointer</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--is-ancestor">is_ancestor</link></methodname>
- <methodparam><parameter
- role="keyword">ancestor</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--translate-coordinates">translate_coordinates</link></methodname>
- <methodparam><parameter
- role="keyword">dest_widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--hide-on-delete">hide_on_delete</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-style">set_style</link></methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--ensure-style">ensure_style</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-style">get_style</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--modify-style">modify_style</link></methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-modifier-style">get_modifier_style</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--modify-fg">modify_fg</link></methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--modify-bg">modify_bg</link></methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--modify-text">modify_text</link></methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--modify-base">modify_base</link></methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--modify-font">modify_font</link></methodname>
- <methodparam><parameter
- role="keyword">font_desc</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--create-pango-context">create_pango_context</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-pango-context">get_pango_context</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--create-pango-layout">create_pango_layout</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--render-icon">render_icon</link></methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-composite-name">set_composite_name</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-composite-name">get_composite_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--reset-rc-styles">reset_rc_styles</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--style-get-property">style_get_property</link></methodname>
- <methodparam><parameter role="keyword">property_name</parameter></methodparam>
- </methodsynopsis>
-
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget- -style-get">style_get</link></methodname>
- <methodparam><parameter role="keyword">first_property_name</parameter></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
-
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-direction">set_direction</link></methodname>
- <methodparam><parameter role="keyword">dir</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-direction">get_direction</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--shape-combine-mask">shape_combine_mask</link></methodname>
- <methodparam><parameter
- role="keyword">shape_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--reset-shapes">reset_shapes</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--path">path</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--class-path">class_path</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--list-mnemonic-labels">list_mnemonic_labels</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--add-mnemonic-label">add_mnemonic_label</link></methodname>
- <methodparam><parameter>label</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--remove-mnemonic-label">remove_mnemonic_label</link></methodname>
- <methodparam><parameter>label</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--menu-get-for-attach-widget">menu_get_for_attach_widget</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-activate-signal">set_activate_signal</link></methodname>
- <methodparam><parameter
- role="keyword">signal_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--set-activate-signal">set_scroll_adjustments_signal</link></methodname>
- <methodparam><parameter
- role="keyword">signal_name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--get-action">get_action</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--drag-dest-set-track-motion">drag_dest_set_track_motion</link></methodname>
- <methodparam><parameter role="keyword">track_motion</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--drag-dest-get-track-motion">drag_dest_get_track_motion</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--is-composited">is_composited</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwidget--input-shape-combine-mask">input_shape_combine_mask</link></methodname>
- <methodparam><parameter role="keyword">shape_mask</parameter></methodparam>
- <methodparam><parameter role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter role="keyword">offset_y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwidget--get-activate-signal">get_activate_signal</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-push-colormap">gtk.widget_push_colormap</link></methodname>
- <methodparam><parameter role="keyword">cmap</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-push-composite-child">gtk.widget_push_composite_child</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-pop-composite-child">gtk.widget_pop_composite_child</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-pop-colormap">gtk.widget_pop_colormap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-get-default-style">gtk.widget_get_default_style</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-set-default-colormap">gtk.widget_set_default_colormap</link></methodname>
- <methodparam><parameter role="keyword">colormap</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-get-default-colormap">gtk.widget_get_default_colormap</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-get-default-visual">gtk.widget_get_default_visual</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-set-default-direction">gtk.widget_set_default_direction</link></methodname>
- <methodparam><parameter role="keyword">dir</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-get-default-direction">gtk.widget_get_default_direction</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-class-find-style-property">gtk.widget_class_find_style_property</link></methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- <methodparam><parameter role="keyword">property_name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-class-list-style-properties">gtk.widget_class_list_style_properties</link></methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--widget-class-install-style-property">gtk.widget_class_install_style_property</link></methodname>
- <methodparam><parameter role="keyword">widget</parameter></methodparam>
- <methodparam><parameter role="keyword">pspec</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkwidget">
- <title>gtk.Widget Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"app-paintable"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the application will paint
-directly on the widget</entry>
- </row>
-
- <row valign="top">
- <entry>"can-default"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the widget can be the
-default widget</entry>
- </row>
-
- <row valign="top">
- <entry>"can-focus"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the widget can accept the
-input focus</entry>
- </row>
-
- <row valign="top">
- <entry>"composite-child"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the widget is part of a
-composite widget</entry>
- </row>
-
- <row valign="top">
- <entry>"events"</entry>
- <entry>Read-Write</entry>
- <entry>The event mask that decides what kind of <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> this
-widget gets.</entry>
- </row>
-
- <row valign="top">
- <entry>"extension-events"</entry>
- <entry>Read-Write</entry>
- <entry>The mask that decides what kind of extension events
-this widget gets.</entry>
- </row>
-
- <row valign="top">
- <entry>"has-default"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the widget is the default
-widget</entry>
- </row>
-
- <row valign="top">
- <entry>"has-focus"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the widget has the input
-focus</entry>
- </row>
-
- <row valign="top">
- <entry>"height-request"</entry>
- <entry>Read-Write</entry>
- <entry>The height request of the widget, or -1 if natural
-request should be used.</entry>
- </row>
-
- <row valign="top">
- <entry>"is-focus"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the widget is the focus
-widget within the toplevel</entry>
- </row>
-
- <row valign="top">
- <entry>"name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the widget</entry>
- </row>
-
- <row valign="top">
- <entry>"no-show-all"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal> <link
-linkend="method-gtkwidget--show-all"><methodname>show_all</methodname>()</link>
-should not affect this widget. Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"parent"</entry>
- <entry>Read-Write</entry>
- <entry>The parent widget of this widget. Must be a <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
-widget.</entry>
- </row>
-
- <row valign="top">
- <entry>"receives-default"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the widget will receive the
-default action when it is focused.</entry>
- </row>
-
- <row valign="top">
- <entry>"sensitive"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the widget responds to
-input</entry>
- </row>
-
- <row valign="top">
- <entry>"style"</entry>
- <entry>Read-Write</entry>
- <entry>The style of the widget, which contains information
-about how it will look (colors etc).</entry>
- </row>
-
- <row valign="top">
- <entry>"visible"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the widget is
-visible</entry>
- </row>
-
- <row valign="top">
- <entry>"width-request"</entry>
- <entry>Read-Write</entry>
- <entry>The width request of the widget, or -1 if natural
-request should be used.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkwidget">
- <title>gtk.Widget Style Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"cursor-aspect-ratio"</entry>
- <entry>Read</entry>
- <entry>The aspect ratio with which to draw the insertion
-cursor</entry>
- </row>
-
- <row valign="top">
- <entry>"cursor-color"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> with
-which to draw insertion cursor</entry>
- </row>
-
- <row valign="top">
- <entry>"draw-border"</entry>
- <entry>Read</entry>
- <entry>The "draw-border" property defines the size of areas
- outside the widget's allocation to draw. This property is
- available in GTK+ 2.8 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"focus-line-pattern"</entry>
- <entry>Read-Write</entry>
- <entry>The dash pattern used to draw the focus
-indicator.</entry>
- </row>
-
- <row valign="top">
- <entry>"focus-line-width"</entry>
- <entry>Read-Write</entry>
- <entry>The width, in pixels, of the focus indicator
-line.</entry>
- </row>
-
- <row valign="top">
- <entry>"focus-padding"</entry>
- <entry>Read-Write</entry>
- <entry>The width, in pixels, between the focus indicator and
-the widget 'box'.</entry>
- </row>
-
- <row valign="top">
- <entry>"interior-focus"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal>, draw the focus indicator
-inside widgets.</entry>
- </row>
-
- <row valign="top">
- <entry>"link-color"</entry>
- <entry>Read</entry>
- <entry>The "link-color" property defines the color of
- unvisited links. This property is available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"scroll-arrow-hlength"</entry>
- <entry>Read</entry>
- <entry>The "scroll-arrow-hlength" property defines the length
- of horizontal scroll arrows. This property is available in
- GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"scroll-arrow-vlength"</entry>
- <entry>Read</entry>
- <entry>The "scroll-arrow-vlength" property defines the length
- of vertical scroll arrows. This property is available in GTK+
- 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"secondary-cursor-color"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> with
-which to draw the secondary insertion cursor when editing mixed
-right-to-left and left-to-right text.</entry>
- </row>
-
- <row valign="top">
- <entry>"separator-height"</entry>
- <entry>Read</entry>
- <entry>The "separator-height" property defines the height of
- separators. This property only takes effect if
- "wide-separators" is <literal>True</literal>. This property
- is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"separator-width"</entry>
- <entry>Read</entry>
- <entry>The "separator-width" property defines the width of
- separators. This property only takes effect if
- "wide-separators" is <literal>True</literal>. This property
- is available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"visited-link-color"</entry>
- <entry>Read</entry>
- <entry>The "visited-link-color" property defines the color of
- visited links. This property is available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"wide-separators"</entry>
- <entry>Read</entry>
- <entry>The "wide-separators" property defines whether
- separators have configurable width and should be drawn using a
- box instead of a line. This property is available in GTK+
- 2.10 and above.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"allocation"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-specifying the widget's space allocation. This attribute is writeable in
-PyGTK 2.4.</entry>
- </row>
-
- <row valign="top">
- <entry>"name"</entry>
- <entry>Read</entry>
- <entry>The name of the widget</entry>
- </row>
-
- <row valign="top">
- <entry>"parent"</entry>
- <entry>Read</entry>
- <entry>The parent widget of this widget. Must be a <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
-widget.</entry>
- </row>
-
- <row valign="top">
- <entry>"saved_state"</entry>
- <entry>Read</entry>
- <entry>The widget's saved state.</entry>
- </row>
-
- <row valign="top">
- <entry>"state"</entry>
- <entry>Read</entry>
- <entry>The widget state: <literal>gtk.STATE_NORMAL</literal>,
-<literal>gtk.STATE_ACTIVE</literal>, <literal>gtk.STATE_PRELIGHT</literal>,
-<literal>gtk.STATE_SELECTED</literal> or
-<literal>gtk.STATE_INSENSITIVE</literal></entry>
- </row>
- <row valign="top">
- <entry>"style"</entry>
- <entry>Read</entry>
- <entry>The style of the widget.</entry>
- </row>
-
- <row valign="top">
- <entry>"window"</entry>
- <entry>Read-Write</entry>
- <entry>The <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> used
-by the widget. This attribute is writeable in PyGTK 2.4.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkwidget">
- <title>gtk.Widget Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--accel-closures-changed">accel-closures-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--button-press-event">button-press-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--button-release-event">button-release-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>signal_id</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--can-activate-accel">can-activate-accel</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--child-notify">child-notify</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>child_property</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--composited-changed">composited-changed</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--client-event">client-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--configure-event">configure-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--delete-event">delete-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--destroy-event">destroy-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--direction-changed">direction-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>direction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--drag-begin">drag-begin</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--drag-data-delete">drag-data-delete</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--drag-data-get">drag-data-get</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>selection_data</parameter></methodparam>
- <methodparam><parameter>info</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--drag-data-received">drag-data-received</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>x</parameter></methodparam>
- <methodparam><parameter>y</parameter></methodparam>
- <methodparam><parameter>selection_data</parameter></methodparam>
- <methodparam><parameter>info</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--drag-drop">drag-drop</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>x</parameter></methodparam>
- <methodparam><parameter>y</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--drag-end">drag-end</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--drag-leave">drag-leave</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--drag-motion">drag-motion</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>x</parameter></methodparam>
- <methodparam><parameter>y</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--enter-notify-event">enter-notify-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--event">event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--event-after">event-after</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--expose-event">expose-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--focus">focus</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>direction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--focus-in-event">focus-in-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--focus-out-event">focus-out-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--grab-broken-event">grab-broken-event</link></term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--grab-focus">grab-focus</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--grab-notify">grab-notify</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>was_grabbed</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--hide">hide</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--hierarchy-changed">hierarchy-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>previous_toplevel</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--key-press-event">key-press-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--key-release-event">key-release-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--leave-notify-event">leave-notify-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--map">map</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--map-event">map-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--mnemonic-activate">mnemonic-activate</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>group_cycling</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--motion-notify-event">motion-notify-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--no-expose-event">no-expose-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--parent-set">parent-set</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>old_parent</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--popup-menu">popup-menu</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--property-notify-event">property-notify-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--proximity-in-event">proximity-in-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--proximity-out-event">proximity-out-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--realize">realize</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--screen-changed">screen-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>screen</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--scroll-event">scroll-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--selection-clear-event">selection-clear-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--selection-get">selection-get</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>selection_data</parameter></methodparam>
- <methodparam><parameter>info</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--selection-notify-event">selection-notify-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--selection-received">selection-received</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>selection_data</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--selection-request-event">selection-request-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--show">show</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--show-help">show-help</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>help_type</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--size-allocate">size-allocate</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>allocation</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--size-request">size-request</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>requisition</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--state-changed">state-changed</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>state</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--style-set">style-set</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>previous_style</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--unmap">unmap</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--unmap-event">unmap-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--unrealize">unrealize</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--visibility-notify-event">visibility-notify-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link linkend="signal-gtkwidget--window-state-event">window-state-event</link>"</term>
- <listitem>
- <methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> class is
-the base class for all <literal>PyGTK</literal> widgets. It provides the common set of method and signals for the widgets including:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>drag and drop setting and management methods</simpara>
- </listitem>
- <listitem>
- <simpara>selection methods</simpara>
- </listitem>
- <listitem>
- <simpara>methods to realize, map and show widgets</simpara>
- </listitem>
- <listitem>
- <simpara>methods to manage size allocation and requests</simpara>
- </listitem>
- <listitem>
- <simpara>methods to initiate widget redrawing</simpara>
- </listitem>
- <listitem>
- <simpara>methods to deal with the widget's place in the widget hierarchy</simpara>
- </listitem>
- <listitem>
- <simpara>event management methods</simpara>
- </listitem>
- <listitem>
- <simpara>methods to modify the style settings</simpara>
- </listitem>
- <listitem>
- <simpara>methods to access the default resources</simpara>
- </listitem>
- </itemizedlist>
-
- <para id="widget-style-properties"><link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-introduces style properties - these are basically object properties that are
-stored not on the object, but in the style object associated to the
-widget. Style properties are set in resource files. This mechanism is used
-for configuring such things as the location of the scrollbar arrows through
-the theme, giving theme authors more control over the look of applications
-without the need to write a theme engine in C.</para>
-
- <para>Use the <link
- linkend="function-gtk--widget-class-install-style-property"><function>gtk.widget_class_install_style_property</function>()</link>
- function to install style properties for a widget class, the <link
- linkend="function-gtk--widget-class-find-style-property"><function>gtk.widget_class_find_style_property</function>()</link>
- function or the <link
- linkend="function-gtk--widget-class-list-style-properties"><function>gtk.widget_class_list_style_properties</function>()</link>
- function to get information about existing style properties and the
- <link
- linkend="method-gtkwidget--style-get-property"><methodname>style_get_property</methodname>()</link>
- method to obtain the value of a style property.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkwidget--get-allocation">
- <title>gtk.Widget.get_allocation</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_allocation</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_allocation</methodname>() method returns a
-<link linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link> containing the bounds of the widget's allocation.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-check-threshold">
- <title>gtk.Widget.drag_check_threshold</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_check_threshold</methodname>
- <methodparam><parameter
- role="keyword">start_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">current_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">current_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of start of
-drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">start_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of start of
-drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">current_x</parameter>&nbsp;:</term>
- <listitem><simpara>the current X coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">current_y</parameter>&nbsp;:</term>
- <listitem><simpara>the current Y coordinate</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the drag threshold
-has been passed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The check_drag_threshold() method checks to see if a mouse drag
-starting at (<parameter>start_x</parameter>, <parameter>start_y</parameter>)
-and ending at (<parameter>current_x</parameter>,
-<parameter>current_y</parameter>) has passed the+ drag threshhold distance,
-and thus should trigger the beginning of a drag-and-drop operation.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-get-data">
- <title>gtk.Widget.drag_get_data</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_get_data</methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- <methodparam><parameter role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">context</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>an atom</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>a timestamp or 0L to specify the current
-time</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_get_data</methodname>() method gets the
-data associated with a drag specified by <parameter>drag_context</parameter>
-and <parameter>target</parameter>. When the data is received or the
-retrieval fails, a "drag_data_received" signal will be emitted. Failure of
-the retrieval is indicated by the length field of the <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-being negative. However, when the <methodname>drag_get_data</methodname>()
-method is called implicitly because <literal>gtk.DRAG_DEFAULT_DROP</literal>
-was set, the widget will not receive notification of failed drops.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-highlight">
- <title>gtk.Widget.drag_highlight</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_highlight</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>drag_highlight</methodname>() method draws a
-highlight around a widget. This will attach handlers to "expose_event" and
-"draw", so the highlight will continue to be displayed until the <link
-linkend="method-gtkwidget--drag-unhighlight"><methodname>drag_unhighlight</methodname>()</link>
-method is called.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-unhighlight">
- <title>gtk.Widget.drag_unhighlight</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_unhighlight</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>drag_unhighlight</methodname>() method removes
-the highlight that was set by the <link
-linkend="method-gtkwidget--drag-highlight"><methodname>drag_highlight</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-dest-set">
- <title>gtk.Widget.drag_dest_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_dest_set</methodname>
- <methodparam><parameter
- role="keyword">flags</parameter></methodparam>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">actions</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">flags</parameter>&nbsp;:</term>
- <listitem><simpara>the flags that specify what actions should be
-taken on behalf of a widget for drops onto that widget. The targets and
-actions fields only are used if <literal>gtk.DEST_DEFAULT_MOTION</literal>
-or <literal>gtk.DEST_DEFAULT_DROP</literal> are given.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of target
-tuples</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">actions</parameter>&nbsp;:</term>
- <listitem><simpara>a bitmask of possible actions for a drop onto
-this widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_dest_set</methodname>() method sets up a
-widget as a potential drag drop destination. The value of
-<parameter>flags</parameter> is a combination of the <xref
-linkend="gtk-dest-defaults-constants"
-endterm="gtk-dest-defaults-constants-title"></xref>.</para>
-
- <para><parameter>targets</parameter> is a sequence (list or tuple) of
-3-tuples that contain information about the targets. The target data contains
-a string representing the drag type, target flags (a combination of
-<literal>gtk.TARGET_SAME_APP</literal> and
-<literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an application
-assigned integer ID used for identification purposes.</para>
-
- <para>The value of <parameter>actions</parameter> is one of the <xref
-linkend="gdk-drag-action-constants"
-endterm="gdk-drag-action-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-dest-set-proxy">
- <title>gtk.Widget.drag_dest_set_proxy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_dest_set_proxy</methodname>
- <methodparam><parameter
- role="keyword">proxy_window</parameter></methodparam>
- <methodparam><parameter
- role="keyword">protocol</parameter></methodparam>
- <methodparam><parameter
- role="keyword">use_coordinates</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">proxy_window</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> to
-forward drag events to</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">protocol</parameter>&nbsp;:</term>
- <listitem><simpara>the drag protocol that
-<parameter>proxy_window</parameter> accepts</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">use_coordinates</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, send the same
-coordinates to the destination, because it is an embedded
-subwindow.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_dest_set_proxy</methodname>() method sets a
-proxy <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-specified by <parameter>proxy_window</parameter> that drag events are
-forwarded to on behalf of the widget. The value of
-<parameter>protocol</parameter> is one of the <xref
-linkend="gdk-drag-protocol-constants"
-endterm="gdk-drag-protocol-constants-title"></xref>.</para>
-
- <para>If <parameter>use_coordinates</parameter> is
-<literal>True</literal>, the same coordinates are sent to the destination
-because the widget's an embedded subwindow.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-dest-unset">
- <title>gtk.Widget.drag_dest_unset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_dest_unset</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>drag_dest_unset</methodname>() method clears the
-information about a drop destination set with the <link
-linkend="method-gtkwidget--drag-dest-set"><methodname>drag_dest_set</methodname>()</link>
-method. The widget will no longer receive notification of drags.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-dest-find-target">
- <title>gtk.Widget.drag_dest_find_target</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_dest_find_target</methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target_list</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">context</parameter>&nbsp;:</term>
- <listitem><simpara>the drag context</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">target_list</parameter>&nbsp;:</term>
- <listitem><simpara>a list of droppable targets, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the first target that the source offers and the
-dest can accept, or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>dest_find_target</methodname>() method looks for
-a match between the targets in the <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link>
-specified by <parameter>context</parameter> and the
-<parameter>target_list</parameter>, returning the first matching target, or
-<literal>NONE</literal> if no match is found. The list specified by
-<parameter>target_list</parameter> should usually be the return value from
-the <link
-linkend="method-gtkwidget--drag-dest-get-target-list"><methodname>drag_dest_get_target_list</methodname>()</link>
-method, but some widgets may have different valid targets for different
-parts of the widget; in that case, they will have to implement a
-"drag-motion" handler that passes the correct target list to this method.
-<parameter>target_list</parameter> is a sequence (list or tuple) of 3-tuples
-that contain information about the targets. The target data contains a
-string representing the drag type, target flags (a combination of
-<literal>gtk.TARGET_SAME_APP</literal> and
-<literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an application
-assigned integer ID used for identification purposes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-dest-get-target-list">
- <title>gtk.Widget.drag_dest_get_target_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_dest_get_target_list</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the list of targets or <literal>None</literal>
-if no targets are set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_dest_get_target_list</methodname>() method
-returns the list of targets this widget can accept from drag-and-drop. The
-returned value is a sequence (list or tuple) of 3-tuples that contain
-information about the targets. The target data contains a string
-representing the drag type, target flags (a combination of
-<literal>gtk.TARGET_SAME_APP</literal> and
-<literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an application
-assigned integer ID used for identification purposes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-dest-set-target-list">
- <title>gtk.Widget.drag_dest_set_target_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_dest_set_target_list</methodname>
- <methodparam><parameter
- role="keyword">target_list</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">target_list</parameter>&nbsp;:</term>
- <listitem><simpara>a list of droppable targets, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_dest_set_target_list</methodname>() method
-sets the target types (that this widget can accept from drag-and-drop) to
-the list specified by <parameter>target_list</parameter>. The widget must
-first be made into a drag destination with the <link
-linkend="method-gtkwidget--drag-dest-set"><methodname>drag_dest_set()</methodname></link>
-method. <parameter>target_list</parameter> is a sequence (list or tuple) of
-3-tuples that contain information about the targets. The target data contains
-a string representing the drag type, target flags (a combination of
-<literal>gtk.TARGET_SAME_APP</literal> and
-<literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an application
-assigned integer ID used for identification purposes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-dest-add-image-targets">
- <title>gtk.Widget.drag_dest_add_image_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_dest_add_image_targets</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>drag_dest_add_image_targets</methodname>()
-method adds the image targets supported by <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-to the target list of the widget's drag destination using an info value of
-0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-dest-add-text-targets">
- <title>gtk.Widget.drag_dest_add_text_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_dest_add_text_targets</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>drag_dest_add_text_targets</methodname>() method
-adds the text targets supported by <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-to the target list of the widget's drag destination using an info value of
-0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-dest-add-uri-targets">
- <title>gtk.Widget.drag_dest_add_uri_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_dest_add_uri_targets</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>drag_dest_add_uri_targets</methodname>() method adds the URI targets supported by <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-to the target list of the widget's drag destination using an info value of
-0.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-source-set">
- <title>gtk.Widget.drag_source_set</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>drag_source_set</methodname>
- <methodparam><parameter role="keyword">start_button_mask</parameter></methodparam>
- <methodparam><parameter role="keyword">targets</parameter></methodparam>
- <methodparam><parameter role="keyword">actions</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start_button_mask</parameter>&nbsp;:</term>
- <listitem><simpara>the bitmask of buttons that can start the drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a list of targets that the drag will support</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">actions</parameter>&nbsp;:</term>
- <listitem><simpara>the possible actions for a drag from this widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_source_set</methodname>() method sets up
-the widget to start a drag operation when the user clicks and drags on the
-widget. The widget must have a window. The value of start_button_mask is a
-combination of the <xref linkend="gdk-modifier-constants"
-endterm="gdk-modifier-constants-title"></xref>.</para>
-
- <para><parameter>targets</parameter> is a sequence (list or tuple) of
-3-tuples that contain information about the targets. The target data contains
-a string representing the drag type, target flags (a combination of
-<literal>gtk.TARGET_SAME_APP</literal> and
-<literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an application
-assigned integer ID used for identification purposes.</para>
-
- <para>The value of <parameter>actions</parameter> is one of the <xref
-linkend="gdk-drag-action-constants"
-endterm="gdk-drag-action-constants-title"></xref>:</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-source-unset">
- <title>gtk.Widget.drag_source_unset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_source_unset</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>drag_source_unset</methodname>() method unsets
-the drag source for the widget that was set up by the <link
-linkend="method-gtkwidget--drag-source-set"><methodname>drag_source_set</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-source-set-icon">
- <title>gtk.Widget.drag_source_set_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_source_set_icon</methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- <methodparam><parameter
- role="keyword">pixmap</parameter></methodparam>
- <methodparam><parameter role="keyword">mask</parameter>
- <initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
- <listitem><simpara>the colormap of the icon</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pixmap</parameter>&nbsp;:</term>
- <listitem><simpara>the image data for the
-icon</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">mask</parameter>&nbsp;:</term>
- <listitem><simpara>the transparency mask for an
-image.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_source_set_icon</methodname>() method sets
-the icon that will be used for drags from the widget using the specified
-<parameter>pixmap</parameter> and <parameter>mask</parameter>.
-<parameter>colormap</parameter> specifies the colormap to be used to create
-the icon. The <link
-linkend="method-gtkwidget--drag-source-set-icon-pixbuf"><methodname>drag_source_set_icon_pixbuf</methodname>()</link>
-method should be used instead of this method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-source-set-icon-pixbuf">
- <title>gtk.Widget.drag_source_set_icon_pixbuf</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_source_set_icon_pixbuf</methodname>
- <methodparam><parameter
- role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">pixbuf</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> for
-the drag icon</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_source_set_icon_pixbuf</methodname>()
-method sets the icon that will be used for drags from the widget from the
-<link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-specified by <parameter>pixbuf</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-source-set-icon-stock">
- <title>gtk.Widget.drag_source_set_icon_stock</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_source_set_icon_stock</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>the ID of the stock icon to
-use</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_source_set_icon_stock</methodname>() method
-sets the icon that will be used for drags from a particular source using the
-stock icon specified by <parameter>stock_id</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-source-set-icon-name">
- <title>gtk.Widget.drag_source_set_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_source_set_icon_name</methodname>
- <methodparam><parameter
- role="keyword">icon_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a themed icon
-use</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>drag_source_set_icon_name</methodname>() method
-sets the icon that will be used for drags from a particular source using the
-themed icon specified by <parameter>icon_name</parameter>. See the <link
-linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>
-docs for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-source-get-target-list">
- <title>gtk.Widget.drag_source_get_target_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_source_get_target_list</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the list of targets or <literal>None</literal>
-if no targets are set</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>drag_source_get_target_list</methodname>() method
-returns the list of targets this widget can provide for drag-and-drop. The
-returned value is a sequence (list or tuple) of 3-tuples that contain
-information about the targets. The target data contains a string
-representing the drag type, target flags (a combination of
-<literal>gtk.TARGET_SAME_APP</literal> and
-<literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an application
-assigned integer ID used for identification purposes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-source-set-target-list">
- <title>gtk.Widget.drag_source_set_target_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_source_set_target_list</methodname>
- <methodparam><parameter
- role="keyword">target_list</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">target_list</parameter>&nbsp;:</term>
- <listitem><simpara>a list of droppable targets, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>drag_source_set_target_list</methodname>()
-method sets the target types (that this widget can provide for
-drag-and-drop) to the list specified by
-<parameter>target_list</parameter>. The widget must first be made into a
-drag source with the <link
-linkend="method-gtkwidget--drag-source-set"><methodname>drag_source_set()</methodname></link>
-method. <parameter>target_list</parameter> is a sequence (list or tuple) of
-3-tuples that contain information about the targets. The target data
-contains a string representing the drag type, target flags (a combination of
-<literal>gtk.TARGET_SAME_APP</literal> and
-<literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an application
-assigned integer ID used for identification purposes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-source-add-text-targets">
- <title>gtk.Widget.drag_source_add_text_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_source_add_text_targets</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>drag_source_add_text_targets</methodname>()
-method adds the text targets supported by <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-to the target list of the widget's drag source using an info value of 0. If
-you need another value for info, use the <link
-linkend="function-gtk--target-list-add-text-targets"><function>gtk.target_list_add_text_targets</function>()</link>
-function and the <link
-linkend="method-gtkwidget--drag-source-set-target-list"><methodname>drag_source_set_target_list</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-source-add-image-targets">
- <title>gtk.Widget.drag_source_add_image_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_source_add_image_targets</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>drag_source_add_image_targets</methodname>()
-method adds the image targets supported by <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-to the target list of the widget's drag source using an info value of 0. If
-you need another value for info, use the <link
-linkend="function-gtk--target-list-add-image-targets"><function>gtk.target_list_add_image_targets</function>()</link>
-function and the <link
-linkend="method-gtkwidget--drag-source-set-target-list"><methodname>drag_source_set_target_list</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-source-add-uri-targets">
- <title>gtk.Widget.drag_source_add_uri_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_source_add_uri_targets</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>drag_source_add_uri_targets</methodname>()
-method adds the URI targets supported by <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-to the target list of the widget's drag source using an info value of 0. If
-you need another value for info, use the <link
-linkend="function-gtk--target-list-add-image-targets"><function>gtk.target_list_add_image_targets</function>()</link> function
-and the <link
-linkend="method-gtkwidget--drag-source-set-target-list"><methodname>drag_source_set_target_list</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-begin">
- <title>gtk.Widget.drag_begin</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_begin</methodname>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- <methodparam><parameter
- role="keyword">actions</parameter></methodparam>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>the list of targets supported by the widget
-drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">actions</parameter>&nbsp;:</term>
- <listitem><simpara>the allowed drag operations for the
-drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">button</parameter>&nbsp;:</term>
- <listitem><simpara>the button the user pressed to start the
-drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> that
-triggered the drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>drag_begin</methodname>() method starts a drag
-on the source side. The method only needs to be used when the application is
-starting drags itself, and is not needed when the <link
-linkend="method-gtkwidget--drag-source-set"><methodname>drag_source_set</methodname>()</link>
-method is used. <parameter>targets</parameter> is a sequence (list or tuple)
-of 3-tuples that contain information about the targets. The target data
-contains a string representing the drag type, target flags (a combination of
-<literal>gtk.TARGET_SAME_APP</literal> and
-<literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an application
-assigned integer ID used for identification purposes.</para>
-
- <para>The value of <parameter>actions</parameter> is one of the <xref
-linkend="gdk-drag-action-constants"
-endterm="gdk-drag-action-constants-title"></xref>.</para>
-
- <para><parameter>button</parameter> is the button that the user
-pressed to start the drag operation. <parameter>event</parameter> is the
-<link linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link>
-that triggered the start of the drag operation (the button press). This
-method returns the <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link>
-for the drag operation.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--grab-add">
- <title>gtk.Widget.grab_add</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>grab_add</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>grab_add</methodname>() method makes the widget
-the current grabbed widget. This means that interaction with other widgets
-in the same application is blocked and mouse as well as keyboard events are
-delivered to this widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--grab-remove">
- <title>gtk.Widget.grab_remove</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>grab_remove</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>grab_remove</methodname>() method removes the
-grab from the widget. You have to pair calls to the <link
-linkend="method-gtkwidget--grab-add"><methodname>grab_add</methodname>()</link>
-and <methodname>grab_remove</methodname>() methods.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--rc-get-style">
- <title>gtk.Widget.rc_get_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>rc_get_style</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the resulting style.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>rc_get_style</methodname>() method finds all
-matching RC styles for the widget, composites them together, and then
-creates a <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link>
-representing the composite appearance.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--selection-owner-set">
- <title>gtk.Widget.selection_owner_set</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>selection_owner_set</methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>an atom representing the selection to
-claim</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>a timestamp or 0L to use the current
-time</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-successful</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>selection_owner_set</methodname>() method claims
-the ownership of the selection specified by <parameter>selection</parameter>
-for the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--selection-add-target">
- <title>gtk.Widget.selection_add_target</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>selection_add_target</methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- <methodparam><parameter
- role="keyword">info</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>an atom representing the
-selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>an atom representing the target for the
-selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">info</parameter>&nbsp;:</term>
- <listitem><simpara>an integer ID that will be passed to the
-application</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>selection_add_target</methodname>() method adds
-the specified <parameter>target</parameter> to the list of supported targets
-for the specified <parameter>selection</parameter>.
-<parameter>info</parameter> is an integer ID that will be passed to the
-application when the "selection-get" handler is called.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--selection-add-targets">
- <title>gtk.Widget.selection_add_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>selection_add_targets</methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">targets</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>an atom representing the
-selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">targets</parameter>&nbsp;:</term>
- <listitem><simpara>a sequence of 3-tuples containing target
-data</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>selection_add_targets</methodname>() method adds
-the list of targets (specified by <parameter>targets</parameter>) to the
-list of supported targets for the specified
-<parameter>selection</parameter>. targets is a sequence (Python tuple or
-list) of 3-tuples that contain information about the targets. The target data
-contains a string representing the drag type, target flags (a combination of
-<literal>gtk.TARGET_SAME_APP</literal> and
-<literal>gtk.TARGET_SAME_WIDGET</literal> or neither) and an application
-assigned integer ID used for identification purposes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--selection-clear-targets">
- <title>gtk.Widget.selection_clear_targets</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>selection_clear_targets</methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>an atom representing a
-selection</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>selection_clear_targets</methodname>() method
-remove all targets registered for the specified
-<parameter>selection</parameter> for the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--selection-convert">
- <title>gtk.Widget.selection_convert</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>selection_convert</methodname>
- <methodparam><parameter
- role="keyword">selection</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- <methodparam><parameter
- role="keyword">time</parameter>
- <initializer>0L</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>an atom specifying the
-selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>an atom specifying the target
-type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">time</parameter>&nbsp;:</term>
- <listitem><simpara>a timestamp for the request or 0L to use the
-current time</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the request
-succeeded</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>selection_convert</methodname>() method requests
-the contents of the specified <parameter>selection</parameter> for the
-specified <parameter>target</parameter> type. When received, a
-"selection_received" signal will be generated.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--selection-remove-all">
- <title>gtk.Widget.selection_remove_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>selection_remove_all</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>selection_remove_all</methodname>() method
-removes all handlers and unsets ownership of all selections for a widget.
-This method is called when widget is being destroyed and not usually by
-applications.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--destroy">
- <title>gtk.Widget.destroy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>destroy</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>destroy</methodname>() method destroys the
-widget. When a widget is destroyed, it will break any references it holds to
-other objects. If the widget is inside a container, the widget will be
-removed from the container. If the widget is a toplevel (derived from <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>), it will
-be removed from the list of toplevels, and the reference
-<literal>PyGTK</literal> holds to it will be removed. Removing a widget from
-its container or the list of toplevels results in the widget being
-finalized. In most cases, only toplevel widgets (windows) require explicit
-destruction, because when you destroy a toplevel its children will be
-destroyed as well.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--unparent">
- <title>gtk.Widget.unparent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unparent</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>unparent</methodname>() method is only for use
-in widget implementations. It should be called by implementations of the
-remove method on a <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>, to
-dissociate a child widget from the container.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--show">
- <title>gtk.Widget.show</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>show</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>show</methodname>() method causes a widget to be
-displayed as soon as practical. Any widget that isn't shown will not appear
-on the screen. If you want to show all the widgets in a container, it's
-easier to call the <link
-linkend="method-gtkwidget--show-all"><methodname>show_all</methodname>()</link>
-on the container, instead of individually showing the widgets. Of course you
-have to show the containers containing a widget, as well as the widget
-itself, before it will appear onscreen. When a toplevel container is shown,
-it is immediately realized and mapped; other shown widgets are realized and
-mapped when their toplevel container is realized and mapped.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--show-now">
- <title>gtk.Widget.show_now</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>show_now</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>show_now</methodname>() method is the same as
-the <link
-linkend="method-gtkwidget--show"><methodname>show</methodname>()</link>
-method except if the widget is an unmapped toplevel widget (i.e. a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> that has
-not yet been shown), it enters the main loop and waits for the window to
-actually be mapped.</para>
- <note>
- <para>Because the main loop is running, anything can happen during
-this method.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--hide">
- <title>gtk.Widget.hide</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>hide</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>hide</methodname>() method reverses the effects
-of the <link
-linkend="method-gtkwidget--show"><methodname>show</methodname>()</link>
-method, causing the widget to be hidden (removed from the display) by
-unmapping it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--show-all">
- <title>gtk.Widget.show_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>show_all</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>show_all</methodname>() method recursively shows
-the widget, and any child widgets (if the widget is a container).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--hide-all">
- <title>gtk.Widget.hide_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>hide_all</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>hide_all</methodname>() method recursively hides
-the widget and its child widgets (if any).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-no-show-all">
- <title>gtk.Widget.set_no_show_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_no_show_all</methodname>
- <methodparam><parameter>no_show_all</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>no_show_all</parameter>&nbsp;:</term>
- <listitem><simpara>the new value for the "no_show_all"
- property</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_no_show_all</methodname>() method sets the
-"no_show_all" property to the value of
-<parameter>no_show_all</parameter>. If <parameter>no_show_all</parameter> is
-<literal>True</literal> calls to the <link
-linkend="method-gtkwidget--show-all"><methodname>show_all()</methodname></link>
-and <link
-linkend="method-gtkwidget--hide-all"><methodname>hide_all()</methodname></link>
-methods will not affect this widget.</para>
-
- <para>This method is mostly for use in constructing widget hierarchies
-with externally controlled visibility, see the <link
-linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>
-reference for mote information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-no-show-all">
- <title>gtk.Widget.get_no_show_all</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_no_show_all</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current value of the "no_show_all"
- property.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_no_show_all</methodname>() method returns
-the current value of the "no_show_all" property. If "no-show-all" is
-<literal>True</literal> calls to the <link
-linkend="method-gtkwidget--show-all"><methodname>show_all()</methodname></link>
-and <link
-linkend="method-gtkwidget--hide-all"><methodname>hide_all()</methodname></link>
-methods will not affect the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--map">
- <title>gtk.Widget.map</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>map</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>map</methodname>() method maps the widget
-(causes it to be displayed). This method will also cause the widget to be
-realized if it is not currently realized. This method is usually not used by
-applications.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--unmap">
- <title>gtk.Widget.unmap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unmap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>unmap</methodname>() method unmaps the widget
-(causes it to be removed from the display). This method is not usually used
-by applications.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--realize">
- <title>gtk.Widget.realize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>realize</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>realize</methodname>() method creates the
-resources associated with a widget. For example, the widget <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> will
-be created when the widget is realized. Normally realization happens
-implicitly; if you show a widget and all its parent containers, then the
-widget will be realized and mapped automatically. Realizing a widget
-requires all the widget's parent widgets to be realized; calling the
-<methodname>realize</methodname>() method realizes the widget's parents in
-addition to the widget itself. A widget must be inside a toplevel window
-when you realize it. This method is primarily used in widget
-implementations, and not in applications. Many times when you think you
-might need it, a better approach is to connect to a signal that will be
-called after the widget is realized automatically, such as "expose_event".
-Or simply using the <link
-linkend="method-gobject--connect-after"><methodname>gobject.connect_after</methodname>()</link>
-method to add a handler to the "realize" signal.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--unrealize">
- <title>gtk.Widget.unrealize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unrealize</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>unrealize</methodname>() method frees all
-resources associated with the widget, such as the <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--queue-draw">
- <title>gtk.Widget.queue_draw</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>queue_draw</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>queue_draw</methodname>() method is equivalent
-to calling the <link
-linkend="method-gtkwidget--queue-draw-area"><methodname>queue_draw_area</methodname>()</link>
-method for the entire area of a widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--queue-draw-area">
- <title>gtk.Widget.queue_draw_area</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>queue_draw_area</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x coordinate of upper-left corner of
-rectangle to redraw</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y coordinate of upper-left corner of
-rectangle to redraw</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of rectangle to
-redraw</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of rectangle to
-redraw</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>queue_draw_area</methodname>() method
-invalidates the rectangular area of the widget specified by
-<parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter> by calling
-the <link
-linkend="method-gdkwindow--invalidate-rect"><methodname>gtk.gdk.Window.invalidate_rect</methodname>()</link>
-method on the widget's window and all its child windows. Once the main loop
-becomes idle (after the current batch of events has been processed,
-roughly), the window will receive expose events for the union of all regions
-that have been invalidated.</para>
-
- <para>Normally you would only use this method in widget
-implementations. But you might also use it, or the <link
-linkend="method-gdkwindow--invalidate-rect"><methodname>gtk.gdk.Window.invalidate_rect</methodname>()</link>
-method directly, to schedule a redraw of a <link
-linkend="class-gtkdrawingarea"><classname>gtk.DrawingArea</classname></link>
-or some portion thereof. Frequently you can just call the <link
-linkend="method-gdkwindow--invalidate-rect"><methodname>gtk.gdk.Window.invalidate_rect</methodname>()</link>
-method instead of this method. This method will invalidate only a single
-window, instead of the widget and all its children. The advantage of adding
-to the invalidated region compared to simply drawing immediately is
-efficiency; using an invalid region ensures that you only have to redraw one
-time.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--queue-resize">
- <title>gtk.Widget.queue_resize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>queue_resize</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>queue_resize</methodname>() method schedules the
-widget to have its size renegotiated. This method should be called when a
-widget for some reason has a new size request. For example, when you change
-the text in a <link
-linkend="class-gtklabel"><classname>gtk.Label</classname></link>, a resize
-is queued to ensure there's enough space for the new text.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--queue-resize-no-redraw">
- <title>gtk.Widget.queue_resize_no_redraw</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>queue_resize_no_redraw</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>queue_resize_no_redraw</methodname>() method
-works like the <link
-linkend="method-gtkwidget--queue-resize"><methodname>queue_resize()</methodname></link>
-method, except that the widget is not invalidated.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--size-request">
- <title>gtk.Widget.size_request</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>size_request</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the widget's required width
-and height.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
-
- <para>The <methodname>size_request</methodname>() method returns the
-preferred size of a widget as a tuple containing its required width and
-height. This method is typically used when implementing a <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
-subclass to arrange the container's child widgets and decide what size
-allocations to give them with the <link
-linkend="method-gtkwidget--size-allocate"><methodname>size_allocate</methodname>()</link>
-method. Obtaining a size request requires that the widget be associated with
-a screen, because font information may be needed.</para>
-
- <para>Also remember that the size request is not necessarily the size
-a widget will actually be allocated. See the <link
-linkend="method-gtkwidget--get-child-requisition"><methodname>get_child_requisition</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--size-allocate">
- <title>gtk.Widget.size_allocate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>size_allocate</methodname>
- <methodparam><parameter
- role="keyword">allocation</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">allocation</parameter>&nbsp;:</term>
- <listitem><simpara>the position and size to be allocated to the
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>size_allocate</methodname>() method sets a size
-allocation for the widget using the <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
-specified by <parameter>allocation</parameter>. This method is only used by
-<link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
-subclasses, to assign a size and position to their child widgets.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-child-requisition">
- <title>gtk.Widget.get_child_requisition</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_child_requisition</methodname>
- <methodparam><parameter
- role="keyword">requisition</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the required size of the
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_child_requisition</methodname>() method
-returns a tuple containing the widget requisition width and height. This
-method is only for use in widget container implementations since it obtains
-the widget requisition directly. By comparison the <link
-linkend="method-gtkwidget--size-request"><methodname>size_request</methodname>()</link>
-method actually computes the size request and fills in the widget
-requisition before returning. Because this method does not recalculate the
-size request, it can only be used when you know that the widget requisition
-is up-to-date, i.e. the <link
-linkend="method-gtkwidget--size-request"><methodname>size_request</methodname>()</link>
-method has been called since the last time a resize was queued. In general,
-only container implementations have this information; applications should
-use the <link
-linkend="method-gtkwidget--size-request"><methodname>size_request</methodname>()</link>
-method instead.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--add-accelerator">
- <title>gtk.Widget.add_accelerator</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_accelerator</methodname>
- <methodparam><parameter
- role="keyword">accel_signal</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_mods</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_flags</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_signal</parameter>&nbsp;:</term>
- <listitem><simpara>the widget signal to emit on accelerator
-activation</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_group</parameter>&nbsp;:</term>
- <listitem><simpara>the accel group for this widget, added to its
-toplevel</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_key</parameter>&nbsp;:</term>
- <listitem><simpara>the keyval of the accelerator e.g.
-<literal>ord('q')</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_mods</parameter>&nbsp;:</term>
- <listitem><simpara>the modifier key combination of the
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_flags</parameter>&nbsp;:</term>
- <listitem><simpara>the flag accelerators, e.g.
-<literal>gtk.ACCEL_VISIBLE</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_accelerator</methodname>() method installs
- an accelerator for the widget in <parameter>accel_group</parameter>
- that causes <parameter>accel_signal</parameter> to be emitted if the
- accelerator is activated. The accelerator key and modifiers are
- specified by <parameter>accel_key</parameter> and
- <parameter>accel_mods</parameter>
- respectively. <parameter>accel_mods</parameter> should be a
- combination of the <xref linkend="gdk-modifier-constants"
- endterm="gdk-modifier-constants-title"></xref>. <parameter>accel_flags</parameter>
- is a combination of <literal>gtk.ACCEL_VISIBLE</literal> and
- <literal>gtk.ACCEL_LOCKED</literal> (see the <xref
- linkend="gtk-accel-flags-constants"
- endterm="gtk-accel-flags-constants-title"></xref>). The
- <parameter>accel_group</parameter> needs to be added to the widget's
- toplevel via the <link
- linkend="method-gtkwindow--add-accel-group"><methodname>gtk.Window.add_accel_group</methodname>()</link>
- method and the signal specified by <parameter>accel_signal</parameter>
- must have signal flags that include the
- <literal>gobject.SIGNAL_ACTION</literal> flag (see the <link
- linkend="gobject-signal-constants">GObject Signal Flag
- Constants</link> for more information). Accelerators added through
- this method are not user changeable during runtime. If you want to
- support accelerators that can be changed by the user, the <link
- linkend="method-gtkwidget--set-accel-path"><methodname>set_accel_path</methodname>()</link>
- or <link
- linkend="method-gtkmenuitem--set-accel-path"><methodname>gtk.MenuItem.set_accel_path</methodname>()</link>
- methods instead.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--remove-accelerator">
- <title>gtk.Widget.remove_accelerator</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_accelerator</methodname>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_key</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_mods</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_group</parameter>&nbsp;:</term>
- <listitem><simpara>the accel group for this
-widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_key</parameter>&nbsp;:</term>
- <listitem><simpara>the keyval of the
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_mods</parameter>&nbsp;:</term>
- <listitem><simpara>the modifier key combination of the
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the accelerator was
-removed</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove_accelerator</methodname>() method removes
-the accelerator specified by <parameter>accel_key</parameter> and
-<parameter>accel_mods</parameter> from the widget's accelerator group
-(specified by <parameter>accel_group</parameter>), previously installed with
-the <link
-linkend="method-gtkwidget--add-accelerator"><methodname>add_accelerator</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-accel-path">
- <title>gtk.Widget.set_accel_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_accel_path</methodname>
- <methodparam><parameter
- role="keyword">accel_path</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_path</parameter>&nbsp;:</term>
- <listitem><simpara>the path used to look up the the
-accelerator</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_group</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_accel_path</methodname>() method sets an
-accelerator (using the key bindings defined in
-<parameter>accel_path</parameter>) in the accelerator group specified by
-<parameter>accel_group</parameter>. This method removes any accelerators for
-any accelerator group installed by previous calls to the
-<methodname>set_accel_path</methodname>() method. Associating accelerators
-with paths allows them to be modified by the user and the modifications to
-be saved for future use. This method is a low level method that would most
-likely be used by a menu creation system like <link
-linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>.
-If you use <link
-linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>,
-setting up accelerator paths will be done automatically. Even when you you
-aren't using <link
-linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>,
-if you only want to set up accelerators on menu items the <link
-linkend="method-gtkmenuitem--set-accel-path"><methodname>gtk.MenuItem.set_accel_path</methodname>()</link>
-method provides a somewhat more convenient interface.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--can-activate-accel">
- <title>gtk.Widget.can_activate_accel</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>can_activate_accel</methodname>
- <methodparam><parameter>signal_id</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>signal_id</parameter>&nbsp;:</term>
- <listitem><simpara>the ID of an installed signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the accelerator can
- be activated.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>can_activate_accel</methodname>() method returns
-<literal>True</literal> if an accelerator that activates the signal
-specified by <parameter>signal_id</parameter> can currently be activated.
-This is done by emitting the "<link
-linkend="signal-gtkwidget--can-activate-accel">can-activate-accel</link>"
-signal. If the signal isn't overridden by a handler or in a derived widget,
-then the default check is that the widget must be sensitive, and the widget
-and all its ancestors mapped.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtkwidget- -list-accel-closures">
- <title>gtk.Widget.list_accel_closures</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_accel_closures</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a </simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>list_accel_closures</methodname>() method
-returns a lists of the closures used by the widget for accelerator group
-connections with <link linkend="method-gtkaccelgroup-
--connect-by-path"><function>gtk.AccelGroup.connect_by_path()</function></link>
-or <link linkend="method-gtkaccelgroup-
--connect"><function>gtk.AccelGroup.connect()</function></link>. The
-closures can be used to monitor accelerator changes on the widget, by
-connecting to the ::accel_changed signal of the <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-of a closure which can be found out with
-<function>accel_group_from_accel_closure()</function>.</para>
-
- </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-gtkwidget--mnemonic-activate">
- <title>gtk.Widget.mnemonic_activate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>mnemonic_activate</methodname>
- <methodparam><parameter
- role="keyword">group_cycling</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">group_cycling</parameter>&nbsp;:</term>
- <listitem><simpara>if True grab the focus instead of activating
-the widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the signal was
-handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The<methodname> mnemonic_activate</methodname>() method emits
-the "mnemonic-activate" signal on the widget and returns
-<literal>True</literal> if the signal was handled.
-<parameter>group_cycling</parameter> is <literal>True</literal> if the focus
-is being shifted to the widget and <literal>False</literal> if the widget
-should be activated.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--event">
- <title>gtk.Widget.event</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>event</methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the event was
-handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>event</methodname>() method emits the event
-signals on a widget (those signals should never be emitted without using
-this method to do so). If you want to synthesize an event though, don't use
-this method; instead, use the <link
-linkend="function-gtk--main-do-event"><methodname>gtk.main_do_event</methodname>()</link>
-function so the event will behave as if it were in the event queue. Don't
-synthesize expose events; instead, use the <link
-linkend="method-gdkwindow--invalidate-rect"><methodname>gtk.gdk.Window.invalidate_rect</methodname>()</link>
-method to invalidate a region of the window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--send-expose">
- <title>gtk.Widget.send_expose</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>send_expose</methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>an expose <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the event was
-handled</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>send_expose</methodname>() method emits an
-expose event signal on a widget. This method is usually used when
-propagating an expose event to a child <literal>NO_WINDOW</literal> widget,
-and that is normally done using the <link
-linkend="method-gtkcontainer--propagate-expose"><methodname>gtk.Container.propagate_expose</methodname>()</link>
-method. If you want to force an area of a window to be redrawn, use the
-<link
-linkend="method-gdkwindow--invalidate-rect"><methodname>gtk.gdk.Window.invalidate_rect</methodname>()</link>
-method. To cause the redraw to be done immediately, follow that call with a
-call to the <link
-linkend="method-gdkwindow--process-updates"><methodname>gtk.gdk.Window.process_updates</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--activate">
- <title>gtk.Widget.activate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>activate</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the widget was
-activatable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>activate</methodname>() method emits the
-"activate" signal on the widget that activates it (if it can be activated).
-Activation is what happens when you press <keycap>Enter</keycap> on a widget
-during key navigation; clicking a button, selecting a menu item, etc. If the
-widget isn't activatable, the method returns
-<literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-scroll-adjustments">
- <title>gtk.Widget.set_scroll_adjustments</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_scroll_adjustments</methodname>
- <methodparam><parameter
- role="keyword">hadjustment</parameter></methodparam>
- <methodparam><parameter
- role="keyword">vadjustment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">hadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>an adjustment for horizontal scrolling, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">vadjustment</parameter>&nbsp;:</term>
- <listitem><simpara>an adjustment for vertical scrolling, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the widget supports
-scrolling</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_scroll_adjustments</methodname>() method
-sets the horizontal and vertical scroll adjustments specified by
-<parameter>hadjustment</parameter> and <parameter>vadjustment</parameter>
-respectively and returns <literal>True</literal>. If the widget doesn't
-support scrolling this method returns <literal>False</literal>. Widgets that
-don't support scrolling can be scrolled by placing them in a <link
-linkend="class-gtkviewport"><classname>gtk.Viewport</classname></link>,
-which does support scrolling. This method emits the "set-scroll-adjustments"
-signal on the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--reparent">
- <title>gtk.Widget.reparent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reparent</methodname>
- <methodparam><parameter
- role="keyword">new_parent</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">new_parent</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link> to
-move the widget into</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>reparent</methodname>() method moves a widget
-from one <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link> to
-another.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--intersect">
- <title>gtk.Widget.intersect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>intersect</methodname>
- <methodparam><parameter
- role="keyword">area</parameter></methodparam>
- <methodparam><parameter
- role="keyword">intersection</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">area</parameter>&nbsp;:</term>
- <listitem><simpara>a rectangle</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a rectangle of the intersection of the widget
-and <parameter>area</parameter> or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>intersect</methodname>() method computes the
-intersection of a the widget's area and <parameter>area</parameter>, and
-returns the intersection in a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>.
-This method returns <literal>False</literal> if there is no
-intersection.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--region-intersect">
- <title>gtk.Widget.region_intersect</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>region_intersect</methodname>
- <methodparam><parameter role="keyword">region</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">region</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>,
- in the same coordinate system as the widget.allocation. That is,
- relative to the widget.window for <literal>NO_WINDOW</literal>
- widgets; relative to the parent window of the widget.window for
- widgets with their own window.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a newly allocated <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- holding the intersection of the widget and <parameter>region</parameter>. The coordinates of
- the returned region are relative to widget.window for <literal>NO_WINDOW</literal>
- widgets, and relative to the parent window of widget.window for
- widgets with their own window.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>region_intersect</methodname>() method computes
- and returns as a <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- the intersection of a the widget's area and the <link
- linkend="class-gdkregion"><classname>gtk.gdk.Region</classname></link>
- specified by <parameter>region</parameter>. Since the result may be
- empty, use the <link
- linkend="method-gdkregion--empty"><methodname>gtk.gdk.Region.empty</methodname>()</link>
- method to check.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--freeze-child-notify">
- <title>gtk.Widget.freeze_child_notify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>freeze_child_notify</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>freeze_child_notify</methodname>() method
-freezes the child notify queue that is used to notify child widgets of child
-property changes.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--child-notify">
- <title>gtk.Widget.child_notify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>child_notify</methodname>
- <methodparam><parameter
- role="keyword">child_property</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">child_property</parameter>&nbsp;:</term>
- <listitem><simpara>a child property</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>child_notify</methodname>() method adds a child
-property to the widget's child notify queue that is used to notify child
-widgets of a change to a child property.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--thaw-child-notify">
- <title>gtk.Widget.thaw_child_notify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>thaw_child_notify</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>thaw_child_notify</methodname>() method reverses
-the effect of a previous call to the <link
-linkend="method-gtkwidget--freeze-child-notify"><methodname>freeze_child_notify</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--is-focus">
- <title>gtk.Widget.is_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_focus</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the widget is the
-focus widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_focus</methodname>() method returns
-<literal>True</literal> if the widget is the focus widget within its
-toplevel. This does not mean that the <literal>gtk.HAS_FOCUS</literal> flag
-is necessarily set; <literal>gtk.HAS_FOCUS</literal> will only be set if the
-toplevel widget additionally has the global input focus.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--grab-focus">
- <title>gtk.Widget.grab_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>grab_focus</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>grab_focus</methodname>() method causes the
-widget to have the keyboard focus for it's enclosing <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>. The
-widget must be a focusable widget, such as a <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link>. Also, the
-widget must have the <literal>gtk.CAN_FOCUS</literal> flag set.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--grab-default">
- <title>gtk.Widget.grab_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>grab_default</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>grab_default</methodname>() method causes the
-widget to become the default widget. The widget must have the
-<literal>gtk.CAN_DEFAULT</literal> flag set by calling the <link
-linkend="method-gtkobject--set-flags"><methodname>gtk.Object.set_flags</methodname>()</link>
-method. The default widget is activated when the user presses
-<keycap>Enter</keycap> in a window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-name">
- <title>gtk.Widget.set_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name for the widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_name</methodname>() method sets the "name"
-property of the widget to the string specified by
-<parameter>name</parameter>. Widgets can be named, which allows you to refer
-to them in a GTK resource file.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-name">
- <title>gtk.Widget.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_name</methodname>() method returns the value
-of the "name" property that contains the name of the widget or
-<literal>None</literal> if the widget has no name.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-state">
- <title>gtk.Widget.set_state</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_state</methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">state</parameter>&nbsp;:</term>
- <listitem><simpara>the new state for the
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The set_state() method sets the state of the widget to the value
-specified by state. The value of state must be one of the <xref
-linkend="gtk-state-type-constants"
-endterm="gtk-state-type-constants-title"></xref>.</para>
-
- <para>Usually you should set the state using wrapper methods such as
-<link
-linkend="method-gtkwidget--set-sensitive"><methodname>set_sensitive</methodname>()</link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-sensitive">
- <title>gtk.Widget.set_sensitive</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_sensitive</methodname>
- <methodparam><parameter
- role="keyword">sensitive</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">sensitive</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> make the widget
-sensitive</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_sensitive</methodname>() method sets the
-"sensitive" property of the widget to the value specified by
-<parameter>sensitive</parameter>. If <parameter>sensitive</parameter> is
-<literal>True</literal> the widget will be sensitive and the user can
-interact with it. An insensitive widget appears "grayed out" and the user
-can't interact with it. Insensitive widgets are known as "inactive",
-"disabled", or "ghosted" in some other toolkits.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-app-paintable">
- <title>gtk.Widget.set_app_paintable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_app_paintable</methodname>
- <methodparam><parameter
- role="keyword">app_paintable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">app_paintable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the application will
-paint directly on the widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_app_paintable</methodname>() method sets the
-"app-paintable" property to the value of
-<parameter>app_paintable</parameter>. If
-<parameter>app_paintable</parameter> is <literal>True</literal> the
-application will paint directly on the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-double-buffered">
- <title>gtk.Widget.set_double_buffered</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_double_buffered</methodname>
- <methodparam><parameter
- role="keyword">double_buffered</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">double_buffered</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> double-buffer a
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_double_buffered</methodname>() method sets
-the widget's flags according to the value of
-<parameter>double_buffered</parameter>. If
-<parameter>double_buffered</parameter> is <literal>True</literal> the
-<literal>gtk.DOUBLE_BUFFERED</literal> flag is set; otherwise it is unset.
-Widgets are double buffered by default. "Double buffered" simply means that
-the <link
-linkend="method-gdkwindow--begin-paint-rect"><methodname>gtk.gdk.Window.begin_paint_rect</methodname>()</link>
-and <link
-linkend="method-gdkwindow--end-paint"><methodname>gtk.gdk.Window.end_paint</methodname>()</link>
-methods are called automatically around expose events sent to the widget.
-The <link
-linkend="method-gdkwindow--begin-paint-rect"><methodname>gtk.gdk.Window.begin_paint_rect</methodname>()</link>
-method diverts all drawing to a widget's window to an off screen buffer, and
-the <link
-linkend="method-gdkwindow--end-paint"><methodname>gtk.gdk.Window.end_paint</methodname>()</link>
-method draws the buffer to the screen. The result is that users see the
-window update in one smooth step, and don't see individual graphics
-primitives being rendered. In very simple terms, double buffered widgets
-don't flicker, so you would only use this method to turn off double
-buffering if you had special needs and really knew what you were
-doing.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-redraw-on-allocate">
- <title>gtk.Widget.set_redraw_on_allocate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_redraw_on_allocate</methodname>
- <methodparam><parameter
- role="keyword">redraw_on_allocate</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">redraw_on_allocate</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the entire widget
-will be redrawn when it is allocated to a new size. Otherwise, only the new
-portion of the widget will be redrawn.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_redraw_on_allocate</methodname>() method
-sets a flag that determines if the entire widget is queued for drawing when
-a widget's size allocation changes. By default, this setting is
-<literal>True</literal> and the entire widget is redrawn on every size
-change. If your widget leaves the upper left are unchanged when made bigger,
-turning this setting on will improve performance.</para>
-
- <note>
- <para>For <literal>NO_WINDOW</literal> widgets setting this flag to
-<literal>False</literal> turns off all allocation on resizing: the widget
-will not redraw even if its position changes; this is to allow containers
-that don't draw anything to avoid excess invalidations. If you set this flag
-on a <literal>NO_WINDOW</literal> widget that <emphasis>does</emphasis> draw
-on the widget's <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>, you
-are responsible for invalidating both the old and new allocation of the
-widget when the widget is moved and responsible for invalidating regions
-newly when the widget increases size.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-parent">
- <title>gtk.Widget.set_parent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_parent</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>a parent container</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_parent</methodname>() method is useful only
-when implementing subclasses of <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>.
-This method sets the container as the parent of the widget, and takes care
-of some details such as updating the state and style of the child to reflect
-its new location. The reverse method is the <link
-linkend="method-gtkwidget--unparent"><methodname>unparent</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-parent-window">
- <title>gtk.Widget.set_parent_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_parent_window</methodname>
- <methodparam><parameter
- role="keyword">parent_window</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">parent_window</parameter>&nbsp;:</term>
- <listitem><simpara>the new parent window.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_parent_window</methodname>() method sets a
-non default parent window for the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-child-visible">
- <title>gtk.Widget.set_child_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_child_visible</methodname>
- <methodparam><parameter
- role="keyword">is_visible</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">is_visible</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, the widget should
-be mapped along with its parent.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_child_visible</methodname>() method
-determines if the widget should be mapped along with its parent. If
-<parameter>is_visible</parameter> is <literal>True</literal> the widget will
-be mapped with its parent if it has called the <link
-linkend="method-gtkwidget--show"><methodname>show</methodname>()</link>
-method.</para>
- <para>
-The child visibility can be set for widget before it is added to a container
-to avoid mapping children unnecessarily. The widget's child visibility flag
-will be reset to its default state of <literal>True</literal> when the
-widget is removed from a container. Note that changing the child visibility
-of a widget does not queue a resize on the widget. Most of the time, the
-size of a widget is computed from all visible children, whether or not they
-are mapped. If this is not the case, the container can queue a resize
-itself. This method is only useful for container implementations and never
-should be called by an application.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-child-visible">
- <title>gtk.Widget.get_child_visible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_child_visible</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the widget is mapped
-with the parent.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_child_visible</methodname>() method returns
-the value set with the <link
-linkend="method-gtkwidget--set-child-visible"><methodname>set_child_visible</methodname>()</link>
-method. This method is only useful for container implementations and never
-should be called by an application.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-parent">
- <title>gtk.Widget.get_parent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_parent</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the parent container of the widget, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_parent</methodname>() method returns the
-parent container of the widget or <literal>None</literal> if the widget has
-no parent.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-parent-window">
- <title>gtk.Widget.get_parent_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_parent_window</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the parent <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> of
-the widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_parent_window</methodname>() method returns
-the widget's parent <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--child-focus">
- <title>gtk.Widget.child_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>child_focus</methodname>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">direction</parameter>&nbsp;:</term>
- <listitem><simpara>the direction of focus
-movement</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if focus ended up
-inside the widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>child_focus</methodname>() method is used by
-custom widget implementations. If you're writing an application, use the
-<link
-linkend="method-gtkwidget--grab-focus"><methodname>grab_focus</methodname>()</link>
-method to move the focus to a particular widget, and the <link
-linkend="method-gtkcontainer--set-focus-chain"><methodname>gtk.Container.set_focus_chain</methodname>()</link>
-method to change the focus tab order.</para>
-
- <para>The <methodname>child_focus</methodname>() method is called by
-containers as the user moves around the window using keyboard shortcuts. The
-value of <parameter>direction</parameter> indicates what kind of motion is
-taking place: <literal>gtk.DIR_TAB_FORWARD</literal>,
-<literal>gtk.DIR_TAB_BACKWARD</literal>, <literal>gtk.DIR_UP</literal>,
-<literal>gtk.DIR_DOWN</literal>, <literal>gtk.DIR_LEFT</literal> or
-<literal>gtk.DIR_RIGHT</literal></para>
-
- <para>This method emits the "focus" signal on the widget. Widgets
-override the default handler for this signal in order to implement
-appropriate focus behavior. The "focus" default handler for a widget should
-return:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><literal>True</literal> if the focus is left on a
-focusable location inside the widget, and</simpara>
- </listitem>
- <listitem>
- <simpara><literal>False</literal> if the focus moved outside the
-widget</simpara>
- </listitem>
- </itemizedlist>
-
- <para>If returning <literal>True</literal>, widgets normally call the
-<link
-linkend="method-gtkwidget--grab-focus"><methodname>grab_focus</methodname>()</link>
-method to place the focus accordingly; if returning
-<literal>False</literal>, they don't modify the current focus
-location.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-size-request">
- <title>gtk.Widget.set_size_request</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_size_request</methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width the widget should request, or -1 to
-unset</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height the widget should request, or -1 to
-unset</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_size_request</methodname>() method sets the
-minimum size of a widget to the values specified by
-<parameter>width</parameter> and <parameter>height</parameter>. You can use
-this method to force a widget to be either larger or smaller than it
-normally would be. In most cases, the <link
-linkend="method-gtkwindow--set-default-size"><methodname>gtk.Window.set_default_size</methodname>()</link>
-is a better choice for toplevel windows than this method. Setting the
-default size will still allow users to shrink the window but setting the
-size request will force them to leave the window at least as large as the
-size request. When dealing with window sizes, the <link
-linkend="method-gtkwindow--set-geometry-hints"><methodname>gtk.Window.set_geometry_hints</methodname>()</link>
-can be a useful method as well.
-</para>
-
- <note>
- <para>There is an inherent danger when setting any fixed size -
-themes, translations into other languages, different fonts, and user action
-can all change the appropriate size for a given widget. So, it's basically
-impossible to hard code a size that will always be correct.</para>
- </note>
-
- <para>The size request of a widget is the smallest size a widget can
-accept while still functioning well and drawing itself correctly. However in
-some strange cases a widget may be allocated less than its requested size,
-and in many cases a widget may be allocated more space than it requested. If
-the size request in a given direction is -1 (unset), then the "natural" size
-request of the widget will be used instead. Widgets can't actually be
-allocated a size less than 1 by 1, but you can pass 0,0 to this method to
-mean "as small as possible".</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-size-request">
- <title>gtk.Widget.get_size_request</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size_request</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the requested width and
- height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_size_request</methodname>() method returns a
-2-tuple containing the width and height of the widget that was explicitly
-set for the widget using the <link
-linkend="method-gtkwidget--set-size-request"><methodname>set_size_request()</methodname></link>. A
-value of -1 for the width or height indicates that that dimension has not
-been set explicitly and the natural requisition of the widget will be used
-instead. See the <link
-linkend="method-gtkwidget--set-size-request"><methodname>set_size_request()</methodname></link>
-method for more information. To get the size a widget will actually use,
-call the <link
-linkend="method-gtkwidget--size-request"><methodname>size_request()</methodname></link>
-instead of this method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-events">
- <title>gtk.Widget.set_events</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_events</methodname>
- <methodparam><parameter
- role="keyword">events</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">events</parameter>&nbsp;:</term>
- <listitem><simpara>the event mask</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_events</methodname>() method sets the event
-mask for a widget using the value specified by
-<parameter>events</parameter>. The event mask determines which events a
-widget will receive. Keep in mind that different widgets have different
-default event masks, and by changing the event mask you may disrupt a
-widget's functionality, so be careful. This method must be called while a
-widget is unrealized. Consider using the <link
-linkend="method-gtkwidget--add-events"><methodname>add_events</methodname>()</link>
-method for widgets that are already realized, or if you want to preserve the
-existing event mask. This method can't be used with
-<literal>gtk.NO_WINDOW</literal> widgets since a widget must have a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> to
-receive events. To get events on <literal>gtk.NO_WINDOW</literal> widgets,
-place them inside a <link
-linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link> and
-receive events on the event box.</para>
-
- <para>The value of <parameter>events</parameter> must be a combination
-of the <xref linkend="gdk-event-mask-constants"
-endterm="gdk-event-mask-constants-title"></xref>:</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--add-events">
- <title>gtk.Widget.add_events</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_events</methodname>
- <methodparam><parameter
- role="keyword">events</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">events</parameter>&nbsp;:</term>
- <listitem><simpara>an event mask</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_events</methodname>() method adds the events
-specified by <parameter>events</parameter> to the event mask for the widget.
-See the <link
-linkend="method-gtkwidget--set-events"><methodname>set_events</methodname>()</link>
-method for details.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-extension-events">
- <title>gtk.Widget.set_extension_events</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_extension_events</methodname>
- <methodparam><parameter
- role="keyword">mode</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">mode</parameter>&nbsp;:</term>
- <listitem><simpara>the extension events to
-receive</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_extension_events</methodname>() method sets
-the extension events mask to the value specified by
-<parameter>mode</parameter>. The value of mode must be one of the <xref
-linkend="gdk-extension-mode-constants"
-endterm="gdk-extension-mode-constants-title"></xref>.</para>
-
- <para>See the <link
-linkend="method-gdkwindow--input-set-extension-events"><methodname>gtk.gdk.Window.input_set_extension_events</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-extension-events">
- <title>gtk.Widget.get_extension_events</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_extension_events</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the extension events for the
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_extension_events</methodname>() method
-returns the extension events the widget will receive. See the <link
-linkend="method-gdkwindow--input-set-extension-events"><methodname>gtk.gdk.Window.input_set_extension_events</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-toplevel">
- <title>gtk.Widget.get_toplevel</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_toplevel</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the topmost ancestor of the widget, or the
-widget itself if there's no ancestor.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_toplevel</methodname>() method returns the
-topmost widget in the container hierarchy that the widget is a part of. If
-the widget has no parent widgets, it will be returned as the topmost
-widget.</para>
-
- <para>Note the difference in behavior as compared to the <link
-linkend="method-gtkwidget--get-ancestor"><methodname>get_ancestor</methodname>()</link>
-method that returns <literal>None</literal> if the widget isn't inside a
-toplevel window, and if the window is inside a widget derived from <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> that is
-in turn inside the toplevel <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>. While
-the second case may seem unlikely, it actually happens when a <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> is embedded
-inside a <link
-linkend="class-gtksocket"><classname>gtk.Socket</classname></link> within
-the same application.</para>
-
- <para>To reliably find the toplevel <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>, use the
-<link
-linkend="method-gtkwidget--get-toplevel"><methodname>get_toplevel</methodname>()</link>
-method and check if the <literal>gtk.TOPLEVEL</literal> flag is set on the
-result.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-ancestor">
- <title>gtk.Widget.get_ancestor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_ancestor</methodname>
- <methodparam><parameter
- role="keyword">widget_type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">widget_type</parameter>&nbsp;:</term>
- <listitem><simpara>a widget type</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the ancestor widget, or <literal>None</literal>
-if not found</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_ancestor</methodname>() method returns the
-first ancestor of the widget with the type specified by
-<parameter>widget_type</parameter>. For example:</para>
-
- <programlisting>
- widget.get_ancestor(gtk.Box)
- </programlisting>
-
- <para>returns the first <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> that's an
-ancestor of the widget. See the <link
-linkend="method-gtkwidget--get-toplevel"><methodname>get_toplevel</methodname>()</link>
-method for information about checking for a toplevel <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-colormap">
- <title>gtk.Widget.get_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_colormap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the colormap used by the
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_colormap</methodname>() method returns the
-colormap that will be used to render the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-visual">
- <title>gtk.Widget.get_visual</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_visual</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the visual for the widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_visual</methodname>() method returns the
-visual that will be used to render the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-screen">
- <title>gtk.Widget.get_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_screen</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
- for the toplevel for this widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_screen</methodname>() method returns the
-<link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-from the toplevel window associated with the widget. This method can only be
-called after the widget has been added to a widget hierarchy with a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> at the
-top.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--has-screen">
- <title>gtk.Widget.has_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>has_screen</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if there is a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
- associated with the widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>has_screen</methodname>() method returns
-<literal>True</literal> if a <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> is
-associated with the widget. All toplevel widgets have an associated screen,
-as do all widgets added into a hierarchy with a toplevel window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-display">
- <title>gtk.Widget.get_display</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_display</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
- for the toplevel for this widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_display</methodname>() method returns the
-<link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link> for
-the toplevel window associated with the widget. This method can only be
-called after the widget has been added to a widget hierarchy with a toplevel
-<link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-root-window">
- <title>gtk.Widget.get_root_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_root_window</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
- root window for the toplevel for this widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_root_window</methodname>() method returns
-the root window containing the widget. This method should only be called
-after the widget has been added to a widget hierarchy with a toplevel <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link></para>
-
- <para>The root window is useful for such purposes as creating a popup
-<link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> associated with the window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-settings">
- <title>gtk.Widget.get_settings</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_settings</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the associated <link
-linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_settings</methodname>() method returns the
-settings object holding the settings (global property settings, RC file
-information, etc) used for this widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-clipboard">
- <title>gtk.Widget.get_clipboard</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_clipboard</methodname>
- <methodparam><parameter role="keyword">selection</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">selection</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link>
- or string that identifies the clipboard to
- use. <literal>gtk.gdk.SELECTION_CLIPBOARD</literal> gives the
- default clipboard. Another common value is
- <literal>gtk.gdk.SELECTION_PRIMARY</literal>, which gives the
- primary X selection.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the appropriate <link
- linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
- object. If no clipboard already exists, a new one will be
- created. Once a clipboard object has been created, it is
- persistent for all time.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_clipboard</methodname>() method returns the
-<link
-linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link>
-object for the selection specified by <parameter>selection</parameter>. The
-widget must have a <link
-linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
-associated with it, and so must be attached to a toplevel window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-accessible">
- <title>gtk.Widget.get_accessible</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_accessible</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_accessible</methodname>() method returns the
- Accessibility ToolKit (ATK) object for the widget as an <link
- linkend="class-atkobject"><classname>atk.Object</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-colormap">
- <title>gtk.Widget.set_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_colormap</methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_colormap</methodname>() method sets the
-<link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-for the widget to the value specified by <parameter>colormap</parameter>.
-Widget must not have been realized.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-events">
- <title>gtk.Widget.get_events</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_events</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the event mask for the
-widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_events</methodname>() method returns the
-event mask for the widget that determines the events that the widget will
-receive. See the <link
-linkend="method-gtkwidget--set-events"><methodname>set_events</methodname>()</link>
-method for more detail about events.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-pointer">
- <title>gtk.Widget.get_pointer</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pointer</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the X and Y coordinates of
-the mouse pointer</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pointer</methodname>() method returns a
-tuple containing the location of the mouse pointer in widget coordinates.
-Widget coordinates are a bit odd; for historical reasons, they are defined
-as:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the widget <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>
-coordinates for widgets that are not <literal>gtk.NO_WINDOW</literal>
-widgets, or</simpara>
- </listitem>
- <listitem>
- <simpara>the coordinates relative to the widget allocation for
-widgets that are <literal>gtk.NO_WINDOW</literal> widgets.</simpara>
- </listitem>
- </itemizedlist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--is-ancestor">
- <title>gtk.Widget.is_ancestor</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_ancestor</methodname>
- <methodparam><parameter
- role="keyword">ancestor</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">ancestor</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>ancestor</parameter> contains the widget as a child, grandchild,
-great grandchild, etc.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_ancestor</methodname>() method returns
-<literal>True</literal> if the widget is somewhere inside the hierarchy of
-the widget specified by<parameter>ancestor</parameter></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--translate-coordinates">
- <title>gtk.Widget.translate_coordinates</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>translate_coordinates</methodname>
- <methodparam><parameter
- role="keyword">dest_widget</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">src_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">dest_widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position relative to the
-widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">src_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position relative to the
-widget</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the X and Y position
-relative to <parameter>dest_widget</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>translate_coordinates</methodname>() method
-returns a tuple containing the translation of the widget x and y coordinates
-specified by <parameter>src_x</parameter> and <parameter>src_y</parameter>
-respectively to coordinates relative to <parameter>dest_widget</parameter>.
-In order to perform this operation, both widgets must be realized, and must
-share a common toplevel.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--hide-on-delete">
- <title>gtk.Widget.hide_on_delete</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>hide_on_delete</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>hide_on_delete</methodname>() method is a
-utility method that is intended to be connected to the "delete_event" signal
-on a <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>. The
-method calls the <link
-linkend="method-gtkwidget--hide"><methodname>hide</methodname>()</link>
-method on the widget, then returns <literal>True</literal>. If connected to
-"delete_event", the result is that clicking the close button for a window
-(on the window frame, top right corner usually) will hide but not destroy
-the window. By default, <literal>PyGTK</literal> destroys windows when
-"delete_event" is received.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-style">
- <title>gtk.Widget.set_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_style</methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">style</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link>, or
-<literal>None</literal> to revert to the default style</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_style</methodname>() method sets the "style"
-property to the value of <parameter>style</parameter>. The "style" property
-contains the <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> for the
-widget. This method interacts badly with themes, because themes work by
-replacing the <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--ensure-style">
- <title>gtk.Widget.ensure_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>ensure_style</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>ensure_style</methodname>() method makes sure
-that the widget has a style. This method is useful if applied to an
-unrealized widget. Usually, if you want the style, the widget is realized,
-and guaranteed to have a style.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-style">
- <title>gtk.Widget.get_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_style</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the widget's <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_style</methodname>() method returns the
-value of the "style" property.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--modify-style">
- <title>gtk.Widget.modify_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>modify_style</methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">style</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkrcstyle"><classname>gtk.RcStyle</classname></link> holding
-the style modifications</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>modify_style</methodname>() method modifies the
-style values on the widget using the values in <parameter>style</parameter>.
-Modifications made using this technique take precedence over style values
-set via an RC file, however, they will be overridden if a style is explicitly
-set on the widget using the <link
-linkend="method-gtkwidget--set-style"><methodname>set_style</methodname>()</link>
-method. The <link
-linkend="class-gtkrcstyle"><classname>gtk.RcStyle</classname></link> object
-is designed so each attribute can either be set or unset, so it is possible,
-using this method, to modify some style values and leave the others
-unchanged.</para>
-
- <para>Note that modifications made with this method are not cumulative
-with previous calls to the <methodname>modify_style</methodname>() method or
-with such methods as the <link
-linkend="method-gtkwidget--modify-fg"><methodname>modify_fg</methodname>()</link>
-method. If you wish to retain previous values, you must first call the <link
-linkend="method-gtkwidget--get-modifier-style"><methodname>get_modifier_style</methodname>()</link>
-method, make your modifications to the returned style, then call the
-<methodname>modify_style</methodname>() method with that style. On the other
-hand, if you first call the <methodname>modify_style</methodname>() method,
-subsequent calls to such methods as the <link
-linkend="method-gtkwidget--modify-fg"><methodname>modify_fg</methodname>()</link>
-method will have a cumulative effect with the initial modifications.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-modifier-style">
- <title>gtk.Widget.get_modifier_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_modifier_style</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the modifier style for the widget. This <link
-linkend="class-gtkrcstyle"><classname>gtk.RcStyle</classname></link> is
-owned by the widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_modifier_style</methodname>() method returns
-the current modifier style for the widget as set by the <link
-linkend="method-gtkwidget--modify-style"><methodname>modify_style</methodname>()</link>
-method. If no style was previously set, a new <link
-linkend="class-gtkrcstyle"><classname>gtk.RcStyle</classname></link> object
-will be created( with all values unset), and set as the modifier style for
-the widget. If you make changes to this rc style, you must call the <link
-linkend="method-gtkwidget--modify-style"><methodname>modify_style</methodname>()</link>
-method, passing in the returned rc style, to make sure that your changes
-take effect.</para>
-
- <caution>
- <para>Passing the style back to the <link
-linkend="method-gtkwidget--modify-style"><methodname>modify_style</methodname>()</link>
-method will normally end up destroying it, because the <link
-linkend="method-gtkwidget--modify-style"><methodname>modify_style</methodname>()</link>
-method copies the passed-in style and sets the copy as the new modifier
-style, thus dropping any reference to the old modifier style.</para>
- </caution>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--modify-fg">
- <title>gtk.Widget.modify_fg</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>modify_fg</methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">state</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to
-assign.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>modify_fg</methodname>() method sets the
-foreground color to the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-specified by <parameter>color</parameter> for the widget in the specified
-<parameter>state</parameter>. All other style values are left untouched. The
-value of state must be one of the <xref
-linkend="gtk-state-type-constants" endterm="gtk-state-type-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--modify-bg">
- <title>gtk.Widget.modify_bg</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>modify_bg</methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">state</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to
-assign</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>modify_bg</methodname>() method sets the
-background color to the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-specified by <parameter>color</parameter> for the widget in the specified
-<parameter>state</parameter>. All other style values are left untouched. See
-<link
-linkend="method-gtkwidget--modify-fg"><methodname>modify_fg</methodname>()</link>
-method for detail on the possible values of
-<parameter>state</parameter>.</para>
-
- <note>
- <para><methodname>modify_bg</methodname>() only affects widgets that
-have an associated <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>. Widgets
-that do not have an associated window include <link
-linkend="class-gtkarrow"><classname>gtk.Arrow</classname></link>, <link
-linkend="class-gtkbin"><classname>gtk.Bin</classname></link>, <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link>, <link
-linkend="class-gtkbutton"><classname>gtk.Button</classname></link>, <link
-linkend="class-gtkcheckbutton"><classname>gtk.CheckButton</classname></link>,
-<link linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link>,
-<link linkend="class-gtkimage"><classname>gtk.Image</classname></link>,
-<link linkend="class-gtklabel"><classname>gtk.Label</classname></link>,
-<link
-linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>,
-<link
-linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link>,
-<link linkend="class-gtkpaned"><classname>gtk.Paned</classname></link>,
-<link
-linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>,
-<link linkend="class-gtkrange"><classname>gtk.Range</classname></link>,
-<link
-linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>,
-<link
-linkend="class-gtkseparator"><classname>gtk.Separator</classname></link>,
-<link linkend="class-gtktable"><classname>gtk.Table</classname></link>,
-<link linkend="class-gtktoolbar"><classname>gtk.Toolbar</classname></link>,
-<link
-linkend="class-gtkaspectframe"><classname>gtk.AspectFrame</classname></link>,
-<link linkend="class-gtkframe"><classname>gtk.Frame</classname></link>,
-<link linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>, <link
-linkend="class-gtkhbox"><classname>gtk.HBox</classname></link>, <link
-linkend="class-gtkvseparator"><classname>gtk.VSeparator</classname></link>,
-<link
-linkend="class-gtkhseparator"><classname>gtk.HSeparator</classname></link>. These
-widgets can be added to a <link
-linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link> to
-overcome this limitation.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--modify-text">
- <title>gtk.Widget.modify_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>modify_text</methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">state</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to
-assign.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>modify_text</methodname>() method sets the text
-color to the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-specified by <parameter>color</parameter> for the widget in the specified
-<parameter>state</parameter>. All other style values are left untouched. The
-text color is the foreground color used along with the base color (see the
-<link
-linkend="method-gtkwidget--modify-base"><methodname>modify_base</methodname>()</link>
-method) for widgets such as <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> and <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>. See
-the <link
-linkend="method-gtkwidget--modify-fg"><methodname>modify_fg</methodname>()</link>
-method for detail on the possible values of
-<parameter>state</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--modify-base">
- <title>gtk.Widget.modify_base</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>modify_base</methodname>
- <methodparam><parameter
- role="keyword">state</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">state</parameter>&nbsp;:</term>
- <listitem><simpara>a widget state.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link> to
-assign</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>modify_base</methodname>() method sets the base
-color to the <link
-linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
-specified by <parameter>color</parameter> for the widget in the specified
-<parameter>state</parameter>. All other style values are left untouched. The
-base color is the background color used along with the text color (see the
-<link
-linkend="method-gtkwidget--modify-text"><methodname>modify_text</methodname>()</link>
-method) for widgets such as <link
-linkend="class-gtkentry"><classname>gtk.Entry</classname></link> and <link
-linkend="class-gtktextview"><classname>gtk.TextView</classname></link>. See
-<link
-linkend="method-gtkwidget--modify-fg"><methodname>modify_fg</methodname>()</link>
-method for detail on the possible values of
-<parameter>state</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--modify-font">
- <title>gtk.Widget.modify_font</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>modify_font</methodname>
- <methodparam><parameter
- role="keyword">font_desc</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">font_desc</parameter>&nbsp;:</term>
- <listitem><simpara>a font description to use</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>modify_font</methodname>() method sets the font
-to use to the value specified by <parameter>font_desc</parameter> for the
-widget. All other style values are left untouched.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--create-pango-context">
- <title>gtk.Widget.create_pango_context</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_pango_context</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>create_pango_context</methodname>() method
-creates a new <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-with the appropriate colormap, font description, and base direction for
-drawing text for this widget. See the <link
-linkend="method-gtkwidget--get-pango-context"><methodname>get_pango_context</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-pango-context">
- <title>gtk.Widget.get_pango_context</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pango_context</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link> for
-the widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pango_context</methodname>() method returns
-the <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-with the appropriate colormap, font description and base direction for this
-widget. Unlike the context returned by the <link
-linkend="method-gtkwidget--create-pango-context"><methodname>create_pango_context</methodname>()</link>
-method, this context is owned by the widget (it can be used as long as
-widget exists), and will be updated to match any changes to the widget's
-attributes.</para>
-
- <para>If you create and keep a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> using
-this context, you must deal with changes to the context by calling the <link
-linkend="method-pangolayout--context-changed"><methodname>pango.Layout.context_changed</methodname>()</link>
-method on the layout in response to the "style-set" and "direction-set"
-signals for the widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--create-pango-layout">
- <title>gtk.Widget.create_pango_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_pango_layout</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the text to set on the
-layout</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>create_pango_layout</methodname>() method
-creates a new <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> with
-the appropriate colormap, font description, and base direction for drawing
-the specified <parameter>text</parameter> for this widget. If you keep a
-<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-created by this method, you must call <link
-linkend="method-pangolayout--context-changed"><methodname>pango.Layout.context_changed()</methodname></link>
-in response to the "style-set" and "direction-set" signals for the widget to
-notify the layout of changes to the base direction or font of this
-widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--render-icon">
- <title>gtk.Widget.render_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>render_icon</methodname>
- <methodparam><parameter
- role="keyword">stock_id</parameter></methodparam>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">detail</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
- <listitem><simpara>a stock ID</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>a stock size</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">detail</parameter>&nbsp;:</term>
- <listitem><simpara>the render detail to pass to the theme engine or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new pixbuf, or <literal>None</literal> if the
-stock ID wasn't known</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>render_icon</methodname>() method is a
-convenience method that uses the theme engine and RC file settings for the
-widget to look up the stock icon specified by
-<parameter>stock_id</parameter> of the specified <parameter>size</parameter>
-and to render it to a pixbuf that is returned.
-<parameter>stock_id</parameter> should be a stock icon ID such as
-<literal>gtk.STOCK_OPEN</literal> or <literal>gtk.STOCK_OK</literal>.
-<parameter>size</parameter> should be one of the <xref
-linkend="gtk-icon-size-constants"
-endterm="gtk-icon-size-constants-title"></xref>:</para>
-
- <para><parameter>detail</parameter> is an optional string that
-identifies the widget or code doing the rendering, so that theme engines can
-special-case rendering for that widget or code.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-composite-name">
- <title>gtk.Widget.set_composite_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_composite_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name to set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_composite_name</methodname>() method sets a
-widgets composite name to the value specified by
-<parameter>name</parameter>. The widget must be a composite child of its
-parent</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-composite-name">
- <title>gtk.Widget.get_composite_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_composite_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the composite name of the widget or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_composite_name</methodname>() method returns
-the composite name of a widget or <literal>None</literal> if the widget is
-not a composite.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--reset-rc-styles">
- <title>gtk.Widget.reset_rc_styles</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reset_rc_styles</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>reset_rc_styles</methodname>() method resets the
-styles of widget and all descendants to the correct values for the currently
-loaded RC file settings. This method is not useful for applications.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--style-get-property">
- <title>gtk.Widget.style_get_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>style_get_property</methodname>
- <methodparam><parameter role="keyword">property_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">property_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a style property</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the property value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>style_get_property</methodname>() method returns
-the value of a style property specified by
-<parameter>property_name</parameter>.</para>
-
- </refsect2>
-
-<!-- NOT IMPLEMENTED
- <refsect2 id="method-gtkwidget- -style-get">
- <title>gtk.Widget.style_get</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>style_get</methodname>
- <methodparam><parameter role="keyword">first_property_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">first_property_name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the first property to get</simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-Gets the values of a multiple style properties of the widget.
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
-
- <refsect2 id="method-gtkwidget--set-direction">
- <title>gtk.Widget.set_direction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_direction</methodname>
- <methodparam><parameter
- role="keyword">dir</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dir</parameter>&nbsp;:</term>
- <listitem><simpara>the new direction</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_direction</methodname>() method sets the
-"direction" property to the value specified by <parameter>dir</parameter>.
-The "direction" property determines the reading direction of the widget that
-controls the primary direction for widgets containing text, and also the
-direction in which the children of a container are packed. The ability to
-set the direction is to handle localization for languages with right-to-left
-reading directions. Generally, applications will use the default reading
-direction, except for containers that are arranged in an order that is
-explicitly visual rather than logical (such as buttons for text
-justification). The values of <parameter>dir</parameter> must be one of the
-<xref linkend="gtk-text-direction-constants"
-endterm="gtk-text-direction-constants-title"></xref>.</para>
-
- <para>If the direction is set to <literal>gtk.TEXT_DIR_NONE</literal>,
-then the value set by the <link
-linkend="function-gtk--widget-set-default-direction"><function>gtk.widget.set_default_direction</function>()</link>
-function will be used.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-direction">
- <title>gtk.Widget.get_direction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_direction</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the reading direction for the
-widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_direction</methodname>() method returns the
-reading direction for the widget. See the <link
-linkend="method-gtkwidget--set-direction"><methodname>set_direction</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--shape-combine-mask">
- <title>gtk.Widget.shape_combine_mask</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>shape_combine_mask</methodname>
- <methodparam><parameter
- role="keyword">shape_mask</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">offset_y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">shape_mask</parameter>&nbsp;:</term>
- <listitem><simpara>the shape to be added.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position of shape mask with respect to
-the widget's <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_y</parameter>&nbsp;:</term>
- <listitem><simpara>Y position of shape mask with respect to the
-widget's <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>shape_combine_mask</methodname>() method sets a
-shape for the widget's <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> using
-the mask specified by <parameter>shape_mask</parameter> at the location
-specified by <parameter>offset_x</parameter> and
-<parameter>offset_y</parameter>. This allows for transparent windows etc.,
-see the <link
-linkend="method-gdkwindow--shape-combine-mask"><methodname>gtk.gdk.Window.shape_combine_mask</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--reset-shapes">
- <title>gtk.Widget.reset_shapes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reset_shapes</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>reset_shapes</methodname>() method recursively
-resets the shapes of the widget and its descendants.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--path">
- <title>gtk.Widget.path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>path</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the widget's path</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>path</methodname>() method returns the full path
-to the widget. The path is simply the name of a widget and all its parents
-in the container hierarchy, separated by periods. The name of a widget comes
-from the <link
-linkend="method-gtkwidget--get-name"><methodname>get_name</methodname>()</link>
-method. Paths are used to apply styles to a widget in gtkrc configuration
-files. Widget names are the type of the widget by default (e.g.
-"GtkButton") or can be set to an application-specific value with the <link
-linkend="method-gtkwidget--set-name"><methodname>set_name</methodname>()</link>
-method. By setting the name of a widget, you allow users or theme authors
-to apply styles to that specific widget in their gtkrc file.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--class-path">
- <title>gtk.Widget.class_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>class_path</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the widget's class path</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>class_path</methodname>() method is similar to
-the <link
-linkend="method-gtkwidget--path"><methodname>path</methodname>()</link>
-method, but does not use a custom name set with the <link
-linkend="method-gtkwidget--set-name"><methodname>set_name</methodname>()</link>
-(e.g. always uses "GtkButton" even if a custom name is available).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--list-mnemonic-labels">
- <title>gtk.Widget.list_mnemonic_labels</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_mnemonic_labels</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the list of mnemonic labels</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>list_mnemonic_labels</methodname>() method
-returns a list of the widgets, normally labels, for which this widget is a
-the target of a mnemonic (see for example, the <link
-linkend="method-gtklabel--set-mnemonic-widget"><function>gtk.Label.set_mnemonic_widget()</function></link>
-method).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--add-mnemonic-label">
- <title>gtk.Widget.add_mnemonic_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_mnemonic_label</methodname>
- <methodparam><parameter>label</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>label</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
- that acts as a mnemonic label.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>add_mnemonic_label</methodname>() method adds
-the widget specified by <parameter>label</parameter> to the list of mnemonic
-labels for the widget.(See the <link
-linkend="method-gtkwidget--list-mnemonic-labels"><methodname>list_mnemonic_labels()</methodname></link>
-method for more detail).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--remove-mnemonic-label">
- <title>gtk.Widget.remove_mnemonic_label</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_mnemonic_label</methodname>
- <methodparam><parameter>label</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>label</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
- that was previously set as a mnemonic label.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>remove_mnemonic_label</methodname>() method
-removes the widget specified by <parameter>label</parameter> from the list
-of mnemonic labels for the widget. (See the <link
-linkend="method-gtkwidget--list-mnemonic-labels"><methodname>list_mnemonic_labels()</methodname></link>
-method). <parameter>label</parameter> must have previously been added to the
-list with the <link
-linkend="method-gtkwidget--add-mnemonic-label"><methodname>add_mnemonic_label()</methodname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--menu-get-for-attach-widget">
- <title>gtk.Widget.menu_get_for_attach_widget</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>menu_get_for_attach_widget</methodname>
- <methodparam><parameter role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of menus attached to this widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>menu_get_for_attach_widget</methodname>() method
-returns a list of the menus that are attached to this widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-activate-signal">
- <title>gtk.Widget.set_activate_signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_activate_signal</methodname>
- <methodparam><parameter role="keyword">signal_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>signal_name</emphasis>&nbsp;:</term>
- <listitem><simpara>a signal name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_activate_signal</methodname>() method sets
-the signal specified by <parameter>signal_name</parameter> as the signal to
-be emitted when the widget is activated for example by a call to the <link
-linkend="method-gtkwidget--activate"><methodname>activate</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--set-scroll-adjustments-signal">
- <title>gtk.Widget.set_scroll_adjustments_signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_scroll_adjustments_signal</methodname>
- <methodparam><parameter role="keyword">signal_name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>signal_name</emphasis>&nbsp;:</term>
- <listitem><simpara>a signal name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_scroll_adjustments_signal</methodname>()
-method sets the signal specified by <parameter>signal_name</parameter> as
-the signal to be emitted when the widget has its scroll adjustments set for
-example by a call to the <link
-linkend="method-gtkwidget--set-scroll-adjustments"><methodname>set_scroll_adjustments</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-action">
- <title>gtk.Widget.get_action</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_action</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkaction"><classname>gtk.Action</classname></link>
- that a widget is a proxy for, or <literal>None</literal>, if it is
- not attached to an action.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_action</methodname>() method returns the
- <link
- linkend="class-gtkaction"><classname>gtk.Action</classname></link>
- that <parameter>widget</parameter> is a proxy for. See also the <link
- linkend="method-gtkaction--get-proxies"><methodname>gtk.Action.get_proxies()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-dest-set-track-motion">
- <title>gtk.Widget.drag_dest_set_track_motion</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_dest_set_track_motion</methodname>
- <methodparam><parameter role="keyword">track_motion</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">track_motion</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> accept all
- targets</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>drag_dest_set_track_motion</methodname>() method
- tells the widget to emit "drag-motion" and "drag-leave" events
- regardless of the targets and the
- <literal>gtk.DEST_DEFAULT_MOTION</literal> flag.</para>
-
- <para>This may be used when a widget wants to do generic actions
- regardless of the targets that the source offers.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--drag-dest-get-track-motion">
- <title>gtk.Widget.drag_dest_get_track_motion</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>drag_dest_get_track_motion</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the widget always
- emits "drag-motion events"</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>drag_dest_get_track_motion</methodname>() method
- returns <literal>True</literal> if the widget has been configured to
- always emit "drag-motion" signals.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--is-composited">
- <title>gtk.Widget.is_composited</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_composited</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the widget can rely
- on its alpha channel being drawn correctly.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>is_composited</methodname>() method returns
- <literal>True</literal> if the widget can rely on having its alpha
- channel drawn correctly. On X11 this function returns whether a
- compositing manager is running for the widget's screen</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--input-shape-combine-mask">
- <title>gtk.Widget.input_shape_combine_mask</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>input_shape_combine_mask</methodname>
- <methodparam><parameter role="keyword">shape_mask</parameter></methodparam>
- <methodparam><parameter role="keyword">offset_x</parameter></methodparam>
- <methodparam><parameter role="keyword">offset_y</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">shape_mask</parameter>&nbsp;:</term>
- <listitem><simpara>shape to be added, or <literal>None</literal>
- to remove an existing shape.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_x</parameter>&nbsp;:</term>
- <listitem><simpara>X position of <parameter>shape_mask</parameter>
- with respect to the widget's window.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">offset_y</parameter>&nbsp;:</term>
- <listitem><simpara>Y position of <parameter>shape_mask</parameter>
- with respect to the widget's window.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>input_shape_combine_mask</methodname>() method
- sets an input shape for this widget's <link
- linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.
- This allows for windows that react to a mouse click in a
- nonrectangular region, see the <link
- linkend="method-gdkwindow--input-shape-combine-mask"><methodname>gtk.gdk.Window.input_shape_combine_mask</methodname>()</link>
- method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwidget--get-activate-signal">
- <title>gtk.Widget.get_activate_signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_activate_signal</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a signal name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <methodname>get_activate_signal</methodname>() method
- returns the name of the signal that is emitted when the widget is
- activated for example by a call to the <link
- linkend="method-gtkwidget--activate"><methodname>activate</methodname>()</link>
- method. See the <link
- linkend="method-gtkwidget--set-activate-signal"><methodname>set_activate_signal</methodname>()</link>
- method for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--widget-push-colormap">
- <title>gtk.widget_push_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_push_colormap</methodname>
- <methodparam><parameter
- role="keyword">cmap</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">cmap</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.widget_push_colormap</function>() function
-pushes the <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-specified by <parameter>cmap</parameter> onto a global stack of colormaps.
-The topmost colormap on the stack will be used when creating widgets. Remove
-<parameter>cmap</parameter> with the <link
-linkend="function-gtk--widget-pop-colormap"><function>gtk.widget_pop_colormap</function>()</link>
-function. There's little reason to use this function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-push-composite-child">
- <title>gtk.widget_push_composite_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_push_composite_child</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.widget_push_composite_child</function>()
-function creates all new widgets as composite children until the
-corresponding <link
-linkend="function-gtk--widget-pop-composite-child"><function>gtk.widget_pop_composite_child</function>()</link>
-function call. A composite child is a child that's an implementation detail
-of the container it's inside and should not be visible to people using the
-container. Composite children aren't treated differently (but see the <link
-linkend="method-gtkcontainer--foreach"><methodname>gtk.Container.foreach</methodname>()</link>
-method vs. the <link
-linkend="method-gtkcontainer--forall"><methodname>gtk.Container.forall</methodname>()</link>
-method), but e.g. GUI builders might want to treat them in a different
-way.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-pop-composite-child">
- <title>gtk.widget_pop_composite_child</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_pop_composite_child</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.widget_pop_composite_child</function>()
-function cancels the effect of a previous call to the <link
-linkend="function-gtk--widget-push-composite-child"><function>gtk.widget_push_composite_child</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-pop-colormap">
- <title>gtk.widget_pop_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_pop_colormap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <function>gtk.widget_pop_colormap</function>() function
-removes the <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-on the top of the global stack of colormaps. This function reverses the
-effect of the <link
-linkend="function-gtk--widget-push-colormap"><function>gtk.widget_push_colormap</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-get-default-style">
- <title>gtk.widget_get_default_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_get_default_style</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.widget_get_default_style</function>() function
-returns the default <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> used by all
-newly created widgets</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-set-default-colormap">
- <title>gtk.widget_set_default_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_set_default_colormap</methodname>
- <methodparam><parameter
- role="keyword">colormap</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">colormap</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.widget_set_default_colormap</function>()
-function sets the default <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-to use when creating widgets to the value specified by
-<parameter>colormap</parameter>. The <link
-linkend="function-gtk--widget-push-colormap"><function>gtk.widget_push_colormap</function>()</link>
-function is a better function to use if you only want to affect a few
-widgets, rather than all widgets.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-get-default-colormap">
- <title>gtk.widget_get_default_colormap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_get_default_colormap</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.widget_get_default_colormap</function>()
-function returns the default <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>
-used when creating new widgets.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-get-default-visual">
- <title>gtk.widget_get_default_visual</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_get_default_visual</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.widget_get_default_visual</function>()
-function returns the default <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> of
-the default <link
-linkend="class-gdkcolormap"><classname>gtk.gdk.Colormap</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-set-default-direction">
- <title>gtk.widget_set_default_direction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_set_default_direction</methodname>
- <methodparam><parameter
- role="keyword">dir</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dir</parameter>&nbsp;:</term>
- <listitem><simpara>the new default direction - either
-<literal>gtk.TEXT_DIR_RTL</literal> or
-<literal>gtk.TEXT_DIR_LTR</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.widget_set_default_direction</function>()
-function sets the default text direction to the value specified by
-<parameter>dir</parameter>. The value of <parameter>dir</parameter> must be
-either <literal>gtk.TEXT_DIR_RTL</literal> or
-<literal>gtk.TEXT_DIR_LTR</literal>. The default text direction is used for
-widgets that have not had a text direction set by the <link
-linkend="method-gtkwidget--set-direction"><methodname>set_direction</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-get-default-direction">
- <title>gtk.widget_get_default_direction</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_get_default_direction</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default text direction</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.widget_get_default_direction</function>()
-function returns the default text direction as set by the <link
-linkend="function-gtk--widget-set-default-direction"><function>gtk.widget_set_default_direction</function>()</link>
-function.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-class-find-style-property">
- <title>gtk.widget_class_find_style_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_class_find_style_property</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">property_name</parameter>&nbsp;:</term>
- <listitem><simpara>a style property name</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the style property as a GParam
- object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.widget_class_find_style_property</function>()
- function returns the GParam object corresponding to the style
- property specified by <parameter>property_name</parameter> of the <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
- specified by <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-class-list-style-properties">
- <title>gtk.widget_class_list_style_properties</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_class_list_style_properties</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of style properties as GParam objects </simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.widget_class_list_style_properties</function>()
-function returns a list of the style properties of the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> specified
-by <parameter>widget</parameter>. The list contains a GParam object for each
-style property.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--widget-class-install-style-property">
- <title>gtk.widget_class_install_style_property</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.widget_class_install_style_property</methodname>
- <methodparam><parameter
- role="keyword">widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pspec</parameter>&nbsp;:</term>
- <listitem><simpara>a 4-tuple containing the property spec</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The
-<function>gtk.widget_class_install_style_property</function>() function
-installs the style property specified by <parameter>pspec</parameter> on the
-<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-specified by <parameter>widget</parameter>. <parameter>pspec</parameter> is
-a 4-tuple containing the property name, the property type, a nickname (or
-<literal>None</literal>) and a description of the property (or None).</para>
-
- <para>This function raises the TypeError exception if
-<parameter>widget</parameter> is not a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> or if the
-property is already installed.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkwidget--accel-closures-changed">
- <title>The "accel-closures-changed" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "accel-closures-changed" signal is emitted when an
-accelerator is added to or removed from the <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
-for <parameter>widget</parameter> or an accelerator path is setup.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--button-press-event">
- <title>The "button-press-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "button-press-event" signal is emitted when a mouse button
-is pressed.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--button-release-event">
- <title>The "button-release-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "button-release-event" signal is emitted when a mouse button
-is released.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--can-activate-accel">
- <title>The "can-activate-accel" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>signal_id</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>signal_id</parameter>&nbsp;:</term>
- <listitem><simpara> the ID of a signal installed on
- <parameter>widget</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "can-activate-accel" signal is emitted when an accelerator
-is about to activate <parameter>widget</parameter>. The handler determines
-if the accelerator that activates the signal identified by
-<parameter>signal_id</parameter> can currently be activated. This signal is
-present to allow applications and derived widgets to override the default
-GtkWidget handling for determining whether an accelerator can be
-activated.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--child-notify">
- <title>The "child-notify" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>child_property</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>child_property</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a child property</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "child-notify" signal is emitted when
-<parameter>child_property</parameter> is changed.</para>
-
- <para>Child properties are available with objects derived from <link
-linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>. Those
-properties are not specific to either the container or the child widget but
-to their relation. For example, the "pack-type" property of <link
-linkend="class-gtkbox"><classname>gtk.Box</classname></link> or the
-"menu-label" property of <link
-linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link> are
-child properties.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--client-event">
- <title>The "client-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "client-event" signal is emitted when another application
-has sent an event to <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--composited-changed">
- <title>The "composited-changed" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--configure-event">
- <title>The "configure-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "configure-event" signal is emitted when the widget's window
-is allocated a size and width.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--delete-event">
- <title>The "delete-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "delete-event" signal is emitted when a request is made to
-delete <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--destroy-event">
- <title>The "destroy-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "destroy-event" signal is emitted when a <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> is
-destroyed. You rarely get this signal, because most widgets disconnect
-themselves from their window before they destroy it, so no widget owns the
-window at destroy time.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--direction-changed">
- <title>The "direction-changed" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>direction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>direction</parameter>&nbsp;:</term>
- <listitem><simpara>the previous direction:
-<literal>gtk.TEXT_DIR_NONE</literal>, <literal>gtk.TEXT_DIR_LTR</literal> or
-<literal>gtk.TEXT_DIR_RTL</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "direction-changed" signal is emitted when the reading
-direction of <parameter>widget</parameter> is changed (usually with the
-<link
-linkend="method-gtkwidget--set-direction"><methodname>set_direction</methodname>()</link>
-method)</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--drag-begin">
- <title>The "drag-begin" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>drag_context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "drag-begin" signal is emitted when the user initiates a
-drag operation on <parameter>widget</parameter>. A typical reason to connect
-to this signal is to set up a custom drag icon with the <link
-linkend="method-gtkwidget--drag-source-set-icon"><methodname>drag_source_set_icon</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--drag-data-delete">
- <title>The "drag-data-delete" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>drag_context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "drag-data-delete" signal is emitted when the drag completes
-a move operation and requires the source data to be deleted. The signal
-handler is responsible for deleting the data that has been dropped.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--drag-data-get">
- <title>The "drag-data-get" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>selection_data</parameter></methodparam>
- <methodparam><parameter>info</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>drag_context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>selection_data</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link> object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>info</parameter>&nbsp;:</term>
- <listitem><simpara>an integer ID for the drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the time of the drag event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "drag-data-get" signal is emitted when a drag operation
-completes that copies data or when a drag drop occurs using the
-<literal>gtk.gdk.DRAG_PROTO_ROOTWIN</literal> protocol. The drag source
-revceives this signal when the drag destination requests the data using the
-<link
-linkend="method-gtkwidget--drag-get-data"><methodname>drag_get_data</methodname>()</link>
-method. The handler needs to fill <parameter>selection_data</parameter> with
-the data in the format specified by the target associated with
-<parameter>info</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--drag-data-received">
- <title>The "drag-data-received" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>x</parameter></methodparam>
- <methodparam><parameter>y</parameter></methodparam>
- <methodparam><parameter>selection_data</parameter></methodparam>
- <methodparam><parameter>info</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>drag_context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position of the drop</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position of the drop</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>selection_data</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>info</parameter>&nbsp;:</term>
- <listitem><simpara>an integer ID for the drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the time of the drag event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "drag-data-received" signal is emitted when the drag
-destination receives the data from the drag operation. If the data was
-received in order to determine whether the drop will be accepted, the
-handler is expected to call the <link
-linkend="method-gdkdragcontext--drag-status"><methodname>gtk.gdk.DragContext.drag_status</methodname>()</link>
-method and not finish the drag. If the data was received in response to a
-"drag-drop" signal (and this is the last target to be received), the handler
-for this signal is expected to process the received data and then call the
-<link
-linkend="method-gdkdragcontext--finish"><methodname>gtk.gdk.DragContext.finish</methodname>()</link>
-method, setting the <parameter>success</parameter> parameter to
-<literal>True</literal> if the data was processed successfully.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--drag-drop">
- <title>The "drag-drop" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>x</parameter></methodparam>
- <methodparam><parameter>y</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>drag_context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position of the drop</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position of the drop</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the time of the drag event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the cursor is in a
- drop zone</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "drag-drop" signal is emitted when the drag initiates a drop
-operation on the destination <parameter>widget</parameter>. The signal
-handler must determine whether the cursor position is in a drop zone or
-not. If it is not in a drop zone, it returns <literal>False</literal> and no
-further processing is necessary. Otherwise, the handler returns
-<literal>True</literal>. In this case, the handler must ensure that the
-<link
-linkend="method-gdkdragcontext--finish"><methodname>gtk.gdk.DragContext.finish</methodname>()</link>
-method is called to let the source know that the drop is done. The call to
-the <link
-linkend="method-gdkdragcontext--finish"><methodname>gtk.gdk.DragContext.finish</methodname>()</link>
-method can be done either directly or in a "drag-data-received" handler that
-gets triggered by calling the <link
-linkend="method-gtkwidget--drag-get-data"><methodname>drag_get_data</methodname>()</link>
-method to receive the data for one or more of the supported targets.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--drag-end">
- <title>The "drag-end" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>drag_context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "drag-end" signal is emitted when the drag operation is
-completed. A typical reason to connect to this signal is to undo things done
-in a "drag-begin" handler.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--drag-leave">
- <title>The "drag-leave" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>drag_context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the time of the drag event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "drag-leave" signal is emitted when the drag operation moves
-off of a drop target widget. A typical reason to connect to this signal is
-to undo things done in a "drag-motion" handler, e.g. undo highlighting with
-the <link
-linkend="method-gtkwidget--drag-unhighlight"><methodname>drag_unhighlight</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--drag-motion">
- <title>The "drag-motion" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>drag_context</parameter></methodparam>
- <methodparam><parameter>x</parameter></methodparam>
- <methodparam><parameter>y</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>drag_context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gdkdragcontext"><classname>gtk.gdk.DragContext</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position of the drop</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position of the drop</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the time of the drag event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the cursor is in a
- drop zone</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "drag-motion" signal is emitted when the drag operation
-moves over a drop target widget. The signal handler must determine if the
-cursor position is in a drop zone or not. If it is not in a drop zone, it
-should return <literal>False</literal> and no further processing is
-necessary. Otherwise, the handler should return <literal>True</literal>. In
-this case, the handler is responsible for providing the necessary
-information for displaying feedback to the user, by calling the <link
-linkend="method-gdkdragcontext--drag-status"><methodname>gtk.gdk.DragContext.drag_status</methodname>()</link>
-method. If the decision to accept or reject the drop can't be made based
-solely on the cursor position and the type of the data, the handler may
-inspect the dragged data by calling the <link
-linkend="method-gtkwidget--drag-get-data"><methodname>drag_get_data</methodname>()</link>
-method and defer the <link
-linkend="method-gdkdragcontext--drag-status"><methodname>gtk.gdk.DragContext.drag_status</methodname>()</link>
-method call to the "drag-data-received" handler.</para>
-
- <note>
- <para>There is no "drag-enter" signal. The drag receiver has to keep
-track of any "drag-motion" signals received since the last "drag-leave"
-signal. The first "drag-motion" signal received after a "drag_leave" signal
-should be treated as an "enter" signal. Upon an "enter", the handler will
-typically highlight the drop site with the <link
-linkend="method-gtkwidget--drag-highlight"><methodname>drag_highlight</methodname>()</link>
-method.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--enter-notify-event">
- <title>The "enter-notify-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "enter-notify-event" signal is emitted when the mouse
-pointer enters <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--event">
- <title>The "event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "event" signal is emitted when any <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> occurs
-on <parameter>widget</parameter>. The "event" signal is emitted before any
-of the specific <link
-linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link> signals
-are emitted.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--event-after">
- <title>The "event-after" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "event-after" signal is emitted after any other event
-handling has occurred for <parameter>widget</parameter></para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--expose-event">
- <title>The "expose-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "expose-event" signal is emitted when
-<parameter>widget</parameter> needs to be repainted because it is first
-displayed or has been partially or fully obscured by another window.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--focus">
- <title>The "focus" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>direction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>direction</parameter>&nbsp;:</term>
- <listitem><simpara>the direction:
-<literal>gtk.DIR_TAB_FORWARD</literal>,
-<literal>gtk.DIR_TAB_BACKWARD</literal>, <literal>gtk.DIR_UP</literal>,
-<literal>gtk.DIR_DOWN</literal>, <literal>gtk.DIR_LEFT</literal> or
-<literal>gtk.DIR_RIGHT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "focus" signal is emitted when <parameter>widget</parameter>
-receives the focus.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--focus-in-event">
- <title>The "focus-in-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "focus-in-event" signal is emitted when the focus changes to
-<parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--focus-out-event">
- <title>The "focus-out-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "focus-out-event" signal is emitted when the focus leaves
-<parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--grab-broken-event">
- <title>The "grab-broken-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the object which received the
- signal.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the gtk.gdk.EventGrabBroken
- event</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
- with the <link
- linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
- method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.8 and above.</para>
- </note>
-
- <para>Emitted when a pointer or keyboard grab on a window belonging to
- <parameter>widget</parameter> gets broken. </para>
-
- <para>On X11, this happens when the grab window becomes unviewable
- (i.e. it or one of its ancestors is unmapped), or if the same
- application grabs the pointer or keyboard again.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--grab-focus">
- <title>The "grab-focus" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "grab-focus" signal is emitted when
-<parameter>widget</parameter> grabs the focus usually by calling the <link
-linkend="method-gtkwidget--grab-focus"><methodname>grab_focus</methodname>()</link>
-method or by the user using a mnemonic accelerator..</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--grab-notify">
- <title>The "grab-notify" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>was_grabbed</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>was_grabbed</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>
-<parameter>widget</parameter> had grabbed the focus</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "grab-notify" signal is emitted when widget (or its
-ancestor) either is grabbing the focus or has the focus grabbed from
-it.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--hide">
- <title>The "hide" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "hide" signal is emitted when <parameter>widget</parameter>
-is hidden usually by calling the <link
-linkend="method-gtkwidget--hide"><methodname>hide</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--hierarchy-changed">
- <title>The "hierarchy-changed" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>previous_toplevel</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>previous_toplevel</parameter>&nbsp;:</term>
- <listitem><simpara>the toplevel widget in the previous hierarchy
-containing <parameter>widget</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "hierarchy-changed" signal is emitted when
-<parameter>widget</parameter> is unparented or has a new parent set.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--key-press-event">
- <title>The "key-press-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "key-press-event" signal is emitted when the user presses a
-key on the keyboard.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--key-release-event">
- <title>The "key-release-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "key-release-event" signal is emitted when the user releases
-a key on the keyboard.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--leave-notify-event">
- <title>The "leave-notify-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "leave-notify-event" signal is emitted when the mouse
-pointer leaves the area of <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--map">
- <title>The "map" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "map" signal is emitted when <parameter>widget</parameter>
-requests to be mapped onto the display usually by calling the <link
-linkend="method-gtkwidget--show"><methodname>show</methodname>()</link> or
-<link linkend="method-gtkwidget--map"><methodname>map</methodname>()</link>
-methods.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--map-event">
- <title>The "map-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "map-event" signal is emitted when
-<parameter>widget</parameter> has been mapped onto the display.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--mnemonic-activate">
- <title>The "mnemonic-activate" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>group_cycling</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>group_cycling</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> shifts the focus instead of activating <parameter>widget</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "mnemonic-activate" signal is emitted when the user uses a
-mnemonic accelerator to activate <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--motion-notify-event">
- <title>The "motion-notify-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "motion-notify-event" signal is emitted when the mouse
-pointer moves while over <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--no-expose-event">
- <title>The "no-expose-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "no-expose-event" signal is emitted when a no expose event
-occurs.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--parent-set">
- <title>The "parent-set" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>old_parent</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>old_parent</parameter>&nbsp;:</term>
- <listitem><simpara>the previous parent of
-<parameter>widget</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "parent-set" signal is emitted when the parent of
-<parameter>widget</parameter> is set or unset.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--popup-menu">
- <title>The "popup-menu" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a menu was
- activated</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "popup-menu" signal is emitted when the user presses the
-<keycombo
-action="simul"><keycap>Shift</keycap><keycap>F10</keycap></keycombo> or
-<keycap>Menu</keycap> keys when <parameter>widget</parameter> has the focus
-to popup a menu.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--property-notify-event">
- <title>The "property-notify-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "property-notify-event" signal is emitted when a window
-property value has changed. This is used for selection data
-retrieval.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--proximity-in-event">
- <title>The "proximity-in-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "proximity-in-event" (available for devices like touch
-screens or graphics tablets) is emitted when the pen touches the tablet or
-when the user's finger touches the screen.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--proximity-out-event">
- <title>The "proximity-out-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "proximity-out-event" (available for devices like touch
-screens or graphics tablets) is emitted when the pen leaves the tablet or
-when the user's finger leaves the screen.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--realize">
- <title>The "realize" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "realize" signal is emitted when
-<parameter>widget</parameter> requests to be realized by calling the <link
-linkend="method-gtkwidget--realize"><methodname>realize</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--screen-changed">
- <title>The "screen-changed" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>screen</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <varlistentry>
- <term><parameter>screen</parameter>&nbsp;:</term>
- <listitem><simpara>the new <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara></listitem>
- </varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This signal is available in GTK+ 2.4 and above.</para>
- </note>
-
- <para>The "screen-changed" signal is emitted when
-<parameter>screen</parameter> becomes the new <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link> for
-<parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--scroll-event">
- <title>The "scroll-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "scroll-event" signal is emitted when widget receives a
-scroll event.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--selection-clear-event">
- <title>The "selection-clear-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "selection-clear-event" signal is emitted when the selection
-needs to be cleared.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--selection-get">
- <title>The "selection-get" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>selection_data</parameter></methodparam>
- <methodparam><parameter>info</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>selection_data</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>info</parameter>&nbsp;:</term>
- <listitem><simpara>an integer ID for the
-selection</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the time the event
-occurred</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "selection-get" signal is emitted when the selection data is
-requested from <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--selection-notify-event">
- <title>The "selection-notify-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "selection-notify-event" signal is emitted when the
-selection owner has responded to the selection conversion request.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--selection-received">
- <title>The "selection-received" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>selection_data</parameter></methodparam>
- <methodparam><parameter>timestamp</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>selection_data</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkselectiondata"><classname>gtk.SelectionData</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the time the event
-occurred</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "selection-received" signal is emitted when the selection
-owner has responded to the request for the selection data.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--selection-request-event">
- <title>The "selection-request-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "selection-request-event" signal is emitted when a selection
-request is made on <parameter>widget</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--show">
- <title>The "show" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "show" signal is emitted when <parameter>widget</parameter>
-requests to be displayed using either the <link
-linkend="method-gtkwidget--show"><methodname>show</methodname>()</link> or
-<link
-linkend="method-gtkwidget--show-all"><methodname>show_all</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--show-help">
- <title>The "show-help" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>help_type</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>help_type</parameter>&nbsp;:</term>
- <listitem><simpara>the help type; either
-<literal>gtk.WIDGET_HELP_TOOLTIP</literal> or
-<literal>gtk.WIDGET_HELP_WHATS_THIS</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "show-help" signal is emitted when the user presses the
-<keycombo
-action="simul"><keycap>Control</keycap><keycap>F1</keycap></keycombo> key
-combination.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--size-allocate">
- <title>The "size-allocate" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>allocation</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>allocation</parameter>&nbsp;:</term>
- <listitem><simpara>the widget's space allocation in a <link
-linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "size-allocate" signal is emitted when widget is given a new
-space allocation.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--size-request">
- <title>The "size-request" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>requisition</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>requisition</parameter>&nbsp;:</term>
- <listitem><simpara>the widget's requested size as a <link
-linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "size-request" signal is emitted when a new size is
-requested for <parameter>widget</parameter> using the <link
-linkend="method-gtkwidget--set-size-request"><methodname>set_size_request</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--state-changed">
- <title>The "state-changed" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>state</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>state</parameter>&nbsp;:</term>
- <listitem><simpara>the previous widget state:
-<literal>gtk.STATE_NORMAL</literal>, <literal>gtk.STATE_ACTIVE</literal>,
-<literal>gtk.STATE_PRELIGHT</literal>, <literal>gtk.STATE_SELECTED</literal>
-or <literal>gtk.STATE_INSENSITIVE</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "state-changed" signal is emitted when the state of
-<parameter>widget</parameter> changes.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--style-set">
- <title>The "style-set" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>previous_style</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>previous_style</parameter>&nbsp;:</term>
- <listitem><simpara>the previous widget <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "style-set" signal is emitted when the <link
-linkend="class-gtkstyle"><classname>gtk.Style</classname></link> of
-<parameter>widget</parameter> is set.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--unmap">
- <title>The "unmap" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "unmap" signal is emitted when <parameter>widget</parameter>
-requests to be unmapped from the display.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--unmap-event">
- <title>The "unmap-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "unmap-event" signal is emitted when
-<parameter>widget</parameter> has been unmapped from the display.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--unrealize">
- <title>The "unrealize" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "unrealize" signal is emitted when
-<parameter>widget</parameter> requests to be unrealized (i.e. have all its
-resources released).</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--visibility-notify-event">
- <title>The "visibility-notify-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "visibility-notify-event" signal is emitted when the
-visibility of <parameter>widget</parameter> changes i.e. it has been
-obscured or unobscured.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwidget--window-state-event">
- <title>The "window-state-event" gtk.Widget Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "window-state-event" signal is emitted when window state of
-widget changes. For example, for a toplevel window this event is signaled
-when the window is iconified, deiconified, minimized, maximized, made
-sticky, made not sticky, shaded or unshaded.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkwindow.xml b/docs/reference/pygtk-gtkwindow.xml
deleted file mode 100644
index 7183c4fb..00000000
--- a/docs/reference/pygtk-gtkwindow.xml
+++ /dev/null
@@ -1,4223 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkwindow">
- <refnamediv>
- <refname>gtk.Window</refname>
- <refpurpose>a top-level window that holds one child widget.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.Window</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkwindow">gtk.Window</link></methodname>
- <methodparam><parameter role="keyword">type</parameter>
- <initializer>gtk.WINDOW_TOPLEVEL</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-title">set_title</link></methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-title">get_title</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-wmclass">set_wmclass</link></methodname>
- <methodparam><parameter
- role="keyword">wmclass_name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">wmclass_class</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-role">set_role</link></methodname>
- <methodparam><parameter
- role="keyword">role</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-role">get_role</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--add-accel-group">add_accel_group</link></methodname>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--remove-accel-group">remove_accel_group</link></methodname>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-position">set_position</link></methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--activate-focus">activate_focus</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-focus">set_focus</link></methodname>
- <methodparam><parameter
- role="keyword">focus</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-focus">get_focus</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-default">set_default</link></methodname>
- <methodparam><parameter
- role="keyword">default_widget</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--activate-default">activate_default</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-transient-for">set_transient_for</link></methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-transient-for">get_transient_for</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-type-hint">set_type_hint</link></methodname>
- <methodparam><parameter
- role="keyword">hint</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-type-hint">get_type_hint</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-destroy-with-parent">set_destroy_with_parent</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-destroy-with-parent">get_destroy_with_parent</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-resizable">set_resizable</link></methodname>
- <methodparam><parameter
- role="keyword">resizable</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-resizable">get_resizable</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-gravity">set_gravity</link></methodname>
- <methodparam><parameter
- role="keyword">gravity</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-gravity">get_gravity</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-geometry-hints">set_geometry_hints</link></methodname>
- <methodparam><parameter
- role="keyword">geometry_widget</parameter></methodparam>
- <methodparam><parameter role="keyword">min_width</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">min_height</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">max_width</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">max_height</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">base_width</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">base_height</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">width_inc</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">height_inc</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">min_aspect</parameter>
- <initializer>-1.0</initializer></methodparam>
- <methodparam><parameter role="keyword">max_aspect</parameter>
- <initializer>-1.0</initializer></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--set-screen">set_screen</link></methodname>
- <methodparam><parameter
- role="keyword">screen</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--get-screen">get_screen</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--is-active">is_active</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--has-toplevel-focus">has_toplevel_focus</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-has-frame">set_has_frame</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-has-frame">get_has_frame</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-frame-dimensions">set_frame_dimensions</link></methodname>
- <methodparam><parameter
- role="keyword">left</parameter></methodparam>
- <methodparam><parameter role="keyword">top</parameter></methodparam>
- <methodparam><parameter
- role="keyword">right</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bottom</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-frame-dimensions">get_frame_dimensions</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-decorated">set_decorated</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-decorated">get_decorated</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-icon-list">set_icon_list</link></methodname>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-icon-list">get_icon_list</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-icon">set_icon</link></methodname>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-icon-from-file">set_icon_from_file</link></methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-icon">get_icon</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-modal">set_modal</link></methodname>
- <methodparam><parameter
- role="keyword">modal</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-modal">get_modal</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--add-mnemonic">add_mnemonic</link></methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--remove-mnemonic">remove_mnemonic</link></methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--mnemonic-activate">mnemonic_activate</link></methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">modifier</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-mnemonic-modifier">set_mnemonic_modifier</link></methodname>
- <methodparam><parameter
- role="keyword">modifier</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-mnemonic-modifier">get_mnemonic_modifier</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--activate-key">activate_key</link></methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--propagate-key-event">propagate_key_event</link></methodname>
- <methodparam><parameter
- role="keyword">event</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--present">present</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--iconify">iconify</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--deiconify">deiconify</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--stick">stick</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--unstick">unstick</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--maximize">maximize</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--unmaximize">unmaximize</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--fullscreen">fullscreen</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--unfullscreen">unfullscreen</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--set-keep-above">set_keep_above</link></methodname>
- <methodparam><parameter>setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--set-keep-below">set_keep_below</link></methodname>
- <methodparam><parameter>setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--begin-resize-drag">begin_resize_drag</link></methodname>
- <methodparam><parameter
- role="keyword">edge</parameter></methodparam>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">timestamp</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--begin-move-drag">begin_move_drag</link></methodname>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">timestamp</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-default-size">set_default_size</link></methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-default-size">get_default_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--resize">resize</link></methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-size">get_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--move">move</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-position">get_position</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--parse-geometry">parse_geometry</link></methodname>
- <methodparam><parameter
- role="keyword">geometry</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--reshow-with-initial-size">reshow_with_initial_size</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--tooltips-get-info-from-tip-window">tooltips_get_info_from_tip_window</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-focus-on-map">set_focus_on_map</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-focus-on-map">get_focus_on_map</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-icon-name">set_icon_name</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-icon-name">get_icon_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--set-urgency-hint">set_urgency_hint</link></methodname>
- <methodparam><parameter
- role="keyword">urgency_hint</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--get-urgency-hint">get_urgency_hint</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindow--present-with-time">present_with_time</link></methodname>
- <methodparam><parameter
- role="keyword">timestamp</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--set-deletable">set_deletable</link></methodname>
- <methodparam><parameter role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--get-deletable">get_deletable</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkwindow--get-group">get_group</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--window-set-default-icon">gtk.window_set_default_icon</link></methodname>
- <methodparam><parameter role="keyword">icon</parameter></methodparam> </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--window-set-default-icon-from-file">gtk.window_set_default_icon_from_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam> </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--window-set-default-icon-list">gtk.window_set_default_icon_list</link></methodname>
- <methodparam><parameter>...</parameter></methodparam> </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--window-get-default-icon-list">gtk.window_get_default_icon_list</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--window-set-auto-startup-notification">gtk.window_set_auto_startup_notification</link></methodname>
- <methodparam><parameter role="keyword">setting</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-gtk--window-list-toplevels">gtk.window_list_toplevels</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-gtk--window-set-default-icon-name">gtk.window_set_default_icon_name</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkwidget">gtk.Widget</link>
- +-- <link linkend="class-gtkcontainer">gtk.Container</link>
- +-- <link linkend="class-gtkbin">gtk.Bin</link>
- +-- <link linkend="class-gtkwindow">gtk.Window</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="properties-gtkwindow">
- <title>gtk.Window Properties</title>
-
- <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
- <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
- <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"accept-focus"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the window should receive
-the input focus. Default value: <literal>True</literal>. Available in GTK+
-2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"allow-grow"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the user can expand the
-window beyond its minimum size. Default value: <literal>True</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"allow-shrink"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the window has no minimum
-size. Setting this to <literal>True</literal> is a bad
-idea 99% of the time. Default value: <literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"decorated"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the window should be
-decorated by the window manager. Default value: <literal>True</literal>.
-Available in GTK+ 2.4 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"default-height"</entry>
- <entry>Read-Write</entry>
- <entry>The default height of the window, used when initially
-showing the window. Allowed values: >= -1. Default value: -1</entry>
- </row>
-
- <row valign="top">
- <entry>"default-width"</entry>
- <entry>Read-Write</entry>
- <entry>The default width of the window, used when initially
-showing the window. Allowed values: >= -1. Default value: -1</entry>
- </row>
-
- <row valign="top">
- <entry>"deletable"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal> the window frame should have
- a close button. This property is available in GTK+ 2.10 and
- above.</entry>
- </row>
-
- <row valign="top">
- <entry>"destroy-with-parent"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the window should be
-destroyed when its parent is destroyed. Default value:
-<literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"focus-on-map"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the window should
-receive the input focus when mapped. Default value:
-<literal>True</literal>. Available in GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"gravity"</entry>
- <entry>Read-Write</entry>
-
- <entry>The window gravity of the window. See the <link
-linkend="method-gtkwindow--move"><methodname>move</methodname>()</link>
-method and the <xref linkend="gdk-gravity-constants"
-endterm="gdk-gravity-constants-title"></xref> for more details about window
-gravity. Default value:
-<literal>gtk.gdk.GRAVITY_NORTH_WEST</literal>. Available in GTK+ 2.4 and
-above.</entry>
- </row>
-
- <row valign="top">
- <entry>"has-toplevel-focus"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal>, the input focus is within
-the window. Default value: <literal>False</literal>. Available in GTK+ 2.2
-and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"icon"</entry>
- <entry>Read-Write</entry>
- <entry>The icon for this window</entry>
- </row>
-
- <row valign="top">
- <entry>"icon-name"</entry>
- <entry>Read-Write</entry>
- <entry>The name of the themed icon to use as the window icon.
-See <link
-linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>
-for more details. Default value: <literal>None</literal>. Available in
-GTK+ 2.6 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"is-active"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal>, the toplevel is the current
-active window. Default value: <literal>False</literal>. Available in GTK+ 2.2
-and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"modal"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the window is modal (other
-windows are not usable while this one is up). Default value:
-<literal>False</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"resizable"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the user can resize the
-window. Default value: <literal>True</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"role"</entry>
- <entry>Read-Write</entry>
- <entry>Unique identifier for the window to be used when
-restoring a session. Default value: <literal>None</literal>. Available in
-GTK+ 2.4</entry>
- </row>
-
- <row valign="top">
- <entry>"screen"</entry>
- <entry>Read-Write</entry>
- <entry>The screen where this window will be displayed.
-Available in GTK+ 2.2</entry>
- </row>
-
- <row valign="top">
- <entry>"skip-pager-hint"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the window should not be
-in the pager. Default value: <literal>False</literal>. Available in GTK+ 2.2
-and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"skip-taskbar-hint"</entry>
- <entry>Read-Write</entry>
- <entry>If <literal>True</literal>, the window should not be
-in the task bar. Default value: <literal>False</literal>. Available in GTK+
-2.2 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"title"</entry>
- <entry>Read-Write</entry>
- <entry>The title of the window. Default value: <literal>None</literal>.</entry>
- </row>
-
- <row valign="top">
- <entry>"transient-for"</entry>
- <entry>Read-Write-Construct</entry>
- <entry>The transient parent of the window. See <link
- linkend="method-gtkwindow--set-transient-for"><methodname>gtk.Window.set_transient_for()</methodname></link>
- for more details about transient windows. This property is
- available in GTK+ 2.10 and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read-Write</entry>
- <entry>The type of the window. Default value:
-<literal>gtk.WINDOW_TOPLEVEL</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"type-hint"</entry>
- <entry>Read-Write</entry>
- <entry>Hint to help the desktop environment understand what
-kind of window this is and how to treat it. Default value:
-<literal>gtk.gdk.WINDOW_TYPE_HINT_NORMAL</literal>. Available in GTK+ 2.2
-and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"urgency-hint"</entry>
- <entry>Read-Write</entry>
- <entry>If True the window should be brought to the users
-attention. Default value: <literal>False</literal>. Available in GTK+ 2.8
-and above.</entry>
- </row>
-
- <row valign="top">
- <entry>"window-position"</entry>
- <entry>Read-Write</entry>
- <entry>The initial position of the window. Default value:
-<literal>gtk.WIN_POS_NONE</literal></entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="style-properties-gtkwindow">
- <title>gtk.Window Style Properties</title>
-
- <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"allow_grow"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal>, users can expand the window
-beyond its minimum size.</entry>
- </row>
-
- <row valign="top">
- <entry>"allow_shrink"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal>, the window has no minimum
-size.</entry>
- </row>
-
- <row valign="top">
- <entry>"configure_notify_received"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> a window resize
-configuration event has been received.</entry>
- </row>
-
- <row valign="top">
- <entry>"configure_request_count"</entry>
- <entry>Read</entry>
- <entry>The number of outstanding configuration
-requests.</entry>
- </row>
-
- <row valign="top">
- <entry>"decorated"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the window will have
-decorations like a titlebar, resize controls, etc. See the <link
-linkend="method-gtkwindow--set-decorated"><methodname>set_decorated</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"default_widget"</entry>
- <entry>Read</entry>
- <entry>The child widget that will be activated by default. See
-the <link
-linkend="method-gtkwindow--set-default"><methodname>set_default</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"destroy_with_parent"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the window is destroyed when
-its transient parent is destroyed.</entry>
- </row>
-
- <row valign="top">
- <entry>"focus_widget"</entry>
- <entry>Read</entry>
- <entry>The child widget that has the focus.</entry>
- </row>
-
- <row valign="top">
- <entry>"frame"</entry>
- <entry>Read</entry>
- <entry>The frame <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> (if
-any). See the <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-and <link
-linkend="method-gtkwindow--set-frame-dimensions"><methodname>set_frame_dimensions</methodname>()</link>
-methods.</entry>
- </row>
-
- <row valign="top">
- <entry>"frame_bottom"</entry>
- <entry>Read</entry>
- <entry>The height of the bottom frame border. See the <link
-linkend="method-gtkwindow--set-frame-dimensions"><methodname>set_frame_dimensions</methodname>()</link>
-and <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-methods.</entry>
- </row>
-
- <row valign="top">
- <entry>"frame_left"</entry>
- <entry>Read</entry>
- <entry>The width of the left frame border. See the <link
-linkend="method-gtkwindow--set-frame-dimensions"><methodname>set_frame_dimensions</methodname>()</link>
-and <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-methods.</entry>
- </row>
-
- <row valign="top">
- <entry>"frame_right"</entry>
- <entry>Read</entry>
- <entry>The width of the right frame border. See the <link
-linkend="method-gtkwindow--set-frame-dimensions"><methodname>set_frame_dimensions</methodname>()</link>
-and <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-methods.</entry>
- </row>
-
- <row valign="top">
- <entry>"frame_top"</entry>
- <entry>Read</entry>
- <entry>The height of the top frame border. See the <link
-linkend="method-gtkwindow--set-frame-dimensions"><methodname>set_frame_dimensions</methodname>()</link>
-and <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-methods.</entry>
- </row>
-
- <row valign="top">
- <entry>"gravity"</entry>
- <entry>Read</entry>
- <entry>The window's gravity. See the <link
-linkend="method-gtkwindow--move"><methodname>move</methodname>()</link> and
-<link
-linkend="method-gtkwindow--set-gravity"><methodname>set_gravity</methodname>()</link>
-methods.</entry>
- </row>
-
- <row valign="top">
- <entry>"group"</entry>
- <entry>Read</entry>
- <entry>The <link
-linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link>
-(if any) the window belongs to.</entry>
- </row>
-
- <row valign="top">
- <entry>"has_focus"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the window has the
-focus.</entry>
- </row>
-
- <row valign="top">
- <entry>"has_frame"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the window has a frame
-window. See the <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"has_user_ref_count"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the window has not been
-destroyed.</entry>
- </row>
-
- <row valign="top">
- <entry>"iconify_initially"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the window has been
-iconified by a call to the <link
-linkend="method-gtkwindow--iconify"><methodname>iconify</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"keys_changed_handler"</entry>
- <entry>Read</entry>
- <entry>The idle handler ID for handling accelerator group
-changes.</entry>
- </row>
-
- <row valign="top">
- <entry>"maximize_initially"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the window has been
-maximized by a call to the <link
-linkend="method-gtkwindow--maximize"><methodname>maximize</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"mnemonic_modifier"</entry>
- <entry>Read</entry>
- <entry>The mnemonic modifier used with a key to activate an
-accelerator. See the <link
-linkend="method-gtkwindow--set-mnemonic-modifier"><methodname>set_mnemonic_modifier</methodname>()</link>
-method </entry>
- </row>
-
- <row valign="top">
- <entry>"modal"</entry>
- <entry>Read</entry>
- <entry>If True the window is modal. See the <link
-linkend="method-gtkwindow--set-modal"><methodname>set_modal</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"need_default_position"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the window needs an initial
-position calculated.</entry>
- </row>
-
- <row valign="top">
- <entry>"need_default_size"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the window needs an initial
-size calculated.</entry>
- </row>
-
- <row valign="top">
- <entry>"position"</entry>
- <entry>Read</entry>
- <entry>The initial position of the window. See the <link
-linkend="method-gtkwindow--set-position"><methodname>set_position</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"stick_initially"</entry>
- <entry>Read</entry>
- <entry>If <literal>True</literal> the window has been made
-sticky by a call to the <link
-linkend="method-gtkwindow--stick"><methodname>stick</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"title"</entry>
- <entry>Read</entry>
- <entry>The title of the window.</entry>
- </row>
-
- <row valign="top">
- <entry>"transient_parent"</entry>
- <entry>Read</entry>
- <entry>The transient parent window. See the <link
-linkend="method-gtkwindow--set-transient-for"><methodname>set_transient_for</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The type of the window: gtk.WINDOW_TOPLEVEL or gtk.WINDOW_POPUP.</entry>
- </row>
-
- <row valign="top">
- <entry>"type_hint"</entry>
- <entry>Read</entry>
- <entry>The window's type hint. See the <link
-linkend="method-gtkwindow--set-type-hint"><methodname>set_type_hint</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"wmclass_class"</entry>
- <entry>Read</entry>
- <entry>The window system class hint. See the <link
-linkend="method-gtkwindow--set-wmclass"><methodname>set_wmclass</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"wmclass_name"</entry>
- <entry>Read</entry>
- <entry>The window system name hint. See the <link
-linkend="method-gtkwindow--set-wmclass"><methodname>set_wmclass</methodname>()</link>
-method.</entry>
- </row>
-
- <row valign="top">
- <entry>"wm_role"</entry>
- <entry>Read</entry>
- <entry>The unique identifier for the window. See the <link
-linkend="method-gtkwindow--set-role"><methodname>set_role</methodname>()</link>
-method.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkwindow">
- <title>gtk.Window Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
- <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
-
- <variablelist>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkwindow--activate-default">activate-default</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkwindow--activate-focus">activate-focus</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkwindow--frame-event">frame-event</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkwindow--keys-changed">keys-changed</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkwindow--move-focus">move-focus</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>direction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>"<link
-linkend="signal-gtkwindow--set-focus">set-focus</link>"</term>
- <listitem>
- <methodsynopsis
- language="python"><methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> provides
-a widget that users commonly think of as a window. That is, an area of the
-display that is managed by the window manager and usually decorated with a
-title bar, and items to allow the user to close, resize and move the
-window. <literal>PyGTK</literal> provides two types of windows (see the
-<xref linkend="gtk-window-type-constants"
-endterm="gtk-window-type-constants-title"></xref> section for more
-information):</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.WINDOW_TOPLEVEL</literal></term>
- <listitem>
- <simpara>A window that has no parent and usually has a frame and
-decorations supplied by a window manager. Toplevels windows are the main
-application window and dialogs.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.WINDOW_POPUP</literal></term>
- <listitem>
- <simpara>A window that is ignored by the window manager and has no
-frame or decorations. A popup window is used for menus and
-tooltips.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>Typically, applications only directly create and use toplevel
-windows.</para>
-
- <para>A <link linkend="class-gtkwindow"><classname>gtk.Window</classname></link> is a container (subclass of <link linkend="class-gtkbin"><classname>gtk.Bin</classname></link>) holding one child widget.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkwindow">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.Window</methodname>
- <methodparam><parameter role="keyword">type</parameter>
- <initializer>gtk.WINDOW_TOPLEVEL</initializer></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the type of window:
-<literal>gtk.WINDOW_TOPLEVEL</literal> or
-<literal>gtk.WINDOW_POPUP</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>, which is
-a toplevel window that can contain other widgets. Nearly always, the type of
-the window should be <literal>gtk.WINDOW_TOPLEVEL</literal> (see the <xref
-linkend="gtk-window-type-constants"
-endterm="gtk-window-type-constants-title"></xref> for more details).
-<literal>gtk.WINDOW_POPUP</literal> is used to create a pop-up menu or
-pop-up tooltip. On X11, popup windows are not controlled by the window
-manager. If you simply want an undecorated window (no window borders), use
-the <link
-linkend="method-gtkwindow--set-decorated"><methodname>set_decorated</methodname>()</link>
-method with a toplevel window, don't use a popup window.</para>
-
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkwindow--set-title">
- <title>gtk.Window.set_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_title</methodname>
- <methodparam><parameter
- role="keyword">title</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">title</parameter>&nbsp;:</term>
- <listitem><simpara>the title of the window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_title</methodname>() method sets the "title" property
-of the <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> to the
-value specified by <parameter>title</parameter>. The title of a window will
-be displayed in its title bar. On the X Window System, the title bar is
-rendered by the window manager, so exactly how the title appears to users
-may vary according to a user's exact configuration. The title should help a
-user distinguish this window from other windows they may have open. A good
-title might include the application name and current document
-filename.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-title">
- <title>gtk.Window.get_title</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_title</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the title of the window, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_title</methodname>() method returns the
-value of the "title" property of the window. See the <link
-linkend="method-gtkwindow--set-title"><methodname>set_title</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-wmclass">
- <title>gtk.Window.set_wmclass</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_wmclass</methodname>
- <methodparam><parameter
- role="keyword">wmclass_name</parameter></methodparam>
- <methodparam><parameter
- role="keyword">wmclass_class</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">wmclass_name</parameter>&nbsp;:</term>
- <listitem><simpara>the window name hint</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">wmclass_class</parameter>&nbsp;:</term>
- <listitem><simpara>the window class hint</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_wmclass</methodname>() method sets the X
-Window System "class" and "name" hints for a window. Applications should not
-call this method. According to the ICCCM, you should always set these to the
-same value for all windows in an application, and <literal>PyGTK</literal>
-sets them to that value by default, so calling this method is sort of
-pointless. However, you may want to call the <link
-linkend="method-gtkwindow--set-role"><methodname>set_role</methodname>()</link>
-method on each window in your application, for the benefit of the session
-manager. Setting the role allows the window manager to restore window
-positions when loading a saved session.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-role">
- <title>gtk.Window.set_role</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_role</methodname>
- <methodparam><parameter
- role="keyword">role</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">role</parameter>&nbsp;:</term>
- <listitem><simpara>a unique identifier for the
-window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_role</methodname>() method sets a unique
-identifier (specified by <parameter>role</parameter>) for the window to be
-used when restoring a session. This method is only useful on X11. In
-combination with the window title, the window role allows a window manager
-to identify "the same" window when an application is restarted. So for
-example you might set the "toolbox" role on your app's toolbox window, so
-that when the user restarts their session, the window manager can put the
-toolbox back in the same place. If a window already has a unique title, you
-don't need to set the role, since the WM can use the title to identify the
-window when restoring the session.d</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-role">
- <title>gtk.Window.get_role</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_role</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the role of the window if set, or
-<literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_role</methodname>() method returns the role
-of the window. See the <link
-linkend="method-gtkwindow--set-role"><methodname>set_role</methodname>()</link>
-method for further explanation.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--add-accel-group">
- <title>gtk.Window.add_accel_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_accel_group</methodname>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_group</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_accel_group</methodname>() method associates
-the accelerator group specified by <parameter>accel_group</parameter> with
-the window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--remove-accel-group">
- <title>gtk.Window.remove_accel_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_accel_group</methodname>
- <methodparam><parameter
- role="keyword">accel_group</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">accel_group</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove_accel_group</methodname>() method
-dissociates the accelerator group specified by
-<parameter>accel_group</parameter> from the widget. This method reverses the
-effects of the <link
-linkend="method-gtkwindow--add-accel-group"><methodname>add_accel_group</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-position">
- <title>gtk.Window.set_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_position</methodname>
- <methodparam><parameter
- role="keyword">position</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">position</parameter>&nbsp;:</term>
- <listitem><simpara>a position constraint.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_position</methodname>() method sets the
-"window-position" property to the value of <parameter>position</parameter>.
-The value of <parameter>position</parameter> must be one of the <xref
-linkend="gtk-window-position-constants"
-endterm="gtk-window-position-constants-title"></xref>.</para>
-
- <para>If the old or new window position constraint is
-<literal>gtk.WIN_POS_CENTER_ALWAYS</literal>, this will also cause the
-window to be repositioned to satisfy the new constraint.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--activate-focus">
- <title>gtk.Window.activate_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>activate_focus</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the window has a
-focus widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>activate_focus</methodname>() method activates
-the child widget with the focus. This method returns <literal>True</literal>
-if the window has a widget with the focus.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-focus">
- <title>gtk.Window.set_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_focus</methodname>
- <methodparam><parameter
- role="keyword">focus</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">focus</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to be the new focus
-widget or <literal>None</literal> to unset a focus widget</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_focus</methodname>() method sets the widget
-specified by <parameter>focus</parameter> to be the focus widget for the
-window. If <parameter>focus</parameter> is <literal>None</literal> the
-window's focus widget is unset. To set the focus to a particular widget in
-the toplevel, it is usually more convenient to use the <link
-linkend="method-gtkwidget--grab-focus"><methodname>gtk.Widget.grab_focus</methodname>()</link>
-method instead of this method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-focus">
- <title>gtk.Window.get_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_focus</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the currently focused
-widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_focus</methodname>() method returns the
-current focused widget within the window. The focus widget is the widget
-that would have the focus if the toplevel window is focused.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-default">
- <title>gtk.Window.set_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_default</methodname>
- <methodparam><parameter
- role="keyword">default_widget</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">default_widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget to be the default, or
-<literal>None</literal> to unset the default widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_default</methodname>() method sets the
-window's default widget to the value specified by
-<parameter>default_widget</parameter>. If
-<parameter>default_widget</parameter> is <literal>None</literal> the
-window's default widget is unset. The default widget is the widget that's
-activated when the user presses <keycap>Enter</keycap> in a window. When
-setting (rather than unsetting) the default widget it's generally easier to
-call the <link
-linkend="method-gtkwidget--grab-default"><methodname>gtk.Widget.grab_default</methodname>()</link>
-method on the widget. Before making a widget the default widget, you must
-set the <literal>gtk.CAN_DEFAULT</literal> flag on the widget you'd like to
-make the default using the <link
-linkend="method-gtkobject--set-flags"><methodname>gtk.Object.set_flags</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--activate-default">
- <title>gtk.Window.activate_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>activate_default</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the window has a
-default widget or a focus widget.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>activate_default</methodname>() method activates
-the default widget. If there is no default widget or the default widget
-cannot be activated, the window's focus widget (if any) is activated. This
-method returns <literal>False</literal> if no default widget could be
-activated or there is no focus widget.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-transient-for">
- <title>gtk.Window.set_transient_for</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_transient_for</methodname>
- <methodparam><parameter
- role="keyword">parent</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
- <listitem><simpara>the parent window or <literal>None</literal> to
-remove the transient parent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_transient_for</methodname>() method sets the
-window as a transient window for the window specified by
-<parameter>parent</parameter>. Dialog windows should be set transient for
-the main application window they were spawned from. This allows window
-managers to keep the dialog on top of the main window, or center the dialog
-over the main window. The <link
-linkend="constructor-gtkdialog">gtk.Dialog</link>() constructor and other
-convenience functions in <literal>PyGTK</literal> will sometimes call the
-<methodname>set_transient_for</methodname>() method on your behalf.
-</para>
- <para>
-On Windows, this method will and put the child window on top of the parent,
-much as the window manager would have done on X.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-transient-for">
- <title>gtk.Window.get_transient_for</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_transient_for</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the transient parent for this window, or
-<literal>None</literal> if no transient parent has been
-set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_transient_for</methodname>() method returns
-the transient parent for this window or <literal>None</literal> if no
-transient window is set. See the <link
-linkend="method-gtkwindow--set-transient-for"><methodname>set_transient_for</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-type-hint">
- <title>gtk.Window.set_type_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_type_hint</methodname>
- <methodparam><parameter
- role="keyword">hint</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">hint</parameter>&nbsp;:</term>
- <listitem><simpara>the window type</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_type_hint</methodname>() method sets the
-window type hint for the window to the value specified by
-<parameter>hint</parameter>. The value of <parameter>hint</parameter> must
-be one of the <xref linkend="gdk-window-type-hint-constants"
-endterm="gdk-window-type-hint-constants-title"></xref>.</para>
-
- <para>By setting the type hint for the window, you allow the window
-manager to decorate and handle the window in a way which is suitable to the
-method of the window in your application. This method should be called
-before the window becomes visible. The <link
-linkend="constructor-gtkdialog">gtk.Dialog</link>() constructor and other
-convenience functions in <literal>PyGTK</literal> will sometimes call this
-method on your behalf.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-type-hint">
- <title>gtk.Window.get_type_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_type_hint</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the type hint for the
-window.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_type_hint</methodname>() method returns the
-type hint for this window. See the <link
-linkend="method-gtkwindow--set-type-hint">s<methodname>et_type_hint</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-destroy-with-parent">
- <title>gtk.Window.set_destroy_with_parent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_destroy_with_parent</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> destroy the window
-with its transient parent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_destroy_with_parent</methodname>() method
-sets the "destroy-with-parent" property to the value specified by
-<parameter>setting</parameter>. If <parameter>setting</parameter> is
-<literal>True</literal>, destroying the transient parent of the window will
-also destroy the window itself. This is useful for dialogs that shouldn't
-persist beyond the lifetime of the main window they're associated
-with.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-destroy-with-parent">
- <title>gtk.Window.get_destroy_with_parent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_destroy_with_parent</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the window will be
-destroyed with its transient parent.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_destroy_with_parent</methodname>() method
-returns the value of the "destroy-with-parent" property that determines if
-the window will be destroyed with its transient parent. See the <link
-linkend="method-gtkwindow--set-destroy-with-parent"><methodname>set_destroy_with_parent</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-resizable">
- <title>gtk.Window.set_resizable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_resizable</methodname>
- <methodparam><parameter
- role="keyword">resizable</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">resizable</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the user can resize
-this window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_resizable</methodname>() method sets the
-"resizable" property to the value of <parameter>resizable</parameter>. If
-<parameter>resizable</parameter> is <literal>True</literal> the user can
-resize the window. Windows are user resizable by default.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-resizable">
- <title>gtk.Window.get_resizable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_resizable</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the user can resize
-the window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_resizable</methodname>() method returns the
-value of the "resizable" property. See the <link
-linkend="method-gtkwindow--set-resizable"><methodname>set_resizable</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-gravity">
- <title>gtk.Window.set_gravity</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_gravity</methodname>
- <methodparam><parameter
- role="keyword">gravity</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">gravity</parameter>&nbsp;:</term>
- <listitem><simpara>the window gravity</simpara></listitem>
- </varlistentry>
- </variablelist>
-
-
- <para>The <methodname>set_gravity</methodname>() method sets the
-gravity of the window to the value specified by
-<parameter>gravity</parameter>. The window gravity defines the meaning of
-coordinates passed to the <link
-linkend="method-gtkwindow--move"><methodname>move</methodname>()</link>
-method. The value of gravity must be one of the <xref
-linkend="gdk-gravity-constants"
-endterm="gdk-gravity-constants-title"></xref>.</para>
-
- <para>The default window gravity is
-<literal>gtk.gdk.GRAVITY_NORTH_WEST</literal> which will typically "do what
-you want."</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-gravity">
- <title>gtk.Window.get_gravity</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_gravity</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the window gravity</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_gravity</methodname>() method returns window
-gravity. See the <link
-linkend="method-gtkwindow--set-gravity"><methodname>set_gravity</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-geometry-hints">
- <title>gtk.Window.set_geometry_hints</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_geometry_hints</methodname>
- <methodparam><parameter
- role="keyword">geometry_widget</parameter></methodparam>
- <methodparam><parameter role="keyword">min_width</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">min_height</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">max_width</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">max_height</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">base_width</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">base_height</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">width_inc</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">height_inc</parameter>
- <initializer>-1</initializer></methodparam>
- <methodparam><parameter role="keyword">min_aspect</parameter>
- <initializer>-1.0</initializer></methodparam>
- <methodparam><parameter role="keyword">max_aspect</parameter>
- <initializer>-1.0</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">geometry_widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget the geometry hints will be applied
-to</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">min_width</parameter>&nbsp;:</term>
- <listitem><simpara>the minimum width of window (or -1 to use
-requisition)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">min_height</parameter>&nbsp;:</term>
- <listitem><simpara>the minimum height of window (or -1 to use
-requisition)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">max_width</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum width of window (or -1 to use
-requisition)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">max_height</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum height of window (or -1 to use
-requisition)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">base_width</parameter>&nbsp;:</term>
- <listitem><simpara>allowed window widths are base_width +
-width_inc * N where N is any integer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">base_height</parameter>&nbsp;:</term>
- <listitem><simpara>allowed window heights are base_height +
-width_inc * N where N is any integer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">width_inc</parameter>&nbsp;:</term>
- <listitem><simpara>the width resize increment</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">height_inc</parameter>&nbsp;:</term>
- <listitem><simpara>the height resize
-increment</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">min_aspect</parameter>&nbsp;:</term>
- <listitem><simpara>the minimum width to height
-ratio</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">max_aspect</parameter>&nbsp;:</term>
- <listitem><simpara>the maximum width to height
-ratio</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_geometry_hints</methodname>() method sets up
-hints about how a window can be resized by the user. You can set the minimum
-and maximum widths and heights, the base width and height for resizing, the
-allowed width and height resize increments (e.g. for xterm, you can only
-resize by the size of a character), and the minimum and maximum aspect
-ratios. If <parameter>geometry_widget</parameter> is not
-<literal>None</literal> it specifies the widget to figure the geometry
-on.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-screen">
- <title>gtk.Window.set_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_screen</methodname>
- <methodparam><parameter role="keyword">screen</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">screen</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>set_screen</methodname>() method sets the
-"screen" property to the <link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-specified by <parameter>screen</parameter>. The "screen" property contains
-the screen that the window is displayed on. If the window is already mapped,
-it will be unmapped, and then remapped on the new screen.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-screen">
- <title>gtk.Window.get_screen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_screen</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>get_screen</methodname>() method returns the
-<link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
-that the window is displayed on.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--is-active">
- <title>gtk.Window.is_active</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_active</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the window is part
- of the current active window.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>is_active</methodname>() method returns
-<literal>True</literal> if the window is part of the current active
-toplevel, i.e., the toplevel window receiving keystrokes. The return value
-is <literal>True</literal> if the window is active the toplevel itself, or
-if it is, for example, a <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link> embedded in
-the active toplevel. You might use this method if you wanted to draw a
-widget differently in an active window from a widget in an inactive window.
-See the <link
-linkend="method-gtkwindow--has-toplevel-focus"><methodname>has_toplevel_focus()</methodname></link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--has-toplevel-focus">
- <title>gtk.Window.has_toplevel_focus</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>has_toplevel_focus</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the the input focus
- is within the window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>has_toplevel_focus</methodname>() method returns
-<literal>True</literal> if the input focus is within the window. For real
-toplevel windows, this is identical to <link
-linkend="method-gtkwindow--is-active"><methodname>is_active()</methodname></link>,
-but for embedded windows, like a <link
-linkend="class-gtkplug"><classname>gtk.Plug</classname></link>, the results
-will differ.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-has-frame">
- <title>gtk.Window.set_has_frame</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_has_frame</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> PyGTK draws the
-window border</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_has_frame</methodname>() method sets the
-flag that causes <literal>PyGTK</literal> to draw its own window border for
-the window.</para>
-
- <note>
- <para>This is a special-purpose method for the framebuffer port. For
-most applications, you want the <link
-linkend="method-gtkwindow--set-decorated"><methodname>set_decorated</methodname>()</link>
-method instead,that tells the window manager whether to draw the window
-border.</para>
- </note>
-
- <para>If this method is called on a window with setting of
-<literal>True</literal>, before it is realized or showed, it will have a
-"frame" window around the window's <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>,
-accessible in the window's frame. Using the signal "frame-event" you can
-receive all events targeted at the frame. This method is used by the
-linux-fb port to implement managed windows, but it could conceivably be used
-by X-programs that want to do their own window decorations.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-has-frame">
- <title>gtk.Window.get_has_frame</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_has_frame</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a frame has been
-added to the window via the <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-method.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_has_frame</methodname>() method returns the
-value of the window's "has_frame" flag that determines if the window has a
-frame window exterior to its <link
-linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>. See
-the <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-frame-dimensions">
- <title>gtk.Window.set_frame_dimensions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_frame_dimensions</methodname>
- <methodparam><parameter
- role="keyword">left</parameter></methodparam>
- <methodparam><parameter
- role="keyword">top</parameter></methodparam>
- <methodparam><parameter
- role="keyword">right</parameter></methodparam>
- <methodparam><parameter
- role="keyword">bottom</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">left</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the left
-border</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">top</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the top
-border</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">right</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the right
-border</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">bottom</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the bottom
-border</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_frame_dimensions</methodname>() method sets
-the size of the frame around the window to the values specified by
-<parameter>left</parameter>, <parameter>top</parameter>,
-<parameter>bottom</parameter> and <parameter>right</parameter>.</para>
-
- <note>
- <para>This is a special-purpose method intended for the framebuffer
-port. See the <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-method. It will have no effect on the window border drawn by the window
-manager, which is the normal case when using the X Window system.</para>
- </note>
-
- <para>For windows with frames (see the <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-method) this method can be used to change the size of the frame
-border.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-frame-dimensions">
- <title>gtk.Window.get_frame_dimensions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_frame_dimensions</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the frame dimensions: the
-width of the frame at the left; the height of the frame at the top; the
-width of the frame at the right; and, the height of the frame at the
-bottom.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_frame_dimensions</methodname>() method
-returns a tuple containing the frame dimensions: the width of the frame at
-the left; the height of the frame at the top; the width of the frame at the
-right; and, the height of the frame at the bottom.</para>
-
- <note>
- <para>This is a special-purpose method intended for the framebuffer
-port See the <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-method. It will not return the size of the window border drawn by the window
-manager, which is the normal case when using a windowing system. See the
-<link
-linkend="method-gdkwindow--get-frame-extents"><methodname>get_frame_extents</methodname>()</link>
-to get the standard window border extents.</para>
- </note>
-
- <para>See the <link
-linkend="method-gtkwindow--set-has-frame"><methodname>set_has_frame</methodname>()</link>
-and <link
-linkend="method-gtkwindow--set-frame-dimensions"><methodname>set_frame_dimensions</methodname>()</link>
-methods for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-decorated">
- <title>gtk.Window.set_decorated</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_decorated</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> decorate the
-window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_decorated</methodname>() method sets the
-decorated flag to the value specified by <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal> the window will be
-decorated. By default, windows are decorated with a title bar, resize
-controls, etc. Some window managers allow PyGTK to disable these
-decorations, creating a borderless window. If you set the decorated property
-to <literal>False</literal> using this method, <literal>PyGTK</literal> will
-do its best to convince the window manager not to decorate the window. On
-Windows, this method always works, since there's no window manager policy
-involved.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-decorated">
- <title>gtk.Window.get_decorated</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_decorated</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the window has been
-set to have decorations</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_decorated</methodname>() method returns the
-value of the decorated flag that determines if the window has been set to
-have decorations such as a title bar. See the <link
-linkend="method-gtkwindow--set-decorated"><methodname>set_decorated</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-icon-list">
- <title>gtk.Window.set_icon_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_list</methodname>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>zero or more <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-objects</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_icon_list</methodname>() method sets up the
-icon representing the window using the set of <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-objects passed as arguments. If no <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-objects are passed in the icon is unset and reverts to the default icon. The
-icon is used when the window is minimized (also known as iconified). Some
-window managers or desktop environments may also place it in the window
-frame, or display it in other contexts. This method allows you to pass in
-the same icon in several hand-drawn sizes. The <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-objects should contain the natural sizes your icon is available in; i.e.,
-don't scale the image before passing it to <literal>PyGTK</literal>. Scaling
-is postponed until the last minute, when the desired final size is known, to
-allow best quality. By passing several sizes, you may improve the final
-image quality of the icon, by reducing or eliminating automatic image
-scaling. The recommended sizes to provide are: 16x16, 32x32, 48x48 at
-minimum, and larger images (64x64, 128x128) if you have them.</para>
-
- <para>See the <link
-linkend="function-gtk--window-set-default-icon-list"><methodname>gtk.window_set_default_icon_list</methodname>()</link>
-function to set the icon for all windows in your application in one go. Note
-that transient windows (those who have been set transient for another window
-using the <link
-linkend="method-gtkwindow--set-transient-for"><methodname>set_transient_for</methodname>()</link>
-method) will inherit their icon from their transient parent. So there's no
-need to explicitly set the icon on transient windows.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-icon-list">
- <title>gtk.Window.get_icon_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_list</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the window's icon
-list</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_icon_list</methodname>() method returns the
-list of icons set by the <link
-linkend="method-gtkwindow--set-icon-list"><methodname>set_icon_list</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-icon">
- <title>gtk.Window.set_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon</methodname>
- <methodparam><parameter
- role="keyword">icon</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon</parameter>&nbsp;:</term>
- <listitem><simpara>an icon image, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_icon</methodname>() method sets the "icon"
-property to the value specified by <parameter>icon</parameter>. This icon is
-used when the window is minimized (also known as iconified). Some window
-managers or desktop environments may also place it in the window frame, or
-display it in other contexts. The icon should be provided in whatever size
-it was naturally drawn; that is, don't scale the image before passing it to
-<literal>PyGTK</literal>. Scaling is postponed until the last minute, when
-the desired final size is known, to allow best quality. If you have your
-icon hand-drawn in multiple sizes, use the <link
-linkend="method-gtkwindow--set-icon-list"><methodname>set_icon_list</methodname>()</link>
-method. Then the best size will be used.</para>
-
- <para>This method is equivalent to calling the <link
-linkend="method-gtkwindow--set-icon-list"><methodname>set_icon_list</methodname>()</link>
-method with a 1-element list. See the <link
-linkend="function-gtk--window-set-default-icon-list"><methodname>gtk.window_set_default_icon_list</methodname>()</link>
-function to set the icon for all windows in your application in one
-go.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-icon-from-file">
- <title>gtk.Window.set_icon_from_file</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_from_file</methodname>
- <methodparam><parameter
- role="keyword">filename</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>the name of a file containing an icon
- image</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the icon was
- loaded.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_icon_from_file</methodname>() method sets
-the "icon" property to the icon loaded from the file specified by
-<parameter>filename</parameter>. The icon is used when the window is
-minimized (also known as iconified). See the <link
-linkend="method-gtkwindow--set-icon"><methodname>set_icon</methodname>()</link>)
-method for more information. This method is equivalent to calling the <link
-linkend="method-gtkwindow--set-icon"><methodname>set_icon</methodname>()</link>
-method with a pixbuf created by loading the image from
-<parameter>filename</parameter>.</para>
-
- <para>The GError exception is raised if an error occurs while loading
-the pixbuf from <parameter>filename</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-icon">
- <title>gtk.Window.get_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the icon for window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_icon</methodname>() method returns the value
-of the "icon" property set by the <link
-linkend="method-gtkwindow--set-icon"><methodname>set_icon</methodname>()</link>
-(or if you've called the <link
-linkend="method-gtkwindow--set-icon-list"><methodname>set_icon_list</methodname>()</link>
-method, returns the first icon in the icon list).</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-modal">
- <title>gtk.Window.set_modal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_modal</methodname>
- <methodparam><parameter
- role="keyword">modal</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">modal</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the window is
-modal</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_modal</methodname>() method sets the "modal"
-property to the value of <parameter>modal</parameter>. If
-<parameter>modal</parameter> is <literal>True</literal> the window becomes
-modal. Modal windows prevent interaction with other windows in the same
-application. Typically modal windows are used for <link
-linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link> windows
-that require a user response before the application can continue. To keep
-modal dialogs on top of the main application windows, use the <link
-linkend="method-gtkwindow--set-transient-for"><methodname>set_transient_for</methodname>()</link>
-method to make the dialog transient for the parent - most window managers
-will then disallow lowering the dialog below the parent.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-modal">
- <title>gtk.Window.get_modal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_modal</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the window is set to
-be modal and establishes a grab when shown</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_modal</methodname>() method returns the
-value of the "modal" property. If "modal" is <literal>True</literal> the
-window is modal. See the <link
-linkend="method-gtkwindow--set-modal"><methodname>set_modal</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--add-mnemonic">
- <title>gtk.Window.add_mnemonic</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_mnemonic</methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>the mnemonic key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that gets activated by the
-mnemonic</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_mnemonic</methodname>() method adds a
-mnemonic key specified by <parameter>keyval</parameter> to this window. When
-the mnemonic key is pressed the widget specified by
-<parameter>target</parameter> will be activated.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--remove-mnemonic">
- <title>gtk.Window.remove_mnemonic</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_mnemonic</methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">target</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>the mnemonic key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">target</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that gets activated by the
-mnemonic</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove_mnemonic</methodname>() method removes
-the mnemonic specified by <parameter>keyval</parameter> for the widget
-specified by <parameter>target</parameter> from this window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--mnemonic-activate">
- <title>gtk.Window.mnemonic_activate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>mnemonic_activate</methodname>
- <methodparam><parameter
- role="keyword">keyval</parameter></methodparam>
- <methodparam><parameter
- role="keyword">modifier</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">keyval</parameter>&nbsp;:</term>
- <listitem><simpara>the mnemonic key</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">modifier</parameter>&nbsp;:</term>
- <listitem><simpara>the modifiers</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>True if the activation was
-done</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The<methodname> mnemonic_activate</methodname>() method
-activates the targets associated with the mnemonic specified by
-<parameter>keyval</parameter>. The window's mnemonic modifier must match
-<parameter>modifier</parameter> to allow the activation to proceed. See the
-<link
-linkend="method-gtkwindow--set-mnemonic-modifier"><methodname>set_mnemonic_modifier</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-mnemonic-modifier">
- <title>gtk.Window.set_mnemonic_modifier</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_mnemonic_modifier</methodname>
- <methodparam><parameter
- role="keyword">modifier</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">modifier</parameter>&nbsp;:</term>
- <listitem><simpara>the modifier mask used to activate mnemonics on
-this window.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_mnemonic_modifier</methodname>() method sets
-the mnemonic modifier for this window to the value specified by
-<parameter>modifier</parameter>. The value of
-<parameter>modifier</parameter> is one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtk.gdk.SHIFT_MASK</literal></term>
- <listitem>
- <simpara>The Shift key.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.CONTROL_MASK</literal></term>
- <listitem>
- <simpara>The Control key. </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtk.gdk.MOD1_MASK</literal></term>
- <listitem>
- <simpara>The fourth modifier key (it depends on the modifier
-mapping of the X server which key is interpreted as this modifier, but
-normally it is the Alt key).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-mnemonic-modifier">
- <title>gtk.Window.get_mnemonic_modifier</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_mnemonic_modifier</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the modifier mask used to activate mnemonics on
-this window.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_mnemonic_modifier</methodname>() method
-returns the mnemonic modifier for this window. See the <link
-linkend="method-gtkwindow--set-mnemonic-modifier"><methodname>set_mnemonic_modifier</methodname>()</link>
-method for more detail.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--activate-key">
- <title>gtk.Window.activate_key</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>activate_key</methodname>
- <methodparam><parameter role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a mnemonic or
- accelerator was found and activated.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>activate_key</methodname>() method activates
-mnemonics and accelerators for the window. This is normally called by the
-default <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--key-press-event">key-press-event</link>" signal
-handler for toplevel windows, however in some cases it may be useful to call
-this directly when overriding the standard key handling for a toplevel
-window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--propagate-key-event">
- <title>gtk.Window.propagate_key_event</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>propagate_key_event</methodname>
- <methodparam><parameter role="keyword">event</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">event</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkevent"><classname>gtk.gdk.Event</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a widget in the
- focus chain handled the event.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>propagate_key_event</methodname>() method
-propagates a key press or release event to the focus widget and up the focus
-container chain until a widget handles the key event specified by
-<parameter>event</parameter>. This is normally called by the default <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--key-press-event">key-press-event</link>" and
-"<link
-linkend="signal-gtkwidget--key-release-event">key-release-event</link>"
-signal handlers for toplevel windows, however in some cases it may be useful
-to call this directly when overriding the standard key handling for a
-toplevel window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--present">
- <title>gtk.Window.present</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>present</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
-
- <para>The <methodname>present</methodname>() method presents a window
-to the user. This may mean raising the window in the stacking order,
-deiconifying it, moving it to the current desktop, and/or giving it the
-keyboard focus, possibly dependent on the user's platform, window manager,
-and preferences. If the window is hidden, this method calls the the <link
-linkend="method-gtkwidget--show"><methodname>gtk.Widget.show</methodname>()</link>
-method as well. This method should be used when the user tries to open a
-window that's already open. Say for example the preferences dialog is
-currently open, and the user chooses <guimenuitem>Preferences</guimenuitem>
-from the menu a second time; use the <methodname>present</methodname>()
-method to move the already-open dialog where the user can see it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--iconify">
- <title>gtk.Window.iconify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iconify</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>iconify</methodname>() method asks the window
-manager to iconify (i.e. minimize) the specified the window. Note that you
-shouldn't assume the window is definitely iconified afterward, because other
-entities (e.g. the user or window manager) could deiconify it again, or
-there may not be a window manager in which case iconification isn't
-possible, etc. But normally the window will end up iconified. Just don't
-write code that crashes if not. This method can be called before showing a
-window, in which case the window will be iconified before it ever appears
-on-screen. You can track iconification via the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--window-state-event">window-state-event</link>"
-signal.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--deiconify">
- <title>gtk.Window.deiconify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>deiconify</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>deiconify</methodname>() method asks the window
-manager to deiconify (i.e. unminimize) the specified the window. Note that
-you shouldn't assume the window is definitely deiconified afterward, because
-other entities (e.g. the user or window manager) could iconify it again
-before your code which assumes deiconification gets to run. You can track
-iconification via the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--window-state-event">window-state-event</link>"
-signal.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--stick">
- <title>gtk.Window.stick</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>stick</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>stick</methodname>() method asks the window
-manager to stick the window, which means that it will appear on all user
-desktops. Note that you shouldn't assume the window is definitely stuck
-afterward, because other entities (e.g. the user or window manager) could
-unstick it again, and some window managers do not support sticking windows.
-But normally the window will end up stuck. Just don't write code that
-crashes if not. This method can be called before showing a window. You can
-track stickiness via the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--window-state-event">window-state-event</link>"
-signal.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--unstick">
- <title>gtk.Window.unstick</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unstick</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The unstick() method asks the window manager to unstick the
-window, which means that it will appear on only one of the user's desktops.
-Note that you shouldn't assume the window is definitely unstuck afterward,
-because other entities (e.g. the user or window manager) could stick it
-again. But normally the window will end up stuck. Just don't write code that
-crashes if not. You can track stickiness via the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--window-state-event">window-state-event</link>"
-signal.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--maximize">
- <title>gtk.Window.maximize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>maximize</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>maximize</methodname>() method asks the window
-manager to maximize the window, so that it becomes full-screen. Note that
-you shouldn't assume the window is definitely maximized afterward, because
-other entities (e.g. the user or window manager) could unmaximize it again,
-and not all window managers support maximization. But normally the window
-will end up maximized. This method can be called before showing a window, in
-which case the window will be maximized when it appears on-screen initially.
-You can track maximization via the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--window-state-event">window-state-event</link>"
-signal.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--unmaximize">
- <title>gtk.Window.unmaximize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unmaximize</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>unmaximize</methodname>() method asks the window
-manager to unmaximize the window. Note that you shouldn't assume the window
-is definitely unmaximized afterward, because other entities (e.g. the user
-or window manager) could maximize it again, and not all window managers
-honor requests to unmaximize. But normally the window will end up
-unmaximized. You can track maximization via the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--window-state-event">window-state-event</link>"
-signal.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--fullscreen">
- <title>gtk.Window.fullscreen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>fullscreen</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>fullscreen</methodname>() method requests the
-window manager to place the window in the fullscreen state. Note you
-shouldn't assume the window is definitely full screen afterward, because
-other entities (e.g. the user or window manager) could unfullscreen it
-again, and not all window managers honor requests to fullscreen windows. But
-normally the window will end up fullscreen. Just don't write code that
-crashes if not.</para>
-
- <para>You can track the fullscreen state via the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--window-state-event">window-state-event</link>"
-signal.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--unfullscreen">
- <title>gtk.Window.unfullscreen</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unfullscreen</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <methodname>unfullscreen</methodname>() method requests the
-window manager to toggle off the fullscreen state for the window. Note that
-you shouldn't assume the window is definitely not full screen afterward,
-because other entities (e.g. the user or window manager) could fullscreen it
-again, and not all window managers honor requests to unfullscreen
-windows. But normally the window will end up restored to its normal
-state. Just don't write code that crashes if not.</para>
-
- <para>You can track the fullscreen state via the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--window-state-event">window_state_event</link>"
-signal.</para> </refsect2>
-
- <refsect2 id="method-gtkwindow--set-keep-above">
- <title>gtk.Window.set_keep_above</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_keep_above</methodname>
- <methodparam><parameter role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> keep the window
- above other windows</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_keep_above</methodname>() method requests
-the window manager to keep the window on top if
-<parameter>setting</parameter> is <literal>True</literal>. Note that you
-shouldn't assume the window is definitely above afterward, because other
-entities (e.g. the user or window manager) could not keep it above, and not
-all window managers support keeping windows above. But normally the window
-will end kept above. Just don't write code that crashes if not.</para>
-
- <para>It's permitted to call this method before showing a window, so
-the window will be kept above when it appears on-screen initially.</para>
-
- <para>You can track the above state via the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--window-state-event">window_state_event</link>"
-signal.</para>
-
- <para>Note that, according to the <ulink
-url="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html">Extended
-Window Manager Hints</ulink> specification, the above state is mainly meant
-for user preferences and should not be used by applications e.g. for drawing
-attention to their dialogs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-keep-below">
- <title>gtk.Window.set_keep_below</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_keep_below</methodname>
- <methodparam><parameter>setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> keep the window
- below other windows</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>set_keep_below</methodname>() method requests
-the window manager to keep the window on the bottom (i.e. below all other
-windows). Note that you shouldn't assume the window is definitely below
-afterward, because other entities (e.g. the user or window manager) could
-not keep it below, and not all window managers support putting windows
-below. But normally the window will be kept below. Just don't write code
-that crashes if not.</para>
-
- <para>It's permitted to call this function before showing a window, in
-which case the window will be kept below when it appears on-screen
-initially.</para>
-
- <para>You can track the below state via the <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
-linkend="signal-gtkwidget--window-state-event">window_state_event</link>"
-signal.</para>
-
- <para>Note that, according to the <ulink
-url="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html">Extended
-Window Manager Hints</ulink> specification, the above state is mainly meant
-for user preferences and should not be used by applications e.g. for drawing
-attention to their dialogs.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--begin-resize-drag">
- <title>gtk.Window.begin_resize_drag</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>begin_resize_drag</methodname>
- <methodparam><parameter
- role="keyword">edge</parameter></methodparam>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">timestamp</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">edge</parameter>&nbsp;:</term>
- <listitem><simpara>the position of the resize
-control</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">button</parameter>&nbsp;:</term>
- <listitem><simpara>the mouse button that initiated the
-drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">root_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position where the user clicked to
-initiate the drag, in root window coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">root_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position where the user clicked to
-initiate the drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp from the click event that
-initiated the drag</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>begin_resize_drag</methodname>() method starts
-resizing a window from the edge specified by <parameter>edge</parameter>.
-The mouse button that started the resize is specified by
-<parameter>button</parameter>; the location, by
-<parameter>root_x</parameter> and <parameter>root_y</parameter>; and the
-time of the event, by <parameter>timestamp</parameter>. The value of
-<parameter>edge</parameter> must be one of the <xref
-linkend="gdk-window-edge-constants"
-endterm="gdk-window-edge-constants-title"></xref>.</para>
-
- <para>This method is used if an application has window resizing
-controls. When <literal>PyGTK</literal> can support it, the resize will be
-done using the standard mechanism for the window manager or windowing
-system. Otherwise, <literal>PyGTK</literal> will try to emulate window
-resizing, potentially not all that well, depending on the windowing
-system.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--begin-move-drag">
- <title>gtk.Window.begin_move_drag</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>begin_move_drag</methodname>
- <methodparam><parameter
- role="keyword">button</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">root_y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">timestamp</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">button</parameter>&nbsp;:</term>
- <listitem><simpara>the mouse button that initiated the
-drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">root_x</parameter>&nbsp;:</term>
- <listitem><simpara>the X position where the user clicked to
-initiate the drag, in root window coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">root_y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y position where the user clicked to
-initiate the drag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp from the click event that
-initiated the drag</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>begin_move_drag</methodname>() method starts
-moving a window when the user presses the mouse button specified by
-<parameter>button</parameter> at the location specified by
-<parameter>root_x</parameter> and <parameter>root_y</parameter> at the time
-specified by <parameter>timestamp</parameter>. This method is used if an
-application has window movement grips. When <literal>PyGTK</literal> can
-support it, the window movement will be done using the standard mechanism
-for the window manager or windowing system. Otherwise,
-<literal>PyGTK</literal> will try to emulate window movement, potentially
-not all that well, depending on the windowing system.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-default-size">
- <title>gtk.Window.set_default_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_default_size</methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width in pixels, or -1 to unset the default
-width</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height in pixels, or -1 to unset the
-default height</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_default_size</methodname>() method sets the
-default size of the window to the specified <parameter>width</parameter> and
-<parameter>height</parameter>. If the window's "natural" size (its size
-request) is larger than the default, the default will be ignored. More
-generally, if the default size does not obey the geometry hints for the
-window (the <link
-linkend="method-gtkwindow--set-geometry-hints"><methodname>set_geometry_hints</methodname>()</link>
-method can be used to set these explicitly), the default size will be
-clamped to the nearest permitted size.</para>
-
- <para>Unlike the <link
-linkend="method-gtkwidget--set-size-request"><methodname>gtk.Widget.set_size_request</methodname>()</link>
-method, which sets a size request for a widget and thus would keep users
-from shrinking the window, this method only sets the initial size, just as
-if the user had resized the window themselves. Users can still shrink the
-window again as they normally would. Setting a default size of -1 means to
-use the "natural" default size (the size request of the window). For more
-control over a window's initial size and how resizing works, investigate the
-<link
-linkend="method-gtkwindow--set-geometry-hints"><methodname>set_geometry_hints</methodname>()</link>
-method.</para>
-
- <para>For some uses, the <link
-linkend="method-gtkwindow--resize"><methodname>resize</methodname>()</link>
-method is more appropriate as it changes the current size of the window,
-rather than the size to be used on initial display. The <link
-linkend="method-gtkwindow--resize"><methodname>resize</methodname>()</link>
-method always affects the window itself, not the geometry widget. The
-default size of a window only affects the first time a window is shown; if a
-window is hidden and re-shown, it will remember the size it had prior to
-hiding, rather than using the default size. Windows can't actually be 0x0 in
-size, they must be at least 1x1, but passing 0 for
-<parameter>width</parameter> and <parameter>height</parameter> is OK,
-resulting in a 1x1 default size.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-default-size">
- <title>gtk.Window.get_default_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_default_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the default width and height
-of the window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_default_size</methodname>() method returns a
-tuple containing the default width and height of the window. A value of -1
-for the returned width or height indicates that a default size has not been
-explicitly set for that dimension, so the "natural" size of the window will
-be used. See the <link linkend="method-gtkwindow--set-default-size"><methodname>set_default_size</methodname>()</link>
-method for more information</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--resize">
- <title>gtk.Window.resize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>resize</methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width in pixels to resize the window
-to</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height in pixels to resize the window
-to</simpara></listitem>
- </varlistentry>
- </variablelist>
-
-
- <para>The <methodname>resize</methodname>() method resizes the window
-to the specified <parameter>width</parameter> and
-<parameter>height</parameter> as if the user had done so, obeying geometry
-constraints. The default geometry constraint is that windows may not be
-smaller than their size request; to override this constraint, call the <link
-linkend="method-gtkwidget--set-size-request"><methodname>gtk.Widget.set_size_request</methodname>()</link>
-method to set the window's request to a smaller value. If the
-<methodname>resize</methodname>() method is called before showing a window
-for the first time, it overrides any default size set with the <link
-linkend="method-gtkwindow--set-default-size"><methodname>set_default_size</methodname>()</link>
-method. Windows may not be resized smaller than 1 by 1 pixels.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-size">
- <title>gtk.Window.get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the width and height of the
-window</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_size</methodname>() method returns a tuple
-containing the current width and height of the window. If the window is not
-on-screen, it returns the size <literal>PyGTK</literal> will suggest to the
-window manager for the initial window size (but this is not reliably the
-same as the size the window manager will actually select). The size obtained
-by the <methodname>get_size</methodname>() method is the last size received
-in a configure event, that is, <literal>PyGTK</literal> uses its
-locally-stored size, rather than querying the X server for the size. As a
-result, if you call the <link
-linkend="method-gtkwindow--resize"><methodname>resize</methodname>()</link>
-method then immediately call the <methodname>get_size</methodname>() method,
-the size won't have taken effect yet. After the window manager processes the
-resize request, PyGTK receives notification that the size has changed via a
-configure event, and the size of the window gets updated.</para>
-
- <note>
- <para>Nearly any use of this method creates a race condition,
-because the size of the window may change between the time that you get the
-size and the time that you perform some action assuming that size is the
-current size. To avoid race conditions, connect to "configure_event" on the
-window and adjust your size-dependent state to match the size delivered in
-the configure event.</para>
-
- <para>The returned size does <emphasis>not</emphasis> include the
-size of the window manager decorations (aka the window frame or border).
-Those are not drawn by <literal>PyGTK</literal> which has no reliable method
-of determining their size.</para>
-
- <para>If you are getting a window size in order to position the
-window on-screen, there may be a better way. The preferred way is to simply
-set the window's semantic type with the <link
-linkend="method-gtkwindow--set-type-hint"><methodname>set_type_hint</methodname>()</link>
-method, that allows the window manager to center dialogs, etc. Also, if you
-set the transient parent of dialogs with the <link
-linkend="method-gtkwindow--set-transient-for"><methodname>set_transient_for</methodname>()</link>
-method, window managers will often center the dialog over its parent window.
-It's much preferred to let the window manager handle these things rather
-than doing it yourself, because all apps will behave consistently and
-according to user prefs if the window manager handles it. Also, the window
-manager can take the size of the window decorations/border into account,
-while your application cannot.</para>
-
- <para>In any case, if you insist on application-specified window
-positioning, there's <emphasis>still</emphasis> a better way than doing it
-yourself - the <link
-linkend="method-gtkwindow--set-position"><methodname>set_position</methodname>()</link>
-method will frequently handle the details for you.</para>
- </note>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--move">
- <title>gtk.Window.move</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate to move window
-to</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate to move window
-to</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>move</methodname>() method asks the window
-manager to move the window to the position specified by
-<parameter>x</parameter> and <parameter>y</parameter>. Window managers are
-free to ignore this. In fact, most window managers ignore requests for
-initial window positions (instead using a user-defined placement algorithm)
-and honor requests after the window has already been shown.</para>
-
- <para>The position is the position of the gravity-determined
-reference point for the window. The gravity determines two things: first,
-the location of the reference point in root window coordinates; and second,
-which point on the window is positioned at the reference point. By default
-the gravity is <literal>gtk.gdk.GRAVITY_NORTH_WEST</literal>, so the
-reference point is simply the <parameter>x</parameter>,
-<parameter>y</parameter> supplied to the <methodname>move</methodname>()
-method. The top-left corner of the window decorations (aka window frame or
-border) will be placed at <parameter>x</parameter>,
-<parameter>y</parameter>. Therefore, to position a window at the top left of
-the screen, you want to use the default gravity (which is
-<literal>gtk.gdk.GRAVITY_NORTH_WEST</literal>) and move the window to
-0,0.</para>
-
- <para>To position a window at the bottom right corner of the screen,
-you would set <literal>gtk.gdk.GRAVITY_SOUTH_EAST</literal>, which means
-that the reference point is at <parameter>x</parameter> + the window width
-and <parameter>y</parameter> + the window height, and the bottom-right
-corner of the window border will be placed at that reference point. So, to
-place a window in the bottom right corner you would first set gravity to
-south east, then move the window:</para>
-
- <programlisting>
- window.set_gravity(gtk.gdk.GRAVITY_SOUTH_EAST)
- width, height = window.get_size()
- window.move(gtk.gdk.screen_width() - width, gtk.gdk.screen_height() - height)
-</programlisting>
-
- <para>The <ulink
-url="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html">Extended
-Window Manager Hints</ulink> specification has a nice table of gravities in
-the "implementation notes" section. The <link
-linkend="method-gtkwindow--get-position"><methodname>get_position</methodname>()</link>
-method documentation may also be relevant.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-position">
- <title>gtk.Window.get_position</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_position</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the X and Y coordinates of
-the gravity-determined reference point</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_position</methodname>() method returns a
-tuple containing the x and y coordinates of the window that you would need
-to pass to the <link
-linkend="method-gtkwindow--move"><methodname>move</methodname>()</link>
-method to keep the window in its current position. This means that the
-meaning of the returned value varies with window gravity. See the <link
-linkend="method-gtkwindow--move"><methodname>move</methodname>()</link>
-method for more details. If you haven't changed the window gravity, its
-gravity will be <literal>gtk.gdk.GRAVITY_NORTH_WEST</literal>. This means
-that the <methodname>get_position</methodname>() method gets the position of
-the top-left corner of the window manager frame for the window. The <link
-linkend="method-gtkwindow--move"><methodname>move</methodname>()</link>
-method sets the position of this same top-left corner.</para>
-
- <para>The <methodname>get_position</methodname>() method is not 100%
-reliable because the X Window System does not specify a way to obtain the
-geometry of the decorations placed on a window by the window manager. Thus
-<literal>PyGTK</literal> is using a "best guess" that works with most window
-managers. Moreover, nearly all window managers are historically broken with
-respect to their handling of window gravity. So moving a window to its
-current position as returned by the <methodname>get_position</methodname>()
-method tends to result in moving the window slightly. Window managers are
-slowly getting better over time.</para>
-
- <para>If a window has gravity
-<literal>gtk.gdk.GRAVITY_STATIC</literal> the window manager frame is not
-relevant, and thus the <methodname>get_position</methodname>() method will
-always produce accurate results. However you can't use static gravity to do
-things like place a window in a corner of the screen, because static gravity
-ignores the window manager decorations. If you are saving and restoring your
-application's window positions, you should know that it's impossible for
-applications to do this without getting it somewhat wrong because
-applications do not have sufficient knowledge of window manager state. The
-correct mechanism is to support the session management protocol (see the
-"GnomeClient" object in the GNOME libraries for example) and allow the
-window manager to save your window sizes and positions.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--parse-geometry">
- <title>gtk.Window.parse_geometry</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>parse_geometry</methodname>
- <methodparam><parameter
- role="keyword">geometry</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">geometry</parameter>&nbsp;:</term>
- <listitem><simpara>the geometry string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if string was parsed
-successfully</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>parse_geometry</methodname>() method parses the
-standard X Window System geometry string specified by
-<parameter>geometry</parameter>. The geometry string has the format
-"WIDTHxHEIGHT+XOFFSET+YOFFSET" where WIDTH, HEIGHT, XOFFSET and YOFFSET are
-specified in pixels (see the X documentation for more details). This method
-works work on all <literal>PyGTK</literal> ports including Win32 but is
-primarily intended for an X environment. If either a size or a position can
-be extracted from the geometry string, the
-<methodname>parse_geometry</methodname>() method returns
-<literal>True</literal> and calls the <link
-linkend="method-gtkwindow--set-default-size"><methodname>set_default_size</methodname>()</link>
-and <link
-linkend="method-gtkwindow--move"><methodname>move</methodname>()</link>
-methods to resize and move the window.</para>
-
- <para>If the <methodname>parse_geometry</methodname>() method returns
-<literal>True</literal>, it will also set the
-<literal>gtk.gdk.HINT_USER_POS</literal> and
-<literal>gtk.gdk.HINT_USER_SIZE</literal> hints indicating to the window
-manager that the size and position of the window was user-specified. This
-causes most window managers to honor the geometry.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--reshow-with-initial-size">
- <title>gtk.Window.reshow_with_initial_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>reshow_with_initial_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <para>The <methodname>reshow_with_initial_size</methodname>() method
-hides the window, then reshows it, resetting the default size and position
-of the window. Used by GUI builders only.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--tooltips-get-info-from-tip-window">
- <title>gtk.Window.tooltips_get_info_from_tip_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>tooltips_get_info_from_tip_window</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the <link
- linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
- and <link
- linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
- displayed in the window or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>tooltips_get_info_from_tip_window</methodname>()
-method returns a 2-tuple containing the <link
-linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> and
-<link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
-displayed in the window. If the window is not displaying tooltips this
-method returns None. This method is mostly intended for use by accessibility
-technologies - applications should have little use for it.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-focus-on-map">
- <title>gtk.Window.set_focus_on_map</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_focus_on_map</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>If <literal>True</literal> this window would
-like to receive focus when mapped.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_focus_on_map</methodname>() method sets the
-"focus-on-map" property to the value of <parameter>setting</parameter>. If
-<parameter>setting</parameter> is <literal>True</literal> a hint is set
-asking the desktop environment to give focus to the window when it is
-mapped.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-focus-on-map">
- <title>gtk.Window.get_focus_on_map</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_focus_on_map</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the window would
-like to receive focus when mapped.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_focus_on_map</methodname>() method returns
-the value of the "focus-on-map" property. See the <link
-linkend="method-gtkwindow--set-focus-on-map"><methodname>set_focus_on_map</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-icon-name">
- <title>gtk.Window.set_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_icon_name</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>the name of the themed icon or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>set_icon_name</methodname>() method sets the
-"icon-name" property to the value of <parameter>name</parameter>. If
-<parameter>name</parameter> is <literal>None</literal>, then the default
-themed icon will be used. The "icon-name" property contains the name of the
-icon used for the window. See the <link
-linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link>
-reference for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-icon-name">
- <title>gtk.Window.get_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_icon_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>The name of the themed icon used for the
-window icon or <literal>None</literal> if no icon is set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_icon_name</methodname>() method returns the
-name of the themed icon for the window, see the <link
-linkend="method-gtkwindow--set-icon-name"><methodname>set_icon_name</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-urgency-hint">
- <title>gtk.Window.set_urgency_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_urgency_hint</methodname>
- <methodparam><parameter
- role="keyword">urgency_hint</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">urgency_hint</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> mark this window
-as needing urgent attention.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_urgency_hint</methodname>() method sets the
-"urgency-hint" property to the value of
-<parameter>urgency_hint</parameter>. If the "urgency-hint" property is True
-the window sets a hint to the desktop environment to draw the users
-attention to the window.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-urgency-hint">
- <title>gtk.Window.get_urgency_hint</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_urgency_hint</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the window is marked
-as needing urgent user attention.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_urgency_hint</methodname>() method returns
-the value of the "urgency-hint" property. See the <link
-linkend="method-gtkwindow--set-urgency-hint"><methodname>set_urgency_hint</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--present-with-time">
- <title>gtk.gdk.Window.present_with_time</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>present_with_time</methodname>
- <methodparam><parameter role="keyword">timestamp</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
- role="keyword">timestamp</parameter>&nbsp;:</term>
- <listitem><simpara>the timestamp of the user interaction (typically
-a button or key press event) which triggered this call</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>present_with_time</methodname>() method presents
-a window to the user in response to a user interaction. If you need to
-present a window without a timestamp, use the <link
-linkend="method-gtkwindow--present"><methodname>present</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--set-deletable">
- <title>gtk.Window.set_deletable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_deletable</methodname>
- <methodparam><parameter role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> decorate the window
- as deletable</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>By default, windows have a close button in the window
- frame. Some window managers allow GTK+ to disable this button. If you
- set the deletable property to <literal>False</literal> using this
- method, GTK+ will do its best to convince the window manager not to
- show a close button. Depending on the system, this method may not have
- any effect when called on a window that is already visible, so you
- should call it before calling
- <methodname>gtk_window_show</methodname>().</para>
-
- <para>On Windows, this method always works, since there's no window
- manager policy involved.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-deletable">
- <title>gtk.Window.get_deletable</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_deletable</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the window has been
- set to have a close button</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns whether the window has been set to have a close button
- via the <link
- linkend="method-gtkwindow--set-deletable"><methodname>gtk.Window.set_deletable()</methodname></link>
- method.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindow--get-group">
- <title>gtk.Window.get_group</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_group</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link>
- for a window or the default group</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Returns the <link
- linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link>
- or the default group, if the window does not have an explicit window
- group.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-gtk--window-set-default-icon-list">
- <title>gtk.window_set_default_icon_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.window_set_default_icon_list</methodname>
- <methodparam><parameter>...</parameter>
- </methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>zero or more <link
-linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>
-objects</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.window_set_default_icon_list</function>()
-function sets an icon list to be used as fallback for windows that haven't
-had the <link
-linkend="method-gtkwindow--set-icon-list"><methodname>set_icon_list</methodname>()</link>
-method called on them to set up a window-specific icon list. This function
-allows you to set up the icon for all windows in your app at once. See the
-<link
-linkend="method-gtkwindow--set-icon-list"><methodname>set_icon_list</methodname>()</link>
-method documentation for more details.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--window-set-default-icon">
- <title>gtk.window_set_default_icon</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.window_set_default_icon</methodname>
- <methodparam><parameter role="keyword">icon</parameter>
- </methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">icon</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>gtk.window_set_default_icon</function>() function
-sets an icon specified by <parameter>icon</parameter> to be used as the
-fallback for windows that haven't had the <link
-linkend="method-gtkwindow--set-icon"><methodname>set_icon</methodname>()</link>
-method called on them to set up a window-specific icon. This function allows
-you to set up the icon for all windows in your app at once.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--window-set-default-icon-from-file">
- <title>gtk.window_set_default_icon_from_file</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.window_set_default_icon_from_file</methodname>
- <methodparam><parameter role="keyword">filename</parameter>
- </methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">filename</parameter>&nbsp;:</term>
- <listitem><simpara>an icon file name</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The <function>gtk.window_set_default_icon_from_file</function>()
-function sets an icon contained in the file specified by
-<parameter>filename</parameter> to be used as the fallback for windows that
-haven't had the <link
-linkend="method-gtkwindow--set-icon"><methodname>set_icon</methodname>()</link>
-method called on them to set up a window-specific icon. This function allows
-you to set up the icon for all windows in your app at once.</para>
-
- <para>The GError exception is raised if an error occurs while loading
-the icon pixbuf from <parameter>filename</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--window-get-default-icon-list">
- <title>gtk.window_get_default_icon_list</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.window_get_default_icon_list</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the applications default icon
-list</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.window_get_default_icon_list</function>()
-function returns the application's default icon list as set by the <link
-linkend="function-gtk--window-set-default-icon-list"><methodname>gtk.window_set_default_icon_list</methodname>()</link>
-function. See the <link
-linkend="method-gtkwindow--set-icon-list"><methodname>set_icon_list</methodname>()</link>
-method documentation for more details.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--window-set-auto-startup-notification">
- <title>gtk.window_set_auto_startup_notification</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.window_set_auto_startup_notification</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, automatically do
- startup notification</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.2 and above.</para>
- </note>
-
- <para>The
-<function>gtk.window_set_auto_startup_notification</function>() function
-sets the auto startup notification setting to the value of <parameter>setting</parameter>. If <parameter>setting</parameter> is <literal>True</literal> startup notification will be done automatically.</para>
-
- <para>By default, after showing the first <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> for each
-<link
-linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>, GTK+
-calls the <function>gdk_notify_startup_complete</function>() function. Call
-this function to disable the automatic startup notification. You might do
-this if your first window is a splash screen, and you want to delay
-notification until after your real main window has been shown. In that
-example, you would disable startup notification temporarily, show your
-splash screen, then re-enable it so that showing the main window would
-automatically result in notification.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--window-list-toplevels">
- <title>gtk.window_list_toplevels</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.window_list_toplevels</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of all the toplevel <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
-widgets</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>gtk.window_list_toplevels</function>() function
-returns a list of all the toplevel <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> widgets
-in the application.</para>
-
- </refsect2>
-
- <refsect2 id="function-gtk--window-set-default-icon-name">
- <title>gtk.window_set_default_icon_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtk.window_set_default_icon_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, automatically do
- startup notification</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <function>gtk.window_set_default_icon_name</function>()
-function sets an icon to be used as fallback for windows that haven't had
-the <link
-linkend="method-gtkwindow--set-icon-list"><methodname>set_icon_list</methodname>()</link>
-method called on them from a named themed icon, see the <link
-linkend="method-gtkwindow--set-icon-name"><methodname>set_icon_name</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Signals</title>
-
- <refsect2 id="signal-gtkwindow--activate-default">
- <title>The "activate-default" gtk.Window Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>window</parameter>&nbsp;:</term>
- <listitem><simpara>the window that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "activate-default" signal is emitted when the default child
-widget of <parameter>window</parameter> is activated usually by the user
-pressing the <keycap>Return</keycap> or <keycap>Enter</keycap> key.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwindow--activate-focus">
- <title>The "activate-focus" gtk.Window Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>window</parameter>&nbsp;:</term>
- <listitem><simpara>the window that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "activate-focus" signal is emitted when the child widget
-with the focus is activated usually by the user pressing the
-<keycap>Space</keycap> key.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwindow--frame-event">
- <title>The "frame-event" gtk.Window Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>window</parameter>&nbsp;:</term>
- <listitem><simpara>the window that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>event</parameter>&nbsp;:</term>
- <listitem><simpara>the event that triggered the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> to stop other handlers
- from being invoked for the event. <literal>False</literal> to
- propagate the event further.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "frame-event" signal is emitted when an event other than key
-press or release or focus change is received on the window's frame.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwindow--keys-changed">
- <title>The "keys-changed" gtk.Window Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>window</parameter>&nbsp;:</term>
- <listitem><simpara>the window that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "keys-changed" signal is emitted when a mnemonic accelerator
-is added, removed or changed or the mnemonic modifier is set.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwindow--move-focus">
- <title>The "move-focus" gtk.Window Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>direction</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>window</parameter>&nbsp;:</term>
- <listitem><simpara>the window that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>direction</parameter>&nbsp;:</term>
- <listitem><simpara>the move direction:
-<literal>gtk.DIR_TAB_FORWARD</literal>,
-<literal>gtk.DIR_TAB_BACKWARD</literal>, <literal>gtk.DIR_UP</literal>,
-<literal>gtk.DIR_DOWN</literal>, <literal>gtk.DIR_LEFT</literal> or
-<literal>gtk.DIR_RIGHT</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "move-focus" signal is emitted when the focus is changed
-within the window's child widgets. Usually this happens when the user
-presses the <keycap>Tab</keycap>, the <keycombo
-action="simul"><keycap>Shift</keycap><keycap>Tab</keycap> </keycombo> or the
-<keycap>Up</keycap>, <keycap>Down</keycap>, <keycap>Left</keycap> or
-<keycap>Right</keycap> arrow keys.</para>
-
- </refsect2>
-
- <refsect2 id="signal-gtkwindow--set-focus">
- <title>The "set-focus" gtk.Window Signal</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>callback</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>...</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter>window</parameter>&nbsp;:</term>
- <listitem><simpara>the window that received the
-signal</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>widget</parameter>&nbsp;:</term>
- <listitem><simpara>the widget that receives the
-focus</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>user_param1</parameter>&nbsp;:</term>
- <listitem><simpara>the first user parameter (if any) specified
-with the <link
-linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>...</parameter>&nbsp;:</term>
- <listitem><simpara>additional user parameters (if
-any)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The "set-focus" signal is emitted when the focus changes to <parameter>widget</parameter> in <parameter>window</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-gtkwindowgroup.xml b/docs/reference/pygtk-gtkwindowgroup.xml
deleted file mode 100644
index e9306c14..00000000
--- a/docs/reference/pygtk-gtkwindowgroup.xml
+++ /dev/null
@@ -1,141 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-gtkwindowgroup">
- <refnamediv>
- <refname>gtk.WindowGroup</refname>
- <refpurpose>a group of <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
-widgets</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.WindowGroup</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkwindowgroup">gtk.WindowGroup</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindowgroup--add-window">add_window</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-gtkwindowgroup--remove-window">remove_window</link></methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkwindowgroup">gtk.WindowGroup</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1 id="signal-prototypes-gtkwindowgroup">
- <title>gtk.WindowGroup Signal Prototypes</title>
-
- <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link>
-object contains a set of <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> widgets
-that are managed together by some <literal>PyGTK</literal> functions and
-methods.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkwindowgroup">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.WindowGroup</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link>
-object. Grabs added with <link
-linkend="method-gtkwidget--grab-add"><methodname>gtk.Widget.grab_add</methodname>()</link>
-only affect windows within the same <link
-linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkwindowgroup--add-window">
- <title>gtk.WindowGroup.add_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>add_window</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> to
-add</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>add_window</methodname>() method adds the <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> specified
-by <parameter>window</parameter> to the windowgroup.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkwindowgroup--remove-window">
- <title>gtk.WindowGroup.remove_window</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>remove_window</methodname>
- <methodparam><parameter
- role="keyword">window</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">window</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-gtkwindow"><classname>gtk.Window</classname></link> to
-remove</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>remove_window</methodname>() method removes the
-<link linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
-specified by <parameter>window</parameter> from the windowgroup.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-hierarchy.xml b/docs/reference/pygtk-hierarchy.xml
deleted file mode 100644
index 40640f87..00000000
--- a/docs/reference/pygtk-hierarchy.xml
+++ /dev/null
@@ -1,230 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE synopsis PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<synopsis><link linkend="class-gobjectgboxed">gobject.GBoxed</link>
- <link linkend="class-gtkborder">gtk.Border</link>
- <link linkend="class-gtkiconinfo">gtk.IconInfo</link>
- <link linkend="class-gtkiconset">gtk.IconSet</link>
- <link linkend="class-gtkiconsource">gtk.IconSource</link>
- <link linkend="class-gtkrequisition">gtk.Requisition</link>
- <link linkend="class-gtkselectiondata">gtk.SelectionData</link>
- <link linkend="class-gtktextattributes">gtk.TextAttributes</link>
- <link linkend="class-gtktextiter">gtk.TextIter</link>
- <link linkend="class-gtktreeiter">gtk.TreeIter</link>
- <link linkend="class-gtktreerowreference">gtk.TreeRowReference</link>
- <link linkend="class-gdkcolor">gtk.gdk.Color</link>
- <link linkend="class-gdkcursor">gtk.gdk.Cursor</link>
- <link linkend="class-gdkevent">gtk.gdk.Event</link><!--
- <link linkend="class-gdkfont">gtk.gdk.Font</link>-->
- <link linkend="class-gdkrectangle">gtk.gdk.Rectangle</link>
- <link linkend="class-pangoattrlist">pango.AttrList</link>
- <link linkend="class-pangocolor">pango.Color</link>
- <link linkend="class-pangofontdescription">pango.FontDescription</link>
- <link linkend="class-pangofontmetrics">pango.FontMetrics</link>
- <link linkend="class-pangoglyphstring">pango.GlyphString</link>
- <link linkend="class-pangolanguage">pango.Language</link>
- <link linkend="class-pangolayoutline">pango.LayoutLine</link>
- <link linkend="class-pangotabarray">pango.TabArray</link>
-<link linkend="class-gobjectginterface">gobject.GInterface</link>
- <link linkend="class-gtkcelleditable">gtk.CellEditable</link>
- <link linkend="class-gtkcelllayout">gtk.CellLayout</link>
- <link linkend="class-gtkeditable">gtk.Editable</link>
- <link linkend="class-gtkfilechooser">gtk.FileChooser</link>
- <link linkend="class-gtktreedragdest">gtk.TreeDragDest</link>
- <link linkend="class-gtktreedragsource">gtk.TreeDragSource</link>
- <link linkend="class-gtktreemodel">gtk.TreeModel</link>
- <link linkend="class-gtktreesortable">gtk.TreeSortable</link>
-<link linkend="class-gobject">gobject.GObject</link><!--
- <link linkend="class-atkhyperlink">atk.Hyperlink</link>
- <link linkend="class-atkobject">atk.Object</link>
- <link linkend="class-atknoopobject">atk.NoOpObject</link>
- <link linkend="class-gtkaccessible">gtk.Accessible</link>
- <link linkend="class-atkobjectfactory">atk.ObjectFactory</link>
- <link linkend="class-atknoopobjectfactory">atk.NoOpObjectFactory</link>
- <link linkend="class-atkregistry">atk.Registry</link>
- <link linkend="class-atkrelation">atk.Relation</link>
- <link linkend="class-atkrelationset">atk.RelationSet</link>
- <link linkend="class-atkstateset">atk.StateSet</link>
- <link linkend="class-atkutil">atk.Util</link>-->
- <link linkend="class-gtkaccelgroup">gtk.AccelGroup</link>
- <link linkend="class-gtkaction">gtk.Action</link>
- <link linkend="class-gtktoggleaction">gtk.ToggleAction</link>
- <link linkend="class-gtkradioaction">gtk.RadioAction</link>
- <link linkend="class-gtkactiongroup">gtk.ActionGroup</link>
- <link linkend="class-gtkclipboard">gtk.Clipboard</link>
- <link linkend="class-gtkentrycompletion">gtk.EntryCompletion</link> (implements <link linkend="class-gtkcelllayout">gtk.CellLayout</link>)
- <link linkend="class-pygtkgenerictreemodel">gtk.GenericTreeModel</link> (implements <link linkend="class-gtktreemodel">gtk.TreeModel</link>)
- <link linkend="class-gtkiconfactory">gtk.IconFactory</link>
- <link linkend="class-gtkicontheme">gtk.IconTheme</link>
- <link linkend="class-gtkliststore">gtk.ListStore</link> (implements <link linkend="class-gtktreemodel">gtk.TreeModel</link>, <link linkend="class-gtktreedragsource">gtk.TreeDragSource</link>, <link linkend="class-gtktreedragdest">gtk.TreeDragDest</link>, <link linkend="class-gtktreesortable">gtk.TreeSortable</link>)
- <link linkend="class-gtkobject">gtk.Object</link>
- <link linkend="class-gtkadjustment">gtk.Adjustment</link>
- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
- <link linkend="class-gtkcellrendererpixbuf">gtk.CellRendererPixbuf</link>
- <link linkend="class-gtkcellrenderertext">gtk.CellRendererText</link>
- <link linkend="class-gtkcellrenderercombo">gtk.CellRendererCombo</link>
- <link linkend="class-gtkcellrendererprogress">gtk.CellRendererProgress</link>
- <link linkend="class-gtkcellrenderertoggle">gtk.CellRendererToggle</link>
- <link linkend="class-pygtkgenericcellrenderer">gtk.GenericCellRenderer</link>
- <link linkend="class-gtkfilefilter">gtk.FileFilter</link>
- <link linkend="class-gtkimcontext">gtk.IMContext</link>
- <link linkend="class-gtkimcontextsimple">gtk.IMContextSimple</link>
- <link linkend="class-gtkimmulticontext">gtk.IMMulticontext</link><!--
- <link linkend="class-gtkitemfactory">gtk.ItemFactory</link>-->
- <link linkend="class-gtktooltips">gtk.Tooltips</link>
- <link linkend="class-gtktreeviewcolumn">gtk.TreeViewColumn</link> (implements <link linkend="class-gtkcelllayout">gtk.CellLayout</link>)
- <link linkend="class-gtkwidget">gtk.Widget</link>
- <link linkend="class-gtkcalendar">gtk.Calendar</link>
- <link linkend="class-gtkcellview">gtk.CellView</link>
- <link linkend="class-gtkcontainer">gtk.Container</link>
- <link linkend="class-gtkbin">gtk.Bin</link>
- <link linkend="class-gtkalignment">gtk.Alignment</link>
- <link linkend="class-gtkbutton">gtk.Button</link>
- <link linkend="class-gtkcolorbutton">gtk.ColorButton</link>
- <link linkend="class-gtkfontbutton">gtk.FontButton</link><!--
- <link linkend="class-gtkoptionmenu">gtk.OptionMenu</link>-->
- <link linkend="class-gtktogglebutton">gtk.ToggleButton</link>
- <link linkend="class-gtkcheckbutton">gtk.CheckButton</link>
- <link linkend="class-gtkradiobutton">gtk.RadioButton</link>
- <link linkend="class-gtkcombobox">gtk.ComboBox</link> (implements <link linkend="class-gtkcelllayout">gtk.CellLayout</link>)
- <link linkend="class-gtkcomboboxentry">gtk.ComboBoxEntry</link> (implements <link linkend="class-gtkcelllayout">gtk.CellLayout</link>)
- <link linkend="class-gtkeventbox">gtk.EventBox</link>
- <link linkend="class-gtkexpander">gtk.Expander</link>
- <link linkend="class-gtkframe">gtk.Frame</link>
- <link linkend="class-gtkaspectframe">gtk.AspectFrame</link>
- <link linkend="class-gtkhandlebox">gtk.HandleBox</link>
- <link linkend="class-gtkitem">gtk.Item</link><!--
- <link linkend="class-gtklistitem">gtk.ListItem</link>-->
- <link linkend="class-gtkmenuitem">gtk.MenuItem</link>
- <link linkend="class-gtkcheckmenuitem">gtk.CheckMenuItem</link>
- <link linkend="class-gtkradiomenuitem">gtk.RadioMenuItem</link>
- <link linkend="class-gtkimagemenuitem">gtk.ImageMenuItem</link>
- <link linkend="class-gtkseparatormenuitem">gtk.SeparatorMenuItem</link>
- <link linkend="class-gtktearoffmenuitem">gtk.TearoffMenuItem</link>
- <link linkend="class-gtkscrolledwindow">gtk.ScrolledWindow</link>
- <link linkend="class-gtktoolitem">gtk.ToolItem</link>
- <link linkend="class-gtkseparatortoolitem">gtk.SeparatorToolItem</link>
- <link linkend="class-gtktoolbutton">gtk.ToolButton</link>
- <link linkend="class-gtkmenutoolbutton">gtk.MenuToolButton</link>
- <link linkend="class-gtktoggletoolbutton">gtk.ToggleToolButton</link>
- <link linkend="class-gtkradiotoolbutton">gtk.RadioToolButton</link>
- <link linkend="class-gtkviewport">gtk.Viewport</link>
- <link linkend="class-gtkwindow">gtk.Window</link>
- <link linkend="class-gtkdialog">gtk.Dialog</link>
- <link linkend="class-gtkaboutdialog">gtk.AboutDialog</link>
- <link linkend="class-gtkcolorselectiondialog">gtk.ColorSelectionDialog</link>
- <link linkend="class-gtkfilechooserdialog">gtk.FileChooserDialog</link> (implements <link linkend="class-gtkfilechooser">gtk.FileChooser</link>)
- <link linkend="class-gtkfileselection">gtk.FileSelection</link>
- <link linkend="class-gtkfontselectiondialog">gtk.FontSelectionDialog</link>
- <link linkend="class-gtkinputdialog">gtk.InputDialog</link>
- <link linkend="class-gtkmessagedialog">gtk.MessageDialog</link>
- <link linkend="class-gtkplug">gtk.Plug</link>
- <link linkend="class-gtkbox">gtk.Box</link>
- <link linkend="class-gtkbuttonbox">gtk.ButtonBox</link>
- <link linkend="class-gtkhbuttonbox">gtk.HButtonBox</link>
- <link linkend="class-gtkvbuttonbox">gtk.VButtonBox</link>
- <link linkend="class-gtkhbox">gtk.HBox</link><!--
- <link linkend="class-gtkcombo">gtk.Combo</link>-->
- <link linkend="class-gtkfilechooserbutton">gtk.FileChooserButton</link>
- <link linkend="class-gtkstatusbar">gtk.Statusbar</link>
- <link linkend="class-gtkvbox">gtk.VBox</link>
- <link linkend="class-gtkcolorselection">gtk.ColorSelection</link>
- <link linkend="class-gtkfilechooserwidget">gtk.FileChooserWidget</link> (implements <link linkend="class-gtkfilechooser">gtk.FileChooser</link>)
- <link linkend="class-gtkfontselection">gtk.FontSelection</link>
- <link linkend="class-gtkgammacurve">gtk.GammaCurve</link><!--
- <link linkend="class-gtkclist">gtk.CList</link>
- <link linkend="class-gtkctree">gtk.CTree</link>-->
- <link linkend="class-gtkfixed">gtk.Fixed</link>
- <link linkend="class-gtkiconview">gtk.IconView</link>
- <link linkend="class-gtklayout">gtk.Layout</link><!--
- <link linkend="class-gtklist">gtk.List</link>-->
- <link linkend="class-gtkmenushell">gtk.MenuShell</link>
- <link linkend="class-gtkmenu">gtk.Menu</link>
- <link linkend="class-gtkmenubar">gtk.MenuBar</link>
- <link linkend="class-gtknotebook">gtk.Notebook</link>
- <link linkend="class-gtkpaned">gtk.Paned</link>
- <link linkend="class-gtkhpaned">gtk.HPaned</link>
- <link linkend="class-gtkvpaned">gtk.VPaned</link>
- <link linkend="class-gtksocket">gtk.Socket</link>
- <link linkend="class-gtktable">gtk.Table</link>
- <link linkend="class-gtktextview">gtk.TextView</link>
- <link linkend="class-gtktoolbar">gtk.Toolbar</link>
- <link linkend="class-gtktreeview">gtk.TreeView</link>
- <link linkend="class-gtkdrawingarea">gtk.DrawingArea</link>
- <link linkend="class-gtkcurve">gtk.Curve</link>
- <link linkend="class-gtkentry">gtk.Entry</link> (implements <link linkend="class-gtkeditable">gtk.Editable</link>, <link linkend="class-gtkcelleditable">gtk.CellEditable</link>)
- <link linkend="class-gtkspinbutton">gtk.SpinButton</link>
- <link linkend="class-gtkinvisible">gtk.Invisible</link>
- <link linkend="class-gtkmisc">gtk.Misc</link>
- <link linkend="class-gtkarrow">gtk.Arrow</link>
- <link linkend="class-gtkimage">gtk.Image</link>
- <link linkend="class-gtklabel">gtk.Label</link>
- <link linkend="class-gtkaccellabel">gtk.AccelLabel</link><!--
- <link linkend="class-gtkpixmap">gtk.Pixmap</link>
- <link linkend="class-gtkoldeditable">gtk.OldEditable</link> (implements <link linkend="class-gtkeditable">gtk.Editable</link>)
- <link linkend="class-gtkpreview">gtk.Preview</link>
- <link linkend="class-gtkprogress">gtk.Progress</link>-->
- <link linkend="class-gtkprogressbar">gtk.ProgressBar</link>
- <link linkend="class-gtkrange">gtk.Range</link>
- <link linkend="class-gtkscale">gtk.Scale</link>
- <link linkend="class-gtkhscale">gtk.HScale</link>
- <link linkend="class-gtkvscale">gtk.VScale</link>
- <link linkend="class-gtkscrollbar">gtk.Scrollbar</link>
- <link linkend="class-gtkhscrollbar">gtk.HScrollbar</link>
- <link linkend="class-gtkvscrollbar">gtk.VScrollbar</link>
- <link linkend="class-gtkruler">gtk.Ruler</link>
- <link linkend="class-gtkhruler">gtk.HRuler</link>
- <link linkend="class-gtkvruler">gtk.VRuler</link>
- <link linkend="class-gtkseparator">gtk.Separator</link>
- <link linkend="class-gtkhseparator">gtk.HSeparator</link>
- <link linkend="class-gtkvseparator">gtk.VSeparator</link>
- <link linkend="class-gtkrcstyle">gtk.RcStyle</link>
- <link linkend="class-gtksettings">gtk.Settings</link>
- <link linkend="class-gtksizegroup">gtk.SizeGroup</link>
- <link linkend="class-gtkstyle">gtk.Style</link>
- <link linkend="class-gtktextbuffer">gtk.TextBuffer</link>
- <link linkend="class-gtktextchildanchor">gtk.TextChildAnchor</link>
- <link linkend="class-gtktextmark">gtk.TextMark</link>
- <link linkend="class-gtktexttag">gtk.TextTag</link>
- <link linkend="class-gtktexttagtable">gtk.TextTagTable</link>
- <link linkend="class-gtktreemodelfilter">gtk.TreeModelFilter</link> (implements <link linkend="class-gtktreemodel">gtk.TreeModel</link>, <link linkend="class-gtktreedragsource">gtk.TreeDragSource</link>)
- <link linkend="class-gtktreemodelsort">gtk.TreeModelSort</link> (implements <link linkend="class-gtktreemodel">gtk.TreeModel</link>, <link linkend="class-gtktreesortable">gtk.TreeSortable</link>)
- <link linkend="class-gtktreeselection">gtk.TreeSelection</link>
- <link linkend="class-gtktreestore">gtk.TreeStore</link> (implements <link linkend="class-gtktreemodel">gtk.TreeModel</link>, <link linkend="class-gtktreedragsource">gtk.TreeDragSource</link>, <link linkend="class-gtktreedragdest">gtk.TreeDragDest</link>, <link linkend="class-gtktreesortable">gtk.TreeSortable</link>)
- <link linkend="class-gtkuimanager">gtk.UIManager</link>
- <link linkend="class-gtkwindowgroup">gtk.WindowGroup</link>
- <link linkend="class-gdkcolormap">gtk.gdk.Colormap</link>
- <link linkend="class-gdkdevice">gtk.gdk.Device</link>
- <link linkend="class-gdkdisplay">gtk.gdk.Display</link>
- <link linkend="class-gdkdisplaymanager">gtk.gdk.DisplayManager</link>
- <link linkend="class-gdkdragcontext">gtk.gdk.DragContext</link>
- <link linkend="class-gdkdrawable">gtk.gdk.Drawable</link>
- <link linkend="class-gdkpixmap">gtk.gdk.Pixmap</link>
- <link linkend="class-gdkwindow">gtk.gdk.Window</link>
- <link linkend="class-gdkgc">gtk.gdk.GC</link>
- <link linkend="class-gdkimage">gtk.gdk.Image</link>
- <link linkend="class-gdkkeymap">gtk.gdk.Keymap</link>
- <link linkend="class-gdkpixbuf">gtk.gdk.Pixbuf</link>
- <link linkend="class-gdkpixbufanimation">gtk.gdk.PixbufAnimation</link>
- <link linkend="class-gdkpixbufanimationiter">gtk.gdk.PixbufAnimationIter</link>
- <link linkend="class-gdkpixbufloader">gtk.gdk.PixbufLoader</link>
- <link linkend="class-gdkscreen">gtk.gdk.Screen</link>
- <link linkend="class-gdkvisual">gtk.gdk.Visual</link><!--
- <link linkend="class-gladexml">gtk.glade.XML</link>-->
- <link linkend="class-pangocontext">pango.Context</link>
- <link linkend="class-pangofont">pango.Font</link>
- <link linkend="class-pangofontface">pango.FontFace</link>
- <link linkend="class-pangofontfamily">pango.FontFamily</link>
- <link linkend="class-pangofontmap">pango.FontMap</link>
- <link linkend="class-pangocairocairofontmap">pangocairo.CairoFontMap</link>
- <link linkend="class-pangofontset">pango.Fontset</link>
- <link linkend="class-pangofontsetsimple">pango.FontsetSimple</link>
- <link linkend="class-pangolayout">pango.Layout</link>
- <link linkend="class-pangorenderer">pango.Renderer</link>
- <link linkend="class-gdkpangorenderer">gtk.gdk.PangoRenderer</link>
-<link linkend="class-gobjectgpointer">gobject.GPointer</link><!--
- <link linkend="class-gtkctreenode">gtk.CTreeNode</link>-->
-cairo.Context
- <link linkend="class-pangocairocairocontext">pangocairo.CairoContext</link>
- <link linkend="class-gdkcairocontext">gtk.gdk.CairoContext</link>
-</synopsis>
diff --git a/docs/reference/pygtk-introduction.xml b/docs/reference/pygtk-introduction.xml
deleted file mode 100644
index 93675af7..00000000
--- a/docs/reference/pygtk-introduction.xml
+++ /dev/null
@@ -1,515 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
- <chapter id="pygtk-introduction">
- <title>Introduction</title>
-
- <para>This document describes most of the <literal>PyGTK</literal> version
- 2.0 through 2.10 classes and their methods and associated
- functions. Deprecated classes, functions and methods have been
- specifically left out of this reference though classes that have become
- deprecated since PyGTK 2.0 have been left in but annotated with a
- deprecation warning. This document attempts to document as much of the
- <literal>PyGTK</literal> <literal>API</literal> as possible but there are
- undoubtedly errors and omissions. If you discover any of these please file
- a bug report at <ulink
- url="http://bugzilla.gnome.org">bugzilla.gnome.org</ulink> for the
- <literal>pygtk</literal> project. Specific areas that have not been
- documented include:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>The Cairo classes</simpara>
- </listitem>
- </itemizedlist>
-
- <para>This reference describes the API for <literal>PyGTK</literal> as of
- version 2.9.0+ and assumes that the additional API changes for version
- 2.10 may not be significant. There will undoubtedly be changes that are
- not reflected in this reference. The differences in the API between
- version 2.0 and previous versions are denoted in this reference with a
- Note that describes the availability of the object, constructor, method or
- function. Any of these that do not have a notation can be assumed to be
- available in all versions of PyGTK from 2.0 and up. In the case of
- properties and signals the availability is dependent on the version of the
- underlying GTK+, GDK or Pango libraries. These will be annotated
- appropriately in a similar fashion. The source code must be consulted if
- this reference and your version of <literal>PyGTK</literal> seem to
- differ. You are encouraged to use the latest version of
- <literal>PyGTK</literal> that is available. See the <ulink
- url="http://www.pygtk.org"><literal>PyGTK</literal> homepage</ulink> for
- more information and more resources on how to use PyGTK as well as help in
- its development.</para>
-
- <para> The Reference contains a chapter for each <literal>PyGTK</literal>
- module (that corresponds to the underlying <literal>GTK+</literal>
- library) containing the class descriptions. The second chapter illustrates
- the <literal>PyGTK</literal> class hierarchy covering the gobject, gtk,
- gtk.gdk and pango modules.</para>
-
- <para>The class descriptions are arranged alphabetically within the
- chapters. Currently there are five module chapters:</para>
-
- <variablelist>
- <varlistentry>
- <term>The&nbsp;<literal>atk</literal>&nbsp;module</term>
- <listitem><simpara>The classes that are included in the
- <literal>atk</literal> module of <literal>PyGTK</literal> and are
- accessed similar to: atk.Object. These classes are the base object
- classes that provide accessibility support for the
- <literal>gtk</literal> module classes.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>The&nbsp;<literal>gtk</literal>&nbsp;module</term>
- <listitem><simpara>The classes that are included in the
- <literal>gtk</literal> module of <literal>PyGTK</literal> and are
- accessed similar to: gtk.Widget. These classes are the "higher" level
- widget classes that provide most of the user interface widgets used
- for application development.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>The&nbsp;<literal>gtk.gdk</literal>&nbsp;module</term>
- <listitem><simpara>The classes that are included in the
- <literal>gtk.gdk</literal> module of <literal>PyGTK</literal>. These
- classes are "lower" level classes that provide more fundamental
- capabilities that the <literal>gtk</literal> module widgets are built
- upon. These classes provide an abstract interface to the underlying
- window system (either X Window System or Microsoft Windows).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>The&nbsp;<literal>gtk.glade</literal>&nbsp;module</term>
- <listitem><simpara>The classes that are included in the
- <literal>gtk.glade</literal> module of <literal>PyGTK</literal>. These
- classes provide access to the libglade functions that allow the
- dynamic loading of user interfaces from XML descriptions.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>The&nbsp;<literal>pango</literal>&nbsp;module</term>
- <listitem>
- <simpara>The classes that are included in the
- <literal>pango</literal> module of <literal>PyGTK</literal>. These
- classes provide access to the Pango text layout and rendering
- engines. PyGTK supports a subset of the full Pango capability:
- mainly the high level layout capabilities exposed by the
- pango.Layout objects. The low level rendering capabilities have not
- been exposed mostly because there isn't a full GObject interface to
- the underlying Pango data structures. It's also likely that the
- rendering capabilities require more performance that Python can
- provide.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <literal>gobject</literal> module is documented in the <link
- linkend="pygobject-reference">PyGObject Reference Manual</link>.</para>
-
- <sect1>
- <title>Major Changes since Version 1.9</title>
-
- <para>The major changes in this document since version 1.9
-include:</para>
-
- <itemizedlist>
- <listitem>
- <para>descriptions of new GTK+ 2.2 and 2.4 classes:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><link linkend="class-gobjectgboxed"><classname>gobject.GBoxed</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gobjectgpointer"><classname>gobject.GPointer</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gobjectginterface"><classname>gobject.GInterface</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gobjectmaincontext"><classname>gobject.MainContext</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gobjectmainloop"><classname>gobject.MainLoop</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkaction"><classname>gtk.Action</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkborder"><classname>gtk.Border</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkclipboard"><classname>gtk.Clipboard</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkcolorbutton"><classname>gtk.ColorButton</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkcomboboxentry"><classname>gtk.ComboBoxEntry</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkentrycompletion"><classname>gtk.EntryCompletion</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkexpander"><classname>gtk.Expander</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkfilechooserdialog"><classname>gtk.FileChooserDialog</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkfilechooserwidget"><classname>gtk.FileChooserWidget</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkfilefilter"><classname>gtk.FileFilter</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkfontbutton"><classname>gtk.FontButton</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkicontheme"><classname>gtk.IconTheme</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtktoggleaction"><classname>gtk.ToggleAction</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtktreemodelfilter"><classname>gtk.TreeModelFilter</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtktreerowreference"><classname>gtk.TreeRowReference</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gdkatom"><classname>gtk.gdk.Atom</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gdkdisplaymanager"><classname>gtk.gdk.DisplayManager</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-pangofontsetsimple"><classname>pango.FontsetSimple</classname></link></simpara>
- </listitem>
- </itemizedlist>
-
- </listitem>
- <listitem>
- <simpara>Descriptions of new GTK+ 2.6 classes:</simpara>
-
- <itemizedlist>
- <listitem>
- <simpara><link linkend="class-gtkaboutdialog"><classname>gtk.AboutDialog</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkcellrenderercombo"><classname>gtk.CellRendererCombo</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkcellrendererprogress"><classname>gtk.CellRendererProgress</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkcellview"><classname>gtk.CellView</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkfilechooserbutton"><classname>gtk.FileChooserButton</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkiconview"><classname>gtk.IconView</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link></simpara>
- </listitem>
- </itemizedlist>
-
- </listitem>
- <listitem>
- <para>a reference page in each module chapter containing
-descriptions of or links to all of the functions defined in a module.</para>
- </listitem>
- <listitem>
- <para>a reference page in each module chapter containing
-descriptions of all of the constants defined in a module.</para>
- </listitem>
- <listitem>
- <para>additional methods, functions, properties and signals added
- for GTK+ 2.2, GTK+ 2.4, GTK+ 2.6, PyGTK 2.2, PyGTK 2.4, PyGTK 2.6,
- PyGTK 2.8 and PyGTK 2.10.</para>
- </listitem>
- <listitem>
- <simpara>Descriptions of new GTK+ 2.10 classes:</simpara>
-
- <itemizedlist>
- <listitem>
- <simpara><link linkend="class-gtkassistant"><classname>gtk.Assistant</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkcellrendereraccel"><classname>gtk.CellRendererAccel</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkcellrendererspin"><classname>gtk.CellRendererSpin</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkprintoperationpreview"><classname>gtk.PrintOperationPreview</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara><link linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link></simpara>
- </listitem>
- </itemizedlist>
-
- </listitem>
- <listitem>
- <para>new in PyGTK 2.10, the <link
- linkend="unixprint-class-reference">Unix print module
- gtkunixprint</link>.</para>
- </listitem>
- <listitem>
- <para>documentation on the <link
- linkend="atk-class-reference">Accessibilty Tool Kit
- atk</link>.</para>
- </listitem>
- </itemizedlist>
-
- </sect1>
-
- <sect1 id="pygtk-reference-format">
- <title>Reference Page Format</title>
-
- <para>Each <literal>PyGTK</literal> class is described in a reference
-page that has a number of sections in a fixed format. Each reference page
-will have a subset of the following sections:</para>
-
- <variablelist>
- <varlistentry>
- <term>Name</term>
- <listitem>
- <simpara>The name and a one-line description of the
-class.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Synopsis</term>
- <listitem>
- <simpara>A synopsis of the class and its methods and
-optionally a list of associated functions.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Ancestry</term>
- <listitem>
- <simpara>The list of the parent classes of the class. This
-section may not be present in all class descriptions.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Properties</term>
- <listitem>
- <simpara>A list of the properties (internal state)
-supported by the class. This section may not be present in all classes. The
-property descriptions include the name, the access operations (e.g. Read,
-Write), and a brief description. Properties are accessed using the <link
-linkend="method-gobject--set-property"><methodname>gobject.set_property</methodname>()</link>
-and <link
-linkend="method-gobject--get-property"><methodname>gobject.get_property</methodname>()</link>
-methods that are available to every <literal>PyGTK</literal> object. This
-section may not be present in all class descriptions.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Style&nbsp;Properties</term>
- <listitem>
- <simpara>A list of style properties supported by the
-class. Similar to the properties (described above) the style properties hold
-information about the style of a widgets e.g. border style, shadow type,
-etc. Most widgets do not support style properties so this section is not
-present in most class descriptions. Only PyGTK 2.4 has the ability to access
-style properties.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Child&nbsp;Properties</term>
- <listitem>
- <simpara>A list of child properties supported by the
-class. Similar to the properties (described above) the child properties hold
-information about the properties of a widget's child widget. Only container
-widgets support child properties so this section is not present in most
-class descriptions.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Attributes</term>
- <listitem>
- <simpara>A set of internal object state data accessible as
-Python attributes (e.g. object.attr). The attribute descriptions include a
-name by which the attribute data is accessed, the access mode (e.g. Read,
-Write), and a brief description of the attribute. Most
-<literal>PyGTK</literal> classes do not support attributes so this section
-is not present in most class descriptions.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Signal&nbsp;Prototypes</term>
- <listitem>
- <simpara>A list of the signals supported by the class
-including the signal name and a synopsis of the signal handler function
-prototype. This section may not be present in all class descriptions; most
-<literal>gtk.gdk</literal> classes do not support signals.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Description</term>
- <listitem><simpara>A description of the class and possibly some of
-the methods supported by the class.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Constructor</term>
- <listitem>
- <simpara>The description of the class object constructor
-including the synopsis with brief parameter descriptions and a description
-of th use of the constructor. There may be more than one constructor
-description if the constructor supports different parameter lists. This
-section may not be present in all class descriptions.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Methods</term>
- <listitem>
- <simpara>A list of methods supported by the class. Each
-method description includes: a synopsis of the method and its parameters as
-well as a brief description of each parameter and return value (if any);
-and, a description of the use of the method.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Functions</term>
- <listitem>
- <simpara>A list of related functions. Each function
-description includes a synopsis of the function and its parameters and
-return value (if any), and a description of the use of the
-function.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Signals</term>
- <listitem>
- <simpara>A list of signals including a synopsis of the
-signal handler prototype function with its parameters and return value (if
-any). The signal emission conditions are briefly described. This section is
-not present in all class descriptions; specifically, the
-<literal>gtk.gdk</literal> classes do not usually support signals.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The function and method synopsis parameters are displayed in
-<emphasis role="bold">bold</emphasis> to denote Python keyword parameters.
-Also if the parameter is optional its default value will be displayed. For
-example the <link linkend="constructor-gtkbutton">gtk.Button</link>()
-constructor synopsis is:</para>
-
- <programlisting>
-<constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkbutton">gtk.Button</link></methodname>
- <methodparam><parameter
- role="keyword">label</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter
- role="keyword">stock</parameter><initializer>None</initializer></methodparam>
- </constructorsynopsis>
-</programlisting>
-
- <para>The parameters <parameter>label</parameter> and
-<parameter>stock</parameter> are keyword parameters that can be specified in
-a call either by position or keyword (in which case position is not
-important). The following calls have the same result:</para>
-
- <programlisting>
- b = gtk.Button("Cancel")
- b = gtk.Button(label="Cancel")
- b = gtk.Button("Cancel", None)
- b = gtk.Button("Cancel", stock=None)
- b = gtk.Button(stock=None, label="Cancel")
-</programlisting>
-
- <para>Parameters that are not keyword parameters are displayed in
- <emphasis>italic</emphasis> and must be specified positionally but may
- also be optional.</para>
-
- </sect1>
-
- </chapter>
diff --git a/docs/reference/pygtk-pango-classes.xml b/docs/reference/pygtk-pango-classes.xml
deleted file mode 100644
index 80e0203a..00000000
--- a/docs/reference/pygtk-pango-classes.xml
+++ /dev/null
@@ -1,33 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<chapter id="pango-class-reference" xmlns:xi="http://www.w3.org/2001/XInclude">
- <title>The pango Class Reference</title>
-
-<!-- PANGO OBJECTS -->
-
- <xi:include href="pygtk-pangoattribute.xml"/>
- <xi:include href="pygtk-pangoattriter.xml"/>
- <xi:include href="pygtk-pangoattrlist.xml"/>
- <xi:include href="pygtk-pangocolor.xml"/>
- <xi:include href="pygtk-pangocontext.xml"/>
- <xi:include href="pygtk-pangofont.xml"/>
- <xi:include href="pygtk-pangofontdescription.xml"/>
- <xi:include href="pygtk-pangofontface.xml"/>
- <xi:include href="pygtk-pangofontfamily.xml"/>
- <xi:include href="pygtk-pangofontmap.xml"/>
- <xi:include href="pygtk-pangofontmetrics.xml"/>
- <xi:include href="pygtk-pangofontset.xml"/>
- <xi:include href="pygtk-pangofontsetsimple.xml"/>
- <xi:include href="pygtk-pangoglyphstring.xml"/>
- <xi:include href="pygtk-pangolanguage.xml"/>
- <xi:include href="pygtk-pangolayout.xml"/>
- <xi:include href="pygtk-pangolayoutiter.xml"/>
- <xi:include href="pygtk-pangolayoutline.xml"/>
- <xi:include href="pygtk-pangorenderer.xml"/>
- <xi:include href="pygtk-pangotabarray.xml"/>
- <xi:include href="pygtk-pango-markup.xml"/>
- <xi:include href="pygtk-pango-functions.xml"/>
- <xi:include href="pygtk-pango-constants.xml"/>
-
-</chapter>
diff --git a/docs/reference/pygtk-pango-constants.xml b/docs/reference/pygtk-pango-constants.xml
deleted file mode 100644
index b10cafb5..00000000
--- a/docs/reference/pygtk-pango-constants.xml
+++ /dev/null
@@ -1,770 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="pango-constants">
- <refnamediv>
- <refname>pango Constants</refname>
- <refpurpose>the built-in constants of the pango module</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <programlisting>
-<xref linkend="pango-alignment-constants" endterm="pango-alignment-constants-title"></xref>
-<xref linkend="pango-attribute-type-constants" endterm="pango-attribute-type-constants-title"></xref>
-<xref linkend="pango-coverage-level-constants" endterm="pango-coverage-level-constants-title"></xref>
-<xref linkend="pango-direction-constants" endterm="pango-direction-constants-title"></xref>
-<xref linkend="pango-ellipsize-mode-constants" endterm="pango-ellipsize-mode-constants-title"></xref>
-<xref linkend="pango-font-mask-constants" endterm="pango-font-mask-constants-title"></xref>
-<xref linkend="pango-render-part-constants" endterm="pango-render-part-constants-title"></xref>
-<xref linkend="pango-scale-constants" endterm="pango-scale-constants-title"></xref>
-<xref linkend="pango-stretch-constants" endterm="pango-stretch-constants-title"></xref>
-<xref linkend="pango-style-constants" endterm="pango-style-constants-title"></xref>
-<xref linkend="pango-tab-constants" endterm="pango-tab-constants-title"></xref>
-<xref linkend="pango-underline-constants" endterm="pango-underline-constants-title"></xref>
-<xref linkend="pango-variant-constants" endterm="pango-variant-constants-title"></xref>
-<xref linkend="pango-weight-constants" endterm="pango-weight-constants-title"></xref>
-<xref linkend="pango-wrap-mode-constants" endterm="pango-wrap-mode-constants-title"></xref>
-</programlisting>
-
- </refsect1>
-
- <refsect1 id="pango-constants-description">
- <title>Description</title>
-
- <refsect2 id="pango-alignment-constants">
- <title id="pango-alignment-constants-title">Pango Alignment Constants</title>
-
- <para>The Alignment constants specify how to align the lines of a
-<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-within the available space. If the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> is
-set to justify using the <link
-linkend="method-pangolayout--set-justify"><methodname>pango.Layout.set_justify</methodname>()</link>
-method, then this only has an effect for partial lines.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.ALIGN_LEFT</literal></term>
- <listitem>
- <simpara>Put all available space on the right</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ALIGN_CENTER</literal></term>
- <listitem>
- <simpara>Center the line within the available space</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ALIGN_RIGHT</literal></term>
- <listitem>
- <simpara>Put all available space on the left</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-attribute-type-constants">
- <title id="pango-attribute-type-constants-title">Pango Attribute Type Constants</title>
-
- <para>The Attribute Type constants specify the type of a <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>.Along
-with the predefined values, it is possible to allocate additional values for
-custom attributes using the <link
-linkend="function-pango--attr-type-register"><function>pango.attr_type_register</function>()</link>
-function. The predefined values are given below. The type of structure used
-to store the attribute is listed in parentheses after the
-description.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.ATTR_LANGUAGE</literal></term>
- <listitem>
- <simpara>Specifies a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_FAMILY</literal></term>
- <listitem>
- <simpara>Specifies a font family name list as a string.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_STYLE</literal></term>
- <listitem>
- <simpara>Specifies a font slant style. See the <link
-linkend="function-pango--attrstyle"><function>pango.AttrStyle</function>()</link>
-function for more details.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_WEIGHT</literal></term>
- <listitem>
- <simpara>Specifies a font weight. See the <link
-linkend="function-pango--attrweight"><function>pango.AttrWeight</function>()</link>
-function for more detail.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_VARIANT</literal></term>
- <listitem>
- <simpara>Specifies a font variant (normal or small caps). See the
-<link
-linkend="function-pango--attrvariant"><function>pango.AttrVariant</function>()</link>
-function for more detail.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_STRETCH</literal></term>
- <listitem>
- <simpara>Specifies a font stretch. See the <link
-linkend="function-pango--attrstretch"><function>pango.AttrStretch</function>()</link>
-function for more details.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_SIZE</literal></term>
- <listitem>
- <simpara>Specifies a font size in thousandths of a point.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_FONT_DESC</literal></term>
- <listitem>
- <simpara>Specifies a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_FOREGROUND</literal></term>
- <listitem>
- <simpara>Specifies a foreground <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_BACKGROUND</literal></term>
- <listitem>
- <simpara>Specifies a background <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_UNDERLINE</literal></term>
- <listitem>
- <simpara>Specifies an underline style. See the <link
-linkend="function-pango--attrunderline"><function>pango.AttrUnderline</function>()</link>
-function for more details.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_STRIKETHROUGH</literal></term>
- <listitem>
- <simpara>If <literal>True</literal> the text is struck
-through.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_RISE</literal></term>
- <listitem>
- <simpara>Specifies the displacement of the text from the
-baseline.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_SHAPE</literal></term>
- <listitem>
- <simpara>Specifies a shape. See the <link
-linkend="function-pango--attrshape"><function>pango.AttrShape</function>()</link>
-function for more details.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_SCALE</literal></term>
- <listitem>
- <simpara>Specifies a font size scale factor.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_FALLBACK</literal></term>
- <listitem>
- <simpara>if <literal>True</literal>, fallback to other fonts is
- enabled (</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-coverage-level-constants">
- <title id="pango-coverage-level-constants-title">Pango Coverage Level Constants</title>
-
- <para></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.COVERAGE_NONE</literal></term>
- <listitem>
- <simpara>The character is not representable with the
- font.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.COVERAGE_FALLBACK</literal></term>
- <listitem>
- <simpara>The character is represented in a way that may be
- comprehensible but is not the correct graphical form. For
- instance, a Hangul character represented as a a sequence of
- Jamos, or a Latin transliteration of a Cyrillic word.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.COVERAGE_APPROXIMATE</literal></term>
- <listitem>
- <simpara>The character is represented as basically the correct
- graphical form, but with a stylistic variant inappropriate for
- the current script.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.COVERAGE_EXACT</literal></term>
- <listitem>
- <simpara>The character is represented as the correct graphical
- form.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-direction-constants">
- <title id="pango-direction-constants-title">Pango Direction Constants</title>
-
- <para>The pango Direction constants specify a direction in the Unicode
-bidirectional algorithm. Not every value in this enumeration makes sense for
-every usage of pango Direction.<!-- for example, the return value of the <link
-linkend="function-pango- -unichar-direction"><function>pango.unichar_direction</function>()</link>
-and <link
-linkend="function-pango- -find-base-direction"><function>pango.find_base_direction</function>()</link>
-functions cannot be <literal>pango.DIRECTION_WEAK_LTR</literal> or
-<literal>pango.DIRECTION_WEAK_RTL</literal>, since every character is either
-neutral or has a strong direction.--></para>
-
- <para>The <literal>pango.DIRECTION_TTB_LTR</literal>,
-<literal>pango.DIRECTION_TTB_RTL</literal> values come from an earlier
-interpretation of this enumeration as the writing direction of a block of
-text and are no longer used; See the Text module of the CSS3 spec for how
-vertical text is planned to be handled in a future version of Pango. The
-explanation of why <literal>pango.DIRECTION_TTB_LTR</literal> is treated as
-<literal>pango.DIRECTION_RTL</literal> can be found there as well.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.DIRECTION_LTR</literal></term>
- <listitem>
- <simpara>A strong left-to-right direction</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.DIRECTION_RTL</literal></term>
- <listitem>
- <simpara>A strong right-to-left direction</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.DIRECTION_TTB_LTR</literal></term>
- <listitem>
- <simpara>Deprecated value; treated the same as
- <literal>pango.DIRECTION_RTL</literal>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.DIRECTION_TTB_RTL</literal></term>
- <listitem>
- <simpara>Deprecated value; treated the same as
- <literal>pango.DIRECTION_LTR</literal></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.DIRECTION_WEAK_LTR</literal></term>
- <listitem>
- <simpara>A weak left-to-right direction</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.DIRECTION_WEAK_RTL</literal></term>
- <listitem>
- <simpara>A weak right-to-left direction</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.DIRECTION_NEUTRAL</literal></term>
- <listitem>
- <simpara>No direction specified</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-ellipsize-mode-constants">
- <title id="pango-ellipsize-mode-constants-title">Pango Ellipsize Mode Constants</title>
-
- <para>The Ellipsize Mode constants specify what sort of (if any)
-ellipsization should be applied to a line of text. In the ellipsization
-process characters are removed from the text in order to make it fit to a
-given width and replaced with an ellipsis (...).</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.ELLIPSIZE_NONE</literal></term>
- <listitem>
- <simpara> No ellipsization.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ELLIPSIZE_START</literal></term>
- <listitem>
- <simpara>Omit characters at the start of the text.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ELLIPSIZE_MIDDLE</literal></term>
- <listitem>
- <simpara> Omit characters in the middle of the text.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ELLIPSIZE_END</literal></term>
- <listitem>
- <simpara> Omit characters at the end of the text.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-font-mask-constants">
- <title id="pango-font-mask-constants-title">Pango Font Mask Flag Constants</title>
-
- <para>The Font Mask flag constants are bit-flags that correspond to
-fields in a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-that have been set.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.FONT_MASK_FAMILY</literal></term>
- <listitem>
- <simpara>the font family is specified.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.FONT_MASK_STYLE</literal></term>
- <listitem>
- <simpara>the font style is specified.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.FONT_MASK_VARIANT</literal></term>
- <listitem>
- <simpara>the font variant is specified.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.FONT_MASK_WEIGHT</literal></term>
- <listitem>
- <simpara>the font weight is specified.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.FONT_MASK_STRETCH</literal></term>
- <listitem>
- <simpara>the font stretch is specified.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.FONT_MASK_SIZE</literal></term>
- <listitem>
- <simpara>the font size is specified.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-render-part-constants">
- <title id="pango-render-part-constants-title">Pango Render Part Constants</title>
-
- <para></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.RENDER_PART</literal></term>
- <listitem>
- <simpara>The <literal>pango.RENDER_PART</literal> constants
-define different items to render for purposes such as setting
-colors. Available since PyGTK 2.8.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.RENDER_PART_FOREGROUND</literal></term>
- <listitem>
- <simpara>The text itself.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.RENDER_PART_BACKGROUND</literal></term>
- <listitem>
- <simpara>The area behind the text.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.RENDER_PART_UNDERLINE</literal></term>
- <listitem>
- <simpara>The underlined areas.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.RENDER_PART_STRIKETHROUGH</literal></term>
- <listitem>
- <simpara>The strikethrough areas.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-scale-constants">
- <title id="pango-scale-constants-title">Pango Scale Constants</title>
-
- <para></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.SCALE</literal></term>
- <listitem>
- <simpara>The <literal>pango.SCALE</literal> constant represents
- the scale between dimensions used for Pango distances and device
- units. (The definition of device units is dependent on the
- output device; it will typically be pixels for a screen, and
- points for a printer.) <literal>pango.SCALE</literal> is
- currently 1024, but this may be changed in the future. When
- setting font sizes, device units are always considered to be
- points (as in "12 point font"), rather than pixels.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_XX_SMALL</literal></term>
- <listitem>
- <simpara>The scale factor for three shrinking steps
-(1 / (1.2 * 1.2 * 1.2)).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_X_SMALL</literal></term>
- <listitem>
- <simpara>The scale factor for two shrinking steps
-(1 / (1.2 * 1.2)).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_SMALL</literal></term>
- <listitem>
- <simpara>The scale factor for one shrinking step
-(1 / 1.2).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_MEDIUM</literal></term>
- <listitem>
- <simpara>The scale factor for normal size (1.0).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_LARGE</literal></term>
- <listitem>
- <simpara>The scale factor for one magnification step
-(1.2).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_X_LARGE</literal></term>
- <listitem>
- <simpara>he scale factor for two magnification steps
-(1.2 * 1.2).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_XX_LARGE</literal></term>
- <listitem>
- <simpara>The scale factor for three magnification steps
-(1.2 * 1.2 * 1.2).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-stretch-constants">
- <title id="pango-stretch-constants-title">Pango Stretch Constants</title>
-
- <para>The Stretch constants specify the width of the font relative to
-other designs within a family.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.STRETCH_ULTRA_CONDENSED</literal></term>
- <listitem>
- <simpara>The most narrow width</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_EXTRA_CONDENSED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_CONDENSED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_SEMI_CONDENSED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_NORMAL</literal></term>
- <listitem>
- <simpara>The normal width.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_SEMI_EXPANDED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_EXPANDED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_EXTRA_EXPANDED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_ULTRA_EXPANDED</literal></term>
- <listitem>
- <simpara>The most expanded width</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-style-constants">
- <title id="pango-style-constants-title">Pango Style Constants</title>
-
- <para>The Style constants specify the various slant styles possible
-for a font.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.STYLE_NORMAL</literal></term>
- <listitem>
- <simpara>The font is upright.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STYLE_OBLIQUE</literal></term>
- <listitem>
- <simpara>The font is slanted in a roman style.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STYLE_ITALIC</literal></term>
- <listitem>
- <simpara>The font is slanted in an italic style.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-tab-constants">
- <title id="pango-tab-constants-title">Pango Tab Constants</title>
-
- <para>The Tab constants specify where a tab stop appears relative to
-the text.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.TAB_LEFT</literal></term>
- <listitem>
- <simpara>the tab stop appears to the left of the text.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-underline-constants">
- <title id="pango-underline-constants-title">Pango Underline Constants</title>
-
- <para>The Underline constants specify he type of underlining (if any)
-to be used.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.UNDERLINE_NONE</literal></term>
- <listitem>
- <simpara>No underline should be drawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.UNDERLINE_SINGLE</literal></term>
- <listitem>
- <simpara>A single underline should be drawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.UNDERLINE_DOUBLE</literal></term>
- <listitem>
- <simpara>A double underline should be drawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.UNDERLINE_LOW</literal></term>
- <listitem>
- <simpara>A single underline should be drawn at a position
-beneath the ink extents of the text being underlined. This should be used
-only for underlining single characters, such as for keyboard accelerators.
-<literal>pango.UNDERLINE_SINGLE</literal> should be used for extended
-portions of text.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-variant-constants">
- <title id="pango-variant-constants-title">Pango Variant Constants</title>
-
- <para>The Variant constants specify the capitalization variant of the
-font.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.VARIANT_NORMAL</literal></term>
- <listitem>
- <simpara>A normal font.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.VARIANT_SMALL_CAPS</literal></term>
- <listitem>
- <simpara>A font with the lower case characters replaced by
-smaller variants of the capital characters.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-weight-constants">
- <title id="pango-weight-constants-title">Pango Weight Constants</title>
-
- <para>The Weight constants specify the weight (boldness) of a
-font. This is a numerical value ranging from 100 to 900, but there are some
-predefined values:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.WEIGHT_ULTRALIGHT</literal></term>
- <listitem>
- <simpara>The ultralight weight (= 200).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_LIGHT</literal></term>
- <listitem>
- <simpara>The light weight (=300).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_NORMAL</literal></term>
- <listitem>
- <simpara>The default weight (= 400).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_BOLD</literal></term>
- <listitem>
- <simpara>The bold weight (= 700).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_ULTRABOLD</literal></term>
- <listitem>
- <simpara>The ultrabold weight (= 800).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_HEAVY</literal></term>
- <listitem>
- <simpara>The heavy weight (= 900).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- <refsect2 id="pango-wrap-mode-constants">
- <title id="pango-wrap-mode-constants-title">Pango Wrap Mode Constants</title>
-
- <para>The Wrap Mode constants specify how to wrap the lines of a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> to
-the desired width.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.WRAP_WORD</literal></term>
- <listitem>
- <simpara>wrap lines at word boundaries.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WRAP_CHAR</literal></term>
- <listitem>
- <simpara>wrap lines at character boundaries.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WRAP_WORD_CHAR</literal></term>
- <listitem>
- <simpara>wrap lines at word boundaries, but fall back to
- character boundaries if there is not enough space for a full
- word.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pango-functions.xml b/docs/reference/pygtk-pango-functions.xml
deleted file mode 100644
index 4d8c340c..00000000
--- a/docs/reference/pygtk-pango-functions.xml
+++ /dev/null
@@ -1,248 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="pango-functions">
- <refnamediv>
- <refname>pango Functions</refname>
- <refpurpose>a list of all the pango functions</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <refsect2>
- <title><link linkend="class-pangoattribute"><classname>pango.Attribute</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attr-type-register">pango.attr_type_register</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrlanguage">pango.AttrLanguage</link></methodname>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrfamily">pango.AttrFamily</link></methodname>
- <methodparam><parameter
- role="keyword">family</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrforeground">pango.AttrForeground</link></methodname>
- <methodparam><parameter role="keyword">red</parameter></methodparam>
- <methodparam><parameter
- role="keyword">green</parameter></methodparam>
- <methodparam><parameter
- role="keyword">blue</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrbackground">pango.AttrBackground</link></methodname>
- <methodparam><parameter role="keyword">red</parameter></methodparam>
- <methodparam><parameter
- role="keyword">green</parameter></methodparam>
- <methodparam><parameter
- role="keyword">blue</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrsize">pango.AttrSize</link></methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrstyle">pango.AttrStyle</link></methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrweight">pango.AttrWeight</link></methodname>
- <methodparam><parameter
- role="keyword">weight</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrvariant">pango.AttrVariant</link></methodname>
- <methodparam><parameter
- role="keyword">variant</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrstretch">pango.AttrStretch</link></methodname>
- <methodparam><parameter
- role="keyword">stretch</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrfontdesc">pango.AttrFontDesc</link></methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrunderline">pango.AttrUnderline</link></methodname>
- <methodparam><parameter
- role="keyword">underline</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrstrikethrough">pango.AttrStrikethrough</link></methodname>
- <methodparam><parameter
- role="keyword">strikethrough</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrrise">pango.AttrRise</link></methodname>
- <methodparam><parameter
- role="keyword">rise</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrshape">pango.AttrShape</link></methodname>
- <methodparam><parameter
- role="keyword">ink_rect</parameter></methodparam>
- <methodparam><parameter
- role="keyword">logical_rect</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrscale">pango.AttrScale</link></methodname>
- <methodparam><parameter
- role="keyword">scale</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrfallback">pango.AttrFallback</link></methodname>
- <methodparam><parameter
- role="keyword">fallback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--parse-markup">pango.parse_markup</link></methodname>
- <methodparam><parameter
- role="keyword">markup_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_marker</parameter><initializer>u'\x00'</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- <refsect2>
- <title><link linkend="class-pangofont"><classname>pango.Font</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-pango--PIXELS">pango.PIXELS</link></methodname>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-pango--ASCENT">pango.ASCENT</link></methodname>
- <methodparam><parameter role="keyword">rect</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-pango--DESCENT">pango.DESCENT</link></methodname>
- <methodparam><parameter role="keyword">rect</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-pango--RBEARING">pango.RBEARING</link></methodname>
- <methodparam><parameter role="keyword">rect</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-pango--LBEARING">pango.LBEARING</link></methodname>
- <methodparam><parameter role="keyword">rect</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pango-markup.xml b/docs/reference/pygtk-pango-markup.xml
deleted file mode 100644
index b7ef3c4f..00000000
--- a/docs/reference/pygtk-pango-markup.xml
+++ /dev/null
@@ -1,215 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="pango-markup-language">
- <refnamediv>
- <refname>The Pango Markup Language</refname>
- <refpurpose>a simple markup language for encoding attributes with text.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Description</title>
-
- <para>The pango markup language is a very simple SGML-like language that
-allows you specify attributes with the text they are applied to by using a
-small set of markup tags. A simple example of a string using markup
-is:</para>
-
- <literal>&lt;span foreground="blue" size="100"&gt;Blue text&lt;/span&gt; is &lt;i&gt;cool&lt;/i&gt;!</literal>
-
- <para>Using the pango markup language to markup text and parsing the
-result with the <link
-linkend="function-pango--parse-markup"><function>pango.parse_markup</function>()</link>
-function is a convenient way to generate the <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-and plain text that can be used in a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>.</para>
-
- <para>The root tag of a marked-up document is
-<literal>&lt;markup&gt;</literal>, but the <link
-linkend="function-pango--parse-markup"><function>pango.parse_markup</function>()</link>
-function allows you to omit this tag, so you will most likely never need to
-use it. The most general markup tag is <literal>&lt;span&gt;</literal>. The
-<literal>&lt;span&gt;</literal> tag has the following attributes:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>font_desc</literal></term>
- <listitem>
- <simpara>A font description string, such as "Sans Italic 12";
-note that any other span attributes will override this description. So if
-you have "Sans Italic" and also a style="normal" attribute, you will get
-Sans normal, not italic.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>font_family</literal></term>
- <listitem>
- <simpara>A font family name such as "normal", "sans", "serif" or
-"monospace".</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>face</literal></term>
- <listitem>
- <simpara>A synonym for font_family</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>size</literal></term>
- <listitem>
- <simpara>The font size in thousandths of a point, or one of the
-absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large',
-'xx-large', or one of the relative sizes 'smaller' or 'larger'.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>style</literal></term>
- <listitem>
- <simpara>The slant style - one of 'normal', 'oblique', or
-'italic'</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>weight</literal></term>
- <listitem>
- <simpara>The font weight - one of 'ultralight', 'light',
-'normal', 'bold', 'ultrabold', 'heavy', or a numeric weight.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>variant</literal></term>
- <listitem>
- <simpara>The font variant - either 'normal' or
-'smallcaps'.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>stretch</literal></term>
- <listitem>
- <simpara>The font width - one of 'ultracondensed',
-'extracondensed', 'condensed', 'semicondensed', 'normal', 'semiexpanded',
-'expanded', 'extraexpanded', 'ultraexpanded'.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>foreground</literal></term>
- <listitem>
- <simpara>An RGB color specification such as '#00FF00' or a color
-name such as 'red'.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>background</literal></term>
- <listitem>
- <simpara>An RGB color specification such as '#00FF00' or a color
-name such as 'red'.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>underline</literal></term>
- <listitem>
- <simpara>The underline style - one of 'single', 'double', 'low',
-or 'none'.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>rise</literal></term>
- <listitem>
- <simpara>The vertical displacement from the baseline, in ten
-thousandths of an em. Can be negative for subscript, positive for
-superscript.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>strikethrough</literal></term>
- <listitem>
- <simpara>'true' or 'false' whether to strike through the
-text.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>fallback</literal></term>
- <listitem>
- <simpara>If <literal>True</literal> enable fallback to other fonts
-of characters are missing from the current font. If disabled, then
-characters will only be used from the closest matching font on the
-system. No fallback will be done to other fonts on the system that might
-contain the characters in the text. Fallback is enabled by default. Most
-applications should not disable fallback.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>lang</literal></term>
- <listitem>
- <simpara>A language code, indicating the text
-language.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>There are a number of convenience tags that encapsulate specific
-span options:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>b</literal></term>
- <listitem>
- <simpara>Make the text bold.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>big</literal></term>
- <listitem>
- <simpara>Makes font relatively larger, equivalent to &lt;span
-size="larger"&gt;.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>i</literal></term>
- <listitem>
- <simpara>Make the text italic.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>s</literal></term>
- <listitem>
- <simpara>Strikethrough the text.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>sub</literal></term>
- <listitem>
- <simpara>Subscript the text.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>sup</literal></term>
- <listitem>
- <simpara>Superscript the text.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>small</literal></term>
- <listitem>
- <simpara>Makes font relatively smaller, equivalent to &lt;span
-size="smaller"&gt;.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>tt</literal></term>
- <listitem>
- <simpara>Use a monospace font.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>u</literal></term>
- <listitem>
- <simpara>Underline the text.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangoattribute.xml b/docs/reference/pygtk-pangoattribute.xml
deleted file mode 100644
index f99edb50..00000000
--- a/docs/reference/pygtk-pangoattribute.xml
+++ /dev/null
@@ -1,1797 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangoattribute">
- <refnamediv>
- <refname>pango.Attribute</refname>
- <refpurpose>an attribute that applies to a section of text</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.Attribute</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattribute--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
-
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attr-type-register">pango.attr_type_register</link></methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrlanguage">pango.AttrLanguage</link></methodname>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrfamily">pango.AttrFamily</link></methodname>
- <methodparam><parameter
- role="keyword">family</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrforeground">pango.AttrForeground</link></methodname>
- <methodparam><parameter role="keyword">red</parameter></methodparam>
- <methodparam><parameter
- role="keyword">green</parameter></methodparam>
- <methodparam><parameter
- role="keyword">blue</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrbackground">pango.AttrBackground</link></methodname>
- <methodparam><parameter role="keyword">red</parameter></methodparam>
- <methodparam><parameter
- role="keyword">green</parameter></methodparam>
- <methodparam><parameter
- role="keyword">blue</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrsize">pango.AttrSize</link></methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrstyle">pango.AttrStyle</link></methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrweight">pango.AttrWeight</link></methodname>
- <methodparam><parameter
- role="keyword">weight</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrvariant">pango.AttrVariant</link></methodname>
- <methodparam><parameter
- role="keyword">variant</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrstretch">pango.AttrStretch</link></methodname>
- <methodparam><parameter
- role="keyword">stretch</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrfontdesc">pango.AttrFontDesc</link></methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrunderline">pango.AttrUnderline</link></methodname>
- <methodparam><parameter
- role="keyword">underline</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrstrikethrough">pango.AttrStrikethrough</link></methodname>
- <methodparam><parameter
- role="keyword">strikethrough</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrrise">pango.AttrRise</link></methodname>
- <methodparam><parameter
- role="keyword">rise</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrshape">pango.AttrShape</link></methodname>
- <methodparam><parameter
- role="keyword">ink_rect</parameter></methodparam>
- <methodparam><parameter
- role="keyword">logical_rect</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrscale">pango.AttrScale</link></methodname>
- <methodparam><parameter
- role="keyword">scale</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrfallback">pango.AttrFallback</link></methodname>
- <methodparam><parameter
- role="keyword">fallback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrsize">pango.AttrSizeAbsolute</link></methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrforeground">pango.AttrUnderlineColor</link></methodname>
- <methodparam><parameter role="keyword">red</parameter></methodparam>
- <methodparam><parameter
- role="keyword">green</parameter></methodparam>
- <methodparam><parameter
- role="keyword">blue</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrforeground">pango.AttrStrikethroughColor</link></methodname>
- <methodparam><parameter role="keyword">red</parameter></methodparam>
- <methodparam><parameter
- role="keyword">green</parameter></methodparam>
- <methodparam><parameter
- role="keyword">blue</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--attrsize">pango.AttrLetterSpacing</link></methodname>
- <methodparam><parameter
- role="keyword">letter_spacing</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <para>All <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-objects support the following three attributes.</para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"end_index"</entry>
- <entry>Read-Write</entry>
- <entry>The index of the end of the application of the
-attribute in the associated text.</entry>
- </row>
-
- <row valign="top">
- <entry>"start_index"</entry>
- <entry>Read-Write</entry>
- <entry>The index of the start of the application of the
-attribute in the associated text.</entry>
- </row>
-
- <row valign="top">
- <entry>"type"</entry>
- <entry>Read</entry>
- <entry>The attribute type.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- <para>In addition each <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-type supports one or more additional attributes that are specific to the
-type:</para>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="1in"/>
- <colspec column="4" colwidth="3in"/>
- <tbody>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read&nbsp;&nbsp;&nbsp;</entry>
- <entry><literal>ATTR_LANGUAGE</literal></entry>
- <entry>The <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_FAMILY</literal></entry>
- <entry>The string containing the font family name list (e.g.
-"normal,sans,serif,monospace")</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_STYLE</literal></entry>
- <entry>The font slant style. See the <link
-linkend="function-pango--attrstyle"><function>pango.AttrStyle</function>()</link>
-function for more details.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_WEIGHT</literal></entry>
- <entry>The font weight. See the <link
-linkend="function-pango--attrweight"><function>pango.AttrWeight</function>()</link>
-function for more detail.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_VARIANT</literal></entry>
- <entry>The font variant. See the <link
-linkend="function-pango--attrvariant"><function>pango.AttrVariant</function>()</link>
-function for more detail.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_STRETCH</literal></entry>
- <entry>The font stretch. See the <link
-linkend="function-pango--attrstretch"><function>pango.AttrStretch</function>()</link>
-function for more details.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_SIZE</literal></entry>
- <entry>The font size in thousandths of a point.</entry>
- </row>
-
- <row valign="top">
- <entry>"desc"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_FONT_DESC</literal></entry>
- <entry>The <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-object.</entry>
- </row>
-
- <row valign="top">
- <entry>"color"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_FOREGROUND</literal></entry>
- <entry>The foreground <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link>
-object.</entry>
- </row>
-
- <row valign="top">
- <entry>"color"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_BACKGROUND</literal></entry>
- <entry>The background <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link>
-object.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_UNDERLINE</literal></entry>
- <entry>The underline style. See the <link
-linkend="function-pango--attrunderline"><function>pango.AttrUnderline</function>()</link>
-function for more details.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_STRIKETHROUGH</literal></entry>
- <entry><literal>True</literal> if the text is struck
-through.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_RISE</literal></entry>
- <entry>The displacement of the text from the baseline.</entry>
- </row>
-
- <row valign="top">
- <entry>"ink_rect"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_SHAPE</literal></entry>
- <entry>The 4-tuple specifying the ink rectangle. See the <link
-linkend="function-pango--attrshape"><function>pango.AttrShape</function>()</link>
-function for more details.</entry>
- </row>
-
- <row valign="top">
- <entry>"logical_rect"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_SHAPE</literal></entry>
- <entry>The 4-tuple specifying the logical rectangle. See the
-<link
-linkend="function-pango--attrshape"><function>pango.AttrShape</function>()</link>
-function for more details.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_SCALE</literal></entry>
- <entry>The font size scale factor as a float.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry> <entry>Read</entry>
- <entry><literal>ATTR_FALLBACK</literal></entry>
- <entry><literal>True</literal> if font fallback is
- enabled.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_LETTER_SPACING</literal></entry>
- <entry>The extra space between graphemes.</entry>
- </row>
-
- <row valign="top">
- <entry>"color"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_UNDERLINE_COLOR</literal></entry>
- <entry>The <link
- linkend="class-pangocolor"><classname>pango.Color</classname></link>
- object used for the color of the underline.</entry>
- </row>
-
- <row valign="top">
- <entry>"color"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_STRIKETHROUGH_COLOR</literal></entry>
- <entry>The <link
- linkend="class-pangocolor"><classname>pango.Color</classname></link>
- object used for the color of the strikethrough.</entry>
- </row>
-
- <row valign="top">
- <entry>"value"</entry>
- <entry>Read</entry>
- <entry><literal>ATTR_ABSOLUTE_SIZE</literal></entry>
- <entry>The font size in device units.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object contains an attribute that applies to a section of text. The
-predefined attribute types are:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.ATTR_LANGUAGE</literal></term>
- <listitem>
- <simpara>Specifies a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_FAMILY</literal></term>
- <listitem>
- <simpara>Specifies a font family name list as a string.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_STYLE</literal></term>
- <listitem>
- <simpara>Specifies a font slant style. See the <link
-linkend="function-pango--attrstyle"><function>pango.AttrStyle</function>()</link>
-function for more details.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_WEIGHT</literal></term>
- <listitem>
- <simpara>Specifies a font weight. See the <link
-linkend="function-pango--attrweight"><function>pango.AttrWeight</function>()</link>
-function for more detail.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_VARIANT</literal></term>
- <listitem>
- <simpara>Specifies a font variant (normal or small caps). See the
-<link
-linkend="function-pango--attrvariant"><function>pango.AttrVariant</function>()</link>
-function for more detail.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_STRETCH</literal></term>
- <listitem>
- <simpara>Specifies a font stretch. See the <link
-linkend="function-pango--attrstretch"><function>pango.AttrStretch</function>()</link>
-function for more details.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_SIZE</literal></term>
- <listitem>
- <simpara>Specifies a font size in thousandths of a point.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_FONT_DESC</literal></term>
- <listitem>
- <simpara>Specifies a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_FOREGROUND</literal></term>
- <listitem>
- <simpara>Specifies a foreground <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_BACKGROUND</literal></term>
- <listitem>
- <simpara>Specifies a background <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link>.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_UNDERLINE</literal></term>
- <listitem>
- <simpara>Specifies an underline style. See the <link
-linkend="function-pango--attrunderline"><function>pango.AttrUnderline</function>()</link>
-function for more details.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_STRIKETHROUGH</literal></term>
- <listitem>
- <simpara>If <literal>True</literal> the text is struck
-through.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_RISE</literal></term>
- <listitem>
- <simpara>Specifies the displacement of the text from the
-baseline.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_SHAPE</literal></term>
- <listitem>
- <simpara>Specifies a shape. See the <link
-linkend="function-pango--attrshape"><function>pango.AttrShape</function>()</link>
-function for more details.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_SCALE</literal></term>
- <listitem>
- <simpara>Specifies a font size scale factor.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_FALLBACK</literal></term>
- <listitem>
- <simpara>if <literal>True</literal>, fallback to other fonts is
- enabled.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_LETTER_SPACING</literal></term>
- <listitem>
- <simpara>Specifies the extra space between graphemes.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_UNDERLINE_COLOR</literal></term>
- <listitem>
- <simpara>Specifies the color of the underline.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_STRIKETHROUGH_COLOR</literal></term>
- <listitem>
- <simpara>Specifies the color of the strikethrough.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ATTR_ABSOLUTE_SIZE</literal></term>
- <listitem>
- <simpara>Specifies the font size in device units.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>Additional attribute types can be registered with the <link
-linkend="function-pango--attr-type-register"><function>pango.attr_type_register</function>()</link>
-function.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangoattribute--copy">
- <title>pango.Attribute.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object that is a copy of this attribute.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-pango--attr-type-register">
- <title>pango.attr_type_register</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.attr_type_register</methodname>
- <methodparam><parameter
- role="keyword">name</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">name</parameter>&nbsp;:</term>
- <listitem><simpara>a name for the type. (Currently not
-used.)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the new attribute type ID
-integer.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>attr_type_register</function>() function returns a
-new attribute type ID integer value.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrlanguage">
- <title>pango.AttrLanguage</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrLanguage</methodname>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">language</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrLanguage</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_LANGUAGE</literal> with the <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-specified by <parameter>language</parameter> and the text range specified by
-<parameter>start_index</parameter> and
-<parameter>end_index</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrfamily">
- <title>pango.AttrFamily</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrFamily</methodname>
- <methodparam><parameter
- role="keyword">family</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">family</parameter>&nbsp;:</term>
- <listitem><simpara>the string containing a font family name
-list.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrFamily</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_FAMILY</literal> with the font family
-name list specified by the string <parameter>family</parameter> and the text
-range specified by <parameter>start_index</parameter> and
-<parameter>end_index</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrforeground">
- <title>pango.AttrForeground</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrForeground</methodname>
- <methodparam><parameter
- role="keyword">red</parameter></methodparam>
- <methodparam><parameter
- role="keyword">green</parameter></methodparam>
- <methodparam><parameter
- role="keyword">blue</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">red</parameter>&nbsp;:</term>
- <listitem><simpara>the red component of the color in the range 0
-to 65535.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">green</parameter>&nbsp;:</term>
- <listitem><simpara>the green component of the color in the range 0
-to 65535.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">blue</parameter>&nbsp;:</term>
- <listitem><simpara>the blue component of the color in the range 0
-to 65535.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrForeground</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-of the type <literal>pango.ATTR_FOREGROUND</literal> with the RGB color
-specified by <parameter>red</parameter>, <parameter>green</parameter> and
-<parameter>blue</parameter> and the text range specified by
-<parameter>start_index</parameter> and
-<parameter>end_index</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrbackground">
- <title>pango.AttrBackground</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrBackground</methodname>
- <methodparam><parameter
- role="keyword">red</parameter></methodparam>
- <methodparam><parameter
- role="keyword">green</parameter></methodparam>
- <methodparam><parameter
- role="keyword">blue</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">red</parameter>&nbsp;:</term>
- <listitem><simpara>the red component of the color in the range 0
-to 65535.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">green</parameter>&nbsp;:</term>
- <listitem><simpara>the green component of the color in the range 0
-to 65535.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">blue</parameter>&nbsp;:</term>
- <listitem><simpara>the blue component of the color in the range 0
-to 65535.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrBackground</function>() function creates a new
-pangoAttribute of the type <literal>pango.ATTR_BACKGROUND</literal> with the
-RGB color specified by <parameter>red</parameter>,
-<parameter>green</parameter> and <parameter>blue</parameter> and the text
-range specified by <parameter>start_index</parameter> and
-<parameter>end_index</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrsize">
- <title>pango.AttrSize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrSize</methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the font size in thousandths of a
-point.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrSize</function>() function creates a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_SIZE</literal> with the font size
-specified by <parameter>size</parameter> and the text range specified by
-<parameter>start_index</parameter> and
-<parameter>end_index</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrstyle">
- <title>pango.AttrStyle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrStyle</methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">style</parameter>&nbsp;:</term>
- <listitem><simpara>the font slant style.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrStyle</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_STYLE</literal> with the font slant
-style specified by <parameter>style</parameter> and the text range specified
-by <parameter>start_index</parameter> and <parameter>end_index</parameter>.
-The value of <parameter>style</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.STYLE_NORMAL</literal></term>
- <listitem>
- <simpara>The font is upright.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STYLE_OBLIQUE</literal></term>
- <listitem>
- <simpara>The font is slanted in a roman style.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STYLE_ITALIC</literal></term>
- <listitem>
- <simpara>The font is slanted in an italic style.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrweight">
- <title>pango.AttrWeight</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrWeight</methodname>
- <methodparam><parameter
- role="keyword">weight</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">weight</parameter>&nbsp;:</term>
- <listitem><simpara>the font weight.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrWeight</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_WEIGHT</literal> with the font weight
-specified by <parameter>weight</parameter> and the text range specified by
-<parameter>start_index</parameter> and <parameter>end_index</parameter>. The
-value of <parameter>style</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.WEIGHT_ULTRALIGHT</literal></term>
- <listitem>
- <simpara>The ultralight weight (= 200).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_LIGHT</literal></term>
- <listitem>
- <simpara>The light weight (=300).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_NORMAL</literal></term>
- <listitem>
- <simpara>The default weight (= 400).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_BOLD</literal></term>
- <listitem>
- <simpara>The bold weight (= 700).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_ULTRABOLD</literal></term>
- <listitem>
- <simpara>The ultrabold weight (= 800).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_HEAVY</literal></term>
- <listitem>
- <simpara>The heavy weight (= 900).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrvariant">
- <title>pango.AttrVariant</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrVariant</methodname>
- <methodparam><parameter
- role="keyword">variant</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">variant</parameter>&nbsp;:</term>
- <listitem><simpara>the font variant.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrVariant</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_VARIANT</literal> with the font
-variant specified by <parameter>variant</parameter> and the text range
-specified by <parameter>start_index</parameter> and
-<parameter>end_index</parameter>. The value of
-<parameter>variant</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.VARIANT_NORMAL</literal></term>
- <listitem>
- <simpara>A normal font.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.VARIANT_SMALL_CAPS</literal></term>
- <listitem>
- <simpara>A font with the lower case characters replaced by
-smaller variants of the capital characters.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrstretch">
- <title>pango.AttrStretch</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrStretch</methodname>
- <methodparam><parameter
- role="keyword">stretch</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stretch</parameter>&nbsp;:</term>
- <listitem><simpara>the font stretch style.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrStretch</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_STRETCH</literal> with the font
-stretch style specified by <parameter>stretch</parameter> and the text range
-specified by <parameter>start_index</parameter> and
-<parameter>end_index</parameter>. The value of
-<parameter>stretch</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.STRETCH_ULTRA_CONDENSED</literal></term>
- <listitem>
- <simpara>The most narrow width</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_EXTRA_CONDENSED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_CONDENSED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_SEMI_CONDENSED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_NORMAL</literal></term>
- <listitem>
- <simpara>The normal width.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_SEMI_EXPANDED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_EXPANDED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_EXTRA_EXPANDED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_ULTRA_EXPANDED</literal></term>
- <listitem>
- <simpara>The most expanded width</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrfontdesc">
- <title>pango.AttrFontDesc</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrFontDesc</methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">desc</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrFontDesc</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_FONT_DESC</literal> with the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-specified by <parameter>desc</parameter> and the text range specified by
-<parameter>start_index</parameter> and
-<parameter>end_index</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrunderline">
- <title>pango.AttrUnderline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrUnderline</methodname>
- <methodparam><parameter
- role="keyword">underline</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">underline</parameter>&nbsp;:</term>
- <listitem><simpara>the underline style.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrUnderline</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_UNDERLINE</literal> with the
-underline style specified by <parameter>underline</parameter> and the text
-range specified by <parameter>start_index</parameter> and
-<parameter>end_index</parameter>. The value of
-<parameter>underline</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.UNDERLINE_NONE</literal></term>
- <listitem>
- <simpara>No underline should be drawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.UNDERLINE_SINGLE</literal></term>
- <listitem>
- <simpara>A single underline should be drawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.UNDERLINE_DOUBLE</literal></term>
- <listitem>
- <simpara>A double underline should be drawn.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.UNDERLINE_LOW</literal></term>
- <listitem>
- <simpara>A single underline should be drawn at a position
-beneath the ink extents of the text being underlined. This should be used
-only for underlining single characters, such as for keyboard accelerators.
-<literal>pango.UNDERLINE_SINGLE</literal> should be used for extended
-portions of text.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrstrikethrough">
- <title>pango.AttrStrikethrough</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrStrikethrough</methodname>
- <methodparam><parameter
- role="keyword">strikethrough</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">strikethrough</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the text should be
-struck through.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrStrikethrough</function>() function creates a
-new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_STRIKETHROUGH</literal> with the
-value specified by <parameter>strikethrough</parameter> and the text range
-specified by <parameter>start_index</parameter> and
-<parameter>end_index</parameter>. If strikethough is <literal>True</literal>
-the text should be struck through.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrrise">
- <title>pango.AttrRise</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrRise</methodname>
- <methodparam><parameter
- role="keyword">rise</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rise</parameter>&nbsp;:</term>
- <listitem><simpara>the displacement of the text from the
-baseline.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrRise</function>() function creates a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_RISE</literal> with the text
-displacement from the baseline specified by <parameter>rise</parameter> and
-the text range specified by <parameter>start_index</parameter> and
-<parameter>end_index</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrshape">
- <title>pango.AttrShape</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrShape</methodname>
- <methodparam><parameter
- role="keyword">ink_rect</parameter></methodparam>
- <methodparam><parameter
- role="keyword">logical_rect</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">ink_rect</parameter>&nbsp;:</term>
- <listitem><simpara>the ink rectangle of the
-shape.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">logical_rect</parameter>&nbsp;:</term>
- <listitem><simpara>the logical rectangle of the
-shape.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrShape</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_SHAPE</literal> with the shape
-rectangles specified by <parameter>ink_rect</parameter> and
-<parameter>logical_rect</parameter> and the text range specified by
-<parameter>start_index</parameter> and <parameter>end_index</parameter>. A
-shape is used to impose a particular ink and logical rect on the result of
-shaping a particular glyph. This might be used, for instance, for embedding
-a picture or a widget inside a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrscale">
- <title>pango.AttrScale</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrScale</methodname>
- <methodparam><parameter
- role="keyword">scale</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">scale</parameter>&nbsp;:</term>
- <listitem><simpara>the font size scale factor as a
-float.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>AttrScale</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_SCALE</literal> with the font size
-scale factor specified by <parameter>scale</parameter> and the text range
-specified by <parameter>start_index</parameter> and
-<parameter>end_index</parameter>. The value of <parameter>scale</parameter>
-can also be one of the following pre-defined values:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.SCALE_XX_SMALL</literal></term>
- <listitem>
- <simpara>0.5787037037037 - the scale factor for three shrinking
-steps (1 / (1.2 * 1.2 * 1.2)).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_X_SMALL</literal></term>
- <listitem>
- <simpara>0.6444444444444 - the scale factor for two shrinking
-steps (1 / (1.2 * 1.2)).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_SMALL</literal></term>
- <listitem>
- <simpara>0.8333333333333 - the scale factor for one shrinking
-step (1 / 1.2).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_MEDIUM</literal></term>
- <listitem>
- <simpara>1.0 - The scale factor for normal size.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_LARGE</literal></term>
- <listitem>
- <simpara>1.2 - the scale factor for one magnification
-step.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_X_LARGE</literal></term>
- <listitem>
- <simpara>1.4399999999999 - the scale factor for two
-magnification steps (1.2 * 1.2).</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.SCALE_XX_LARGE</literal></term>
- <listitem>
- <simpara>1.728 - the scale factor for three magnification steps
-(1.2 * 1.2 * 1.2).</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="function-pango--attrfallback">
- <title>pango.AttrFallback</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.AttrFallback</methodname>
- <methodparam><parameter
- role="keyword">fallback</parameter></methodparam>
- <methodparam><parameter
- role="keyword">start_index</parameter>
- <initializer>0</initializer></methodparam>
- <methodparam><parameter
- role="keyword">end_index</parameter>
- <initializer>1</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">fallback</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, we should fall back
- on other fonts for characters the active font is
- missing.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">start_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the start of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">end_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of the end of the attribute
-application in the text.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <function>AttrFallback</function>() function creates a new
-<link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-object of the type <literal>pango.ATTR_FALLBACK</literal>. If fallback is
-<literal>True</literal> other fonts on the system can be used to provide
-characters missing from the current font. Otherwise, only characters from
-the closest matching font can be used.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangoattriter.xml b/docs/reference/pygtk-pangoattriter.xml
deleted file mode 100644
index e82b51e5..00000000
--- a/docs/reference/pygtk-pangoattriter.xml
+++ /dev/null
@@ -1,250 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangoattriterator">
- <refnamediv>
- <refname>pango.AttrIterator</refname>
- <refpurpose>an object pointing to a location in a <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.AttrIterator</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattriterator--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattriterator--range">range</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattriterator--next">next</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattriterator--get">get</link></methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattriterator--get-font">get_font</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattriterator--get-attrs">get_attrs</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-pangoattriterator"><classname>pango.AttrIterator</classname></link>
-object contains a pointer into a <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>.
-A <link
-linkend="class-pangoattriterator"><classname>pango.AttrIterator</classname></link>
-object is created using the <link
-linkend="method-pangoattrlist--get-iterator"><methodname>pango.AttrList.get_iterator</methodname>()</link>
-method and then can be advanced through the attribute changes in the text
-using the <link
-linkend="method-pangoattriterator--next"><methodname>next</methodname>()</link>
-method. The <link
-linkend="class-pangoattriterator"><classname>pango.AttrIterator</classname></link>
-object can access information about the current attributes applied at the
-iterator location (using the <link
-linkend="method-pangoattriterator--get"><methodname>get</methodname>()</link>
-method) and the range of text that the current attribute change applies to
-(using the <link
-linkend="method-pangoattriterator--range"><methodname>range</methodname>()</link>
-method).</para>
-
- <para>The <link
-linkend="class-pangoattriterator"><classname>pango.AttrIterator</classname></link>
-object is only valid as long as the associated <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-is not changed.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangoattriterator--copy">
- <title>pango.AttrIterator.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattriterator"><classname>pango.AttrIterator</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns a new <link
-linkend="class-pangoattriterator"><classname>pango.AttrIterator</classname></link>
-object that is a copy of this attribute iterator.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoattriterator--range">
- <title>pango.AttrIterator.range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>range</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the start and end index of
-the current attribute in the text.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>range</methodname>() method returns a 2-tuple
-containing the start and end index of the application of the current
-attribute change in the text.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoattriterator--next">
- <title>pango.AttrIterator.next</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>next</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>False</literal> if the iterator is at
-the end of the <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>next</methodname>() method advances the iterator
-to the next attribute change in its <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>.
-The <methodname>next</methodname> method returns <literal>False</literal> if
-the iterator is at the end of the <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>;
-otherwise, <literal>True</literal>. </para>
-
- </refsect2>
-
- <refsect2 id="method-pangoattriterator--get">
- <title>pango.AttrIterator.get</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get</methodname>
- <methodparam><parameter
- role="keyword">type</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">type</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-type to find.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-matching type or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get</methodname>() method returns the <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-at the iterator location that matches the specified
-<parameter>type</parameter>. When multiple attributes of the same type
-overlap, the attribute whose range starts closest to the current location is
-returned. If no attribute matches, <literal>None</literal> is
-returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoattriterator--get-font">
- <title>pango.AttrIterator.get_font</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_font</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple containing a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>,
-a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-and a list of non-font <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-objects at the current iterator location.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_font</methodname>() method returns a 3-tuple
-containing a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-holding the current font attributes, a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-object (if a language is set) or <literal>None</literal> and a list of
-non-font <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-objects in effect at the current iterator location.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoattriterator--get-attrs">
- <title>pango.AttrIterator.get_attrs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_attrs</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing the <link
- linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
- objects in effect at the current iterator
- location.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_attrs</methodname>() method returns a tuple
-containing the <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-objects in effect at the current iterator location.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangoattrlist.xml b/docs/reference/pygtk-pangoattrlist.xml
deleted file mode 100644
index b881e399..00000000
--- a/docs/reference/pygtk-pangoattrlist.xml
+++ /dev/null
@@ -1,399 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangoattrlist">
- <refnamediv>
- <refname>pango.AttrList</refname>
- <refpurpose>an object holding attributes that apply to a section of
-text</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.AttrList</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-pangoattrlist">pango.AttrList</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattrlist--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattrlist--insert">insert</link></methodname>
- <methodparam><parameter
- role="keyword">attr</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattrlist--insert-before">insert_before</link></methodname>
- <methodparam><parameter
- role="keyword">attr</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattrlist--change">change</link></methodname>
- <methodparam><parameter
- role="keyword">attr</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattrlist--splice">splice</link></methodname>
- <methodparam><parameter
- role="keyword">other</parameter></methodparam>
- <methodparam><parameter role="keyword">pos</parameter></methodparam>
- <methodparam><parameter role="keyword">len</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattrlist--get-iterator">get_iterator</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoattrlist--filter">filter</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
-
- </classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link
-linkend="function-pango--parse-markup">pango.parse_markup</link></methodname>
- <methodparam><parameter
- role="keyword">markup_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_marker</parameter><initializer>u'\x00'</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-object contains a list of attributes that apply to a section of text. The
-attributes are, in general, allowed to overlap in an arbitrary fashion,
-however, if the attributes are manipulated only through the <link
-linkend="method-pangoattrlist--change"><methodname>change</methodname>()</link>
-method, the overlap between properties will meet stricter criteria. Since
-the <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-object is stored as a linear list, it is not suitable for storing attributes
-for large amounts of text. In general, you should not use a single <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-for more than one paragraph of text.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-pangoattrlist">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>pango.AttrList</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangoattrlist--copy">
- <title>pango.AttrList.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns
-a new <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-object that is a copy of the attribute list </para>
-
- </refsect2>
-
- <refsect2 id="method-pangoattrlist--insert">
- <title>pango.AttrList.insert</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert</methodname>
- <methodparam><parameter role="keyword">attr</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">attr</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-to insert.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert</methodname>() method
-inserts the <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-specified by <parameter>attr</parameter> into the attribute list. It will be
-inserted after all other attributes with a matching "start_index".</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoattrlist--insert-before">
- <title>pango.AttrList.insert_before</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>insert_before</methodname>
- <methodparam><parameter role="keyword">attr</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">attr</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-to insert.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>insert_before</methodname>()
-method inserts the <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-specified by attr into the attribute list. It will be inserted before all
-other attributes with a matching "start_index".</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoattrlist--change">
- <title>pango.AttrList.change</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>change</methodname>
- <methodparam><parameter role="keyword">attr</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">attr</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-to insert.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>change</methodname>() method
-inserts the <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-specified by <parameter>attr</parameter> into the attribute list. It will
-replace any attributes of the same type on that segment and be merged with
-any adjoining attributes that are identical. This method is slower than the
-<link
-linkend="method-pangoattrlist--insert"><function>insert()</function></link>
-method for creating an attribute list in order (potentially much slower for
-large lists). However, the <link
-linkend="method-pangoattrlist--insert"><function>insert()</function></link>
-method is not suitable for continually changing a set of attributes since it
-never removes or combines existing attributes.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoattrlist--splice">
- <title>pango.AttrList.splice</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>splice</methodname>
- <methodparam><parameter role="keyword">other</parameter></methodparam>
- <methodparam><parameter role="keyword">pos</parameter></methodparam>
- <methodparam><parameter role="keyword">len</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">other</parameter>&nbsp;:</term>
- <listitem><simpara>another <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">pos</parameter>&nbsp;:</term>
- <listitem><simpara>the position in this attribute list to insert
-<parameter>other</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">len</parameter>&nbsp;:</term>
- <listitem><simpara>the length of the spliced segment. (Note that
-this must be specified since the attributes in <parameter>other</parameter>
-may only be present at some subsection of this range)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>splice</methodname>() method
-splices the <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-specified by <parameter>other</parameter> into this attribute list. This
-method stretches each attribute with a range including the position
-specified by <parameter>pos</parameter> in the list by the amount specified
-by <parameter>len</parameter>, and then calls the <link
-linkend="method-pangoattrlist--change"><methodname>change</methodname>()</link>
-method with a copy of each attribute in <parameter>other</parameter> in
-sequence (offset in position by <parameter>pos</parameter>).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoattrlist--get-iterator">
- <title>pango.AttrList.get_iterator</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iterator</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoattriterator"><classname>pango.AttrIterator</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_iterator</methodname>() method creates and
-returns a <link
-linkend="class-pangoattriterator"><classname>pango.AttrIterator</classname></link>
-initialized to the beginning of the attribute list.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoattrlist--filter">
- <title>pango.AttrList.filter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>filter</methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>a callback function that returns
- <literal>True</literal> if an attribute should be filtered
- out.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>data to be passed to
- <parameter>func</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
- or <literal>None</literal>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>filter</methodname>() method arranges for the
-callback function specified by <parameter>function</parameter> to be called
-on each <link
-linkend="class-pangoattribute"><classname>pango.Attribute</classname></link>
-in the attribute list with the optional user data specified by
-<literal>data</literal>. The callback function signature is:</para>
-
- <programlisting>
- def func(attribute, user_data)
-</programlisting>
-
- <para>where <parameter>attribute</parameter> is an attribute of the
-attribute list and <parameter>user_data</parameter> is
-<parameter>data</parameter>. The callback function returns
-<literal>True</literal> if the attribute should be filtered out of the
-attribute list. The <methodname>filter</methodname> method returns a new
-<link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-containing the attributes that were filtered out (removed from) the
-attribute list.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-pango--parse-markup">
- <title>pango.parse_markup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.parse_markup</methodname>
- <methodparam><parameter
- role="keyword">markup_text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_marker</parameter><initializer>u'\x00'</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">markup_text</parameter>&nbsp;:</term>
- <listitem><simpara>a string containing the markup to
-parse.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_marker</parameter>&nbsp;:</term>
- <listitem><simpara>the Unicode character that precedes an
-accelerator, or u'\x00' for none</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple containing a <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>,
-the plain text in <parameter>markup_text</parameter>, and the first
-accelerator character in the text.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>parse_markup</function>() function parses the text
-specified by <parameter>markup_text</parameter> and returns a 3-tuple
-containing a <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>,
-the plain text from <parameter>markup_text</parameter> and the first
-accelerator character that is preceded by the Unicode character specified by
-<parameter>accel_marker</parameter>. The returned accelerator character is a
-Unicode character that may be u'\x00' if there is no accelerator
-character.</para>
-
- <para>See the <link linkend="pango-markup-language">The Pango Markup
-Language</link> reference for more information.</para>
-
- <para>The GError exception is raised if an error occurs while parsing
-the markup text.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangocairo-classes.xml b/docs/reference/pygtk-pangocairo-classes.xml
deleted file mode 100644
index 22083c77..00000000
--- a/docs/reference/pygtk-pangocairo-classes.xml
+++ /dev/null
@@ -1,15 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<chapter id="pangocairo-class-reference"
- xmlns:xi="http://www.w3.org/2001/XInclude">
- <title>The pangocairo Class Reference</title>
-
-<!-- PANGO OBJECTS -->
-
- <xi:include href="pygtk-pangocairocairocontext.xml"/>
- <xi:include href="pygtk-pangocairocairofontmap.xml"/>
- <xi:include href="pygtk-pangocairo-functions.xml"/>
- <xi:include href="pygtk-pangocairo-constants.xml"/>
-
-</chapter>
diff --git a/docs/reference/pygtk-pangocairo-constants.xml b/docs/reference/pygtk-pangocairo-constants.xml
deleted file mode 100644
index fe6be057..00000000
--- a/docs/reference/pygtk-pangocairo-constants.xml
+++ /dev/null
@@ -1,43 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="pangocairo-constants">
- <refnamediv>
- <refname>pangocairo Constants</refname>
- <refpurpose>the built-in constants of the pangocairo module</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
-<!--
- <programlisting>
-<xref linkend="pangocairo- -constants" endterm="pangocairo- -constants-title"></xref>
-</programlisting>
--->
-
- </refsect1>
-
- <refsect1 id="pangocairo-constants-description">
- <title>Description</title>
-<!--
- <refsect2 id="pangocairo- -constants">
- <title id="pangocairo- -constants-title">Pangocairo Alignment Constants</title>
-
- <para></para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pangocairo.</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
--->
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangocairo-functions.xml b/docs/reference/pygtk-pangocairo-functions.xml
deleted file mode 100644
index 3e387c99..00000000
--- a/docs/reference/pygtk-pangocairo-functions.xml
+++ /dev/null
@@ -1,129 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="pangocairo-functions">
- <refnamediv>
- <refname>pangocairo Functions</refname>
- <refpurpose>a list of all the pangocairo functions</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <refsect2>
- <title><link linkend="class-pangocairocairofontmap"><classname>pangocairo.CairoFontMap</classname></link> Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link
-linkend="function-pangocairo--cairo-font-map-get-default">pangocairo.cairo_font_map_get_default</link></methodname>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
-
-
- <refsect2>
- <title>Miscellaneous Functions</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-pangocairo--context-get-font-options">context_get_font_options</link></methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-pangocairo--context-set-font-options">context_set_font_options</link></methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font_options</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-pangocairo--context-get-font-options">
- <title>pangocairo.context_get_font_options</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pangocairo.context_get_font_options</methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">context</parameter>&nbsp;:</term>
- <listitem><simpara>a
- <link linkend="class-pangocontext"><classname>pango.Context</classname></link>
- created by the
- <link linkend="method-pangocairocairofontmap--create-context"><methodname>pango.FontMap.create_context</methodname>()</link>
- method.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a cairo.FontOptions object or
- <literal>None</literal> </simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <function>pangocairo.context_get_font_options</function>()
- method returns the cairo.FontOptions object associated with the <link
- linkend="class-pangocontext"><classname>pango.Context</classname></link>
- specified by <parameter>context</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pangocairo--context-set-font-options">
- <title>pangocairo.context_set_font_options</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pangocairo.context_set_font_options</methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font_options</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">context</parameter>&nbsp;:</term>
- <listitem><simpara>a
- <link linkend="class-pangocontext"><classname>pango.Context</classname></link>
- created by the
- <link linkend="method-pangocairocairofontmap--create-context"><methodname>pango.FontMap.create_context</methodname>()</link>
- method.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">font_options</parameter>&nbsp;:</term>
- <listitem><simpara>a cairo.FontOptions object or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>The <function>pangocairo.context_set_font_options</function>()
- function sets the font options specified by
- <parameter>font_options</parameter> used when rendering text with the
- <link
- linkend="class-pangocontext"><classname>pango.Context</classname></link>
- specified by <parameter>context</parameter>. These options override
- any options that <link
- linkend="method-pangocairocairocontext--update-context"><methodname>pangocairo.CairoContext.update_context</methodname>()</link>
- derives from the target surface. If
- <parameter>font_options</parameter> is <literal>None</literal> any
- previously set options are unset.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangocairocairocontext.xml b/docs/reference/pygtk-pangocairocairocontext.xml
deleted file mode 100644
index fdc90169..00000000
--- a/docs/reference/pygtk-pangocairocairocontext.xml
+++ /dev/null
@@ -1,408 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangocairocairocontext">
- <refnamediv>
- <refname>pangocairo.CairoContext</refname>
- <refpurpose>object providing support for using Cairo (new in
-PyGTK 2.8)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pangocairo.CairoContext</classname></ooclass>
- <ooclass><classname><link
-linkend="class-pangocairocairocontext">pangocairo.CairoContext</link></classname></ooclass>
-
- <constructorsynopsis language="python">
- <methodname>pangocairo.CairoContext</methodname>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairocontext--update-context">update_context</link></methodname>
- <methodparam><parameter role="keyword">context</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairocontext--create-layout">create_layout</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairocontext--update-layout">update_layout</link></methodname>
- <methodparam><parameter role="keyword">layout</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairocontext--show-glyph-string">show_glyph_string</link></methodname>
- <methodparam><parameter role="keyword">font</parameter></methodparam>
- <methodparam><parameter role="keyword">glyphs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairocontext--show-layout-line">show_layout_line</link></methodname>
- <methodparam><parameter role="keyword">line</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairocontext--show-layout">show_layout</link></methodname>
- <methodparam><parameter role="keyword">layout</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairocontext--glyph-string-path">glyph_string_path</link></methodname>
- <methodparam><parameter role="keyword">font</parameter></methodparam>
- <methodparam><parameter role="keyword">glyphs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairocontext--layout-line-path">layout_line_path</link></methodname>
- <methodparam><parameter role="keyword">line</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairocontext--layout-path">layout_path</link></methodname>
- <methodparam><parameter role="keyword">layout</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- cairo.Context
- +-- <link linkend="class-pangocairocairocontext">pangocairo.CairoContext</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>Cairo is a graphics library that supports vector graphics and
-image compositing that can be used with PyGTK. Since 2.8, GTK+ and Pango do
-most of their drawing using Cairo. The Cairo drawing model and primitives
-are similar to PostScript which uses an imaging model of painting on a two
-dimensional surface. There is a Python module that wraps the Cairo API that
-is used by PyGTK via subclassing of the cairo.Context class by the <link
-linkend="class-pangocairocairocontext"><classname>pangocairo.CairoContext</classname></link>
-class. The cairo.Context class provides most of the drawing primitives used
-for drawing on Cairo surfaces.</para>
-
- <para>PyGTK (and GTK+ and GDK) does not wrap the Cairo API, instead
-<link
-linkend="class-pangocairocairocontext"><classname>pangocairo.CairoContext</classname></link>
-objects can be used to draw on <link
-linkend="class-gdkdrawable"><classname>gtk.gdk.Drawable</classname></link>
-objects. A <link
-linkend="class-pangocairocairocontext"><classname>pangocairo.CairoContext</classname></link>
-is created using the <link
-linkend="method-gdkdrawable--cairo-create"><methodname>gtk.gdk.Drawable.cairo_create</methodname>()</link>
-method. See the <link
-linkend="class-pangocairocairocontext"><classname>pangocairo.CairoContext</classname></link>
-and Python cairo module documentation for additional methods.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangocairocairocontext--update-context">
- <title>pangocairo.CairoContext.update_context</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>update_context</methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">context</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-created by the <link
-linkend="method-pangocairocairofontmap--create-context"><methodname>pangocairo.CairoFontMap.create_context</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>update_context</methodname>() method updates a
-<link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-previously created for use with Cairo to match the current transformation
-and target surface of a Cairo context. If any layouts have been created for
-the context, it's necessary to call the <link
-linkend="method-pangolayout--context-changed"><methodname>pango.Layout.context_changed</methodname>()</link>
-method on those layouts.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocairocairocontext--create-layout">
- <title>pangocairo.CairoContext.create_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_layout</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>create_layout</methodname>() method creates a
-<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-object set up to match the current transformation and target surface of the
-Cairo context. This layout can then be used for text measurement with
-methods like <link
-linkend="method-pangolayout--get-size"><methodname>pango.Layout.get_size</methodname>()</link>
-or for drawing with methods like <link
-linkend="method-pangocairocairocontext--show-layout"><methodname>show_layout</methodname>()</link>. If
-you change the transformation or target surface for the context, you need to
-call the <link
-linkend="method-pangocairocairocontext--update-layout"><methodname>update_layout</methodname>()</link>
-method.</para>
-
- <para>This method is the most convenient way to use Cairo with Pango,
-however it is slightly inefficient since it creates a separate <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-object for each layout. This might be of concern in an application laying
-out large amounts of text.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocairocairocontext--update-layout">
- <title>pangocairo.CairoContext.update_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>update_layout</methodname>
- <methodparam><parameter
- role="keyword">layout</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">layout</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-created by the <link
-linkend="method-pangocairocairocontext--create-layout"><methodname>create_layout</methodname>()</link>
-method</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>update_layout</methodname>() method updates the
-private <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link> of
-the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-(specified by <parameter>layout</parameter>) that was created with the <link
-linkend="method-pangocairocairocontext--create-layout"><methodname>create_layout</methodname>()</link>
-method to match the current transformation and target surface of a Cairo
-context.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocairocairocontext--show-glyph-string">
- <title>pangocairo.CairoContext.show_glyph_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>show_glyph_string</methodname>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- <methodparam><parameter
- role="keyword">glyphs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">font</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofont"><classname>pango.Font</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">glyphs</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangoglyphstring"><classname>pango.GlyphString</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>show_glyph_string</methodname>() method draws
-the <link
-linkend="class-pangoglyphstring"><classname>pango.GlyphString</classname></link>
-specified by <parameter>glyphs</parameter> in the cairo context using the
-<link linkend="class-pangofont"><classname>pango.Font</classname></link>
-specified by <parameter>font</parameter>. The origin of the glyphs (the left
-edge of the baseline) will be drawn at the current point of the cairo
-context.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocairocairocontext--show-layout-line">
- <title>pangocairo.CairoContext.show_layout_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>show_layout_line</methodname>
- <methodparam><parameter
- role="keyword">line</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">line</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>show_layout_line</methodname>() method draws the
-<link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>
-specified by <parameter>line</parameter> in the cairo context. The origin of
-the glyphs (the left edge of the line) will be drawn at the current point of
-the cairo context.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocairocairocontext--show-layout">
- <title>pangocairo.CairoContext.show_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>show_layout</methodname>
- <methodparam><parameter
- role="keyword">layout</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">layout</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>show_layout</methodname>() method draws the
-<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-specified by <parameter>layout</parameter> in the cairo context. The
-top-left corner of the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> will
-be drawn at the current point of the cairo context.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocairocairocontext--glyph-string-path">
- <title>pangocairo.CairoContext.glyph_string_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>glyph_string_path</methodname>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- <methodparam><parameter
- role="keyword">glyphs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">font</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofont"><classname>pango.Font</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">glyphs</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangoglyphstring"><classname>pango.GlyphString</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>glyph_string_path</methodname>() method adds the
-<link
-linkend="class-pangoglyphstring"><classname>pango.GlyphString</classname></link>
-specified by <parameter>glyphs</parameter> to the current path in the cairo
-context using the <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> specified
-by font. The origin of the added glyphs (the left edge of the baseline) will
-be at the current point of the cairo context.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocairocairocontext--layout-line-path">
- <title>pangocairo.CairoContext.layout_line_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>layout_line_path</methodname>
- <methodparam><parameter
- role="keyword">line</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">line</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>layout_line_path</methodname>() method adds the
-text in the <link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>
-specified by <parameter>line</parameter> to the current path in the
-specified cairo context. The origin of the glyphs (the left edge of the
-line) will be at the current point of the cairo context.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocairocairocontext--layout-path">
- <title>pangocairo.CairoContext.layout_path</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>layout_path</methodname>
- <methodparam><parameter
- role="keyword">layout</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">layout</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>layout_path</methodname>() method adds the text
-in the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-specified by <parameter>layout</parameter> to the current path in the
-specified cairo context. The top-left corner of the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> will
-be at the current point of the cairo context.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangocairocairofontmap.xml b/docs/reference/pygtk-pangocairocairofontmap.xml
deleted file mode 100644
index e7504f6b..00000000
--- a/docs/reference/pygtk-pangocairocairofontmap.xml
+++ /dev/null
@@ -1,217 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangocairocairofontmap">
- <refnamediv>
- <refname>pangocairo.CairoFontMap</refname>
- <refpurpose>object providing support for using font maps with
-Cairo (new in PyGTK 2.8)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pangocairo.CairoFontMap</classname></ooclass>
- <ooclass><classname><link
-linkend="class-pangocairocairofontmap">pangocairo.CairoFontMap</link></classname></ooclass>
-
- <constructorsynopsis language="python">
- <methodname><link linkend="constructor-pangocairocairofontmap">pangocairo.CairoFontMap</link></methodname>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairofontmap--set-resolution">set_resolution</link></methodname>
- <methodparam><parameter role="keyword">dpi</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairofontmap--get-resolution">get_resolution</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangocairocairofontmap--create-context">create_context</link></methodname>
- </methodsynopsis>
- </classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-pangocairo--cairo-font-map-get-default">pangocairo.cairo_font_map_get_default</link></methodname>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pangofontmap">pango.FontMap</link>
- +-- <link linkend="class-pangocairocairofontmap">pangocairo.CairoFontMap</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
-linkend="class-pangocairocairofontmap"><classname>pangocairo.CairoFontMap</classname></link>
-is an interface exported by font maps for use with Cairo. The actual type of
-the font map will depend on the particular font technology Cairo was
-compiled to use.</para>
-
- <para>Cairo is a graphics library that supports vector graphics and
-image compositing that can be used with PyGTK. Since 2.8, GTK+ and Pango do
-most of their drawing using Cairo. The Cairo drawing model and primitives
-are similar to PostScript which uses an imaging model of painting on a two
-dimensional surface.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-pangocairocairofontmap">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>pangocairo.CairoFontMap</methodname>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link linkend="class-pangocairocairofontmap"><classname>pangocairo.CairoFontMap</classname></link> object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-pangocairocairofontmap"><classname>pangocairo.CairoFontMap</classname></link>
-object; a fontmap is used to cache information about available fonts, and
-holds certain global parameters such as the resolution. In most cases, you
-can use the <link
-linkend="function-pangocairo--cairo-font-map-get-default"><function>pangocairo.cairo_font_map_get_default</function>()</link>
-function instead.</para>
-
- <para>Note that the type of the returned object will depend on the
-particular font backend Cairo was compiled to use; You generally should only
-use the <link
-linkend="class-pangofontmap"><classname>pango.FontMap</classname></link> and
-<link
-linkend="class-pangocairocairofontmap"><classname>pangocairo.CairoFontMap</classname></link>
-interfaces on the returned object.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangocairocairofontmap--set-resolution">
- <title>pangocairo.CairoFontMap.set_resolution</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_resolution</methodname>
- <methodparam><parameter
- role="keyword">dpi</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">dpi</parameter>&nbsp;:</term>
- <listitem><simpara>the resolution in "dots per inch". (Physical
-inches aren't actually involved; the terminology is
-conventional.)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_resolution</methodname>() method sets the
-resolution for the fontmap to the value specified by
-<parameter>dpi</parameter>. This is a scale factor between the points
-specified in a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-and Cairo units. The default value is 96, meaning that a 10 point font will
-be 13 units high. (10 * 96. / 72. = 13.3).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocairocairofontmap--get-resolution">
- <title>pangocairo.CairoFontMap.get_resolution</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_resolution</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the resolution in
-"dots per inch"</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_resolution</methodname>() method returns the
-resolution for the fontmap. See the <link
-linkend="method-pangocairocairofontmap--set-resolution"><methodname>set_resolution</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocairocairofontmap--create-context">
- <title>pangocairo.CairoFontMap.create_context</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>create_context</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>create_context</methodname>() method creates a
-new <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-object.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-pangocairo--cairo-font-map-get-default">
- <title>pangocairo.cairo_font_map_get_default</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pangocairo.cairo_font_map_get_default</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the default Cairo fontmap for
-Pango.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <function>pangocairo.cairo_font_map_get_default</function>()
-function returns the default font map to use with Cairo.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangocolor.xml b/docs/reference/pygtk-pangocolor.xml
deleted file mode 100644
index ec4dcaf7..00000000
--- a/docs/reference/pygtk-pangocolor.xml
+++ /dev/null
@@ -1,116 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangocolor">
- <refnamediv>
- <refname>pango.Color</refname>
- <refpurpose>an object representing a RGB color</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.Color</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-pangocolor">pango.Color</link></methodname>
- <methodparam><parameter
- role="keyword">spec</parameter></methodparam>
- </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"red"</entry>
- <entry>Read</entry>
- <entry>The red component of the color with a value between 0
-and 65535.</entry>
- </row>
-
- <row valign="top">
- <entry>"green"</entry>
- <entry>Read</entry>
- <entry>The green component of the color with a value between 0
-and 65535.</entry>
- </row>
-
- <row valign="top">
- <entry>"blue"</entry>
- <entry>Read</entry>
- <entry>The blue component of the color with a value between 0
-and 65535.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link> object
-is a <link
-linkend="class-gobjectgboxed"><classname>gobject.GBoxed</classname></link>
-type that represents a color with RGB components. Each component value
-ranges from 0 to 65535.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-pangocolor">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>pango.Color</methodname>
- <methodparam><parameter
- role="keyword">spec</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter>spec</parameter>&nbsp;:</term>
- <listitem><simpara>a string specifying the new
-color</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link> using
-the color attributes specified by the string
-<parameter>spec</parameter>. The string in <parameter>spec</parameter> can
-either one of a large set of standard names. (Taken from the X11
-<filename>rgb.txt</filename> file), or it can be a hex value in the form
-'<literal>rgb</literal>' '<literal>rrggbb</literal>'
-'<literal>rrrgggbbb</literal>' or '<literal>rrrrggggbbbb</literal>' where
-'r', 'g' and 'b' are hex digits of the red, green, and blue components of
-the color, respectively. (White in the four forms is
-'<literal>fff</literal>' '<literal>ffffff</literal>'
-'<literal>fffffffff</literal>' and '<literal>ffffffffffff</literal>')</para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangocontext.xml b/docs/reference/pygtk-pangocontext.xml
deleted file mode 100644
index 1a9dbd70..00000000
--- a/docs/reference/pygtk-pangocontext.xml
+++ /dev/null
@@ -1,448 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangocontext">
- <refnamediv>
- <refname>pango.Context</refname>
- <refpurpose>stores global information used to control
-rendering.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.Context</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangocontext--list-families">list_families</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangocontext--load-font">load_font</link></methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangocontext--load-fontset">load_fontset</link></methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangocontext--get-metrics">get_metrics</link></methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangocontext--set-font-description">set_font_description</link></methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangocontext--get-font-description">get_font_description</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangocontext--get-language">get_language</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangocontext--set-language">set_language</link></methodname>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangocontext--set-base-dir">set_base_dir</link></methodname>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangocontext--get-base-dir">get_base_dir</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pangocontext">pango.Context</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
- linkend="class-pangocontext"><classname>pango.Context</classname></link>
- object contains global information used to control the rendering
- process. The information accessible using the <link
- linkend="class-pangocontext"><classname>pango.Context</classname></link>
- methods includes:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the default <link linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara>the default <link linkend="class-pangolanguage"><classname>pango.Language</classname></link></simpara>
- </listitem>
- <listitem>
- <simpara>the base direction of the text</simpara>
- </listitem>
- </itemizedlist>
-
- <para>A <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link> can
-be created with the <link
-linkend="method-gtkwidget--create-pango-context"><methodname>gtk.Widget.create_pango_context</methodname>()</link>
-method. The <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-associated with a <link
-linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> is
-retrieved using the <link
-linkend="method-gtkwidget--get-pango-context"><methodname>gtk.Widget.get_pango_context</methodname>()</link>)
-method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangocontext--list-families">
- <title>pango.Context.list_families</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_families</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a set of <link
-linkend="class-pangofontfamily"><classname>pango.FontFamily</classname></link>
-objects.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>list_families</methodname>() method returns a
-tuple containing the list of all the <link
-linkend="class-pangofontfamily"><classname>pango.FontFamily</classname></link>
-objects for a context.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocontext--load-font">
- <title>pango.Context.load_font</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>load_font</methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">desc</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-describing the font to load</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> loaded,
-or <literal>None</literal> if no font matched.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>load_font</methodname>() method loads and
-returns the <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> from one
-of the fontmaps in the context that is the closest match for the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-specified by <parameter>desc</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocontext--load-fontset">
- <title>pango.Context.load_fontset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>load_fontset</methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">desc</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-describing the fonts to load</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">language</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-the fonts will be used for</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangofontset"><classname>pango.FontSet</classname></link>, or
-<literal>None</literal> if no font matched.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>load_fontset</methodname>() method loads and
-returns a set of fonts (in a <link
-linkend="class-pangofontset"><classname>pango.FontSet</classname></link>)
-from the context that can be used to render a font matching the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-specified by <parameter>desc</parameter> with the <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-specified by <parameter>language</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocontext--get-metrics">
- <title>pango.Context.get_metrics</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_metrics</methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">desc</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">language</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-that determines the script to get the metrics for, or
-<literal>None</literal> to get the metrics for the entire
-font.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontmetrics"><classname>pango.FontMetrics</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_metrics</methodname>() method returns the
-overall metric information for the font described by the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-specified by <parameter>desc</parameter>. Since the metrics may be
-substantially different for different scripts, a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-(specified by <parameter>language</parameter>) can be provided to indicate
-that the metrics should correspond to the script(s) used by that language.
-If the value of <parameter>language</parameter> is <literal>None</literal>,
-the returned <link
-linkend="class-pangofontmetrics"><classname>pango.FontMetrics</classname></link>
-covers the entire font.</para>
-
- <para>The family name in the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-may be a comma separated list of families. If characters from multiple of
-these families would be used to render the string, then the returned fonts
-would be a composite of the metrics for the fonts loaded for the individual
-families.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocontext--set-font-description">
- <title>pango.Context.set_font_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_font_description</methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">desc</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_font_description</methodname>() method sets
-the default <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-(specified by <parameter>desc</parameter>) for the context.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocontext--get-font-description">
- <title>pango.Context.get_font_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_font_description</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the default font description of the
-context.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_font_description</methodname>() method
-returns the default <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-for the context.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocontext--get-language">
- <title>pango.Context.get_language</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_language</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the global <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_language</methodname>() method returns the
-global <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-for the context.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocontext--set-language">
- <title>pango.Context.set_language</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_language</methodname>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">language</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_language</methodname>() method sets the
-global <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-for the context to the value specified by
-<parameter>language</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangocontext--set-base-dir">
- <title>pango.Context.set_base_dir</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_base_dir</methodname>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">direction</parameter>&nbsp;:</term>
- <listitem><simpara>the new base direction</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_base_dir</methodname>() method sets the base
-text direction for the context to the value specified by
-<parameter>direction</parameter>. The value of
-<parameter>direction</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.DIRECTION_LTR</literal></term>
- <listitem>
- <simpara>The text is written left-to-right</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.DIRECTION_RTL</literal></term>
- <listitem>
- <simpara>The text is written right-to-left</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.DIRECTION_TTB_LTR</literal></term>
- <listitem>
- <simpara>The text is written vertically top-to-bottom, with the
-rows ordered from left to right.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.DIRECTION_TTB_RTL</literal></term>
- <listitem>
- <simpara>The text is written vertically top-to-bottom, with the
-rows ordered from right to left.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
-
- <refsect2 id="method-pangocontext--get-base-dir">
- <title>pango.Context.get_base_dir</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_base_dir</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the base direction for the
-context.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_base_dir</methodname>() method returns the
-base text direction for the context. See the <link
-linkend="method-pangocontext--set-base-dir"><methodname>set_base_dir</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangofont.xml b/docs/reference/pygtk-pangofont.xml
deleted file mode 100644
index f1e7bf87..00000000
--- a/docs/reference/pygtk-pangofont.xml
+++ /dev/null
@@ -1,352 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangofont">
- <refnamediv>
- <refname>pango.Font</refname>
- <refpurpose>a rendering-system independent font
-representation.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.Font</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofont--describe">describe</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofont--get-metrics">get_metrics</link></methodname>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofont--get-glyph-extents">get_glyph_extents</link></methodname>
- <methodparam><parameter
- role="keyword">glyph</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangofont--get-font-map">get_font_map</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
-<programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-pango--PIXELS">pango.PIXELS</link></methodname>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-pango--ASCENT">pango.ASCENT</link></methodname>
- <methodparam><parameter role="keyword">rect</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-pango--DESCENT">pango.DESCENT</link></methodname>
- <methodparam><parameter role="keyword">rect</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-pango--RBEARING">pango.RBEARING</link></methodname>
- <methodparam><parameter role="keyword">rect</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-pango--LBEARING">pango.LBEARING</link></methodname>
- <methodparam><parameter role="keyword">rect</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pangofont">pango.Font</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> object
-represents a font in a rendering-system independent way. A <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> is
-returned from the <link
-linkend="method-pangocontext--load-font"><methodname>pango.Context.load_font</methodname>()</link>,
-<link
-linkend="method-pangofontset--get-font"><methodname>pango.FontSet.get_font</methodname>()</link>
-and <link
-linkend="method-pangofontmap--load-font"><methodname>pango.FontMap.load_font</methodname>()</link>)
-methods.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangofont--describe">
- <title>pango.Font.describe</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>describe</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>describe</methodname>() method returns a
-description of the font in a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-object.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofont--get-metrics">
- <title>pango.Font.get_metrics</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_metrics</methodname>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">language</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-that determines the script to get the metrics for, or
-<literal>None</literal> to get the metrics for the entire
-font.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontmetrics"><classname>pango.FontMetrics</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_metrics</methodname>() method returns a
-<link
-linkend="class-pangofontmetrics"><classname>pango.FontMetrics</classname></link>
-object containing the metric information for a font using the <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-specified by <parameter>language</parameter> to limit the metrics to the
-script(s) used by <parameter>language</parameter>. If the value of
-<parameter>language</parameter> is <literal>None</literal>, the font metrics
-for the entire font is returned.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofont--get-glyph-extents">
- <title>pango.Font.get_glyph_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_glyph_extents</methodname>
- <methodparam><parameter
- role="keyword">glyph</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">glyph</parameter>&nbsp;:</term>
- <listitem><simpara>the glyph index</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing two 4-tuples representing
-the ink and logical rectangles used to store the extents of
-<parameter>glyph</parameter> as drawn.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_glyph_extents</methodname>() method returns a
-2-tuple containing two 4-tuples representing the values of the logical and
-ink extent rectangles of the specified <parameter>glyph</parameter> within a
-font. The coordinate system for each rectangle has its origin at the base
-line and horizontal origin of the character with increasing coordinates
-extending to the right and down. The <function>pango.ASCENT()</function>,
-<function>pango.DESCENT()</function>, <function>pango.LBEARING()</function>,
-and <function>pango.RBEARING</function> functions can be used to convert
-from the extents rectangle to more traditional font metrics. The units of
-the rectangles are in <literal>1/pango.SCALE</literal> of a device
-unit.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofont--get-font-map">
- <title>pango.Font.get_font_map</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_font_map</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
- linkend="class-pangofontmap"><classname>pango.FontMap</classname></link>
- for the font</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Gets the font map for which the font was created.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-pango--PIXELS">
- <title>pango.PIXELS</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.PIXELS</methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the integer value to convert to pango
-pixels</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the pixel value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>pango.PIXELS</function>() function converts and
-returns the integer value specified by <parameter>size</parameter> to pango
-pixels.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--ASCENT">
- <title>pango.ASCENT</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.ASCENT</methodname>
- <methodparam><parameter
- role="keyword">rect</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rect</parameter>&nbsp;:</term>
- <listitem><simpara>a 4-tuple representing an extent rectangle's
-(x, y, width, height) value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the ascent value of
-<parameter>rect</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>pango.ASCENT</function>() function returns the
-ascent value of the extent rectangle specified by
-<parameter>rect</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--DESCENT">
- <title>pango.DESCENT</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.DESCENT</methodname>
- <methodparam><parameter
- role="keyword">rect</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rect</parameter>&nbsp;:</term>
- <listitem><simpara>a 4-tuple representing an extent rectangle's
-(x, y, width, height) value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the descent value of
-<parameter>rect</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>pango.DESCENT</function>() function returns the
-descent value of the extent rectangle specified by
-<parameter>rect</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--RBEARING">
- <title>pango.RBEARING</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.RBEARING</methodname>
- <methodparam><parameter
- role="keyword">rect</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rect</parameter>&nbsp;:</term>
- <listitem><simpara>a 4-tuple representing an extent rectangle's
-(x, y, width, height) value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the right bearing value of
-<parameter>rect</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>pango.RBEARING</function>() function returns the
-right bearing value of the extent rectangle specified by
-<parameter>rect</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--LBEARING">
- <title>pango.LBEARING</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.LBEARING</methodname>
- <methodparam><parameter
- role="keyword">rect</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">rect</parameter>&nbsp;:</term>
- <listitem><simpara>a 4-tuple representing an extent rectangle's
-(x, y, width, height) value</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the left bearing value of
-<parameter>rect</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <function>pango.LBEARING</function>() function returns the
-left bearing value of the extent rectangle specified by
-<parameter>rect</parameter>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangofontdescription.xml b/docs/reference/pygtk-pangofontdescription.xml
deleted file mode 100644
index 508b0427..00000000
--- a/docs/reference/pygtk-pangofontdescription.xml
+++ /dev/null
@@ -1,1154 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangofontdescription">
- <refnamediv>
- <refname>pango.FontDescription</refname>
- <refpurpose>an object representing a description of a font.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.FontDescription</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-pangofontdescription">pango.FontDescription</link></methodname>
- <methodparam><parameter role="keyword">str</parameter>
- <initializer>None</initializer></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--copy-static">copy_static</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--hash">hash</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--set-family">set_family</link></methodname>
- <methodparam><parameter
- role="keyword">family</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--set-family-static">set_family_static</link></methodname>
- <methodparam><parameter
- role="keyword">family</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--get-family">get_family</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--set-style">set_style</link></methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--get-style">get_style</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--set-variant">set_variant</link></methodname>
- <methodparam><parameter
- role="keyword">variant</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--get-variant">get_variant</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--set-weight">set_weight</link></methodname>
- <methodparam><parameter
- role="keyword">weight</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--get-weight">get_weight</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--set-stretch">set_stretch</link></methodname>
- <methodparam><parameter
- role="keyword">stretch</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--get-stretch">get_stretch</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--set-size">set_size</link></methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--get-size">get_size</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--get-set-fields">get_set_fields</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--unset-fields">unset_fields</link></methodname>
- <methodparam><parameter
- role="keyword">to_unset</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--merge">merge</link></methodname>
- <methodparam><parameter
- role="keyword">desc_to_merge</parameter></methodparam>
- <methodparam><parameter
- role="keyword">replace_existing</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--merge-static">merge_static</link></methodname>
- <methodparam><parameter
- role="keyword">desc_to_merge</parameter></methodparam>
- <methodparam><parameter
- role="keyword">replace_existing</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--better-match">better_match</link></methodname>
- <methodparam><parameter
- role="keyword">old_match</parameter></methodparam>
- <methodparam><parameter
- role="keyword">new_match</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--to-string">to_string</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontdescription--to-filename">to_filename</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangofontdescription--set-absolute-size">set_absolute_size</link></methodname>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangofontdescription--get-size-is-absolute">get_size_is_absolute</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-represents the description of an ideal font. They are used to both specify
-the characteristics of a font to load and to list the available fonts on the
-system.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-pangofontdescription">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>pango.FontDescription</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-object from the representation in the string specified by
-<parameter>str</parameter>. The format of the string representation
-is:</para>
-
- <programlisting>
- "[FAMILY-LIST] [STYLE-OPTIONS] [SIZE]"
-</programlisting>
-
- <para>where <literal>FAMILY-LIST</literal> is a comma separated list of
-families optionally terminated by a comma, <literal>STYLE_OPTIONS</literal>
-is a whitespace separated list of words where each <literal>WORD</literal>
-describes one of style, variant, weight, or stretch, and
-<literal>SIZE</literal> is an decimal number (size in points). For example
-the following are all valid string representations:</para>
-
- <programlisting>
- "sans bold 12"
- "serif,monospace bold italic condensed 16"
- "normal 10"
-</programlisting>
-
- <para>The commonly available font families are: Normal, Sans, Serif and
-Monospace. The available styles are:</para>
-
- <variablelist>
- <varlistentry>
- <term>Normal</term>
- <listitem>
- <simpara>the font is upright.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Oblique</term>
- <listitem>
- <simpara>the font is slanted, but in a roman style.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Italic</term>
- <listitem>
- <simpara>the font is slanted in an italic style. </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The available weights are:</para>
-
- <variablelist>
- <varlistentry>
- <term>Ultra-Light</term>
- <listitem>
- <simpara>the ultralight weight (= 200)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Light</term>
- <listitem>
- <simpara>the light weight (=300)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Normal</term>
- <listitem>
- <simpara>the default weight (= 400)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Bold</term>
- <listitem>
- <simpara>the bold weight (= 700)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Ultra-Bold</term>
- <listitem>
- <simpara>the ultra-bold weight (= 800)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Heavy</term>
- <listitem>
- <simpara>the heavy weight (= 900)</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The available variants are:</para>
-
- <variablelist>
- <varlistentry>
- <term>Normal</term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Small-Caps</term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The available stretch styles are:</para>
-
- <variablelist>
- <varlistentry>
- <term>Ultra-Condensed</term>
- <listitem>
- <simpara>the smallest width</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Extra-Condensed</term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Condensed</term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Semi-Condensed</term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Normal</term>
- <listitem>
- <simpara>the normal width</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Semi-Expanded</term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Expanded</term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Extra-Expanded</term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Ultra-Expanded</term>
- <listitem>
- <simpara>the widest width</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangofontdescription--copy">
- <title>pango.FontDescription.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns a new copy of
-this font description.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--copy-static">
- <title>pango.FontDescription.copy_static</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy_static</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>..</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy_static</methodname>() method is like the
-<link
-linkend="method-pangofontdescription--copy"><methodname>copy</methodname>()</link>
-method, but only a shallow copy is made of the family name and other
-allocated attribute fields. The result can only be used until the original
-font description is modified or freed. This is meant to be used when the
-copy is only needed temporarily.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--hash">
- <title>pango.FontDescription.hash</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>hash</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the hash value.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>hash</methodname>() method computes and returns
-a hash of the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--set-family">
- <title>pango.FontDescription.set_family</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_family</methodname>
- <methodparam><parameter
- role="keyword">family</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">family</parameter>&nbsp;:</term>
- <listitem><simpara>a string representing the family
-name.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_family</methodname>() method sets the family
-name attribute field of the font description to the value specified by
-<parameter>family</parameter>. The family name represents a family of
-related font styles, and will resolve to a particular <link
-linkend="class-pangofontfamily"><classname>pango.FontFamily</classname></link>.
-In some uses of <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>,
-it is also possible to use a comma separated list of family names for this
-field.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--set-family-static">
- <title>pango.FontDescription.set_family_static</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_family_static</methodname>
- <methodparam><parameter
- role="keyword">family</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">family</parameter>&nbsp;:</term>
- <listitem><simpara>a string representing the family
-name.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The set_family_static() method is like the <link
-linkend="method-pangofontdescription--set-family"><methodname>set_family</methodname>()</link>,
-except that no copy of <parameter>family</parameter> is made. The caller
-must make sure that the string passed in stays around until the font
-description is no longer needed or the family name is set again. This method
-can be used if <parameter>family</parameter> is only needed
-temporarily.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--get-family">
- <title>pango.FontDescription.get_family</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_family</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the family name or <literal>None</literal> if
-not previously set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_family</methodname>() method returns the
-family name attribute field of the font description. See the <link
-linkend="method-pangofontdescription--set-family"><methodname>set_family</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--set-style">
- <title>pango.FontDescription.set_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_style</methodname>
- <methodparam><parameter
- role="keyword">style</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">style</parameter>&nbsp;:</term>
- <listitem><simpara>the style for the font
-description</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_style</methodname>() method sets the slant
-style attribute field of the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-to the value specified by <parameter>style</parameter>. The value of
-<parameter>style</parameter> must be either
-<literal>pango.STYLE_NORMAL</literal>,
-<literal>pango.STYLE_ITALIC</literal>, or
-<literal>pango.STYLE_OBLIQUE</literal>. Most fonts will either have a italic
-style or an oblique style, but not both, and font matching in Pango will
-match italic specifications with oblique fonts and vice-versa if an exact
-match is not found.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--get-style">
- <title>pango.FontDescription.get_style</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_style</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the slant style for the font description.
-</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_style</methodname>() method returns the
-slant style attribute field of the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>.
-See the <link
-linkend="method-pangofontdescription--set-style"><methodname>set_style</methodname>()</link>
-method for more details. Use the <link
-linkend="method-pangofontdescription--get-set-fields"><methodname>get_set_fields</methodname>()</link>
-method to find out if the field was explicitly set.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--set-variant">
- <title>pango.FontDescription.set_variant</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_variant</methodname>
- <methodparam><parameter
- role="keyword">variant</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">variant</parameter>&nbsp;:</term>
- <listitem><simpara>the variant type for the font
-description.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_variant</methodname>() method sets the
-variant attribute field of a font description to the value specified by
-<parameter>variant</parameter>. The value of <parameter>variant</parameter>
-must be either <literal>pango.VARIANT_NORMAL</literal> or
-<literal>pango.VARIANT_SMALL_CAPS</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--get-variant">
- <title>pango.FontDescription.get_variant</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_variant</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the variant style of the font
-description.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_variant</methodname>() method returns the
-variant style of a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>.
-See the <link
-linkend="method-pangofontdescription--set-variant"><methodname>set_variant</methodname>()</link>
-method for more information. Use the <link
-linkend="method-pangofontdescription--get-set-fields"><methodname>get_set_fields</methodname>()</link>
-method to find out if the field was explicitly set.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--set-weight">
- <title>pango.FontDescription.set_weight</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_weight</methodname>
- <methodparam><parameter
- role="keyword">weight</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">weight</parameter>&nbsp;:</term>
- <listitem><simpara>the weight for the font
-description.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_weight</methodname>() method sets the weight
-attribute field of a font description to the value specified by
-<parameter>weight</parameter>. The value of <parameter>weight</parameter>
-specifies how bold or light the font should be in a range from 100 to 900.
-The predefined values of weight are:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.WEIGHT_ULTRALIGHT</literal></term>
- <listitem>
- <simpara>the ultralight weight (= 200)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_LIGHT</literal></term>
- <listitem>
- <simpara>the light weight (=300)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_NORMAL</literal></term>
- <listitem>
- <simpara>the default weight (= 400)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_BOLD</literal></term>
- <listitem>
- <simpara>the bold weight (= 700)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_ULTRABOLD</literal></term>
- <listitem>
- <simpara>the ultrabold weight (= 800)</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WEIGHT_HEAVY</literal></term>
- <listitem>
- <simpara>the heavy weight (= 900)</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--get-weight">
- <title>pango.FontDescription.get_weight</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_weight</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the weight field for the font
-description.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_weight</methodname>() method returns the
-value of the weight attribute of a font description. See the <link
-linkend="method-pangofontdescription--set-weight"><methodname>set_weight</methodname>()</link>
-method for more information. Use the <link
-linkend="method-pangofontdescription--get-set-fields"><methodname>get_set_fields</methodname>()</link>
-method to determine if the attribute was explicitly set.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--set-stretch">
- <title>pango.FontDescription.set_stretch</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_stretch</methodname>
- <methodparam><parameter
- role="keyword">stretch</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">stretch</parameter>&nbsp;:</term>
- <listitem><simpara>the stretch for the font
-description</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_stretch</methodname>() method sets the
-stretch attribute field of a font description to the value specified by
-<parameter>stretch</parameter>. The value of <parameter>stretch</parameter>
-specifies how narrow or wide the font should be relative to the base width
-of the font family:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.STRETCH_ULTRA_CONDENSED</literal></term>
- <listitem>
- <simpara>the narrowest width</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_EXTRA_CONDENSED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_CONDENSED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_SEMI_CONDENSED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_NORMAL</literal></term>
- <listitem>
- <simpara>the normal (base) width</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_SEMI_EXPANDED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_EXPANDED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_EXTRA_EXPANDED</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.STRETCH_ULTRA_EXPANDED</literal></term>
- <listitem>
- <simpara>the widest width</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--get-stretch">
- <title>pango.FontDescription.get_stretch</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_stretch</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the stretch field for the font
-description</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_stretch</methodname>() method returns the
-stretch attribute field of a font description. See the <link
-linkend="method-pangofontdescription--set-stretch"><methodname>set_stretch</methodname>()</link>
-method for more details. Use the <link
-linkend="method-pangofontdescription--get-set-fields"><methodname>get_set_fields</methodname>()</link>
-method to determine if the field was explicitly set.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--set-size">
- <title>pango.FontDescription.set_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_size</methodname>
- <methodparam><parameter
- role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the size for the font description in pango
-units.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_size</methodname>() method sets the
-size attribute field of a font description to the value specified by
-<parameter>size</parameter>. The value of <parameter>size</parameter> is
-specified in pango units. There are <literal>pango.SCALE</literal> (1024)
-pango units in one device unit (the device unit is a point for font
-sizes).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--get-size">
- <title>pango.FontDescription.get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the size for the font description in pango
-units.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_size</methodname>() method returns the value
-of the size attribute field of a font description. See the <link
-linkend="method-pangofontdescription--get-size"><methodname>get_size</methodname>()</link>
-method for more information. There are <literal>pango.SCALE</literal> pango
-units in one device unit (point). If the stretch attribute field has not
-previously been set, 0 is returned. Use the <link
-linkend="method-pangofontdescription--get-set-fields"><methodname>get_set_fields</methodname>()</link>
-method to determine if the field was explicitly set.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--get-set-fields">
- <title>pango.FontDescription.get_set_fields</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_set_fields</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a bitmask with bits set corresponding to the
-font description attribute fields that have been set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_set_fields</methodname>() method returns a
-value that indicates which attribute fields in a font description have been
-set. The value returned is a combination of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.FONT_MASK_FAMILY</literal></term>
- <listitem>
- <simpara>the font family has been set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.FONT_MASK_STYLE</literal></term>
- <listitem>
- <simpara>the font slant style has been set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.FONT_MASK_VARIANT</literal></term>
- <listitem>
- <simpara>the font variant has been set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.FONT_MASK_WEIGHT</literal></term>
- <listitem>
- <simpara>the font weight has been set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.FONT_MASK_STRETCH</literal></term>
- <listitem>
- <simpara>the font stretch has been set.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.FONT_MASK_SIZE</literal></term>
- <listitem>
- <simpara>the font size has been set.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--unset-fields">
- <title>pango.FontDescription.unset_fields</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>unset_fields</methodname>
- <methodparam><parameter
- role="keyword">to_unset</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">to_unset</parameter>&nbsp;:</term>
- <listitem><simpara>a bitmask of attribute fields in the font
-description to unset.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>unset_fields</methodname>() method unsets the
-attribute fields (specified by <parameter>to_unset</parameter>) in the
-<link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>.
-Note that this merely marks the attribute fields cleared, it does not clear
-the settings.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--merge">
- <title>pango.FontDescription.merge</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>merge</methodname>
- <methodparam><parameter
- role="keyword">desc_to_merge</parameter></methodparam>
- <methodparam><parameter
- role="keyword">replace_existing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">desc_to_merge</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-to merge into the font description</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">replace_existing</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, replace attribute
-fields in the font description with the corresponding values from
-<parameter>desc_to_merge</parameter>, even if they are already
-exist.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>merge</methodname>() method merges the attribute
-fields that are set in the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-specified by <parameter>desc_to_merge</parameter> into the attribute fields
-in the font description. If <parameter>replace_existing</parameter> is
-<literal>False</literal>, only fields in the font description that are not
-already set are affected. If <parameter>replace_existing</parameter> is
-<literal>True</literal>, attribute fields that are already set will also be
-replaced.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--merge-static">
- <title>pango.FontDescription.merge_static</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>merge_static</methodname>
- <methodparam><parameter
- role="keyword">desc_to_merge</parameter></methodparam>
- <methodparam><parameter
- role="keyword">replace_existing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">desc_to_merge</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-to merge from</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">replace_existing</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, replace attribute
-fields in the font description with the corresponding values from
-<parameter>desc_to_merge</parameter>, even if they are already
-exist.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>merge_static</methodname>() method is similar to
-the <link
-linkend="method-pangofontdescription--merge"><methodname>merge</methodname>()</link>
-method, but only a shallow copy is made of the family name and other
-allocated fields. The font description can only be used until
-<parameter>desc_to_merge</parameter> is modified or freed. This is meant to
-be used when the merged font description is only needed temporarily.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--better-match">
- <title>pango.FontDescription.better_match</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>better_match</methodname>
- <methodparam><parameter
- role="keyword">old_match</parameter></methodparam>
- <methodparam><parameter
- role="keyword">new_match</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">old_match</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>,
-or <literal>None</literal></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">new_match</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
-<parameter>new_match</parameter> is a better match</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>better_match</methodname>() method determines if
-the attributes of the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-specified by <parameter>new_match</parameter> are a closer match for the
-font description than the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-specified by <parameter>old_match</parameter>. If
-<parameter>old_match</parameter> is <literal>None</literal>, determines if
-<parameter>new_match</parameter> is a match at all. The weight and style
-attribute need only match approximately but the other attributes must match
-exactly.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--to-string">
- <title>pango.FontDescription.to_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>to_string</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string representation of the font
-description.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>to_string</methodname>() method returns a string
-representation of the font description. See the <link
-linkend="constructor-pangofontdescription">pango.FontDescription</link>()
-constructor for a description of the format of the string representation.
-The family list in the string description will only have a terminating comma
-if the last word of the list is a valid style option.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--to-filename">
- <title>pango.FontDescription.to_filename</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>to_filename</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a string representation of the font description
-as a filename.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>to_filename</methodname>() method returns a
-filename representation of a font description. The filename is identical to
-the result from calling the <link
-linkend="method-pangofontdescription--to-string"><methodname>to_string</methodname>()</link>
-method, but underscores replace characters that are not typically used in
-filenames, and it is in lower case only.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--set-absolute-size">
- <title>pango.FontDescription.set_absolute_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_absolute_size</methodname>
- <methodparam><parameter role="keyword">size</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">size</parameter>&nbsp;:</term>
- <listitem><simpara>the new size, in Pango units. There are
- <literal>pango.SCALE</literal> Pango units in one device unit. For
- an output backend where a device unit is a pixel, a
- <parameter>size</parameter> value of 10 * pango.SCALE gives a 10
- pixel font.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Sets the size field of a font description, in device units. This
- is mutually exclusive with <link
- linkend="method-pangofontdescription--set-size"><methodname>pango.FontDescription.set_size()</methodname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontdescription--get-size-is-absolute">
- <title>pango.FontDescription.get_size_is_absolute</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size_is_absolute</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>whether the size for the font description is in
- points or device units. Use <link
- linkend="method-pangofontdescription--get-set-fields"><methodname>pango.FontDescription.get_set_fields()</methodname></link>
- to find out if the size field of the font description was
- explicitly set or not.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Determines whether the size of the font is in points or device
- units. See <link
- linkend="method-pangofontdescription--set-size"><methodname>pango.FontDescription.set_size()</methodname></link>
- and <link
- linkend="method-pangofontdescription--set-absolute-size"><methodname>pango.FontDescription.set_absolute_size()</methodname></link>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangofontface.xml b/docs/reference/pygtk-pangofontface.xml
deleted file mode 100644
index ac666e76..00000000
--- a/docs/reference/pygtk-pangofontface.xml
+++ /dev/null
@@ -1,138 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangofontface">
- <refnamediv>
- <refname>pango.FontFace</refname>
- <refpurpose>an object representing a group of fonts varying only in
-size.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.FontFace</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontface--describe">describe</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontface--get-face-name">get_face_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontface--list-sizes">list_sizes</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangofontface"><classname>pango.FontFace</classname></link>
-object represents a group of fonts with the same family, weight, slant,
-stretch and width but varying sizes. A list of font faces can be retrieved
-from a <link
-linkend="class-pangofontfamily"><classname>pango.FontFamily</classname></link>
-object using the <link
-linkend="method-pangofontfamily--list-faces"><methodname>pango.FontFamily.list_faces</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pangofontface">pango.FontFace</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangofontface--describe">
- <title>pango.FontFace.describe</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>describe</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-object containing the description of the face.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>describe</methodname>() method returns a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-object containing the family, style, variant, weight and stretch of the
-<link
-linkend="class-pangofontface"><classname>pango.FontFace</classname></link>.
-The size attribute field will be unset.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontface--get-face-name">
- <title>pango.FontFace.get_face_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_face_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the face name for the
-face.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_face_name</methodname>() method returns a
-string representing this font face. This name is unique among all faces in the
-family and is suitable for displaying to users.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontface--list-sizes">
- <title>pango.FontFace.list_sizes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_sizes</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a list of face sizes in
- pango units or <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>list_sizes</methodname>() method returns a tuple
-containing the available sizes for a bitmap font. If the font face is a
-scalable font this method returns <literal>None</literal>.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangofontfamily.xml b/docs/reference/pygtk-pangofontfamily.xml
deleted file mode 100644
index e4db50a9..00000000
--- a/docs/reference/pygtk-pangofontfamily.xml
+++ /dev/null
@@ -1,148 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangofontfamily">
- <refnamediv>
- <refname>pango.FontFamily</refname>
- <refpurpose>an object representing a family of related font
-faces.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.FontFamily</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontfamily--list-faces">list_faces</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontfamily--get-name">get_name</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontfamily--is-monospace">is_monospace</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pangofontfamily">pango.FontFamily</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-pangofontfamily"><classname>pango.FontFamily</classname></link>
-object is used to represent a family of related font faces. The faces in a
-family share a common design, but differ in slant, weight, width and other
-aspects. A list of <link
-linkend="class-pangofontfamily"><classname>pango.FontFamily</classname></link>
-objects can be retrieved from a <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-object using the <link
-linkend="method-pangocontext--list-families"><methodname>pango.Context.list_families</methodname>()</link>
-method and from a <link
-linkend="class-pangofontmap"><classname>pango.FontMap</classname></link>
-object using the <link
-linkend="method-pangofontmap--list-families"><methodname>pango.FontMap.list_families</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangofontfamily--list-faces">
- <title>pango.FontFamily.list_faces</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_faces</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of <link
-linkend="class-pangofontface"><classname>pango.FontFace</classname></link>
-objects.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>list_faces</methodname>() method returns a list
-of the different <link
-linkend="class-pangofontface"><classname>pango.FontFace</classname></link>
-object that make up the font family>. The faces in a family share a common
-design, but differ in slant, weight, width and other aspects.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontfamily--get-name">
- <title>pango.FontFamily.get_name</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_name</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the name of the family.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_name</methodname>() method returns a string
-containing the name of the font family. The name is unique among all fonts
-for the font backend and can be used in a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-to specify that a face from this family is desired.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontfamily--is-monospace">
- <title>pango.FontFamily.is_monospace</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>is_monospace</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the font family is
- monospace.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>is_monospace</methodname>() method returns
- <literal>True</literal> if the font family describes a monospace
- font. A monospace font is a font designed for text display where the
- the characters form a regular grid. For Western languages this would
- mean that the advance width of all characters are the same, but this
- categorization also includes Asian fonts which include double-width
- characters: characters that occupy two grid cells. The best way to
- find out the grid-cell size is to call the <link
- linkend="method-pangofontmetrics--get-approximate-digit-width"><methodname>get_approximate_digit_width</methodname>()</link>
- method, since the results of the <link
- linkend="method-pangofontmetrics--get-approximate-char-width"><methodname>get_approximate_char_width</methodname>()</link></para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangofontmap.xml b/docs/reference/pygtk-pangofontmap.xml
deleted file mode 100644
index a8dbeef4..00000000
--- a/docs/reference/pygtk-pangofontmap.xml
+++ /dev/null
@@ -1,215 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangofontmap">
- <refnamediv>
- <refname>pango.FontMap</refname>
- <refpurpose>an object that represents the set of fonts available for a
-particular rendering system.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.FontMap</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontmap--load-font">load_font</link></methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontmap--load-fontset">load_fontset</link></methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontmap--list-families">list_families</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontmap--get-shape-engine-type">get_shape_engine_type</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pangofontmap">pango.FontMap</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangofontmap"><classname>pango.FontMap</classname></link>
-object represents the set of fonts available for a particular rendering
-system. There appears to be no way to retrieve a <link
-linkend="class-pangofontmap"><classname>pango.FontMap</classname></link>
-object in <literal>PyGTK</literal>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangofontmap--load-font">
- <title>pango.FontMap.load_font</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>load_font</methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link> the
-font will be used with</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">desc</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-describing the font to load</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the loaded font , or <literal>None</literal> if
-no font matched.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>load_font</methodname>() method loads the <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> in the
-fontmap that is the closest match for the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-specified by <parameter>desc</parameter> in the <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-specified by <parameter>context</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontmap--load-fontset">
- <title>pango.FontMap.load_fontset</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>load_fontset</methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">context</parameter>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link> the
-font will be used with</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">desc</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-describing the font to load</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">language</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-the fonts will be used for</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofontset"><classname>pango.FontSet</classname></link>, or
-<literal>None</literal> if no font matched.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>load_fontset</methodname>() method loads a set
-of <link linkend="class-pangofont"><classname>pango.Font</classname></link>
-objects in the fontmap that can be used to render a font matching the <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-specified by <parameter>desc</parameter> for the <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-specified by <parameter>language</parameter> in the <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-specified by <parameter>context</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontmap--list-families">
- <title>pango.FontMap.list_families</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>list_families</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list of <link
-linkend="class-pangofontfamily"><classname>pango.FontFamily</classname></link>
-objects.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>list_families</methodname>() method returns a
-list of all <link
-linkend="class-pangofontfamily"><classname>pango.FontFamily</classname></link>
-objects for the fontmap.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontmap--get-shape-engine-type">
- <title>pango.FontMap.get_shape_engine_type</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_shape_engine_type</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara> the ID string for the shape engines for the
- font map.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>get_shape_engine_type</methodname>() method
-returns the render ID for the shape engines for the font map</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangofontmetrics.xml b/docs/reference/pygtk-pangofontmetrics.xml
deleted file mode 100644
index 31dd2403..00000000
--- a/docs/reference/pygtk-pangofontmetrics.xml
+++ /dev/null
@@ -1,164 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangofontmetrics">
- <refnamediv>
- <refname>pango.FontMetrics</refname>
- <refpurpose>an object containing overall metric information for a
-font.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.FontMetrics</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontmetrics--get-ascent">get_ascent</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontmetrics--get-descent">get_descent</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontmetrics--get-approximate-char-width">get_approximate_char_width</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontmetrics--get-approximate-digit-width">get_approximate_digit_width</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangofontmetrics"><classname>pango.FontMetrics</classname></link>
-object holds the overall metric information for a font. A <link
-linkend="class-pangofontmetrics"><classname>pango.FontMetrics</classname></link>
-object is returned from the following methods:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><link
-linkend="method-pangocontext--get-metrics"><methodname>pango.Context.get_metrics</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-pangofont--get-metrics"><methodname>pango.Font.get_metrics</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-pangofontset--get-metrics"><methodname>pango.Fontset.get_metrics</methodname>()</link></simpara>
- </listitem>
- </itemizedlist>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangofontmetrics--get-ascent">
- <title>pango.FontMetrics.get_ascent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_ascent</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the ascent in pango units. (1 point ==
-<literal>pango.SCALE</literal> pango units.)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_ascent</methodname>() method returns the
-font ascent in pango units where one font point is equal to pango.SCALE
-(1024) pango units. The ascent is the distance from the baseline to the
-logical top of a line of text. (The logical top may be above or below the
-top of the actual drawn ink. It is necessary to lay out the text to figure
-where the ink will be.)</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontmetrics--get-descent">
- <title>pango.FontMetrics.get_descent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_descent</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the descent in pango units. (1 point ==
-<literal>pango.SCALE</literal> pango units.)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_descent</methodname>() method returns the
-font descent in pango units where one font point is equal to pango.SCALE
-(1024) pango units. The descent is the distance from the baseline to the
-logical bottom of a line of text. (The logical bottom may be above or below
-the bottom of the actual drawn ink. It is necessary to lay out the text to
-figure where the ink will be.)</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontmetrics--get-approximate-char-width">
- <title>pango.FontMetrics.get_approximate_char_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_approximate_char_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the character width in pango units. (1 point ==
-<literal>pango.SCALE</literal> pango units.)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_approximate_char_width</methodname>() method
-returns the approximate character width for a font in pango units where one
-font point is equal to pango.SCALE (1024) pango units. This is merely a
-representative value that is useful, for example, for determining the
-initial size for a window. Actual characters in text will be wider and
-narrower than this.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontmetrics--get-approximate-digit-width">
- <title>pango.FontMetrics.get_approximate_digit_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_approximate_digit_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the digit width in pango units. (1 point ==
-<literal>pango.SCALE</literal> pango units.)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_approximate_digit_width</methodname>()
-method returns the approximate digit width for a font in pango units where
-one font point is equal to pango.SCALE (1024) pango units. This is merely a
-representative value that is useful, for example, for determining the
-initial size for a window. Actual digits in text can be wider and narrower
-than this, though this value is generally somewhat more accurate than the
-result of the <link
-linkend="method-pangofontmetrics--get-approximate-char-width"><methodname>get_approximate_char_width</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangofontset.xml b/docs/reference/pygtk-pangofontset.xml
deleted file mode 100644
index f17ffcd5..00000000
--- a/docs/reference/pygtk-pangofontset.xml
+++ /dev/null
@@ -1,172 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangofontset">
- <refnamediv>
- <refname>pango.Fontset</refname>
- <refpurpose>an object containing a set of <link
-linkend="class-pangofont"><classname>pango.Font</classname></link>
-objects.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.Fontset</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontset--get-font">get_font</link></methodname>
- <methodparam><parameter role="keyword">wc</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontset--get-metrics">get_metrics</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangofontset--foreach">foreach</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pangofontset">pango.Fontset</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangofontset"><classname>pango.Fontset</classname></link>
-object holds a set of <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> objects.
-A <link
-linkend="class-pangofontset"><classname>pango.FontSet</classname></link>
-object is returned from the following methods:</para>
-
- <itemizedlist>
- <listitem>
- <simpara><link
-linkend="method-pangocontext--load-fontset"><methodname>pango.Context.load_fontset</methodname>()</link></simpara>
- </listitem>
- <listitem>
- <simpara><link
-linkend="method-pangofontmap--load-fontset"><methodname>pango.FontMap.load_fontset</methodname>()</link></simpara>
- </listitem>
- </itemizedlist>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangofontset--get-font">
- <title>pango.Fontset.get_font</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_font</methodname>
- <methodparam><parameter
- role="keyword">wc</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">wc</parameter>&nbsp;:</term>
- <listitem><simpara>a unicode character</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofont"><classname>pango.Font</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_font</methodname>() method returns the <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> in the
-fontset that contains the best glyph for the unicode character specified by
-<parameter>wc</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontset--get-metrics">
- <title>pango.Fontset.get_metrics</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_metrics</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-pangofontmetrics"><classname>pango.FontMetrics</classname></link>
- object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_metrics</methodname>() method returns a
-<link
-linkend="class-pangofontmetrics"><classname>pango.FontMetrics</classname></link>
-object that contains the overall metric information for the fonts in the
-fontset.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontset--foreach">
- <title>pango.Fontset.foreach</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>foreach</methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>a callback function</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to
- <parameter>func</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>foreach</methodname>() method invokes the
-function specified by <parameter>func</parameter> on each <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> of the
-font set passing it the optional user data specified by
-<parameter>data</parameter>. The signature of <parameter>func</parameter>
-is:</para>
-
- <programlisting>
- def func(fontset, font, user_data)
-</programlisting>
-
- <para>where <parameter>fontset</parameter> is the <link
-linkend="class-pangofontset"><classname>pango.Fontset</classname></link>
-containing the <link
-linkend="class-pangofont"><classname>pango.Font</classname></link>
-<parameter>font</parameter> and <parameter>user_data</parameter> is
-<parameter>data</parameter></para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangofontsetsimple.xml b/docs/reference/pygtk-pangofontsetsimple.xml
deleted file mode 100644
index 352c777b..00000000
--- a/docs/reference/pygtk-pangofontsetsimple.xml
+++ /dev/null
@@ -1,149 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-pangofontsetsimple">
- <refnamediv>
- <refname>pango.FontsetSimple</refname>
- <refpurpose>a simple container for a set of fonts </refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.FontsetSimple</classname></ooclass>
- <ooclass><classname><link linkend="class-pangofontset">pango.Fontset</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname>pango.FontsetSimple</methodname>
- <methodparam><parameter role="keyword">language</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangofontsetsimple--append">append</link></methodname>
- <methodparam><parameter role="keyword">font</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangofontsetsimple--size">size</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pangofontset">pango.Fontset</link>
- +-- <link linkend="class-pangofontsetsimple">pango.FontsetSimple</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <note>
- <para>This object is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>A <link
-linkend="class-pangofontsetsimple"><classname>pango.FontsetSimple</classname></link>
-is a subclass of <link
-linkend="class-pangofontset"><classname>pango.Fontset</classname></link>
-that provides a simple container for storing a set of <link
-linkend="class-pangofont"><classname>pango.Font</classname></link>
-objects. The set of fonts in a <link
-linkend="class-pangofontsetsimple"><classname>pango.FontsetSimple</classname></link>
-are assemble by using the <link
-linkend="method-pangofontsetsimple--append"><methodname>append</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>pango.FontsetSimple</methodname>
- <methodparam><parameter role="keyword">language</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">language</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-pangolanguage"><classname>pango.Language</classname></link>
- object</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-pangofontsetsimple"><classname>pango.FontsetSimple</classname></link>
- object.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-pangofontsetsimple"><classname>pango.FontsetSimple</classname></link>
-for the <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-specified by language.</para>
-
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangofontsetsimple--append">
- <title>pango.FontsetSimple.append</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>append</methodname>
- <methodparam><parameter role="keyword">font</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">font</parameter>&nbsp;:</term>
- <listitem><simpara>a <link linkend="class-pangofont"><classname>pango.Font</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>append</methodname>() method adds the <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> specified
-by font to the fontset.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangofontsetsimple--size">
- <title>pango.FontsetSimple.size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the size of the font set.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>size</methodname>() method returns the number of
-fonts in the fontset.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangoglyphstring.xml b/docs/reference/pygtk-pangoglyphstring.xml
deleted file mode 100644
index ab0fea58..00000000
--- a/docs/reference/pygtk-pangoglyphstring.xml
+++ /dev/null
@@ -1,274 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangoglyphstring">
- <refnamediv>
- <refname>pango.GlyphString</refname>
- <refpurpose>an object holding strings of glyphs and glyph
-information.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.GlyphString</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-pangoglyphstring">pango.GlyphString</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoglyphstring--set-size">set_size</link></methodname>
- <methodparam><parameter
- role="keyword">new_len</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoglyphstring--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoglyphstring--extents">extents</link></methodname>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoglyphstring--extents-range">extents_range</link></methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter role="keyword">end</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangoglyphstring--get-logical-widths">get_logical_widths</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">embedding_level</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"num_glyphs"</entry>
- <entry>Read</entry>
- <entry>The number of glyphs in the glyph string.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangoglyphstring"><classname>pango.GlyphString</classname></link>
-object contains strings of glyphs with geometry and visual attribute
-information.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-pangoglyphstring">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>pango.GlyphString</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangoglyphstring"><classname>pango.GlyphString</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-pangoglyphstring"><classname>pango.GlyphString</classname></link>
-containing no glyphs.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangoglyphstring--set-size">
- <title>pango.GlyphString.set_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_size</methodname>
- <methodparam><parameter
- role="keyword">new_len</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">new_len</parameter>&nbsp;:</term>
- <listitem><simpara>the new length of the
-string.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_size</methodname>() method resizes the glyph
-string to the length specified by <parameter>new_len</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoglyphstring--copy">
- <title>pango.GlyphString.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangoglyphstring"><classname>pango.GlyphString</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns a <link
-linkend="class-pangoglyphstring"><classname>pango.GlyphString</classname></link>
-that is a copy of the glyph string.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoglyphstring--extents">
- <title>pango.GlyphString.extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>extents</methodname>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">font</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofont"><classname>pango.Font</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing two 4-tuples representing
-the ink and logical extents rectangles of the glyph
-string.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>extents</methodname>() method returns a 2-tuple
-containing two 4-tuples representing the logical and ink extents rectangles
-of the glyph string as rendered in the <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> specified
-by <parameter>font</parameter>. See the <link
-linkend="method-pangofont--get-glyph-extents"><methodname>pango.Font.get_glyph_extents</methodname>()</link>
-for details about the interpretation of the rectangles.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoglyphstring--extents-range">
- <title>pango.GlyphString.extents_range</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>extents_range</methodname>
- <methodparam><parameter
- role="keyword">start</parameter></methodparam>
- <methodparam><parameter
- role="keyword">end</parameter></methodparam>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">start</parameter>&nbsp;:</term>
- <listitem><simpara>start index</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">end</parameter>&nbsp;:</term>
- <listitem><simpara>end index</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">font</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofont"><classname>pango.Font</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing two 4-tuples representing
-the ink and logical extents rectangles of the glyph string
-range.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>extents_range</methodname>() method returns a
-2-tuple containing two 4-tuples representing the logical and ink extents
-rectangles of a range (specified by <parameter>start</parameter> and
-<parameter>end</parameter>) of the glyph string as rendered in the <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> specified
-by <parameter>font</parameter>. The extents are relative to the start of the
-glyph string range (the origin of their coordinate system is at the start of
-the range, not at the start of the entire glyph string).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangoglyphstring--get-logical-widths">
- <title>pango.GlyphString.get_logical_widths</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_logical_widths</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- <methodparam><parameter
- role="keyword">embedding_level</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>the text corresponding to the
-glyphs</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">embedding_level</parameter>&nbsp;:</term>
- <listitem><simpara>the embedding level of the
-string</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a list containing the calculated character
-widths.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_logical_widths</methodname>() method returns
-a list of the screen width of the characters in the specified
-<parameter>text</parameter> that corresponds to the glyph string. When
-multiple characters compose a single cluster, the width of the entire
-cluster is divided equally among the characters.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangolanguage.xml b/docs/reference/pygtk-pangolanguage.xml
deleted file mode 100644
index a51aa717..00000000
--- a/docs/reference/pygtk-pangolanguage.xml
+++ /dev/null
@@ -1,277 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangolanguage">
- <refnamediv>
- <refname>pango.Language</refname>
- <refpurpose>an object that represents a language tag.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.Language</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-pangolanguage">pango.Language</link></methodname>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolanguage--matches">matches</link></methodname>
- <methodparam><parameter
- role="keyword">range_list</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolanguage--to-string">to_string</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis></classsynopsis>
-
- <programlisting>
-<emphasis role="bold">Functions</emphasis>
-
-<methodsynopsis language="python">
- <methodname><link linkend="function-pango--pango-language-from-string">pango.pango_language_from_string</link></methodname>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis><methodsynopsis language="python">
- <methodname><link linkend="function-pango--pango-language-matches">pango.pango_language_matches</link></methodname>
- <methodparam><parameter role="keyword">language</parameter></methodparam>
- <methodparam><parameter
- role="keyword">range_list</parameter></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-object represents a language tag meeting the RFC-3066 standard. The <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-can be retrieved from a <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link> by
-using the <link
-linkend="method-pangocontext--get-language"><methodname>pango.Context.get_language</methodname>()</link>
-method or created using the <link
-linkend="constructor-pangolanguage">pango.Language</link>() constructor.
-Example RFC-3066 language tags include: "en-us", "fr", and
-"sgn-us-ma".</para>
-
- </refsect1>
-
- <refsect1 id="constructor-pangolanguage">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>pango.Language</methodname>
- <methodparam><parameter
- role="keyword">language</parameter>></methodparam>
-</constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">language</parameter>&nbsp;:</term>
- <listitem><simpara>a string representing a language
-tag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This constructor is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>Creates a new <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-object from the RFC-3066 language tag specified by
-<parameter>language</parameter>. This constructor first canonicalizes the
-string in <parameter>language</parameter> by converting it to lowercase,
-mapping '_' to '-', and stripping all characters other than letters and
-'-'.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangolanguage--matches">
- <title>pango.Language.matches</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>matches</methodname>
- <methodparam><parameter
- role="keyword">range_list</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">>range_list</parameter>&nbsp;:</term>
- <listitem><simpara>a list of language ranges, separated by ';'
-characters.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a match was
-found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>matches</methodname>() method returns
-<literal>True</literal> if the language matches one of the language ranges
-in the list specified by <parameter>range_list</parameter>.A language tag is
-considered to match a range in the list if</para>
-
- <itemizedlist>
- <listitem>
- <simpara>the range is '*'</simpara>
- </listitem>
- <listitem>
- <simpara>the range is exactly the same as the tag, or</simpara>
- </listitem>
- <listitem>
- <simpara>the range is a prefix of the tag, and the character after
-the matching portion of the tag is '-'</simpara>
- </listitem>
- </itemizedlist>
-
- <para>each range must either be '*', or a canonicalized RFC-3066
-language range (see the <link
-linkend="constructor-pangolanguage">pango.Language</link>() constructor for
-more information).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolanguage--to-string">
- <title>pango.Language.matches</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>to_string</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the string representation of the language
-tag</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>to_string</methodname>() method returns a string
-representation of the canonicalized language tag. See the <link
-linkend="constructor-pangolanguage">pango.Language</link>() constructor for
-more information.</para>
-
- </refsect2>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-pango--pango-language-from-string">
- <title>pango.pango_language_from_string</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.pango_language_from_string</methodname>
- <methodparam><parameter
- role="keyword">language</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">language</parameter>&nbsp;:</term>
- <listitem><simpara>a string representing a language
- tag</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
- linkend="class-pangolanguage"><classname>pango.Language</classname></link>
- object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is deprecated in PyGTK 2.4 and above. Use the
-<link linkend="constructor-pangolanguage">pango.Language()</link>
-constructor instead.</para>
- </note>
-
- <para>The <function>pango.pango_language_from_string</function>()
-function takes a RFC-3066 format language tag as a string (specified by
-<parameter>language</parameter>) and converts it to a <link
-linkend="class-pangolanguage"><classname>pango.Language</classname></link>
-object. This function first canonicalizes the string by converting it to
-lowercase, mapping '_' to '-', and stripping all characters other than
-letters and '-'.</para>
-
- </refsect2>
-
- <refsect2 id="function-pango--pango-language-matches">
- <title>pango.pango_language_matches</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>pango.pango_language_matches</methodname>
- <methodparam><parameter
- role="keyword"></parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">language</parameter>&nbsp;:</term>
- <listitem><simpara> a language tag (see the <link
- linkend="function-pango--pango-language-from-string"><function>pango.pango_language_from_string</function>()</link>
- function), <literal>None</literal> is allowed and matches nothing
- but '*'</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
- role="keyword">range_list</parameter>&nbsp;:</term>
- <listitem><simpara> a list of language ranges, separated by ';'
- characters. each element must either be '*', or a RFC 3066
- language range canonicalized as by the <link
- linkend="function-pango--pango-language-from-string"><function>pango.pango_language_from_string</function>()</link>
- function.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if a match was
- found.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is deprecated in PyGTK 2.4 and above. Use the
-<link
-linkend="method-pangolanguage--matches"><methodname>matches</methodname>()</link>
-method instead.</para>
- </note>
-
- <para>The <function>pango.pango_language_matches</function>() function
-checks if a language tag matches one of the elements in a list of language
-ranges. A language tag is considered to match a range in the list if the
-range is '*', the range is exactly the tag, or the range is a prefix of the
-tag, and the character after the tag is '-'.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangolayout.xml b/docs/reference/pygtk-pangolayout.xml
deleted file mode 100644
index c6100996..00000000
--- a/docs/reference/pygtk-pangolayout.xml
+++ /dev/null
@@ -1,1312 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-pangolayout">
- <refnamediv>
- <refname>pango.Layout</refname>
- <refpurpose>an object representing a paragraph of text with
-attributes.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.Layout</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-pangolayout">pango.Layout</link></methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-context">get_context</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-attributes">set_attributes</link></methodname>
- <methodparam><parameter
- role="keyword">attrs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-attributes">get_attributes</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-text">set_text</link></methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-text">get_text</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-markup">set_markup</link></methodname>
- <methodparam><parameter
- role="keyword">markup</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-markup-with-accel">set_markup_with_accel</link></methodname>
- <methodparam><parameter
- role="keyword">markup</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_marker</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-font-description">set_font_description</link></methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-width">set_width</link></methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-width">get_width</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-wrap">set_wrap</link></methodname>
- <methodparam><parameter
- role="keyword">wrap</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-wrap">get_wrap</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-indent">set_indent</link></methodname>
- <methodparam><parameter
- role="keyword">indent</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-indent">get_indent</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-spacing">set_spacing</link></methodname>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-spacing">get_spacing</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-justify">set_justify</link></methodname>
- <methodparam><parameter
- role="keyword">justify</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-justify">get_justify</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-alignment">set_alignment</link></methodname>
- <methodparam><parameter
- role="keyword">alignment</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-alignment">get_alignment</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-tabs">set_tabs</link></methodname>
- <methodparam><parameter
- role="keyword">tabs</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-tabs">get_tabs</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--set-single-paragraph-mode">set_single_paragraph_mode</link></methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-single-paragraph-mode">get_single_paragraph_mode</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--context-changed">context_changed</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--index-to-pos">index_to_pos</link></methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-cursor-pos">get_cursor_pos</link></methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--move-cursor-visually">move_cursor_visually</link></methodname>
- <methodparam><parameter
- role="keyword">strong</parameter></methodparam>
- <methodparam><parameter
- role="keyword">old_index</parameter></methodparam>
- <methodparam><parameter
- role="keyword">old_trailing</parameter></methodparam>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--xy-to-index">xy_to_index</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-extents">get_extents</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-pixel-extents">get_pixel_extents</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-size">get_size</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-pixel-size">get_pixel_size</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayout--get-line-count">get_line_count</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangolayout--get-line">get_line</link></methodname>
- <methodparam><parameter role="keyword">line</parameter></methodparam>
- </methodsynopsis>
-<!-- NOT IMPLEMENTED
-<methodsynopsis language="python">
- <methodname><link linkend="method-pangolayout- -get-lines">get_lines</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-END NOT IMPLEMENTED -->
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangolayout--get-iter">get_iter</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pangolayout">pango.Layout</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-object represents a paragraph of text with a <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>, a
-UTF-8 text string and a set of attributes for that string. The set of
-formatted lines can be extracted from the object, the layout can be
-rendered, and conversion between logical character positions within the
-layout's text, and the physical position of the resulting glyphs can be
-made. Also there are a number of attributes that adjust the formatting of
-the layout.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-pangolayout">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>pango.Layout</methodname>
- <methodparam><parameter
- role="keyword">context</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">context</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-object with attributes initialized to the default values of the <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-specified by <parameter>context</parameter>.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangolayout--copy">
- <title>pango.Layout.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> that
-is a copy of the layout</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> that
-is a deep copy-by-value of the layout. The attribute list, tab array, and
-text from the layout are all copied by value.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-context">
- <title>pango.Layout.get_context</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_context</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link> for
-the layout.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_context</methodname>() method returns the
-<link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-used for this layout.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-attributes">
- <title>pango.Layout.set_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_attributes</methodname>
- <methodparam><parameter
- role="keyword">attrs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">attrs</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_attributes</methodname>() method sets the
-<link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-for the layout object to the value specified by
-<parameter>attrs</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-attributes">
- <title>pango.Layout.get_attributes</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_attributes</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_attributes</methodname>() method returns the
-<link
-linkend="class-pangoattrlist"><classname>pango.AttrList</classname></link>
-for the layout, if any.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-text">
- <title>pango.Layout.set_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_text</methodname>
- <methodparam><parameter
- role="keyword">text</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">text</parameter>&nbsp;:</term>
- <listitem><simpara>a UTF8-string</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_text</methodname>() method sets the text of
-the layout to the value specified by <parameter>text</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-text">
- <title>pango.Layout.get_text</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_text</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the text in the layout</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_text</methodname>() method returns the text
-in the layout.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-markup">
- <title>pango.Layout.set_markup</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_markup</methodname>
- <methodparam><parameter
- role="keyword">markup</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">markup</parameter>&nbsp;:</term>
- <listitem><simpara>marked-up text</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_markup</methodname>() method is the same as
-the <link
-linkend="method-pangolayout--set-markup-with-accel"><methodname>set_markup_with_accel</methodname>()</link>
-method but the markup text isn't scanned for accelerators.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-markup-with-accel">
- <title>pango.Layout.set_markup_with_accel</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_markup_with_accel</methodname>
- <methodparam><parameter
- role="keyword">markup</parameter></methodparam>
- <methodparam><parameter
- role="keyword">accel_marker</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">markup</parameter>&nbsp;:</term>
- <listitem><simpara>some marked-up text (see the <link
-linkend="pango-markup-language">Pango Markup Language</link> reference
-page)</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">accel_marker</parameter>&nbsp;:</term>
- <listitem><simpara>marker for accelerators in the
-text</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the accelerator character if
-any</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_markup_with_accel</methodname>() method sets
-the layout text and attribute list from marked-up text to the value
-specified by <parameter>markup_format</parameter> (see the <link
-linkend="pango-markup-language">Pango Markup Language</link> reference
-page). The current text and attribute list of the layout are replaced. If
-<parameter>accel_marker</parameter> is nonzero the markup will be parsed for
-the marker and the character following the first marker becomes the
-accelerator character. For example, if the accelerator marker is an
-underscore, the character after the first underscore will be the accelerator
-character. All characters marked as an accelerator will be displayed with a
-<literal>pango.UNDERLINE_LOW</literal> attribute, and the accelerator
-character will be returned in <parameter>accel_char</parameter>. A literal
-<parameter>accel_marker</parameter> character can be put in the markup by
-using two <parameter>accel_marker</parameter> characters together.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-font-description">
- <title>pango.Layout.set_font_description</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_font_description</methodname>
- <methodparam><parameter
- role="keyword">desc</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">desc</parameter>&nbsp;:</term>
- <listitem><simpara>the new <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>,
-or <literal>None</literal> to unset the current font
-description.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_font_description</methodname>() method set
-the default <link
-linkend="class-pangofontdescription"><classname>pango.FontDescription</classname></link>
-for the layout to the value specified by <parameter>desc</parameter>. If no
-font description is set on the layout, the font description from the
-layout's context is used.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-width">
- <title>pango.Layout.set_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_width</methodname>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the desired width, or -1 to indicate that no
-wrapping should be performed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_width</methodname>() method sets the wrap
-width for the lines of the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> to
-the value specified by <parameter>width</parameter>. If the value of
-<parameter>width</parameter> is -1 no wrapping should be performed.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-width">
- <title>pango.Layout.get_width</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_width</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the width</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_width</methodname>() method returns the
-width at which the lines of the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-should be wrapped.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-wrap">
- <title>pango.Layout.set_wrap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_wrap</methodname>
- <methodparam><parameter
- role="keyword">wrap</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">wrap</parameter>&nbsp;:</term>
- <listitem><simpara>the wrap mode</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_wrap</methodname>() method sets the wrap
-style to the value specified by <parameter>wrap</parameter>. The value of
-wrap must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.WRAP_WORD</literal></term>
- <listitem>
- <simpara>Wrap lines at word boundaries.</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.WRAP_CHAR</literal></term>
- <listitem>
- <simpara>Wrap lines at character boundaries.</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The wrap style is in effect if a width is set on the layout with
-the <link
-linkend="method-pangolayout--set-width"><function>pango.Layout.set_width()</function></link>.
-To turn off wrapping, set the width to -1.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-wrap">
- <title>pango.Layout.get_wrap</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_wrap</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>Active wrap mode.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_wrap</methodname>() method returns the value
-of the wrap mode for the layout. See the <link
-linkend="method-pangolayout--set-wrap"><methodname>set_wrap</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-indent">
- <title>pango.Layout.set_indent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_indent</methodname>
- <methodparam><parameter
- role="keyword">indent</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">indent</parameter>&nbsp;:</term>
- <listitem><simpara>the amount by which to
-indent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_indent</methodname>() method sets the
-indentation of the first line of the layout to the value specified by
-<parameter>indent</parameter>. The value of <parameter>indent</parameter>
-may be negative to provide a hanging indent.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-indent">
- <title>pango.Layout.get_indent</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_indent</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the indent</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_indent</methodname>() method returns the
-amount of indentation of the first line of the layout.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-spacing">
- <title>pango.Layout.set_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_spacing</methodname>
- <methodparam><parameter
- role="keyword">spacing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
- <listitem><simpara>the amount of spacing (in thousandths of a
-device unit)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_spacing</methodname>() method sets the
-amount of spacing between the lines of the layout to the value specified by
-<parameter>spacing</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-spacing">
- <title>pango.Layout.get_spacing</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_spacing</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the spacing (in thousandths of a device
-unit)</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_spacing</methodname>() method returns the
-amount of spacing between the lines of the layout.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-justify">
- <title>pango.Layout.set_justify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_justify</methodname>
- <methodparam><parameter
- role="keyword">justify</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">justify</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the lines in the
-layout should be justified.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_justify</methodname>() method sets the
-justification attribute to the value of <parameter>justify</parameter>. If
-<parameter>justify</parameter> is <literal>True</literal> each complete line
-should be stretched to fill the entire width of the layout. This stretching
-is typically done by adding whitespace, but for some scripts (such as
-Arabic), the justification is done by extending the characters.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-justify">
- <title>pango.Layout.get_justify</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_justify</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if justification will
-be used</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_justify</methodname>() method returns
-<literal>True</literal> if each complete line should be stretched to fill
-the entire width of the layout.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-alignment">
- <title>pango.Layout.set_alignment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_alignment</methodname>
- <methodparam><parameter
- role="keyword">alignment</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">alignment</parameter>&nbsp;:</term>
- <listitem><simpara>the new alignment</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_alignment</methodname>() method sets the
-alignment (how partial lines are positioned within the
-horizontal space available) for the layout to the value specified by
-<parameter>alignment</parameter>. The value of
-<parameter>alignment</parameter> must be one of:</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>pango.ALIGN_LEFT</literal></term>
- <listitem>
- <simpara>Put all available space on the right</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ALIGN_CENTER</literal></term>
- <listitem>
- <simpara>Center the line within the available space</simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>pango.ALIGN_RIGHT</literal></term>
- <listitem>
- <simpara>Put all available space on the left</simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para></para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-alignment">
- <title>pango.Layout.get_alignment</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_alignment</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the alignment value</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_alignment</methodname>() method returns the
-alignment (how partial lines are positioned within the
-horizontal space available) for the layout. See the <link
-linkend="method-pangolayout--set-alignment"><methodname>set_alignment</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-tabs">
- <title>pango.Layout.set_tabs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tabs</methodname>
- <methodparam><parameter
- role="keyword">tabs</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">tabs</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangotabarray"><classname>pango.TabArray</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_tabs</methodname>() method sets the tabs to
-the value specified by <parameter>tabs</parameter> thereby overriding the
-default tabs (every 8 spaces). If <parameter>tabs</parameter> is
-<literal>None</literal>, the default tabs are reinstated.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-tabs">
- <title>pango.Layout.get_tabs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tabs</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a copy of the tabs for this layout, or
-<literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tabs</methodname>() method returns the
-current <link
-linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>
-used by this layout. If no <link
-linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>
-has been set, then the default tabs (every 8 spaces) are in use and
-<literal>None</literal> is returned</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--set-single-paragraph-mode">
- <title>pango.Layout.set_single_paragraph_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_single_paragraph_mode</methodname>
- <methodparam><parameter
- role="keyword">setting</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">setting</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> newlines, etc. are
-not treated as paragraph separators.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_single_paragraph_mode</methodname>() method
-sets the single paragraph mode attribute to the value specified by
-<parameter>setting</parameter>. If <parameter>setting</parameter> is
-<literal>True</literal>, do not treat newlines and similar characters as
-paragraph separators; instead, keep all text in a single paragraph, and
-display a glyph for paragraph separator characters. Used when you want to
-allow editing of newlines on a single text line.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-single-paragraph-mode">
- <title>pango.Layout.get_single_paragraph_mode</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_single_paragraph_mode</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the layout does not
-break paragraphs at paragraph separator characters</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_single_paragraph_mode</methodname>() method
-returns the value set by the <link
-linkend="method-pangolayout--set-single-paragraph-mode"><methodname>set_single_paragraph_mode</methodname>()</link>
-method.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--context-changed">
- <title>pango.Layout.context_changed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>context_changed</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
-
- <para>The <methodname>context_changed</methodname>() method forces
-recomputation of any state in the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> that
-might depend on the layout's context. This method should be called if you
-make changes to the <link
-linkend="class-pangocontext"><classname>pango.Context</classname></link>
-subsequent to creating the layout.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--index-to-pos">
- <title>pango.Layout.index_to_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>index_to_pos</methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>byte index within the
-layout</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 4-tuple representing the grapheme's
-position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>index_to_pos</methodname>() method converts from
-the specified <parameter>index</parameter> within a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> to
-the onscreen position corresponding to the grapheme at that index, which is
-represented as a 4-tuple (x, y, width, height). Note that
-<literal>x</literal> is always the leading edge of the grapheme and
-<literal>x + width</literal> the trailing edge of the grapheme. If the
-directionality of the grapheme is right-to-left, then
-<literal>width</literal> will be negative.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-cursor-pos">
- <title>pango.Layout.get_cursor_pos</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_cursor_pos</methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>the byte index of the
-cursor</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing two 4-tuples representing
-the strong and weak cursor positions</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_cursor_pos</methodname>() method returns a
-2-tuple containing two 4-tuples representing the strong and weak cursor
-positions of the specified <parameter>index</parameter> within a layout. The
-position of each cursor is stored as a zero-width rectangle represented by a
-4-tuple (<literal>x</literal>, <literal>y</literal>,
-<literal>width</literal>, <literal>height</literal>). The strong cursor
-location is the location where characters of the directionality equal to the
-base direction of the layout are inserted. The weak cursor location is the
-location where characters of the directionality opposite to the base
-direction of the layout are inserted.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--move-cursor-visually">
- <title>pango.Layout.move_cursor_visually</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>move_cursor_visually</methodname>
- <methodparam><parameter
- role="keyword">strong</parameter></methodparam>
- <methodparam><parameter
- role="keyword">old_index</parameter></methodparam>
- <methodparam><parameter
- role="keyword">old_trailing</parameter></methodparam>
- <methodparam><parameter
- role="keyword">direction</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">strong</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the moving cursor is
-the strong cursor; otherwise, the weak cursor. The strong cursor is the
-cursor corresponding to text insertion in the base direction for the
-layout.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">old_index</parameter>&nbsp;:</term>
- <listitem><simpara>the byte index of the grapheme for the old
-index</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">old_trailing</parameter>&nbsp;:</term>
- <listitem><simpara>if 0, the cursor was at the trailing edge of
-the grapheme indicated by <parameter>old_index</parameter>, if > 0, the
-cursor was at the leading edge.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">direction</parameter>&nbsp;:</term>
- <listitem><simpara>direction to move cursor. A negative value
-indicates motion to the left.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing: the new cursor byte index
-(a value of -1 indicates that the cursor has been moved off the beginning of
-the layout while a value of G_MAXINT indicates that the cursor has been
-moved off the end of the layout); and, the number of characters to move
-forward (from the new cursor position) to get the position where the cursor
-should be displayed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>move_cursor_visually</methodname>() returns a
-2-tuple containing:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>a new cursor position calculated from an old position
-(specified by <parameter>old_index</parameter>) and the specified
-<parameter>direction</parameter> to move visually</simpara>
- </listitem>
- <listitem>
- <simpara>the number of characters to move forward (from the new
-cursor position) to get the position where the cursor should be displayed.
-This allows distinguishing the position at the beginning of one line from
-the position at the end of the preceding line. the first value is always on
-the line where the cursor should be displayed.</simpara>
- </listitem>
- </itemizedlist>
-
- <para>If <parameter>direction</parameter> is positive, then the new
-strong cursor position will be one position to the right of the old cursor
-position. If <parameter>direction</parameter> is negative then the new
-strong cursor position will be one position to the left of the old cursor
-position.</para>
-
- <para>In the presence of bidirectional text, the correspondence
-between logical and visual order will depend on the direction of the current
-run, and there may be jumps when the cursor is moved off of the end of a
-run.</para>
-
- <para>Motion here is in cursor positions, not in characters, so a
-single call to the <methodname>move_cursor_visually</methodname>() method
-may move the cursor over multiple characters when multiple characters
-combine to form a single grapheme.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--xy-to-index">
- <title>pango.Layout.xy_to_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>xy_to_index</methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X offset (in thousandths of a device unit)
-from the left edge of the layout.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y offset (in thousandths of a device unit)
-from the top edge of the layout</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the calculated byte index
-and an integer indicating where in the grapheme the user clicked (it will
-either be zero, or the number of characters in the grapheme - 0 represents
-the trailing edge of the grapheme).</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>xy_to_index</methodname>() method returns the
-byte index of the character at the specified <parameter>x</parameter> and
-<parameter>y</parameter> position within a layout. If the position is not
-inside the layout, the closest position is chosen (the
-(<parameter>x</parameter>, <parameter>y</parameter>) position will be
-clamped inside the layout).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-extents">
- <title>pango.Layout.get_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_extents</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing two 4-tuples representing
-the as drawn and logical extents rectangles of the layout
-</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_extents</methodname>() method returns a
-2-tuple containing two 4-tuples representing the ink and logical extents
-rectangles of the layout in device units (one pixel =
-<literal>pango.SCALE</literal> device units). Logical extents are usually
-what you want for positioning things. The extents are given in layout
-coordinates which begin at the top left corner of the layout.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-pixel-extents">
- <title>pango.Layout.get_pixel_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixel_extents</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing two 4-tuples representing
-the as drawn (ink) and logical extents rectangles of the
-layout</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixel_extents</methodname>() method returns
-a 2-tuple containing two 4-tuples representing the logical and ink extents
-rectangles of the layout in pixel units. See the <link
-linkend="method-pangolayout--get-extents"><methodname>get_extents</methodname>()</link>
-method for more information. This method just calls the <link
-linkend="method-pangolayout--get-extents"><methodname>get_extents</methodname>()</link>
-and then converts the extents to pixels (one pixel =
-<literal>pango.SCALE</literal> device units).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-size">
- <title>pango.Layout.get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the logical width and
-height of the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_size</methodname>() method returns a 2-tuple
-containing the logical width and height of the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> in
-pango device units (one pixel = <literal>pango.SCALE</literal> device
-units).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-pixel-size">
- <title>pango.Layout.get_pixel_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixel_size</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the logical width height
-of the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_pixel_size</methodname>() method returns a
-2-tuple containing the logical width and height of the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> in
-pixels (one pixel = <literal>pango.SCALE</literal> device units). (The <link
-linkend="method-pangolayout--get-size"><methodname>get_size</methodname>()</link>
-returns the width and height in device units.)</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-line-count">
- <title>pango.Layout.get_line_count</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line_count</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the line count</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_line_count</methodname>() method returns the
-count of lines in the layout.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayout--get-line">
- <title>pango.Layout.get_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line</methodname>
- <methodparam><parameter role="keyword">line</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">line</parameter>&nbsp;:</term>
- <listitem><simpara>the index of a line, which must be between 0 and
-layout.get_line_count() - 1, inclusive.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the requested <link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>,
- or <literal>None</literal> if the index is out of range.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_line</methodname>() method returns the line
-with the index number specified by <parameter>line</parameter> from the
-layout. The returned layout line will become invalid if changes are made to
-the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>.</para>
-
- </refsect2>
-
- <!-- NOT IMPLEMENTED
- <refsect2 id="method-pangolayout- -get-lines">
- <title>pango.Layout.get_lines</title>
-
-<programlisting><methodsynopsis language="python">
- <methodname>get_lines</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <literal>GSList</literal> containing the lines in the layout. This
-points to internal data of the <link linkend="class-pangolayout"><classname>pango.Layout</classname></link> and must be used with
-care. It will become invalid on any change to the layout's
-text or properties.</simpara></listitem>
- </varlistentry>
- </variablelist>
-<para>
-Return the lines of the <parameter>layout</parameter> as a list.
-</para> </refsect2>
-END NOT IMPLEMENTED -->
-
- <refsect2 id="method-pangolayout--get-iter">
- <title>pango.Layout.get_iter</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_iter</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangolayoutiter"><classname>pango.LayoutIter</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.6 and above.</para>
- </note>
-
- <para>The <methodname>get_iter</methodname>() method returns a <link
-linkend="class-pangolayoutiter"><classname>pango.LayoutIter</classname></link>
-object that can be used to iterate over the visual extents of the
-layout.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangolayoutiter.xml b/docs/reference/pygtk-pangolayoutiter.xml
deleted file mode 100644
index 0c5a2862..00000000
--- a/docs/reference/pygtk-pangolayoutiter.xml
+++ /dev/null
@@ -1,473 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-pangolayoutiter">
- <refnamediv>
- <refname>pango.LayoutIter</refname>
- <refpurpose>an object used to iterate over the visual extents of a
-<link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-(new in PyGTK 2.6)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.LayoutIter</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobjectgboxed">gobject.GBoxed</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--free">free</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--next-char">next_char</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--next-cluster">next_cluster</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--next-line">next_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--next-run">next_run</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--at-last-line">at_last_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--get-index">get_index</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--get-baseline">get_baseline</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--get-char-extents">get_char_extents</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--get-cluster-extents">get_cluster_extents</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--get-layout-extents">get_layout_extents</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--get-line-extents">get_line_extents</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--get-run-extents">get_run_extents</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--get-line-yrange">get_line_yrange</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutiter--get-line-yrange">get_line</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
-
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobjectgboxed">gobject.GBoxed</link>
- +-- <link linkend="class-pangolayoutiter">pango.LayoutIter</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangolayoutiter"><classname>pango.LayoutIter</classname></link>
-object can be used to iterate over the visual elements of a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>. A
-<link
-linkend="class-pangolayoutiter"><classname>pango.LayoutIter</classname></link>
-is created using the <link
-linkend="method-pangolayout--get-iter"><methodname>pango.Layout.get_iter</methodname>()</link>
-method.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangolayoutiter--free">
- <title>pango.LayoutIter.free</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>free</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> that
-is a copy of the layout</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <warning>
- <para>This method is deprecated and should not be used since it may
-crash your application.</para>
- </warning>
-
- <para>The <methodname>free</methodname>() method frees the <link
-linkend="class-pangolayoutiter"><classname>pango.LayoutIter</classname></link>
-object.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--next-char">
- <title>pango.LayoutIter.next_char</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>next_char</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the iter was
-moved.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>next_char</methodname>() method returns
-<literal>True</literal> if the <link
-linkend="class-pangolayoutiter"><classname>pango.LayoutIter</classname></link>
-is moved to the next character in visual order. If the iter was already at
-the end of the layout this method returns <literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--next-cluster">
- <title>pango.LayoutIter.next_cluster</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>next_cluster</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the iter was
-moved.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>next_cluster</methodname>() method returns
-<literal>True</literal> if the <link
-linkend="class-pangolayoutiter"><classname>pango.LayoutIter</classname></link>
-is moved to the next cluster in visual order. If the iter was already at the
-end of the layout this method returns <literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--next-line">
- <title>pango.LayoutIter.next_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>next_line</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the iter was
-moved.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>next_line</methodname>() method returns
-<literal>True</literal> if the <link
-linkend="class-pangolayoutiter"><classname>pango.LayoutIter</classname></link>
-is moved to the next line in visual order. If the iter was already at the
-end of the layout this method returns <literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--next-run">
- <title>pango.LayoutIter.next_run</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>next_run</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the iter was
-moved.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>next_run</methodname>() method returns
-<literal>True</literal> if the <link
-linkend="class-pangolayoutiter"><classname>pango.LayoutIter</classname></link>
-is moved to the next run in visual order. If the iter was already at the end
-of the layout this method returns <literal>False</literal>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--at-last-line">
- <title>pango.LayoutIter.at_last_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>at_last_line</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if the iter is in the
-last line.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>at_last_line</methodname>() method returns
-<literal>True</literal> if the <link
-linkend="class-pangolayoutiter"><classname>pango.LayoutIter</classname></link>
-points to a position in the last line of the layout.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--get-index">
- <title>pango.LayoutIter.get_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_index</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the current byte index</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_index</methodname>() method returns the
-current byte index. Note that iterating forward by char moves in visual
-order, not logical order, so indexes may not be sequential. Also, the index
-may be equal to the length of the text in the layout.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--get-baseline">
- <title>pango.LayoutIter.get_baseline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_baseline</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the baseline of the current
-line.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_baseline</methodname>() method returns the y
-position of the current line's baseline, in layout coordinates (origin at
-top left of the entire layout).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--get-char-extents">
- <title>pango.LayoutIter.get_char_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_char_extents</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 4-tuple containing the logical extents of the
-character at the iter position.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_char_extents</methodname>() method returns a
-4-tuple (x, y, width, height) containing the logical extents of the current
-character, in layout coordinates (origin is the top left of the entire
-layout). Only logical extents can sensibly be obtained for characters; ink
-extents make sense only down to the level of clusters.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--get-cluster-extents">
- <title>pango.LayoutIter.get_cluster_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_cluster_extents</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing containing the
-ink and logical extents as 4-tuples.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_cluster_extents</methodname>() method
-returns a 2-tuple containing the ink and logical extents (as 4-tuples: x, y,
-width, height) of the cluster at the iter position.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--get-layout-extents">
- <title>pango.LayoutIter.get_layout_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_layout_extents</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing containing the
-ink and logical extents as 4-tuples.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_layout_extents</methodname>() method returns
-a 2-tuple containing the ink and logical extents (as 4-tuples: x, y, width,
-height) of the layout at the iter position.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--get-line-extents">
- <title>pango.LayoutIter.get_line_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line_extents</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing containing the
-ink and logical extents as 4-tuples.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_line_extents</methodname>() method returns a
-2-tuple containing the ink and logical extents (as 4-tuples: x, y, width,
-height) of the line at the iter position.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--get-run-extents">
- <title>pango.LayoutIter.get_run_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_run_extents</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing containing the
-ink and logical extents as 4-tuples.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_run_extents</methodname>() method returns a
-2-tuple containing the ink and logical extents (as 4-tuples: x, y, width,
-height) of the run at the iter position.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--get-line-yrange">
- <title>pango.LayoutIter.get_line_yrange</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line_yrange</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the start and end of the
-layout line.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_line_yrange</methodname>() method returns a
-2-tuple containing the start and end y positions of the layout line. The
-vertical space in the <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-associated with the iter is devided between the lines in the layout, the
-space belonging to the current line is returned in the 2-tuple. A line's
-range includes the line's logical extents, plus half of the spacing above
-and below the line, if the <link
-linkend="method-pangolayout--set-spacing"><methodname>pango.Layout.set_spacing</methodname>()</link>
-method has been called to set the layout spacing. The y positions are in layout
-coordinates (origin at top left of the entire layout).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutiter--get-line">
- <title>pango.LayoutIter.get_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_line</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>
-containing the current line.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_line</methodname>() method returns a <link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>
-containing the current line.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangolayoutline.xml b/docs/reference/pygtk-pangolayoutline.xml
deleted file mode 100644
index d6efe553..00000000
--- a/docs/reference/pygtk-pangolayoutline.xml
+++ /dev/null
@@ -1,262 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<refentry id="class-pangolayoutline">
- <refnamediv>
- <refname>pango.LayoutLine</refname>
- <refpurpose>a line in a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-(new in PyGTK 2.8)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.LayoutLine</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobjectgboxed">gobject.GBoxed</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutline--get-extents">get_extents</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutline--get-pixel-extents">get_pixel_extents</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutline--index-to-x">index_to_x</link></methodname>
- <methodparam><parameter role="keyword">index</parameter></methodparam>
- <methodparam><parameter role="keyword">trailing</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangolayoutline--x-to-index">x_to_index</link></methodname>
- <methodparam><parameter role="keyword">x_pos</parameter></methodparam>
- </methodsynopsis>
-
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobjectgboxed">gobject.GBoxed</link>
- +-- <link linkend="class-pangolayoutline">pango.LayoutLine</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"is_paragraph_start"</entry>
- <entry>Read</entry>
- <entry><literal>True</literal> if this is the first line of
-the paragraph</entry>
- </row>
-
- <row valign="top">
- <entry>"length"</entry>
- <entry>Read</entry>
- <entry>the length of the line in bytes</entry>
- </row>
-
- <row valign="top">
- <entry>"resolved_dir"</entry>
- <entry>Read</entry>
- <entry>the resolved direction of line</entry>
- </row>
-
- <row valign="top">
- <entry>"runs"</entry>
- <entry>Read</entry>
- <entry>a list containing the runs of the line in visual
-order.</entry>
- </row>
-
- <row valign="top">
- <entry>"start_index"</entry>
- <entry>Read</entry>
- <entry>the start of the line as byte index into the
-layout.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>
-object represents one of the lines resulting from laying out a paragraph via
-<link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link>. <link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>
-objects are obtained by calling the <link
-linkend="method-pangolayout--get-line"><methodname>pango.Layout.get_line</methodname>()</link>
-method or the <link
-linkend="method-pangolayoutiter--get-line"><methodname>pango.LayoutIter.get_line</methodname>()</link>
-method. <link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>
-objects are only valid until the text, attributes, or settings of the parent
-<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-are modified.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangolayoutline--get-extents">
- <title>pango.LayoutLine.get_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_extents</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing 4-tuples representing
-the rectangles for the logical and ink extents in Pango
-units.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_extents</methodname>() method returns the
-logical and ink extents rectangles of the layout line in a 2-tuple
-containing two 4-tuples which represent the rectangles. See the
-documentation for the <link
-linkend="method-pangofont--get-glyph-extents"><methodname>pango.Font.get_glyph_extents</methodname>()</link>
-method for details about the interpretation of the rectangles. The return
-extents are in Pango units (1 device unit = pango.SCALE pango units).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutline--get-pixel-extents">
- <title>pango.LayoutLine.get_pixel_extents</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_pixel_extents</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing 4-tuples representing
-the rectangles for the logical and ink extents in device
-units.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_pixel_extents</methodname>() method returns
-the logical and ink extents rectangles of the layout line in a 2-tuple
-containing two 4-tuples which represent the rectangles. See the
-documentation for the <link
-linkend="method-pangofont--get-glyph-extents"><methodname>pango.Font.get_glyph_extents</methodname>()</link>
-method for details about the interpretation of the rectangles. The return
-extents are in device units (1 device unit = pango.SCALE pango
-units).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutline--index-to-x">
- <title>pango.LayoutLine.index_to_x</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>index_to_x</methodname>
- <methodparam><parameter
- role="keyword">index</parameter></methodparam>
- <methodparam><parameter
- role="keyword">trailing</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">index</parameter>&nbsp;:</term>
- <listitem><simpara>the byte offset of a grapheme
-within the layout</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">trailing</parameter>&nbsp;:</term>
- <listitem><simpara>an integer indicating the edge of the grapheme
-to retrieve the position of. If 0, the trailing edge of the grapheme,
-if > 0, the leading edge of the grapheme.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the X position in Pango units</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>index_to_x</methodname>() method returns the X
-position (in Pango units) of the grapheme at the byte offset specified by
-<parameter>index</parameter> and edge specified by
-<parameter>trailing</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangolayoutline--x-to-index">
- <title>pango.LayoutLine.x_to_index</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>x_to_index</methodname>
- <methodparam><parameter
- role="keyword">x_pos</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x_pos</parameter>&nbsp;:</term>
- <listitem><simpara>the x offset (in Pango units) from the left
-edge of the line.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 3-tuple containing a boolean indicating if the
-<parameter>x_pos</parameter> is inside the line, the byte offset of the
-grapheme and the location in the grapheme.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>x_to_index</methodname>() method returns a
-3-tuple containing a boolean that is <literal>True</literal> if x_pos is
-inside the line, the location inside the grapheme - either zero, or the
-number of characters in the grapheme. 0 represents the trailing edge of the
-grapheme.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangorenderer.xml b/docs/reference/pygtk-pangorenderer.xml
deleted file mode 100644
index 23a2253f..00000000
--- a/docs/reference/pygtk-pangorenderer.xml
+++ /dev/null
@@ -1,598 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangorenderer">
- <refnamediv>
- <refname>pango.Renderer</refname>
- <refpurpose>a base class for pango rendering (new in
-PyGTK 2.8)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.Renderer</classname></ooclass>
- <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangorenderer--draw-layout">draw_layout</link></methodname>
- <methodparam><parameter role="keyword">layout</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangorenderer--draw-layout-line">draw_layout_line</link></methodname>
- <methodparam><parameter role="keyword">line</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangorenderer--draw-glyphs">draw_glyphs</link></methodname>
- <methodparam><parameter role="keyword">font</parameter></methodparam>
- <methodparam><parameter role="keyword">glyphs</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangorenderer--draw-rectangle">draw_rectangle</link></methodname>
- <methodparam><parameter role="keyword">part</parameter></methodparam>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangorenderer--draw-error-underline">draw_error_underline</link></methodname>
- <methodparam><parameter role="keyword">x</parameter></methodparam>
- <methodparam><parameter role="keyword">y</parameter></methodparam>
- <methodparam><parameter role="keyword">width</parameter></methodparam>
- <methodparam><parameter role="keyword">height</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangorenderer--draw-trapezoid">draw_trapezoid</link></methodname>
- <methodparam><parameter role="keyword">part</parameter></methodparam>
- <methodparam><parameter role="keyword">y1_</parameter></methodparam>
- <methodparam><parameter role="keyword">x11</parameter></methodparam>
- <methodparam><parameter role="keyword">x21</parameter></methodparam>
- <methodparam><parameter role="keyword">y2</parameter></methodparam>
- <methodparam><parameter role="keyword">x12</parameter></methodparam>
- <methodparam><parameter role="keyword">x22</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangorenderer--activate">activate</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangorenderer--deactivate">deactivate</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangorenderer--part-changed">part_changed</link></methodname>
- <methodparam><parameter role="keyword">part</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangorenderer--set-color">set_color</link></methodname>
- <methodparam><parameter role="keyword">part</parameter></methodparam>
- <methodparam><parameter role="keyword">color</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-pangorenderer--get-color">get_color</link></methodname>
- <methodparam><parameter role="keyword">part</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pangorenderer">pango.Renderer</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para><link
-linkend="class-pangorenderer"><classname>pango.Renderer</classname></link>
-is a base class that contains the necessary logic for rendering a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link> or
-<link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>. By
-subclassing <link
-linkend="class-pangorenderer"><classname>pango.Renderer</classname></link>
-and overriding operations such as <link
-linkend="method-pangorenderer--draw-glyphs"><methodname>draw_glyphs</methodname>()</link>
-and <link
-linkend="method-pangorenderer--draw-rectangle"><methodname>draw_rectangle</methodname>()</link>,
-renderers for particular font backends and destinations can be
-created.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangorenderer--draw-layout">
- <title>pango.Renderer.draw_layout</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_layout</methodname>
- <methodparam><parameter
- role="keyword">layout</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">layout</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolayout"><classname>pango.Layout</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x position of left edge of baseline,
-in user space coordinates in Pango units.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y position of left edge of baseline,
-in user space coordinates in Pango units.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>draw_layout</methodname>() method draws the
-<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
-s[ecified by <parameter>layout</parameter> at the position specified by
-<parameter>x</parameter> and <parameter>y</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangorenderer--draw-layout-line">
- <title>pango.Renderer.draw_layout_line</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_layout_line</methodname>
- <methodparam><parameter
- role="keyword">line</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">line</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x position of left edge of baseline,
-in user space coordinates in Pango units.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y position of left edge of baseline,
-in user space coordinates in Pango units.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>draw_layout_line</methodname>() method draws the
-<link
-linkend="class-pangolayoutline"><classname>pango.LayoutLine</classname></link>
-specified by <parameter>line</parameter> at the position specified by
-<parameter>x</parameter> and <parameter>y</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangorenderer--draw-glyphs">
- <title>pango.Renderer.draw_glyphs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_glyphs</methodname>
- <methodparam><parameter
- role="keyword">font</parameter></methodparam>
- <methodparam><parameter
- role="keyword">glyphs</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">font</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangofont"><classname>pango.Font</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">glyphs</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangoglyphstring"><classname>pango.GlyphString</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x position of left edge of baseline,
-in user space coordinates in Pango units.</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y position of left edge of baseline,
-in user space coordinates in Pango units.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>draw_glyphs</methodname>() method draws the
-<link
-linkend="class-pangoglyphstring"><classname>pango.GlyphString</classname></link>
-specified by <parameter>glyphs</parameter> using the <link
-linkend="class-pangofont"><classname>pango.Font</classname></link> specified
-by <parameter>font</parameter> at the position specified by
-<parameter>x</parameter> and <parameter>y</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangorenderer--draw-rectangle">
- <title>pango.Renderer.draw_rectangle</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_rectangle</methodname>
- <methodparam><parameter
- role="keyword">part</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">part</parameter>&nbsp;:</term>
- <listitem><simpara>the part where the rectangle is to be
-rendered</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the x position at which to draw rectangle,
-in user space coordinates in Pango units</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the y position at which to draw rectangle,
-in user space coordinates in Pango units</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of rectangle in Pango units
-in user space coordinates</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of rectangle in Pango units
-in user space coordinates</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>draw_rectangle</methodname>() method draws an
-axis-aligned rectangle with the size specified by
-<parameter>width</parameter> and <parameter>height</parameter> at the
-position specified by <parameter>x</parameter> and <parameter>y</parameter>,
-all in user space coordinates. The rectangle will be drawn in the rendering
-part (see the <xref linkend="pango-render-part-constants"
-endterm="pango-render-part-constants-title"></xref>) specified by
-<parameter>part</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangorenderer--draw-error-underline">
- <title>pango.Renderer.draw_error_underline</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_error_underline</methodname>
- <methodparam><parameter
- role="keyword">x</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y</parameter></methodparam>
- <methodparam><parameter
- role="keyword">width</parameter></methodparam>
- <methodparam><parameter
- role="keyword">height</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">x</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the underline, in Pango units
-in the user coordinate system</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the underline, in Pango units
-in the user coordinate system</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">width</parameter>&nbsp;:</term>
- <listitem><simpara>the width of the underline, in Pango units
-in the user coordinate system</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">height</parameter>&nbsp;:</term>
- <listitem><simpara>the height of the underline, in Pango units
-in the user coordinate system</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>draw_error_underline</methodname>() method draws a
-squiggly line that approximately covers the rectangle specified by
-<parameter>x</parameter>, <parameter>y</parameter>,
-<parameter>width</parameter> and <parameter>height</parameter> in the style
-of an underline used to indicate a spelling error. (The width of the
-underline is rounded to an integer number of up/down segments and the
-resulting rectangle is centered in the original rectangle).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangorenderer--draw-trapezoid">
- <title>pango.Renderer.draw_trapezoid</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>draw_trapezoid</methodname>
- <methodparam><parameter
- role="keyword">part</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y1_</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x11</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x21</parameter></methodparam>
- <methodparam><parameter
- role="keyword">y2</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x12</parameter></methodparam>
- <methodparam><parameter
- role="keyword">x22</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">part</parameter>&nbsp;:</term>
- <listitem><simpara>where the trapezoid is to be
-rendered</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y1_</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the top of the
-trapezoid</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x11</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the left end of the top of
-the trapezoid</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x21</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the right end of the top of
-the trapezoid</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">y2</parameter>&nbsp;:</term>
- <listitem><simpara>the Y coordinate of the bottom of the
-trapezoid</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x12</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the left end of the bottom of
-the trapezoid</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">x22</parameter>&nbsp;:</term>
- <listitem><simpara>the X coordinate of the left end of the bottom of
-the trapezoid</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>draw_trapezoid</methodname>() method draws a
-trapezoid with the parallel sides aligned with the X axis using the
-coordinates specified by <parameter>y1_</parameter>,
-<parameter>x11</parameter>, <parameter>x21</parameter>,
-<parameter>y2</parameter>, <parameter>x12</parameter>,
-<parameter>x22</parameter>. The coordinates are in device space. The
-trapezoid is rendered in the part specified by <parameter>part</parameter>
-which must be one of the <xref linkend="pango-render-part-constants"
-endterm="pango-render-part-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangorenderer--activate">
- <title>pango.Renderer.activate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>activate</methodname>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>activate</methodname>() method does initial
-setup before performing the rendering operations on renderer. The <link
-linkend="method-pangorenderer--deactivate"><methodname>deactivate</methodname>()</link>
-method should be called when drawing is complete. Calls to the <link
-linkend="method-pangorenderer--draw-layout"><methodname>draw_layout</methodname>()</link>
-method automatically activate the layout before drawing on it. Calls to the
-<link
-linkend="method-pangorenderer--activate"><methodname>activate</methodname>()</link>
-and <link
-linkend="method-pangorenderer--deactivate"><methodname>deactivate</methodname>()</link>
-methods can be nested and the renderer will only be initialized and
-deinitialized once.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangorenderer--deactivate">
- <title>pango.Renderer.deactivate</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>deactivate</methodname>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>deactivate</methodname>() method cleans up after
-rendering operations are completed. See the <link
-linkend="method-pangorenderer--activate"><methodname>activate</methodname>()</link>
-method for more information.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangorenderer--part-changed">
- <title>pango.Renderer.part_changed</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>part_changed</methodname>
- <methodparam><parameter
- role="keyword">part</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">part</parameter>&nbsp;:</term>
- <listitem><simpara>the part that has its rendering
-changed.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>part_changed</methodname>() method informs Pango
-that the way that the renderering is done for the part specified by
-<parameter>part</parameter> has changed in a way that would prevent multiple
-pieces being joined together into one drawing
-call. <parameter>part</parameter> must be one of the <xref
-linkend="pango-render-part-constants"
-endterm="pango-render-part-constants-title"></xref>. For instance, if a
-subclass of <link
-linkend="class-pangorenderer"><classname>pango.Renderer</classname></link>
-was to add a stipple option for drawing underlines, it needs to call:</para>
-
- <programlisting>
-renderer.part_changed(pango.RENDER_PART_UNDERLINE)
-</programlisting>
-
- <para>when the stipple changes or underlines with different stipples
-might be joined together. Pango automatically calls this for changes to
-colors. (See the <link
-linkend="method-pangorenderer--set-color"><methodname>set_color</methodname>()</link>
-method for more information).</para>
-
- </refsect2>
-
- <refsect2 id="method-pangorenderer--set-color">
- <title>pango.Renderer.set_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_color</methodname>
- <methodparam><parameter
- role="keyword">part</parameter></methodparam>
- <methodparam><parameter
- role="keyword">color</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">part</parameter>&nbsp;:</term>
- <listitem><simpara>the part to change the color
- of</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">color</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>set_color</methodname>() method sets the <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link>
-specified by <parameter>color</parameter> as the color for the part
-specified by <parameter>part</parameter>. <parameter>part</parameter> must
-be one of the <xref linkend="pango-render-part-constants"
-endterm="pango-render-part-constants-title"></xref>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangorenderer--get-color">
- <title>pango.Renderer.get_color</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_color</methodname>
- <methodparam><parameter
- role="keyword">part</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">part</parameter>&nbsp;:</term>
- <listitem><simpara>a part</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <term><parameter
-role="keyword"></parameter>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link> or
-<parameter>None</parameter></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.8 and above.</para>
- </note>
-
- <para>The <methodname>get_color</methodname>() method returns the
-current rendering <link
-linkend="class-pangocolor"><classname>pango.Color</classname></link> for the
-part specified by <parameter>part</parameter>. <parameter>part</parameter>
-must be one of the <xref linkend="pango-render-part-constants"
-endterm="pango-render-part-constants-title"></xref>. If
-<literal>None</literal> is returned, the color has not been set and should
-be inherited from the environment.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pangotabarray.xml b/docs/reference/pygtk-pangotabarray.xml
deleted file mode 100644
index b4f4ee72..00000000
--- a/docs/reference/pygtk-pangotabarray.xml
+++ /dev/null
@@ -1,290 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pangotabarray">
- <refnamediv>
- <refname>pango.TabArray</refname>
- <refpurpose>an object containing an array of tab stops.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>pango.TabArray</classname></ooclass>
- <ooclass><classname>gobject.GBoxed</classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-pangotabarray">pango.TabArray</link></methodname>
- <methodparam><parameter
- role="keyword">initial_size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">positions_in_pixels</parameter></methodparam>
- </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangotabarray--copy">copy</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangotabarray--get-size">get_size</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangotabarray--resize">resize</link></methodname>
- <methodparam><parameter
- role="keyword">new_size</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangotabarray--set-tab">set_tab</link></methodname>
- <methodparam><parameter
- role="keyword">tab_index</parameter></methodparam>
- <methodparam><parameter
- role="keyword">alignment</parameter></methodparam>
- <methodparam><parameter
- role="keyword">location</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangotabarray--get-tab">get_tab</link></methodname>
- <methodparam><parameter
- role="keyword">tab_index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangotabarray--get-tabs">get_tabs</link></methodname>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link
-linkend="method-pangotabarray--get-positions-in-pixels">get_positions_in_pixels</link></methodname>
- <methodparam></methodparam> </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>
-object contains an array of tab stops. Each tab stop has an alignment and a
-position.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-pangotabarray">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>pango.TabArray</methodname>
- <methodparam><parameter
- role="keyword">initial_size</parameter></methodparam>
- <methodparam><parameter
- role="keyword">positions_in_pixels</parameter></methodparam>
- </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">initial_size</parameter>&nbsp;:</term>
- <listitem><simpara>Initial number of tab stops to allocate, can be
-0</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">positions_in_pixels</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal> the tab positions are
-in pixel units</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
-linkend="class-pangotabarray"><classname>pango.TabArray</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>
-object with the number of tab stops specified by
-<parameter>initial_size</parameter>. If
-<parameter>positions_in_pixels</parameter> is <literal>True</literal>, the
-tab stop positions are specified in pixel units otherwise in pango units
-(one pixel = <literal>pango.SCALE</literal> pango units). All tab stops are
-initially at position 0.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-pangotabarray--copy">
- <title>pango.TabArray.copy</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>copy</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>copy</methodname>() method returns a new <link
-linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>
-that is copy of this <link
-linkend="class-pangotabarray"><classname>pango.TabArray</classname></link>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangotabarray--get-size">
- <title>pango.TabArray.get_size</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_size</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the number of tab stops in the
-array.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_size</methodname>() method returns the
-number of tab stops in the tab array.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangotabarray--resize">
- <title>pango.TabArray.resize</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>resize</methodname>
- <methodparam><parameter
- role="keyword">new_size</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">new_size</parameter>&nbsp;:</term>
- <listitem><simpara>the new size of the array</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>resize</methodname>() method sets the size of
-the tab array to the value specified by <parameter>new_size</parameter>. You
-must subsequently initialize any tabs that were added to the array.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangotabarray--set-tab">
- <title>pango.TabArray.set_tab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>set_tab</methodname>
- <methodparam><parameter
- role="keyword">tab_index</parameter></methodparam>
- <methodparam><parameter
- role="keyword">alignment</parameter></methodparam>
- <methodparam><parameter
- role="keyword">location</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">tab_index</parameter>&nbsp;:</term>
- <listitem><simpara>the index of a tab stop</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter
-role="keyword">alignment</parameter>&nbsp;:</term>
- <listitem><simpara>the tab alignment</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">location</parameter>&nbsp;:</term>
- <listitem><simpara>the tab location in pango
-units</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>set_tab</methodname>() method sets the specified
-<parameter>alignment</parameter> and <parameter>location</parameter> of the
-tab stop specified by <parameter>tab_index</parameter>. The value of
-<parameter>alignment</parameter> must always be
-<literal>pango.TAB_LEFT</literal> in the current implementation.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangotabarray--get-tab">
- <title>pango.TabArray.get_tab</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tab</methodname>
- <methodparam><parameter
- role="keyword">tab_index</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter
-role="keyword">tab_index</parameter>&nbsp;:</term>
- <listitem><simpara>the tab stop index</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a 2-tuple containing the tab alignment and
-position</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tab</methodname>() method returns a 2-tuple
-containing the alignment and position of the tab stop specified by
-<parameter>tab_index</parameter>.</para>
-
- </refsect2>
-
- <refsect2 id="method-pangotabarray--get-tabs">
- <title>pango.TabArray.get_tabs</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_tabs</methodname>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a tuple containing a list of 2-tuples (each
-holding the alignment and position of a tab stop).</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_tabs</methodname>() method returns a tuple
-containing a list of 2-tuples (each holding the alignment and position of a
-tab stop)</para>
-
- </refsect2>
-
- <refsect2 id="method-pangotabarray--get-positions-in-pixels">
- <title>pango.TabArray.get_positions_in_pixels</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>get_positions_in_pixels</methodname>
- <methodparam></methodparam> </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if tab stop positions
-are specified in pixels</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>get_positions_in_pixels</methodname>() method
-returns <parameter>True</parameter> if the tab positions are specified in
-pixels and <literal>False</literal> if they are in pango units.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pygtkgenericcellrenderer.xml b/docs/reference/pygtk-pygtkgenericcellrenderer.xml
deleted file mode 100644
index 9ea092e0..00000000
--- a/docs/reference/pygtk-pygtkgenericcellrenderer.xml
+++ /dev/null
@@ -1,112 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pygtkgenericcellrenderer">
- <refnamediv>
- <refname>gtk.GenericCellRenderer</refname>
- <refpurpose>a TreeView cell renderer that helps create cell renderers
-in Python</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.GenericCellRenderer</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtkcellrenderer">gtk.CellRenderer</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkgenericcellrenderer">gtk.GenericCellRenderer</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-gtkobject">gtk.Object</link>
- +-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
- +-- <link linkend="class-pygtkgenericcellrenderer">gtk.GenericCellRenderer</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-pygtkgenericcellrenderer"><classname>gtk.GenericCellRenderer</classname></link>
-helps in the creation of <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> cell
-renderers in Python. The <link
-linkend="class-pygtkgenericcellrenderer"><classname>gtk.GenericCellRenderer</classname></link>
-is subclassed to provide a new cell renderer that provides cell renderer
-behavior using methods with predefined names that are called by the <link
-linkend="class-pygtkgenericcellrenderer"><classname>gtk.GenericCellRenderer</classname></link>
-methods as required to provide the various cell renderer operations. The
-methods that need to be defined by the programmer in Python are:</para>
-
- <methodsynopsis language="python">
- <methodname>on_get_size</methodname>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>cell_area</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_render</methodname>
- <methodparam><parameter>window</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>background_area</parameter></methodparam>
- <methodparam><parameter>cell_area</parameter></methodparam>
- <methodparam><parameter>expose_area</parameter></methodparam>
- <methodparam><parameter>flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_activate</methodname>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>background_area</parameter></methodparam>
- <methodparam><parameter>cell_area</parameter></methodparam>
- <methodparam><parameter>flags</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_start_editing</methodname>
- <methodparam><parameter>event</parameter></methodparam>
- <methodparam><parameter>widget</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- <methodparam><parameter>background_area</parameter></methodparam>
- <methodparam><parameter>cell_area</parameter></methodparam>
- <methodparam><parameter>flags</parameter></methodparam>
- </methodsynopsis>
-
- <para>See the <link
-linkend="class-gtkcellrenderer"><classname>gtk.CellRenderer</classname></link>
-description for details of the above methods.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkgenericcellrenderer">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.GenericCellRenderer</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pygtkgenericcellrenderer"><classname>gtk.GenericCellRenderer</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-pygtkgenericcellrenderer"><classname>gtk.GenericCellRenderer</classname></link></para>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pygtkgenerictreemodel.xml b/docs/reference/pygtk-pygtkgenerictreemodel.xml
deleted file mode 100644
index 54677206..00000000
--- a/docs/reference/pygtk-pygtkgenerictreemodel.xml
+++ /dev/null
@@ -1,279 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pygtkgenerictreemodel">
- <refnamediv>
- <refname>gtk.GenericTreeModel</refname>
- <refpurpose>a TreeView model that helps create tree models in
-Python</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.GenericTreeModel</classname></ooclass>
- <ooclass><classname><link
-linkend="class-gobject">gobject.GObject</link></classname></ooclass>
- <ooclass><classname><link
-linkend="class-gtktreemodel">gtk.TreeModel</link></classname></ooclass>
- <constructorsynopsis language="python">
- <methodname><link
-linkend="constructor-gtkgenerictreemodel">gtk.GenericTreeModel</link></methodname>
- <methodparam></methodparam> </constructorsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkgenerictreemodel--invalidate-iters">invalidate_iters</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkgenerictreemodel--iter-is-valid">iter_is_valid</link></methodname>
- <methodparam><parameter role="keyword">iter</parameter></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
- +-- <link linkend="class-pygtkgenerictreemodel">gtk.GenericTreeModel</link> (implements <link linkend="class-gtktreemodel">gtk.TreeModel</link>)
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Properties</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"leak-references"</entry>
- <entry>Read-Write</entry>
-
- <entry>If <literal>True</literal>, creating a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> will
-bump the reference count of the object used as the internal row
-reference. This may cause a memory leak but will prevent problems with
-objects being destroyed while still in use in a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>. Set
-this to <literal>False</literal> only if the model saves the objects used in
-tree iters.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>The <link
-linkend="class-pygtkgenerictreemodel"><classname>gtk.GenericTreeModel</classname></link>
-helps in the creation of <link
-linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link> tree
-models in Python. The <link
-linkend="class-pygtkgenerictreemodel"><classname>gtk.GenericTreeModel</classname></link>
-is subclassed to provide a new tree model that provides the tree model
-behavior using methods with predefined names that are called by the <link
-linkend="class-pygtkgenerictreemodel"><classname>gtk.GenericTreeModel</classname></link>
-methods as required to provide the various tree model operations. The
-methods that need to be defined by the programmer in Python are:</para>
-
- <methodsynopsis language="python">
- <methodname>on_get_flags</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_get_n_columns</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_get_column_type</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>index</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_get_iter</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>path</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_get_path</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>rowref</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_get_value</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>rowref</parameter></methodparam>
- <methodparam><parameter>column</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_iter_next</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>rowref</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_iter_children</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>parent</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_iter_has_child</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>rowref</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_iter_n_children</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>rowref</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_iter_nth_child</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>parent</parameter></methodparam>
- <methodparam><parameter>n</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname>on_iter_parent</methodname>
- <methodparam><parameter>self</parameter></methodparam>
- <methodparam><parameter>child</parameter></methodparam>
- </methodsynopsis>
-
- <para>See the <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-description for details of the above methods.</para>
-
- <para>In PyGTK 2.4 and above the <link
-linkend="method-gtkgenerictreemodel--invalidate-iters"><methodname>invalidate_iters</methodname>()</link>
-and <link
-linkend="method-gtkgenerictreemodel--iter-is-valid"><methodname>iter_is_valid</methodname>()</link>
-methods are available to help manage the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-objects and their Python object references. These are particularly useful
-when the "leak-references" property is set to
-<literal>False</literal>.</para>
-
- <para>The tree models derived from <link
-linkend="class-pygtkgenerictreemodel"><classname>gtk.GenericTreeModel</classname></link>
-are protected from problems with out of date <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-objects because <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-objects are automatically checked for validity with the tree model.</para>
-
- <para>If a custom tree model doesn't support persistent iters
-(i.e. <literal>gtk.TREE_MODEL_ITERS_PERSIST</literal> is not set in the
-return from the <link
-linkend="method-gtktreemodel--get-flags"><methodname>gtk.TreeModel.get_flags</methodname>()</link>
-method), it can call the <link
-linkend="method-gtkgenerictreemodel--invalidate-iters"><methodname>invalidate_iters</methodname>()</link>
-method to invalidate all its outstanding <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-objects when it changes the model (e.g. after inserting a new row). The tree
-model can also dispose of any Python objects that it passed references to
-<link linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-objects after calling the <link
-linkend="method-gtkgenerictreemodel--invalidate-iters"><methodname>invalidate_iters</methodname>()</link>
-method.</para>
-
- <para>Applications can use the <link
-linkend="method-gtkgenerictreemodel--iter-is-valid"><methodname>iter_is_valid</methodname>()</link>
-method to determine if a <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link> is
-still valid for the custom tree model.</para>
-
- </refsect1>
-
- <refsect1 id="constructor-gtkgenerictreemodel">
- <title>Constructor</title>
-
- <programlisting><constructorsynopsis language="python">
- <methodname>gtk.GenericTreeModel</methodname>
- <methodparam></methodparam> </constructorsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a new <link
-linkend="class-pygtkgenerictreemodel"><classname>gtk.GenericTreeModel</classname></link>
-object</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>Creates a new <link
-linkend="class-pygtkgenerictreemodel"><classname>gtk.GenericTreeModel</classname></link>
-object</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtkgenerictreemodel--invalidate-iters">
- <title>gtk.GenericTreeModel.invalidate_iters</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>invalidate_iters</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>invalidate_iters</methodname>() method
-invalidates all the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-objects for the custom tree model.</para>
-
- </refsect2>
-
- <refsect2 id="method-gtkgenerictreemodel--iter-is-valid">
- <title>gtk.GenericTreeModel.iter_is_valid</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iter_is_valid</methodname>
- <methodparam><parameter
- role="keyword">iter</parameter></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">iter</parameter>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara><literal>True</literal> if
- <parameter>iter</parameter> is valid for the tree model;
- otherwise, <literal>False</literal> is
- returned.</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This method is available in PyGTK 2.4 and above.</para>
- </note>
-
- <para>The <methodname>iter_is_valid</methodname>() method returns
-<literal>True</literal> if the <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-specified by <parameter>iter</parameter> is valid for the custom tree
-model.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pygtktreemodelrow.xml b/docs/reference/pygtk-pygtktreemodelrow.xml
deleted file mode 100644
index b44b54b7..00000000
--- a/docs/reference/pygtk-pygtktreemodelrow.xml
+++ /dev/null
@@ -1,189 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pygtktreemodelrow">
- <refnamediv>
- <refname>gtk.TreeModelRow</refname>
- <refpurpose>an object representing a row in a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link></refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeModelRow</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelrow--iterchildren">iterchildren</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GBoxed</link>
- +-- <link linkend="class-gtkwidget">gtk.TreeModelRow</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Attributes</title>
-
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <?dbhtml cellpadding="5"?>
- <colspec column="1" colwidth="1in"/>
- <colspec column="2" colwidth="1in"/>
- <colspec column="3" colwidth="4in"/>
- <tbody>
-
- <row valign="top">
- <entry>"next"</entry>
- <entry>Read</entry>
-
- <entry>The next <link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
-or <literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"parent"</entry>
- <entry>Read</entry>
-
- <entry>The parent <link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
- of this row or <literal>None</literal></entry>
- </row>
-
- <row valign="top">
- <entry>"model"</entry>
- <entry>Read</entry>
-
- <entry>The <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-that the row is part of.</entry>
- </row>
-
- <row valign="top">
- <entry>"path"</entry>
- <entry>Read</entry>
- <entry>The tree path of the row</entry>
- </row>
-
- <row valign="top">
- <entry>"iter"</entry>
- <entry>Read</entry>
-
- <entry>A <link
-linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
-pointing at the row.</entry>
- </row>
-
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
-object represents a row in a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>. A
-<link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
-is created by taking the mapping of a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>. For
-example:</para>
-
- <programlisting>
- treemodelrow = liststore[0]
- treemodelrow = liststore[(0,)]
- treemodelrow = liststore['0']
-</programlisting>
-
- <para>all create a <link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
-for the first row in <parameter>liststore</parameter>. The <link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
-implements some of the Python sequence protocol that makes the row behave
-like a sequence of objects. Specifically a tree model row has the capability
-of:</para>
-
- <itemizedlist>
- <listitem>
- <simpara>getting and setting column values,</simpara>
- </listitem>
- <listitem>
- <simpara>returning a tuple or list containing the column values,
-and</simpara>
- </listitem>
- <listitem>
- <simpara>getting the number of values in the row i.e. the number of
-columns</simpara>
- </listitem>
- </itemizedlist>
-
- <para>For example to get and set the value in the second column of a
-row, you could do the following:</para>
-
- <programlisting>
- value = treemodelrow[1]
- treemodelrow[1] = value
-</programlisting>
-
- <para>You can use the Python <function>len</function>() function to get
-the number of columns in the row and you can retrieve all the column values
-as a list (tuple) using the Python <function>list</function>()
-(<function>tuple</function>()) function.</para>
-
- <para>The <link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
-supports one method: the <link
-linkend="method-gtktreemodelrow--iterchildren"><methodname>iterchildren</methodname>()</link>
-method that returns a <link
-linkend="class-pygtktreemodelrowiter"><classname>gtk.TreeModelRowIter</classname></link>
-for iterating over the children of the row.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreemodelrow--iterchildren">
- <title>gtk.TreeModelRow.iterchildren</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>iterchildren</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>a <link
- linkend="class-pygtktreemodelrowiter"><classname>gtk.TreeModelRowIter</classname></link>
- for the row's children or
- <literal>None</literal></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>iterchildren</methodname>() method returns a
-<link
-linkend="class-pygtktreemodelrowiter"><classname>gtk.TreeModelRowIter</classname></link>
-for iterating over the children of the row or <literal>None</literal> if the
-row has no children.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-pygtktreemodelrowiter.xml b/docs/reference/pygtk-pygtktreemodelrowiter.xml
deleted file mode 100644
index df24080b..00000000
--- a/docs/reference/pygtk-pygtktreemodelrowiter.xml
+++ /dev/null
@@ -1,102 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="class-pygtktreemodelrowiter">
- <refnamediv>
- <refname>gtk.TreeModelRowIter</refname>
- <refpurpose>an object for iterating over a set of <link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
-objects.</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <classsynopsis language="python">
- <ooclass><classname>gtk.TreeModelRowIter</classname></ooclass>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtktreemodelrowiter--next">next</link></methodname>
- <methodparam></methodparam>
- </methodsynopsis>
- </classsynopsis>
-
-</refsect1>
-
- <refsect1>
- <title>Ancestry</title>
-
-<synopsis>+-- <link linkend="class-gobject">gobject.GBoxed</link>
- +-- <link linkend="class-gtkwidget">gtk.TreeModelRowIter</link>
-</synopsis>
-
- </refsect1>
-
- <refsect1>
- <title>Description</title>
-
- <para>A <link
-linkend="class-pygtktreemodelrowiter"><classname>gtk.TreeModelRowIter</classname></link>
-is an object that implements the Python Iterator protocol. It provides the
-means to iterate over a set of <link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
-objects in a <link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>. A
-<link
-linkend="class-pygtktreemodelrowiter"><classname>gtk.TreeModelRowIter</classname></link>
-is created by calling the Python <function>iter</function>() function on a
-<link
-linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
-object:</para>
-
- <programlisting>
- treemodelrowiter = iter(treestore)
-</programlisting>
-
- <para>or, calling the <link
-linkend="method-gtktreemodelrow--iterchildren"><methodname>gtk.TreeModelRow.iterchildren</methodname>()</link>
-method to iterate over its child rows.</para>
-
- <para>Each time you call the <link
-linkend="method-gtktreemodelrowiter--next"><methodname>next</methodname>()</link>
-method it returns the next sibling <link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
-. When there are no rows left the StopIteration exception is raised. Note
-that a <link
-linkend="class-pygtktreemodelrowiter"><classname>gtk.TreeModelRowIter</classname></link>
-does not iterate over the child rows of the rows it is iterating
-over. You'll have to use the <link
-linkend="method-gtktreemodelrow--iterchildren"><methodname>gtk.TreeModelRow.iterchildren</methodname>()</link>
-method to retrieve an iterator for the child rows.</para>
-
- </refsect1>
-
- <refsect1>
- <title>Methods</title>
-
- <refsect2 id="method-gtktreemodelrowiter--next">
- <title>gtk.TreeModelRowIter.next</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>next</methodname>
- <methodparam></methodparam>
- </methodsynopsis></programlisting>
- <variablelist>
- <varlistentry>
- <term><emphasis>Returns</emphasis>&nbsp;:</term>
- <listitem><simpara>the next <link
- linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link></simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <methodname>next</methodname>() method returns the next
-<link
-linkend="class-pygtktreemodelrow"><classname>gtk.TreeModelRow</classname></link>
-in the set of rows it is iterating over. When there are no more rows left
-the StopIteration exception is raised.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-unixprint-classes.xml b/docs/reference/pygtk-unixprint-classes.xml
deleted file mode 100644
index 9d8eeea5..00000000
--- a/docs/reference/pygtk-unixprint-classes.xml
+++ /dev/null
@@ -1,16 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<chapter id="unixprint-class-reference" xmlns:xi="http://www.w3.org/2001/XInclude">
- <title>The gtkunixprint Class Reference</title>
-
-<!-- UNIXPRINT CLASSES -->
-
- <xi:include href="pygtk-gtkpagesetupunixdialog.xml"/>
- <xi:include href="pygtk-gtkprinter.xml"/>
- <xi:include href="pygtk-gtkprintjob.xml"/>
- <xi:include href="pygtk-gtkprintunixdialog.xml"/>
- <xi:include href="pygtk-unixprint-functions.xml"/>
- <xi:include href="pygtk-unixprint-constants.xml"/>
-
-</chapter>
diff --git a/docs/reference/pygtk-unixprint-constants.xml b/docs/reference/pygtk-unixprint-constants.xml
deleted file mode 100644
index a4abe8d9..00000000
--- a/docs/reference/pygtk-unixprint-constants.xml
+++ /dev/null
@@ -1,67 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="unixprint-constants">
- <refnamediv>
- <refname>gtkunixprint Constants</refname>
- <refpurpose>the built-in constants of the gtkunixprint module (new in
- PyGTK 2.10)</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <programlisting>
-<xref linkend="unixprint-print-capabilities-constants" endterm="unixprint-print-capabilities-title"></xref>
-</programlisting>
-
- </refsect1>
-
- <refsect1 id="unixprint-constants-description">
- <title>Description</title>
-
- <refsect2 id="unixprint-print-capabilities-constants">
- <title id="unixprint-print-capabilities-title">Unixprint Print Capabilities Flag Constants</title>
-
- <para>The Print Capabilities Flag constants specify the printing
- capabilities an application supports.</para>
-
- <variablelist>
- <varlistentry>
- <term><literal>gtkunixprint.PRINT_CAPABILITY_PAGE_SET</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtkunixprint.PRINT_CAPABILITY_COPIES</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtkunixprint.PRINT_CAPABILITY_COLLATE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtkunixprint.PRINT_CAPABILITY_REVERSE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>gtkunixprint.PRINT_CAPABILITY_SCALE</literal></term>
- <listitem>
- <simpara></simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk-unixprint-functions.xml b/docs/reference/pygtk-unixprint-functions.xml
deleted file mode 100644
index 5d38ec11..00000000
--- a/docs/reference/pygtk-unixprint-functions.xml
+++ /dev/null
@@ -1,82 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<refentry id="unixprint-functions">
-
- <refnamediv>
- <refname>gtkunixprint Functions</refname>
- <refpurpose>the built-in functions of the gtkunixprint
- module</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Synopsis</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname><link linkend="function-unixprint--enumerate-printers">gtkunixprint.enumerate_printers</link></methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">wait</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- </refsect1>
-
- <refsect1>
- <title>Functions</title>
-
- <refsect2 id="function-unixprint--enumerate-printers">
- <title>gtkunixprint.enumerate_printers</title>
-
- <programlisting><methodsynopsis language="python">
- <methodname>gtkunixprint.enumerate_printers</methodname>
- <methodparam><parameter role="keyword">func</parameter></methodparam>
- <methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
- <methodparam><parameter role="keyword">wait</parameter><initializer>True</initializer></methodparam>
- </methodsynopsis></programlisting>
-
- <variablelist>
- <varlistentry>
- <term><parameter role="keyword">func</parameter>&nbsp;:</term>
- <listitem><simpara>a function to call for each
- printer</simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">data</parameter>&nbsp;:</term>
- <listitem><simpara>user data to pass to
- <parameter>func</parameter></simpara></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter role="keyword">wait</parameter>&nbsp;:</term>
- <listitem><simpara>if <literal>True</literal>, wait in a recursive
- mainloop until all printers are enumerated; otherwise return
- early</simpara></listitem>
- </varlistentry>
- </variablelist>
-
- <note>
- <para>This function is available in PyGTK 2.10 and above.</para>
- </note>
-
- <para>Calls the function specified by <parameter>func</parameter> for
- all <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>s.
- If <parameter>func</parameter> returns <literal>True</literal>, the
- enumeration is stopped.</para>
-
- <para>The signature of func is:</para>
- <programlisting>
- def func(printer, user_data):
- </programlisting>
- <para>where <parameter>printer</parameter> is a <link
- linkend="class-gtkprinter"><classname>gtkunixprint.Printer</classname></link>
- object and <parameter>user_data</parameter> is
- <parameter>data</parameter>. Note if <parameter>data</parameter> is
- not specified <parameter>user_data</parameter> will not be passed to
- func.</para>
-
- </refsect2>
-
- </refsect1>
-
-</refentry>
diff --git a/docs/reference/pygtk2-ref.xml b/docs/reference/pygtk2-ref.xml
deleted file mode 100644
index d29afea0..00000000
--- a/docs/reference/pygtk2-ref.xml
+++ /dev/null
@@ -1,42 +0,0 @@
-<?xml version='1.0'?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-<!ENTITY % entities SYSTEM "entities.docbook">
-%entities;
-<!ENTITY builddate SYSTEM "builddate.xml">
-]>
-
-<book id="pygtk-reference" xmlns:xi="http://www.w3.org/2001/XInclude">
- <bookinfo>
- <pubdate>&builddate;</pubdate>
- <title>PyGTK 2.0 Reference Manual</title>
- <edition>PyGTK Reference Manual for PyGTK &version;</edition>
- <releaseinfo>For PyGTK version &version;</releaseinfo>
- <abstract>
- <para>This reference describes the classes of the Python PyGTK
-module.</para>
- </abstract>
- </bookinfo>
- <toc>
- </toc>
-
- <xi:include href="pygtk-introduction.xml"/>
-
- <chapter id="class-hierarchy">
- <title>PyGTK Class Hierarchy</title>
-
- <xi:include href="pygtk-hierarchy.xml"/>
-
- </chapter>
-
-<!-- the reference page chapters for the PyGTK classes -->
-
- <xi:include href="pygtk-atk-classes.xml"/>
- <xi:include href="pygtk-gtk-classes.xml"/>
- <xi:include href="pygtk-gdk-classes.xml"/>
- <xi:include href="pygtk-glade-classes.xml"/>
- <xi:include href="pygtk-pango-classes.xml"/>
- <xi:include href="pygtk-pangocairo-classes.xml"/>
- <xi:include href="pygtk-unixprint-classes.xml"/>
-
-</book>
diff --git a/examples/Makefile.am b/examples/Makefile.am
deleted file mode 100644
index 2407b296..00000000
--- a/examples/Makefile.am
+++ /dev/null
@@ -1,103 +0,0 @@
-pygtklibdir = $(libdir)/pygtk/2.0
-pygtklib_PYTHON = pygtk-demo/pygtk-demo.py
-demodir = $(pygtklibdir)/demos
-demoimgdir = $(demodir)/images
-
-bin_SCRIPTS = pygtk-demo/pygtk-demo
-pygtk-demo/pygtk-demo: pygtk-demo/pygtk-demo.in
- @mkdir -p pygtk-demo
- @sed -e s!\@PYTHON\@!@PYTHON@! \
- -e s!\@libdir\@!@libdir@! \
- < $< > $@
- @chmod a+x $@
-
-CLEANFILES = pygtk-demo/pygtk-demo
-
-EXTRA_DIST = \
- pygtk-demo/pygtk-demo.in\
- atk/atk-demo.py \
- gobject/editable-interface.py \
- gobject/properties.py \
- gobject/signal.py \
- gtk/bin.py \
- gtk/filechooser.py \
- gtk/scrollable.py \
- gtk/sizegroup.py \
- gtk/uimanager.py \
- gtk/widget.py \
- gtk/testprint.py \
- glade/README \
- glade/test.glade \
- glade/autoconnect.py \
- glade/test2.glade \
- glade/glade-demo.py \
- ide/README \
- ide/break.xpm \
- ide/browse.py \
- ide/continue.xpm \
- ide/edit.py \
- ide/edit.xpm \
- ide/gtkcons.py \
- ide/gtkdb.py \
- ide/gtkprof.py \
- ide/minibreak.xpm \
- ide/next.xpm \
- ide/pyide.py \
- ide/quit.xpm \
- ide/return.xpm \
- ide/run.xpm \
- ide/step.xpm \
- ide/dialogs.py \
- pango/utf8-demo.py \
- pango/pangocairo-simple.py \
- simple/README \
- simple/dnd.py \
- simple/dndpixmap.py \
- simple/hello.py \
- simple/scribble.py \
- simple/simple.py \
- simple/tooltip.py
-
-
-demo_PYTHON = \
- pygtk-demo/demos/__init__.py \
- pygtk-demo/demos/appwindow.py \
- pygtk-demo/demos/buttonbox.py \
- pygtk-demo/demos/changedisplay.py \
- pygtk-demo/demos/colorsel.py \
- pygtk-demo/demos/dialogs.py \
- pygtk-demo/demos/dnd.py \
- pygtk-demo/demos/dndpixmap.py \
- pygtk-demo/demos/editable_cells.py \
- pygtk-demo/demos/entry_completion.py \
- pygtk-demo/demos/expander.py \
- pygtk-demo/demos/hypertext.py \
- pygtk-demo/demos/images.py \
- pygtk-demo/demos/list_store.py \
- pygtk-demo/demos/menu.py \
- pygtk-demo/demos/panes.py \
- pygtk-demo/demos/pixbufs.py \
- pygtk-demo/demos/print_editor.py \
- pygtk-demo/demos/sizegroup.py \
- pygtk-demo/demos/stock_browser.py \
- pygtk-demo/demos/textview.py \
- pygtk-demo/demos/tree_store.py \
- pygtk-demo/demos/treemodel.py \
- pygtk-demo/demos/statusicon.py \
- pygtk-demo/demos/ui_manager.py
-
-demoimg_DATA = \
- pygtk-demo/demos/images/alphatest.png \
- pygtk-demo/demos/images/apple-red.png \
- pygtk-demo/demos/images/background.jpg \
- pygtk-demo/demos/images/floppybuddy.gif \
- pygtk-demo/demos/images/gnome-applets.png \
- pygtk-demo/demos/images/gnome-calendar.png \
- pygtk-demo/demos/images/gnome-foot.png \
- pygtk-demo/demos/images/gnome-gimp.png \
- pygtk-demo/demos/images/gnome-gmush.png \
- pygtk-demo/demos/images/gnome-gsame.png \
- pygtk-demo/demos/images/gnu-keys.png \
- pygtk-demo/demos/images/gtk-logo-rgb.gif
-
-EXTRA_DIST += $(demoimg_DATA)
diff --git a/examples/atk/atk-demo.py b/examples/atk/atk-demo.py
deleted file mode 100644
index 238a00e6..00000000
--- a/examples/atk/atk-demo.py
+++ /dev/null
@@ -1,29 +0,0 @@
-#!/usr/bin/env python
-
-import gtk
-import atk
-
-win = gtk.Window()
-win.connect('destroy', lambda win: gtk.main_quit())
-
-button = gtk.Button(stock=gtk.STOCK_QUIT)
-button.connect('pressed', lambda button: gtk.main_quit())
-atk_button = button.get_accessible()
-atk_button.set_description('Be careful, clicking this button will exit')
-
-label = gtk.Label('This label describes a button')
-atk_label = label.get_accessible()
-atk_label.set_description('This is a useless label')
-relation_set = atk_label.ref_relation_set()
-
-relation = atk.Relation((atk_button,), atk.RELATION_LABEL_FOR)
-relation_set.add(relation)
-
-box = gtk.HBox()
-box.pack_start(label)
-box.pack_start(button)
-
-win.add(box)
-win.show_all()
-
-gtk.main()
diff --git a/examples/glade/README b/examples/glade/README
deleted file mode 100644
index d83c582d..00000000
--- a/examples/glade/README
+++ /dev/null
@@ -1,12 +0,0 @@
-This directory contains examples of the use of the pyglade module, which can
-be used for creating user interfaces from the .glade files created by the
-GLADE UI builder.
-
-Just put a glade file in this directory and run:
- ./glade.py filename.glade
-
-The pyglade module should make it even easier to prototype interfaces in
-python, since you can get it to look right, and act correctly when signals
-get emitted, then generate a C skeleton for the UI.
-
-You can find GLADE at http://www.comp.lancs.ac.uk/~damon/builder/index.html \ No newline at end of file
diff --git a/examples/glade/autoconnect.py b/examples/glade/autoconnect.py
deleted file mode 100644
index 72b1f2a2..00000000
--- a/examples/glade/autoconnect.py
+++ /dev/null
@@ -1,20 +0,0 @@
-#!/usr/bin/env python
-#
-# Small test to demonstrate glade.XML.signal_autoconnect on an instance
-#
-
-import pygtk
-pygtk.require('2.0')
-
-import gtk, gtk.glade
-
-class SimpleTest:
- def __init__(self):
- xml = gtk.glade.XML('test2.glade')
- xml.signal_autoconnect(self)
-
- def on_button1_clicked(self, button):
- print 'foo!'
-
-test = SimpleTest()
-gtk.main()
diff --git a/examples/glade/glade-demo.py b/examples/glade/glade-demo.py
deleted file mode 100644
index d67a586b..00000000
--- a/examples/glade/glade-demo.py
+++ /dev/null
@@ -1,19 +0,0 @@
-#!/usr/bin/env python
-import sys
-import gtk
-import gtk.glade
-
-if len(sys.argv) > 1:
- fname = sys.argv[1]
-else:
- fname = 'test.glade'
-
-# create widget tree ...
-xml = gtk.glade.XML(fname)
-
-def gtk_main_quit(*args):
- gtk.main_quit()
-
-xml.signal_autoconnect(locals())
-
-gtk.main()
diff --git a/examples/glade/test.glade b/examples/glade/test.glade
deleted file mode 100644
index 93c37f9c..00000000
--- a/examples/glade/test.glade
+++ /dev/null
@@ -1,127 +0,0 @@
-<?xml version="1.0" standalone="no"?> <!--*- mode: xml -*-->
-<!DOCTYPE glade-interface SYSTEM "../glade-2.0.dtd" >
-
-<glade-interface>
- <widget class="GtkWindow" id="window1">
- <property name="title" translatable="yes">Testing</property>
- <property name="border_width">10</property>
- <property name="visible">yes</property>
-
- <accessibility>
- <atkproperty name="AtkObject::accessible-name">Test Frame</atkproperty>
- <atkproperty name="AtkObject::accessible-description">
- This is the first of two test windows.
- </atkproperty>
- </accessibility>
-
- <child>
- <widget class="GtkVBox" id="vbox1">
- <property name="spacing">5</property>
- <property name="visible">yes</property>
-
- <child>
- <widget class="GtkLabel" id="label1">
- <property name="label" translatable="yes">A label</property>
- <property name="visible">yes</property>
- <accessibility>
- <atkproperty name="AtkObject::accessible-name">A label</atkproperty>
- <atkrelation target="button1" type="label_for"/>
- </accessibility>
- </widget>
- <packing>
- <property name="expand">no</property>
- </packing>
- </child>
- <child>
- <widget class="GtkButton" id="button1">
- <property name="tooltip">I am a tooltip</property>
- <property name="visible">yes</property>
-
- <accessibility>
- <atkproperty name="AtkObject::accessible-name">Push Me Button</atkproperty>
- <atkproperty name="AtkObject::accessible-description">
- This button wants to be pushed.
- </atkproperty>
- <atkaction action_name="click" description="This button
-dares you to invoke this action."/>
- <atkaction action_name="press" description="This action
-does nothing interesting."/>
- <atkrelation target="label1" type="labelled_by"/>
- </accessibility>
-
- <signal name="clicked" handler="gtk_main_quit" />
-
- <child>
- <widget class="GtkLabel" id="label2">
- <property name="label" translatable="yes">_Push me</property>
- <property name="use_underline">yes</property>
- <property name="visible">yes</property>
- </widget>
- </child>
- </widget>
- </child>
- </widget>
- </child>
- </widget>
-
- <widget class="GtkDialog" id="dialog1">
- <property name="title" translatable="yes">Testing2</property>
- <property name="border_width">10</property>
- <property name="visible">yes</property>
-
- <accessibility>
- <atkproperty name="AtkObject::accessible-name">Testing 2</atkproperty>
- <atkproperty name="AtkObject::accessible-description">
- This is the second of two test windows, a test dialog box.
- </atkproperty>
- </accessibility>
-
- <child internal-child="vbox">
- <widget class="GtkVBox" id="vbox2">
- <child>
- <widget class="GtkLabel" id="label3">
- <property name="label" translatable="yes">Click the button below</property>
- <property name="visible">yes</property>
- <accessibility>
- <atkrelation target="button2" type="label_for"/>
- </accessibility>
- </widget>
- <packing>
- <property name="expand">yes</property>
- </packing>
- </child>
- <child internal-child="action_area">
- <widget class="GtkHButtonBox" id="buttonbox1">
- <child>
- <widget class="GtkButton" id="button2">
- <property name="visible">yes</property>
-
- <accessibility>
- <atkproperty name="AtkObject::accessible-name">Cancel</atkproperty>
- <atkproperty name="AtkObject::accessible-description">
- Another button that does the same as the first one...
- </atkproperty>
- <atkaction action_name="click" description="Cancel (and exit) the test."/>
- <atkaction action_name="press" description="This action
-does nothing interesting."/>
- <atkrelation target="label3" type="labelled_by"/>
- </accessibility>
-
- <signal name="clicked" handler="gtk_main_quit" />
-
- <child>
- <widget class="GtkLabel" id="label4">
- <property name="label" translatable="yes">_Cancel</property>
- <property name="use_underline">yes</property>
- <property name="visible">yes</property>
- </widget>
- </child>
- </widget>
- </child>
- </widget>
- </child>
- </widget>
- </child>
- </widget>
-</glade-interface>
-
diff --git a/examples/glade/test2.glade b/examples/glade/test2.glade
deleted file mode 100644
index bf4d279c..00000000
--- a/examples/glade/test2.glade
+++ /dev/null
@@ -1,27 +0,0 @@
-<?xml version="1.0" standalone="no"?> <!--*- mode: xml -*-->
-<!DOCTYPE glade-interface SYSTEM "http://glade.gnome.org/glade-2.0.dtd">
-
-<glade-interface>
-
-<widget class="GtkWindow" id="window1">
- <property name="visible">True</property>
- <property name="title" translatable="yes">window1</property>
- <property name="type">GTK_WINDOW_TOPLEVEL</property>
- <property name="window_position">GTK_WIN_POS_NONE</property>
- <property name="modal">False</property>
- <property name="resizable">True</property>
- <property name="destroy_with_parent">False</property>
-
- <child>
- <widget class="GtkButton" id="button1">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="label" translatable="yes">button1</property>
- <property name="use_underline">True</property>
- <property name="relief">GTK_RELIEF_NORMAL</property>
- <signal name="clicked" handler="on_button1_clicked" last_modification_time="Thu, 25 Mar 2004 16:36:54 GMT"/>
- </widget>
- </child>
-</widget>
-
-</glade-interface>
diff --git a/examples/gobject/editable-interface.py b/examples/gobject/editable-interface.py
deleted file mode 100644
index 70ba1dc2..00000000
--- a/examples/gobject/editable-interface.py
+++ /dev/null
@@ -1,30 +0,0 @@
-import gtk
-import gobject
-
-
-class EditableLabel(gtk.Entry, gtk.Editable):
-
- def __init__(self, text):
- gtk.Entry.__init__(self, 100)
- self.set_text(text)
-
- def do_do_delete_text(self, start_pos, end_pos):
- print "do_do_delete_text", start_pos, end_pos
- gtk.Entry.do_do_delete_text(self, start_pos, end_pos)
-
-gobject.type_register(EditableLabel)
-
-if __name__ == '__main__':
- w = gtk.Window()
- vbox = gtk.VBox()
- w.add(vbox)
- label = EditableLabel("Foo Bar Zbr")
- vbox.add(label)
- bt = gtk.Button("delete word")
- def delete_word(bt):
- label.delete_text(4, 7)
- bt.connect("clicked", delete_word)
- vbox.add(bt)
- w.connect("destroy", lambda w: gtk.main_quit())
- w.show_all()
- gtk.main()
diff --git a/examples/gobject/properties.py b/examples/gobject/properties.py
deleted file mode 100644
index 2d36afc6..00000000
--- a/examples/gobject/properties.py
+++ /dev/null
@@ -1,43 +0,0 @@
-import gobject
-
-class MyObject(gobject.GObject):
- __gproperties__ = {
- 'foo': (gobject.TYPE_STRING, 'foo property', 'the foo of the object',
- 'bar', gobject.PARAM_READWRITE),
- 'boolprop': (gobject.TYPE_BOOLEAN, 'bool prop', 'a test boolean prop',
- 0, gobject.PARAM_READABLE),
- }
-
- def __init__(self):
- self.__gobject_init__()
- self.foo = 'bar'
- def do_set_property(self, pspec, value):
- print ' do_set_property called for %s=%r' % (pspec.name, value)
- if pspec.name == 'foo':
- self.foo = value
- else:
- raise AttributeError, 'unknown property %s' % pspec.name
- def do_get_property(self, pspec):
- print ' do_get_property called for %s' % pspec.name
- if pspec.name == 'foo':
- return self.foo
- elif pspec.name == 'boolprop':
- return 1
- else:
- raise AttributeError, 'unknown property %s' % pspec.name
-gobject.type_register(MyObject)
-
-print "MyObject properties: ", gobject.list_properties(MyObject)
-obj = MyObject()
-
-val = obj.get_property('foo')
-print "obj.get_property('foo') == ", val
-
-obj.set_property('foo', 'spam')
-print "obj.set_property('foo', 'spam')"
-
-val = obj.get_property('foo')
-print "obj.get_property('foo') == ", val
-
-val = obj.get_property('boolprop')
-print "obj.get_property('boolprop') == ", val
diff --git a/examples/gobject/signal.py b/examples/gobject/signal.py
deleted file mode 100644
index 26ddae93..00000000
--- a/examples/gobject/signal.py
+++ /dev/null
@@ -1,28 +0,0 @@
-import pygtk; pygtk.require("2.0")
-import gobject
-
-class C(gobject.GObject):
- __gsignals__ = {
- 'my_signal': (gobject.SIGNAL_RUN_FIRST, gobject.TYPE_NONE,
- (gobject.TYPE_INT,))
- }
- def __init__(self):
- self.__gobject_init__() # default constructor using our new GType
- def do_my_signal(self, arg):
- print "C: class closure for `my_signal' called with argument", arg
-
-class D(C):
- def do_my_signal(self, arg):
- print "D: class closure for `my_signal' called. Chaining up to C"
- C.do_my_signal(self, arg)
-
-def my_signal_handler(object, arg, *extra):
- print "handler for `my_signal' called with argument", arg, \
- "and extra args", extra
-
-inst = C()
-inst2 = D()
-
-inst.connect("my_signal", my_signal_handler, 1, 2, 3)
-inst.emit("my_signal", 42)
-inst2.emit("my_signal", 42)
diff --git a/examples/gtk/bin.py b/examples/gtk/bin.py
deleted file mode 100644
index fa8d7afa..00000000
--- a/examples/gtk/bin.py
+++ /dev/null
@@ -1,30 +0,0 @@
-# A simple gtk.Conatiner subclassing example reimplementing gtk.Bin in python
-import gtk
-
-class Bin(gtk.Container):
- __gtype_name__ = 'PyGtkBin'
- def __init__(self):
- gtk.Container.__init__(self)
- self.child = None
-
- def do_add(self, child):
- child.set_parent(self)
- self.child = child
-
- def do_remove(self, child):
- widget_was_visible = child.flags() & gtk.VISIBLE
- child.unparent()
- self.child = None
-
- if widget_was_visible:
- self.queue_resize()
-
- def do_forall(self, internal, callback, data):
- if self.child:
- callback(self.child, data)
-
-label = gtk.Label()
-c = Bin()
-c.add(label)
-print c.get_children()
-c.remove(label)
diff --git a/examples/gtk/filechooser.py b/examples/gtk/filechooser.py
deleted file mode 100644
index 613b4e19..00000000
--- a/examples/gtk/filechooser.py
+++ /dev/null
@@ -1,35 +0,0 @@
-import pygtk
-pygtk.require('2.0')
-
-import gtk
-
-dialog = gtk.FileChooserDialog("Open..",
- None,
- gtk.FILE_CHOOSER_ACTION_OPEN,
- (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
- gtk.STOCK_OPEN, gtk.RESPONSE_OK))
-dialog.set_default_response(gtk.RESPONSE_OK)
-
-filter = gtk.FileFilter()
-filter.set_name("All files")
-filter.add_pattern("*")
-dialog.add_filter(filter)
-
-filter = gtk.FileFilter()
-filter.set_name("Images")
-filter.add_mime_type("image/png")
-filter.add_mime_type("image/jpeg")
-filter.add_mime_type("image/gif")
-filter.add_pattern("*.png")
-filter.add_pattern("*.jpg")
-filter.add_pattern("*.gif")
-filter.add_pattern("*.tif")
-filter.add_pattern("*.xpm")
-dialog.add_filter(filter)
-
-response = dialog.run()
-if response == gtk.RESPONSE_OK:
- print dialog.get_filename(), 'selected'
-elif response == gtk.RESPONSE_CANCEL:
- print 'Closed, no files selected'
-dialog.destroy()
diff --git a/examples/gtk/scrollable.py b/examples/gtk/scrollable.py
deleted file mode 100644
index 12db08fc..00000000
--- a/examples/gtk/scrollable.py
+++ /dev/null
@@ -1,280 +0,0 @@
-#
-# Reimplementation of gtk.Layout in python
-# Example on how to implement a scrollable container in python
-#
-# Johan Dahlin <johan@gnome.org>, 2006
-#
-# Requires PyGTK 2.8.0 or later
-
-import gobject
-import gtk
-from gtk import gdk
-
-class Child:
- widget = None
- x = 0
- y = 0
-
-def set_adjustment_upper(adj, upper, always_emit):
- changed = False
- value_changed = False
-
- min = max(0.0, upper - adj.page_size)
-
- if upper != adj.upper:
- adj.upper = upper
- changed = True
-
- if adj.value > min:
- adj.value = min
- value_changed = True
-
- if changed or always_emit:
- adj.changed()
- if value_changed:
- adj.value_changed()
-
-def new_adj():
- return gtk.Adjustment(0.0, 0.0, 0.0,
- 0.0, 0.0, 0.0)
-
-class Layout(gtk.Container):
- __gsignals__ = dict(set_scroll_adjustments=
- (gobject.SIGNAL_RUN_LAST, None,
- (gtk.Adjustment, gtk.Adjustment)))
- def __init__(self):
- self._children = []
- self._width = 100
- self._height = 100
- self._hadj = None
- self._vadj = None
- self._bin_window = None
- self._hadj_changed_id = -1
- self._vadj_changed_id = -1
- gtk.Container.__init__(self)
-
- if not self._hadj or not self._vadj:
- self._set_adjustments(self._vadj or new_adj(),
- self._hadj or new_adj())
-
- # Public API
-
- def put(self, widget, x=0, y=0):
- child = Child()
- child.widget = widget
- child.x = x
- child.y = y
- self._children.append(child)
-
- if self.flags() & gtk.REALIZED:
- widget.set_parent_window(self._bin_window)
-
- widget.set_parent(self)
-
- def set_size(self, width, height):
- if self._width != width:
- self._width = width
- if self._height != height:
- self._height = height
- if self._hadj:
- set_adjustment_upper(self._hadj, self._width, False)
- if self._vadj:
- set_adjustment_upper(self._vadj, self._height, False)
-
- if self.flags() & gtk.REALIZED:
- self._bin_window.resize(max(width, self.allocation.width),
- max(height, self.allocation.height))
-
- # GtkWidget
-
- def do_realize(self):
- self.set_flags(self.flags() | gtk.REALIZED)
-
- self.window = gdk.Window(
- self.get_parent_window(),
- window_type=gdk.WINDOW_CHILD,
- x=self.allocation.x,
- y=self.allocation.y,
- width=self.allocation.width,
- height=self.allocation.height,
- wclass=gdk.INPUT_OUTPUT,
- colormap=self.get_colormap(),
- event_mask=gdk.VISIBILITY_NOTIFY_MASK)
- self.window.set_user_data(self)
-
- self._bin_window = gdk.Window(
- self.window,
- window_type=gdk.WINDOW_CHILD,
- x=int(-self._hadj.value),
- y=int(-self._vadj.value),
- width=max(self._width, self.allocation.width),
- height=max(self._height, self.allocation.height),
- colormap=self.get_colormap(),
- wclass=gdk.INPUT_OUTPUT,
- event_mask=(self.get_events() | gdk.EXPOSURE_MASK |
- gdk.SCROLL_MASK))
- self._bin_window.set_user_data(self)
-
- self.set_style(self.style.attach(self.window))
- self.style.set_background(self.window, gtk.STATE_NORMAL)
- self.style.set_background(self._bin_window, gtk.STATE_NORMAL)
-
- for child in self._children:
- child.widget.set_parent_window(self._bin_window)
- self.queue_resize()
-
- def do_unrealize(self):
- self._bin_window.set_user_data(None)
- self._bin_window.destroy()
- self._bin_window = None
- gtk.Container.do_unrealize(self)
-
- def _do_style_set(self, style):
- gtk.Widget.do_style_set(self, style)
-
- if self.flags() & gtk.REALIZED:
- self.style.set_background(self._bin_window, gtk.STATE_NORMAL)
-
- def do_expose_event(self, event):
- if event.window != self._bin_window:
- return False
- gtk.Container.do_expose_event(self, event)
- return False
-
- def do_map(self):
- self.set_flags(self.flags() | gtk.MAPPED)
- for child in self._children:
- flags = child.widget.flags()
- if flags & gtk.VISIBLE:
- if not (flags & gtk.MAPPED):
- child.widget.map()
- self._bin_window.show()
- self.window.show()
-
- def do_size_request(self, req):
- req.width = 0
- req.height = 0
- for child in self._children:
- child.widget.size_request()
-
- def do_size_allocate(self, allocation):
- self.allocation = allocation
- for child in self._children:
- self._allocate_child(child)
-
- if self.flags() & gtk.REALIZED:
- self.window.move_resize(*allocation)
- self._bin_window.resize(max(self._width, allocation.width),
- max(self._height, allocation.height))
-
- self._hadj.page_size = allocation.width
- self._hadj.page_increment = allocation.width * 0.9
- self._hadj.lower = 0
- set_adjustment_upper(self._hadj,
- max(allocation.width, self._width), True)
-
- self._vadj.page_size = allocation.height
- self._vadj.page_increment = allocation.height * 0.9
- self._vadj.lower = 0
- self._vadj.upper = max(allocation.height, self._height)
- set_adjustment_upper(self._vadj,
- max(allocation.height, self._height), True)
-
- def do_set_scroll_adjustments(self, hadj, vadj):
- self._set_adjustments(hadj, vadj)
-
- # GtkContainer
-
- def do_forall(self, include_internals, callback, data):
- for child in self._children:
- callback(child.widget, data)
-
- def do_add(self, widget):
- self.put(widget)
-
- def do_remove(self, widget):
- child = self._get_child_from_widget(widget)
- self._children.remove(child)
- widget.unparent()
-
- # Private
-
- def _set_adjustments(self, hadj, vadj):
- if not hadj and self._hadj:
- hadj = new_adj()
-
- if not vadj and self._vadj:
- vadj = new_adj()
-
- if self._hadj and self._hadj != hadj:
- self._hadj.disconnect(self._hadj_changed_id)
-
- if self._vadj and self._vadj != vadj:
- self._vadj.disconnect(self._vadj_changed_id)
-
- need_adjust = False
-
- if self._hadj != hadj:
- self._hadj = hadj
- set_adjustment_upper(hadj, self._width, False)
- self._hadj_changed_id = hadj.connect(
- "value-changed",
- self._adjustment_changed)
- need_adjust = True
-
- if self._vadj != vadj:
- self._vadj = vadj
- set_adjustment_upper(vadj, self._height, False)
- self._vadj_changed_id = vadj.connect(
- "value-changed",
- self._adjustment_changed)
- need_adjust = True
-
- if need_adjust and vadj and hadj:
- self._adjustment_changed()
-
- def _adjustment_changed(self, adj=None):
- if self.flags() & gtk.REALIZED:
- self._bin_window.move(int(-self._hadj.value),
- int(-self._vadj.value))
- self._bin_window.process_updates(True)
-
- def _get_child_from_widget(self, widget):
- for child in self._children:
- if child.widget == widget:
- return child
- else:
- raise AssertionError
-
- def _allocate_child(self, child):
- allocation = gdk.Rectangle()
- allocation.x = child.x
- allocation.y = child.y
- req = child.widget.get_child_requisition()
- allocation.width = req[0]
- allocation.height = req[1]
- child.widget.size_allocate(allocation)
-
-Layout.set_set_scroll_adjustments_signal('set-scroll-adjustments')
-
-def main():
- window = gtk.Window()
- window.set_size_request(300, 300)
- window.connect('delete-event', gtk.main_quit)
-
- sw = gtk.ScrolledWindow()
- sw.set_policy(gtk.POLICY_ALWAYS, gtk.POLICY_ALWAYS)
- window.add(sw)
-
- layout = Layout()
- layout.set_size(1000, 1000)
- sw.add(layout)
-
- b = gtk.Button('foobar')
- layout.put(b, 100, 100)
-
- window.show_all()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/gtk/sizegroup.py b/examples/gtk/sizegroup.py
deleted file mode 100644
index a88308d3..00000000
--- a/examples/gtk/sizegroup.py
+++ /dev/null
@@ -1,48 +0,0 @@
-#
-# Small example of GtkSizeGroup
-#
-# Johan Dahlin <johan@gnome.org>, 2005
-#
-
-"""Simple example that demonstrates how to use a GtkSizeGroup.
-
-In this case we'll have two labels and two entries.
-The labels have different width, but we'd like to have the entries
-aligned vertically. We can accomplish this by adding a horizontal
-sizegroup to the labels.
-"""
-
-import gtk
-
-def create_label(text):
- hbox = gtk.HBox(spacing=6)
- label = gtk.Label(text)
- hbox.pack_start(label)
- entry = gtk.Entry()
- hbox.pack_start(entry)
- return hbox, label
-
-def main():
- win = gtk.Window()
- win.connect('delete-event', gtk.main_quit)
- win.set_border_width(6)
- win.set_title('GtkSizeGroup example')
-
- vbox = gtk.VBox(spacing=6)
- win.add(vbox)
-
- sg = gtk.SizeGroup(gtk.SIZE_GROUP_HORIZONTAL)
-
- hbox, label = create_label('Name:')
- sg.add_widget(label)
- vbox.pack_start(hbox)
-
- hbox, label = create_label('Address:')
- sg.add_widget(label)
- vbox.pack_start(hbox)
-
- win.show_all()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/gtk/testprint.py b/examples/gtk/testprint.py
deleted file mode 100644
index 06acf3f3..00000000
--- a/examples/gtk/testprint.py
+++ /dev/null
@@ -1,68 +0,0 @@
-## Derived from tests/testprint.c from gtk+ sources
-
-import sys
-import math
-import cairo
-import pango
-import gtk
-
-def request_page_setup(operation, context, page_nr, page_setup):
- ## Make the second page landscape mode a5
- if page_nr == 1:
- page_setup.set_orientation(gtk.PAGE_ORIENTATION_LANDSCAPE)
- page_setup.set_paper_size(gtk.PaperSize("iso_a5"))
-
-
-def draw_page (operation, context, page_nr):
- cr = context.get_cairo()
-
- ## Draw a red rectangle, as wide as the paper (inside the margins)
- cr.set_source_rgb(1.0, 0, 0)
- cr.rectangle(0, 0, context.get_width(), 50)
-
- cr.fill()
-
- ## Draw some lines
- cr.move_to(20, 10)
- cr.line_to(40, 20)
- cr.arc(60, 60, 20, 0, math.pi)
- cr.line_to(80, 20)
-
- cr.set_source_rgb(0, 0, 0)
- cr.set_line_width(5)
- cr.set_line_cap(cairo.LINE_CAP_ROUND)
- cr.set_line_join(cairo.LINE_JOIN_ROUND)
-
- cr.stroke()
-
- ## Draw some text
- layout = context.create_layout()
- layout.set_text("Hello World! Printing is easy")
- layout.set_font_description(pango.FontDescription("sans 28"))
-
- cr.move_to(30, 20)
- cr.layout_path(layout)
-
- ## Font Outline
- cr.set_source_rgb(0.93, 1.0, 0.47)
- cr.set_line_width(0.5)
- cr.stroke_preserve()
-
- ## Font Fill
- cr.set_source_rgb(0, 0.0, 1.0)
- cr.fill()
-
-
-def main(argv):
- ## Test some random drawing, with per-page paper settings
- print_ = gtk.PrintOperation()
- print_.set_nr_of_pages(2)
- print_.set_unit(gtk.UNIT_MM)
- print_.set_pdf_target("test.pdf")
- print_.connect("draw_page", draw_page)
- print_.connect("request_page_setup", request_page_setup)
- res = print_.run()
- return 0
-
-if __name__ == '__main__':
- sys.exit(main(sys.argv))
diff --git a/examples/gtk/uimanager.py b/examples/gtk/uimanager.py
deleted file mode 100644
index 7f731524..00000000
--- a/examples/gtk/uimanager.py
+++ /dev/null
@@ -1,127 +0,0 @@
-#
-# Small example of the new GtkUIManager
-#
-# Johan Dahlin <johan@gnome.org>, 2004
-#
-
-import pygtk
-pygtk.require('2.0')
-
-import gtk
-
-ui_string = """<ui>
- <menubar name='Menubar'>
- <menu action='FileMenu'>
- <menuitem action='New'/>
- <menuitem action='Open'/>
- <separator/>
- <menuitem action='Close'/>
- <menuitem action='Quit'/>
- </menu>
- <menu action='HelpMenu'>
- <menuitem action='About'/>
- </menu>
- </menubar>
- <toolbar name='Toolbar'>
- <toolitem action='New'/>
- <toolitem action='Open'/>
- <separator/>
- <toolitem action='Quit'/>
- </toolbar>
-</ui>"""
-
-class Window(gtk.Window):
- def __init__(self):
- gtk.Window.__init__(self)
- self.set_position(gtk.WIN_POS_CENTER)
- self.set_title('GtkUIManager test app')
- self.connect('delete-event', self.delete_event_cb)
- self.set_size_request(400, 200)
- vbox = gtk.VBox()
- self.add(vbox)
-
- self.create_ui()
- vbox.pack_start(self.ui.get_widget('/Menubar'), expand=False)
- vbox.pack_start(self.ui.get_widget('/Toolbar'), expand=False)
-
- sw = gtk.ScrolledWindow()
- sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- vbox.pack_start(sw)
-
- textview = gtk.TextView()
- self.buffer = textview.get_buffer()
- sw.add(textview)
-
- status = gtk.Statusbar()
- vbox.pack_end(status, expand=False)
-
- def create_ui(self):
- ag = gtk.ActionGroup('WindowActions')
- actions = [
- ('FileMenu', None, '_File'),
- ('New', gtk.STOCK_NEW, '_New', '<control>N',
- 'Create a new file', self.file_new_cb),
- ('Open', gtk.STOCK_OPEN, '_Open', '<control>O',
- 'Open a file', self.file_open_cb),
- ('Close', gtk.STOCK_CLOSE, '_Close', '<control>W',
- 'Close the current window', self.file_close_cb),
- ('Quit', gtk.STOCK_QUIT, '_Quit', '<control>Q',
- 'Quit application', self.file_quit_cb),
- ('HelpMenu', None, '_Help'),
- ('About', None, '_About', None, 'About application',
- self.help_about_cb),
- ]
- ag.add_actions(actions)
- self.ui = gtk.UIManager()
- self.ui.insert_action_group(ag, 0)
- self.ui.add_ui_from_string(ui_string)
- self.add_accel_group(self.ui.get_accel_group())
-
- def file_new_cb(self, action):
- w = Window()
- w.show_all()
- gtk.main()
-
- def file_open_cb(self, action):
- dialog = gtk.FileChooserDialog("Open..", self,
- gtk.FILE_CHOOSER_ACTION_OPEN,
- (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
- gtk.STOCK_OPEN, gtk.RESPONSE_OK))
- dialog.set_default_response(gtk.RESPONSE_OK)
-
- filter = gtk.FileFilter()
- filter.set_name("All files")
- filter.add_pattern("*")
- dialog.add_filter(filter)
-
- dialog.hide()
-
- if dialog.run() == gtk.RESPONSE_OK:
- filename = dialog.get_filename()
- self.buffer.set_text(file(filename).read())
-
- dialog.destroy()
-
- def file_close_cb(self, action):
- self.hide()
- gtk.main_quit()
-
- def file_quit_cb(self, action):
- raise SystemExit
-
- def help_about_cb(self, action):
- dialog = gtk.MessageDialog(self,
- (gtk.DIALOG_MODAL |
- gtk.DIALOG_DESTROY_WITH_PARENT),
- gtk.MESSAGE_INFO, gtk.BUTTONS_OK,
- "Small example of the new GtkUIManger")
- dialog.run()
- dialog.destroy()
-
- def delete_event_cb(self, window, event):
- gtk.main_quit()
-
-if __name__ == '__main__':
- w = Window()
- w.show_all()
- gtk.main()
diff --git a/examples/gtk/widget.py b/examples/gtk/widget.py
deleted file mode 100644
index 976dc447..00000000
--- a/examples/gtk/widget.py
+++ /dev/null
@@ -1,133 +0,0 @@
-import sys
-
-import gobject
-import pango
-import gtk
-from gtk import gdk
-
-if gtk.pygtk_version < (2, 8):
- print "PyGtk 2.8 or later required for this example"
- raise SystemExit
-
-try:
- import cairo
-except ImportError:
- raise SystemExit("cairo required for this example")
-
-TEXT = 'A GtkWidget implemented in PyGTK'
-BORDER_WIDTH = 10
-
-# A quite simple gtk.Widget subclass which demonstrates how to subclass
-# and do realizing, sizing and drawing.
-
-class PyGtkWidget(gtk.Widget):
- def __init__(self, text):
- gtk.Widget.__init__(self)
- self._layout = self.create_pango_layout(text)
- self._layout.set_font_description(pango.FontDescription("Sans Serif 16"))
-
- # GtkWidget
-
- def do_realize(self):
- # The do_realize method is responsible for creating GDK (windowing system)
- # resources. In this example we will create a new gdk.Window which we
- # then draw on
-
- # First set an internal flag telling that we're realized
- self.set_flags(self.flags() | gtk.REALIZED)
-
- # Create a new gdk.Window which we can draw on.
- # Also say that we want to receive exposure events by setting
- # the event_mask
- self.window = gdk.Window(
- self.get_parent_window(),
- width=self.allocation.width,
- height=self.allocation.height,
- window_type=gdk.WINDOW_CHILD,
- wclass=gdk.INPUT_OUTPUT,
- event_mask=self.get_events() | gdk.EXPOSURE_MASK)
-
- # Associate the gdk.Window with ourselves, Gtk+ needs a reference
- # between the widget and the gdk window
- self.window.set_user_data(self)
-
- # Attach the style to the gdk.Window, a style contains colors and
- # GC contextes used for drawing
- self.style.attach(self.window)
-
- # The default color of the background should be what
- # the style (theme engine) tells us.
- self.style.set_background(self.window, gtk.STATE_NORMAL)
- self.window.move_resize(*self.allocation)
-
- def do_unrealize(self):
- # The do_unrealized method is responsible for freeing the GDK resources
-
- # De-associate the window we created in do_realize with ourselves
- self.window.set_user_data(None)
-
- def do_size_request(self, requisition):
- # The do_size_request method Gtk+ is calling on a widget to ask
- # it the widget how large it wishes to be. It's not guaranteed
- # that gtk+ will actually give this size to the widget
-
- # In this case, we say that we want to be as big as the
- # text is, plus a little border around it.
- width, height = self._layout.get_size()
- requisition.width = width // pango.SCALE + BORDER_WIDTH*4
- requisition.height = height // pango.SCALE + BORDER_WIDTH*4
-
- def do_size_allocate(self, allocation):
- # The do_size_allocate is called by when the actual size is known
- # and the widget is told how much space could actually be allocated
-
- # Save the allocated space
- self.allocation = allocation
-
- # If we're realized, move and resize the window to the
- # requested coordinates/positions
- if self.flags() & gtk.REALIZED:
- self.window.move_resize(*allocation)
-
- def do_expose_event(self, event):
- # The do_expose_event is called when the widget is asked to draw itself
- # Remember that this will be called a lot of times, so it's usually
- # a good idea to write this code as optimized as it can be, don't
- # Create any resources in here.
-
- # In this example, draw a rectangle in the foreground color
- x, y, w, h = self.allocation
- cr = self.window.cairo_create()
- cr.set_source_color(self.style.fg[self.state])
- cr.rectangle(BORDER_WIDTH, BORDER_WIDTH,
- w - 2*BORDER_WIDTH, h - 2*BORDER_WIDTH)
- cr.set_line_width(5.0)
- cr.set_line_join(cairo.LINE_JOIN_ROUND)
- cr.stroke()
-
- # And draw the text in the middle of the allocated space
- fontw, fonth = self._layout.get_pixel_size()
- cr.move_to((w - fontw)/2, (h - fonth)/2)
- cr.update_layout(self._layout)
- cr.show_layout(self._layout)
-
-gobject.type_register(PyGtkWidget)
-
-def main(args):
- win = gtk.Window()
- win.set_border_width(5)
- win.set_title('Widget test')
- win.connect('delete-event', gtk.main_quit)
-
- frame = gtk.Frame("Example frame")
- win.add(frame)
-
- w = PyGtkWidget(TEXT)
- frame.add(w)
-
- win.show_all()
-
- gtk.main()
-
-if __name__ == '__main__':
- sys.exit(main(sys.argv))
diff --git a/examples/ide/README b/examples/ide/README
deleted file mode 100644
index 99568b0f..00000000
--- a/examples/ide/README
+++ /dev/null
@@ -1,7 +0,0 @@
-This directory contains some tools that can be used to help develop python
-applications. There is a graphical front end to the profiler and debugger,
-and a graphical python console, and a 'module browser'.
-
-I will probably link these together with an editor (just use emacs, or write
-one in python?).
-
diff --git a/examples/ide/break.xpm b/examples/ide/break.xpm
deleted file mode 100644
index f5221a30..00000000
--- a/examples/ide/break.xpm
+++ /dev/null
@@ -1,29 +0,0 @@
-/* XPM */
-static char * break_xpm[] = {
-"21 22 4 1",
-" c None",
-". c #000000",
-"X c #FFFFFF",
-"o c #FF0000",
-" ......... ",
-" .XXXXXXXXX. ",
-" .XXoooooooXX. ",
-" .XXoooooooooXX. ",
-" .XXoooooooooooXX. ",
-" .XXoooooooooooooXX. ",
-".XXoooooooooooooooXX.",
-".XoooooooooooooooooX.",
-".XooXXoXXXoXXooXXooX.",
-".XoXooXoXoXooXoXoXoX.",
-".XoXooooXoXooXoXoXoX.",
-".XooXXooXoXooXoXXooX.",
-".XooooXoXoXooXoXoooX.",
-".XoXooXoXoXooXoXoooX.",
-".XooXXooXooXXooXoooX.",
-".XXoooooooooooooooXX.",
-" .XXoooooooooooooXX. ",
-" .XXoooooooooooXX. ",
-" .XXoooooooooXX. ",
-" .XXoooooooXX. ",
-" .XXXXXXXXX. ",
-" ......... "};
diff --git a/examples/ide/browse.py b/examples/ide/browse.py
deleted file mode 100755
index 0cc85b0d..00000000
--- a/examples/ide/browse.py
+++ /dev/null
@@ -1,119 +0,0 @@
-#!/usr/bin/env python
-
-# This is an example of using dynamic trees (trees where nodes are only
-# calculated as they are needed) with pygtk. This particular example
-# allows for the browsing of the variables in a module, allowing the
-# descent into classes and modules and other objects with a __dict__
-# attribute.
-
-# If this file is run straight, it will let you browse the gtk module.
-
-import pygtk
-pygtk.require('2.0')
-import gtk
-
-class BrowseVariables(gtk.VBox):
- def __init__(self, name, obj):
- gtk.VBox.__init__(self)
- self.set_spacing(2)
- #
- self.sw = gtk.ScrolledWindow()
- self.sw.set_size_request(300, 200)
- self.sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- self.pack_start(self.sw)
- self.sw.show()
- #
- self.disp = gtk.Entry()
- self.disp.set_editable(False)
- self.pack_start(self.disp, expand=False)
- self.disp.show()
- #
- self.treestore = gtk.TreeStore(str, object)
- self.tree = gtk.TreeView(self.treestore)
- treeviewcolumn = gtk.TreeViewColumn('Variable',
- gtk.CellRendererText(),
- text=0)
- self.tree.append_column(treeviewcolumn)
- self.sw.add(self.tree)
- self.tree.show()
- #
- riter = self.treestore.append(None, [name, obj])
- self.treestore.append(riter, ['', None])
- self.tree.connect('test-expand-row', self.expand_row_cb)
- self.tree.connect('test-collapse-row', self.collapse_row_cb)
- self.treeselection = self.tree.get_selection()
- self.treeselection.connect('changed', self.change_selection_cb)
- return
- def change_selection_cb(self, treeselection):
- model, iter = treeselection.get_selected()
- if not iter or not self.disp:
- return
- key = model[iter][0]
- if key == '__builtins__':
- value = key
- else:
- value = model[iter][1]
- self.disp.set_text(str(value))
- return
- def expand_row_cb(self, treeview, riter, path):
- model = treeview.get_model()
- dict = vars(model[riter][1])
- if not dict:
- return True
- citer = model.iter_children(riter)
- model.remove(citer)
- keylist = dict.keys()
- keylist.sort()
- for key in keylist:
- obj = dict[key]
- i = model.append(riter, [key, obj])
- try:
- d = vars(obj)
- if d:
- model.append(i, ['', d])
- except TypeError:
- pass
- return False
- def collapse_row_cb(self, treeview, riter, path):
- model = treeview.get_model()
- citer = model.iter_children(riter)
- if citer:
- while model.remove(citer):
- pass
- model.append(riter, ['', None])
- return True
-
-class BrowseWindow(gtk.Window):
- def __init__(self, name, dict):
- gtk.Window.__init__(self)
- self.set_title("Browse Window")
- box = gtk.VBox()
- self.add(box)
- box.show()
- browse = BrowseVariables(name, dict)
- browse.set_border_width(10)
- box.pack_start(browse)
- browse.show()
- separator = gtk.HSeparator()
- box.pack_start(separator, expand=False)
- separator.show()
- box2 = gtk.VBox(spacing=10)
- box2.set_border_width(10)
- box.pack_start(box2, expand=False)
- box2.show()
- button = gtk.Button(stock=gtk.STOCK_CLOSE)
- box2.pack_start(button)
- button.set_flags(gtk.CAN_DEFAULT)
- button.grab_default()
- button.show()
- self.close_button = button
- return
-
-if __name__ == '__main__':
- win = BrowseWindow('gtk', gtk)
- win.set_title("Browse gtk")
- win.connect("destroy", lambda w: gtk.main_quit())
- win.connect("delete_event", lambda w,e: gtk.main_quit())
- win.close_button.connect("clicked", lambda w: gtk.main_quit())
- win.show()
- gtk.main()
diff --git a/examples/ide/continue.xpm b/examples/ide/continue.xpm
deleted file mode 100644
index f44f61d7..00000000
--- a/examples/ide/continue.xpm
+++ /dev/null
@@ -1,27 +0,0 @@
-/* XPM */
-static char * continue_xpm[] = {
-"20 22 2 1",
-" c None",
-". c #000000",
-" ",
-" ",
-" . . ",
-" .. .. ",
-" ... ... ",
-" .... .... ",
-" ..... ..... ",
-" ...... ...... ",
-" ....... ....... ",
-" ........ ........ ",
-" .................. ",
-" .................. ",
-" ........ ........ ",
-" ....... ....... ",
-" ...... ...... ",
-" ..... ..... ",
-" .... .... ",
-" ... ... ",
-" .. .. ",
-" . . ",
-" ",
-" "};
diff --git a/examples/ide/dialogs.py b/examples/ide/dialogs.py
deleted file mode 100644
index ac009e44..00000000
--- a/examples/ide/dialogs.py
+++ /dev/null
@@ -1,58 +0,0 @@
-import pygtk
-pygtk.require('2.0')
-import gtk
-
-import os
-
-def InputBox(title, label, parent, text=''):
- dlg = gtk.Dialog(title, parent, gtk.DIALOG_DESTROY_WITH_PARENT,
- (gtk.STOCK_OK, gtk.RESPONSE_OK,
- gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL))
- lbl = gtk.Label(label)
- lbl.show()
- dlg.vbox.pack_start(lbl)
- entry = gtk.Entry()
- if text: entry.set_text(text)
- entry.show()
- dlg.vbox.pack_start(entry, False)
- resp = dlg.run()
- text = entry.get_text()
- dlg.hide()
- if resp == gtk.RESPONSE_CANCEL:
- return None
- return text
-
-def OpenFile(title, parent=None, dirname=None, fname=None):
- dlg = gtk.FileChooserDialog(title, parent,
- buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
- gtk.STOCK_CANCEL,
- gtk.RESPONSE_CANCEL))
- if fname:
- dlg.set_current_folder(os.path.dirname(fname))
- elif dirname:
- dlg.set_current_folder(dirname)
- dlg.set_local_only(True)
- resp = dlg.run()
- fname = dlg.get_filename()
- dlg.hide()
- if resp == gtk.RESPONSE_CANCEL:
- return None
- return fname
-
-def SaveFile(title, parent=None, dirname=None, fname=None):
- dlg = gtk.FileChooserDialog(title, parent,
- gtk.FILE_CHOOSER_ACTION_SAVE,
- buttons=(gtk.STOCK_OK, gtk.RESPONSE_OK,
- gtk.STOCK_CANCEL,
- gtk.RESPONSE_CANCEL))
- if fname:
- dlg.set_filename(fname)
- elif dirname:
- dlg.set_current_folder(dirname)
- dlg.set_local_only(True)
- resp = dlg.run()
- fname = dlg.get_filename()
- dlg.hide()
- if resp == gtk.RESPONSE_CANCEL:
- return None
- return fname
diff --git a/examples/ide/edit.py b/examples/ide/edit.py
deleted file mode 100644
index 6e34e8b0..00000000
--- a/examples/ide/edit.py
+++ /dev/null
@@ -1,284 +0,0 @@
-#!/usr/bin/env python
-
-# This is a sample implementation of an editor.
-
-import os
-import dialogs
-
-import gtk
-
-BLOCK_SIZE = 2048
-RESPONSE_FORWARD = 1
-
-class EditWindow(gtk.Window):
- def __init__(self, quit_cb=None):
- gtk.Window.__init__(self, gtk.WINDOW_TOPLEVEL)
- self.set_size_request(470, 300)
- self.connect("delete_event", self.file_exit)
- self.quit_cb = quit_cb
- self.vbox = gtk.VBox()
- self.add(self.vbox)
- self.vbox.show()
- hdlbox = gtk.HandleBox()
- self.vbox.pack_start(hdlbox, expand=False)
- hdlbox.show()
- self.menubar, self.toolbar = self.create_menu()
- hdlbox.add(self.menubar)
- self.menubar.show()
- self.vbox.pack_start(self.toolbar, expand=False)
- self.scrolledwin = gtk.ScrolledWindow()
- self.scrolledwin.show()
- self.vbox.pack_start(self.scrolledwin)
- self.text = gtk.TextView()
- self.text.set_editable(True)
- self.scrolledwin.add(self.text)
- self.text.show()
- self.buffer = self.text.get_buffer()
- self.dirty = 0
- self.file_new()
- self.text.grab_focus()
- self.clipboard = gtk.Clipboard(selection='CLIPBOARD')
- self.dirname = None
- self.search_string = None
- self.last_search_iter = None
- return
- def load_file(self, fname):
- try:
- fd = open(fname)
- self.buffer.set_text('')
- buf = fd.read(BLOCK_SIZE)
- while buf != '':
- self.buffer.insert_at_cursor(buf)
- buf = fd.read(BLOCK_SIZE)
- self.text.queue_draw()
- self.set_title(os.path.basename(fname))
- self.fname = fname
- self.dirname = os.path.dirname(self.fname)
- self.buffer.set_modified(False)
- self.new = 0
- except:
- dlg = gtk.MessageDialog(self, gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR, gtk.BUTTONS_OK,
- "Can't open " + fname)
- resp = dlg.run()
- dlg.hide()
- return
- def create_menu(self):
- ui_string = """<ui>
- <menubar>
- <menu name='FileMenu' action='FileMenu'>
- <menuitem action='FileNew'/>
- <menuitem action='FileOpen'/>
- <menuitem action='FileSave'/>
- <menuitem action='FileSaveAs'/>
- <separator/>
- <menuitem action='FileExit'/>
- </menu>
- <menu name='EditMenu' action='EditMenu'>
- <menuitem action='EditCut'/>
- <menuitem action='EditCopy'/>
- <menuitem action='EditPaste'/>
- <menuitem action='EditClear'/>
- <separator/>
- <menuitem action='EditFind'/>
- <menuitem action='EditFindNext'/>
- </menu>
- <placeholder name='OtherMenus'/>
- <menu name='HelpMenu' action='HelpMenu'>
- <menuitem action='HelpAbout'/>
- </menu>
- </menubar>
- <toolbar>
- <toolitem action='FileNew'/>
- <toolitem action='FileOpen'/>
- <toolitem action='FileSave'/>
- <toolitem action='FileSaveAs'/>
- <separator/>
- <toolitem action='EditCut'/>
- <toolitem action='EditCopy'/>
- <toolitem action='EditPaste'/>
- <toolitem action='EditClear'/>
- </toolbar>
- </ui>
- """
- actions = [
- ('FileMenu', None, '_File'),
- ('FileNew', gtk.STOCK_NEW, None, None, None, self.file_new),
- ('FileOpen', gtk.STOCK_OPEN, None, None, None, self.file_open),
- ('FileSave', gtk.STOCK_SAVE, None, None, None, self.file_save),
- ('FileSaveAs', gtk.STOCK_SAVE_AS, None, None, None,
- self.file_saveas),
- ('FileExit', gtk.STOCK_QUIT, None, None, None, self.file_exit),
- ('EditMenu', None, '_Edit'),
- ('EditCut', gtk.STOCK_CUT, None, None, None, self.edit_cut),
- ('EditCopy', gtk.STOCK_COPY, None, None, None, self.edit_copy),
- ('EditPaste', gtk.STOCK_PASTE, None, None, None, self.edit_paste),
- ('EditClear', gtk.STOCK_REMOVE, 'C_lear', None, None,
- self.edit_clear),
- ('EditFind', gtk.STOCK_FIND, None, None, None, self.edit_find),
- ('EditFindNext', None, 'Find _Next', "F3", None,
- self.edit_find_next),
- ('HelpMenu', gtk.STOCK_HELP),
- ('HelpAbout', None, 'A_bout', None, None, self.help_about),
- ]
- self.ag = gtk.ActionGroup('edit')
- self.ag.add_actions(actions)
- self.ui = gtk.UIManager()
- self.ui.insert_action_group(self.ag, 0)
- self.ui.add_ui_from_string(ui_string)
- self.add_accel_group(self.ui.get_accel_group())
- return (self.ui.get_widget('/menubar'), self.ui.get_widget('/toolbar'))
-
- def chk_save(self):
- if self.buffer.get_modified():
- dlg = gtk.Dialog('Unsaved File', self,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- (gtk.STOCK_YES, gtk.RESPONSE_YES,
- gtk.STOCK_NO, gtk.RESPONSE_NO,
- gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL))
- lbl = gtk.Label((self.fname or "Untitled")+
- " has not been saved\n" +
- "Do you want to save it?")
- lbl.show()
- dlg.vbox.pack_start(lbl)
- ret = dlg.run()
- dlg.hide()
- if ret == gtk.RESPONSE_NO:
- return 0
- if ret == gtk.RESPONSE_YES:
- if self.file_save():
- return 0
- return 1
- return 0
-
- def file_new(self, mi=None):
- if self.chk_save(): return
- self.buffer.set_text('')
- self.buffer.set_modified(False)
- self.fname = None
- self.set_title("Untitled")
- self.new = 1
- return
- def file_open(self, mi=None):
- if self.chk_save(): return
- fname = dialogs.OpenFile('Open File', self, self.dirname, self.fname)
- if not fname: return
- self.load_file(fname)
- return
- def file_save(self, mi=None):
- if self.new:
- return self.file_saveas()
- ret = False
- try:
- start, end = self.buffer.get_bounds()
- blockend = start.copy()
- fd = open(self.fname, "w")
- while blockend.forward_chars(BLOCK_SIZE):
- buf = self.buffer.get_text(start, blockend)
- fd.write(buf)
- start = blockend.copy()
- buf = self.buffer.get_text(start, blockend)
- fd.write(buf)
- fd.close()
- self.buffer.set_modified(False)
- ret = True
- except:
- dlg = gtk.MessageDialog(self, gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR, gtk.BUTTONS_OK,
- "Error saving file " + self.fname)
- resp = dlg.run()
- dlg.hide()
- return ret
- def file_saveas(self, mi=None):
- fname = dialogs.SaveFile('Save File As', self, self.dirname,
- self.fname)
- if not fname: return False
- self.fname = fname
- self.dirname = os.path.dirname(self.fname)
- self.set_title(os.path.basename(fname))
- self.new = 0
- return self.file_save()
- def file_exit(self, mi=None, event=None):
- if self.chk_save(): return True
- self.hide()
- self.destroy()
- if self.quit_cb: self.quit_cb(self)
- return False
- def edit_cut(self, mi):
- self.buffer.cut_clipboard(self.clipboard, True)
- return
- def edit_copy(self, mi):
- self.buffer.copy_clipboard(self.clipboard)
- return
- def edit_paste(self, mi):
- self.buffer.paste_clipboard(self.clipboard, None, True)
- return
- def edit_clear(self, mi):
- self.buffer.delete_selection(True, True)
- return
- def _search(self, search_string, iter = None):
- if iter is None:
- start = self.buffer.get_start_iter()
- else:
- start = iter
- i = 0
- if search_string:
- self.search_string = search_string
- res = start.forward_search(search_string, gtk.TEXT_SEARCH_TEXT_ONLY)
- if res:
- match_start, match_end = res
- self.buffer.place_cursor(match_start)
- self.buffer.select_range(match_start, match_end)
- self.text.scroll_to_iter(match_start, 0.0)
- self.last_search_iter = match_end
-
- else:
- self.search_string = None
- self.last_search_iter = None
-
- def edit_find(self, mi):
- def dialog_response_callback(dialog, response_id):
- if response_id == gtk.RESPONSE_CLOSE:
- dialog.destroy()
- return
- self._search(search_text.get_text(), self.last_search_iter)
- search_text = gtk.Entry()
- s = self.buffer.get_selection_bounds()
- if len(s) > 0:
- search_text.set_text(self.buffer.get_slice(s[0], s[1]))
- dialog = gtk.Dialog("Search", self,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- (gtk.STOCK_FIND, RESPONSE_FORWARD,
- gtk.STOCK_CLOSE, gtk.RESPONSE_CLOSE))
- dialog.vbox.pack_end(search_text, True, True, 0)
- dialog.connect("response", dialog_response_callback)
- search_text.show()
- search_text.grab_focus()
- dialog.show_all()
- response_id = dialog.run()
- def edit_find_next(self, mi):
- self._search(self.search_string, self.last_search_iter)
- def help_about(self, mi):
- dlg = gtk.MessageDialog(self, gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_INFO, gtk.BUTTONS_OK,
- "Copyright (C)\n"
- "1998 James Henstridge\n"
- "2004 John Finlay\n"
- "This program is covered by the GPL>=2")
- dlg.run()
- dlg.hide()
- return
-
-def edit(fname, mainwin=False):
- if mainwin: quit_cb = lambda w: gtk.main_quit()
- else: quit_cb = None
- w = EditWindow(quit_cb=quit_cb)
- w.load_file(fname)
- w.show()
- w.set_size_request(0,0)
- if mainwin: gtk.main()
- return
-
-if __name__ == '__main__':
- import sys
- edit(sys.argv[-1], mainwin=True)
diff --git a/examples/ide/edit.xpm b/examples/ide/edit.xpm
deleted file mode 100644
index a2291f36..00000000
--- a/examples/ide/edit.xpm
+++ /dev/null
@@ -1,38 +0,0 @@
-/* XPM */
-static char *edit[] = {
-/* width height num_colors chars_per_pixel */
-" 20 22 8 1",
-/* colors */
-". c #ffffff",
-"# c None",
-"a c #9999ff",
-"b c #999999",
-"c c #6666cc",
-"d c #663399",
-"e c #333333",
-"f c #000000",
-/* pixels */
-"eeeeeeeeeeeee#######",
-"e..........e.e######",
-"e..........e..eeffff",
-"e..........e.effadf#",
-"e..........effacdf##",
-"e.........ffaccdff##",
-"e........facccdfbf##",
-"e.......faccddfbbf##",
-"e......faccddf..bf##",
-"e.....faccddf...bf##",
-"e....faccddf....bf##",
-"e...eaccddf.....bf##",
-"e...facddf......bf##",
-"e..eacddf.......bf##",
-"e..faeff........bf##",
-"e.eaeb..........bf##",
-"e.feb...........bf##",
-"e.fb............bf##",
-"e.f.............bf##",
-"e...............bf##",
-"eebbbbbbbbbbbbbbef##",
-"##ffffffffffffffff##"
-};
-
diff --git a/examples/ide/gtkcons.py b/examples/ide/gtkcons.py
deleted file mode 100755
index 770d5859..00000000
--- a/examples/ide/gtkcons.py
+++ /dev/null
@@ -1,330 +0,0 @@
-#!/usr/bin/env python
-
-# Interactive Python-GTK Console
-# Copyright (C),
-# 1998 James Henstridge
-# 2004 John Finlay
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-# This module implements an interactive python session in a GTK window. To
-# start the session, use the gtk_console command. Its specification is:
-# gtk_console(namespace, title, copyright)
-# where namespace is a dictionary representing the namespace of the session,
-# title is the title on the window and
-# copyright is any additional copyright info to print.
-#
-# As well as the starting attributes in namespace, the session will also
-# have access to the list __history__, which is the command history.
-
-import sys, string, traceback
-import pygtk
-pygtk.require('2.0')
-import gobject
-import gtk
-
-stdout = sys.stdout
-
-if not hasattr(sys, 'ps1'): sys.ps1 = '>>> '
-if not hasattr(sys, 'ps2'): sys.ps2 = '... '
-
-# some functions to help recognise breaks between commands
-def remQuotStr(s):
- '''Returns s with any quoted strings removed (leaving quote marks)'''
- r = ''
- inq = 0
- qt = ''
- prev = '_'
- while len(s):
- s0, s = s[0], s[1:]
- if inq and (s0 != qt or prev == '\\'):
- prev = s0
- continue
- prev = s0
- if s0 in '\'"':
- if inq:
- inq = 0
- else:
- inq = 1
- qt = s0
- r = r + s0
- return r
-
-def bracketsBalanced(s):
- '''Returns true iff the brackets in s are balanced'''
- s = filter(lambda x: x in '()[]{}', s)
- stack = []
- brackets = {'(':')', '[':']', '{':'}'}
- while len(s) != 0:
- if s[0] in ")]}":
- if len(stack) != 0 and brackets[stack[-1]] == s[0]:
- del stack[-1]
- else:
- return 0
- else:
- stack.append(s[0])
- s = s[1:]
- return len(stack) == 0
-
-class gtkoutfile:
- '''A fake output file object. It sends output to a GTK TextView widget,
- and if asked for a file number, returns one set on instance creation'''
- def __init__(self, w, fn, font):
- self.__fn = fn
- self.__w = w
- self.__b = w.get_buffer()
- self.__ins = self.__b.get_mark('insert')
- self.__font = font
- def close(self): pass
- flush = close
- def fileno(self): return self.__fn
- def isatty(self): return 0
- def read(self, a): return ''
- def readline(self): return ''
- def readlines(self): return []
- def write(self, s):
- #stdout.write(str(self.__w.get_point()) + '\n')
- iter = self.__b.get_iter_at_mark(self.__ins)
- self.__b.insert_with_tags(iter, s, self.__font)
- self.__w.scroll_to_mark(self.__ins, 0.0)
- self.__w.queue_draw()
- def writelines(self, l):
- iter = self.__b.get_iter_at_mark(self.__ins)
- for s in l:
- self.__b.insert_with_tags(iter, s, self.__font)
- self.__w.scroll_to_mark(self.__ins, 0.0)
- self.__w.queue_draw()
- def seek(self, a): raise IOError, (29, 'Illegal seek')
- def tell(self): raise IOError, (29, 'Illegal seek')
- truncate = tell
-
-class Console(gtk.VBox):
- def __init__(self, namespace={}, copyright='', quit_cb=None):
- gtk.VBox.__init__(self, spacing=2)
- self.set_border_width(2)
- self.copyright = copyright
- #self.set_size_request(475, 300)
-
- self.quit_cb = quit_cb
-
- self.inp = gtk.HBox()
- self.pack_start(self.inp)
- self.inp.show()
-
- self.scrolledwin = gtk.ScrolledWindow()
- self.scrolledwin.show()
- self.inp.pack_start(self.scrolledwin, padding=1)
- self.text = gtk.TextView()
- self.text.set_editable(False)
- self.text.set_wrap_mode(gtk.WRAP_WORD)
- self.text.set_size_request(500, 400)
- self.scrolledwin.add(self.text)
- self.text.show()
- self.buffer = self.text.get_buffer()
- #create the tags we will use
- self.normal = self.buffer.create_tag('Normal', font='Helvetica 10',
- foreground='black')
- self.title = self.buffer.create_tag('Title', font='Helvetica Bold 10',
- foreground='darkgreen')
- self.error = self.buffer.create_tag('Error', font='Helvetica 12',
- foreground='red')
- self.command = self.buffer.create_tag('Command',
- font='Helvetica Bold 10',
- foreground='blue')
-
- self.inputbox = gtk.HBox(spacing=2)
- self.pack_end(self.inputbox, expand=False)
- self.inputbox.show()
-
- self.prompt = gtk.Label(sys.ps1)
- self.prompt.set_padding(xpad=2, ypad=0)
- self.prompt.set_size_request(26, -1)
- self.inputbox.pack_start(self.prompt, fill=False, expand=False)
- self.prompt.show()
-
- self.closer = gtk.Button(stock=gtk.STOCK_CLOSE)
- self.closer.connect("clicked", self.quit)
- self.inputbox.pack_end(self.closer, fill=False, expand=False)
- self.closer.show()
-
- self.line = gtk.Entry()
- self.line.set_size_request(400,-1)
- self.line.connect("key_press_event", self.key_function)
- self.inputbox.pack_start(self.line, padding=2)
- self.line.show()
-
- # now let the text box be resized
- self.text.set_size_request(0, 0)
- self.line.set_size_request(0, -1)
-
- self.namespace = namespace
-
- self.cmd = ''
- self.cmd2 = ''
-
- # set up hooks for standard output.
- self.stdout = gtkoutfile(self.text, sys.stdout.fileno(),
- self.normal)
- self.stderr = gtkoutfile(self.text, sys.stderr.fileno(),
- self.error)
-
- # set up command history
- self.history = ['']
- self.histpos = 0
- self.namespace['__history__'] = self.history
-
- def init(self):
- self.text.realize()
- self.insert = self.buffer.get_mark('insert')
- iter = self.buffer.get_iter_at_mark(self.insert)
- self.buffer.insert_with_tags(iter, 'Python %s\n%s\n\n' %
- (sys.version, sys.copyright) +
- 'Interactive Python-GTK Console - \n' +
- 'Copyright (C)\n' \
- '1998 James Henstridge\n' \
- '2004 John Finlay\n\n' +
- self.copyright + '\n', self.title)
- self.text.scroll_to_mark(self.insert, 0.0)
- self.line.grab_focus()
-
- def quit(self, *args):
- self.hide()
- self.destroy()
- if self.quit_cb: self.quit_cb()
-
- def key_function(self, entry, event):
- if event.keyval == gtk.keysyms.Return:
- self.line.emit_stop_by_name("key_press_event")
- self.eval()
- if event.keyval == gtk.keysyms.Tab:
- self.line.emit_stop_by_name("key_press_event")
- self.line.append_text('\t')
- gobject.idle_add(self.focus_text)
- elif event.keyval in (gtk.keysyms.KP_Up, gtk.keysyms.Up):
- self.line.emit_stop_by_name("key_press_event")
- self.historyUp()
- gobject.idle_add(self.focus_text)
- elif event.keyval in (gtk.keysyms.KP_Down, gtk.keysyms.Down):
- self.line.emit_stop_by_name("key_press_event")
- self.historyDown()
- gobject.idle_add(self.focus_text)
- elif event.keyval in (gtk.keysyms.D, gtk.keysyms.d) and \
- event.state & gtk.gdk.CONTROL_MASK:
- self.line.emit_stop_by_name("key_press_event")
- self.ctrld()
-
- def focus_text(self):
- self.line.grab_focus()
- return False # don't requeue this handler
-
- def ctrld(self):
- self.quit()
-
- def historyUp(self):
- if self.histpos > 0:
- l = self.line.get_text()
- if len(l) > 0 and l[0] == '\n': l = l[1:]
- if len(l) > 0 and l[-1] == '\n': l = l[:-1]
- self.history[self.histpos] = l
- self.histpos = self.histpos - 1
- self.line.set_text(self.history[self.histpos])
-
- def historyDown(self):
- if self.histpos < len(self.history) - 1:
- l = self.line.get_text()
- if len(l) > 0 and l[0] == '\n': l = l[1:]
- if len(l) > 0 and l[-1] == '\n': l = l[:-1]
- self.history[self.histpos] = l
- self.histpos = self.histpos + 1
- self.line.set_text(self.history[self.histpos])
-
- def eval(self):
- l = self.line.get_text() + '\n'
- if len(l) > 1 and l[0] == '\n': l = l[1:]
- self.histpos = len(self.history) - 1
- if len(l) > 0 and l[-1] == '\n':
- self.history[self.histpos] = l[:-1]
- else:
- self.history[self.histpos] = l
- self.line.set_text('')
- iter = self.buffer.get_iter_at_mark(self.insert)
- self.buffer.insert_with_tags(iter, self.prompt.get() + l, self.command)
- self.text.scroll_to_mark(self.insert, 0.0)
- if l == '\n':
- self.run(self.cmd)
- self.cmd = ''
- self.cmd2 = ''
- return
- self.histpos = self.histpos + 1
- self.history.append('')
- self.cmd = self.cmd + l
- self.cmd2 = self.cmd2 + remQuotStr(l)
- l = string.rstrip(l)
- if not bracketsBalanced(self.cmd2) or l[-1] == ':' or \
- l[-1] == '\\' or l[0] in ' \11':
- self.prompt.set_text(sys.ps2)
- self.prompt.queue_draw()
- return
- self.run(self.cmd)
- self.cmd = ''
- self.cmd2 = ''
-
- def run(self, cmd):
- sys.stdout, self.stdout = self.stdout, sys.stdout
- sys.stderr, self.stderr = self.stderr, sys.stderr
- try:
- try:
- r = eval(cmd, self.namespace, self.namespace)
- if r is not None:
- print `r`
- except SyntaxError:
- exec cmd in self.namespace
- except:
- if hasattr(sys, 'last_type') and \
- sys.last_type == SystemExit:
- self.quit()
- else:
- traceback.print_exc()
- self.prompt.set_text(sys.ps1)
- self.prompt.queue_draw()
- sys.stdout, self.stdout = self.stdout, sys.stdout
- sys.stderr, self.stderr = self.stderr, sys.stderr
-
-def gtk_console(ns, title='Python', copyright='', menu=None):
- win = gtk.Window()
- win.set_size_request(475, 300)
- win.connect("destroy", lambda w: gtk.main_quit())
- win.connect("delete_event", lambda w,e: gtk.main_quit())
- win.set_title(title)
- cons = Console(namespace=ns, copyright=copyright,
- quit_cb=lambda w: gtk.main_quit())
- if menu:
- box = gtk.VBox()
- win.add(box)
- box.show()
- box.pack_start(menu, expand=False)
- menu.show()
- box.pack_start(cons)
- else:
- win.add(cons)
- cons.show()
- win.show()
- win.set_size_request(0,0)
- cons.init()
- gtk.main()
-
-if __name__ == '__main__':
- gtk_console({'__builtins__': __builtins__, '__name__': '__main__',
- '__doc__': None})
diff --git a/examples/ide/gtkdb.py b/examples/ide/gtkdb.py
deleted file mode 100755
index cb33d150..00000000
--- a/examples/ide/gtkdb.py
+++ /dev/null
@@ -1,434 +0,0 @@
-#!/usr/bin/env python
-
-import sys
-import bdb
-import repr
-import string
-import linecache # for linecache.getlines(filename)
-import pygtk
-pygtk.require('2.0')
-import gtk
-import dialogs
-
-class PyGTKDb(gtk.Window, bdb.Bdb):
- ui_string = """<ui>
- <toolbar name='Toolbar'>
- <toolitem action='Next'/>
- <toolitem action='Step'/>
- <separator/>
- <toolitem action='Return'/>
- <separator/>
- <toolitem action='Continue'/>
- <toolitem action='Break'/>
- <separator/>
- <toolitem action='Edit'/>
- <toolitem action='Run'/>
- <separator/>
- <toolitem action='Quit'/>
- </toolbar>
- </ui>"""
- def __init__(self):
- gtk.Window.__init__(self)
- bdb.Bdb.__init__(self)
- self.realize()
-
- self.set_title("PyGTKDb")
- self.connect("destroy", self.do_quit)
- self.connect("delete_event", self.do_quit)
-
- self.box = gtk.VBox()
- self.add(self.box)
- self.box.show()
-
- self.add_stock_ids()
-
- actions = [
- ('Next', 'pyide-next', None, None, "Next statement", self.do_next),
- ('Step', 'pyide-step', None, None, "Step into function",
- self.do_step),
- ('Return', 'pyide-return', None, None,
- "Continue execution to end of function", self.do_return),
- ('Continue', 'pyide-continue', None, None,
- "Continue execution to next break point", self.do_continue),
- ('Break', 'pyide-break', None, None,
- "Toggle break point at selected line", self.do_break),
- ('Edit', 'pyide-edit', None, None,
- "Edit the value of the selected variable", self.do_edit),
- ('Run', 'pyide-run', None, None,
- "Execute some code in the current stack context", self.do_run),
- ('Quit', 'pyide-quit', None, None, "Quit the debugger",
- self.do_quit),
- ]
-
- self.ag = gtk.ActionGroup('PyIDE Actions')
- self.ag.add_actions(actions)
- self.ui = gtk.UIManager()
- self.ui.insert_action_group(self.ag, 0)
- self.ui.add_ui_from_string(self.ui_string)
- self.add_accel_group(self.ui.get_accel_group())
-
- self.box.pack_start(self.ui.get_widget('/Toolbar'), expand=False)
- sep = gtk.HSeparator()
- self.box.pack_start(sep, expand=False)
- sep.show()
-
- vpane = gtk.VPaned()
- self.box.pack_start(vpane)
- vpane.show()
-
- hpane = gtk.HPaned()
- vpane.add1(hpane)
- hpane.show()
-
- swin = gtk.ScrolledWindow()
- swin.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- hpane.add1(swin)
- swin.show()
-
- ls = gtk.ListStore(str)
- self.stackdisp = gtk.TreeView(ls)
- tvc = gtk.TreeViewColumn('Stack Frame', gtk.CellRendererText(),
- text=0)
- self.stackdisp.append_column(tvc)
- self.stackdisp.set_size_request(280, 125)
- selection = self.stackdisp.get_selection()
- selection.set_mode(gtk.SELECTION_BROWSE)
- selection.connect("changed", self.update_curstack)
-
- self.stackdisp.set_border_width(2)
- swin.add(self.stackdisp)
- self.stackdisp.show()
-
- swin = gtk.ScrolledWindow()
- swin.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- hpane.add2(swin)
- swin.show()
-
- ls = gtk.ListStore(str, str, str)
- self.vardisp = gtk.TreeView(ls)
- titles = ['local var', 'type', 'value']
- for n in range(len(titles)):
- tvc = gtk.TreeViewColumn(titles[n], gtk.CellRendererText(),
- text=n)
- self.vardisp.append_column(tvc)
-
- selection = self.vardisp.get_selection()
- selection.set_mode(gtk.SELECTION_BROWSE)
- selection.connect("changed", self.update_selectedvar)
- self.vardisp.set_border_width(2)
-
- self.vardisp.set_border_width(2)
- swin.add(self.vardisp)
- self.vardisp.show()
- self.vardisp.selected = 0
- self.vardisp.varnames = []
-
- swin = gtk.ScrolledWindow()
- swin.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- vpane.add2(swin)
- swin.show()
-
- self.minibreak = gtk.Image()
- self.minibreak.set_from_file("minibreak.xpm")
- self.minibreak.show()
- ls = gtk.ListStore(gtk.gdk.Pixbuf, str, str)
- self.filedisp = gtk.TreeView(ls)
- titles = ['break', 'lineno', 'line']
- cell = gtk.CellRendererPixbuf()
- tvc = gtk.TreeViewColumn(None, cell, pixbuf=0)
- tvc.set_min_width(14)
- tvc.set_widget(self.minibreak)
- self.filedisp.append_column(tvc)
- cell = gtk.CellRendererText()
- cell.set_property('xalign', 1.0)
- tvc = gtk.TreeViewColumn(titles[1], cell, text=1)
- self.filedisp.append_column(tvc)
- cell = gtk.CellRendererText()
- tvc = gtk.TreeViewColumn(titles[2], cell, text=2)
- self.filedisp.append_column(tvc)
- self.minibreak = self.minibreak.get_pixbuf()
- selection = self.filedisp.get_selection()
- selection.set_mode(gtk.SELECTION_BROWSE)
- selection.connect("changed", self.update_selection)
- self.filedisp.connect('row-activated', lambda t,p,c: self.do_break())
- self.filedisp.set_border_width(2)
- self.filedisp.set_size_request(600, 200)
- swin.add(self.filedisp)
- self.filedisp.show()
-
- separator = gtk.HSeparator()
- self.box.pack_start(separator, expand=False)
- separator.show()
-
- align = gtk.Alignment(0.0, 0.5, 0.0, 0.0)
- self.box.pack_start(align, expand=False)
- align.show()
- self.status = gtk.Label()
- self.status.set_padding(4, 1)
- align.add(self.status)
- self.status.show()
-
- self.filename = None
- self.selected = 0
- self.blockupdate = 0
- return
-
- def add_stock_ids(self):
- ids = [
- ('pyide-next', '_Next', gtk.gdk.CONTROL_MASK, gtk.keysyms.N,
- 'pyide'),
- ('pyide-step', '_Step', gtk.gdk.CONTROL_MASK, gtk.keysyms.S,
- 'pyide'),
- ('pyide-return', '_Return', gtk.gdk.CONTROL_MASK, gtk.keysyms.R,
- 'pyide'),
- ('pyide-continue', '_Continue', gtk.gdk.CONTROL_MASK,
- gtk.keysyms.C, 'pyide'),
- ('pyide-break', '_Break', gtk.gdk.CONTROL_MASK, gtk.keysyms.B,
- 'pyide'),
- ('pyide-edit', '_Edit', gtk.gdk.CONTROL_MASK, gtk.keysyms.E,
- 'pyide'),
- ('pyide-run', 'R_un', gtk.gdk.CONTROL_MASK, gtk.keysyms.U,
- 'pyide'),
- ('pyide-quit', '_Quit', gtk.gdk.CONTROL_MASK, gtk.keysyms.Q,
- 'pyide'),
- ]
- gtk.stock_add(ids)
- names = ['next', 'step', 'return', 'continue', 'break',
- 'edit', 'run', 'quit']
- self.iconfactory = gtk.IconFactory()
- for name in names:
- iconset = gtk.IconSet(gtk.gdk.pixbuf_new_from_file(name+'.xpm'))
- self.iconfactory.add('pyide-'+name, iconset)
- self.iconfactory.add_default()
- return
-
- def set_status(self, str):
- self.status.set_text(str)
- return
- def update_selection(self, sel):
- if self.blockupdate: return
- model, iter = sel.get_selected()
- r = model.get_path(iter)[0]
- self.selected = r + 1
- return
- def update_curstack(self, sel):
- if self.blockupdate: return
- model, iter = sel.get_selected()
- r = model.get_path(iter)[0]
- self.curindex = r
- self.curframe = self.stack[self.curindex][0]
- self.lineno = None
- self.update_code_listing()
- self.update_var_listing()
- return
- def update_selectedvar(self, sel):
- model, iter = sel.get_selected()
- if iter:
- r = model.get_path(iter)[0]
- self.vardisp.selected = r
- return
- def set_quit(self):
- self.hide()
- self.destroy()
- bdb.Bdb.set_quit(self)
-
- def reset(self):
- bdb.Bdb.reset(self)
- self.forget()
- def forget(self):
- self.lineno = None
- self.stack = []
- self.curindex = 0
- self.curframe = None
- def setup(self, f, t):
- self.forget()
- self.stack, self.curindex = self.get_stack(f, t)
- self.curframe = self.stack[self.curindex][0]
- return
- # interaction functions -- overriden from bdb
- def user_line(self, frame):
- # called when we stop or break at this line
- self.interaction(frame, None)
- def user_return(self, frame, return_value):
- # called when a return trap is set here
- frame.f_locals['__return__'] = return_value
- if frame.f_code.co_name:
- func = frame.f_code.co_name
- else:
- func = "<lambda>"
- self.set_status(func + " returned " + repr.repr(return_value))
- self.interaction(frame, None)
- def user_exception(self, frame, (exc_type, exc_value, exc_traceback)):
- frame.f_locals['__exception__'] = exc_type, exc_value
- if type(exc_type) == type(''):
- exc_type_name = exc_type
- else: exc_type_name = exc_type.__name__
- self.set_status(exc_type_name + ':' + repr.repr(exc_value))
- self.interaction(frame, exc_traceback)
-
- def interaction(self, frame, traceback):
- self.setup(frame, traceback)
- self.update_stack_listing(self.curindex)
- gtk.main()
- self.forget()
-
- def update_stack_listing(self, curindex):
- self.blockupdate = 1
- model = self.stackdisp.get_model()
- model.clear()
- for i in range(len(self.stack)):
- frame_lineno = self.stack[i]
- row = self.format_stack_entry(frame_lineno, "##!##")
- row = string.split(row, "##!##")[0]
- model.append([row])
- self.blockupdate = 0
- self.stackdisp.scroll_to_cell(curindex, None, True, 1.0, 0.0)
- self.stackdisp.get_selection().select_path(curindex)
- return
- def update_var_listing(self):
- model = self.vardisp.get_model()
- model.clear()
- locals = self.curframe.f_locals
- self.vardisp.varnames = locals.keys()
- self.vardisp.varnames.sort()
- for var in self.vardisp.varnames:
- row = [var, type(locals[var]).__name__, repr.repr(locals[var])]
- model.append(row)
- self.vardisp.get_selection().select_path(0)
- return
- def update_code_listing(self):
- frame = self.curframe
- newfile = frame.f_code.co_filename
- if newfile != self.filename:
- lines = linecache.getlines(newfile)
- self.filename = newfile
- self.blockupdate = 1
- model = self.filedisp.get_model()
- model.clear()
- breaks = self.get_file_breaks(newfile)
- for line in range(len(lines)):
- if line+1 in breaks:
- model.append([self.minibreak, line+1,
- lines[line].rstrip()])
- else:
- model.append([None, line+1, lines[line].rstrip()])
- self.blockupdate = 0
- self.selected = frame.f_lineno
- lineno = self.selected
- if newfile != '<string>':
- self.filedisp.scroll_to_cell(lineno - 1, None, True, 1.0, 0.0)
- self.filedisp.get_selection().select_path(lineno - 1)
- return
- def do_next(self, _b=None):
- self.set_next(self.curframe)
- gtk.main_quit()
- def do_step(self, _b=None):
- self.set_step()
- gtk.main_quit()
- def do_return(self, _b=None):
- self.set_return(self.curframe)
- gtk.main_quit()
- def do_continue(self, _b=None):
- self.set_continue()
- gtk.main_quit()
- def do_quit(self, _b=None, _e=None):
- self.set_quit()
- gtk.main_quit()
- def do_break(self, _b=None):
- breaks = self.get_file_breaks(self.filename)
- if self.selected in breaks:
- err = self.clear_break(self.filename, self.selected)
- if err:
- self.set_status(err)
- return
- self.filedisp.get_model()[self.selected-1][0] = None
- else:
- err = self.set_break(self.filename, self.selected)
- if err:
- self.set_status(err)
- return
- self.filedisp.get_model()[self.selected-1][0] = self.minibreak
- return
- def do_run(self, _b=None):
- line = dialogs.InputBox("Execute Code", "Enter code to execute:", self)
- if line == None: return
- locals = self.curframe.f_locals
- globals = self.curframe.f_globals
- globals['__privileged__'] = 1
- try:
- code = compile(line + '\n', '<stdin>', 'single')
- exec code in globals, locals
- except:
- if type(sys.exc_type) == type(''):
- exc_type_name = sys.exc_type
- else: exc_type_name = sys.exc_type.__name__
- self.set_status('*** ' + exc_type_name + ': ' +
- str(sys.exc_value))
- return
- self.update_var_listing()
- return
- def do_edit(self, _b=None):
- locals = self.curframe.f_locals
- varname = self.vardisp.varnames[self.vardisp.selected]
- val = repr.repr(locals[varname])
- value = dialogs.InputBox("Edit Variable",
- "Enter new value for " + varname + ":",
- self, val)
- if value == None: return
- globals = self.curframe.f_globals
- globals['__privileged__'] = 1
- try:
- val = eval(value, globals, locals)
- self.curframe.f_locals[varname] = val
- except:
- if type(sys.exc_type) == type(''):
- exc_type_name = sys.exc_type
- else: exc_type_name = sys.exc_type.__name__
- self.set_status('*** ' + exc_type_name + ': ' +
- str(sys.exc_value))
- return
- row = self.vardisp.selected
- model = self.vardisp.get_model()
- model[row][1] = type(val).__name__
- model[row][2] = repr.repr(val)
-
-# this makes up the interface that is compatible with pdb.
-def run(statement, globals=None, locals=None):
- win = PyGTKDb()
- win.show()
- win.run(statement, globals, locals)
-
-def runeval(expression, globals=None, locals=None):
- win = PyGTKDb()
- win.show()
- return win.runeval(expression, globals, locals)
-
-def runcall(*args):
- win = PyGTKDb()
- win.show()
- return apply(win.runcall, args)
-
-def set_trace():
- win = PyGTKDb()
- win.show()
- win.set_trace()
-
-def post_mortem(traceback):
- win = PyGTKDb()
- win.show()
- win.reset()
- win.interaction(None, traceback)
-
-def pm():
- post_mortem(sys.last_traceback)
-
-if __name__ == '__main__':
- import os
- if not sys.argv[1:]:
- print "usage: gtkdb.py scriptfile [args ...]"
- sys.exit(2)
- filename = sys.argv[1]
- del sys.argv[0] # delete gtkdb.py
- sys.path.insert(0, os.path.dirname(filename))
-
- run('execfile("' + filename + '")', {'__name__': '__main__'})
diff --git a/examples/ide/gtkprof.py b/examples/ide/gtkprof.py
deleted file mode 100755
index 649456f0..00000000
--- a/examples/ide/gtkprof.py
+++ /dev/null
@@ -1,133 +0,0 @@
-#!/usr/bin/env python
-
-import profile, pstats, fpformat
-
-import pygtk
-pygtk.require('2.0')
-import gtk
-
-class PStatWindow(gtk.Window):
- def __init__(self, stats):
- gtk.Window.__init__(self)
- self.connect("destroy", self.quit)
- self.connect("delete_event", self.quit)
- self.set_title("Profile Statistics")
-
- self.stats = stats
-
- box1 = gtk.VBox()
- self.add(box1)
- box1.show()
-
- text = `stats.total_calls` + " function calls "
- if stats.total_calls != stats.prim_calls:
- text = text + "( " + `stats.prim_calls` + " primitive calls) "
- text = text + "in " + fpformat.fix(stats.total_tt, 3) + " CPU seconds"
- label = gtk.Label(text)
- label.set_padding(2, 2)
- box1.pack_start(label, expand=False)
- label.show()
-
- swin = gtk.ScrolledWindow()
- swin.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- box1.pack_start(swin)
- swin.show()
-
- titles = [('ncalls', 40), ('tottime', 50), ('percall', 50),
- ('cumtime', 50), ('percall', 50),
- ('filename:lineno(function)', 10)]
- ls = gtk.ListStore(*((str,)*len(titles)))
- list = gtk.TreeView(ls)
- for n in range(len(titles)):
- cell = gtk.CellRendererText()
- cell.set_property('xalign', 1.0)
- tvc = gtk.TreeViewColumn(titles[n][0], cell, text=n)
- tvc.set_min_width(titles[n][1])
- list.append_column(tvc)
- list.set_size_request(500, 200)
- self.list = list
- list.set_border_width(10)
- swin.add(list)
- list.show()
-
- self.insert_stats()
-
- separator = gtk.HSeparator()
- box1.pack_start(separator, expand=False)
- separator.show()
-
- box2 = gtk.VBox(spacing=10)
- box2.set_border_width(10)
- box1.pack_start(box2, expand=False)
- box2.show()
-
- button = gtk.Button("close")
- button.connect("clicked", self.quit)
- self.close_button = button
- box2.pack_start(button)
- button.set_flags(gtk.CAN_DEFAULT)
- button.grab_default()
- button.show()
-
- def quit(self, *args):
- self.hide()
- self.destroy()
- gtk.main_quit()
-
- def get_stats_list(self):
- if self.stats.fcn_list:
- return self.stats.fcn_list[:]
- else:
- return self.stats.stats.keys()
-
- def insert_stats(self):
- list = self.get_stats_list()
- if list:
- row = [None] * 6
- model = self.list.get_model()
- for func in list:
- cc,nc,tt,ct,callers = self.stats.stats[func]
- row[0] = `nc`
- if nc != cc:
- row[0] = row[0] + '/' + `cc`
- row[1] = fpformat.fix(tt, 3)
- if nc == 0:
- row[2] = ''
- else:
- row[2] = fpformat.fix(tt/nc, 3)
- row[3] = fpformat.fix(ct, 3)
- if cc == 0:
- row[4] = ''
- else:
- row[4] = fpformat.fix(ct/cc, 3)
- file,line,name = func
- row[5] = file + ":" + `line` + "(" + name + \
- ")"
- self.list.get_model().append(row)
- return
-
-def run(cmd):
- prof = profile.Profile()
- try:
- stats = pstats.Stats(prof.run(cmd))
- except SystemExit:
- pass
- stats.strip_dirs().sort_stats("time", "module", "name")
- win = PStatWindow(stats)
- win.show()
- gtk.main()
-
-def run_file(file):
- return run('execfile("' + file + '")')
-
-
-if __name__ == '__main__':
- import sys, os
- if not sys.argv[1:]:
- print "usage: gtkprof.py scriptfile [args ...]"
- sys.exit(2)
- filename = sys.argv[1]
- del sys.argv[0]
- sys.path.insert(0, os.path.dirname(filename))
-
- run_file(filename)
diff --git a/examples/ide/minibreak.xpm b/examples/ide/minibreak.xpm
deleted file mode 100644
index 6fd11e7c..00000000
--- a/examples/ide/minibreak.xpm
+++ /dev/null
@@ -1,19 +0,0 @@
-/* XPM */
-static char * minibreak_xpm[] = {
-"12 12 4 1",
-" c None",
-". c #000000",
-"X c #FF0000",
-"o c #FFFFFF",
-" ...... ",
-" .oooooo. ",
-" .ooXXXXoo. ",
-".ooXXXXXXoo.",
-".oXXXXXXXXo.",
-".oXXXXXXXXo.",
-".oXXXXXXXXo.",
-".oXXXXXXXXo.",
-".ooXXXXXXoo.",
-" .ooXXXXoo. ",
-" .oooooo. ",
-" ...... "};
diff --git a/examples/ide/next.xpm b/examples/ide/next.xpm
deleted file mode 100644
index 6c0cf361..00000000
--- a/examples/ide/next.xpm
+++ /dev/null
@@ -1,32 +0,0 @@
-/* XPM */
-static char *next[] = {
-/* width height num_colors chars_per_pixel */
-" 20 22 2 1",
-/* colors */
-". c None",
-"# c #000000",
-/* pixels */
-"....................",
-"....................",
-"......#.............",
-"......##............",
-"......###...........",
-"......####..........",
-"......#####.........",
-"......######........",
-"......#######.......",
-"......########......",
-"......#########.....",
-"......#########.....",
-"......########......",
-"......#######.......",
-"......######........",
-"......#####.........",
-"......####..........",
-"......###...........",
-"......##............",
-"......#.............",
-"....................",
-"...................."
-};
-
diff --git a/examples/ide/pyide.py b/examples/ide/pyide.py
deleted file mode 100755
index 9b6ea524..00000000
--- a/examples/ide/pyide.py
+++ /dev/null
@@ -1,260 +0,0 @@
-#!/usr/bin/env python
-
-import pygtk
-pygtk.require('2.0')
-import gtk
-import gtkcons, gtkdb, gtkprof, edit, dialogs
-import os, sys, string
-
-# select a good VT emulator
-for vt in 'Eterm', 'nxterm', 'xterm-color', 'xterm', 'rxvt':
- for dirname in string.split(os.environ['PATH'], os.pathsep):
- fullname = os.path.join(dirname, vt)
- if os.path.exists(fullname):
- VT_CMD = fullname + ' -geometry 80x6 -e '
- break
- else:
- continue
- break
-else:
- VT_CMD='' # this is not ideal
-
-ui_string = """<ui>
-<menubar>
- <menu action='FileMenu'>
- <menuitem action='FileNew'/>
- <menuitem action='FileOpen'/>
- <separator/>
- <menuitem action='FileExit'/>
- </menu>
- <menu action='EditMenu'>
- <menuitem action='EditCopy'/>
- <menuitem action='EditPaste'/>
- <menuitem action='EditClear'/>
- </menu>
- <placeholder name='OtherMenus'/>
- <menu action='HelpMenu' position='bot'>
- <menuitem action='HelpAbout'/>
- </menu>
-</menubar>
-</ui>
-"""
-pythonmenu_uistring = """<ui>
-<menubar>
- <placeholder name='OtherMenus'>
- <menu name='PythonMenu' action='PythonMenu'>
- <menuitem action='PythonReload'/>
- <menuitem action='PythonRun'/>
- <menuitem action='PythonDebug'/>
- <menuitem action='PythonProfile'/>
- </menu>
- </placeholder>
-</menubar>
-</ui>
-"""
-
-class Application(gtk.Window):
- def __init__(self):
- gtk.Window.__init__(self, gtk.WINDOW_TOPLEVEL)
- self.connect("destroy", self.quit)
- self.connect("delete_event", self.quit)
- self.set_title("Python")
- self.set_size_request(475, 325)
- self.main_box = gtk.VBox()
- self.add(self.main_box)
- self.main_box.show()
- hdlbox = gtk.HandleBox()
- self.main_box.pack_start(hdlbox, expand=False)
- hdlbox.show()
- actions = [
- ('FileMenu', None, '_File'),
- ('FileNew', gtk.STOCK_NEW, None, None, None, self.file_new),
- ('FileOpen', gtk.STOCK_OPEN, None, None, None, self.file_open),
- ('FileExit', gtk.STOCK_QUIT, None, None, None, self.file_exit),
- ('EditMenu', None, '_Edit'),
- ('EditCopy', gtk.STOCK_COPY, None, None, None, self.edit_copy),
- ('EditPaste', gtk.STOCK_PASTE, None, None, None, self.edit_paste),
- ('EditClear', gtk.STOCK_REMOVE, 'C_lear', None, None,
- self.edit_clear),
- ('HelpMenu', gtk.STOCK_HELP),
- ('HelpAbout', None, 'A_bout', None, None, self.help_about),
- ]
- python_actions = [
- ('PythonMenu', None, '_Python'),
- ('PythonReload', None, '_Reload Module...', None, None,
- self.python_reload),
- ('PythonRun', None, 'R_un...', None, None, self.python_run),
- ('PythonDebug', None, '_Debug...', None, None, self.python_debug),
- ('PythonProfile', None, 'Pro_file...', None, None,
- self.python_prof),
- ]
- self.ag = gtk.ActionGroup('ide')
- self.ag.add_actions(actions)
- self.ag.add_actions(python_actions)
- self.ui = gtk.UIManager()
- self.ui.insert_action_group(self.ag, 0)
- self.ui.add_ui_from_string(ui_string)
- self.ui.add_ui_from_string(pythonmenu_uistring)
- self.add_accel_group(self.ui.get_accel_group())
- hdlbox.add(self.ui.get_widget('/menubar'))
- #self.ui.get_widget('/menubar').show()
- self.interp = gtkcons.Console(
- namespace={'__builtins__': __builtins__,
- '__name__': '__main__',
- '__doc__': None}, quit_cb=self.quit)
- self.main_box.pack_start(self.interp)
- self.interp.show()
- self.interp.init()
- self.editwins = []
- return
-
- def quit(self, *args):
- for win in self.editwins:
- if win.chk_save(): return
- win.hide()
- win.destroy()
- gtk.main_quit()
- return
-
- def reload_file(self, fname):
- if not os.path.isfile(fname):
- gtk.MessageDialog(self, gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR, gtk.BUTTONS_OK,
- fname + " was not found.")
- return
- dir = os.path.dirname(fname)
- base = os.path.basename(fname)
- if dir not in sys.path: sys.path.insert(0, dir)
- if string.lower(base[-3:]) == '.py': base = base[:-3]
- elif string.lower(base[-4:]) == '.pyc': base = base[:-4]
- if not sys.modules.has_key(base):
- self.interp.run('import ' + base)
- else:
- self.interp.run('import ' + base)
- self.interp.run('reload(' + base + ')')
- return
-
- # execute a python script normally or with the debugger or profiler
- def run_script(self, fname):
- if not fname or not os.path.exists(fname):
- dlg = gtk.MessageDialog(self, gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR, gtk.BUTTONS_OK,
- "Invalid filename "+fname)
- dlg.run()
- return
- args = dialogs.InputBox("Arguments",
- "Enter any command line arguments", self)
- if args == None: return
- os.system(VT_CMD+'python "'+fname+'" ' + args + ' &')
- return
- def debug_script(self, fname):
- if not fname or not os.path.exists(fname):
- dlg = gtk.MessageDialog(self, gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR, gtk.BUTTONS_OK,
- "Invalid filename "+fname)
- dlg.run()
- return
- args = dialogs.InputBox("Arguments",
- "Enter any command line arguments", self)
- if args == None: return
- os.system(VT_CMD+'python '+gtkdb.__file__+' "'+fname+'" ' +
- args + ' &')
- return
- def profile_script(self, fname):
- if not fname or not os.path.exists(fname):
- dlg = gtk.MessageDialog(self, gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR, gtk.BUTTONS_OK,
- "Invalid filename "+fname)
- dlg.run()
- return
- args = dialogs.InputBox("Arguments",
- "Enter any command line arguments", self)
- if args == None: return
- os.system(VT_CMD+'python '+gtkprof.__file__+' "'+fname+'" ' +
- args + ' &')
- return
-
- def add_py_menu(self, ew):
- python_actions = [
- ('PythonMenu', None, '_Python'),
- ('PythonReload', None, '_Reload Module'),
- ('PythonRun', None, 'R_un...', None, None,
- lambda w, ew=ew: self.run_script(ew.fname)),
- ('PythonDebug', None, '_Debug...', None, None,
- lambda w, ew=ew: self.debug_script(ew.fname)),
- ('PythonProfile', None, 'Pro_file...', None, None,
- lambda w, ew=ew: self.profile_script(ew.fname)),
- ]
- ew.ag.add_actions(python_actions)
- ew.ui.add_ui_from_string(pythonmenu_uistring)
- return
-
- def file_new(self, mi=None):
- ew = edit.EditWindow(quit_cb=self.rem_editwin)
- self.editwins.append(ew)
- self.add_py_menu(ew)
- ew.show()
- ew.set_size_request(0,0)
- return
- def file_open(self, mi=None):
- fname = dialogs.OpenFile('Open', self)
- if fname:
- ew = edit.EditWindow(quit_cb=self.rem_editwin)
- ew.load_file(fname)
- self.editwins.append(ew)
- self.add_py_menu(ew)
- ew.show()
- ew.set_size_request(0,0)
- return
- def rem_editwin(self, win=None, event=None):
- for i in range(len(self.editwins)):
- if self.editwins[i] == win:
- del self.editwins[i]
- break
- return
- def file_exit(self, mi=None):
- self.quit()
- return
- def edit_copy(self, mi=None):
- self.interp.text.copy_clipboard(0)
- return
- def edit_paste(self, mi=None):
- self.interp.line.paste_clipboard(0)
- return
- def edit_clear(self, mi=None):
- self.interp.line.delete_selection()
- return
- def python_reload(self, mi=None):
- print "python_reload"
- return
- def python_run(self, mi=None):
- fname = dialogs.OpenFile("Run", self)
- if fname:
- self.run_script(fname)
- return
- def python_debug(self, mi=None):
- fname = dialogs.OpenFile("Debug", self)
- if fname:
- self.debug_script(fname)
- return
- def python_prof(self, mi=None):
- fname = dialogs.OpenFile("Profile", self)
- if fname:
- self.profile_script(fname)
- return
- def help_about(self, mi=None):
- dlg = gtk.MessageDialog(self, gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_INFO, gtk.BUTTONS_OK,
- "Copyright (C)\n" \
- "1998 James Henstridge\n" \
- "2004 John Finlay\n" \
- "This program is covered by the GPL>=2")
- dlg.run()
- dlg.hide()
- return
-
-if __name__ == '__main__':
- app = Application()
- app.show()
- app.set_size_request(0,0)
- gtk.main()
diff --git a/examples/ide/quit.xpm b/examples/ide/quit.xpm
deleted file mode 100644
index 11d0bb01..00000000
--- a/examples/ide/quit.xpm
+++ /dev/null
@@ -1,36 +0,0 @@
-/* XPM */
-static char *quit[] = {
-/* width height num_colors chars_per_pixel */
-" 20 22 6 1",
-/* colors */
-". c #ffcc33",
-"# c None",
-"a c #996600",
-"b c #666666",
-"c c #333333",
-"d c #000000",
-/* pixels */
-"####################",
-"####################",
-"####################",
-"########d####d######",
-"#######dad##dd###dd#",
-"#######d.addaad#dad#",
-"######da......dda.d#",
-"#dddddd..........ad#",
-"da...............dc#",
-"cda..............dc#",
-"#cd..............ad#",
-"##d...............ad",
-"#da.............addc",
-"#d.............ddcc#",
-"da.............dc###",
-"dddd...........ad###",
-"#ccd........adaad###",
-"###d..da....dcddd###",
-"###dbdcda...c#ccc###",
-"###cdc#ccdadc#######",
-"####c###ccdc########",
-"##########c#########"
-};
-
diff --git a/examples/ide/return.xpm b/examples/ide/return.xpm
deleted file mode 100644
index a908f597..00000000
--- a/examples/ide/return.xpm
+++ /dev/null
@@ -1,35 +0,0 @@
-/* XPM */
-static char *return[] = {
-/* width height num_colors chars_per_pixel */
-" 20 22 5 1",
-/* colors */
-". c None",
-"# c #999999",
-"a c #666666",
-"b c #333333",
-"c c #000000",
-/* pixels */
-"....................",
-"..............c.....",
-"..............cc....",
-".........#bcccccc...",
-".....#bccccccccccc..",
-"..#bccccccccccccccc.",
-".acccccccccccccccccc",
-"#cccccccccccccccccc.",
-"bccccccccccccccccc..",
-"ccccccccccccccccc...",
-"cccccccccb#...cc....",
-"ccccccb#......c.....",
-"cccb#..b............",
-"cc..bbbbbb..........",
-"c.bbbbbbbb.a........",
-"bbbbbbbbbbb#........",
-".bbbbbbbbb.a........",
-"..bbbbbbbbb#........",
-"...bbbbbbb.a........",
-".....bbbbbb#........",
-"........bb.a........",
-"...................."
-};
-
diff --git a/examples/ide/run.xpm b/examples/ide/run.xpm
deleted file mode 100644
index fbfb4ed8..00000000
--- a/examples/ide/run.xpm
+++ /dev/null
@@ -1,28 +0,0 @@
-/* XPM */
-static char * run_xpm[] = {
-"20 22 3 1",
-" c None",
-". c #000000",
-"X c #C00080",
-" ",
-" ",
-" .... ",
-" .XXXX. ",
-" .XXXX. ",
-" .XXXX. ",
-" .XXXX. ",
-" .XX. ",
-" .XX. ",
-" .XX. ",
-" .XX. ",
-" .. ",
-" .. ",
-" .. ",
-" .. ",
-" ",
-" .. ",
-" .XX. ",
-" .XX. ",
-" .. ",
-" ",
-" "};
diff --git a/examples/ide/step.xpm b/examples/ide/step.xpm
deleted file mode 100644
index 4e5c7bb3..00000000
--- a/examples/ide/step.xpm
+++ /dev/null
@@ -1,35 +0,0 @@
-/* XPM */
-static char *forward[] = {
-/* width height num_colors chars_per_pixel */
-" 20 22 5 1",
-/* colors */
-". c None",
-"# c #999999",
-"a c #666666",
-"b c #333333",
-"c c #000000",
-/* pixels */
-"....................",
-"........bb.a........",
-".....bbbbbb#........",
-"...bbbbbbb.a........",
-"..bbbbbbbbb#........",
-".bbbbbbbbb.a........",
-"bbbbbbbbbbb#........",
-"c.bbbbbbbb.a........",
-"cc..bbbbbb..........",
-"cccb#..b............",
-"ccccccb#......c.....",
-"cccccccccb#...cc....",
-"ccccccccccccccccc...",
-"bccccccccccccccccc..",
-"#cccccccccccccccccc.",
-".acccccccccccccccccc",
-"..#bccccccccccccccc.",
-".....#bccccccccccc..",
-".........#bcccccc...",
-"..............cc....",
-"..............c.....",
-"...................."
-};
-
diff --git a/examples/pango/pangocairo-simple.py b/examples/pango/pangocairo-simple.py
deleted file mode 100644
index 8cf6d46f..00000000
--- a/examples/pango/pangocairo-simple.py
+++ /dev/null
@@ -1,66 +0,0 @@
-#! /usr/bin/env python
-import sys
-import math
-import pango
-import cairo
-import pangocairo
-
-RADIUS = 150
-
-def draw_text(cr):
- N_WORDS = 10
- FONT = "Sans Bold 27"
-
- # Center coordinates on the middle of the region we are drawing
- cr.translate(RADIUS, RADIUS);
-
- # Create a PangoLayout, set the font and text */
- layout = cr.create_layout()
-
- layout.set_text("Text")
- layout.set_font_description(pango.FontDescription(FONT))
-
- # Draw the layout N_WORDS times in a circle
- for i in range(N_WORDS):
- angle = (360 * i) / N_WORDS;
- cr.save()
-
- # Gradient from red at angle == 60 to blue at angle == 300
- red = (1 + math.cos((angle - 60)*math.pi/180))/2
- cr.set_source_rgb(red, 0, 1 - red)
- cr.rotate(angle*math.pi/180)
-
- # Inform Pango to re-layout the text with the new transformation */
- cr.update_layout(layout)
-
- width, height = layout.get_size()
- cr.move_to(-width/pango.SCALE/2, -RADIUS)
- cr.show_layout(layout)
-
- cr.restore()
-
-def main(argv):
- if len(argv) != 2:
- print >> sys.stderr, "Usage: cairosimple OUTPUT_BASENAME\n"
- return 1
-
- filename = argv[1]
- surface = cairo.ImageSurface(cairo.FORMAT_ARGB32, 2*RADIUS, 2*RADIUS)
- cr = pangocairo.CairoContext(cairo.Context(surface))
- cr.set_source_rgb(1.0, 1.0, 1.0)
- cr.rectangle(0, 0, 2*RADIUS, 2*RADIUS)
- cr.fill()
- draw_text(cr)
-
- surface.write_to_png(filename + ".png")
-
- ## output also a PDF file
- surface = cairo.PDFSurface(filename + ".pdf", 2*RADIUS, 2*RADIUS)
- cr = pangocairo.CairoContext(cairo.Context(surface))
- draw_text(cr)
- cr.show_page()
- surface.finish()
-
-
-if __name__ == '__main__':
- sys.exit(main(sys.argv))
diff --git a/examples/pango/utf8-demo.py b/examples/pango/utf8-demo.py
deleted file mode 100644
index e22da2ba..00000000
--- a/examples/pango/utf8-demo.py
+++ /dev/null
@@ -1,68 +0,0 @@
-# order is important here (for now)
-import gtk
-
-# string taken from pango examples directory and converted from utf8
-# to python unicode string escapes
-hellos = u'''\u03A0\u03B1\u03BD\u8A9E
-This is a list of ways to say hello in various languages.
-The purpose of it is to illustrate a number of scripts.
-
-(Converted into UTF-8)
-
----------------------------------------------------------
-Arabic\t\u0627\u0644\u0633\u0644\u0627\u0645 \u0639\u0644\u064A\u0643\u0645
-Czech\t(\u010Desky)\tDobr\375 den
-Danish\t(Dansk)\tHej, Goddag
-English\tHello
-Esperanto\tSaluton
-Estonian\tTere, Tervist
-FORTRAN\tPROGRAM
-Finnish\t(Suomi)\tHei
-French\t(Fran\347ais)\tBonjour, Salut
-German\t(Deutsch Nord)\tGuten Tag
-German\t(Deutsch S\374d)\tGr\374\337 Gott
-Greek\t(\u0395\u03BB\u03BB\u03B7\u03BD\u03B9\u03BA\u03AC)\t\u0393\u03B5\u03B9\u03AC \u03C3\u03B1\u03C2
-Hebrew\t\u05E9\u05DC\u05D5\u05DD
-Hindi\t\u0928\u092E\u0938\u094D\u0924\u0947, \u0928\u092E\u0938\u094D\u0915\u093E\u0930\u0964
-Italiano\tCiao, Buon giorno
-Maltese\t\u010Aaw, Sa\u0127\u0127a
-Nederlands, Vlaams\tHallo, Dag
-Norwegian\t(Norsk)\tHei, God dag
-Polish\tDzie\u0144 dobry, Hej
-Russian\t(\u0420\u0443\u0441\u0441\u043A\u0438\u0439)\t\u0417\u0434\u0440\u0430\u0432\u0441\u0442\u0432\u0443\u0439\u0442\u0435!\u200E
-Slovak\tDobr\375 de\u0148
-Spanish\t(Espa\361ol)\t\u200E\241Hola!\u200E
-Swedish\t(Svenska)\tHej, Goddag
-Thai\t(\u0E20\u0E32\u0E29\u0E32\u0E44\u0E17\u0E22)\t\u0E2A\u0E27\u0E31\u0E2A\u0E14\u0E35\u0E04\u0E23\u0E31\u0E1A, \u0E2A\u0E27\u0E31\u0E2A\u0E14\u0E35\u0E04\u0E48\u0E30
-Turkish\t(T\374rk\347e)\tMerhaba
-Vietnamese\t(Ti\u1EBFng Vi\u1EC7t)\tXin Ch\340o
-Yiddish\t(\u05F2\u05B7\u05D3\u05D9\u05E9\u05E2)\t\u05D3\u05D0\u05B8\u05E1 \u05D4\u05F2\u05B7\u05D6\u05E2\u05DC\u05E2
-
-Japanese\t(\u65E5\u672C\u8A9E)\t\u3053\u3093\u306B\u3061\u306F, \uFF7A\uFF9D\uFF86\uFF81\uFF8A
-Chinese\t(\u4E2D\u6587,\u666E\u901A\u8BDD,\u6C49\u8BED)\t\u4F60\u597D
-Cantonese\t(\u7CB5\u8A9E,\u5EE3\u6771\u8A71)\t\u65E9\u6668, \u4F60\u597D
-Korean\t(\uD55C\uAE00)\t\uC548\uB155\uD558\uC138\uC694, \uC548\uB155\uD558\uC2ED\uB2C8\uAE4C
-
-Difference among chinese characters in GB, JIS, KSC, BIG5:\u200E
- GB\t--\t\u5143\u6C14\t\u5F00\u53D1
- JIS\t--\t\u5143\u6C17\t\u958B\u767A
- KSC\t--\t\u5143\u6C23\t\u958B\u767C
- BIG5\t--\t\u5143\u6C23\t\u958B\u767C
-
-'''
-win = gtk.Window()
-win.connect('destroy', gtk.mainquit)
-win.set_default_size(600, 400)
-
-swin = gtk.ScrolledWindow()
-swin.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
-win.add(swin)
-swin.show()
-
-l = gtk.Label(hellos)
-swin.add_with_viewport(l)
-l.show()
-
-win.show()
-
-gtk.main()
diff --git a/examples/pygtk-demo/demos/__init__.py b/examples/pygtk-demo/demos/__init__.py
deleted file mode 100644
index 0ca5ff54..00000000
--- a/examples/pygtk-demo/demos/__init__.py
+++ /dev/null
@@ -1,25 +0,0 @@
-
-import os
-
-_file_list = [
- x for x in os.listdir(os.path.dirname(__file__))
- if len(x) > 3 and x[-3:] == '.py']
-
-demo_list = []
-for _mod in _file_list:
- # Leave underscored Modulnames.
- if _mod.startswith('_'):
- continue
- _mod = _mod[:-3]
- try:
- _doc = ''
- exec 'import ' + _mod + '\n' + \
- '_doc = ' + _mod + '.__doc__'
- _description = _doc.splitlines()[0]
- demo_list.append((_description, _mod))
- except (ImportError, AttributeError), msg:
- # ImportError or AttributeError (if _doc is None)
- #print 'failed: ', _mod
- pass
-
-demo_list.sort()
diff --git a/examples/pygtk-demo/demos/appwindow.py b/examples/pygtk-demo/demos/appwindow.py
deleted file mode 100644
index b29b63ec..00000000
--- a/examples/pygtk-demo/demos/appwindow.py
+++ /dev/null
@@ -1,306 +0,0 @@
-#!/usr/bin/env python
-'''Application main window
-
-Demonstrates a typical application window, with menubar, toolbar, statusbar.'''
-# pygtk version: Maik Hertha <maik.hertha@berlin.de>
-
-import gobject
-import gtk
-
-(
- COLOR_RED,
- COLOR_GREEN,
- COLOR_BLUE
-) = range(3)
-
-(
- SHAPE_SQUARE,
- SHAPE_RECTANGLE,
- SHAPE_OVAL,
-) = range(3)
-
-ui_info = \
-'''<ui>
- <menubar name='MenuBar'>
- <menu action='FileMenu'>
- <menuitem action='New'/>
- <menuitem action='Open'/>
- <menuitem action='Save'/>
- <menuitem action='SaveAs'/>
- <separator/>
- <menuitem action='Quit'/>
- </menu>
- <menu action='PreferencesMenu'>
- <menu action='ColorMenu'>
- <menuitem action='Red'/>
- <menuitem action='Green'/>
- <menuitem action='Blue'/>
- </menu>
- <menu action='ShapeMenu'>
- <menuitem action='Square'/>
- <menuitem action='Rectangle'/>
- <menuitem action='Oval'/>
- </menu>
- <menuitem action='Bold'/>
- </menu>
- <menu action='HelpMenu'>
- <menuitem action='About'/>
- </menu>
- </menubar>
- <toolbar name='ToolBar'>
- <toolitem action='Open'/>
- <toolitem action='Quit'/>
- <separator/>
- <toolitem action='Logo'/>
- </toolbar>
-</ui>'''
-
-
-# It's totally optional to do this, you could just manually insert icons
-# and have them not be themeable, especially if you never expect people
-# to theme your app.
-def register_stock_icons():
- ''' This function registers our custom toolbar icons, so they
- can be themed.
- '''
- items = [('demo-gtk-logo', '_GTK!', 0, 0, '')]
- # Register our stock items
- gtk.stock_add(items)
-
- # Add our custom icon factory to the list of defaults
- factory = gtk.IconFactory()
- factory.add_default()
-
- import os
- img_dir = os.path.join(os.path.dirname(__file__), 'images')
- img_path = os.path.join(img_dir, 'gtk-logo-rgb.gif')
- try:
- pixbuf = gtk.gdk.pixbuf_new_from_file(img_path)
-
- # Register icon to accompany stock item
-
- # The gtk-logo-rgb icon has a white background, make it transparent
- # the call is wrapped to (gboolean, guchar, guchar, guchar)
- transparent = pixbuf.add_alpha(True, chr(255), chr(255),chr(255))
- icon_set = gtk.IconSet(transparent)
- factory.add('demo-gtk-logo', icon_set)
-
- except gobject.GError, error:
- print 'failed to load GTK logo for toolbar'
-
-class ApplicationMainWindowDemo(gtk.Window):
- def __init__(self, parent=None):
- register_stock_icons()
-
- # Create the toplevel window
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
-
- self.set_title(self.__class__.__name__)
- self.set_default_size(200, 200)
-
- merge = gtk.UIManager()
- self.set_data("ui-manager", merge)
- merge.insert_action_group(self.__create_action_group(), 0)
- self.add_accel_group(merge.get_accel_group())
-
- try:
- mergeid = merge.add_ui_from_string(ui_info)
- except gobject.GError, msg:
- print "building menus failed: %s" % msg
- bar = merge.get_widget("/MenuBar")
- bar.show()
-
- table = gtk.Table(1, 4, False)
- self.add(table)
-
- table.attach(bar,
- # X direction # # Y direction
- 0, 1, 0, 1,
- gtk.EXPAND | gtk.FILL, 0,
- 0, 0);
-
- bar = merge.get_widget("/ToolBar")
- bar.set_tooltips(True)
- bar.show()
- table.attach(bar,
- # X direction # # Y direction
- 0, 1, 1, 2,
- gtk.EXPAND | gtk.FILL, 0,
- 0, 0)
-
- # Create document
- sw = gtk.ScrolledWindow()
- sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- sw.set_shadow_type(gtk.SHADOW_IN)
-
- table.attach(sw,
- # X direction Y direction
- 0, 1, 2, 3,
- gtk.EXPAND | gtk.FILL, gtk.EXPAND | gtk.FILL,
- 0, 0)
-
- contents = gtk.TextView()
- contents.grab_focus()
-
- sw.add (contents)
-
- # Create statusbar
- self.statusbar = gtk.Statusbar()
- table.attach(self.statusbar,
- # X direction Y direction
- 0, 1, 3, 4,
- gtk.EXPAND | gtk.FILL, 0,
- 0, 0)
-
- # Show text widget info in the statusbar
- buffer = contents.get_buffer()
- buffer.connect("changed", self.update_statusbar)
- mark_set_callback = (lambda buffer, new_location, mark:
- self.update_statusbar(buffer))
-
- # cursor moved
- buffer.connect("mark_set", mark_set_callback)
-
- self.connect("window_state_event", self.update_resize_grip)
- self.update_statusbar(buffer)
-
- self.show_all()
-
- def __create_action_group(self):
- # GtkActionEntry
- entries = (
- ( "FileMenu", None, "_File" ), # name, stock id, label
- ( "PreferencesMenu", None, "_Preferences" ), # name, stock id, label
- ( "ColorMenu", None, "_Color" ), # name, stock id, label
- ( "ShapeMenu", None, "_Shape" ), # name, stock id, label
- ( "HelpMenu", None, "_Help" ), # name, stock id, label
- ( "New", gtk.STOCK_NEW, # name, stock id
- "_New", "<control>N", # label, accelerator
- "Create a new file", # tooltip
- self.activate_action ),
- ( "Open", gtk.STOCK_OPEN, # name, stock id
- "_Open","<control>O", # label, accelerator
- "Open a file", # tooltip
- self.activate_action ),
- ( "Save", gtk.STOCK_SAVE, # name, stock id
- "_Save","<control>S", # label, accelerator
- "Save current file", # tooltip
- self.activate_action ),
- ( "SaveAs", gtk.STOCK_SAVE, # name, stock id
- "Save _As...", None, # label, accelerator
- "Save to a file", # tooltip
- self.activate_action ),
- ( "Quit", gtk.STOCK_QUIT, # name, stock id
- "_Quit", "<control>Q", # label, accelerator
- "Quit", # tooltip
- self.activate_action ),
- ( "About", None, # name, stock id
- "_About", "<control>A", # label, accelerator
- "About", # tooltip
- self.activate_about ),
- ( "Logo", "demo-gtk-logo", # name, stock id
- None, None, # label, accelerator
- "GTK+", # tooltip
- self.activate_action ),
- );
-
- # GtkToggleActionEntry
- toggle_entries = (
- ( "Bold", gtk.STOCK_BOLD, # name, stock id
- "_Bold", "<control>B", # label, accelerator
- "Bold", # tooltip
- self.activate_action,
- True ), # is_active
- )
-
- # GtkRadioActionEntry
- color_entries = (
- ( "Red", None, # name, stock id
- "_Red", "<control><shift>R", # label, accelerator
- "Blood", COLOR_RED ), # tooltip, value
- ( "Green", None, # name, stock id
- "_Green", "<control><shift>G", # label, accelerator
- "Grass", COLOR_GREEN ), # tooltip, value
- ( "Blue", None, # name, stock id
- "_Blue", "<control><shift>B", # label, accelerator
- "Sky", COLOR_BLUE ), # tooltip, value
- )
-
- # GtkRadioActionEntry
- shape_entries = (
- ( "Square", None, # name, stock id
- "_Square", "<control><shift>S", # label, accelerator
- "Square", SHAPE_SQUARE ), # tooltip, value
- ( "Rectangle", None, # name, stock id
- "_Rectangle", "<control><shift>R", # label, accelerator
- "Rectangle", SHAPE_RECTANGLE ), # tooltip, value
- ( "Oval", None, # name, stock id
- "_Oval", "<control><shift>O", # label, accelerator
- "Egg", SHAPE_OVAL ), # tooltip, value
- )
-
- # Create the menubar and toolbar
- action_group = gtk.ActionGroup("AppWindowActions")
- action_group.add_actions(entries)
- action_group.add_toggle_actions(toggle_entries)
- action_group.add_radio_actions(color_entries, COLOR_RED, self.activate_radio_action)
- action_group.add_radio_actions(shape_entries, SHAPE_OVAL, self.activate_radio_action)
-
- return action_group
-
- def activate_about(self, action):
- dialog = gtk.AboutDialog()
- dialog.set_name("PyGTK Demo")
- dialog.set_copyright("\302\251 Copyright 200x the PyGTK Team")
- dialog.set_website("http://www.pygtk.org./")
- ## Close dialog on user response
- dialog.connect ("response", lambda d, r: d.destroy())
- dialog.show()
-
- def activate_action(self, action):
- dialog = gtk.MessageDialog(self, gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_INFO, gtk.BUTTONS_CLOSE,
- 'You activated action: "%s" of type "%s"' % (action.get_name(), type(action)))
- # Close dialog on user response
- dialog.connect ("response", lambda d, r: d.destroy())
- dialog.show()
-
- def activate_radio_action(self, action, current):
- active = current.get_active()
- value = current.get_current_value()
-
- if active:
- dialog = gtk.MessageDialog(self, gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_INFO, gtk.BUTTONS_CLOSE,
- "You activated radio action: \"%s\" of type \"%s\".\nCurrent value: %d" %
- (current.get_name(), type(current), value))
-
- # Close dialog on user response
- dialog.connect("response", lambda d, r: d.destroy())
- dialog.show()
-
- def update_statusbar(self, buffer):
- # clear any previous message, underflow is allowed
- self.statusbar.pop(0)
- count = buffer.get_char_count()
- iter = buffer.get_iter_at_mark(buffer.get_insert())
- row = iter.get_line()
- col = iter.get_line_offset()
- self.statusbar.push(0,
- 'Cursor at row %d column %d - %d chars in document' % (row, col, count))
-
- def update_resize_grip(self, widget, event):
- mask = gtk.gdk.WINDOW_STATE_MAXIMIZED | gtk.gdk.WINDOW_STATE_FULLSCREEN
- if (event.changed_mask & mask):
- self.statusbar.set_has_resize_grip(not (event.new_window_state & mask))
-
-def main():
- ApplicationMainWindowDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/buttonbox.py b/examples/pygtk-demo/demos/buttonbox.py
deleted file mode 100644
index 91b434b2..00000000
--- a/examples/pygtk-demo/demos/buttonbox.py
+++ /dev/null
@@ -1,88 +0,0 @@
-#!/usr/bin/env python
-'''Button Box
-
-This demo shows various button box configurations available. It also
-uses stock buttons, and use of mnemonics for navigation.'''
-
-import gtk
-
-def create_bbox(horizontal=True, title=None, spacing=0,
- layout=gtk.BUTTONBOX_SPREAD):
- frame = gtk.Frame(title)
-
- if horizontal:
- bbox = gtk.HButtonBox()
- else:
- bbox = gtk.VButtonBox()
-
- bbox.set_border_width(5)
- bbox.set_layout(layout)
- bbox.set_spacing(spacing)
- frame.add(bbox)
-
- button = gtk.Button(stock='gtk-ok')
- bbox.add(button)
-
- button = gtk.Button(stock='gtk-cancel')
- bbox.add(button)
-
- button = gtk.Button(stock='gtk-help')
- bbox.add(button)
-
- return frame
-
-class ButtonBoxDemo(gtk.Window):
- def __init__(self, parent=None):
- # Create the toplevel window
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
-
- self.set_title(self.__class__.__name__)
- self.set_border_width(10)
-
- main_vbox = gtk.VBox()
- self.add(main_vbox)
-
- frame_horiz = gtk.Frame("Horizontal Button Boxes")
- main_vbox.pack_start(frame_horiz, padding=10)
-
- vbox = gtk.VBox()
- vbox.set_border_width(10)
- frame_horiz.add(vbox)
-
- vbox.pack_start(create_bbox(True, "Spread", 40, gtk.BUTTONBOX_SPREAD),
- padding=0)
- vbox.pack_start(create_bbox(True, "Edge", 40, gtk.BUTTONBOX_EDGE),
- padding=5)
- vbox.pack_start(create_bbox(True, "Start", 40, gtk.BUTTONBOX_START),
- padding=5)
- vbox.pack_start(create_bbox(True, "End", 40, gtk.BUTTONBOX_END),
- padding=5)
-
- frame_vert = gtk.Frame("Vertical Button Boxes")
- main_vbox.pack_start(frame_vert, padding=10)
-
- hbox = gtk.HBox()
- hbox.set_border_width(10)
- frame_vert.add(hbox)
-
- hbox.pack_start(create_bbox(False, "Spread", 40, gtk.BUTTONBOX_SPREAD),
- padding=0)
- hbox.pack_start(create_bbox(False, "Edge", 40, gtk.BUTTONBOX_EDGE),
- padding=5)
- hbox.pack_start(create_bbox(False, "Start", 40, gtk.BUTTONBOX_START),
- padding=5)
- hbox.pack_start(create_bbox(False, "End", 40, gtk.BUTTONBOX_END),
- padding=5)
-
- self.show_all()
-
-def main():
- ButtonBoxDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/changedisplay.py b/examples/pygtk-demo/demos/changedisplay.py
deleted file mode 100644
index e10fcee7..00000000
--- a/examples/pygtk-demo/demos/changedisplay.py
+++ /dev/null
@@ -1,413 +0,0 @@
-#!/usr/bin/env python
-'''Change Display
-
-Demonstrates migrating a window between different displays and
-screens. A display is a mouse and keyboard with some number of
-associated monitors. A screen is a set of monitors grouped
-into a single physical work area. The neat thing about having
-multiple displays is that they can be on a completely separate
-computers, as long as there is a network connection to the
-computer where the application is running.
-
-Only some of the windowing systems where GTK+ runs have the
-concept of multiple displays and screens. (The X Window System
-is the main example.) Other windowing systems can only
-handle one keyboard and mouse, and combine all monitors into
-a single screen.
-
-This is a moderately complex example, and demonstrates:
-
-- Tracking the currently open displays and screens
-- Changing the screen for a window
-- Letting the user choose a window by clicking on it
-- Using GtkListStore and GtkTreeView
-- Using GtkDialog
-'''
-import gtk
-import gobject
-
-# These enumerations provide symbolic names for the columns
-# in the two GtkListStore models.
-#
-(
- DISPLAY_COLUMN_NAME,
- DISPLAY_COLUMN_DISPLAY,
- DISPLAY_NUM_COLUMNS
-) = range(3)
-
-(
- SCREEN_COLUMN_NUMBER,
- SCREEN_COLUMN_SCREEN,
- SCREEN_NUM_COLUMNS
-) = range(3)
-
-def find_toplevel_at_pointer(display):
- ''' Finds the toplevel window under the mouse pointer, if any.
- '''
- pointer_window = display.get_window_at_pointer()[0]
-
- # The user data field of a GdkWindow is used to store a pointer
- # to the widget that created it.
- #
- if pointer_window:
- widget = pointer_window.get_user_data()
-
- return widget and widget.get_toplevel() or None
-
-class QueryForToplevel(gtk.Window):
- ''' Asks the user to click on a window, then waits for them click
- the mouse. When the mouse is released, returns the toplevel
- window under the pointer, or NULL, if there is none.
- '''
-
- def __init__(self, screen, prompt):
- gtk.Window.__init__(self, gtk.WINDOW_POPUP)
- self.set_screen(screen)
- self.set_modal(True)
- self.set_position(gtk.WIN_POS_CENTER)
-
- frame = gtk.Frame()
- frame.set_shadow_type(gtk.SHADOW_OUT)
- self.add(frame)
-
- label = gtk.Label(prompt)
- label.set_padding(10, 10)
- frame.add(label)
-
- self.show_all()
-
- def run(self):
- display = self.get_screen().get_display()
- cursor = gtk.gdk.Cursor(display, gtk.gdk.CROSSHAIR)
-
- main_context = gobject.main_context_default()
- if (gtk.gdk.pointer_grab(self.window, False,
- gtk.gdk.BUTTON_RELEASE_MASK, None, cursor) == gtk.gdk.GRAB_SUCCESS):
- self.query_clicked = False
- self.connect("button-release-event", self.button_release_event_cb)
-
- # Process events until clicked is set by button_release_event_cb.
- # We pass in may_block=True since we want to wait if there
- # are no events currently.
- #
- while self.query_clicked is False:
- main_context.iteration(True)
-
- toplevel = find_toplevel_at_pointer(display)
- if (toplevel == self):
- toplevel = None;
-
- self.destroy()
- gtk.gdk.flush() # Really release the grab
-
- return toplevel
-
- def button_release_event_cb(self, winref, event):
- self.query_clicked = True
- return True
-
-
-class LeftAlignButton(gtk.Button):
- ''' If we have a stack of buttons, it often looks better if their contents
- are left-aligned, rather than centered. This class creates a button
- and left-aligns it contents.
- '''
- def __init__(self, label):
- gtk.Button.__init__(self, label)
- child = self.get_children()[0]
- child.set_alignment(0., 0.5)
-
-
-# Main entry point. If the dialog for this demo doesn't yet exist, creates
-# it.
-#
-class ChangeDisplayDemo(gtk.Dialog):
- size_group = None
- display_model = None
- screen_model = None
- screen_selection = None
- current_display = None
- current_screen = None
-
- def __init__(self, parent=None):
- gtk.Dialog.__init__(self, "Change Screen or display", parent,
- gtk.DIALOG_NO_SEPARATOR,
- (gtk.STOCK_CLOSE, gtk.RESPONSE_CLOSE,
- "Change", gtk.RESPONSE_OK))
- self.set_default_size(300, 400)
-
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
- self.connect("response", self.response_cb)
- self.connect("destroy", self.destroy_cb)
-
- vbox = gtk.VBox(False, 5)
- vbox.set_border_width(8)
-
- self.vbox.pack_start(vbox, True, True, 0)
-
- frame = self.__create_display_frame()
- vbox.pack_start(frame, True, True, 0)
-
- frame = self.__create_screen_frame()
- vbox.pack_start(frame, True, True, 0)
-
- self.__initialize_displays()
-
- self.show_all()
-
- def __initialize_displays(self):
- ''' Adds all currently open displays to our list of displays,
- and set up a signal connection so that we'll be notified
- when displays are opened in the future as well.
- '''
- manager = gtk.gdk.display_manager_get()
- displays = manager.list_displays()
-
- for item in displays:
- self.add_display(item)
- id = manager.connect("display_opened", self.display_opened_cb)
- manager.set_data('user-callback', id)
-
- def __create_frame(self, title):
- ''' This function is used both for creating the "Display" and
- "Screen" frames, since they have a similar structure. The
- caller hooks up the right context for the value returned
- in tree_view, and packs any relevant buttons into button_vbox.
- '''
- frame = gtk.Frame(title)
-
- hbox = gtk.HBox(False, 8)
- hbox.set_border_width(8)
- frame.add(hbox)
-
- scrollwin = gtk.ScrolledWindow();
- scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
- scrollwin.set_shadow_type (gtk.SHADOW_IN)
- hbox.pack_start(scrollwin, True, True, 0)
-
- tree_view = gtk.TreeView()
- tree_view.set_headers_visible(False)
- scrollwin.add(tree_view)
-
- selection = tree_view.get_selection()
- selection.set_mode(gtk.SELECTION_BROWSE)
-
- button_vbox = gtk.VBox(False, 5)
- hbox.pack_start(button_vbox, False, False, 0)
-
- if self.size_group is None:
- self.size_group = gtk.SizeGroup(gtk.SIZE_GROUP_HORIZONTAL)
-
- self.size_group.add_widget(button_vbox)
-
- return (frame, tree_view, button_vbox)
-
-
- def __create_display_frame(self):
- ''' Creates the "Display" frame in the main window.
- '''
- frame, tree_view, button_vbox = self.__create_frame("Display")
-
- button = LeftAlignButton("_Open...")
- button.connect("clicked", self.open_display_cb)
- button_vbox.pack_start(button, False, False, 0)
-
- button = LeftAlignButton("_Close")
- button.connect ("clicked", self.close_display_cb)
- button_vbox.pack_start(button, False, False, 0)
-
- self.display_model = gtk.ListStore(str, object);
- tree_view.set_model(self.display_model)
-
- column = gtk.TreeViewColumn("Name", gtk.CellRendererText(),
- text=DISPLAY_COLUMN_NAME)
- tree_view.append_column(column)
-
- selection = tree_view.get_selection()
- selection.connect("changed", self.display_changed_cb)
-
- return frame
-
- def __create_screen_frame(self):
- ''' Creates the "Screen" frame in the main window.
- '''
- frame, tree_view, button_vbox = self.__create_frame("Screen")
-
- self.screen_model = gtk.ListStore(int, object);
- tree_view.set_model(self.screen_model)
-
- column = gtk.TreeViewColumn("Number", gtk.CellRendererText(),
- text=SCREEN_COLUMN_NUMBER)
- tree_view.append_column(column)
-
- self.screen_selection = tree_view.get_selection()
- self.screen_selection.connect("changed", self.screen_changed_cb)
-
- return frame
-
- def query_change_display(self):
- ''' Prompts the user for a toplevel window to move, and then moves
- that window to the currently selected display
- '''
- screen = self.window.get_screen()
-
- toplevel = QueryForToplevel(screen,
- "Please select the toplevel\nto move to the new screen").run()
-
- if toplevel is not None:
- toplevel.set_screen(self.current_screen)
- else:
- screen.get_display().beep()
-
-
- def response_cb(self, dialog, response_id):
- ''' Called when the user clicks on a button in our dialog or
- closes the dialog through the window manager. Unless the
- "Change" button was clicked, we destroy the dialog.
- '''
- if response_id == gtk.RESPONSE_OK:
- self.query_change_display()
- else:
- dialog.destroy()
-
- def open_display_cb(self, button):
- ''' Called when the user clicks on "Open..." in the display
- frame. Prompts for a new display, and then opens a connection
- to that display.
- '''
- dialog = gtk.Dialog("Open Display", self, gtk.DIALOG_MODAL,
- (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL, gtk.STOCK_OK, gtk.RESPONSE_OK))
-
- dialog.set_default_response(gtk.RESPONSE_OK)
- display_entry = gtk.Entry()
- display_entry.set_activates_default(True)
- dialog_label = gtk.Label("Please enter the name of\nthe new display\n")
-
- dialog.vbox.add(dialog_label)
- dialog.vbox.add(display_entry)
-
- display_entry.grab_focus()
- dialog.show_all()
-
- result = None
- while result is None:
- response_id = dialog.run()
- if response_id != gtk.RESPONSE_OK:
- break;
- new_screen_name = display_entry.get_chars(0, -1)
- print new_screen_name
- if new_screen_name != "":
- result = gtk.gdk.Display(new_screen_name)
- if result is None:
- error_msg = (
- "Can't open display :\n\t%s\nplease try another one\n" %
- (new_screen_name,))
- dialog_label.set_text(error_msg)
-
- dialog.destroy()
-
- def close_display_cb(self, button):
- ''' Called when the user clicks on the "Close" button in the
- "Display" frame. Closes the selected display.
- '''
- if self.current_display:
- self.current_display.close()
-
-
- def display_changed_cb(self, selection):
- ''' Called when the selected row in the display list changes.
- Updates info.current_display, then refills the list of
- screens.
- '''
- model, iter = selection.get_selected()
- if iter is not None:
- self.current_display = model.get_value(iter, DISPLAY_COLUMN_DISPLAY)
- else:
- self.current_display = None
- self.fill_screens()
-
- def screen_changed_cb(self, selection):
- ''' Called when the selected row in the sceen list changes.
- Updates info->current_screen.
- '''
- model, iter = selection.get_selected()
- if iter:
- self.current_screen = model.get(iter, SCREEN_COLUMN_SCREEN)
- else:
- self.current_screen = None;
-
- def destroy_cb(self, parent):
- self.destroy_info()
- if parent is None:
- gtk.main_quit()
-
-
- def fill_screens(self):
- ''' Fills in the screen list based on the current display
- '''
- self.screen_model.clear()
- if self.current_display is not None:
- n_screens = self.current_display.get_n_screens()
-
- for i in range(n_screens):
- screen = self.current_display.get_screen(i);
- iter = self.screen_model.append()
- self.screen_model.set(iter,
- SCREEN_COLUMN_NUMBER, i, SCREEN_COLUMN_SCREEN, screen)
- if (i == 0):
- self.screen_selection.select_iter(iter)
-
- def display_closed_cb(self, display, is_error, info):
- ''' Called when one of the currently open displays is closed.
- Remove it from our list of displays.
- '''
- iter = self.display_model.get_iter_first()
- while iter:
- tmp_display = self.display_model.get_value(iter, DISPLAY_COLUMN_DISPLAY)
- if (tmp_display == display):
- info.display_model.remove(iter)
- break;
- iter = info.display_model.iter_next()
-
- def add_display(self, display):
- ''' Adds a new display to our list of displays, and connects
- to the "closed" signal so that we can remove it from the
- list of displays again.
- '''
- name = display.get_name()
-
- iter = self.display_model.append()
- self.display_model.set(iter,
- DISPLAY_COLUMN_NAME, name, DISPLAY_COLUMN_DISPLAY, display)
- id = display.connect("closed", self.display_closed_cb)
- display.set_data('user-callback', id)
-
- def display_opened_cb(self, manager, display):
- ''' Called when a new display is opened
- '''
- self.add_display(display)
-
- def destroy_info(self):
- ''' Cleans up when the toplevel is destroyed; we remove the
- connections we use to track currently open displays.
- '''
- manager = gtk.gdk.display_manager_get()
- displays = manager.list_displays()
-
- id = manager.get_data('user-callback')
- manager.disconnect(id)
-
- for tmp_list in displays:
- id = tmp_list.get_data('user-callback')
- tmp_list.disconnect(id)
-
-
-def main():
- ChangeDisplayDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/colorsel.py b/examples/pygtk-demo/demos/colorsel.py
deleted file mode 100644
index 252d09c4..00000000
--- a/examples/pygtk-demo/demos/colorsel.py
+++ /dev/null
@@ -1,73 +0,0 @@
-#!/usr/bin/env python
-"""Color Selector
-
-GtkColorSelection lets the user choose a color. GtkColorSelectionDialog is a
-prebuilt dialog containing a GtkColorSelection."""
-
-import gtk
-
-class ColorSelectorDemo(gtk.Window):
- color = gtk.gdk.color_parse("blue")
-
- def __init__(self, parent=None):
- # Create the toplevel window
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
-
- self.set_title(self.__class__.__name__)
- self.set_border_width(8)
- vbox = gtk.VBox()
- vbox.set_border_width(8)
- self.add(vbox)
-
- # Create the color swatch area
- frame = gtk.Frame()
- frame.set_shadow_type(gtk.SHADOW_IN)
- vbox.pack_start(frame, True, True, 8)
-
- self.d_area = gtk.DrawingArea()
- self.d_area.set_size_request(200, 200)
- self.d_area.modify_bg(gtk.STATE_NORMAL, self.color)
- frame.add(self.d_area)
-
- alignment = gtk.Alignment(1.0, 0.5, 0.0, 0.0)
-
- button = gtk.Button("_Change the above color")
- alignment.add(button)
-
- vbox.pack_start(alignment, True, True)
-
- button.connect('clicked', self.on_change_color_clicked)
- button.set_flags(gtk.CAN_DEFAULT)
- button.grab_default()
-
- self.show_all()
-
- def on_change_color_clicked(self, button):
-
- dialog = gtk.ColorSelectionDialog("Changing color")
- dialog.set_transient_for(self)
- colorsel = dialog.colorsel
-
- colorsel.set_previous_color(self.color)
- colorsel.set_current_color(self.color)
- colorsel.set_has_palette(True)
-
- response = dialog.run()
-
- if response == gtk.RESPONSE_OK:
- self.color = colorsel.get_current_color()
- self.d_area.modify_bg(gtk.STATE_NORMAL, self.color)
-
- dialog.destroy()
- return True
-
-def main():
- ColorSelectorDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/dialogs.py b/examples/pygtk-demo/demos/dialogs.py
deleted file mode 100644
index edea0701..00000000
--- a/examples/pygtk-demo/demos/dialogs.py
+++ /dev/null
@@ -1,130 +0,0 @@
-#!/usr/bin/env python
-"""Dialog and Message Boxes
-
-Dialog widgets are used to pop up a transient window for user feedback."""
-
-import gtk
-
-class DialogAndMessageBoxesDemo(gtk.Window):
- counter = 1
- def __init__(self, parent=None):
- # Create the toplevel window
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
-
- self.set_title(self.__class__.__name__)
- self.set_border_width(8)
-
- frame = gtk.Frame("Dialogs")
- self.add(frame)
-
- vbox = gtk.VBox(False, 8)
- vbox.set_border_width(8)
- frame.add(vbox)
-
- # Standard message dialog
- hbox = gtk.HBox(False, 8)
- vbox.pack_start(hbox)
- button = gtk.Button("_Message Dialog")
- button.connect('clicked', self.on_message_dialog_clicked)
- hbox.pack_start(button, False, False, 0)
- vbox.pack_start(gtk.HSeparator(), False, False, 0)
-
- # Interactive dialog
- hbox = gtk.HBox(False, 8)
- vbox.pack_start(hbox, False, False, 0)
- vbox2 = gtk.VBox()
-
- button = gtk.Button("_Interactive Dialog")
- button.connect('clicked', self.on_interactive_dialog_clicked)
- hbox.pack_start(vbox2, False, False, 0)
- vbox2.pack_start(button, False, False, 0)
-
- table = gtk.Table(2, 2)
- table.set_row_spacings(4)
- table.set_col_spacings(4)
- hbox.pack_start(table, False, False, 0)
-
- label = gtk.Label("Entry _1")
- label.set_use_underline(True)
- table.attach(label, 0, 1, 0, 1)
-
- self.entry1 = gtk.Entry()
- table.attach(self.entry1, 1, 2, 0, 1)
- label.set_mnemonic_widget(self.entry1)
-
- label = gtk.Label("Entry _2")
- label.set_use_underline(True)
- table.attach(label, 0, 1, 1, 2)
-
- self.entry2 = gtk.Entry()
- table.attach(self.entry2, 1, 2, 1, 2)
- label.set_mnemonic_widget(self.entry2)
-
- self.show_all()
-
- def on_message_dialog_clicked(self, button):
- dialog = gtk.MessageDialog(self,
- gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_INFO, gtk.BUTTONS_OK,
- "This message box has been popped up %d time%s." %
- (self.counter, self.counter > 1 and 's' or ''))
- dialog.run()
- dialog.destroy()
- self.counter += 1
-
- def on_interactive_dialog_clicked(self, button):
-
- dialog = gtk.Dialog("Interactive Dialog", self, 0,
- (gtk.STOCK_OK, gtk.RESPONSE_OK,
- "_Non-stock button", gtk.RESPONSE_CANCEL))
-
- hbox = gtk.HBox(False, 8)
- hbox.set_border_width(8)
- dialog.vbox.pack_start(hbox, False, False, 0)
-
- stock = gtk.image_new_from_stock(
- gtk.STOCK_DIALOG_QUESTION,
- gtk.ICON_SIZE_DIALOG)
- hbox.pack_start(stock, False, False, 0)
-
- table = gtk.Table(2, 2)
- table.set_row_spacings(4)
- table.set_col_spacings(4)
- hbox.pack_start(table, True, True, 0)
-
- label = gtk.Label("Entry _1")
- label.set_use_underline(True)
- table.attach(label, 0, 1, 0, 1)
- local_entry1 = gtk.Entry()
- local_entry1.set_text(self.entry1.get_text())
- table.attach(local_entry1, 1, 2, 0, 1)
- label.set_mnemonic_widget(local_entry1)
-
- label = gtk.Label("Entry _2")
- label.set_use_underline(True)
- table.attach(label, 0, 1, 1, 2)
- local_entry2 = gtk.Entry()
- local_entry2.set_text(self.entry2.get_text())
- table.attach(local_entry2, 1, 2, 1, 2)
- label.set_mnemonic_widget(local_entry2)
-
- dialog.show_all()
-
- response = dialog.run()
-
- if response == gtk.RESPONSE_OK:
- self.entry1.set_text(local_entry1.get_text())
- self.entry2.set_text(local_entry2.get_text())
-
- dialog.destroy()
-
-def main():
- DialogAndMessageBoxesDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/dnd.py b/examples/pygtk-demo/demos/dnd.py
deleted file mode 100644
index ad6cf99d..00000000
--- a/examples/pygtk-demo/demos/dnd.py
+++ /dev/null
@@ -1,205 +0,0 @@
-#!/usr/bin/env python
-'''Drag and Drop
-
-This is a test of the drag and drop capabilities of gtk. It is a
-fairly straight forward port of the example distributed with gtk.
-'''
-
-import gtk
-import gobject
-
-from dndpixmap import drag_icon_xpm, trashcan_open_xpm, trashcan_closed_xpm
-
-TARGET_STRING = 0
-TARGET_ROOTWIN = 1
-
-target = [
- ('STRING', 0, TARGET_STRING),
- ('text/plain', 0, TARGET_STRING),
- ('application/x-rootwin-drop', 0, TARGET_ROOTWIN)
-]
-
-def create_pixmap(widget, xpm_data):
- return \
- gtk.gdk.pixmap_colormap_create_from_xpm_d(
- None, widget.get_colormap(), None, xpm_data)
-
-class DragAndDropDemo(gtk.Window):
- trashcan_open = None
- trashcan_open_mask = None
- trashcan_closed = None
- trashcan_closed_mask = None
- drag_icon = None
- drag_mask = None
- have_drag = False
- popped_up = False
- in_popup = False
- popup_timer = 0
- popdown_timer = 0
- popup_win = None
-
- def __init__(self, parent=None):
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
- self.set_title(self.__class__.__name__)
-
- table = gtk.Table(2,2)
- self.add(table)
-
- self.drag_icon, self.drag_mask = \
- create_pixmap(self, drag_icon_xpm)
- self.trashcan_open, self.trashcan_open_mask = \
- create_pixmap(self, trashcan_open_xpm)
- self.trashcan_closed, self.trashcan_closed_mask = \
- create_pixmap(self, trashcan_closed_xpm)
-
- label = gtk.Label('Drop to Trashcan!\n')
- label.drag_dest_set(gtk.DEST_DEFAULT_ALL, target[:-1],
- gtk.gdk.ACTION_COPY | gtk.gdk.ACTION_MOVE)
- label.connect('drag_data_received', self.label_drag_data_received)
- table.attach(label, 0, 1, 0, 1)
-
- label = gtk.Label('Popup\n')
- label.drag_dest_set(gtk.DEST_DEFAULT_ALL, target[:-1],
- gtk.gdk.ACTION_COPY | gtk.gdk.ACTION_MOVE)
- table.attach(label, 1, 2, 1, 2)
- label.connect('drag_motion', self.popsite_motion)
- label.connect('drag_leave', self.popsite_leave)
-
- image = gtk.Image()
- image.set_from_pixmap(self.trashcan_closed, self.trashcan_closed_mask)
- image.drag_dest_set(0, [], 0)
- table.attach(image, 1, 2, 0, 1)
- image.connect('drag_leave', self.target_drag_leave)
- image.connect('drag_motion', self.target_drag_motion)
- image.connect('drag_drop', self.target_drag_drop)
- image.connect('drag_data_received', self.target_drag_data_received)
-
- b = gtk.Button('Drag from Here\n')
- b.drag_source_set(gtk.gdk.BUTTON1_MASK | gtk.gdk.BUTTON3_MASK,
- target, gtk.gdk.ACTION_COPY | gtk.gdk.ACTION_MOVE)
- b.drag_source_set_icon(self.get_colormap(), self.drag_icon, self.drag_mask)
- table.attach(b, 0, 1, 1, 2)
- b.connect('drag_data_get', self.source_drag_data_get)
- b.connect('drag_data_delete', self.source_drag_data_delete)
- self.show_all()
-
- def label_drag_data_received(self, w, context, x, y, data, info, time):
- if data and data.format == 8:
- print 'Received "%s" in label' % data.data
- context.finish(True, False, time)
- else:
- context.finish(False, False, time)
-
- def popsite_motion(self, w, context, x, y, time):
- if not self.popup_timer:
- self.popup_timer = gobject.timeout_add(500, self.popup_cb)
- return True
-
- def popsite_leave(self, w, context, time):
- if self.popup_timer:
- gobject.source_remove(self.popup_timer)
- self.popup_timer = 0
-
- def popup_motion(self, w, context, x, y, time):
- print 'popup_motion'
- if not self.in_popup:
- self.in_popup = True
- if self.popdown_timer:
- print 'removed popdown'
- gobject.source_remove(self.popdown_timer)
- self.popdown_timer = 0
- return True
-
- def popup_leave(self, w, context, time):
- print 'popup_leave'
- if self.in_popup:
- self.in_popup = False
- if not self.popdown_timer:
- print 'added popdown'
- self.popdown_timer = gobject.timeout_add(500, self.popdown_cb)
-
- def popup_cb(self):
- if not self.popped_up:
- if self.popup_win is None:
- self.popup_win = gtk.Window(gtk.WINDOW_POPUP)
- self.popup_win.set_position(gtk.WIN_POS_MOUSE)
- table = gtk.Table(3, 3)
- for k in range(9):
- i, j = divmod(k, 3)
- b = gtk.Button("%d,%d" % (i,j))
- b.drag_dest_set(gtk.DEST_DEFAULT_ALL, target[:-1],
- gtk.gdk.ACTION_COPY | gtk.gdk.ACTION_MOVE)
- b.connect('drag_motion', self.popup_motion)
- b.connect('drag_leave', self.popup_leave)
- table.attach(b, i, i+1, j, j+1)
- table.show_all()
- self.popup_win.add(table)
- self.popup_win.present()
- self.popped_up = True
- self.popdown_timer = gobject.timeout_add(500, self.popdown_cb)
- print 'added popdown'
- self.popup_timer = 0
- return False
-
- def popdown_cb(self):
- print 'popdown'
- #if self.in_popup:
- # return True
- self.popdown_timer = 0
- self.popup_win.hide()
- self.popped_up = False
- return False
-
- def target_drag_leave(self, img, context, time):
- print 'leave'
- self.have_drag = False
- img.set_from_pixmap(self.trashcan_closed, self.trashcan_closed_mask)
-
- def target_drag_motion(self, img, context, x, y, time):
- if self.have_drag is False:
- self.have_drag = True
- img.set_from_pixmap(self.trashcan_open, self.trashcan_open_mask)
- source_widget = context.get_source_widget()
- print 'motion, source ',
- if source_widget:
- print source_widget.__class__.__name__
- else:
- print 'unknown'
- context.drag_status(context.suggested_action, time)
- return True
-
- def target_drag_drop(self, img, context, x, y, time):
- print 'drop'
- self.have_drag = False
- img.set_from_pixmap(self.trashcan_closed, self.trashcan_closed_mask)
- if context.targets:
- img.drag_get_data(context, context.targets[0], time)
- return True
- return False
-
- def target_drag_data_received(self, img, context, x, y, data, info, time):
- if data.format == 8:
- print 'Received "%s" in trashcan' % data.data
- context.finish(True, False, time)
- else:
- context.finish(False, False, time)
-
- def source_drag_data_get(self, btn, context, selection_data, info, time):
- if info == TARGET_ROOTWIN:
- print 'I was dropped on the rootwin'
- else:
- selection_data.set(selection_data.target, 8, "I'm Data!")
-
- def source_drag_data_delete(self, btn, context, data):
- print 'Delete the data!'
-
-def main():
- DragAndDropDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/dndpixmap.py b/examples/pygtk-demo/demos/dndpixmap.py
deleted file mode 100644
index 781b9798..00000000
--- a/examples/pygtk-demo/demos/dndpixmap.py
+++ /dev/null
@@ -1,259 +0,0 @@
-drag_icon_xpm = [
-"36 48 9 1",
-" c None",
-". c #020204",
-"+ c #8F8F90",
-"@ c #D3D3D2",
-"# c #AEAEAC",
-"$ c #ECECEC",
-"% c #A2A2A4",
-"& c #FEFEFC",
-"* c #BEBEBC",
-" .....................",
-" ..&&&&&&&&&&&&&&&&&&&.",
-" ...&&&&&&&&&&&&&&&&&&&.",
-" ..&.&&&&&&&&&&&&&&&&&&&.",
-" ..&&.&&&&&&&&&&&&&&&&&&&.",
-" ..&&&.&&&&&&&&&&&&&&&&&&&.",
-" ..&&&&.&&&&&&&&&&&&&&&&&&&.",
-" ..&&&&&.&&&@&&&&&&&&&&&&&&&.",
-" ..&&&&&&.*$%$+$&&&&&&&&&&&&&.",
-" ..&&&&&&&.%$%$+&&&&&&&&&&&&&&.",
-" ..&&&&&&&&.#&#@$&&&&&&&&&&&&&&.",
-" ..&&&&&&&&&.#$**#$&&&&&&&&&&&&&.",
-" ..&&&&&&&&&&.&@%&%$&&&&&&&&&&&&&.",
-" ..&&&&&&&&&&&.&&&&&&&&&&&&&&&&&&&.",
-" ..&&&&&&&&&&&&.&&&&&&&&&&&&&&&&&&&.",
-"................&$@&&&@&&&&&&&&&&&&.",
-".&&&&&&&+&&#@%#+@#@*$%$+$&&&&&&&&&&.",
-".&&&&&&&+&&#@#@&&@*%$%$+&&&&&&&&&&&.",
-".&&&&&&&+&$%&#@&#@@#&#@$&&&&&&&&&&&.",
-".&&&&&&@#@@$&*@&@#@#$**#$&&&&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&@%&%$&&&&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&$#@@$&&&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&&+&$+&$&@&$@&&$@&&&&&&&&&&.",
-".&&&&&&&&&+&&#@%#+@#@*$%&+$&&&&&&&&.",
-".&&&&&&&&&+&&#@#@&&@*%$%$+&&&&&&&&&.",
-".&&&&&&&&&+&$%&#@&#@@#&#@$&&&&&&&&&.",
-".&&&&&&&&@#@@$&*@&@#@#$#*#$&&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&$%&%$&&&&&&&&.",
-".&&&&&&&&&&$#@@$&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&&&&+&$%&$$@&$@&&$@&&&&&&&&.",
-".&&&&&&&&&&&+&&#@%#+@#@*$%$+$&&&&&&.",
-".&&&&&&&&&&&+&&#@#@&&@*#$%$+&&&&&&&.",
-".&&&&&&&&&&&+&$+&*@&#@@#&#@$&&&&&&&.",
-".&&&&&&&&&&$%@@&&*@&@#@#$#*#&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&$%&%$&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&&&&&&&$#@@$&&&&&&&&&&&&&&&.",
-".&&&&&&&&&&&&&&&+&$%&$$@&$@&&$@&&&&.",
-".&&&&&&&&&&&&&&&+&&#@%#+@#@*$%$+$&&.",
-".&&&&&&&&&&&&&&&+&&#@#@&&@*#$%$+&&&.",
-".&&&&&&&&&&&&&&&+&$+&*@&#@@#&#@$&&&.",
-".&&&&&&&&&&&&&&$%@@&&*@&@#@#$#*#&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&$%&%$&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.",
-"...................................."]
-
-trashcan_closed_xpm = [
-"64 80 17 1",
-" c None",
-". c #030304",
-"+ c #5A5A5C",
-"@ c #323231",
-"# c #888888",
-"$ c #1E1E1F",
-"% c #767677",
-"& c #494949",
-"* c #9E9E9C",
-"= c #111111",
-"- c #3C3C3D",
-"; c #6B6B6B",
-"> c #949494",
-", c #282828",
-"' c #808080",
-") c #545454",
-"! c #AEAEAC",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ==......=$$...=== ",
-" ..$------)+++++++++++++@$$... ",
-" ..=@@-------&+++++++++++++++++++-.... ",
-" =.$$@@@-&&)++++)-,$$$$=@@&+++++++++++++,..$ ",
-" .$$$$@@&+++++++&$$$@@@@-&,$,-++++++++++;;;&.. ",
-" $$$$,@--&++++++&$$)++++++++-,$&++++++;%%'%%;;$@ ",
-" .-@@-@-&++++++++-@++++++++++++,-++++++;''%;;;%*-$ ",
-" +------++++++++++++++++++++++++++++++;;%%%;;##*!. ",
-" =+----+++++++++++++++++++++++;;;;;;;;;;;;%'>>). ",
-" .=)&+++++++++++++++++;;;;;;;;;;;;;;%''>>#>#@. ",
-" =..=&++++++++++++;;;;;;;;;;;;;%###>>###+%== ",
-" .&....=-+++++%;;####''''''''''##'%%%)..#. ",
-" .+-++@....=,+%#####'%%%%%%%%%;@$-@-@*++!. ",
-" .+-++-+++-&-@$$=$=......$,,,@;&)+!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" =+-++-+++-+++++++++!++++!++++!+++!++!+++= ",
-" $.++-+++-+++++++++!++++!++++!+++!++!+.$ ",
-" =.++++++++++++++!++++!++++!+++!++.= ",
-" $..+++++++++++++++!++++++...$ ",
-" $$=.............=$$ ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" "]
-
-trashcan_open_xpm = [
-"64 80 17 1",
-" c None",
-". c #030304",
-"+ c #5A5A5C",
-"@ c #323231",
-"# c #888888",
-"$ c #1E1E1F",
-"% c #767677",
-"& c #494949",
-"* c #9E9E9C",
-"= c #111111",
-"- c #3C3C3D",
-"; c #6B6B6B",
-"> c #949494",
-", c #282828",
-"' c #808080",
-") c #545454",
-"! c #AEAEAC",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" .=.==.,@ ",
-" ==.,@-&&&)-= ",
-" .$@,&++;;;%>*- ",
-" $,-+)+++%%;;'#+. ",
-" =---+++++;%%%;%##@. ",
-" @)++++++++;%%%%'#%$ ",
-" $&++++++++++;%%;%##@= ",
-" ,-++++)+++++++;;;'#%) ",
-" @+++&&--&)++++;;%'#'-. ",
-" ,&++-@@,,,,-)++;;;'>'+, ",
-" =-++&@$@&&&&-&+;;;%##%+@ ",
-" =,)+)-,@@&+++++;;;;%##%&@ ",
-" @--&&,,@&)++++++;;;;'#)@ ",
-" ---&)-,@)+++++++;;;%''+, ",
-" $--&)+&$-+++++++;;;%%'';- ",
-" .,-&+++-$&++++++;;;%''%&= ",
-" $,-&)++)-@++++++;;%''%), ",
-" =,@&)++++&&+++++;%'''+$@&++++++ ",
-" .$@-++++++++++++;'#';,........=$@&++++ ",
-" =$@@&)+++++++++++'##-.................=&++ ",
-" .$$@-&)+++++++++;%#+$.....................=)+ ",
-" $$,@-)+++++++++;%;@=........................,+ ",
-" .$$@@-++++++++)-)@=............................ ",
-" $,@---)++++&)@===............................,. ",
-" $-@---&)))-$$=..............................=)!. ",
-" --&-&&,,$=,==...........................=&+++!. ",
-" =,=$..=$+)+++++&@$=.............=$@&+++++!++!. ",
-" .)-++-+++++++++++++++++++++++++++!++!++!. ",
-" .+-++-+++++++++++++++++++++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!+++!!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" =+-++-+++-+++++++++!++++!++++!+++!++!+++= ",
-" $.++-+++-+++++++++!++++!++++!+++!++!+.$ ",
-" =.++++++++++++++!++++!++++!+++!++.= ",
-" $..+++++++++++++++!++++++...$ ",
-" $$==...........==$$ ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" "]
diff --git a/examples/pygtk-demo/demos/editable_cells.py b/examples/pygtk-demo/demos/editable_cells.py
deleted file mode 100644
index a0797ad0..00000000
--- a/examples/pygtk-demo/demos/editable_cells.py
+++ /dev/null
@@ -1,166 +0,0 @@
-#!/usr/bin/env python
-'''Tree View/Editable Cells
-
-This demo demonstrates the use of editable cells in a GtkTreeView.
-If you're new to the GtkTreeView widgets and associates, look into the
-GtkListStore example first.'''
-# pygtk version: Maik Hertha <maik.hertha@berlin.de>
-
-import gobject
-import gtk
-
-# columns
-(
- COLUMN_NUMBER,
- COLUMN_PRODUCT,
- COLUMN_EDITABLE
-) = range(3)
-
-# data
-articles = [
- [ 3, "bottles of coke", True ],
- [ 5, "packages of noodles", True ],
- [ 2, "packages of chocolate chip cookies", True ],
- [ 1, "can vanilla ice cream", True ],
- [ 6, "eggs", True ]
-]
-
-class EditableCellsDemo(gtk.Window):
- def __init__(self, parent=None):
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
- self.set_title(self.__class__.__name__)
- self.set_border_width(5)
- self.set_default_size(320, 200)
-
- vbox = gtk.VBox(False, 5)
- self.add(vbox)
-
- label = gtk.Label("Shopping list (you can edit the cells!)")
- vbox.pack_start(label, False, False)
-
- sw = gtk.ScrolledWindow()
- sw.set_shadow_type(gtk.SHADOW_ETCHED_IN)
- sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- vbox.pack_start(sw)
-
- # create model
- model = self.__create_model()
-
- # create tree view
- treeview = gtk.TreeView(model)
- treeview.set_rules_hint(True)
- treeview.get_selection().set_mode(gtk.SELECTION_SINGLE)
-
- self.__add_columns(treeview)
-
- sw.add(treeview)
-
- # some buttons
- hbox = gtk.HBox(True, 4)
- vbox.pack_start(hbox, False, False)
-
- button = gtk.Button(stock=gtk.STOCK_ADD)
- button.connect("clicked", self.on_add_item_clicked, model)
- hbox.pack_start(button)
-
- button = gtk.Button(stock=gtk.STOCK_REMOVE)
- button.connect("clicked", self.on_remove_item_clicked, treeview)
- hbox.pack_start(button)
-
- self.show_all()
-
- def __create_model(self):
-
- # create list store
- model = gtk.ListStore(
- gobject.TYPE_INT,
- gobject.TYPE_STRING,
- gobject.TYPE_BOOLEAN
- )
-
- # add items
- for item in articles:
- iter = model.append()
-
- model.set (iter,
- COLUMN_NUMBER, item[COLUMN_NUMBER],
- COLUMN_PRODUCT, item[COLUMN_PRODUCT],
- COLUMN_EDITABLE, item[COLUMN_EDITABLE]
- )
- return model
-
-
- def __add_columns(self, treeview):
-
- model = treeview.get_model()
-
- # number column
- renderer = gtk.CellRendererText()
- renderer.connect("edited", self.on_cell_edited, model)
- renderer.set_data("column", COLUMN_NUMBER)
-
- column = gtk.TreeViewColumn("Number", renderer, text=COLUMN_NUMBER,
- editable=COLUMN_EDITABLE)
- treeview.append_column(column)
-
- # product column
- renderer = gtk.CellRendererText()
- renderer.connect("edited", self.on_cell_edited, model)
- renderer.set_data("column", COLUMN_PRODUCT)
-
- column = gtk.TreeViewColumn("Product", renderer, text=COLUMN_PRODUCT,
- editable=COLUMN_EDITABLE)
- treeview.append_column(column)
-
-
- def on_add_item_clicked(self, button, model):
- new_item = [0, "Description here", True]
- articles.append(new_item)
-
- iter = model.append()
- model.set (iter,
- COLUMN_NUMBER, new_item[COLUMN_NUMBER],
- COLUMN_PRODUCT, new_item[COLUMN_PRODUCT],
- COLUMN_EDITABLE, new_item[COLUMN_EDITABLE]
- )
-
-
- def on_remove_item_clicked(self, button, treeview):
-
- selection = treeview.get_selection()
- model, iter = selection.get_selected()
-
- if iter:
- path = model.get_path(iter)[0]
- model.remove(iter)
-
- del articles[ path ]
-
-
- def on_cell_edited(self, cell, path_string, new_text, model):
-
- iter = model.get_iter_from_string(path_string)
- path = model.get_path(iter)[0]
- column = cell.get_data("column")
-
- if column == COLUMN_NUMBER:
- articles[path][COLUMN_NUMBER] = int(new_text)
-
- model.set(iter, column, articles[path][COLUMN_NUMBER])
-
- elif column == COLUMN_PRODUCT:
- old_text = model.get_value(iter, column)
- articles[path][COLUMN_PRODUCT] = new_text
-
- model.set(iter, column, articles[path][COLUMN_PRODUCT])
-
-def main():
- EditableCellsDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/entry_completion.py b/examples/pygtk-demo/demos/entry_completion.py
deleted file mode 100644
index 71e094e6..00000000
--- a/examples/pygtk-demo/demos/entry_completion.py
+++ /dev/null
@@ -1,76 +0,0 @@
-#!/usr/bin/env python
-'''Entry Completion
-
-GtkEntryCompletion provides a mechanism for adding support for
-completion in GtkEntry.
-'''
-# pygtk version: Maik Hertha <maik.hertha@berlin.de>
-
-import gtk
-
-class EntryCompletionDemo(gtk.Dialog):
-
- def __init__(self, parent=None):
- gtk.Dialog.__init__(self, self.__class__.__name__, parent,
- 0,
- (gtk.STOCK_CLOSE, gtk.RESPONSE_NONE))
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
- self.connect("response", lambda d, r: d.destroy())
- self.set_resizable(False)
-
- vbox = gtk.VBox(False, 5)
- self.vbox.pack_start(vbox, True, True, 0)
- vbox.set_border_width(5)
-
- label = gtk.Label()
- label.set_markup("Completion demo, try writing <b>total</b> "
- "or <b>gnome</b> for example.")
- vbox.pack_start(label, False, False, 0)
-
- # Create our entry
- entry = gtk.Entry()
- vbox.pack_start(entry, False, False, 0)
-
- # Create the completion object
- completion = gtk.EntryCompletion()
-
- # Assign the completion to the entry
- entry.set_completion(completion)
-
- # Create a tree model and use it as the completion model
- completion_model = self.__create_completion_model()
- completion.set_model(completion_model)
-
- # Use model column 0 as the text column
- completion.set_text_column(0)
-
- self.show_all()
-
- def __create_completion_model(self):
- ''' Creates a tree model containing the completions.
- '''
- store = gtk.ListStore(str)
-
- # Append one word
- iter = store.append()
- store.set(iter, 0, "GNOME")
-
- # Append another word
- iter = store.append()
- store.set(iter, 0, "total")
-
- # And another word
- iter = store.append()
- store.set(iter, 0, "totally")
-
- return store
-
-def main():
- EntryCompletionDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/expander.py b/examples/pygtk-demo/demos/expander.py
deleted file mode 100644
index bb02b950..00000000
--- a/examples/pygtk-demo/demos/expander.py
+++ /dev/null
@@ -1,47 +0,0 @@
-#!/usr/bin/env python
-'''Expander
-
-GtkExpander allows to provide additional content that is initially hidden.
-This is also known as "disclosure triangle".
-'''
-# pygtk version: Maik Hertha <maik.hertha@berlin.de>
-
-import gtk
-
-class ExpanderDemo(gtk.Dialog):
-
- def __init__(self, parent=None):
- gtk.Dialog.__init__(self, self.__class__.__name__, parent,
- 0,
- (gtk.STOCK_CLOSE, gtk.RESPONSE_NONE))
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
- self.connect("response", lambda d, r: d.destroy())
- self.set_resizable(False)
-
- vbox = gtk.VBox(False, 5)
- self.vbox.pack_start(vbox, True, True, 0)
- vbox.set_border_width(5)
-
- label = gtk.Label()
- label.set_markup("Expander demo. Click on the triangle for details.")
- vbox.pack_start(label, False, False, 0)
-
- # Create the expander
- expander = gtk.Expander("Details")
- vbox.pack_start(expander, False, False, 0)
-
- # The Label for the expander
- label = gtk.Label("Details can be shown or hidden.")
- expander.add(label)
-
- self.show_all()
-
-def main():
- ExpanderDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/hypertext.py b/examples/pygtk-demo/demos/hypertext.py
deleted file mode 100644
index 2dd0fc60..00000000
--- a/examples/pygtk-demo/demos/hypertext.py
+++ /dev/null
@@ -1,184 +0,0 @@
-#!/usr/bin/env python
-'''Text Widget/Hypertext
-
-Usually, tags modify the appearance of text in the view, e.g. making it
-bold or colored or underlined. But tags are not restricted to appearance.
-They can also affect the behavior of mouse and key presses, as this demo
-shows.'''
-# pygtk version: Maik Hertha <maik.hertha@berlin.de>
-
-import gtk
-import pango
-
-class HypertextDemo(gtk.Window):
- hovering_over_link = False
- hand_cursor = gtk.gdk.Cursor(gtk.gdk.HAND2)
- regular_cursor = gtk.gdk.Cursor(gtk.gdk.XTERM)
-
- def __init__(self, parent=None):
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
-
- self.set_title(self.__class__.__name__)
- self.set_default_size(450, 450)
- self.set_border_width(0)
-
- view = gtk.TextView()
- view.set_wrap_mode(gtk.WRAP_WORD)
- view.connect("key-press-event", self.key_press_event)
- view.connect("event-after", self.event_after)
- view.connect("motion-notify-event", self.motion_notify_event)
- view.connect("visibility-notify-event", self.visibility_notify_event)
-
- buffer = view.get_buffer()
-
- sw = gtk.ScrolledWindow()
- sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- self.add(sw)
- sw.add(view)
-
- self.show_page(buffer, 1)
-
- self.show_all()
-
- # Links can be activated by pressing Enter.
- def key_press_event(self, text_view, event):
- if (event.keyval == gtk.gdk.Return or
- event.keyval == gtk.gdk.KP_Enter):
- buffer = text_view.get_buffer()
- iter = buffer.get_iter_at_mark(buffer.get_insert())
- self.follow_if_link(text_view, iter)
- return False
-
- # Links can also be activated by clicking.
- def event_after(self, text_view, event):
- if event.type != gtk.gdk.BUTTON_RELEASE:
- return False
- if event.button != 1:
- return False
- buffer = text_view.get_buffer()
-
- # we shouldn't follow a link if the user has selected something
- try:
- start, end = buffer.get_selection_bounds()
- except ValueError:
- # If there is nothing selected, None is return
- pass
- else:
- if start.get_offset() != end.get_offset():
- return False
-
- x, y = text_view.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET,
- int(event.x), int(event.y))
- iter = text_view.get_iter_at_location(x, y)
-
- self.follow_if_link(text_view, iter)
- return False
-
-
- # Looks at all tags covering the position (x, y) in the text view,
- # and if one of them is a link, change the cursor to the "hands" cursor
- # typically used by web browsers.
- def set_cursor_if_appropriate(self, text_view, x, y):
- hovering = False
-
- buffer = text_view.get_buffer()
- iter = text_view.get_iter_at_location(x, y)
-
- tags = iter.get_tags()
- for tag in tags:
- page = tag.get_data("page")
- if page != 0:
- hovering = True
- break
-
- if hovering != self.hovering_over_link:
- self.hovering_over_link = hovering
-
- if self.hovering_over_link:
- text_view.get_window(gtk.TEXT_WINDOW_TEXT).set_cursor(self.hand_cursor)
- else:
- text_view.get_window(gtk.TEXT_WINDOW_TEXT).set_cursor(self.regular_cursor)
-
- # Update the cursor image if the pointer moved.
- def motion_notify_event(self, text_view, event):
- x, y = text_view.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET,
- int(event.x), int(event.y))
- self.set_cursor_if_appropriate(text_view, x, y)
- text_view.window.get_pointer()
- return False
-
- # Also update the cursor image if the window becomes visible
- # (e.g. when a window covering it got iconified).
- def visibility_notify_event(self, text_view, event):
- wx, wy, mod = text_view.window.get_pointer()
- bx, by = text_view.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET, wx, wy)
-
- self.set_cursor_if_appropriate (text_view, bx, by)
- return False
-
- def insert_link(self, buffer, iter, text, page):
- ''' Inserts a piece of text into the buffer, giving it the usual
- appearance of a hyperlink in a web browser: blue and underlined.
- Additionally, attaches some data on the tag, to make it recognizable
- as a link.
- '''
- tag = buffer.create_tag(None,
- foreground="blue", underline=pango.UNDERLINE_SINGLE)
- tag.set_data("page", page)
- buffer.insert_with_tags(iter, text, tag)
-
-
- def show_page(self, buffer, page):
- ''' Fills the buffer with text and interspersed links. In any real
- hypertext app, this method would parse a file to identify the links.
- '''
- buffer.set_text("", 0)
- iter = buffer.get_iter_at_offset(0)
- if page == 1:
- buffer.insert(iter, "Some text to show that simple ")
- self.insert_link(buffer, iter, "hypertext", 3)
- buffer.insert(iter, " can easily be realized with ")
- self.insert_link(buffer, iter, "tags", 2)
- buffer.insert(iter, ".")
-
- elif page == 2:
- buffer.insert(iter,
- "A tag is an attribute that can be applied to some range of text. "
- "For example, a tag might be called \"bold\" and make the text inside "
- "the tag bold. However, the tag concept is more general than that "
- "tags don't have to affect appearance. They can instead affect the "
- "behavior of mouse and key presses, \"lock\" a range of text so the "
- "user can't edit it, or countless other things.\n", -1)
- self.insert_link(buffer, iter, "Go back", 1)
- elif page == 3:
- tag = buffer.create_tag(None, weight=pango.WEIGHT_BOLD)
- buffer.insert_with_tags(iter, "hypertext:\n", tag)
- buffer.insert(iter,
- "machine-readable text that is not sequential but is organized "
- "so that related items of information are connected.\n")
- self.insert_link(buffer, iter, "Go back", 1)
-
-
- def follow_if_link(self, text_view, iter):
- ''' Looks at all tags covering the position of iter in the text view,
- and if one of them is a link, follow it by showing the page identified
- by the data attached to it.
- '''
- tags = iter.get_tags()
- for tag in tags:
- page = tag.get_data("page")
- if page != 0:
- self.show_page(text_view.get_buffer(), page)
- break
-
-
-def main():
- HypertextDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/images.py b/examples/pygtk-demo/demos/images.py
deleted file mode 100644
index 176cfa78..00000000
--- a/examples/pygtk-demo/demos/images.py
+++ /dev/null
@@ -1,306 +0,0 @@
-#!/usr/bin/env python
-'''Images
-
-GtkImage is used to display an image; the image can be in a number of formats.
-Typically, you load an image into a GdkPixbuf, then display the pixbuf.
-This demo code shows some of the more obscure cases, in the simple case a call
-to gtk_image_new_from_file() is all you need.
-If you want to put image data in your program as a C variable, use the
-make-inline-pixbuf program that comes with GTK+. This way you won't need to
-depend on loading external files, your application binary can be self-contained.'''
-# pygtk version: Maik Hertha <maik.hertha@berlin.de>
-
-import os
-import gobject
-import gtk
-
-IMAGEDIR = os.path.join(os.path.dirname(__file__), 'images')
-ALPHA_IMAGE = os.path.join(IMAGEDIR, 'alphatest.png')
-GTKLOGO_IMAGE = os.path.join(IMAGEDIR, 'gtk-logo-rgb.gif')
-BUDDY_IMAGE = os.path.join(IMAGEDIR, 'floppybuddy.gif')
-
-def progressive_prepared_callback(loader, image):
- pixbuf = loader.get_pixbuf()
-
- # Avoid displaying random memory contents, since the pixbuf
- # isn't filled in yet.
- #images.c -> gdk_pixbuf_fill(pixbuf, 0xaaaaaaff)
- pixbuf.fill(0)
- image.set_from_pixbuf(pixbuf)
-
-
-def progressive_updated_callback(loader, x, y, width, height, image):
- ''' We know the pixbuf inside the GtkImage has changed, but the image
- itself doesn't know this; so queue a redraw. If we wanted to be
- really efficient, we could use a drawing area or something
- instead of a GtkImage, so we could control the exact position of
- the pixbuf on the display, then we could queue a draw for only
- the updated area of the image.
- '''
- image.queue_draw()
-
-class ImagesDemo(gtk.Window):
- pixbuf_loader = None
- load_timeout = None
- image_stream = None
-
- def __init__(self, parent=None):
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
- self.connect("destroy", self.cleanup_callback)
- self.set_title(self.__class__.__name__)
- self.set_border_width(8)
-
- vbox = gtk.VBox(False, 8)
- vbox.set_border_width(8)
- self.add(vbox)
-
- label = gtk.Label();
- label.set_markup("<u>Image loaded from a file</u>")
- vbox.pack_start(label, False, False, 0)
-
- frame = gtk.Frame()
- frame.set_shadow_type(gtk.SHADOW_IN)
-
- # The alignment keeps the frame from growing when users resize
- # the window
- align = gtk.Alignment(0.5, 0.5, 0, 0)
- align.add(frame)
- vbox.pack_start(align, False, False, 0)
-
- image = gtk.Image()
-
- # use the current directory for the file
- try:
- pixbuf = gtk.gdk.pixbuf_new_from_file(GTKLOGO_IMAGE)
- image.set_from_pixbuf(pixbuf)
-
- except gobject.GError, error:
-
- # This code shows off error handling. You can just use
- # gtk_image_new_from_file() instead if you don't want to report
- # errors to the user. If the file doesn't load when using
- # gtk_image_new_from_file(), a "missing image" icon will
- # be displayed instead.
-
- dialog = gtk.MessageDialog(self,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR,
- gtk.BUTTONS_CLOSE,
- "Unable to open image file 'gtk-logo-rgb.gif': \n%s" % error)
-
- dialog.connect("response", lambda dlg, resp: dlg.destroy())
- dialog.show()
-
- frame.add(image)
-
- # Animation
-
- label = gtk.Label()
- label.set_markup("<u>Animation loaded from a file</u>")
- vbox.pack_start(label, False, False, 0)
-
- frame = gtk.Frame()
- frame.set_shadow_type(gtk.SHADOW_IN)
-
- # The alignment keeps the frame from growing when users resize
- # the window
-
- align = gtk.Alignment(0.5, 0.5, 0, 0)
- align.add(frame)
- vbox.pack_start(align, False, False, 0)
-
- image = gtk.Image()
- image.set_from_file(BUDDY_IMAGE);
-
- frame.add(image)
-
- # Progressive
-
- label = gtk.Label()
- label.set_markup("<u>Progressive image loading</u>")
- vbox.pack_start(label, False, False, 0)
-
- frame = gtk.Frame()
- frame.set_shadow_type(gtk.SHADOW_IN)
-
- # The alignment keeps the frame from growing when users resize
- # the window
-
- align = gtk.Alignment(0.5, 0.5, 0, 0)
- align.add(frame)
- vbox.pack_start(align, False, False, 0)
-
- # Create an empty image for now; the progressive loader
- # will create the pixbuf and fill it in.
-
- image = gtk.Image()
- image.set_from_pixbuf(None)
- frame.add(image)
-
- self.start_progressive_loading(image)
-
- # Sensitivity control
-
- button = gtk.ToggleButton("_Insensitive");
- vbox.pack_start(button, False, False, 0)
-
- button.connect("toggled", self.on_sensitivity_toggled, vbox)
-
- self.show_all()
-
- def cleanup_callback(self, win):
- if self.load_timeout != 0:
- gtk.timeout_remove(self.load_timeout)
- self.load_timeout = 0
-
- if self.pixbuf_loader is not None:
- self.pixbuf_loader.close()
- self.pixbuf_loader = None
-
- if self.image_stream is not None:
- self.image_stream.close()
- self.image_stream = None
-
-
- def on_sensitivity_toggled(self, togglebutton, container):
- children = container.get_children()
-
- for child in children:
-
- # don't disable our toggle
- if type(child) != type(togglebutton):
- child.set_sensitive(not togglebutton.get_active())
-
- def start_progressive_loading(self, image):
- ''' This is obviously totally contrived(we slow down loading
- on purpose to show how incremental loading works).
- The real purpose of incremental loading is the case where
- you are reading data from a slow source such as the network.
- The timeout simply simulates a slow data source by inserting
- pauses in the reading process.
- '''
- self.load_timeout = gtk.timeout_add(150, self.progressive_timeout, image)
-
- def progressive_timeout(self, image):
-
- # This shows off fully-paranoid error handling, so looks scary.
- # You could factor out the error handling code into a nice separate
- # function to make things nicer.
-
- if self.image_stream is not None: # file is already opened
- try:
- buf = self.image_stream.read(256)
- bytes_read = len(buf)
-
- except IOError, error:
- dialog = gtk.MessageDialog(self,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR,
- gtk.BUTTONS_CLOSE,
- "Failure reading image file 'alphatest.png': %s" % error)
-
- dialog.connect("response", lambda d, r: d.destroy())
-
- self.image_stream.close()
- self.image_stream = None
-
- dialog.show()
-
- self.load_timeout = 0
-
- return False; # uninstall the timeout
-
- if not self.pixbuf_loader.write(buf, bytes_read):
-
- dialog = gtk.MessageDialog(self,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR,
- gtk.BUTTONS_CLOSE,
- "Failed to load image")
-
- dialog.connect("response", lambda d, r: d.destroy())
-
- self.image_stream.close()
- self.image_stream = None
-
- dialog.show()
-
- self.load_timeout = 0
-
- return False # uninstall the timeout
-
- #if(feof(image_stream)):
- if bytes_read == 0:
-
- self.image_stream.close()
- self.image_stream = None
-
- # Errors can happen on close, e.g. if the image
- # file was truncated we'll know on close that
- # it was incomplete.
-
- if not self.pixbuf_loader.close():
-
- dialog = gtk.MessageDialog(self,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR,
- gtk.BUTTONS_CLOSE,
- "Failed to load image")
-
- dialog.connect("response", lambda d, r: d.destroy())
- dialog.show()
-
- self.pixbuf_loader = None
-
- self.load_timeout = 0
-
- return False # uninstall the timeout
-
- # if feof(image_stream)
- self.pixbuf_loader = None
-
- else: # if(image_stream) ...
- try:
- self.image_stream = open(ALPHA_IMAGE, "rb")
-
- except IOError, error:
- error_message = "Unable to open image file 'alphatest.png' : %s"
-
- dialog = gtk.MessageDialog(self,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR,
- gtk.BUTTONS_CLOSE,
- error_message % error)
-
- dialog.connect("response", lambda d, r: d.destroy())
- dialog.show()
-
- self.load_timeout = 0
-
- return False # uninstall the timeout
-
- if self.pixbuf_loader is not None:
- self.pixbuf_loader.close()
- self.pixbuf_loader = None
-
- self.pixbuf_loader = gtk.gdk.PixbufLoader()
-
- self.pixbuf_loader.connect("area_prepared",
- progressive_prepared_callback, image)
-
- self.pixbuf_loader.connect("area_updated",
- progressive_updated_callback, image)
-
- # leave timeout installed
- return True;
-
-def main():
- ImagesDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/images/alphatest.png b/examples/pygtk-demo/demos/images/alphatest.png
deleted file mode 100644
index eb5885f8..00000000
--- a/examples/pygtk-demo/demos/images/alphatest.png
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/images/apple-red.png b/examples/pygtk-demo/demos/images/apple-red.png
deleted file mode 100644
index b0a24e94..00000000
--- a/examples/pygtk-demo/demos/images/apple-red.png
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/images/background.jpg b/examples/pygtk-demo/demos/images/background.jpg
deleted file mode 100644
index 86c006aa..00000000
--- a/examples/pygtk-demo/demos/images/background.jpg
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/images/floppybuddy.gif b/examples/pygtk-demo/demos/images/floppybuddy.gif
deleted file mode 100644
index ac986c8e..00000000
--- a/examples/pygtk-demo/demos/images/floppybuddy.gif
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/images/gnome-applets.png b/examples/pygtk-demo/demos/images/gnome-applets.png
deleted file mode 100644
index 8d3549e9..00000000
--- a/examples/pygtk-demo/demos/images/gnome-applets.png
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/images/gnome-calendar.png b/examples/pygtk-demo/demos/images/gnome-calendar.png
deleted file mode 100644
index 889f329a..00000000
--- a/examples/pygtk-demo/demos/images/gnome-calendar.png
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/images/gnome-foot.png b/examples/pygtk-demo/demos/images/gnome-foot.png
deleted file mode 100644
index 04766585..00000000
--- a/examples/pygtk-demo/demos/images/gnome-foot.png
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/images/gnome-gimp.png b/examples/pygtk-demo/demos/images/gnome-gimp.png
deleted file mode 100644
index f6bbc6d3..00000000
--- a/examples/pygtk-demo/demos/images/gnome-gimp.png
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/images/gnome-gmush.png b/examples/pygtk-demo/demos/images/gnome-gmush.png
deleted file mode 100644
index 0a4b0d04..00000000
--- a/examples/pygtk-demo/demos/images/gnome-gmush.png
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/images/gnome-gsame.png b/examples/pygtk-demo/demos/images/gnome-gsame.png
deleted file mode 100644
index 01c06115..00000000
--- a/examples/pygtk-demo/demos/images/gnome-gsame.png
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/images/gnu-keys.png b/examples/pygtk-demo/demos/images/gnu-keys.png
deleted file mode 100644
index 58a33770..00000000
--- a/examples/pygtk-demo/demos/images/gnu-keys.png
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/images/gtk-logo-rgb.gif b/examples/pygtk-demo/demos/images/gtk-logo-rgb.gif
deleted file mode 100644
index 63c622b9..00000000
--- a/examples/pygtk-demo/demos/images/gtk-logo-rgb.gif
+++ /dev/null
Binary files differ
diff --git a/examples/pygtk-demo/demos/list_store.py b/examples/pygtk-demo/demos/list_store.py
deleted file mode 100644
index 6273033d..00000000
--- a/examples/pygtk-demo/demos/list_store.py
+++ /dev/null
@@ -1,141 +0,0 @@
-#!/usr/bin/env python
-'''Tree View/List Store
-
-The GtkListStore is used to store data in list form, to be used
-later on by a GtkTreeView to display it. This demo builds a
-simple GtkListStore and displays it. See the Stock Browser
-demo for a more advanced example.'''
-
-import gobject
-import gtk
-
-(
- COLUMN_FIXED,
- COLUMN_NUMBER,
- COLUMN_SEVERITY,
- COLUMN_DESCRIPTION
-) = range(4)
-
-data = \
-((False, 60482, 'Normal', 'scrollable notebooks and hidden tabs'),
- (False, 60620, 'Critical',
- 'gdk_window_clear_area(gdkwindow-win32.c) is not thread-safe'),
- (False, 50214, 'Major', 'Xft support does not clean up correctly'),
- (True, 52877, 'Major', 'GtkFileSelection needs a refresh method. '),
- (False, 56070, 'Normal', "Can't click button after setting in sensitive"),
- (True, 56355, 'Normal', 'GtkLabel - Not all changes propagate correctly'),
- (False, 50055, 'Normal', 'Rework width/height computations for TreeView'),
- (False, 58278, 'Normal', "gtk_dialog_set_response_sensitive() doesn't work"),
- (False, 55767, 'Normal', 'Getters for all setters'),
- (False, 56925, 'Normal', 'Gtkcalender size'),
- (False, 56221, 'Normal', 'Selectable label needs right-click copy menu'),
- (True, 50939, 'Normal', 'Add shift clicking to GtkTextView'),
- (False, 6112, 'Enhancement', 'netscape-like collapsable toolbars'),
- (False, 1, 'Normal', 'First bug :=)'))
-
-class ListStoreDemo(gtk.Window):
- def __init__(self, parent=None):
- # create window, etc
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
- self.set_title(self.__class__.__name__)
-
- self.set_border_width(8)
- self.set_default_size(300, 250)
-
- vbox = gtk.VBox(False, 8)
- self.add(vbox)
-
- label = gtk.Label('This is the bug list (note: not based on real data, '
- 'it would be nice to have a nice ODBC interface to bugzilla or so, though).')
- vbox.pack_start(label, False, False)
-
- sw = gtk.ScrolledWindow()
- sw.set_shadow_type(gtk.SHADOW_ETCHED_IN)
- sw.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
- vbox.pack_start(sw)
-
- # create tree model
- model = self.__create_model()
-
- # create tree view
- treeview = gtk.TreeView(model)
- treeview.set_rules_hint(True)
- treeview.set_search_column(COLUMN_DESCRIPTION)
-
- sw.add(treeview)
-
- # add columns to the tree view
- self.__add_columns(treeview)
-
- self.show_all()
-
- def __create_model(self):
- lstore = gtk.ListStore(
- gobject.TYPE_BOOLEAN,
- gobject.TYPE_UINT,
- gobject.TYPE_STRING,
- gobject.TYPE_STRING)
-
- for item in data:
- iter = lstore.append()
- lstore.set(iter,
- COLUMN_FIXED, item[COLUMN_FIXED],
- COLUMN_NUMBER, item[COLUMN_NUMBER],
- COLUMN_SEVERITY, item[COLUMN_SEVERITY],
- COLUMN_DESCRIPTION, item[COLUMN_DESCRIPTION])
- return lstore
-
- def fixed_toggled(self, cell, path, model):
- # get toggled iter
- iter = model.get_iter((int(path),))
- fixed = model.get_value(iter, COLUMN_FIXED)
-
- # do something with the value
- fixed = not fixed
-
- # set new value
- model.set(iter, COLUMN_FIXED, fixed)
-
- def __add_columns(self, treeview):
- model = treeview.get_model()
-
- # column for fixed toggles
- renderer = gtk.CellRendererToggle()
- renderer.connect('toggled', self.fixed_toggled, model)
-
- column = gtk.TreeViewColumn('Fixed', renderer, active=COLUMN_FIXED)
-
- # set this column to a fixed sizing(of 50 pixels)
- column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
- column.set_fixed_width(50)
-
- treeview.append_column(column)
-
- # column for bug numbers
- column = gtk.TreeViewColumn('Bug Number', gtk.CellRendererText(),
- text=COLUMN_NUMBER)
- column.set_sort_column_id(COLUMN_NUMBER)
- treeview.append_column(column)
-
- # columns for severities
- column = gtk.TreeViewColumn('Severity', gtk.CellRendererText(),
- text=COLUMN_SEVERITY)
- column.set_sort_column_id(COLUMN_SEVERITY)
- treeview.append_column(column)
-
- # column for description
- column = gtk.TreeViewColumn('Description', gtk.CellRendererText(),
- text=COLUMN_DESCRIPTION)
- column.set_sort_column_id(COLUMN_DESCRIPTION)
- treeview.append_column(column)
-
-def main():
- ListStoreDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/menu.py b/examples/pygtk-demo/demos/menu.py
deleted file mode 100644
index 3a61a427..00000000
--- a/examples/pygtk-demo/demos/menu.py
+++ /dev/null
@@ -1,88 +0,0 @@
-#!/usr/bin/env python
-'''Menu
-
-This example demonstrates the use of various menu types in gtk. It
-demonstrates the new submenu navigation and scrolling menu features of
-gtk 2.0.'''
-
-import gtk
-
-def create_menu(depth, length=5):
- if depth < 1:
- return None
-
- menu = gtk.Menu()
- group= None
-
- for i in range(length):
- menuitem = gtk.RadioMenuItem(group, 'item %2d - %d' % (depth, i))
- group = menuitem
- menu.add(menuitem)
- menuitem.show()
- if depth > 1:
- submenu = create_menu(depth - 1)
- menuitem.set_submenu(submenu)
- return menu
-
-class MenuDemo(gtk.Window):
- def __init__(self, parent=None):
- # Create the toplevel window
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
-
- self.set_title(self.__class__.__name__)
-
- vbox = gtk.VBox()
- self.add(vbox)
-
- menubar = gtk.MenuBar()
- vbox.pack_start(menubar, expand=False)
-
- menuitem = gtk.MenuItem('test\nline2')
- menuitem.set_submenu(create_menu(2, 50))
- menubar.add(menuitem)
-
- menuitem = gtk.MenuItem('foo')
- menuitem.set_submenu(create_menu(2))
- menubar.add(menuitem)
-
- menuitem = gtk.MenuItem('bar')
- menuitem.set_submenu(create_menu(2))
- menuitem.set_right_justified(True)
- menubar.add(menuitem)
-
- vbox2 = gtk.VBox(spacing=10)
- vbox2.set_border_width(10)
- vbox.pack_start(vbox2)
-
- combo_box = gtk.combo_box_new_text()
- combo_box.set_wrap_width(2)
- for i in range(50):
- combo_box.append_text('item - %d' % i)
- combo_box.set_active(0)
- vbox2.pack_start(combo_box)
-
- separator = gtk.HSeparator()
- vbox.pack_start(separator, expand=False)
-
- vbox2 = gtk.VBox(spacing=10)
- vbox2.set_border_width(10)
- vbox.pack_start(vbox2, expand=False)
-
- button = gtk.Button('close')
- button.connect('clicked', lambda button, w=self: w.destroy())
- vbox2.pack_start(button)
- button.set_flags(gtk.CAN_DEFAULT)
- button.grab_default()
-
- self.show_all()
-
-def main():
- MenuDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/panes.py b/examples/pygtk-demo/demos/panes.py
deleted file mode 100644
index 007ec077..00000000
--- a/examples/pygtk-demo/demos/panes.py
+++ /dev/null
@@ -1,124 +0,0 @@
-#!/usr/bin/env python
-"""Paned Widgets
-
-The GtkHPaned and GtkVPaned Widgets divide their content area into two panes
-with a divider in between that the user can adjust. A separate child is placed
-into each pane.
-There are a number of options that can be set for each pane. This test contains
-both a horizontal(HPaned) and a vertical(VPaned) widget, and allows you to
-adjust the options for each side of each widget."""
-
-import gtk
-
-class PanedWidgetsDemo(gtk.Window):
- def __init__(self, parent=None):
- # Create the toplevel window
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
-
- self.set_title(self.__class__.__name__)
- self.set_border_width(0)
-
- vbox = gtk.VBox(False, 0)
- self.add(vbox)
-
- vpaned = gtk.VPaned()
- vbox.pack_start(vpaned, True, True)
- vpaned.set_border_width(5)
-
- hpaned = gtk.HPaned()
- vpaned.add1(hpaned)
-
- frame = gtk.Frame()
- frame.set_shadow_type(gtk.SHADOW_IN)
- frame.set_size_request(60, 60)
- hpaned.add1(frame)
-
- button = gtk.Button("_Hi there")
- frame.add(button)
-
- frame = gtk.Frame()
- frame.set_shadow_type(gtk.SHADOW_IN)
- frame.set_size_request(80, 60)
- hpaned.add2(frame)
-
- frame = gtk.Frame()
- frame.set_shadow_type(gtk.SHADOW_IN)
- frame.set_size_request(60, 80)
- vpaned.add2(frame)
-
- # Now create toggle buttons to control sizing
-
- vbox.pack_start(
- self.__create_pane_options(hpaned, "Horizontal", "Left", "Right"),
- False, False, 0)
-
- vbox.pack_start(
- self.__create_pane_options(vpaned, "Vertical", "Top", "Bottom"),
- False, False, 0)
-
- self.show_all()
-
- def on_resize_toggled(self, tbutton, child):
- paned = child.parent
-
- if child == paned.get_children()[0]:
- paned.remove(child)
- paned.pack1(child, tbutton.get_active(), 0)
- else:
- paned.remove(child)
- paned.pack2(child, tbutton.get_active(), 0)
-
- def on_shrink_toggled(self, tbutton, child):
- paned = child.parent
-
- if child == paned.get_children()[0]:
- paned.remove(child)
- paned.pack1(child, 0, tbutton.get_active())
- else:
- paned.remove(child)
- paned.pack2(child, 0, tbutton.get_active())
-
- def __create_pane_options(self, paned, frame_label, label1, label2):
- frame = gtk.Frame(frame_label)
- frame.set_border_width(4)
-
- table = gtk.Table(3, 2, True)
- frame.add(table)
-
- label = gtk.Label(label1)
- table.attach(label, 0, 1, 0, 1)
-
- check_button = gtk.CheckButton("_Resize")
- check_button.connect('toggled', self.on_resize_toggled, paned.get_children()[0])
- table.attach(check_button, 0, 1, 1, 2)
-
- check_button = gtk.CheckButton("_Shrink")
- check_button.set_active(True)
- check_button.connect('toggled', self.on_shrink_toggled, paned.get_children()[0])
- table.attach(check_button, 0, 1, 2, 3)
-
- label = gtk.Label(label2)
- table.attach(label, 1, 2, 0, 1)
-
- check_button = gtk.CheckButton("_Resize")
- check_button.set_active(True)
- check_button.connect('toggled', self.on_resize_toggled, paned.get_children()[1])
- table.attach(check_button, 1, 2, 1, 2)
-
- check_button = gtk.CheckButton("_Shrink")
- check_button.set_active(True)
- check_button.connect('toggled', self.on_shrink_toggled, paned.get_children()[1])
- table.attach(check_button, 1, 2, 2, 3)
-
- return frame
-
-def main():
- PanedWidgetsDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/pixbufs.py b/examples/pygtk-demo/demos/pixbufs.py
deleted file mode 100644
index c29d1dd8..00000000
--- a/examples/pygtk-demo/demos/pixbufs.py
+++ /dev/null
@@ -1,200 +0,0 @@
-#!/usr/bin/env python
-'''Pixbufs
-
-A GdkPixbuf represents an image, normally in RGB or RGBA format.
-Pixbufs are normally used to load files from disk and perform image scaling.
-This demo is not all that educational, but looks cool. It was written by
-Extreme Pixbuf Hacker Federico Mena Quintero. It also shows off how to use
-GtkDrawingArea to do a simple animation.
-Look at the Image demo for additional pixbuf usage examples.'''
-# pygtk version: Maik Hertha <maik.hertha@berlin.de>
-
-import os
-import math
-import gobject
-import gtk
-
-FRAME_DELAY = 50
-CYCLE_LEN = 60
-IMAGE_DIR = os.path.join(os.path.dirname(__file__), 'images')
-BACKGROUND_NAME = "background.jpg"
-
-image_names = [
- "apple-red.png",
- "gnome-applets.png",
- "gnome-calendar.png",
- "gnome-foot.png",
- "gnome-gmush.png",
- "gnome-gimp.png",
- "gnome-gsame.png",
- "gnu-keys.png"
-]
-
-class PixbufsDemo(gtk.Window):
- frame = None # frame of the background image
- background = None # background-pixbuf
- images = [] # list of pixbufs
- back_width = 0 # width of background image
- back_height = 0 # height of background image
- timeout_id = 0 # timeout id
- frame_num = 0 # number of the current frame
- timeout_id = None
-
- def __init__(self, parent=None):
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect("destroy", lambda *w: gtk.main_quit())
- self.connect("destroy", self.cleanup_callback)
- self.set_title(self.__class__.__name__)
- self.set_resizable(False)
-
- if not self.load_pixbufs():
- dialog = gtk.MessageDialog(self,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR,
- gtk.BUTTONS_CLOSE,
- "Failed to load an image")
- dialog.connect("response", lambda d, r: d.destroy())
- dialog.show()
-
- else:
- self.set_size_request(self.back_width, self.back_height)
-
- self.frame = gtk.gdk.Pixbuf(gtk.gdk.COLORSPACE_RGB, False, 8,
- self.back_width, self.back_height)
-
- da = gtk.DrawingArea()
- da.connect("expose_event", self.expose_cb)
- self.add(da)
-
- self.timeout_id = gtk.timeout_add(FRAME_DELAY, self.timeout)
-
- self.show_all()
-
- def load_pixbufs(self):
- ''' Loads the images for the demo and returns whether the
- operation succeeded.
- '''
- if self.background is not None:
- return True # already loaded earlier
-
- # look in the the current directory where the file is installed
- try:
- self.background = gtk.gdk.pixbuf_new_from_file(
- os.path.join(IMAGE_DIR, BACKGROUND_NAME))
- except gobject.GError, error:
- return False
-
- self.back_width = self.background.get_width()
- self.back_height = self.background.get_height()
-
- for filename in image_names:
- try:
- self.images.append(gtk.gdk.pixbuf_new_from_file(
- os.path.join(IMAGE_DIR, filename)))
- except gobject.GError, error:
- return False
-
- return True
-
- def expose_cb(self, draw_area, event):
- ''' Expose callback for the drawing area. '''
- rowstride = self.frame.get_rowstride()
-
- # FIXME: what should be the result, string guchar an integer result?
- #pixels = frame.get_pixels() + rowstride * event.area.y + event.area.x * 3
- #pixels = frame.get_pixels()[len(frame.get_pixels()) + rowstride * event.area.y + event.area.x * 3]
- pixels = self.frame.get_pixels()
-
- draw_area.window.draw_rgb_image(
- draw_area.style.black_gc,
- event.area.x, event.area.y,
- event.area.width, event.area.height,
- 'normal',
- pixels, rowstride,
- event.area.x, event.area.y)
-
- return True
-
- def cleanup_callback(self, win):
- if self.timeout_id is not None:
- gtk.timeout_remove(self.timeout_id)
- self.timeout_id = None
-
- def timeout(self):
- ''' Timeout handler to regenerate the frame. '''
- self.background.copy_area(0, 0, self.back_width, self.back_height,
- self.frame, 0, 0)
-
- f = float(self.frame_num % CYCLE_LEN) / float(CYCLE_LEN)
-
- xmid = self.back_width / 2.0
- ymid = self.back_height / 2.0
-
- radius = min(xmid, ymid) / 2.0
-
- N_IMAGES = len(image_names)
- for i_name in image_names:
- i = image_names.index(i_name)
-
- ang = 2.0 * math.pi * i / N_IMAGES - f * 2.0 * math.pi
-
- iw = self.images[i].get_width()
- ih = self.images[i].get_height()
-
- r = radius +(radius / 3.0) * math.sin(f * 2.0 * math.pi)
-
- xpos = math.floor(xmid + r * math.cos(ang) - iw / 2.0 + 0.5)
- ypos = math.floor(ymid + r * math.sin(ang) - ih / 2.0 + 0.5)
-
- if i % 2 == 0:
- k = math.cos(f * 2.0 * math.pi)
- else:
- k = math.sin(f * 2.0 * math.pi)
- k = 2.0 * k * k
- k = max(0.25, k)
-
- # satisfy the c-source
- r1 = gtk.gdk.Rectangle()
- r1.x = int(xpos)
- r1.y = int(ypos)
- r1.width = iw * k
- r1.height = ih * k
-
- r2 = gtk.gdk.Rectangle()
- r2.x = 0
- r2.y = 0
- r2.width = self.back_width
- r2.height = self.back_height
-
- dest = r1.intersect(r2)
- if dest is not None:
- if i % 2 == 0:
- alpha = int(
- max(127, math.fabs(255 * math.cos(f * 2.0 * math.pi))))
- else:
- alpha = int(
- max(127, math.fabs(255 * math.sin(f * 2.0 * math.pi))))
- self.images[i].composite(
- self.frame,
- dest.x, dest.y,
- dest.width, dest.height,
- xpos, ypos,
- k, k,
- gtk.gdk.INTERP_NEAREST,
- alpha)
-
- if self is not None:
- self.queue_draw()
-
- self.frame_num += 1
- return True
-
-def main():
- PixbufsDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/print_editor.py b/examples/pygtk-demo/demos/print_editor.py
deleted file mode 100644
index 7b7ae106..00000000
--- a/examples/pygtk-demo/demos/print_editor.py
+++ /dev/null
@@ -1,450 +0,0 @@
-"""Print Editor
-
-A small demo editor with printing support"""
-
-import sys
-import gobject
-import pango
-import gtk
-
-main_window = None
-filename = None
-page_setup = None
-settings = None
-file_changed = False
-buffer = None
-statusbar = None
-active_prints = []
-
-def update_title():
- if filename is None:
- basename = "Untitled"
- else:
- basename = os.path.basename(filename)
- main_window.set_title("Simple Editor with printing - %s" % basename)
-
-def update_statusbar():
- statusbar.pop(0)
-
- iter = buffer.get_iter_at_mark(buffer.get_insert())
-
- row = iter.get_line()
- col = iter.get_line_offset()
-
- print_str = "";
- if active_prints:
- op = active_prints[0]
- print_str = op.get_status_string()
-
- msg = "%d, %d%s %s" % (row, col, (file_changed and " - Modified" or ""),
- print_str)
-
- statusbar.push(0, msg)
-
-def update_ui():
- update_title()
- update_statusbar()
-
-def get_text():
- start, end = buffer.get_bounds()
- return buffer.get_text(start, end, False)
-
-def set_text(text):
- buffer.set_text(text)
- global file_changed
- file_changed = False
- update_ui()
-
-
-def do_new(action):
- global filename
- filename = None
- set_text("")
-
-
-def load_file(open_filename):
- error_dialog = None
- try:
- contents = file(open_filename).read()
- except IOError, ex:
- error_dialog = gtk.MessageDialog(main_window,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR,
- gtk.BUTTONS_CLOSE,
- "Error loading file %s:\n%s" %
- (open_filename,
- str(ex)))
- else:
- try:
- contents = contents.decode("utf-8")
- except UnicodeDecodeError:
- error_dialog = gtk.MessageDialog(main_window,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR,
- gtk.BUTTONS_CLOSE,
- "Error loading file %s:\n%s" %
- (open_filename,
- "Not valid utf8"))
- else:
- set_text(contents)
- if error_dialog is not None:
- error_dialog.connect("response", gtk.Widget.destroy)
- error_dialog.show()
-
-
-def do_open(action):
- dialog = gtk.FileChooserDialog("Select file",
- main_window,
- gtk.FILE_CHOOSER_ACTION_OPEN,
- (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
- gtk.STOCK_OPEN, gtk.RESPONSE_OK))
- dialog.set_default_response(gtk.RESPONSE_OK)
- response = dialog.run()
- if response == gtk.RESPONSE_OK:
- open_filename = dialog.get_filename()
- load_file(open_filename)
- dialog.destroy()
-
-
-def save_file(save_filename):
- global filename
- text = get_text()
- error_dialog = None
-
- try:
- file(save_filename, "w").write(text)
- except IOError, ex:
- error_dialog = gtk.MessageDialog(main_window,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk.MESSAGE_ERROR,
- gtk.BUTTONS_CLOSE,
- "Error saving to file %s:\n%s" %
- (open_filename,
- str(ex)))
- error_dialog.connect("response", gtk.Widget.destroy)
- error_dialog.show()
- else:
- if save_filename != filename:
- filename = save_filename
- file_changed = False
- update_ui()
-
-
-def do_save_as(action):
- dialog = gtk.FileChooserDialog("Select file",
- main_window,
- (gtk.FILE_CHOOSER_ACTION_SAVE,
- gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
- gtk.STOCK_SAVE, gtk.RESPONSE_OK))
- dialog.set_default_response(gtk.RESPONSE_OK)
- response = dialog.run()
-
- if response == gtk.RESPONSE_OK:
- save_filename = dialog.get_filename()
- save_file(save_filename)
-
- dialog.destroy()
-
-def do_save(action):
- if filename is None:
- do_save_as(action)
- else:
- save_file(filename)
-
-class PrintData:
- text = None
- layout = None
- page_breaks = None
-
-
-def begin_print(operation, context, print_data):
- width = context.get_width()
- height = context.get_height()
- print_data.layout = context.create_pango_layout()
- print_data.layout.set_font_description(pango.FontDescription("Sans 12"))
- print_data.layout.set_width(int(width*pango.SCALE))
- print_data.layout.set_text(print_data.text)
-
- num_lines = print_data.layout.get_line_count()
-
- page_breaks = []
- page_height = 0
-
- for line in xrange(num_lines):
- layout_line = print_data.layout.get_line(line)
- ink_rect, logical_rect = layout_line.get_extents()
- lx, ly, lwidth, lheight = logical_rect
- line_height = lheight / 1024.0
- if page_height + line_height > height:
- page_breaks.append(line)
- page_height = 0
- page_height += line_height
-
- operation.set_n_pages(len(page_breaks) + 1)
- print_data.page_breaks = page_breaks
-
-
-def draw_page(operation, context, page_nr, print_data):
- assert isinstance(print_data.page_breaks, list)
- if page_nr == 0:
- start = 0
- else:
- start = print_data.page_breaks[page_nr - 1]
-
- try:
- end = print_data.page_breaks[page_nr]
- except IndexError:
- end = print_data.layout.get_line_count()
-
- cr = context.get_cairo_context()
-
- cr.set_source_rgb(0, 0, 0)
-
- i = 0
- start_pos = 0
- iter = print_data.layout.get_iter()
- while 1:
- if i >= start:
- line = iter.get_line()
- _, logical_rect = iter.get_line_extents()
- lx, ly, lwidth, lheight = logical_rect
- baseline = iter.get_baseline()
- if i == start:
- start_pos = ly / 1024.0;
- cr.move_to(lx / 1024.0, baseline / 1024.0 - start_pos)
- cr.show_layout_line(line)
- i += 1
- if not (i < end and iter.next_line()):
- break
-
-
-def do_page_setup(action):
- global settings, page_setup
- if settings is None:
- settings = gtk.PrintSettings()
- page_setup = gtk.print_run_page_setup_dialog(main_window,
- page_setup, settings)
-
-
-def status_changed_cb(op):
- if op.is_finished():
- active_prints.remove(op)
- update_statusbar()
-
-
-def do_print(action):
- global settings, page_setup
- print_data = PrintData()
- print_data.text = get_text()
- print_ = gtk.PrintOperation()
- if settings is not None:
- print_.set_print_settings(settings)
-
- if page_setup is not None:
- print_.set_default_page_setup(page_setup)
-
- print_.connect("begin_print", begin_print, print_data)
- print_.connect("draw_page", draw_page, print_data)
-
- try:
- res = print_.run(gtk.PRINT_OPERATION_ACTION_PRINT_DIALOG, main_window)
- except gobject.GError, ex:
- error_dialog = gtk.MessageDialog(main_window,
- gtk.DIALOG_DESTROY_WITH_PARENT,
- gtk._MESSAGE_ERROR,
- gtk.BUTTONS_CLOSE,
- ("Error printing file:\n%s" % str(ex)))
- error_dialog.connect("response", gtk.Widget.destroy)
- error_dialog.show()
- else:
- if res == gtk.PRINT_OPERATION_RESULT_APPLY:
- settings = print_.get_print_settings()
-
- if not print_.is_finished():
- active_prints.remove(print_)
- update_statusbar()
-
- print_.connect("status_changed", status_changed_cb)
-
-
-def do_about(action):
- authors = [
- "Alexander Larsson (C version)",
- "Gustavo Carneiro (Python translation)",
- ]
- about = gobject.new(gtk.AboutDialog, name="print test editor",
- version="0.1", copyright="(C) Red Hat, Inc",
- comments="Program to demonstrate GTK+ printing.",
- authors=authors)
- about.set_transient_for(main_window)
- about.show()
-
-
-def do_quit(action):
- if __name__ == '__main__':
- gtk.main_quit()
-
-entries = [
- ( "FileMenu", None, "_File" ), # name, stock id, label
- ( "HelpMenu", None, "_Help" ), # name, stock id, label
- ( "New", gtk.STOCK_NEW, # name, stock id
- "_New", "<control>N", # label, accelerator
- "Create a new file", # tooltip
- do_new ),
- ( "Open", gtk.STOCK_OPEN, # name, stock id
- "_Open","<control>O", # label, accelerator
- "Open a file", # tooltip
- do_open ),
- ( "Save", gtk.STOCK_SAVE, # name, stock id
- "_Save","<control>S", # label, accelerator
- "Save current file", # tooltip
- do_save ),
- ( "SaveAs", gtk.STOCK_SAVE, # name, stock id
- "Save _As...", None, # label, accelerator
- "Save to a file", # tooltip
- do_save_as ),
- ( "Quit", gtk.STOCK_QUIT, # name, stock id
- "_Quit", "<control>Q", # label, accelerator
- "Quit", # tooltip
- do_quit ),
- ( "About", None, # name, stock id
- "_About", "<control>A", # label, accelerator
- "About", # tooltip
- do_about ),
- ( "PageSetup", None, # name, stock id
- "Page _Setup", None, # label, accelerator
- "Set up the page", # tooltip
- do_page_setup ),
- ( "Print", gtk.STOCK_PRINT, # name, stock id
- None, None, # label, accelerator
- "Print the document", # tooltip
- do_print ),
-]
-
-ui_info ="""
-<ui>
- <menubar name='MenuBar'>
- <menu action='FileMenu'>
- <menuitem action='New'/>
- <menuitem action='Open'/>
- <menuitem action='Save'/>
- <menuitem action='SaveAs'/>
- <menuitem action='PageSetup'/>
- <menuitem action='Print'/>
- <separator/>
- <menuitem action='Quit'/>
- </menu>
- <menu action='HelpMenu'>
- <menuitem action='About'/>
- </menu>
- </menubar>
-</ui>
-"""
-
-def buffer_changed_callback(buffer):
- global file_changed
- file_changed = True
- update_statusbar()
-
-
-def mark_set_callback(buffer, new_location, mark):
- update_statusbar()
-
-def update_resize_grip(widget, event, statusbar):
- if event.changed_mask & (gtk.gdk.WINDOW_STATE_MAXIMIZED |
- gtk.gdk.WINDOW_STATE_FULLSCREEN):
- maximized = event.new_window_state & (gtk.gdk.WINDOW_STATE_MAXIMIZED |
- gtk.gdk.WINDOW_STATE_FULLSCREEN)
- statusbar.set_has_resize_grip(not maximized)
-
-
-def create_window():
- global main_window, statusbar, buffer
- main_window = gtk.Window()
- main_window.set_default_size(400, 600)
- if __name__ == '__main__':
- main_window.connect("delete-event", gtk.main_quit)
- actions = gtk.ActionGroup("Actions")
- actions.add_actions(entries)
-
- ui = gtk.UIManager()
- ui.insert_action_group(actions, 0)
- main_window.add_accel_group(ui.get_accel_group())
- main_window.set_border_width(0)
-
- ui.add_ui_from_string(ui_info)
-
- table = gtk.Table(1, 3, False)
- main_window.add(table)
-
- bar = ui.get_widget("/MenuBar")
- bar.show()
- table.attach(bar,
- # /* X direction */ /* Y direction */
- 0, 1, 0, 1,
- gtk.EXPAND | gtk.FILL, 0,
- 0, 0)
-
- ## Create document
- sw = gtk.ScrolledWindow()
- sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- sw.set_shadow_type(gtk.SHADOW_IN)
- table.attach(sw,
- # /* X direction */ /* Y direction */
- 0, 1, 1, 2,
- gtk.EXPAND | gtk.FILL, gtk.EXPAND | gtk.FILL,
- 0, 0)
-
- contents = gtk.TextView()
- contents.grab_focus()
- sw.add(contents)
-
- ## Create statusbar
-
- statusbar = gtk.Statusbar()
- table.attach(statusbar,
- #/* X direction */ /* Y direction */
- 0, 1, 2, 3,
- gtk.EXPAND | gtk.FILL, 0,
- 0, 0);
-
- ## Show text widget info in the statusbar */
- buffer = contents.get_buffer()
-
- buffer.connect_object("changed",
- buffer_changed_callback,
- None)
-
- buffer.connect_object("mark_set", # cursor moved
- mark_set_callback,
- None)
-
- main_window.connect_object("window_state_event",
- update_resize_grip,
- statusbar,
- 0)
-
- update_ui()
-
- main_window.show_all()
-
-
-def main(argv):
- create_window()
-
- try:
- fname = argv[1]
- except IndexError:
- pass
- else:
- load_file(fname)
-
- gtk.main()
-
-def PrintEditorDemo(win):
- create_window()
- main_window.set_transient_for(win)
- return main_window
-
-if __name__ == '__main__':
- sys.exit(main(sys.argv))
diff --git a/examples/pygtk-demo/demos/sizegroup.py b/examples/pygtk-demo/demos/sizegroup.py
deleted file mode 100644
index a780390e..00000000
--- a/examples/pygtk-demo/demos/sizegroup.py
+++ /dev/null
@@ -1,108 +0,0 @@
-#!/usr/bin/env python
-"""Size Group
-
-GtkSizeGroup provides a mechanism for grouping a number of widgets together so
-they all request the same amount of space. This is typically useful when you
-want a column of widgets to have the same size, but you can't use a GtkTable
-widget.
-
-Note that size groups only affect the amount of space requested, not the size
-that the widgets finally receive. If you want the widgets in a GtkSizeGroup to
-actually be the same size, you need to pack them in such a way that they get
-the size they request and not more. For example, if you are packing your
-widgets into a table, you would not include the GTK_FILL flag."""
-
-import gtk
-
-class SizeGroupDemo(gtk.Dialog):
- def __init__(self, parent=None):
- gtk.Dialog.__init__(self, "Size Groups", parent,
- 0,
- (gtk.STOCK_CLOSE, gtk.RESPONSE_CLOSE))
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
- self.connect('response', lambda d, r: d.destroy())
- self.set_resizable(False)
-
- vbox = gtk.VBox(False, 5)
- self.vbox.pack_start(vbox, True, True, 0)
- vbox.set_border_width(5)
-
- self.size_group = gtk.SizeGroup(gtk.SIZE_GROUP_HORIZONTAL)
-
- # Create one frame holding color options
- frame = gtk.Frame("Color options")
- vbox.pack_start(frame, True, True, 0)
-
- table = gtk.Table(2, 2, False)
- table.set_border_width(5)
- table.set_row_spacings(5)
- table.set_col_spacings(10)
- frame.add(table)
-
- color_options = ("Red", "Green", "Blue")
- self.__add_row(table, 0, "_Foreground", color_options)
- self.__add_row(table, 1, "_Background", color_options)
-
- # And another frame holding line style options
- frame = gtk.Frame("Line options")
- vbox.pack_start(frame, False, False, 0)
-
- table = gtk.Table(2, 2, False)
- table.set_border_width(5)
- table.set_row_spacings(5)
- table.set_col_spacings(10)
- frame.add(table)
-
- dash_options = ("Solid", "Dashed", "Dotted")
- end_options = ("Square", "Round", "Arrow")
- self.__add_row(table, 0, "_Dashing", dash_options)
- self.__add_row(table, 1, "_Line ends", end_options)
-
- # And a check button to turn grouping on and off
-
- check_button = gtk.CheckButton("_Enable grouping")
- vbox.pack_start(check_button, False, False, 0)
- check_button.set_active(True)
- check_button.connect('toggled', self.on_toggle_grouping)
-
- self.show_all()
-
- def __create_option_menu(self, options):
-
- option_menu = gtk.combo_box_new_text()
- for opt in options:
- option_menu.append_text(opt)
-
- option_menu.set_active(0)
- return option_menu
-
- def __add_row(self, table, row, label_text, options):
- label = gtk.Label(label_text)
- label.set_use_underline(True)
- label.set_alignment(0, 1)
- table.attach(label, 0, 1, row, row + 1, gtk.EXPAND | gtk.FILL, 0, 0, 0)
-
- option_menu = self.__create_option_menu(options)
- label.set_mnemonic_widget(option_menu)
- self.size_group.add_widget(option_menu)
- table.attach(option_menu, 1, 2, row, row + 1, 0, 0, 0, 0)
-
- def on_toggle_grouping(self, check_button):
-
- # gtk.SIZE_GROUP_NONE is not generally useful, but is useful
- # here to show the effect of gtk.SIZE_GROUP_HORIZONTAL by
- # contrast.
- if check_button.get_active():
- self.size_group.set_mode(gtk.SIZE_GROUP_HORIZONTAL)
- else:
- self.size_group.set_mode(gtk.SIZE_GROUP_NONE)
-
-def main():
- SizeGroupDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/statusicon.py b/examples/pygtk-demo/demos/statusicon.py
deleted file mode 100644
index 53564a81..00000000
--- a/examples/pygtk-demo/demos/statusicon.py
+++ /dev/null
@@ -1,31 +0,0 @@
-#!/usr/bin/env python
-'''Status Icon
-
-This is a simple example that shows how to create a status icon that
-will appear in the "notification area" in GNOME/KDE, or "system tray"
-in Windows.
-'''
-## Author: Nikos Kouremenos
-
-import gtk
-
-
-def make_menu(event_button, event_time, icon):
- menu = gtk.Menu()
- item = gtk.MenuItem('hi')
- item.show()
- menu.append(item)
- menu.popup(None, None,
- gtk.status_icon_position_menu, event_button,
- event_time, icon)
-
-def on_right_click(icon, event_button, event_time):
- make_menu(event_button, event_time, icon)
-
-def StatusIconDemo(parent=None):
- icon = gtk.status_icon_new_from_stock(gtk.STOCK_QUIT)
- icon.connect('popup-menu', on_right_click)
-
-if __name__ == '__main__':
- StatusIconDemo()
- gtk.main()
diff --git a/examples/pygtk-demo/demos/stock_browser.py b/examples/pygtk-demo/demos/stock_browser.py
deleted file mode 100644
index 1689230f..00000000
--- a/examples/pygtk-demo/demos/stock_browser.py
+++ /dev/null
@@ -1,270 +0,0 @@
-#!/usr/bin/env python
-'''Stock Item and Icon Browser
-
-This source code for this demo doesn't demonstrate anything particularly
-useful in applications. The purpose of the "demo" is just to provide a
-handy place to browse the available stock icons and stock items.
-'''
-# pygtk version: Maik Hertha <maik.hertha@berlin.de>
-
-import gobject
-import gtk
-import re
-
-def id_to_macro(stock_id):
- if stock_id == '':
- return ''
- if stock_id.startswith('gtk'):
- # gtk-foo-bar -> gtk.STOCK_FOO_BAR
- macro = 'gtk.STOCK' + \
- re.sub('-([^-]+)', lambda m:('_' + m.group(1).upper()), stock_id[3:])
-
- else:
- # demo-gtk-logo -> DEMO_GTK_LOGO as with custom icon-factories
- macro = re.sub('([^-]+)-?', lambda m:('_' + m.group(1).upper()), stock_id)
- macro = macro[1:] # there is a leading '_' always
-
- return macro
-
-
-class StockItemInfo(object):
- def __init__(self, stock_id=''):
- self.stock_id = stock_id
- self.stock_item = None
- self.small_icon = None
- self.macro = id_to_macro(stock_id)
- self.accel_str = ''
-
-class StockItemDisplay(object):
- def __init__(self):
- self.type_label = None
- self.macro_label = None
- self.id_label = None
- self.label_accel_label = None
- self.icon_image = None
-
-
-def get_largest_size(stockid):
- ''' Finds the largest size at which the given image stock id is
- available. This would not be useful for a normal application.
- '''
- set = gtk.icon_factory_lookup_default(stockid)
- best_size = gtk.ICON_SIZE_INVALID
- best_pixels = 0
-
- sizes = set.get_sizes()
- n_sizes = len(sizes)
-
- i = 0
- while(i < n_sizes):
- width, height = gtk.icon_size_lookup(sizes[i])
-
- if(width * height > best_pixels):
- best_size = sizes[i]
- best_pixels = width * height
-
- i += 1
-
- return best_size
-
-
-def macro_set_func_text(tree_column, cell, model, iter):
- info = model.get_value(iter, 0)
- cell.set_property("text", info.macro)
-
-def id_set_func(tree_column, cell, model, iter):
- info = model.get_value(iter, 0)
- cell.set_property("text", info.stock_id)
-
-def accel_set_func(tree_column, cell, model, iter):
- info = model.get_value(iter, 0)
- cell.set_property("text", info.accel_str)
-
-def label_set_func(tree_column, cell, model, iter):
- info = model.get_value(iter, 0)
- cell.set_property("text", info.stock_item[1])
-
-
-class StockItemAndIconBrowserDemo(gtk.Window):
- def __init__(self, parent=None):
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
-
- self.set_title(self.__class__.__name__)
- self.set_default_size(-1, 500)
- self.set_border_width(8)
-
- hbox = gtk.HBox(False, 8)
- self.add(hbox)
-
- sw = gtk.ScrolledWindow()
- sw.set_shadow_type(gtk.SHADOW_ETCHED_IN)
- sw.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
- hbox.pack_start(sw, False, False, 0)
-
- model = self.__create_model()
- treeview = gtk.TreeView(model)
- sw.add(treeview)
-
- column = gtk.TreeViewColumn()
- column.set_title("Macro")
-
- cell_renderer = gtk.CellRendererPixbuf()
- column.pack_start(cell_renderer, False)
- column.set_attributes(cell_renderer, stock_id=1)
-
- cell_renderer = gtk.CellRendererText()
- column.pack_start(cell_renderer, True)
- column.set_cell_data_func(cell_renderer, macro_set_func_text)
-
- treeview.append_column(column)
-
- cell_renderer = gtk.CellRendererText()
- treeview.insert_column_with_data_func(-1, "Label", cell_renderer, label_set_func)
-
- cell_renderer = gtk.CellRendererText()
- treeview.insert_column_with_data_func(-1, "Accel", cell_renderer, accel_set_func)
-
- cell_renderer = gtk.CellRendererText()
- treeview.insert_column_with_data_func(-1, "ID", cell_renderer, id_set_func)
-
- align = gtk.Alignment(0.5, 0.0, 0.0, 0.0)
- hbox.pack_end(align, False, False, 0)
-
- frame = gtk.Frame("Selected Item")
- align.add(frame)
-
- vbox = gtk.VBox(False, 8)
- vbox.set_border_width(4)
- frame.add(vbox)
-
- display = StockItemDisplay()
- treeview.set_data("stock-display", display)
-
- display.type_label = gtk.Label()
- display.macro_label = gtk.Label()
- display.id_label = gtk.Label()
- display.label_accel_label = gtk.Label()
- display.icon_image = gtk.Image(); # empty image
-
- vbox.pack_start(display.type_label, False, False, 0)
- vbox.pack_start(display.icon_image, False, False, 0)
- vbox.pack_start(display.label_accel_label, False, False, 0)
- vbox.pack_start(display.macro_label, False, False, 0)
- vbox.pack_start(display.id_label, False, False, 0)
-
- selection = treeview.get_selection()
- selection.set_mode(gtk.SELECTION_SINGLE)
-
- selection.connect("changed", self.on_selection_changed)
-
- self.show_all()
-
- def __create_model(self):
- store = gtk.ListStore(
- gobject.TYPE_PYOBJECT,
- gobject.TYPE_STRING)
-
- ids = gtk.stock_list_ids()
- ids.sort()
-
- for data in ids:
- info = StockItemInfo(stock_id=data)
- stock_item = gtk.stock_lookup(data)
-
- if stock_item:
- info.stock_item = stock_item
- else:
- # stock_id, label, modifier, keyval, translation_domain
- info.stock_item =('', '', 0, 0, '')
-
- # only show icons for stock IDs that have default icons
- icon_set = gtk.icon_factory_lookup_default(info.stock_id)
- if icon_set is None:
- info.small_icon = None
- else:
- # See what sizes this stock icon really exists at
- sizes = icon_set.get_sizes()
- n_sizes = len(sizes)
-
- # Use menu size if it exists, otherwise first size found
- size = sizes[0];
- i = 0;
- while(i < n_sizes):
- if(sizes[i] == gtk.ICON_SIZE_MENU):
- size = gtk.ICON_SIZE_MENU
- break
- i += 1
-
- info.small_icon = self.render_icon(info.stock_id, size)
-
- if(size != gtk.ICON_SIZE_MENU):
- # Make the result the proper size for our thumbnail
- w, h = gtk.icon_size_lookup(gtk.ICON_SIZE_MENU)
-
- scaled = info.small_icon.scale_simple(w, h, 'bilinear')
- info.small_icon = scaled
-
- if info.stock_item[3] == 0:
- info.accel_str = ""
- else:
- info.accel_str = \
- gtk.accelerator_name(info.stock_item[3], info.stock_item[2])
-
- iter = store.append()
- store.set(iter, 0, info, 1, info.stock_id)
-
- return store
-
- def on_selection_changed(self, selection):
- treeview = selection.get_tree_view()
- display = treeview.get_data("stock-display")
-
- model, iter = selection.get_selected()
- if iter:
- info = model.get_value(iter, 0)
-
- if(info.small_icon and info.stock_item[1]):
- display.type_label.set_text("Icon and Item")
-
- elif(info.small_icon):
- display.type_label.set_text("Icon Only")
-
- elif(info.stock_item[1]):
- display.type_label.set_text("Item Only")
-
- else:
- display.type_label.set_text("???????")
-
- display.macro_label.set_text(info.macro)
- display.id_label.set_text(info.stock_id)
-
- if(info.stock_item[1]):
- s = "%s %s" % (info.stock_item[1], info.accel_str)
- display.label_accel_label.set_text_with_mnemonic(s)
-
- else:
- display.label_accel_label.set_text("")
-
- if(info.small_icon):
- display.icon_image.set_from_stock(info.stock_id,
- get_largest_size(info.stock_id))
- else:
- display.icon_image.set_from_pixbuf(None)
-
- else:
- display.type_label.set_text("No selected item")
- display.macro_label.set_text("")
- display.id_label.set_text("")
- display.label_accel_label.set_text("")
- display.icon_image.set_from_pixbuf(None)
-
-def main():
- StockItemAndIconBrowserDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/textview.py b/examples/pygtk-demo/demos/textview.py
deleted file mode 100644
index 44166616..00000000
--- a/examples/pygtk-demo/demos/textview.py
+++ /dev/null
@@ -1,498 +0,0 @@
-#!/usr/bin/env python
-"""Text Widget/TextView
-
-The GtkTextView widget displays a GtkTextBuffer. One GtkTextBuffer can be displayed
-by multiple GtkTextViews. This demo has two views displaying a single buffer, and
-shows off the widget's text formatting features."""
-# pygtk version: Maik Hertha <maik.hertha@berlin.de>
-
-import os
-import sys
-
-import gobject
-import gtk
-
-gray50_width = 2
-gray50_height = 2
-gray50_bits = '\x02\x01'
-GTKLOGO_IMAGE = os.path.join(os.path.dirname(__file__),
- 'images', 'gtk-logo-rgb.gif')
-FLOPPYBUDDY_IMAGE = os.path.join(os.path.dirname(__file__),
- 'images', 'floppybuddy.gif')
-
-class TextViewDemo(gtk.Window):
- def __init__(self, parent=None):
- # Create the toplevel window
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
-
- self.set_title(self.__class__.__name__)
- self.set_default_size(450, 450)
- self.set_border_width(0)
-
- vpaned = gtk.VPaned()
- vpaned.set_border_width(5)
- self.add(vpaned)
-
- # For convenience, we just use the autocreated buffer from
- # the first text view; you could also create the buffer
- # by itself with gtk.text_buffer_new(), then later create
- # a view widget.
-
- view1 = gtk.TextView();
- buffer_1 = view1.get_buffer()
- view2 = gtk.TextView(buffer_1)
-
- sw = gtk.ScrolledWindow()
- sw.set_shadow_type(gtk.SHADOW_ETCHED_IN)
- sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
-
- vpaned.add1(sw)
-
- sw.add(view1)
-
- sw = gtk.ScrolledWindow()
- sw.set_shadow_type(gtk.SHADOW_ETCHED_IN)
- sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
-
- vpaned.add2(sw)
-
- sw.add(view2)
-
- self.create_tags(buffer_1)
- self.insert_text(buffer_1)
-
- self.attach_widgets(view1)
- self.attach_widgets(view2)
- self.win = None
- self.show_all()
-
- def create_tags(self, text_buffer):
- '''
- Create a bunch of tags. Note that it's also possible to
- create tags with gtk.text_tag_new() then add them to the
- tag table for the buffer, text_buffer.create_tag() is
- just a convenience function. Also note that you don't have
- to give tags a name; pass None for the name to create an
- anonymous tag.
-
- In any real app, another useful optimization would be to create
- a GtkTextTagTable in advance, and reuse the same tag table for
- all the buffers with the same tag set, instead of creating
- new copies of the same tags for every buffer.
-
- Tags are assigned default priorities in order of addition to the
- tag table. That is, tags created later that affect the same text
- property affected by an earlier tag will override the earlier
- tag. You can modify tag priorities with
- gtk.text_tag_set_priority().
- '''
-
- import pango
- text_buffer.create_tag("heading",
- weight=pango.WEIGHT_BOLD,
- size=15 * pango.SCALE)
-
- text_buffer.create_tag("italic", style=pango.STYLE_ITALIC)
-
- text_buffer.create_tag("bold", weight=pango.WEIGHT_BOLD)
-
- # points times the pango.SCALE factor
- text_buffer.create_tag("big", size=20 * pango.SCALE)
-
- text_buffer.create_tag("xx-small", scale=pango.SCALE_XX_SMALL)
-
- text_buffer.create_tag("x-large", scale=pango.SCALE_X_LARGE)
-
- text_buffer.create_tag("monospace", family="monospace")
-
- text_buffer.create_tag("blue_foreground", foreground="blue")
-
- text_buffer.create_tag("red_background", background="red")
-
- stipple = gtk.gdk.bitmap_create_from_data(None,
- gray50_bits, gray50_width, gray50_height)
-
- text_buffer.create_tag("background_stipple", background_stipple=stipple)
-
- text_buffer.create_tag("foreground_stipple", foreground_stipple=stipple)
-
- text_buffer.create_tag("big_gap_before_line", pixels_above_lines=30)
-
- text_buffer.create_tag("big_gap_after_line", pixels_below_lines=30)
-
- text_buffer.create_tag("double_spaced_line", pixels_inside_wrap=10)
-
- text_buffer.create_tag("not_editable", editable=False)
-
- text_buffer.create_tag("word_wrap", wrap_mode=gtk.WRAP_WORD)
-
- text_buffer.create_tag("char_wrap", wrap_mode=gtk.WRAP_CHAR)
-
- text_buffer.create_tag("no_wrap", wrap_mode=gtk.WRAP_NONE)
-
- text_buffer.create_tag("center", justification=gtk.JUSTIFY_CENTER)
-
- text_buffer.create_tag("right_justify", justification=gtk.JUSTIFY_RIGHT)
-
- text_buffer.create_tag("wide_margins",
- left_margin=50, right_margin=50)
-
- text_buffer.create_tag("strikethrough", strikethrough=True)
-
- text_buffer.create_tag("underline",
- underline=pango.UNDERLINE_SINGLE)
-
- text_buffer.create_tag("double_underline",
- underline=pango.UNDERLINE_DOUBLE)
-
- text_buffer.create_tag("superscript",
- rise=10 * pango.SCALE, # 10 pixels
- size=8 * pango.SCALE) # 8 points
-
- text_buffer.create_tag("subscript",
- rise=-10 * pango.SCALE, # 10 pixels
- size=8 * pango.SCALE) # 8 points
-
- text_buffer.create_tag("rtl_quote",
- wrap_mode=gtk.WRAP_WORD, direction=gtk.TEXT_DIR_RTL,
- indent=30, left_margin=20, right_margin=20)
-
- def insert_text(self, text_buffer):
- # use the current directory for the file
- try:
- pixbuf = gtk.gdk.pixbuf_new_from_file(GTKLOGO_IMAGE)
- except gobject.GError, error:
- sys.exit("Failed to load image file gtk-logo-rgb.gif\n")
-
- scaled = pixbuf.scale_simple(32, 32, 'bilinear')
- pixbuf = scaled
-
- # get start of buffer; each insertion will revalidate the
- # iterator to point to just after the inserted text.
- iter = text_buffer.get_iter_at_offset(0)
-
- text_buffer.insert(iter, "The text widget can display text with "
- "all kinds of nifty attributes. It also supports multiple views "
- "of the same buffer; this demo is showing the same buffer in "
- "two places.\n\n")
-
- text_buffer.insert_with_tags_by_name(iter, "Font styles. ", "heading")
-
- text_buffer.insert(iter, "For example, you can have ")
- text_buffer.insert_with_tags_by_name(iter,
- "italic", "italic")
- text_buffer.insert(iter, ", ");
- text_buffer.insert_with_tags_by_name(iter,
- "bold", "bold")
- text_buffer.insert(iter, ", or ", -1)
- text_buffer.insert_with_tags_by_name(iter,
- "monospace(typewriter)", "monospace")
- text_buffer.insert(iter, ", or ")
- text_buffer.insert_with_tags_by_name(iter,
- "big", "big")
- text_buffer.insert(iter, " text. ")
- text_buffer.insert(iter, "It's best not to hardcode specific text "
- "sizes; you can use relative sizes as with CSS, such as ")
- text_buffer.insert_with_tags_by_name(iter,
- "xx-small", "xx-small")
- text_buffer.insert(iter, " or ")
- text_buffer.insert_with_tags_by_name(iter,
- "x-large", "x-large")
- text_buffer.insert(iter, " to ensure that your program properly "
- "adapts if the user changes the default font size.\n\n")
-
- text_buffer.insert_with_tags_by_name(iter, "Colors. ", "heading")
-
- text_buffer.insert(iter, "Colors such as ");
- text_buffer.insert_with_tags_by_name(iter,
- "a blue foreground", "blue_foreground")
- text_buffer.insert(iter, " or ");
- text_buffer.insert_with_tags_by_name(iter,
- "a red background",
- "red_background")
- text_buffer.insert(iter, " or even ", -1);
- text_buffer.insert_with_tags_by_name(iter,
- "a stippled red background",
- "red_background",
- "background_stipple")
-
- text_buffer.insert(iter, " or ", -1);
- text_buffer.insert_with_tags_by_name(iter,
- "a stippled blue foreground on solid red background",
- "blue_foreground",
- "red_background",
- "foreground_stipple")
- text_buffer.insert(iter, "(select that to read it) can be used.\n\n", -1);
-
- text_buffer.insert_with_tags_by_name(iter,
- "Underline, strikethrough, and rise. ", "heading")
-
- text_buffer.insert_with_tags_by_name(iter,
- "Strikethrough",
- "strikethrough")
- text_buffer.insert(iter, ", ", -1)
- text_buffer.insert_with_tags_by_name(iter,
- "underline",
- "underline")
- text_buffer.insert(iter, ", ", -1)
- text_buffer.insert_with_tags_by_name(iter,
- "double underline",
- "double_underline")
- text_buffer.insert(iter, ", ", -1)
- text_buffer.insert_with_tags_by_name(iter,
- "superscript",
- "superscript")
- text_buffer.insert(iter, ", and ", -1)
- text_buffer.insert_with_tags_by_name(iter,
- "subscript",
- "subscript")
- text_buffer.insert(iter, " are all supported.\n\n", -1)
-
- text_buffer.insert_with_tags_by_name(iter, "Images. ",
- "heading")
-
- text_buffer.insert(iter, "The buffer can have images in it: ", -1)
- text_buffer.insert_pixbuf(iter, pixbuf)
- text_buffer.insert_pixbuf(iter, pixbuf)
- text_buffer.insert_pixbuf(iter, pixbuf)
- text_buffer.insert(iter, " for example.\n\n", -1)
-
- text_buffer.insert_with_tags_by_name(iter, "Spacing. ",
- "heading")
-
- text_buffer.insert(iter,
- "You can adjust the amount of space before each line.\n", -1)
-
- text_buffer.insert_with_tags_by_name(iter,
- "This line has a whole lot of space before it.\n",
- "big_gap_before_line", "wide_margins")
- text_buffer.insert_with_tags_by_name(iter,
- "You can also adjust the amount of space after each line; "
- "this line has a whole lot of space after it.\n",
- "big_gap_after_line", "wide_margins")
-
- text_buffer.insert_with_tags_by_name(iter,
- "You can also adjust the amount of space between wrapped "
- "lines; this line has extra space between each wrapped line "
- "in the same paragraph. To show off wrapping, some filler "
- "text: the quick brown fox jumped over the lazy dog. Blah "
- "blah blah blah blah blah blah blah blah.\n",
- "double_spaced_line", "wide_margins")
-
- text_buffer.insert(iter, "Also note that those lines have "
- "extra-wide margins.\n\n", -1)
-
- text_buffer.insert_with_tags_by_name(iter, "Editability. ", "heading")
-
- text_buffer.insert_with_tags_by_name(iter,
- "This line is 'locked down' and can't be edited by the "
- "user - just try it! You can't delete this line.\n\n",
- "not_editable")
-
- text_buffer.insert_with_tags_by_name(iter, "Wrapping. ", "heading")
-
- text_buffer.insert(iter,
- "This line(and most of the others in this buffer) is "
- "word-wrapped, using the proper Unicode algorithm. Word "
- "wrap should work in all scripts and languages that GTK+ "
- "supports. Let's make this a long paragraph to demonstrate: "
- "blah blah blah blah blah blah blah blah blah blah blah "
- "blah blah blah blah blah blah blah blah\n\n", -1);
-
- text_buffer.insert_with_tags_by_name(iter,
- "This line has character-based wrapping, and can wrap "
- "between any two character glyphs. Let's make this a long "
- "paragraph to demonstrate: blah blah blah blah blah blah "
- "blah blah blah blah blah blah blah blah blah blah blah "
- "blah blah\n\n", "char_wrap")
-
- text_buffer.insert_with_tags_by_name(iter,
- "This line has all wrapping turned off, so it makes the "
- "horizontal scrollbar appear.\n\n\n", "no_wrap")
-
- text_buffer.insert_with_tags_by_name(iter, "Justification. ",
- "heading");
-
- text_buffer.insert_with_tags_by_name(iter,
- "\nThis line has center justification.\n", "center")
-
- text_buffer.insert_with_tags_by_name(iter,
- "This line has right justification.\n", "right_justify")
-
- text_buffer.insert_with_tags_by_name(iter,
- "\nThis line has big wide margins. Text text text text "
- "text text text text text text text text text text text "
- "text text text text text text text text text text text "
- "text text text text text text text text text text.\n",
- "wide_margins");
-
- text_buffer.insert_with_tags_by_name(iter,
- "Internationalization. ", "heading")
-
- text_buffer.insert(iter,
- "You can put all sorts of Unicode text in the buffer.\n\n"
- "German(Deutsch S\303\274d) Gr\303\274\303\237 Gott\nGreek"
- "(\316\225\316\273\316\273\316\267\316\275\316\271\316\272"
- "\316\254) \316\223\316\265\316\271\316\254 \317\203\316\261"
- "\317\202\nHebrew \327\251\327\234\327\225\327\235\n"
- "Japanese(\346\227\245\346\234\254\350\252\236)\n\nThe "
- "widget properly handles bidirectional text, word wrapping, "
- "DOS/UNIX/Unicode paragraph separators, grapheme boundaries, "
- "and so on using the Pango internationalization framework.\n", -1)
-
- text_buffer.insert(iter, "Here's a word-wrapped quote in a "
- "right-to-left language:\n", -1)
- text_buffer.insert_with_tags_by_name(iter,
- "\331\210\331\202\330\257 \330\250\330\257\330\243 "
- "\330\253\331\204\330\247\330\253 \331\205\331\206 "
- "\330\243\331\203\330\253\330\261 \330\247\331\204\331"
- "\205\330\244\330\263\330\263\330\247\330\252 \330\252"
- "\331\202\330\257\331\205\330\247 \331\201\331\212 \330"
- "\264\330\250\331\203\330\251 \330\247\331\203\330\263"
- "\331\212\331\210\331\206 \330\250\330\261\330\247\331"
- "\205\330\254\331\207\330\247 \331\203\331\205\331\206"
- "\330\270\331\205\330\247\330\252 \331\204\330\247 \330"
- "\252\330\263\330\271\331\211 \331\204\331\204\330\261"
- "\330\250\330\255\330\214 \330\253\331\205 \330\252\330"
- "\255\331\210\331\204\330\252 \331\201\331\212 \330\247"
- "\331\204\330\263\331\206\331\210\330\247\330\252 \330"
- "\247\331\204\330\256\331\205\330\263 \330\247\331\204"
- "\331\205\330\247\330\266\331\212\330\251 \330\245\331"
- "\204\331\211 \331\205\330\244\330\263\330\263\330\247"
- "\330\252 \331\205\330\247\331\204\331\212\330\251 \331"
- "\205\331\206\330\270\331\205\330\251\330\214 \331\210"
- "\330\250\330\247\330\252\330\252 \330\254\330\262\330\241"
- "\330\247 \331\205\331\206 \330\247\331\204\331\206\330\270"
- "\330\247\331\205 \330\247\331\204\331\205\330\247\331\204"
- "\331\212 \331\201\331\212 \330\250\331\204\330\257\330\247"
- "\331\206\331\207\330\247\330\214 \331\210\331\204\331\203"
- "\331\206\331\207\330\247 \330\252\330\252\330\256\330\265"
- "\330\265 \331\201\331\212 \330\256\330\257\331\205\330\251 "
- "\331\202\330\267\330\247\330\271 \330\247\331\204\331\205\330"
- "\264\330\261\331\210\330\271\330\247\330\252 \330\247\331\204"
- "\330\265\330\272\331\212\330\261\330\251. \331\210\330\243"
- "\330\255\330\257 \330\243\331\203\330\253\330\261 \331\207"
- "\330\260\331\207 \330\247\331\204\331\205\330\244\330\263"
- "\330\263\330\247\330\252 \331\206\330\254\330\247\330\255"
- "\330\247 \331\207\331\210 \302\273\330\250\330\247\331\206"
- "\331\203\331\210\330\263\331\210\331\204\302\253 \331\201"
- "\331\212 \330\250\331\210\331\204\331\212\331\201\331\212"
- "\330\247.\n\n", "rtl_quote")
-
- text_buffer.insert(iter, "You can put widgets in the buffer: "
- "Here's a button: ", -1)
-
- anchor = text_buffer.create_child_anchor(iter)
- text_buffer.insert(iter, " and a menu: ", -1)
- anchor = text_buffer.create_child_anchor(iter)
- text_buffer.insert(iter, " and a scale: ", -1)
- anchor = text_buffer.create_child_anchor(iter)
- text_buffer.insert(iter, " and an animation: ", -1)
- anchor = text_buffer.create_child_anchor(iter)
- text_buffer.insert(iter, " finally a text entry: ", -1)
- anchor = text_buffer.create_child_anchor(iter)
- text_buffer.insert(iter, ".\n", -1)
-
- text_buffer.insert(iter, "\n\nThis demo doesn't demonstrate all "
- "the GtkTextBuffer features; it leaves out, for example: "
- "invisible/hidden text(doesn't work in GTK 2, but planned), "
- "tab stops, application-drawn areas on the sides of the "
- "widget for displaying breakpoints and such...", -1)
-
- # Apply word_wrap tag to whole buffer */
- start, end = text_buffer.get_bounds()
- text_buffer.apply_tag_by_name("word_wrap", start, end)
-
- def attach_widgets(self, text_view):
- buffer = text_view.get_buffer()
- iter = buffer.get_start_iter()
- i = 0
- while self.find_anchor(iter):
- anchor = iter.get_child_anchor()
- if i == 0:
- widget = gtk.Button("Click Me")
- widget.connect("clicked", self.easter_egg_callback)
- elif i == 1:
- widget = gtk.combo_box_new_text()
- widget.append_text("Option 1")
- widget.append_text("Option 2")
- widget.append_text("Option 3")
- elif i == 2:
- widget = gtk.HScale()
- widget.set_range(0, 100)
- widget.set_size_request(70, -1)
- elif i == 3:
- widget = gtk.Image()
- widget.set_from_file(FLOPPYBUDDY_IMAGE)
- elif i == 4:
- widget = gtk.Entry()
- else:
- raise ValueError
-
- text_view.add_child_at_anchor(widget, anchor)
- widget.show_all()
- i += 1
- return
-
- def find_anchor(self, iter):
- while iter.forward_char():
- if iter.get_child_anchor():
- return True
- return False
-
- def easter_egg_callback(self, button):
- if self.win:
- self.win.present()
- return
-
- buffer = gtk.TextBuffer()
- iter = buffer.get_start_iter()
- buffer.insert(iter,
- "This buffer is shared by a set of nested text views.\n Nested view:\n")
- anchor = buffer.create_child_anchor(iter)
- buffer.insert(iter,
- "\nDon't do this in real applications, please.\n")
-
- view = gtk.TextView(buffer)
-
- self.recursive_attach_view(0, view, anchor)
-
- self.win = gtk.Window()
- sw = gtk.ScrolledWindow()
- sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
-
- self.win.add(sw)
- sw.add(view)
- self.win.set_default_size(300, 400)
- self.win.show_all()
- return
-
- def recursive_attach_view(self, depth, view, anchor):
- if depth > 4:
- return
- child_view = gtk.TextView(view.get_buffer())
- # Event box is needed to add a black border around each child view
- event_box = gtk.EventBox()
- color = gtk.gdk.color_parse("black")
- event_box.modify_bg(gtk.STATE_NORMAL, color)
- align = gtk.Alignment(0.5, 0.5, 1.0, 1.0)
- align.set_border_width(1)
-
- event_box.add(align)
- align.add(child_view)
-
- view.add_child_at_anchor(event_box, anchor)
-
- self.recursive_attach_view(depth + 1, child_view, anchor)
- return
-
-def main():
- TextViewDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/tree_store.py b/examples/pygtk-demo/demos/tree_store.py
deleted file mode 100644
index fc53644d..00000000
--- a/examples/pygtk-demo/demos/tree_store.py
+++ /dev/null
@@ -1,334 +0,0 @@
-#!/usr/bin/env python
-'''Tree View/Tree Store
-
-The GtkTreeStore is used to store data in tree form, to be used
-later on by a GtkTreeView to display it. This demo builds a simple
-GtkTreeStore and displays it. If you're new to the GtkTreeView widgets
-and associates, look into the GtkListStore example first.'''
-# pygtk version: Maik Hertha <maik.hertha@berlin.de>
-
-import gobject
-import gtk
-
-# columns
-(
- HOLIDAY_NAME_COLUMN,
- ALEX_COLUMN,
- HAVOC_COLUMN,
- TIM_COLUMN,
- OWEN_COLUMN,
- DAVE_COLUMN,
- VISIBLE_COLUMN,
- WORLD_COLUMN,
- NUM_COLUMNS
-) = range(9)
-
-# tree data
-january = \
-[
- ["New Years Day", True, True, True, True, False, True ],
- ["Presidential Inauguration", False, True, False, True, False, False ],
- ["Martin Luther King Jr. day", False, True, False, True, False, False ]
-]
-
-february = \
-[
- [ "Presidents' Day", False, True, False, True, False, False ],
- [ "Groundhog Day", False, False, False, False, False, False ],
- [ "Valentine's Day", False, False, False, False, True, True ]
-]
-
-march = \
-[
- [ "National Tree Planting Day", False, False, False, False, False, False ],
- [ "St Patrick's Day", False, False, False, False, False, True ]
-]
-april = \
-[
- [ "April Fools' Day", False, False, False, False, False, True ],
- [ "Army Day", False, False, False, False, False, False ],
- [ "Earth Day", False, False, False, False, False, True ],
- [ "Administrative Professionals' Day", False, False, False, False, False, False ]
-]
-
-may = \
-[
- [ "Nurses' Day", False, False, False, False, False, False ],
- [ "National Day of Prayer", False, False, False, False, False, False ],
- [ "Mothers' Day", False, False, False, False, False, True ],
- [ "Armed Forces Day", False, False, False, False, False, False ],
- [ "Memorial Day", True, True, True, True, False, True ]
-]
-
-june = \
-[
- [ "June Fathers' Day", False, False, False, False, False, True ],
- [ "Juneteenth(Liberation of Slaves)", False, False, False, False, False, False ],
- [ "Flag Day", False, True, False, True, False, False ]
-]
-
-july = \
-[
- [ "Parents' Day", False, False, False, False, False, True ],
- [ "Independence Day", False, True, False, True, False, False ]
-]
-
-august = \
-[
- [ "Air Force Day", False, False, False, False, False, False ],
- [ "Coast Guard Day", False, False, False, False, False, False ],
- [ "Friendship Day", False, False, False, False, False, False ]
-]
-
-september = \
-[
- [ "Grandparents' Day", False, False, False, False, False, True ],
- [ "Citizenship Day or Constitution Day", False, False, False, False, False, False ],
- [ "Labor Day", True, True, True, True, False, True ]
-]
-
-october = \
-[
- [ "National Children's Day", False, False, False, False, False, False ],
- [ "Bosses' Day", False, False, False, False, False, False ],
- [ "Sweetest Day", False, False, False, False, False, False ],
- [ "Mother-in-Law's Day", False, False, False, False, False, False ],
- [ "Navy Day", False, False, False, False, False, False ],
- [ "Columbus Day", False, True, False, True, False, False ],
- [ "Halloween", False, False, False, False, False, True ]
-]
-
-november = \
-[
- [ "Marine Corps Day", False, False, False, False, False, False ],
- [ "Veterans' Day", True, True, True, True, False, True ],
- [ "Thanksgiving", False, True, False, True, False, False ]
-]
-
-december = \
-[
- [ "Pearl Harbor Remembrance Day", False, False, False, False, False, False ],
- [ "Christmas", True, True, True, True, False, True ],
- [ "Kwanzaa", False, False, False, False, False, False ]
-]
-
-
-toplevel = \
-[
- ["January", False, False, False, False, False, False, january],
- ["February", False, False, False, False, False, False, february],
- ["March", False, False, False, False, False, False, march],
- ["April", False, False, False, False, False, False, april],
- ["May", False, False, False, False, False, False, may],
- ["June", False, False, False, False, False, False, june],
- ["July", False, False, False, False, False, False, july],
- ["August", False, False, False, False, False, False, august],
- ["September", False, False, False, False, False, False, september],
- ["October", False, False, False, False, False, False, october],
- ["November", False, False, False, False, False, False, november],
- ["December", False, False, False, False, False, False, december]
-]
-
-class TreeStoreDemo(gtk.Window):
- def __init__(self, parent=None):
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
- self.set_title(self.__class__.__name__)
- self.set_default_size(650, 400)
- self.set_border_width(8)
-
- vbox = gtk.VBox(False, 8)
- self.add(vbox)
-
- label = gtk.Label("Jonathan's Holiday Card Planning Sheet")
- vbox.pack_start(label, False, False)
-
- sw = gtk.ScrolledWindow()
- sw.set_shadow_type(gtk.SHADOW_ETCHED_IN)
- sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- vbox.pack_start(sw)
-
- # create model
- model = self.__create_model()
-
- # create treeview
- treeview = gtk.TreeView(model)
- treeview.set_rules_hint(True)
-
- self.__add_columns(treeview)
-
- sw.add(treeview)
-
- # expand all rows after the treeview widget has been realized
- treeview.connect('realize', lambda tv: tv.expand_all())
-
- self.show_all()
-
- def __create_model(self):
-
- # create tree store
- model = gtk.TreeStore(
- gobject.TYPE_STRING,
- gobject.TYPE_BOOLEAN,
- gobject.TYPE_BOOLEAN,
- gobject.TYPE_BOOLEAN,
- gobject.TYPE_BOOLEAN,
- gobject.TYPE_BOOLEAN,
- gobject.TYPE_BOOLEAN,
- gobject.TYPE_BOOLEAN)
-
- # add data to the tree store
- for month in toplevel:
- iter = model.append(None)
- model.set(iter,
- HOLIDAY_NAME_COLUMN, month[HOLIDAY_NAME_COLUMN],
- ALEX_COLUMN, False,
- HAVOC_COLUMN, False,
- TIM_COLUMN, False,
- OWEN_COLUMN, False,
- DAVE_COLUMN, False,
- VISIBLE_COLUMN, False,
- WORLD_COLUMN, False
- )
-
- # add children
- for holiday in month[-1]:
- child_iter = model.append(iter);
- model.set(child_iter,
- HOLIDAY_NAME_COLUMN, holiday[HOLIDAY_NAME_COLUMN],
- ALEX_COLUMN, holiday[ALEX_COLUMN],
- HAVOC_COLUMN, holiday[HAVOC_COLUMN],
- TIM_COLUMN, holiday[TIM_COLUMN],
- OWEN_COLUMN, holiday[OWEN_COLUMN],
- DAVE_COLUMN, holiday[DAVE_COLUMN],
- VISIBLE_COLUMN, True,
- WORLD_COLUMN, holiday[WORLD_COLUMN-1]
- )
-
- return model
-
- def on_item_toggled(self, cell, path_str, model):
-
- # get selected column
- column = cell.get_data('column')
-
- # get toggled iter
- iter = model.get_iter_from_string(path_str)
- toggle_item = model.get_value(iter, column)
-
- # do something with the value
- toggle_item = not toggle_item
-
- # set new value
- model.set(iter, column, toggle_item)
-
-
- def __add_columns(self, treeview):
- model = treeview.get_model()
-
- # column for holiday names
- renderer = gtk.CellRendererText()
- renderer.set_property("xalign", 0.0)
-
- #col_offset = gtk.TreeViewColumn("Holiday", renderer, text=HOLIDAY_NAME_COLUMN)
- column = gtk.TreeViewColumn("Holiday", renderer, text=HOLIDAY_NAME_COLUMN)
- #column = gtk_tree_view_get_column(GTK_TREE_VIEW(treeview), col_offset - 1);
- column.set_clickable(True)
-
- treeview.append_column(column)
-
- # alex column */
- renderer = gtk.CellRendererToggle()
- renderer.set_property("xalign", 0.0)
- renderer.set_data("column", ALEX_COLUMN)
-
- renderer.connect("toggled", self.on_item_toggled, model)
-
- column = gtk.TreeViewColumn("Alex", renderer, active=ALEX_COLUMN,
- visible=VISIBLE_COLUMN, activatable=WORLD_COLUMN)
-
- # set this column to a fixed sizing(of 50 pixels)
- #column = gtk_tree_view_get_column(GTK_TREE_VIEW(treeview), col_offset - 1);
- column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
- column.set_fixed_width(50)
- column.set_clickable(True)
-
- treeview.append_column(column)
-
- # havoc column
- renderer = gtk.CellRendererToggle();
- renderer.set_property("xalign", 0.0)
- renderer.set_data("column", HAVOC_COLUMN)
-
- renderer.connect("toggled", self.on_item_toggled, model)
-
- column = gtk.TreeViewColumn("Havoc", renderer, active=HAVOC_COLUMN,
- visible=VISIBLE_COLUMN)
-
- #column = treeview.get_column(col_offset - 1)
- column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
- column.set_fixed_width(50)
- column.set_clickable(True)
-
- treeview.append_column(column)
-
- # tim column
- renderer = gtk.CellRendererToggle();
- renderer.set_property("xalign", 0.0)
- renderer.set_data("column", TIM_COLUMN)
-
- renderer.connect("toggled", self.on_item_toggled, model)
-
- column = gtk.TreeViewColumn("Tim", renderer, active=TIM_COLUMN,
- visible=VISIBLE_COLUMN, activatable=WORLD_COLUMN)
-
- #column = treeview.get_column(col_offset - 1)
- column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
- column.set_fixed_width(50)
- column.set_clickable(True)
-
- treeview.append_column(column)
-
- # owen column
- renderer = gtk.CellRendererToggle();
- renderer.set_property("xalign", 0.0)
- renderer.set_data("column", OWEN_COLUMN)
-
- renderer.connect("toggled", self.on_item_toggled, model)
-
- column = gtk.TreeViewColumn("Owen", renderer, active=OWEN_COLUMN,
- visible=VISIBLE_COLUMN)
-
- #column = treeview.get_column(col_offset - 1)
- column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
- column.set_fixed_width(50)
- column.set_clickable(True)
-
- treeview.append_column(column)
-
- # dave column
- renderer = gtk.CellRendererToggle();
- renderer.set_property("xalign", 0.0)
- renderer.set_data("column", DAVE_COLUMN)
-
- renderer.connect("toggled", self.on_item_toggled, model)
-
- column = gtk.TreeViewColumn("Dave", renderer, active=DAVE_COLUMN,
- visible=VISIBLE_COLUMN)
-
- #column = treeview.get_column(col_offset - 1)
- column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
- column.set_fixed_width(50)
- column.set_clickable(True)
-
- treeview.append_column(column)
-
-def main():
- TreeStoreDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/treemodel.py b/examples/pygtk-demo/demos/treemodel.py
deleted file mode 100644
index 7fca9a08..00000000
--- a/examples/pygtk-demo/demos/treemodel.py
+++ /dev/null
@@ -1,120 +0,0 @@
-#!/usr/bin/env python
-'''Tree View/Generic Tree Model
-
-This test is designed to demonstrate creating a new type of tree model
-in python for use with the new tree widget in gtk 2.0.'''
-
-import gtk
-import gobject
-
-# to create a new GtkTreeModel from python, you must derive from
-# TreeModel.
-class MyTreeModel(gtk.GenericTreeModel):
- '''This class represents the model of a tree. The iterators used
- to represent positions are converted to python objects when passed
- to the on_* methods. This means you can use any python object to
- represent a node in the tree. The None object represents a NULL
- iterator.
-
- In this tree, we use simple tuples to represent nodes, which also
- happen to be the tree paths for those nodes. This model is a tree
- of depth 3 with 5 nodes at each level of the tree. The values in
- the tree are just the string representations of the nodes.'''
-
- TREE_DEPTH = 4
- TREE_SIBLINGS = 5
- def __init__(self):
- '''constructor for the model. Make sure you call
- PyTreeModel.__init__'''
- gtk.GenericTreeModel.__init__(self)
-
- # the implementations for TreeModel methods are prefixed with on_
- def on_get_flags(self):
- '''returns the GtkTreeModelFlags for this particular type of model'''
- return 0
- def on_get_n_columns(self):
- '''returns the number of columns in the model'''
- return 1
- def on_get_column_type(self, index):
- '''returns the type of a column in the model'''
- return gobject.TYPE_STRING
- def on_get_path(self, node):
- '''returns the tree path(a tuple of indices at the various
- levels) for a particular node.'''
- return node
- def on_get_iter(self, path):
- '''returns the node corresponding to the given path. In our
- case, the node is the path'''
- return path
- def on_get_value(self, node, column):
- '''returns the value stored in a particular column for the node'''
- assert column == 0
- return `node`
- def on_iter_next(self, node):
- '''returns the next node at this level of the tree'''
- if node != None:
- if node[-1] == self.TREE_SIBLINGS - 1: # last node at level
- return None
- return node[:-1] +(node[-1]+1,)
- def on_iter_children(self, node):
- '''returns the first child of this node'''
- if node == None: # top of tree
- return(0,)
- if len(node) >= self.TREE_DEPTH: # no more levels
- return None
- return node +(0,)
- def on_iter_has_child(self, node):
- '''returns true if this node has children'''
- return node == None or len(node) < self.TREE_DEPTH
- def on_iter_n_children(self, node):
- '''returns the number of children of this node'''
- if node == None or len(node) < self.TREE_DEPTH:
- return self.TREE_SIBLINGS
- else:
- return 0
- def on_iter_nth_child(self, node, n):
- '''returns the nth child of this node'''
- if node == None:
- return(n,)
- if len(node) < self.TREE_DEPTH and n < self.TREE_SIBLINGS:
- return node +(n,)
- else:
- return None
- def on_iter_parent(self, node):
- '''returns the parent of this node'''
- assert node != None
- if len(node) == 0:
- return None
- else:
- return node[:-1]
-
-class GenericTreeModelDemo(gtk.Window):
- def __init__(self, parent=None):
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
- self.set_title(self.__class__.__name__)
-
- scrolled_window = gtk.ScrolledWindow()
- scrolled_window.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- self.add(scrolled_window)
-
- model = MyTreeModel()
- model = model.filter_new()
- tree_view = gtk.TreeView(model)
- cell = gtk.CellRendererText()
- # the text in the column comes from column 0
- column = gtk.TreeViewColumn("tuples", cell, text=0)
- tree_view.append_column(column)
-
- scrolled_window.add(tree_view)
- self.show_all()
-
-def main():
- GenericTreeModelDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/demos/ui_manager.py b/examples/pygtk-demo/demos/ui_manager.py
deleted file mode 100644
index 02eed389..00000000
--- a/examples/pygtk-demo/demos/ui_manager.py
+++ /dev/null
@@ -1,191 +0,0 @@
-#!/usr/bin/env python
-'''UI Manager
-
-The GtkUIManager object allows the easy creation of menus
-from an array of actions and a description of the menu hierarchy.
-'''
-# pygtk version: Maik Hertha <maik.hertha@berlin.de>
-
-import gobject
-import gtk
-
-def activate_action(action):
- print 'Action "%s" activated' % action.get_name()
-
-def activate_radio_action(action, current):
- print 'Radio action "%s" selected'% current.get_name()
-
-entries = (
- ( "FileMenu", None, "_File" ), # name, stock id, label
- ( "PreferencesMenu", None, "_Preferences" ), # name, stock id, label
- ( "ColorMenu", None, "_Color" ), # name, stock id, label
- ( "ShapeMenu", None, "_Shape" ), # name, stock id, label
- ( "HelpMenu", None, "_Help" ), # name, stock id, label
- ( "New", gtk.STOCK_NEW, # name, stock id
- "_New", "<control>N", # label, accelerator
- "Create a new file", # tooltip
- activate_action ),
- ( "Open", gtk.STOCK_OPEN, # name, stock id
- "_Open","<control>O", # label, accelerator
- "Open a file", # tooltip
- activate_action ),
- ( "Save", gtk.STOCK_SAVE, # name, stock id
- "_Save","<control>S", # label, accelerator
- "Save current file", # tooltip
- activate_action ),
- ( "SaveAs", gtk.STOCK_SAVE, # name, stock id
- "Save _As...", None, # label, accelerator
- "Save to a file", # tooltip
- activate_action ),
- ( "Quit", gtk.STOCK_QUIT, # name, stock id
- "_Quit", "<control>Q", # label, accelerator
- "Quit", # tooltip
- activate_action ),
- ( "About", None, # name, stock id
- "_About", "<control>A", # label, accelerator
- "About", # tooltip
- activate_action ),
- ( "Logo", "demo-gtk-logo", # name, stock id
- None, None, # label, accelerator
- "GTK+", # tooltip
- activate_action ),
-)
-
-toggle_entries = (
- ( "Bold", gtk.STOCK_BOLD, # name, stock id
- "_Bold", "<control>B", # label, accelerator
- "Bold", # tooltip
- activate_action,
- True ), # is_active
-)
-
-(
- COLOR_RED,
- COLOR_GREEN,
- COLOR_BLUE
-) = range(3)
-
-color_entries = (
- ( "Red", None, # name, stock id
- "_Red", "<control>R", # label, accelerator
- "Blood", COLOR_RED ), # tooltip, value
- ( "Green", None, # name, stock id
- "_Green", "<control>G", # label, accelerator
- "Grass", COLOR_GREEN ), # tooltip, value
- ( "Blue", None, # name, stock id
- "_Blue", "<control>B", # label, accelerator
- "Sky", COLOR_BLUE ), # tooltip, value
-)
-
-(
- SHAPE_SQUARE,
- SHAPE_RECTANGLE,
- SHAPE_OVAL,
-) = range(3)
-
-# GtkRadioActionEntry
-shape_entries = (
- ( "Square", None, # name, stock id
- "_Square", "<control>S", # label, accelerator
- "Square", SHAPE_SQUARE ), # tooltip, value
- ( "Rectangle", None, # name, stock id
- "_Rectangle", "<control>R", # label, accelerator
- "Rectangle", SHAPE_RECTANGLE ), # tooltip, value
- ( "Oval", None, # name, stock id
- "_Oval", "<control>O", # label, accelerator
- "Egg", SHAPE_OVAL ), # tooltip, value
-)
-
-ui_info = \
-'''<ui>
- <menubar name='MenuBar'>
- <menu action='FileMenu'>
- <menuitem action='New'/>
- <menuitem action='Open'/>
- <menuitem action='Save'/>
- <menuitem action='SaveAs'/>
- <separator/>
- <menuitem action='Quit'/>
- </menu>
- <menu action='PreferencesMenu'>
- <menu action='ColorMenu'>
- <menuitem action='Red'/>
- <menuitem action='Green'/>
- <menuitem action='Blue'/>
- </menu>
- <menu action='ShapeMenu'>
- <menuitem action='Square'/>
- <menuitem action='Rectangle'/>
- <menuitem action='Oval'/>
- </menu>
- <menuitem action='Bold'/>
- </menu>
- <menu action='HelpMenu'>
- <menuitem action='About'/>
- </menu>
- </menubar>
- <toolbar name='ToolBar'>
- <toolitem action='Open'/>
- <toolitem action='Quit'/>
- <separator action='Sep1'/>
- <toolitem action='Logo'/>
- </toolbar>
-</ui>'''
-
-class UIManagerDemo(gtk.Window):
-
- def __init__(self, parent=None):
- gtk.Window.__init__(self)
- try:
- self.set_screen(parent.get_screen())
- except AttributeError:
- self.connect('destroy', lambda *w: gtk.main_quit())
- self.set_title(self.__class__.__name__)
- self.set_border_width(0)
-
- actions = gtk.ActionGroup("Actions")
- actions.add_actions(entries)
- actions.add_toggle_actions(toggle_entries)
- actions.add_radio_actions(color_entries, COLOR_RED, activate_radio_action)
- actions.add_radio_actions(shape_entries, SHAPE_OVAL, activate_radio_action)
-
- ui = gtk.UIManager()
- ui.insert_action_group(actions, 0)
- self.add_accel_group(ui.get_accel_group())
-
- try:
- mergeid = ui.add_ui_from_string(ui_info)
- except gobject.GError, msg:
- print "building menus failed: %s" % msg
-
- box1 = gtk.VBox(False, 0)
- self.add(box1)
-
- box1.pack_start(ui.get_widget("/MenuBar"), False, False, 0)
-
- label = gtk.Label("Type\n<alt>\nto start")
- label.set_size_request(200, 200)
- label.set_alignment(0.5, 0.5)
- box1.pack_start(label, True, True, 0)
-
- separator = gtk.HSeparator()
- box1.pack_start(separator, False, True, 0)
-
- box2 = gtk.VBox(False, 10)
- box2.set_border_width(10)
- box1.pack_start(box2, False, True, 0)
-
- button = gtk.Button("close")
- button.connect("clicked", lambda b, w=self: w.destroy())
- box2.pack_start(button, True, True, 0)
- button.set_flags(gtk.CAN_DEFAULT)
- button.grab_default()
-
- self.show_all()
-
-def main():
- UIManagerDemo()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/pygtk-demo/pygtk-demo.in b/examples/pygtk-demo/pygtk-demo.in
deleted file mode 100644
index fead8c54..00000000
--- a/examples/pygtk-demo/pygtk-demo.in
+++ /dev/null
@@ -1,7 +0,0 @@
-#! @PYTHON@
-
-import sys
-import os.path
-pygtklibdir = os.path.join("@libdir@", "pygtk", "2.0")
-sys.path.insert(0, pygtklibdir)
-execfile(os.path.join(pygtklibdir, "pygtk-demo.py"))
diff --git a/examples/pygtk-demo/pygtk-demo.py b/examples/pygtk-demo/pygtk-demo.py
deleted file mode 100644
index 282a14d2..00000000
--- a/examples/pygtk-demo/pygtk-demo.py
+++ /dev/null
@@ -1,318 +0,0 @@
-#!/usr/bin/env python
-'''
- $Id$
-
- pygtk-demo.py
- 2004-07-18: Some enhancements for building the demolist like in gtk-demos of the
- gtk+ distribution.
- 2004-07-22: Simple syntaxhighlighting implemented, based on the tokenizer-module.
-'''
-
-import string
-import re
-try:
- import pygtk
- pygtk.require('2.0')
-except ImportError:
- pass
-import gobject
-import gtk
-import pango
-
-# use for simple syntax highlighting ;-)
-import tokenize
-import keyword
-
-import demos
-D_TEMPL = '%sDemo'
-
-# Some programmatic definition for the testgtk_demos list. This avoids extra
-# maintenance if the demo list grows up. The current definition requires
-# a class or function with a swapped case name+'Demo' like in the doc string.
-# Swapped case is build from the __doc__-string programatically.
-child_demos = {}
-testgtk_demos = []
-for descr, mod in demos.demo_list:
- # Find some categorized demos
- try:
- main, child = descr.split('/')
- except ValueError:
- # No, only one application
- demo_class = D_TEMPL % re.sub('(\S+) *',
- lambda m:(m.group(1)[0].isupper() and m.group(1) or m.group(1).capitalize()),
- descr)
- testgtk_demos.append((descr, mod, demo_class))
- else:
- # Ok. Some more testing
- demo_class = D_TEMPL % re.sub('(\S+) *',
- lambda m:(m.group(1)[0].isupper() and m.group(1) or m.group(1).capitalize()),
- child)
- try:
- # Applicationgroup already defined?
- child_demos[main.upper()].append((child, mod, demo_class))
- except KeyError:
- # No. Start a new category
- child_demos.setdefault(main.upper(), []).append((child, mod, demo_class))
- testgtk_demos.append((main, None, None, child_demos[main.upper()]))
-
-(
- TITLE_COLUMN,
- MODULE_COLUMN,
- FUNC_COLUMN,
- ITALIC_COLUMN
-) = range(4)
-
-CHILDREN_COLUMN = 3
-
-class InputStream(object):
- ''' Simple Wrapper for File-like objects. [c]StringIO doesn't provide
- a readline function for use with generate_tokens.
- Using a iterator-like interface doesn't succeed, because the readline
- function isn't used in such a context. (see <python-lib>/tokenize.py)
- '''
- def __init__(self, data):
- self.__data = [ '%s\n' % x for x in data.splitlines() ]
- self.__lcount = 0
- def readline(self):
- try:
- line = self.__data[self.__lcount]
- self.__lcount += 1
- except IndexError:
- line = ''
- self.__lcount = 0
- return line
-
-
-class PyGtkDemo(gtk.Window):
- info_buffer = None
- source_buffer = None
- module_cache = {}
-
- def __init__(self):
- gtk.Window.__init__(self)
- self.set_title("PyGTK+ Code Demos")
- self.connect('destroy', lambda w: gtk.main_quit())
- self.set_default_size(800, 400)
-
- hbox = gtk.HBox(False, 3)
- self.add(hbox)
-
- treeview = self.__create_treeview()
- hbox.pack_start(treeview, False, False)
-
- self.notebook = gtk.Notebook()
- hbox.pack_start(self.notebook, expand=True)
-
- scrolled_window, self.info_buffer = self.__create_text(False)
- self._new_notebook_page(scrolled_window, '_Info')
- tag = self.info_buffer.create_tag('title')
- tag.set_property('font', 'Sans 18')
-
- scrolled_window, self.source_buffer = self.__create_text(True)
- self._new_notebook_page(scrolled_window, '_Source')
- tag = self.source_buffer.create_tag('source')
- tag.set_property('font', 'monospace')
- tag.set_property('pixels_above_lines', 0)
- tag.set_property('pixels_below_lines', 0)
- tag = self.source_buffer.create_tag('keyword', foreground='#00007F',
- weight=pango.WEIGHT_BOLD)
- tag = self.source_buffer.create_tag('string', foreground='#7F007F')
- tag = self.source_buffer.create_tag('comment', foreground='#007F00',
- style=pango.STYLE_ITALIC)
-
- self.show_all()
-
- def run(self):
- gtk.main()
-
- def _new_notebook_page(self, widget, label):
- l = gtk.Label('')
- l.set_text_with_mnemonic(label)
- self.notebook.append_page(widget, l)
-
- def __create_treeview(self):
- model = gtk.TreeStore(
- gobject.TYPE_STRING,
- gobject.TYPE_STRING,
- gobject.TYPE_STRING,
- gobject.TYPE_BOOLEAN
- )
-
- treeview = gtk.TreeView(model)
- selection = treeview.get_selection()
- selection.set_mode(gtk.SELECTION_BROWSE)
- treeview.set_size_request(200, -1)
-
- for module in testgtk_demos:
- iter = model.append(None)
- model.set(iter,
- TITLE_COLUMN, module[TITLE_COLUMN],
- MODULE_COLUMN, module[MODULE_COLUMN],
- FUNC_COLUMN, module[FUNC_COLUMN],
- ITALIC_COLUMN, False
- )
-
- try:
- children = module[CHILDREN_COLUMN]
- for child_module in children:
- child_iter = model.append(iter)
- model.set(child_iter,
- TITLE_COLUMN, child_module[TITLE_COLUMN],
- MODULE_COLUMN, child_module[MODULE_COLUMN],
- FUNC_COLUMN, child_module[FUNC_COLUMN],
- ITALIC_COLUMN, False
- )
- except IndexError:
- pass
-
- cell = gtk.CellRendererText()
- cell.set_property('style', pango.STYLE_ITALIC)
-
- column = gtk.TreeViewColumn("Widget (double click for demo)", cell,
- text=TITLE_COLUMN, style_set=ITALIC_COLUMN)
-
- treeview.append_column(column)
-
- selection.connect('changed', self.selection_changed_cb)
- treeview.connect('row-activated', self.row_activated_cb)
-
- treeview.expand_all()
-
- return treeview
-
- def __create_text(self, is_source=False):
- scrolled_window = gtk.ScrolledWindow()
- scrolled_window.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
- scrolled_window.set_shadow_type(gtk.SHADOW_IN)
-
- text_view = gtk.TextView()
- scrolled_window.add(text_view)
-
- buffer = gtk.TextBuffer(None)
- text_view.set_buffer(buffer)
- text_view.set_editable(False)
- text_view.set_cursor_visible(False)
-
- text_view.set_wrap_mode(not is_source)
-
- return scrolled_window, buffer
-
- def row_activated_cb(self, treeview, path, column):
- model = treeview.get_model()
- iter = model.get_iter(path)
- module_name = model.get_value(iter, MODULE_COLUMN)
- func_name = model.get_value(iter, FUNC_COLUMN)
- italic_value = model.get_value(iter, ITALIC_COLUMN)
- try:
- self.module_cache[module_name].present()
- except KeyError:
- module = getattr(demos, module_name)
- model.set(iter, ITALIC_COLUMN, not italic_value)
- cmd = 'demos.%s.%s' % (module_name, func_name)
- #print cmd
- window = eval(cmd)(self)
- if window:
- window.connect('destroy', self.window_closed_cb, model, path)
- self.module_cache[module_name] = window
-
- def selection_changed_cb(self, selection):
- model, iter = selection.get_selected()
- if not iter:
- return False
-
- name = model.get_value(iter, MODULE_COLUMN)
- self.load_module(name)
-
- def window_closed_cb (self, window, model, path):
- iter = model.get_iter(path)
- module_name = model.get_value(iter, MODULE_COLUMN)
- del self.module_cache[module_name]
- italic_value = model.get_value(iter, ITALIC_COLUMN)
- if italic_value:
- model.set(iter, ITALIC_COLUMN, not italic_value)
-
-
- def read_module(self, module):
- filename = module.__file__
- if filename[-4:] == '.pyc':
- filename = filename[:-1]
- fd = open(filename)
- return fd.read()
-
- def insert_documentation(self, module):
- buffer = self.info_buffer
- iter = buffer.get_iter_at_offset(0)
-
- lines = string.split(module.__doc__ or '', '\n')
- buffer.insert(iter, lines[0])
- start = buffer.get_iter_at_offset(0)
- buffer.apply_tag_by_name('title', start, iter)
- buffer.insert(iter, '\n')
- for line in lines[1:]:
- buffer.insert(iter, line)
- buffer.insert(iter, '\n')
-
- def clear_buffers(self):
- start, end = self.info_buffer.get_bounds()
- self.info_buffer.delete(start, end)
-
- start, end = self.source_buffer.get_bounds()
- self.source_buffer.delete(start, end)
-
- def insert_source(self, data):
- source_buffer = self.source_buffer
- iter = source_buffer.get_iter_at_offset(0)
-
- last_erow, last_ecol = 0, 0
- was_newline = False # multiline statement detection
- for x in tokenize.generate_tokens(InputStream(data).readline):
- # x has 5-tuples
- tok_type, tok_str = x[0], x[1]
- srow, scol = x[2]
- erow, ecol = x[3]
-
- # The tokenizer 'eats' the whitespaces, so we have to insert this again
- # if needed.
- if srow == last_erow:
- # Same line, spaces between statements
- if scol != last_ecol:
- source_buffer.insert_with_tags_by_name(iter, ' '*(scol-last_ecol), 'source')
- else:
- # New line.
- # First: Detect multiline statements. There is no special in the tokenizer stream.
- if was_newline is False and last_erow != 0:
- source_buffer.insert_with_tags_by_name(iter, ' \\\n', 'source')
- # new line check if it starts with col 0
- if scol != 0:
- source_buffer.insert_with_tags_by_name(iter, ' '*scol, 'source')
- last_erow = erow
- last_ecol = ecol
-
- if tok_type == tokenize.COMMENT:
- was_newline = True # newline is in tok_str included.
- source_buffer.insert_with_tags_by_name(iter, tok_str, 'source', 'comment')
- continue
- elif tok_type == tokenize.NAME:
- if tok_str in keyword.kwlist:
- source_buffer.insert_with_tags_by_name(iter, tok_str, 'source', 'keyword')
- continue
- elif tok_type == tokenize.STRING:
- source_buffer.insert_with_tags_by_name(iter, tok_str, 'source', 'string')
- continue
-
- # No special format for use. Check for newline.
- was_newline = tok_type in (tokenize.NEWLINE, tokenize.NL)
- source_buffer.insert_with_tags_by_name(iter, tok_str, 'source')
-
- def load_module(self, name):
- self.clear_buffers()
- if name is None: return
- module = getattr(demos, name)
- if module.__doc__:
- self.insert_documentation(module)
-
- source = self.read_module(module)
- self.insert_source(source)
-
-if __name__ == '__main__':
- PyGtkDemo().run()
diff --git a/examples/simple/README b/examples/simple/README
deleted file mode 100644
index 9bcb80cc..00000000
--- a/examples/simple/README
+++ /dev/null
@@ -1,5 +0,0 @@
-These are some of the simplest examples you can do. They are only intended
-to help you see how to use pygtk. The examples ending in 1.py use the low
-level C-like interface, while the ones ending in 2.py are translations that
-use Gtkinter.
-
diff --git a/examples/simple/dnd.py b/examples/simple/dnd.py
deleted file mode 100644
index 0217def7..00000000
--- a/examples/simple/dnd.py
+++ /dev/null
@@ -1,182 +0,0 @@
-#! /usr/bin/env python
-
-import gobject
-import gtk
-
-from dndpixmap import drag_icon_xpm, trashcan_open_xpm, trashcan_closed_xpm
-
-
-trashcan_open = None
-trashcan_closed = None
-
-have_drag = False;
-popped_up = False
-in_popup = False
-popup_timer = 0
-popdown_timer = 0
-popup_win = None
-
-
-TARGET_STRING = 0
-TARGET_ROOTWIN = 1
-
-target = [
- ('STRING', 0, TARGET_STRING),
- ('text/plain', 0, TARGET_STRING),
- ('application/x-rootwin-drop', 0, TARGET_ROOTWIN)
- ]
-
-def target_drag_leave(w, context, time):
- global trashcan_closed
- global have_drag
- print 'leave'
- have_drag = False
- w.set_from_pixbuf(trashcan_closed)
-def target_drag_motion(w, context, x, y, time):
- global trashcan_open
- global have_drag
- if not have_drag:
- have_drag = True
- w.set_from_pixbuf(trashcan_open)
- source_widget = context.get_source_widget()
- print 'motion, source ',
- if source_widget:
- print source_widget.__class__.__name__
- else:
- print 'unknown'
- context.drag_status(context.suggested_action, time)
- return True
-def target_drag_drop(w, context, x, y, time):
- global trashcan_closed
- global have_drag
- print 'drop'
- have_drag = False
- w.set_from_pixbuf(trashcan_closed)
- if context.targets:
- w.drag_get_data(context, context.targets[0], time)
- return True
- return False
-def target_drag_data_received(w, context, x, y, data, info, time):
- if data.format == 8:
- print 'Received "%s" in trashcan' % data.data
- context.finish(True, False, time)
- else:
- context.finish(False, False, time)
-def label_drag_data_received(w, context, x, y, data, info, time):
- if data and data.format == 8:
- print 'Received "%s" in label' % data.data
- context.finish(True, False, time)
- else:
- context.finish(False, False, time)
-def source_drag_data_get(w, context, selection_data, info, time):
- if info == TARGET_ROOTWIN:
- print 'I was dropped on the rootwin'
- else:
- selection_data.set(selection_data.target, 8, "I'm Data!")
-
-def popdown_cb():
- global popdown_timer, popped_up
- global popup_win
- popdown_timer = 0
- popup_win.hide()
- popped_up = False
- return False
-def popup_motion(w, context, x, y, time):
- global in_popup, popdown_timer
- if not in_popup:
- in_popup = True
- if popdown_timer:
- print 'removed popdown'
- gobject.source_remove(popdown_timer)
- popdown_timer = 0
- return True
-def popup_leave(w, context, time):
- global in_popup, popdown_timer
- print 'popup_leave'
- if in_popup:
- in_popup = False
- if not popdown_timer:
- print 'added popdown'
- popdown_timer = gobject.timeout_add(500, popdown_cb)
-def popup_cb():
- global popped_up, popup_win
- global popup_timer, popdown_timer
- if not popped_up:
- if not popup_win:
- popup_win = gtk.Window(gtk.WINDOW_POPUP)
- popup_win.set_position(gtk.WIN_POS_MOUSE)
- table = gtk.Table(3,3,False)
- for k in range(9):
- i, j = divmod(k, 3)
- b = gtk.Button("%d,%d" % (i,j))
- table.attach(b, i,i+1,j,j+1)
- b.drag_dest_set(gtk.DEST_DEFAULT_ALL, target,
- gtk.gdk.ACTION_COPY | gtk.gdk.ACTION_MOVE)
- b.connect('drag_motion', popup_motion)
- b.connect('drag_leave', popup_leave)
- table.show_all()
- popup_win.add(table)
- popup_win.show()
- popped_up = True
- popdown_timer = gobject.timeout_add(500, popdown_cb)
- print 'added popdown'
- popup_timer = 0
- return False
-def popsite_motion(w, context, x, y, time):
- global popup_timer
- if not popup_timer:
- popup_timer = gobject.timeout_add(500, popup_cb)
- return True
-def popsite_leave(w, context, time):
- global popup_timer
- if popup_timer:
- gobject.source_remove(popup_timer)
- popup_timer = 0
-def source_drag_data_delete(w, context, data):
- print 'Delete the data!'
-def create_pixmap(w, xpm):
- return gtk.gdk.pixmap_create_from_xpm_d(w.window, None, xpm)
-def main():
- global trashcan_open
- global trashcan_closed
- global drag_icon
- win = gtk.Window()
- win.realize()
- win.connect('destroy', lambda w: gtk.main_quit())
- table = gtk.Table(2,2)
- win.add(table)
- drag_icon = gtk.gdk.pixbuf_new_from_xpm_data(drag_icon_xpm)
- trashcan_open = gtk.gdk.pixbuf_new_from_xpm_data(trashcan_open_xpm)
- trashcan_closed = gtk.gdk.pixbuf_new_from_xpm_data(trashcan_closed_xpm)
- label = gtk.Label('Drop on Trashcan!\n')
- label.drag_dest_set(gtk.DEST_DEFAULT_ALL, target[:-1],
- gtk.gdk.ACTION_COPY | gtk.gdk.ACTION_MOVE)
- label.connect('drag_data_received', label_drag_data_received)
- table.attach(label, 0, 1, 0, 1)
-
- label = gtk.Label('Popup\n')
- label.drag_dest_set(gtk.DEST_DEFAULT_ALL, target[:-1],
- gtk.gdk.ACTION_COPY | gtk.gdk.ACTION_MOVE)
- table.attach(label, 1, 2, 1, 2)
- label.connect('drag_motion', popsite_motion)
- label.connect('drag_leave', popsite_leave)
-
- image = gtk.Image()
- image.set_from_pixbuf(trashcan_closed)
- image.drag_dest_set(0, [], 0)
- table.attach(image, 1, 2, 0, 1)
- image.connect('drag_leave', target_drag_leave)
- image.connect('drag_motion', target_drag_motion)
- image.connect('drag_drop', target_drag_drop)
- image.connect('drag_data_received', target_drag_data_received)
-
- b = gtk.Button('Drag from Here\n')
- b.drag_source_set(gtk.gdk.BUTTON1_MASK|gtk.gdk.BUTTON3_MASK, target,
- gtk.gdk.ACTION_COPY|gtk.gdk.ACTION_MOVE)
- b.drag_source_set_icon_pixbuf(drag_icon)
- table.attach(b, 0, 1, 1, 2)
- b.connect('drag_data_get', source_drag_data_get)
- b.connect('drag_data_delete', source_drag_data_delete)
- win.show_all()
-main()
-gtk.main()
diff --git a/examples/simple/dndpixmap.py b/examples/simple/dndpixmap.py
deleted file mode 100644
index 781b9798..00000000
--- a/examples/simple/dndpixmap.py
+++ /dev/null
@@ -1,259 +0,0 @@
-drag_icon_xpm = [
-"36 48 9 1",
-" c None",
-". c #020204",
-"+ c #8F8F90",
-"@ c #D3D3D2",
-"# c #AEAEAC",
-"$ c #ECECEC",
-"% c #A2A2A4",
-"& c #FEFEFC",
-"* c #BEBEBC",
-" .....................",
-" ..&&&&&&&&&&&&&&&&&&&.",
-" ...&&&&&&&&&&&&&&&&&&&.",
-" ..&.&&&&&&&&&&&&&&&&&&&.",
-" ..&&.&&&&&&&&&&&&&&&&&&&.",
-" ..&&&.&&&&&&&&&&&&&&&&&&&.",
-" ..&&&&.&&&&&&&&&&&&&&&&&&&.",
-" ..&&&&&.&&&@&&&&&&&&&&&&&&&.",
-" ..&&&&&&.*$%$+$&&&&&&&&&&&&&.",
-" ..&&&&&&&.%$%$+&&&&&&&&&&&&&&.",
-" ..&&&&&&&&.#&#@$&&&&&&&&&&&&&&.",
-" ..&&&&&&&&&.#$**#$&&&&&&&&&&&&&.",
-" ..&&&&&&&&&&.&@%&%$&&&&&&&&&&&&&.",
-" ..&&&&&&&&&&&.&&&&&&&&&&&&&&&&&&&.",
-" ..&&&&&&&&&&&&.&&&&&&&&&&&&&&&&&&&.",
-"................&$@&&&@&&&&&&&&&&&&.",
-".&&&&&&&+&&#@%#+@#@*$%$+$&&&&&&&&&&.",
-".&&&&&&&+&&#@#@&&@*%$%$+&&&&&&&&&&&.",
-".&&&&&&&+&$%&#@&#@@#&#@$&&&&&&&&&&&.",
-".&&&&&&@#@@$&*@&@#@#$**#$&&&&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&@%&%$&&&&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&$#@@$&&&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&&+&$+&$&@&$@&&$@&&&&&&&&&&.",
-".&&&&&&&&&+&&#@%#+@#@*$%&+$&&&&&&&&.",
-".&&&&&&&&&+&&#@#@&&@*%$%$+&&&&&&&&&.",
-".&&&&&&&&&+&$%&#@&#@@#&#@$&&&&&&&&&.",
-".&&&&&&&&@#@@$&*@&@#@#$#*#$&&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&$%&%$&&&&&&&&.",
-".&&&&&&&&&&$#@@$&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&&&&+&$%&$$@&$@&&$@&&&&&&&&.",
-".&&&&&&&&&&&+&&#@%#+@#@*$%$+$&&&&&&.",
-".&&&&&&&&&&&+&&#@#@&&@*#$%$+&&&&&&&.",
-".&&&&&&&&&&&+&$+&*@&#@@#&#@$&&&&&&&.",
-".&&&&&&&&&&$%@@&&*@&@#@#$#*#&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&$%&%$&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&&&&&&&$#@@$&&&&&&&&&&&&&&&.",
-".&&&&&&&&&&&&&&&+&$%&$$@&$@&&$@&&&&.",
-".&&&&&&&&&&&&&&&+&&#@%#+@#@*$%$+$&&.",
-".&&&&&&&&&&&&&&&+&&#@#@&&@*#$%$+&&&.",
-".&&&&&&&&&&&&&&&+&$+&*@&#@@#&#@$&&&.",
-".&&&&&&&&&&&&&&$%@@&&*@&@#@#$#*#&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&$%&%$&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.",
-".&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&.",
-"...................................."]
-
-trashcan_closed_xpm = [
-"64 80 17 1",
-" c None",
-". c #030304",
-"+ c #5A5A5C",
-"@ c #323231",
-"# c #888888",
-"$ c #1E1E1F",
-"% c #767677",
-"& c #494949",
-"* c #9E9E9C",
-"= c #111111",
-"- c #3C3C3D",
-"; c #6B6B6B",
-"> c #949494",
-", c #282828",
-"' c #808080",
-") c #545454",
-"! c #AEAEAC",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ==......=$$...=== ",
-" ..$------)+++++++++++++@$$... ",
-" ..=@@-------&+++++++++++++++++++-.... ",
-" =.$$@@@-&&)++++)-,$$$$=@@&+++++++++++++,..$ ",
-" .$$$$@@&+++++++&$$$@@@@-&,$,-++++++++++;;;&.. ",
-" $$$$,@--&++++++&$$)++++++++-,$&++++++;%%'%%;;$@ ",
-" .-@@-@-&++++++++-@++++++++++++,-++++++;''%;;;%*-$ ",
-" +------++++++++++++++++++++++++++++++;;%%%;;##*!. ",
-" =+----+++++++++++++++++++++++;;;;;;;;;;;;%'>>). ",
-" .=)&+++++++++++++++++;;;;;;;;;;;;;;%''>>#>#@. ",
-" =..=&++++++++++++;;;;;;;;;;;;;%###>>###+%== ",
-" .&....=-+++++%;;####''''''''''##'%%%)..#. ",
-" .+-++@....=,+%#####'%%%%%%%%%;@$-@-@*++!. ",
-" .+-++-+++-&-@$$=$=......$,,,@;&)+!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" =+-++-+++-+++++++++!++++!++++!+++!++!+++= ",
-" $.++-+++-+++++++++!++++!++++!+++!++!+.$ ",
-" =.++++++++++++++!++++!++++!+++!++.= ",
-" $..+++++++++++++++!++++++...$ ",
-" $$=.............=$$ ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" "]
-
-trashcan_open_xpm = [
-"64 80 17 1",
-" c None",
-". c #030304",
-"+ c #5A5A5C",
-"@ c #323231",
-"# c #888888",
-"$ c #1E1E1F",
-"% c #767677",
-"& c #494949",
-"* c #9E9E9C",
-"= c #111111",
-"- c #3C3C3D",
-"; c #6B6B6B",
-"> c #949494",
-", c #282828",
-"' c #808080",
-") c #545454",
-"! c #AEAEAC",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" .=.==.,@ ",
-" ==.,@-&&&)-= ",
-" .$@,&++;;;%>*- ",
-" $,-+)+++%%;;'#+. ",
-" =---+++++;%%%;%##@. ",
-" @)++++++++;%%%%'#%$ ",
-" $&++++++++++;%%;%##@= ",
-" ,-++++)+++++++;;;'#%) ",
-" @+++&&--&)++++;;%'#'-. ",
-" ,&++-@@,,,,-)++;;;'>'+, ",
-" =-++&@$@&&&&-&+;;;%##%+@ ",
-" =,)+)-,@@&+++++;;;;%##%&@ ",
-" @--&&,,@&)++++++;;;;'#)@ ",
-" ---&)-,@)+++++++;;;%''+, ",
-" $--&)+&$-+++++++;;;%%'';- ",
-" .,-&+++-$&++++++;;;%''%&= ",
-" $,-&)++)-@++++++;;%''%), ",
-" =,@&)++++&&+++++;%'''+$@&++++++ ",
-" .$@-++++++++++++;'#';,........=$@&++++ ",
-" =$@@&)+++++++++++'##-.................=&++ ",
-" .$$@-&)+++++++++;%#+$.....................=)+ ",
-" $$,@-)+++++++++;%;@=........................,+ ",
-" .$$@@-++++++++)-)@=............................ ",
-" $,@---)++++&)@===............................,. ",
-" $-@---&)))-$$=..............................=)!. ",
-" --&-&&,,$=,==...........................=&+++!. ",
-" =,=$..=$+)+++++&@$=.............=$@&+++++!++!. ",
-" .)-++-+++++++++++++++++++++++++++!++!++!. ",
-" .+-++-+++++++++++++++++++++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!+++!!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" .+-++-+++-+++++++++!++++!++++!+++!++!++!. ",
-" =+-++-+++-+++++++++!++++!++++!+++!++!+++= ",
-" $.++-+++-+++++++++!++++!++++!+++!++!+.$ ",
-" =.++++++++++++++!++++!++++!+++!++.= ",
-" $..+++++++++++++++!++++++...$ ",
-" $$==...........==$$ ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" "]
diff --git a/examples/simple/hello.py b/examples/simple/hello.py
deleted file mode 100755
index 79909b06..00000000
--- a/examples/simple/hello.py
+++ /dev/null
@@ -1,31 +0,0 @@
-#!/usr/bin/env python
-
-""" Simple Hello World example similar to the GTK+ Tutorials one """
-
-import gtk
-
-def hello(*args):
- """ Callback function that is attached to the button """
- print "Hello World"
- window.destroy()
-
-def destroy(*args):
- """ Callback function that is activated when the program is destoyed """
- window.hide()
- gtk.main_quit()
-
-# this block creates our main application window
-window = gtk.Window(gtk.WINDOW_TOPLEVEL)
-window.connect("destroy", destroy)
-window.set_border_width(10)
-
-# this block creates our button and places it within the window
-button = gtk.Button("Hello World")
-# connects the 'hello' function to the clicked signal from the button
-button.connect("clicked", hello)
-window.add(button)
-button.show()
-
-# as the button is within the window this also shows the window
-window.show_all()
-gtk.main()
diff --git a/examples/simple/scribble.py b/examples/simple/scribble.py
deleted file mode 100755
index 465effd2..00000000
--- a/examples/simple/scribble.py
+++ /dev/null
@@ -1,78 +0,0 @@
-#!/usr/bin/env python
-
-#this is a simple translation of the scribble example that comes with GTK+
-
-import gtk
-
-pixmap = None
-
-def configure_event(widget, event):
- global pixmap
- win = widget.window
- width, height = win.get_size()
- pixmap = gtk.gdk.Pixmap(win, width, height)
- pixmap.draw_rectangle(widget.get_style().white_gc, True,
- 0, 0, width, height)
- return True
-
-def expose_event(widget, event):
- x, y, width, height = event.area
- gc = widget.get_style().fg_gc[gtk.STATE_NORMAL]
- widget.window.draw_drawable(gc, pixmap, x, y, x, y, width, height)
- return False
-
-def draw_brush(widget, x, y):
- x, y = int(x), int(y)
- pixmap.draw_rectangle(widget.get_style().black_gc, True,
- x-5, y-5, 10, 10)
- widget.queue_draw()
-
-def button_press_event(widget, event):
- if event.button == 1 and pixmap != None:
- draw_brush(widget, event.x, event.y)
- return True
-
-def motion_notify_event(widget, event):
- if event.is_hint:
- x, y, state = event.window.get_pointer()
- else:
- x = event.x; y = event.y
- state = event.state
- if state & gtk.gdk.BUTTON1_MASK and pixmap != None:
- draw_brush(widget, x, y)
- return True
-
-def main():
- win = gtk.Window()
- win.set_name("Test Input")
- win.connect("destroy", lambda w: gtk.main_quit())
- win.set_border_width(5)
-
- vbox = gtk.VBox(spacing=3)
- win.add(vbox)
- vbox.show()
-
- drawing_area = gtk.DrawingArea()
- drawing_area.set_size_request(200, 200)
- vbox.pack_start(drawing_area)
- drawing_area.show()
-
- drawing_area.connect("expose_event", expose_event)
- drawing_area.connect("configure_event", configure_event)
- drawing_area.connect("motion_notify_event", motion_notify_event)
- drawing_area.connect("button_press_event", button_press_event)
- drawing_area.set_events(gtk.gdk.EXPOSURE_MASK |
- gtk.gdk.LEAVE_NOTIFY_MASK |
- gtk.gdk.BUTTON_PRESS_MASK |
- gtk.gdk.POINTER_MOTION_MASK |
- gtk.gdk.POINTER_MOTION_HINT_MASK)
-
- button = gtk.Button(stock=gtk.STOCK_QUIT)
- vbox.pack_start(button, expand=False, fill=False)
- button.connect("clicked", lambda widget, win=win: win.destroy())
- button.show()
- win.show()
- gtk.main()
-
-if __name__ == '__main__':
- main()
diff --git a/examples/simple/simple.py b/examples/simple/simple.py
deleted file mode 100755
index 97858301..00000000
--- a/examples/simple/simple.py
+++ /dev/null
@@ -1,29 +0,0 @@
-#!/usr/bin/env python
-
-# translation of the simple.c test in the gtk+ distribution, using the
-# new() function from gobject (this is an example of creating objects
-# with the properties interface).
-
-import gobject, gtk
-
-def hello(*args):
- print "Hello World"
- window.destroy()
-
-def destroy(*args):
- window.hide()
- gtk.main_quit()
-
-window = gobject.new(gtk.Window,
- type=gtk.WINDOW_TOPLEVEL,
- title='Hello World',
- allow_grow=False,
- allow_shrink=False,
- border_width=10)
-window.connect("destroy", destroy)
-
-button = gobject.new(gtk.Button, label="Hello World", parent=window)
-button.connect("clicked", hello)
-
-window.show_all()
-gtk.main()
diff --git a/examples/simple/tooltip.py b/examples/simple/tooltip.py
deleted file mode 100755
index 0ef1d2b8..00000000
--- a/examples/simple/tooltip.py
+++ /dev/null
@@ -1,43 +0,0 @@
-#!/usr/bin/env python
-
-""" Simple example of creating a basic window and button.
- Also adds a tooltip. """
-
-import gtk
-
-def hello_cb(widget, main_window):
- """ Callback function that prints a message and destroys the window """
- print "Hello World"
- main_window.destroy()
-
-def destroy_cb(widget, main_window):
- """ Callback function to hide the main window and then terminate. """
- main_window.hide()
- gtk.main_quit()
-
-def main():
- """ Sets up the application
- Forms the widgets and connects callback functions to the signals """
-
- window = gtk.Window( type=gtk.WINDOW_TOPLEVEL )
- window.set_title("Hello World")
- window.set_default_size(200, 200)
- window.set_border_width(10)
- window.connect("destroy", destroy_cb, window)
-
- button = gtk.Button(label="Hello World")
- window.add(button)
- button.connect("clicked", hello_cb, window)
-
- # setup tooltips and associate them with the button
- tt = gtk.Tooltips()
- tt.set_tip(button, 'Prints "Hello World"', None)
- tt.enable()
-
- # shows the window and any child objects (button in this example)
- window.show_all()
- gtk.main()
-
-# if we're being run normally then call the main function
-if __name__ == '__main__':
- main()
diff --git a/gtk/Makefile.am b/gtk/Makefile.am
deleted file mode 100644
index 2a5f19ec..00000000
--- a/gtk/Makefile.am
+++ /dev/null
@@ -1,191 +0,0 @@
-AUTOMAKE_OPTIONS = 1.7
-
-PLATFORM_VERSION = 2.0
-
-CLEANFILES =
-EXTRA_DIST =
-INCLUDES = \
- $(PYTHON_INCLUDES) \
- $(PYGOBJECT_CFLAGS) \
- -I$(srcdir)/gtk
-
-# defs files
-defsdir = $(pkgdatadir)/$(PLATFORM_VERSION)/defs
-defs_DATA =
-
-# python scripts & extension modules
-pkgpythondir = $(pyexecdir)/gtk-2.0
-pkgpyexecdir = $(pyexecdir)/gtk-2.0
-
-# gtk python extension modules
-pygtkexecdir = $(pkgpyexecdir)/gtk
-pygtkexec_LTLIBRARIES =
-
-# gtk python scripts
-pygtkdir = $(pkgpythondir)/gtk
-pygtk_PYTHON = \
- __init__.py \
- _lazyutils.py \
- compat.py \
- deprecation.py \
- keysyms.py
-
-# gtk headers
-pkgincludedir = $(includedir)/pygtk-$(PLATFORM_VERSION)/pygtk
-pkginclude_HEADERS = pygtk.h
-
-# linker flags
-common_ldflags = -module -avoid-version
-if PLATFORM_WIN32
-common_ldflags += -no-undefined
-endif
-
-# gtk module
-GTK_DEFS = gtk-base.defs
-GDK_DEFS = gdk-base.defs
-GTK_TYPES_DEFS = gtk-base-types.defs
-GDK_TYPES_DEFS = gdk-base-types.defs
-
-GTK_2_10_DEFS = gdk-2.10.defs gtk-2.10.defs gtk-2.10-types.defs
-
-if HAVE_GTK_2_10
-GDK_DEFS += gdk-2.10.defs
-GTK_DEFS += gtk-2.10.defs
-GTK_TYPES_DEFS += gtk-2.10-types.defs
-endif
-
-CREATEDEFS = $(PYTHON) $(top_srcdir)/codegen/createdefs.py
-
-GDK_OVERRIDES = \
- gdk.override \
- gdkcairo.override \
- gdkcolor.override \
- gdkdraw.override \
- gdkevent.override \
- gdkgc.override \
- gdkpixbuf.override \
- gdkrectangle.override \
- gdkwindow.override
-
-GTK_OVERRIDES = \
- gtk.override \
- gtkclist.override \
- gtkcontainer.override \
- gtkctree.override \
- gtkiconview.override \
- gtkstyle.override \
- gtktextview.override \
- gtktoolbar.override \
- gtktreeview.override \
- gtkwidget.override \
- gtkwindow.override
-
-CLEANFILES += \
- gtk.c \
- gdk.c \
- gtk.defs \
- gtk-types.defs \
- gdk.defs \
- gdk-types.defs
-
-EXTRA_DIST += \
- gtk-extrafuncs.defs \
- $(GDK_DEFS) \
- $(GDK_TYPES_DEFS) \
- $(GDK_OVERRIDES) \
- $(GTK_DEFS) \
- $(GTK_TYPES_DEFS) \
- $(GTK_2_10_DEFS) \
- $(GTK_OVERRIDES)
-
-
-gdk.defs: $(GDK_DEFS)
- $(CREATEDEFS) $@ $(GDK_DEFS)
-
-gtk.defs: $(GTK_DEFS)
- $(CREATEDEFS) $@ $(GTK_DEFS)
-
-gdk-types.defs: $(GDK_TYPES_DEFS)
- $(CREATEDEFS) $@ $(GDK_TYPES_DEFS)
-
-gtk-types.defs: $(GTK_TYPES_DEFS)
- $(CREATEDEFS) $@ $(GTK_TYPES_DEFS)
-
-gdk.c: gdk-types.defs gdk.defs $(GDK_OVERRIDES)
-gtk.c: gdk-types.defs gtk-types.defs gtk.defs gdk-types.defs $(GTK_OVERRIDES)
-_gtk_la_CFLAGS = $(PYCAIRO_CFLAGS) $(GTK_CFLAGS)
-_gtk_la_LDFLAGS = $(common_ldflags) -export-symbols-regex init_gtk
-_gtk_la_LIBADD = $(GTK_LIBS)
-_gtk_la_SOURCES = \
- gtk-types.c \
- gtkmodule.c \
- gtkobject-support.c \
- pygtk.h \
- pygtk-private.h \
- pygtkcellrenderer.h \
- pygtkcellrenderer.c \
- pygtktreemodel.h \
- pygtktreemodel.c
-nodist__gtk_la_SOURCES = gtk.c gdk.c
-if BUILD_GTK
-pygtkexec_LTLIBRARIES += _gtk.la
-defs_DATA += $(GDK_DEFS) $(GDK_TYPES_DEFS) $(GTK_DEFS) $(GTK_TYPES_DEFS) \
- gdk.defs gtk.defs gdk-types.defs gtk-types.defs
-endif
-
-# libglade module
-LIBGLADE_DEFS = libglade.defs
-CLEANFILES += libglade.c
-EXTRA_DIST += $(LIBGLADE_DEFS) libglade.override
-libglade.c: $(LIBGLADE_DEFS) libglade.override gdk-types.defs gtk-types.defs
-glade_la_CFLAGS = $(LIBGLADE_CFLAGS)
-glade_la_LIBADD = $(LIBGLADE_LIBS)
-glade_la_LDFLAGS = $(common_ldflags) -export-symbols-regex initglade
-glade_la_SOURCES = libglademodule.c
-nodist_glade_la_SOURCES = libglade.c
-if BUILD_LIBGLADE
-pygtkexec_LTLIBRARIES += glade.la
-defs_DATA += $(LIBGLADE_DEFS)
-endif
-
-# gtkunixprint module
-GTKUNIXPRINT_DEFS = gtkunixprint.defs
-CLEANFILES += gtkunixprint.c
-EXTRA_DIST += $(GTKUNIXPRINT_DEFS) gtkunixprint.override
-gtkunixprint.c: $(GTKUNIXPRINT_DEFS) gtkunixprint.override gdk-types.defs \
- gtk-types.defs
-gtkunixprint_la_CFLAGS = $(PYCAIRO_CFLAGS) $(GTKUNIXPRINT_CFLAGS)
-gtkunixprint_la_LIBADD = $(GTKUNIXPRINT_LIBS)
-gtkunixprint_la_LDFLAGS = $(common_ldflags) -export-symbols-regex initgtkunixprint
-gtkunixprint_la_SOURCES = gtkunixprintmodule.c
-nodist_gtkunixprint_la_SOURCES = gtkunixprint.c
-if BUILD_GTKUNIXPRINT
-pkgpyexec_LTLIBRARIES = gtkunixprint.la
-defs_DATA += $(GTKUNIXPRINT_DEFS)
-endif
-
-if PLATFORM_WIN32
-_gtk_la_CFLAGS += -DPLATFORM_WIN32
-endif
-
-
-.defs.c:
- ($(PYTHON) $(top_srcdir)/codegen/codegen.py \
- $(PYGTK_CODEGEN_DEFINES) \
- -I $(srcdir) \
- --py_ssize_t-clean \
- --register $(top_srcdir)/pango-types.defs \
- --register $(top_srcdir)/atk-types.defs \
- --register gdk-types.defs \
- --register gtk-types.defs \
- --override $(srcdir)/$*.override \
- --prefix py$* $<) > gen-$*.c \
- && cp gen-$*.c $*.c \
- && rm -f gen-$*.c
-
-# prevent the .defs.c rule from trying to generate gtk-types.c because
-# there is gtk-types.defs. This is basically a hack and I really wish I
-# could use pattern rules. Perhaps we should rename gtk-types.c.
-gtk-types.c:
- @:
-
diff --git a/gtk/__init__.py b/gtk/__init__.py
deleted file mode 100644
index 82348c39..00000000
--- a/gtk/__init__.py
+++ /dev/null
@@ -1,139 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-# pygtk - Python bindings for the GTK toolkit.
-# Copyright (C) 1998-2003 James Henstridge
-# 2004-2006 Johan Dahlin
-#
-# gtk/__init__.py: initialisation file for gtk package.
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-# USA
-
-import sys
-
-# this can go when things are a little further along
-try:
- import ltihooks
- # pyflakes
- ltihooks
-except ImportError:
- ltihooks = None
-
-# For broken embedded programs which forgot to call Sys_SetArgv
-if not hasattr(sys, 'argv'):
- sys.argv = []
-
-# load the required modules:
-import gobject as _gobject
-
-ver = getattr(_gobject, 'pygobject_version', ())
-if ver < (2, 11, 1):
- raise ImportError(
- "PyGTK requires PyGObject 2.11.1 or higher, but %s was found" % (ver,))
-
-if 'gtk._gtk' in sys.modules:
- _gtk = sys.modules['gtk._gtk']
-else:
- from gtk import _gtk
-
-import gdk
-
-if ltihooks:
- ltihooks.uninstall()
- del ltihooks
-
-from gtk._lazyutils import LazyNamespace, LazyModule
-from gtk.deprecation import _Deprecated, _DeprecatedConstant
-
-def _init():
- import sys
-
- try:
- sys_path = sys.path[:]
-
- try:
- _gtk.init_check()
- except RuntimeError, e:
- import warnings
- warnings.warn(str(e), _gtk.Warning)
- finally:
- # init_check calls PySys_SetArgv which calls sys.path.insert(0, ''),
- # which causes problems for pychecker, restore it if modified.
- if sys.path != sys_path:
- sys.path[:] = sys_path
-
- # install the default log handlers
- _gtk.add_log_handlers()
-
-keysyms = LazyModule('keysyms', locals())
-
-_init()
-
-# CAPI
-_PyGtk_API = _gtk._PyGtk_API
-
-gdk.INPUT_READ = _gobject.IO_IN | _gobject.IO_HUP | _gobject.IO_ERR
-gdk.INPUT_WRITE = _gobject.IO_OUT | _gobject.IO_HUP
-gdk.INPUT_EXCEPTION = _gobject.IO_PRI
-
-# old names compatibility ...
-idle_add = _Deprecated(_gobject, 'idle_add', 'idle_add', 'gobject')
-idle_remove = _Deprecated(_gobject, 'source_remove', 'idle_remove', 'gobject')
-timeout_add = _Deprecated(_gobject, 'timeout_add', 'timeout_add', 'gobject')
-timeout_remove = _Deprecated(_gobject, 'source_remove', 'timeout_remove',
- 'gobject')
-input_add = _Deprecated(_gobject, 'io_add_watch', 'input_add', 'gobject')
-input_add_full = _Deprecated(_gobject, 'io_add_watch', 'input_add_full',
- 'gobject')
-input_remove = _Deprecated(_gobject, 'source_remove', 'input_remove', 'gobject')
-
-mainloop = _Deprecated('gtk', 'main', 'mainloop')
-mainquit = _Deprecated('gtk', 'main_quit', 'mainquit')
-mainiteration = _Deprecated('gtk', 'main_iteration',
- 'mainiteration')
-load_font = _Deprecated(gdk, 'Font', 'load_font', 'gtk.gdk')
-load_fontset = _Deprecated(gdk, 'fontset_load', 'load_fontset',
- 'gtk.gdk')
-create_pixmap = _Deprecated(gdk, 'Pixmap', 'create_pixmap', 'gtk.gdk')
-create_pixmap_from_xpm = _Deprecated(gdk, 'pixmap_create_from_xpm',
- 'pixmap_create_from_xpm', 'gtk.gdk')
-create_pixmap_from_xpm_d = _Deprecated(gdk, 'pixmap_create_from_xpm_d',
- 'pixmap_create_from_xpm_d', 'gtk.gdk')
-
-threads_init = _Deprecated(gdk, 'threads_init', 'threads_init', 'gtk.gdk')
-threads_enter = _Deprecated(gdk, 'threads_enter', 'threads_enter', 'gtk.gdk')
-threads_leave = _Deprecated(gdk, 'threads_leave', 'threads_leave', 'gtk.gdk')
-
-TRUE = _DeprecatedConstant(True, 'gtk.TRUE', 'True')
-FALSE = _DeprecatedConstant(False, 'gtk.FALSE', 'False')
-
-# Can't figure out how to deprecate gdk.Warning
-gdk.Warning = Warning
-
-# We don't want to export this
-del _Deprecated, _DeprecatedConstant, _gobject, _init
-
-# Do this as late as possible, so programs like pyflakes can check
-# everything above
-from gtk._gtk import *
-
-# # For testing, so you can just turn of dynamicnamespace in gtk.override
-# if hasattr(_gtk, '_get_symbol_names'):
-# import gtk
-# ns = LazyNamespace(_gtk, locals())
-# ns.add_submodule('glade', '_glade')
-# ns.add_submodule('_gtk', 'gtk._gtk')
-# sys.modules['gtk'] = ns
-# sys.modules['gtk.glade'] = LazyModule('_glade', {})
-
diff --git a/gtk/_lazyutils.py b/gtk/_lazyutils.py
deleted file mode 100644
index 2a053134..00000000
--- a/gtk/_lazyutils.py
+++ /dev/null
@@ -1,84 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-# pygtk - Python bindings for the GTK toolkit.
-# Copyright (C) 2006 Johan Dahlin
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-# USA
-
-# Private to PyGTK, do not use in applications
-
-import sys
-from types import ModuleType
-
-class LazyModule(object):
- def __init__(self, name, locals):
- self._name = name
- self._locals = locals
- self._modname = '%s.%s' % (self._locals.get('__name__'), self._name)
-
- def __getattr__(self, attr):
- module = __import__(self._name, self._locals, {}, ' ')
- sys.modules[self._modname] = module
- if attr == '__members__':
- return dir(module)
- return getattr(module, attr)
-
-class _NotLoadedMarker:
- pass
-_marker = _NotLoadedMarker()
-
-class LazyDict(dict):
- def __init__(self, module):
- self._module = module
- dict.__init__(self)
-
- def __getitem__(self, name):
- print name
- return getattr(self._module, name)
-
-class LazyNamespace(ModuleType):
- def __init__(self, module, locals):
- ModuleType.__init__(self, locals['__name__'])
- self._imports = {}
-
- ns = self.__dict__
- ns.update(locals)
- ns['__module__'] = self
- lazy_symbols = {}
- for symbol in module._get_symbol_names():
- lazy_symbols[symbol] = ns[symbol] = _marker
-
- ns.update(__dict__=LazyDict(self),
- __bases__=(ModuleType,),
- add_submodule=self.add_submodule)
-
- def __getattribute__(_, name):
- v = ns.get(name, _marker)
- if v is not _marker:
- return v
- if name in lazy_symbols:
- s = module._get_symbol(ns, name)
- return s
- elif name in self._imports:
- m = __import__(self._imports[name], {}, {}, ' ')
- ns[name] = m
- return m
-
- raise AttributeError(name)
- LazyNamespace.__getattribute__ = __getattribute__
-
- def add_submodule(self, name, importname):
- self._imports[name] = importname
-
diff --git a/gtk/compat.py b/gtk/compat.py
deleted file mode 100644
index bbf2e350..00000000
--- a/gtk/compat.py
+++ /dev/null
@@ -1,71 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-# pygtk - Python bindings for the GTK+ widget set.
-# Copyright (C) 1998-2003 James Henstridge
-#
-# gtk/compat.py: half arsed compatibility code.
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-# USA
-
-__all__ = ['GTK', 'GDK', 'gtk']
-
-from types import ModuleType as module
-
-def _find_mod(modname):
- d = {}
- exec 'import %s; mod = %s' % (modname, modname) in d
- return d['mod']
-
-class RemapModule(module):
- def __init__(self, name, modulenames):
- module.__init__(self)
- self.__name__ = name
- if isinstance(modulenames, str):
- modulenames = [modulenames]
- self.__modulenames = modulenames
- self.__modules = None
- def __getattr__(self, attr):
- if not self.__modules:
- self.__modules = map(_find_mod, self.__modulenames)
- for mod in self.__modules:
- try:
- value = getattr(mod, attr)
- setattr(self, attr, value)
- return value
- except AttributeError:
- pass
- raise AttributeError("module has no attribute '%s'" % attr)
-
-GTK = RemapModule('GTK', 'gtk')
-GDK = RemapModule('GDK', ['gtk.gdk', 'gtk.keysyms'])
-
-class gtkModule(RemapModule):
- def __init__(self):
- RemapModule('gtk', ['gtk', 'gtk.gdk'])
- self.__name__ = 'gtk'
- def __getattr__(self, attr):
- if attr[:3] == 'Gtk':
- value = getattr(_find_mod('gtk'), attr[3:])
- setattr(self, attr, value)
- return value
- elif attr[:3] == 'Gdk':
- value = getattr(_find_mod('gtk.gdk'), attr[3:])
- setattr(self, attr, value)
- return value
- else:
- return RemapModule.__getattr__(self, attr)
-
-gtk = gtkModule()
-
diff --git a/gtk/deprecation.py b/gtk/deprecation.py
deleted file mode 100644
index 38918268..00000000
--- a/gtk/deprecation.py
+++ /dev/null
@@ -1,83 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-# pygtk - Python bindings for the GTK toolkit.
-# Copyright (C) 2004-2006 Johan Dahlin
-#
-# gtk/deprecation.py: deprecation helpers for gtk
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-# USA
-
-import os
-import sys
-import warnings
-
-from gtk._gtk import DeprecationWarning
-
-def _is_pydoc():
- if sys.argv:
- name = os.path.basename(sys.argv[0])
- if 'pydoc' in name:
- return True
-
- return False
-
-class _Deprecated:
- def __init__(self, module, funcname, oldname, modulename=''):
- self.module = module
- self.funcname = funcname
- self.oldname = oldname
- if modulename:
- self.modulename = modulename
- else:
- self.modulename = 'gtk'
-
- def __repr__(self):
- return '<deprecated function %s>' % (self.oldname)
-
- def __call__(self, *args, **kwargs):
- if type(self.module) == str:
- module = __import__(self.module, {}, {}, ' ')
- else:
- module = self.module
- func = getattr(module, self.funcname)
- if not _is_pydoc():
- message = 'gtk.%s is deprecated, use %s.%s instead' % (
- self.oldname, self.modulename, func.__name__)
- # DeprecationWarning is imported from _gtk, so it's not the same
- # as the one found in exceptions.
- warnings.warn(message, DeprecationWarning, 2)
- try:
- return func(*args, **kwargs)
- except TypeError, e:
- raise TypeError(str(e).replace(func.__name__, self.oldname))
-
-class _DeprecatedConstant:
- def __init__(self, value, name, suggestion):
- self._v = value
- self._name = name
- self._suggestion = suggestion
-
- def _deprecated(self, value):
- if not _is_pydoc():
- message = '%s is deprecated, use %s instead' % (self._name,
- self._suggestion)
- warnings.warn(message, DeprecationWarning, 3)
- return value
-
- __nonzero__ = lambda self: self._deprecated(self._v == True)
- __int__ = lambda self: self._deprecated(int(self._v))
- __str__ = lambda self: self._deprecated(str(self._v))
- __repr__ = lambda self: self._deprecated(repr(self._v))
- __cmp__ = lambda self, other: self._deprecated(cmp(self._v, other))
diff --git a/gtk/gdk-2.10.defs b/gtk/gdk-2.10.defs
deleted file mode 100644
index 5ddaa488..00000000
--- a/gtk/gdk-2.10.defs
+++ /dev/null
@@ -1,260 +0,0 @@
-;; From gdkalias.h
-
-
-
-;; From gdkcairo.h
-
-(define-function cairo_set_source_pixmap
- (c-name "gdk_cairo_set_source_pixmap")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("GdkPixmap*" "pixmap")
- '("double" "pixmap_x")
- '("double" "pixmap_y")
- )
-)
-
-
-
-;; From gdkcolor.h
-
-
-
-;; From gdkcursor.h
-
-
-
-;; From gdkdisplay.h
-
-(define-method supports_shapes
- (of-object "GdkDisplay")
- (c-name "gdk_display_supports_shapes")
- (return-type "gboolean")
-)
-
-(define-method supports_input_shapes
- (of-object "GdkDisplay")
- (c-name "gdk_display_supports_input_shapes")
- (return-type "gboolean")
-)
-
-
-
-;; From gdkdisplaymanager.h
-
-
-
-;; From gdkdnd.h
-
-
-
-;; From gdkdrawable.h
-
-
-
-;; From gdkenumtypes.h
-
-
-
-;; From gdkevents.h
-
-
-
-;; From gdkfont.h
-
-
-
-;; From gdkgc.h
-
-
-
-;; From gdk.h
-
-
-
-;; From gdki18n.h
-
-
-
-;; From gdkimage.h
-
-
-
-;; From gdkinput.h
-
-
-
-;; From gdkkeys.h
-
-
-
-;; From gdkkeysyms.h
-
-
-
-;; From gdkpango.h
-
-
-
-;; From gdkpixbuf.h
-
-
-
-;; From gdkpixmap.h
-
-(define-function pixmap_foreign_new_for_screen
- (c-name "gdk_pixmap_foreign_new_for_screen")
- (return-type "GdkPixmap*")
- (parameters
- '("GdkScreen*" "screen")
- '("GdkNativeWindow" "anid")
- '("gint" "width")
- '("gint" "height")
- '("gint" "depth")
- )
-)
-
-
-
-;; From gdkprivate.h
-
-
-
-;; From gdkproperty.h
-
-(define-function atom_intern_static_string
- (c-name "gdk_atom_intern_static_string")
- (return-type "GdkAtom")
- (parameters
- '("const-gchar*" "atom_name")
- )
-)
-
-
-
-;; From gdkregion.h
-
-
-
-;; From gdkrgb.h
-
-
-
-;; From gdkscreen.h
-
-(define-method is_composited
- (of-object "GdkScreen")
- (c-name "gdk_screen_is_composited")
- (return-type "gboolean")
-)
-
-(define-method set_font_options
- (of-object "GdkScreen")
- (c-name "gdk_screen_set_font_options")
- (return-type "none")
- (parameters
- '("const-cairo_font_options_t*" "options")
- )
-)
-
-(define-method get_font_options
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_font_options")
- (return-type "const-cairo_font_options_t*")
-)
-
-(define-method set_resolution
- (of-object "GdkScreen")
- (c-name "gdk_screen_set_resolution")
- (return-type "none")
- (parameters
- '("gdouble" "dpi")
- )
-)
-
-(define-method get_resolution
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_resolution")
- (return-type "gdouble")
-)
-
-(define-method get_active_window
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_active_window")
- (return-type "GdkWindow*")
-)
-
-(define-method get_window_stack
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_window_stack")
- (return-type "GList*")
-)
-
-(define-virtual composited_changed
- (of-object "GdkScreen")
- (return-type "none")
-)
-
-
-
-;; From gdkselection.h
-
-
-
-;; From gdkspawn.h
-
-
-
-;; From gdktypes.h
-
-
-
-;; From gdkvisual.h
-
-
-
-;; From gdkwindow.h
-
-(define-method input_shape_combine_mask
- (of-object "GdkWindow")
- (c-name "gdk_window_input_shape_combine_mask")
- (return-type "none")
- (parameters
- '("GdkBitmap*" "mask")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method input_shape_combine_region
- (of-object "GdkWindow")
- (c-name "gdk_window_input_shape_combine_region")
- (return-type "none")
- (parameters
- '("GdkRegion*" "shape_region")
- '("gint" "offset_x")
- '("gint" "offset_y")
- )
-)
-
-(define-method set_child_input_shapes
- (of-object "GdkWindow")
- (c-name "gdk_window_set_child_input_shapes")
- (return-type "none")
-)
-
-(define-method merge_child_input_shapes
- (of-object "GdkWindow")
- (c-name "gdk_window_merge_child_input_shapes")
- (return-type "none")
-)
-
-(define-method get_type_hint
- (of-object "GdkWindow")
- (c-name "gdk_window_get_type_hint")
- (return-type "GdkWindowTypeHint")
-)
-
-
-
diff --git a/gtk/gdk-base-types.defs b/gtk/gdk-base-types.defs
deleted file mode 100644
index 59776fbf..00000000
--- a/gtk/gdk-base-types.defs
+++ /dev/null
@@ -1,989 +0,0 @@
-;; -*- scheme -*-
-; object definitions ...
-(define-object Colormap
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkColormap")
- (gtype-id "GDK_TYPE_COLORMAP")
-)
-
-(define-object Device
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkDevice")
- (gtype-id "GDK_TYPE_DEVICE")
- (fields
- '("gchar*" "name")
- '("GdkInputSource" "source")
- '("GdkInputMode" "mode")
- '("gboolean" "has_cursor")
- '("gint" "num_axes")
- '("GdkDeviceAxis*" "axes")
- '("gint" "num_keys")
- '("GdkDeviceKey*" "keys")
- )
-)
-
-(define-object Display
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkDisplay")
- (gtype-id "GDK_TYPE_DISPLAY")
-)
-
-(define-object DisplayManager
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkDisplayManager")
- (gtype-id "GDK_TYPE_DISPLAY_MANAGER")
-)
-
-(define-object DragContext
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkDragContext")
- (gtype-id "GDK_TYPE_DRAG_CONTEXT")
- (fields
- '("GdkDragProtocol" "protocol")
- '("gboolean" "is_source")
- '("GdkWindow*" "source_window")
- '("GdkWindow*" "dest_window")
- '("GList*" "targets")
- '("GdkDragAction" "actions")
- '("GdkDragAction" "suggested_action")
- '("GdkDragAction" "action")
- '("guint32" "start_time")
- )
-)
-
-(define-object Drawable
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkDrawable")
- (gtype-id "GDK_TYPE_DRAWABLE")
- (fields
- '("guint32" "xid")
- '("gulong*" "handle")
- )
-)
-
-(define-object Window
- (in-module "Gdk")
- (parent "GdkDrawable")
- (c-name "GdkWindow")
- (gtype-id "GDK_TYPE_WINDOW")
-)
-
-(define-object PangoRenderer
- (in-module "Gdk")
- (parent "PangoRenderer")
- (c-name "GdkPangoRenderer")
- (gtype-id "GDK_TYPE_PANGO_RENDERER")
-)
-
-(define-object Pixmap
- (in-module "Gdk")
- (parent "GdkDrawable")
- (c-name "GdkPixmap")
- (gtype-id "GDK_TYPE_PIXMAP")
-)
-
-(define-object GC
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkGC")
- (gtype-id "GDK_TYPE_GC")
-)
-
-(define-object Image
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkImage")
- (gtype-id "GDK_TYPE_IMAGE")
-)
-
-(define-object Keymap
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkKeymap")
- (gtype-id "GDK_TYPE_KEYMAP")
-)
-
-(define-object Pixbuf
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkPixbuf")
- (gtype-id "GDK_TYPE_PIXBUF")
- (fields
-; XXXX this next one isn't a real field. added for Python bindings
- '("guchar*" "pixel_array")
- )
-)
-
-(define-object PixbufAnimation
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkPixbufAnimation")
- (gtype-id "GDK_TYPE_PIXBUF_ANIMATION")
-)
-
-(define-object PixbufAnimationIter
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkPixbufAnimationIter")
- (gtype-id "GDK_TYPE_PIXBUF_ANIMATION_ITER")
-)
-
-(define-object PixbufLoader
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkPixbufLoader")
- (gtype-id "GDK_TYPE_PIXBUF_LOADER")
-)
-
-(define-object PixbufSimpleAnim
- (in-module "Gdk")
- (parent "GdkPixbufAnimation")
- (c-name "GdkPixbufSimpleAnim")
- (gtype-id "GDK_TYPE_PIXBUF_SIMPLE_ANIM")
-)
-
-(define-object PixbufSimpleAnimIter
- (in-module "Gdk")
- (parent "GdkPixbufAnimationIter")
- (c-name "GdkPixbufSimpleAnimIter")
- (gtype-id "GDK_TYPE_PIXBUF_SIMPLE_ANIM_ITER")
-)
-
-
-(define-object Screen
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkScreen")
- (gtype-id "GDK_TYPE_SCREEN")
-)
-
-(define-object Visual
- (in-module "Gdk")
- (parent "GObject")
- (c-name "GdkVisual")
- (gtype-id "GDK_TYPE_VISUAL")
- (fields
- '("GdkVisualType" "type")
- '("gint" "depth")
- '("GdkByteOrder" "byte_order")
- '("gint" "colormap_size")
- '("gint" "bits_per_rgb")
- '("guint32" "red_mask")
- '("gint" "red_shift")
- '("gint" "red_prec")
- '("guint32" "green_mask")
- '("gint" "green_shift")
- '("gint" "green_prec")
- '("guint32" "blue_mask")
- '("gint" "blue_shift")
- '("gint" "blue_prec")
- )
-)
-
-
-;; Boxed types ...
-
-(define-boxed Event
- (in-module "Gdk")
- (c-name "GdkEvent")
- (gtype-id "GDK_TYPE_EVENT")
- (copy-func "gdk_event_copy")
- (release-func "gdk_event_free")
-)
-
-(define-boxed Font
- (in-module "Gdk")
- (c-name "GdkFont")
- (gtype-id "GDK_TYPE_FONT")
- (copy-func "gdk_font_ref")
- (release-func "gdk_font_unref")
- (fields
- '("GdkFontType" "type")
- '("gint" "ascent")
- '("gint" "descent")
- )
-)
-
-(define-boxed Color
- (in-module "Gdk")
- (c-name "GdkColor")
- (gtype-id "GDK_TYPE_COLOR")
- (copy-func "gdk_color_copy")
- (release-func "gdk_color_free")
- (fields
- '("guint32" "pixel")
- '("guint16" "red")
- '("guint16" "green")
- '("guint16" "blue")
- )
-)
-
-(define-boxed Cursor
- (in-module "Gdk")
- (c-name "GdkCursor")
- (gtype-id "GDK_TYPE_CURSOR")
- (copy-func "gdk_cursor_ref")
- (release-func "gdk_cursor_unref")
- (fields
- '("GdkCursorType" "type")
- )
-)
-
-(define-boxed Rectangle
- (in-module "Gdk")
- (c-name "GdkRectangle")
- (gtype-id "GDK_TYPE_RECTANGLE")
- (fields
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-boxed Region
- (in-module "Gdk")
- (c-name "GdkRegion")
- (gtype-id "PYGDK_TYPE_REGION")
-)
-
-;; Enumerations and flags ...
-
-(define-enum CursorType
- (in-module "Gdk")
- (c-name "GdkCursorType")
- (gtype-id "GDK_TYPE_CURSOR_TYPE")
-; (value (name #include) (c-name #include))
- (values
- '("gdk-cursor-is-pixmap" "GDK_CURSOR_IS_PIXMAP")
- )
-)
-
-(define-flags DragAction
- (in-module "Gdk")
- (c-name "GdkDragAction")
- (gtype-id "GDK_TYPE_DRAG_ACTION")
- (values
- '("default" "GDK_ACTION_DEFAULT")
- '("copy" "GDK_ACTION_COPY")
- '("move" "GDK_ACTION_MOVE")
- '("link" "GDK_ACTION_LINK")
- '("private" "GDK_ACTION_PRIVATE")
- '("ask" "GDK_ACTION_ASK")
- )
-)
-
-(define-enum DragProtocol
- (in-module "Gdk")
- (c-name "GdkDragProtocol")
- (gtype-id "GDK_TYPE_DRAG_PROTOCOL")
- (values
- '("motif" "GDK_DRAG_PROTO_MOTIF")
- '("xdnd" "GDK_DRAG_PROTO_XDND")
- '("rootwin" "GDK_DRAG_PROTO_ROOTWIN")
- '("none" "GDK_DRAG_PROTO_NONE")
- '("win32-dropfiles" "GDK_DRAG_PROTO_WIN32_DROPFILES")
- '("ole2" "GDK_DRAG_PROTO_OLE2")
- '("local" "GDK_DRAG_PROTO_LOCAL")
- )
-)
-
-(define-enum FilterReturn
- (in-module "Gdk")
- (c-name "GdkFilterReturn")
- (gtype-id "GDK_TYPE_FILTER_RETURN")
- (values
- '("continue" "GDK_FILTER_CONTINUE")
- '("translate" "GDK_FILTER_TRANSLATE")
- '("remove" "GDK_FILTER_REMOVE")
- )
-)
-
-(define-enum EventType
- (in-module "Gdk")
- (c-name "GdkEventType")
- (gtype-id "GDK_TYPE_EVENT_TYPE")
- (values
- '("nothing" "GDK_NOTHING")
- '("delete" "GDK_DELETE")
- '("destroy" "GDK_DESTROY")
- '("expose" "GDK_EXPOSE")
- '("motion-notify" "GDK_MOTION_NOTIFY")
- '("button-press" "GDK_BUTTON_PRESS")
- '("2button-press" "GDK_2BUTTON_PRESS")
- '("3button-press" "GDK_3BUTTON_PRESS")
- '("button-release" "GDK_BUTTON_RELEASE")
- '("key-press" "GDK_KEY_PRESS")
- '("key-release" "GDK_KEY_RELEASE")
- '("enter-notify" "GDK_ENTER_NOTIFY")
- '("leave-notify" "GDK_LEAVE_NOTIFY")
- '("focus-change" "GDK_FOCUS_CHANGE")
- '("configure" "GDK_CONFIGURE")
- '("map" "GDK_MAP")
- '("unmap" "GDK_UNMAP")
- '("property-notify" "GDK_PROPERTY_NOTIFY")
- '("selection-clear" "GDK_SELECTION_CLEAR")
- '("selection-request" "GDK_SELECTION_REQUEST")
- '("selection-notify" "GDK_SELECTION_NOTIFY")
- '("proximity-in" "GDK_PROXIMITY_IN")
- '("proximity-out" "GDK_PROXIMITY_OUT")
- '("drag-enter" "GDK_DRAG_ENTER")
- '("drag-leave" "GDK_DRAG_LEAVE")
- '("drag-motion" "GDK_DRAG_MOTION")
- '("drag-status" "GDK_DRAG_STATUS")
- '("drop-start" "GDK_DROP_START")
- '("drop-finished" "GDK_DROP_FINISHED")
- '("client-event" "GDK_CLIENT_EVENT")
- '("visibility-notify" "GDK_VISIBILITY_NOTIFY")
- '("no-expose" "GDK_NO_EXPOSE")
- '("scroll" "GDK_SCROLL")
- '("window-state" "GDK_WINDOW_STATE")
- '("setting" "GDK_SETTING")
- )
-)
-
-(define-flags EventMask
- (in-module "Gdk")
- (c-name "GdkEventMask")
- (gtype-id "GDK_TYPE_EVENT_MASK")
- (values
- '("exposure-mask" "GDK_EXPOSURE_MASK")
- '("pointer-motion-mask" "GDK_POINTER_MOTION_MASK")
- '("pointer-motion-hint-mask" "GDK_POINTER_MOTION_HINT_MASK")
- '("button-motion-mask" "GDK_BUTTON_MOTION_MASK")
- '("button1-motion-mask" "GDK_BUTTON1_MOTION_MASK")
- '("button2-motion-mask" "GDK_BUTTON2_MOTION_MASK")
- '("button3-motion-mask" "GDK_BUTTON3_MOTION_MASK")
- '("button-press-mask" "GDK_BUTTON_PRESS_MASK")
- '("button-release-mask" "GDK_BUTTON_RELEASE_MASK")
- '("key-press-mask" "GDK_KEY_PRESS_MASK")
- '("key-release-mask" "GDK_KEY_RELEASE_MASK")
- '("enter-notify-mask" "GDK_ENTER_NOTIFY_MASK")
- '("leave-notify-mask" "GDK_LEAVE_NOTIFY_MASK")
- '("focus-change-mask" "GDK_FOCUS_CHANGE_MASK")
- '("structure-mask" "GDK_STRUCTURE_MASK")
- '("property-change-mask" "GDK_PROPERTY_CHANGE_MASK")
- '("visibility-notify-mask" "GDK_VISIBILITY_NOTIFY_MASK")
- '("proximity-in-mask" "GDK_PROXIMITY_IN_MASK")
- '("proximity-out-mask" "GDK_PROXIMITY_OUT_MASK")
- '("substructure-mask" "GDK_SUBSTRUCTURE_MASK")
- '("scroll-mask" "GDK_SCROLL_MASK")
- '("all-events-mask" "GDK_ALL_EVENTS_MASK")
- )
-)
-
-(define-enum VisibilityState
- (in-module "Gdk")
- (c-name "GdkVisibilityState")
- (gtype-id "GDK_TYPE_VISIBILITY_STATE")
- (values
- '("unobscured" "GDK_VISIBILITY_UNOBSCURED")
- '("partial" "GDK_VISIBILITY_PARTIAL")
- '("fully-obscured" "GDK_VISIBILITY_FULLY_OBSCURED")
- )
-)
-
-(define-enum ScrollDirection
- (in-module "Gdk")
- (c-name "GdkScrollDirection")
- (gtype-id "GDK_TYPE_SCROLL_DIRECTION")
- (values
- '("up" "GDK_SCROLL_UP")
- '("down" "GDK_SCROLL_DOWN")
- '("left" "GDK_SCROLL_LEFT")
- '("right" "GDK_SCROLL_RIGHT")
- )
-)
-
-(define-enum NotifyType
- (in-module "Gdk")
- (c-name "GdkNotifyType")
- (gtype-id "GDK_TYPE_NOTIFY_TYPE")
- (values
- '("ancestor" "GDK_NOTIFY_ANCESTOR")
- '("virtual" "GDK_NOTIFY_VIRTUAL")
- '("inferior" "GDK_NOTIFY_INFERIOR")
- '("nonlinear" "GDK_NOTIFY_NONLINEAR")
- '("nonlinear-virtual" "GDK_NOTIFY_NONLINEAR_VIRTUAL")
- '("unknown" "GDK_NOTIFY_UNKNOWN")
- )
-)
-
-(define-enum CrossingMode
- (in-module "Gdk")
- (c-name "GdkCrossingMode")
- (gtype-id "GDK_TYPE_CROSSING_MODE")
- (values
- '("normal" "GDK_CROSSING_NORMAL")
- '("grab" "GDK_CROSSING_GRAB")
- '("ungrab" "GDK_CROSSING_UNGRAB")
- )
-)
-
-(define-enum PropertyState
- (in-module "Gdk")
- (c-name "GdkPropertyState")
- (gtype-id "GDK_TYPE_PROPERTY_STATE")
- (values
- '("new-value" "GDK_PROPERTY_NEW_VALUE")
- '("delete" "GDK_PROPERTY_DELETE")
- )
-)
-
-(define-flags WindowState
- (in-module "Gdk")
- (c-name "GdkWindowState")
- (gtype-id "GDK_TYPE_WINDOW_STATE")
- (values
- '("withdrawn" "GDK_WINDOW_STATE_WITHDRAWN")
- '("iconified" "GDK_WINDOW_STATE_ICONIFIED")
- '("maximized" "GDK_WINDOW_STATE_MAXIMIZED")
- '("sticky" "GDK_WINDOW_STATE_STICKY")
- '("fullscreen" "GDK_WINDOW_STATE_FULLSCREEN")
- '("above" "GDK_WINDOW_STATE_ABOVE")
- '("below" "GDK_WINDOW_STATE_BELOW")
- )
-)
-
-(define-enum SettingAction
- (in-module "Gdk")
- (c-name "GdkSettingAction")
- (gtype-id "GDK_TYPE_SETTING_ACTION")
- (values
- '("new" "GDK_SETTING_ACTION_NEW")
- '("changed" "GDK_SETTING_ACTION_CHANGED")
- '("deleted" "GDK_SETTING_ACTION_DELETED")
- )
-)
-
-(define-enum FontType
- (in-module "Gdk")
- (c-name "GdkFontType")
- (gtype-id "GDK_TYPE_FONT_TYPE")
- (values
- '("font" "GDK_FONT_FONT")
- '("fontset" "GDK_FONT_FONTSET")
- )
-)
-
-(define-enum CapStyle
- (in-module "Gdk")
- (c-name "GdkCapStyle")
- (gtype-id "GDK_TYPE_CAP_STYLE")
- (values
- '("not-last" "GDK_CAP_NOT_LAST")
- '("butt" "GDK_CAP_BUTT")
- '("round" "GDK_CAP_ROUND")
- '("projecting" "GDK_CAP_PROJECTING")
- )
-)
-
-(define-enum Fill
- (in-module "Gdk")
- (c-name "GdkFill")
- (gtype-id "GDK_TYPE_FILL")
- (values
- '("solid" "GDK_SOLID")
- '("tiled" "GDK_TILED")
- '("stippled" "GDK_STIPPLED")
- '("opaque-stippled" "GDK_OPAQUE_STIPPLED")
- )
-)
-
-(define-enum Function
- (in-module "Gdk")
- (c-name "GdkFunction")
- (gtype-id "GDK_TYPE_FUNCTION")
- (values
- '("copy" "GDK_COPY")
- '("invert" "GDK_INVERT")
- '("xor" "GDK_XOR")
- '("clear" "GDK_CLEAR")
- '("and" "GDK_AND")
- '("and-reverse" "GDK_AND_REVERSE")
- '("and-invert" "GDK_AND_INVERT")
- '("noop" "GDK_NOOP")
- '("or" "GDK_OR")
- '("equiv" "GDK_EQUIV")
- '("or-reverse" "GDK_OR_REVERSE")
- '("copy-invert" "GDK_COPY_INVERT")
- '("or-invert" "GDK_OR_INVERT")
- '("nand" "GDK_NAND")
- '("nor" "GDK_NOR")
- '("set" "GDK_SET")
- )
-)
-
-(define-enum JoinStyle
- (in-module "Gdk")
- (c-name "GdkJoinStyle")
- (gtype-id "GDK_TYPE_JOIN_STYLE")
- (values
- '("miter" "GDK_JOIN_MITER")
- '("round" "GDK_JOIN_ROUND")
- '("bevel" "GDK_JOIN_BEVEL")
- )
-)
-
-(define-enum LineStyle
- (in-module "Gdk")
- (c-name "GdkLineStyle")
- (gtype-id "GDK_TYPE_LINE_STYLE")
- (values
- '("solid" "GDK_LINE_SOLID")
- '("on-off-dash" "GDK_LINE_ON_OFF_DASH")
- '("double-dash" "GDK_LINE_DOUBLE_DASH")
- )
-)
-
-(define-enum SubwindowMode
- (in-module "Gdk")
- (c-name "GdkSubwindowMode")
- (gtype-id "GDK_TYPE_SUBWINDOW_MODE")
- (values
- '("clip-by-children" "GDK_CLIP_BY_CHILDREN")
- '("include-inferiors" "GDK_INCLUDE_INFERIORS")
- )
-)
-
-(define-flags GCValuesMask
- (in-module "Gdk")
- (c-name "GdkGCValuesMask")
- (gtype-id "GDK_TYPE_GC_VALUES_MASK")
- (values
- '("foreground" "GDK_GC_FOREGROUND")
- '("background" "GDK_GC_BACKGROUND")
- '("font" "GDK_GC_FONT")
- '("function" "GDK_GC_FUNCTION")
- '("fill" "GDK_GC_FILL")
- '("tile" "GDK_GC_TILE")
- '("stipple" "GDK_GC_STIPPLE")
- '("clip-mask" "GDK_GC_CLIP_MASK")
- '("subwindow" "GDK_GC_SUBWINDOW")
- '("ts-x-origin" "GDK_GC_TS_X_ORIGIN")
- '("ts-y-origin" "GDK_GC_TS_Y_ORIGIN")
- '("clip-x-origin" "GDK_GC_CLIP_X_ORIGIN")
- '("clip-y-origin" "GDK_GC_CLIP_Y_ORIGIN")
- '("exposures" "GDK_GC_EXPOSURES")
- '("line-width" "GDK_GC_LINE_WIDTH")
- '("line-style" "GDK_GC_LINE_STYLE")
- '("cap-style" "GDK_GC_CAP_STYLE")
- '("join-style" "GDK_GC_JOIN_STYLE")
- )
-)
-
-(define-enum ImageType
- (in-module "Gdk")
- (c-name "GdkImageType")
- (gtype-id "GDK_TYPE_IMAGE_TYPE")
- (values
- '("normal" "GDK_IMAGE_NORMAL")
- '("shared" "GDK_IMAGE_SHARED")
- '("fastest" "GDK_IMAGE_FASTEST")
- )
-)
-
-(define-enum ExtensionMode
- (in-module "Gdk")
- (c-name "GdkExtensionMode")
- (gtype-id "GDK_TYPE_EXTENSION_MODE")
- (values
- '("none" "GDK_EXTENSION_EVENTS_NONE")
- '("all" "GDK_EXTENSION_EVENTS_ALL")
- '("cursor" "GDK_EXTENSION_EVENTS_CURSOR")
- )
-)
-
-(define-enum InputSource
- (in-module "Gdk")
- (c-name "GdkInputSource")
- (gtype-id "GDK_TYPE_INPUT_SOURCE")
- (values
- '("mouse" "GDK_SOURCE_MOUSE")
- '("pen" "GDK_SOURCE_PEN")
- '("eraser" "GDK_SOURCE_ERASER")
- '("cursor" "GDK_SOURCE_CURSOR")
- )
-)
-
-(define-enum InputMode
- (in-module "Gdk")
- (c-name "GdkInputMode")
- (gtype-id "GDK_TYPE_INPUT_MODE")
- (values
- '("disabled" "GDK_MODE_DISABLED")
- '("screen" "GDK_MODE_SCREEN")
- '("window" "GDK_MODE_WINDOW")
- )
-)
-
-(define-enum AxisUse
- (in-module "Gdk")
- (c-name "GdkAxisUse")
- (gtype-id "GDK_TYPE_AXIS_USE")
- (values
- '("ignore" "GDK_AXIS_IGNORE")
- '("x" "GDK_AXIS_X")
- '("y" "GDK_AXIS_Y")
- '("pressure" "GDK_AXIS_PRESSURE")
- '("xtilt" "GDK_AXIS_XTILT")
- '("ytilt" "GDK_AXIS_YTILT")
- '("wheel" "GDK_AXIS_WHEEL")
- '("last" "GDK_AXIS_LAST")
- )
-)
-
-(define-enum PropMode
- (in-module "Gdk")
- (c-name "GdkPropMode")
- (gtype-id "GDK_TYPE_PROP_MODE")
- (values
- '("replace" "GDK_PROP_MODE_REPLACE")
- '("prepend" "GDK_PROP_MODE_PREPEND")
- '("append" "GDK_PROP_MODE_APPEND")
- )
-)
-
-(define-enum FillRule
- (in-module "Gdk")
- (c-name "GdkFillRule")
- (gtype-id "GDK_TYPE_FILL_RULE")
- (values
- '("even-odd-rule" "GDK_EVEN_ODD_RULE")
- '("winding-rule" "GDK_WINDING_RULE")
- )
-)
-
-(define-enum OverlapType
- (in-module "Gdk")
- (c-name "GdkOverlapType")
- (gtype-id "GDK_TYPE_OVERLAP_TYPE")
- (values
- '("in" "GDK_OVERLAP_RECTANGLE_IN")
- '("out" "GDK_OVERLAP_RECTANGLE_OUT")
- '("part" "GDK_OVERLAP_RECTANGLE_PART")
- )
-)
-
-(define-enum RgbDither
- (in-module "Gdk")
- (c-name "GdkRgbDither")
- (gtype-id "GDK_TYPE_RGB_DITHER")
- (values
- '("none" "GDK_RGB_DITHER_NONE")
- '("normal" "GDK_RGB_DITHER_NORMAL")
- '("max" "GDK_RGB_DITHER_MAX")
- )
-)
-
-(define-enum ByteOrder
- (in-module "Gdk")
- (c-name "GdkByteOrder")
- (gtype-id "GDK_TYPE_BYTE_ORDER")
- (values
- '("lsb-first" "GDK_LSB_FIRST")
- '("msb-first" "GDK_MSB_FIRST")
- )
-)
-
-(define-flags ModifierType
- (in-module "Gdk")
- (c-name "GdkModifierType")
- (gtype-id "GDK_TYPE_MODIFIER_TYPE")
- (values
- '("shift-mask" "GDK_SHIFT_MASK")
- '("lock-mask" "GDK_LOCK_MASK")
- '("control-mask" "GDK_CONTROL_MASK")
- '("mod1-mask" "GDK_MOD1_MASK")
- '("mod2-mask" "GDK_MOD2_MASK")
- '("mod3-mask" "GDK_MOD3_MASK")
- '("mod4-mask" "GDK_MOD4_MASK")
- '("mod5-mask" "GDK_MOD5_MASK")
- '("button1-mask" "GDK_BUTTON1_MASK")
- '("button2-mask" "GDK_BUTTON2_MASK")
- '("button3-mask" "GDK_BUTTON3_MASK")
- '("button4-mask" "GDK_BUTTON4_MASK")
- '("button5-mask" "GDK_BUTTON5_MASK")
- '("release-mask" "GDK_RELEASE_MASK")
- '("modifier-mask" "GDK_MODIFIER_MASK")
- )
-)
-
-(define-flags InputCondition
- (in-module "Gdk")
- (c-name "GdkInputCondition")
- (gtype-id "GDK_TYPE_INPUT_CONDITION")
- (values
- '("read" "GDK_INPUT_READ")
- '("write" "GDK_INPUT_WRITE")
- '("exception" "GDK_INPUT_EXCEPTION")
- )
-)
-
-(define-enum Status
- (in-module "Gdk")
- (c-name "GdkStatus")
- (gtype-id "GDK_TYPE_STATUS")
- (values
- '("ok" "GDK_OK")
- '("error" "GDK_ERROR")
- '("error-param" "GDK_ERROR_PARAM")
- '("error-file" "GDK_ERROR_FILE")
- '("error-mem" "GDK_ERROR_MEM")
- )
-)
-
-(define-enum GrabStatus
- (in-module "Gdk")
- (c-name "GdkGrabStatus")
- (gtype-id "GDK_TYPE_GRAB_STATUS")
- (values
- '("success" "GDK_GRAB_SUCCESS")
- '("already-grabbed" "GDK_GRAB_ALREADY_GRABBED")
- '("invalid-time" "GDK_GRAB_INVALID_TIME")
- '("not-viewable" "GDK_GRAB_NOT_VIEWABLE")
- '("frozen" "GDK_GRAB_FROZEN")
- )
-)
-
-(define-enum VisualType
- (in-module "Gdk")
- (c-name "GdkVisualType")
- (gtype-id "GDK_TYPE_VISUAL_TYPE")
- (values
- '("static-gray" "GDK_VISUAL_STATIC_GRAY")
- '("grayscale" "GDK_VISUAL_GRAYSCALE")
- '("static-color" "GDK_VISUAL_STATIC_COLOR")
- '("pseudo-color" "GDK_VISUAL_PSEUDO_COLOR")
- '("true-color" "GDK_VISUAL_TRUE_COLOR")
- '("direct-color" "GDK_VISUAL_DIRECT_COLOR")
- )
-)
-
-(define-enum WindowClass
- (in-module "Gdk")
- (c-name "GdkWindowClass")
- (gtype-id "GDK_TYPE_WINDOW_CLASS")
- (values
- '("utput" "GDK_INPUT_OUTPUT")
- '("nly" "GDK_INPUT_ONLY")
- )
-)
-
-(define-enum WindowType
- (in-module "Gdk")
- (c-name "GdkWindowType")
- (gtype-id "GDK_TYPE_WINDOW_TYPE")
- (values
- '("root" "GDK_WINDOW_ROOT")
- '("toplevel" "GDK_WINDOW_TOPLEVEL")
- '("child" "GDK_WINDOW_CHILD")
- '("dialog" "GDK_WINDOW_DIALOG")
- '("temp" "GDK_WINDOW_TEMP")
- '("foreign" "GDK_WINDOW_FOREIGN")
- )
-)
-
-(define-flags WindowAttributesType
- (in-module "Gdk")
- (c-name "GdkWindowAttributesType")
- (gtype-id "GDK_TYPE_WINDOW_ATTRIBUTES_TYPE")
- (values
- '("title" "GDK_WA_TITLE")
- '("x" "GDK_WA_X")
- '("y" "GDK_WA_Y")
- '("cursor" "GDK_WA_CURSOR")
- '("colormap" "GDK_WA_COLORMAP")
- '("visual" "GDK_WA_VISUAL")
- '("wmclass" "GDK_WA_WMCLASS")
- '("noredir" "GDK_WA_NOREDIR")
- )
-)
-
-(define-flags WindowHints
- (in-module "Gdk")
- (c-name "GdkWindowHints")
- (gtype-id "GDK_TYPE_WINDOW_HINTS")
- (values
- '("pos" "GDK_HINT_POS")
- '("min-size" "GDK_HINT_MIN_SIZE")
- '("max-size" "GDK_HINT_MAX_SIZE")
- '("base-size" "GDK_HINT_BASE_SIZE")
- '("aspect" "GDK_HINT_ASPECT")
- '("resize-inc" "GDK_HINT_RESIZE_INC")
- '("win-gravity" "GDK_HINT_WIN_GRAVITY")
- '("user-pos" "GDK_HINT_USER_POS")
- '("user-size" "GDK_HINT_USER_SIZE")
- )
-)
-
-(define-enum WindowTypeHint
- (in-module "Gdk")
- (c-name "GdkWindowTypeHint")
- (gtype-id "GDK_TYPE_WINDOW_TYPE_HINT")
- (values
- '("normal" "GDK_WINDOW_TYPE_HINT_NORMAL")
- '("dialog" "GDK_WINDOW_TYPE_HINT_DIALOG")
- '("menu" "GDK_WINDOW_TYPE_HINT_MENU")
- '("toolbar" "GDK_WINDOW_TYPE_HINT_TOOLBAR")
- '("splashscreen" "GDK_WINDOW_TYPE_HINT_SPLASHSCREEN")
- '("utility" "GDK_WINDOW_TYPE_HINT_UTILITY")
- '("dock" "GDK_WINDOW_TYPE_HINT_DOCK")
- '("desktop" "GDK_WINDOW_TYPE_HINT_DESKTOP")
- )
-)
-
-(define-flags WMDecoration
- (in-module "Gdk")
- (c-name "GdkWMDecoration")
- (gtype-id "GDK_TYPE_WM_DECORATION")
- (values
- '("all" "GDK_DECOR_ALL")
- '("border" "GDK_DECOR_BORDER")
- '("resizeh" "GDK_DECOR_RESIZEH")
- '("title" "GDK_DECOR_TITLE")
- '("menu" "GDK_DECOR_MENU")
- '("minimize" "GDK_DECOR_MINIMIZE")
- '("maximize" "GDK_DECOR_MAXIMIZE")
- )
-)
-
-(define-flags WMFunction
- (in-module "Gdk")
- (c-name "GdkWMFunction")
- (gtype-id "GDK_TYPE_WM_FUNCTION")
- (values
- '("all" "GDK_FUNC_ALL")
- '("resize" "GDK_FUNC_RESIZE")
- '("move" "GDK_FUNC_MOVE")
- '("minimize" "GDK_FUNC_MINIMIZE")
- '("maximize" "GDK_FUNC_MAXIMIZE")
- '("close" "GDK_FUNC_CLOSE")
- )
-)
-
-(define-enum Gravity
- (in-module "Gdk")
- (c-name "GdkGravity")
- (gtype-id "GDK_TYPE_GRAVITY")
- (values
- '("north-west" "GDK_GRAVITY_NORTH_WEST")
- '("north" "GDK_GRAVITY_NORTH")
- '("north-east" "GDK_GRAVITY_NORTH_EAST")
- '("west" "GDK_GRAVITY_WEST")
- '("center" "GDK_GRAVITY_CENTER")
- '("east" "GDK_GRAVITY_EAST")
- '("south-west" "GDK_GRAVITY_SOUTH_WEST")
- '("south" "GDK_GRAVITY_SOUTH")
- '("south-east" "GDK_GRAVITY_SOUTH_EAST")
- '("static" "GDK_GRAVITY_STATIC")
- )
-)
-
-(define-enum WindowEdge
- (in-module "Gdk")
- (c-name "GdkWindowEdge")
- (gtype-id "GDK_TYPE_WINDOW_EDGE")
- (values
- '("north-west" "GDK_WINDOW_EDGE_NORTH_WEST")
- '("north" "GDK_WINDOW_EDGE_NORTH")
- '("north-east" "GDK_WINDOW_EDGE_NORTH_EAST")
- '("west" "GDK_WINDOW_EDGE_WEST")
- '("east" "GDK_WINDOW_EDGE_EAST")
- '("south-west" "GDK_WINDOW_EDGE_SOUTH_WEST")
- '("south" "GDK_WINDOW_EDGE_SOUTH")
- '("south-east" "GDK_WINDOW_EDGE_SOUTH_EAST")
- )
-)
-
-(define-enum PixbufAlphaMode
- (in-module "Gdk")
- (c-name "GdkPixbufAlphaMode")
- (gtype-id "GDK_TYPE_PIXBUF_ALPHA_MODE")
- (values
- '("bilevel" "GDK_PIXBUF_ALPHA_BILEVEL")
- '("full" "GDK_PIXBUF_ALPHA_FULL")
- )
-)
-
-(define-enum Colorspace
- (in-module "Gdk")
- (c-name "GdkColorspace")
- (gtype-id "GDK_TYPE_COLORSPACE")
- (values
- '("b" "GDK_COLORSPACE_RGB")
- )
-)
-
-(define-enum PixbufError
- (in-module "Gdk")
- (c-name "GdkPixbufError")
- (gtype-id "GDK_TYPE_PIXBUF_ERROR")
- (values
- '("header-corrupt" "GDK_PIXBUF_ERROR_HEADER_CORRUPT")
- '("pixel-corrupt" "GDK_PIXBUF_ERROR_PIXEL_CORRUPT")
- '("unknown-format" "GDK_PIXBUF_ERROR_UNKNOWN_FORMAT")
- '("corrupt-image" "GDK_PIXBUF_ERROR_CORRUPT_IMAGE")
- '("insufficient-memory" "GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY")
- '("bad-option-value" "GDK_PIXBUF_ERROR_BAD_OPTION_VALUE")
- '("unknown-type" "GDK_PIXBUF_ERROR_UNKNOWN_TYPE")
- '("unsupported-operation" "GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION")
- '("failed" "GDK_PIXBUF_ERROR_FAILED")
- )
-)
-
-(define-enum PixbufRotation
- (in-module "Gdk")
- (c-name "GdkPixbufRotation")
- (gtype-id "GDK_TYPE_PIXBUF_ROTATION")
- (values
- '("none" "GDK_PIXBUF_ROTATE_NONE")
- '("counterclockwise" "GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE")
- '("upsidedown" "GDK_PIXBUF_ROTATE_UPSIDEDOWN")
- '("clockwise" "GDK_PIXBUF_ROTATE_CLOCKWISE")
- )
-)
-
-(define-enum InterpType
- (in-module "Gdk")
- (c-name "GdkInterpType")
- (gtype-id "GDK_TYPE_INTERP_TYPE")
- (values
- '("nearest" "GDK_INTERP_NEAREST")
- '("tiles" "GDK_INTERP_TILES")
- '("bilinear" "GDK_INTERP_BILINEAR")
- '("hyper" "GDK_INTERP_HYPER")
- )
-)
-
-(define-enum OwnerChange
- (in-module "Gdk")
- (c-name "GdkOwnerChange")
- (gtype-id "GDK_TYPE_OWNER_CHANGE")
- (values
- '("new-owner" "GDK_OWNER_CHANGE_NEW_OWNER")
- '("destroy" "GDK_OWNER_CHANGE_DESTROY")
- '("close" "GDK_OWNER_CHANGE_CLOSE")
- )
-)
-
-(define-object PixmapObject
- (in-module "Gdk")
- (parent "GdkDrawable")
- (c-name "GdkPixmapObject")
- (gtype-id "GDK_TYPE_PIXMAP_OBJECT")
-)
-
-(define-object WindowObject
- (in-module "Gdk")
- (parent "GdkDrawable")
- (c-name "GdkWindowObject")
- (gtype-id "GDK_TYPE_WINDOW_OBJECT")
-
-)
diff --git a/gtk/gdk-base.defs b/gtk/gdk-base.defs
deleted file mode 100644
index 26e68dce..00000000
--- a/gtk/gdk-base.defs
+++ /dev/null
@@ -1,6809 +0,0 @@
-;; -*- scheme -*-
-
-(include "gdk-base-types.defs")
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdk.h
-
-(define-function notify_startup_complete
- (c-name "gdk_notify_startup_complete")
- (return-type "none")
-)
-
-(define-function get_display_arg_name
- (c-name "gdk_get_display_arg_name")
- (return-type "const-gchar*")
-)
-
-(define-function get_program_class
- (c-name "gdk_get_program_class")
- (return-type "const-gchar*")
-)
-
-(define-function set_program_class
- (c-name "gdk_set_program_class")
- (parameters
- '("const-gchar*" "program_class")
- )
-)
-
-(define-function get_display
- (c-name "gdk_get_display")
- (return-type "const-gchar*")
-)
-
-(define-function pointer_grab
- (c-name "gdk_pointer_grab")
- (return-type "GdkGrabStatus")
- (parameters
- '("GdkWindow*" "window")
- '("gboolean" "owner_events" (null-ok) (default "FALSE"))
- '("GdkEventMask" "event_mask" (null-ok) (default "0"))
- '("GdkWindow*" "confine_to" (null-ok) (default "NULL"))
- '("GdkCursor*" "cursor" (null-ok) (default "NULL"))
- '("guint32" "time" (null-ok) (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-function pointer_ungrab
- (c-name "gdk_pointer_ungrab")
- (return-type "none")
- (parameters
- '("guint32" "time" (null-ok) (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-function keyboard_grab
- (c-name "gdk_keyboard_grab")
- (return-type "GdkGrabStatus")
- (parameters
- '("GdkWindow*" "window")
- '("gboolean" "owner_events" (null-ok) (default "FALSE"))
- '("guint32" "time" (null-ok) (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-function keyboard_ungrab
- (c-name "gdk_keyboard_ungrab")
- (return-type "none")
- (parameters
- '("guint32" "time" (null-ok) (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-function pointer_is_grabbed
- (c-name "gdk_pointer_is_grabbed")
- (return-type "gboolean")
-)
-
-(define-function screen_width
- (c-name "gdk_screen_width")
- (return-type "gint")
-)
-
-(define-function screen_height
- (c-name "gdk_screen_height")
- (return-type "gint")
-)
-
-(define-function screen_width_mm
- (c-name "gdk_screen_width_mm")
- (return-type "gint")
-)
-
-(define-function screen_height_mm
- (c-name "gdk_screen_height_mm")
- (return-type "gint")
-)
-
-(define-function flush
- (c-name "gdk_flush")
- (return-type "none")
-)
-
-(define-function beep
- (c-name "gdk_beep")
- (return-type "none")
-)
-
-(define-function set_double_click_time
- (c-name "gdk_set_double_click_time")
- (return-type "none")
- (parameters
- '("guint" "msec")
- )
-)
-
-(define-function threads_enter
- (c-name "gdk_threads_enter")
- (return-type "none")
-)
-
-(define-function threads_leave
- (c-name "gdk_threads_leave")
- (return-type "none")
-)
-
-(define-function threads_init
- (c-name "gdk_threads_init")
- (return-type "none")
-)
-
-(define-function parse_args
- (c-name "gdk_parse_args")
- (return-type "none")
- (parameters
- '("gint*" "argc")
- '("gchar***" "argv")
- )
-)
-
-(define-function init
- (c-name "gdk_init")
- (return-type "none")
- (parameters
- '("gint*" "argc")
- '("gchar***" "argv")
- )
-)
-
-(define-function init_check
- (c-name "gdk_init_check")
- (return-type "gboolean")
- (parameters
- '("gint*" "argc")
- '("gchar***" "argv")
- )
-)
-
-(define-function add_option_entries_libgtk_only
- (c-name "gdk_add_option_entries_libgtk_only")
- (return-type "none")
- (parameters
- '("GOptionGroup*" "group")
- )
-)
-
-(define-function pre_parse_libgtk_only
- (c-name "gdk_pre_parse_libgtk_only")
- (return-type "none")
-)
-
-(define-function exit
- (c-name "gdk_exit")
- (return-type "none")
- (parameters
- '("gint" "error_code")
- )
-)
-
-(define-function set_locale
- (c-name "gdk_set_locale")
- (return-type "gchar*")
-)
-
-(define-function error_trap_push
- (c-name "gdk_error_trap_push")
- (return-type "none")
-)
-
-(define-function error_trap_pop
- (c-name "gdk_error_trap_pop")
- (return-type "gint")
-)
-
-(define-function set_use_xshm
- (c-name "gdk_set_use_xshm")
- (return-type "none")
- (parameters
- '("gboolean" "use_xshm")
- )
-)
-
-(define-function get_use_xshm
- (c-name "gdk_get_use_xshm")
- (return-type "gboolean")
-)
-
-(define-function input_add_full
- (c-name "gdk_input_add_full")
- (return-type "gint")
- (parameters
- '("gint" "source")
- '("GdkInputCondition" "condition")
- '("GdkInputFunction" "function")
- '("gpointer" "data")
- '("GdkDestroyNotify" "destroy")
- )
-)
-
-(define-function input_add
- (c-name "gdk_input_add")
- (return-type "gint")
- (parameters
- '("gint" "source")
- '("GdkInputCondition" "condition")
- '("GdkInputFunction" "function")
- '("gpointer" "data")
- )
-)
-
-(define-function input_remove
- (c-name "gdk_input_remove")
- (return-type "none")
- (parameters
- '("gint" "tag")
- )
-)
-
-(define-function pointer_grab_info_libgtk_only
- (c-name "gdk_pointer_grab_info_libgtk_only")
- (return-type "gboolean")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkWindow**" "grab_window")
- '("gboolean*" "owner_events")
- )
-)
-
-(define-function keyboard_grab_info_libgtk_only
- (c-name "gdk_keyboard_grab_info_libgtk_only")
- (return-type "gboolean")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkWindow**" "grab_window")
- '("gboolean*" "owner_events")
- )
-)
-
-(define-function rectangle_get_type
- (c-name "gdk_rectangle_get_type")
- (return-type "GType")
-)
-
-(define-function wcstombs
- (c-name "gdk_wcstombs")
- (return-type "gchar*")
- (parameters
- '("const-GdkWChar*" "src")
- )
-)
-
-(define-function mbstowcs
- (c-name "gdk_mbstowcs")
- (return-type "gint")
- (parameters
- '("GdkWChar*" "dest")
- '("const-gchar*" "src")
- '("gint" "dest_max")
- )
-)
-
-(define-method send_client_message
- (of-object "GdkEvent")
- (c-name "gdk_event_send_client_message")
- (return-type "gboolean")
- (parameters
- '("GdkNativeWindow" "winid")
- )
-)
-
-(define-method send_clientmessage_toall
- (of-object "GdkEvent")
- (c-name "gdk_event_send_clientmessage_toall")
- (return-type "none")
-)
-
-(define-function event_send_client_message_for_display
- (c-name "gdk_event_send_client_message_for_display")
- (return-type "gboolean")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkEvent*" "event")
- '("GdkNativeWindow" "winid")
- )
-)
-
-(define-function threads_set_lock_functions
- (c-name "gdk_threads_set_lock_functions")
- (return-type "none")
- (parameters
- '("GCallback" "enter_fn")
- '("GCallback" "leave_fn")
- )
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkcolor.h
-
-(define-method ref
- (of-object "GdkColormap")
- (c-name "gdk_colormap_ref")
- (return-type "GdkColormap*")
-)
-
-(define-method unref
- (of-object "GdkColormap")
- (c-name "gdk_colormap_unref")
- (return-type "none")
-)
-
-(define-method change
- (of-object "GdkColormap")
- (deprecated "deprecated")
- (c-name "gdk_colormap_change")
- (return-type "none")
- (parameters
- '("gint" "ncolors")
- )
-)
-
-(define-method alloc_colors
- (of-object "GdkColormap")
- (c-name "gdk_colormap_alloc_colors")
- (return-type "gint")
- (parameters
- '("GdkColor*" "colors")
- '("gint" "ncolors")
- '("gboolean" "writeable")
- '("gboolean" "best_match")
- '("gboolean*" "success")
- )
-)
-
-(define-method free_colors
- (of-object "GdkColormap")
- (c-name "gdk_colormap_free_colors")
- (return-type "none")
- (parameters
- '("GdkColor*" "colors")
- '("gint" "ncolors")
- )
-)
-
-(define-method copy
- (of-object "GdkColor")
- (c-name "gdk_color_copy")
- (return-type "GdkColor*")
-)
-
-(define-method free
- (of-object "GdkColor")
- (c-name "gdk_color_free")
- (return-type "none")
-)
-
-(define-method hash
- (of-object "GdkColor")
- (c-name "gdk_color_hash")
- (return-type "guint")
-)
-
-(define-method equal
- (of-object "GdkColor")
- (c-name "gdk_color_equal")
- (return-type "gboolean")
- (parameters
- '("const-GdkColor*" "colorb")
- )
-)
-
-(define-function color_get_type
- (c-name "gdk_color_get_type")
- (return-type "GType")
-)
-
-(define-function colors_store
- (c-name "gdk_colors_store")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- '("GdkColor*" "colors")
- '("gint" "ncolors")
- )
-)
-
-(define-function colors_alloc
- (c-name "gdk_colors_alloc")
- (return-type "gint")
- (parameters
- '("GdkColormap*" "colormap")
- '("gboolean" "contiguous")
- '("gulong*" "planes")
- '("gint" "nplanes")
- '("gulong*" "pixels")
- '("gint" "npixels")
- )
-)
-
-(define-function colors_free
- (c-name "gdk_colors_free")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- '("gulong*" "pixels")
- '("gint" "npixels")
- '("gulong" "planes")
- )
-)
-
-(define-function color_new
- (c-name "gdk_color_new")
- (is-constructor-of "GdkColor")
- (return-type "GdkColor")
-)
-
-(define-function colormap_get_type
- (c-name "gdk_colormap_get_type")
- (return-type "GType")
-)
-
-(define-function colormap_new
- (c-name "gdk_colormap_new")
- (is-constructor-of GdkColormap)
- (return-type "GdkColormap*")
- (parameters
- '("GdkVisual*" "visual")
- '("gboolean" "allocate")
- )
-)
-
-(define-function colormap_get_system
- (c-name "gdk_colormap_get_system")
- (return-type "GdkColormap*")
-)
-
-(define-function colormap_get_system_size
- (deprecated "deprecated")
- (c-name "gdk_colormap_get_system_size")
- (return-type "gint")
-)
-
-(define-method alloc_color
- (of-object "GdkColormap")
- (c-name "gdk_colormap_alloc_color")
- (return-type "gboolean")
- (parameters
- '("GdkColor*" "color")
- '("gboolean" "writeable")
- '("gboolean" "best_match")
- )
-)
-
-(define-method query_color
- (of-object "GdkColormap")
- (c-name "gdk_colormap_query_color")
- (parameters
- '("gulong" "pixel")
- '("GdkColor*" "color")
- )
-)
-
-(define-method get_visual
- (of-object "GdkColormap")
- (c-name "gdk_colormap_get_visual")
- (return-type "GdkVisual*")
-)
-
-(define-method get_screen
- (of-object "GdkColormap")
- (c-name "gdk_colormap_get_screen")
- (return-type "GdkScreen*")
-)
-
-(define-function color_parse
- (c-name "gdk_color_parse")
- (return-type "gint")
- (parameters
- '("const-gchar*" "spec")
- '("GdkColor*" "color")
- )
-)
-
-(define-method white
- (deprecated "deprecated")
- (of-object "GdkColormap")
- (c-name "gdk_color_white")
- (return-type "gint")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method black
- (deprecated "deprecated")
- (of-object "GdkColormap")
- (c-name "gdk_color_black")
- (return-type "gint")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method alloc
- (deprecated "deprecated")
- (of-object "GdkColormap")
- (c-name "gdk_color_alloc")
- (return-type "gint")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-function color_change
- (deprecated "deprecated")
- (c-name "gdk_color_change")
- (return-type "gint")
- (parameters
- '("GdkColormap*" "colormap")
- '("GdkColor*" "color")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkcursor.h
-
-;; From gdkcursor.h
-
-(define-function cursor_get_type
- (c-name "gdk_cursor_get_type")
- (return-type "GType")
-)
-
-(define-method ref
- (of-object "GdkCursor")
- (c-name "gdk_cursor_ref")
- (return-type "GdkCursor*")
-)
-
-(define-method unref
- (of-object "GdkCursor")
- (c-name "gdk_cursor_unref")
- (return-type "none")
-)
-
-(define-function cursor_new_from_name
- (c-name "gdk_cursor_new_from_name")
- (return-type "GdkCursor*")
- (parameters
- '("GdkDisplay*" "display")
- '("const-gchar*" "name")
- )
-)
-
-(define-method get_image
- (of-object "GdkCursor")
- (c-name "gdk_cursor_get_image")
- (return-type "GdkPixbuf*")
-)
-
-
-(define-function cursor_new
- (is-constructor-of GdkCursor)
- (c-name "gdk_cursor_new")
- (return-type "GdkCursor*")
- (parameters
- '("GdkCursorType" "cursor_type")
- )
-)
-
-(define-function cursor_new_for_display
- (is-constructor-of GdkCursor)
- (c-name "gdk_cursor_new_for_display")
- (return-type "GdkCursor*")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkCursorType" "cursor_type")
- )
-)
-
-(define-function cursor_new_from_pixmap
- (is-constructor-of GdkCursor)
- (c-name "gdk_cursor_new_from_pixmap")
- (return-type "GdkCursor*")
- (parameters
- '("GdkPixmap*" "source")
- '("GdkPixmap*" "mask")
- '("GdkColor*" "fg")
- '("GdkColor*" "bg")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-function cursor_new_from_pixbuf
- (is-constructor-of GdkCursor)
- (c-name "gdk_cursor_new_from_pixbuf")
- (return-type "GdkCursor*")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkPixbuf*" "source")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method get_display
- (of-object "GdkCursor")
- (c-name "gdk_cursor_get_display")
- (return-type "GdkDisplay*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkdisplay.h
-
-(define-function gdk_display_get_type
- (c-name "gdk_display_get_type")
- (return-type "GType")
-)
-
-(define-function display_open
- (is-constructor-of "GdkDisplay")
- (c-name "gdk_display_open")
- (return-type "GdkDisplay*")
- (parameters
- '("const-gchar*" "display_name" (null-ok))
- )
-)
-
-(define-method get_name
- (of-object "GdkDisplay")
- (c-name "gdk_display_get_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_n_screens
- (of-object "GdkDisplay")
- (c-name "gdk_display_get_n_screens")
- (return-type "gint")
-)
-
-(define-method get_screen
- (of-object "GdkDisplay")
- (c-name "gdk_display_get_screen")
- (return-type "GdkScreen*")
- (parameters
- '("gint" "screen_num")
- )
-)
-
-(define-method get_default_screen
- (of-object "GdkDisplay")
- (c-name "gdk_display_get_default_screen")
- (return-type "GdkScreen*")
-)
-
-(define-method pointer_ungrab
- (of-object "GdkDisplay")
- (c-name "gdk_display_pointer_ungrab")
- (return-type "none")
- (parameters
- '("guint32" "time_" (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method keyboard_ungrab
- (of-object "GdkDisplay")
- (c-name "gdk_display_keyboard_ungrab")
- (return-type "none")
- (parameters
- '("guint32" "time_" (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method pointer_is_grabbed
- (of-object "GdkDisplay")
- (c-name "gdk_display_pointer_is_grabbed")
- (return-type "gboolean")
-)
-
-(define-method beep
- (of-object "GdkDisplay")
- (c-name "gdk_display_beep")
- (return-type "none")
-)
-
-(define-method sync
- (of-object "GdkDisplay")
- (c-name "gdk_display_sync")
- (return-type "none")
-)
-
-(define-method close
- (of-object "GdkDisplay")
- (c-name "gdk_display_close")
- (return-type "none")
-)
-
-(define-method list_devices
- (of-object "GdkDisplay")
- (c-name "gdk_display_list_devices")
- (return-type "GList*")
-)
-
-(define-method get_event
- (of-object "GdkDisplay")
- (c-name "gdk_display_get_event")
- (return-type "GdkEvent*")
-)
-
-(define-method peek_event
- (of-object "GdkDisplay")
- (c-name "gdk_display_peek_event")
- (return-type "GdkEvent*")
-)
-
-(define-method put_event
- (of-object "GdkDisplay")
- (c-name "gdk_display_put_event")
- (return-type "none")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-
-(define-method add_client_message_filter
- (of-object "GdkDisplay")
- (c-name "gdk_display_add_client_message_filter")
- (return-type "none")
- (parameters
- '("GdkAtom" "message_type")
- '("GdkFilterFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method set_double_click_time
- (of-object "GdkDisplay")
- (c-name "gdk_display_set_double_click_time")
- (return-type "none")
- (parameters
- '("guint" "msec")
- )
-)
-
-(define-function display_get_default
- (c-name "gdk_display_get_default")
- (return-type "GdkDisplay*")
-)
-
-(define-method get_core_pointer
- (of-object "GdkDisplay")
- (c-name "gdk_display_get_core_pointer")
- (return-type "GdkDevice*")
-)
-
-(define-method get_pointer
- (of-object "GdkDisplay")
- (c-name "gdk_display_get_pointer")
- (return-type "none")
- (parameters
- '("GdkScreen**" "screen")
- '("gint*" "x")
- '("gint*" "y")
- '("GdkModifierType*" "mask")
- )
-)
-
-(define-method get_window_at_pointer
- (of-object "GdkDisplay")
- (c-name "gdk_display_get_window_at_pointer")
- (return-type "GdkWindow*")
- (parameters
- '("gint*" "win_x")
- '("gint*" "win_y")
- )
-)
-
-(define-method set_pointer_hooks
- (of-object "GdkDisplay")
- (c-name "gdk_display_set_pointer_hooks")
- (return-type "GdkDisplayPointerHooks*")
- (parameters
- '("const-GdkDisplayPointerHooks*" "new_hooks")
- )
-)
-
-(define-method store_clipboard
- (of-object "GdkDisplay")
- (c-name "gdk_display_store_clipboard")
- (return-type "none")
- (parameters
- '("GdkWindow*" "clipboard_window")
- '("guint32" "time_")
- '("GdkAtom*" "targets")
- '("gint" "n_targets")
- )
-)
-
-(define-method supports_selection_notification
- (of-object "GdkDisplay")
- (c-name "gdk_display_supports_selection_notification")
- (return-type "gboolean")
-)
-
-(define-method request_selection_notification
- (of-object "GdkDisplay")
- (c-name "gdk_display_request_selection_notification")
- (return-type "gboolean")
- (parameters
- '("GdkAtom" "selection")
- )
-)
-
-(define-method supports_clipboard_persistence
- (of-object "GdkDisplay")
- (c-name "gdk_display_supports_clipboard_persistence")
- (return-type "gboolean")
-)
-
-(define-method flush
- (of-object "GdkDisplay")
- (c-name "gdk_display_flush")
- (return-type "none")
-)
-
-(define-method set_double_click_distance
- (of-object "GdkDisplay")
- (c-name "gdk_display_set_double_click_distance")
- (return-type "none")
- (parameters
- '("guint" "distance")
- )
-)
-
-(define-method supports_cursor_alpha
- (of-object "GdkDisplay")
- (c-name "gdk_display_supports_cursor_alpha")
- (return-type "gboolean")
-)
-
-(define-method supports_cursor_color
- (of-object "GdkDisplay")
- (c-name "gdk_display_supports_cursor_color")
- (return-type "gboolean")
-)
-
-(define-method get_default_cursor_size
- (of-object "GdkDisplay")
- (c-name "gdk_display_get_default_cursor_size")
- (return-type "guint")
-)
-
-(define-method get_maximal_cursor_size
- (of-object "GdkDisplay")
- (c-name "gdk_display_get_maximal_cursor_size")
- (return-type "none")
- (parameters
- '("guint*" "width")
- '("guint*" "height")
- )
-)
-(define-method get_default_group
- (of-object "GdkDisplay")
- (c-name "gdk_display_get_default_group")
- (return-type "GdkWindow*")
-)
-
-(define-method warp_pointer
- (of-object "GdkDisplay")
- (c-name "gdk_display_warp_pointer")
- (return-type "none")
- (parameters
- '("GdkScreen*" "screen")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-virtual get_display_name
- (of-object "GdkDisplay")
- (return-type "const-gchar*")
-)
-
-(define-virtual get_n_screens
- (of-object "GdkDisplay")
- (return-type "gint")
-)
-
-(define-virtual get_screen
- (of-object "GdkDisplay")
- (return-type "GdkScreen*")
- (parameters
- '("gint" "screen_num")
- )
-)
-
-(define-virtual get_default_screen
- (of-object "GdkDisplay")
- (return-type "GdkScreen*")
-)
-
-(define-virtual closed
- (of-object "GdkDisplay")
- (return-type "none")
- (parameters
- '("gboolean" "is_error")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkdisplaymanager.h
-
-(define-function gdk_display_manager_get_type
- (c-name "gdk_display_manager_get_type")
- (return-type "GType")
-)
-
-(define-function display_manager_get
- (c-name "gdk_display_manager_get")
- (return-type "GdkDisplayManager*")
-)
-
-(define-method get_default_display
- (of-object "GdkDisplayManager")
- (c-name "gdk_display_manager_get_default_display")
- (return-type "GdkDisplay*")
-)
-
-(define-method set_default_display
- (of-object "GdkDisplayManager")
- (c-name "gdk_display_manager_set_default_display")
- (return-type "none")
- (parameters
- '("GdkDisplay*" "display")
- )
-)
-
-(define-method list_displays
- (of-object "GdkDisplayManager")
- (c-name "gdk_display_manager_list_displays")
- (return-type "GSList*")
-)
-
-(define-virtual display_opened
- (of-object "GdkDisplayManager")
- (return-type "none")
- (parameters
- '("GdkDisplay*" "display")
- )
-)
-
-;;
-
-(define-function display_open_default_libgtk_only
- (c-name "gdk_display_open_default_libgtk_only")
- (return-type "GdkDisplay*")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkdnd.h
-
-(define-function drag_context_get_type
- (c-name "gdk_drag_context_get_type")
- (return-type "GType")
-)
-
-(define-function drag_context_new
- (is-constructor-of GdkDragContext)
- (c-name "gdk_drag_context_new")
- (return-type "GdkDragContext*")
-)
-
-(define-method ref
- (of-object "GdkDragContext")
- (c-name "gdk_drag_context_ref")
- (return-type "none")
-)
-
-(define-method unref
- (of-object "GdkDragContext")
- (c-name "gdk_drag_context_unref")
- (return-type "none")
-)
-
-(define-method drag_status
- (of-object "GdkDragContext")
- (c-name "gdk_drag_status")
- (return-type "none")
- (parameters
- '("GdkDragAction" "action")
- '("guint32" "time" (null-ok) (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method drop_reply
- (of-object "GdkDragContext")
- (c-name "gdk_drop_reply")
- (return-type "none")
- (parameters
- '("gboolean" "ok")
- '("guint32" "time" (null-ok) (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method drop_finish
- (of-object "GdkDragContext")
- (c-name "gdk_drop_finish")
- (return-type "none")
- (parameters
- '("gboolean" "success")
- '("guint32" "time" (null-ok) (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method drag_get_selection
- (of-object "GdkDragContext")
- (c-name "gdk_drag_get_selection")
- (return-type "GdkAtom")
-)
-
-(define-method drag_begin
- (of-object "GdkWindow")
- (c-name "gdk_drag_begin")
- (return-type "GdkDragContext*")
- (parameters
- '("GList*" "targets")
- )
-)
-
-(define-function drag_get_protocol
- (c-name "gdk_drag_get_protocol")
- (return-type "guint32")
- (parameters
- '("guint32" "xid")
- '("GdkDragProtocol*" "protocol")
- )
-)
-
-(define-method drag_find_window
- (of-object "GdkDragContext")
- (c-name "gdk_drag_find_window")
- (return-type "none")
- (parameters
- '("GdkWindow*" "drag_window")
- '("gint" "x_root")
- '("gint" "y_root")
- '("GdkWindow**" "dest_window")
- '("GdkDragProtocol*" "protocol")
- )
-)
-
-(define-function drag_get_protocol_for_display
- (c-name "gdk_drag_get_protocol_for_display")
- (return-type "guint32")
- (parameters
- '("GdkDisplay*" "display")
- '("guint32" "xid")
- '("GdkDragProtocol*" "protocol")
- )
-)
-
-(define-method drag_find_window_for_screen
- (of-object "GdkDragContext")
- (c-name "gdk_drag_find_window_for_screen")
- (return-type "none")
- (parameters
- '("GdkWindow*" "drag_window")
- '("GdkScreen*" "screen")
- '("gint" "x_root")
- '("gint" "y_root")
- '("GdkWindow**" "dest_window")
- '("GdkDragProtocol*" "protocol")
- )
-)
-
-(define-method drag_motion
- (of-object "GdkDragContext")
- (c-name "gdk_drag_motion")
- (return-type "gboolean")
- (parameters
- '("GdkWindow*" "dest_window")
- '("GdkDragProtocol" "protocol")
- '("gint" "x_root")
- '("gint" "y_root")
- '("GdkDragAction" "suggested_action")
- '("GdkDragAction" "possible_actions")
- '("guint32" "time")
- )
-)
-
-(define-method drag_drop
- (of-object "GdkDragContext")
- (c-name "gdk_drag_drop")
- (return-type "none")
- (parameters
- '("guint32" "time")
- )
-)
-
-(define-method drag_abort
- (of-object "GdkDragContext")
- (c-name "gdk_drag_abort")
- (return-type "none")
- (parameters
- '("guint32" "time")
- )
-)
-
-(define-method drag_drop_succeeded
- (of-object "GdkDragContext")
- (c-name "gdk_drag_drop_succeeded")
- (return-type "gboolean")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkdrawable.h
-
-(define-function gdk_drawable_get_type
- (c-name "gdk_drawable_get_type")
- (return-type "GType")
-)
-
-(define-method copy_to_image
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_copy_to_image")
- (return-type "GdkImage*")
- (parameters
- '("GdkImage*" "image")
- '("gint" "src_x")
- '("gint" "src_y")
- '("gint" "dest_x")
- '("gint" "dest_y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method set_data
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_set_data")
- (return-type "none")
- (parameters
- '("const-gchar*" "key")
- '("gpointer" "data")
- '("GDestroyNotify" "destroy_func")
- )
-)
-
-(define-method get_data
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_get_data")
- (return-type "gpointer")
- (parameters
- '("const-gchar*" "key")
- )
-)
-
-(define-method get_size
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_get_size")
- (return-type "none")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-method set_colormap
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_set_colormap")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- )
-)
-
-(define-method get_colormap
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_get_colormap")
- (return-type "GdkColormap*")
-)
-
-(define-method get_visual
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_get_visual")
- (return-type "GdkVisual*")
-)
-
-(define-method get_depth
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_get_depth")
- (return-type "gint")
-)
-
-(define-method get_screen
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_get_screen")
- (return-type "GdkScreen*")
-)
-
-(define-method get_display
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_get_display")
- (return-type "GdkDisplay*")
-)
-
-(define-method ref
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_ref")
- (return-type "GdkDrawable*")
-)
-
-(define-method unref
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_unref")
- (return-type "none")
-)
-
-(define-method draw_point
- (of-object "GdkDrawable")
- (c-name "gdk_draw_point")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method draw_line
- (of-object "GdkDrawable")
- (c-name "gdk_draw_line")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gint" "x1")
- '("gint" "y1")
- '("gint" "x2")
- '("gint" "y2")
- )
-)
-
-(define-method draw_rectangle
- (of-object "GdkDrawable")
- (c-name "gdk_draw_rectangle")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gboolean" "filled")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method draw_arc
- (of-object "GdkDrawable")
- (c-name "gdk_draw_arc")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gboolean" "filled")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("gint" "angle1")
- '("gint" "angle2")
- )
-)
-
-(define-method draw_polygon
- (of-object "GdkDrawable")
- (c-name "gdk_draw_polygon")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gboolean" "filled")
- '("GdkPoint*" "points")
- '("gint" "npoints")
- )
-)
-
-(define-method draw_string
- (deprecated "use GdkDrawable.draw_layout")
- (of-object "GdkDrawable")
- (c-name "gdk_draw_string")
- (return-type "none")
- (parameters
- '("GdkFont*" "font")
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("const-gchar*" "string")
- )
-)
-
-(define-method draw_text
- (deprecated "use GdkDrawable.draw_layout")
- (of-object "GdkDrawable")
- (c-name "gdk_draw_text")
- (return-type "none")
- (parameters
- '("GdkFont*" "font")
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("const-gchar*" "text")
- '("gint" "text_length")
- )
-)
-
-(define-method draw_text_wc
- (deprecated "use GdkDrawable.draw_layout")
- (of-object "GdkDrawable")
- (c-name "gdk_draw_text_wc")
- (return-type "none")
- (parameters
- '("GdkFont*" "font")
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("const-GdkWChar*" "text")
- '("gint" "text_length")
- )
-)
-
-(define-method draw_drawable
- (of-object "GdkDrawable")
- (c-name "gdk_draw_drawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkDrawable*" "src")
- '("gint" "xsrc")
- '("gint" "ysrc")
- '("gint" "xdest")
- '("gint" "ydest")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method draw_image
- (of-object "GdkDrawable")
- (c-name "gdk_draw_image")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkImage*" "image")
- '("gint" "xsrc")
- '("gint" "ysrc")
- '("gint" "xdest")
- '("gint" "ydest")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method draw_points
- (of-object "GdkDrawable")
- (c-name "gdk_draw_points")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkPoint*" "points")
- '("gint" "npoints")
- )
-)
-
-(define-method draw_segments
- (of-object "GdkDrawable")
- (c-name "gdk_draw_segments")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkSegment*" "segs")
- '("gint" "nsegs")
- )
-)
-
-(define-method draw_lines
- (of-object "GdkDrawable")
- (c-name "gdk_draw_lines")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkPoint*" "points")
- '("gint" "npoints")
- )
-)
-
-(define-method draw_pixbuf
- (of-object "GdkDrawable")
- (c-name "gdk_draw_pixbuf")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc" (null-ok))
- '("GdkPixbuf*" "pixbuf")
- '("gint" "src_x")
- '("gint" "src_y")
- '("gint" "dest_x")
- '("gint" "dest_y")
- '("gint" "width" (default "-1"))
- '("gint" "height" (default "-1"))
- '("GdkRgbDither" "dither" (default "GDK_RGB_DITHER_NORMAL"))
- '("gint" "x_dither" (default "0"))
- '("gint" "y_dither" (default "0"))
- )
-)
-
-(define-method draw_glyphs
- (of-object "GdkDrawable")
- (c-name "gdk_draw_glyphs")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("PangoFont*" "font")
- '("gint" "x")
- '("gint" "y")
- '("PangoGlyphString*" "glyphs")
- )
-)
-
-(define-method draw_layout_line
- (of-object "GdkDrawable")
- (c-name "gdk_draw_layout_line")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("PangoLayoutLine*" "line")
- )
-)
-
-(define-method draw_layout
- (of-object "GdkDrawable")
- (c-name "gdk_draw_layout")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("PangoLayout*" "layout")
- )
-)
-
-(define-function draw_layout_line_with_colors
- (c-name "gdk_draw_layout_line_with_colors")
- (return-type "none")
- (parameters
- '("GdkDrawable*" "drawable")
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("PangoLayoutLine*" "line")
- '("GdkColor*" "foreground")
- '("GdkColor*" "background")
- )
-)
-
-(define-function draw_layout_with_colors
- (deprecated "use gtk.gdk.Drawable.draw_layout instead")
- (c-name "gdk_draw_layout_with_colors")
- (return-type "none")
- (parameters
- '("GdkDrawable*" "drawable")
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("PangoLayout*" "layout")
- '("GdkColor*" "foreground")
- '("GdkColor*" "background")
- )
-)
-
-(define-function draw_glyphs_transformed
- (c-name "gdk_draw_glyphs_transformed")
- (return-type "none")
- (parameters
- '("GdkDrawable*" "drawable")
- '("GdkGC*" "gc")
- '("PangoMatrix*" "matrix")
- '("PangoFont*" "font")
- '("gint" "x")
- '("gint" "y")
- '("PangoGlyphString*" "glyphs")
- )
-)
-
-(define-function draw_trapezoids
- (c-name "gdk_draw_trapezoids")
- (return-type "none")
- (parameters
- '("GdkDrawable*" "drawable")
- '("GdkGC*" "gc")
- '("GdkTrapezoid*" "trapezoids")
- '("gint" "n_trapezoids")
- )
-)
-(define-method get_image
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_get_image")
- (return-type "GdkImage*")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (caller-owns-return #t)
-)
-
-(define-method get_clip_region
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_get_clip_region")
- (return-type "GdkRegion*")
- (caller-owns-return #t)
-)
-
-(define-method get_visible_region
- (of-object "GdkDrawable")
- (c-name "gdk_drawable_get_visible_region")
- (return-type "GdkRegion*")
- (caller-owns-return #t)
-)
-
-(define-virtual create_gc
- (of-object "GdkDrawable")
- (return-type "GdkGC*")
- (parameters
- '("GdkGCValues*" "values")
- '("GdkGCValuesMask" "mask")
- )
-)
-
-(define-virtual draw_rectangle
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gboolean" "filled")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-virtual draw_arc
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gboolean" "filled")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("gint" "angle1")
- '("gint" "angle2")
- )
-)
-
-(define-virtual draw_polygon
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gboolean" "filled")
- '("GdkPoint*" "points")
- '("gint" "npoints")
- )
-)
-
-(define-virtual draw_text
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkFont*" "font")
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("const-gchar*" "text")
- '("gint" "text_length")
- )
-)
-
-(define-virtual draw_text_wc
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkFont*" "font")
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("const-GdkWChar*" "text")
- '("gint" "text_length")
- )
-)
-
-(define-virtual draw_drawable
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkDrawable*" "src")
- '("gint" "xsrc")
- '("gint" "ysrc")
- '("gint" "xdest")
- '("gint" "ydest")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-virtual draw_points
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkPoint*" "points")
- '("gint" "npoints")
- )
-)
-
-(define-virtual draw_segments
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkSegment*" "segs")
- '("gint" "nsegs")
- )
-)
-
-(define-virtual draw_lines
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkPoint*" "points")
- '("gint" "npoints")
- )
-)
-
-(define-virtual draw_glyphs
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("PangoFont*" "font")
- '("gint" "x")
- '("gint" "y")
- '("PangoGlyphString*" "glyphs")
- )
-)
-
-(define-virtual draw_image
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkImage*" "image")
- '("gint" "xsrc")
- '("gint" "ysrc")
- '("gint" "xdest")
- '("gint" "ydest")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-virtual get_depth
- (of-object "GdkDrawable")
- (return-type "gint")
-)
-
-(define-virtual get_size
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-virtual set_colormap
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkColormap*" "cmap")
- )
-)
-
-(define-virtual get_colormap
- (of-object "GdkDrawable")
- (return-type "GdkColormap*")
-)
-
-(define-virtual get_visual
- (of-object "GdkDrawable")
- (return-type "GdkVisual*")
-)
-
-(define-virtual get_screen
- (of-object "GdkDrawable")
- (return-type "GdkScreen*")
-)
-
-(define-virtual get_image
- (of-object "GdkDrawable")
- (return-type "GdkImage*")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-virtual get_clip_region
- (of-object "GdkDrawable")
- (return-type "GdkRegion*")
-)
-
-(define-virtual get_visible_region
- (of-object "GdkDrawable")
- (return-type "GdkRegion*")
-)
-
-(define-virtual get_composite_drawable
- (of-object "GdkDrawable")
- (return-type "GdkDrawable*")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("gint*" "composite_x_offset")
- '("gint*" "composite_y_offset")
- )
-)
-
-(define-virtual draw_pixbuf
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkPixbuf*" "pixbuf")
- '("gint" "src_x")
- '("gint" "src_y")
- '("gint" "dest_x")
- '("gint" "dest_y")
- '("gint" "width")
- '("gint" "height")
- '("GdkRgbDither" "dither")
- '("gint" "x_dither")
- '("gint" "y_dither")
- )
-)
-
-(define-virtual draw_glyphs_transformed
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("PangoMatrix*" "matrix")
- '("PangoFont*" "font")
- '("gint" "x")
- '("gint" "y")
- '("PangoGlyphString*" "glyphs")
- )
-)
-
-(define-virtual draw_trapezoids
- (of-object "GdkDrawable")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("GdkTrapezoid*" "trapezoids")
- '("gint" "n_trapezoids")
- )
-)
-
-(define-virtual ref_cairo_surface
- (of-object "GdkDrawable")
- (return-type "cairo_surface_t*")
-)
-
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkevents.h
-
-(define-function gdk_event_get_type
- (c-name "gdk_event_get_type")
- (return-type "GType")
-)
-
-(define-function events_pending
- (c-name "gdk_events_pending")
- (return-type "gboolean")
-)
-
-(define-function event_get
- (c-name "gdk_event_get")
- (return-type "GdkEvent*")
-)
-
-(define-function event_peek
- (c-name "gdk_event_peek")
- (return-type "GdkEvent*")
-)
-
-(define-function event_get_graphics_expose
- (c-name "gdk_event_get_graphics_expose")
- (return-type "GdkEvent*")
- (parameters
- '("GdkWindow*" "window")
- )
-)
-
-(define-method put
- (of-object "GdkEvent")
- (c-name "gdk_event_put")
- (return-type "none")
-)
-
-(define-function event_new
- (is-constructor-of "GdkEvent")
- (c-name "gdk_event_new")
- (return-type "GdkEvent*")
- (parameters
- '("GdkEventType" "type")
- )
-)
-
-(define-method copy
- (of-object "GdkEvent")
- (c-name "gdk_event_copy")
- (return-type "GdkEvent*")
-)
-
-(define-method free
- (of-object "GdkEvent")
- (c-name "gdk_event_free")
- (return-type "none")
-)
-
-(define-method get_time
- (of-object "GdkEvent")
- (c-name "gdk_event_get_time")
- (return-type "guint32")
-)
-
-(define-method get_state
- (of-object "GdkEvent")
- (c-name "gdk_event_get_state")
- (return-type "gboolean")
- (parameters
- '("GdkModifierType*" "state")
- )
-)
-
-(define-method get_coords
- (of-object "GdkEvent")
- (c-name "gdk_event_get_coords")
- (return-type "gboolean")
- (parameters
- '("gdouble*" "x_win")
- '("gdouble*" "y_win")
- )
-)
-
-(define-method get_root_coords
- (of-object "GdkEvent")
- (c-name "gdk_event_get_root_coords")
- (return-type "gboolean")
- (parameters
- '("gdouble*" "x_root")
- '("gdouble*" "y_root")
- )
-)
-
-(define-method get_axis
- (of-object "GdkEvent")
- (c-name "gdk_event_get_axis")
- (return-type "gboolean")
- (parameters
- '("GdkAxisUse" "axis_use")
- '("gdouble*" "value")
- )
-)
-
-(define-function event_handler_set
- (c-name "gdk_event_handler_set")
- (return-type "none")
- (parameters
- '("GdkEventFunc" "func")
- '("gpointer" "data")
- '("GDestroyNotify" "notify")
- )
-)
-
-(define-method set_screen
- (of-object "GdkEvent")
- (c-name "gdk_event_set_screen")
- (return-type "none")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-method get_screen
- (of-object "GdkEvent")
- (c-name "gdk_event_get_screen")
- (return-type "GdkScreen*")
-)
-
-(define-function set_show_events
- (c-name "gdk_set_show_events")
- (return-type "none")
- (parameters
- '("gboolean" "show_events")
- )
-)
-
-(define-function get_show_events
- (c-name "gdk_get_show_events")
- (return-type "gboolean")
-)
-
-(define-function add_client_message_filter
- (c-name "gdk_add_client_message_filter")
- (return-type "none")
- (parameters
- '("GdkAtom" "message_type")
- '("GdkFilterFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-function setting_get
- (c-name "gdk_setting_get")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "name")
- '("GValue*" "value")
- )
-)
-
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkfont.h
-
-(define-function font_get_type
- (c-name "gdk_font_get_type")
- (return-type "GType")
-)
-
-(define-method ref
- (of-object "GdkFont")
- (c-name "gdk_font_ref")
- (return-type "GdkFont*")
-)
-
-(define-method unref
- (of-object "GdkFont")
- (c-name "gdk_font_unref")
- (return-type "none")
-)
-
-(define-method equal
- (of-object "GdkFont")
- (c-name "gdk_font_equal")
- (return-type "gboolean")
- (parameters
- '("const-GdkFont*" "fontb")
- )
-)
-
-(define-method id
- (of-object "GdkFont")
- (c-name "gdk_font_id")
- (return-type "gint")
-)
-
-(define-function font_load_for_display
- (c-name "gdk_font_load_for_display")
- (return-type "GdkFont*")
- (parameters
- '("GdkDisplay*" "display")
- '("const-gchar*" "font_name")
- )
-)
-
-(define-function fontset_load_for_display
- (c-name "gdk_fontset_load_for_display")
- (return-type "GdkFont*")
- (parameters
- '("GdkDisplay*" "display")
- '("const-gchar*" "fontset_name")
- )
-)
-
-(define-function font_from_description_for_display
- (c-name "gdk_font_from_description_for_display")
- (return-type "GdkFont*")
- (parameters
- '("GdkDisplay*" "display")
- '("PangoFontDescription*" "font_desc")
- )
-)
-
-(define-function font_load
- (is-constructor-of GdkFont)
- (c-name "gdk_font_load")
- (return-type "GdkFont*")
- (parameters
- '("const-gchar*" "font_name")
- )
-)
-
-(define-function fontset_load
- (c-name "gdk_fontset_load")
- (return-type "GdkFont*")
- (parameters
- '("const-gchar*" "fontset_name")
- )
-)
-
-(define-function font_from_description
- (c-name "gdk_font_from_description")
- (return-type "GdkFont*")
- (parameters
- '("PangoFontDescription*" "font_desc")
- )
-)
-
-(define-method string_width
- (of-object "GdkFont")
- (c-name "gdk_string_width")
- (return-type "gint")
- (parameters
- '("const-gchar*" "string")
- )
-)
-
-(define-method width
- (of-object "GdkFont")
- (c-name "gdk_text_width")
- (return-type "gint")
- (parameters
- '("const-gchar*" "text")
- '("gint" "text_length" (default "-1"))
- )
-)
-
-(define-method text_width_wc
- (of-object "GdkFont")
- (c-name "gdk_text_width_wc")
- (return-type "gint")
- (parameters
- '("const-GdkWChar*" "text")
- '("gint" "text_length")
- )
-)
-
-(define-method char_width
- (of-object "GdkFont")
- (c-name "gdk_char_width")
- (return-type "gint")
- (parameters
- '("gchar" "character")
- )
-)
-
-(define-method char_width_wc
- (of-object "GdkFont")
- (c-name "gdk_char_width_wc")
- (return-type "gint")
- (parameters
- '("GdkWChar" "character")
- )
-)
-
-(define-method string_measure
- (of-object "GdkFont")
- (c-name "gdk_string_measure")
- (return-type "gint")
- (parameters
- '("const-gchar*" "string")
- )
-)
-
-(define-method measure
- (of-object "GdkFont")
- (c-name "gdk_text_measure")
- (return-type "gint")
- (parameters
- '("const-gchar*" "text")
- '("gint" "text_length" (default "-1"))
- )
-)
-
-(define-method char_measure
- (of-object "GdkFont")
- (c-name "gdk_char_measure")
- (return-type "gint")
- (parameters
- '("gchar" "character")
- )
-)
-
-(define-method string_height
- (of-object "GdkFont")
- (c-name "gdk_string_height")
- (return-type "gint")
- (parameters
- '("const-gchar*" "string")
- )
-)
-
-(define-method height
- (of-object "GdkFont")
- (c-name "gdk_text_height")
- (return-type "gint")
- (parameters
- '("const-gchar*" "text")
- '("gint" "text_length" (default "-1"))
- )
-)
-
-(define-method char_height
- (of-object "GdkFont")
- (c-name "gdk_char_height")
- (return-type "gint")
- (parameters
- '("gchar" "character")
- )
-)
-
-(define-method extents
- (of-object "GdkFont")
- (c-name "gdk_text_extents")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("gint" "text_length")
- '("gint*" "lbearing")
- '("gint*" "rbearing")
- '("gint*" "width")
- '("gint*" "ascent")
- '("gint*" "descent")
- )
-)
-
-(define-method text_extents_wc
- (of-object "GdkFont")
- (c-name "gdk_text_extents_wc")
- (return-type "none")
- (parameters
- '("const-GdkWChar*" "text")
- '("gint" "text_length")
- '("gint*" "lbearing")
- '("gint*" "rbearing")
- '("gint*" "width")
- '("gint*" "ascent")
- '("gint*" "descent")
- )
-)
-
-(define-method string_extents
- (of-object "GdkFont")
- (c-name "gdk_string_extents")
- (return-type "none")
- (parameters
- '("const-gchar*" "string")
- '("gint*" "lbearing")
- '("gint*" "rbearing")
- '("gint*" "width")
- '("gint*" "ascent")
- '("gint*" "descent")
- )
-)
-
-(define-method "get_display"
- (of-object "GdkFont")
- (c-name "gdk_font_get_display")
- (return-type "GdkDisplay*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkgc.h
-
-(define-method ref
- (of-object "GdkGC")
- (c-name "gdk_gc_ref")
- (return-type "GdkGC*")
-)
-
-(define-method unref
- (of-object "GdkGC")
- (c-name "gdk_gc_unref")
- (return-type "none")
-)
-
-(define-function gdk_gc_get_type
- (c-name "gdk_gc_get_type")
- (return-type "GType")
-)
-
-(define-function gc_new
- (c-name "gdk_gc_new")
- (is-constructor-of "GdkGC")
- (return-type "GdkGC*")
- (parameters
- '("GdkDrawable*" "drawable")
- )
-)
-
-(define-function gc_new
- (deprecated "use gdk.GC")
- (c-name "gdk_gc_new2")
- (return-type "GdkGC*")
- (parameters
- '("GdkDrawable*" "drawable")
- )
-)
-
-(define-method new_gc
- (of-object "GdkDrawable")
- (c-name "gdk_gc_new_with_values")
- (return-type "GdkGC*")
- (parameters
- '("GdkGCValues*" "values")
- '("GdkGCValuesMask" "values_mask")
- )
-)
-
-(define-method get_values
- (of-object "GdkGC")
- (c-name "gdk_gc_get_values")
- (return-type "none")
- (parameters
- '("GdkGCValues*" "values")
- )
-)
-
-(define-method set_values
- (of-object "GdkGC")
- (c-name "gdk_gc_set_values")
- (return-type "none")
- (parameters
- '("GdkGCValues*" "values")
- '("GdkGCValuesMask" "values_mask")
- )
-)
-
-(define-method set_foreground
- (of-object "GdkGC")
- (c-name "gdk_gc_set_foreground")
- (return-type "none")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method set_background
- (of-object "GdkGC")
- (c-name "gdk_gc_set_background")
- (return-type "none")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method set_font
- (of-object "GdkGC")
- (c-name "gdk_gc_set_font")
- (return-type "none")
- (parameters
- '("GdkFont*" "font")
- )
-)
-
-(define-method set_function
- (of-object "GdkGC")
- (c-name "gdk_gc_set_function")
- (return-type "none")
- (parameters
- '("GdkFunction" "function")
- )
-)
-
-(define-method set_fill
- (of-object "GdkGC")
- (c-name "gdk_gc_set_fill")
- (return-type "none")
- (parameters
- '("GdkFill" "fill")
- )
-)
-
-(define-method set_tile
- (of-object "GdkGC")
- (c-name "gdk_gc_set_tile")
- (return-type "none")
- (parameters
- '("GdkPixmap*" "tile")
- )
-)
-
-(define-method set_stipple
- (of-object "GdkGC")
- (c-name "gdk_gc_set_stipple")
- (return-type "none")
- (parameters
- '("GdkPixmap*" "stipple")
- )
-)
-
-(define-method set_ts_origin
- (of-object "GdkGC")
- (c-name "gdk_gc_set_ts_origin")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method set_clip_origin
- (of-object "GdkGC")
- (c-name "gdk_gc_set_clip_origin")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method set_clip_mask
- (of-object "GdkGC")
- (c-name "gdk_gc_set_clip_mask")
- (return-type "none")
- (parameters
- '("GdkBitmap*" "mask")
- )
-)
-
-(define-method set_clip_rectangle
- (of-object "GdkGC")
- (c-name "gdk_gc_set_clip_rectangle")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "rectangle")
- )
-)
-
-(define-method set_clip_region
- (of-object "GdkGC")
- (c-name "gdk_gc_set_clip_region")
- (return-type "none")
- (parameters
- '("GdkRegion*" "region")
- )
-)
-
-(define-method set_subwindow
- (of-object "GdkGC")
- (c-name "gdk_gc_set_subwindow")
- (return-type "none")
- (parameters
- '("GdkSubwindowMode" "mode")
- )
-)
-
-(define-method set_exposures
- (of-object "GdkGC")
- (c-name "gdk_gc_set_exposures")
- (return-type "none")
- (parameters
- '("gboolean" "exposures")
- )
-)
-
-(define-method set_line_attributes
- (of-object "GdkGC")
- (c-name "gdk_gc_set_line_attributes")
- (return-type "none")
- (parameters
- '("gint" "line_width")
- '("GdkLineStyle" "line_style")
- '("GdkCapStyle" "cap_style")
- '("GdkJoinStyle" "join_style")
- )
-)
-
-(define-method set_dashes
- (of-object "GdkGC")
- (c-name "gdk_gc_set_dashes")
- (return-type "none")
- (parameters
- '("gint" "dash_offset")
- '("gint8[]" "dash_list")
- '("gint" "n")
- )
-)
-
-(define-method offset
- (of-object "GdkGC")
- (c-name "gdk_gc_offset")
- (return-type "none")
- (parameters
- '("gint" "x_offset")
- '("gint" "y_offset")
- )
-)
-
-(define-method copy
- (of-object "GdkGC")
- (c-name "gdk_gc_copy")
- (return-type "none")
- (parameters
- '("GdkGC*" "src_gc")
- )
-)
-
-(define-method set_colormap
- (of-object "GdkGC")
- (c-name "gdk_gc_set_colormap")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- )
-)
-
-(define-method get_colormap
- (of-object "GdkGC")
- (c-name "gdk_gc_get_colormap")
- (return-type "GdkColormap*")
-)
-
-(define-method set_rgb_fg_color
- (of-object "GdkGC")
- (c-name "gdk_gc_set_rgb_fg_color")
- (return-type "none")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method set_rgb_bg_color
- (of-object "GdkGC")
- (c-name "gdk_gc_set_rgb_bg_color")
- (return-type "none")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method "get_screen"
- (of-object "GdkGC")
- (c-name "gdk_gc_get_screen")
- (return-type "GdkScreen*")
-)
-
-
-(define-virtual get_values
- (of-object "GdkGC")
- (return-type "none")
- (parameters
- '("GdkGCValues*" "values")
- )
-)
-
-(define-virtual set_values
- (of-object "GdkGC")
- (return-type "none")
- (parameters
- '("GdkGCValues*" "values")
- '("GdkGCValuesMask" "mask")
- )
-)
-
-(define-virtual set_dashes
- (of-object "GdkGC")
- (return-type "none")
- (parameters
- '("gint" "dash_offset")
- '("gint8[]" "dash_list")
- '("gint" "n")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkimage.h
-
-(define-function gdk_image_get_type
- (c-name "gdk_image_get_type")
- (return-type "GType")
-)
-
-(define-function image_new
- (is-constructor-of GdkImage)
- (c-name "gdk_image_new")
- (return-type "GdkImage*")
- (parameters
- '("GdkImageType" "type")
- '("GdkVisual*" "visual")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method ref
- (of-object "GdkImage")
- (c-name "gdk_image_ref")
- (return-type "GdkImage*")
-)
-
-(define-method unref
- (of-object "GdkImage")
- (c-name "gdk_image_unref")
- (return-type "none")
-)
-
-(define-function image_new_bitmap
- (c-name "gdk_image_new_bitmap")
- (return-type "GdkImage*")
- (parameters
- '("GdkVisual*" "visual")
- '("gpointer" "data")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method image_get
- (of-object "GdkDrawable")
- (deprecated "use GdkDrawable.get_image")
- (c-name "gdk_image_get")
- (return-type "GdkImage*")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method put_pixel
- (of-object "GdkImage")
- (c-name "gdk_image_put_pixel")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("guint32" "pixel")
- )
-)
-
-(define-method get_pixel
- (of-object "GdkImage")
- (c-name "gdk_image_get_pixel")
- (return-type "guint32")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method set_colormap
- (of-object "GdkImage")
- (c-name "gdk_image_set_colormap")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- )
-)
-
-(define-method get_colormap
- (of-object "GdkImage")
- (c-name "gdk_image_get_colormap")
- (return-type "GdkColormap*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkinput.h
-
-(define-function device_get_type
- (c-name "gdk_device_get_type")
- (return-type "GType")
-)
-
-(define-function devices_list
- (c-name "gdk_devices_list")
- (return-type "GList*")
-)
-
-(define-method set_source
- (of-object "GdkDevice")
- (c-name "gdk_device_set_source")
- (return-type "none")
- (parameters
- '("GdkInputSource" "source")
- )
-)
-
-(define-method set_mode
- (of-object "GdkDevice")
- (c-name "gdk_device_set_mode")
- (return-type "gboolean")
- (parameters
- '("GdkInputMode" "mode")
- )
-)
-
-(define-method set_key
- (of-object "GdkDevice")
- (c-name "gdk_device_set_key")
- (return-type "none")
- (parameters
- '("guint" "index")
- '("guint" "keyval")
- '("GdkModifierType" "modifiers")
- )
-)
-
-(define-method set_axis_use
- (of-object "GdkDevice")
- (c-name "gdk_device_set_axis_use")
- (return-type "none")
- (parameters
- '("guint" "index")
- '("GdkAxisUse" "use")
- )
-)
-
-(define-method get_state
- (of-object "GdkDevice")
- (c-name "gdk_device_get_state")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("gdouble*" "axes")
- '("GdkModifierType*" "mask")
- )
-)
-
-(define-method get_history
- (of-object "GdkDevice")
- (c-name "gdk_device_get_history")
- (return-type "gboolean")
- (parameters
- '("GdkWindow*" "window")
- '("guint32" "start")
- '("guint32" "stop")
- '("GdkTimeCoord***" "events")
- '("gint*" "n_events")
- )
-)
-
-(define-function device_free_history
- (c-name "gdk_device_free_history")
- (return-type "none")
- (parameters
- '("GdkTimeCoord**" "events")
- '("gint" "n_events")
- )
-)
-
-(define-method get_axis
- (of-object "GdkDevice")
- (c-name "gdk_device_get_axis")
- (return-type "gboolean")
- (parameters
- '("gdouble*" "axes")
- '("GdkAxisUse" "use")
- '("gdouble*" "value")
- )
-)
-
-(define-method input_set_extension_events
- (of-object "GdkWindow")
- (c-name "gdk_input_set_extension_events")
- (return-type "none")
- (parameters
- '("gint" "mask")
- '("GdkExtensionMode" "mode")
- )
-)
-
-(define-function device_get_core_pointer
- (c-name "gdk_device_get_core_pointer")
- (return-type "GdkDevice*")
-)
-
-
-
-;; from /opt/gtk2/include/gtk-2.0/gdk/gdkkeys.h
-
-(define-function gdk_keymap_get_type
- (c-name "gdk_keymap_get_type")
- (return-type "GType")
-)
-
-(define-function keymap_get_default
- (c-name "gdk_keymap_get_default")
- (return-type "GdkKeymap*")
-)
-
-(define-function keymap_get_for_display
- (c-name "gdk_keymap_get_for_display")
- (return-type "GdkKeymap*")
- (parameters
- '("GdkDisplay*" "display")
- )
-)
-
-(define-method lookup_key
- (of-object "GdkKeymap")
- (c-name "gdk_keymap_lookup_key")
- (return-type "guint")
- (parameters
- '("const-GdkKeymapKey*" "key")
- )
-)
-
-(define-method translate_keyboard_state
- (of-object "GdkKeymap")
- (c-name "gdk_keymap_translate_keyboard_state")
- (return-type "gboolean")
- (parameters
- '("guint" "hardware_keycode")
- '("GdkModifierType" "state")
- '("gint" "group")
- '("guint*" "keyval")
- '("gint*" "effective_group")
- '("gint*" "level")
- '("GdkModifierType*" "consumed_modifiers")
- )
-)
-
-(define-method get_entries_for_keyval
- (of-object "GdkKeymap")
- (c-name "gdk_keymap_get_entries_for_keyval")
- (return-type "gboolean")
- (parameters
- '("guint" "keyval")
- '("GdkKeymapKey**" "keys")
- '("gint*" "n_keys")
- )
-)
-
-(define-method get_entries_for_keycode
- (of-object "GdkKeymap")
- (c-name "gdk_keymap_get_entries_for_keycode")
- (return-type "gboolean")
- (parameters
- '("guint" "hardware_keycode")
- '("GdkKeymapKey**" "keys")
- '("guint**" "keyvals")
- '("gint*" "n_entries")
- )
-)
-
-(define-method get_direction
- (of-object "GdkKeymap")
- (c-name "gdk_keymap_get_direction")
- (return-type "PangoDirection")
-)
-
-(define-function keyval_name
- (c-name "gdk_keyval_name")
- (return-type "gchar*")
- (parameters
- '("guint" "keyval")
- )
- (caller-owns-return #f)
-)
-
-(define-function keyval_from_name
- (c-name "gdk_keyval_from_name")
- (return-type "guint")
- (parameters
- '("const-gchar*" "keyval_name")
- )
-)
-
-(define-function keyval_convert_case
- (c-name "gdk_keyval_convert_case")
- (return-type "none")
- (parameters
- '("guint" "symbol")
- '("guint*" "lower")
- '("guint*" "upper")
- )
-)
-
-(define-function keyval_to_upper
- (c-name "gdk_keyval_to_upper")
- (return-type "guint")
- (parameters
- '("guint" "keyval")
- )
-)
-
-(define-function keyval_to_lower
- (c-name "gdk_keyval_to_lower")
- (return-type "guint")
- (parameters
- '("guint" "keyval")
- )
-)
-
-(define-function keyval_is_upper
- (c-name "gdk_keyval_is_upper")
- (return-type "gboolean")
- (parameters
- '("guint" "keyval")
- )
-)
-
-(define-function keyval_is_lower
- (c-name "gdk_keyval_is_lower")
- (return-type "gboolean")
- (parameters
- '("guint" "keyval")
- )
-)
-
-(define-function keyval_to_unicode
- (c-name "gdk_keyval_to_unicode")
- (return-type "guint32")
- (parameters
- '("guint" "keyval")
- )
-)
-
-(define-function unicode_to_keyval
- (c-name "gdk_unicode_to_keyval")
- (return-type "guint")
- (parameters
- '("guint32" "wc")
- )
-)
-
-(define-virtual direction_changed
- (of-object "GdkKeymap")
- (return-type "none")
-)
-
-(define-virtual keys_changed
- (of-object "GdkKeymap")
- (return-type "none")
-)
-
-
-
-;; From /home/jdahlin/dev/gtk-2.8/gtk+/gdk/gdkpango.h
-
-(define-function gdk_pango_renderer_get_type
- (c-name "gdk_pango_renderer_get_type")
- (return-type "GType")
-)
-
-(define-function pango_renderer_new
- (c-name "gdk_pango_renderer_new")
- (is-constructor-of "GdkPangoRenderer")
- (return-type "PangoRenderer*")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-function pango_renderer_get_default
- (c-name "gdk_pango_renderer_get_default")
- (return-type "PangoRenderer*")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-method set_drawable
- (of-object "GdkPangoRenderer")
- (c-name "gdk_pango_renderer_set_drawable")
- (return-type "none")
- (parameters
- '("GdkDrawable*" "drawable" (null-ok))
- )
-)
-
-(define-method set_gc
- (of-object "GdkPangoRenderer")
- (c-name "gdk_pango_renderer_set_gc")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc"(null-ok))
- )
-)
-
-(define-method set_stipple
- (of-object "GdkPangoRenderer")
- (c-name "gdk_pango_renderer_set_stipple")
- (return-type "none")
- (parameters
- '("PangoRenderPart" "part")
- '("GdkBitmap*" "stipple"(null-ok))
- )
-)
-
-(define-method set_override_color
- (of-object "GdkPangoRenderer")
- (c-name "gdk_pango_renderer_set_override_color")
- (return-type "none")
- (parameters
- '("PangoRenderPart" "part")
- '("const-GdkColor*" "color"(null-ok))
- )
-)
-
-(define-function pango_context_get_for_screen
- (c-name "gdk_pango_context_get_for_screen")
- (return-type "PangoContext*")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-function pango_context_get
- (c-name "gdk_pango_context_get")
- (return-type "PangoContext*")
-)
-
-(define-function pango_context_set_colormap
- (c-name "gdk_pango_context_set_colormap")
- (return-type "none")
- (parameters
- '("PangoContext*" "context")
- '("GdkColormap*" "colormap")
- )
-)
-
-(define-function pango_layout_line_get_clip_region
- (c-name "gdk_pango_layout_line_get_clip_region")
- (return-type "GdkRegion*")
- (caller-owns-return #t)
- (parameters
- '("PangoLayoutLine*" "line")
- '("gint" "x_origin")
- '("gint" "y_origin")
- '("gint*" "index_ranges")
- '("gint" "n_ranges")
- )
-)
-
-(define-function pango_layout_get_clip_region
- (c-name "gdk_pango_layout_get_clip_region")
- (return-type "GdkRegion*")
- (caller-owns-return #t)
- (parameters
- '("PangoLayout*" "layout")
- '("gint" "x_origin")
- '("gint" "y_origin")
- '("gint*" "index_ranges")
- '("gint" "n_ranges")
- )
-)
-
-(define-function pango_attr_stipple_new
- (c-name "gdk_pango_attr_stipple_new")
- (is-constructor-of "GdkPangoAttrStipple")
- (return-type "PangoAttribute*")
- (parameters
- '("GdkBitmap*" "stipple")
- )
-)
-
-(define-function pango_attr_embossed_new
- (c-name "gdk_pango_attr_embossed_new")
- (is-constructor-of "GdkPangoAttrEmbossed")
- (return-type "PangoAttribute*")
- (parameters
- '("gboolean" "embossed")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkpixbuf.h
-
-(define-method render_threshold_alpha
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_render_threshold_alpha")
- (return-type "none")
- (parameters
- '("GdkBitmap*" "bitmap")
- '("int" "src_x")
- '("int" "src_y")
- '("int" "dest_x")
- '("int" "dest_y")
- '("int" "width")
- '("int" "height")
- '("int" "alpha_threshold")
- )
-)
-
-(define-method render_pixmap_and_mask_for_colormap
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_render_pixmap_and_mask_for_colormap")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- '("GdkPixmap**" "pixmap_return")
- '("GdkBitmap**" "mask_return")
- '("int" "alpha_threshold")
- )
-)
-
-(define-method render_to_drawable
- (deprecated "use gtk.gdk.Drawable.draw_pixbuf")
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_render_to_drawable")
- (return-type "none")
- (parameters
- '("GdkDrawable*" "drawable")
- '("GdkGC*" "gc")
- '("int" "src_x")
- '("int" "src_y")
- '("int" "dest_x")
- '("int" "dest_y")
- '("int" "width")
- '("int" "height")
- '("GdkRgbDither" "dither" (default "GDK_RGB_DITHER_NORMAL"))
- '("gint" "x_dither" (default "0"))
- '("gint" "y_dither" (default "0"))
- )
-)
-
-(define-method render_to_drawable_alpha
- (deprecated "use gtk.gdk.Drawable.draw_pixbuf")
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_render_to_drawable_alpha")
- (return-type "none")
- (parameters
- '("GdkDrawable*" "drawable")
- '("int" "src_x")
- '("int" "src_y")
- '("int" "dest_x")
- '("int" "dest_y")
- '("int" "width")
- '("int" "height")
- '("GdkPixbufAlphaMode" "alpha_mode")
- '("int" "alpha_threshold")
- '("GdkRgbDither" "dither" (default "GDK_RGB_DITHER_NORMAL"))
- '("gint" "x_dither" (default "0"))
- '("gint" "y_dither" (default "0"))
- )
-)
-
-(define-method render_pixmap_and_mask
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_render_pixmap_and_mask")
- (return-type "none")
- (parameters
- '("GdkPixmap**" "pixmap_return")
- '("GdkBitmap**" "mask_return")
- '("int" "alpha_threshold" (default "127"))
- )
-)
-
-(define-method get_from_drawable
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_get_from_drawable")
- (return-type "GdkPixbuf*")
- (parameters
- '("GdkDrawable*" "src")
- '("GdkColormap*" "cmap")
- '("int" "src_x")
- '("int" "src_y")
- '("int" "dest_x")
- '("int" "dest_y")
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-function pixbuf_get_from_drawable
- (c-name "gdk_pixbuf_get_from_drawable2")
- (return-type "GdkPixbuf*")
- (parameters
- '("GdkPixbuf*" "pixbuf" (null-ok))
- '("GdkDrawable*" "src")
- '("GdkColormap*" "cmap")
- '("int" "src_x")
- '("int" "src_y")
- '("int" "dest_x")
- '("int" "dest_y")
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-method get_from_image
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_get_from_image")
- (return-type "GdkPixbuf*")
- (parameters
- '("GdkImage*" "src")
- '("GdkColormap*" "cmap")
- '("int" "src_x")
- '("int" "src_y")
- '("int" "dest_x")
- '("int" "dest_y")
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-method rotate_simple
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_rotate_simple")
- (return-type "GdkPixbuf*")
- (parameters
- '("int" "angle")
- )
- (caller-owns-return #t)
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkpixmap.h
-
-(define-function gdk_pixmap_get_type
- (c-name "gdk_pixmap_get_type")
- (return-type "GType")
-)
-
-(define-function pixmap_new
- (is-constructor-of GdkPixmap)
- (c-name "gdk_pixmap_new")
- (return-type "GdkPixmap*")
- (parameters
- '("GdkDrawable*" "drawable" (null-ok))
- '("gint" "width")
- '("gint" "height")
- '("gint" "depth" (default "-1"))
- )
-)
-
-(define-function bitmap_create_from_data
- (c-name "gdk_bitmap_create_from_data")
- (return-type "GdkBitmap*")
- (parameters
- '("GdkDrawable*" "drawable" (null-ok))
- '("const-guchar*" "data")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-function pixmap_create_from_data
- (c-name "gdk_pixmap_create_from_data")
- (return-type "GdkPixmap*")
- (parameters
- '("GdkDrawable*" "drawable" (null-ok))
- '("const-guchar*" "data")
- '("gint" "width")
- '("gint" "height")
- '("gint" "depth")
- '("GdkColor*" "fg")
- '("GdkColor*" "bg")
- )
-)
-
-(define-function pixmap_create_from_xpm
- (c-name "gdk_pixmap_create_from_xpm")
- (return-type "GdkPixmap*")
- (parameters
- '("GdkDrawable*" "drawable")
- '("GdkBitmap**" "mask")
- '("GdkColor*" "transparent_color")
- '("const-gchar*" "filename")
- )
-)
-
-(define-function pixmap_colormap_create_from_xpm
- (c-name "gdk_pixmap_colormap_create_from_xpm")
- (return-type "GdkPixmap*")
- (parameters
- '("GdkDrawable*" "drawable")
- '("GdkColormap*" "colormap")
- '("GdkBitmap**" "mask")
- '("GdkColor*" "transparent_color")
- '("const-gchar*" "filename")
- )
-)
-
-(define-function pixmap_create_from_xpm_d
- (c-name "gdk_pixmap_create_from_xpm_d")
- (return-type "GdkPixmap*")
- (parameters
- '("GdkDrawable*" "drawable")
- '("GdkBitmap**" "mask")
- '("GdkColor*" "transparent_color")
- '("gchar**" "data")
- )
-)
-
-(define-function pixmap_colormap_create_from_xpm_d
- (c-name "gdk_pixmap_colormap_create_from_xpm_d")
- (return-type "GdkPixmap*")
- (parameters
- '("GdkDrawable*" "drawable")
- '("GdkColormap*" "colormap")
- '("GdkBitmap**" "mask")
- '("GdkColor*" "transparent_color")
- '("gchar**" "data")
- )
-)
-
-(define-function pixmap_foreign_new
- (c-name "gdk_pixmap_foreign_new")
- (return-type "GdkPixmap*")
- (caller-owns-return #t)
- (parameters
- '("GdkNativeWindow" "anid")
- )
-)
-
-(define-function pixmap_lookup
- (c-name "gdk_pixmap_lookup")
- (return-type "GdkPixmap*")
- (parameters
- '("GdkNativeWindow" "anid")
- )
-)
-
-(define-function pixmap_foreign_new_for_display
- (c-name "gdk_pixmap_foreign_new_for_display")
- (return-type "GdkPixmap*")
- (caller-owns-return #t)
- (parameters
- '("GdkDisplay*" "display")
- '("GdkNativeWindow" "anid")
- )
-)
-
-(define-function pixmap_lookup_for_display
- (c-name "gdk_pixmap_lookup_for_display")
- (return-type "GdkPixmap*")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkNativeWindow" "anid")
- )
-)
-
-
-;; From gdkprivate.h
-
-(define-method destroy_notify
- (of-object "GdkWindow")
- (c-name "gdk_window_destroy_notify")
- (return-type "none")
-)
-
-(define-function synthesize_window_state
- (c-name "gdk_synthesize_window_state")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GdkWindowState" "unset_flags")
- '("GdkWindowState" "set_flags")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkproperty.h
-
-(define-function text_property_to_text_list
- (c-name "gdk_text_property_to_text_list")
- (return-type "gint")
- (parameters
- '("GdkAtom" "encoding")
- '("gint" "format")
- '("const-guchar*" "text")
- '("gint" "length")
- '("gchar***" "list")
- )
-)
-
-(define-function text_property_to_utf8_list
- (c-name "gdk_text_property_to_utf8_list")
- (return-type "gint")
- (parameters
- '("GdkAtom" "encoding")
- '("gint" "format")
- '("const-guchar*" "text")
- '("gint" "length")
- '("gchar***" "list")
- )
-)
-
-(define-function utf8_to_compound_text
- (c-name "gdk_utf8_to_compound_text")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "str")
- '("GdkAtom*" "encoding")
- '("gint*" "format")
- '("guchar**" "ctext")
- '("gint*" "length")
- )
-)
-
-(define-function string_to_compound_text
- (c-name "gdk_string_to_compound_text")
- (return-type "gint")
- (parameters
- '("const-gchar*" "str")
- '("GdkAtom*" "encoding")
- '("gint*" "format")
- '("guchar**" "ctext")
- '("gint*" "length")
- )
-)
-
-(define-function text_property_to_text_list_for_display
- (c-name "gdk_text_property_to_text_list_for_display")
- (return-type "gint")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkAtom" "encoding")
- '("gint" "format")
- '("const-guchar*" "text")
- '("gint" "length")
- '("gchar***" "list")
- )
-)
-
-(define-function text_property_to_utf8_list_for_display
- (c-name "gdk_text_property_to_utf8_list_for_display")
- (return-type "gint")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkAtom" "encoding")
- '("gint" "format")
- '("const-guchar*" "text")
- '("gint" "length")
- '("gchar***" "list")
- )
-)
-
-(define-function utf8_to_string_target
- (c-name "gdk_utf8_to_string_target")
- (return-type "gchar*")
- (parameters
- '("const-gchar*" "str")
- )
-)
-
-(define-function string_to_compound_text_for_display
- (c-name "gdk_string_to_compound_text_for_display")
- (return-type "gint")
- (parameters
- '("GdkDisplay*" "display")
- '("const-gchar*" "str")
- '("GdkAtom*" "encoding")
- '("gint*" "format")
- '("guchar**" "ctext")
- '("gint*" "length")
- )
-)
-
-(define-function utf8_to_compound_text_for_display
- (c-name "gdk_utf8_to_compound_text_for_display")
- (return-type "gboolean")
- (parameters
- '("GdkDisplay*" "display")
- '("const-gchar*" "str")
- '("GdkAtom*" "encoding")
- '("gint*" "format")
- '("guchar**" "ctext")
- '("gint*" "length")
- )
-)
-
-(define-function free_text_list
- (c-name "gdk_free_text_list")
- (return-type "none")
- (parameters
- '("gchar**" "list")
- )
-)
-
-(define-function free_compound_text
- (c-name "gdk_free_compound_text")
- (return-type "none")
- (parameters
- '("guchar*" "ctext")
- )
-)
-
-(define-method name
- (of-object "GdkAtom")
- (c-name "gdk_atom_name")
- (return-type "gchar*")
-)
-
-(define-function atom_intern
- (c-name "gdk_atom_intern")
- (return-type "GdkAtom")
- (parameters
- '("gchar*" "atom_name")
- '("gboolean" "only_if_exists" (default "FALSE"))
- )
-)
-
-(define-method property_get
- (of-object "GdkWindow")
- (c-name "gdk_property_get")
- (return-type "gboolean")
- (parameters
- '("GdkAtom" "property")
- '("GdkAtom" "type")
- '("gulong" "offset")
- '("gulong" "length")
- '("gint" "pdelete")
- '("GdkAtom*" "actual_property_type")
- '("gint*" "actual_format")
- '("gint*" "actual_length")
- '("guchar**" "data")
- )
-)
-
-(define-method property_change
- (of-object "GdkWindow")
- (c-name "gdk_property_change")
- (return-type "none")
- (parameters
- '("GdkAtom" "property")
- '("GdkAtom" "type")
- '("gint" "format")
- '("GdkPropMode" "mode")
- '("const-guchar*" "data")
- '("gint" "nelements")
- )
-)
-
-(define-method property_delete
- (of-object "GdkWindow")
- (c-name "gdk_property_delete")
- (return-type "none")
- (parameters
- '("GdkAtom" "property")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkrgb.h
-
-(define-function rgb_xpixel_from_rgb
- (c-name "gdk_rgb_xpixel_from_rgb")
- (return-type "gulong")
- (parameters
- '("guint32" "rgb")
- )
-)
-
-(define-function rgb_gc_set_foreground
- (c-name "gdk_rgb_gc_set_foreground")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("guint32" "rgb")
- )
-)
-
-(define-function rgb_gc_set_background
- (c-name "gdk_rgb_gc_set_background")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("guint32" "rgb")
- )
-)
-
-(define-method draw_rgb_image
- (of-object "GdkDrawable")
- (c-name "gdk_draw_rgb_image")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GdkRgbDither" "dith")
- '("guchar*" "rgb_buf")
- '("gint" "rowstride")
- )
-)
-
-(define-method draw_rgb_image_dithalign
- (of-object "GdkDrawable")
- (c-name "gdk_draw_rgb_image_dithalign")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GdkRgbDither" "dith")
- '("guchar*" "rgb_buf")
- '("gint" "rowstride")
- '("gint" "xdith")
- '("gint" "ydith")
- )
-)
-
-(define-method draw_rgb_32_image
- (of-object "GdkDrawable")
- (c-name "gdk_draw_rgb_32_image")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GdkRgbDither" "dith")
- '("guchar*" "buf")
- '("gint" "rowstride")
- )
-)
-
-(define-method draw_gray_image
- (of-object "GdkDrawable")
- (c-name "gdk_draw_gray_image")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GdkRgbDither" "dith")
- '("guchar*" "buf")
- '("gint" "rowstride")
- )
-)
-
-(define-function rgb_cmap_new
- (c-name "gdk_rgb_cmap_new")
- (return-type "GdkRgbCmap*")
- (parameters
- '("guint32*" "colors")
- '("gint" "n_colors")
- )
-)
-
-(define-method draw_indexed_image
- (of-object "GdkDrawable")
- (c-name "gdk_draw_indexed_image")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GdkRgbDither" "dith")
- '("guchar*" "buf")
- '("gint" "rowstride")
- '("GdkRgbCmap*" "cmap")
- )
-)
-
-(define-function rgb_ditherable
- (c-name "gdk_rgb_ditherable")
- (return-type "gboolean")
-)
-
-(define-function rgb_set_verbose
- (c-name "gdk_rgb_set_verbose")
- (return-type "none")
- (parameters
- '("gboolean" "verbose")
- )
-)
-
-(define-function rgb_set_install
- (c-name "gdk_rgb_set_install")
- (return-type "none")
- (parameters
- '("gboolean" "install")
- )
-)
-
-(define-function rgb_set_min_colors
- (c-name "gdk_rgb_set_min_colors")
- (return-type "none")
- (parameters
- '("gint" "min_colors")
- )
-)
-
-(define-function rgb_get_colormap
- (c-name "gdk_rgb_get_colormap")
- (return-type "GdkColormap*")
-)
-
-(define-function rgb_get_cmap
- (deprecated "use gtk.gdk.rgb_get_colormap instead")
- (c-name "gdk_rgb_get_cmap")
- (return-type "GdkColormap*")
-)
-
-(define-function rgb_get_visual
- (c-name "gdk_rgb_get_visual")
- (return-type "GdkVisual*")
-)
-
-(define-function rgb_init
- (c-name "gdk_rgb_init")
- (return-type "none")
-)
-
-(define-function rgb_find_color
- (c-name "gdk_rgb_find_color")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- '("GdkColor*" "color")
- )
-)
-
-(define-function draw_rgb_32_image_dithalign
- (c-name "gdk_draw_rgb_32_image_dithalign")
- (return-type "none")
- (parameters
- '("GdkDrawable*" "drawable")
- '("GdkGC*" "gc")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GdkRgbDither" "dith")
- '("guchar*" "buf")
- '("gint" "rowstride")
- '("gint" "xdith")
- '("gint" "ydith")
- )
-)
-
-(define-method free
- (of-object "GdkRgbCmap")
- (c-name "gdk_rgb_cmap_free")
- (return-type "none")
-)
-
-(define-function rgb_colormap_ditherable
- (c-name "gdk_rgb_colormap_ditherable")
- (return-type "gboolean")
- (parameters
- '("GdkColormap*" "cmap")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkscreen.h
-
-(define-function gdk_screen_get_type
- (c-name "gdk_screen_get_type")
- (return-type "GType")
-)
-
-(define-method get_default_colormap
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_default_colormap")
- (return-type "GdkColormap*")
-)
-
-(define-method set_default_colormap
- (of-object "GdkScreen")
- (c-name "gdk_screen_set_default_colormap")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- )
-)
-
-(define-method get_system_colormap
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_system_colormap")
- (return-type "GdkColormap*")
-)
-
-(define-method get_system_visual
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_system_visual")
- (return-type "GdkVisual*")
-)
-
-(define-method get_rgb_colormap
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_rgb_colormap")
- (return-type "GdkColormap*")
-)
-
-(define-method get_rgba_colormap
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_rgba_colormap")
- (return-type "GdkColormap*")
-)
-
-(define-method get_rgb_visual
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_rgb_visual")
- (return-type "GdkVisual*")
-)
-
-(define-method get_rgba_visual
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_rgba_visual")
- (return-type "GdkVisual*")
-)
-
-(define-method get_root_window
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_root_window")
- (return-type "GdkWindow*")
-)
-
-(define-method get_display
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_display")
- (return-type "GdkDisplay*")
-)
-
-(define-method get_number
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_number")
- (return-type "gint")
-)
-
-(define-method get_width
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_width")
- (return-type "gint")
-)
-
-(define-method get_height
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_height")
- (return-type "gint")
-)
-
-(define-method get_width_mm
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_width_mm")
- (return-type "gint")
-)
-
-(define-method get_height_mm
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_height_mm")
- (return-type "gint")
-)
-
-(define-method list_visuals
- (of-object "GdkScreen")
- (c-name "gdk_screen_list_visuals")
- (return-type "GList*")
-)
-
-(define-method get_toplevel_windows
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_toplevel_windows")
- (return-type "GList*")
-)
-
-(define-method make_display_name
- (of-object "GdkScreen")
- (c-name "gdk_screen_make_display_name")
- (return-type "gchar*")
-)
-
-(define-method get_n_monitors
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_n_monitors")
- (return-type "gint")
-)
-
-(define-method get_monitor_geometry
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_monitor_geometry")
- (return-type "none")
- (parameters
- '("gint" "monitor_num")
- '("GdkRectangle*" "dest")
- )
-)
-
-(define-method get_monitor_at_point
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_monitor_at_point")
- (return-type "gint")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method get_monitor_at_window
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_monitor_at_window")
- (return-type "gint")
- (parameters
- '("GdkWindow*" "window")
- )
-)
-
-(define-method broadcast_client_message
- (of-object "GdkScreen")
- (c-name "gdk_screen_broadcast_client_message")
- (return-type "none")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-
-(define-function screen_get_default
- (c-name "gdk_screen_get_default")
- (return-type "GdkScreen*")
-)
-
-(define-method get_setting
- (of-object "GdkScreen")
- (c-name "gdk_screen_get_setting")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "name")
- '("GValue*" "value")
- )
-)
-
-(define-method alternative_dialog_button_order
- (of-object "GdkScreen")
- (c-name "gtk_alternative_dialog_button_order")
- (return-type "gboolean")
-)
-
-
-(define-virtual size_changed
- (of-object "GdkScreen")
- (return-type "none")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkselection.h
-
-(define-function selection_owner_set
- (c-name "gdk_selection_owner_set")
- (return-type "gboolean")
- (parameters
- '("GdkWindow*" "owner")
- '("GdkAtom" "selection")
- '("guint32" "time")
- '("gboolean" "send_event")
- )
-)
-
-(define-function selection_owner_get
- (c-name "gdk_selection_owner_get")
- (return-type "GdkWindow*")
- (parameters
- '("GdkAtom" "selection")
- )
-)
-
-(define-function selection_owner_set_for_display
- (c-name "gdk_selection_owner_set_for_display")
- (return-type "gboolean")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkWindow*" "owner")
- '("GdkAtom" "selection")
- '("guint32" "time")
- '("gboolean" "send_event")
- )
-)
-
-(define-function selection_owner_get_for_display
- (c-name "gdk_selection_owner_get_for_display")
- (return-type "GdkWindow*")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkAtom" "selection")
- )
-)
-
-(define-method selection_convert
- (of-object "GdkWindow")
- (c-name "gdk_selection_convert")
- (return-type "none")
- (parameters
- '("GdkAtom" "selection")
- '("GdkAtom" "target")
- '("guint32" "time")
- )
-)
-
-(define-method selection_property_get
- (of-object "GdkWindow")
- (c-name "gdk_selection_property_get")
- (return-type "gboolean")
- (parameters
- '("guchar**" "data")
- '("GdkAtom*" "prop_type")
- '("gint*" "prop_format")
- )
-)
-
-(define-function selection_send_notify
- (c-name "gdk_selection_send_notify")
- (return-type "none")
- (parameters
- '("guint32" "requestor")
- '("GdkAtom" "selection")
- '("GdkAtom" "target")
- '("GdkAtom" "property")
- '("guint32" "time")
- )
-)
-
-(define-function selection_send_notify_for_display
- (c-name "gdk_selection_send_notify_for_display")
- (return-type "none")
- (parameters
- '("GdkDisplay*" "display")
- '("guint32" "requestor")
- '("GdkAtom" "selection")
- '("GdkAtom" "target")
- '("GdkAtom" "property")
- '("guint32" "time")
- )
-)
-
-;; From /mondo/local/gtk-2.10/include/gtk-2.0/gdk/gdkspawn.h
-
-(define-function spawn_on_screen
- (c-name "gdk_spawn_on_screen")
- (return-type "gboolean")
- (parameters
- '("GdkScreen*" "screen")
- '("const-gchar*" "working_directory")
- '("gchar**" "argv")
- '("gchar**" "envp")
- '("GSpawnFlags" "flags")
- '("GSpawnChildSetupFunc" "child_setup")
- '("gpointer" "user_data")
- '("gint*" "child_pid")
- '("GError**" "error")
- )
-)
-
-(define-function spawn_on_screen_with_pipes
- (c-name "gdk_spawn_on_screen_with_pipes")
- (return-type "gboolean")
- (parameters
- '("GdkScreen*" "screen")
- '("const-gchar*" "working_directory")
- '("gchar**" "argv")
- '("gchar**" "envp")
- '("GSpawnFlags" "flags")
- '("GSpawnChildSetupFunc" "child_setup")
- '("gpointer" "user_data")
- '("gint*" "child_pid")
- '("gint*" "standard_input")
- '("gint*" "standard_output")
- '("gint*" "standard_error")
- '("GError**" "error")
- )
-)
-
-(define-function spawn_command_line_on_screen
- (c-name "gdk_spawn_command_line_on_screen")
- (return-type "gboolean")
- (parameters
- '("GdkScreen*" "screen")
- '("const-gchar*" "command_line")
- '("GError**" "error")
- )
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkvisual.h
-
-(define-function gdk_visual_get_type
- (c-name "gdk_visual_get_type")
- (return-type "GType")
-)
-
-(define-function visual_get_best_depth
- (c-name "gdk_visual_get_best_depth")
- (return-type "gint")
-)
-
-(define-function visual_get_best_type
- (c-name "gdk_visual_get_best_type")
- (return-type "GdkVisualType")
-)
-
-(define-function visual_get_system
- (c-name "gdk_visual_get_system")
- (return-type "GdkVisual*")
-)
-
-(define-function visual_get_best
- (c-name "gdk_visual_get_best")
- (return-type "GdkVisual*")
-)
-
-(define-function visual_get_best_with_depth
- (c-name "gdk_visual_get_best_with_depth")
- (return-type "GdkVisual*")
- (parameters
- '("gint" "depth")
- )
-)
-
-(define-function visual_get_best_with_type
- (c-name "gdk_visual_get_best_with_type")
- (return-type "GdkVisual*")
- (parameters
- '("GdkVisualType" "visual_type")
- )
-)
-
-(define-function visual_get_best_with_both
- (is-constructor-of GdkVisual)
- (c-name "gdk_visual_get_best_with_both")
- (return-type "GdkVisual*")
- (parameters
- '("gint" "depth")
- '("GdkVisualType" "visual_type")
- )
-)
-
-(define-function query_depths
- (c-name "gdk_query_depths")
- (return-type "none")
- (parameters
- '("gint**" "depths")
- '("gint*" "count")
- )
-)
-
-(define-function query_visual_types
- (c-name "gdk_query_visual_types")
- (return-type "none")
- (parameters
- '("GdkVisualType**" "visual_types")
- '("gint*" "count")
- )
-)
-
-(define-function list_visuals
- (c-name "gdk_list_visuals")
- (return-type "GList*")
-)
-
-(define-method get_screen
- (of-object "GdkVisual")
- (c-name "gdk_visual_get_screen")
- (return-type "GdkScreen*")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk/gdkwindow.h
-
-(define-function gdk_window_object_get_type
- (c-name "gdk_window_object_get_type")
- (return-type "GType")
-)
-
-(define-function new
- (is-constructor-of GdkWindow)
- (c-name "gdk_window_new")
- (return-type "GdkWindow*")
- (parameters
- '("GdkWindow*" "parent")
- '("GdkWindowAttr*" "attributes")
- '("gint" "attributes_mask")
- )
-)
-
-(define-method set_keep_above
- (c-name "gdk_window_set_keep_above")
- (of-object "GdkWindow")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method set_keep_below
- (c-name "gdk_window_set_keep_below")
- (of-object "GdkWindow")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method destroy
- (of-object "GdkWindow")
- (c-name "gdk_window_destroy")
- (return-type "none")
-)
-
-(define-method get_window_type
- (of-object "GdkWindow")
- (c-name "gdk_window_get_window_type")
- (return-type "GdkWindowType")
-)
-
-(define-function window_at_pointer
- (c-name "gdk_window_at_pointer")
- (return-type "GdkWindow*")
- (parameters
- '("gint*" "win_x")
- '("gint*" "win_y")
- )
-)
-
-(define-method show
- (of-object "GdkWindow")
- (c-name "gdk_window_show")
- (return-type "none")
-)
-
-(define-method hide
- (of-object "GdkWindow")
- (c-name "gdk_window_hide")
- (return-type "none")
-)
-
-(define-method withdraw
- (of-object "GdkWindow")
- (c-name "gdk_window_withdraw")
- (return-type "none")
-)
-
-(define-method move
- (of-object "GdkWindow")
- (c-name "gdk_window_move")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method resize
- (of-object "GdkWindow")
- (c-name "gdk_window_resize")
- (return-type "none")
- (parameters
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method move_resize
- (of-object "GdkWindow")
- (c-name "gdk_window_move_resize")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method reparent
- (of-object "GdkWindow")
- (c-name "gdk_window_reparent")
- (return-type "none")
- (parameters
- '("GdkWindow*" "new_parent")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method clear
- (of-object "GdkWindow")
- (c-name "gdk_window_clear")
- (return-type "none")
-)
-
-(define-method clear_area
- (of-object "GdkWindow")
- (c-name "gdk_window_clear_area")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method clear_area_e
- (of-object "GdkWindow")
- (c-name "gdk_window_clear_area_e")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method raise
- (of-object "GdkWindow")
- (c-name "gdk_window_raise")
- (return-type "none")
-)
-
-(define-method lower
- (of-object "GdkWindow")
- (c-name "gdk_window_lower")
- (return-type "none")
-)
-
-(define-method focus
- (of-object "GdkWindow")
- (c-name "gdk_window_focus")
- (return-type "none")
- (parameters
- '("guint32" "timestamp" (null-ok) (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method set_user_data
- (of-object "GdkWindow")
- (c-name "gdk_window_set_user_data")
- (return-type "none")
- (parameters
- '("gpointer" "user_data")
- )
-)
-
-(define-method get_user_data
- (of-object "GdkWindow")
- (c-name "gdk_window_get_user_data")
- (return-type "none")
- (parameters
- '("gpointer*" "user_data")
- )
-)
-
-(define-method set_override_redirect
- (of-object "GdkWindow")
- (c-name "gdk_window_set_override_redirect")
- (return-type "none")
- (parameters
- '("gboolean" "override_redirect")
- )
-)
-
-(define-method add_filter
- (of-object "GdkWindow")
- (c-name "gdk_window_add_filter")
- (return-type "none")
- (parameters
- '("GdkFilterFunc" "function")
- '("gpointer" "data")
- )
-)
-
-(define-method remove_filter
- (of-object "GdkWindow")
- (c-name "gdk_window_remove_filter")
- (return-type "none")
- (parameters
- '("GdkFilterFunc" "function")
- '("gpointer" "data")
- )
-)
-
-(define-method scroll
- (of-object "GdkWindow")
- (c-name "gdk_window_scroll")
- (return-type "none")
- (parameters
- '("gint" "dx")
- '("gint" "dy")
- )
-)
-
-(define-method shape_combine_mask
- (of-object "GdkWindow")
- (c-name "gdk_window_shape_combine_mask")
- (return-type "none")
- (parameters
- '("GdkBitmap*" "shape_mask" (null-ok))
- '("gint" "offset_x")
- '("gint" "offset_y")
- )
-)
-
-(define-method set_child_shapes
- (of-object "GdkWindow")
- (c-name "gdk_window_set_child_shapes")
- (return-type "none")
-)
-
-(define-method merge_child_shapes
- (of-object "GdkWindow")
- (c-name "gdk_window_merge_child_shapes")
- (return-type "none")
-)
-
-(define-method is_visible
- (of-object "GdkWindow")
- (c-name "gdk_window_is_visible")
- (return-type "gboolean")
-)
-
-(define-method is_viewable
- (of-object "GdkWindow")
- (c-name "gdk_window_is_viewable")
- (return-type "gboolean")
-)
-
-(define-method get_state
- (of-object "GdkWindow")
- (c-name "gdk_window_get_state")
- (return-type "GdkWindowState")
-)
-
-(define-method set_static_gravities
- (of-object "GdkWindow")
- (c-name "gdk_window_set_static_gravities")
- (return-type "gboolean")
- (parameters
- '("gboolean" "use_static")
- )
-)
-
-(define-function window_foreign_new
- (c-name "gdk_window_foreign_new")
- (return-type "GdkWindow*")
- (caller-owns-return #t)
- (parameters
- '("GdkNativeWindow" "anid")
- )
-)
-
-(define-function window_lookup
- (c-name "gdk_window_lookup")
- (return-type "GdkWindow*")
- (parameters
- '("GdkNativeWindow" "anid")
- )
-)
-
-(define-function window_foreign_new_for_display
- (c-name "gdk_window_foreign_new_for_display")
- (return-type "GdkWindow*")
- (caller-owns-return #t)
- (parameters
- '("GdkDisplay*" "display")
- '("GdkNativeWindow" "anid")
- )
-)
-
-(define-function window_lookup_for_display
- (c-name "gdk_window_lookup_for_display")
- (return-type "GdkWindow*")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkNativeWindow" "anid")
- )
-)
-
-(define-method set_hints
- (of-object "GdkWindow")
- (c-name "gdk_window_set_hints")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "min_width")
- '("gint" "min_height")
- '("gint" "max_width")
- '("gint" "max_height")
- '("gint" "flags")
- )
-)
-
-(define-method set_type_hint
- (of-object "GdkWindow")
- (c-name "gdk_window_set_type_hint")
- (return-type "none")
- (parameters
- '("GdkWindowTypeHint" "hint")
- )
-)
-
-(define-method set_modal_hint
- (of-object "GdkWindow")
- (c-name "gdk_window_set_modal_hint")
- (return-type "none")
- (parameters
- '("gboolean" "modal")
- )
-)
-
-(define-method set_skip_taskbar_hint
- (of-object "GdkWindow")
- (c-name "gdk_window_set_skip_taskbar_hint")
- (return-type "none")
- (parameters
- '("gboolean" "modal")
- )
-)
-
-(define-method set_skip_pager_hint
- (of-object "GdkWindow")
- (c-name "gdk_window_set_skip_pager_hint")
- (return-type "none")
- (parameters
- '("gboolean" "modal")
- )
-)
-
-(define-method set_geometry_hints
- (of-object "GdkWindow")
- (c-name "gdk_window_set_geometry_hints")
- (return-type "none")
- (parameters
- '("GdkGeometry*" "geometry")
- '("GdkWindowHints" "flags")
- )
-)
-
-(define-function set_sm_client_id
- (c-name "gdk_set_sm_client_id")
- (return-type "none")
- (parameters
- '("const-gchar*" "sm_client_id")
- )
-)
-
-(define-method begin_paint_rect
- (of-object "GdkWindow")
- (c-name "gdk_window_begin_paint_rect")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "rectangle")
- )
-)
-
-(define-method begin_paint_region
- (of-object "GdkWindow")
- (c-name "gdk_window_begin_paint_region")
- (return-type "none")
- (parameters
- '("GdkRegion*" "region")
- )
-)
-
-(define-method end_paint
- (of-object "GdkWindow")
- (c-name "gdk_window_end_paint")
- (return-type "none")
-)
-
-(define-method set_title
- (of-object "GdkWindow")
- (c-name "gdk_window_set_title")
- (return-type "none")
- (parameters
- '("const-gchar*" "title")
- )
-)
-
-(define-method set_role
- (of-object "GdkWindow")
- (c-name "gdk_window_set_role")
- (return-type "none")
- (parameters
- '("const-gchar*" "role")
- )
-)
-
-(define-method set_transient_for
- (of-object "GdkWindow")
- (c-name "gdk_window_set_transient_for")
- (return-type "none")
- (parameters
- '("GdkWindow*" "leader")
- )
-)
-
-(define-method set_background
- (of-object "GdkWindow")
- (c-name "gdk_window_set_background")
- (return-type "none")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method set_back_pixmap
- (of-object "GdkWindow")
- (c-name "gdk_window_set_back_pixmap")
- (return-type "none")
- (parameters
- '("GdkPixmap*" "pixmap" (null-ok))
- '("gboolean" "parent_relative")
- )
-)
-
-(define-method set_cursor
- (of-object "GdkWindow")
- (c-name "gdk_window_set_cursor")
- (return-type "none")
- (parameters
- '("GdkCursor*" "cursor" (null-ok))
- )
-)
-
-(define-method get_geometry
- (of-object "GdkWindow")
- (c-name "gdk_window_get_geometry")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- '("gint*" "width")
- '("gint*" "height")
- '("gint*" "depth")
- )
-)
-
-(define-method get_position
- (of-object "GdkWindow")
- (c-name "gdk_window_get_position")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- )
-)
-
-(define-method get_origin
- (of-object "GdkWindow")
- (c-name "gdk_window_get_origin")
- (return-type "gint")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- )
-)
-
-(define-method get_deskrelative_origin
- (of-object "GdkWindow")
- (c-name "gdk_window_get_deskrelative_origin")
- (return-type "gboolean")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- )
-)
-
-(define-method get_root_origin
- (of-object "GdkWindow")
- (c-name "gdk_window_get_root_origin")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- )
-)
-
-(define-method get_frame_extents
- (of-object "GdkWindow")
- (c-name "gdk_window_get_frame_extents")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "rect")
- )
-)
-
-(define-method get_pointer
- (of-object "GdkWindow")
- (c-name "gdk_window_get_pointer")
- (return-type "GdkWindow*")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- '("GdkModifierType*" "mask")
- )
-)
-
-(define-method get_parent
- (of-object "GdkWindow")
- (c-name "gdk_window_get_parent")
- (return-type "GdkWindow*")
-)
-
-(define-method get_toplevel
- (of-object "GdkWindow")
- (c-name "gdk_window_get_toplevel")
- (return-type "GdkWindow*")
-)
-
-(define-method get_children
- (of-object "GdkWindow")
- (c-name "gdk_window_get_children")
- (return-type "GList*")
-)
-
-(define-method peek_children
- (of-object "GdkWindow")
- (c-name "gdk_window_peek_children")
- (return-type "GList*")
-)
-
-(define-method get_events
- (of-object "GdkWindow")
- (c-name "gdk_window_get_events")
- (return-type "GdkEventMask")
-)
-
-(define-method set_events
- (of-object "GdkWindow")
- (c-name "gdk_window_set_events")
- (return-type "none")
- (parameters
- '("GdkEventMask" "event_mask")
- )
-)
-
-(define-method set_icon_list
- (of-object "GdkWindow")
- (c-name "gdk_window_set_icon_list")
- (return-type "none")
- (parameters
- '("GList*" "pixbufs")
- )
-)
-
-(define-method set_icon
- (of-object "GdkWindow")
- (c-name "gdk_window_set_icon")
- (return-type "none")
- (parameters
- '("GdkWindow*" "icon_window")
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask")
- )
-)
-
-(define-method set_icon_name
- (of-object "GdkWindow")
- (c-name "gdk_window_set_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method set_group
- (of-object "GdkWindow")
- (c-name "gdk_window_set_group")
- (return-type "none")
- (parameters
- '("GdkWindow*" "leader")
- )
-)
-
-(define-method get_group
- (of-object "GdkWindow")
- (c-name "gdk_window_get_group")
- (return-type "GdkWindow*")
-)
-
-(define-method set_decorations
- (of-object "GdkWindow")
- (c-name "gdk_window_set_decorations")
- (return-type "none")
- (parameters
- '("GdkWMDecoration" "decorations")
- )
-)
-
-(define-method get_decorations
- (of-object "GdkWindow")
- (c-name "gdk_window_get_decorations")
- (return-type "gboolean")
- (parameters
- '("GdkWMDecoration*" "decorations")
- )
-)
-
-(define-method set_functions
- (of-object "GdkWindow")
- (c-name "gdk_window_set_functions")
- (return-type "none")
- (parameters
- '("GdkWMFunction" "functions")
- )
-)
-
-(define-function window_get_toplevels
- (c-name "gdk_window_get_toplevels")
- (return-type "GList*")
-)
-
-(define-method iconify
- (of-object "GdkWindow")
- (c-name "gdk_window_iconify")
- (return-type "none")
-)
-
-(define-method deiconify
- (of-object "GdkWindow")
- (c-name "gdk_window_deiconify")
- (return-type "none")
-)
-
-(define-method stick
- (of-object "GdkWindow")
- (c-name "gdk_window_stick")
- (return-type "none")
-)
-
-(define-method unstick
- (of-object "GdkWindow")
- (c-name "gdk_window_unstick")
- (return-type "none")
-)
-
-(define-method maximize
- (of-object "GdkWindow")
- (c-name "gdk_window_maximize")
- (return-type "none")
-)
-
-(define-method unmaximize
- (of-object "GdkWindow")
- (c-name "gdk_window_unmaximize")
- (return-type "none")
-)
-
-(define-method fullscreen
- (of-object "GdkWindow")
- (c-name "gdk_window_fullscreen")
- (return-type "none")
-)
-
-(define-method unfullscreen
- (of-object "GdkWindow")
- (c-name "gdk_window_unfullscreen")
- (return-type "none")
-)
-
-(define-method register_dnd
- (of-object "GdkWindow")
- (c-name "gdk_window_register_dnd")
- (return-type "none")
-)
-
-(define-method begin_resize_drag
- (of-object "GdkWindow")
- (c-name "gdk_window_begin_resize_drag")
- (return-type "none")
- (parameters
- '("GdkWindowEdge" "edge")
- '("gint" "button")
- '("gint" "root_x")
- '("gint" "root_y")
- '("guint32" "timestamp")
- )
-)
-
-(define-method begin_move_drag
- (of-object "GdkWindow")
- (c-name "gdk_window_begin_move_drag")
- (return-type "none")
- (parameters
- '("gint" "button")
- '("gint" "root_x")
- '("gint" "root_y")
- '("guint32" "timestamp")
- )
-)
-
-(define-method invalidate_rect
- (of-object "GdkWindow")
- (c-name "gdk_window_invalidate_rect")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "rect" (null-ok))
- '("gboolean" "invalidate_children")
- )
-)
-
-(define-method invalidate_region
- (of-object "GdkWindow")
- (c-name "gdk_window_invalidate_region")
- (return-type "none")
- (parameters
- '("GdkRegion*" "region")
- '("gboolean" "invalidate_children")
- )
-)
-
-(define-method invalidate_maybe_recurse
- (of-object "GdkWindow")
- (c-name "gdk_window_invalidate_maybe_recurse")
- (return-type "none")
- (parameters
- '("GdkRegion*" "region")
- '("gboolean (*child_func)(GdkWindow *, gpointer)" "child_func")
- )
-)
-
-(define-method get_update_area
- (of-object "GdkWindow")
- (c-name "gdk_window_get_update_area")
- (return-type "GdkRegion*")
- (caller-owns-return #t)
-)
-
-(define-method freeze_updates
- (of-object "GdkWindow")
- (c-name "gdk_window_freeze_updates")
- (return-type "none")
-)
-
-(define-method thaw_updates
- (of-object "GdkWindow")
- (c-name "gdk_window_thaw_updates")
- (return-type "none")
-)
-
-(define-function window_process_all_updates
- (c-name "gdk_window_process_all_updates")
- (return-type "none")
-)
-
-(define-method process_updates
- (of-object "GdkWindow")
- (c-name "gdk_window_process_updates")
- (return-type "none")
- (parameters
- '("gboolean" "update_children")
- )
-)
-
-(define-function window_set_debug_updates
- (c-name "gdk_window_set_debug_updates")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-function window_constrain_size
- (c-name "gdk_window_constrain_size")
- (return-type "none")
- (parameters
- '("GdkGeometry*" "geometry")
- '("guint" "flags")
- '("gint" "width")
- '("gint" "height")
- '("gint*" "new_width")
- '("gint*" "new_height")
- )
-)
-
-(define-method get_internal_paint_info
- (of-object "GdkWindow")
- (c-name "gdk_window_get_internal_paint_info")
- (return-type "none")
- (parameters
- '("GdkDrawable**" "real_drawable")
- '("gint*" "x_offset")
- '("gint*" "y_offset")
- )
-)
-
-(define-function set_pointer_hooks
- (c-name "gdk_set_pointer_hooks")
- (return-type "GdkPointerHooks*")
- (parameters
- '("const-GdkPointerHooks*" "new_hooks")
- )
-)
-
-(define-function get_default_root_window
- (c-name "gdk_get_default_root_window")
- (return-type "GdkWindow*")
-)
-
-(define-method set_accept_focus
- (of-object "GdkWindow")
- (c-name "gdk_window_set_accept_focus")
- (return-type "none")
- (parameters
- '("gboolean" "accept_focus")
- )
-)
-
-(define-method set_focus_on_map
- (of-object "GdkWindow")
- (c-name "gdk_window_set_focus_on_map")
- (return-type "none")
- (parameters
- '("gboolean" "focus_on_map")
- )
-)
-
-(define-method enable_synchronized_configure
- (of-object "GdkWindow")
- (c-name "gdk_window_enable_synchronized_configure")
- (return-type "none")
-)
-
-(define-method configure_finished
- (of-object "GdkWindow")
- (c-name "gdk_window_configure_finished")
- (return-type "none")
-)
-
-(define-method set_urgency_hint
- (of-object "GdkWindow")
- (c-name "gdk_window_set_urgency_hint")
- (return-type "none")
- (parameters
- '("gboolean" "urgent")
- )
-)
-
-;; From /mondo/local/gtk-2.10/include/gtk-2.0/gdk/gdkwindow.h
-
-(define-method show_unraised
- (of-object "GdkWindow")
- (c-name "gdk_window_show_unraised")
- (return-type "none")
-)
-
-(define-method move_region
- (of-object "GdkWindow")
- (c-name "gdk_window_move_region")
- (return-type "none")
- (parameters
- '("GdkRegion*" "region")
- '("gint" "dx")
- '("gint" "dy")
- )
-)
-
-(define-method shape_combine_region
- (of-object "GdkWindow")
- (c-name "gdk_window_shape_combine_region")
- (return-type "none")
- (parameters
- '("GdkRegion*" "shape_region" (null-ok))
- '("gint" "offset_x")
- '("gint" "offset_y")
- )
-)
-
-
-;;; XXXX functions from GTK that extend GDK types.
-(define-method finish
- (of-object "GdkDragContext")
- (c-name "gtk_drag_finish")
- (return-type "none")
- (parameters
- '("gboolean" "success")
- '("gboolean" "del")
- '("guint32" "time" (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method get_source_widget
- (of-object "GdkDragContext")
- (c-name "gtk_drag_get_source_widget")
- (return-type "GtkWidget*")
-)
-
-(define-method set_icon_widget
- (of-object "GdkDragContext")
- (c-name "gtk_drag_set_icon_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("gint" "hot_x")
- '("gint" "hot_y")
- )
-)
-
-(define-method set_icon_pixmap
- (of-object "GdkDragContext")
- (c-name "gtk_drag_set_icon_pixmap")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask")
- '("gint" "hot_x")
- '("gint" "hot_y")
- )
-)
-
-(define-method set_icon_pixbuf
- (of-object "GdkDragContext")
- (c-name "gtk_drag_set_icon_pixbuf")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "pixbuf")
- '("gint" "hot_x")
- '("gint" "hot_y")
- )
-)
-
-(define-method set_icon_stock
- (of-object "GdkDragContext")
- (c-name "gtk_drag_set_icon_stock")
- (return-type "none")
- (parameters
- '("const-gchar*" "stock_id")
- '("gint" "hot_x")
- '("gint" "hot_y")
- )
-)
-
-(define-method set_icon_default
- (of-object "GdkDragContext")
- (c-name "gtk_drag_set_icon_default")
- (return-type "none")
-)
-
-(define-method set_icon_name
- (of-object "GdkDragContext")
- (c-name "gtk_drag_set_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "icon_name")
- '("gint" "hot_x")
- '("gint" "hot_y")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gdk-pixbuf/gdk-pixbuf.h
-
-(define-method get_colorspace
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_get_colorspace")
- (return-type "GdkColorspace")
-)
-
-(define-method get_n_channels
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_get_n_channels")
- (return-type "int")
-)
-
-(define-method get_has_alpha
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_get_has_alpha")
- (return-type "gboolean")
-)
-
-(define-method get_bits_per_sample
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_get_bits_per_sample")
- (return-type "int")
-)
-
-(define-method get_pixels
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_get_pixels")
- (return-type "guchar*")
-)
-
-(define-method get_width
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_get_width")
- (return-type "int")
-)
-
-(define-method get_height
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_get_height")
- (return-type "int")
-)
-
-(define-method get_rowstride
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_get_rowstride")
- (return-type "int")
-)
-
-(define-function pixbuf_new
- (is-constructor-of GdkPixbuf)
- (c-name "gdk_pixbuf_new")
- (return-type "GdkPixbuf*")
- (parameters
- '("GdkColorspace" "colorspace")
- '("gboolean" "has_alpha")
- '("int" "bits_per_sample")
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-method copy
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_copy")
- (caller-owns-return #t)
- (return-type "GdkPixbuf*")
-)
-
-(define-function pixbuf_new_from_file
- (c-name "gdk_pixbuf_new_from_file")
- (return-type "GdkPixbuf*")
- (caller-owns-return #t)
- (parameters
- '("const-char*" "filename")
- '("GError**" "error")
- )
-)
-
-(define-function pixbuf_new_from_file_at_size
- (c-name "gdk_pixbuf_new_from_file_at_size")
- (return-type "GdkPixbuf*")
- (caller-owns-return #t)
- (parameters
- '("const-char*" "filename")
- '("int" "width")
- '("int" "height")
- '("GError**" "error")
- )
-)
-
-(define-function pixbuf_new_from_data
- (c-name "gdk_pixbuf_new_from_data")
- (return-type "GdkPixbuf*")
- (caller-owns-return #t)
- (parameters
- '("const-guchar*" "data")
- '("GdkColorspace" "colorspace")
- '("gboolean" "has_alpha")
- '("int" "bits_per_sample")
- '("int" "width")
- '("int" "height")
- '("int" "rowstride")
- '("GdkPixbufDestroyNotify" "destroy_fn")
- '("gpointer" "destroy_fn_data")
- )
-)
-
-(define-function pixbuf_new_from_array
- (c-name "gdk_pixbuf_new_from_array")
- (return-type "GdkPixbuf*")
- (caller-owns-return #t)
- (parameters
- '("PyArrayObject*" "array")
- '("GdkColorspace" "colorspace")
- '("int" "bits_per_sample")
- )
-)
-
-(define-function pixbuf_new_from_xpm_data
- (c-name "gdk_pixbuf_new_from_xpm_data")
- (return-type "GdkPixbuf*")
- (caller-owns-return #t)
- (parameters
- '("const-char**" "data")
- )
-)
-
-(define-function pixbuf_new_from_inline
- (c-name "gdk_pixbuf_new_from_inline")
- (return-type "GdkPixbuf*")
- (caller-owns-return #t)
- (parameters
- '("gint" "data_length")
- '("const-guchar*" "data")
- '("gboolean" "copy_pixels")
- '("GError**" "error")
- )
-)
-
-(define-method subpixbuf
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_new_subpixbuf")
- (return-type "GdkPixbuf*")
- (caller-owns-return #t)
- (parameters
- '("int" "src_x")
- '("int" "src_y")
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-method fill
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_fill")
- (parameters
- '("guint32" "pixel")
- )
-)
-
-(define-method save
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_save")
- (return-type "gboolean")
- (parameters
- '("const-char*" "filename")
- '("const-char*" "type")
- '("GError**" "error")
- )
- (varargs #t)
-)
-
-(define-method savev
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_savev")
- (return-type "gboolean")
- (parameters
- '("const-char*" "filename")
- '("const-char*" "type")
- '("char**" "option_keys")
- '("char**" "option_values")
- '("GError**" "error")
- )
-)
-
-(define-method save_to_callback
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_save_to_callback")
- ;; overridden
-)
-
-(define-method add_alpha
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_add_alpha")
- (caller-owns-return #t)
- (return-type "GdkPixbuf*")
- (parameters
- '("gboolean" "substitute_color")
- '("guchar" "r")
- '("guchar" "g")
- '("guchar" "b")
- )
-)
-
-(define-method copy_area
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_copy_area")
- (return-type "none")
- (parameters
- '("int" "src_x")
- '("int" "src_y")
- '("int" "width")
- '("int" "height")
- '("GdkPixbuf*" "dest_pixbuf")
- '("int" "dest_x")
- '("int" "dest_y")
- )
-)
-
-(define-method saturate_and_pixelate
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_saturate_and_pixelate")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "dest")
- '("gfloat" "saturation")
- '("gboolean" "pixelate")
- )
-)
-
-(define-method scale
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_scale")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "dest")
- '("int" "dest_x")
- '("int" "dest_y")
- '("int" "dest_width")
- '("int" "dest_height")
- '("double" "offset_x")
- '("double" "offset_y")
- '("double" "scale_x")
- '("double" "scale_y")
- '("GdkInterpType" "interp_type")
- )
-)
-
-(define-method composite
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_composite")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "dest")
- '("int" "dest_x")
- '("int" "dest_y")
- '("int" "dest_width")
- '("int" "dest_height")
- '("double" "offset_x")
- '("double" "offset_y")
- '("double" "scale_x")
- '("double" "scale_y")
- '("GdkInterpType" "interp_type")
- '("int" "overall_alpha")
- )
-)
-
-(define-method composite_color
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_composite_color")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "dest")
- '("int" "dest_x")
- '("int" "dest_y")
- '("int" "dest_width")
- '("int" "dest_height")
- '("double" "offset_x")
- '("double" "offset_y")
- '("double" "scale_x")
- '("double" "scale_y")
- '("GdkInterpType" "interp_type")
- '("int" "overall_alpha")
- '("int" "check_x")
- '("int" "check_y")
- '("int" "check_size")
- '("guint32" "color1")
- '("guint32" "color2")
- )
-)
-
-(define-method scale_simple
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_scale_simple")
- (caller-owns-return #t)
- (return-type "GdkPixbuf*")
- (parameters
- '("int" "dest_width")
- '("int" "dest_height")
- '("GdkInterpType" "interp_type")
- )
-)
-
-(define-method composite_color_simple
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_composite_color_simple")
- (caller-owns-return #t)
- (return-type "GdkPixbuf*")
- (parameters
- '("int" "dest_width")
- '("int" "dest_height")
- '("GdkInterpType" "interp_type")
- '("int" "overall_alpha")
- '("int" "check_size")
- '("guint32" "color1")
- '("guint32" "color2")
- )
-)
-
-;; From gdk-pixbuf-animation.h
-
-(define-function pixbuf_animation_get_type
- (c-name "gdk_pixbuf_animation_get_type")
- (return-type "GType")
-)
-
-(define-function pixbuf_animation_new_from_file
- (is-constructor-of GdkPixbufAnimation)
- (c-name "gdk_pixbuf_animation_new_from_file")
- (return-type "GdkPixbufAnimation*")
- (parameters
- '("const-char*" "filename")
- '("GError**" "error")
- )
-)
-
-(define-method ref
- (of-object "GdkPixbufAnimation")
- (c-name "gdk_pixbuf_animation_ref")
- (return-type "GdkPixbufAnimation*")
-)
-
-(define-method unref
- (of-object "GdkPixbufAnimation")
- (c-name "gdk_pixbuf_animation_unref")
- (return-type "none")
-)
-
-(define-method get_width
- (of-object "GdkPixbufAnimation")
- (c-name "gdk_pixbuf_animation_get_width")
- (return-type "int")
-)
-
-(define-method get_height
- (of-object "GdkPixbufAnimation")
- (c-name "gdk_pixbuf_animation_get_height")
- (return-type "int")
-)
-
-(define-method is_static_image
- (of-object "GdkPixbufAnimation")
- (c-name "gdk_pixbuf_animation_is_static_image")
- (return-type "gboolean")
-)
-
-(define-method get_static_image
- (of-object "GdkPixbufAnimation")
- (c-name "gdk_pixbuf_animation_get_static_image")
- (return-type "GdkPixbuf*")
-)
-
-(define-method get_iter
- (of-object "GdkPixbufAnimation")
- (c-name "gdk_pixbuf_animation_get_iter")
- (return-type "GdkPixbufAnimationIter*")
- (parameters
- '("const-GTimeVal*" "start_time")
- )
-)
-
-(ifdef GDK_PIXBUF_ENABLE_BACKEND
-
-(define-method non_anim_new
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_non_anim_new")
- (return-type "GdkPixbufAnimation*")
-)
-
-(define-virtual is_static_image
- (of-object "GdkPixbufAnimation")
- (return-type "gboolean")
-)
-
-(define-virtual get_static_image
- (of-object "GdkPixbufAnimation")
- (return-type "GdkPixbuf*")
-)
-
-(define-virtual get_size
- (of-object "GdkPixbufAnimation")
- (return-type "none")
- (parameters
- '("int*" "width")
- '("int*" "height")
- )
-)
-
-(define-virtual get_iter
- (of-object "GdkPixbufAnimation")
- (return-type "GdkPixbufAnimationIter*")
- (parameters
- '("const-GTimeVal*" "start_time")
- )
-)
-)
-
-(define-function pixbuf_animation_iter_get_type
- (c-name "gdk_pixbuf_animation_iter_get_type")
- (return-type "GType")
-)
-
-(define-method get_delay_time
- (of-object "GdkPixbufAnimationIter")
- (c-name "gdk_pixbuf_animation_iter_get_delay_time")
- (return-type "int")
-)
-
-(define-method get_pixbuf
- (of-object "GdkPixbufAnimationIter")
- (c-name "gdk_pixbuf_animation_iter_get_pixbuf")
- (return-type "GdkPixbuf*")
-)
-
-(define-method on_currently_loading_frame
- (of-object "GdkPixbufAnimationIter")
- (c-name "gdk_pixbuf_animation_iter_on_currently_loading_frame")
- (return-type "gboolean")
-)
-
-(define-method advance
- (of-object "GdkPixbufAnimationIter")
- (c-name "gdk_pixbuf_animation_iter_advance")
- (return-type "gboolean")
- (parameters
- '("const-GTimeVal*" "current_time")
- )
-)
-
-(ifdef GDK_PIXBUF_ENABLE_BACKEND
-
-(define-virtual get_delay_time
- (of-object "GdkPixbufAnimationIter")
- (return-type "int")
-)
-
-(define-virtual get_pixbuf
- (of-object "GdkPixbufAnimationIter")
- (return-type "GdkPixbuf*")
-)
-
-(define-virtual on_currently_loading_frame
- (of-object "GdkPixbufAnimationIter")
- (return-type "gboolean")
-)
-
-(define-virtual advance
- (of-object "GdkPixbufAnimationIter")
- (return-type "gboolean")
- (parameters
- '("const-GTimeVal*" "current_time")
- )
-)
-)
-
-
-;; From gdk-pixbuf-core.h
-
-(define-function pixbuf_error_quark
- (c-name "gdk_pixbuf_error_quark")
- (return-type "GQuark")
-)
-
-(define-function pixbuf_get_type
- (c-name "gdk_pixbuf_get_type")
- (return-type "GType")
-)
-
-(define-method ref
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_ref")
- (return-type "GdkPixbuf*")
-)
-
-(define-method unref
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_unref")
- (return-type "none")
-)
-
-(define-function pixbuf_new_from_file_at_scale
- (c-name "gdk_pixbuf_new_from_file_at_scale")
- (return-type "GdkPixbuf*")
- (parameters
- '("const-char*" "filename")
- '("int" "width")
- '("int" "height")
- '("gboolean" "preserve_aspect_ratio")
- '("GError**" "error")
- )
-)
-
-(define-method save_to_callbackv
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_save_to_callbackv")
- (return-type "gboolean")
- (parameters
- '("GdkPixbufSaveFunc" "save_func")
- '("gpointer" "user_data")
- '("const-char*" "type")
- '("char**" "option_keys")
- '("char**" "option_values")
- '("GError**" "error")
- )
-)
-
-(define-method save_to_buffer
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_save_to_buffer")
- (return-type "gboolean")
- (parameters
- '("gchar**" "buffer")
- '("gsize*" "buffer_size")
- '("const-char*" "type")
- '("GError**" "error")
- )
- (varargs #t)
-)
-
-(define-method save_to_bufferv
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_save_to_bufferv")
- (return-type "gboolean")
- (parameters
- '("gchar**" "buffer")
- '("gsize*" "buffer_size")
- '("const-char*" "type")
- '("char**" "option_keys")
- '("char**" "option_values")
- '("GError**" "error")
- )
-)
-
-(define-method get_option
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_get_option")
- (return-type "const-char*")
- (parameters
- '("const-char*" "key")
- )
-)
-
-;; From gdk-pixbuf-enum-types.h
-
-(define-function pixbuf_alpha_mode_get_type
- (c-name "gdk_pixbuf_alpha_mode_get_type")
- (return-type "GType")
-)
-
-(define-function colorspace_get_type
- (c-name "gdk_colorspace_get_type")
- (return-type "GType")
-)
-
-(define-function pixbuf_error_get_type
- (c-name "gdk_pixbuf_error_get_type")
- (return-type "GType")
-)
-
-(define-function interp_type_get_type
- (c-name "gdk_interp_type_get_type")
- (return-type "GType")
-)
-
-(define-function pixbuf_rotation_get_type
- (c-name "gdk_pixbuf_rotation_get_type")
- (return-type "GType")
-)
-
-
-
-(define-function pixbuf_get_formats
- (c-name "gdk_pixbuf_get_formats")
- (return-type "GSList*")
-)
-
-(define-function pixbuf_get_file_info
- (c-name "gdk_pixbuf_get_file_info")
- (return-type "GdkPixbufFormat*")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-method get_name
- (of-object "GdkPixbufFormat")
- (c-name "gdk_pixbuf_format_get_name")
- (return-type "gchar*")
-)
-
-(define-method get_description
- (of-object "GdkPixbufFormat")
- (c-name "gdk_pixbuf_format_get_description")
- (return-type "gchar*")
-)
-
-(define-method get_mime_types
- (of-object "GdkPixbufFormat")
- (c-name "gdk_pixbuf_format_get_mime_types")
- (return-type "gchar**")
-)
-
-(define-method get_extensions
- (of-object "GdkPixbufFormat")
- (c-name "gdk_pixbuf_format_get_extensions")
- (return-type "gchar**")
-)
-
-(define-method is_writable
- (of-object "GdkPixbufFormat")
- (c-name "gdk_pixbuf_format_is_writable")
- (return-type "gboolean")
-)
-
-(define-method is_scalable
- (of-object "GdkPixbufFormat")
- (c-name "gdk_pixbuf_format_is_scalable")
- (return-type "gboolean")
-)
-
-(define-method is_disabled
- (of-object "GdkPixbufFormat")
- (c-name "gdk_pixbuf_format_is_disabled")
- (return-type "gboolean")
-)
-
-(define-method set_disabled
- (of-object "GdkPixbufFormat")
- (c-name "gdk_pixbuf_format_set_disabled")
- (return-type "none")
- (parameters
- '("gboolean" "disabled")
- )
-)
-
-(define-method get_license
- (of-object "GdkPixbufFormat")
- (c-name "gdk_pixbuf_format_get_license")
- (return-type "gchar*")
-)
-
-(ifdef GDK_PIXBUF_ENABLE_BACKEND
-
-(define-method set_option
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_set_option")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "key")
- '("const-gchar*" "value")
- )
-)
-)
-
-
-
-;; From /opt/gnome/include/gtk-2.0/gdk-pixbuf/gdk-pixbuf-loader.h
-
-(define-function pixbuf_loader_get_type
- (c-name "gdk_pixbuf_loader_get_type")
- (return-type "GType")
-)
-
-(define-function pixbuf_loader_new
- (deprecated "use gtk.gdk.PixbufLoader instead")
- (c-name "gdk_pixbuf_loader_new")
- (return-type "GdkPixbufLoader*")
-)
-
-(define-function pixbuf_loader_new_with_type
- (c-name "gdk_pixbuf_loader_new_with_type")
- (is-constructor-of GdkPixbufLoader)
- (return-type "GdkPixbufLoader*")
- (parameters
- '("const-char*" "image_type")
- '("GError**" "error")
- )
-)
-
-(define-function pixbuf_loader_new_with_mime_type
- (c-name "gdk_pixbuf_loader_new_with_mime_type")
- (return-type "GdkPixbufLoader*")
- (parameters
- '("const-char*" "mime_type")
- '("GError**" "error")
- )
- (caller-owns-return #t)
-)
-
-(define-method write
- (of-object "GdkPixbufLoader")
- (c-name "gdk_pixbuf_loader_write")
- (return-type "gboolean")
- (parameters
- '("const-guchar*" "buf")
- '("gsize" "count")
- '("GError**" "error")
- )
-)
-
-(define-method get_pixbuf
- (of-object "GdkPixbufLoader")
- (c-name "gdk_pixbuf_loader_get_pixbuf")
- (return-type "GdkPixbuf*")
-)
-
-(define-method get_animation
- (of-object "GdkPixbufLoader")
- (c-name "gdk_pixbuf_loader_get_animation")
- (return-type "GdkPixbufAnimation*")
-)
-
-(define-method close
- (of-object "GdkPixbufLoader")
- (c-name "gdk_pixbuf_loader_close")
- (return-type "gboolean")
- (parameters
- '("GError**" "error")
- )
-)
-
-(define-method set_size
- (of-object "GdkPixbufLoader")
- (c-name "gdk_pixbuf_loader_set_size")
- (return-type "none")
- (parameters
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-method get_format
- (of-object "GdkPixbufLoader")
- (c-name "gdk_pixbuf_loader_get_format")
- (return-type "GdkPixbufFormat*")
-)
-
-(define-virtual size_prepared
- (of-object "GdkPixbufLoader")
- (return-type "none")
- (parameters
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-virtual area_prepared
- (of-object "GdkPixbufLoader")
- (return-type "none")
-)
-
-(define-virtual area_updated
- (of-object "GdkPixbufLoader")
- (return-type "none")
- (parameters
- '("int" "x")
- '("int" "y")
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-virtual closed
- (of-object "GdkPixbufLoader")
- (return-type "none")
-)
-
-
-
-;; From gdk-pixbuf-simple-anim.h
-
-(define-function pixbuf_simple_anim_get_type
- (c-name "gdk_pixbuf_simple_anim_get_type")
- (return-type "GType")
-)
-
-(define-function pixbuf_simple_anim_iter_get_type
- (c-name "gdk_pixbuf_simple_anim_iter_get_type")
- (return-type "GType")
-)
-
-(define-function pixbuf_simple_anim_new
- (c-name "gdk_pixbuf_simple_anim_new")
- (is-constructor-of "GdkPixbufSimpleAnim")
- (return-type "GdkPixbufSimpleAnim*")
- (parameters
- '("gint" "width")
- '("gint" "height")
- '("gfloat" "rate")
- )
-)
-
-(define-method add_frame
- (of-object "GdkPixbufSimpleAnim")
- (c-name "gdk_pixbuf_simple_anim_add_frame")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "pixbuf")
- )
-)
-
-
-
-;; From gdk-pixbuf-transform.h
-
-(define-method flip
- (of-object "GdkPixbuf")
- (c-name "gdk_pixbuf_flip")
- (return-type "GdkPixbuf*")
- (parameters
- '("gboolean" "horizontal")
- )
-)
-
-;; From gdk-pixdata.h
-
-(define-method serialize
- (of-object "GdkPixdata")
- (c-name "gdk_pixdata_serialize")
- (return-type "guint8*")
- (parameters
- '("guint*" "stream_length_p")
- )
-)
-
-(define-method deserialize
- (of-object "GdkPixdata")
- (c-name "gdk_pixdata_deserialize")
- (return-type "gboolean")
- (parameters
- '("guint" "stream_length")
- '("const-guint8*" "stream")
- '("GError**" "error")
- )
-)
-
-(define-method from_pixbuf
- (of-object "GdkPixdata")
- (c-name "gdk_pixdata_from_pixbuf")
- (return-type "gpointer")
- (parameters
- '("const-GdkPixbuf*" "pixbuf")
- '("gboolean" "use_rle")
- )
-)
-
-(define-function pixbuf_from_pixdata
- (c-name "gdk_pixbuf_from_pixdata")
- (return-type "GdkPixbuf*")
- (parameters
- '("const-GdkPixdata*" "pixdata")
- '("gboolean" "copy_pixels")
- '("GError**" "error")
- )
-)
-
-(define-method to_csource
- (of-object "GdkPixdata")
- (c-name "gdk_pixdata_to_csource")
- (return-type "GString*")
- (parameters
- '("const-gchar*" "name")
- '("GdkPixdataDumpType" "dump_type")
- )
-)
-
-
-
-;;
-
-(define-method intersect
- (of-object "GdkRectangle")
- (c-name "gdk_rectangle_intersect")
- (return-type "gboolean")
- (parameters
- '("GdkRectangle*" "src1")
- '("GdkRectangle*" "src2")
- '("GdkRectangle*" "dest")
- )
-)
-
-(define-method union
- (of-object "GdkRectangle")
- (c-name "gdk_rectangle_union")
- (return-type "void")
- (parameters
- '("GdkRectangle*" "src1")
- '("GdkRectangle*" "src2")
- '("GdkRectangle*" "dest")
- )
-)
-
-(define-function rectangle_new
- (c-name "gdk_rectangle_new")
- (is-constructor-of "GdkRectangle")
- (return-type "GdkRectangle")
-)
-
-
-(define-method get_clipbox
- (of-object "GdkRegion")
- (c-name "gdk_region_get_clipbox")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "rect")
- )
-)
-
-(define-method empty
- (of-object "GdkRegion")
- (c-name "gdk_region_empty")
- (return-type "gboolean")
-)
-
-
-(define-method equal
- (of-object "GdkRegion")
- (c-name "gdk_region_equal")
- (return-type "gboolean")
- (parameters
- '("GdkRegion*" "other")
- )
-)
-
-(define-method point_in
- (of-object "GdkRegion")
- (c-name "gdk_region_point_in")
- (return-type "gboolean")
- (parameters
- '("int" "x")
- '("int" "y")
- )
-)
-
-(define-method rect_in
- (of-object "GdkRegion")
- (c-name "gdk_region_rect_in")
- (return-type "GdkOverlapType")
- (parameters
- '("GdkRectangle*" "rect")
- )
-)
-
-;; From gdkenumtypes.h
-
-(define-function cursor_type_get_type
- (c-name "gdk_cursor_type_get_type")
- (return-type "GType")
-)
-
-(define-function drag_action_get_type
- (c-name "gdk_drag_action_get_type")
- (return-type "GType")
-)
-
-(define-function drag_protocol_get_type
- (c-name "gdk_drag_protocol_get_type")
- (return-type "GType")
-)
-
-(define-function filter_return_get_type
- (c-name "gdk_filter_return_get_type")
- (return-type "GType")
-)
-
-(define-function event_type_get_type
- (c-name "gdk_event_type_get_type")
- (return-type "GType")
-)
-
-(define-function event_mask_get_type
- (c-name "gdk_event_mask_get_type")
- (return-type "GType")
-)
-
-(define-function visibility_state_get_type
- (c-name "gdk_visibility_state_get_type")
- (return-type "GType")
-)
-
-(define-function scroll_direction_get_type
- (c-name "gdk_scroll_direction_get_type")
- (return-type "GType")
-)
-
-(define-function notify_type_get_type
- (c-name "gdk_notify_type_get_type")
- (return-type "GType")
-)
-
-(define-function crossing_mode_get_type
- (c-name "gdk_crossing_mode_get_type")
- (return-type "GType")
-)
-
-(define-function property_state_get_type
- (c-name "gdk_property_state_get_type")
- (return-type "GType")
-)
-
-(define-function window_state_get_type
- (c-name "gdk_window_state_get_type")
- (return-type "GType")
-)
-
-(define-function setting_action_get_type
- (c-name "gdk_setting_action_get_type")
- (return-type "GType")
-)
-
-(define-function owner_change_get_type
- (c-name "gdk_owner_change_get_type")
- (return-type "GType")
-)
-
-(define-function font_type_get_type
- (c-name "gdk_font_type_get_type")
- (return-type "GType")
-)
-
-(define-function cap_style_get_type
- (c-name "gdk_cap_style_get_type")
- (return-type "GType")
-)
-
-(define-function fill_get_type
- (c-name "gdk_fill_get_type")
- (return-type "GType")
-)
-
-(define-function function_get_type
- (c-name "gdk_function_get_type")
- (return-type "GType")
-)
-
-(define-function join_style_get_type
- (c-name "gdk_join_style_get_type")
- (return-type "GType")
-)
-
-(define-function line_style_get_type
- (c-name "gdk_line_style_get_type")
- (return-type "GType")
-)
-
-(define-function subwindow_mode_get_type
- (c-name "gdk_subwindow_mode_get_type")
- (return-type "GType")
-)
-
-(define-function gc_values_mask_get_type
- (c-name "gdk_gc_values_mask_get_type")
- (return-type "GType")
-)
-
-(define-function image_type_get_type
- (c-name "gdk_image_type_get_type")
- (return-type "GType")
-)
-
-(define-function extension_mode_get_type
- (c-name "gdk_extension_mode_get_type")
- (return-type "GType")
-)
-
-(define-function input_source_get_type
- (c-name "gdk_input_source_get_type")
- (return-type "GType")
-)
-
-(define-function input_mode_get_type
- (c-name "gdk_input_mode_get_type")
- (return-type "GType")
-)
-
-(define-function axis_use_get_type
- (c-name "gdk_axis_use_get_type")
- (return-type "GType")
-)
-
-(define-function prop_mode_get_type
- (c-name "gdk_prop_mode_get_type")
- (return-type "GType")
-)
-
-(define-function fill_rule_get_type
- (c-name "gdk_fill_rule_get_type")
- (return-type "GType")
-)
-
-(define-function overlap_type_get_type
- (c-name "gdk_overlap_type_get_type")
- (return-type "GType")
-)
-
-(define-function rgb_dither_get_type
- (c-name "gdk_rgb_dither_get_type")
- (return-type "GType")
-)
-
-(define-function byte_order_get_type
- (c-name "gdk_byte_order_get_type")
- (return-type "GType")
-)
-
-(define-function modifier_type_get_type
- (c-name "gdk_modifier_type_get_type")
- (return-type "GType")
-)
-
-(define-function input_condition_get_type
- (c-name "gdk_input_condition_get_type")
- (return-type "GType")
-)
-
-(define-function status_get_type
- (c-name "gdk_status_get_type")
- (return-type "GType")
-)
-
-(define-function grab_status_get_type
- (c-name "gdk_grab_status_get_type")
- (return-type "GType")
-)
-
-(define-function visual_type_get_type
- (c-name "gdk_visual_type_get_type")
- (return-type "GType")
-)
-
-(define-function window_class_get_type
- (c-name "gdk_window_class_get_type")
- (return-type "GType")
-)
-
-(define-function window_type_get_type
- (c-name "gdk_window_type_get_type")
- (return-type "GType")
-)
-
-(define-function window_attributes_type_get_type
- (c-name "gdk_window_attributes_type_get_type")
- (return-type "GType")
-)
-
-(define-function window_hints_get_type
- (c-name "gdk_window_hints_get_type")
- (return-type "GType")
-)
-
-(define-function window_type_hint_get_type
- (c-name "gdk_window_type_hint_get_type")
- (return-type "GType")
-)
-
-(define-function wm_decoration_get_type
- (c-name "gdk_wm_decoration_get_type")
- (return-type "GType")
-)
-
-(define-function wm_function_get_type
- (c-name "gdk_wm_function_get_type")
- (return-type "GType")
-)
-
-(define-function gravity_get_type
- (c-name "gdk_gravity_get_type")
- (return-type "GType")
-)
-
-(define-function window_edge_get_type
- (c-name "gdk_window_edge_get_type")
- (return-type "GType")
-)
-
-;; From gdkregion.h
-
-(define-function region_new
- (c-name "gdk_region_new")
- (is-constructor-of "GdkRegion")
- (return-type "GdkRegion*")
-)
-
-(define-function region_polygon
- (c-name "gdk_region_polygon")
- (return-type "GdkRegion*")
- (parameters
- '("GdkPoint*" "points")
- '("gint" "npoints")
- '("GdkFillRule" "fill_rule")
- )
-)
-
-(define-method copy
- (of-object "GdkRegion")
- (c-name "gdk_region_copy")
- (return-type "GdkRegion*")
-)
-
-(define-function region_rectangle
- (c-name "gdk_region_rectangle")
- (return-type "GdkRegion*")
- (parameters
- '("GdkRectangle*" "rectangle")
- )
-)
-
-(define-method destroy
- (of-object "GdkRegion")
- (c-name "gdk_region_destroy")
- (return-type "none")
-)
-
-(define-method get_rectangles
- (of-object "GdkRegion")
- (c-name "gdk_region_get_rectangles")
- (return-type "none")
- (parameters
- '("GdkRectangle**" "rectangles")
- '("gint*" "n_rectangles")
- )
-)
-
-(define-method offset
- (of-object "GdkRegion")
- (c-name "gdk_region_offset")
- (return-type "none")
- (parameters
- '("gint" "dx")
- '("gint" "dy")
- )
-)
-
-(define-method shrink
- (of-object "GdkRegion")
- (c-name "gdk_region_shrink")
- (return-type "none")
- (parameters
- '("gint" "dx")
- '("gint" "dy")
- )
-)
-
-(define-method union_with_rect
- (of-object "GdkRegion")
- (c-name "gdk_region_union_with_rect")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "rect")
- )
-)
-
-(define-method intersect
- (of-object "GdkRegion")
- (c-name "gdk_region_intersect")
- (return-type "none")
- (parameters
- '("GdkRegion*" "source2")
- )
-)
-
-(define-method union
- (of-object "GdkRegion")
- (c-name "gdk_region_union")
- (return-type "none")
- (parameters
- '("GdkRegion*" "source2")
- )
-)
-
-(define-method subtract
- (of-object "GdkRegion")
- (c-name "gdk_region_subtract")
- (return-type "none")
- (parameters
- '("GdkRegion*" "source2")
- )
-)
-
-(define-method xor
- (of-object "GdkRegion")
- (c-name "gdk_region_xor")
- (return-type "none")
- (parameters
- '("GdkRegion*" "source2")
- )
-)
-
-(define-method spans_intersect_foreach
- (of-object "GdkRegion")
- (c-name "gdk_region_spans_intersect_foreach")
- (return-type "none")
- (parameters
- '("GdkSpan*" "spans")
- '("int" "n_spans")
- '("gboolean" "sorted")
- '("GdkSpanFunc" "function")
- '("gpointer" "data")
- )
-)
-
-;; From /opt/gnome-devel/include/gtk-2.0/gdk/gdkcairo.h
-
-(define-method cairo_create
- (of-object "GdkDrawable")
- (c-name "gdk_cairo_create")
- (return-type "cairo_t*"))
-
-(define-function cairo_set_source_color
- (c-name "gdk_cairo_set_source_color")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("GdkColor*" "color")
- )
-)
-
-(define-function cairo_set_source_pixbuf
- (c-name "gdk_cairo_set_source_pixbuf")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("GdkPixbuf*" "pixbuf")
- '("double" "pixbuf_x")
- '("double" "pixbuf_y")
- )
-)
-
-(define-function cairo_rectangle
- (c-name "gdk_cairo_rectangle")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("GdkRectangle*" "rectangle")
- )
-)
-
-(define-function cairo_region
- (c-name "gdk_cairo_region")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("GdkRegion*" "region")
- )
-)
-
-
-;; gdkx.h
-
-(ifdef GDK_TARGET_X11
-
-(define-method get_xdisplay
- (of-object "GdkDrawable")
- (c-name "gdk_x11_drawable_get_xdisplay")
- (return-type "Display*")
-)
-
-(define-method get_xid
- (of-object "GdkDrawable")
- (c-name "gdk_x11_drawable_get_xid")
- (return-type "XID")
-)
-
-(define-method get_xdisplay
- (of-object "GdkImage")
- (c-name "gdk_x11_image_get_xdisplay")
- (return-type "Display*")
-)
-
-(define-method get_ximage
- (of-object "GdkImage")
- (c-name "gdk_x11_image_get_ximage")
- (return-type "XImage*")
-)
-
-(define-method get_xdisplay
- (of-object "GdkColormap")
- (c-name "gdk_x11_colormap_get_xdisplay")
- (return-type "Display*")
-)
-
-(define-method get_xcolormap
- (of-object "GdkColormap")
- (c-name "gdk_x11_colormap_get_xcolormap")
- (return-type "Colormap")
-)
-
-(define-method get_xdisplay
- (of-object "GdkCursor")
- (c-name "gdk_x11_cursor_get_xdisplay")
- (return-type "Display*")
-)
-
-(define-method get_xcursor
- (of-object "GdkCursor")
- (c-name "gdk_x11_cursor_get_xcursor")
- (return-type "Cursor")
-)
-
-(define-method get_xdisplay
- (of-object "GdkDisplay")
- (c-name "gdk_x11_display_get_xdisplay")
- (return-type "Display*")
-)
-
-(define-method get_xvisual
- (of-object "GdkVisual")
- (c-name "gdk_x11_visual_get_xvisual")
- (return-type "Visual*")
-)
-
-(define-method get_xdisplay
- (of-object "GdkGC")
- (c-name "gdk_x11_gc_get_xdisplay")
- (return-type "Display*")
-)
-
-(define-method get_xgc
- (of-object "GdkGC")
- (c-name "gdk_x11_gc_get_xgc")
- (return-type "GC")
-)
-
-(define-method get_xscreen
- (of-object "GdkScreen")
- (c-name "gdk_x11_screen_get_xscreen")
- (return-type "Screen*")
-)
-
-(define-method get_screen_number
- (of-object "GdkScreen")
- (c-name "gdk_x11_screen_get_screen_number")
- (return-type "int")
-)
-
-(define-method set_user_time
- (of-object "GdkWindow")
- (c-name "gdk_x11_window_set_user_time")
- (return-type "none")
- (parameters
- '("guint32" "timestamp")
- )
-)
-
-(define-method move_to_current_desktop
- (of-object "GdkWindow")
- (c-name "gdk_x11_window_move_to_current_desktop")
- (return-type "none")
-)
-
-(define-method get_window_manager_name
- (of-object "GdkScreen")
- (c-name "gdk_x11_screen_get_window_manager_name")
- (return-type "const-char*")
-)
-
-(define-function x11_get_default_root_xwindow
- (c-name "gdk_x11_get_default_root_xwindow")
- (return-type "Window")
-)
-
-(define-function x11_get_default_xdisplay
- (c-name "gdk_x11_get_default_xdisplay")
- (return-type "Display*")
-)
-
-(define-function x11_get_default_screen
- (c-name "gdk_x11_get_default_screen")
- (return-type "gint")
-)
-
-(define-method lookup_visual
- (of-object "GdkScreen")
- (c-name "gdk_x11_screen_lookup_visual")
- (return-type "GdkVisual*")
- (parameters
- '("VisualID" "xvisualid")
- )
-)
-
-(define-function gdkx_visual_get
- (c-name "gdkx_visual_get")
- (return-type "GdkVisual*")
- (parameters
- '("VisualID" "xvisualid")
- )
-)
-
-(define-function gdkx_colormap_get
- (c-name "gdkx_colormap_get")
- (return-type "GdkColormap*")
- (parameters
- '("Colormap" "xcolormap")
- )
-)
-
-(define-function x11_colormap_foreign_new
- (c-name "gdk_x11_colormap_foreign_new")
- (is-constructor-of "GdkX11ColormapForeign")
- (return-type "GdkColormap*")
- (parameters
- '("GdkVisual*" "visual")
- '("Colormap" "xcolormap")
- )
-)
-
-(define-function xid_table_lookup_for_display
- (c-name "gdk_xid_table_lookup_for_display")
- (return-type "gpointer")
- (parameters
- '("GdkDisplay*" "display")
- '("XID" "xid")
- )
-)
-
-(define-function x11_get_server_time
- (c-name "gdk_x11_get_server_time")
- (return-type "guint32")
- (parameters
- '("GdkWindow*" "window")
- )
-)
-
-(define-method get_user_time
- (of-object "GdkDisplay")
- (c-name "gdk_x11_display_get_user_time")
- (return-type "guint32")
-)
-
-(define-method set_cursor_theme
- (of-object "GdkDisplay")
- (c-name "gdk_x11_display_set_cursor_theme")
- (return-type "none")
- (parameters
- '("const-gchar*" "theme")
- '("const-gint" "size")
- )
-)
-
-(define-method supports_net_wm_hint
- (of-object "GdkScreen")
- (c-name "gdk_x11_screen_supports_net_wm_hint")
- (return-type "gboolean")
- (parameters
- '("GdkAtom" "property")
- )
-)
-
-(define-function xid_table_lookup
- (c-name "gdk_xid_table_lookup")
- (return-type "gpointer")
- (parameters
- '("XID" "xid")
- )
-)
-
-(define-function net_wm_supports
- (c-name "gdk_net_wm_supports")
- (return-type "gboolean")
- (parameters
- '("GdkAtom" "property")
- )
-)
-
-(define-function x11_grab_server
- (c-name "gdk_x11_grab_server")
- (return-type "none")
-)
-
-(define-function x11_ungrab_server
- (c-name "gdk_x11_ungrab_server")
- (return-type "none")
-)
-
-(define-function x11_lookup_xdisplay
- (c-name "gdk_x11_lookup_xdisplay")
- (return-type "GdkDisplay*")
- (parameters
- '("Display*" "xdisplay")
- )
-)
-
-(define-function x11_atom_to_xatom_for_display
- (c-name "gdk_x11_atom_to_xatom_for_display")
- (return-type "Atom")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkAtom" "atom")
- )
-)
-
-(define-function x11_xatom_to_atom_for_display
- (c-name "gdk_x11_xatom_to_atom_for_display")
- (return-type "GdkAtom")
- (parameters
- '("GdkDisplay*" "display")
- '("Atom" "xatom")
- )
-)
-
-(define-function x11_get_xatom_by_name_for_display
- (c-name "gdk_x11_get_xatom_by_name_for_display")
- (return-type "Atom")
- (parameters
- '("GdkDisplay*" "display")
- '("const-gchar*" "atom_name")
- )
-)
-
-(define-function x11_get_xatom_name_for_display
- (c-name "gdk_x11_get_xatom_name_for_display")
- (return-type "const-gchar*")
- (parameters
- '("GdkDisplay*" "display")
- '("Atom" "xatom")
- )
-)
-
-(define-function x11_atom_to_xatom
- (c-name "gdk_x11_atom_to_xatom")
- (return-type "Atom")
- (parameters
- '("GdkAtom" "atom")
- )
-)
-
-(define-function x11_xatom_to_atom
- (c-name "gdk_x11_xatom_to_atom")
- (return-type "GdkAtom")
- (parameters
- '("Atom" "xatom")
- )
-)
-
-(define-function x11_get_xatom_by_name
- (c-name "gdk_x11_get_xatom_by_name")
- (return-type "Atom")
- (parameters
- '("const-gchar*" "atom_name")
- )
-)
-
-(define-function x11_get_xatom_name
- (c-name "gdk_x11_get_xatom_name")
- (return-type "const-gchar*")
- (parameters
- '("Atom" "xatom")
- )
-)
-
-(define-method grab
- (of-object "GdkDisplay")
- (c-name "gdk_x11_display_grab")
- (return-type "none")
-)
-
-(define-method ungrab
- (of-object "GdkDisplay")
- (c-name "gdk_x11_display_ungrab")
- (return-type "none")
-)
-
-(define-function x11_register_standard_event_type
- (c-name "gdk_x11_register_standard_event_type")
- (return-type "none")
- (parameters
- '("GdkDisplay*" "display")
- '("gint" "event_base")
- '("gint" "n_events")
- )
-)
-
-(define-method get_xfont
- (of-object "GdkFont")
- (c-name "gdk_x11_font_get_xfont")
- (return-type "gpointer")
-)
-
-(define-method x11_font_get_xdisplay
- (of-object "GdkFont")
- (c-name "gdk_x11_font_get_xdisplay")
- (return-type "Display*")
-)
-
-(define-method get_name
- (of-object "GdkFont")
- (c-name "gdk_x11_font_get_name")
- (return-type "const-char*")
-)
-
-
-) ; (ifdef GDK_TARGET_X11
diff --git a/gtk/gdk.override b/gtk/gdk.override
deleted file mode 100644
index 2b06b2a1..00000000
--- a/gtk/gdk.override
+++ /dev/null
@@ -1,1493 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gdk.override: overrides for the gtk.gdk module.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-headers
-#ifdef HAVE_CONFIG_H
-# include <config.h>
-#endif
-
-#define NO_IMPORT_PYGOBJECT
-#include "pygobject.h"
-#include <glib.h>
-#include <gtk/gtk.h>
-#include <gdk-pixbuf/gdk-pixbuf.h>
-#include "pygtk-private.h"
-
-#if defined(GDK_WINDOWING_X11)
-#include <gdk/gdkx.h>
-#elif defined(GDK_WINDOWING_WIN32)
-#include <gdk/gdkwin32.h>
-#endif
-
-/* make GDK_DISPLAY() the case macro */
-#undef GDK_DISPLAY
-#define GDK_DISPLAY(object) (GDK_DISPLAY_OBJECT(object))
-
-#ifdef HAVE_NUMPY
-# include <Numeric/arrayobject.h>
-static int have_numpy(void);
-#endif
-
-extern PyTypeObject PyGtkWidget_Type;
-
-#ifdef HAVE_PYCAIRO
-# include <pycairo.h>
-extern Pycairo_CAPI_t *Pycairo_CAPI;
-extern PyTypeObject PyGdkCairoContext_Type;
-#endif
-
-#ifndef GDK_TYPE_REGION
-GType
-pygdk_region_get_type (void)
-{
- static GType our_type = 0;
-
- if (our_type == 0)
- our_type = g_boxed_type_register_static ("GdkRegion",
- (GBoxedCopyFunc)gdk_region_copy,
- (GBoxedFreeFunc)gdk_region_destroy);
- return our_type;
-}
-#endif
-
-#ifndef GDK_TYPE_PIXBUF_SIMPLE_ANIM_ITER
-GType gtk_print_capabilites_get_type (void) G_GNUC_CONST;
-#define GDK_TYPE_PIXBUF_SIMPLE_ANIM_ITER (gdk_pixbuf_simple_anim_iter_get_type())
-#endif
-
-%%
-include
- gdkcairo.override
- gdkcolor.override
- gdkdraw.override
- gdkevent.override
- gdkgc.override
- gdkpixbuf.override
- gdkrectangle.override
- gdkwindow.override
-%%
-modulename gtk.gdk
-%%
-import gobject.GObject as PyGObject_Type
-import pango.Context as PyPangoContext_Type
-import pango.Font as PyPangoFont_Type
-import pango.Layout as PyPangoLayout_Type
-import pango.Renderer as PyPangoRenderer_Type
-%%
-ignore
- gdk_window_set_debug_updates
- gdk_region_destroy
- gdk_atom_intern_static_string
- gdk_pixbuf_from_pixdata
-%%
-ignore-glob
- *_get_type
- _*
- *_ref
- *_unref
- gdk_spawn_*
- *_libgtk_only
- gdk_pixdata_*
-%%
-ignore-type
- GdkPixmapObject
- GdkWindowObject
-%%
-override gdk_threads_init noargs
-static PyObject *
-_wrap_gdk_threads_init(PyObject *self)
-{
- if (pyg_enable_threads())
- return NULL;
- gdk_threads_init();
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_threads_enter noargs
-static PyObject *
-_wrap_gdk_threads_enter(PyObject *self)
-{
- /* must allow threads while acquiring lock, or no other python
- * code will execute while we wait! */
- pyg_begin_allow_threads;
- gdk_threads_enter();
- pyg_end_allow_threads;
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_fontset_load kwargs
-static PyObject *
-_wrap_gdk_fontset_load(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "fontset_name", NULL };
- char *fontset_name;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s:fontset_load", kwlist,
- &fontset_name))
- return NULL;
-
- /* pyg_boxed_new handles NULL checking */
- return pyg_boxed_new(GDK_TYPE_FONT, gdk_fontset_load(fontset_name),
- FALSE, TRUE);
-}
-%%
-override gdk_text_extents kwargs
-static PyObject *
-_wrap_gdk_text_extents(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "text", NULL };
- gchar *text;
- Py_ssize_t length;
- gint lbearing, rbearing, width, ascent, descent;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s#:GdkFont.extents",
- kwlist, &text, &length))
- return NULL;
- gdk_text_extents(pyg_boxed_get(self, GdkFont), text, length,
- &lbearing, &rbearing, &width, &ascent, &descent);
- return Py_BuildValue("(iiiii)", lbearing, rbearing, width,
- ascent, descent);
-}
-%%
-override gdk_pixmap_create_from_xpm kwargs
-static PyObject *
-_wrap_gdk_pixmap_create_from_xpm(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "window", "transparent_color", "filename", NULL};
- PyGObject *window;
- PyObject *py_trans_color, *ret;
- GdkColor *trans_color = NULL;
- gchar *filename;
- GdkPixmap *pixmap;
- GdkBitmap *mask;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!Os:pixmap_create_from_xpm", kwlist,
- &PyGdkDrawable_Type, &window,
- &py_trans_color, &filename))
- return NULL;
- if (pyg_boxed_check(py_trans_color, GDK_TYPE_COLOR))
- trans_color = pyg_boxed_get(py_trans_color, GdkColor);
- else if (py_trans_color != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "transparent_color must be a colour or None");
- return NULL;
- }
- pixmap = gdk_pixmap_create_from_xpm(GDK_DRAWABLE(window->obj), &mask,
- trans_color, filename);
- if (pixmap == NULL) {
- PyErr_SetString(PyExc_IOError, "can't load pixmap");
- return NULL;
- }
- ret = Py_BuildValue("(NN)",
- pygobject_new((GObject *)pixmap),
- pygobject_new((GObject *)mask));
- gdk_pixmap_unref(pixmap);
- gdk_bitmap_unref(mask);
- return ret;
-}
-%%
-override gdk_pixmap_colormap_create_from_xpm kwargs
-static PyObject *
-_wrap_gdk_pixmap_colormap_create_from_xpm(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "window", "colormap", "transparent_color",
- "filename", NULL };
- PyObject *py_window, *py_colormap, *py_trans_color, *ret;
- GdkDrawable *window = NULL;
- GdkColormap *colormap = NULL;
- GdkColor *trans_color = NULL;
- gchar *filename;
- GdkPixmap *pixmap;
- GdkBitmap *mask;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOOs:pixmap_colormap_create_from_xpm",
- kwlist, &py_window, &py_colormap,
- &py_trans_color, &filename))
- return NULL;
- if (pygobject_check(py_window, &PyGdkDrawable_Type))
- window = GDK_DRAWABLE(pygobject_get(py_window));
- else if (py_window != Py_None) {
- PyErr_SetString(PyExc_TypeError, "window must be a GdkDrawable or None");
- return NULL;
- }
- if (pygobject_check(py_colormap, &PyGdkColormap_Type))
- colormap = GDK_COLORMAP(pygobject_get(py_colormap));
- else if (py_colormap != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "colormap must be a GdkColormap or None");
- return NULL;
- }
- if (pyg_boxed_check(py_trans_color, GDK_TYPE_COLOR))
- trans_color = pyg_boxed_get(py_trans_color, GdkColor);
- else if (py_trans_color != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "transparent_color must be a colour or None");
- return NULL;
- }
- pixmap = gdk_pixmap_colormap_create_from_xpm(window, colormap, &mask,
- trans_color, filename);
- if (pixmap == NULL) {
- PyErr_SetString(PyExc_IOError, "can't load pixmap");
- return NULL;
- }
- ret = Py_BuildValue("(NN)",
- pygobject_new((GObject *)pixmap),
- pygobject_new((GObject *)mask));
- gdk_pixmap_unref(pixmap);
- gdk_bitmap_unref(mask);
- return ret;
-}
-%%
-override gdk_pixmap_create_from_xpm_d kwargs
-static PyObject *
-_wrap_gdk_pixmap_create_from_xpm_d(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "window", "transparent_color", "data", NULL };
- PyGObject *window;
- PyObject *py_trans_color, *py_data, *ret;
- GdkColor *trans_color = NULL;
- gchar **data;
- int len, i;
- GdkPixmap *pixmap;
- GdkBitmap *mask;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!OO!:pixmap_create_from_xpm_d", kwlist,
- &PyGdkDrawable_Type, &window,
- &py_trans_color, &PyList_Type, &py_data))
- return NULL;
- if (pyg_boxed_check(py_trans_color, GDK_TYPE_COLOR))
- trans_color = pyg_boxed_get(py_trans_color, GdkColor);
- else if (py_trans_color != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "transparent_color must be a colour or None");
- return NULL;
- }
- len = PyList_Size(py_data);
- data = g_new(gchar *, len);
- for (i = 0; i < len; i ++) {
- PyObject *item = PyList_GetItem(py_data, i);
- if (!PyString_Check(item)) {
- PyErr_SetString(PyExc_TypeError, "data items must be strings");
- g_free(data);
- return NULL;
- }
- data[i] = PyString_AsString(item);
- }
- pixmap = gdk_pixmap_create_from_xpm_d(GDK_DRAWABLE(window->obj), &mask,
- trans_color, data);
- g_free(data);
- if (pixmap == NULL) {
- PyErr_SetString(PyExc_IOError, "can't load pixmap");
- return NULL;
- }
- ret = Py_BuildValue("(NN)",
- pygobject_new((GObject *)pixmap),
- pygobject_new((GObject *)mask));
- gdk_pixmap_unref(pixmap);
- gdk_bitmap_unref(mask);
- return ret;
-}
-%%
-override gdk_pixmap_colormap_create_from_xpm_d kwargs
-static PyObject *
-_wrap_gdk_pixmap_colormap_create_from_xpm_d(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "window", "colormap", "transparent_color",
- "data", NULL };
- PyObject *py_window, *py_colormap, *py_trans_color, *py_data, *ret;
- GdkDrawable *window = NULL;
- GdkColormap *colormap = NULL;
- GdkColor *trans_color = NULL;
- gchar **data;
- int len, i;
- GdkPixmap *pixmap;
- GdkBitmap *mask;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOOO!:pixmap_colormap_create_from_xpm_d",
- kwlist, &py_window, &py_colormap,
- &py_trans_color,
- &PyList_Type, &py_data))
- return NULL;
- if (pygobject_check(py_window, &PyGdkDrawable_Type))
- window = GDK_DRAWABLE(pygobject_get(py_window));
- else if (py_window != Py_None) {
- PyErr_SetString(PyExc_TypeError, "window must be a GdkDrawable or None");
- return NULL;
- }
- if (pygobject_check(py_colormap, &PyGdkColormap_Type))
- colormap = GDK_COLORMAP(pygobject_get(py_colormap));
- else if (py_colormap != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "colormap must be a GdkColormap or None");
- return NULL;
- }
- if (pyg_boxed_check(py_trans_color, GDK_TYPE_COLOR))
- trans_color = pyg_boxed_get(py_trans_color, GdkColor);
- else if (py_trans_color != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "transparent_color must be a colour or None");
- return NULL;
- }
- len = PyList_Size(py_data);
- data = g_new(gchar *, len);
- for (i = 0; i < len; i ++) {
- PyObject *item = PyList_GetItem(py_data, i);
- if (!PyString_Check(item)) {
- PyErr_SetString(PyExc_TypeError, "data items must be strings");
- g_free(data);
- return NULL;
- }
- data[i] = PyString_AsString(item);
- }
- pixmap = gdk_pixmap_colormap_create_from_xpm_d(window, colormap, &mask,
- trans_color, data);
- g_free(data);
- if (pixmap == NULL) {
- PyErr_SetString(PyExc_IOError, "can't load pixmap");
- return NULL;
- }
- ret = Py_BuildValue("(NN)",
- pygobject_new((GObject *)pixmap),
- pygobject_new((GObject *)mask));
- gdk_pixmap_unref(pixmap);
- gdk_bitmap_unref(mask);
- return ret;
-}
-%%
-ignore gdk_cursor_new_from_pixmap
-%%
-override gdk_cursor_new kwargs
-static int
-_wrap_gdk_cursor_new(PyGBoxed *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist1[] = { "cursor_type", NULL };
- static char *kwlist2[] = { "display", "cursor_type", NULL };
- static char *kwlist3[] = { "display", "pixbuf", "x", "y", NULL };
- static char *kwlist4[] = { "source", "mask", "fg", "bg", "x", "y", NULL };
- PyObject *py_cursor_type;
- PyGObject *py_display;
- PyGObject *source, *mask, *pixbuf;
- PyObject *fg, *bg;
- gint x, y;
-
- self->gtype = GDK_TYPE_CURSOR;
- self->free_on_dealloc = FALSE;
- self->boxed = NULL;
-
- if (PyArg_ParseTupleAndKeywords(args, kwargs, "O:GdkCursor.__init__",
- kwlist1, &py_cursor_type)) {
- GdkCursorType cursor_type;
-
- if (pyg_enum_get_value(GDK_TYPE_CURSOR_TYPE, py_cursor_type,
- (gint *)&cursor_type))
- return -1;
- self->boxed = gdk_cursor_new(cursor_type);
- goto done;
- }
-
- PyErr_Clear();
-
- if (PyArg_ParseTupleAndKeywords(args, kwargs, "OO:GdkCursor.__init__",
- kwlist2, &py_display, &py_cursor_type)) {
-
- GdkCursorType cursor_type;
-
- if (!pygobject_check(py_display, &PyGdkDisplay_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "display should be a GdkDisplay");
- return -1;
- }
- if (pyg_enum_get_value(GDK_TYPE_CURSOR_TYPE, py_cursor_type,
- (gint *)&cursor_type))
- return -1;
- self->boxed = gdk_cursor_new_for_display(GDK_DISPLAY(py_display->obj),
- cursor_type);
- goto done;
- }
-
- PyErr_Clear();
-
- if (PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOii:GdkCursor.__init__", kwlist3,
- &py_display, &pixbuf, &x, &y)) {
-
- if (!pygobject_check(py_display, &PyGdkDisplay_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "display should be a GdkDisplay");
- return -1;
- }
- if (!pygobject_check(pixbuf, &PyGdkPixbuf_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "pixbuf should be a GdkPixbuf");
- return -1;
- }
- self->boxed = gdk_cursor_new_from_pixbuf(GDK_DISPLAY(py_display->obj),
- GDK_PIXBUF(pixbuf->obj),
- x, y);
- goto done;
- }
-
- PyErr_Clear();
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOOOii:GdkCursor.__init__", kwlist4,
- &source, &mask, &fg, &bg, &x, &y)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError, "Usage:\n"
- " gtk.gdk.Cursor(cursor_type)\n"
- " gtk.gdk.Cursor(display, cursor_type)\n"
- " gtk.gdk.Cursor(display, pixbuf, x, y)\n"
- " gtk.gdk.Cursor(source, mask, fg, bg, x, y)");
- return -1;
- }
-
- if (!pygobject_check(source, &PyGdkPixmap_Type)) {
- PyErr_SetString(PyExc_TypeError, "source should be a GdkPixmap");
- return -1;
- }
- if (!pygobject_check(mask, &PyGdkPixmap_Type)) {
- PyErr_SetString(PyExc_TypeError, "mask should be a GdkPixmap");
- return -1;
- }
- if (!pyg_boxed_check(fg, GDK_TYPE_COLOR)) {
- PyErr_SetString(PyExc_TypeError, "fg should be a GdkColor");
- return -1;
- }
- if (!pyg_boxed_check(bg, GDK_TYPE_COLOR)) {
- PyErr_SetString(PyExc_TypeError, "bg should be a GdkColor");
- return -1;
- }
- self->boxed = gdk_cursor_new_from_pixmap(GDK_PIXMAP(source->obj),
- GDK_PIXMAP(mask->obj),
- pyg_boxed_get(fg, GdkColor),
- pyg_boxed_get(bg, GdkColor),
- x, y);
- done:
- if (!self->boxed) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GdkCursor object");
- return -1;
- }
- self->free_on_dealloc = TRUE;
- return 0;
-}
-%%
-override gdk_region_get_clipbox noargs
-static PyObject *
-_wrap_gdk_region_get_clipbox(PyGObject *self)
-{
- GdkRectangle rect = {0, 0, 0, 0};
-
- gdk_region_get_clipbox(pyg_boxed_get(self, GdkRegion), &rect);
-
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &rect, TRUE, TRUE);
-}
-%%
-override-attr GdkDevice.axes
-static PyObject *
-_wrap_gdk_device__get_axes(PyGObject *self, void *closure)
-{
- GdkDevice *device = GDK_DEVICE(self->obj);
- PyObject *ret;
- gint i;
-
- ret = PyTuple_New(device->num_axes);
- for (i = 0; i < device->num_axes; i++)
- PyTuple_SetItem(ret, i, Py_BuildValue("(idd)",
- device->axes[i].use,
- device->axes[i].min,
- device->axes[i].max));
- return ret;
-}
-%%
-override-attr GdkDevice.keys
-static PyObject *
-_wrap_gdk_device__get_keys(PyGObject *self, void *closure)
-{
- GdkDevice *device = GDK_DEVICE(self->obj);
- PyObject *ret;
- gint i;
-
- ret = PyTuple_New(device->num_keys);
- for (i = 0; i < device->num_keys; i++)
- PyTuple_SetItem(ret, i,
- Py_BuildValue("(iN)", device->keys[i].keyval,
- pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE,
- device->keys[i].modifiers)));
- return ret;
-}
-%%
-override gdk_device_get_state kwargs
-static PyObject *
-_wrap_gdk_device_get_state(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "window", NULL };
- GdkDevice *device = GDK_DEVICE(self->obj);
- PyGObject *window;
- gdouble *axes;
- GdkModifierType mask;
- PyObject *py_axes;
- guint i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GdkDevice.get_state",
- kwlist, &window))
- return NULL;
- if (!pygobject_check(window, &PyGdkWindow_Type)) {
- PyErr_SetString(PyExc_TypeError, "window should be a GdkWindow");
- return NULL;
- }
- axes = g_new0(gdouble, device->num_axes);
- gdk_device_get_state(device, GDK_WINDOW(window->obj), axes, &mask);
- py_axes = PyTuple_New(device->num_axes);
- for (i = 0; i < device->num_axes; i++)
- PyTuple_SetItem(py_axes, i, PyFloat_FromDouble(axes[i]));
- g_free(axes);
- return Py_BuildValue("(NN)", py_axes,
- pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE, mask));
-}
-%%
-ignore gdk_device_free_history
-%%
-override gdk_device_get_history kwargs
-static PyObject *
-_wrap_gdk_device_get_history(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "window", "start", "stop", NULL };
- GdkDevice *device = GDK_DEVICE(self->obj);
- PyGObject *window;
- guint start, stop;
- GdkTimeCoord **events;
- gint n_events;
- PyObject *pyevents;
- guint i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oii:GdkDevice.get_history", kwlist,
- &window, &start, &stop))
- return NULL;
- if (!pygobject_check(window, &PyGdkWindow_Type)) {
- PyErr_SetString(PyExc_TypeError, "window should be a GdkWindow");
- return NULL;
- }
- gdk_device_get_history(device, GDK_WINDOW(window->obj), start, stop,
- &events, &n_events);
- pyevents = PyTuple_New(n_events);
- for (i = 0; i < n_events; i++) {
- PyObject *axes;
- gint j;
-
- axes = PyTuple_New(device->num_axes);
- for (j = 0; j < device->num_axes; j++)
- PyTuple_SetItem(axes, j, PyFloat_FromDouble(events[i]->axes[j]));
- PyTuple_SetItem(pyevents, i, Py_BuildValue("(iN)", events[i]->time,
- axes));
- }
- gdk_device_free_history(events, n_events);
- return pyevents;
-}
-%%
-override gdk_device_get_axis kwargs
-static PyObject *
-_wrap_gdk_device_get_axis(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "axes", "use", NULL };
- GdkDevice *device = GDK_DEVICE(self->obj);
- PyObject *py_axes;
- gdouble *axes, value;
- GdkAxisUse use;
- gboolean ret;
- gint i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "Oi:GdkDevice.get_axis",
- kwlist, &py_axes, &use))
- return NULL;
- if (!PySequence_Check(py_axes)) {
- PyErr_SetString(PyExc_TypeError, "axes must be a sequence");
- return NULL;
- }
- if (PySequence_Length(py_axes) != device->num_axes) {
- PyErr_SetString(PyExc_TypeError, "axes has the wrong length");
- return NULL;
- }
- axes = g_new(gdouble, device->num_axes);
- for (i = 0; i < device->num_axes; i++) {
- PyObject *item = PySequence_GetItem(py_axes, i);
-
- axes[i] = PyFloat_AsDouble(item);
- Py_DECREF(item);
- if (PyErr_Occurred()) {
- g_free(axes);
- return NULL;
- }
- }
- ret = gdk_device_get_axis(device, axes, use, &value);
- g_free(axes);
- if (ret)
- return PyFloat_FromDouble(value);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_drag_find_window kwargs
-static PyObject *
-_wrap_gdk_drag_find_window(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "drag_window", "x_root", "y_root", NULL };
- PyGObject *drag_window;
- gint x_root, y_root;
- GdkWindow *dest_window;
- GdkDragProtocol protocol;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oii:GdkDragContext.drag_find_window",
- kwlist, &drag_window, &x_root, &y_root))
- return NULL;
- if (!pygobject_check(drag_window, &PyGdkWindow_Type)) {
- PyErr_SetString(PyExc_TypeError, "drag_window must be a GdkWindow");
- return NULL;
- }
- gdk_drag_find_window(GDK_DRAG_CONTEXT(self->obj),
- GDK_WINDOW(drag_window->obj), x_root, y_root,
- &dest_window, &protocol);
- return Py_BuildValue("(Ni)", pygobject_new((GObject *)dest_window),
- protocol);
-}
-%%
-override gdk_drag_find_window_for_screen kwargs
-static PyObject *
-_wrap_gdk_drag_find_window_for_screen(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "drag_window", "screen", "x_root", "y_root", NULL };
- PyGObject *drag_window, *screen;
- gint x_root, y_root;
- GdkWindow *dest_window;
- GdkDragProtocol protocol;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!O!ii:GdkDragContext.drag_find_window_for_screen",
- kwlist, &PyGdkWindow_Type, &drag_window,
- &PyGdkScreen_Type, &screen,
- &x_root, &y_root))
- return NULL;
- gdk_drag_find_window_for_screen(GDK_DRAG_CONTEXT(self->obj),
- GDK_WINDOW(drag_window->obj),
- GDK_SCREEN(screen->obj),
- x_root, y_root,
- &dest_window, &protocol);
- return Py_BuildValue("(Ni)", pygobject_new((GObject *)dest_window),
- protocol);
-}
-%%
-override-attr GdkDragContext.targets
-static PyObject *
-_wrap_gdk_drag_context__get_targets(PyGObject *self, void *closure)
-{
- PyObject *atom, *ret = PyList_New(0);
- GList *tmp;
- if (ret == NULL)
- return NULL;
- for (tmp = GDK_DRAG_CONTEXT(self->obj)->targets; tmp; tmp = tmp->next) {
- gchar *name;
-
- name = gdk_atom_name(GDK_POINTER_TO_ATOM(tmp->data));
- if ((atom = PyString_FromString(name)) == NULL) {
- g_free(name);
- Py_DECREF(ret);
- return NULL;
- }
- PyList_Append(ret, atom);
- g_free(name);
- Py_DECREF(atom);
- }
- return ret;
-}
-%%
-override gdk_drawable_get_size noargs
-static PyObject *
-_wrap_gdk_drawable_get_size(PyGObject *self)
-{
- gint width;
- gint height;
-
- gdk_drawable_get_size(GDK_DRAWABLE(self->obj), &width, &height);
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override gdk_drag_begin kwargs
-static PyObject *
-_wrap_gdk_drag_begin(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "targets", NULL };
- PyObject *py_targets;
- GList *targets = NULL;
- guint i, len;
- GdkDragContext *context;
- PyObject *py_context;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GdkWindow.drag_begin",
- kwlist, &py_targets))
- return NULL;
- if (!PySequence_Check(py_targets)) {
- PyErr_SetString(PyExc_TypeError, "targets must be a list of ints");
- return NULL;
- }
- len = PySequence_Length(py_targets);
- for (i = 0; i < len; i++) {
- PyObject *item = PySequence_GetItem(py_targets, i);
-
- if (PyInt_Check(item)) {
- targets = g_list_append(targets,
- GUINT_TO_POINTER(PyInt_AsLong(item)));
- Py_DECREF(item);
- } else {
- PyErr_SetString(PyExc_TypeError, "targets must be a list of ints");
- Py_DECREF(item);
- g_list_free(targets);
- return NULL;
- }
- }
- context = gdk_drag_begin(GDK_WINDOW(self->obj), targets);
- g_list_free(targets);
- py_context = pygobject_new((GObject *)context);
- gdk_drag_context_unref(context);
- return py_context;
-}
-%%
-override gdk_devices_list noargs
-static PyObject *
-_wrap_gdk_devices_list(PyObject *self)
-{
- GList * devlist, *tmp;
- PyObject *list;
-
- devlist = gdk_devices_list();
- list = PyList_New(0);
- for (tmp = devlist; tmp != NULL; tmp = tmp->next) {
- PyObject *item = pygobject_new((GObject *)tmp->data);
- PyList_Append(list, item);
- Py_DECREF(item);
- }
-
- return list;
-}
-%%
-override-attr GdkDrawable.handle
-static PyObject *
-_wrap_gdk_drawable__get_handle(PyGObject *self, void *closure)
-{
-#if defined(GDK_WINDOWING_WIN32)
- GdkDrawable *drawable = GDK_DRAWABLE(self->obj);
- return PyLong_FromVoidPtr(GDK_WINDOW_HWND(drawable));
-#else
- PyErr_SetString(PyExc_AttributeError, "handle attribute not supported");
- return NULL;
-#endif
-}
-%%
-override-attr GdkDrawable.xid
-static PyObject *
-_wrap_gdk_drawable__get_xid(PyGObject *self, void *closure)
-{
-#if defined(GDK_WINDOWING_X11)
- GdkDrawable *drawable = GDK_DRAWABLE(self->obj);
- return PyLong_FromUnsignedLong(GDK_DRAWABLE_XID(drawable));
-#else
- PyErr_SetString(PyExc_AttributeError, "xid attribute not supported");
- return NULL;
-#endif
-}
-%%
-override gdk_list_visuals noargs
-static PyObject *
-_wrap_gdk_list_visuals(PyGObject *self)
-{
- GList *visl;
- guint nvisl;
- int i;
- PyObject *list;
-
- visl = gdk_list_visuals();
- nvisl = g_list_length(visl);
-
- if ((list = PyList_New(nvisl)) == NULL)
- return NULL;
-
- for (i = 0; i < nvisl; i++) {
- PyObject *item;
-
- item = pygobject_new((GObject *)g_list_nth_data(visl, i));
- PyList_SetItem(list, i, item);
- }
-
- g_list_free(visl);
-
- return list;
-}
-%%
-override gdk_display_list_devices noargs
-static PyObject *
-_wrap_gdk_display_list_devices(PyGObject *self)
-{
- GList * devlist, *tmp;
- PyObject *list;
-
- devlist = gdk_display_list_devices(GDK_DISPLAY_OBJECT(self->obj));
- list = PyList_New(0);
- for (tmp = devlist; tmp != NULL; tmp = tmp->next) {
- PyObject *item = pygobject_new((GObject *)tmp->data);
- PyList_Append(list, item);
- Py_DECREF(item);
- }
-
- return list;
-}
-%%
-override gdk_display_get_pointer noargs
-static PyObject *
-_wrap_gdk_display_get_pointer(PyGObject *self)
-{
- GdkScreen *screen = NULL;
- gint x, y;
- GdkModifierType mask;
-
- gdk_display_get_pointer(GDK_DISPLAY_OBJECT(self->obj), &screen, &x, &y, &mask);
- return Py_BuildValue("(NiiN)", pygobject_new((GObject *)screen),
- x, y,
- pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE, mask));
-}
-%%
-override gdk_display_get_window_at_pointer noargs
-static PyObject *
-_wrap_gdk_display_get_window_at_pointer(PyGObject *self)
-{
- GdkWindow *window;
- gint win_x, win_y;
-
- window = gdk_display_get_window_at_pointer(GDK_DISPLAY_OBJECT(self->obj),
- &win_x, &win_y);
- if (window)
- return Py_BuildValue("(Nii)", pygobject_new((GObject *)window),
- win_x, win_y);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_display_manager_list_displays noargs
-static PyObject *
-_wrap_gdk_display_manager_list_displays(PyGObject *self)
-{
- GSList *list, *tmp;
- PyObject *py_list;
-
- list = gdk_display_manager_list_displays(GDK_DISPLAY_MANAGER(self->obj));
- py_list = PyList_New(0);
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- PyObject *item = pygobject_new((GObject *)tmp->data);
- PyList_Append(py_list, item);
- Py_DECREF(item);
- }
- g_slist_free(list);
-
- return py_list;
-}
-%%
-override gdk_screen_list_visuals noargs
-static PyObject *
-_wrap_gdk_screen_list_visuals(PyGObject *self)
-{
- GList *visl;
- guint nvisl;
- int i;
- PyObject *list;
-
- visl = gdk_screen_list_visuals(GDK_SCREEN(self->obj));
- nvisl = g_list_length(visl);
-
- if ((list = PyList_New(nvisl)) == NULL)
- return NULL;
-
- for (i = 0; i < nvisl; i++) {
- PyObject *item;
-
- item = pygobject_new((GObject *)g_list_nth_data(visl, i));
- PyList_SetItem(list, i, item);
- }
-
- g_list_free(visl);
-
- return list;
-}
-%%
-override gdk_screen_get_toplevel_windows noargs
-static PyObject *
-_wrap_gdk_screen_get_toplevel_windows(PyGObject *self)
-{
- GList *topl;
- guint ntopl;
- int i;
- PyObject *list;
-
- topl = gdk_screen_get_toplevel_windows(GDK_SCREEN(self->obj));
- ntopl = g_list_length(topl);
-
- if ((list = PyList_New(ntopl)) == NULL)
- return NULL;
-
- for (i = 0; i < ntopl; i++) {
- PyObject *item;
-
- item = pygobject_new((GObject *)g_list_nth_data(topl, i));
- PyList_SetItem(list, i, item);
- }
-
- g_list_free(topl);
-
- return list;
-}
-%%
-override gdk_screen_get_monitor_geometry kwargs
-static PyObject *
-_wrap_gdk_screen_get_monitor_geometry(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "monitor_num", NULL };
- int monitor_num;
- GdkRectangle dest = { 0, 0, 0, 0 };
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i:GdkScreen.get_monitor_geometry",
- kwlist, &monitor_num))
- return NULL;
-
- gdk_screen_get_monitor_geometry(GDK_SCREEN(self->obj), monitor_num, &dest);
-
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &dest, TRUE, TRUE);
-}
-%%
-override gdk_screen_get_setting kwargs
-static PyObject *
-_wrap_gdk_screen_get_setting(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "name", NULL };
- char *name;
- GValue value = { 0, };
- PyObject *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s:GdkScreen.get_setting",
- kwlist, &name))
- return NULL;
-
- /* this is a bit of a hack. We don't know what type of setting it is */
- g_value_init(&value, GDK_TYPE_COLOR);
- if (gdk_screen_get_setting(GDK_SCREEN(self->obj), name, &value))
- goto got_setting;
- g_value_unset(&value);
- g_value_init(&value, G_TYPE_INT);
- if (gdk_screen_get_setting(GDK_SCREEN(self->obj), name, &value))
- goto got_setting;
- g_value_unset(&value);
- g_value_init(&value, G_TYPE_STRING);
- if (gdk_screen_get_setting(GDK_SCREEN(self->obj), name, &value))
- goto got_setting;
- g_value_unset(&value);
- /* setting not found */
- PyErr_SetString(PyExc_ValueError, "could not find setting");
- return NULL;
-
- got_setting:
- ret = pyg_value_as_pyobject(&value, TRUE);
- g_value_unset(&value);
- return ret;
-}
-%%
-override gdk_atom_intern kwargs
-static PyObject *
-_wrap_gdk_atom_intern(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "atom_name", "only_if_exists", NULL };
- char *atom_name;
- int only_if_exists = FALSE;
- GdkAtom ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|i:atom_intern",
- kwlist, &atom_name, &only_if_exists))
- return NULL;
- ret = gdk_atom_intern(atom_name, only_if_exists);
- if (ret == GDK_NONE) {
- Py_INCREF(Py_None);
- return Py_None;
- }
- return PyGdkAtom_New(ret);
-}
-%%
-override gdk_display_get_maximal_cursor_size noargs
-static PyObject *
-_wrap_gdk_display_get_maximal_cursor_size(PyGObject *self)
-{
- guint width, height;
-
- gdk_display_get_maximal_cursor_size(GDK_DISPLAY(self->obj),
- &width, &height);
-
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override gdk_keyval_convert_case kwargs
-static PyObject *
-_wrap_gdk_keyval_convert_case(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "symbol", NULL };
- guint symbol, upper, lower;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i:keyval_convert_case",
- kwlist, &symbol))
- return NULL;
-
- gdk_keyval_convert_case(symbol, &lower, &upper);
-
- return Py_BuildValue("(ii)", lower, upper);
-}
-%%
-override gdk_keymap_get_entries_for_keyval kwargs
-static PyObject *
-_wrap_gdk_keymap_get_entries_for_keyval(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "keyval", NULL };
- guint keyval;
- GdkKeymapKey *keys;
- gint n_keys;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i:gtk.gdk.Keymap.get_entries_for_keyval",
- kwlist, &keyval))
- return NULL;
-
- if (gdk_keymap_get_entries_for_keyval(GDK_KEYMAP(self->obj), keyval,
- &keys, &n_keys)) {
- int i;
- PyObject * list = PyTuple_New(n_keys);
-
- for (i = 0; i < n_keys; i++) {
- PyTuple_SetItem(list, i,
- Py_BuildValue("(iii)", keys[i].keycode,
- keys[i].group, keys[i].level));
- }
- g_free(keys);
-
- return list;
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_keymap_get_entries_for_keycode kwargs
-static PyObject *
-_wrap_gdk_keymap_get_entries_for_keycode(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "hardware_keycode", NULL };
- guint keycode;
- GdkKeymapKey *keys;
- guint *keyvals;
- gint n_keys;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i:gtk.gdk.Keymap.get_entries_for_keycode",
- kwlist, &keycode))
- return NULL;
-
- if (gdk_keymap_get_entries_for_keycode(GDK_KEYMAP(self->obj), keycode,
- &keys, &keyvals, &n_keys)) {
- int i;
- PyObject * list = PyTuple_New(n_keys);
-
- for (i = 0; i < n_keys; i++) {
- PyTuple_SetItem(list, i,
- Py_BuildValue("(iiii)", keyvals[i],
- keys[i].keycode,
- keys[i].group, keys[i].level));
- }
- g_free(keys);
-
- return list;
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_keymap_lookup_key kwargs
-static PyObject *
-_wrap_gdk_keymap_lookup_key(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "keycode", "group", "level", NULL };
- GdkKeymapKey key;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iii:gtk.gdk.Keymap.lookup_key",
- kwlist, &key.keycode, &key.group,
- &key.level))
- return NULL;
-
- return PyInt_FromLong(gdk_keymap_lookup_key(GDK_KEYMAP(self->obj), &key));
-}
-%%
-override gdk_keymap_translate_keyboard_state kwargs
-static PyObject *
-_wrap_gdk_keymap_translate_keyboard_state(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "keycode", "state", "group", NULL };
- guint keycode, keyval;
- gint group, effective_group, level;
- GdkModifierType state, modifiers;
- PyObject *py_state;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iOi:gtk.gdk.Keymap.translate_keyboard_state",
- kwlist, &keycode, &py_state,
- &group))
- return NULL;
-
- if (pyg_flags_get_value(GDK_TYPE_MODIFIER_TYPE, py_state,
- (gint *)&state))
- return NULL;
-
- if (gdk_keymap_translate_keyboard_state(GDK_KEYMAP(self->obj), keycode,
- state, group, &keyval,
- &effective_group, &level,
- &modifiers))
- return Py_BuildValue("(iiiN)", keyval, effective_group, level,
- pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE,
- modifiers));
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_query_depths noargs
-static PyObject *
-_wrap_gdk_query_depths(PyObject *self)
-{
- gint count, i;
- gint *depths;
- PyObject *py_depths;
-
- gdk_query_depths(&depths, &count);
-
- py_depths = PyTuple_New(count);
-
- for (i = 0; i < count; i++)
- PyTuple_SetItem(py_depths, i, PyInt_FromLong(depths[i]));
-
- return py_depths;
-}
-%%
-override gdk_query_visual_types noargs
-static PyObject *
-_wrap_gdk_query_visual_types(PyObject *self)
-{
- gint count, i;
- GdkVisualType *types;
- PyObject *py_types;
-
- gdk_query_visual_types(&types, &count);
-
- py_types = PyTuple_New(count);
-
- for (i = 0; i < count; i++)
- PyTuple_SetItem(py_types, i, PyInt_FromLong(types[i]));
-
- return py_types;
-}
-%%
-override gdk_window_at_pointer noargs
-static PyObject *
-_wrap_gdk_window_at_pointer(PyObject *self)
-{
- GdkWindow *window;
- gint x, y;
-
- window = gdk_window_at_pointer(&x, &y);
-
- if (window)
- return Py_BuildValue("(Nii)", pygobject_new((GObject *)window), x, y);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_display_store_clipboard kwargs
-static PyObject *
-_wrap_gdk_display_store_clipboard(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "clipboard_window", "time_", "targets", NULL };
- PyGObject *pyclipboard_window;
- guint32 time_;
- PyObject *pytargets;
- GdkAtom *targets;
- int tlen, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!iO:GdkDIsplay.store_clipboard", kwlist,
- &PyGdkWindow_Type, &pyclipboard_window,
- &time_, &pytargets))
- return NULL;
-
- if (!pytargets || pytargets == Py_None) {
- tlen = 0;
- targets = NULL;
- } else {
- if (!PySequence_Check(pytargets)) {
- PyErr_SetString(PyExc_TypeError,
- "targets must be a sequence of target strings"
- "or GdkAtoms or None");
- return NULL;
- }
- tlen = PySequence_Size(pytargets);
- targets = g_new0(GdkAtom, tlen);
- for (i = 0; i < tlen; i++) {
- PyObject *item = PySequence_GetItem(pytargets, i);
- targets[i] = pygdk_atom_from_pyobject(item);
- if (PyErr_Occurred()) {
- Py_DECREF(item);
- g_free(targets);
- return NULL;
- }
- Py_DECREF(item);
- }
- g_free(targets);
- }
- gdk_display_store_clipboard(GDK_DISPLAY(self->obj),
- GDK_WINDOW(pyclipboard_window->obj),
- time_, targets, tlen);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_event_handler_set args
-static void
-pygdk_event_handler_marshal(GdkEvent *event, gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *retobj;
- PyObject *pyevent;
-
- g_assert (cunote->func);
-
- state = pyg_gil_state_ensure();
-
- pyevent = pyg_boxed_new(GDK_TYPE_EVENT, event, TRUE, TRUE);
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NO)",
- pyevent, cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(N)", pyevent);
-
- if (retobj == NULL) {
- PyErr_Print();
- } else
- Py_DECREF(retobj);
-
- pyg_gil_state_release(state);
-}
-
-static PyObject *
-_wrap_gdk_event_handler_set(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTuple(args, "O|O:event_handler_set",
- &pyfunc, &pyarg))
- return NULL;
-
- if (pyfunc == Py_None) {
- gdk_event_handler_set(NULL, NULL, NULL);
- } else {
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gdk_event_handler_set(pygdk_event_handler_marshal,
- cunote,
- pygtk_custom_destroy_notify);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-override gdk_bitmap_create_from_data kwargs
-static PyObject *
-_wrap_gdk_bitmap_create_from_data(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "drawable", "data", "width", "height", NULL };
- PyGObject *py_drawable;
- GdkDrawable *drawable = NULL;
- gchar *data;
- GdkBitmap *ret;
- Py_ssize_t data_len;
- int width, height, rowstride;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,"Os#ii:bitmap_create_from_data", kwlist, &py_drawable, &data, &data_len, &width, &height))
- return NULL;
- if (py_drawable && pygobject_check(py_drawable, &PyGdkDrawable_Type))
- drawable = GDK_DRAWABLE(py_drawable->obj);
- else if ((PyObject *)py_drawable != Py_None) {
- PyErr_SetString(PyExc_TypeError, "drawable should be a GdkDrawable or None");
- return NULL;
- }
-
- rowstride = (width&(~7))/8 + 1;
- if (data_len*8 < rowstride*height) {
- PyErr_SetString(PyExc_ValueError, "data size is insufficient for the given width, height, and depth");
- return NULL;
- }
-
- ret = gdk_bitmap_create_from_data((GdkDrawable *) drawable, data, width, height);
-
- /* pygobject_new handles NULL checking */
- return pygobject_new((GObject *)ret);
-}
-
-%%
-override gdk_pixmap_create_from_data kwargs
-static PyObject *
-_wrap_gdk_pixmap_create_from_data(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "drawable", "data", "width", "height", "depth", "fg", "bg", NULL };
- Py_ssize_t data_len;
- int width, height, depth;
- GdkPixmap *ret;
- PyObject *py_fg, *py_bg;
- GdkColor *fg = NULL, *bg = NULL;
- GdkDrawable *drawable = NULL;
- gchar *data;
- PyGObject *py_drawable;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,"Os#iiiOO:pixmap_create_from_data", kwlist, &py_drawable, &data, &data_len, &width, &height, &depth, &py_fg, &py_bg))
- return NULL;
- if (py_drawable && pygobject_check(py_drawable, &PyGdkDrawable_Type))
- drawable = GDK_DRAWABLE(py_drawable->obj);
- else if ((PyObject *)py_drawable != Py_None) {
- PyErr_SetString(PyExc_TypeError, "drawable should be a GdkDrawable or None");
- return NULL;
- }
- if (pyg_boxed_check(py_fg, GDK_TYPE_COLOR))
- fg = pyg_boxed_get(py_fg, GdkColor);
- else {
- PyErr_SetString(PyExc_TypeError, "fg should be a GdkColor");
- return NULL;
- }
- if (pyg_boxed_check(py_bg, GDK_TYPE_COLOR))
- bg = pyg_boxed_get(py_bg, GdkColor);
- else {
- PyErr_SetString(PyExc_TypeError, "bg should be a GdkColor");
- return NULL;
- }
-
- if (data_len < width*height*(depth>>3)) {
- PyErr_SetString(PyExc_ValueError, "data size is insufficient for the given width, height, and depth");
- return NULL;
- }
-
- ret = gdk_pixmap_create_from_data((GdkDrawable *) drawable, data, width, height, depth, fg, bg);
-
- /* pygobject_new handles NULL checking */
- return pygobject_new((GObject *)ret);
-}
-%%
-override gdk_screen_get_font_options noargs
-static PyObject *
-_wrap_gdk_screen_get_font_options(PyGObject *self)
-{
- const cairo_font_options_t *options;
-
- options = gdk_screen_get_font_options(GDK_SCREEN(self->obj));
- if (!options) {
- Py_INCREF(Py_None);
- return Py_None;
- }
- return PycairoFontOptions_FromFontOptions(cairo_font_options_copy(options));
-}
-%%
-override gdk_screen_set_font_options kwargs
-static PyObject *
-_wrap_gdk_screen_set_font_options(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "options", NULL };
- PyGObject *py_options;
- const cairo_font_options_t *options;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GdkScreen.set_font_options",
- kwlist, &py_options))
- return NULL;
- if ((PyObject*)py_options == Py_None)
- options = NULL;
- else if (pygobject_check(py_options, &PycairoFontOptions_Type))
- options = ((PycairoFontOptions *)py_options)->font_options;
- else {
- PyErr_SetString(PyExc_TypeError,
- "options must be a cairo.FontOptions or None");
- return NULL;
- }
-
- gdk_screen_set_font_options(GDK_SCREEN(self->obj), options);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-override gdk_display_close noargs
-static PyObject *
-_wrap_gdk_display_close(PyGObject *self)
-{
- GdkDisplay *display = GDK_DISPLAY(self->obj);
- if (self->obj && !display->closed) {
- g_object_ref(self->obj);
- gdk_display_close(display);
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
diff --git a/gtk/gdkcairo.override b/gtk/gdkcairo.override
deleted file mode 100644
index b231c651..00000000
--- a/gtk/gdkcairo.override
+++ /dev/null
@@ -1,249 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 2005 Gustavo Carneiro
- *
- * gdkcairo.override: GdkCairo overrides
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-body
-
-#ifdef HAVE_PYCAIRO
-
-
-static PyTypeObject *_PyPangoCairoContext_Type;
-#define PyPangoCairoContext_Type (*_PyPangoCairoContext_Type)
-
-static PyObject *
-_wrap_gdk_cairo_set_source_color(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "color", NULL };
- PyObject *py_color;
- GdkColor *color = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:gtk.gdk.CairoContext.set_source_color", kwlist, &py_color))
- return NULL;
- if (pyg_boxed_check(py_color, GDK_TYPE_COLOR))
- color = pyg_boxed_get(py_color, GdkColor);
- else {
- PyErr_SetString(PyExc_TypeError, "color should be a GdkColor");
- return NULL;
- }
- gdk_cairo_set_source_color(PycairoContext_GET(self), color);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-_wrap_gdk_cairo_set_source_pixbuf(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "pixbuf", "pixbuf_x", "pixbuf_y", NULL };
- PyGObject *pixbuf;
- double pixbuf_x, pixbuf_y;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!dd:gtk.gdk.CairoContext.set_source_pixbuf", kwlist,
- &PyGdkPixbuf_Type, &pixbuf, &pixbuf_x, &pixbuf_y))
- return NULL;
- gdk_cairo_set_source_pixbuf(PycairoContext_GET(self), GDK_PIXBUF(pixbuf->obj),
- pixbuf_x, pixbuf_y);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-_wrap_gdk_cairo_rectangle(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "rectangle", NULL };
- PyObject *py_rectangle;
- GdkRectangle rectangle;
- double x, y, width, height;
-
- if (PyArg_ParseTuple (args, "dddd:Context.rectangle",
- &x, &y, &width, &height))
- {
- cairo_rectangle(PycairoContext_GET(self), x, y, width, height);
- } else {
- PyErr_Clear();
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:gtk.gdk.CairoContext.rectangle", kwlist,
- &py_rectangle)) {
- PyErr_SetString(PyExc_TypeError, "gtk.gdk.CairoContext.rectangle accepts either"
- " (x, y, width, height) or a single gtk.gdk.Rectangle parameter");
- return NULL;
- }
- if (!pyg_boxed_check(py_rectangle, GDK_TYPE_RECTANGLE)) {
- if (!pygdk_rectangle_from_pyobject(py_rectangle, &rectangle)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "rectangle must be a GdkRectangle or 4-tuple");
- return NULL;
- }
- } else {
- rectangle = *pyg_boxed_get(py_rectangle, GdkRectangle);
- }
-
- gdk_cairo_rectangle(PycairoContext_GET(self), &rectangle);
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-_wrap_gdk_cairo_region(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "region", NULL };
- PyGObject *py_region;
- GdkRegion *region;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:gtk.gdk.CairoContext.region", kwlist,
- &py_region))
- return NULL;
-
- if (pyg_boxed_check(py_region, PYGDK_TYPE_REGION))
- region = pyg_boxed_get(py_region, GdkRegion);
- else {
- PyErr_SetString(PyExc_TypeError, "region should be a gtk.gdk.Region");
- return NULL;
- }
-
- gdk_cairo_region(PycairoContext_GET(self), region);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-#if GTK_CHECK_VERSION(2, 9, 3)
-static PyObject *
-_wrap_gdk_cairo_set_source_pixmap(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "pixmap", "pixmap_x", "pixmap_y", NULL };
- PyGObject *pixmap;
- double pixmap_x, pixmap_y;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!dd:cairo_set_source_pixmap", kwlist,
- &PyGdkPixmap_Type, &pixmap, &pixmap_x, &pixmap_y))
- return NULL;
- gdk_cairo_set_source_pixmap(PycairoContext_GET(self), GDK_PIXMAP(pixmap->obj),
- pixmap_x, pixmap_y);
- Py_INCREF(Py_None);
- return Py_None;
-}
-#endif
-
-static PyMethodDef _PyGdkCairoContext_methods[] = {
- { "set_source_pixbuf", (PyCFunction)_wrap_gdk_cairo_set_source_pixbuf, METH_VARARGS|METH_KEYWORDS },
- { "set_source_color", (PyCFunction)_wrap_gdk_cairo_set_source_color, METH_VARARGS|METH_KEYWORDS },
- { "rectangle", (PyCFunction)_wrap_gdk_cairo_rectangle, METH_VARARGS|METH_KEYWORDS },
- { "region", (PyCFunction)_wrap_gdk_cairo_region, METH_VARARGS|METH_KEYWORDS },
-#if GTK_CHECK_VERSION(2, 9, 3)
- { "set_source_pixmap", (PyCFunction)_wrap_gdk_cairo_set_source_pixmap, METH_VARARGS|METH_KEYWORDS },
-#endif
- { NULL, NULL, 0 }
-};
-
-
-PyTypeObject PyGdkCairoContext_Type = {
- PyObject_HEAD_INIT(NULL)
- 0, /* ob_size */
- "gtk.gdk.CairoContext", /* tp_name */
- 0, /* tp_basicsize */
- 0, /* tp_itemsize */
- /* methods */
- (destructor)0, /* tp_dealloc */
- (printfunc)0, /* tp_print */
- (getattrfunc)0, /* tp_getattr */
- (setattrfunc)0, /* tp_setattr */
- (cmpfunc)0, /* tp_compare */
- (reprfunc)0, /* tp_repr */
- 0, /* tp_as_number */
- 0, /* tp_as_sequence */
- 0, /* tp_as_mapping */
- (hashfunc)0, /* tp_hash */
- (ternaryfunc)0, /* tp_call */
- (reprfunc)0, /* tp_str */
- (getattrofunc)0, /* tp_getattro */
- (setattrofunc)0, /* tp_setattro */
- 0, /* tp_as_buffer */
- Py_TPFLAGS_DEFAULT, /* tp_flags */
- "A pangocairo.CairoContext enhanced with some additional gdk methods", /* Documentation string */
- (traverseproc)0, /* tp_traverse */
- (inquiry)0, /* tp_clear */
- (richcmpfunc)0, /* tp_richcompare */
- 0, /* tp_weaklistoffset */
- (getiterfunc)0, /* tp_iter */
- (iternextfunc)0, /* tp_iternext */
- _PyGdkCairoContext_methods, /* tp_methods */
- 0, /* tp_members */
- 0, /* tp_getset */
- (PyTypeObject *)0, /* tp_base */
- (PyObject *)0, /* tp_dict */
- 0, /* tp_descr_get */
- 0, /* tp_descr_set */
- 0, /* tp_dictoffset */
- (initproc)0, /* tp_init */
- 0, /* tp_alloc */
- 0, /* tp_new */
- 0, /* tp_free */
- (inquiry)0, /* tp_is_gc */
- (PyObject *)0, /* tp_bases */
-};
-
-#endif /* #ifdef HAVE_PYCAIRO */
-
-%%
-ignore
- gdk_cairo_set_source_color
- gdk_cairo_set_source_pixbuf
- gdk_cairo_rectangle
- gdk_cairo_region
- gdk_cairo_set_source_pixmap
-
-%%
-init
-#ifdef HAVE_PYCAIRO
- if ((module = PyImport_ImportModule("pangocairo")) != NULL) {
- PyObject *moddict = PyModule_GetDict(module);
-
- _PyPangoCairoContext_Type = (PyTypeObject *)PyDict_GetItemString(moddict, "CairoContext");
- if (_PyPangoCairoContext_Type == NULL) {
- PyErr_SetString(PyExc_ImportError,
- "cannot import name CairoContext from pangocairo");
- return;
- }
- } else {
- return;
- }
-
- PyGdkCairoContext_Type.tp_base = &PyPangoCairoContext_Type;
- if (PyType_Ready(&PyGdkCairoContext_Type) < 0) {
- g_return_if_reached();
- }
- if (PyDict_SetItemString(d, "CairoContext", (PyObject *)&PyGdkCairoContext_Type) < 0) {
- g_return_if_reached();
- }
-#endif
-
-%%
-override gdk_cairo_create noargs
-static PyObject *
-_wrap_gdk_cairo_create(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- cairo_t *ret;
-
- ret = gdk_cairo_create(GDK_DRAWABLE(self->obj));
- return PycairoContext_FromContext(ret, &PyGdkCairoContext_Type, NULL);
-}
-
diff --git a/gtk/gdkcolor.override b/gtk/gdkcolor.override
deleted file mode 100644
index c3490fd0..00000000
--- a/gtk/gdkcolor.override
+++ /dev/null
@@ -1,201 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gdkcolor.override: gtk.gdk.Color and gtk.gdk.ColorMap overrides
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-ignore
- gdk_color_copy gdk_color_free
- gdk_color_hash gdk_color_equal
-%%
-override gdk_color_new kwargs
-static int
-_wrap_gdk_color_new(PyGBoxed *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = {"red", "green", "blue", "pixel", NULL };
- int red = 0, green = 0, blue = 0;
- unsigned int pixel = 0;
- GdkColor colour;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|iiik:gdk.Color", kwlist,
- &red, &green, &blue, &pixel)) {
- return -1;
- }
- colour.red = red;
- colour.green = green;
- colour.blue = blue;
- colour.pixel = pixel;
-
- self->boxed = g_boxed_copy(GDK_TYPE_COLOR, &colour);
- self->free_on_dealloc = TRUE;
- self->gtype = GDK_TYPE_COLOR;
-
- return 0;
-}
-%%
-override-slot GdkColor.tp_setattr
-static int
-_wrap_gdk_color_tp_setattr(PyGBoxed *self, char *attr, PyObject *value)
-{
- if (value == NULL) {
- PyErr_SetString(PyExc_TypeError, "can't delete attributes");
- return -1;
- }
-
- if (PyInt_Check(value)) {
- int i = PyInt_AsLong(value);
- if (!strcmp(attr, "red")) {
- pyg_boxed_get(self, GdkColor)->red = i;
- return 0;
- } else if (!strcmp(attr, "green")) {
- pyg_boxed_get(self, GdkColor)->green = i;
- return 0;
- } else if (!strcmp(attr, "blue")) {
- pyg_boxed_get(self, GdkColor)->blue = i;
- return 0;
- } else if (!strcmp(attr, "pixel")) {
- pyg_boxed_get(self, GdkColor)->pixel = i;
- return 0;
- }
- }
-
- PyErr_SetString(PyExc_AttributeError, "could not write attribute");
- return -1;
-}
-%%
-override gdk_color_parse kwargs
-static PyObject *
-_wrap_gdk_color_parse(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "spec", NULL };
- const char *spec;
- GdkColor colour = { 0, };
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s:color_parse", kwlist,
- &spec))
- return NULL;
-
- if (!gdk_color_parse(spec, &colour)) {
- PyErr_SetString(PyExc_ValueError,
- "unable to parse colour specification");
- return NULL;
- }
-
- /* pyg_boxed_new handles NULL checking */
- return pyg_boxed_new (GDK_TYPE_COLOR, &colour, TRUE, TRUE);
-}
-%%
-override gdk_colormap_alloc_color kwargs
-static PyObject *
-_wrap_gdk_colormap_alloc_color(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist1[] = { "red", "green", "blue", "writeable", "best_match", NULL };
- static char *kwlist2[] = { "spec", "writeable", "best_match", NULL };
- static char *kwlist3[] = { "color", "writeable", "best_match", NULL };
- GdkColor colour = { 0, 0, 0, 0 };
- gboolean writeable = FALSE;
- gboolean best_match = TRUE;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "HHH|ii:GdkColormap.alloc_color", kwlist1,
- &colour.red, &colour.green, &colour.blue,
- &writeable, &best_match)) {
-
- PyObject *pycolour;
-
- PyErr_Clear();
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|ii:GdkColormap.alloc_color",
- kwlist3, &pycolour,
- &writeable, &best_match)) {
- return NULL;
- }
-
- if (!pyg_boxed_check(pycolour, GDK_TYPE_COLOR)) {
- gchar *color_name;
-
- PyErr_Clear();
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s|ii:GdkColormap.alloc_color",
- kwlist2, &color_name, &writeable,
- &best_match)) {
- return NULL;
- }
-
- if (!gdk_color_parse(color_name, &colour)) {
- PyErr_SetString(PyExc_ValueError,
- "unable to parse colour specification");
- return NULL;
- }
- } else {
- colour = *pyg_boxed_get(pycolour, GdkColor);
- }
- }
-
- if (!gdk_colormap_alloc_color(GDK_COLORMAP(self->obj),
- &colour, writeable, best_match)) {
- PyErr_SetString(PyExc_RuntimeError, "couldn't allocate colour");
- return NULL;
- }
- return pyg_boxed_new(GDK_TYPE_COLOR, &colour, TRUE, TRUE);
-}
-%%
-override gdk_color_alloc kwargs
-static PyObject *
-_wrap_gdk_color_alloc(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- if (!PyErr_Warn(PyExc_DeprecationWarning, "use GdkColormap.alloc_color")<0)
- return NULL;
- return _wrap_gdk_colormap_alloc_color(self, args, kwargs);
-}
-%%
-override gdk_colormap_query_color kwargs
-static PyObject *
-_wrap_gdk_colormap_query_color(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "pixel", NULL };
- GdkColor colour = { 0, 0, 0, 0 };
- PyObject *py_pixel;
- gulong pixel;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GdkColormap.query_color", kwlist,
- &py_pixel))
- return NULL;
-
- if (PyLong_Check(py_pixel)) {
- pixel = PyLong_AsUnsignedLong(py_pixel);
- if (PyErr_Occurred())
- return NULL;
- } else if (PyInt_Check(py_pixel))
- pixel = PyInt_AS_LONG(py_pixel);
- else {
- PyErr_SetString(PyExc_TypeError, "GdkColormap.query_color: pixel must be"
- " either int or long");
- return NULL;
- }
-
- gdk_colormap_query_color(GDK_COLORMAP(self->obj), pixel, &colour);
-
- return pyg_boxed_new(GDK_TYPE_COLOR, &colour, TRUE, TRUE);
-}
diff --git a/gtk/gdkdraw.override b/gtk/gdkdraw.override
deleted file mode 100644
index 1b5bab87..00000000
--- a/gtk/gdkdraw.override
+++ /dev/null
@@ -1,464 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gdkdraw.override: gtk.gdk.draw_* overrides
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-ignore
- gdk_draw_layout_line_with_colors
-
-%%
-override gdk_draw_polygon kwargs
-static PyObject *
-_wrap_gdk_draw_polygon(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "gc", "filled", "points", NULL };
- PyGObject *gc;
- PyObject *py_points;
- gint filled, npoints, i;
- GdkPoint *points;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!iO:GdkDrawable.draw_polygon", kwlist,
- &PyGdkGC_Type, &gc, &filled, &py_points))
- return NULL;
- if (!PySequence_Check(py_points)) {
- PyErr_SetString(PyExc_TypeError, "points must be a sequence");
- return NULL;
- }
- npoints = PySequence_Length(py_points);
- points = g_new(GdkPoint, npoints);
- for (i = 0; i < npoints; i++) {
- PyObject *item = PySequence_GetItem(py_points, i);
- Py_DECREF(item);
- if (!PyArg_ParseTuple(item, "ii", &points[i].x, &points[i].y)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "sequence members must be 2-tuples");
- g_free(points);
- return NULL;
- }
- }
- gdk_draw_polygon(GDK_DRAWABLE(self->obj), GDK_GC(gc->obj), filled,
- points, npoints);
- g_free(points);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_draw_text kwargs
-static PyObject *
-_wrap_gdk_draw_text(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "font", "gc", "x", "y", "text",NULL};
- PyGObject *gc;
- PyObject *font;
- int x, y;
- Py_ssize_t len;
- char *text;
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO!iis#:GdkDrawable.draw_text", kwlist,
- &font, &PyGdkGC_Type, &gc,
- &x, &y, &text, &len))
- return NULL;
- if (!pyg_boxed_check(font, GDK_TYPE_FONT)) {
- PyErr_SetString(PyExc_TypeError, "font must be a GdkFont");
- return NULL;
- }
- gdk_draw_text(GDK_DRAWABLE(self->obj), pyg_boxed_get(font, GdkFont),
- GDK_GC(gc->obj), x, y, text, len);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_draw_points kwargs
-static PyObject *
-_wrap_gdk_draw_points(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "gc", "points", NULL };
- PyGObject *gc;
- PyObject *py_points;
- gint npoints, i;
- GdkPoint *points;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!O:GdkDrawable.draw_points", kwlist,
- &PyGdkGC_Type, &gc, &py_points))
- return NULL;
- if (!PySequence_Check(py_points)) {
- PyErr_SetString(PyExc_TypeError, "points must be a sequence");
- return NULL;
- }
- npoints = PySequence_Length(py_points);
- points = g_new(GdkPoint, npoints);
- for (i = 0; i < npoints; i++) {
- PyObject *item = PySequence_GetItem(py_points, i);
- Py_DECREF(item);
- if (!PyArg_ParseTuple(item, "ii", &points[i].x, &points[i].y)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "sequence members must be 2-tuples");
- g_free(points);
- return NULL;
- }
- }
- gdk_draw_points(GDK_DRAWABLE(self->obj), GDK_GC(gc->obj), points, npoints);
- g_free(points);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_draw_segments kwargs
-static PyObject *
-_wrap_gdk_draw_segments(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "gc", "segs", NULL };
- PyGObject *gc;
- PyObject *py_segs;
- gint nsegs, i;
- GdkSegment *segs;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!O:GdkDrawable.draw_segments", kwlist,
- &PyGdkGC_Type, &gc, &py_segs))
- return NULL;
- if (!PySequence_Check(py_segs)) {
- PyErr_SetString(PyExc_TypeError, "segs must be a sequence");
- return NULL;
- }
- nsegs = PySequence_Length(py_segs);
- segs = g_new(GdkSegment, nsegs);
- for (i = 0; i < nsegs; i++) {
- PyObject *item = PySequence_GetItem(py_segs, i);
- Py_DECREF(item);
- if (!PyArg_ParseTuple(item, "iiii", &segs[i].x1, &segs[i].y1,
- &segs[i].x2, &segs[i].y2)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "sequence members must be 4-tuples");
- g_free(segs);
- return NULL;
- }
- }
- gdk_draw_segments(GDK_DRAWABLE(self->obj), GDK_GC(gc->obj), segs, nsegs);
- g_free(segs);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_draw_lines kwargs
-static PyObject *
-_wrap_gdk_draw_lines(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "gc", "points", NULL };
- PyGObject *gc;
- PyObject *py_points;
- gint npoints, i;
- GdkPoint *points;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!O:GdkDrawable.draw_lines", kwlist,
- &PyGdkGC_Type, &gc, &py_points))
- return NULL;
- if (!PySequence_Check(py_points)) {
- PyErr_SetString(PyExc_TypeError, "points must be a sequence");
- return NULL;
- }
- npoints = PySequence_Length(py_points);
- points = g_new(GdkPoint, npoints);
- for (i = 0; i < npoints; i++) {
- PyObject *item = PySequence_GetItem(py_points, i);
- Py_DECREF(item);
- if (!PyArg_ParseTuple(item, "ii", &points[i].x, &points[i].y)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "sequence members must be 2-tuples");
- g_free(points);
- return NULL;
- }
- }
- gdk_draw_lines(GDK_DRAWABLE(self->obj), GDK_GC(gc->obj), points, npoints);
- g_free(points);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_draw_rgb_image kwargs
-static PyObject *
-_wrap_gdk_draw_rgb_image(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "gc", "x", "y", "width", "height", "dith",
- "rgb_buf", "rowstride", "xdith", "ydith", NULL };
- PyGObject *gc;
- PyObject *py_dith;
- gint x, y, width, height, rowstride = -1, xdith = 0, ydith = 0;
- Py_ssize_t len;
- GdkRgbDither dith;
- guchar *rgb_buf;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!iiiiOs#|iii:GdkDrawable.draw_rgb_image",
- kwlist, &PyGdkGC_Type, &gc, &x, &y,
- &width, &height, &py_dith,
- &rgb_buf, &len, &rowstride,
- &xdith, &ydith))
- return NULL;
-
- if (pyg_enum_get_value(GDK_TYPE_RGB_DITHER, py_dith, (gint *)&dith))
- return NULL;
- if (!(width > 0 && height > 0)) {
- PyErr_SetString(PyExc_ValueError,
- "height and width must be greater than zero");
- return NULL;
- }
- if (rowstride == -1) rowstride = width * 3;
- if (len < rowstride * (height - 1) + width*3) {
- PyErr_SetString(PyExc_IndexError, "rgb_buf is not large enough");
- return NULL;
- }
- /* We always call gdk_draw_rgb_image_dithalign instead of
- * gdk_draw_rgb_image, since gdk_draw_rgb_image is strictly
- * equivalent to calling gdk_draw_rgb_image_dithalign with
- * xdith=0 and ydith=0, which are their default values. */
- gdk_draw_rgb_image_dithalign(GDK_DRAWABLE(self->obj), GDK_GC(gc->obj),
- x, y, width, height, dith, rgb_buf,
- rowstride, xdith, ydith);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-ignore gdk_draw_rgb_image_dithalign
-%%
-override gdk_draw_rgb_32_image kwargs
-static PyObject *
-_wrap_gdk_draw_rgb_32_image(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "gc", "x", "y", "width", "height", "dith",
- "rgb_buf", "rowstride", "xdith", "ydith", NULL };
- PyGObject *gc;
- PyObject *py_dith;
- gint x, y, width, height, rowstride = -1, xdith = 0, ydith = 0;
- Py_ssize_t len;
- GdkRgbDither dith;
- guchar *rgb_buf;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!iiiiOs#|iii:GdkDrawable.draw_rgb_32_image",
- kwlist, &PyGdkGC_Type, &gc, &x, &y,
- &width, &height, &py_dith,
- &rgb_buf, &len, &rowstride,
- &xdith, &ydith))
- return NULL;
-
- if (pyg_enum_get_value(GDK_TYPE_RGB_DITHER, py_dith, (gint *)&dith))
- return NULL;
- if (!(width > 0 && height > 0)) {
- PyErr_SetString(PyExc_ValueError,
- "height and width must be greater than zero");
- return NULL;
- }
- if (rowstride == -1) rowstride = width * 4;
- if (len < rowstride * (height - 1) + width*4) {
- PyErr_SetString(PyExc_IndexError, "rgb_buf is not large enough");
- return NULL;
- }
- /* We always call gdk_draw_rgb_32_image_dithalign instead of
- * gdk_draw_rgb_32_image, since gdk_draw_rgb_32_image is strictly
- * equivalent to calling gdk_draw_rgb_32_image_dithalign with
- * xdith=0 and ydith=0, which are their default values. */
- gdk_draw_rgb_32_image_dithalign(GDK_DRAWABLE(self->obj), GDK_GC(gc->obj),
- x, y, width, height, dith, rgb_buf,
- rowstride, xdith, ydith);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-ignore gdk_draw_rgb_32_image_dithalign
-%%
-override gdk_draw_gray_image kwargs
-static PyObject *
-_wrap_gdk_draw_gray_image(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "gc", "x", "y", "width", "height", "dith",
- "buf", "rowstride", NULL };
- PyGObject *gc;
- PyObject *py_dith;
- gint x, y, width, height, rowstride = -1;
- Py_ssize_t len;
- GdkRgbDither dith;
- guchar *buf;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!iiiiOs#|i:GdkDrawable.draw_gray_image",
- kwlist, &PyGdkGC_Type, &gc, &x, &y,
- &width, &height, &py_dith,
- &buf, &len, &rowstride))
- return NULL;
-
- if (pyg_enum_get_value(GDK_TYPE_RGB_DITHER, py_dith, (gint *)&dith))
- return NULL;
- if (!(width > 0 && height > 0)) {
- PyErr_SetString(PyExc_ValueError,
- "height and width must be greater than zero");
- return NULL;
- }
- if (rowstride == -1) rowstride = width;
- if (len < rowstride * (height - 1) + width) {
- PyErr_SetString(PyExc_IndexError, "buf is not large enough");
- return NULL;
- }
- gdk_draw_gray_image(GDK_DRAWABLE(self->obj), GDK_GC(gc->obj), x, y,
- width, height, dith, buf, rowstride);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_draw_indexed_image kwargs
-static PyObject *
-_wrap_gdk_draw_indexed_image(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "gc", "x", "y", "width", "height", "dith",
- "buf", "rowstride", "colors", NULL };
- PyGObject *gc;
- PyObject *py_dith;
- gint x, y, width, height, rowstride = -1;
- Py_ssize_t len;
- GdkRgbDither dith;
- guchar *buf;
- PyObject *pycolors;
- GdkRgbCmap *cmap;
- guint32 *colors;
- int i, n_colors;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!iiiiOs#iO:GdkDrawable.draw_indexed_image",
- kwlist, &PyGdkGC_Type, &gc, &x, &y,
- &width, &height, &py_dith,
- &buf, &len, &rowstride,
- &pycolors))
- return NULL;
-
- if (pyg_enum_get_value(GDK_TYPE_RGB_DITHER, py_dith, (gint *)&dith))
- return NULL;
- if (!(width > 0 && height > 0)) {
- PyErr_SetString(PyExc_ValueError,
- "height and width must be greater than zero");
- return NULL;
- }
- if (rowstride == -1) rowstride = width;
- if (len < rowstride * (height - 1) + width) {
- PyErr_SetString(PyExc_IndexError, "buf is not large enough");
- return NULL;
- }
- if (!PyList_Check(pycolors)) {
- PyErr_SetString(PyExc_TypeError, "colors must be a list");
- return NULL;
- }
- n_colors = PyList_Size(pycolors);
- colors = g_new0(guint32, n_colors);
- for (i = 0; i < n_colors; i++)
- colors[i] = PyInt_AsLong(PyList_GetItem(pycolors, i));
- cmap = gdk_rgb_cmap_new(colors, n_colors);
- gdk_draw_indexed_image(GDK_DRAWABLE(self->obj), GDK_GC(gc->obj), x, y,
- width, height, dith, buf, rowstride,
- cmap);
- gdk_rgb_cmap_free(cmap);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_draw_layout kwargs
-static PyObject *
-_wrap_gdk_draw_layout(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "gc", "x", "y", "layout", "foreground",
- "background", NULL };
- PyGObject *gc, *layout;
- int x, y;
- GdkColor *foreground = NULL, *background = NULL;
- PyObject *py_foreground = Py_None, *py_background = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "O!iiO!|OO:GdkDrawable.draw_layout",
- kwlist, &PyGdkGC_Type, &gc, &x, &y, &PyPangoLayout_Type, &layout,
- &py_foreground, &py_background))
- return NULL;
- if (pyg_boxed_check(py_foreground, GDK_TYPE_COLOR))
- foreground = pyg_boxed_get(py_foreground, GdkColor);
- else if (py_foreground != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "foreground should be a GdkColor or None");
- return NULL;
- }
- if (pyg_boxed_check(py_background, GDK_TYPE_COLOR))
- background = pyg_boxed_get(py_background, GdkColor);
- else if (py_background != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "background should be a GdkColor or None");
- return NULL;
- }
- gdk_draw_layout_with_colors(GDK_DRAWABLE(self->obj), GDK_GC(gc->obj), x, y,
- PANGO_LAYOUT(layout->obj), foreground,
- background);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_draw_layout_line kwargs
-static PyObject *
-_wrap_gdk_draw_layout_line(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "gc", "x", "y", "line", "foreground",
- "background", NULL };
- PyGObject *gc, *py_line;
- int x, y;
- GdkColor *foreground = NULL, *background = NULL;
- PyObject *py_foreground = Py_None, *py_background = Py_None;
- PangoLayoutLine *line;
-
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "O!iiO|OO:GdkDrawable.draw_layout_line",
- kwlist, &PyGdkGC_Type, &gc, &x, &y, &py_line,
- &py_foreground, &py_background))
- return NULL;
- if (pyg_boxed_check(py_line, PANGO_TYPE_LAYOUT_LINE))
- line = pyg_boxed_get(py_line, PangoLayoutLine);
- else {
- PyErr_SetString(PyExc_TypeError, "line should be a PangoLayoutLine");
- return NULL;
- }
- if (pyg_boxed_check(py_foreground, GDK_TYPE_COLOR))
- foreground = pyg_boxed_get(py_foreground, GdkColor);
- else if (py_foreground != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "foreground should be a GdkColor or None");
- return NULL;
- }
- if (pyg_boxed_check(py_background, GDK_TYPE_COLOR))
- background = pyg_boxed_get(py_background, GdkColor);
- else if (py_background != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "background should be a GdkColor or None");
- return NULL;
- }
- gdk_draw_layout_line_with_colors(GDK_DRAWABLE(self->obj), GDK_GC(gc->obj),
- x, y, line, foreground, background);
- Py_INCREF(Py_None);
- return Py_None;
-}
diff --git a/gtk/gdkevent.override b/gtk/gdkevent.override
deleted file mode 100644
index 6f18ca0a..00000000
--- a/gtk/gdkevent.override
+++ /dev/null
@@ -1,909 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gdkevent.override: gtk.gdk.Event overrides
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-override-slot GdkEvent.tp_setattr
-#define INT_CHECK() \
- if (!PyInt_Check(value)) { \
- PyErr_Format(PyExc_TypeError, "%s must be an int", attr); \
- return -1; \
- }
-#define FLOAT_CHECK() \
- if (!PyFloat_Check(value)) { \
- PyErr_Format(PyExc_TypeError, "%s must be a float", attr); \
- return -1; \
- }
-#define STRING_CHECK() \
- if (!PyString_Check(value)) { \
- PyErr_Format(PyExc_TypeError, "%s must be a string", attr); \
- return -1; \
- }
-static int
-_wrap_gdk_event_tp_setattr(PyObject *self, char *attr, PyObject *value)
-{
- GdkEvent *event;
-
- if (value == NULL) {
- PyErr_SetString(PyExc_TypeError, "can't delete attributes");
- return -1;
- }
-
- event = pyg_boxed_get(self, GdkEvent);
-
- /* Common members */
- if (attr[0] == 't' && !strcmp(attr, "type")) {
- PyErr_SetString(PyExc_AttributeError, "type is not writable");
- return -1;
- } else if (attr[0] == 'w' && !strcmp(attr, "window")) {
- if (!pygobject_check(value, &PyGdkWindow_Type)) {
- PyErr_SetString(PyExc_TypeError, "window must be a GdkWindow");
- return -1;
- }
- if (event->any.window)
- g_object_unref(event->any.window);
- event->any.window = g_object_ref(GDK_WINDOW(((PyGObject*)value)->obj));
- return 0;
- } else if (attr[0] == 's' && !strcmp(attr, "send_event")) {
- INT_CHECK();
- event->any.send_event = PyInt_AsLong(value);
- return 0;
- }
-
- switch(event->type) {
- case GDK_NOTHING: break;
- case GDK_DELETE: break;
- case GDK_DESTROY: break;
- case GDK_EXPOSE: /*GdkEventExpose expose*/
- if (!strcmp(attr, "area")) {
- if (!pygdk_rectangle_from_pyobject(value, &event->expose.area))
- return -1;
- return 0;
- } else if (!strcmp(attr, "count")) {
- INT_CHECK();
- event->expose.count = PyInt_AsLong(value);
- return 0;
- }
- break;
- case GDK_MOTION_NOTIFY: /*GdkEventMotion motion*/
- if (!strcmp(attr, "time")) {
- INT_CHECK();
- event->motion.time = PyInt_AsLong(value);
- return 0;
- } else if (attr[0] == 'x' && attr[1] == '\0') {
- FLOAT_CHECK();
- event->motion.x = PyFloat_AsDouble(value);
- return 0;
- } else if (attr[0] == 'y' && attr[1] == '\0') {
- FLOAT_CHECK();
- event->motion.y = PyFloat_AsDouble(value);
- return 0;
- } else if (!strcmp(attr, "axes")) {
- PyErr_SetString(PyExc_TypeError, "axes is not writable");
- return -1;
- } else if (!strcmp(attr, "state")) {
- INT_CHECK();
- event->motion.state = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "is_hint")) {
- INT_CHECK();
- event->motion.is_hint = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "device")) {
- PyErr_SetString(PyExc_TypeError, "device is not writable");
- return -1;
- } else if (!strcmp(attr, "x_root")) {
- FLOAT_CHECK()
- event->motion.x_root = PyFloat_AsDouble(value);
- return 0;
- } else if (!strcmp(attr, "y_root")) {
- FLOAT_CHECK()
- event->motion.x_root = PyFloat_AsDouble(value);
- return 0;
- }
- break;
- case GDK_BUTTON_PRESS: /*GdkEventButton button*/
- case GDK_2BUTTON_PRESS: /*GdkEventButton button*/
- case GDK_3BUTTON_PRESS: /*GdkEventButton button*/
- case GDK_BUTTON_RELEASE: /*GdkEventButton button*/
- if (!strcmp(attr, "time")) {
- INT_CHECK();
- event->button.time = PyInt_AsLong(value);
- return 0;
- } else if (attr[0] == 'x' && attr[1] == '\0') {
- FLOAT_CHECK();
- event->button.x = PyFloat_AsDouble(value);
- return 0;
- } else if (attr[0] == 'y' && attr[1] == '\0') {
- FLOAT_CHECK();
- event->button.y = PyFloat_AsDouble(value);
- return 0;
- } else if (!strcmp(attr, "axes")) {
- PyErr_SetString(PyExc_TypeError, "axes is not writable");
- return -1;
- } else if (!strcmp(attr, "state")) {
- INT_CHECK();
- event->button.state = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "button")) {
- INT_CHECK();
- event->button.button = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "device")) {
- PyErr_SetString(PyExc_TypeError, "device is not writable");
- return -1;
- } else if (!strcmp(attr, "x_root")) {
- FLOAT_CHECK();
- event->button.x_root = PyFloat_AsDouble(value);
- return 0;
- } else if (!strcmp(attr, "y_root")) {
- FLOAT_CHECK();
- event->button.x_root = PyFloat_AsDouble(value);
- return 0;
- }
- break;
- case GDK_KEY_PRESS: /*GdkEventKey key*/
- case GDK_KEY_RELEASE: /*GdkEventKey key*/
- if (!strcmp(attr, "time")) {
- INT_CHECK();
- event->key.time = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "state")) {
- INT_CHECK();
- event->key.state = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "keyval")) {
- INT_CHECK();
- event->key.keyval = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "string")) {
- STRING_CHECK();
- g_free(event->key.string);
- event->key.string = g_strdup(PyString_AsString(value));
- return 0;
- } else if (!strcmp(attr, "hardware_keycode")) {
- INT_CHECK();
- event->key.hardware_keycode = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "group")) {
- INT_CHECK();
- event->key.group = PyInt_AsLong(value);
- return 0;
- }
- break;
- case GDK_ENTER_NOTIFY: /*GdkEventCrossing crossing*/
- case GDK_LEAVE_NOTIFY: /*GdkEventCrossing crossing*/
- if (!strcmp(attr, "subwindow")) {
- if (!pygobject_check(value, &PyGdkWindow_Type)) {
- PyErr_SetString(PyExc_TypeError, "subwindow must be a GdkWindow");
- return -1;
- }
- if (event->crossing.subwindow)
- g_object_unref(event->crossing.subwindow);
- event->crossing.subwindow = g_object_ref(GDK_WINDOW(((PyGObject*)value)->obj));
- return 0;
- } else if (!strcmp(attr, "time")) {
- INT_CHECK();
- event->crossing.time = PyInt_AsLong(value);
- return 0;
- } else if (attr[0] == 'x' && attr[1] == '\0') {
- FLOAT_CHECK();
- event->crossing.x = PyFloat_AsDouble(value);
- return 0;
- } else if (attr[0] == 'y' && attr[1] == '\0') {
- FLOAT_CHECK();
- event->crossing.y = PyFloat_AsDouble(value);
- return 0;
- } else if (!strcmp(attr, "x_root")) {
- FLOAT_CHECK();
- event->crossing.x_root = PyFloat_AsDouble(value);
- return 0;
- } else if (!strcmp(attr, "y_root")) {
- FLOAT_CHECK();
- event->crossing.x_root = PyFloat_AsDouble(value);
- return 0;
- } else if (!strcmp(attr, "mode")) {
- INT_CHECK();
- event->crossing.mode = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "detail")) {
- INT_CHECK();
- event->crossing.detail = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "focus")) {
- INT_CHECK();
- event->crossing.focus = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "state")) {
- INT_CHECK();
- event->crossing.state = PyInt_AsLong(value);
- return 0;
- }
- break;
- case GDK_FOCUS_CHANGE: /*GdkEventFocus focus_change*/
- if (!strcmp(attr, "in_")) {
- INT_CHECK();
- event->focus_change.in = PyInt_AsLong(value);
- return 0;
- }
- break;
- case GDK_CONFIGURE:
- if (!strcmp(attr, "x")) {
- INT_CHECK();
- event->configure.x = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "y")) {
- INT_CHECK();
- event->configure.y = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "width")) {
- INT_CHECK();
- event->configure.width = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "height")) {
- INT_CHECK();
- event->configure.height = PyInt_AsLong(value);
- return 0;
- }
- case GDK_MAP: break;
- case GDK_UNMAP: break;
- case GDK_PROPERTY_NOTIFY: /*GdkEventProperty property*/
- if (!strcmp(attr, "atom")) {
- PyErr_SetString(PyExc_TypeError, "atom is not writable");
- return -1;
- } else if (!strcmp(attr, "time")) {
- INT_CHECK();
- event->property.time = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "state")) {
- INT_CHECK();
- event->property.state = PyInt_AsLong(value);
- return 0;
- }
- break;
- case GDK_SELECTION_CLEAR: /*GdkEventSelection selection*/
- case GDK_SELECTION_REQUEST: /*GdkEventSelection selection*/
- case GDK_SELECTION_NOTIFY: /*GdkEventSelection selection*/
- if (!strcmp(attr, "selection")) {
- PyErr_SetString(PyExc_TypeError, "selection is not writable");
- return -1;
- } else if (!strcmp(attr, "target")) {
- PyErr_SetString(PyExc_TypeError, "target is not writable");
- return -1;
- } else if (!strcmp(attr, "property")) {
- PyErr_SetString(PyExc_TypeError, "property is not writable");
- return -1;
- } else if (!strcmp(attr, "requestor")) {
- INT_CHECK();
- event->selection.requestor = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "time")) {
- INT_CHECK();
- event->selection.time = PyInt_AsLong(value);
- return 0;
- }
-
- break;
- case GDK_PROXIMITY_IN: /*GdkEventProximity proximity*/
- case GDK_PROXIMITY_OUT: /*GdkEventProximity proximity*/
- if (!strcmp(attr, "time")) {
- INT_CHECK();
- event->proximity.time = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "device")) {
- PyErr_SetString(PyExc_TypeError, "device is not writable");
- return -1;
- }
- break;
- case GDK_DRAG_ENTER: /*GdkEventDND dnd*/
- case GDK_DRAG_LEAVE: /*GdkEventDND dnd*/
- case GDK_DRAG_MOTION: /*GdkEventDND dnd*/
- case GDK_DRAG_STATUS: /*GdkEventDND dnd*/
- case GDK_DROP_START: /*GdkEventDND dnd*/
- case GDK_DROP_FINISHED: /*GdkEventDND dnd*/
- if (!strcmp(attr, "context")) {
- PyErr_SetString(PyExc_TypeError, "context is not writable");
- return -1;
- } else if (!strcmp(attr, "time")) {
- INT_CHECK();
- event->dnd.time = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "x_root")) {
- FLOAT_CHECK();
- event->dnd.x_root = PyFloat_AsDouble(value);
- return 0;
- } else if (!strcmp(attr, "y_root")) {
- FLOAT_CHECK();
- event->dnd.x_root = PyFloat_AsDouble(value);
- return 0;
- }
- break;
- case GDK_CLIENT_EVENT: /*GdkEventClient client*/
- if (!strcmp(attr, "message_type")) {
- GdkAtom message_type = pygdk_atom_from_pyobject(value);
- if (PyErr_Occurred())
- return -1;
- event->client.message_type = message_type;
- return 0;
- } else if (!strcmp(attr, "data_format")) {
- INT_CHECK();
- event->client.data_format = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "data")) {
- char *tmp;
- STRING_CHECK();
- tmp = PyString_AsString(value);
- strncpy(event->client.data.b, tmp, 20);
- return 0;
- }
- break;
- case GDK_VISIBILITY_NOTIFY: /*GdkEventVisibility visibility*/
- if (!strcmp(attr, "state")) {
- INT_CHECK();
- event->visibility.state = PyInt_AsLong(value);
- return 0;
- }
- break;
- case GDK_NO_EXPOSE: /*GdkEventNoExpose no_expose*/
- break;
- case GDK_SCROLL: /*GdkEventScroll scroll*/
- if (!strcmp(attr, "time")) {
- INT_CHECK();
- event->scroll.time = PyInt_AsLong(value);
- return 0;
- } else if (attr[0] == 'x' && attr[1] == '\0') {
- FLOAT_CHECK();
- event->scroll.x = PyFloat_AsDouble(value);
- return 0;
- } else if (attr[0] == 'y' && attr[1] == '\0') {
- FLOAT_CHECK();
- event->scroll.y = PyFloat_AsDouble(value);
- return 0;
- } else if (!strcmp(attr, "state")) {
- INT_CHECK();
- event->scroll.state = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "direction")) {
- INT_CHECK(); /* XXX: ENUM */
- event->scroll.direction = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "device")) {
- PyErr_SetString(PyExc_TypeError, "device is not writable");
- return -1;
- } else if (!strcmp(attr, "x_root")) {
- FLOAT_CHECK();
- event->scroll.x_root = PyFloat_AsDouble(value);
- return 0;
- } else if (!strcmp(attr, "y_root")) {
- FLOAT_CHECK();
- event->scroll.x_root = PyFloat_AsDouble(value);
- return 0;
- }
- break;
- case GDK_WINDOW_STATE: /*GdkEventWindowState window_state*/
- if (!strcmp(attr, "changed_mask")) {
- INT_CHECK();
- event->window_state.changed_mask = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "new_window_state")) {
- INT_CHECK();
- event->window_state.new_window_state = PyInt_AsLong(value);
- return 0;
- }
- break;
- case GDK_SETTING: /*GdkEventSetting setting*/
- if (!strcmp(attr, "action")) {
- INT_CHECK();
- event->setting.action = PyInt_AsLong(value);
- return 0;
- } else if (!strcmp(attr, "name")) {
- STRING_CHECK();
- event->setting.name = PyString_AsString(value);
- return 0;
- }
- break;
- case GDK_OWNER_CHANGE:
- if (!strcmp(attr, "owner")) {
- INT_CHECK();
- event->owner_change.owner = PyInt_AsLong(value);
- } else if (!strcmp(attr, "reason")) {
- INT_CHECK();
- event->owner_change.reason = PyInt_AsLong(value);
- } else if (!strcmp(attr, "selection")) {
- PyErr_SetString(PyExc_TypeError, "selection is not writable");
- return -1;
- } else if (!strcmp(attr, "time")) {
- INT_CHECK();
- event->owner_change.time = PyInt_AsLong(value);
- } else if (!strcmp(attr, "selection_time")) {
- INT_CHECK();
- event->owner_change.selection_time = PyInt_AsLong(value);
- }
- break;
- case GDK_GRAB_BROKEN:
- if (!strcmp(attr, "keyboard")) {
- INT_CHECK();
- event->grab_broken.keyboard = PyInt_AsLong(value);
- } else if (!strcmp(attr, "implicit")) {
- INT_CHECK();
- event->grab_broken.keyboard = PyInt_AsLong(value);
- } else if (!strcmp(attr, "grab_window")) {
- PyErr_SetString(PyExc_TypeError, "grab_window is not writable");
- return -1;
- }
- break;
- default:
- break;
- }
-
- PyErr_SetString(PyExc_AttributeError, "could not write attribute");
- return -1;
-}
-#undef INT_CHECK
-#undef FLOAT_CHECK
-#undef STRING_CHECK
-%%
-override-slot GdkEvent.tp_getattr
-static PyObject *
-_wrap_gdk_event_tp_getattr(PyObject *self, char *attr)
-{
- GdkEvent *event = pyg_boxed_get(self, GdkEvent);
- guint i;
- gchar *name;
- PyObject *ret;
-
- switch(event->type) {
- case GDK_NOTHING: break;
- case GDK_DELETE: break;
- case GDK_DESTROY: break;
- case GDK_EXPOSE: /*GdkEventExpose expose*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[sssss]",
- "type", "window", "send_event",
- "area", "count");
- if (!strcmp(attr, "area"))
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &event->expose.area,
- TRUE, TRUE);
- if (!strcmp(attr, "count"))
- return PyInt_FromLong(event->expose.count);
- break;
- case GDK_MOTION_NOTIFY: /*GdkEventMotion motion*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ssssssssssss]",
- "type", "window", "send_event",
- "time", "x", "y", "axes", "state",
- "is_hint", "device", "x_root", "y_root");
- if (!strcmp(attr, "time"))
- return PyInt_FromLong(event->motion.time);
- if (!strcmp(attr, "x"))
- return PyFloat_FromDouble(event->motion.x);
- if (!strcmp(attr, "y"))
- return PyFloat_FromDouble(event->motion.y);
- if (!strcmp(attr, "axes")) {
- if (event->motion.axes) {
- PyObject *v = PyTuple_New(event->motion.device->num_axes);
- if (!v) return NULL;
- for (i = 0; i < event->motion.device->num_axes; i++)
- PyTuple_SetItem(v, i,PyFloat_FromDouble(
- event->motion.axes[i]));
- return v;
- } else {
- Py_INCREF(Py_None);
- return Py_None;
- }
- }
- if (!strcmp(attr, "state"))
- return pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE,
- event->motion.state);
- if (!strcmp(attr, "is_hint"))
- return PyInt_FromLong(event->motion.is_hint);
- if (!strcmp(attr, "device"))
- return pygobject_new((GObject *)event->motion.device);
- if (!strcmp(attr, "x_root"))
- return PyFloat_FromDouble(event->motion.x_root);
- if (!strcmp(attr, "y_root"))
- return PyFloat_FromDouble(event->motion.y_root);
- break;
- case GDK_BUTTON_PRESS: /*GdkEventButton button*/
- case GDK_2BUTTON_PRESS: /*GdkEventButton button*/
- case GDK_3BUTTON_PRESS: /*GdkEventButton button*/
- case GDK_BUTTON_RELEASE: /*GdkEventButton button*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ssssssssssss]",
- "type", "window", "send_event",
- "time", "x", "y", "axes", "state",
- "button", "device", "x_root", "y_root");
- if (!strcmp(attr, "time"))
- return PyInt_FromLong(event->button.time);
- if (!strcmp(attr, "x"))
- return PyFloat_FromDouble(event->button.x);
- if (!strcmp(attr, "y"))
- return PyFloat_FromDouble(event->button.y);
- if (!strcmp(attr, "axes")) {
- if (event->button.axes) {
- PyObject *v = PyTuple_New(event->button.device->num_axes);
- if (!v) return NULL;
- for (i = 0; i < event->button.device->num_axes; i++)
- PyTuple_SetItem(v, i,PyFloat_FromDouble(
- event->button.axes[i]));
- return v;
- } else {
- Py_INCREF(Py_None);
- return Py_None;
- }
- }
- if (!strcmp(attr, "state"))
- return pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE,
- event->button.state);
- if (!strcmp(attr, "button"))
- return PyInt_FromLong(event->button.button);
- if (!strcmp(attr, "device"))
- return pygobject_new((GObject *)event->button.device);
- if (!strcmp(attr, "x_root"))
- return PyFloat_FromDouble(event->button.x_root);
- if (!strcmp(attr, "y_root"))
- return PyFloat_FromDouble(event->button.y_root);
- break;
- case GDK_KEY_PRESS: /*GdkEventKey key*/
- case GDK_KEY_RELEASE: /*GdkEventKey key*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[sssssssss]",
- "type", "window", "send_event",
- "time", "state", "keyval", "string",
- "hardware_keycode", "group");
- if (!strcmp(attr, "time"))
- return PyInt_FromLong(event->key.time);
- if (!strcmp(attr, "state"))
- return pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE,
- event->key.state);
- if (!strcmp(attr, "keyval"))
- return PyInt_FromLong(event->key.keyval);
- if (!strcmp(attr, "string"))
- return PyString_FromStringAndSize(event->key.string,
- event->key.length);
- if (!strcmp(attr, "hardware_keycode"))
- return PyInt_FromLong(event->key.hardware_keycode);
- if (!strcmp(attr, "group"))
- return PyInt_FromLong(event->key.group);
- break;
- case GDK_ENTER_NOTIFY: /*GdkEventCrossing crossing*/
- case GDK_LEAVE_NOTIFY: /*GdkEventCrossing crossing*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[sssssssssssss]",
- "type", "window", "send_event",
- "subwindow", "time", "x", "y",
- "x_root", "y_root", "mode", "detail",
- "focus", "state");
- if (!strcmp(attr, "subwindow"))
- return pygobject_new((GObject *)event->crossing.subwindow);
- if (!strcmp(attr, "time"))
- return PyInt_FromLong(event->crossing.time);
- if (!strcmp(attr, "x"))
- return PyFloat_FromDouble(event->crossing.x);
- if (!strcmp(attr, "y"))
- return PyFloat_FromDouble(event->crossing.y);
- if (!strcmp(attr, "x_root"))
- return PyFloat_FromDouble(event->crossing.x_root);
- if (!strcmp(attr, "y_root"))
- return PyFloat_FromDouble(event->crossing.y_root);
- if (!strcmp(attr, "mode"))
- return pyg_enum_from_gtype(GDK_TYPE_CROSSING_MODE,
- event->crossing.mode);
- if (!strcmp(attr, "detail"))
- return pyg_enum_from_gtype(GDK_TYPE_NOTIFY_TYPE,
- event->crossing.detail);
- if (!strcmp(attr, "focus"))
- return PyInt_FromLong(event->crossing.focus);
- if (!strcmp(attr, "state"))
- return pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE,
- event->crossing.state);
- break;
- case GDK_FOCUS_CHANGE: /*GdkEventFocus focus_change*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ssss]",
- "type", "window", "send_event",
- "in_");
- if (!strcmp(attr, "in_"))
- return PyInt_FromLong(event->focus_change.in);
- break;
- case GDK_CONFIGURE: /*GdkEventConfigure configure*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[sssssss]",
- "type", "window", "send_event",
- "x", "y", "width", "height");
- if (!strcmp(attr, "x"))
- return PyInt_FromLong(event->configure.x);
- if (!strcmp(attr, "y"))
- return PyInt_FromLong(event->configure.y);
- if (!strcmp(attr, "width"))
- return PyInt_FromLong(event->configure.width);
- if (!strcmp(attr, "height"))
- return PyInt_FromLong(event->configure.height);
- break;
- case GDK_MAP: break;
- case GDK_UNMAP: break;
- case GDK_PROPERTY_NOTIFY: /*GdkEventProperty property*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ssssss]",
- "type", "window", "send_event",
- "atom", "time", "state");
- if (!strcmp(attr, "atom")) {
- name = gdk_atom_name(event->property.atom);
- ret = PyString_FromString(name);
- g_free(name);
- return ret;
- }
- if (!strcmp(attr, "time"))
- return PyInt_FromLong(event->property.time);
- if (!strcmp(attr, "state"))
- return pyg_enum_from_gtype(GDK_TYPE_PROPERTY_STATE, event->property.state);
- break;
- case GDK_SELECTION_CLEAR: /*GdkEventSelection selection*/
- case GDK_SELECTION_REQUEST: /*GdkEventSelection selection*/
- case GDK_SELECTION_NOTIFY: /*GdkEventSelection selection*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ssssssss]",
- "type", "window", "send_event",
- "selection", "target", "property",
- "requestor", "time");
- if (!strcmp(attr, "selection")) {
- name = gdk_atom_name(event->selection.selection);
- ret = PyString_FromString(name);
- g_free(name);
- return ret;
- }
- if (!strcmp(attr, "target")) {
- name = gdk_atom_name(event->selection.target);
- ret = PyString_FromString(name);
- g_free(name);
- return ret;
- }
- if (!strcmp(attr, "property")) {
- name = gdk_atom_name(event->selection.property);
- ret = PyString_FromString(name);
- g_free(name);
- return ret;
- }
- if (!strcmp(attr, "requestor"))
- return PyInt_FromLong(event->selection.requestor);
- if (!strcmp(attr, "time"))
- return PyInt_FromLong(event->selection.time);
- break;
- case GDK_PROXIMITY_IN: /*GdkEventProximity proximity*/
- case GDK_PROXIMITY_OUT: /*GdkEventProximity proximity*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[sssss]",
- "type", "window", "send_event",
- "time", "device");
- if (!strcmp(attr, "time"))
- return PyInt_FromLong(event->proximity.time);
- if (!strcmp(attr, "device"))
- return pygobject_new((GObject *)event->proximity.device);
- break;
- case GDK_DRAG_ENTER: /*GdkEventDND dnd*/
- case GDK_DRAG_LEAVE: /*GdkEventDND dnd*/
- case GDK_DRAG_MOTION: /*GdkEventDND dnd*/
- case GDK_DRAG_STATUS: /*GdkEventDND dnd*/
- case GDK_DROP_START: /*GdkEventDND dnd*/
- case GDK_DROP_FINISHED: /*GdkEventDND dnd*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[sssssss]",
- "type", "window", "send_event",
- "context", "time", "x_root", "y_root");
- if (!strcmp(attr, "context"))
- return pygobject_new((GObject *)event->dnd.context);
- if (!strcmp(attr, "time"))
- return PyInt_FromLong(event->dnd.time);
- if (!strcmp(attr, "x_root"))
- return PyFloat_FromDouble(event->dnd.x_root);
- if (!strcmp(attr, "y_root"))
- return PyFloat_FromDouble(event->dnd.y_root);
- break;
- case GDK_CLIENT_EVENT: /*GdkEventClient client*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ssssss]",
- "type", "window", "send_event",
- "message_type", "data_format", "data");
- if (!strcmp(attr, "message_type")) {
- name = gdk_atom_name(event->client.message_type);
- ret = PyString_FromString(name);
- g_free(name);
- return ret;
- }
- if (!strcmp(attr, "data_format"))
- return PyInt_FromLong(event->client.data_format);
- if (!strcmp(attr, "data"))
- return PyString_FromStringAndSize(event->client.data.b, 20);
- break;
- case GDK_VISIBILITY_NOTIFY: /*GdkEventVisibility visibility*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ssss]",
- "type", "window", "send_event",
- "state");
- if (!strcmp(attr, "state"))
- return pyg_enum_from_gtype(GDK_TYPE_VISIBILITY_STATE, event->visibility.state);
- break;
- case GDK_NO_EXPOSE: /*GdkEventNoExpose no_expose*/
- break;
- case GDK_SCROLL: /*GdkEventScroll scroll*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[sssssssssss]",
- "type", "window", "send_event",
- "time", "x", "y", "state", "direction",
- "device", "x_root", "y_root");
- if (!strcmp(attr, "time"))
- return PyInt_FromLong(event->scroll.time);
- if (!strcmp(attr, "x"))
- return PyFloat_FromDouble(event->scroll.x);
- if (!strcmp(attr, "y"))
- return PyFloat_FromDouble(event->scroll.y);
- if (!strcmp(attr, "state"))
- return pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE,
- event->scroll.state);
- if (!strcmp(attr, "direction"))
- return pyg_enum_from_gtype(GDK_TYPE_SCROLL_DIRECTION, event->scroll.direction);
- if (!strcmp(attr, "device"))
- return pygobject_new((GObject *)event->scroll.device);
- if (!strcmp(attr, "x_root"))
- return PyFloat_FromDouble(event->scroll.x_root);
- if (!strcmp(attr, "y_root"))
- return PyFloat_FromDouble(event->scroll.y_root);
- break;
- case GDK_WINDOW_STATE: /*GdkEventWindowState window_state*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[sssss]",
- "type", "window", "send_event",
- "changed_mask", "new_window_state");
- if (!strcmp(attr, "changed_mask"))
- return pyg_flags_from_gtype(GDK_TYPE_WINDOW_STATE,
- event->window_state.changed_mask);
- if (!strcmp(attr, "new_window_state"))
- return pyg_flags_from_gtype(GDK_TYPE_WINDOW_STATE,
- event->window_state.new_window_state);
- break;
- case GDK_SETTING: /*GdkEventSetting setting*/
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[sssss]",
- "type", "window", "send_event",
- "action", "name");
- if (!strcmp(attr, "action"))
- return pyg_enum_from_gtype(GDK_TYPE_SETTING_ACTION, event->setting.action);
- if (!strcmp(attr, "name"))
- return PyString_FromString(event->setting.name);
- break;
- /* New in 2.8 */
- case GDK_OWNER_CHANGE:
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ssssssss]",
- "type", "window", "send_event", "owner",
- "reason", "selection", "time",
- "selection_time");
- if (!strcmp(attr, "owner"))
- return PyInt_FromLong(event->owner_change.owner);
- if (!strcmp(attr, "reason"))
- return pyg_enum_from_gtype(GDK_TYPE_OWNER_CHANGE,
- event->owner_change.reason);
- if (!strcmp(attr, "selection")) {
- name = gdk_atom_name(event->owner_change.selection);
- ret = PyString_FromString(name);
- g_free(name);
- return ret;
- }
- if (!strcmp(attr, "time"))
- return PyInt_FromLong(event->owner_change.time);
- if (!strcmp(attr, "selection_time"))
- return PyInt_FromLong(event->owner_change.selection_time);
- break;
- case GDK_GRAB_BROKEN:
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ssssss]",
- "type", "window", "send_event",
- "keyboard", "implicit",
- "grab_window");
- if (!strcmp(attr, "keyboard"))
- return PyBool_FromLong(event->grab_broken.keyboard);
- if (!strcmp(attr, "implicit"))
- return PyBool_FromLong(event->grab_broken.implicit);
- if (!strcmp(attr, "grab_window"))
- return pygobject_new((GObject *)event->grab_broken.grab_window);
- break;
-
- default:
- break;
- }
-
- if (!strcmp(attr, "type"))
- return pyg_enum_from_gtype(GDK_TYPE_EVENT_TYPE, event->type);
- if (!strcmp(attr, "window"))
- return pygobject_new((GObject *)event->any.window);
- if (!strcmp(attr, "send_event"))
- return PyInt_FromLong(event->any.send_event);
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[sss]", "type", "window", "send_event");
-
- return Py_FindMethod((PyMethodDef*)_PyGdkEvent_methods, self, attr);
-}
-%%
-override gdk_event_get_axis args
-static PyObject *
-_wrap_gdk_event_get_axis(PyGObject *self, PyObject *args)
-{
- GdkEvent *event = pyg_boxed_get(self, GdkEvent);
- gint axis_use;
- gdouble value;
-
- if (!PyArg_ParseTuple(args, "i:gdk.event_get_axis",
- &axis_use))
- return NULL;
-
- if (gdk_event_get_axis(event, axis_use, &value)) {
- return PyFloat_FromDouble(value);
- } else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override gdk_event_get_coords noargs
-static PyObject *
-_wrap_gdk_event_get_coords(PyGObject *self)
-{
- GdkEvent *event = pyg_boxed_get(self, GdkEvent);
- gdouble x, y;
-
- if (gdk_event_get_coords(event, &x, &y))
- return Py_BuildValue("(dd)", x, y);
- else
- return Py_BuildValue("()");
-}
-%%
-override gdk_event_get_root_coords noargs
-static PyObject *
-_wrap_gdk_event_get_root_coords(PyGObject *self)
-{
- GdkEvent *event = pyg_boxed_get(self, GdkEvent);
- gdouble x, y;
-
- if (gdk_event_get_root_coords(event, &x, &y))
- return Py_BuildValue("(dd)", x, y);
- else
- return Py_BuildValue("()");
-}
-%%
-override gdk_event_get_state noargs
-static PyObject *
-_wrap_gdk_event_get_state(PyGObject *self)
-{
- GdkEvent *event = pyg_boxed_get(self, GdkEvent);
- GdkModifierType state = 0;
-
- gdk_event_get_state(event, &state);
- return pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE, state);
-}
-%%
-override gdk_event_free noargs
-static PyObject *
-_wrap_gdk_event_free(PyObject *self)
-{
- if (PyErr_Warn(PyExc_DeprecationWarning, "gtk.gdk.Event.free should not be used") < 0)
- return NULL;
- Py_INCREF(Py_None);
- return Py_None;
-}
diff --git a/gtk/gdkgc.override b/gtk/gdkgc.override
deleted file mode 100644
index dd23f431..00000000
--- a/gtk/gdkgc.override
+++ /dev/null
@@ -1,625 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gdkgc.override: gtk.gdk.GC override
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-override gdk_gc_new kwargs
-static int
-_wrap_gdk_gc_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "drawable", "foreground", "background", "font",
- "function", "fill", "tile", "stipple",
- "clip_mask", "subwindow_mode", "ts_x_origin",
- "ts_y_origin", "clip_x_origin", "clip_y_origin",
- "graphics_exposures", "line_width", "line_style",
- "cap_style", "join_style", NULL };
- PyGObject *drawable;
- PyObject *foreground = Py_None, *background = Py_None;
- PyObject *font = Py_None;
- PyObject *tile = Py_None, *stipple = Py_None, *clip_mask = Py_None;
- gint function = -1, fill = -1;
- gint subwindow_mode = -1, ts_x_origin = -1, ts_y_origin = -1;
- gint clip_x_origin = -1, clip_y_origin = -1, graphics_exposures = -1;
- gint line_width = -1, line_style = -1, cap_style = -1, join_style = -1;
- GdkGCValues values;
- GdkGCValuesMask mask = 0;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!|OOOiiOOOiiiiiiiiii:GdkGC.__init__",
- kwlist, &PyGdkDrawable_Type, &drawable,
- &foreground, &background, &font,
- &function, &fill, &tile, &stipple,
- &clip_mask, &subwindow_mode,
- &ts_x_origin, &ts_y_origin,
- &clip_x_origin, &clip_y_origin,
- &graphics_exposures, &line_width,
- &line_style, &cap_style, &join_style))
- return -1;
- if (pyg_boxed_check(foreground, GDK_TYPE_COLOR)) {
- mask |= GDK_GC_FOREGROUND;
- values.foreground = *pyg_boxed_get(foreground, GdkColor);
- } else if (foreground != Py_None) {
- PyErr_SetString(PyExc_TypeError, "foreground must be a GdkColor");
- return -1;
- }
- if (pyg_boxed_check(background, GDK_TYPE_COLOR)) {
- mask |= GDK_GC_BACKGROUND;
- values.background = *pyg_boxed_get(background, GdkColor);
- } else if (background != Py_None) {
- PyErr_SetString(PyExc_TypeError, "background must be a GdkColor");
- return -1;
- }
- if (pyg_boxed_check(font, GDK_TYPE_FONT)) {
- mask |= GDK_GC_FONT;
- values.font = pyg_boxed_get(font, GdkFont);
- } else if (font != Py_None) {
- PyErr_SetString(PyExc_TypeError, "font must be a GdkFont");
- return -1;
- }
- if (function != -1) {
- mask |= GDK_GC_FUNCTION;
- values.function = function;
- }
- if (fill != -1) {
- mask |= GDK_GC_FILL;
- values.fill = fill;
- }
- if (pygobject_check(tile, &PyGdkPixmap_Type)) {
- mask |= GDK_GC_TILE;
- values.tile = GDK_PIXMAP(pygobject_get(tile));
- } else if (tile != Py_None) {
- PyErr_SetString(PyExc_TypeError, "tile must be a GdkPixmap");
- return -1;
- }
- if (pygobject_check(stipple, &PyGdkPixmap_Type)) {
- mask |= GDK_GC_STIPPLE;
- values.stipple = GDK_PIXMAP(pygobject_get(stipple));
- } else if (stipple != Py_None) {
- PyErr_SetString(PyExc_TypeError, "stipple must be a GdkPixmap");
- return -1;
- }
- if (pygobject_check(clip_mask, &PyGdkPixmap_Type)) {
- mask |= GDK_GC_CLIP_MASK;
- values.clip_mask = GDK_PIXMAP(pygobject_get(clip_mask));
- } else if (clip_mask != Py_None) {
- PyErr_SetString(PyExc_TypeError, "clip_mask must be a GdkPixmap");
- return -1;
- }
- if (subwindow_mode != -1) {
- mask |= GDK_GC_SUBWINDOW;
- values.subwindow_mode = subwindow_mode;
- }
- if (ts_x_origin != -1) {
- mask |= GDK_GC_TS_X_ORIGIN;
- values.ts_x_origin = ts_x_origin;
- }
- if (ts_y_origin != -1) {
- mask |= GDK_GC_TS_Y_ORIGIN;
- values.ts_y_origin = ts_y_origin;
- }
- if (clip_x_origin != -1) {
- mask |= GDK_GC_CLIP_X_ORIGIN;
- values.clip_x_origin = clip_x_origin;
- }
- if (clip_y_origin != -1) {
- mask |= GDK_GC_CLIP_Y_ORIGIN;
- values.clip_y_origin = clip_y_origin;
- }
- if (graphics_exposures != -1) {
- mask |= GDK_GC_EXPOSURES;
- values.graphics_exposures = graphics_exposures;
- }
- if (line_width != -1) {
- mask |= GDK_GC_LINE_WIDTH;
- values.line_width = line_width;
- }
- if (line_style != -1) {
- mask |= GDK_GC_LINE_STYLE;
- values.line_style = line_style;
- }
- if (cap_style != -1) {
- mask |= GDK_GC_CAP_STYLE;
- values.cap_style = cap_style;
- }
- if (join_style != -1) {
- mask |= GDK_GC_JOIN_STYLE;
- values.join_style = join_style;
- }
- self->obj = (GObject *)gdk_gc_new_with_values(GDK_DRAWABLE(drawable->obj),
- &values, mask);
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError, "could not create GdkGC object");
- return -1;
- }
- pygobject_register_wrapper((PyObject *)self);
- return 0;
-}
-%%
-override gdk_gc_new_with_values kwargs
-static PyObject *
-_wrap_gdk_gc_new_with_values(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "foreground", "background", "font", "function",
- "fill", "tile", "stipple", "clip_mask",
- "subwindow_mode", "ts_x_origin", "ts_y_origin",
- "clip_x_origin", "clip_y_origin",
- "graphics_exposures", "line_width", "line_style",
- "cap_style", "join_style", NULL };
- PyObject *foreground = Py_None, *background = Py_None;
- PyObject *font = Py_None;
- gint function = -1, fill = -1;
- PyObject *tile = Py_None, *stipple = Py_None, *clip_mask = Py_None;
- gint subwindow_mode = -1, ts_x_origin = -1, ts_y_origin = -1;
- gint clip_x_origin = -1, clip_y_origin = -1, graphics_exposures = -1;
- gint line_width = -1, line_style = -1, cap_style = -1, join_style = -1;
- GdkGCValues values;
- GdkGCValuesMask mask = 0;
- GdkGC *gc;
- PyObject *pygc;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|OOOiiOOOiiiiiiiiii:GdkDrawable.new_gc",
- kwlist, &foreground, &background, &font,
- &function, &fill, &tile, &stipple,
- &clip_mask, &subwindow_mode,
- &ts_x_origin, &ts_y_origin,
- &clip_x_origin, &clip_y_origin,
- &graphics_exposures, &line_width,
- &line_style, &cap_style, &join_style))
- return NULL;
- if (pyg_boxed_check(foreground, GDK_TYPE_COLOR)) {
- mask |= GDK_GC_FOREGROUND;
- values.foreground = *pyg_boxed_get(foreground, GdkColor);
- } else if (foreground != Py_None) {
- PyErr_SetString(PyExc_TypeError, "foreground must be a GdkColor");
- return NULL;
- }
- if (pyg_boxed_check(background, GDK_TYPE_COLOR)) {
- mask |= GDK_GC_BACKGROUND;
- values.background = *pyg_boxed_get(background, GdkColor);
- } else if (background != Py_None) {
- PyErr_SetString(PyExc_TypeError, "background must be a GdkColor");
- return NULL;
- }
- if (pyg_boxed_check(font, GDK_TYPE_FONT)) {
- mask |= GDK_GC_FONT;
- values.font = pyg_boxed_get(font, GdkFont);
- } else if (font != Py_None) {
- PyErr_SetString(PyExc_TypeError, "font must be a GdkFont");
- return NULL;
- }
- if (function != -1) {
- mask |= GDK_GC_FUNCTION;
- values.function = function;
- }
- if (fill != -1) {
- mask |= GDK_GC_FILL;
- values.fill = fill;
- }
- if (pygobject_check(tile, &PyGdkPixmap_Type)) {
- mask |= GDK_GC_TILE;
- values.tile = GDK_PIXMAP(pygobject_get(tile));
- } else if (tile != Py_None) {
- PyErr_SetString(PyExc_TypeError, "tile must be a GdkPixmap");
- return NULL;
- }
- if (pygobject_check(stipple, &PyGdkPixmap_Type)) {
- mask |= GDK_GC_STIPPLE;
- values.stipple = GDK_PIXMAP(pygobject_get(stipple));
- } else if (stipple != Py_None) {
- PyErr_SetString(PyExc_TypeError, "stipple must be a GdkPixmap");
- return NULL;
- }
- if (pygobject_check(clip_mask, &PyGdkPixmap_Type)) {
- mask |= GDK_GC_CLIP_MASK;
- values.clip_mask = GDK_PIXMAP(pygobject_get(clip_mask));
- } else if (clip_mask != Py_None) {
- PyErr_SetString(PyExc_TypeError, "clip_mask must be a GdkPixmap");
- return NULL;
- }
- if (subwindow_mode != -1) {
- mask |= GDK_GC_SUBWINDOW;
- values.subwindow_mode = subwindow_mode;
- }
- if (ts_x_origin != -1) {
- mask |= GDK_GC_TS_X_ORIGIN;
- values.ts_x_origin = ts_x_origin;
- }
- if (ts_y_origin != -1) {
- mask |= GDK_GC_TS_Y_ORIGIN;
- values.ts_y_origin = ts_y_origin;
- }
- if (clip_x_origin != -1) {
- mask |= GDK_GC_CLIP_X_ORIGIN;
- values.clip_x_origin = clip_x_origin;
- }
- if (clip_y_origin != -1) {
- mask |= GDK_GC_CLIP_Y_ORIGIN;
- values.clip_y_origin = clip_y_origin;
- }
- if (graphics_exposures != -1) {
- mask |= GDK_GC_EXPOSURES;
- values.graphics_exposures = graphics_exposures;
- }
- if (line_width != -1) {
- mask |= GDK_GC_LINE_WIDTH;
- values.line_width = line_width;
- }
- if (line_style != -1) {
- mask |= GDK_GC_LINE_STYLE;
- values.line_style = line_style;
- }
- if (cap_style != -1) {
- mask |= GDK_GC_CAP_STYLE;
- values.cap_style = cap_style;
- }
- if (join_style != -1) {
- mask |= GDK_GC_JOIN_STYLE;
- values.join_style = join_style;
- }
- gc = gdk_gc_new_with_values(GDK_DRAWABLE(self->obj), &values, mask);
- pygc = pygobject_new((GObject *)gc);
- gdk_gc_unref(gc);
- return pygc;
-}
-%%
-override gdk_gc_new2 kwargs
-static PyObject *
-_wrap_gdk_gc_new2(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "drawable", NULL };
- PyGObject *drawable;
- GdkGC *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!:gc_new", kwlist, &PyGdkDrawable_Type, &drawable))
- return NULL;
- if (PyErr_Warn(PyExc_DeprecationWarning, "use gdk.GC or drawable.new_gc") < 0)
- return NULL;
- ret = gdk_gc_new(GDK_DRAWABLE(drawable->obj));
- /* pygobject_new handles NULL checking */
- return pygobject_new((GObject *)ret);
-}
-%%
-override gdk_gc_set_values kwargs
-static PyObject *
-_wrap_gdk_gc_set_values(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "foreground", "background", "font", "function",
- "fill", "tile", "stipple", "clip_mask",
- "subwindow_mode", "ts_x_origin", "ts_y_origin",
- "clip_x_origin", "clip_y_origin",
- "graphics_exposures", "line_width", "line_style",
- "cap_style", "join_style", NULL };
- PyObject *foreground = Py_None, *background = Py_None;
- PyObject *font = Py_None;
- gint function = -1, fill = -1;
- PyObject *tile = Py_None, *stipple = Py_None, *clip_mask = Py_None;
- gint subwindow_mode = -1, ts_x_origin = -1, ts_y_origin = -1;
- gint clip_x_origin = -1, clip_y_origin = -1, graphics_exposures = -1;
- gint line_width = -1, line_style = -1, cap_style = -1, join_style = -1;
- GdkGCValues values;
- GdkGCValuesMask mask = 0;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|OOOiiOOOiiiiiiiiii:GdkGC.set_values",
- kwlist, &foreground, &background, &font,
- &function, &fill, &tile, &stipple,
- &clip_mask, &subwindow_mode,
- &ts_x_origin, &ts_y_origin,
- &clip_x_origin, &clip_y_origin,
- &graphics_exposures, &line_width,
- &line_style, &cap_style, &join_style))
- return NULL;
- if (pyg_boxed_check(foreground, GDK_TYPE_COLOR)) {
- mask |= GDK_GC_FOREGROUND;
- values.foreground = *pyg_boxed_get(foreground, GdkColor);
- } else if (foreground != Py_None) {
- PyErr_SetString(PyExc_TypeError, "foreground must be a GdkColor");
- return NULL;
- }
- if (pyg_boxed_check(background, GDK_TYPE_COLOR)) {
- mask |= GDK_GC_BACKGROUND;
- values.background = *pyg_boxed_get(background, GdkColor);
- } else if (background != Py_None) {
- PyErr_SetString(PyExc_TypeError, "background must be a GdkColor");
- return NULL;
- }
- if (pyg_boxed_check(font, GDK_TYPE_FONT)) {
- mask |= GDK_GC_FONT;
- values.font = pyg_boxed_get(font, GdkFont);
- } else if (font != Py_None) {
- PyErr_SetString(PyExc_TypeError, "font must be a GdkFont");
- return NULL;
- }
- if (function != -1) {
- mask |= GDK_GC_FUNCTION;
- values.function = function;
- }
- if (fill != -1) {
- mask |= GDK_GC_FILL;
- values.fill = fill;
- }
- if (pygobject_check(tile, &PyGdkPixmap_Type)) {
- mask |= GDK_GC_TILE;
- values.tile = GDK_PIXMAP(pygobject_get(tile));
- } else if (tile != Py_None) {
- PyErr_SetString(PyExc_TypeError, "tile must be a GdkPixmap");
- return NULL;
- }
- if (pygobject_check(stipple, &PyGdkPixmap_Type)) {
- mask |= GDK_GC_STIPPLE;
- values.stipple = GDK_PIXMAP(pygobject_get(stipple));
- } else if (stipple != Py_None) {
- PyErr_SetString(PyExc_TypeError, "stipple must be a GdkPixmap");
- return NULL;
- }
- if (pygobject_check(clip_mask, &PyGdkPixmap_Type)) {
- mask |= GDK_GC_CLIP_MASK;
- values.clip_mask = GDK_PIXMAP(pygobject_get(clip_mask));
- } else if (clip_mask != Py_None) {
- PyErr_SetString(PyExc_TypeError, "clip_mask must be a GdkPixmap");
- return NULL;
- }
- if (subwindow_mode != -1) {
- mask |= GDK_GC_SUBWINDOW;
- values.subwindow_mode = subwindow_mode;
- }
- if (ts_x_origin != -1) {
- mask |= GDK_GC_TS_X_ORIGIN;
- values.ts_x_origin = ts_x_origin;
- }
- if (ts_y_origin != -1) {
- mask |= GDK_GC_TS_Y_ORIGIN;
- values.ts_y_origin = ts_y_origin;
- }
- if (clip_x_origin != -1) {
- mask |= GDK_GC_CLIP_X_ORIGIN;
- values.clip_x_origin = clip_x_origin;
- }
- if (clip_y_origin != -1) {
- mask |= GDK_GC_CLIP_Y_ORIGIN;
- values.clip_y_origin = clip_y_origin;
- }
- if (graphics_exposures != -1) {
- mask |= GDK_GC_EXPOSURES;
- values.graphics_exposures = graphics_exposures;
- }
- if (line_width != -1) {
- mask |= GDK_GC_LINE_WIDTH;
- values.line_width = line_width;
- }
- if (line_style != -1) {
- mask |= GDK_GC_LINE_STYLE;
- values.line_style = line_style;
- }
- if (cap_style != -1) {
- mask |= GDK_GC_CAP_STYLE;
- values.cap_style = cap_style;
- }
- if (join_style != -1) {
- mask |= GDK_GC_JOIN_STYLE;
- values.join_style = join_style;
- }
- gdk_gc_set_values(GDK_GC(self->obj), &values, mask);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override-slot GdkGC.tp_getattro
-static PyObject *
-_wrap_gdk_gc_tp_getattro(PyGObject *self, PyObject *py_attr)
-{
- GdkGCValues gc;
- char *attr;
-
- if (PyString_Check(py_attr))
- attr = PyString_AsString(py_attr);
- else
- return PyObject_GenericGetAttr((PyObject *)self, py_attr);
-
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ssssssssssssssssss]", "background", "cap_style",
- "clip_mask", "clip_x_origin", "clip_y_origin",
- "fill", "font", "foreground", "function",
- "graphics_exposures", "join_style", "line_style",
- "line_width", "stipple", "sub_window", "tile",
- "ts_x_origin", "ts_y_origin");
- gdk_gc_get_values(GDK_GC(self->obj), &gc);
- if (!strcmp(attr, "foreground"))
- return pyg_boxed_new(GDK_TYPE_COLOR, &(gc.foreground), TRUE, TRUE);
- if (!strcmp(attr, "background"))
- return pyg_boxed_new(GDK_TYPE_COLOR, &(gc.background), TRUE, TRUE);
- if (!strcmp(attr, "font"))
- return pyg_boxed_new(GDK_TYPE_FONT, gc.font, TRUE, TRUE);
- if (!strcmp(attr, "function"))
- return PyInt_FromLong(gc.function);
- if (!strcmp(attr, "fill"))
- return PyInt_FromLong(gc.fill);
- if (!strcmp(attr, "tile"))
- return pygobject_new((GObject *)gc.tile);
- if (!strcmp(attr, "stipple"))
- return pygobject_new((GObject *)gc.stipple);
- if (!strcmp(attr, "clip_mask"))
- return pygobject_new((GObject *)gc.clip_mask);
- if (!strcmp(attr, "subwindow_mode"))
- return pyg_enum_from_gtype(GDK_TYPE_SUBWINDOW_MODE, gc.subwindow_mode);
- if (!strcmp(attr, "ts_x_origin"))
- return PyInt_FromLong(gc.ts_x_origin);
- if (!strcmp(attr, "ts_y_origin"))
- return PyInt_FromLong(gc.ts_y_origin);
- if (!strcmp(attr, "clip_x_origin"))
- return PyInt_FromLong(gc.clip_x_origin);
- if (!strcmp(attr, "clip_y_origin"))
- return PyInt_FromLong(gc.clip_y_origin);
- if (!strcmp(attr, "graphics_exposures"))
- return PyInt_FromLong(gc.graphics_exposures);
- if (!strcmp(attr, "line_width"))
- return PyInt_FromLong(gc.line_width);
- if (!strcmp(attr, "line_style"))
- return pyg_enum_from_gtype(GDK_TYPE_LINE_STYLE, gc.line_style);
- if (!strcmp(attr, "cap_style"))
- return pyg_enum_from_gtype(GDK_TYPE_CAP_STYLE, gc.cap_style);
- if (!strcmp(attr, "join_style"))
- return pyg_enum_from_gtype(GDK_TYPE_JOIN_STYLE, gc.join_style);
-
- {
- PyObject *name = PyString_FromString(attr);
- PyObject *ret = PyObject_GenericGetAttr((PyObject *)self, name);
- Py_DECREF(name);
- return ret;
- }
-}
-%%
-override-slot GdkGC.tp_setattro
-static int
-_wrap_gdk_gc_tp_setattro(PyGObject *self, PyObject *py_attr, PyObject *value)
-{
- GdkGC *gc = GDK_GC(self->obj);
- char *attr;
-
- if (value == NULL) {
- PyErr_SetString(PyExc_TypeError, "can't delete attributes");
- return -1;
- }
-
- if (PyString_Check(py_attr))
- attr = PyString_AsString(py_attr);
- else {
- PyErr_SetString(PyExc_AttributeError, "could not write attribute");
- return -1;
- }
-
- if (PyInt_Check(value)) {
- int i = PyInt_AsLong(value);
- GdkGCValues v;
- gdk_gc_get_values(gc, &v);
- if (!strcmp(attr, "function")) {
- gdk_gc_set_function(gc, i);
- return 0;
- } else if (!strcmp(attr, "fill")) {
- gdk_gc_set_fill(gc, i);
- return 0;
- } else if (!strcmp(attr, "subwindow_mode")) {
- gdk_gc_set_subwindow(gc, i);
- return 0;
- } else if (!strcmp(attr, "ts_x_origin")) {
- gdk_gc_set_ts_origin(gc, i, v.ts_y_origin);
- return 0;
- } else if (!strcmp(attr, "ts_y_origin")) {
- gdk_gc_set_ts_origin(gc, v.ts_x_origin, i);
- return 0;
- } else if (!strcmp(attr, "clip_x_origin")) {
- gdk_gc_set_clip_origin(gc, i, v.clip_y_origin);
- return 0;
- } else if (!strcmp(attr, "clip_y_origin")) {
- gdk_gc_set_clip_origin(gc, v.clip_x_origin, i);
- return 0;
- } else if (!strcmp(attr, "graphics_exposures")) {
- gdk_gc_set_exposures(gc, i);
- return 0;
- } else if (!strcmp(attr, "line_width")) {
- gdk_gc_set_line_attributes(gc, i, v.line_style,
- v.cap_style, v.join_style);
- return 0;
- } else if (!strcmp(attr, "line_style")) {
- gdk_gc_set_line_attributes(gc, v.line_width, i,
- v.cap_style, v.join_style);
- return 0;
- } else if (!strcmp(attr, "cap_style")) {
- gdk_gc_set_line_attributes(gc, v.line_width, v.line_style,
- i, v.join_style);
- return 0;
- } else if (!strcmp(attr, "join_style")) {
- gdk_gc_set_line_attributes(gc, v.line_width, v.line_style,
- v.cap_style, i);
- return 0;
- }
- } else if (pyg_boxed_check(value, GDK_TYPE_COLOR)) {
- GdkColor *c = pyg_boxed_get(value, GdkColor);
- if (!strcmp(attr, "foreground")) {
- gdk_gc_set_foreground(gc, c);
- return 0;
- } else if (!strcmp(attr, "background")) {
- gdk_gc_set_background(gc, c);
- return 0;
- }
- } else if (pyg_boxed_check(value, GDK_TYPE_FONT)) {
- if (!strcmp(attr, "font")) {
- gdk_gc_set_font(gc, pyg_boxed_get(value, GdkFont));
- return 0;
- }
- } else if (pygobject_check(value, &PyGdkWindow_Type) || value == Py_None) {
- PyGObject *window = (PyGObject *)value;
- GdkWindow *w = (value==Py_None)?NULL:GDK_WINDOW(window->obj);
- if (!strcmp(attr, "tile")) {
- gdk_gc_set_tile(gc, w);
- return 0;
- } else if (!strcmp(attr, "stipple")) {
- gdk_gc_set_stipple(gc, w);
- return 0;
- } else if (!strcmp(attr, "clip_mask")) {
- gdk_gc_set_clip_mask(gc, w);
- return 0;
- }
- }
-
- PyErr_SetString(PyExc_AttributeError, "could not write attribute");
- return -1;
-}
-%%
-override gdk_gc_set_dashes
-static PyObject *
-_wrap_gdk_gc_set_dashes(PyGObject *self, PyObject *args)
-{
- gint dash_offset, n, i;
- PyObject *list;
- gint8 *dash_list;
-
- if (!PyArg_ParseTuple(args, "iO:GdkGC.set_dashes", &dash_offset, &list))
- return NULL;
- if (!PySequence_Check(list)) {
- PyErr_SetString(PyExc_TypeError, "second argument must be a sequence");
- return NULL;
- }
- n = PySequence_Length(list);
- dash_list = g_new(gint8, n);
- for (i = 0; i < n; i++) {
- PyObject *item = PySequence_GetItem(list, i);
- Py_DECREF(item);
-
- if (!PyInt_Check(item)) {
- PyErr_SetString(PyExc_TypeError, "sequence member must be an int");
- g_free(dash_list);
- return NULL;
- }
- dash_list[i] = (gint8)PyInt_AsLong(item);
- if (dash_list[i] == 0) {
- PyErr_SetString(PyExc_TypeError, "sequence member must not be 0");
- g_free(dash_list);
- return NULL;
- }
- }
- gdk_gc_set_dashes(GDK_GC(self->obj), dash_offset, dash_list, n);
- g_free(dash_list);
- Py_INCREF(Py_None);
- return Py_None;
-}
diff --git a/gtk/gdkpixbuf.override b/gtk/gdkpixbuf.override
deleted file mode 100644
index 91323a68..00000000
--- a/gtk/gdkpixbuf.override
+++ /dev/null
@@ -1,767 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gdkpixbuf.override: gtk.gdk.Pixbuf and gtk.gdk.PixbufLoader overrides
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-override gdk_pixbuf_render_pixmap_and_mask kwargs
-static PyObject *
-_wrap_gdk_pixbuf_render_pixmap_and_mask(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "alpha_threshold", NULL};
- int alpha_threshold = 127;
- GdkPixmap *pixmap;
- GdkBitmap *mask;
- PyObject *pypixmap, *pymask, *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|i:GdkPixbuf.render_pixmap_and_mask", kwlist,
- &alpha_threshold))
- return NULL;
- gdk_pixbuf_render_pixmap_and_mask(GDK_PIXBUF(self->obj), &pixmap, &mask,
- alpha_threshold);
-
- if (pixmap) {
- pypixmap = pygobject_new((GObject *) pixmap);
- gdk_pixmap_unref(pixmap);
- } else {
- Py_INCREF(Py_None);
- pypixmap = Py_None;
- }
-
- if (mask) {
- pymask = pygobject_new((GObject *) mask);
- gdk_bitmap_unref(mask);
- } else {
- Py_INCREF(Py_None);
- pymask = Py_None;
- }
-
- ret = Py_BuildValue("(NN)", pypixmap, pymask);
- return ret;
-}
-%%
-override-attr GdkPixbuf.pixel_array
-#ifdef HAVE_NUMPY
-static int
-have_numpy(void)
-{
- /* Return 1 if Numeric is available,
- return 0 and set and exception if it is not. */
- static int import_done = 0;
- static PyObject *exc_type=NULL, *exc_value=NULL;
- PyObject *exc_tb=NULL;
-
- if (exc_type != NULL) {
- PyErr_Restore(exc_type, exc_value, NULL);
- return 0;
- }
- if (!import_done) {
- import_done = 1;
- import_array();
- if (PyErr_Occurred()) {
- PyErr_Fetch(&exc_type, &exc_value, &exc_tb);
- Py_INCREF(exc_type);
- Py_XINCREF(exc_value);
- PyErr_Restore(exc_type, exc_value, exc_tb);
- return 0;
- }
- }
- return 1;
-}
-#endif
-static PyObject *
-_wrap_gdk_pixbuf__get_pixel_array(PyGObject *self, void *closure)
-{
- PyErr_Warn(PyExc_DeprecationWarning, "use pixbuf.get_pixels_array() instead of the pixbuf.pixel_array attribute");
- return _wrap_gdk_pixbuf_get_pixels_array(self);
-}
-%%
-define GdkPixbuf.get_pixels_array noargs
-static PyObject *
-_wrap_gdk_pixbuf_get_pixels_array(PyGObject *self)
-{
-
-
-#ifdef HAVE_NUMPY
- GdkPixbuf *pixbuf = GDK_PIXBUF(self->obj);
- PyArrayObject *array;
- int dims[3] = { 0, 0, 3 };
-
- if (!have_numpy())
- return NULL;
-
- dims[0] = gdk_pixbuf_get_height(pixbuf);
- dims[1] = gdk_pixbuf_get_width(pixbuf);
- if (gdk_pixbuf_get_has_alpha(pixbuf))
- dims[2] = 4;
- array = (PyArrayObject *)PyArray_FromDimsAndData(3, dims, PyArray_UBYTE,
- (char *)gdk_pixbuf_get_pixels(pixbuf));
- if (array == NULL)
- return NULL;
-
- array->strides[0] = gdk_pixbuf_get_rowstride(pixbuf);
- /* the array holds a ref to the pixbuf pixels through this wrapper*/
- Py_INCREF(self);
- array->base = (PyObject *)self;
- return PyArray_Return(array);
-#else
- PyErr_SetString(PyExc_RuntimeError, "pygtk was not compiled with Numeric Python support");
- return NULL;
-#endif
-}
-%%
-override gdk_pixbuf_get_pixels noargs
-static PyObject *
-_wrap_gdk_pixbuf_get_pixels(PyGObject *self)
-{
- GdkPixbuf *pixbuf;
- guchar *pixels;
- gint rowstride, height;
-
- pixbuf = GDK_PIXBUF(self->obj);
- pixels = gdk_pixbuf_get_pixels(pixbuf);
- rowstride = gdk_pixbuf_get_rowstride(pixbuf);
- height = gdk_pixbuf_get_height(pixbuf);
-
- if (pixels == NULL) {
- PyErr_SetString(PyExc_ValueError, "could not get pixel data");
- return NULL;
- }
-
- return PyString_FromStringAndSize((char*)pixels, rowstride*height);
-}
-%%
-override gdk_pixbuf_save kwargs
-static PyObject *
-_wrap_gdk_pixbuf_save(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = {"filename", "type", "options", NULL};
- gchar *filename, *type, **option_keys = NULL, **option_values = NULL;
- PyObject *py_options = NULL;
- GError *error = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "ss|O!:GdkPixbuf.save", kwlist,
- &filename, &type,
- &PyDict_Type, &py_options))
- return NULL;
-
- if (py_options != NULL) {
- guint len;
- Py_ssize_t pos = 0, i = 0;
- PyObject *key, *value;
-
- len = PyDict_Size(py_options);
- option_keys = g_new(gchar *, len + 1);
- option_values = g_new(gchar *, len + 1);
-
- while (PyDict_Next(py_options, &pos, &key, &value)) {
- if (!PyString_Check(key) || !PyString_Check(value)) {
- g_free(option_keys);
- g_free(option_values);
- PyErr_SetString(PyExc_TypeError,
- "keys and values must be strings");
- return NULL;
- }
-
- option_keys[i] = PyString_AsString(key);
- option_values[i] = PyString_AsString(value);
- i++;
- }
-
- option_keys[len] = NULL;
- option_values[len] = NULL;
- }
- gdk_pixbuf_savev(GDK_PIXBUF(self->obj), filename, type,
- option_keys, option_values, &error);
-
- g_free(option_keys);
- g_free(option_values);
-
- if (pyg_error_check(&error))
- return NULL;
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-override gdk_pixbuf_save_to_callback kwargs
-
-typedef struct {
- PyObject *callback;
- PyObject *user_data;
-} py_pixbuf_save_callback_data_t;
-
-static gboolean
-pixbuf_save_func(const gchar *buf,
- gsize count,
- GError **error,
- py_pixbuf_save_callback_data_t *data)
-{
- PyObject *ret;
-
- if (data->user_data)
- ret = PyObject_CallFunction(data->callback, "s#O", buf, (Py_ssize_t) count, data->user_data);
-
- else
- ret = PyObject_CallFunction(data->callback, "s#", buf, (Py_ssize_t) count);
-
- if (ret == NULL) {
- PyErr_Print();
- return FALSE;
- }
- Py_DECREF(ret);
- return TRUE;
-}
-
-static PyObject *
-_wrap_gdk_pixbuf_save_to_callback(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = {"save_func", "type", "options", "user_data", NULL};
- gchar *type, **option_keys = NULL, **option_values = NULL;
- PyObject *py_options = NULL;
- GError *error = NULL;
- py_pixbuf_save_callback_data_t data = { NULL, NULL };
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Os|O!O:GdkPixbuf.save", kwlist,
- &data.callback, &type,
- &PyDict_Type, &py_options, &data.user_data))
- return NULL;
-
- if (!PyCallable_Check(data.callback)) {
- PyErr_SetString(PyExc_TypeError, "first argument must be callable");
- return NULL;
- }
-
- if (py_options != NULL) {
- Py_ssize_t len;
- Py_ssize_t pos = 0, i = 0;
- PyObject *key, *value;
-
- len = PyDict_Size(py_options);
- option_keys = g_new(gchar *, len + 1);
- option_values = g_new(gchar *, len + 1);
-
- while (PyDict_Next(py_options, &pos, &key, &value)) {
- if (!PyString_Check(key) || !PyString_Check(value)) {
- g_free(option_keys);
- g_free(option_values);
- PyErr_SetString(PyExc_TypeError,
- "keys and values must be strings");
- return NULL;
- }
-
- option_keys[i] = PyString_AsString(key);
- option_values[i] = PyString_AsString(value);
- i++;
- }
-
- option_keys[len] = NULL;
- option_values[len] = NULL;
- }
- gdk_pixbuf_save_to_callbackv(GDK_PIXBUF(self->obj),
- (GdkPixbufSaveFunc) pixbuf_save_func, &data,
- type, option_keys, option_values, &error);
- g_free(option_keys);
- g_free(option_values);
-
- if (pyg_error_check(&error))
- return NULL;
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_pixbuf_new_from_data kwargs
-static PyObject *
-_wrap_gdk_pixbuf_new_from_data(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "data", "colorspace", "has_alpha",
- "bits_per_sample", "width", "height",
- "rowstride", NULL };
- const gchar *data;
- GdkColorspace colorspace;
- gboolean has_alpha;
- Py_ssize_t data_len;
- gint bits_per_sample, width, height, rowstride;
- Py_ssize_t required_len;
- guchar *data_copy;
- GdkPixbuf *pixbuf;
- PyObject *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s#iiiiii:pixbuf_new_from_data", kwlist,
- &data, &data_len, &colorspace,
- &has_alpha, &bits_per_sample,
- &width, &height, &rowstride))
- return NULL;
- required_len = height*rowstride;
- if (data_len < required_len) {
- PyErr_Format(PyExc_ValueError,
- "data length (%ld) is less then required by the other parameters (%ld)",
- (long int) data_len, (long int) required_len);
- return NULL;
- }
- data_copy = g_try_malloc(required_len);
- if (!data_copy)
- return PyErr_NoMemory();
- memcpy(data_copy, data, required_len);
- pixbuf = gdk_pixbuf_new_from_data(data_copy, colorspace, has_alpha,
- bits_per_sample, width, height,
- rowstride,
- (GdkPixbufDestroyNotify )g_free, NULL);
- ret = pygobject_new((GObject *)pixbuf);
- g_object_unref(pixbuf);
- return ret;
-}
-%%
-override gdk_pixbuf_new_from_array kwargs
-static PyObject *
-_wrap_gdk_pixbuf_new_from_array(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
-#ifdef HAVE_NUMPY
- static char *kwlist[] = { "array", "colorspace", "bits_per_sample", NULL };
- PyArrayObject *array;
- GdkColorspace colorspace;
- gint bits_per_sample ;
- GdkPixbuf *pixbuf;
- PyObject *ret;
- gboolean has_alpha;
- gint width, height;
- gint i, j, nc, rs, st0, st1, st2;
- guchar *src, *dst;
-
- if (!have_numpy())
- return NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!ii:pixbuf_new_from_array", kwlist,
- &PyArray_Type, &array, &colorspace,
- &bits_per_sample))
- return NULL;
- if (array->descr->type_num != PyArray_CHAR
- && array->descr->type_num != PyArray_UBYTE) {
- PyErr_SetString(PyExc_TypeError, "array type must be 'c' or 'b'");
- return NULL;
- }
- if (array->nd != 3 || array->dimensions[2] < 3 || array->dimensions[2] > 4) {
- PyErr_SetString(PyExc_TypeError, "array shape must be (n,m,3) or (n,m,4)");
- return NULL;
- }
- height = array->dimensions[0];
- width = array->dimensions[1];
- has_alpha = array->dimensions[2] == 4;
- pixbuf = gdk_pixbuf_new(colorspace, has_alpha, bits_per_sample,
- width, height);
- src = (guchar*) array->data;
- dst = gdk_pixbuf_get_pixels(pixbuf);
- nc = gdk_pixbuf_get_n_channels(pixbuf);
- rs = gdk_pixbuf_get_rowstride(pixbuf);
- st0 = array->strides[0];
- st1 = array->strides[1];
- st2 = array->strides[2];
- if (has_alpha) {
- for (j = 0; j < height; j++) {
- for (i = 0; i < width; i++) {
- dst[j*rs + i*4 + 0] = src[j*st0 + i*st1 + 0*st2];
- dst[j*rs + i*4 + 1] = src[j*st0 + i*st1 + 1*st2];
- dst[j*rs + i*4 + 2] = src[j*st0 + i*st1 + 2*st2];
- dst[j*rs + i*4 + 3] = src[j*st0 + i*st1 + 3*st2];
- }
- }
- } else {
- for (j = 0; j < height; j++) {
- for (i = 0; i < width; i++) {
- dst[j*rs + i*3 + 0] = src[j*st0 + i*st1 + 0*st2];
- dst[j*rs + i*3 + 1] = src[j*st0 + i*st1 + 1*st2];
- dst[j*rs + i*3 + 2] = src[j*st0 + i*st1 + 2*st2];
- }
- }
- }
- ret = pygobject_new((GObject *)pixbuf);
- g_object_unref(pixbuf);
- return ret;
-
-#else
- PyErr_SetString(PyExc_RuntimeError, "pygtk was not compiled with Numeric Python support");
- return NULL;
-#endif
-}
-%%
-override gdk_pixbuf_new_from_xpm_data kwargs
-static PyObject *
-_wrap_gdk_pixbuf_new_from_xpm_data(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "data", NULL };
- PyObject *py_data, *ret;
- gchar **data;
- int len, i;
- GdkPixbuf *pixbuf;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!:pixbuf_new_from_xpm_data", kwlist,
- &PyList_Type, &py_data))
- return NULL;
- len = PyList_Size(py_data);
- data = g_new(gchar *, len);
- for (i = 0; i < len; i ++) {
- PyObject *item = PyList_GetItem(py_data, i);
- if (!PyString_Check(item)) {
- PyErr_SetString(PyExc_TypeError, "data items must be strings");
- g_free(data);
- return NULL;
- }
- data[i] = PyString_AsString(item);
- }
- pixbuf = gdk_pixbuf_new_from_xpm_data((const char**)data);
- g_free(data);
- if (pixbuf == NULL) {
- PyErr_SetString(PyExc_IOError, "can't load pixbuf");
- return NULL;
- }
- ret = pygobject_new((GObject *)pixbuf);
- g_object_unref(pixbuf);
- return ret;
-}
-%%
-override gdk_pixbuf_loader_new_with_type kwargs
-static int
-_wrap_gdk_pixbuf_loader_new_with_type(PyGObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "image_type", NULL };
- char *image_type = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|s:GdkPixbufLoader.__init__",
- kwlist, &image_type))
- return -1;
-
- if (image_type == NULL) {
- self->obj = (GObject *)gdk_pixbuf_loader_new();
- } else {
- GError *error = NULL;
- self->obj = (GObject *)gdk_pixbuf_loader_new_with_type(image_type,
- &error);
- if (pyg_error_check(&error))
- return -1;
- }
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GdkPixbufLoader object");
- return -1;
- }
- pygobject_register_wrapper((PyObject *)self);
- return 0;
-}
-%%
-override gdk_pixbuf_loader_write kwargs
-static PyObject *
-_wrap_gdk_pixbuf_loader_write(PyGObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "buf", "count", NULL };
- Py_ssize_t buf_len;
- int count = -1, ret;
- guchar *buf;
- GError *error = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s#|i:GdkPixbufLoader.write",
- kwlist, &buf, &buf_len, &count))
- return NULL;
-
- if (count < 0 || count > buf_len) {
- count = buf_len;
- }
-
- ret = gdk_pixbuf_loader_write(GDK_PIXBUF_LOADER(self->obj),
- buf, count, &error);
-
- if (pyg_error_check(&error))
- return NULL;
-
- return PyBool_FromLong(ret);
-}
-%%
-override gdk_pixbuf_animation_get_iter kwargs
-static PyObject *
-_wrap_gdk_pixbuf_animation_get_iter(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "start_time", NULL };
- GdkPixbufAnimationIter *ret;
- double start_time = 0.0;
- GTimeVal starttime, *starttimep;
- PyObject *pyretval;
-
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "|d:GdkPixbufAnimation.get_iter",
- kwlist, &start_time))
- return NULL;
-
- if (start_time > 0.0) {
- starttime.tv_sec = (glong) start_time;
- starttime.tv_usec = (glong)((start_time - starttime.tv_sec)
- * G_USEC_PER_SEC);
- starttimep = &starttime;
- } else if (start_time == 0.0) {
- starttimep = NULL;
- } else {
- PyErr_SetString(PyExc_ValueError, "start_time must be >= 0.0");
- return NULL;
- }
-
- ret = gdk_pixbuf_animation_get_iter(GDK_PIXBUF_ANIMATION(self->obj),
- starttimep);
- /* pygobject_new handles NULL checking */
- pyretval = pygobject_new((GObject *)ret);
- if (ret)
- g_object_unref(ret);
- return pyretval;
-}
-%%
-override gdk_pixbuf_animation_iter_advance kwargs
-static PyObject *
-_wrap_gdk_pixbuf_animation_iter_advance(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "current_time", NULL };
- gboolean ret;
- double current_time = 0.0;
- GTimeVal currenttime, *currenttimep;
-
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "|d:GdkPixbufAnimationIter.advance",
- kwlist, &current_time))
- return NULL;
-
- if (current_time > 0.0) {
- currenttime.tv_sec = (glong) current_time;
- currenttime.tv_usec = (glong)((current_time - currenttime.tv_sec)
- * G_USEC_PER_SEC);
- currenttimep = &currenttime;
- } else if (current_time == 0.0) {
- currenttimep = NULL;
- } else {
- PyErr_SetString(PyExc_ValueError, "current_time must be >= 0.0");
- return NULL;
- }
-
- ret = gdk_pixbuf_animation_iter_advance(GDK_PIXBUF_ANIMATION_ITER(self->obj),
- currenttimep);
-
- return PyBool_FromLong(ret);
-}
-%%
-override gdk_pixbuf_get_formats noargs
-static PyObject *
-pygtk_make_pixbuf_format_dict(GdkPixbufFormat *format)
-{
- PyObject *item, *value;
- gchar *sval, **aval;
- gint i;
-
- item = PyDict_New();
-
- sval = gdk_pixbuf_format_get_name(format);
- value = PyString_FromString(sval);
- PyDict_SetItemString(item, "name", value);
- Py_DECREF(value);
- g_free(sval);
-
- sval = gdk_pixbuf_format_get_description(format);
- value = PyString_FromString(sval);
- PyDict_SetItemString(item, "description", value);
- Py_DECREF(value);
- g_free(sval);
-
- aval = gdk_pixbuf_format_get_mime_types(format);
- value = PyList_New(0);
- for (i = 0; aval[i] != NULL; i++) {
- PyObject *string_item = PyString_FromString(aval[i]);
-
- PyList_Append(value, string_item);
- Py_DECREF(string_item);
- }
- PyDict_SetItemString(item, "mime_types", value);
- Py_DECREF(value);
- g_strfreev(aval);
-
- aval = gdk_pixbuf_format_get_extensions(format);
- value = PyList_New(0);
- for (i = 0; aval[i] != NULL; i++) {
- PyObject *string_item = PyString_FromString(aval[i]);
-
- PyList_Append(value, string_item);
- Py_DECREF(string_item);
- }
- PyDict_SetItemString(item, "extensions", value);
- Py_DECREF(value);
- g_strfreev(aval);
-
- PyDict_SetItemString(item, "is_writable",
- PyBool_FromLong(gdk_pixbuf_format_is_writable(format)));
-
- return item;
-}
-static PyObject *
-_wrap_gdk_pixbuf_get_formats(PyObject *self)
-{
- GSList *list, *tmp;
- PyObject *ret;
-
- list = gdk_pixbuf_get_formats();
- ret = PyList_New(0);
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- PyObject *item;
- item = pygtk_make_pixbuf_format_dict((GdkPixbufFormat *)(tmp->data));
-
- PyList_Append(ret, item);
- Py_DECREF(item);
- }
-
- g_slist_free(list);
-
- return ret;
-}
-%%
-override gdk_pixbuf_fill kwargs
-static PyObject *
-_wrap_gdk_pixbuf_fill(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "pixel", NULL };
- PyObject *py_pixel = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GdkPixbuf.fill", kwlist, &py_pixel))
- return NULL;
-
- if (PyInt_Check(py_pixel))
- gdk_pixbuf_fill(GDK_PIXBUF(self->obj), PyInt_AsLong(py_pixel));
- else if (PyLong_Check(py_pixel))
- gdk_pixbuf_fill(GDK_PIXBUF(self->obj), PyLong_AsUnsignedLong(py_pixel));
- else {
- PyErr_SetString(PyExc_TypeError, "pixel must be an int or a long");
- return NULL;
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_pixbuf_get_file_info kwargs
-static PyObject *
-_wrap_gdk_pixbuf_get_file_info(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- PyObject *pygtk_make_pixbuf_format_dict(GdkPixbufFormat *format);
- static char *kwlist[] = { "filename", NULL };
- gint width, height;
- GdkPixbufFormat *format;
- gchar *filename;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:gtk.gdk.pixbuf_get_file_info", kwlist,
- &filename))
- return NULL;
-
- format = gdk_pixbuf_get_file_info(filename, &width, &height);
-
- if (format) {
- PyObject *py_format;
-
- py_format = pygtk_make_pixbuf_format_dict(format);
- return Py_BuildValue("(Nii)", py_format, width, height);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_pixbuf_loader_get_format noargs
-static PyObject *pygtk_make_pixbuf_format_dict(GdkPixbufFormat *format);
-static PyObject *
-_wrap_gdk_pixbuf_loader_get_format(PyGObject *self)
-{
- GdkPixbufFormat *format;
-
- format = gdk_pixbuf_loader_get_format(GDK_PIXBUF_LOADER(self->obj));
-
- if (format)
- return pygtk_make_pixbuf_format_dict(format);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_pixbuf_get_from_drawable2 kwargs
-static PyObject *
-_wrap_gdk_pixbuf_get_from_drawable2(PyObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "pixbuf", "src", "cmap",
- "src_x", "src_y",
- "dest_x", "dest_y",
- "width", "height", NULL };
- PyGObject *py_pixbuf, *src, *cmap;
- int src_x, src_y, dest_x, dest_y, width, height;
- GdkPixbuf *pixbuf = NULL, *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO!O!iiiiii:pixbuf_get_from_drawable",
- kwlist,
- &py_pixbuf,
- &PyGdkDrawable_Type, &src,
- &PyGdkColormap_Type, &cmap,
- &src_x, &src_y,
- &dest_x, &dest_y,
- &width, &height))
- return NULL;
-
- if (py_pixbuf && pygobject_check(py_pixbuf, &PyGdkPixbuf_Type))
- pixbuf = GDK_PIXBUF(py_pixbuf->obj);
- else if ((PyObject *)py_pixbuf != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "pixbuf should be a GdkPixbuf or None");
- return NULL;
- }
-
- ret = gdk_pixbuf_get_from_drawable(pixbuf,
- GDK_DRAWABLE(src->obj),
- GDK_COLORMAP(cmap->obj),
- src_x, src_y,
- dest_x, dest_y,
- width, height);
-
- /* pygobject_new handles NULL checking */
- return pygobject_new((GObject *)ret);
-}
diff --git a/gtk/gdkrectangle.override b/gtk/gdkrectangle.override
deleted file mode 100644
index e1a0fcf0..00000000
--- a/gtk/gdkrectangle.override
+++ /dev/null
@@ -1,216 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gdkrectangle.override: gtk.gdk.Rectangle overrides
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-override gdk_rectangle_new kwargs
-static int
-_wrap_gdk_rectangle_new(PyGBoxed *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "x", "y", "width", "height", NULL };
- GdkRectangle rect = {0, 0, 0, 0};
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|iiii:GdkRectangle.__init__",
- kwlist, &(rect.x), &(rect.y),
- &(rect.width), &(rect.height)))
- return -1;
-
- self->boxed = g_boxed_copy(GDK_TYPE_RECTANGLE, &rect);
- self->free_on_dealloc = TRUE;
- self->gtype = GDK_TYPE_RECTANGLE;
-
- return 0;
-}
-%%
-override-slot GdkRectangle.tp_as_sequence
-static Py_ssize_t
-_wrap_gdk_rectangle_length(PyGBoxed *self)
-{
- return 4;
-}
-static PyObject *
-_wrap_gdk_rectangle_getitem(PyGBoxed *self, Py_ssize_t pos)
-{
- GdkRectangle *rect;
-
- if (pos < 0) pos += 4;
- if (pos < 0 || pos >= 4) {
- PyErr_SetString(PyExc_IndexError, "index out of range");
- return NULL;
- }
- rect = pyg_boxed_get(self, GdkRectangle);
- switch (pos) {
- case 0: return PyInt_FromLong(rect->x);
- case 1: return PyInt_FromLong(rect->y);
- case 2: return PyInt_FromLong(rect->width);
- case 3: return PyInt_FromLong(rect->height);
- default:
- g_assert_not_reached();
- return NULL;
- }
-}
-static int
-_wrap_gdk_rectangle_setitem(PyGBoxed *self, Py_ssize_t pos, PyObject *value)
-{
- GdkRectangle *rect;
- gint val;
-
- if (pos < 0) pos += 4;
- if (pos < 0 || pos >= 4) {
- PyErr_SetString(PyExc_IndexError, "index out of range");
- return -1;
- }
- rect = pyg_boxed_get(self, GdkRectangle);
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- switch(pos) {
- case 0: rect->x = val; break;
- case 1: rect->y = val; break;
- case 2: rect->width = val; break;
- case 3: rect->height = val; break;
- default:
- g_assert_not_reached();
- return -1;
- }
- return 0;
-}
-static PySequenceMethods _wrap_gdk_rectangle_tp_as_sequence = {
- (lenfunc)_wrap_gdk_rectangle_length,
- 0,
- 0,
- (ssizeargfunc)_wrap_gdk_rectangle_getitem,
- 0,
- (ssizeobjargproc)_wrap_gdk_rectangle_setitem,
- 0,
-};
-%%
-override-attr GdkRectangle.x
-static int
-_wrap_gdk_rectangle__set_x(PyGBoxed *self, PyObject *value, void *closure)
-{
- gint val;
-
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- pyg_boxed_get(self, GdkRectangle)->x = val;
- return 0;
-}
-%%
-override-attr GdkRectangle.y
-static int
-_wrap_gdk_rectangle__set_y(PyGBoxed *self, PyObject *value, void *closure)
-{
- gint val;
-
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- pyg_boxed_get(self, GdkRectangle)->y = val;
- return 0;
-}
-%%
-override-attr GdkRectangle.width
-static int
-_wrap_gdk_rectangle__set_width(PyGBoxed *self, PyObject *value, void *closure)
-{
- gint val;
-
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- pyg_boxed_get(self, GdkRectangle)->width = val;
- return 0;
-}
-%%
-override-attr GdkRectangle.height
-static int
-_wrap_gdk_rectangle__set_height(PyGBoxed *self, PyObject *value, void *closure)
-{
- gint val;
-
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- pyg_boxed_get(self, GdkRectangle)->height = val;
- return 0;
-}
-%%
-override gdk_rectangle_intersect kwargs
-static PyObject *
-_wrap_gdk_rectangle_intersect(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "src", NULL };
- PyObject *py_src;
- GdkRectangle src, dest = {0, 0, 0, 0};
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GdkRectangle.intersect",
- kwlist, &py_src)) {
- return NULL;
- }
-
- if (!pyg_boxed_check(py_src, GDK_TYPE_RECTANGLE)) {
- if (!pygdk_rectangle_from_pyobject(py_src, &src)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "src must be a GdkRectangle or 4-tuple");
- return NULL;
- }
- } else {
- src = *pyg_boxed_get(py_src, GdkRectangle);
- }
-
- gdk_rectangle_intersect(pyg_boxed_get(self, GdkRectangle), &src, &dest);
-
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &dest, TRUE, TRUE);
-}
-%%
-override gdk_rectangle_union kwargs
-static PyObject *
-_wrap_gdk_rectangle_union(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "src", NULL };
- PyObject *py_src;
- GdkRectangle src, dest;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GdkRectangle.union",
- kwlist, &py_src)) {
- return NULL;
- }
-
- if (!pyg_boxed_check(py_src, GDK_TYPE_RECTANGLE)) {
- if (!pygdk_rectangle_from_pyobject(py_src, &src)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "src must be a GdkRectangle or 4-tuple");
- return NULL;
- }
- } else {
- src = *pyg_boxed_get(py_src, GdkRectangle);
- }
-
- gdk_rectangle_union(pyg_boxed_get(self, GdkRectangle), &src, &dest);
-
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &dest, TRUE, TRUE);
-}
diff --git a/gtk/gdkwindow.override b/gtk/gdkwindow.override
deleted file mode 100644
index 8544fa17..00000000
--- a/gtk/gdkwindow.override
+++ /dev/null
@@ -1,704 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- *
- * gdkwindow.override: gtk.gdk.Window overrides
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-override gdk_window_new kwargs
-static int
-_wrap_gdk_window_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "parent", "width", "height", "window_type",
- "event_mask", "wclass", "title", "x", "y",
- "visual", "colormap", "cursor", "wmclass_name",
- "wmclass_class", "override_redirect", NULL };
- GdkWindowAttr attr = { NULL, 0, -1, -1, 0, 0, -1, NULL, NULL, 0, NULL,
- NULL, NULL, -1 };
- guint attr_mask = 0;
- GdkWindow *parent = NULL;
- PyGObject *py_parent = NULL;
- PyObject *py_window_type = NULL;
- PyObject *py_wclass = NULL;
- PyGObject *py_visual = NULL;
- PyGObject *py_colormap = NULL;
- PyGObject *py_cursor = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OiiOiO|siiO!O!Ossb:GdkWindow.__init__",
- kwlist, &py_parent, &attr.width,
- &attr.height, &py_window_type,
- &attr.event_mask, &py_wclass,
- &attr.title, &attr.x, &attr.y,
- &PyGdkVisual_Type, &py_visual,
- &PyGdkColormap_Type, &py_colormap,
- &py_cursor,
- &attr.wmclass_name,
- &attr.wmclass_class,
- &attr.override_redirect))
- return -1;
-
- if (py_parent && pygobject_check(py_parent, &PyGdkWindow_Type))
- parent = GDK_WINDOW(py_parent->obj);
- else if ((PyObject *)py_parent != Py_None) {
- PyErr_SetString(PyExc_TypeError, "parent must be a GdkWindow or None");
- return -1;
- }
-
- if (pyg_enum_get_value(GDK_TYPE_WINDOW_CLASS,
- py_wclass, (gint *)&attr.wclass))
- return -1;
- if (pyg_enum_get_value(GDK_TYPE_WINDOW_TYPE,
- py_window_type, (gint *)&attr.window_type))
- return -1;
-
- if (attr.title)
- attr_mask |= GDK_WA_TITLE;
- if (attr.x != -1)
- attr_mask |= GDK_WA_X;
- if (attr.y != -1)
- attr_mask |= GDK_WA_Y;
- if (py_visual) {
- attr.visual = GDK_VISUAL(py_visual->obj);
- attr_mask |= GDK_WA_VISUAL;
- }
- if (py_colormap) {
- attr.colormap = GDK_COLORMAP(py_colormap->obj);
- attr_mask |= GDK_WA_COLORMAP;
- }
- if (py_cursor) {
- if (!pyg_boxed_check(py_cursor, GDK_TYPE_CURSOR)) {
- PyErr_SetString(PyExc_TypeError, "cursor should be a GdkCursor");
- return -1;
- }
- attr.cursor = pyg_boxed_get(py_cursor, GdkCursor);
- attr_mask |= GDK_WA_CURSOR;
- }
- if (attr.wmclass_name && attr.wmclass_class)
- attr_mask |= GDK_WA_WMCLASS;
- if (attr.override_redirect != -1)
- attr_mask |= GDK_WA_NOREDIR;
-
- self->obj = (GObject *)gdk_window_new(parent, &attr, attr_mask);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GdkWindow object");
- return -1;
- }
-
- g_object_ref(self->obj);
-
- pygobject_register_wrapper((PyObject *)self);
- return 0;
-}
-%%
-override gdk_property_get kwargs
-
-static GdkAtom atom_type = GDK_NONE, atom_pair_type = GDK_NONE;
-
-static PyObject *
-_wrap_gdk_property_get(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "property", "type", "pdelete", NULL };
- PyObject *py_property, *py_type = NULL;
- GdkAtom property, type;
- gint pdelete = FALSE;
-
- GdkAtom atype;
- gint aformat, alength;
- guchar *data;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|Oi:GdkWindow.property_get", kwlist,
- &py_property, &py_type,
- &pdelete)) {
- return NULL;
- }
- property = pygdk_atom_from_pyobject(py_property);
- if (PyErr_Occurred())
- return NULL;
-
- type = pygdk_atom_from_pyobject(py_type);
- if (PyErr_Occurred())
- return NULL;
-
- if (gdk_property_get(GDK_WINDOW(self->obj), property, type, 0, 9999,
- pdelete, &atype, &aformat, &alength, &data)) {
- /* success */
- PyObject *pdata = NULL;
- gint nelements, i;
- gchar *aname;
- PyObject *ret;
-
- switch (aformat) {
- case 8:
- if ((pdata = PyString_FromStringAndSize((char*)data,
- alength)) == NULL)
- return NULL;
- break;
- case 16: {
- short *data16;
-
- data16 = (short *)data;
- nelements = alength / sizeof(short);
- if ((pdata = PyList_New(nelements)) == NULL)
- return NULL;
- for (i = 0; i < nelements; i++)
- PyList_SetItem(pdata, i, PyInt_FromLong(data16[i]));
- break;
- }
- case 32: {
- if (atom_type == GDK_NONE) {
- atom_type = gdk_atom_intern("ATOM", TRUE);
- atom_pair_type = gdk_atom_intern("ATOM_PAIR", TRUE);
- }
-
- /* special handling for atom types */
- if (atype == atom_type || atype == atom_pair_type) {
- GdkAtom *data32;
-
- data32 = (GdkAtom *)data;
- nelements = alength / sizeof(GdkAtom);
- if ((pdata = PyList_New(nelements)) == NULL)
- return NULL;
- for (i = 0; i < nelements; i++) {
- aname = gdk_atom_name(data32[i]);
- PyList_SetItem(pdata, i, PyString_FromString(aname));
- g_free(aname);
- }
- } else {
- long *data32;
-
- data32 = (long *)data;
- nelements = alength / sizeof(long);
- if ((pdata = PyList_New(nelements)) == NULL)
- return NULL;
- for (i = 0; i < nelements; i++)
- PyList_SetItem(pdata, i, PyInt_FromLong(data32[i]));
- }
- break;
- }
- default:
- g_warning("got a property format != 8, 16 or 32");
- g_assert_not_reached();
- }
- g_free(data);
- aname = gdk_atom_name(atype);
- ret = Py_BuildValue("(NiN)", PyString_FromString(aname), aformat,
- pdata);
- g_free(aname);
- return ret;
- } else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override gdk_property_change kwargs
-static PyObject *
-_wrap_gdk_property_change(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "property","type","format","mode","data",NULL };
- PyObject *py_property, *py_type;
- GdkAtom property, type;
- gint format;
- PyObject *py_mode, *pdata;
- GdkPropMode mode;
- guchar *data = NULL;
- gint nelements;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOiOO:GdkWindow.property_change", kwlist,
- &py_property, &py_type, &format, &py_mode,
- &pdata)) {
- return NULL;
- }
- property = pygdk_atom_from_pyobject(py_property);
- if (PyErr_Occurred())
- return NULL;
-
- type = pygdk_atom_from_pyobject(py_type);
- if (PyErr_Occurred())
- return NULL;
-
- if (pyg_enum_get_value(GDK_TYPE_PROP_MODE, py_mode, (gint *)&mode))
- return NULL;
- switch (format) {
- case 8:
- if (!PyString_Check(pdata)) {
- PyErr_SetString(PyExc_TypeError, "data not a string and format=8");
- return NULL;
- }
- data = (guchar*)PyString_AsString(pdata);
- nelements = PyString_Size(pdata);
- break;
- case 16: {
- short *data16;
- gint i;
-
- if (!PySequence_Check(pdata)) {
- PyErr_SetString(PyExc_TypeError,
- "data not a sequence and format=16");
- return NULL;
- }
- nelements = PySequence_Length(pdata);
- data16 = g_new(short, nelements);
- data = (guchar *)data16;
- for (i = 0; i < nelements; i++) {
- PyObject *item = PySequence_GetItem(pdata, i);
-
- if (item) data16[i] = PyInt_AsLong(item);
- if (!item || PyErr_Occurred()) {
- Py_XDECREF(item);
- g_free(data16);
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,"data element not an int");
- return NULL;
- }
- Py_DECREF(item);
- }
- break;
- }
- case 32: {
- gint i;
-
- if (!PySequence_Check(pdata)) {
- PyErr_SetString(PyExc_TypeError,
- "data not a sequence and format=32");
- return NULL;
- }
- nelements = PySequence_Length(pdata);
-
- if (atom_type == GDK_NONE) {
- atom_type = gdk_atom_intern("ATOM", TRUE);
- atom_pair_type = gdk_atom_intern("ATOM_PAIR", TRUE);
- }
-
- /* special handling for atom types */
- if (type == atom_type || type == atom_pair_type) {
- GdkAtom *data32 = g_new(GdkAtom, nelements);
-
- data = (guchar *)data32;
- for (i = 0; i < nelements; i++) {
- PyObject *item = PySequence_GetItem(pdata, i);
-
- if (item) data32[i] = pygdk_atom_from_pyobject(item);
- if (!item || PyErr_Occurred()) {
- Py_XDECREF(item);
- g_free(data32);
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,"data element not an atom");
- return NULL;
- }
- Py_DECREF(item);
- }
- } else {
- long *data32 = g_new(long, nelements);
-
- data = (guchar *)data32;
- for (i = 0; i < nelements; i++) {
- PyObject *item = PySequence_GetItem(pdata, i);
-
- if (item) data32[i] = PyInt_AsLong(item);
- if (!item || PyErr_Occurred()) {
- Py_XDECREF(item);
- g_free(data32);
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,"data element not an int");
- return NULL;
- }
- Py_DECREF(item);
- }
- }
- break;
- }
- default:
- PyErr_SetString(PyExc_TypeError, "format must be 8, 16 or 32");
- return NULL;
- break;
- }
- gdk_property_change(GDK_WINDOW(self->obj), property, type, format, mode,
- data, nelements);
- if (format != 8)
- g_free(data);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_window_set_geometry_hints kwargs
-static PyObject *
-_wrap_gdk_window_set_geometry_hints(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "min_width", "min_height",
- "max_width", "max_height", "base_width",
- "base_height", "width_inc", "height_inc",
- "min_aspect", "max_aspect", NULL };
- gint min_width = -1, min_height = -1, max_width = -1, max_height = -1;
- gint base_width = -1, base_height = -1, width_inc = -1, height_inc = -1;
- gdouble min_aspect = -1.0, max_aspect = -1.0;
- GdkGeometry geometry = { 0 };
- GdkWindowHints geom_mask = 0;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|iiiiiiiidd:GdkWindow.set_geometry_hints",
- kwlist, &min_width, &min_height,
- &max_width, &max_height,
- &base_width, &base_height, &width_inc,
- &height_inc, &min_aspect, &max_aspect))
- return NULL;
- if (min_width >= 0 || min_height >= 0) {
- geometry.min_width = MAX(min_width, 0);
- geometry.min_height = MAX(min_height, 0);
- geom_mask |= GDK_HINT_MIN_SIZE;
- }
- if (max_width >= 0 || max_height >= 0) {
- geometry.max_width = MAX(max_width, 0);
- geometry.max_height = MAX(max_height, 0);
- geom_mask |= GDK_HINT_MAX_SIZE;
- }
- if (base_width >= 0 || base_height >= 0) {
- geometry.base_width = MAX(base_width, 0);
- geometry.base_height = MAX(base_height, 0);
- geom_mask |= GDK_HINT_BASE_SIZE;
- }
- if (width_inc >= 0 || height_inc >= 0) {
- geometry.width_inc = MAX(width_inc, 0);
- geometry.height_inc = MAX(height_inc, 0);
- geom_mask |= GDK_HINT_RESIZE_INC;
- }
- if (min_aspect >= 0.0 || max_aspect >= 0.0) {
- if (min_aspect <= 0.0 || max_aspect <= 0.0) {
- PyErr_SetString(PyExc_TypeError, "aspect ratios must be positive");
- return NULL;
- }
- geometry.min_aspect = min_aspect;
- geometry.max_aspect = max_aspect;
- geom_mask |= GDK_HINT_ASPECT;
- }
- gdk_window_set_geometry_hints(GDK_WINDOW(self->obj), &geometry, geom_mask);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_window_get_geometry noargs
-static PyObject *
-_wrap_gdk_window_get_geometry(PyGObject *self)
-{
- gint x, y, width, height, depth;
-
- gdk_window_get_geometry(GDK_WINDOW(self->obj), &x, &y, &width, &height,
- &depth);
- return Py_BuildValue("(iiiii)", x, y, width, height, depth);
-}
-%%
-override gdk_window_get_position noargs
-static PyObject *
-_wrap_gdk_window_get_position(PyGObject *self)
-{
- gint x, y;
-
- gdk_window_get_position(GDK_WINDOW(self->obj), &x, &y);
- return Py_BuildValue("(ii)", x, y);
-}
-%%
-override gdk_window_get_origin noargs
-static PyObject *
-_wrap_gdk_window_get_origin(PyGObject *self)
-{
- gint x, y;
-
- gdk_window_get_origin(GDK_WINDOW(self->obj), &x, &y);
- return Py_BuildValue("(ii)", x, y);
-}
-%%
-override gdk_window_get_deskrelative_origin noargs
-static PyObject *
-_wrap_gdk_window_get_deskrelative_origin(PyGObject *self)
-{
- gint x, y;
-
- gdk_window_get_deskrelative_origin(GDK_WINDOW(self->obj), &x, &y);
- return Py_BuildValue("(ii)", x, y);
-}
-%%
-override gdk_window_get_root_origin noargs
-static PyObject *
-_wrap_gdk_window_get_root_origin(PyGObject *self)
-{
- gint x, y;
-
- gdk_window_get_root_origin(GDK_WINDOW(self->obj), &x, &y);
- return Py_BuildValue("(ii)", x, y);
-}
-%%
-override gdk_window_get_pointer noargs
-static PyObject *
-_wrap_gdk_window_get_pointer(PyGObject *self)
-{
- gint x, y;
- GdkModifierType mask;
-
- gdk_window_get_pointer(GDK_WINDOW(self->obj), &x, &y, &mask);
- return Py_BuildValue("(iiN)", x, y,
- pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE, mask));
-}
-%%
-ignore gdk_window_peek_children
-%%
-override gdk_window_get_children noargs
-static PyObject *
-_wrap_gdk_window_get_children(PyGObject *self)
-{
- GList *children, *tmp;
- PyObject *list;
-
- children = gdk_window_get_children(GDK_WINDOW(self->obj));
- list = PyList_New(0);
- for (tmp = children; tmp != NULL; tmp = tmp->next) {
- PyObject *item = pygobject_new((GObject *)tmp->data);
-
- PyList_Append(list, item);
- Py_DECREF(item);
- }
- g_list_free(children);
- return list;
-}
-%%
-override gdk_window_set_icon_list kwargs
-static PyObject *
-_wrap_gdk_window_set_icon_list(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "pixbufs", NULL };
- PyObject *py_pixbufs;
- gint length, i;
- GList *pixbufs = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GdkWindow.set_icon_list",
- kwlist, &py_pixbufs))
- return NULL;
- if (!(py_pixbufs = PySequence_Fast(py_pixbufs,
- "pixbufs must be a sequence of pixbufs")))
- return NULL;
- length = PySequence_Fast_GET_SIZE(py_pixbufs);
- for (i = length - 1; i >= 0; i--) {
- PyObject *item = PySequence_Fast_GET_ITEM(py_pixbufs, i);
-
- if (!pygobject_check(item, &PyGdkPixbuf_Type)) {
- g_list_free(pixbufs);
- Py_DECREF(py_pixbufs);
- PyErr_SetString(PyExc_TypeError,
- "pixbufs must be a sequence of pixbufs");
- return NULL;
- }
- pixbufs = g_list_prepend(pixbufs, GDK_PIXBUF(pygobject_get(item)));
- }
- gdk_window_set_icon_list(GDK_WINDOW(self->obj), pixbufs);
- g_list_free(pixbufs);
- Py_DECREF(py_pixbufs);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_window_get_frame_extents noargs
-static PyObject *
-_wrap_gdk_window_get_frame_extents(PyGObject *self)
-{
- GdkRectangle rect = {0, 0, 0, 0};
-
- gdk_window_get_frame_extents(GDK_WINDOW(self->obj), &rect);
-
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &rect, TRUE, TRUE);
-}
-%%
-override gdk_window_get_decorations noargs
-static PyObject *
-_wrap_gdk_window_get_decorations(PyGObject *self)
-{
- GdkWMDecoration decor = 0;
-
- gdk_window_get_decorations(GDK_WINDOW(self->obj), &decor);
-
- return pyg_flags_from_gtype(GDK_TYPE_WM_DECORATION, decor);
-}
-%%
-override gdk_window_get_toplevels noargs
-static PyObject *
-_wrap_gdk_window_get_toplevels(PyGObject *self)
-{
- GList *topl;
- guint ntopl;
- int i;
- PyObject *list;
-
- topl = gdk_window_get_toplevels();
- ntopl = g_list_length(topl);
-
- if ((list = PyList_New(ntopl)) == NULL)
- return NULL;
-
- for (i = 0; i < ntopl; i++) {
- PyObject *item;
-
- item = pygobject_new((GObject *)g_list_nth_data(topl, i));
- PyList_SetItem(list, i, item);
- }
-
- g_list_free(topl);
-
- return list;
-}
-%%
-override gdk_window_set_user_data kwargs
-
-static void __gdk_window_set_user_data_window_destroyed(gpointer widget,
- GObject *window);
-
-static void
-__gdk_window_set_user_data_widget_destroyed(gpointer window,
- GObject *widget)
-{
- gpointer old_user_data = NULL;
- gdk_window_get_user_data(GDK_WINDOW(window), &old_user_data);
- gdk_window_set_user_data(GDK_WINDOW(window), NULL);
- g_object_weak_unref(G_OBJECT(window), __gdk_window_set_user_data_window_destroyed,
- widget);
-}
-
-static void
-__gdk_window_set_user_data_window_destroyed(gpointer widget,
- GObject *window)
-{
- g_object_weak_unref(G_OBJECT(widget), __gdk_window_set_user_data_widget_destroyed,
- window);
-}
-
-static PyObject *
-_wrap_gdk_window_set_user_data(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "user_data", NULL };
- PyGObject *user_data;
- gpointer old_user_data = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GdkWindow.set_user_data",
- kwlist, &user_data))
- return NULL;
-
- if ((PyObject *)user_data != Py_None &&
- !pygobject_check(user_data, &PyGtkWidget_Type)) {
- PyErr_SetString(PyExc_TypeError, "Only GtkWidgets are allowed as user data."
- " Maybe you want to use GObject.set_data()");
- return NULL;
- }
- /* Remove any existing weak references */
- gdk_window_get_user_data(GDK_WINDOW(self->obj), &old_user_data);
- if (old_user_data) {
- g_object_weak_unref(old_user_data, __gdk_window_set_user_data_widget_destroyed, self->obj);
- g_object_weak_unref(self->obj, __gdk_window_set_user_data_window_destroyed, old_user_data);
- }
-
- if ((PyObject *)user_data != Py_None) {
- /* Add new weak references */
- gdk_window_set_user_data(GDK_WINDOW(self->obj), GTK_WIDGET(user_data->obj));
- g_object_weak_ref(user_data->obj, __gdk_window_set_user_data_widget_destroyed, self->obj);
- g_object_weak_ref(self->obj, __gdk_window_set_user_data_window_destroyed, user_data->obj);
- } else {
- gdk_window_set_user_data(GDK_WINDOW(self->obj), NULL);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gdk_window_get_user_data noargs
-static PyObject *
-_wrap_gdk_window_get_user_data(PyGObject *self)
-{
- gpointer user_data = NULL;
- gdk_window_get_user_data(GDK_WINDOW(self->obj), &user_data);
- if (GTK_IS_WIDGET(user_data)) {
- return pygobject_new(G_OBJECT(user_data));
- } else {
- PyErr_SetString(PyExc_ValueError, "could not convert the user data");
- return NULL;
- }
-}
-%%
-override gdk_window_add_filter kwargs
-static int
-pygdk_filter_func_marshal(GdkXEvent *xevent,
- GdkEvent *event,
- PyGtkCustomNotify *cunote)
-{
- PyGILState_STATE state;
- PyObject *ret;
- PyObject *pyevent;
- int retval;
-
- state = pyg_gil_state_ensure();
-
- pyevent = pyg_boxed_new(GDK_TYPE_EVENT, event, TRUE, TRUE);
-
- if (cunote->data)
- ret = PyObject_CallFunction(cunote->func, "OO", pyevent, cunote->data);
-
- else
- ret = PyObject_CallFunction(cunote->func, "O", pyevent);
-
- if (ret == NULL) {
- PyErr_Print();
- retval = GDK_FILTER_CONTINUE;
- } else {
- retval = PyInt_AsLong(ret);
- }
-
- pyg_gil_state_release(state);
-
- return retval;
-}
-static PyObject*
-_wrap_gdk_window_add_filter(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "entries", "callback_data", NULL };
- PyGtkCustomNotify *cunote;
- PyObject *pyfunc, *pydata = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GdkWindow.add_filter", kwlist,
- &pyfunc, &pydata))
- return NULL;
-
-
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pydata;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- g_object_weak_ref(G_OBJECT(self->obj),
- (GWeakNotify) pygtk_custom_destroy_notify,
- cunote);
-
- gdk_window_add_filter (GDK_WINDOW(self->obj),
- (GdkFilterFunc)pygdk_filter_func_marshal,
- cunote);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
diff --git a/gtk/gtk-2.10-types.defs b/gtk/gtk-2.10-types.defs
deleted file mode 100644
index 5d00e049..00000000
--- a/gtk/gtk-2.10-types.defs
+++ /dev/null
@@ -1,376 +0,0 @@
-;; -*- scheme -*-
-; boxed definitions ...
-
-(define-boxed PaperSize
- (in-module "Gtk")
- (c-name "GtkPaperSize")
- (gtype-id "GTK_TYPE_PAPER_SIZE")
-)
-
-(define-boxed RecentInfo
- (in-module "Gtk")
- (c-name "GtkRecentInfo")
- (gtype-id "GTK_TYPE_RECENT_INFO")
-)
-
-(define-boxed TargetList
- (in-module "Gtk")
- (c-name "GtkTargetList")
- (gtype-id "GTK_TYPE_TARGET_LIST")
-)
-
-; interface definitions ...
-
-(define-interface PrintOperationPreview
- (in-module "Gtk")
- (c-name "GtkPrintOperationPreview")
- (gtype-id "GTK_TYPE_PRINT_OPERATION_PREVIEW")
- (prerequisite "GObject")
-)
-
-(define-interface RecentChooser
- (in-module "Gtk")
- (c-name "GtkRecentChooser")
- (gtype-id "GTK_TYPE_RECENT_CHOOSER")
- (prerequisite "GtkObject")
-)
-
-; object definitions ...
-
-(define-object Assistant
- (in-module "Gtk")
- (parent "GtkWindow")
- (c-name "GtkAssistant")
- (gtype-id "GTK_TYPE_ASSISTANT")
-)
-
-(define-object CellRendererAccel
- (in-module "Gtk")
- (parent "GtkCellRendererText")
- (c-name "GtkCellRendererAccel")
- (gtype-id "GTK_TYPE_CELL_RENDERER_ACCEL")
-)
-
-(define-object CellRendererSpin
- (in-module "Gtk")
- (parent "GtkCellRendererText")
- (c-name "GtkCellRendererSpin")
- (gtype-id "GTK_TYPE_CELL_RENDERER_SPIN")
-)
-
-(define-object LinkButton
- (in-module "Gtk")
- (parent "GtkButton")
- (c-name "GtkLinkButton")
- (gtype-id "GTK_TYPE_LINK_BUTTON")
-)
-
-(define-object PageSetup
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkPageSetup")
- (gtype-id "GTK_TYPE_PAGE_SETUP")
-)
-
-(define-object PrintContext
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkPrintContext")
- (gtype-id "GTK_TYPE_PRINT_CONTEXT")
-)
-
-(define-object PrintOperation
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkPrintOperation")
- (gtype-id "GTK_TYPE_PRINT_OPERATION")
- (implements "GtkPrintOperationPreview")
-)
-
-(define-object PrintSettings
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkPrintSettings")
- (gtype-id "GTK_TYPE_PRINT_SETTINGS")
-)
-
-(define-object RecentChooserDialog
- (in-module "Gtk")
- (parent "GtkDialog")
- (c-name "GtkRecentChooserDialog")
- (gtype-id "GTK_TYPE_RECENT_CHOOSER_DIALOG")
- (implements "GtkRecentChooser")
-)
-
-(define-object RecentChooserMenu
- (in-module "Gtk")
- (parent "GtkMenu")
- (c-name "GtkRecentChooserMenu")
- (gtype-id "GTK_TYPE_RECENT_CHOOSER_MENU")
- (implements "GtkRecentChooser")
-)
-
-(define-object RecentChooserWidget
- (in-module "Gtk")
- (parent "GtkVBox")
- (c-name "GtkRecentChooserWidget")
- (gtype-id "GTK_TYPE_RECENT_CHOOSER_WIDGET")
- (implements "GtkRecentChooser")
-)
-
-(define-object RecentFilter
- (in-module "Gtk")
- (parent "GtkObject")
- (c-name "GtkRecentFilter")
- (gtype-id "GTK_TYPE_RECENT_FILTER")
-)
-
-(define-object RecentManager
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkRecentManager")
- (gtype-id "GTK_TYPE_RECENT_MANAGER")
-)
-
-(define-object StatusIcon
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkStatusIcon")
- (gtype-id "GTK_TYPE_STATUS_ICON")
-)
-
-; pointer definitions ...
-
-;; Enumerations ...
-
-(define-enum AssistantPageType
- (in-module "Gtk")
- (c-name "GtkAssistantPageType")
- (gtype-id "GTK_TYPE_ASSISTANT_PAGE_TYPE")
- (values
- '("content" "GTK_ASSISTANT_PAGE_CONTENT")
- '("intro" "GTK_ASSISTANT_PAGE_INTRO")
- '("confirm" "GTK_ASSISTANT_PAGE_CONFIRM")
- '("summary" "GTK_ASSISTANT_PAGE_SUMMARY")
- '("progress" "GTK_ASSISTANT_PAGE_PROGRESS")
- )
-)
-
-(define-enum CellRendererAccelMode
- (in-module "Gtk")
- (c-name "GtkCellRendererAccelMode")
- (gtype-id "GTK_TYPE_CELL_RENDERER_ACCEL_MODE")
- (values
- '("gtk" "GTK_CELL_RENDERER_ACCEL_MODE_GTK")
- '("other" "GTK_CELL_RENDERER_ACCEL_MODE_OTHER")
- )
-)
-
-(define-enum PageOrientation
- (in-module "Gtk")
- (c-name "GtkPageOrientation")
- (gtype-id "GTK_TYPE_PAGE_ORIENTATION")
- (values
- '("portrait" "GTK_PAGE_ORIENTATION_PORTRAIT")
- '("landscape" "GTK_PAGE_ORIENTATION_LANDSCAPE")
- '("reverse-portrait" "GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT")
- '("reverse-landscape" "GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE")
- )
-)
-
-(define-enum PageSet
- (in-module "Gtk")
- (c-name "GtkPageSet")
- (gtype-id "GTK_TYPE_PAGE_SET")
- (values
- '("all" "GTK_PAGE_SET_ALL")
- '("even" "GTK_PAGE_SET_EVEN")
- '("odd" "GTK_PAGE_SET_ODD")
- )
-)
-
-(define-enum PrintDuplex
- (in-module "Gtk")
- (c-name "GtkPrintDuplex")
- (gtype-id "GTK_TYPE_PRINT_DUPLEX")
- (values
- '("simplex" "GTK_PRINT_DUPLEX_SIMPLEX")
- '("horizontal" "GTK_PRINT_DUPLEX_HORIZONTAL")
- '("vertical" "GTK_PRINT_DUPLEX_VERTICAL")
- )
-)
-
-(define-enum PrintError
- (in-module "Gtk")
- (c-name "GtkPrintError")
- (gtype-id "GTK_TYPE_PRINT_ERROR")
- (values
- '("general" "GTK_PRINT_ERROR_GENERAL")
- '("internal-error" "GTK_PRINT_ERROR_INTERNAL_ERROR")
- '("nomem" "GTK_PRINT_ERROR_NOMEM")
- )
-)
-
-(define-enum PrintOperationAction
- (in-module "Gtk")
- (c-name "GtkPrintOperationAction")
- (gtype-id "GTK_TYPE_PRINT_OPERATION_ACTION")
- (values
- '("print-dialog" "GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG")
- '("print" "GTK_PRINT_OPERATION_ACTION_PRINT")
- '("preview" "GTK_PRINT_OPERATION_ACTION_PREVIEW")
- '("export" "GTK_PRINT_OPERATION_ACTION_EXPORT")
- )
-)
-
-(define-enum PrintOperationResult
- (in-module "Gtk")
- (c-name "GtkPrintOperationResult")
- (gtype-id "GTK_TYPE_PRINT_OPERATION_RESULT")
- (values
- '("error" "GTK_PRINT_OPERATION_RESULT_ERROR")
- '("apply" "GTK_PRINT_OPERATION_RESULT_APPLY")
- '("cancel" "GTK_PRINT_OPERATION_RESULT_CANCEL")
- '("in-progress" "GTK_PRINT_OPERATION_RESULT_IN_PROGRESS")
- )
-)
-
-(define-enum PrintPages
- (in-module "Gtk")
- (c-name "GtkPrintPages")
- (gtype-id "GTK_TYPE_PRINT_PAGES")
- (values
- '("all" "GTK_PRINT_PAGES_ALL")
- '("current" "GTK_PRINT_PAGES_CURRENT")
- '("ranges" "GTK_PRINT_PAGES_RANGES")
- )
-)
-
-(define-enum PrintQuality
- (in-module "Gtk")
- (c-name "GtkPrintQuality")
- (gtype-id "GTK_TYPE_PRINT_QUALITY")
- (values
- '("low" "GTK_PRINT_QUALITY_LOW")
- '("normal" "GTK_PRINT_QUALITY_NORMAL")
- '("high" "GTK_PRINT_QUALITY_HIGH")
- '("draft" "GTK_PRINT_QUALITY_DRAFT")
- )
-)
-
-(define-enum PrintStatus
- (in-module "Gtk")
- (c-name "GtkPrintStatus")
- (gtype-id "GTK_TYPE_PRINT_STATUS")
- (values
- '("initial" "GTK_PRINT_STATUS_INITIAL")
- '("preparing" "GTK_PRINT_STATUS_PREPARING")
- '("generating-data" "GTK_PRINT_STATUS_GENERATING_DATA")
- '("sending-data" "GTK_PRINT_STATUS_SENDING_DATA")
- '("pending" "GTK_PRINT_STATUS_PENDING")
- '("pending-issue" "GTK_PRINT_STATUS_PENDING_ISSUE")
- '("printing" "GTK_PRINT_STATUS_PRINTING")
- '("finished" "GTK_PRINT_STATUS_FINISHED")
- '("finished-aborted" "GTK_PRINT_STATUS_FINISHED_ABORTED")
- )
-)
-
-(define-enum RecentChooserError
- (in-module "Gtk")
- (c-name "GtkRecentChooserError")
- (gtype-id "GTK_TYPE_RECENT_CHOOSER_ERROR")
- (values
- '("not-found" "GTK_RECENT_CHOOSER_ERROR_NOT_FOUND")
- '("invalid-uri" "GTK_RECENT_CHOOSER_ERROR_INVALID_URI")
- )
-)
-
-(define-enum RecentManagerError
- (in-module "Gtk")
- (c-name "GtkRecentManagerError")
- (gtype-id "GTK_TYPE_RECENT_MANAGER_ERROR")
- (values
- '("not-found" "GTK_RECENT_MANAGER_ERROR_NOT_FOUND")
- '("invalid-uri" "GTK_RECENT_MANAGER_ERROR_INVALID_URI")
- '("invalid-encoding" "GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING")
- '("not-registered" "GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED")
- '("read" "GTK_RECENT_MANAGER_ERROR_READ")
- '("write" "GTK_RECENT_MANAGER_ERROR_WRITE")
- '("unknown" "GTK_RECENT_MANAGER_ERROR_UNKNOWN")
- )
-)
-
-(define-enum RecentSortType
- (in-module "Gtk")
- (c-name "GtkRecentSortType")
- (gtype-id "GTK_TYPE_RECENT_SORT_TYPE")
- (values
- '("none" "GTK_RECENT_SORT_NONE")
- '("mru" "GTK_RECENT_SORT_MRU")
- '("lru" "GTK_RECENT_SORT_LRU")
- '("custom" "GTK_RECENT_SORT_CUSTOM")
- )
-)
-
-(define-enum SensitivityType
- (in-module "Gtk")
- (c-name "GtkSensitivityType")
- (gtype-id "GTK_TYPE_SENSITIVITY_TYPE")
- (values
- '("auto" "GTK_SENSITIVITY_AUTO")
- '("on" "GTK_SENSITIVITY_ON")
- '("off" "GTK_SENSITIVITY_OFF")
- )
-)
-
-(define-enum TextBufferTargetInfo
- (in-module "Gtk")
- (c-name "GtkTextBufferTargetInfo")
- (gtype-id "GTK_TYPE_TEXT_BUFFER_TARGET_INFO")
- (values
- '("buffer-contents" "GTK_TEXT_BUFFER_TARGET_INFO_BUFFER_CONTENTS")
- '("rich-text" "GTK_TEXT_BUFFER_TARGET_INFO_RICH_TEXT")
- '("text" "GTK_TEXT_BUFFER_TARGET_INFO_TEXT")
- )
-)
-
-(define-enum TreeViewGridLines
- (in-module "Gtk")
- (c-name "GtkTreeViewGridLines")
- (gtype-id "GTK_TYPE_TREE_VIEW_GRID_LINES")
- (values
- '("none" "GTK_TREE_VIEW_GRID_LINES_NONE")
- '("horizontal" "GTK_TREE_VIEW_GRID_LINES_HORIZONTAL")
- '("vertical" "GTK_TREE_VIEW_GRID_LINES_VERTICAL")
- '("both" "GTK_TREE_VIEW_GRID_LINES_BOTH")
- )
-)
-
-(define-enum Unit
- (in-module "Gtk")
- (c-name "GtkUnit")
- (gtype-id "GTK_TYPE_UNIT")
- (values
- '("pixel" "GTK_UNIT_PIXEL")
- '("points" "GTK_UNIT_POINTS")
- '("inch" "GTK_UNIT_INCH")
- '("mm" "GTK_UNIT_MM")
- )
-)
-
-;; Flags ...
-
-(define-flags RecentFilterFlags
- (in-module "Gtk")
- (c-name "GtkRecentFilterFlags")
- (gtype-id "GTK_TYPE_RECENT_FILTER_FLAGS")
- (values
- '("uri" "GTK_RECENT_FILTER_URI")
- '("display-name" "GTK_RECENT_FILTER_DISPLAY_NAME")
- '("mime-type" "GTK_RECENT_FILTER_MIME_TYPE")
- '("application" "GTK_RECENT_FILTER_APPLICATION")
- '("group" "GTK_RECENT_FILTER_GROUP")
- '("age" "GTK_RECENT_FILTER_AGE")
- )
-)
-
diff --git a/gtk/gtk-2.10.defs b/gtk/gtk-2.10.defs
deleted file mode 100644
index 00dbbe03..00000000
--- a/gtk/gtk-2.10.defs
+++ /dev/null
@@ -1,4122 +0,0 @@
-;; -*- scheme -*-
-
-(include "gtk-2.10-types.defs")
-
-;; From gtkaboutdialog.h
-
-
-
-;; From gtkaccelgroup.h
-
-
-
-;; From gtkaccellabel.h
-
-
-
-;; From gtkaccelmap.h
-
-
-
-;; From gtkaccessible.h
-
-
-
-;; From gtkactiongroup.h
-
-
-
-;; From gtkaction.h
-
-(define-method get_action
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_action")
- (return-type "GtkAction*")
-)
-
-(define-method get_accel_closure
- (of-object "GtkAction")
- (c-name "gtk_action_get_accel_closure")
- (return-type "GClosure*")
-)
-
-
-
-;; From gtkadjustment.h
-
-
-
-;; From gtkalignment.h
-
-
-
-;; From gtkarrow.h
-
-
-
-;; From gtkaspectframe.h
-
-
-
-;; From gtkassistant.h
-
-(define-function assistant_get_type
- (c-name "gtk_assistant_get_type")
- (return-type "GType")
-)
-
-(define-function assistant_new
- (c-name "gtk_assistant_new")
- (is-constructor-of "GtkAssistant")
- (return-type "GtkWidget*")
-)
-
-(define-method get_current_page
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_get_current_page")
- (return-type "gint")
-)
-
-(define-method set_current_page
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_set_current_page")
- (return-type "none")
- (parameters
- '("gint" "page_num")
- )
-)
-
-(define-method get_n_pages
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_get_n_pages")
- (return-type "gint")
-)
-
-(define-method get_nth_page
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_get_nth_page")
- (return-type "GtkWidget*")
- (parameters
- '("gint" "page_num")
- )
-)
-
-(define-method prepend_page
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_prepend_page")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "page")
- )
-)
-
-(define-method append_page
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_append_page")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "page")
- )
-)
-
-(define-method insert_page
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_insert_page")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "page")
- '("gint" "position")
- )
-)
-
-(define-method set_forward_page_func
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_set_forward_page_func")
- (return-type "none")
- (parameters
- '("GtkAssistantPageFunc" "page_func")
- '("gpointer" "data")
- '("GDestroyNotify" "destroy")
- )
-)
-
-(define-method set_page_type
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_set_page_type")
- (return-type "none")
- (parameters
- '("GtkWidget*" "page")
- '("GtkAssistantPageType" "type")
- )
-)
-
-(define-method get_page_type
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_get_page_type")
- (return-type "GtkAssistantPageType")
- (parameters
- '("GtkWidget*" "page")
- )
-)
-
-(define-method set_page_title
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_set_page_title")
- (return-type "none")
- (parameters
- '("GtkWidget*" "page")
- '("const-gchar*" "title")
- )
-)
-
-(define-method get_page_title
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_get_page_title")
- (return-type "const-gchar*")
- (parameters
- '("GtkWidget*" "page")
- )
-)
-
-(define-method set_page_header_image
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_set_page_header_image")
- (return-type "none")
- (parameters
- '("GtkWidget*" "page")
- '("GdkPixbuf*" "pixbuf" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_page_header_image
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_get_page_header_image")
- (return-type "GdkPixbuf*")
- (parameters
- '("GtkWidget*" "page")
- )
-)
-
-(define-method set_page_side_image
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_set_page_side_image")
- (return-type "none")
- (parameters
- '("GtkWidget*" "page")
- '("GdkPixbuf*" "pixbuf" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_page_side_image
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_get_page_side_image")
- (return-type "GdkPixbuf*")
- (parameters
- '("GtkWidget*" "page")
- )
-)
-
-(define-method set_page_complete
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_set_page_complete")
- (return-type "none")
- (parameters
- '("GtkWidget*" "page")
- '("gboolean" "complete")
- )
-)
-
-(define-method get_page_complete
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_get_page_complete")
- (return-type "gboolean")
- (parameters
- '("GtkWidget*" "page")
- )
-)
-
-(define-method add_action_widget
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_add_action_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method remove_action_widget
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_remove_action_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method update_buttons_state
- (of-object "GtkAssistant")
- (c-name "gtk_assistant_update_buttons_state")
- (return-type "none")
-)
-
-(define-virtual prepare
- (of-object "GtkAssistant")
- (return-type "none")
- (parameters
- '("GtkWidget*" "page")
- )
-)
-
-(define-virtual apply
- (of-object "GtkAssistant")
- (return-type "none")
-)
-
-(define-virtual close
- (of-object "GtkAssistant")
- (return-type "none")
-)
-
-(define-virtual cancel
- (of-object "GtkAssistant")
- (return-type "none")
-)
-
-
-
-
-;; From gtkbbox.h
-
-
-
-;; From gtkbindings.h
-
-
-
-;; From gtkbin.h
-
-
-
-;; From gtkbox.h
-
-
-
-;; From gtkbutton.h
-
-(define-method set_image_position
- (of-object "GtkButton")
- (c-name "gtk_button_set_image_position")
- (return-type "none")
- (parameters
- '("GtkPositionType" "position")
- )
-)
-
-(define-method get_image_position
- (of-object "GtkButton")
- (c-name "gtk_button_get_image_position")
- (return-type "GtkPositionType")
-)
-
-
-;; From gtkcalendar.h
-
-
-
-;; From gtkcelleditable.h
-
-
-
-;; From gtkcelllayout.h
-
-
-
-;; From gtkcellrendereraccel.h
-
-(define-function cell_renderer_accel_get_type
- (c-name "gtk_cell_renderer_accel_get_type")
- (return-type "GType")
-)
-
-(define-function cell_renderer_accel_new
- (c-name "gtk_cell_renderer_accel_new")
- (is-constructor-of "GtkCellRendererAccel")
- (return-type "GtkCellRenderer*")
-)
-
-(define-virtual accel_edited
- (of-object "GtkCellRendererAccel")
- (return-type "none")
- (parameters
- '("const-gchar*" "path_string")
- '("guint" "accel_key")
- '("GdkModifierType" "accel_mods")
- '("guint" "hardware_keycode")
- )
-)
-
-(define-virtual accel_cleared
- (of-object "GtkCellRendererAccel")
- (return-type "none")
- (parameters
- '("const-gchar*" "path_string")
- )
-)
-
-
-
-;; From gtkcellrenderercombo.h
-
-
-
-;; From gtkcellrenderer.h
-
-
-
-;; From gtkcellrendererpixbuf.h
-
-
-
-;; From gtkcellrendererprogress.h
-
-
-
-;; From gtkcellrendererspin.h
-
-(define-function cell_renderer_spin_get_type
- (c-name "gtk_cell_renderer_spin_get_type")
- (return-type "GType")
-)
-
-(define-function cell_renderer_spin_new
- (c-name "gtk_cell_renderer_spin_new")
- (is-constructor-of "GtkCellRendererSpin")
- (return-type "GtkCellRenderer*")
-)
-
-
-
-;; From gtkcellrenderertext.h
-
-
-
-;; From gtkcellrenderertoggle.h
-
-
-
-;; From gtkcellview.h
-
-
-
-;; From gtkcheckbutton.h
-
-
-
-;; From gtkcheckmenuitem.h
-
-
-
-;; From gtkclipboard.h
-
-(define-method request_rich_text
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_request_rich_text")
- (return-type "none")
- (parameters
- '("GtkTextBuffer*" "buffer")
- '("GtkClipboardRichTextReceivedFunc" "callback")
- '("gpointer" "user_data")
- )
-)
-
-(define-method wait_for_rich_text
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_wait_for_rich_text")
- (return-type "guint8*")
- (parameters
- '("GtkTextBuffer*" "buffer")
- '("GdkAtom*" "format")
- '("gsize*" "length")
- )
-)
-
-(define-method wait_is_rich_text_available
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_wait_is_rich_text_available")
- (return-type "gboolean")
- (parameters
- '("GtkTextBuffer*" "buffer")
- )
-)
-
-
-
-;; From gtkclist.h
-
-
-
-;; From gtkcolorbutton.h
-
-
-
-;; From gtkcolorseldialog.h
-
-
-
-;; From gtkcolorsel.h
-
-
-
-;; From gtkcomboboxentry.h
-
-
-
-;; From gtkcombobox.h
-
-(define-method get_title
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_title")
- (return-type "const-gchar*")
-)
-
-(define-method set_title
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_set_title")
- (return-type "none")
- (parameters
- '("const-gchar*" "title")
- )
-)
-
-
-
-;; From gtkcombo.h
-
-
-
-;; From gtkcontainer.h
-
-
-
-;; From gtkctree.h
-
-
-
-;; From gtkcurve.h
-
-
-
-;; From gtkdebug.h
-
-
-
-;; From gtkdialog.h
-
-
-
-;; From gtkdnd.h
-
-(define-method drag_dest_set_track_motion
- (of-object "GtkWidget")
- (c-name "gtk_drag_dest_set_track_motion")
- (return-type "none")
- (parameters
- '("gboolean" "track_motion")
- )
-)
-
-(define-method drag_dest_get_track_motion
- (of-object "GtkWidget")
- (c-name "gtk_drag_dest_get_track_motion")
- (return-type "gboolean")
-)
-
-
-
-;; From gtkdrawingarea.h
-
-
-
-;; From gtkeditable.h
-
-
-
-;; From gtkentrycompletion.h
-
-
-
-;; From gtkentry.h
-
-(define-method set_inner_border
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_inner_border")
- (return-type "none")
- (parameters
- '("const-GtkBorder*" "border" (null-ok))
- )
-)
-
-(define-method get_inner_border
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_inner_border")
- (return-type "const-GtkBorder*")
-)
-
-
-
-;; From gtkenums.h
-
-
-
-;; From gtkeventbox.h
-
-
-
-;; From gtkexpander.h
-
-
-
-;; From gtkfilechooserbutton.h
-
-(define-method get_focus_on_click
- (of-object "GtkFileChooserButton")
- (c-name "gtk_file_chooser_button_get_focus_on_click")
- (return-type "gboolean")
-)
-
-(define-method set_focus_on_click
- (of-object "GtkFileChooserButton")
- (c-name "gtk_file_chooser_button_set_focus_on_click")
- (return-type "none")
- (parameters
- '("gboolean" "focus_on_click")
- )
-)
-
-
-
-;; From gtkfilechooserdialog.h
-
-
-
-;; From gtkfilechooser.h
-
-
-
-;; From gtkfilechooserwidget.h
-
-
-
-;; From gtkfilefilter.h
-
-
-
-;; From gtkfilesel.h
-
-
-
-;; From gtkfilesystem.h
-
-(define-virtual get_info
- (of-object "GtkFileSystem")
- (return-type "GtkFileSystemHandle*")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GtkFileInfoType" "types")
- '("GtkFileSystemGetInfoCallback" "callback")
- '("gpointer" "data")
- )
-)
-
-(define-virtual cancel_operation
- (of-object "GtkFileSystem")
- (return-type "none")
-)
-
-
-
-;; From gtkfixed.h
-
-
-
-;; From gtkfontbutton.h
-
-
-
-;; From gtkfontsel.h
-
-
-
-;; From gtkframe.h
-
-
-
-;; From gtkgamma.h
-
-
-
-;; From gtkgc.h
-
-
-
-;; From gtk.h
-
-
-
-;; From gtkhandlebox.h
-
-
-
-;; From gtkhbbox.h
-
-
-
-;; From gtkhbox.h
-
-
-
-;; From gtkhpaned.h
-
-
-
-;; From gtkhruler.h
-
-
-
-;; From gtkhscale.h
-
-
-
-;; From gtkhscrollbar.h
-
-
-
-;; From gtkhseparator.h
-
-
-
-;; From gtkiconfactory.h
-
-
-
-;; From gtkicontheme.h
-
-
-
-;; From gtkiconview.h
-
-
-
-;; From gtkimage.h
-
-
-
-;; From gtkimagemenuitem.h
-
-
-
-;; From gtkimcontext.h
-
-
-
-;; From gtkimcontextsimple.h
-
-
-
-;; From gtkimmodule.h
-
-
-
-;; From gtkimmulticontext.h
-
-
-
-;; From gtkinputdialog.h
-
-
-
-;; From gtkinvisible.h
-
-
-
-;; From gtkitemfactory.h
-
-
-
-;; From gtkitem.h
-
-
-
-;; From gtklabel.h
-
-(define-method set_line_wrap_mode
- (of-object "GtkLabel")
- (c-name "gtk_label_set_line_wrap_mode")
- (return-type "none")
- (parameters
- '("PangoWrapMode" "wrap_mode")
- )
-)
-
-(define-method get_line_wrap_mode
- (of-object "GtkLabel")
- (c-name "gtk_label_get_line_wrap_mode")
- (return-type "PangoWrapMode")
-)
-
-
-
-;; From gtklayout.h
-
-
-
-;; From gtklinkbutton.h
-
-(define-function link_button_get_type
- (c-name "gtk_link_button_get_type")
- (return-type "GType")
-)
-
-(define-function link_button_new
- (c-name "gtk_link_button_new")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "uri")
- )
-)
-
-(define-function link_button_new_with_label
- (c-name "gtk_link_button_new_with_label")
- (is-constructor-of "GtkLinkButton")
- (return-type "GtkWidget*")
- (parameters
- '("gchar*" "uri")
- '("gchar*" "label" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_uri
- (of-object "GtkLinkButton")
- (c-name "gtk_link_button_get_uri")
- (return-type "const-gchar*")
-)
-
-(define-method set_uri
- (of-object "GtkLinkButton")
- (c-name "gtk_link_button_set_uri")
- (return-type "none")
- (parameters
- '("const-gchar*" "uri")
- )
-)
-
-(define-function link_button_set_uri_hook
- (c-name "gtk_link_button_set_uri_hook")
- (return-type "GtkLinkButtonUriFunc")
- (parameters
- '("GtkLinkButtonUriFunc" "func")
- '("gpointer" "data")
- '("GDestroyNotify" "destroy")
- )
-)
-
-
-
-;; From gtklist.h
-
-
-
-;; From gtklistitem.h
-
-
-
-;; From gtkliststore.h
-
-
-
-;; From gtkmain.h
-
-
-
-;; From gtkmarshal.h
-
-
-
-;; From gtkmenubar.h
-
-
-
-;; From gtkmenu.h
-
-
-
-;; From gtkmenuitem.h
-
-
-
-;; From gtkmenushell.h
-
-
-
-;; From gtkmenutoolbutton.h
-
-
-
-;; From gtkmessagedialog.h
-
-(define-method set_image
- (of-object "GtkMessageDialog")
- (c-name "gtk_message_dialog_set_image")
- (return-type "none")
- (parameters
- '("GtkWidget*" "image")
- )
-)
-
-
-;; From gtkmisc.h
-
-
-
-;; From gtkmodules.h
-
-
-
-;; From gtknotebook.h
-
-(define-function notebook_set_window_creation_hook
- (c-name "gtk_notebook_set_window_creation_hook")
- (return-type "none")
- (parameters
- '("GtkNotebookWindowCreationFunc" "func")
- '("gpointer" "data")
- '("GDestroyNotify" "destroy")
- )
-)
-
-(define-method set_group_id
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_group_id")
- (return-type "none")
- (parameters
- '("gint" "group_id")
- )
-)
-
-(define-method get_group_id
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_group_id")
- (return-type "gint")
-)
-
-(define-method get_tab_reorderable
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_tab_reorderable")
- (return-type "gboolean")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method set_tab_reorderable
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_tab_reorderable")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gboolean" "reorderable")
- )
-)
-
-(define-method get_tab_detachable
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_tab_detachable")
- (return-type "gboolean")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method set_tab_detachable
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_tab_detachable")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gboolean" "detachable")
- )
-)
-
-(define-virtual reorder_tab
- (of-object "GtkNotebook")
- (return-type "none")
- (parameters
- '("GtkDirectionType" "direction")
- '("gboolean" "move_to_last")
- )
-)
-
-(define-virtual insert_page
- (of-object "GtkNotebook")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "child")
- '("GtkWidget*" "tab_label")
- '("GtkWidget*" "menu_label")
- '("gint" "position")
- )
-)
-
-
-
-;; From gtkobject.h
-
-
-
-;; From gtkoldeditable.h
-
-
-
-;; From gtkoptionmenu.h
-
-
-
-;; From gtkpagesetup.h
-
-(define-function page_setup_get_type
- (c-name "gtk_page_setup_get_type")
- (return-type "GType")
-)
-
-(define-function page_setup_new
- (c-name "gtk_page_setup_new")
- (is-constructor-of "GtkPageSetup")
- (return-type "GtkPageSetup*")
-)
-
-(define-method copy
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_copy")
- (return-type "GtkPageSetup*")
-)
-
-(define-method get_orientation
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_get_orientation")
- (return-type "GtkPageOrientation")
-)
-
-(define-method set_orientation
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_set_orientation")
- (return-type "none")
- (parameters
- '("GtkPageOrientation" "orientation")
- )
-)
-
-(define-method get_paper_size
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_get_paper_size")
- (return-type "GtkPaperSize*")
-)
-
-(define-method set_paper_size
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_set_paper_size")
- (return-type "none")
- (parameters
- '("GtkPaperSize*" "size")
- )
-)
-
-(define-method get_top_margin
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_get_top_margin")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method set_top_margin
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_set_top_margin")
- (return-type "none")
- (parameters
- '("gdouble" "margin")
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_bottom_margin
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_get_bottom_margin")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method set_bottom_margin
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_set_bottom_margin")
- (return-type "none")
- (parameters
- '("gdouble" "margin")
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_left_margin
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_get_left_margin")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method set_left_margin
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_set_left_margin")
- (return-type "none")
- (parameters
- '("gdouble" "margin")
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_right_margin
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_get_right_margin")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method set_right_margin
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_set_right_margin")
- (return-type "none")
- (parameters
- '("gdouble" "margin")
- '("GtkUnit" "unit")
- )
-)
-
-(define-method set_paper_size_and_default_margins
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_set_paper_size_and_default_margins")
- (return-type "none")
- (parameters
- '("GtkPaperSize*" "size")
- )
-)
-
-(define-method get_paper_width
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_get_paper_width")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_paper_height
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_get_paper_height")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_page_width
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_get_page_width")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_page_height
- (of-object "GtkPageSetup")
- (c-name "gtk_page_setup_get_page_height")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-
-
-;; From gtkpaned.h
-
-
-
-;; From gtkpapersize.h
-
-(define-function paper_size_get_type
- (c-name "gtk_paper_size_get_type")
- (return-type "GType")
-)
-
-(define-function paper_size_new
- (c-name "gtk_paper_size_new")
- (is-constructor-of "GtkPaperSize")
- (return-type "GtkPaperSize*")
- (parameters
- '("const-gchar*" "name" (null-ok) (default "NULL"))
- )
-)
-
-(define-function paper_size_new_from_ppd
- (c-name "gtk_paper_size_new_from_ppd")
- (return-type "GtkPaperSize*")
- (parameters
- '("const-gchar*" "ppd_name")
- '("const-gchar*" "ppd_display_name")
- '("gdouble" "width")
- '("gdouble" "height")
- )
-)
-
-(define-function paper_size_new_custom
- (c-name "gtk_paper_size_new_custom")
- (return-type "GtkPaperSize*")
- (parameters
- '("const-gchar*" "name")
- '("const-gchar*" "display_name")
- '("gdouble" "width")
- '("gdouble" "height")
- '("GtkUnit" "unit")
- )
-)
-
-(define-method copy
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_copy")
- (return-type "GtkPaperSize*")
-)
-
-(define-method free
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_free")
- (return-type "none")
-)
-
-(define-method is_equal
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_is_equal")
- (return-type "gboolean")
- (parameters
- '("GtkPaperSize*" "size2")
- )
-)
-
-(define-method get_name
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_get_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_display_name
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_get_display_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_ppd_name
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_get_ppd_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_width
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_get_width")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_height
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_get_height")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method is_custom
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_is_custom")
- (return-type "gboolean")
-)
-
-(define-method set_size
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_set_size")
- (return-type "none")
- (parameters
- '("gdouble" "width")
- '("gdouble" "height")
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_default_top_margin
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_get_default_top_margin")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_default_bottom_margin
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_get_default_bottom_margin")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_default_left_margin
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_get_default_left_margin")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_default_right_margin
- (of-object "GtkPaperSize")
- (c-name "gtk_paper_size_get_default_right_margin")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-function paper_size_get_default
- (c-name "gtk_paper_size_get_default")
- (return-type "const-gchar*")
-)
-
-
-
-;; From gtkpixmap.h
-
-
-
-;; From gtkplug.h
-
-
-
-;; From gtkpreview.h
-
-
-
-;; From gtkprintcontext.h
-
-(define-function print_context_get_type
- (c-name "gtk_print_context_get_type")
- (return-type "GType")
-)
-
-(define-method get_cairo_context
- (of-object "GtkPrintContext")
- (c-name "gtk_print_context_get_cairo_context")
- (return-type "cairo_t*")
-)
-
-(define-method get_page_setup
- (of-object "GtkPrintContext")
- (c-name "gtk_print_context_get_page_setup")
- (return-type "GtkPageSetup*")
-)
-
-(define-method get_width
- (of-object "GtkPrintContext")
- (c-name "gtk_print_context_get_width")
- (return-type "gdouble")
-)
-
-(define-method get_height
- (of-object "GtkPrintContext")
- (c-name "gtk_print_context_get_height")
- (return-type "gdouble")
-)
-
-(define-method get_dpi_x
- (of-object "GtkPrintContext")
- (c-name "gtk_print_context_get_dpi_x")
- (return-type "gdouble")
-)
-
-(define-method get_dpi_y
- (of-object "GtkPrintContext")
- (c-name "gtk_print_context_get_dpi_y")
- (return-type "gdouble")
-)
-
-(define-method get_pango_fontmap
- (of-object "GtkPrintContext")
- (c-name "gtk_print_context_get_pango_fontmap")
- (return-type "PangoFontMap*")
-)
-
-(define-method create_pango_context
- (of-object "GtkPrintContext")
- (c-name "gtk_print_context_create_pango_context")
- (return-type "PangoContext*")
-)
-
-(define-method create_pango_layout
- (of-object "GtkPrintContext")
- (c-name "gtk_print_context_create_pango_layout")
- (return-type "PangoLayout*")
-)
-
-(define-method set_cairo_context
- (of-object "GtkPrintContext")
- (c-name "gtk_print_context_set_cairo_context")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("double" "dpi_x")
- '("double" "dpi_y")
- )
-)
-
-
-
-;; From gtkprintoperation.h
-
-(define-function print_error_quark
- (c-name "gtk_print_error_quark")
- (return-type "GQuark")
-)
-
-(define-function print_operation_get_type
- (c-name "gtk_print_operation_get_type")
- (return-type "GType")
-)
-
-(define-function print_operation_new
- (c-name "gtk_print_operation_new")
- (is-constructor-of "GtkPrintOperation")
- (return-type "GtkPrintOperation*")
-)
-
-(define-method set_default_page_setup
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_default_page_setup")
- (return-type "none")
- (parameters
- '("GtkPageSetup*" "default_page_setup" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_default_page_setup
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_get_default_page_setup")
- (return-type "GtkPageSetup*")
-)
-
-(define-method set_print_settings
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_print_settings")
- (return-type "none")
- (parameters
- '("GtkPrintSettings*" "print_settings" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_print_settings
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_get_print_settings")
- (return-type "GtkPrintSettings*")
-)
-
-(define-method set_job_name
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_job_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "job_name")
- )
-)
-
-(define-method set_n_pages
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_n_pages")
- (return-type "none")
- (parameters
- '("gint" "n_pages")
- )
-)
-
-(define-method set_current_page
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_current_page")
- (return-type "none")
- (parameters
- '("gint" "current_page")
- )
-)
-
-(define-method set_use_full_page
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_use_full_page")
- (return-type "none")
- (parameters
- '("gboolean" "full_page")
- )
-)
-
-(define-method set_unit
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_unit")
- (return-type "none")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method set_export_filename
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_export_filename")
- (return-type "none")
- (parameters
- '("const-gchar*" "filename")
- )
-)
-
-(define-method set_track_print_status
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_track_print_status")
- (return-type "none")
- (parameters
- '("gboolean" "track_status")
- )
-)
-
-(define-method set_show_progress
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_show_progress")
- (return-type "none")
- (parameters
- '("gboolean" "show_progress")
- )
-)
-
-(define-method set_allow_async
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_allow_async")
- (return-type "none")
- (parameters
- '("gboolean" "allow_async")
- )
-)
-
-(define-method set_custom_tab_label
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_set_custom_tab_label")
- (return-type "none")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-method run
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_run")
- (return-type "GtkPrintOperationResult")
- (parameters
- '("GtkPrintOperationAction" "action")
- '("GtkWindow*" "parent" (null-ok) (default "NULL"))
- '("GError**" "error")
- )
-)
-
-(define-method get_error
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_get_error")
- (return-type "none")
- (parameters
- '("GError**" "error")
- )
-)
-
-(define-method get_status
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_get_status")
- (return-type "GtkPrintStatus")
-)
-
-(define-method get_status_string
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_get_status_string")
- (return-type "const-gchar*")
-)
-
-(define-method is_finished
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_is_finished")
- (return-type "gboolean")
-)
-
-(define-method cancel
- (of-object "GtkPrintOperation")
- (c-name "gtk_print_operation_cancel")
- (return-type "none")
-)
-
-(define-function print_run_page_setup_dialog
- (c-name "gtk_print_run_page_setup_dialog")
- (return-type "GtkPageSetup*")
- (parameters
- '("GtkWindow*" "parent" (null-ok))
- '("GtkPageSetup*" "page_setup" (null-ok))
- '("GtkPrintSettings*" "settings")
- )
-)
-
-(define-function print_run_page_setup_dialog_async
- (c-name "gtk_print_run_page_setup_dialog_async")
- (return-type "none")
- (parameters
- '("GtkWindow*" "parent")
- '("GtkPageSetup*" "page_setup")
- '("GtkPrintSettings*" "settings")
- '("GtkPageSetupDoneFunc" "done_cb")
- '("gpointer" "data")
- )
-)
-
-(define-virtual done
- (of-object "GtkPrintOperation")
- (return-type "none")
- (parameters
- '("GtkPrintOperationResult" "result")
- )
-)
-
-(define-virtual begin_print
- (of-object "GtkPrintOperation")
- (return-type "none")
- (parameters
- '("GtkPrintContext*" "context")
- )
-)
-
-(define-virtual paginate
- (of-object "GtkPrintOperation")
- (return-type "gboolean")
- (parameters
- '("GtkPrintContext*" "context")
- )
-)
-
-(define-virtual request_page_setup
- (of-object "GtkPrintOperation")
- (return-type "none")
- (parameters
- '("GtkPrintContext*" "context")
- '("gint" "page_nr")
- '("GtkPageSetup*" "setup")
- )
-)
-
-(define-virtual draw_page
- (of-object "GtkPrintOperation")
- (return-type "none")
- (parameters
- '("GtkPrintContext*" "context")
- '("gint" "page_nr")
- )
-)
-
-(define-virtual end_print
- (of-object "GtkPrintOperation")
- (return-type "none")
- (parameters
- '("GtkPrintContext*" "context")
- )
-)
-
-(define-virtual status_changed
- (of-object "GtkPrintOperation")
- (return-type "none")
-)
-
-(define-virtual create_custom_widget
- (of-object "GtkPrintOperation")
- (return-type "GtkWidget*")
-)
-
-(define-virtual custom_widget_apply
- (of-object "GtkPrintOperation")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-virtual preview
- (of-object "GtkPrintOperation")
- (return-type "gboolean")
- (parameters
- '("GtkPrintOperationPreview*" "preview")
- '("GtkPrintContext*" "context")
- '("GtkWindow*" "parent")
- )
-)
-
-
-
-;; From gtkprintoperationpreview.h
-
-(define-function print_operation_preview_get_type
- (c-name "gtk_print_operation_preview_get_type")
- (return-type "GType")
-)
-
-(define-method render_page
- (of-object "GtkPrintOperationPreview")
- (c-name "gtk_print_operation_preview_render_page")
- (return-type "none")
- (parameters
- '("gint" "page_nr")
- )
-)
-
-(define-method end_preview
- (of-object "GtkPrintOperationPreview")
- (c-name "gtk_print_operation_preview_end_preview")
- (return-type "none")
-)
-
-(define-method is_selected
- (of-object "GtkPrintOperationPreview")
- (c-name "gtk_print_operation_preview_is_selected")
- (return-type "gboolean")
- (parameters
- '("gint" "page_nr")
- )
-)
-
-(define-virtual ready
- (of-object "GtkPrintOperationPreview")
- (return-type "none")
- (parameters
- '("GtkPrintContext*" "context")
- )
-)
-(define-virtual got_page_size
- (of-object "GtkPrintOperationPreview")
- (return-type "none")
- (parameters
- '("GtkPrintContext*" "context")
- '("GtkPageSetup*" "page_setup")
- )
-)
-(define-virtual render_page
- (of-object "GtkPrintOperationPreview")
- (return-type "none")
- (parameters
- '("gint" "page_nr")
- )
-)
-(define-virtual is_selected
- (of-object "GtkPrintOperationPreview")
- (return-type "gboolean")
- (parameters
- '("gint" "page_nr")
- )
-)
-(define-virtual end_preview
- (of-object "GtkPrintOperationPreview")
- (return-type "none")
-)
-
-
-;; From gtkprintsettings.h
-
-(define-function print_settings_get_type
- (c-name "gtk_print_settings_get_type")
- (return-type "GType")
-)
-
-(define-function print_settings_new
- (c-name "gtk_print_settings_new")
- (is-constructor-of "GtkPrintSettings")
- (return-type "GtkPrintSettings*")
-)
-
-(define-method copy
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_copy")
- (return-type "GtkPrintSettings*")
-)
-
-(define-method has_key
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_has_key")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "key")
- )
-)
-
-(define-method get
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get")
- (return-type "const-gchar*")
- (parameters
- '("const-gchar*" "key")
- )
-)
-
-(define-method set
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set")
- (return-type "none")
- (parameters
- '("const-gchar*" "key")
- '("const-gchar*" "value" (null-ok))
- )
-)
-
-(define-method unset
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_unset")
- (return-type "none")
- (parameters
- '("const-gchar*" "key")
- )
-)
-
-(define-method foreach
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_foreach")
- (return-type "none")
- (parameters
- '("GtkPrintSettingsFunc" "func")
- '("gpointer" "user_data" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_bool
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_bool")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "key")
- )
-)
-
-(define-method set_bool
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_bool")
- (return-type "none")
- (parameters
- '("const-gchar*" "key")
- '("gboolean" "value")
- )
-)
-
-(define-method get_double
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_double")
- (return-type "gdouble")
- (parameters
- '("const-gchar*" "key")
- )
-)
-
-(define-method get_double_with_default
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_double_with_default")
- (return-type "gdouble")
- (parameters
- '("const-gchar*" "key")
- '("gdouble" "def")
- )
-)
-
-(define-method set_double
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_double")
- (return-type "none")
- (parameters
- '("const-gchar*" "key")
- '("gdouble" "value")
- )
-)
-
-(define-method get_length
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_length")
- (return-type "gdouble")
- (parameters
- '("const-gchar*" "key")
- '("GtkUnit" "unit")
- )
-)
-
-(define-method set_length
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_length")
- (return-type "none")
- (parameters
- '("const-gchar*" "key")
- '("gdouble" "value")
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_int
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_int")
- (return-type "gint")
- (parameters
- '("const-gchar*" "key")
- )
-)
-
-(define-method get_int_with_default
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_int_with_default")
- (return-type "gint")
- (parameters
- '("const-gchar*" "key")
- '("gint" "def")
- )
-)
-
-(define-method set_int
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_int")
- (return-type "none")
- (parameters
- '("const-gchar*" "key")
- '("gint" "value")
- )
-)
-
-(define-method get_printer
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_printer")
- (return-type "const-gchar*")
-)
-
-(define-method set_printer
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_printer")
- (return-type "none")
- (parameters
- '("const-gchar*" "printer")
- )
-)
-
-(define-method get_orientation
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_orientation")
- (return-type "GtkPageOrientation")
-)
-
-(define-method set_orientation
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_orientation")
- (return-type "none")
- (parameters
- '("GtkPageOrientation" "orientation")
- )
-)
-
-(define-method get_paper_size
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_paper_size")
- (return-type "GtkPaperSize*")
-)
-
-(define-method set_paper_size
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_paper_size")
- (return-type "none")
- (parameters
- '("GtkPaperSize*" "paper_size")
- )
-)
-
-(define-method get_paper_width
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_paper_width")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method set_paper_width
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_paper_width")
- (return-type "none")
- (parameters
- '("gdouble" "width")
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_paper_height
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_paper_height")
- (return-type "gdouble")
- (parameters
- '("GtkUnit" "unit")
- )
-)
-
-(define-method set_paper_height
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_paper_height")
- (return-type "none")
- (parameters
- '("gdouble" "height")
- '("GtkUnit" "unit")
- )
-)
-
-(define-method get_use_color
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_use_color")
- (return-type "gboolean")
-)
-
-(define-method set_use_color
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_use_color")
- (return-type "none")
- (parameters
- '("gboolean" "use_color")
- )
-)
-
-(define-method get_collate
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_collate")
- (return-type "gboolean")
-)
-
-(define-method set_collate
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_collate")
- (return-type "none")
- (parameters
- '("gboolean" "collate")
- )
-)
-
-(define-method get_reverse
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_reverse")
- (return-type "gboolean")
-)
-
-(define-method set_reverse
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_reverse")
- (return-type "none")
- (parameters
- '("gboolean" "reverse")
- )
-)
-
-(define-method get_duplex
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_duplex")
- (return-type "GtkPrintDuplex")
-)
-
-(define-method set_duplex
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_duplex")
- (return-type "none")
- (parameters
- '("GtkPrintDuplex" "duplex")
- )
-)
-
-(define-method get_quality
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_quality")
- (return-type "GtkPrintQuality")
-)
-
-(define-method set_quality
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_quality")
- (return-type "none")
- (parameters
- '("GtkPrintQuality" "quality")
- )
-)
-
-(define-method get_n_copies
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_n_copies")
- (return-type "gint")
-)
-
-(define-method set_n_copies
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_n_copies")
- (return-type "none")
- (parameters
- '("gint" "num_copies")
- )
-)
-
-(define-method get_number_up
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_number_up")
- (return-type "gint")
-)
-
-(define-method set_number_up
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_number_up")
- (return-type "none")
- (parameters
- '("gint" "number_up")
- )
-)
-
-(define-method get_resolution
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_resolution")
- (return-type "gint")
-)
-
-(define-method set_resolution
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_resolution")
- (return-type "none")
- (parameters
- '("gint" "resolution")
- )
-)
-
-(define-method get_scale
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_scale")
- (return-type "gdouble")
-)
-
-(define-method set_scale
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_scale")
- (return-type "none")
- (parameters
- '("gdouble" "scale")
- )
-)
-
-(define-method get_print_pages
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_print_pages")
- (return-type "GtkPrintPages")
-)
-
-(define-method set_print_pages
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_print_pages")
- (return-type "none")
- (parameters
- '("GtkPrintPages" "pages")
- )
-)
-
-(define-method get_page_ranges
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_page_ranges")
- (return-type "GtkPageRange*")
- (parameters
- '("gint*" "num_ranges")
- )
-)
-
-(define-method set_page_ranges
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_page_ranges")
- (return-type "none")
- (parameters
- '("GtkPageRange*" "page_ranges")
- '("gint" "num_ranges")
- )
-)
-
-(define-method get_page_set
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_page_set")
- (return-type "GtkPageSet")
-)
-
-(define-method set_page_set
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_page_set")
- (return-type "none")
- (parameters
- '("GtkPageSet" "page_set")
- )
-)
-
-(define-method get_default_source
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_default_source")
- (return-type "const-gchar*")
-)
-
-(define-method set_default_source
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_default_source")
- (return-type "none")
- (parameters
- '("const-gchar*" "default_source")
- )
-)
-
-(define-method get_media_type
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_media_type")
- (return-type "const-gchar*")
-)
-
-(define-method set_media_type
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_media_type")
- (return-type "none")
- (parameters
- '("const-gchar*" "media_type")
- )
-)
-
-(define-method get_dither
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_dither")
- (return-type "const-gchar*")
-)
-
-(define-method set_dither
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_dither")
- (return-type "none")
- (parameters
- '("const-gchar*" "dither")
- )
-)
-
-(define-method get_finishings
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_finishings")
- (return-type "const-gchar*")
-)
-
-(define-method set_finishings
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_finishings")
- (return-type "none")
- (parameters
- '("const-gchar*" "finishings")
- )
-)
-
-(define-method get_output_bin
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_get_output_bin")
- (return-type "const-gchar*")
-)
-
-(define-method set_output_bin
- (of-object "GtkPrintSettings")
- (c-name "gtk_print_settings_set_output_bin")
- (return-type "none")
- (parameters
- '("const-gchar*" "output_bin")
- )
-)
-
-
-
-;; From gtkprivate.h
-
-
-
-;; From gtkprogressbar.h
-
-
-
-;; From gtkprogress.h
-
-
-
-;; From gtkradioaction.h
-
-(define-method set_current_value
- (of-object "GtkRadioAction")
- (c-name "gtk_radio_action_set_current_value")
- (return-type "none")
- (parameters
- '("gint" "current_value")
- )
-)
-
-
-
-;; From gtkradiobutton.h
-
-
-
-;; From gtkradiomenuitem.h
-
-
-
-;; From gtkradiotoolbutton.h
-
-
-
-;; From gtkrange.h
-
-(define-method set_lower_stepper_sensitivity
- (of-object "GtkRange")
- (c-name "gtk_range_set_lower_stepper_sensitivity")
- (return-type "none")
- (parameters
- '("GtkSensitivityType" "sensitivity")
- )
-)
-
-(define-method get_lower_stepper_sensitivity
- (of-object "GtkRange")
- (c-name "gtk_range_get_lower_stepper_sensitivity")
- (return-type "GtkSensitivityType")
-)
-
-(define-method set_upper_stepper_sensitivity
- (of-object "GtkRange")
- (c-name "gtk_range_set_upper_stepper_sensitivity")
- (return-type "none")
- (parameters
- '("GtkSensitivityType" "sensitivity")
- )
-)
-
-(define-method get_upper_stepper_sensitivity
- (of-object "GtkRange")
- (c-name "gtk_range_get_upper_stepper_sensitivity")
- (return-type "GtkSensitivityType")
-)
-
-
-
-;; From gtkrc.h
-
-
-
-;; From gtkrecentchooserdialog.h
-
-(define-function recent_chooser_dialog_get_type
- (c-name "gtk_recent_chooser_dialog_get_type")
- (return-type "GType")
-)
-
-(define-function recent_chooser_dialog_new
- (c-name "gtk_recent_chooser_dialog_new")
- (is-constructor-of "GtkRecentChooserDialog")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "title")
- '("GtkWindow*" "parent")
- '("const-gchar*" "first_button_text")
- )
- (varargs #t)
-)
-
-(define-function recent_chooser_dialog_new_for_manager
- (c-name "gtk_recent_chooser_dialog_new_for_manager")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "title")
- '("GtkWindow*" "parent")
- '("GtkRecentManager*" "manager")
- '("const-gchar*" "first_button_text")
- )
- (varargs #t)
-)
-
-
-
-;; From gtkrecentchooser.h
-
-(define-function recent_chooser_error_quark
- (c-name "gtk_recent_chooser_error_quark")
- (return-type "GQuark")
-)
-
-(define-function recent_chooser_get_type
- (c-name "gtk_recent_chooser_get_type")
- (return-type "GType")
-)
-
-(define-method set_show_private
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_show_private")
- (return-type "none")
- (parameters
- '("gboolean" "show_private")
- )
-)
-
-(define-method get_show_private
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_show_private")
- (return-type "gboolean")
-)
-
-(define-method set_show_not_found
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_show_not_found")
- (return-type "none")
- (parameters
- '("gboolean" "show_not_found")
- )
-)
-
-(define-method get_show_not_found
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_show_not_found")
- (return-type "gboolean")
-)
-
-(define-method set_select_multiple
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_select_multiple")
- (return-type "none")
- (parameters
- '("gboolean" "select_multiple")
- )
-)
-
-(define-method get_select_multiple
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_select_multiple")
- (return-type "gboolean")
-)
-
-(define-method set_limit
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_limit")
- (return-type "none")
- (parameters
- '("gint" "limit")
- )
-)
-
-(define-method get_limit
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_limit")
- (return-type "gint")
-)
-
-(define-method set_local_only
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_local_only")
- (return-type "none")
- (parameters
- '("gboolean" "local_only")
- )
-)
-
-(define-method get_local_only
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_local_only")
- (return-type "gboolean")
-)
-
-(define-method set_show_tips
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_show_tips")
- (return-type "none")
- (parameters
- '("gboolean" "show_tips")
- )
-)
-
-(define-method get_show_tips
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_show_tips")
- (return-type "gboolean")
-)
-
-(define-method set_show_numbers
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_show_numbers")
- (return-type "none")
- (parameters
- '("gboolean" "show_numbers")
- )
-)
-
-(define-method get_show_numbers
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_show_numbers")
- (return-type "gboolean")
-)
-
-(define-method set_show_icons
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_show_icons")
- (return-type "none")
- (parameters
- '("gboolean" "show_icons")
- )
-)
-
-(define-method get_show_icons
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_show_icons")
- (return-type "gboolean")
-)
-
-(define-method set_sort_type
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_sort_type")
- (return-type "none")
- (parameters
- '("GtkRecentSortType" "sort_type")
- )
-)
-
-(define-method get_sort_type
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_sort_type")
- (return-type "GtkRecentSortType")
-)
-
-(define-method set_sort_func
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_sort_func")
- (return-type "none")
- (parameters
- '("GtkRecentSortFunc" "sort_func")
- '("gpointer" "sort_data")
- '("GDestroyNotify" "data_destroy")
- )
-)
-
-(define-method set_current_uri
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_current_uri")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "uri")
- '("GError**" "error")
- )
-)
-
-(define-method get_current_uri
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_current_uri")
- (return-type "gchar*")
-)
-
-(define-method get_current_item
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_current_item")
- (return-type "GtkRecentInfo*")
-)
-
-(define-method select_uri
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_select_uri")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "uri")
- '("GError**" "error")
- )
-)
-
-(define-method unselect_uri
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_unselect_uri")
- (return-type "none")
- (parameters
- '("const-gchar*" "uri")
- )
-)
-
-(define-method select_all
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_select_all")
- (return-type "none")
-)
-
-(define-method unselect_all
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_unselect_all")
- (return-type "none")
-)
-
-(define-method get_items
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_items")
- (return-type "GList*")
-)
-
-(define-method get_uris
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_uris")
- (return-type "gchar**")
- (parameters
- '("gsize*" "length")
- )
-)
-
-(define-method add_filter
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_add_filter")
- (return-type "none")
- (parameters
- '("GtkRecentFilter*" "filter")
- )
-)
-
-(define-method remove_filter
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_remove_filter")
- (return-type "none")
- (parameters
- '("GtkRecentFilter*" "filter")
- )
-)
-
-(define-method list_filters
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_list_filters")
- (return-type "GSList*")
-)
-
-(define-method set_filter
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_set_filter")
- (return-type "none")
- (parameters
- '("GtkRecentFilter*" "filter")
- )
-)
-
-(define-method get_filter
- (of-object "GtkRecentChooser")
- (c-name "gtk_recent_chooser_get_filter")
- (return-type "GtkRecentFilter*")
-)
-
-(define-virtual set_current_uri
- (of-object "GtkRecentChooser")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "uri")
- '("GError**" "error")
- )
-)
-(define-virtual get_current_uri
- (of-object "GtkRecentChooser")
- (return-type "gchar*")
-)
-(define-virtual select_uri
- (of-object "GtkRecentChooser")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "uri")
- '("GError**" "error")
- )
-)
-(define-virtual unselect_uri
- (of-object "GtkRecentChooser")
- (return-type "none")
- (parameters
- '("const-gchar*" "uri")
- )
-)
-(define-virtual select_all
- (of-object "GtkRecentChooser")
- (return-type "none")
-)
-(define-virtual unselect_all
- (of-object "GtkRecentChooser")
- (return-type "none")
-)
-(define-virtual get_items
- (of-object "GtkRecentChooser")
- (return-type "GList*")
-)
-(define-virtual get_recent_manager
- (of-object "GtkRecentChooser")
- (return-type "GtkRecentManager*")
-)
-(define-virtual add_filter
- (of-object "GtkRecentChooser")
- (return-type "none")
- (parameters
- '("GtkRecentFilter*" "filter")
- )
-)
-(define-virtual remove_filter
- (of-object "GtkRecentChooser")
- (return-type "none")
- (parameters
- '("GtkRecentFilter*" "filter")
- )
-)
-(define-virtual list_filters
- (of-object "GtkRecentChooser")
- (return-type "GSList*")
-)
-(define-virtual set_sort_func
- (of-object "GtkRecentChooser")
- (return-type "none")
- (parameters
- '("GtkRecentSortFunc" "sort_func")
- '("gpointer" "data")
- '("GDestroyNotify" "destroy")
- )
-)
-(define-virtual item_activated
- (of-object "GtkRecentChooser")
- (return-type "none")
-)
-(define-virtual selection_changed
- (of-object "GtkRecentChooser")
- (return-type "none")
-)
-
-
-;; From gtkrecentchoosermenu.h
-
-(define-function recent_chooser_menu_get_type
- (c-name "gtk_recent_chooser_menu_get_type")
- (return-type "GType")
-)
-
-(define-function recent_chooser_menu_new
- (c-name "gtk_recent_chooser_menu_new")
- (return-type "GtkWidget*")
-)
-
-(define-function recent_chooser_menu_new_for_manager
- (c-name "gtk_recent_chooser_menu_new_for_manager")
- (is-constructor-of "GtkRecentChooserMenu")
- (return-type "GtkWidget*")
- (properties
- '("recent-manager" (argname "manager") (optional))
- )
-)
-
-(define-method get_show_numbers
- (of-object "GtkRecentChooserMenu")
- (c-name "gtk_recent_chooser_menu_get_show_numbers")
- (return-type "gboolean")
-)
-
-(define-method set_show_numbers
- (of-object "GtkRecentChooserMenu")
- (c-name "gtk_recent_chooser_menu_set_show_numbers")
- (return-type "none")
- (parameters
- '("gboolean" "show_numbers")
- )
-)
-
-
-
-;; From gtkrecentchooserwidget.h
-
-(define-function recent_chooser_widget_get_type
- (c-name "gtk_recent_chooser_widget_get_type")
- (return-type "GType")
-)
-
-(define-function recent_chooser_widget_new
- (c-name "gtk_recent_chooser_widget_new")
- (return-type "GtkWidget*")
-)
-
-(define-function recent_chooser_widget_new_for_manager
- (c-name "gtk_recent_chooser_widget_new_for_manager")
- (is-constructor-of "GtkRecentChooserWidget")
- (return-type "GtkWidget*")
- (properties
- '("recent-manager" (argname "manager") (optional))
- )
-)
-
-
-
-;; From gtkrecentfilter.h
-
-(define-function recent_filter_get_type
- (c-name "gtk_recent_filter_get_type")
- (return-type "GType")
-)
-
-(define-function recent_filter_new
- (c-name "gtk_recent_filter_new")
- (is-constructor-of "GtkRecentFilter")
- (return-type "GtkRecentFilter*")
-)
-
-(define-method set_name
- (of-object "GtkRecentFilter")
- (c-name "gtk_recent_filter_set_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method get_name
- (of-object "GtkRecentFilter")
- (c-name "gtk_recent_filter_get_name")
- (return-type "const-gchar*")
-)
-
-(define-method add_mime_type
- (of-object "GtkRecentFilter")
- (c-name "gtk_recent_filter_add_mime_type")
- (return-type "none")
- (parameters
- '("const-gchar*" "mime_type")
- )
-)
-
-(define-method add_pattern
- (of-object "GtkRecentFilter")
- (c-name "gtk_recent_filter_add_pattern")
- (return-type "none")
- (parameters
- '("const-gchar*" "pattern")
- )
-)
-
-(define-method add_pixbuf_formats
- (of-object "GtkRecentFilter")
- (c-name "gtk_recent_filter_add_pixbuf_formats")
- (return-type "none")
-)
-
-(define-method add_application
- (of-object "GtkRecentFilter")
- (c-name "gtk_recent_filter_add_application")
- (return-type "none")
- (parameters
- '("const-gchar*" "application")
- )
-)
-
-(define-method add_group
- (of-object "GtkRecentFilter")
- (c-name "gtk_recent_filter_add_group")
- (return-type "none")
- (parameters
- '("const-gchar*" "group")
- )
-)
-
-(define-method add_age
- (of-object "GtkRecentFilter")
- (c-name "gtk_recent_filter_add_age")
- (return-type "none")
- (parameters
- '("gint" "days")
- )
-)
-
-(define-method add_custom
- (of-object "GtkRecentFilter")
- (c-name "gtk_recent_filter_add_custom")
- (return-type "none")
- (parameters
- '("GtkRecentFilterFlags" "needed")
- '("GtkRecentFilterFunc" "func")
- '("gpointer" "data")
- '("GDestroyNotify" "data_destroy")
- )
-)
-
-(define-method get_needed
- (of-object "GtkRecentFilter")
- (c-name "gtk_recent_filter_get_needed")
- (return-type "GtkRecentFilterFlags")
-)
-
-(define-method filter
- (of-object "GtkRecentFilter")
- (c-name "gtk_recent_filter_filter")
- (return-type "gboolean")
- (parameters
- '("const-GtkRecentFilterInfo*" "filter_info")
- )
-)
-
-
-
-;; From gtkrecentmanager.h
-
-(define-function recent_manager_error_quark
- (c-name "gtk_recent_manager_error_quark")
- (return-type "GQuark")
-)
-
-(define-function recent_manager_get_type
- (c-name "gtk_recent_manager_get_type")
- (return-type "GType")
-)
-
-(define-function recent_manager_new
- (c-name "gtk_recent_manager_new")
- (is-constructor-of "GtkRecentManager")
- (return-type "GtkRecentManager*")
-)
-
-(define-function recent_manager_get_default
- (c-name "gtk_recent_manager_get_default")
- (return-type "GtkRecentManager*")
-)
-
-(define-function recent_manager_get_for_screen
- (c-name "gtk_recent_manager_get_for_screen")
- (return-type "GtkRecentManager*")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-method set_screen
- (of-object "GtkRecentManager")
- (c-name "gtk_recent_manager_set_screen")
- (return-type "none")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-method add_item
- (of-object "GtkRecentManager")
- (c-name "gtk_recent_manager_add_item")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "uri")
- )
-)
-
-(define-method add_full
- (of-object "GtkRecentManager")
- (c-name "gtk_recent_manager_add_full")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "uri")
- '("const-GtkRecentData*" "recent_data")
- )
-)
-
-(define-method remove_item
- (of-object "GtkRecentManager")
- (c-name "gtk_recent_manager_remove_item")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "uri")
- '("GError**" "error")
- )
-)
-
-(define-method lookup_item
- (of-object "GtkRecentManager")
- (c-name "gtk_recent_manager_lookup_item")
- (return-type "GtkRecentInfo*")
- (parameters
- '("const-gchar*" "uri")
- '("GError**" "error")
- )
-)
-
-(define-method has_item
- (of-object "GtkRecentManager")
- (c-name "gtk_recent_manager_has_item")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "uri")
- )
-)
-
-(define-method move_item
- (of-object "GtkRecentManager")
- (c-name "gtk_recent_manager_move_item")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "uri")
- '("const-gchar*" "new_uri")
- '("GError**" "error")
- )
-)
-
-(define-method set_limit
- (of-object "GtkRecentManager")
- (c-name "gtk_recent_manager_set_limit")
- (return-type "none")
- (parameters
- '("gint" "limit")
- )
-)
-
-(define-method get_limit
- (of-object "GtkRecentManager")
- (c-name "gtk_recent_manager_get_limit")
- (return-type "gint")
-)
-
-(define-method get_items
- (of-object "GtkRecentManager")
- (c-name "gtk_recent_manager_get_items")
- (return-type "GList*")
-)
-
-(define-method purge_items
- (of-object "GtkRecentManager")
- (c-name "gtk_recent_manager_purge_items")
- (return-type "gint")
- (parameters
- '("GError**" "error")
- )
-)
-
-(define-function recent_info_get_type
- (c-name "gtk_recent_info_get_type")
- (return-type "GType")
-)
-
-(define-method ref
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_ref")
- (return-type "GtkRecentInfo*")
-)
-
-(define-method unref
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_unref")
- (return-type "none")
-)
-
-(define-method get_uri
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_uri")
- (return-type "const-gchar*")
-)
-
-(define-method get_display_name
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_display_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_description
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_description")
- (return-type "const-gchar*")
-)
-
-(define-method get_mime_type
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_mime_type")
- (return-type "const-gchar*")
-)
-
-(define-method get_added
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_added")
- (return-type "time_t")
-)
-
-(define-method get_modified
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_modified")
- (return-type "time_t")
-)
-
-(define-method get_visited
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_visited")
- (return-type "time_t")
-)
-
-(define-method get_private_hint
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_private_hint")
- (return-type "gboolean")
-)
-
-(define-method get_application_info
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_application_info")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "app_name")
- '("gchar**" "app_exec")
- '("guint*" "count")
- '("time_t*" "time_")
- )
-)
-
-(define-method get_applications
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_applications")
- (return-type "gchar**")
- (parameters
- '("gsize*" "length")
- )
-)
-
-(define-method last_application
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_last_application")
- (return-type "gchar*")
-)
-
-(define-method has_application
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_has_application")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "app_name")
- )
-)
-
-(define-method get_groups
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_groups")
- (return-type "gchar**")
- (parameters
- '("gsize*" "length")
- )
-)
-
-(define-method has_group
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_has_group")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "group_name")
- )
-)
-
-(define-method get_icon
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_icon")
- (return-type "GdkPixbuf*")
- (parameters
- '("gint" "size")
- )
-)
-
-(define-method get_short_name
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_short_name")
- (return-type "gchar*")
-)
-
-(define-method get_uri_display
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_uri_display")
- (return-type "gchar*")
-)
-
-(define-method get_age
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_get_age")
- (return-type "gint")
-)
-
-(define-method is_local
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_is_local")
- (return-type "gboolean")
-)
-
-(define-method exists
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_exists")
- (return-type "gboolean")
-)
-
-(define-method match
- (of-object "GtkRecentInfo")
- (c-name "gtk_recent_info_match")
- (return-type "gboolean")
- (parameters
- '("GtkRecentInfo*" "info_b")
- )
-)
-
-(define-virtual changed
- (of-object "GtkRecentManager")
- (return-type "none")
-)
-
-
-
-;; From gtkruler.h
-
-
-
-;; From gtkscale.h
-
-
-
-;; From gtkscrollbar.h
-
-
-
-;; From gtkscrolledwindow.h
-
-(define-method unset_placement
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_unset_placement")
- (return-type "none")
-)
-
-
-
-;; From gtkselection.h
-
-(define-function target_list_add_rich_text_targets
- (c-name "gtk_target_list_add_rich_text_targets")
- (return-type "none")
- (parameters
- '("guint" "info")
- '("gboolean" "deserializable")
- '("GtkTextBuffer*" "buffer")
- )
-)
-
-(define-function target_table_new_from_list
- (c-name "gtk_target_table_new_from_list")
- (return-type "GtkTargetEntry*")
- (parameters
- '("GtkTargetList*" "list")
- '("gint*" "n_targets")
- )
-)
-
-(define-function target_table_free
- (c-name "gtk_target_table_free")
- (return-type "none")
- (parameters
- '("GtkTargetEntry*" "targets")
- '("gint" "n_targets")
- )
-)
-
-(define-method targets_include_rich_text
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_targets_include_rich_text")
- (return-type "gboolean")
- (parameters
- '("GtkTextBuffer*" "buffer")
- )
-)
-
-(define-method targets_include_uri
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_targets_include_uri")
- (return-type "gboolean")
-)
-
-(define-function targets_include_text
- (c-name "gtk_targets_include_text")
- (return-type "gboolean")
- (parameters
- '("GdkAtom*" "targets")
- '("gint" "n_targets")
- )
-)
-
-(define-function targets_include_rich_text
- (c-name "gtk_targets_include_rich_text")
- (return-type "gboolean")
- (parameters
- '("GdkAtom*" "targets")
- '("gint" "n_targets")
- '("GtkTextBuffer*" "buffer")
- )
-)
-
-(define-function targets_include_image
- (c-name "gtk_targets_include_image")
- (return-type "gboolean")
- (parameters
- '("GdkAtom*" "targets")
- '("gint" "n_targets")
- '("gboolean" "writable")
- )
-)
-
-(define-function targets_include_uri
- (c-name "gtk_targets_include_uri")
- (return-type "gboolean")
- (parameters
- '("GdkAtom*" "targets")
- '("gint" "n_targets")
- )
-)
-
-(define-function target_list_get_type
- (c-name "gtk_target_list_get_type")
- (return-type "GType")
-)
-
-
-
-;; From gtkseparator.h
-
-
-
-;; From gtkseparatormenuitem.h
-
-
-
-;; From gtkseparatortoolitem.h
-
-
-
-;; From gtksettings.h
-
-
-
-;; From gtksignal.h
-
-
-
-;; From gtksizegroup.h
-
-(define-method get_widgets
- (of-object "GtkSizeGroup")
- (c-name "gtk_size_group_get_widgets")
- (return-type "GSList*")
-)
-
-
-
-;; From gtksocket.h
-
-
-
-;; From gtkspinbutton.h
-
-(define-virtual wrapped
- (of-object "GtkSpinButton")
- (return-type "none")
-)
-
-
-
-;; From gtkstatusbar.h
-
-
-
-;; From gtkstatusicon.h
-
-(define-function status_icon_get_type
- (c-name "gtk_status_icon_get_type")
- (return-type "GType")
-)
-
-(define-function status_icon_new
- (c-name "gtk_status_icon_new")
- (is-constructor-of "GtkStatusIcon")
- (return-type "GtkStatusIcon*")
-)
-
-(define-function status_icon_new_from_pixbuf
- (c-name "gtk_status_icon_new_from_pixbuf")
- (return-type "GtkStatusIcon*")
- (parameters
- '("GdkPixbuf*" "pixbuf")
- )
-)
-
-(define-function status_icon_new_from_file
- (c-name "gtk_status_icon_new_from_file")
- (return-type "GtkStatusIcon*")
- (parameters
- '("const-gchar*" "filename")
- )
-)
-
-(define-function status_icon_new_from_stock
- (c-name "gtk_status_icon_new_from_stock")
- (return-type "GtkStatusIcon*")
- (parameters
- '("const-gchar*" "stock_id")
- )
-)
-
-(define-function status_icon_new_from_icon_name
- (c-name "gtk_status_icon_new_from_icon_name")
- (return-type "GtkStatusIcon*")
- (parameters
- '("const-gchar*" "icon_name")
- )
-)
-
-(define-method set_from_pixbuf
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_set_from_pixbuf")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "pixbuf" (null-ok))
- )
-)
-
-(define-method set_from_file
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_set_from_file")
- (return-type "none")
- (parameters
- '("const-gchar*" "filename")
- )
-)
-
-(define-method set_from_stock
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_set_from_stock")
- (return-type "none")
- (parameters
- '("const-gchar*" "stock_id")
- )
-)
-
-(define-method set_from_icon_name
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_set_from_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "icon_name")
- )
-)
-
-(define-method get_storage_type
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_get_storage_type")
- (return-type "GtkImageType")
-)
-
-(define-method get_pixbuf
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_get_pixbuf")
- (return-type "GdkPixbuf*")
-)
-
-(define-method get_stock
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_get_stock")
- (return-type "const-gchar*")
-)
-
-(define-method get_icon_name
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_get_icon_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_size
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_get_size")
- (return-type "gint")
-)
-
-(define-method set_tooltip
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_set_tooltip")
- (return-type "none")
- (parameters
- '("const-gchar*" "tooltip_text" (null-ok))
- )
-)
-
-(define-method set_visible
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_set_visible")
- (return-type "none")
- (parameters
- '("gboolean" "visible")
- )
-)
-
-(define-method get_visible
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_get_visible")
- (return-type "gboolean")
-)
-
-(define-method set_blinking
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_set_blinking")
- (return-type "none")
- (parameters
- '("gboolean" "blinking")
- )
-)
-
-(define-method get_blinking
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_get_blinking")
- (return-type "gboolean")
-)
-
-(define-method is_embedded
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_is_embedded")
- (return-type "gboolean")
-)
-
-(define-function status_icon_position_menu
- (c-name "gtk_status_icon_position_menu")
- (return-type "none")
- (parameters
- '("GtkMenu*" "menu")
- '("gint*" "x")
- '("gint*" "y")
- '("gboolean*" "push_in")
- '("gpointer" "user_data")
- )
-)
-
-(define-method get_geometry
- (of-object "GtkStatusIcon")
- (c-name "gtk_status_icon_get_geometry")
- (return-type "gboolean")
- (parameters
- '("GdkScreen**" "screen")
- '("GdkRectangle*" "area")
- '("GtkOrientation*" "orientation")
- )
-)
-
-(define-virtual activate
- (of-object "GtkStatusIcon")
- (return-type "none")
-)
-
-(define-virtual popup_menu
- (of-object "GtkStatusIcon")
- (return-type "none")
- (parameters
- '("guint" "button")
- '("guint32" "activate_time")
- )
-)
-
-(define-virtual size_changed
- (of-object "GtkStatusIcon")
- (return-type "gboolean")
- (parameters
- '("gint" "size")
- )
-)
-
-
-
-;; From gtkstock.h
-
-
-
-;; From gtkstyle.h
-
-(define-method lookup_color
- (of-object "GtkStyle")
- (c-name "gtk_style_lookup_color")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "color_name")
- '("GdkColor*" "color")
- )
-)
-
-
-
-;; From gtktable.h
-
-
-
-;; From gtktearoffmenuitem.h
-
-
-
-;; From gtktextbuffer.h
-
-(define-method get_has_selection
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_has_selection")
- (return-type "gboolean")
-)
-
-(define-method get_copy_target_list
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_copy_target_list")
- (return-type "GtkTargetList*")
-)
-
-(define-method get_paste_target_list
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_paste_target_list")
- (return-type "GtkTargetList*")
-)
-
-
-
-;; From gtktextbufferrichtext.h
-
-(define-method register_serialize_format
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_register_serialize_format")
- (return-type "GdkAtom")
- (parameters
- '("const-gchar*" "mime_type")
- '("GtkTextBufferSerializeFunc" "function")
- '("gpointer" "user_data")
- '("GDestroyNotify" "user_data_destroy")
- )
-)
-
-(define-method register_serialize_tagset
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_register_serialize_tagset")
- (return-type "GdkAtom")
- (parameters
- '("const-gchar*" "tagset_name" (null-ok) (default "NULL"))
- )
-)
-
-(define-method register_deserialize_format
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_register_deserialize_format")
- (return-type "GdkAtom")
- (parameters
- '("const-gchar*" "mime_type")
- '("GtkTextBufferDeserializeFunc" "function")
- '("gpointer" "user_data")
- '("GDestroyNotify" "user_data_destroy")
- )
-)
-
-(define-method register_deserialize_tagset
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_register_deserialize_tagset")
- (return-type "GdkAtom")
- (parameters
- '("const-gchar*" "tagset_name" (null-ok) (default "NULL"))
- )
-)
-
-(define-method unregister_serialize_format
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_unregister_serialize_format")
- (return-type "none")
- (parameters
- '("GdkAtom" "format")
- )
-)
-
-(define-method unregister_deserialize_format
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_unregister_deserialize_format")
- (return-type "none")
- (parameters
- '("GdkAtom" "format")
- )
-)
-
-(define-method deserialize_set_can_create_tags
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_deserialize_set_can_create_tags")
- (return-type "none")
- (parameters
- '("GdkAtom" "format")
- '("gboolean" "can_create_tags")
- )
-)
-
-(define-method deserialize_get_can_create_tags
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_deserialize_get_can_create_tags")
- (return-type "gboolean")
- (parameters
- '("GdkAtom" "format")
- )
-)
-
-(define-method get_serialize_formats
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_serialize_formats")
- (return-type "GdkAtom*")
- (parameters
- '("gint*" "n_formats")
- )
-)
-
-(define-method get_deserialize_formats
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_deserialize_formats")
- (return-type "GdkAtom*")
- (parameters
- '("gint*" "n_formats")
- )
-)
-
-(define-method serialize
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_serialize")
- (return-type "guint8*")
- (parameters
- '("GtkTextBuffer*" "content_buffer")
- '("GdkAtom" "format")
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- '("gsize*" "length")
- )
-)
-
-(define-method deserialize
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_deserialize")
- (return-type "gboolean")
- (parameters
- '("GtkTextBuffer*" "content_buffer")
- '("GdkAtom" "format")
- '("GtkTextIter*" "iter")
- '("const-guint8*" "data")
- '("gsize" "length")
- '("GError**" "error")
- )
-)
-
-
-
-;; From gtktextchild.h
-
-
-
-;; From gtktextdisplay.h
-
-
-
-;; From gtktext.h
-
-
-
-;; From gtktextiter.h
-
-
-
-;; From gtktextlayout.h
-
-
-
-;; From gtktextmark.h
-
-
-
-;; From gtktexttag.h
-
-
-
-;; From gtktexttagtable.h
-
-
-
-;; From gtktextview.h
-
-
-
-;; From gtktipsquery.h
-
-
-
-;; From gtktoggleaction.h
-
-
-
-;; From gtktogglebutton.h
-
-
-
-;; From gtktoggletoolbutton.h
-
-
-
-;; From gtktoolbar.h
-
-
-
-;; From gtktoolbutton.h
-
-
-
-;; From gtktoolitem.h
-
-
-
-;; From gtktooltips.h
-
-
-
-;; From gtktreednd.h
-
-
-
-;; From gtktree.h
-
-
-
-;; From gtktreeitem.h
-
-
-
-;; From gtktreemodelfilter.h
-
-
-
-;; From gtktreemodel.h
-
-
-
-;; From gtktreemodelsort.h
-
-
-
-;; From gtktreeselection.h
-
-
-
-;; From gtktreesortable.h
-
-
-
-;; From gtktreestore.h
-
-(define-method insert_with_values
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_insert_with_values")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "parent")
- '("gint" "position")
- )
- (varargs #t)
-)
-
-(define-method insert_with_valuesv
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_insert_with_valuesv")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "parent")
- '("gint" "position")
- '("gint*" "columns")
- '("GValue*" "values")
- '("gint" "n_values")
- )
-)
-
-
-
-;; From gtktreeviewcolumn.h
-
-
-
-;; From gtktreeview.h
-
-(define-method get_headers_clickable
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_headers_clickable")
- (return-type "gboolean")
-)
-
-(define-method get_search_entry
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_search_entry")
- (return-type "GtkEntry*")
-)
-
-(define-method set_search_entry
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_search_entry")
- (return-type "none")
- (parameters
- '("GtkEntry*" "entry" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_search_position_func
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_search_position_func")
- (return-type "GtkTreeViewSearchPositionFunc")
-)
-
-(define-method set_search_position_func
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_search_position_func")
- (return-type "none")
- (parameters
- '("GtkTreeViewSearchPositionFunc" "func")
- '("gpointer" "data")
- '("GDestroyNotify" "destroy")
- )
-)
-
-(define-method set_rubber_banding
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_rubber_banding")
- (return-type "none")
- (parameters
- '("gboolean" "enable")
- )
-)
-
-(define-method get_rubber_banding
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_rubber_banding")
- (return-type "gboolean")
-)
-
-(define-method get_grid_lines
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_grid_lines")
- (return-type "GtkTreeViewGridLines")
-)
-
-(define-method set_grid_lines
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_grid_lines")
- (return-type "none")
- (parameters
- '("GtkTreeViewGridLines" "grid_lines")
- )
-)
-
-(define-method get_enable_tree_lines
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_enable_tree_lines")
- (return-type "gboolean")
-)
-
-(define-method set_enable_tree_lines
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_enable_tree_lines")
- (return-type "none")
- (parameters
- '("gboolean" "enabled")
- )
-)
-
-
-
-;; From gtktypebuiltins.h
-
-(define-function assistant_page_type_get_type
- (c-name "gtk_assistant_page_type_get_type")
- (return-type "GType")
-)
-
-(define-function cell_renderer_accel_mode_get_type
- (c-name "gtk_cell_renderer_accel_mode_get_type")
- (return-type "GType")
-)
-
-(define-function sensitivity_type_get_type
- (c-name "gtk_sensitivity_type_get_type")
- (return-type "GType")
-)
-
-(define-function print_pages_get_type
- (c-name "gtk_print_pages_get_type")
- (return-type "GType")
-)
-
-(define-function page_set_get_type
- (c-name "gtk_page_set_get_type")
- (return-type "GType")
-)
-
-(define-function page_orientation_get_type
- (c-name "gtk_page_orientation_get_type")
- (return-type "GType")
-)
-
-(define-function print_quality_get_type
- (c-name "gtk_print_quality_get_type")
- (return-type "GType")
-)
-
-(define-function print_duplex_get_type
- (c-name "gtk_print_duplex_get_type")
- (return-type "GType")
-)
-
-(define-function unit_get_type
- (c-name "gtk_unit_get_type")
- (return-type "GType")
-)
-
-(define-function tree_view_grid_lines_get_type
- (c-name "gtk_tree_view_grid_lines_get_type")
- (return-type "GType")
-)
-
-(define-function print_operation_action_get_type
- (c-name "gtk_print_operation_action_get_type")
- (return-type "GType")
-)
-
-(define-function recent_sort_type_get_type
- (c-name "gtk_recent_sort_type_get_type")
- (return-type "GType")
-)
-
-(define-function recent_chooser_error_get_type
- (c-name "gtk_recent_chooser_error_get_type")
- (return-type "GType")
-)
-
-(define-function recent_filter_flags_get_type
- (c-name "gtk_recent_filter_flags_get_type")
- (return-type "GType")
-)
-
-(define-function recent_manager_error_get_type
- (c-name "gtk_recent_manager_error_get_type")
- (return-type "GType")
-)
-
-(define-function text_buffer_target_info_get_type
- (c-name "gtk_text_buffer_target_info_get_type")
- (return-type "GType")
-)
-
-
-
-;; From gtktypeutils.h
-
-
-
-;; From gtkuimanager.h
-
-
-
-;; From gtkvbbox.h
-
-
-
-;; From gtkvbox.h
-
-
-
-;; From gtkversion.h
-
-
-
-;; From gtkviewport.h
-
-
-
-;; From gtkvpaned.h
-
-
-
-;; From gtkvruler.h
-
-
-
-;; From gtkvscale.h
-
-
-
-;; From gtkvscrollbar.h
-
-
-
-;; From gtkvseparator.h
-
-
-
-;; From gtkwidget.h
-
-(define-method is_composited
- (of-object "GtkWidget")
- (c-name "gtk_widget_is_composited")
- (return-type "gboolean")
-)
-
-(define-method input_shape_combine_mask
- (of-object "GtkWidget")
- (c-name "gtk_widget_input_shape_combine_mask")
- (return-type "none")
- (parameters
- '("GdkBitmap*" "shape_mask" (null-ok))
- '("gint" "offset_x")
- '("gint" "offset_y")
- )
-)
-
-(define-virtual composited_changed
- (of-object "GtkWidget")
- (return-type "none")
-)
-
-
-
-;; From gtkwindow.h
-
-(define-method set_deletable
- (of-object "GtkWindow")
- (c-name "gtk_window_set_deletable")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_deletable
- (of-object "GtkWindow")
- (c-name "gtk_window_get_deletable")
- (return-type "gboolean")
-)
-
-(define-method get_group
- (of-object "GtkWindow")
- (c-name "gtk_window_get_group")
- (return-type "GtkWindowGroup*")
-)
-
-
diff --git a/gtk/gtk-base-types.defs b/gtk/gtk-base-types.defs
deleted file mode 100644
index 73aac81d..00000000
--- a/gtk/gtk-base-types.defs
+++ /dev/null
@@ -1,2735 +0,0 @@
-;; -*- scheme -*-
-;;
-;; Note, everything should be sorted in here.
-
-;; Boxed types ...
-
-(define-boxed Border
- (in-module "Gtk")
- (c-name "GtkBorder")
- (gtype-id "GTK_TYPE_BORDER")
- (copy-func "gtk_border_copy")
- (release-func "gtk_border_free")
-)
-
-(define-boxed IconInfo
- (in-module "Gtk")
- (c-name "GtkIconInfo")
- (gtype-id "GTK_TYPE_ICON_INFO")
- (copy-func "gtk_icon_info_copy")
- (release-func "gtk_icon_info_free")
-)
-
-(define-boxed IconSet
- (in-module "Gtk")
- (c-name "GtkIconSet")
- (gtype-id "GTK_TYPE_ICON_SET")
-)
-
-(define-boxed IconSource
- (in-module "Gtk")
- (c-name "GtkIconSource")
- (gtype-id "GTK_TYPE_ICON_SOURCE")
- (copy-func "gtk_icon_source_copy")
- (release-func "gtk_icon_source_free")
-)
-
-(define-boxed Requisition
- (in-module "Gtk")
- (c-name "GtkRequisition")
- (gtype-id "GTK_TYPE_REQUISITION")
- (fields
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-boxed SelectionData
- (in-module "Gtk")
- (c-name "GtkSelectionData")
- (gtype-id "GTK_TYPE_SELECTION_DATA")
- (copy-func "gtk_selection_data_copy")
- (release-func "gtk_selection_data_free")
- (fields
- '("GdkAtom" "selection")
- '("GdkAtom" "target")
- '("GdkAtom" "type")
- '("gint" "format")
- '("guchar*" "data")
- )
-)
-
-(define-boxed TextAttributes
- (in-module "Gtk")
- (c-name "GtkTextAttributes")
- (gtype-id "GTK_TYPE_TEXT_ATTRIBUTES")
- (fields
- '("GdkColor" "bg_color")
- '("GdkColor" "fg_color")
- '("GdkBitmap" "bg_stipple")
- '("GdkBitmap" "fg_stipple")
- '("gint" "rise")
- '("guint" "underline")
- '("guint" "strikethrough")
- '("guint" "draw_bg")
- '("GtkJustification" "justification")
- '("GtkTextDirection" "direction")
- '("PangoFontDescription*" "font")
- '("gdouble" "font_scale")
- '("gint" "left_margin")
- '("gint" "indent")
- '("gint" "right_margin")
- '("gint" "pixels_above_lines")
- '("gint" "pixels_below_lines")
- '("gint" "pixels_inside_wrap")
- '("PangoTabArray*" "tabs")
- '("GtkWrapMode" "wrap_mode")
- '("PangoLanguage*" "language")
- '("guint" "invisible")
- '("guint" "bg_full_height")
- '("guint" "editable")
- '("guint" "realized")
- '("guint" "pad1")
- '("guint" "pad2")
- '("guint" "pad3")
- '("guint" "pad4")
- )
-)
-
-(define-boxed TextIter
- (in-module "Gtk")
- (c-name "GtkTextIter")
- (gtype-id "GTK_TYPE_TEXT_ITER")
- (copy-func "gtk_text_iter_copy")
- (release-func "gtk_text_iter_free")
-)
-
-(define-boxed TreeIter
- (in-module "Gtk")
- (c-name "GtkTreeIter")
- (gtype-id "GTK_TYPE_TREE_ITER")
- (copy-func "gtk_tree_iter_copy")
- (release-func "gtk_tree_iter_free")
-)
-
-(define-boxed TreeRowReference
- (in-module "Gtk")
- (c-name "GtkTreeRowReference")
- (gtype-id "GTK_TYPE_TREE_ROW_REFERENCE")
- (copy-func "gtk_tree_row_reference_copy")
- (release-func "gtk_tree_row_reference_free")
-)
-
-;; Enumerations ...
-
-(define-enum AnchorType
- (in-module "Gtk")
- (c-name "GtkAnchorType")
- (gtype-id "GTK_TYPE_ANCHOR_TYPE")
- (values
- '("center" "GTK_ANCHOR_CENTER")
- '("north" "GTK_ANCHOR_NORTH")
- '("north-west" "GTK_ANCHOR_NORTH_WEST")
- '("north-east" "GTK_ANCHOR_NORTH_EAST")
- '("south" "GTK_ANCHOR_SOUTH")
- '("south-west" "GTK_ANCHOR_SOUTH_WEST")
- '("south-east" "GTK_ANCHOR_SOUTH_EAST")
- '("west" "GTK_ANCHOR_WEST")
- '("east" "GTK_ANCHOR_EAST")
- '("n" "GTK_ANCHOR_N")
- '("nw" "GTK_ANCHOR_NW")
- '("ne" "GTK_ANCHOR_NE")
- '("s" "GTK_ANCHOR_S")
- '("sw" "GTK_ANCHOR_SW")
- '("se" "GTK_ANCHOR_SE")
- '("w" "GTK_ANCHOR_W")
- '("e" "GTK_ANCHOR_E")
- )
-)
-
-(define-enum ArrowType
- (in-module "Gtk")
- (c-name "GtkArrowType")
- (gtype-id "GTK_TYPE_ARROW_TYPE")
- (values
- '("up" "GTK_ARROW_UP")
- '("down" "GTK_ARROW_DOWN")
- '("left" "GTK_ARROW_LEFT")
- '("right" "GTK_ARROW_RIGHT")
- )
-)
-
-(define-enum ButtonBoxStyle
- (in-module "Gtk")
- (c-name "GtkButtonBoxStyle")
- (gtype-id "GTK_TYPE_BUTTON_BOX_STYLE")
- (values
- '("default-style" "GTK_BUTTONBOX_DEFAULT_STYLE")
- '("spread" "GTK_BUTTONBOX_SPREAD")
- '("edge" "GTK_BUTTONBOX_EDGE")
- '("start" "GTK_BUTTONBOX_START")
- '("end" "GTK_BUTTONBOX_END")
- )
-)
-
-(define-enum ButtonsType
- (in-module "Gtk")
- (c-name "GtkButtonsType")
- (gtype-id "GTK_TYPE_BUTTONS_TYPE")
- (values
- '("none" "GTK_BUTTONS_NONE")
- '("ok" "GTK_BUTTONS_OK")
- '("close" "GTK_BUTTONS_CLOSE")
- '("cancel" "GTK_BUTTONS_CANCEL")
- '("yes-no" "GTK_BUTTONS_YES_NO")
- '("ok-cancel" "GTK_BUTTONS_OK_CANCEL")
- )
-)
-
-(define-enum CellRendererMode
- (in-module "Gtk")
- (c-name "GtkCellRendererMode")
- (gtype-id "GTK_TYPE_CELL_RENDERER_MODE")
- (values
- '("inert" "GTK_CELL_RENDERER_MODE_INERT")
- '("activatable" "GTK_CELL_RENDERER_MODE_ACTIVATABLE")
- '("editable" "GTK_CELL_RENDERER_MODE_EDITABLE")
- )
-)
-
-(define-enum CellType
- (in-module "Gtk")
- (c-name "GtkCellType")
- (gtype-id "GTK_TYPE_CELL_TYPE")
- (values
- '("empty" "GTK_CELL_EMPTY")
- '("text" "GTK_CELL_TEXT")
- '("pixmap" "GTK_CELL_PIXMAP")
- '("pixtext" "GTK_CELL_PIXTEXT")
- '("widget" "GTK_CELL_WIDGET")
- )
-)
-
-(define-enum CListDragPos
- (in-module "Gtk")
- (c-name "GtkCListDragPos")
- (gtype-id "GTK_TYPE_CLIST_DRAG_POS")
- (values
- '("none" "GTK_CLIST_DRAG_NONE")
- '("before" "GTK_CLIST_DRAG_BEFORE")
- '("into" "GTK_CLIST_DRAG_INTO")
- '("after" "GTK_CLIST_DRAG_AFTER")
- )
-)
-
-(define-enum CornerType
- (in-module "Gtk")
- (c-name "GtkCornerType")
- (gtype-id "GTK_TYPE_CORNER_TYPE")
- (values
- '("top-left" "GTK_CORNER_TOP_LEFT")
- '("bottom-left" "GTK_CORNER_BOTTOM_LEFT")
- '("top-right" "GTK_CORNER_TOP_RIGHT")
- '("bottom-right" "GTK_CORNER_BOTTOM_RIGHT")
- )
-)
-
-(define-enum CTreeExpanderStyle
- (in-module "Gtk")
- (c-name "GtkCTreeExpanderStyle")
- (gtype-id "GTK_TYPE_CTREE_EXPANDER_STYLE")
- (values
- '("none" "GTK_CTREE_EXPANDER_NONE")
- '("square" "GTK_CTREE_EXPANDER_SQUARE")
- '("triangle" "GTK_CTREE_EXPANDER_TRIANGLE")
- '("circular" "GTK_CTREE_EXPANDER_CIRCULAR")
- )
-)
-
-(define-enum CTreeExpansionType
- (in-module "Gtk")
- (c-name "GtkCTreeExpansionType")
- (gtype-id "GTK_TYPE_CTREE_EXPANSION_TYPE")
- (values
- '("expand" "GTK_CTREE_EXPANSION_EXPAND")
- '("expand-recursive" "GTK_CTREE_EXPANSION_EXPAND_RECURSIVE")
- '("collapse" "GTK_CTREE_EXPANSION_COLLAPSE")
- '("collapse-recursive" "GTK_CTREE_EXPANSION_COLLAPSE_RECURSIVE")
- '("toggle" "GTK_CTREE_EXPANSION_TOGGLE")
- '("toggle-recursive" "GTK_CTREE_EXPANSION_TOGGLE_RECURSIVE")
- )
-)
-
-(define-enum CTreeLineStyle
- (in-module "Gtk")
- (c-name "GtkCTreeLineStyle")
- (gtype-id "GTK_TYPE_CTREE_LINE_STYLE")
- (values
- '("none" "GTK_CTREE_LINES_NONE")
- '("solid" "GTK_CTREE_LINES_SOLID")
- '("dotted" "GTK_CTREE_LINES_DOTTED")
- '("tabbed" "GTK_CTREE_LINES_TABBED")
- )
-)
-
-(define-enum CTreePos
- (in-module "Gtk")
- (c-name "GtkCTreePos")
- (gtype-id "GTK_TYPE_CTREE_POS")
- (values
- '("before" "GTK_CTREE_POS_BEFORE")
- '("as-child" "GTK_CTREE_POS_AS_CHILD")
- '("after" "GTK_CTREE_POS_AFTER")
- )
-)
-
-(define-enum CurveType
- (in-module "Gtk")
- (c-name "GtkCurveType")
- (gtype-id "GTK_TYPE_CURVE_TYPE")
- (values
- '("linear" "GTK_CURVE_TYPE_LINEAR")
- '("spline" "GTK_CURVE_TYPE_SPLINE")
- '("free" "GTK_CURVE_TYPE_FREE")
- )
-)
-
-(define-enum DeleteType
- (in-module "Gtk")
- (c-name "GtkDeleteType")
- (gtype-id "GTK_TYPE_DELETE_TYPE")
- (values
- '("chars" "GTK_DELETE_CHARS")
- '("word-ends" "GTK_DELETE_WORD_ENDS")
- '("words" "GTK_DELETE_WORDS")
- '("display-lines" "GTK_DELETE_DISPLAY_LINES")
- '("display-line-ends" "GTK_DELETE_DISPLAY_LINE_ENDS")
- '("paragraph-ends" "GTK_DELETE_PARAGRAPH_ENDS")
- '("paragraphs" "GTK_DELETE_PARAGRAPHS")
- '("whitespace" "GTK_DELETE_WHITESPACE")
- )
-)
-
-(define-enum DirectionType
- (in-module "Gtk")
- (c-name "GtkDirectionType")
- (gtype-id "GTK_TYPE_DIRECTION_TYPE")
- (values
- '("tab-forward" "GTK_DIR_TAB_FORWARD")
- '("tab-backward" "GTK_DIR_TAB_BACKWARD")
- '("up" "GTK_DIR_UP")
- '("down" "GTK_DIR_DOWN")
- '("left" "GTK_DIR_LEFT")
- '("right" "GTK_DIR_RIGHT")
- )
-)
-
-(define-enum ExpanderStyle
- (in-module "Gtk")
- (c-name "GtkExpanderStyle")
- (gtype-id "GTK_TYPE_EXPANDER_STYLE")
- (values
- '("collapsed" "GTK_EXPANDER_COLLAPSED")
- '("semi-collapsed" "GTK_EXPANDER_SEMI_COLLAPSED")
- '("semi-expanded" "GTK_EXPANDER_SEMI_EXPANDED")
- '("expanded" "GTK_EXPANDER_EXPANDED")
- )
-)
-
-(define-enum FileChooserAction
- (in-module "Gtk")
- (c-name "GtkFileChooserAction")
- (gtype-id "GTK_TYPE_FILE_CHOOSER_ACTION")
- (values
- '("open" "GTK_FILE_CHOOSER_ACTION_OPEN")
- '("save" "GTK_FILE_CHOOSER_ACTION_SAVE")
- '("select-folder" "GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER")
- '("create-folder" "GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER")
- )
-)
-
-(define-enum FileChooserConfirmation
- (in-module "Gtk")
- (c-name "GtkFileChooserConfirmation")
- (gtype-id "GTK_TYPE_FILE_CHOOSER_CONFIRMATION")
- (values
- '("confirm" "GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM")
- '("accept-filename" "GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME")
- '("select-again" "GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN")
- )
-)
-
-(define-enum FileChooserError
- (in-module "Gtk")
- (c-name "GtkFileChooserError")
- (gtype-id "GTK_TYPE_FILE_CHOOSER_ERROR")
- (values
- '("nonexistent" "GTK_FILE_CHOOSER_ERROR_NONEXISTENT")
- '("bad-filename" "GTK_FILE_CHOOSER_ERROR_BAD_FILENAME")
- )
-)
-
-(define-enum IconSize
- (in-module "Gtk")
- (c-name "GtkIconSize")
- (gtype-id "GTK_TYPE_ICON_SIZE")
- (values
- '("invalid" "GTK_ICON_SIZE_INVALID")
- '("menu" "GTK_ICON_SIZE_MENU")
- '("small-toolbar" "GTK_ICON_SIZE_SMALL_TOOLBAR")
- '("large-toolbar" "GTK_ICON_SIZE_LARGE_TOOLBAR")
- '("button" "GTK_ICON_SIZE_BUTTON")
- '("dnd" "GTK_ICON_SIZE_DND")
- '("dialog" "GTK_ICON_SIZE_DIALOG")
- )
-)
-
-(define-enum IconThemeError
- (in-module "Gtk")
- (c-name "GtkIconThemeError")
- (gtype-id "GTK_TYPE_ICON_THEME_ERROR")
- (values
- '("not-found" "GTK_ICON_THEME_NOT_FOUND")
- '("failed" "GTK_ICON_THEME_FAILED")
- )
-)
-
-(define-enum IconViewDropPosition
- (in-module "Gtk")
- (c-name "GtkIconViewDropPosition")
- (gtype-id "GTK_TYPE_ICON_VIEW_DROP_POSITION")
- (values
- '("no-drop" "GTK_ICON_VIEW_NO_DROP")
- '("drop-into" "GTK_ICON_VIEW_DROP_INTO")
- '("drop-left" "GTK_ICON_VIEW_DROP_LEFT")
- '("drop-right" "GTK_ICON_VIEW_DROP_RIGHT")
- '("drop-above" "GTK_ICON_VIEW_DROP_ABOVE")
- '("drop-below" "GTK_ICON_VIEW_DROP_BELOW")
- )
-)
-
-(define-enum ImageType
- (in-module "Gtk")
- (c-name "GtkImageType")
- (gtype-id "GTK_TYPE_IMAGE_TYPE")
- (values
- '("empty" "GTK_IMAGE_EMPTY")
- '("pixmap" "GTK_IMAGE_PIXMAP")
- '("image" "GTK_IMAGE_IMAGE")
- '("pixbuf" "GTK_IMAGE_PIXBUF")
- '("stock" "GTK_IMAGE_STOCK")
- '("icon-set" "GTK_IMAGE_ICON_SET")
- '("animation" "GTK_IMAGE_ANIMATION")
- )
-)
-
-(define-enum IMPreeditStyle
- (in-module "Gtk")
- (c-name "GtkIMPreeditStyle")
- (gtype-id "GTK_TYPE_IM_PREEDIT_STYLE")
- (values
- '("nothing" "GTK_IM_PREEDIT_NOTHING")
- '("callback" "GTK_IM_PREEDIT_CALLBACK")
- '("none" "GTK_IM_PREEDIT_NONE")
- )
-)
-
-(define-enum IMStatusStyle
- (in-module "Gtk")
- (c-name "GtkIMStatusStyle")
- (gtype-id "GTK_TYPE_IM_STATUS_STYLE")
- (values
- '("nothing" "GTK_IM_STATUS_NOTHING")
- '("callback" "GTK_IM_STATUS_CALLBACK")
- )
-)
-
-(define-enum PackDirection
- (in-module "Gtk")
- (c-name "GtkPackDirection")
- (gtype-id "GTK_TYPE_PACK_DIRECTION")
- (values
- '("ltr" "GTK_PACK_DIRECTION_LTR")
- '("rtl" "GTK_PACK_DIRECTION_RTL")
- '("ttb" "GTK_PACK_DIRECTION_TTB")
- '("btt" "GTK_PACK_DIRECTION_BTT")
- )
-)
-
-(define-enum Justification
- (in-module "Gtk")
- (c-name "GtkJustification")
- (gtype-id "GTK_TYPE_JUSTIFICATION")
- (values
- '("left" "GTK_JUSTIFY_LEFT")
- '("right" "GTK_JUSTIFY_RIGHT")
- '("center" "GTK_JUSTIFY_CENTER")
- '("fill" "GTK_JUSTIFY_FILL")
- )
-)
-
-(define-enum MatchType
- (in-module "Gtk")
- (c-name "GtkMatchType")
- (gtype-id "GTK_TYPE_MATCH_TYPE")
- (values
- '("all" "GTK_MATCH_ALL")
- '("all-tail" "GTK_MATCH_ALL_TAIL")
- '("head" "GTK_MATCH_HEAD")
- '("tail" "GTK_MATCH_TAIL")
- '("exact" "GTK_MATCH_EXACT")
- '("last" "GTK_MATCH_LAST")
- )
-)
-
-(define-enum MenuDirectionType
- (in-module "Gtk")
- (c-name "GtkMenuDirectionType")
- (gtype-id "GTK_TYPE_MENU_DIRECTION_TYPE")
- (values
- '("parent" "GTK_MENU_DIR_PARENT")
- '("child" "GTK_MENU_DIR_CHILD")
- '("next" "GTK_MENU_DIR_NEXT")
- '("prev" "GTK_MENU_DIR_PREV")
- )
-)
-
-(define-enum MessageType
- (in-module "Gtk")
- (c-name "GtkMessageType")
- (gtype-id "GTK_TYPE_MESSAGE_TYPE")
- (values
- '("info" "GTK_MESSAGE_INFO")
- '("warning" "GTK_MESSAGE_WARNING")
- '("question" "GTK_MESSAGE_QUESTION")
- '("error" "GTK_MESSAGE_ERROR")
- )
-)
-
-(define-enum MetricType
- (in-module "Gtk")
- (c-name "GtkMetricType")
- (gtype-id "GTK_TYPE_METRIC_TYPE")
- (values
- '("pixels" "GTK_PIXELS")
- '("inches" "GTK_INCHES")
- '("centimeters" "GTK_CENTIMETERS")
- )
-)
-
-(define-enum MovementStep
- (in-module "Gtk")
- (c-name "GtkMovementStep")
- (gtype-id "GTK_TYPE_MOVEMENT_STEP")
- (values
- '("logical-positions" "GTK_MOVEMENT_LOGICAL_POSITIONS")
- '("visual-positions" "GTK_MOVEMENT_VISUAL_POSITIONS")
- '("words" "GTK_MOVEMENT_WORDS")
- '("display-lines" "GTK_MOVEMENT_DISPLAY_LINES")
- '("display-line-ends" "GTK_MOVEMENT_DISPLAY_LINE_ENDS")
- '("paragraphs" "GTK_MOVEMENT_PARAGRAPHS")
- '("paragraph-ends" "GTK_MOVEMENT_PARAGRAPH_ENDS")
- '("pages" "GTK_MOVEMENT_PAGES")
- '("buffer-ends" "GTK_MOVEMENT_BUFFER_ENDS")
- '("horizontal-pages" "GTK_MOVEMENT_HORIZONTAL_PAGES")
- )
-)
-
-(define-enum NotebookTab
- (in-module "Gtk")
- (c-name "GtkNotebookTab")
- (gtype-id "GTK_TYPE_NOTEBOOK_TAB")
- (values
- '("first" "GTK_NOTEBOOK_TAB_FIRST")
- '("last" "GTK_NOTEBOOK_TAB_LAST")
- )
-)
-
-(define-enum Orientation
- (in-module "Gtk")
- (c-name "GtkOrientation")
- (gtype-id "GTK_TYPE_ORIENTATION")
- (values
- '("horizontal" "GTK_ORIENTATION_HORIZONTAL")
- '("vertical" "GTK_ORIENTATION_VERTICAL")
- )
-)
-
-(define-enum PackType
- (in-module "Gtk")
- (c-name "GtkPackType")
- (gtype-id "GTK_TYPE_PACK_TYPE")
- (values
- '("start" "GTK_PACK_START")
- '("end" "GTK_PACK_END")
- )
-)
-
-(define-enum PathPriorityType
- (in-module "Gtk")
- (c-name "GtkPathPriorityType")
- (gtype-id "GTK_TYPE_PATH_PRIORITY_TYPE")
- (values
- '("lowest" "GTK_PATH_PRIO_LOWEST")
- '("gtk" "GTK_PATH_PRIO_GTK")
- '("application" "GTK_PATH_PRIO_APPLICATION")
- '("theme" "GTK_PATH_PRIO_THEME")
- '("rc" "GTK_PATH_PRIO_RC")
- '("highest" "GTK_PATH_PRIO_HIGHEST")
- )
-)
-
-(define-enum PathType
- (in-module "Gtk")
- (c-name "GtkPathType")
- (gtype-id "GTK_TYPE_PATH_TYPE")
- (values
- '("widget" "GTK_PATH_WIDGET")
- '("widget-class" "GTK_PATH_WIDGET_CLASS")
- '("class" "GTK_PATH_CLASS")
- )
-)
-
-(define-enum PolicyType
- (in-module "Gtk")
- (c-name "GtkPolicyType")
- (gtype-id "GTK_TYPE_POLICY_TYPE")
- (values
- '("always" "GTK_POLICY_ALWAYS")
- '("automatic" "GTK_POLICY_AUTOMATIC")
- '("never" "GTK_POLICY_NEVER")
- )
-)
-
-(define-enum PositionType
- (in-module "Gtk")
- (c-name "GtkPositionType")
- (gtype-id "GTK_TYPE_POSITION_TYPE")
- (values
- '("left" "GTK_POS_LEFT")
- '("right" "GTK_POS_RIGHT")
- '("top" "GTK_POS_TOP")
- '("bottom" "GTK_POS_BOTTOM")
- )
-)
-
-(define-enum PreviewType
- (in-module "Gtk")
- (c-name "GtkPreviewType")
- (gtype-id "GTK_TYPE_PREVIEW_TYPE")
- (values
- '("color" "GTK_PREVIEW_COLOR")
- '("grayscale" "GTK_PREVIEW_GRAYSCALE")
- )
-)
-
-(define-enum ProgressBarOrientation
- (in-module "Gtk")
- (c-name "GtkProgressBarOrientation")
- (gtype-id "GTK_TYPE_PROGRESS_BAR_ORIENTATION")
- (values
- '("left-to-right" "GTK_PROGRESS_LEFT_TO_RIGHT")
- '("right-to-left" "GTK_PROGRESS_RIGHT_TO_LEFT")
- '("bottom-to-top" "GTK_PROGRESS_BOTTOM_TO_TOP")
- '("top-to-bottom" "GTK_PROGRESS_TOP_TO_BOTTOM")
- )
-)
-
-(define-enum ProgressBarStyle
- (in-module "Gtk")
- (c-name "GtkProgressBarStyle")
- (gtype-id "GTK_TYPE_PROGRESS_BAR_STYLE")
- (values
- '("continuous" "GTK_PROGRESS_CONTINUOUS")
- '("discrete" "GTK_PROGRESS_DISCRETE")
- )
-)
-
-(define-enum RcTokenType
- (in-module "Gtk")
- (c-name "GtkRcTokenType")
- (gtype-id "GTK_TYPE_RC_TOKEN_TYPE")
- (values
- '("invalid" "GTK_RC_TOKEN_INVALID")
- '("include" "GTK_RC_TOKEN_INCLUDE")
- '("normal" "GTK_RC_TOKEN_NORMAL")
- '("active" "GTK_RC_TOKEN_ACTIVE")
- '("prelight" "GTK_RC_TOKEN_PRELIGHT")
- '("selected" "GTK_RC_TOKEN_SELECTED")
- '("insensitive" "GTK_RC_TOKEN_INSENSITIVE")
- '("fg" "GTK_RC_TOKEN_FG")
- '("bg" "GTK_RC_TOKEN_BG")
- '("text" "GTK_RC_TOKEN_TEXT")
- '("base" "GTK_RC_TOKEN_BASE")
- '("xthickness" "GTK_RC_TOKEN_XTHICKNESS")
- '("ythickness" "GTK_RC_TOKEN_YTHICKNESS")
- '("font" "GTK_RC_TOKEN_FONT")
- '("fontset" "GTK_RC_TOKEN_FONTSET")
- '("font-name" "GTK_RC_TOKEN_FONT_NAME")
- '("bg-pixmap" "GTK_RC_TOKEN_BG_PIXMAP")
- '("pixmap-path" "GTK_RC_TOKEN_PIXMAP_PATH")
- '("style" "GTK_RC_TOKEN_STYLE")
- '("binding" "GTK_RC_TOKEN_BINDING")
- '("bind" "GTK_RC_TOKEN_BIND")
- '("widget" "GTK_RC_TOKEN_WIDGET")
- '("widget-class" "GTK_RC_TOKEN_WIDGET_CLASS")
- '("class" "GTK_RC_TOKEN_CLASS")
- '("lowest" "GTK_RC_TOKEN_LOWEST")
- '("gtk" "GTK_RC_TOKEN_GTK")
- '("application" "GTK_RC_TOKEN_APPLICATION")
- '("theme" "GTK_RC_TOKEN_THEME")
- '("rc" "GTK_RC_TOKEN_RC")
- '("highest" "GTK_RC_TOKEN_HIGHEST")
- '("engine" "GTK_RC_TOKEN_ENGINE")
- '("module-path" "GTK_RC_TOKEN_MODULE_PATH")
- '("im-module-path" "GTK_RC_TOKEN_IM_MODULE_PATH")
- '("im-module-file" "GTK_RC_TOKEN_IM_MODULE_FILE")
- '("stock" "GTK_RC_TOKEN_STOCK")
- '("ltr" "GTK_RC_TOKEN_LTR")
- '("rtl" "GTK_RC_TOKEN_RTL")
- '("last" "GTK_RC_TOKEN_LAST")
- )
-)
-
-(define-enum ReliefStyle
- (in-module "Gtk")
- (c-name "GtkReliefStyle")
- (gtype-id "GTK_TYPE_RELIEF_STYLE")
- (values
- '("normal" "GTK_RELIEF_NORMAL")
- '("half" "GTK_RELIEF_HALF")
- '("none" "GTK_RELIEF_NONE")
- )
-)
-
-(define-enum ResizeMode
- (in-module "Gtk")
- (c-name "GtkResizeMode")
- (gtype-id "GTK_TYPE_RESIZE_MODE")
- (values
- '("parent" "GTK_RESIZE_PARENT")
- '("queue" "GTK_RESIZE_QUEUE")
- '("immediate" "GTK_RESIZE_IMMEDIATE")
- )
-)
-
-(define-enum ResponseType
- (in-module "Gtk")
- (c-name "GtkResponseType")
- (gtype-id "GTK_TYPE_RESPONSE_TYPE")
- (values
- '("none" "GTK_RESPONSE_NONE")
- '("reject" "GTK_RESPONSE_REJECT")
- '("accept" "GTK_RESPONSE_ACCEPT")
- '("delete-event" "GTK_RESPONSE_DELETE_EVENT")
- '("ok" "GTK_RESPONSE_OK")
- '("cancel" "GTK_RESPONSE_CANCEL")
- '("close" "GTK_RESPONSE_CLOSE")
- '("yes" "GTK_RESPONSE_YES")
- '("no" "GTK_RESPONSE_NO")
- '("apply" "GTK_RESPONSE_APPLY")
- '("help" "GTK_RESPONSE_HELP")
- )
-)
-
-(define-enum ScrollStep
- (in-module "Gtk")
- (c-name "GtkScrollStep")
- (gtype-id "GTK_TYPE_SCROLL_STEP")
- (values
- '("steps" "GTK_SCROLL_STEPS")
- '("pages" "GTK_SCROLL_PAGES")
- '("ends" "GTK_SCROLL_ENDS")
- '("horizontal-steps" "GTK_SCROLL_HORIZONTAL_STEPS")
- '("horizontal-pages" "GTK_SCROLL_HORIZONTAL_PAGES")
- '("horizontal-ends" "GTK_SCROLL_HORIZONTAL_ENDS")
- )
- )
-
-(define-enum ScrollType
- (in-module "Gtk")
- (c-name "GtkScrollType")
- (gtype-id "GTK_TYPE_SCROLL_TYPE")
- (values
- '("none" "GTK_SCROLL_NONE")
- '("jump" "GTK_SCROLL_JUMP")
- '("step-backward" "GTK_SCROLL_STEP_BACKWARD")
- '("step-forward" "GTK_SCROLL_STEP_FORWARD")
- '("page-backward" "GTK_SCROLL_PAGE_BACKWARD")
- '("page-forward" "GTK_SCROLL_PAGE_FORWARD")
- '("step-up" "GTK_SCROLL_STEP_UP")
- '("step-down" "GTK_SCROLL_STEP_DOWN")
- '("page-up" "GTK_SCROLL_PAGE_UP")
- '("page-down" "GTK_SCROLL_PAGE_DOWN")
- '("step-left" "GTK_SCROLL_STEP_LEFT")
- '("step-right" "GTK_SCROLL_STEP_RIGHT")
- '("page-left" "GTK_SCROLL_PAGE_LEFT")
- '("page-right" "GTK_SCROLL_PAGE_RIGHT")
- '("start" "GTK_SCROLL_START")
- '("end" "GTK_SCROLL_END")
- )
-)
-
-(define-enum SelectionMode
- (in-module "Gtk")
- (c-name "GtkSelectionMode")
- (gtype-id "GTK_TYPE_SELECTION_MODE")
- (values
- '("none" "GTK_SELECTION_NONE")
- '("single" "GTK_SELECTION_SINGLE")
- '("browse" "GTK_SELECTION_BROWSE")
- '("multiple" "GTK_SELECTION_MULTIPLE")
- '("extended" "GTK_SELECTION_EXTENDED")
- )
-)
-
-(define-enum ShadowType
- (in-module "Gtk")
- (c-name "GtkShadowType")
- (gtype-id "GTK_TYPE_SHADOW_TYPE")
- (values
- '("none" "GTK_SHADOW_NONE")
- '("in" "GTK_SHADOW_IN")
- '("out" "GTK_SHADOW_OUT")
- '("etched-in" "GTK_SHADOW_ETCHED_IN")
- '("etched-out" "GTK_SHADOW_ETCHED_OUT")
- )
-)
-
-(define-enum SideType
- (in-module "Gtk")
- (c-name "GtkSideType")
- (gtype-id "GTK_TYPE_SIDE_TYPE")
- (values
- '("top" "GTK_SIDE_TOP")
- '("bottom" "GTK_SIDE_BOTTOM")
- '("left" "GTK_SIDE_LEFT")
- '("right" "GTK_SIDE_RIGHT")
- )
-)
-
-(define-enum SignalRunType
- (in-module "Gtk")
- (c-name "GtkSignalRunType")
- (gtype-id "GTK_TYPE_SIGNAL_RUN_TYPE")
- (values
- '("first" "GTK_RUN_FIRST")
- '("last" "GTK_RUN_LAST")
- '("both" "GTK_RUN_BOTH")
- '("no-recurse" "GTK_RUN_NO_RECURSE")
- '("action" "GTK_RUN_ACTION")
- '("no-hooks" "GTK_RUN_NO_HOOKS")
- )
-)
-
-(define-enum SizeGroupMode
- (in-module "Gtk")
- (c-name "GtkSizeGroupMode")
- (gtype-id "GTK_TYPE_SIZE_GROUP_MODE")
- (values
- '("none" "GTK_SIZE_GROUP_NONE")
- '("horizontal" "GTK_SIZE_GROUP_HORIZONTAL")
- '("vertical" "GTK_SIZE_GROUP_VERTICAL")
- '("both" "GTK_SIZE_GROUP_BOTH")
- )
-)
-
-(define-enum SortType
- (in-module "Gtk")
- (c-name "GtkSortType")
- (gtype-id "GTK_TYPE_SORT_TYPE")
- (values
- '("ascending" "GTK_SORT_ASCENDING")
- '("descending" "GTK_SORT_DESCENDING")
- )
-)
-
-(define-enum SpinButtonUpdatePolicy
- (in-module "Gtk")
- (c-name "GtkSpinButtonUpdatePolicy")
- (gtype-id "GTK_TYPE_SPIN_BUTTON_UPDATE_POLICY")
- (values
- '("always" "GTK_UPDATE_ALWAYS")
- '("if-valid" "GTK_UPDATE_IF_VALID")
- )
-)
-
-(define-enum SpinType
- (in-module "Gtk")
- (c-name "GtkSpinType")
- (gtype-id "GTK_TYPE_SPIN_TYPE")
- (values
- '("step-forward" "GTK_SPIN_STEP_FORWARD")
- '("step-backward" "GTK_SPIN_STEP_BACKWARD")
- '("page-forward" "GTK_SPIN_PAGE_FORWARD")
- '("page-backward" "GTK_SPIN_PAGE_BACKWARD")
- '("home" "GTK_SPIN_HOME")
- '("end" "GTK_SPIN_END")
- '("user-defined" "GTK_SPIN_USER_DEFINED")
- )
-)
-
-(define-enum StateType
- (in-module "Gtk")
- (c-name "GtkStateType")
- (gtype-id "GTK_TYPE_STATE_TYPE")
- (values
- '("normal" "GTK_STATE_NORMAL")
- '("active" "GTK_STATE_ACTIVE")
- '("prelight" "GTK_STATE_PRELIGHT")
- '("selected" "GTK_STATE_SELECTED")
- '("insensitive" "GTK_STATE_INSENSITIVE")
- )
-)
-
-(define-enum SubmenuDirection
- (in-module "Gtk")
- (c-name "GtkSubmenuDirection")
- (gtype-id "GTK_TYPE_SUBMENU_DIRECTION")
- (values
- '("left" "GTK_DIRECTION_LEFT")
- '("right" "GTK_DIRECTION_RIGHT")
- )
-)
-
-(define-enum SubmenuPlacement
- (in-module "Gtk")
- (c-name "GtkSubmenuPlacement")
- (gtype-id "GTK_TYPE_SUBMENU_PLACEMENT")
- (values
- '("top-bottom" "GTK_TOP_BOTTOM")
- '("left-right" "GTK_LEFT_RIGHT")
- )
-)
-
-(define-enum TextDirection
- (in-module "Gtk")
- (c-name "GtkTextDirection")
- (gtype-id "GTK_TYPE_TEXT_DIRECTION")
- (values
- '("none" "GTK_TEXT_DIR_NONE")
- '("ltr" "GTK_TEXT_DIR_LTR")
- '("rtl" "GTK_TEXT_DIR_RTL")
- )
-)
-
-(define-enum TextWindowType
- (in-module "Gtk")
- (c-name "GtkTextWindowType")
- (gtype-id "GTK_TYPE_TEXT_WINDOW_TYPE")
- (values
- '("private" "GTK_TEXT_WINDOW_PRIVATE")
- '("widget" "GTK_TEXT_WINDOW_WIDGET")
- '("text" "GTK_TEXT_WINDOW_TEXT")
- '("left" "GTK_TEXT_WINDOW_LEFT")
- '("right" "GTK_TEXT_WINDOW_RIGHT")
- '("top" "GTK_TEXT_WINDOW_TOP")
- '("bottom" "GTK_TEXT_WINDOW_BOTTOM")
- )
-)
-
-(define-enum ToolbarChildType
- (in-module "Gtk")
- (c-name "GtkToolbarChildType")
- (gtype-id "GTK_TYPE_TOOLBAR_CHILD_TYPE")
- (values
- '("space" "GTK_TOOLBAR_CHILD_SPACE")
- '("button" "GTK_TOOLBAR_CHILD_BUTTON")
- '("togglebutton" "GTK_TOOLBAR_CHILD_TOGGLEBUTTON")
- '("radiobutton" "GTK_TOOLBAR_CHILD_RADIOBUTTON")
- '("widget" "GTK_TOOLBAR_CHILD_WIDGET")
- )
-)
-
-(define-enum ToolbarSpaceStyle
- (in-module "Gtk")
- (c-name "GtkToolbarSpaceStyle")
- (gtype-id "GTK_TYPE_TOOLBAR_SPACE_STYLE")
- (values
- '("empty" "GTK_TOOLBAR_SPACE_EMPTY")
- '("line" "GTK_TOOLBAR_SPACE_LINE")
- )
-)
-
-(define-enum ToolbarStyle
- (in-module "Gtk")
- (c-name "GtkToolbarStyle")
- (gtype-id "GTK_TYPE_TOOLBAR_STYLE")
- (values
- '("icons" "GTK_TOOLBAR_ICONS")
- '("text" "GTK_TOOLBAR_TEXT")
- '("both" "GTK_TOOLBAR_BOTH")
- '("both-horiz" "GTK_TOOLBAR_BOTH_HORIZ")
- )
-)
-
-(define-enum TreeViewColumnSizing
- (in-module "Gtk")
- (c-name "GtkTreeViewColumnSizing")
- (gtype-id "GTK_TYPE_TREE_VIEW_COLUMN_SIZING")
- (values
- '("grow-only" "GTK_TREE_VIEW_COLUMN_GROW_ONLY")
- '("autosize" "GTK_TREE_VIEW_COLUMN_AUTOSIZE")
- '("fixed" "GTK_TREE_VIEW_COLUMN_FIXED")
- )
-)
-
-(define-enum TreeViewDropPosition
- (in-module "Gtk")
- (c-name "GtkTreeViewDropPosition")
- (gtype-id "GTK_TYPE_TREE_VIEW_DROP_POSITION")
- (values
- '("before" "GTK_TREE_VIEW_DROP_BEFORE")
- '("after" "GTK_TREE_VIEW_DROP_AFTER")
- '("into-or-before" "GTK_TREE_VIEW_DROP_INTO_OR_BEFORE")
- '("into-or-after" "GTK_TREE_VIEW_DROP_INTO_OR_AFTER")
- )
-)
-
-(define-enum TreeViewMode
- (in-module "Gtk")
- (c-name "GtkTreeViewMode")
- (gtype-id "GTK_TYPE_TREE_VIEW_MODE")
- (values
- '("line" "GTK_TREE_VIEW_LINE")
- '("item" "GTK_TREE_VIEW_ITEM")
- )
-)
-
-(define-enum UpdateType
- (in-module "Gtk")
- (c-name "GtkUpdateType")
- (gtype-id "GTK_TYPE_UPDATE_TYPE")
- (values
- '("continuous" "GTK_UPDATE_CONTINUOUS")
- '("discontinuous" "GTK_UPDATE_DISCONTINUOUS")
- '("delayed" "GTK_UPDATE_DELAYED")
- )
-)
-
-(define-enum Visibility
- (in-module "Gtk")
- (c-name "GtkVisibility")
- (gtype-id "GTK_TYPE_VISIBILITY")
- (values
- '("none" "GTK_VISIBILITY_NONE")
- '("partial" "GTK_VISIBILITY_PARTIAL")
- '("full" "GTK_VISIBILITY_FULL")
- )
-)
-
-(define-enum WidgetHelpType
- (in-module "Gtk")
- (c-name "GtkWidgetHelpType")
- (gtype-id "GTK_TYPE_WIDGET_HELP_TYPE")
- (values
- '("tooltip" "GTK_WIDGET_HELP_TOOLTIP")
- '("whats-this" "GTK_WIDGET_HELP_WHATS_THIS")
- )
-)
-
-(define-enum WindowPosition
- (in-module "Gtk")
- (c-name "GtkWindowPosition")
- (gtype-id "GTK_TYPE_WINDOW_POSITION")
- (values
- '("none" "GTK_WIN_POS_NONE")
- '("center" "GTK_WIN_POS_CENTER")
- '("mouse" "GTK_WIN_POS_MOUSE")
- '("center-always" "GTK_WIN_POS_CENTER_ALWAYS")
- '("center-on-parent" "GTK_WIN_POS_CENTER_ON_PARENT")
- )
-)
-
-(define-enum WindowType
- (in-module "Gtk")
- (c-name "GtkWindowType")
- (gtype-id "GTK_TYPE_WINDOW_TYPE")
- (values
- '("toplevel" "GTK_WINDOW_TOPLEVEL")
- '("popup" "GTK_WINDOW_POPUP")
- )
-)
-
-(define-enum WrapMode
- (in-module "Gtk")
- (c-name "GtkWrapMode")
- (gtype-id "GTK_TYPE_WRAP_MODE")
- (values
- '("none" "GTK_WRAP_NONE")
- '("char" "GTK_WRAP_CHAR")
- '("word" "GTK_WRAP_WORD")
- '("word_char" "GTK_WRAP_WORD_CHAR")
- )
-)
-
-;; Flags ...
-
-(define-flags AccelFlags
- (in-module "Gtk")
- (c-name "GtkAccelFlags")
- (gtype-id "GTK_TYPE_ACCEL_FLAGS")
- (values
- '("visible" "GTK_ACCEL_VISIBLE")
- '("locked" "GTK_ACCEL_LOCKED")
- '("mask" "GTK_ACCEL_MASK")
- )
-)
-
-(define-flags ArgFlags
- (in-module "Gtk")
- (c-name "GtkArgFlags")
- (gtype-id "GTK_TYPE_ARG_FLAGS")
- (values
- '("readable" "GTK_ARG_READABLE")
- '("writable" "GTK_ARG_WRITABLE")
- '("construct" "GTK_ARG_CONSTRUCT")
- '("construct-only" "GTK_ARG_CONSTRUCT_ONLY")
- '("child-arg" "GTK_ARG_CHILD_ARG")
- )
-)
-
-(define-flags AttachOptions
- (in-module "Gtk")
- (c-name "GtkAttachOptions")
- (gtype-id "GTK_TYPE_ATTACH_OPTIONS")
- (values
- '("expand" "GTK_EXPAND")
- '("shrink" "GTK_SHRINK")
- '("fill" "GTK_FILL")
- )
-)
-
-(define-flags ButtonAction
- (in-module "Gtk")
- (c-name "GtkButtonAction")
- (gtype-id "GTK_TYPE_BUTTON_ACTION")
- (values
- '("ignored" "GTK_BUTTON_IGNORED")
- '("selects" "GTK_BUTTON_SELECTS")
- '("drags" "GTK_BUTTON_DRAGS")
- '("expands" "GTK_BUTTON_EXPANDS")
- )
-)
-
-(define-flags CalendarDisplayOptions
- (in-module "Gtk")
- (c-name "GtkCalendarDisplayOptions")
- (gtype-id "GTK_TYPE_CALENDAR_DISPLAY_OPTIONS")
- (values
- '("show-heading" "GTK_CALENDAR_SHOW_HEADING")
- '("show-day-names" "GTK_CALENDAR_SHOW_DAY_NAMES")
- '("no-month-change" "GTK_CALENDAR_NO_MONTH_CHANGE")
- '("show-week-numbers" "GTK_CALENDAR_SHOW_WEEK_NUMBERS")
- '("week-start-monday" "GTK_CALENDAR_WEEK_START_MONDAY")
- )
-)
-
-(define-flags CellRendererState
- (in-module "Gtk")
- (c-name "GtkCellRendererState")
- (gtype-id "GTK_TYPE_CELL_RENDERER_STATE")
- (values
- '("selected" "GTK_CELL_RENDERER_SELECTED")
- '("prelit" "GTK_CELL_RENDERER_PRELIT")
- '("insensitive" "GTK_CELL_RENDERER_INSENSITIVE")
- '("sorted" "GTK_CELL_RENDERER_SORTED")
- '("focused" "GTK_CELL_RENDERER_FOCUSED")
- )
-)
-
-(define-flags DebugFlag
- (in-module "Gtk")
- (c-name "GtkDebugFlag")
- (gtype-id "GTK_TYPE_DEBUG_FLAG")
- (values
- '("misc" "GTK_DEBUG_MISC")
- '("plugsocket" "GTK_DEBUG_PLUGSOCKET")
- '("text" "GTK_DEBUG_TEXT")
- '("tree" "GTK_DEBUG_TREE")
- '("updates" "GTK_DEBUG_UPDATES")
- '("keybindings" "GTK_DEBUG_KEYBINDINGS")
- '("multihead" "GTK_DEBUG_MULTIHEAD")
- )
-)
-
-(define-flags DestDefaults
- (in-module "Gtk")
- (c-name "GtkDestDefaults")
- (gtype-id "GTK_TYPE_DEST_DEFAULTS")
- (values
- '("motion" "GTK_DEST_DEFAULT_MOTION")
- '("highlight" "GTK_DEST_DEFAULT_HIGHLIGHT")
- '("drop" "GTK_DEST_DEFAULT_DROP")
- '("all" "GTK_DEST_DEFAULT_ALL")
- )
-)
-
-(define-flags DialogFlags
- (in-module "Gtk")
- (c-name "GtkDialogFlags")
- (gtype-id "GTK_TYPE_DIALOG_FLAGS")
- (values
- '("modal" "GTK_DIALOG_MODAL")
- '("destroy-with-parent" "GTK_DIALOG_DESTROY_WITH_PARENT")
- '("no-separator" "GTK_DIALOG_NO_SEPARATOR")
- )
-)
-
-(define-flags FileFilterFlags
- (in-module "Gtk")
- (c-name "GtkFileFilterFlags")
- (gtype-id "GTK_TYPE_FILE_FILTER_FLAGS")
- (values
- '("filename" "GTK_FILE_FILTER_FILENAME")
- '("uri" "GTK_FILE_FILTER_URI")
- '("display-name" "GTK_FILE_FILTER_DISPLAY_NAME")
- '("mime-type" "GTK_FILE_FILTER_MIME_TYPE")
- )
-)
-
-(define-flags IconLookupFlags
- (in-module "Gtk")
- (c-name "GtkIconLookupFlags")
- (gtype-id "GTK_TYPE_ICON_LOOKUP_FLAGS")
- (values
- '("no-svg" "GTK_ICON_LOOKUP_NO_SVG")
- '("force-svg" "GTK_ICON_LOOKUP_FORCE_SVG")
- '("use-builtin" "GTK_ICON_LOOKUP_USE_BUILTIN")
- )
-)
-
-(define-flags ObjectFlags
- (in-module "Gtk")
- (c-name "GtkObjectFlags")
- (gtype-id "GTK_TYPE_OBJECT_FLAGS")
- (values
- '("in-destruction" "GTK_IN_DESTRUCTION")
- '("floating" "GTK_FLOATING")
- '("reserved-1" "GTK_RESERVED_1")
- '("reserved-2" "GTK_RESERVED_2")
- )
-)
-
-(define-flags PrivateFlags
- (in-module "Gtk")
- (c-name "GtkPrivateFlags")
- (gtype-id "GTK_TYPE_PRIVATE_FLAGS")
- (values
- '("user-style" "PRIVATE_GTK_USER_STYLE")
- '("resize-pending" "PRIVATE_GTK_RESIZE_PENDING")
- '("leave-pending" "PRIVATE_GTK_LEAVE_PENDING")
- '("has-shape-mask" "PRIVATE_GTK_HAS_SHAPE_MASK")
- '("in-reparent" "PRIVATE_GTK_IN_REPARENT")
- '("direction-set" "PRIVATE_GTK_DIRECTION_SET")
- '("direction-ltr" "PRIVATE_GTK_DIRECTION_LTR")
- '("anchored" "PRIVATE_GTK_ANCHORED")
- '("child-visible" "PRIVATE_GTK_CHILD_VISIBLE")
- '("redraw-on-alloc" "PRIVATE_GTK_REDRAW_ON_ALLOC")
- '("alloc-needed" "PRIVATE_GTK_ALLOC_NEEDED")
- '("request-needed" "PRIVATE_GTK_REQUEST_NEEDED")
- )
-)
-
-(define-flags RcFlags
- (in-module "Gtk")
- (c-name "GtkRcFlags")
- (gtype-id "GTK_TYPE_RC_FLAGS")
- (values
- '("fg" "GTK_RC_FG")
- '("bg" "GTK_RC_BG")
- '("text" "GTK_RC_TEXT")
- '("base" "GTK_RC_BASE")
- )
-)
-
-(define-flags TargetFlags
- (in-module "Gtk")
- (c-name "GtkTargetFlags")
- (gtype-id "GTK_TYPE_TARGET_FLAGS")
- (values
- '("app" "GTK_TARGET_SAME_APP")
- '("widget" "GTK_TARGET_SAME_WIDGET")
- )
-)
-
-(define-flags TextSearchFlags
- (in-module "Gtk")
- (c-name "GtkTextSearchFlags")
- (gtype-id "GTK_TYPE_TEXT_SEARCH_FLAGS")
- (values
- '("visible-only" "GTK_TEXT_SEARCH_VISIBLE_ONLY")
- '("text-only" "GTK_TEXT_SEARCH_TEXT_ONLY")
- )
- )
-
-(define-flags TreeModelFlags
- (in-module "Gtk")
- (c-name "GtkTreeModelFlags")
- (gtype-id "GTK_TYPE_TREE_MODEL_FLAGS")
- (values
- '("iters-persist" "GTK_TREE_MODEL_ITERS_PERSIST")
- '("list-only" "GTK_TREE_MODEL_LIST_ONLY")
- )
-)
-
-(define-flags UIManagerItemType
- (in-module "Gtk")
- (c-name "GtkUIManagerItemType")
- (gtype-id "GTK_TYPE_UI_MANAGER_ITEM_TYPE")
- (values
- '("auto" "GTK_UI_MANAGER_AUTO")
- '("menubar" "GTK_UI_MANAGER_MENUBAR")
- '("menu" "GTK_UI_MANAGER_MENU")
- '("toolbar" "GTK_UI_MANAGER_TOOLBAR")
- '("placeholder" "GTK_UI_MANAGER_PLACEHOLDER")
- '("popup" "GTK_UI_MANAGER_POPUP")
- '("menuitem" "GTK_UI_MANAGER_MENUITEM")
- '("toolitem" "GTK_UI_MANAGER_TOOLITEM")
- '("separator" "GTK_UI_MANAGER_SEPARATOR")
- '("accelerator" "GTK_UI_MANAGER_ACCELERATOR")
- )
-)
-
-(define-flags WidgetFlags
- (in-module "Gtk")
- (c-name "GtkWidgetFlags")
- (gtype-id "GTK_TYPE_WIDGET_FLAGS")
- (values
- '("toplevel" "GTK_TOPLEVEL")
- '("no-window" "GTK_NO_WINDOW")
- '("realized" "GTK_REALIZED")
- '("mapped" "GTK_MAPPED")
- '("visible" "GTK_VISIBLE")
- '("sensitive" "GTK_SENSITIVE")
- '("parent-sensitive" "GTK_PARENT_SENSITIVE")
- '("can-focus" "GTK_CAN_FOCUS")
- '("has-focus" "GTK_HAS_FOCUS")
- '("can-default" "GTK_CAN_DEFAULT")
- '("has-default" "GTK_HAS_DEFAULT")
- '("has-grab" "GTK_HAS_GRAB")
- '("rc-style" "GTK_RC_STYLE")
- '("composite-child" "GTK_COMPOSITE_CHILD")
- '("no-reparent" "GTK_NO_REPARENT")
- '("app-paintable" "GTK_APP_PAINTABLE")
- '("receives-default" "GTK_RECEIVES_DEFAULT")
- '("double-buffered" "GTK_DOUBLE_BUFFERED")
- '("no-show-all" "GTK_NO_SHOW_ALL")
- )
-)
-
-;; Interfaces ...
-
-(define-interface CellEditable
- (in-module "Gtk")
- (c-name "GtkCellEditable")
- (gtype-id "GTK_TYPE_CELL_EDITABLE")
- (prerequisite "GtkWidget")
-)
-
-(define-interface CellLayout
- (in-module "Gtk")
- (c-name "GtkCellLayout")
- (gtype-id "GTK_TYPE_CELL_LAYOUT")
- (prerequisite "GObject")
-)
-
-(define-interface Editable
- (in-module "Gtk")
- (c-name "GtkEditable")
- (gtype-id "GTK_TYPE_EDITABLE")
- (vtable "GtkEditableClass")
- (prerequisite "GtkWidget")
-)
-
-(define-interface FileChooser
- (in-module "Gtk")
- (c-name "GtkFileChooser")
- (gtype-id "GTK_TYPE_FILE_CHOOSER")
- (prerequisite "GtkWidget")
-)
-
-(define-interface TreeDragDest
- (in-module "Gtk")
- (c-name "GtkTreeDragDest")
- (gtype-id "GTK_TYPE_TREE_DRAG_DEST")
-)
-
-(define-interface TreeDragSource
- (in-module "Gtk")
- (c-name "GtkTreeDragSource")
- (gtype-id "GTK_TYPE_TREE_DRAG_SOURCE")
-)
-
-(define-interface TreeModel
- (in-module "Gtk")
- (c-name "GtkTreeModel")
- (gtype-id "GTK_TYPE_TREE_MODEL")
- (prerequisite "GObject")
-)
-
-(define-interface TreeSortable
- (in-module "Gtk")
- (c-name "GtkTreeSortable")
- (gtype-id "GTK_TYPE_TREE_SORTABLE")
- (prerequisite "GtkTreeModel")
- (prerequisite "GObject")
-)
-
-;; Objects ...
-
-(define-object AboutDialog
- (in-module "Gtk")
- (parent "GtkDialog")
- (c-name "GtkAboutDialog")
- (gtype-id "GTK_TYPE_ABOUT_DIALOG")
-)
-
-(define-object AccelGroup
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkAccelGroup")
- (gtype-id "GTK_TYPE_ACCEL_GROUP")
-)
-
-(define-object AccelLabel
- (in-module "Gtk")
- (parent "GtkLabel")
- (c-name "GtkAccelLabel")
- (gtype-id "GTK_TYPE_ACCEL_LABEL")
-)
-
-(define-object AccelMap
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkAccelMap")
- (gtype-id "GTK_TYPE_ACCEL_MAP")
-)
-
-(define-object Accessible
- (in-module "Gtk")
- (parent "AtkObject")
- (c-name "GtkAccessible")
- (gtype-id "GTK_TYPE_ACCESSIBLE")
-)
-
-(define-object Action
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkAction")
- (gtype-id "GTK_TYPE_ACTION")
-)
-
-(define-object ActionGroup
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkActionGroup")
- (gtype-id "GTK_TYPE_ACTION_GROUP")
-)
-
-(define-object Adjustment
- (in-module "Gtk")
- (parent "GtkObject")
- (c-name "GtkAdjustment")
- (gtype-id "GTK_TYPE_ADJUSTMENT")
- (fields
- '("gfloat" "value")
- '("gfloat" "lower")
- '("gfloat" "upper")
- '("gfloat" "step_increment")
- '("gfloat" "page_increment")
- '("gfloat" "page_size")
- )
-)
-
-(define-object Alignment
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkAlignment")
- (gtype-id "GTK_TYPE_ALIGNMENT")
-)
-
-(define-object Arrow
- (in-module "Gtk")
- (parent "GtkMisc")
- (c-name "GtkArrow")
- (gtype-id "GTK_TYPE_ARROW")
-)
-
-(define-object AspectFrame
- (in-module "Gtk")
- (parent "GtkFrame")
- (c-name "GtkAspectFrame")
- (gtype-id "GTK_TYPE_ASPECT_FRAME")
-)
-
-(define-object Bin
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkBin")
- (gtype-id "GTK_TYPE_BIN")
- (fields
- '("GtkWidget*" "child")
- )
-)
-
-(define-object Box
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkBox")
- (gtype-id "GTK_TYPE_BOX")
-)
-
-(define-object Button
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkButton")
- (gtype-id "GTK_TYPE_BUTTON")
-)
-
-(define-object ButtonBox
- (in-module "Gtk")
- (parent "GtkBox")
- (c-name "GtkButtonBox")
- (gtype-id "GTK_TYPE_BUTTON_BOX")
-)
-
-(define-object Calendar
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkCalendar")
- (gtype-id "GTK_TYPE_CALENDAR")
-)
-
-(define-object CellRenderer
- (in-module "Gtk")
- (parent "GtkObject")
- (c-name "GtkCellRenderer")
- (gtype-id "GTK_TYPE_CELL_RENDERER")
-)
-
-(define-object CellRendererCombo
- (in-module "Gtk")
- (parent "GtkCellRendererText")
- (c-name "GtkCellRendererCombo")
- (gtype-id "GTK_TYPE_CELL_RENDERER_COMBO")
-)
-
-(define-object CellRendererPixbuf
- (in-module "Gtk")
- (parent "GtkCellRenderer")
- (c-name "GtkCellRendererPixbuf")
- (gtype-id "GTK_TYPE_CELL_RENDERER_PIXBUF")
-)
-
-(define-object CellRendererProgress
- (in-module "Gtk")
- (parent "GtkCellRenderer")
- (c-name "GtkCellRendererProgress")
- (gtype-id "GTK_TYPE_CELL_RENDERER_PROGRESS")
-)
-
-(define-object CellRendererText
- (in-module "Gtk")
- (parent "GtkCellRenderer")
- (c-name "GtkCellRendererText")
- (gtype-id "GTK_TYPE_CELL_RENDERER_TEXT")
-)
-
-(define-object CellRendererToggle
- (in-module "Gtk")
- (parent "GtkCellRenderer")
- (c-name "GtkCellRendererToggle")
- (gtype-id "GTK_TYPE_CELL_RENDERER_TOGGLE")
-)
-
-(define-object CellView
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkCellView")
- (gtype-id "GTK_TYPE_CELL_VIEW")
- (implements "GtkCellLayout")
-)
-
-(define-object CheckButton
- (in-module "Gtk")
- (parent "GtkToggleButton")
- (c-name "GtkCheckButton")
- (gtype-id "GTK_TYPE_CHECK_BUTTON")
-)
-
-(define-object CheckMenuItem
- (in-module "Gtk")
- (parent "GtkMenuItem")
- (c-name "GtkCheckMenuItem")
- (gtype-id "GTK_TYPE_CHECK_MENU_ITEM")
- (fields
- '("gboolean" "active")
- )
-)
-
-(define-object Clipboard
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkClipboard")
- (gtype-id "GTK_TYPE_CLIPBOARD")
-)
-
-(define-object CList
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkCList")
- (gtype-id "GTK_TYPE_CLIST")
- (fields
- '("GList*" "selection")
- '("gint" "focus_row")
- '("gint" "rows")
- '("gint" "columns")
- )
-)
-
-(define-object ColorButton
- (in-module "Gtk")
- (parent "GtkButton")
- (c-name "GtkColorButton")
- (gtype-id "GTK_TYPE_COLOR_BUTTON")
-)
-
-(define-object ColorSelection
- (in-module "Gtk")
- (parent "GtkVBox")
- (c-name "GtkColorSelection")
- (gtype-id "GTK_TYPE_COLOR_SELECTION")
-)
-
-(define-object ColorSelectionDialog
- (in-module "Gtk")
- (parent "GtkDialog")
- (c-name "GtkColorSelectionDialog")
- (gtype-id "GTK_TYPE_COLOR_SELECTION_DIALOG")
- (fields
- '("GtkWidget*" "colorsel")
- '("GtkWidget*" "ok_button")
- '("GtkWidget*" "cancel_button")
- '("GtkWidget*" "help_button")
- )
-)
-
-(define-object Combo
- (in-module "Gtk")
- (parent "GtkHBox")
- (c-name "GtkCombo")
- (gtype-id "GTK_TYPE_COMBO")
- (fields
- '("GtkWidget*" "entry")
- '("GtkWidget*" "list")
- )
-)
-
-(define-object ComboBox
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkComboBox")
- (gtype-id "GTK_TYPE_COMBO_BOX")
- (implements "GtkCellEditable")
- (implements "GtkCellLayout")
-)
-
-(define-object ComboBoxEntry
- (in-module "Gtk")
- (parent "GtkComboBox")
- (c-name "GtkComboBoxEntry")
- (gtype-id "GTK_TYPE_COMBO_BOX_ENTRY")
- (implements "GtkCellEditable")
- (implements "GtkCellLayout")
-)
-
-(define-object Container
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkContainer")
- (gtype-id "GTK_TYPE_CONTAINER")
- (fields
- '("GtkWidget*" "focus_child")
- '("guint" "border_width")
- '("guint" "need_resize")
- '("guint" "resize_mode")
- '("guint" "reallocate_redraws")
- '("guint" "has_focus_chain")
- )
-)
-
-
-(define-object CTree
- (in-module "Gtk")
- (parent "GtkCList")
- (c-name "GtkCTree")
- (gtype-id "GTK_TYPE_CTREE")
- (fields
- '("GList*" "selection")
- )
-)
-
-(define-object Curve
- (in-module "Gtk")
- (parent "GtkDrawingArea")
- (c-name "GtkCurve")
- (gtype-id "GTK_TYPE_CURVE")
-)
-
-(define-object Dialog
- (in-module "Gtk")
- (parent "GtkWindow")
- (c-name "GtkDialog")
- (gtype-id "GTK_TYPE_DIALOG")
- (fields
- '("GtkWidget*" "vbox")
- '("GtkWidget*" "action_area")
- )
-)
-
-(define-object DrawingArea
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkDrawingArea")
- (gtype-id "GTK_TYPE_DRAWING_AREA")
-)
-
-(define-object Entry
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkEntry")
- (gtype-id "GTK_TYPE_ENTRY")
- (implements "GtkEditable")
- (implements "GtkCellEditable")
-)
-
-(define-object EntryCompletion
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkEntryCompletion")
- (gtype-id "GTK_TYPE_ENTRY_COMPLETION")
- (implements "GtkCellLayout")
-)
-
-(define-object EventBox
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkEventBox")
- (gtype-id "GTK_TYPE_EVENT_BOX")
-)
-
-(define-object Expander
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkExpander")
- (gtype-id "GTK_TYPE_EXPANDER")
-)
-
-(define-object FileChooserButton
- (in-module "Gtk")
- (parent "GtkHBox")
- (c-name "GtkFileChooserButton")
- (gtype-id "GTK_TYPE_FILE_CHOOSER_BUTTON")
- (implements "GtkFileChooser")
-)
-
-(define-object FileChooserDialog
- (in-module "Gtk")
- (parent "GtkDialog")
- (c-name "GtkFileChooserDialog")
- (gtype-id "GTK_TYPE_FILE_CHOOSER_DIALOG")
- (implements "GtkFileChooser")
-)
-
-(define-object FileChooserWidget
- (in-module "Gtk")
- (parent "GtkVBox")
- (c-name "GtkFileChooserWidget")
- (gtype-id "GTK_TYPE_FILE_CHOOSER_WIDGET")
- (implements "GtkFileChooser")
-)
-
-(define-object FileFilter
- (in-module "Gtk")
- (parent "GtkObject")
- (c-name "GtkFileFilter")
- (gtype-id "GTK_TYPE_FILE_FILTER")
-)
-
-(define-object FileSelection
- (in-module "Gtk")
- (parent "GtkDialog")
- (c-name "GtkFileSelection")
- (gtype-id "GTK_TYPE_FILE_SELECTION")
- (fields
- '("GtkWidget*" "dir_list")
- '("GtkWidget*" "file_list")
- '("GtkWidget*" "selection_entry")
- '("GtkWidget*" "selection_text")
- '("GtkWidget*" "main_vbox")
- '("GtkWidget*" "ok_button")
- '("GtkWidget*" "cancel_button")
- '("GtkWidget*" "help_button")
- '("GtkWidget*" "history_pulldown")
- '("GtkWidget*" "history_menu")
- '("GtkWidget*" "fileop_dialog")
- '("GtkWidget*" "fileop_entry")
- '("gchar*" "fileop_file")
- '("GtkWidget*" "fileop_c_dir")
- '("GtkWidget*" "fileop_del_file")
- '("GtkWidget*" "fileop_ren_file")
- '("GtkWidget*" "button_area")
- '("GtkWidget*" "action_area")
- )
-)
-
-(define-object Fixed
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkFixed")
- (gtype-id "GTK_TYPE_FIXED")
-)
-
-(define-object FontButton
- (in-module "Gtk")
- (parent "GtkButton")
- (c-name "GtkFontButton")
- (gtype-id "GTK_TYPE_FONT_BUTTON")
-)
-
-(define-object FontSelection
- (in-module "Gtk")
- (parent "GtkVBox")
- (c-name "GtkFontSelection")
- (gtype-id "GTK_TYPE_FONT_SELECTION")
-)
-
-(define-object FontSelectionDialog
- (in-module "Gtk")
- (parent "GtkDialog")
- (c-name "GtkFontSelectionDialog")
- (gtype-id "GTK_TYPE_FONT_SELECTION_DIALOG")
- (fields
- '("GtkWidget*" "fontsel")
- '("GtkWidget*" "main_vbox")
- '("GtkWidget*" "action_area")
- '("GtkWidget*" "ok_button")
- '("GtkWidget*" "apply_button")
- '("GtkWidget*" "cancel_button")
- )
-)
-
-(define-object Frame
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkFrame")
- (gtype-id "GTK_TYPE_FRAME")
-)
-
-(define-object GammaCurve
- (in-module "Gtk")
- (parent "GtkVBox")
- (c-name "GtkGammaCurve")
- (gtype-id "GTK_TYPE_GAMMA_CURVE")
- (fields
- '("GtkWidget*" "table")
- '("GtkWidget*" "curve")
- '("gfloat" "gamma")
- '("GtkWidget*" "gamma_dialog")
- '("GtkWidget*" "gamma_text")
- )
-)
-
-(define-object HandleBox
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkHandleBox")
- (gtype-id "GTK_TYPE_HANDLE_BOX")
-)
-
-(define-object HBox
- (in-module "Gtk")
- (parent "GtkBox")
- (c-name "GtkHBox")
- (gtype-id "GTK_TYPE_HBOX")
-)
-
-(define-object HButtonBox
- (in-module "Gtk")
- (parent "GtkButtonBox")
- (c-name "GtkHButtonBox")
- (gtype-id "GTK_TYPE_HBUTTON_BOX")
-)
-
-(define-object HPaned
- (in-module "Gtk")
- (parent "GtkPaned")
- (c-name "GtkHPaned")
- (gtype-id "GTK_TYPE_HPANED")
-)
-
-(define-object HRuler
- (in-module "Gtk")
- (parent "GtkRuler")
- (c-name "GtkHRuler")
- (gtype-id "GTK_TYPE_HRULER")
-)
-
-(define-object HScale
- (in-module "Gtk")
- (parent "GtkScale")
- (c-name "GtkHScale")
- (gtype-id "GTK_TYPE_HSCALE")
-)
-
-(define-object HScrollbar
- (in-module "Gtk")
- (parent "GtkScrollbar")
- (c-name "GtkHScrollbar")
- (gtype-id "GTK_TYPE_HSCROLLBAR")
-)
-
-(define-object HSeparator
- (in-module "Gtk")
- (parent "GtkSeparator")
- (c-name "GtkHSeparator")
- (gtype-id "GTK_TYPE_HSEPARATOR")
-)
-
-(define-object IconFactory
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkIconFactory")
- (gtype-id "GTK_TYPE_ICON_FACTORY")
-)
-
-(define-object IconTheme
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkIconTheme")
- (gtype-id "GTK_TYPE_ICON_THEME")
-)
-
-(define-object IconView
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkIconView")
- (gtype-id "GTK_TYPE_ICON_VIEW")
- (implements "GtkCellLayout")
-)
-
-(define-object Image
- (in-module "Gtk")
- (parent "GtkMisc")
- (c-name "GtkImage")
- (gtype-id "GTK_TYPE_IMAGE")
-)
-
-(define-object ImageMenuItem
- (in-module "Gtk")
- (parent "GtkMenuItem")
- (c-name "GtkImageMenuItem")
- (gtype-id "GTK_TYPE_IMAGE_MENU_ITEM")
-)
-
-(define-object IMContext
- (in-module "Gtk")
- (parent "GtkObject")
- (c-name "GtkIMContext")
- (gtype-id "GTK_TYPE_IM_CONTEXT")
-)
-
-(define-object IMContextSimple
- (in-module "Gtk")
- (parent "GtkIMContext")
- (c-name "GtkIMContextSimple")
- (gtype-id "GTK_TYPE_IM_CONTEXT_SIMPLE")
-)
-
-(define-object IMMulticontext
- (in-module "Gtk")
- (parent "GtkIMContext")
- (c-name "GtkIMMulticontext")
- (gtype-id "GTK_TYPE_IM_MULTICONTEXT")
-)
-
-(define-object InputDialog
- (in-module "Gtk")
- (parent "GtkDialog")
- (c-name "GtkInputDialog")
- (gtype-id "GTK_TYPE_INPUT_DIALOG")
-)
-
-(define-object Invisible
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkInvisible")
- (gtype-id "GTK_TYPE_INVISIBLE")
-)
-
-(define-object Item
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkItem")
- (gtype-id "GTK_TYPE_ITEM")
-)
-
-(define-object ItemFactory
- (in-module "Gtk")
- (parent "GtkObject")
- (c-name "GtkItemFactory")
- (gtype-id "GTK_TYPE_ITEM_FACTORY")
-)
-
-(define-object Label
- (in-module "Gtk")
- (parent "GtkMisc")
- (c-name "GtkLabel")
- (gtype-id "GTK_TYPE_LABEL")
-)
-
-(define-object Layout
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkLayout")
- (gtype-id "GTK_TYPE_LAYOUT")
- (fields
- '("GdkWindow*" "bin_window")
- )
-)
-
-(define-object List
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkList")
- (gtype-id "GTK_TYPE_LIST")
- (fields
- '("GList*" "selection")
- )
-)
-
-(define-object ListItem
- (in-module "Gtk")
- (parent "GtkItem")
- (c-name "GtkListItem")
- (gtype-id "GTK_TYPE_LIST_ITEM")
-)
-
-(define-object ListStore
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkListStore")
- (gtype-id "GTK_TYPE_LIST_STORE")
- (implements "GtkTreeModel")
- (implements "GtkTreeDragSource")
- (implements "GtkTreeDragDest")
- (implements "GtkTreeSortable")
-)
-
-(define-object Menu
- (in-module "Gtk")
- (parent "GtkMenuShell")
- (c-name "GtkMenu")
- (gtype-id "GTK_TYPE_MENU")
-)
-
-(define-object MenuBar
- (in-module "Gtk")
- (parent "GtkMenuShell")
- (c-name "GtkMenuBar")
- (gtype-id "GTK_TYPE_MENU_BAR")
-)
-
-(define-object MenuItem
- (in-module "Gtk")
- (parent "GtkItem")
- (c-name "GtkMenuItem")
- (gtype-id "GTK_TYPE_MENU_ITEM")
-)
-
-(define-object MenuShell
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkMenuShell")
- (gtype-id "GTK_TYPE_MENU_SHELL")
-)
-
-(define-object MenuToolButton
- (in-module "Gtk")
- (parent "GtkToolButton")
- (c-name "GtkMenuToolButton")
- (gtype-id "GTK_TYPE_MENU_TOOL_BUTTON")
-)
-
-(define-object MessageDialog
- (in-module "Gtk")
- (parent "GtkDialog")
- (c-name "GtkMessageDialog")
- (gtype-id "GTK_TYPE_MESSAGE_DIALOG")
- (fields
- '("GtkWidget*" "image")
- '("GtkWidget*" "label")
- )
-)
-
-(define-object Misc
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkMisc")
- (gtype-id "GTK_TYPE_MISC")
-)
-
-(define-object Notebook
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkNotebook")
- (gtype-id "GTK_TYPE_NOTEBOOK")
- (fields
- '("GtkPositionType" "tab_pos")
- )
-)
-
-(define-object Object
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkObject")
- (gtype-id "GTK_TYPE_OBJECT")
-)
-
-(define-object OldEditable
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkOldEditable")
- (gtype-id "GTK_TYPE_OLD_EDITABLE")
- (implements "GtkEditable")
-)
-
-(define-object OptionMenu
- (in-module "Gtk")
- (parent "GtkButton")
- (c-name "GtkOptionMenu")
- (gtype-id "GTK_TYPE_OPTION_MENU")
-)
-
-(define-object Paned
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkPaned")
- (gtype-id "GTK_TYPE_PANED")
-)
-
-(define-object Pixmap
- (in-module "Gtk")
- (parent "GtkMisc")
- (c-name "GtkPixmap")
- (gtype-id "GTK_TYPE_PIXMAP")
-)
-
-(define-object Plug
- (in-module "Gtk")
- (parent "GtkWindow")
- (c-name "GtkPlug")
- (gtype-id "GTK_TYPE_PLUG")
-)
-
-(define-object Preview
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkPreview")
- (gtype-id "GTK_TYPE_PREVIEW")
-)
-
-(define-object Progress
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkProgress")
- (gtype-id "GTK_TYPE_PROGRESS")
-)
-
-(define-object ProgressBar
- (in-module "Gtk")
- (parent "GtkProgress")
- (c-name "GtkProgressBar")
- (gtype-id "GTK_TYPE_PROGRESS_BAR")
-)
-
-(define-object RadioAction
- (in-module "Gtk")
- (parent "GtkToggleAction")
- (c-name "GtkRadioAction")
- (gtype-id "GTK_TYPE_RADIO_ACTION")
-)
-
-(define-object RadioButton
- (in-module "Gtk")
- (parent "GtkCheckButton")
- (c-name "GtkRadioButton")
- (gtype-id "GTK_TYPE_RADIO_BUTTON")
-)
-
-(define-object RadioMenuItem
- (in-module "Gtk")
- (parent "GtkCheckMenuItem")
- (c-name "GtkRadioMenuItem")
- (gtype-id "GTK_TYPE_RADIO_MENU_ITEM")
-)
-
-(define-object RadioToolButton
- (in-module "Gtk")
- (parent "GtkToggleToolButton")
- (c-name "GtkRadioToolButton")
- (gtype-id "GTK_TYPE_RADIO_TOOL_BUTTON")
-)
-
-(define-object Range
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkRange")
- (gtype-id "GTK_TYPE_RANGE")
-)
-
-(define-object RcStyle
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkRcStyle")
- (gtype-id "GTK_TYPE_RC_STYLE")
-)
-
-(define-object Ruler
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkRuler")
- (gtype-id "GTK_TYPE_RULER")
-)
-
-(define-object Scale
- (in-module "Gtk")
- (parent "GtkRange")
- (c-name "GtkScale")
- (gtype-id "GTK_TYPE_SCALE")
-)
-
-(define-object Scrollbar
- (in-module "Gtk")
- (parent "GtkRange")
- (c-name "GtkScrollbar")
- (gtype-id "GTK_TYPE_SCROLLBAR")
-)
-
-(define-object ScrolledWindow
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkScrolledWindow")
- (gtype-id "GTK_TYPE_SCROLLED_WINDOW")
-)
-
-(define-object Separator
- (in-module "Gtk")
- (parent "GtkWidget")
- (c-name "GtkSeparator")
- (gtype-id "GTK_TYPE_SEPARATOR")
-)
-
-(define-object SeparatorMenuItem
- (in-module "Gtk")
- (parent "GtkMenuItem")
- (c-name "GtkSeparatorMenuItem")
- (gtype-id "GTK_TYPE_SEPARATOR_MENU_ITEM")
-)
-
-(define-object SeparatorToolItem
- (in-module "Gtk")
- (parent "GtkToolItem")
- (c-name "GtkSeparatorToolItem")
- (gtype-id "GTK_TYPE_SEPARATOR_TOOL_ITEM")
-)
-
-(define-object Settings
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkSettings")
- (gtype-id "GTK_TYPE_SETTINGS")
-)
-
-(define-object SizeGroup
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkSizeGroup")
- (gtype-id "GTK_TYPE_SIZE_GROUP")
-)
-
-(define-object Socket
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkSocket")
- (gtype-id "GTK_TYPE_SOCKET")
-)
-
-(define-object SpinButton
- (in-module "Gtk")
- (parent "GtkEntry")
- (c-name "GtkSpinButton")
- (gtype-id "GTK_TYPE_SPIN_BUTTON")
- (implements "GtkEditable")
- (implements "GtkCellEditable")
-)
-
-(define-object Statusbar
- (in-module "Gtk")
- (parent "GtkHBox")
- (c-name "GtkStatusbar")
- (gtype-id "GTK_TYPE_STATUSBAR")
-)
-
-(define-object Style
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkStyle")
- (fields
- '("GdkColor*" "fg")
- '("GdkColor*" "bg")
- '("GdkColor*" "light")
- '("GdkColor*" "dark")
- '("GdkColor*" "mid")
- '("GdkColor*" "text")
- '("GdkColor*" "base")
- '("GdkColor*" "text_aa")
- '("GdkColor" "white")
- '("GdkColor" "black")
- '("PangoFontDescription*" "font_desc")
- '("gint" "xthickness")
- '("gint" "ythickness")
- '("GdkGC**" "fg_gc")
- '("GdkGC**" "bg_gc")
- '("GdkGC**" "light_gc")
- '("GdkGC**" "dark_gc")
- '("GdkGC**" "mid_gc")
- '("GdkGC**" "text_gc")
- '("GdkGC**" "base_gc")
- '("GdkGC**" "text_aa_gc")
- '("GdkGC*" "white_gc")
- '("GdkGC*" "black_gc")
- '("GdkPixmap**" "bg_pixmap")
- )
- (gtype-id "GTK_TYPE_STYLE")
-)
-
-(define-object Table
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkTable")
- (gtype-id "GTK_TYPE_TABLE")
-)
-
-(define-object TearoffMenuItem
- (in-module "Gtk")
- (parent "GtkMenuItem")
- (c-name "GtkTearoffMenuItem")
- (gtype-id "GTK_TYPE_TEAROFF_MENU_ITEM")
-)
-
-
-(define-object TextBuffer
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkTextBuffer")
- (gtype-id "GTK_TYPE_TEXT_BUFFER")
- (fields
- '("GtkTextTagTable*" "tag_table")
- )
-)
-
-(define-object TextChildAnchor
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkTextChildAnchor")
- (gtype-id "GTK_TYPE_TEXT_CHILD_ANCHOR")
-)
-
-(define-object TextMark
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkTextMark")
- (gtype-id "GTK_TYPE_TEXT_MARK")
-)
-
-(define-object TextTag
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkTextTag")
- (gtype-id "GTK_TYPE_TEXT_TAG")
-)
-
-(define-object TextTagTable
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkTextTagTable")
- (gtype-id "GTK_TYPE_TEXT_TAG_TABLE")
-)
-
-(define-object TextView
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkTextView")
- (gtype-id "GTK_TYPE_TEXT_VIEW")
-)
-
-(define-object ToggleAction
- (in-module "Gtk")
- (parent "GtkAction")
- (c-name "GtkToggleAction")
- (gtype-id "GTK_TYPE_TOGGLE_ACTION")
-)
-
-(define-object ToggleButton
- (in-module "Gtk")
- (parent "GtkButton")
- (c-name "GtkToggleButton")
- (gtype-id "GTK_TYPE_TOGGLE_BUTTON")
- (fields
- '("gboolean" "draw_indicator")
- )
-)
-
-(define-object ToggleToolButton
- (in-module "Gtk")
- (parent "GtkToolButton")
- (c-name "GtkToggleToolButton")
- (gtype-id "GTK_TYPE_TOGGLE_TOOL_BUTTON")
-)
-
-(define-object Toolbar
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkToolbar")
- (gtype-id "GTK_TYPE_TOOLBAR")
-)
-
-(define-object ToolButton
- (in-module "Gtk")
- (parent "GtkToolItem")
- (c-name "GtkToolButton")
- (gtype-id "GTK_TYPE_TOOL_BUTTON")
-)
-
-(define-object ToolItem
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkToolItem")
- (gtype-id "GTK_TYPE_TOOL_ITEM")
-)
-
-(define-object Tooltips
- (in-module "Gtk")
- (parent "GtkObject")
- (c-name "GtkTooltips")
- (fields
- '("GtkWidget*" "tip_window")
- '("GtkWidget*" "tip_label")
- '("GtkTooltipsData*" "active_tips_data")
- '("GList*" "tips_data_list")
- '("guint" "delay")
- '("guint" "enabled")
- '("guint" "use_sticky_delay")
- '("gint" "timer_tag")
- )
- (gtype-id "GTK_TYPE_TOOLTIPS")
-)
-
-(define-object TreeModelFilter
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkTreeModelFilter")
- (gtype-id "GTK_TYPE_TREE_MODEL_FILTER")
- (implements "GtkTreeModel")
- (implements "GtkTreeDragSource")
-)
-
-(define-object TreeModelSort
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkTreeModelSort")
- (gtype-id "GTK_TYPE_TREE_MODEL_SORT")
- (implements "GtkTreeModel")
- (implements "GtkTreeDragSource")
- (implements "GtkTreeSortable")
-)
-
-(define-object TreeSelection
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkTreeSelection")
- (gtype-id "GTK_TYPE_TREE_SELECTION")
-)
-
-(define-object TreeStore
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkTreeStore")
- (gtype-id "GTK_TYPE_TREE_STORE")
- (implements "GtkTreeModel")
- (implements "GtkTreeDragSource")
- (implements "GtkTreeDragDest")
- (implements "GtkTreeSortable")
-)
-
-(define-object TreeView
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkTreeView")
- (gtype-id "GTK_TYPE_TREE_VIEW")
-)
-
-(define-object TreeViewColumn
- (in-module "Gtk")
- (parent "GtkObject")
- (c-name "GtkTreeViewColumn")
- (gtype-id "GTK_TYPE_TREE_VIEW_COLUMN")
- (implements "GtkCellLayout")
-)
-
-(define-object UIManager
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkUIManager")
- (gtype-id "GTK_TYPE_UI_MANAGER")
-)
-
-(define-object VBox
- (in-module "Gtk")
- (parent "GtkBox")
- (c-name "GtkVBox")
- (gtype-id "GTK_TYPE_VBOX")
-)
-
-(define-object VButtonBox
- (in-module "Gtk")
- (parent "GtkButtonBox")
- (c-name "GtkVButtonBox")
- (gtype-id "GTK_TYPE_VBUTTON_BOX")
-)
-
-(define-object Viewport
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkViewport")
- (gtype-id "GTK_TYPE_VIEWPORT")
-)
-
-(define-object VPaned
- (in-module "Gtk")
- (parent "GtkPaned")
- (c-name "GtkVPaned")
- (gtype-id "GTK_TYPE_VPANED")
-)
-
-(define-object VRuler
- (in-module "Gtk")
- (parent "GtkRuler")
- (c-name "GtkVRuler")
- (gtype-id "GTK_TYPE_VRULER")
-)
-
-(define-object VScale
- (in-module "Gtk")
- (parent "GtkScale")
- (c-name "GtkVScale")
- (gtype-id "GTK_TYPE_VSCALE")
-)
-
-(define-object VScrollbar
- (in-module "Gtk")
- (parent "GtkScrollbar")
- (c-name "GtkVScrollbar")
- (gtype-id "GTK_TYPE_VSCROLLBAR")
-)
-
-(define-object VSeparator
- (in-module "Gtk")
- (parent "GtkSeparator")
- (c-name "GtkVSeparator")
- (gtype-id "GTK_TYPE_VSEPARATOR")
-)
-
-(define-object Widget
- (in-module "Gtk")
- (parent "GtkObject")
- (c-name "GtkWidget")
- (gtype-id "GTK_TYPE_WIDGET")
- (fields
- '("guint8" "state")
- '("guint8" "saved_state")
- '("gchar*" "name")
- '("GtkStyle*" "style")
- '("GdkRectangle" "allocation")
- '("GdkWindow*" "window")
- '("GtkWidget*" "parent")
- )
-)
-
-(define-object Window
- (in-module "Gtk")
- (parent "GtkBin")
- (c-name "GtkWindow")
- (gtype-id "GTK_TYPE_WINDOW")
- (fields
- '("gchar*" "title")
- '("gchar*" "wmclass_name")
- '("gchar*" "wmclass_class")
- '("gchar*" "wm_role")
- '("GtkWidget*" "focus_widget")
- '("GtkWidget*" "default_widget")
- '("GtkWindow*" "transient_parent")
-; '("GtkWindowGeometryInfo* "geometry_info")
- '("GdkWindow*" "frame")
- '("GtkWindowGroup*" "group")
- '("guint16" "configure_request_count")
- '("guint" "allow_shrink")
- '("guint" "allow_grow")
- '("guint" "configure_notify_received")
- '("guint" "need_default_position")
- '("guint" "need_default_size")
- '("guint" "position")
- '("guint" "type")
- '("guint" "has_user_ref_count")
- '("guint" "has_focus")
- '("guint" "modal")
- '("guint" "destroy_with_parent")
- '("guint" "has_frame")
- '("guint" "iconify_initially")
- '("guint" "stick_initially")
- '("guint" "maximize_initially")
- '("guint" "decorated")
- '("guint" "type_hint")
- '("guint" "gravity")
- '("guint" "frame_left")
- '("guint" "frame_top")
- '("guint" "frame_right")
- '("guint" "frame_bottom")
- '("guint" "keys_changed_handler")
- '("GdkModifierType" "mnemonic_modifier")
- )
-)
-
-(define-object WindowGroup
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkWindowGroup")
- (gtype-id "GTK_TYPE_WINDOW_GROUP")
-)
-
-;; Pointers ...
-
-(define-pointer CTreeNode
- (in-module "Gtk")
- (c-name "GtkCTreeNode")
- (gtype-id "GTK_TYPE_CTREE_NODE")
-)
-
-;; Unsupported
-
-(define-boxed FileInfo
- (in-module "Gtk")
- (c-name "GtkFileInfo")
- (gtype-id "GTK_TYPE_FILE_INFO")
-)
-
-(define-boxed FilePath
- (in-module "Gtk")
- (c-name "GtkFilePath")
- (gtype-id "GTK_TYPE_FILE_PATH")
-)
-
-(define-boxed TreePath
- (in-module "Gtk")
- (c-name "GtkTreePath")
- (gtype-id "GTK_TYPE_TREE_PATH")
-)
-
-(define-interface FileFolder
- (in-module "Gtk")
- (c-name "GtkFileFolder")
- (gtype-id "GTK_TYPE_FILE_FOLDER")
- (prerequisite "GObject")
-)
-
-(define-interface FileSystem
- (in-module "Gtk")
- (c-name "GtkFileSystem")
- (gtype-id "GTK_TYPE_FILE_SYSTEM")
- (prerequisite "GObject")
-)
-
-(define-object FileSystemHandle
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkFileSystemHandle")
- (gtype-id "GTK_TYPE_FILE_SYSTEM_HANDLE")
-)
-
-(define-object TextLayout
- (in-module "Gtk")
- (parent "GObject")
- (c-name "GtkTextLayout")
- (gtype-id "GTK_TYPE_TEXT_LAYOUT")
-)
-
-(define-object Text
- (in-module "Gtk")
- (parent "GtkOldEditable")
- (c-name "GtkText")
- (gtype-id "GTK_TYPE_TEXT")
- (implements "GtkEditable")
-)
-
-(define-object Tree
- (in-module "Gtk")
- (parent "GtkContainer")
- (c-name "GtkTree")
- (gtype-id "GTK_TYPE_TREE")
-)
-
-(define-object TreeItem
- (in-module "Gtk")
- (parent "GtkItem")
- (c-name "GtkTreeItem")
- (gtype-id "GTK_TYPE_TREE_ITEM")
-)
-
-(define-object TipsQuery
- (in-module "Gtk")
- (parent "GtkLabel")
- (c-name "GtkTipsQuery")
- (gtype-id "GTK_TYPE_TIPS_QUERY")
-)
-
-(define-flags FileInfoType
- (in-module "Gtk")
- (c-name "GtkFileInfoType")
- (gtype-id "GTK_TYPE_FILE_INFO_TYPE")
- (values
- '("display-name" "GTK_FILE_INFO_DISPLAY_NAME")
- '("is-folder" "GTK_FILE_INFO_IS_FOLDER")
- '("is-hidden" "GTK_FILE_INFO_IS_HIDDEN")
- '("mime-type" "GTK_FILE_INFO_MIME_TYPE")
- '("modification-time" "GTK_FILE_INFO_MODIFICATION_TIME")
- '("size" "GTK_FILE_INFO_SIZE")
- '("icon" "GTK_FILE_INFO_ICON")
- '("all" "GTK_FILE_INFO_ALL")
- )
-)
-
-(define-enum FileSystemError
- (in-module "Gtk")
- (c-name "GtkFileSystemError")
- (gtype-id "GTK_TYPE_FILE_SYSTEM_ERROR")
- (values
- '("nonexistent" "GTK_FILE_SYSTEM_ERROR_NONEXISTENT")
- '("not-folder" "GTK_FILE_SYSTEM_ERROR_NOT_FOLDER")
- '("invalid-uri" "GTK_FILE_SYSTEM_ERROR_INVALID_URI")
- '("bad-filename" "GTK_FILE_SYSTEM_ERROR_BAD_FILENAME")
- '("failed" "GTK_FILE_SYSTEM_ERROR_FAILED")
- '("already-exists" "GTK_FILE_SYSTEM_ERROR_ALREADY_EXISTS")
- )
-)
diff --git a/gtk/gtk-base.defs b/gtk/gtk-base.defs
deleted file mode 100644
index 583ea5a8..00000000
--- a/gtk/gtk-base.defs
+++ /dev/null
@@ -1,28041 +0,0 @@
-;; -*- scheme -*-
-
-(include "gtk-extrafuncs.defs")
-(include "gtk-base-types.defs")
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtk.h
-
-;; From /opt/gnome-2.10/include/gtk-2.0/gtk/gtkaboutdialog.h
-
-(define-function gtk_about_dialog_get_type
- (c-name "gtk_about_dialog_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_about_dialog_new
- (c-name "gtk_about_dialog_new")
- (is-constructor-of "GtkAboutDialog")
- (return-type "GtkWidget*")
-)
-
-(define-method get_name
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_name")
- (return-type "const-gchar*")
-)
-
-(define-method set_name
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name" (null-ok))
- )
-)
-
-(define-method get_version
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_version")
- (return-type "const-gchar*")
-)
-
-(define-method set_version
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_version")
- (return-type "none")
- (parameters
- '("const-gchar*" "version" (null-ok))
- )
-)
-
-(define-method get_copyright
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_copyright")
- (return-type "const-gchar*")
-)
-
-(define-method set_copyright
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_copyright")
- (return-type "none")
- (parameters
- '("const-gchar*" "copyright" (null-ok))
- )
-)
-
-(define-method get_comments
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_comments")
- (return-type "const-gchar*")
-)
-
-(define-method set_comments
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_comments")
- (return-type "none")
- (parameters
- '("const-gchar*" "comments" (null-ok))
- )
-)
-
-(define-method get_license
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_license")
- (return-type "const-gchar*")
-)
-
-(define-method set_license
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_license")
- (return-type "none")
- (parameters
- '("const-gchar*" "license" (null-ok))
- )
-)
-
-(define-method get_wrap_license
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_wrap_license")
- (return-type "gboolean")
-)
-
-(define-method set_wrap_license
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_wrap_license")
- (return-type "none")
- (parameters
- '("gboolean" "wrap_license")
- )
-)
-
-(define-method get_website
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_website")
- (return-type "const-gchar*")
-)
-
-(define-method set_website
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_website")
- (return-type "none")
- (parameters
- '("const-gchar*" "website" (null-ok))
- )
-)
-
-(define-method get_website_label
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_website_label")
- (return-type "const-gchar*")
-)
-
-(define-method set_website_label
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_website_label")
- (return-type "none")
- (parameters
- '("const-gchar*" "website_label" (null-ok))
- )
-)
-
-(define-method get_authors
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_authors")
- (return-type "gchar**")
-)
-
-(define-method set_authors
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_authors")
- (return-type "none")
- (parameters
- '("gchar**" "authors")
- )
-)
-
-(define-method get_documenters
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_documenters")
- (return-type "gchar**")
-)
-
-(define-method set_documenters
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_documenters")
- (return-type "none")
- (parameters
- '("gchar**" "documenters")
- )
-)
-
-(define-method get_artists
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_artists")
- (return-type "gchar**")
-)
-
-(define-method set_artists
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_artists")
- (return-type "none")
- (parameters
- '("gchar**" "artists")
- )
-)
-
-(define-method get_translator_credits
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_translator_credits")
- (return-type "const-gchar*")
-)
-
-(define-method set_translator_credits
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_translator_credits")
- (return-type "none")
- (parameters
- '("const-gchar*" "translator_credits" (null-ok))
- )
-)
-
-(define-method get_logo
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_logo")
- (return-type "GdkPixbuf*")
-)
-
-(define-method set_logo
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_logo")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "logo" (null-ok))
- )
-)
-
-(define-method get_logo_icon_name
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_get_logo_icon_name")
- (return-type "const-gchar*")
-)
-
-(define-method set_logo_icon_name
- (of-object "GtkAboutDialog")
- (c-name "gtk_about_dialog_set_logo_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "icon_name" (null-ok))
- )
-)
-
-(define-function about_dialog_set_email_hook
- (c-name "gtk_about_dialog_set_email_hook")
- (return-type "GtkAboutDialogActivateLinkFunc")
- (parameters
- '("GtkAboutDialogActivateLinkFunc" "func")
- '("gpointer" "data")
- '("GDestroyNotify" "destroy")
- )
-)
-
-(define-function about_dialog_set_url_hook
- (c-name "gtk_about_dialog_set_url_hook")
- (return-type "GtkAboutDialogActivateLinkFunc")
- (parameters
- '("GtkAboutDialogActivateLinkFunc" "func")
- '("gpointer" "data")
- '("GDestroyNotify" "destroy")
- )
-)
-
-(define-function show_about_dialog
- (c-name "gtk_show_about_dialog")
- (return-type "none")
- (parameters
- '("GtkWindow*" "parent")
- '("const-gchar*" "first_property_name")
- )
- (varargs #t)
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkaccelgroup.h
-
-(define-function gtk_accel_group_get_type
- (c-name "gtk_accel_group_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_accel_group_new
- (c-name "gtk_accel_group_new")
- (is-constructor-of "GtkAccelGroup")
- (return-type "GtkAccelGroup*")
-)
-
-(define-method lock
- (of-object "GtkAccelGroup")
- (c-name "gtk_accel_group_lock")
- (return-type "none")
-)
-
-(define-method unlock
- (of-object "GtkAccelGroup")
- (c-name "gtk_accel_group_unlock")
- (return-type "none")
-)
-
-(define-method connect
- (of-object "GtkAccelGroup")
- (c-name "gtk_accel_group_connect")
- (return-type "none")
- (parameters
- '("guint" "accel_key")
- '("GdkModifierType" "accel_mods")
- '("GtkAccelFlags" "accel_flags")
- '("GClosure*" "closure")
- )
-)
-
-(define-method connect_by_path
- (of-object "GtkAccelGroup")
- (c-name "gtk_accel_group_connect_by_path")
- (return-type "none")
- (parameters
- '("const-gchar*" "accel_path")
- '("GClosure*" "closure")
- )
-)
-
-(define-method disconnect
- (of-object "GtkAccelGroup")
- (c-name "gtk_accel_group_disconnect")
- (return-type "gboolean")
- (parameters
- '("GClosure*" "closure")
- )
-)
-
-(define-method disconnect_key
- (of-object "GtkAccelGroup")
- (c-name "gtk_accel_group_disconnect_key")
- (return-type "gboolean")
- (parameters
- '("guint" "accel_key")
- '("GdkModifierType" "accel_mods")
- )
-)
-
-(define-method activate
- (of-object "GtkAccelGroup")
- (c-name "gtk_accel_group_activate")
- (return-type "gboolean")
- (parameters
- '("GQuark" "accel_quark")
- '("GObject*" "acceleratable")
- '("guint" "accel_key")
- '("GdkModifierType" "accel_mods")
- )
-)
-
-(define-function accel_groups_activate
- (c-name "gtk_accel_groups_activate")
- (return-type "gboolean")
- (parameters
- '("GObject*" "object")
- '("guint" "accel_key")
- '("GdkModifierType" "accel_mods")
- )
-)
-
-(define-function accel_groups_from_object
- (c-name "gtk_accel_groups_from_object")
- (return-type "GSList*")
- (parameters
- '("GObject*" "object")
- )
-)
-
-(define-method find
- (of-object "GtkAccelGroup")
- (c-name "gtk_accel_group_find")
- (return-type "GtkAccelKey*")
- (parameters
- '("gboolean" "(*find_func")
- )
- )
-
-(define-function accel_group_from_accel_closure
- (c-name "gtk_accel_group_from_accel_closure")
- (return-type "GtkAccelGroup*")
- (parameters
- '("GClosure*" "closure")
- )
-)
-
-(define-virtual accel_changed
- (of-object "GtkAccelGroup")
- (return-type "none")
- (parameters
- '("guint" "keyval")
- '("GdkModifierType" "modifier")
- '("GClosure*" "accel_closure")
- )
-)
-
-(define-function accelerator_valid
- (c-name "gtk_accelerator_valid")
- (return-type "gboolean")
- (parameters
- '("guint" "keyval")
- '("GdkModifierType" "modifiers")
- )
-)
-
-(define-function accelerator_parse
- (c-name "gtk_accelerator_parse")
- (return-type "none")
- (parameters
- '("const-gchar*" "accelerator")
- '("guint*" "accelerator_key")
- '("GdkModifierType*" "accelerator_mods")
- )
-)
-
-(define-function accelerator_name
- (c-name "gtk_accelerator_name")
- (return-type "gchar*")
- (parameters
- '("guint" "accelerator_key")
- '("GdkModifierType" "accelerator_mods")
- )
-)
-
-(define-function accelerator_set_default_mod_mask
- (c-name "gtk_accelerator_set_default_mod_mask")
- (return-type "none")
- (parameters
- '("GdkModifierType" "default_mod_mask")
- )
-)
-
-(define-function accelerator_get_default_mod_mask
- (c-name "gtk_accelerator_get_default_mod_mask")
- (return-type "GdkModifierType")
-)
-
-(define-method query
- (of-object "GtkAccelGroup")
- (c-name "gtk_accel_group_query")
- (return-type "GtkAccelGroupEntry*")
- (parameters
- '("guint" "accel_key")
- '("GdkModifierType" "accel_mods")
- '("guint*" "n_entries")
- )
-)
-
-(define-function accelerator_get_label
- (c-name "gtk_accelerator_get_label")
- (return-type "gchar*")
- (parameters
- '("guint" "accelerator_key")
- '("GdkModifierType" "accelerator_mods")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkaccellabel.h
-
-(define-function gtk_accel_label_get_type
- (c-name "gtk_accel_label_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_accel_label_new
- (c-name "gtk_accel_label_new")
- (is-constructor-of "GtkAccelLabel")
- (return-type "GtkWidget*")
- (properties
- '("label" (argname "string"))
- )
-)
-
-(define-method accelerator_width
- (of-object "GtkAccelLabel")
- (c-name "gtk_accel_label_accelerator_width")
- (deprecated "use AtkAccelLabel.get_accel_width")
- (return-type "guint")
- (deprecated "use GtkAccelLabel.get_accel_width")
-)
-
-(define-method get_accel_widget
- (of-object "GtkAccelLabel")
- (c-name "gtk_accel_label_get_accel_widget")
- (return-type "GtkWidget*")
-)
-
-(define-method get_accel_width
- (of-object "GtkAccelLabel")
- (c-name "gtk_accel_label_get_accel_width")
- (return-type "guint")
-)
-
-(define-method set_accel_widget
- (of-object "GtkAccelLabel")
- (c-name "gtk_accel_label_set_accel_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "accel_widget")
- )
-)
-
-(define-method set_accel_closure
- (of-object "GtkAccelLabel")
- (c-name "gtk_accel_label_set_accel_closure")
- (return-type "none")
- (parameters
- '("GClosure*" "accel_closure")
- )
-)
-
-(define-method refetch
- (of-object "GtkAccelLabel")
- (c-name "gtk_accel_label_refetch")
- (return-type "gboolean")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkaccelmap.h
-
-(define-function accel_map_add_entry
- (c-name "gtk_accel_map_add_entry")
- (return-type "none")
- (parameters
- '("const-gchar*" "accel_path")
- '("guint" "accel_key")
- '("GdkModifierType" "accel_mods")
- )
-)
-
-(define-function accel_map_lookup_entry
- (c-name "gtk_accel_map_lookup_entry")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "accel_path")
- '("GtkAccelKey*" "key")
- )
-)
-
-(define-function accel_map_change_entry
- (c-name "gtk_accel_map_change_entry")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "accel_path")
- '("guint" "accel_key")
- '("GdkModifierType" "accel_mods")
- '("gboolean" "replace")
- )
-)
-
-(define-function accel_map_load
- (c-name "gtk_accel_map_load")
- (return-type "none")
- (parameters
- '("const-gchar*" "file_name")
- )
-)
-
-(define-function accel_map_save
- (c-name "gtk_accel_map_save")
- (return-type "none")
- (parameters
- '("const-gchar*" "file_name")
- )
-)
-
-(define-function accel_map_foreach
- (c-name "gtk_accel_map_foreach")
- (return-type "none")
- (parameters
- '("gpointer" "data")
- '("GtkAccelMapForeach" "foreach_func")
- )
-)
-
-(define-function accel_map_load_fd
- (c-name "gtk_accel_map_load_fd")
- (return-type "none")
- (parameters
- '("gint" "fd")
- )
-)
-
-(define-function accel_map_load_scanner
- (c-name "gtk_accel_map_load_scanner")
- (return-type "none")
- (parameters
- '("GScanner*" "scanner")
- )
-)
-
-(define-function accel_map_save_fd
- (c-name "gtk_accel_map_save_fd")
- (return-type "none")
- (parameters
- '("gint" "fd")
- )
-)
-
-(define-function accel_map_lock_path
- (c-name "gtk_accel_map_lock_path")
- (return-type "none")
- (parameters
- '("const-gchar*" "accel_path")
- )
-)
-
-(define-function accel_map_unlock_path
- (c-name "gtk_accel_map_unlock_path")
- (return-type "none")
- (parameters
- '("const-gchar*" "accel_path")
- )
-)
-
-(define-function accel_map_add_filter
- (c-name "gtk_accel_map_add_filter")
- (return-type "none")
- (parameters
- '("const-gchar*" "filter_pattern")
- )
-)
-
-(define-function accel_map_foreach_unfiltered
- (c-name "gtk_accel_map_foreach_unfiltered")
- (return-type "none")
- (parameters
- '("gpointer" "data")
- '("GtkAccelMapForeach" "foreach_func")
- )
-)
-
-(define-function accel_map_get_type
- (c-name "gtk_accel_map_get_type")
- (return-type "GType")
-)
-
-(define-function accel_map_get
- (c-name "gtk_accel_map_get")
- (return-type "GtkAccelMap*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkaccessible.h
-
-(define-function gtk_accessible_get_type
- (c-name "gtk_accessible_get_type")
- (return-type "GType")
-)
-
-(define-method connect_widget_destroyed
- (of-object "GtkAccessible")
- (c-name "gtk_accessible_connect_widget_destroyed")
- (return-type "none")
-)
-
-(define-virtual connect_widget_destroyed
- (of-object "GtkAccessible")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkaction.h
-
-(define-function gtk_action_get_type
- (c-name "gtk_action_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_action_new
- (c-name "gtk_action_new")
- (is-constructor-of "GtkAction")
- (return-type "GtkAction*")
- (properties
- '("name")
- '("label")
- '("tooltip")
- '("stock_id")
- )
-)
-
-(define-method get_name
- (of-object "GtkAction")
- (c-name "gtk_action_get_name")
- (return-type "const-gchar*")
-)
-
-(define-method is_sensitive
- (of-object "GtkAction")
- (c-name "gtk_action_is_sensitive")
- (return-type "gboolean")
-)
-
-(define-method get_sensitive
- (of-object "GtkAction")
- (c-name "gtk_action_get_sensitive")
- (return-type "gboolean")
-)
-
-(define-method is_visible
- (of-object "GtkAction")
- (c-name "gtk_action_is_visible")
- (return-type "gboolean")
-)
-
-(define-method get_visible
- (of-object "GtkAction")
- (c-name "gtk_action_get_visible")
- (return-type "gboolean")
-)
-
-(define-method activate
- (of-object "GtkAction")
- (c-name "gtk_action_activate")
- (return-type "none")
-)
-
-(define-method create_icon
- (of-object "GtkAction")
- (c-name "gtk_action_create_icon")
- (return-type "GtkWidget*")
- (parameters
- '("GtkIconSize" "icon_size")
- )
-)
-
-(define-method create_menu_item
- (of-object "GtkAction")
- (c-name "gtk_action_create_menu_item")
- (return-type "GtkWidget*")
-)
-
-(define-method create_tool_item
- (of-object "GtkAction")
- (c-name "gtk_action_create_tool_item")
- (return-type "GtkWidget*")
-)
-
-(define-method connect_proxy
- (of-object "GtkAction")
- (c-name "gtk_action_connect_proxy")
- (return-type "none")
- (parameters
- '("GtkWidget*" "proxy")
- )
-)
-
-(define-method disconnect_proxy
- (of-object "GtkAction")
- (c-name "gtk_action_disconnect_proxy")
- (return-type "none")
- (parameters
- '("GtkWidget*" "proxy")
- )
-)
-
-(define-method get_proxies
- (of-object "GtkAction")
- (c-name "gtk_action_get_proxies")
- (return-type "GSList*")
-)
-
-(define-method connect_accelerator
- (of-object "GtkAction")
- (c-name "gtk_action_connect_accelerator")
- (return-type "none")
-)
-
-(define-method disconnect_accelerator
- (of-object "GtkAction")
- (c-name "gtk_action_disconnect_accelerator")
- (return-type "none")
-)
-
-(define-method get_accel_path
- (of-object "GtkAction")
- (c-name "gtk_action_get_accel_path")
- (return-type "const-gchar*")
-)
-
-(define-method block_activate_from
- (of-object "GtkAction")
- (c-name "gtk_action_block_activate_from")
- (return-type "none")
- (parameters
- '("GtkWidget*" "proxy")
- )
-)
-
-(define-method unblock_activate_from
- (of-object "GtkAction")
- (c-name "gtk_action_unblock_activate_from")
- (return-type "none")
- (parameters
- '("GtkWidget*" "proxy")
- )
-)
-
-(define-method set_accel_path
- (of-object "GtkAction")
- (c-name "gtk_action_set_accel_path")
- (return-type "none")
- (parameters
- '("const-gchar*" "accel_path")
- )
-)
-
-(define-method set_accel_group
- (of-object "GtkAction")
- (c-name "gtk_action_set_accel_group")
- (return-type "none")
- (parameters
- '("GtkAccelGroup*" "accel_group")
- )
-)
-
-(define-method set_sensitive
- (of-object "GtkAction")
- (c-name "gtk_action_set_sensitive")
- (return-type "none")
- (parameters
- '("gboolean" "sensitive")
- )
-)
-
-(define-method set_visible
- (of-object "GtkAction")
- (c-name "gtk_action_set_visible")
- (return-type "none")
- (parameters
- '("gboolean" "visible")
- )
-)
-
-(define-virtual activate
- (of-object "GtkAction")
- (return-type "none")
-)
-(define-virtual connect_proxy
- (of-object "GtkAction")
- (return-type "none")
- (parameters
- '("GtkWidget*" "proxy")
- )
-)
-(define-virtual create_menu_item
- (of-object "GtkAction")
- (return-type "GtkWidget*")
-)
-(define-virtual create_tool_item
- (of-object "GtkAction")
- (return-type "GtkWidget*")
-)
-(define-virtual disconnect_proxy
- (of-object "GtkAction")
- (return-type "none")
- (parameters
- '("GtkWidget*" "proxy")
- )
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkactiongroup.h
-
-(define-function gtk_action_group_get_type
- (c-name "gtk_action_group_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_action_group_new
- (c-name "gtk_action_group_new")
- (is-constructor-of "GtkActionGroup")
- (return-type "GtkActionGroup*")
- (properties
- '("name")
- )
-)
-
-(define-method get_name
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_get_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_sensitive
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_get_sensitive")
- (return-type "gboolean")
-)
-
-(define-method set_sensitive
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_set_sensitive")
- (return-type "none")
- (parameters
- '("gboolean" "sensitive")
- )
-)
-
-(define-method get_visible
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_get_visible")
- (return-type "gboolean")
-)
-
-(define-method set_visible
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_set_visible")
- (return-type "none")
- (parameters
- '("gboolean" "visible")
- )
-)
-
-(define-method get_action
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_get_action")
- (return-type "GtkAction*")
- (parameters
- '("const-gchar*" "action_name")
- )
-)
-
-(define-method list_actions
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_list_actions")
- (return-type "GList*")
-)
-
-(define-method add_action
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_add_action")
- (return-type "none")
- (parameters
- '("GtkAction*" "action")
- )
-)
-
-(define-method add_action_with_accel
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_add_action_with_accel")
- (return-type "none")
- (parameters
- '("GtkAction*" "action")
- '("const-gchar*" "accelerator" (null-ok))
- )
-)
-
-(define-method remove_action
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_remove_action")
- (return-type "none")
- (parameters
- '("GtkAction*" "action")
- )
-)
-
-(define-method add_actions
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_add_actions")
- (return-type "none")
- (parameters
- '("GtkActionEntry*" "entries")
- '("guint" "n_entries")
- '("gpointer" "user_data")
- )
-)
-
-(define-method add_toggle_actions
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_add_toggle_actions")
- (return-type "none")
- (parameters
- '("GtkToggleActionEntry*" "entries")
- '("guint" "n_entries")
- '("gpointer" "user_data")
- )
-)
-
-(define-method add_radio_actions
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_add_radio_actions")
- (return-type "none")
- (parameters
- '("GtkRadioActionEntry*" "entries")
- '("guint" "n_entries")
- '("gint" "value")
- '("GCallback" "on_change")
- '("gpointer" "user_data")
- )
-)
-
-(define-method add_actions_full
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_add_actions_full")
- (return-type "none")
- (parameters
- '("GtkActionEntry*" "entries")
- '("guint" "n_entries")
- '("gpointer" "user_data")
- '("GDestroyNotify" "destroy")
- )
-)
-
-(define-method add_toggle_actions_full
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_add_toggle_actions_full")
- (return-type "none")
- (parameters
- '("GtkToggleActionEntry*" "entries")
- '("guint" "n_entries")
- '("gpointer" "user_data")
- '("GDestroyNotify" "destroy")
- )
-)
-
-(define-method add_radio_actions_full
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_add_radio_actions_full")
- (return-type "none")
- (parameters
- '("GtkRadioActionEntry*" "entries")
- '("guint" "n_entries")
- '("gint" "value")
- '("GCallback" "on_change")
- '("gpointer" "user_data")
- '("GDestroyNotify" "destroy")
- )
-)
-
-(define-method set_translate_func
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_set_translate_func")
- (return-type "none")
- (parameters
- '("GtkTranslateFunc" "func")
- '("gpointer" "data")
- '("GtkDestroyNotify" "notify")
- )
-)
-
-(define-method set_translation_domain
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_set_translation_domain")
- (return-type "none")
- (parameters
- '("const-gchar*" "domain")
- )
-)
-
-(define-method translate_string
- (of-object "GtkActionGroup")
- (c-name "gtk_action_group_translate_string")
- (return-type "const-gchar*")
- (parameters
- '("const-gchar*" "string")
- )
-)
-
-(define-virtual get_action
- (of-object "GtkActionGroup")
- (return-type "GtkAction*")
- (parameters
- '("const-gchar*" "action_name")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkadjustment.h
-
-(define-function gtk_adjustment_get_type
- (c-name "gtk_adjustment_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_adjustment_new
- (c-name "gtk_adjustment_new")
- (is-constructor-of "GtkAdjustment")
- (return-type "GtkObject*")
- (properties
- '("value" (optional))
- '("lower" (optional))
- '("upper" (optional))
- '("step_increment" (argname "step_incr") (optional))
- '("page_increment" (argname "page_incr") (optional))
- '("page_size" (optional))
- )
-)
-
-(define-method changed
- (of-object "GtkAdjustment")
- (c-name "gtk_adjustment_changed")
- (return-type "none")
-)
-
-(define-method value_changed
- (of-object "GtkAdjustment")
- (c-name "gtk_adjustment_value_changed")
- (return-type "none")
-)
-
-(define-method clamp_page
- (of-object "GtkAdjustment")
- (c-name "gtk_adjustment_clamp_page")
- (return-type "none")
- (parameters
- '("gdouble" "lower")
- '("gdouble" "upper")
- )
-)
-
-(define-method get_value
- (of-object "GtkAdjustment")
- (c-name "gtk_adjustment_get_value")
- (return-type "gdouble")
-)
-
-(define-method set_value
- (of-object "GtkAdjustment")
- (c-name "gtk_adjustment_set_value")
- (return-type "none")
- (parameters
- '("gdouble" "value")
- )
-)
-
-(define-virtual changed
- (of-object "GtkAdjustment")
- (return-type "none")
-)
-(define-virtual value_changed
- (of-object "GtkAdjustment")
- (return-type "none")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkalignment.h
-
-(define-function gtk_alignment_get_type
- (c-name "gtk_alignment_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_alignment_new
- (c-name "gtk_alignment_new")
- (is-constructor-of "GtkAlignment")
- (return-type "GtkWidget*")
- (properties
- '("xalign" (optional))
- '("yalign" (optional))
- '("xscale" (optional))
- '("yscale" (optional))
- )
-)
-
-(define-method set
- (of-object "GtkAlignment")
- (c-name "gtk_alignment_set")
- (return-type "none")
- (parameters
- '("gfloat" "xalign")
- '("gfloat" "yalign")
- '("gfloat" "xscale")
- '("gfloat" "yscale")
- )
-)
-
-(define-method set_padding
- (of-object "GtkAlignment")
- (c-name "gtk_alignment_set_padding")
- (return-type "none")
- (parameters
- '("guint" "padding_top")
- '("guint" "padding_bottom")
- '("guint" "padding_left")
- '("guint" "padding_right")
- )
-)
-
-(define-method get_padding
- (of-object "GtkAlignment")
- (c-name "gtk_alignment_get_padding")
- (return-type "none")
- (parameters
- '("guint*" "padding_top")
- '("guint*" "padding_bottom")
- '("guint*" "padding_left")
- '("guint*" "padding_right")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkarrow.h
-
-(define-function gtk_arrow_get_type
- (c-name "gtk_arrow_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_arrow_new
- (c-name "gtk_arrow_new")
- (is-constructor-of "GtkArrow")
- (return-type "GtkWidget*")
- (properties
- '("arrow_type")
- '("shadow_type")
- )
-)
-
-(define-method set
- (of-object "GtkArrow")
- (c-name "gtk_arrow_set")
- (return-type "none")
- (parameters
- '("GtkArrowType" "arrow_type")
- '("GtkShadowType" "shadow_type")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkaspectframe.h
-
-(define-function gtk_aspect_frame_get_type
- (c-name "gtk_aspect_frame_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_aspect_frame_new
- (c-name "gtk_aspect_frame_new")
- (is-constructor-of "GtkAspectFrame")
- (return-type "GtkWidget*")
- (properties
- '("label" (optional))
- '("xalign" (optional))
- '("yalign" (optional))
- '("ratio" (optional))
- '("obey_child" (optional))
- )
-)
-
-(define-method set
- (of-object "GtkAspectFrame")
- (c-name "gtk_aspect_frame_set")
- (return-type "none")
- (parameters
- '("gfloat" "xalign" (default "0.0"))
- '("gfloat" "yalign" (default "0.0"))
- '("gfloat" "ratio" (default "1.0"))
- '("gboolean" "obey_child" (default "1"))
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkbbox.h
-
-(define-function gtk_button_box_get_type
- (c-name "gtk_button_box_get_type")
- (return-type "GType")
-)
-
-(define-method get_layout
- (of-object "GtkButtonBox")
- (c-name "gtk_button_box_get_layout")
- (return-type "GtkButtonBoxStyle")
-)
-
-(define-method set_layout
- (of-object "GtkButtonBox")
- (c-name "gtk_button_box_set_layout")
- (return-type "none")
- (parameters
- '("GtkButtonBoxStyle" "layout_style")
- )
-)
-
-(define-method get_child_secondary
- (of-object "GtkButtonBox")
- (c-name "gtk_button_box_get_child_secondary")
- (return-type "gboolean")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method set_child_secondary
- (of-object "GtkButtonBox")
- (c-name "gtk_button_box_set_child_secondary")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gboolean" "is_secondary")
- )
-)
-
-(define-method set_child_size
- (of-object "GtkButtonBox")
- (c-name "gtk_button_box_set_child_size")
- (return-type "none")
- (parameters
- '("gint" "min_width")
- '("gint" "min_height")
- )
- (deprecated "don't use this")
-)
-
-(define-method set_child_ipadding
- (of-object "GtkButtonBox")
- (c-name "gtk_button_box_set_child_ipadding")
- (return-type "none")
- (parameters
- '("gint" "ipad_x")
- '("gint" "ipad_y")
- )
- (deprecated "don't use this")
-)
-
-(define-method get_child_size
- (of-object "GtkButtonBox")
- (c-name "gtk_button_box_get_child_size")
- (return-type "none")
- (parameters
- '("gint*" "min_width")
- '("gint*" "min_height")
- )
- (deprecated "don't use this")
-)
-
-(define-method get_child_ipadding
- (of-object "GtkButtonBox")
- (c-name "gtk_button_box_get_child_ipadding")
- (return-type "none")
- (parameters
- '("gint*" "ipad_x")
- '("gint*" "ipad_y")
- )
- (deprecated "don't use this")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkbin.h
-
-(define-function gtk_bin_get_type
- (c-name "gtk_bin_get_type")
- (return-type "GType")
-)
-
-(define-method get_child
- (of-object "GtkBin")
- (c-name "gtk_bin_get_child")
- (return-type "GtkWidget*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkbindings.h
-
-(define-function gtk_binding_set_new
- (c-name "gtk_binding_set_new")
- (return-type "GtkBindingSet*")
- (parameters
- '("const-gchar*" "set_name")
- )
- (deprecated "use binding_set_new")
-)
-
-(define-function binding_set_new
- (c-name "gtk_binding_set_new")
- (is-constructor-of "GtkBindingSet")
- (return-type "GtkBindingSet*")
- (parameters
- '("const-gchar*" "set_name")
- )
-)
-
-(define-function gtk_binding_set_by_class
- (c-name "gtk_binding_set_by_class")
- (return-type "GtkBindingSet*")
- (parameters
- '("gpointer" "object_class")
- )
- (deprecated "use binding_set_by_class")
-)
-
-(define-function binding_set_by_class
- (c-name "gtk_binding_set_by_class")
- (return-type "GtkBindingSet*")
- (parameters
- '("gpointer" "object_class")
- )
-)
-
-(define-function gtk_binding_set_find
- (c-name "gtk_binding_set_find")
- (return-type "GtkBindingSet*")
- (parameters
- '("const-gchar*" "set_name")
- )
- (deprecated "use binding_set_find")
-)
-
-(define-function binding_set_find
- (c-name "gtk_binding_set_find")
- (is-constructor-of "GtkBindingSet")
- (return-type "GtkBindingSet*")
- (parameters
- '("const-gchar*" "set_name")
- )
-)
-
-(define-function bindings_activate
- (c-name "gtk_bindings_activate")
- (return-type "gboolean")
- (parameters
- '("GtkObject*" "object")
- '("guint" "keyval")
- '("GdkModifierType" "modifiers")
- )
-)
-
-(define-function bindings_activate_event
- (c-name "gtk_bindings_activate_event")
- (return-type "gboolean")
- (parameters
- '("GtkObject*" "object")
- '("GdkEventKey*" "event")
- )
-)
-
-(define-method activate
- (of-object "GtkBindingSet")
- (c-name "gtk_binding_set_activate")
- (return-type "gboolean")
- (parameters
- '("guint" "keyval")
- '("GdkModifierType" "modifiers")
- '("GtkObject*" "object")
- )
-)
-
-(define-function binding_entry_clear
- (c-name "gtk_binding_entry_clear")
- (return-type "none")
- (parameters
- '("GtkBindingSet*" "binding_set")
- '("guint" "keyval")
- '("GdkModifierType" "modifiers")
- )
-)
-
-(define-function binding_entry_add_signal
- (c-name "gtk_binding_entry_add_signal")
- (return-type "none")
- (parameters
- '("GtkBindingSet*" "binding_set")
- '("guint" "keyval")
- '("GdkModifierType" "modifiers")
- '("const-gchar*" "signal_name")
- '("guint" "n_args")
- )
- (varargs #t)
-)
-
-(define-method add_path
- (of-object "GtkBindingSet")
- (c-name "gtk_binding_set_add_path")
- (return-type "none")
- (parameters
- '("GtkPathType" "path_type")
- '("const-gchar*" "path_pattern")
- '("GtkPathPriorityType" "priority")
- )
-)
-
-(define-function binding_entry_remove
- (c-name "gtk_binding_entry_remove")
- (return-type "none")
- (parameters
- '("GtkBindingSet*" "binding_set")
- '("guint" "keyval")
- '("GdkModifierType" "modifiers")
- )
-)
-
-(define-function binding_entry_add_signall
- (c-name "gtk_binding_entry_add_signall")
- (return-type "none")
- (parameters
- '("GtkBindingSet*" "binding_set")
- '("guint" "keyval")
- '("GdkModifierType" "modifiers")
- '("const-gchar*" "signal_name")
- '("GSList*" "binding_args")
- )
-)
-
-(define-function binding_parse_binding
- (c-name "gtk_binding_parse_binding")
- (return-type "guint")
- (parameters
- '("GScanner*" "scanner")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkbox.h
-
-(define-function gtk_box_get_type
- (c-name "gtk_box_get_type")
- (return-type "GType")
-)
-
-(define-method pack_start
- (of-object "GtkBox")
- (c-name "gtk_box_pack_start")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gboolean" "expand" (default "TRUE"))
- '("gboolean" "fill" (default "TRUE"))
- '("guint" "padding" (default "0"))
- )
-)
-
-(define-method pack_end
- (of-object "GtkBox")
- (c-name "gtk_box_pack_end")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gboolean" "expand" (default "TRUE"))
- '("gboolean" "fill" (default "TRUE"))
- '("guint" "padding" (default "0"))
- )
-)
-
-(define-method pack_start_defaults
- (of-object "GtkBox")
- (c-name "gtk_box_pack_start_defaults")
- (deprecated "use pack_start instead")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-method pack_end_defaults
- (of-object "GtkBox")
- (c-name "gtk_box_pack_end_defaults")
- (deprecated "use pack_end instead")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-method set_homogeneous
- (of-object "GtkBox")
- (c-name "gtk_box_set_homogeneous")
- (return-type "none")
- (parameters
- '("gboolean" "homogeneous")
- )
-)
-
-(define-method get_homogeneous
- (of-object "GtkBox")
- (c-name "gtk_box_get_homogeneous")
- (return-type "gboolean")
-)
-
-(define-method set_spacing
- (of-object "GtkBox")
- (c-name "gtk_box_set_spacing")
- (return-type "none")
- (parameters
- '("gint" "spacing")
- )
-)
-
-(define-method get_spacing
- (of-object "GtkBox")
- (c-name "gtk_box_get_spacing")
- (return-type "gint")
-)
-
-(define-method reorder_child
- (of-object "GtkBox")
- (c-name "gtk_box_reorder_child")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gint" "position")
- )
-)
-
-(define-method query_child_packing
- (of-object "GtkBox")
- (c-name "gtk_box_query_child_packing")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gboolean*" "expand")
- '("gboolean*" "fill")
- '("guint*" "padding")
- '("GtkPackType*" "pack_type")
- )
-)
-
-(define-method set_child_packing
- (of-object "GtkBox")
- (c-name "gtk_box_set_child_packing")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gboolean" "expand")
- '("gboolean" "fill")
- '("guint" "padding")
- '("GtkPackType" "pack_type")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkbutton.h
-
-(define-function gtk_button_get_type
- (c-name "gtk_button_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_button_new
- (c-name "gtk_button_new")
- (is-constructor-of "GtkButton")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_button_new_with_label
- (c-name "gtk_button_new_with_label")
- (is-constructor-of "GtkButton")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-function gtk_button_new_from_stock
- (c-name "gtk_button_new_from_stock")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "stock_id")
- )
-)
-
-(define-function gtk_button_new_with_mnemonic
- (c-name "gtk_button_new_with_mnemonic")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-method pressed
- (of-object "GtkButton")
- (c-name "gtk_button_pressed")
- (return-type "none")
-)
-
-(define-method released
- (of-object "GtkButton")
- (c-name "gtk_button_released")
- (return-type "none")
-)
-
-(define-method clicked
- (of-object "GtkButton")
- (c-name "gtk_button_clicked")
- (return-type "none")
-)
-
-(define-method enter
- (of-object "GtkButton")
- (c-name "gtk_button_enter")
- (return-type "none")
-)
-
-(define-method leave
- (of-object "GtkButton")
- (c-name "gtk_button_leave")
- (return-type "none")
-)
-
-(define-method set_relief
- (of-object "GtkButton")
- (c-name "gtk_button_set_relief")
- (return-type "none")
- (parameters
- '("GtkReliefStyle" "newstyle")
- )
-)
-
-(define-method get_relief
- (of-object "GtkButton")
- (c-name "gtk_button_get_relief")
- (return-type "GtkReliefStyle")
-)
-
-(define-method set_label
- (of-object "GtkButton")
- (c-name "gtk_button_set_label")
- (return-type "none")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-method get_label
- (of-object "GtkButton")
- (c-name "gtk_button_get_label")
- (return-type "const-gchar*")
-)
-
-(define-method set_use_underline
- (of-object "GtkButton")
- (c-name "gtk_button_set_use_underline")
- (return-type "none")
- (parameters
- '("gboolean" "use_underline")
- )
-)
-
-(define-method get_use_underline
- (of-object "GtkButton")
- (c-name "gtk_button_get_use_underline")
- (return-type "gboolean")
-)
-
-(define-method set_use_stock
- (of-object "GtkButton")
- (c-name "gtk_button_set_use_stock")
- (return-type "none")
- (parameters
- '("gboolean" "use_stock")
- )
-)
-
-(define-method get_use_stock
- (of-object "GtkButton")
- (c-name "gtk_button_get_use_stock")
- (return-type "gboolean")
-)
-
-(define-method set_focus_on_click
- (of-object "GtkButton")
- (c-name "gtk_button_set_focus_on_click")
- (return-type "none")
- (parameters
- '("gboolean" "focus_on_click")
- )
-)
-
-(define-method get_focus_on_click
- (of-object "GtkButton")
- (c-name "gtk_button_get_focus_on_click")
- (return-type "gboolean")
-)
-
-(define-method set_alignment
- (of-object "GtkButton")
- (c-name "gtk_button_set_alignment")
- (return-type "none")
- (parameters
- '("gfloat" "xalign")
- '("gfloat" "yalign")
- )
-)
-
-(define-method get_alignment
- (of-object "GtkButton")
- (c-name "gtk_button_get_alignment")
- (return-type "none")
- (parameters
- '("gfloat*" "xalign")
- '("gfloat*" "yalign")
- )
-)
-
-(define-method set_image
- (of-object "GtkButton")
- (c-name "gtk_button_set_image")
- (return-type "none")
- (parameters
- '("GtkWidget*" "image")
- )
-)
-
-(define-method get_image
- (of-object "GtkButton")
- (c-name "gtk_button_get_image")
- (return-type "GtkWidget*")
-)
-
-(define-virtual pressed
- (of-object "GtkButton")
- (return-type "none")
-)
-(define-virtual released
- (of-object "GtkButton")
- (return-type "none")
-)
-(define-virtual clicked
- (of-object "GtkButton")
- (return-type "none")
-)
-(define-virtual enter
- (of-object "GtkButton")
- (return-type "none")
-)
-(define-virtual leave
- (of-object "GtkButton")
- (return-type "none")
-)
-(define-virtual activate
- (of-object "GtkButton")
- (return-type "none")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcalendar.h
-
-(define-function gtk_calendar_get_type
- (c-name "gtk_calendar_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_calendar_new
- (c-name "gtk_calendar_new")
- (is-constructor-of "GtkCalendar")
- (return-type "GtkWidget*")
-)
-
-(define-method select_month
- (of-object "GtkCalendar")
- (c-name "gtk_calendar_select_month")
- (return-type "gboolean")
- (parameters
- '("guint" "month")
- '("guint" "year")
- )
-)
-
-(define-method select_day
- (of-object "GtkCalendar")
- (c-name "gtk_calendar_select_day")
- (return-type "none")
- (parameters
- '("guint" "day")
- )
-)
-
-(define-method mark_day
- (of-object "GtkCalendar")
- (c-name "gtk_calendar_mark_day")
- (return-type "gboolean")
- (parameters
- '("guint" "day")
- )
-)
-
-(define-method unmark_day
- (of-object "GtkCalendar")
- (c-name "gtk_calendar_unmark_day")
- (return-type "gboolean")
- (parameters
- '("guint" "day")
- )
-)
-
-(define-method clear_marks
- (of-object "GtkCalendar")
- (c-name "gtk_calendar_clear_marks")
- (return-type "none")
-)
-
-(define-method set_display_options
- (of-object "GtkCalendar")
- (c-name "gtk_calendar_set_display_options")
- (return-type "none")
- (parameters
- '("GtkCalendarDisplayOptions" "flags")
- )
-)
-
-(define-method get_display_options
- (of-object "GtkCalendar")
- (c-name "gtk_calendar_get_display_options")
- (return-type "GtkCalendarDisplayOptions")
-)
-
-(define-method display_options
- (of-object "GtkCalendar")
- (c-name "gtk_calendar_display_options")
- (return-type "none")
- (parameters
- '("GtkCalendarDisplayOptions" "flags")
- )
-)
-
-(define-method get_date
- (of-object "GtkCalendar")
- (c-name "gtk_calendar_get_date")
- (return-type "none")
- (parameters
- '("guint*" "year")
- '("guint*" "month")
- '("guint*" "day")
- )
-)
-
-(define-method freeze
- (of-object "GtkCalendar")
- (c-name "gtk_calendar_freeze")
- (return-type "none")
-)
-
-(define-method thaw
- (of-object "GtkCalendar")
- (c-name "gtk_calendar_thaw")
- (return-type "none")
-)
-
-(define-virtual month_changed
- (of-object "GtkCalendar")
- (return-type "none")
-)
-(define-virtual day_selected
- (of-object "GtkCalendar")
- (return-type "none")
-)
-(define-virtual day_selected_double_click
- (of-object "GtkCalendar")
- (return-type "none")
-)
-(define-virtual prev_month
- (of-object "GtkCalendar")
- (return-type "none")
-)
-(define-virtual next_month
- (of-object "GtkCalendar")
- (return-type "none")
-)
-(define-virtual prev_year
- (of-object "GtkCalendar")
- (return-type "none")
-)
-(define-virtual next_year
- (of-object "GtkCalendar")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcelleditable.h
-
-(define-function gtk_cell_editable_get_type
- (c-name "gtk_cell_editable_get_type")
- (return-type "GType")
-)
-
-(define-method start_editing
- (of-object "GtkCellEditable")
- (c-name "gtk_cell_editable_start_editing")
- (return-type "none")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-
-(define-method editing_done
- (of-object "GtkCellEditable")
- (c-name "gtk_cell_editable_editing_done")
- (return-type "none")
-)
-
-(define-method remove_widget
- (of-object "GtkCellEditable")
- (c-name "gtk_cell_editable_remove_widget")
- (return-type "none")
-)
-
-(define-virtual editing_done
- (of-object "GtkCellEditable")
- (return-type "none")
-)
-(define-virtual remove_widget
- (of-object "GtkCellEditable")
- (return-type "none")
-)
-(define-virtual start_editing
- (of-object "GtkCellEditable")
- (return-type "none")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcelllayout.h
-
-(define-function gtk_cell_layout_get_type
- (c-name "gtk_cell_layout_get_type")
- (return-type "GType")
-)
-
-(define-method pack_start
- (of-object "GtkCellLayout")
- (c-name "gtk_cell_layout_pack_start")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("gboolean" "expand" (default "TRUE"))
- )
-)
-
-(define-method pack_end
- (of-object "GtkCellLayout")
- (c-name "gtk_cell_layout_pack_end")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("gboolean" "expand" (default "TRUE"))
- )
-)
-
-(define-method clear
- (of-object "GtkCellLayout")
- (c-name "gtk_cell_layout_clear")
- (return-type "none")
-)
-
-(define-method set_attributes
- (of-object "GtkCellLayout")
- (c-name "gtk_cell_layout_set_attributes")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- )
- (varargs #t)
-)
-
-(define-method add_attribute
- (of-object "GtkCellLayout")
- (c-name "gtk_cell_layout_add_attribute")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("const-gchar*" "attribute")
- '("gint" "column")
- )
-)
-
-(define-method set_cell_data_func
- (of-object "GtkCellLayout")
- (c-name "gtk_cell_layout_set_cell_data_func")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("GtkCellLayoutDataFunc" "func")
- '("gpointer" "func_data")
- '("GDestroyNotify" "destroy")
- )
-)
-
-(define-method clear_attributes
- (of-object "GtkCellLayout")
- (c-name "gtk_cell_layout_clear_attributes")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- )
-)
-
-(define-method reorder
- (of-object "GtkCellLayout")
- (c-name "gtk_cell_layout_reorder")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("gint" "position")
- )
-)
-
-(define-virtual pack_start
- (of-object "GtkCellLayout")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("gboolean" "expand")
- )
-)
-(define-virtual pack_end
- (of-object "GtkCellLayout")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("gboolean" "expand")
- )
-)
-(define-virtual clear
- (of-object "GtkCellLayout")
- (return-type "none")
-)
-(define-virtual add_attribute
- (of-object "GtkCellLayout")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("const-gchar*" "attribute")
- '("gint" "column")
- )
-)
-(define-virtual set_cell_data_func
- (of-object "GtkCellLayout")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("GtkCellLayoutDataFunc" "func")
- '("gpointer" "func_data")
- '("GDestroyNotify" "destroy")
- )
-)
-(define-virtual clear_attributes
- (of-object "GtkCellLayout")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- )
-)
-(define-virtual reorder
- (of-object "GtkCellLayout")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("gint" "position")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcellrenderer.h
-
-(define-function gtk_cell_renderer_get_type
- (c-name "gtk_cell_renderer_get_type")
- (return-type "GType")
-)
-
-(define-method get_size
- (of-object "GtkCellRenderer")
- (c-name "gtk_cell_renderer_get_size")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("GdkRectangle*" "cell_area")
- '("gint*" "x_offset")
- '("gint*" "y_offset")
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-method render
- (of-object "GtkCellRenderer")
- (c-name "gtk_cell_renderer_render")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkWidget*" "widget")
- '("GdkRectangle*" "background_area")
- '("GdkRectangle*" "cell_area")
- '("GdkRectangle*" "expose_area")
- '("GtkCellRendererState" "flags")
- )
-)
-
-(define-method activate
- (of-object "GtkCellRenderer")
- (c-name "gtk_cell_renderer_activate")
- (return-type "gboolean")
- (parameters
- '("GdkEvent*" "event")
- '("GtkWidget*" "widget")
- '("const-gchar*" "path")
- '("GdkRectangle*" "background_area")
- '("GdkRectangle*" "cell_area")
- '("GtkCellRendererState" "flags")
- )
-)
-
-(define-method start_editing
- (of-object "GtkCellRenderer")
- (c-name "gtk_cell_renderer_start_editing")
- (return-type "GtkCellEditable*")
- (parameters
- '("GdkEvent*" "event")
- '("GtkWidget*" "widget")
- '("const-gchar*" "path")
- '("GdkRectangle*" "background_area")
- '("GdkRectangle*" "cell_area")
- '("GtkCellRendererState" "flags")
- )
-)
-
-(define-method set_fixed_size
- (of-object "GtkCellRenderer")
- (c-name "gtk_cell_renderer_set_fixed_size")
- (return-type "none")
- (parameters
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method get_fixed_size
- (of-object "GtkCellRenderer")
- (c-name "gtk_cell_renderer_get_fixed_size")
- (return-type "none")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-method editing_canceled
- (of-object "GtkCellRenderer")
- (c-name "gtk_cell_renderer_editing_canceled")
- (return-type "none")
-)
-
-(define-method stop_editing
- (of-object "GtkCellRenderer")
- (c-name "gtk_cell_renderer_stop_editing")
- (return-type "none")
- (parameters
- '("gboolean" "canceled")
- )
-)
-
-(define-virtual get_size
- (of-object "GtkCellRenderer")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("GdkRectangle*" "cell_area")
- '("gint*" "x_offset")
- '("gint*" "y_offset")
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-(define-virtual render
- (of-object "GtkCellRenderer")
- (return-type "none")
- (parameters
- '("GdkDrawable*" "window")
- '("GtkWidget*" "widget")
- '("GdkRectangle*" "background_area")
- '("GdkRectangle*" "cell_area")
- '("GdkRectangle*" "expose_area")
- '("GtkCellRendererState" "flags")
- )
-)
-(define-virtual activate
- (of-object "GtkCellRenderer")
- (return-type "gboolean")
- (parameters
- '("GdkEvent*" "event")
- '("GtkWidget*" "widget")
- '("const-gchar*" "path")
- '("GdkRectangle*" "background_area")
- '("GdkRectangle*" "cell_area")
- '("GtkCellRendererState" "flags")
- )
-)
-(define-virtual editing_canceled
- (of-object "GtkCellRenderer")
- (return-type "none")
-)
-(define-virtual editing_started
- (of-object "GtkCellRenderer")
- (return-type "none")
- (parameters
- '("GtkCellEditable*" "editable")
- '("const-gchar*" "path")
- )
-)
-(define-virtual start_editing
- (of-object "GtkCellRenderer")
- (return-type "GtkCellEditable*")
- (parameters
- '("GdkEvent*" "event")
- '("GtkWidget*" "widget")
- '("const-gchar*" "path")
- '("GdkRectangle*" "background_area")
- '("GdkRectangle*" "cell_area")
- '("GtkCellRendererState" "flags")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcellrenderercombo.h
-
-(define-function gtk_cell_renderer_combo_get_type
- (c-name "gtk_cell_renderer_combo_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_cell_renderer_combo_new
- (c-name "gtk_cell_renderer_combo_new")
- (is-constructor-of "GtkCellRendererCombo")
- (return-type "GtkCellRenderer*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcellrendererpixbuf.h
-
-(define-function gtk_cell_renderer_pixbuf_get_type
- (c-name "gtk_cell_renderer_pixbuf_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_cell_renderer_pixbuf_new
- (c-name "gtk_cell_renderer_pixbuf_new")
- (is-constructor-of "GtkCellRendererPixbuf")
- (return-type "GtkCellRenderer*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcellrendererprogress.h
-
-(define-function gtk_cell_renderer_progress_get_type
- (c-name "gtk_cell_renderer_progress_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_cell_renderer_progress_new
- (c-name "gtk_cell_renderer_progress_new")
- (is-constructor-of "GtkCellRendererProgress")
- (return-type "GtkCellRenderer*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcellrenderertext.h
-
-(define-function gtk_cell_renderer_text_get_type
- (c-name "gtk_cell_renderer_text_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_cell_renderer_text_new
- (c-name "gtk_cell_renderer_text_new")
- (is-constructor-of "GtkCellRendererText")
- (return-type "GtkCellRenderer*")
-)
-
-(define-method set_fixed_height_from_font
- (of-object "GtkCellRendererText")
- (c-name "gtk_cell_renderer_text_set_fixed_height_from_font")
- (return-type "none")
- (parameters
- '("gint" "number_of_rows")
- )
-)
-
-(define-virtual edited
- (of-object "GtkCellRendererText")
- (return-type "none")
- (parameters
- '("const-gchar*" "path")
- '("const-gchar*" "new_text")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcellrenderertoggle.h
-
-(define-function gtk_cell_renderer_toggle_get_type
- (c-name "gtk_cell_renderer_toggle_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_cell_renderer_toggle_new
- (c-name "gtk_cell_renderer_toggle_new")
- (is-constructor-of "GtkCellRendererToggle")
- (return-type "GtkCellRenderer*")
-)
-
-(define-method get_radio
- (of-object "GtkCellRendererToggle")
- (c-name "gtk_cell_renderer_toggle_get_radio")
- (return-type "gboolean")
-)
-
-(define-method set_radio
- (of-object "GtkCellRendererToggle")
- (c-name "gtk_cell_renderer_toggle_set_radio")
- (return-type "none")
- (parameters
- '("gboolean" "radio")
- )
-)
-
-(define-method get_active
- (of-object "GtkCellRendererToggle")
- (c-name "gtk_cell_renderer_toggle_get_active")
- (return-type "gboolean")
-)
-
-(define-method set_active
- (of-object "GtkCellRendererToggle")
- (c-name "gtk_cell_renderer_toggle_set_active")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-virtual toggled
- (of-object "GtkCellRendererToggle")
- (return-type "none")
- (parameters
- '("const-gchar*" "path")
- )
-)
-
-
-;; From /opt/gnome-2.10/include/gtk-2.0/gtk/gtkcellview.h
-
-(define-function gtk_cell_view_get_type
- (c-name "gtk_cell_view_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_cell_view_new
- (c-name "gtk_cell_view_new")
- (is-constructor-of "GtkCellView")
- (return-type "GtkWidget*")
-)
-
-(define-function cell_view_new_with_text
- (c-name "gtk_cell_view_new_with_text")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "text")
- )
- (caller-owns-return #t)
-)
-
-(define-function cell_view_new_with_markup
- (c-name "gtk_cell_view_new_with_markup")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "markup")
- )
- (caller-owns-return #t)
-)
-
-(define-function cell_view_new_with_pixbuf
- (c-name "gtk_cell_view_new_with_pixbuf")
- (return-type "GtkWidget*")
- (parameters
- '("GdkPixbuf*" "pixbuf")
- )
- (caller-owns-return #t)
-)
-
-(define-method set_model
- (of-object "GtkCellView")
- (c-name "gtk_cell_view_set_model")
- (return-type "none")
- (parameters
- '("GtkTreeModel*" "model" (null-ok))
- )
-)
-
-(define-method set_displayed_row
- (of-object "GtkCellView")
- (c-name "gtk_cell_view_set_displayed_row")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path" (null-ok))
- )
-)
-
-(define-method get_displayed_row
- (of-object "GtkCellView")
- (c-name "gtk_cell_view_get_displayed_row")
- (return-type "GtkTreePath*")
-)
-
-(define-method get_size_of_row
- (of-object "GtkCellView")
- (c-name "gtk_cell_view_get_size_of_row")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkRequisition*" "requisition")
- )
-)
-
-(define-method set_background_color
- (of-object "GtkCellView")
- (c-name "gtk_cell_view_set_background_color")
- (return-type "none")
- (parameters
- '("const-GdkColor*" "color")
- )
-)
-
-(define-method get_cell_renderers
- (of-object "GtkCellView")
- (c-name "gtk_cell_view_get_cell_renderers")
- (return-type "GList*")
-)
-
-;; From /opt/gnome-2.10/include/gtk-2.0/gtk/gtkclipboard.h
-
-
-(define-method wait_is_target_available
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_wait_is_target_available")
- (return-type "gboolean")
- (parameters
- '("GdkAtom" "target")
- )
-)
-
-(define-method set_can_store
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_set_can_store")
- (return-type "none")
- (parameters
- '("const-GtkTargetEntry*" "targets")
- '("gint" "n_targets")
- )
-)
-
-(define-method store
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_store")
- (return-type "none")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcheckbutton.h
-
-(define-function gtk_check_button_get_type
- (c-name "gtk_check_button_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_check_button_new
- (c-name "gtk_check_button_new")
- (is-constructor-of "GtkCheckButton")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_check_button_new_with_label
- (c-name "gtk_check_button_new_with_label")
- (is-constructor-of "GtkCheckButton")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-function gtk_check_button_new_with_mnemonic
- (c-name "gtk_check_button_new_with_mnemonic")
- (is-constructor-of "GtkCheckButton")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-virtual draw_indicator
- (of-object "GtkCheckButton")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "area")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcheckmenuitem.h
-
-(define-function gtk_check_menu_item_get_type
- (c-name "gtk_check_menu_item_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_check_menu_item_new
- (c-name "gtk_check_menu_item_new")
- (is-constructor-of "GtkCheckMenuItem")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_check_menu_item_new_with_label
- (c-name "gtk_check_menu_item_new_with_label")
- (is-constructor-of "GtkCheckMenuItem")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-function gtk_check_menu_item_new_with_mnemonic
- (c-name "gtk_check_menu_item_new_with_mnemonic")
- (is-constructor-of "GtkCheckMenuItem")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-method set_active
- (of-object "GtkCheckMenuItem")
- (c-name "gtk_check_menu_item_set_active")
- (return-type "none")
- (parameters
- '("gboolean" "is_active")
- )
-)
-
-(define-method get_active
- (of-object "GtkCheckMenuItem")
- (c-name "gtk_check_menu_item_get_active")
- (return-type "gboolean")
-)
-
-(define-method toggled
- (of-object "GtkCheckMenuItem")
- (c-name "gtk_check_menu_item_toggled")
- (return-type "none")
-)
-
-(define-method set_inconsistent
- (of-object "GtkCheckMenuItem")
- (c-name "gtk_check_menu_item_set_inconsistent")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_inconsistent
- (of-object "GtkCheckMenuItem")
- (c-name "gtk_check_menu_item_get_inconsistent")
- (return-type "gboolean")
-)
-
-(define-method set_draw_as_radio
- (of-object "GtkCheckMenuItem")
- (c-name "gtk_check_menu_item_set_draw_as_radio")
- (return-type "none")
- (parameters
- '("gboolean" "draw_as_radio")
- )
-)
-
-(define-method get_draw_as_radio
- (of-object "GtkCheckMenuItem")
- (c-name "gtk_check_menu_item_get_draw_as_radio")
- (return-type "gboolean")
-)
-
-(define-method set_show_toggle
- (of-object "GtkCheckMenuItem")
- (c-name "gtk_check_menu_item_set_show_toggle")
- (return-type "none")
- (parameters
- '("gboolean" "always")
- )
- (deprecated "don't use this method")
-)
-
-(define-method set_state
- (of-object "GtkCheckMenuItem")
- (c-name "gtk_check_menu_item_set_state")
- (return-type "none")
- (parameters
- '("gboolean" "is_active")
- )
- (deprecated "use GtkCheckMenuItem.set_active")
-)
-
-(define-virtual toggled
- (of-object "GtkCheckMenuItem")
- (return-type "none")
-)
-(define-virtual draw_indicator
- (of-object "GtkCheckMenuItem")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "area")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkclipboard.h
-
-(define-function gtk_clipboard_get_type
- (c-name "gtk_clipboard_get_type")
- (return-type "GType")
-)
-
-(define-function clipboard_get_for_display
- (c-name "gtk_clipboard_get_for_display")
- (is-constructor-of "GtkClipboard")
- (caller-owns-return nil)
- (return-type "GtkClipboard*")
- (parameters
- '("GdkDisplay*" "display" (default "gdk_display_get_default()"))
- '("GdkAtom" "selection" (default "GDK_SELECTION_CLIPBOARD"))
- )
-)
-
-(define-function clipboard_get
- (c-name "gtk_clipboard_get")
- (return-type "GtkClipboard*")
- (parameters
- '("GdkAtom" "selection" (default "GDK_SELECTION_CLIPBOARD"))
- )
-)
-
-(define-method get_display
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_get_display")
- (return-type "GdkDisplay*")
-)
-
-(define-method set_with_data
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_set_with_data")
- (return-type "gboolean")
- (parameters
- '("const-GtkTargetEntry*" "targets")
- '("guint" "n_targets")
- '("GtkClipboardGetFunc" "get_func")
- '("GtkClipboardClearFunc" "clear_func")
- '("gpointer" "user_data")
- )
-)
-
-(define-method set_with_owner
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_set_with_owner")
- (return-type "gboolean")
- (parameters
- '("const-GtkTargetEntry*" "targets")
- '("guint" "n_targets")
- '("GtkClipboardGetFunc" "get_func")
- '("GtkClipboardClearFunc" "clear_func")
- '("GObject*" "owner")
- )
-)
-
-(define-method get_owner
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_get_owner")
- (return-type "GObject*")
-)
-
-(define-method clear
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_clear")
- (return-type "none")
-)
-
-(define-method set_text
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_set_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("gint" "len" (default "-1"))
- )
-)
-
-(define-method request_contents
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_request_contents")
- (return-type "none")
- (parameters
- '("GdkAtom" "target")
- '("GtkClipboardReceivedFunc" "callback")
- '("gpointer" "user_data")
- )
-)
-
-(define-method request_text
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_request_text")
- (return-type "none")
- (parameters
- '("GtkClipboardTextReceivedFunc" "callback")
- '("gpointer" "user_data")
- )
-)
-
-(define-method request_targets
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_request_targets")
- (return-type "none")
- (parameters
- '("GtkClipboardTargetsReceivedFunc" "callback")
- '("gpointer" "user_data")
- )
-)
-
-(define-method wait_for_contents
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_wait_for_contents")
- (return-type "GtkSelectionData*")
- (parameters
- '("GdkAtom" "target")
- )
-)
-
-(define-method wait_for_text
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_wait_for_text")
- (return-type "gchar*")
-)
-
-(define-method wait_is_text_available
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_wait_is_text_available")
- (return-type "gboolean")
-)
-
-(define-method wait_for_targets
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_wait_for_targets")
- (return-type "gboolean")
- (parameters
- '("GdkAtom**" "targets")
- '("gint*" "n_targets")
- )
-)
-
-(define-method request_image
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_request_image")
- (return-type "none")
- (parameters
- '("GtkClipboardImageReceivedFunc" "callback")
- '("gpointer" "user_data")
- )
-)
-
-(define-method wait_for_image
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_wait_for_image")
- (return-type "GdkPixbuf*")
-)
-
-(define-method set_image
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_set_image")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "pixbuf")
- )
-)
-
-(define-method wait_is_image_available
- (of-object "GtkClipboard")
- (c-name "gtk_clipboard_wait_is_image_available")
- (return-type "gboolean")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkclist.h
-
-(define-function gtk_clist_get_type
- (c-name "gtk_clist_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_clist_new
- (c-name "gtk_clist_new")
- (is-constructor-of "GtkCList")
- (return-type "GtkWidget*")
- (parameters
- '("gint" "columns" (default "1"))
- )
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-function gtk_clist_new_with_titles
- (c-name "gtk_clist_new_with_titles")
- (is-constructor-of "GtkCList")
- (return-type "GtkWidget*")
- (parameters
- '("gint" "columns" (default "1"))
- '("gchar*[]" "titles")
- )
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method set_hadjustment
- (of-object "GtkCList")
- (c-name "gtk_clist_set_hadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment")
- )
-)
-
-(define-method set_vadjustment
- (of-object "GtkCList")
- (c-name "gtk_clist_set_vadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment")
- )
-)
-
-(define-method get_hadjustment
- (of-object "GtkCList")
- (c-name "gtk_clist_get_hadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method get_vadjustment
- (of-object "GtkCList")
- (c-name "gtk_clist_get_vadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method set_shadow_type
- (of-object "GtkCList")
- (c-name "gtk_clist_set_shadow_type")
- (return-type "none")
- (parameters
- '("GtkShadowType" "type")
- )
-)
-
-(define-method set_selection_mode
- (of-object "GtkCList")
- (c-name "gtk_clist_set_selection_mode")
- (return-type "none")
- (parameters
- '("GtkSelectionMode" "mode")
- )
-)
-
-(define-method set_reorderable
- (of-object "GtkCList")
- (c-name "gtk_clist_set_reorderable")
- (return-type "none")
- (parameters
- '("gboolean" "reorderable")
- )
-)
-
-(define-method set_use_drag_icons
- (of-object "GtkCList")
- (c-name "gtk_clist_set_use_drag_icons")
- (return-type "none")
- (parameters
- '("gboolean" "use_icons")
- )
-)
-
-(define-method set_button_actions
- (of-object "GtkCList")
- (c-name "gtk_clist_set_button_actions")
- (return-type "none")
- (parameters
- '("guint" "button")
- '("guint8" "button_actions")
- )
-)
-
-(define-method freeze
- (of-object "GtkCList")
- (c-name "gtk_clist_freeze")
- (return-type "none")
-)
-
-(define-method thaw
- (of-object "GtkCList")
- (c-name "gtk_clist_thaw")
- (return-type "none")
-)
-
-(define-method column_titles_show
- (of-object "GtkCList")
- (c-name "gtk_clist_column_titles_show")
- (return-type "none")
-)
-
-(define-method column_titles_hide
- (of-object "GtkCList")
- (c-name "gtk_clist_column_titles_hide")
- (return-type "none")
-)
-
-(define-method column_title_active
- (of-object "GtkCList")
- (c-name "gtk_clist_column_title_active")
- (return-type "none")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method column_title_passive
- (of-object "GtkCList")
- (c-name "gtk_clist_column_title_passive")
- (return-type "none")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method column_titles_active
- (of-object "GtkCList")
- (c-name "gtk_clist_column_titles_active")
- (return-type "none")
-)
-
-(define-method column_titles_passive
- (of-object "GtkCList")
- (c-name "gtk_clist_column_titles_passive")
- (return-type "none")
-)
-
-(define-method set_column_title
- (of-object "GtkCList")
- (c-name "gtk_clist_set_column_title")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("const-gchar*" "title")
- )
-)
-
-(define-method get_column_title
- (of-object "GtkCList")
- (c-name "gtk_clist_get_column_title")
- (return-type "gchar*")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method set_column_widget
- (of-object "GtkCList")
- (c-name "gtk_clist_set_column_widget")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("GtkWidget*" "widget")
- )
-)
-
-(define-method get_column_widget
- (of-object "GtkCList")
- (c-name "gtk_clist_get_column_widget")
- (return-type "GtkWidget*")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method set_column_justification
- (of-object "GtkCList")
- (c-name "gtk_clist_set_column_justification")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("GtkJustification" "justification")
- )
-)
-
-(define-method set_column_visibility
- (of-object "GtkCList")
- (c-name "gtk_clist_set_column_visibility")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("gboolean" "visible")
- )
-)
-
-(define-method set_column_resizeable
- (of-object "GtkCList")
- (c-name "gtk_clist_set_column_resizeable")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("gboolean" "resizeable")
- )
-)
-
-(define-method set_column_auto_resize
- (of-object "GtkCList")
- (c-name "gtk_clist_set_column_auto_resize")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("gboolean" "auto_resize")
- )
-)
-
-(define-method columns_autosize
- (of-object "GtkCList")
- (c-name "gtk_clist_columns_autosize")
- (return-type "gint")
-)
-
-(define-method optimal_column_width
- (of-object "GtkCList")
- (c-name "gtk_clist_optimal_column_width")
- (return-type "gint")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method set_column_width
- (of-object "GtkCList")
- (c-name "gtk_clist_set_column_width")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("gint" "width")
- )
-)
-
-(define-method set_column_min_width
- (of-object "GtkCList")
- (c-name "gtk_clist_set_column_min_width")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("gint" "min_width")
- )
-)
-
-(define-method set_column_max_width
- (of-object "GtkCList")
- (c-name "gtk_clist_set_column_max_width")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("gint" "max_width")
- )
-)
-
-(define-method set_row_height
- (of-object "GtkCList")
- (c-name "gtk_clist_set_row_height")
- (return-type "none")
- (parameters
- '("guint" "height")
- )
-)
-
-(define-method moveto
- (of-object "GtkCList")
- (c-name "gtk_clist_moveto")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "column")
- '("gfloat" "row_align")
- '("gfloat" "col_align")
- )
-)
-
-(define-method row_is_visible
- (of-object "GtkCList")
- (c-name "gtk_clist_row_is_visible")
- (return-type "GtkVisibility")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-method get_cell_type
- (of-object "GtkCList")
- (c-name "gtk_clist_get_cell_type")
- (return-type "GtkCellType")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-method set_text
- (of-object "GtkCList")
- (c-name "gtk_clist_set_text")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "column")
- '("const-gchar*" "text")
- )
-)
-
-(define-method get_text
- (of-object "GtkCList")
- (c-name "gtk_clist_get_text")
- (return-type "gint")
- (parameters
- '("gint" "row")
- '("gint" "column")
- '("gchar**" "text")
- )
-)
-
-(define-method set_pixmap
- (of-object "GtkCList")
- (c-name "gtk_clist_set_pixmap")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "column")
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_pixmap
- (of-object "GtkCList")
- (c-name "gtk_clist_get_pixmap")
- (return-type "gint")
- (parameters
- '("gint" "row")
- '("gint" "column")
- '("GdkPixmap**" "pixmap")
- '("GdkBitmap**" "mask")
- )
-)
-
-(define-method set_pixtext
- (of-object "GtkCList")
- (c-name "gtk_clist_set_pixtext")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "column")
- '("const-gchar*" "text")
- '("guint8" "spacing")
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask")
- )
-)
-
-(define-method get_pixtext
- (of-object "GtkCList")
- (c-name "gtk_clist_get_pixtext")
- (return-type "gint")
- (parameters
- '("gint" "row")
- '("gint" "column")
- '("gchar**" "text")
- '("guint8*" "spacing")
- '("GdkPixmap**" "pixmap")
- '("GdkBitmap**" "mask")
- )
-)
-
-(define-method set_foreground
- (of-object "GtkCList")
- (c-name "gtk_clist_set_foreground")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("GdkColor*" "color")
- )
-)
-
-(define-method set_background
- (of-object "GtkCList")
- (c-name "gtk_clist_set_background")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("GdkColor*" "color")
- )
-)
-
-(define-method set_cell_style
- (of-object "GtkCList")
- (c-name "gtk_clist_set_cell_style")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "column")
- '("GtkStyle*" "style")
- )
-)
-
-(define-method get_cell_style
- (of-object "GtkCList")
- (c-name "gtk_clist_get_cell_style")
- (return-type "GtkStyle*")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-method set_row_style
- (of-object "GtkCList")
- (c-name "gtk_clist_set_row_style")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("GtkStyle*" "style")
- )
-)
-
-(define-method get_row_style
- (of-object "GtkCList")
- (c-name "gtk_clist_get_row_style")
- (return-type "GtkStyle*")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-method set_shift
- (of-object "GtkCList")
- (c-name "gtk_clist_set_shift")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "column")
- '("gint" "vertical")
- '("gint" "horizontal")
- )
-)
-
-(define-method set_selectable
- (of-object "GtkCList")
- (c-name "gtk_clist_set_selectable")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gboolean" "selectable")
- )
-)
-
-(define-method get_selectable
- (of-object "GtkCList")
- (c-name "gtk_clist_get_selectable")
- (return-type "gboolean")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-method prepend
- (of-object "GtkCList")
- (c-name "gtk_clist_prepend")
- (return-type "gint")
- (parameters
- '("gchar*[]" "text")
- )
-)
-
-(define-method append
- (of-object "GtkCList")
- (c-name "gtk_clist_append")
- (return-type "gint")
- (parameters
- '("gchar*[]" "text")
- )
-)
-
-(define-method insert
- (of-object "GtkCList")
- (c-name "gtk_clist_insert")
- (return-type "gint")
- (parameters
- '("gint" "row")
- '("gchar*[]" "text")
- )
-)
-
-(define-method remove
- (of-object "GtkCList")
- (c-name "gtk_clist_remove")
- (return-type "none")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-method set_row_data
- (of-object "GtkCList")
- (c-name "gtk_clist_set_row_data")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gpointer" "data")
- )
-)
-
-(define-method set_row_data_full
- (of-object "GtkCList")
- (c-name "gtk_clist_set_row_data_full")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method get_row_data
- (of-object "GtkCList")
- (c-name "gtk_clist_get_row_data")
- (return-type "gpointer")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-method find_row_from_data
- (of-object "GtkCList")
- (c-name "gtk_clist_find_row_from_data")
- (return-type "gint")
- (parameters
- '("gpointer" "data")
- )
-)
-
-(define-method select_row
- (of-object "GtkCList")
- (c-name "gtk_clist_select_row")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-method unselect_row
- (of-object "GtkCList")
- (c-name "gtk_clist_unselect_row")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "column")
- )
-)
-
-(define-method undo_selection
- (of-object "GtkCList")
- (c-name "gtk_clist_undo_selection")
- (return-type "none")
-)
-
-(define-method clear
- (of-object "GtkCList")
- (c-name "gtk_clist_clear")
- (return-type "none")
-)
-
-(define-method get_selection_info
- (of-object "GtkCList")
- (c-name "gtk_clist_get_selection_info")
- (return-type "gint")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint*" "row")
- '("gint*" "column")
- )
-)
-
-(define-method select_all
- (of-object "GtkCList")
- (c-name "gtk_clist_select_all")
- (return-type "none")
-)
-
-(define-method unselect_all
- (of-object "GtkCList")
- (c-name "gtk_clist_unselect_all")
- (return-type "none")
-)
-
-(define-method swap_rows
- (of-object "GtkCList")
- (c-name "gtk_clist_swap_rows")
- (return-type "none")
- (parameters
- '("gint" "row1")
- '("gint" "row2")
- )
-)
-
-(define-method row_move
- (of-object "GtkCList")
- (c-name "gtk_clist_row_move")
- (return-type "none")
- (parameters
- '("gint" "source_row")
- '("gint" "dest_row")
- )
-)
-
-(define-method set_compare_func
- (of-object "GtkCList")
- (c-name "gtk_clist_set_compare_func")
- (return-type "none")
- (parameters
- '("GtkCListCompareFunc" "cmp_func")
- )
-)
-
-(define-method set_sort_column
- (of-object "GtkCList")
- (c-name "gtk_clist_set_sort_column")
- (return-type "none")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method set_sort_type
- (of-object "GtkCList")
- (c-name "gtk_clist_set_sort_type")
- (return-type "none")
- (parameters
- '("GtkSortType" "sort_type")
- )
-)
-
-(define-method sort
- (of-object "GtkCList")
- (c-name "gtk_clist_sort")
- (return-type "none")
-)
-
-(define-method set_auto_sort
- (of-object "GtkCList")
- (c-name "gtk_clist_set_auto_sort")
- (return-type "none")
- (parameters
- '("gboolean" "auto_sort")
- )
-)
-
-(define-virtual set_scroll_adjustments
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "hadjustment")
- '("GtkAdjustment*" "vadjustment")
- )
-)
-
-(define-virtual refresh
- (of-object "GtkCList")
- (return-type "none")
-)
-
-(define-virtual select_row
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "column")
- '("GdkEvent*" "event")
- )
-)
-
-(define-virtual unselect_row
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("gint" "row")
- '("gint" "column")
- '("GdkEvent*" "event")
- )
-)
-
-(define-virtual row_move
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("gint" "source_row")
- '("gint" "dest_row")
- )
-)
-
-(define-virtual click_column
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-virtual resize_column
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("gint" "column")
- '("gint" "width")
- )
-)
-
-(define-virtual toggle_focus_row
- (of-object "GtkCList")
- (return-type "none")
-)
-
-(define-virtual select_all
- (of-object "GtkCList")
- (return-type "none")
-)
-
-(define-virtual unselect_all
- (of-object "GtkCList")
- (return-type "none")
-)
-
-(define-virtual undo_selection
- (of-object "GtkCList")
- (return-type "none")
-)
-
-(define-virtual start_selection
- (of-object "GtkCList")
- (return-type "none")
-)
-
-(define-virtual end_selection
- (of-object "GtkCList")
- (return-type "none")
-)
-
-(define-virtual extend_selection
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll_type")
- '("gfloat" "position")
- '("gboolean" "auto_start_selection")
- )
-)
-
-(define-virtual scroll_horizontal
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll_type")
- '("gfloat" "position")
- )
-)
-
-(define-virtual scroll_vertical
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll_type")
- '("gfloat" "position")
- )
-)
-
-(define-virtual toggle_add_mode
- (of-object "GtkCList")
- (return-type "none")
-)
-
-(define-virtual abort_column_resize
- (of-object "GtkCList")
- (return-type "none")
-)
-
-(define-virtual resync_selection
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-
-(define-virtual selection_find
- (of-object "GtkCList")
- (return-type "GList*")
- (parameters
- '("gint" "row_number")
- '("GList*" "row_list_element")
- )
-)
-
-(define-virtual draw_row
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "area")
- '("gint" "row")
- '("GtkCListRow*" "clist_row")
- )
-)
-
-(define-virtual draw_drag_highlight
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("GtkCListRow*" "target_row")
- '("gint" "target_row_number")
- '("GtkCListDragPos" "drag_pos")
- )
-)
-
-(define-virtual clear
- (of-object "GtkCList")
- (return-type "none")
-)
-
-(define-virtual fake_unselect_all
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-virtual sort_list
- (of-object "GtkCList")
- (return-type "none")
-)
-
-(define-virtual insert_row
- (of-object "GtkCList")
- (return-type "gint")
- (parameters
- '("gint" "row")
- '("gchar*[]" "text")
- )
-)
-
-(define-virtual remove_row
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-virtual set_cell_contents
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("GtkCListRow*" "clist_row")
- '("gint" "column")
- '("GtkCellType" "type")
- '("const-gchar*" "text")
- '("guint8" "spacing")
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask")
- )
-)
-
-(define-virtual cell_size_request
- (of-object "GtkCList")
- (return-type "none")
- (parameters
- '("GtkCListRow*" "clist_row")
- '("gint" "column")
- '("GtkRequisition*" "requisition")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcolorbutton.h
-
-(define-function gtk_color_button_get_type
- (c-name "gtk_color_button_get_type")
- (return-type "GType")
-)
-
-(define-function color_button_new
- (c-name "gtk_color_button_new")
- (is-constructor-of "GtkColorButton")
- (return-type "GtkWidget*")
-)
-
-(define-function color_button_new_with_color
- (c-name "gtk_color_button_new_with_color")
- (is-constructor-of "GtkColorButton")
- (return-type "GtkWidget*")
- (parameters
- '("const-GdkColor*" "color")
- )
-)
-
-(define-method set_color
- (of-object "GtkColorButton")
- (c-name "gtk_color_button_set_color")
- (return-type "none")
- (parameters
- '("const-GdkColor*" "color")
- )
-)
-
-(define-method set_alpha
- (of-object "GtkColorButton")
- (c-name "gtk_color_button_set_alpha")
- (return-type "none")
- (parameters
- '("guint16" "alpha")
- )
-)
-
-(define-method get_color
- (of-object "GtkColorButton")
- (c-name "gtk_color_button_get_color")
- (return-type "none")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method get_alpha
- (of-object "GtkColorButton")
- (c-name "gtk_color_button_get_alpha")
- (return-type "guint16")
-)
-
-(define-method set_use_alpha
- (of-object "GtkColorButton")
- (c-name "gtk_color_button_set_use_alpha")
- (return-type "none")
- (parameters
- '("gboolean" "use_alpha")
- )
-)
-
-(define-method get_use_alpha
- (of-object "GtkColorButton")
- (c-name "gtk_color_button_get_use_alpha")
- (return-type "gboolean")
-)
-
-(define-method set_title
- (of-object "GtkColorButton")
- (c-name "gtk_color_button_set_title")
- (return-type "none")
- (parameters
- '("const-gchar*" "title")
- )
-)
-
-(define-method get_title
- (of-object "GtkColorButton")
- (c-name "gtk_color_button_get_title")
- (return-type "const-gchar*")
-)
-
-(define-virtual color_set
- (of-object "GtkColorButton")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcolorsel.h
-
-(define-function gtk_color_selection_get_type
- (c-name "gtk_color_selection_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_color_selection_new
- (c-name "gtk_color_selection_new")
- (is-constructor-of "GtkColorSelection")
- (return-type "GtkWidget*")
-)
-
-(define-method get_has_opacity_control
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_get_has_opacity_control")
- (return-type "gboolean")
-)
-
-(define-method set_has_opacity_control
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_set_has_opacity_control")
- (return-type "none")
- (parameters
- '("gboolean" "has_opacity")
- )
-)
-
-(define-method get_has_palette
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_get_has_palette")
- (return-type "gboolean")
-)
-
-(define-method set_has_palette
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_set_has_palette")
- (return-type "none")
- (parameters
- '("gboolean" "has_palette")
- )
-)
-
-(define-method set_current_color
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_set_current_color")
- (return-type "none")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method set_current_alpha
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_set_current_alpha")
- (return-type "none")
- (parameters
- '("guint16" "alpha")
- )
-)
-
-(define-method get_current_color
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_get_current_color")
- (return-type "none")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method get_current_alpha
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_get_current_alpha")
- (return-type "guint16")
-)
-
-(define-method set_previous_color
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_set_previous_color")
- (return-type "none")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method set_previous_alpha
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_set_previous_alpha")
- (return-type "none")
- (parameters
- '("guint16" "alpha")
- )
-)
-
-(define-method get_previous_color
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_get_previous_color")
- (return-type "none")
- (parameters
- '("GdkColor*" "color")
- )
-)
-
-(define-method get_previous_alpha
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_get_previous_alpha")
- (return-type "guint16")
-)
-
-(define-method is_adjusting
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_is_adjusting")
- (return-type "gboolean")
-)
-
-(define-function color_selection_palette_from_string
- (c-name "gtk_color_selection_palette_from_string")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "str")
- '("GdkColor**" "colors")
- '("gint*" "n_colors")
- )
-)
-
-(define-function color_selection_palette_to_string
- (c-name "gtk_color_selection_palette_to_string")
- (return-type "gchar*")
- (parameters
- '("const-GdkColor*" "colors")
- '("gint" "n_colors")
- )
-)
-
-(define-function color_selection_set_change_palette_hook
- (c-name "gtk_color_selection_set_change_palette_hook")
- (return-type "GtkColorSelectionChangePaletteFunc")
- (parameters
- '("GtkColorSelectionChangePaletteFunc" "func")
- )
-)
-
-(define-function color_selection_set_change_palette_with_screen_hook
- (c-name "gtk_color_selection_set_change_palette_with_screen_hook")
- (return-type "GtkColorSelectionChangePaletteWithScreenFunc")
- (parameters
- '("GtkColorSelectionChangePaletteWithScreenFunc" "func")
- )
-)
-
-(define-method set_color
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_set_color")
- (return-type "none")
- (parameters
- '("gdouble*" "color")
- )
- (deprecated "use GtkColorSelection.set_current_color")
-)
-
-(define-method get_color
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_get_color")
- (return-type "none")
- (parameters
- '("gdouble*" "color")
- )
- (deprecated "use GtkColorSelection.get_current_color")
-)
-
-(define-method set_update_policy
- (of-object "GtkColorSelection")
- (c-name "gtk_color_selection_set_update_policy")
- (return-type "none")
- (parameters
- '("GtkUpdateType" "policy")
- )
- (deprecated "")
-)
-
-(define-virtual color_changed
- (of-object "GtkColorSelection")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcolorseldialog.h
-
-(define-function gtk_color_selection_dialog_get_type
- (c-name "gtk_color_selection_dialog_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_color_selection_dialog_new
- (c-name "gtk_color_selection_dialog_new")
- (is-constructor-of "GtkColorSelectionDialog")
- (return-type "GtkWidget*")
- (properties
- '("title")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcombo.h
-
-(define-function gtk_combo_get_type
- (c-name "gtk_combo_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_combo_new
- (c-name "gtk_combo_new")
- (is-constructor-of "GtkCombo")
- (return-type "GtkWidget*")
- (deprecated "use gtk.ComboBoxEntry")
-)
-
-(define-method set_value_in_list
- (of-object "GtkCombo")
- (c-name "gtk_combo_set_value_in_list")
- (return-type "none")
- (parameters
- '("gboolean" "val")
- '("gboolean" "ok_if_empty")
- )
-)
-
-(define-method set_use_arrows
- (of-object "GtkCombo")
- (c-name "gtk_combo_set_use_arrows")
- (return-type "none")
- (parameters
- '("gboolean" "val")
- )
-)
-
-(define-method set_use_arrows_always
- (of-object "GtkCombo")
- (c-name "gtk_combo_set_use_arrows_always")
- (return-type "none")
- (parameters
- '("gboolean" "val")
- )
-)
-
-(define-method set_case_sensitive
- (of-object "GtkCombo")
- (c-name "gtk_combo_set_case_sensitive")
- (return-type "none")
- (parameters
- '("gboolean" "val")
- )
-)
-
-(define-method set_item_string
- (of-object "GtkCombo")
- (c-name "gtk_combo_set_item_string")
- (return-type "none")
- (parameters
- '("GtkItem*" "item")
- '("const-gchar*" "item_value")
- )
-)
-
-(define-method set_popdown_strings
- (of-object "GtkCombo")
- (c-name "gtk_combo_set_popdown_strings")
- (return-type "none")
- (parameters
- '("GList*" "strings")
- )
-)
-
-(define-method disable_activate
- (of-object "GtkCombo")
- (c-name "gtk_combo_disable_activate")
- (return-type "none")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcombobox.h
-
-(define-function gtk_combo_box_get_type
- (c-name "gtk_combo_box_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_combo_box_new
- (c-name "gtk_combo_box_new")
- (is-constructor-of "GtkComboBox")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_combo_box_new_with_model
- (c-name "gtk_combo_box_new_with_model")
- (is-constructor-of "GtkComboBox")
- (return-type "GtkWidget*")
- (parameters
- '("GtkTreeModel*" "model")
- )
-)
-
-(define-method set_wrap_width
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_set_wrap_width")
- (return-type "none")
- (parameters
- '("gint" "width")
- )
-)
-
-(define-method set_row_span_column
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_set_row_span_column")
- (return-type "none")
- (parameters
- '("gint" "row_span")
- )
-)
-
-(define-method set_column_span_column
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_set_column_span_column")
- (return-type "none")
- (parameters
- '("gint" "column_span")
- )
-)
-
-(define-method get_active
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_active")
- (return-type "gint")
-)
-
-(define-method set_active
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_set_active")
- (return-type "none")
- (parameters
- '("gint" "index")
- )
-)
-
-(define-method get_active_iter
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_active_iter")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method set_active_iter
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_set_active_iter")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method set_model
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_set_model")
- (return-type "none")
- (parameters
- '("GtkTreeModel*" "model" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_model
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_model")
- (return-type "GtkTreeModel*")
-)
-
-(define-function combo_box_new_text
- (c-name "gtk_combo_box_new_text")
- (return-type "GtkWidget*")
- (caller-owns-return #t)
-)
-
-(define-method append_text
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_append_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- )
-)
-
-(define-method insert_text
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_insert_text")
- (return-type "none")
- (parameters
- '("gint" "position")
- '("const-gchar*" "text")
- )
-)
-
-(define-method prepend_text
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_prepend_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- )
-)
-
-(define-method remove_text
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_remove_text")
- (return-type "none")
- (parameters
- '("gint" "position")
- )
-)
-
-(define-method popup
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_popup")
- (return-type "none")
-)
-
-(define-method popdown
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_popdown")
- (return-type "none")
-)
-
-(define-method get_wrap_width
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_wrap_width")
- (return-type "gint")
-)
-
-(define-method get_row_span_column
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_row_span_column")
- (return-type "gint")
-)
-
-(define-method get_column_span_column
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_column_span_column")
- (return-type "gint")
-)
-
-(define-method get_add_tearoffs
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_add_tearoffs")
- (return-type "gboolean")
-)
-
-(define-method set_add_tearoffs
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_set_add_tearoffs")
- (return-type "none")
- (parameters
- '("gboolean" "add_tearoffs")
- )
-)
-
-(define-method get_focus_on_click
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_focus_on_click")
- (return-type "gboolean")
-)
-
-(define-method set_focus_on_click
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_set_focus_on_click")
- (return-type "none")
- (parameters
- '("gboolean" "focus_on_click")
- )
-)
-
-(define-method set_row_separator_func
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_set_row_separator_func")
- (return-type "none")
- (parameters
- '("GtkTreeViewRowSeparatorFunc" "func")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method get_row_separator_func
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_row_separator_func")
- (return-type "GtkTreeViewRowSeparatorFunc")
-)
-
-
-(define-method get_active_text
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_active_text")
- (return-type "gchar*")
-)
-
-(define-method get_popup_accessible
- (of-object "GtkComboBox")
- (c-name "gtk_combo_box_get_popup_accessible")
- (return-type "AtkObject*")
-)
-
-(define-virtual changed
- (of-object "GtkComboBox")
- (return-type "none")
-)
-
-(define-virtual get_active_text
- (of-object "GtkComboBox")
- (return-type "char*")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcomboboxentry.h
-
-(define-function gtk_combo_box_entry_get_type
- (c-name "gtk_combo_box_entry_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_combo_box_entry_new
- (c-name "gtk_combo_box_entry_new")
- (is-constructor-of "GtkComboBoxEntry")
- (return-type "GtkWidget*")
-)
-
-(define-function combo_box_entry_new_with_model
- (c-name "gtk_combo_box_entry_new_with_model")
- (return-type "GtkWidget*")
- (parameters
- '("GtkTreeModel*" "model")
- '("gint" "text_column")
- )
- (caller-owns-return #t)
-)
-
-(define-method set_text_column
- (of-object "GtkComboBoxEntry")
- (c-name "gtk_combo_box_entry_set_text_column")
- (return-type "none")
- (parameters
- '("gint" "text_column")
- )
-)
-
-(define-method get_text_column
- (of-object "GtkComboBoxEntry")
- (c-name "gtk_combo_box_entry_get_text_column")
- (return-type "gint")
-)
-
-(define-function combo_box_entry_new_text
- (c-name "gtk_combo_box_entry_new_text")
- (return-type "GtkWidget*")
- (caller-owns-return #t)
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcontainer.h
-
-(define-function gtk_container_get_type
- (c-name "gtk_container_get_type")
- (return-type "GType")
-)
-
-(define-method set_border_width
- (of-object "GtkContainer")
- (c-name "gtk_container_set_border_width")
- (return-type "none")
- (parameters
- '("guint" "border_width")
- )
-)
-
-(define-method get_border_width
- (of-object "GtkContainer")
- (c-name "gtk_container_get_border_width")
- (return-type "guint")
-)
-
-(define-method add
- (of-object "GtkContainer")
- (c-name "gtk_container_add")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-method remove
- (of-object "GtkContainer")
- (c-name "gtk_container_remove")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-method set_resize_mode
- (of-object "GtkContainer")
- (c-name "gtk_container_set_resize_mode")
- (return-type "none")
- (parameters
- '("GtkResizeMode" "resize_mode")
- )
-)
-
-(define-method get_resize_mode
- (of-object "GtkContainer")
- (c-name "gtk_container_get_resize_mode")
- (return-type "GtkResizeMode")
-)
-
-(define-method check_resize
- (of-object "GtkContainer")
- (c-name "gtk_container_check_resize")
- (return-type "none")
-)
-
-(define-method foreach
- (of-object "GtkContainer")
- (c-name "gtk_container_foreach")
- (return-type "none")
- (parameters
- '("GtkCallback" "callback")
- '("gpointer" "callback_data")
- )
-)
-
-(define-method foreach_full
- (of-object "GtkContainer")
- (c-name "gtk_container_foreach_full")
- (return-type "none")
- (parameters
- '("GtkCallback" "callback")
- '("GtkCallbackMarshal" "marshal")
- '("gpointer" "callback_data")
- '("GtkDestroyNotify" "notify")
- )
- (deprecated "")
-)
-
-(define-method get_children
- (of-object "GtkContainer")
- (c-name "gtk_container_get_children")
- (return-type "GList*")
-)
-
-(define-method children
- (of-object "GtkContainer")
- (c-name "gtk_container_children")
- (return-type "GList*")
- (deprecated "use GtkContainer.get_children")
-)
-
-(define-method propagate_expose
- (of-object "GtkContainer")
- (c-name "gtk_container_propagate_expose")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("GdkEventExpose*" "event")
- )
-)
-
-(define-method set_focus_chain
- (of-object "GtkContainer")
- (c-name "gtk_container_set_focus_chain")
- (return-type "none")
- (parameters
- '("GList*" "focusable_widgets")
- )
-)
-
-(define-method get_focus_chain
- (of-object "GtkContainer")
- (c-name "gtk_container_get_focus_chain")
- (return-type "gboolean")
- (parameters
- '("GList**" "focusable_widgets")
- )
-)
-
-(define-method unset_focus_chain
- (of-object "GtkContainer")
- (c-name "gtk_container_unset_focus_chain")
- (return-type "none")
-)
-
-(define-method set_reallocate_redraws
- (of-object "GtkContainer")
- (c-name "gtk_container_set_reallocate_redraws")
- (return-type "none")
- (parameters
- '("gboolean" "needs_redraws")
- )
-)
-
-(define-method set_focus_child
- (of-object "GtkContainer")
- (c-name "gtk_container_set_focus_child")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method set_focus_vadjustment
- (of-object "GtkContainer")
- (c-name "gtk_container_set_focus_vadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment")
- )
-)
-
-(define-method get_focus_vadjustment
- (of-object "GtkContainer")
- (c-name "gtk_container_get_focus_vadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method set_focus_hadjustment
- (of-object "GtkContainer")
- (c-name "gtk_container_set_focus_hadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment")
- )
-)
-
-(define-method get_focus_hadjustment
- (of-object "GtkContainer")
- (c-name "gtk_container_get_focus_hadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method resize_children
- (of-object "GtkContainer")
- (c-name "gtk_container_resize_children")
- (return-type "none")
-)
-
-(define-method child_type
- (of-object "GtkContainer")
- (c-name "gtk_container_child_type")
- (return-type "GType")
-)
-
-(define-function container_class_install_child_property
- (c-name "gtk_container_class_install_child_property")
- (return-type "none")
- (parameters
- '("GtkContainerClass*" "cclass")
- '("guint" "property_id")
- '("GParamSpec*" "pspec")
- )
-)
-
-(define-function container_class_find_child_property
- (c-name "gtk_container_class_find_child_property")
- (return-type "GParamSpec*")
- (parameters
- '("GObjectClass*" "cclass")
- '("const-gchar*" "property_name")
- )
-)
-
-(define-function container_class_list_child_properties
- (c-name "gtk_container_class_list_child_properties")
- (return-type "GParamSpec**")
- (parameters
- '("GObjectClass*" "cclass")
- '("guint*" "n_properties")
- )
-)
-
-(define-method add_with_properties
- (of-object "GtkContainer")
- (c-name "gtk_container_add_with_properties")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("const-gchar*" "first_prop_name")
- )
- (varargs #t)
-)
-
-(define-method child_set
- (of-object "GtkContainer")
- (c-name "gtk_container_child_set")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("const-gchar*" "first_prop_name")
- )
- (varargs #t)
-)
-
-(define-method child_get
- (of-object "GtkContainer")
- (c-name "gtk_container_child_get")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("const-gchar*" "first_prop_name")
- )
- (varargs #t)
-)
-
-(define-method child_set_valist
- (of-object "GtkContainer")
- (c-name "gtk_container_child_set_valist")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("const-gchar*" "first_property_name")
- '("va_list" "var_args")
- )
-)
-
-(define-method child_get_valist
- (of-object "GtkContainer")
- (c-name "gtk_container_child_get_valist")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("const-gchar*" "first_property_name")
- '("va_list" "var_args")
- )
-)
-
-(define-method child_set_property
- (of-object "GtkContainer")
- (c-name "gtk_container_child_set_property")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("const-gchar*" "property_name")
- '("const-GValue*" "value")
- )
-)
-
-(define-method child_get_property
- (of-object "GtkContainer")
- (c-name "gtk_container_child_get_property")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("const-gchar*" "property_name")
- '("GValue*" "value")
- )
-)
-
-(define-method forall
- (of-object "GtkContainer")
- (c-name "gtk_container_forall")
- (return-type "none")
- (parameters
- '("GtkCallback" "callback")
- '("gpointer" "callback_data")
- )
-)
-
-(define-virtual add
- (of-object "GtkContainer")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-(define-virtual remove
- (of-object "GtkContainer")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-(define-virtual check_resize
- (of-object "GtkContainer")
- (return-type "none")
-)
-(define-virtual forall
- (of-object "GtkContainer")
- (return-type "none")
- (parameters
- '("gboolean" "include_internals")
- '("GtkCallback" "callback")
- '("gpointer" "callback_data")
- )
-)
-(define-virtual set_focus_child
- (of-object "GtkContainer")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-(define-virtual child_type
- (of-object "GtkContainer")
- (return-type "GType")
-)
-(define-virtual composite_name
- (of-object "GtkContainer")
- (return-type "gchar*")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-(define-virtual set_child_property
- (of-object "GtkContainer")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("guint" "property_id")
- '("const-GValue*" "value")
- '("GParamSpec*" "pspec")
- )
-)
-(define-virtual get_child_property
- (of-object "GtkContainer")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("guint" "property_id")
- '("GValue*" "value")
- '("GParamSpec*" "pspec")
- )
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkctree.h
-
-(define-function gtk_ctree_get_type
- (c-name "gtk_ctree_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_ctree_new_with_titles
- (c-name "gtk_ctree_new_with_titles")
- (is-constructor-of "GtkCTree")
- (return-type "GtkWidget*")
- (parameters
- '("gint" "columns" (default "1"))
- '("gint" "tree_column" (default "0"))
- '("gchar*[]" "titles")
- )
- (deprecated "use GtkTreeStore/GtkTreeView")
-)
-
-(define-function gtk_ctree_new
- (c-name "gtk_ctree_new")
- (is-constructor-of "GtkCTree")
- (return-type "GtkWidget*")
- (parameters
- '("gint" "columns" (default "1"))
- '("gint" "tree_column" (default "0"))
- )
- (deprecated "use GtkTreeStore/GtkTreeView")
-)
-
-(define-method base_nodes
- (of-object "GtkCTree")
- (c-name "gtk_ctree_base_nodes")
- (return-type "GList*")
-)
-
-(define-method insert_node
- (of-object "GtkCTree")
- (c-name "gtk_ctree_insert_node")
- (return-type "GtkCTreeNode*")
- (parameters
- '("GtkCTreeNode*" "parent")
- '("GtkCTreeNode*" "sibling")
- '("gchar*[]" "text")
- '("guint8" "spacing" (default "5"))
- '("GdkPixmap*" "pixmap_closed" (null-ok) (default "NULL"))
- '("GdkBitmap*" "mask_closed" (null-ok) (default "NULL"))
- '("GdkPixmap*" "pixmap_opened" (null-ok) (default "NULL"))
- '("GdkBitmap*" "mask_opened" (null-ok) (default "NULL"))
- '("gboolean" "is_leaf" (default "1"))
- '("gboolean" "expanded" (default "0"))
- )
-)
-
-(define-method remove_node
- (of-object "GtkCTree")
- (c-name "gtk_ctree_remove_node")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method insert_gnode
- (of-object "GtkCTree")
- (c-name "gtk_ctree_insert_gnode")
- (return-type "GtkCTreeNode*")
- (parameters
- '("GtkCTreeNode*" "parent")
- '("GtkCTreeNode*" "sibling")
- '("GNode*" "gnode")
- '("GtkCTreeGNodeFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method export_to_gnode
- (of-object "GtkCTree")
- (c-name "gtk_ctree_export_to_gnode")
- (return-type "GNode*")
- (parameters
- '("GNode*" "parent")
- '("GNode*" "sibling")
- '("GtkCTreeNode*" "node")
- '("GtkCTreeGNodeFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method post_recursive
- (of-object "GtkCTree")
- (c-name "gtk_ctree_post_recursive")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("GtkCTreeFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method post_recursive_to_depth
- (of-object "GtkCTree")
- (c-name "gtk_ctree_post_recursive_to_depth")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "depth")
- '("GtkCTreeFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method pre_recursive
- (of-object "GtkCTree")
- (c-name "gtk_ctree_pre_recursive")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("GtkCTreeFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method pre_recursive_to_depth
- (of-object "GtkCTree")
- (c-name "gtk_ctree_pre_recursive_to_depth")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "depth")
- '("GtkCTreeFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method is_viewable
- (of-object "GtkCTree")
- (c-name "gtk_ctree_is_viewable")
- (return-type "gboolean")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method last
- (of-object "GtkCTree")
- (c-name "gtk_ctree_last")
- (return-type "GtkCTreeNode*")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method find_node_ptr
- (of-object "GtkCTree")
- (c-name "gtk_ctree_find_node_ptr")
- (return-type "GtkCTreeNode*")
- (parameters
- '("GtkCTreeRow*" "ctree_row")
- )
-)
-
-(define-method node_nth
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_nth")
- (return-type "GtkCTreeNode*")
- (parameters
- '("guint" "row")
- )
-)
-
-(define-method find
- (of-object "GtkCTree")
- (c-name "gtk_ctree_find")
- (return-type "gboolean")
- (parameters
- '("GtkCTreeNode*" "node")
- '("GtkCTreeNode*" "child")
- )
-)
-
-(define-method is_ancestor
- (of-object "GtkCTree")
- (c-name "gtk_ctree_is_ancestor")
- (return-type "gboolean")
- (parameters
- '("GtkCTreeNode*" "node")
- '("GtkCTreeNode*" "child")
- )
-)
-
-(define-method find_by_row_data
- (of-object "GtkCTree")
- (c-name "gtk_ctree_find_by_row_data")
- (return-type "GtkCTreeNode*")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gpointer" "data")
- )
-)
-
-(define-method find_all_by_row_data
- (of-object "GtkCTree")
- (c-name "gtk_ctree_find_all_by_row_data")
- (return-type "GList*")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gpointer" "data")
- )
-)
-
-(define-method find_by_row_data_custom
- (of-object "GtkCTree")
- (c-name "gtk_ctree_find_by_row_data_custom")
- (return-type "GtkCTreeNode*")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gpointer" "data")
- '("GCompareFunc" "func")
- )
-)
-
-(define-method find_all_by_row_data_custom
- (of-object "GtkCTree")
- (c-name "gtk_ctree_find_all_by_row_data_custom")
- (return-type "GList*")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gpointer" "data")
- '("GCompareFunc" "func")
- )
-)
-
-(define-method is_hot_spot
- (of-object "GtkCTree")
- (c-name "gtk_ctree_is_hot_spot")
- (return-type "gboolean")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method move
- (of-object "GtkCTree")
- (c-name "gtk_ctree_move")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("GtkCTreeNode*" "new_parent" (null-ok))
- '("GtkCTreeNode*" "new_sibling" (null-ok))
- )
-)
-
-(define-method expand
- (of-object "GtkCTree")
- (c-name "gtk_ctree_expand")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method expand_recursive
- (of-object "GtkCTree")
- (c-name "gtk_ctree_expand_recursive")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method expand_to_depth
- (of-object "GtkCTree")
- (c-name "gtk_ctree_expand_to_depth")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "depth")
- )
-)
-
-(define-method collapse
- (of-object "GtkCTree")
- (c-name "gtk_ctree_collapse")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method collapse_recursive
- (of-object "GtkCTree")
- (c-name "gtk_ctree_collapse_recursive")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method collapse_to_depth
- (of-object "GtkCTree")
- (c-name "gtk_ctree_collapse_to_depth")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "depth")
- )
-)
-
-(define-method toggle_expansion
- (of-object "GtkCTree")
- (c-name "gtk_ctree_toggle_expansion")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method toggle_expansion_recursive
- (of-object "GtkCTree")
- (c-name "gtk_ctree_toggle_expansion_recursive")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method select
- (of-object "GtkCTree")
- (c-name "gtk_ctree_select")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method select_recursive
- (of-object "GtkCTree")
- (c-name "gtk_ctree_select_recursive")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method unselect
- (of-object "GtkCTree")
- (c-name "gtk_ctree_unselect")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method unselect_recursive
- (of-object "GtkCTree")
- (c-name "gtk_ctree_unselect_recursive")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method real_select_recursive
- (of-object "GtkCTree")
- (c-name "gtk_ctree_real_select_recursive")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "state")
- )
-)
-
-(define-method node_set_text
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_set_text")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "column")
- '("const-gchar*" "text")
- )
-)
-
-(define-method node_set_pixmap
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_set_pixmap")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "column")
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask" (null-ok))
- )
-)
-
-(define-method node_set_pixtext
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_set_pixtext")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "column")
- '("const-gchar*" "text")
- '("guint8" "spacing")
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask" (null-ok))
- )
-)
-
-(define-method set_node_info
- (of-object "GtkCTree")
- (c-name "gtk_ctree_set_node_info")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("const-gchar*" "text")
- '("guint8" "spacing")
- '("GdkPixmap*" "pixmap_closed" (null-ok))
- '("GdkBitmap*" "mask_closed" (null-ok))
- '("GdkPixmap*" "pixmap_opened" (null-ok))
- '("GdkBitmap*" "mask_opened" (null-ok))
- '("gboolean" "is_leaf")
- '("gboolean" "expanded")
- )
-)
-
-(define-method node_set_shift
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_set_shift")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "column")
- '("gint" "vertical")
- '("gint" "horizontal")
- )
-)
-
-(define-method node_set_selectable
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_set_selectable")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gboolean" "selectable")
- )
-)
-
-(define-method node_get_selectable
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_get_selectable")
- (return-type "gboolean")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method node_get_cell_type
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_get_cell_type")
- (return-type "GtkCellType")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "column")
- )
-)
-
-(define-method node_get_text
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_get_text")
- (return-type "gboolean")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "column")
- '("gchar**" "text")
- )
-)
-
-(define-method node_get_pixmap
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_get_pixmap")
- (return-type "gboolean")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "column")
- '("GdkPixmap**" "pixmap")
- '("GdkBitmap**" "mask")
- )
-)
-
-(define-method node_get_pixtext
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_get_pixtext")
- (return-type "gboolean")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "column")
- '("gchar**" "text")
- '("guint8*" "spacing")
- '("GdkPixmap**" "pixmap")
- '("GdkBitmap**" "mask")
- )
-)
-
-(define-method get_node_info
- (of-object "GtkCTree")
- (c-name "gtk_ctree_get_node_info")
- (return-type "gboolean")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gchar**" "text")
- '("guint8*" "spacing")
- '("GdkPixmap**" "pixmap_closed")
- '("GdkBitmap**" "mask_closed")
- '("GdkPixmap**" "pixmap_opened")
- '("GdkBitmap**" "mask_opened")
- '("gboolean*" "is_leaf")
- '("gboolean*" "expanded")
- )
-)
-
-(define-method node_set_row_style
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_set_row_style")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("GtkStyle*" "style")
- )
-)
-
-(define-method node_get_row_style
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_get_row_style")
- (return-type "GtkStyle*")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method node_set_cell_style
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_set_cell_style")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "column")
- '("GtkStyle*" "style")
- )
-)
-
-(define-method node_get_cell_style
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_get_cell_style")
- (return-type "GtkStyle*")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "column")
- )
-)
-
-(define-method node_set_foreground
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_set_foreground")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("GdkColor*" "color")
- )
-)
-
-(define-method node_set_background
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_set_background")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("GdkColor*" "color")
- )
-)
-
-(define-method node_set_row_data
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_set_row_data")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gpointer" "data")
- )
-)
-
-(define-method node_set_row_data_full
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_set_row_data_full")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method node_get_row_data
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_get_row_data")
- (return-type "gpointer")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method node_moveto
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_moveto")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("gint" "column")
- '("gfloat" "row_align")
- '("gfloat" "col_align")
- )
-)
-
-(define-method node_is_visible
- (of-object "GtkCTree")
- (c-name "gtk_ctree_node_is_visible")
- (return-type "GtkVisibility")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method set_indent
- (of-object "GtkCTree")
- (c-name "gtk_ctree_set_indent")
- (return-type "none")
- (parameters
- '("gint" "indent")
- )
-)
-
-(define-method set_spacing
- (of-object "GtkCTree")
- (c-name "gtk_ctree_set_spacing")
- (return-type "none")
- (parameters
- '("gint" "spacing")
- )
-)
-
-(define-method set_show_stub
- (of-object "GtkCTree")
- (c-name "gtk_ctree_set_show_stub")
- (return-type "none")
- (parameters
- '("gboolean" "show_stub")
- )
-)
-
-(define-method set_line_style
- (of-object "GtkCTree")
- (c-name "gtk_ctree_set_line_style")
- (return-type "none")
- (parameters
- '("GtkCTreeLineStyle" "line_style")
- )
-)
-
-(define-method set_expander_style
- (of-object "GtkCTree")
- (c-name "gtk_ctree_set_expander_style")
- (return-type "none")
- (parameters
- '("GtkCTreeExpanderStyle" "expander_style")
- )
-)
-
-(define-method set_drag_compare_func
- (of-object "GtkCTree")
- (c-name "gtk_ctree_set_drag_compare_func")
- (return-type "none")
- (parameters
- '("GtkCTreeCompareDragFunc" "cmp_func")
- )
-)
-
-(define-method sort_node
- (of-object "GtkCTree")
- (c-name "gtk_ctree_sort_node")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-method sort_recursive
- (of-object "GtkCTree")
- (c-name "gtk_ctree_sort_recursive")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-function gtk_ctree_node_get_type
- (c-name "gtk_ctree_node_get_type")
- (return-type "GType")
-)
-
-(define-virtual tree_select_row
- (of-object "GtkCTree")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "row")
- '("gint" "column")
- )
-)
-
-(define-virtual tree_unselect_row
- (of-object "GtkCTree")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "row")
- '("gint" "column")
- )
-)
-
-(define-virtual tree_expand
- (of-object "GtkCTree")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-virtual tree_collapse
- (of-object "GtkCTree")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- )
-)
-
-(define-virtual tree_move
- (of-object "GtkCTree")
- (return-type "none")
- (parameters
- '("GtkCTreeNode*" "node")
- '("GtkCTreeNode*" "new_parent")
- '("GtkCTreeNode*" "new_sibling")
- )
-)
-
-(define-virtual change_focus_row_expansion
- (of-object "GtkCTree")
- (return-type "none")
- (parameters
- '("GtkCTreeExpansionType" "action")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkcurve.h
-
-(define-function gtk_curve_get_type
- (c-name "gtk_curve_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_curve_new
- (c-name "gtk_curve_new")
- (is-constructor-of "GtkCurve")
- (return-type "GtkWidget*")
-)
-
-(define-method reset
- (of-object "GtkCurve")
- (c-name "gtk_curve_reset")
- (return-type "none")
-)
-
-(define-method set_gamma
- (of-object "GtkCurve")
- (c-name "gtk_curve_set_gamma")
- (return-type "none")
- (parameters
- '("gfloat" "gamma")
- )
-)
-
-(define-method set_range
- (of-object "GtkCurve")
- (c-name "gtk_curve_set_range")
- (return-type "none")
- (parameters
- '("gfloat" "min_x")
- '("gfloat" "max_x")
- '("gfloat" "min_y")
- '("gfloat" "max_y")
- )
-)
-
-(define-method get_vector
- (of-object "GtkCurve")
- (c-name "gtk_curve_get_vector")
- (return-type "none")
- (parameters
- '("int" "veclen")
- '("gfloat[]" "vector")
- )
-)
-
-(define-method set_vector
- (of-object "GtkCurve")
- (c-name "gtk_curve_set_vector")
- (return-type "none")
- (parameters
- '("int" "veclen")
- '("gfloat[]" "vector")
- )
-)
-
-(define-method set_curve_type
- (of-object "GtkCurve")
- (c-name "gtk_curve_set_curve_type")
- (return-type "none")
- (parameters
- '("GtkCurveType" "type")
- )
-)
-
-(define-virtual curve_type_changed
- (of-object "GtkCurve")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkdebug.h
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkdialog.h
-
-(define-function gtk_dialog_get_type
- (c-name "gtk_dialog_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_dialog_new
- (c-name "gtk_dialog_new")
- (is-constructor-of "GtkDialog")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_dialog_new_with_buttons
- (c-name "gtk_dialog_new_with_buttons")
- (is-constructor-of "GtkDialog")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "title" (null-ok) (default "NULL"))
- '("GtkWindow*" "parent" (null-ok) (default "NULL"))
- '("GtkDialogFlags" "flags" (default "0"))
- '("const-gchar*" "first_button_text" (null-ok) (default "NULL"))
- )
- (varargs #t)
-)
-
-(define-method add_action_widget
- (of-object "GtkDialog")
- (c-name "gtk_dialog_add_action_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gint" "response_id")
- )
-)
-
-(define-method add_button
- (of-object "GtkDialog")
- (c-name "gtk_dialog_add_button")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "button_text")
- '("gint" "response_id")
- )
-)
-
-(define-method add_buttons
- (of-object "GtkDialog")
- (c-name "gtk_dialog_add_buttons")
- (return-type "none")
- (parameters
- '("const-gchar*" "first_button_text")
- )
- (varargs #t)
-)
-
-(define-method set_response_sensitive
- (of-object "GtkDialog")
- (c-name "gtk_dialog_set_response_sensitive")
- (return-type "none")
- (parameters
- '("gint" "response_id")
- '("gboolean" "setting")
- )
-)
-
-(define-method set_default_response
- (of-object "GtkDialog")
- (c-name "gtk_dialog_set_default_response")
- (return-type "none")
- (parameters
- '("gint" "response_id")
- )
-)
-
-(define-method get_response_for_widget
- (of-object "GtkDialog")
- (c-name "gtk_dialog_get_response_for_widget")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-method set_has_separator
- (of-object "GtkDialog")
- (c-name "gtk_dialog_set_has_separator")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_has_separator
- (of-object "GtkDialog")
- (c-name "gtk_dialog_get_has_separator")
- (return-type "gboolean")
-)
-
-(define-method response
- (of-object "GtkDialog")
- (c-name "gtk_dialog_response")
- (return-type "none")
- (parameters
- '("gint" "response_id")
- )
-)
-
-(define-method run
- (of-object "GtkDialog")
- (c-name "gtk_dialog_run")
- (return-type "gint")
-)
-
-(define-method set_alternative_button_order
- (of-object "GtkDialog")
- (c-name "gtk_dialog_set_alternative_button_order")
- (return-type "none")
- (parameters
- '("gint" "first_response_id")
- )
- (varargs #t)
-)
-
-(define-method set_alternative_button_order_from_array
- (of-object "GtkDialog")
- (c-name "gtk_dialog_set_alternative_button_order_from_array")
- (return-type "none")
- (parameters
- '("gint" "n_params")
- '("gint*" "new_order")
- )
-)
-
-(define-function alternative_dialog_button_order
- (c-name "gtk_alternative_dialog_button_order")
- (return-type "gboolean")
- (parameters
- '("GdkScreen*" "screen" (null-ok) (default "NULL"))
- )
-)
-
-(define-virtual response
- (of-object "GtkDialog")
- (return-type "none")
- (parameters
- '("gint" "response_id")
- )
-)
-
-(define-virtual close
- (of-object "GtkDialog")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkdnd.h
-
-(define-function drag_finish
- (c-name "gtk_drag_finish")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- '("gboolean" "success")
- '("gboolean" "del")
- '("guint32" "time_")
- )
-)
-
-(define-function drag_set_icon_widget
- (c-name "gtk_drag_set_icon_widget")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- '("GtkWidget*" "widget")
- '("gint" "hot_x")
- '("gint" "hot_y")
- )
-)
-
-(define-function drag_set_icon_pixmap
- (c-name "gtk_drag_set_icon_pixmap")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- '("GdkColormap*" "colormap")
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask")
- '("gint" "hot_x")
- '("gint" "hot_y")
- )
-)
-
-(define-function drag_set_icon_pixbuf
- (c-name "gtk_drag_set_icon_pixbuf")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- '("GdkPixbuf*" "pixbuf")
- '("gint" "hot_x")
- '("gint" "hot_y")
- )
-)
-
-(define-function drag_set_icon_stock
- (c-name "gtk_drag_set_icon_stock")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- '("const-gchar*" "stock_id")
- '("gint" "hot_x")
- '("gint" "hot_y")
- )
-)
-
-(define-function drag_set_icon_name
- (c-name "gtk_drag_set_icon_name")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- '("const-gchar*" "icon_name")
- '("gint" "hot_x")
- '("gint" "hot_y")
- )
-)
-
-(define-function drag_set_icon_default
- (c-name "gtk_drag_set_icon_default")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- )
-)
-
-(define-method drag_check_threshold
- (of-object "GtkWidget")
- (c-name "gtk_drag_check_threshold")
- (return-type "gboolean")
- (parameters
- '("gint" "start_x")
- '("gint" "start_y")
- '("gint" "current_x")
- '("gint" "current_y")
- )
-)
-
-(define-method drag_get_data
- (of-object "GtkWidget")
- (c-name "gtk_drag_get_data")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- '("GdkAtom" "target")
- '("guint32" "time" (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method drag_highlight
- (of-object "GtkWidget")
- (c-name "gtk_drag_highlight")
- (return-type "none")
-)
-
-(define-method drag_unhighlight
- (of-object "GtkWidget")
- (c-name "gtk_drag_unhighlight")
- (return-type "none")
-)
-
-(define-method drag_dest_set
- (of-object "GtkWidget")
- (c-name "gtk_drag_dest_set")
- (return-type "none")
- (parameters
- '("GtkDestDefaults" "flags")
- '("const-GtkTargetEntry*" "targets")
- '("gint" "n_targets")
- '("GdkDragAction" "actions")
- )
-)
-
-(define-method drag_dest_set_proxy
- (of-object "GtkWidget")
- (c-name "gtk_drag_dest_set_proxy")
- (return-type "none")
- (parameters
- '("GdkWindow*" "proxy_window")
- '("GdkDragProtocol" "protocol")
- '("gboolean" "use_coordinates")
- )
-)
-
-(define-method drag_dest_unset
- (of-object "GtkWidget")
- (c-name "gtk_drag_dest_unset")
- (return-type "none")
-)
-
-(define-method drag_dest_find_target
- (of-object "GtkWidget")
- (c-name "gtk_drag_dest_find_target")
- (return-type "GdkAtom")
- (parameters
- '("GdkDragContext*" "context")
- '("GtkTargetList*" "target_list")
- )
-)
-
-(define-method drag_dest_get_target_list
- (of-object "GtkWidget")
- (c-name "gtk_drag_dest_get_target_list")
- (return-type "GtkTargetList*")
-)
-
-(define-method drag_dest_set_target_list
- (of-object "GtkWidget")
- (c-name "gtk_drag_dest_set_target_list")
- (return-type "none")
- (parameters
- '("GtkTargetList*" "target_list")
- )
-)
-
-(define-method drag_source_set
- (of-object "GtkWidget")
- (c-name "gtk_drag_source_set")
- (return-type "none")
- (parameters
- '("GdkModifierType" "start_button_mask")
- '("const-GtkTargetEntry*" "targets")
- '("gint" "n_targets")
- '("GdkDragAction" "actions")
- )
-)
-
-(define-method drag_source_unset
- (of-object "GtkWidget")
- (c-name "gtk_drag_source_unset")
- (return-type "none")
-)
-
-(define-method drag_source_set_icon
- (of-object "GtkWidget")
- (c-name "gtk_drag_source_set_icon")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask" (null-ok) (default "NULL"))
- )
-)
-
-(define-method drag_source_set_icon_pixbuf
- (of-object "GtkWidget")
- (c-name "gtk_drag_source_set_icon_pixbuf")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "pixbuf")
- )
-)
-
-(define-method drag_source_set_icon_stock
- (of-object "GtkWidget")
- (c-name "gtk_drag_source_set_icon_stock")
- (return-type "none")
- (parameters
- '("const-gchar*" "stock_id")
- )
-)
-
-(define-method drag_source_set_icon_name
- (of-object "GtkWidget")
- (c-name "gtk_drag_source_set_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "icon_name")
- )
-)
-
-(define-method drag_source_get_target_list
- (of-object "GtkWidget")
- (c-name "gtk_drag_source_get_target_list")
- (return-type "GtkTargetList*")
-)
-
-(define-method drag_source_set_target_list
- (of-object "GtkWidget")
- (c-name "gtk_drag_source_set_target_list")
- (return-type "none")
- (parameters
- '("GtkTargetList*" "target_list")
- )
-)
-
-(define-method drag_begin
- (of-object "GtkWidget")
- (c-name "gtk_drag_begin")
- (return-type "GdkDragContext*")
- (parameters
- '("GtkTargetList*" "targets")
- '("GdkDragAction" "actions")
- '("gint" "button")
- '("GdkEvent*" "event")
- )
-)
-
-(define-function drag_set_default_icon
- (c-name "gtk_drag_set_default_icon")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask")
- '("gint" "hot_x")
- '("gint" "hot_y")
- )
- (deprecated "change the stock pixbuf for GTK_STOCK_DND")
-)
-
-(define-method drag_dest_add_text_targets
- (of-object "GtkWidget")
- (c-name "gtk_drag_dest_add_text_targets")
- (return-type "none")
-)
-
-(define-method drag_dest_add_image_targets
- (of-object "GtkWidget")
- (c-name "gtk_drag_dest_add_image_targets")
- (return-type "none")
-)
-
-(define-method drag_dest_add_uri_targets
- (of-object "GtkWidget")
- (c-name "gtk_drag_dest_add_uri_targets")
- (return-type "none")
-)
-
-(define-method drag_source_add_text_targets
- (of-object "GtkWidget")
- (c-name "gtk_drag_source_add_text_targets")
- (return-type "none")
-)
-
-(define-method drag_source_add_image_targets
- (of-object "GtkWidget")
- (c-name "gtk_drag_source_add_image_targets")
- (return-type "none")
-)
-
-(define-method drag_source_add_uri_targets
- (of-object "GtkWidget")
- (c-name "gtk_drag_source_add_uri_targets")
- (return-type "none")
-)
-
-(define-function target_list_add_text_targets
- (c-name "gtk_target_list_add_text_targets")
- (return-type "none")
- (parameters
- '("GtkTargetList*" "list")
- '("guint" "info")
- )
-)
-
-(define-function target_list_add_image_targets
- (c-name "gtk_target_list_add_image_targets")
- (return-type "none")
- (parameters
- '("GtkTargetList*" "list")
- '("guint" "info")
- '("gboolean" "writable")
- )
-)
-
-(define-function target_list_add_uri_targets
- (c-name "gtk_target_list_add_uri_targets")
- (return-type "none")
- (parameters
- '("GtkTargetList*" "list")
- '("guint" "info")
- )
-)
-
-(define-function drag_get_source_widget
- (c-name "gtk_drag_get_source_widget")
- (return-type "GtkWidget*")
- (parameters
- '("GdkDragContext*" "context")
- )
-)
-
-(define-function drag_source_set_icon_name
- (c-name "gtk_drag_source_set_icon_name1")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("const-gchar*" "icon_name")
- )
- (deprecated "use GtkWidget.drag_source_set_icon_name")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkdrawingarea.h
-
-(define-function gtk_drawing_area_get_type
- (c-name "gtk_drawing_area_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_drawing_area_new
- (c-name "gtk_drawing_area_new")
- (is-constructor-of "GtkDrawingArea")
- (return-type "GtkWidget*")
-)
-
-(define-method size
- (of-object "GtkDrawingArea")
- (c-name "gtk_drawing_area_size")
- (return-type "none")
- (parameters
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "use GtkWidget.set_size_request")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkeditable.h
-
-(define-function gtk_editable_get_type
- (c-name "gtk_editable_get_type")
- (return-type "GType")
-)
-
-(define-method select_region
- (of-object "GtkEditable")
- (c-name "gtk_editable_select_region")
- (return-type "none")
- (parameters
- '("gint" "start")
- '("gint" "end")
- )
-)
-
-(define-method get_selection_bounds
- (of-object "GtkEditable")
- (c-name "gtk_editable_get_selection_bounds")
- (return-type "gboolean")
- (parameters
- '("gint*" "start")
- '("gint*" "end")
- )
-)
-
-(define-method insert_text
- (of-object "GtkEditable")
- (c-name "gtk_editable_insert_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "new_text")
- '("gint" "new_text_length")
- '("gint*" "position" ("default" "0"))
- )
-)
-
-(define-method delete_text
- (of-object "GtkEditable")
- (c-name "gtk_editable_delete_text")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-
-(define-method get_chars
- (of-object "GtkEditable")
- (c-name "gtk_editable_get_chars")
- (return-type "gchar*")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-
-(define-method cut_clipboard
- (of-object "GtkEditable")
- (c-name "gtk_editable_cut_clipboard")
- (return-type "none")
-)
-
-(define-method copy_clipboard
- (of-object "GtkEditable")
- (c-name "gtk_editable_copy_clipboard")
- (return-type "none")
-)
-
-(define-method paste_clipboard
- (of-object "GtkEditable")
- (c-name "gtk_editable_paste_clipboard")
- (return-type "none")
-)
-
-(define-method delete_selection
- (of-object "GtkEditable")
- (c-name "gtk_editable_delete_selection")
- (return-type "none")
-)
-
-(define-method set_position
- (of-object "GtkEditable")
- (c-name "gtk_editable_set_position")
- (return-type "none")
- (parameters
- '("gint" "position")
- )
-)
-
-(define-method get_position
- (of-object "GtkEditable")
- (c-name "gtk_editable_get_position")
- (return-type "gint")
-)
-
-(define-method set_editable
- (of-object "GtkEditable")
- (c-name "gtk_editable_set_editable")
- (return-type "none")
- (parameters
- '("gboolean" "is_editable")
- )
-)
-
-(define-method get_editable
- (of-object "GtkEditable")
- (c-name "gtk_editable_get_editable")
- (return-type "gboolean")
-)
-
-(define-virtual insert_text
- (of-object "GtkEditable")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("gint" "length")
- '("gint*" "position" (direction "inout"))
- )
-)
-(define-virtual delete_text
- (of-object "GtkEditable")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-(define-virtual changed
- (of-object "GtkEditable")
- (return-type "none")
-)
-(define-virtual do_insert_text
- (of-object "GtkEditable")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("gint" "length")
- '("gint*" "position" (direction "inout"))
- )
-)
-(define-virtual do_delete_text
- (of-object "GtkEditable")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-(define-virtual get_chars
- (of-object "GtkEditable")
- (return-type "gchar*")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-(define-virtual set_selection_bounds
- (of-object "GtkEditable")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-(define-virtual get_selection_bounds
- (of-object "GtkEditable")
- (return-type "gboolean")
- (parameters
- '("gint*" "start_pos" (direction "out"))
- '("gint*" "end_pos" (direction "out"))
- )
-)
-(define-virtual set_position
- (of-object "GtkEditable")
- (return-type "none")
- (parameters
- '("gint" "position")
- )
-)
-(define-virtual get_position
- (of-object "GtkEditable")
- (return-type "gint")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkentry.h
-
-(define-function gtk_entry_get_type
- (c-name "gtk_entry_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_entry_new
- (c-name "gtk_entry_new")
- (is-constructor-of "GtkEntry")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_entry_new_with_max_length
- (c-name "gtk_entry_new_with_max_length")
- (is-constructor-of "GtkEntry")
- (return-type "GtkWidget*")
- (parameters
- '("guint16" "max" (default "0"))
- )
- (deprecated "use gtk.Entry() instead")
-)
-
-(define-method set_visibility
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_visibility")
- (return-type "none")
- (parameters
- '("gboolean" "visible")
- )
-)
-
-(define-method get_visibility
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_visibility")
- (return-type "gboolean")
-)
-
-(define-method set_invisible_char
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_invisible_char")
- (return-type "none")
- (parameters
- '("gunichar" "ch")
- )
-)
-
-(define-method get_invisible_char
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_invisible_char")
- (return-type "gunichar")
-)
-
-(define-method set_has_frame
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_has_frame")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_has_frame
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_has_frame")
- (return-type "gboolean")
-)
-
-(define-method set_max_length
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_max_length")
- (return-type "none")
- (parameters
- '("gint" "max")
- )
-)
-
-(define-method get_max_length
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_max_length")
- (return-type "gint")
-)
-
-(define-method set_activates_default
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_activates_default")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_activates_default
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_activates_default")
- (return-type "gboolean")
-)
-
-(define-method set_width_chars
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_width_chars")
- (return-type "none")
- (parameters
- '("gint" "n_chars")
- )
-)
-
-(define-method get_width_chars
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_width_chars")
- (return-type "gint")
-)
-
-(define-method set_text
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- )
-)
-
-(define-method get_text
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_text")
- (return-type "const-gchar*")
-)
-
-(define-method get_layout
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_layout")
- (return-type "PangoLayout*")
-)
-
-(define-method get_layout_offsets
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_layout_offsets")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- )
-)
-
-(define-method set_alignment
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_alignment")
- (return-type "none")
- (parameters
- '("gfloat" "xalign")
- )
-)
-
-(define-method get_alignment
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_alignment")
- (return-type "gfloat")
-)
-
-(define-method set_completion
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_completion")
- (return-type "none")
- (parameters
- '("GtkEntryCompletion*" "completion" (null-ok))
- )
-)
-
-(define-method get_completion
- (of-object "GtkEntry")
- (c-name "gtk_entry_get_completion")
- (return-type "GtkEntryCompletion*")
-)
-
-(define-method append_text
- (of-object "GtkEntry")
- (c-name "gtk_entry_append_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- )
- (deprecated "use GtkEditable.insert_text")
-)
-
-(define-method prepend_text
- (of-object "GtkEntry")
- (c-name "gtk_entry_prepend_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- )
- (deprecated "use GtkEditable.insert_text")
-)
-
-(define-method set_position
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_position")
- (return-type "none")
- (parameters
- '("gint" "position")
- )
-)
-
-(define-method select_region
- (of-object "GtkEntry")
- (c-name "gtk_entry_select_region")
- (return-type "none")
- (parameters
- '("gint" "start")
- '("gint" "end")
- )
-)
-
-(define-method set_editable
- (of-object "GtkEntry")
- (c-name "gtk_entry_set_editable")
- (return-type "none")
- (parameters
- '("gboolean" "editable")
- )
-)
-
-(define-method layout_index_to_text_index
- (of-object "GtkEntry")
- (c-name "gtk_entry_layout_index_to_text_index")
- (return-type "gint")
- (parameters
- '("gint" "layout_index")
- )
-)
-
-(define-method text_index_to_layout_index
- (of-object "GtkEntry")
- (c-name "gtk_entry_text_index_to_layout_index")
- (return-type "gint")
- (parameters
- '("gint" "text_index")
- )
-)
-
-(define-virtual populate_popup
- (of-object "GtkEntry")
- (return-type "none")
- (parameters
- '("GtkMenu*" "menu")
- )
-)
-
-(define-virtual activate
- (of-object "GtkEntry")
- (return-type "none")
-)
-
-(define-virtual move_cursor
- (of-object "GtkEntry")
- (return-type "none")
- (parameters
- '("GtkMovementStep" "step")
- '("gint" "count")
- '("gboolean" "extend_selection")
- )
-)
-
-(define-virtual insert_at_cursor
- (of-object "GtkEntry")
- (return-type "none")
- (parameters
- '("const-gchar*" "str")
- )
-)
-
-(define-virtual delete_from_cursor
- (of-object "GtkEntry")
- (return-type "none")
- (parameters
- '("GtkDeleteType" "type")
- '("gint" "count")
- )
-)
-
-(define-virtual backspace
- (of-object "GtkEntry")
- (return-type "none")
-)
-
-(define-virtual cut_clipboard
- (of-object "GtkEntry")
- (return-type "none")
-)
-
-(define-virtual copy_clipboard
- (of-object "GtkEntry")
- (return-type "none")
-)
-
-(define-virtual paste_clipboard
- (of-object "GtkEntry")
- (return-type "none")
-)
-
-(define-virtual toggle_overwrite
- (of-object "GtkEntry")
- (return-type "none")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkentrycompletion.h
-
-(define-function gtk_entry_completion_get_type
- (c-name "gtk_entry_completion_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_entry_completion_new
- (c-name "gtk_entry_completion_new")
- (is-constructor-of "GtkEntryCompletion")
- (return-type "GtkEntryCompletion*")
-)
-
-(define-method get_entry
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_get_entry")
- (return-type "GtkWidget*")
-)
-
-(define-method set_model
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_set_model")
- (return-type "none")
- (parameters
- '("GtkTreeModel*" "model" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_model
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_get_model")
- (return-type "GtkTreeModel*")
-)
-
-(define-method set_match_func
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_set_match_func")
- (return-type "none")
- (parameters
- '("GtkEntryCompletionMatchFunc" "func")
- '("gpointer" "func_data")
- '("GDestroyNotify" "func_notify")
- )
-)
-
-(define-method set_minimum_key_length
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_set_minimum_key_length")
- (return-type "none")
- (parameters
- '("gint" "length")
- )
-)
-
-(define-method get_minimum_key_length
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_get_minimum_key_length")
- (return-type "gint")
-)
-
-(define-method complete
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_complete")
- (return-type "none")
-)
-
-(define-method insert_action_text
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_insert_action_text")
- (return-type "none")
- (parameters
- '("gint" "index")
- '("const-gchar*" "text")
- )
-)
-
-(define-method insert_action_markup
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_insert_action_markup")
- (return-type "none")
- (parameters
- '("gint" "index")
- '("const-gchar*" "markup")
- )
-)
-
-(define-method delete_action
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_delete_action")
- (return-type "none")
- (parameters
- '("gint" "index")
- )
-)
-
-(define-method set_text_column
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_set_text_column")
- (return-type "none")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method get_text_column
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_get_text_column")
- (return-type "gint")
-)
-
-(define-method insert_prefix
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_insert_prefix")
- (return-type "none")
-)
-
-(define-method set_inline_completion
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_set_inline_completion")
- (return-type "none")
- (parameters
- '("gboolean" "inline_completion")
- )
-)
-
-(define-method get_inline_completion
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_get_inline_completion")
- (return-type "gboolean")
-)
-
-(define-method set_popup_completion
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_set_popup_completion")
- (return-type "none")
- (parameters
- '("gboolean" "popup_completion")
- )
-)
-
-(define-method get_popup_completion
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_get_popup_completion")
- (return-type "gboolean")
-)
-
-(define-method set_popup_set_width
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_set_popup_set_width")
- (return-type "none")
- (parameters
- '("gboolean" "popup_set_width")
- )
-)
-
-(define-method get_popup_set_width
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_get_popup_set_width")
- (return-type "gboolean")
-)
-
-(define-method set_popup_single_match
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_set_popup_single_match")
- (return-type "none")
- (parameters
- '("gboolean" "popup_single_match")
- )
-)
-
-(define-method get_popup_single_match
- (of-object "GtkEntryCompletion")
- (c-name "gtk_entry_completion_get_popup_single_match")
- (return-type "gboolean")
-)
-
-(define-virtual match_selected
- (of-object "GtkEntryCompletion")
- (return-type "gboolean")
- (parameters
- '("GtkTreeModel*" "model")
- '("GtkTreeIter*" "iter")
- )
-)
-(define-virtual action_activated
- (of-object "GtkEntryCompletion")
- (return-type "none")
- (parameters
- '("gint" "index_")
- )
-)
-(define-virtual insert_prefix
- (of-object "GtkEntryCompletion")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "prefix")
- )
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkenums.h
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkeventbox.h
-
-(define-function gtk_event_box_get_type
- (c-name "gtk_event_box_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_event_box_new
- (c-name "gtk_event_box_new")
- (is-constructor-of "GtkEventBox")
- (return-type "GtkWidget*")
-)
-
-(define-method get_visible_window
- (of-object "GtkEventBox")
- (c-name "gtk_event_box_get_visible_window")
- (return-type "gboolean")
-)
-
-(define-method set_visible_window
- (of-object "GtkEventBox")
- (c-name "gtk_event_box_set_visible_window")
- (return-type "none")
- (parameters
- '("gboolean" "visible_window")
- )
-)
-
-(define-method get_above_child
- (of-object "GtkEventBox")
- (c-name "gtk_event_box_get_above_child")
- (return-type "gboolean")
-)
-
-(define-method set_above_child
- (of-object "GtkEventBox")
- (c-name "gtk_event_box_set_above_child")
- (return-type "none")
- (parameters
- '("gboolean" "above_child")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkexpander.h
-
-(define-function gtk_expander_get_type
- (c-name "gtk_expander_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_expander_new
- (c-name "gtk_expander_new")
- (is-constructor-of "GtkExpander")
- (return-type "GtkWidget*")
- (properties
- '("label" (optional))
- )
-)
-
-(define-function expander_new_with_mnemonic
- (c-name "gtk_expander_new_with_mnemonic")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label" (null-ok) (default "NULL"))
- )
- (caller-owns-return #t)
-)
-
-(define-method set_expanded
- (of-object "GtkExpander")
- (c-name "gtk_expander_set_expanded")
- (return-type "none")
- (parameters
- '("gboolean" "expanded")
- )
-)
-
-(define-method get_expanded
- (of-object "GtkExpander")
- (c-name "gtk_expander_get_expanded")
- (return-type "gboolean")
-)
-
-(define-method set_spacing
- (of-object "GtkExpander")
- (c-name "gtk_expander_set_spacing")
- (return-type "none")
- (parameters
- '("gint" "spacing")
- )
-)
-
-(define-method get_spacing
- (of-object "GtkExpander")
- (c-name "gtk_expander_get_spacing")
- (return-type "gint")
-)
-
-(define-method set_label
- (of-object "GtkExpander")
- (c-name "gtk_expander_set_label")
- (return-type "none")
- (parameters
- '("const-gchar*" "label" (null-ok))
- )
-)
-
-(define-method get_label
- (of-object "GtkExpander")
- (c-name "gtk_expander_get_label")
- (return-type "const-gchar*")
-)
-
-(define-method set_use_underline
- (of-object "GtkExpander")
- (c-name "gtk_expander_set_use_underline")
- (return-type "none")
- (parameters
- '("gboolean" "use_underline")
- )
-)
-
-(define-method get_use_underline
- (of-object "GtkExpander")
- (c-name "gtk_expander_get_use_underline")
- (return-type "gboolean")
-)
-
-(define-method set_use_markup
- (of-object "GtkExpander")
- (c-name "gtk_expander_set_use_markup")
- (return-type "none")
- (parameters
- '("gboolean" "use_markup")
- )
-)
-
-(define-method get_use_markup
- (of-object "GtkExpander")
- (c-name "gtk_expander_get_use_markup")
- (return-type "gboolean")
-)
-
-(define-method set_label_widget
- (of-object "GtkExpander")
- (c-name "gtk_expander_set_label_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "label_widget" (null-ok))
- )
-)
-
-(define-method get_label_widget
- (of-object "GtkExpander")
- (c-name "gtk_expander_get_label_widget")
- (return-type "GtkWidget*")
-)
-
-(define-virtual activate
- (of-object "GtkExpander")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkfilechooser.h
-
-(define-function gtk_file_chooser_get_type
- (c-name "gtk_file_chooser_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_file_chooser_error_quark
- (c-name "gtk_file_chooser_error_quark")
- (return-type "GQuark")
-)
-
-(define-method set_action
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_action")
- (return-type "none")
- (parameters
- '("GtkFileChooserAction" "action")
- )
-)
-
-(define-method get_action
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_action")
- (return-type "GtkFileChooserAction")
-)
-
-(define-method set_local_only
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_local_only")
- (return-type "none")
- (parameters
- '("gboolean" "local_only")
- )
-)
-
-(define-method get_local_only
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_local_only")
- (return-type "gboolean")
-)
-
-(define-method set_select_multiple
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_select_multiple")
- (return-type "none")
- (parameters
- '("gboolean" "select_multiple")
- )
-)
-
-(define-method get_select_multiple
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_select_multiple")
- (return-type "gboolean")
-)
-
-(define-method set_show_hidden
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_show_hidden")
- (return-type "none")
- (parameters
- '("gboolean" "show_hidden")
- )
-)
-
-(define-method get_show_hidden
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_show_hidden")
- (return-type "gboolean")
-)
-
-(define-method set_do_overwrite_confirmation
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_do_overwrite_confirmation")
- (return-type "none")
- (parameters
- '("gboolean" "do_overwrite_confirmation")
- )
-)
-
-(define-method get_do_overwrite_confirmation
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_do_overwrite_confirmation")
- (return-type "gboolean")
-)
-
-(define-method set_current_name
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_current_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method get_filename
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_filename")
- (return-type "gchar*")
-)
-
-(define-method set_filename
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_filename")
- (return-type "gboolean")
- (parameters
- '("const-char*" "filename")
- )
-)
-
-(define-method select_filename
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_select_filename")
- (return-type "gboolean")
- (parameters
- '("const-char*" "filename")
- )
-)
-
-(define-method unselect_filename
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_unselect_filename")
- (return-type "none")
- (parameters
- '("const-char*" "filename")
- )
-)
-
-(define-method select_all
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_select_all")
- (return-type "none")
-)
-
-(define-method unselect_all
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_unselect_all")
- (return-type "none")
-)
-
-(define-method get_filenames
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_filenames")
- (return-type "GSList*")
-)
-
-(define-method set_current_folder
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_current_folder")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "filename")
- )
-)
-
-(define-method get_current_folder
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_current_folder")
- (return-type "gchar*")
-)
-
-(define-method get_uri
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_uri")
- (return-type "gchar*")
-)
-
-(define-method set_uri
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_uri")
- (return-type "gboolean")
- (parameters
- '("const-char*" "uri")
- )
-)
-
-(define-method select_uri
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_select_uri")
- (return-type "gboolean")
- (parameters
- '("const-char*" "uri")
- )
-)
-
-(define-method unselect_uri
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_unselect_uri")
- (return-type "none")
- (parameters
- '("const-char*" "uri")
- )
-)
-
-(define-method get_uris
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_uris")
- (return-type "GSList*")
-)
-
-(define-method set_current_folder_uri
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_current_folder_uri")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "uri")
- )
-)
-
-(define-method get_current_folder_uri
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_current_folder_uri")
- (return-type "gchar*")
-)
-
-(define-method set_preview_widget
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_preview_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "preview_widget")
- )
-)
-
-(define-method get_preview_widget
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_preview_widget")
- (return-type "GtkWidget*")
-)
-
-(define-method set_preview_widget_active
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_preview_widget_active")
- (return-type "none")
- (parameters
- '("gboolean" "active")
- )
-)
-
-(define-method get_preview_widget_active
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_preview_widget_active")
- (return-type "gboolean")
-)
-
-(define-method set_use_preview_label
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_use_preview_label")
- (return-type "none")
- (parameters
- '("gboolean" "use_label")
- )
-)
-
-(define-method get_use_preview_label
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_use_preview_label")
- (return-type "gboolean")
-)
-
-(define-method get_preview_filename
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_preview_filename")
- (return-type "char*")
-)
-
-(define-method get_preview_uri
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_preview_uri")
- (return-type "char*")
-)
-
-(define-method set_extra_widget
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_extra_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "extra_widget")
- )
-)
-
-(define-method get_extra_widget
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_extra_widget")
- (return-type "GtkWidget*")
-)
-
-(define-method add_filter
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_add_filter")
- (return-type "none")
- (parameters
- '("GtkFileFilter*" "filter")
- )
-)
-
-(define-method remove_filter
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_remove_filter")
- (return-type "none")
- (parameters
- '("GtkFileFilter*" "filter")
- )
-)
-
-(define-method list_filters
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_list_filters")
- (return-type "GSList*")
-)
-
-(define-method set_filter
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_set_filter")
- (return-type "none")
- (parameters
- '("GtkFileFilter*" "filter")
- )
-)
-
-(define-method get_filter
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_get_filter")
- (return-type "GtkFileFilter*")
-)
-
-(define-method add_shortcut_folder
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_add_shortcut_folder")
- (return-type "gboolean")
- (parameters
- '("const-char*" "folder")
- '("GError**" "error")
- )
-)
-
-(define-method remove_shortcut_folder
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_remove_shortcut_folder")
- (return-type "gboolean")
- (parameters
- '("const-char*" "folder")
- '("GError**" "error")
- )
-)
-
-(define-method list_shortcut_folders
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_list_shortcut_folders")
- (return-type "GSList*")
-)
-
-(define-method add_shortcut_folder_uri
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_add_shortcut_folder_uri")
- (return-type "gboolean")
- (parameters
- '("const-char*" "uri")
- '("GError**" "error")
- )
-)
-
-(define-method remove_shortcut_folder_uri
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_remove_shortcut_folder_uri")
- (return-type "gboolean")
- (parameters
- '("const-char*" "uri")
- '("GError**" "error")
- )
-)
-
-(define-method list_shortcut_folder_uris
- (of-object "GtkFileChooser")
- (c-name "gtk_file_chooser_list_shortcut_folder_uris")
- (return-type "GSList*")
-)
-
-
-
-;; From /opt/gnome-2.10/include/gtk-2.0/gtk/gtkfilechooserbutton.h
-
-(define-function gtk_file_chooser_button_get_type
- (c-name "gtk_file_chooser_button_get_type")
- (return-type "GType")
-)
-
-(define-function file_chooser_button_new
- (c-name "gtk_file_chooser_button_new")
- (is-constructor-of "GtkFileChooserButton")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "title")
- )
-)
-
-(define-function file_chooser_button_new_with_backend
- (c-name "gtk_file_chooser_button_new_with_backend")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "title")
- '("const-gchar*" "backend")
- )
- (caller-owns-return #t)
-)
-
-(define-function file_chooser_button_new_with_dialog
- (c-name "gtk_file_chooser_button_new_with_dialog")
- (return-type "GtkWidget*")
- (parameters
- '("GtkWidget*" "dialog")
- )
- (caller-owns-return #t)
-)
-
-(define-method get_title
- (of-object "GtkFileChooserButton")
- (c-name "gtk_file_chooser_button_get_title")
- (return-type "const-gchar*")
-)
-
-(define-method set_title
- (of-object "GtkFileChooserButton")
- (c-name "gtk_file_chooser_button_set_title")
- (return-type "none")
- (parameters
- '("const-gchar*" "title")
- )
-)
-
-(define-method get_width_chars
- (of-object "GtkFileChooserButton")
- (c-name "gtk_file_chooser_button_get_width_chars")
- (return-type "gint")
-)
-
-(define-method set_width_chars
- (of-object "GtkFileChooserButton")
- (c-name "gtk_file_chooser_button_set_width_chars")
- (return-type "none")
- (parameters
- '("gint" "n_chars")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkfilechooserdialog.h
-
-(define-function gtk_file_chooser_dialog_get_type
- (c-name "gtk_file_chooser_dialog_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_file_chooser_dialog_new
- (c-name "gtk_file_chooser_dialog_new")
- (is-constructor-of "GtkFileChooserDialog")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "title")
- '("GtkWindow*" "parent")
- '("GtkFileChooserAction" "action")
- '("const-gchar*" "first_button_text")
- )
- (varargs #t)
-)
-
-(define-function file_chooser_dialog_new_with_backend
- (c-name "gtk_file_chooser_dialog_new_with_backend")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "title")
- '("GtkWindow*" "parent")
- '("GtkFileChooserAction" "action")
- '("const-gchar*" "backend")
- '("const-gchar*" "first_button_text")
- )
- (varargs #t)
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkfilechooserwidget.h
-
-(define-function gtk_file_chooser_widget_get_type
- (c-name "gtk_file_chooser_widget_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_file_chooser_widget_new
- (c-name "gtk_file_chooser_widget_new")
- (is-constructor-of "GtkFileChooserWidget")
- (return-type "GtkWidget*")
- (parameters
- '("GtkFileChooserAction" "action")
- )
-)
-
-(define-function file_chooser_widget_new_with_backend
- (c-name "gtk_file_chooser_widget_new_with_backend")
- (return-type "GtkWidget*")
- (parameters
- '("GtkFileChooserAction" "action")
- '("const-gchar*" "backend")
- )
- (caller-owns-return #t)
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkfilefilter.h
-
-(define-function gtk_file_filter_get_type
- (c-name "gtk_file_filter_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_file_filter_new
- (c-name "gtk_file_filter_new")
- (is-constructor-of "GtkFileFilter")
- (return-type "GtkFileFilter*")
-)
-
-(define-method set_name
- (of-object "GtkFileFilter")
- (c-name "gtk_file_filter_set_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method get_name
- (of-object "GtkFileFilter")
- (c-name "gtk_file_filter_get_name")
- (return-type "const-gchar*")
-)
-
-(define-method add_mime_type
- (of-object "GtkFileFilter")
- (c-name "gtk_file_filter_add_mime_type")
- (return-type "none")
- (parameters
- '("const-gchar*" "mime_type")
- )
-)
-
-(define-method add_pattern
- (of-object "GtkFileFilter")
- (c-name "gtk_file_filter_add_pattern")
- (return-type "none")
- (parameters
- '("const-gchar*" "pattern")
- )
-)
-
-(define-method add_pixbuf_formats
- (of-object "GtkFileFilter")
- (c-name "gtk_file_filter_add_pixbuf_formats")
- (return-type "none")
-)
-
-(define-method add_custom
- (of-object "GtkFileFilter")
- (c-name "gtk_file_filter_add_custom")
- (return-type "none")
- (parameters
- '("GtkFileFilterFlags" "needed")
- '("GtkFileFilterFunc" "func")
- '("gpointer" "data")
- '("GDestroyNotify" "notify")
- )
-)
-
-(define-method get_needed
- (of-object "GtkFileFilter")
- (c-name "gtk_file_filter_get_needed")
- (return-type "GtkFileFilterFlags")
-)
-
-(define-method filter
- (of-object "GtkFileFilter")
- (c-name "gtk_file_filter_filter")
- (return-type "gboolean")
- (parameters
- '("const-GtkFileFilterInfo*" "filter_info")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkfilesel.h
-
-(define-function gtk_file_selection_get_type
- (c-name "gtk_file_selection_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_file_selection_new
- (c-name "gtk_file_selection_new")
- (is-constructor-of "GtkFileSelection")
- (return-type "GtkWidget*")
- (properties
- '("title" (optional))
- )
-)
-
-(define-method set_filename
- (of-object "GtkFileSelection")
- (c-name "gtk_file_selection_set_filename")
- (return-type "none")
- (parameters
- '("const-gchar*" "filename")
- )
-)
-
-(define-method get_filename
- (of-object "GtkFileSelection")
- (c-name "gtk_file_selection_get_filename")
- (return-type "const-gchar*")
-)
-
-(define-method complete
- (of-object "GtkFileSelection")
- (c-name "gtk_file_selection_complete")
- (return-type "none")
- (parameters
- '("const-gchar*" "pattern")
- )
-)
-
-(define-method show_fileop_buttons
- (of-object "GtkFileSelection")
- (c-name "gtk_file_selection_show_fileop_buttons")
- (return-type "none")
-)
-
-(define-method hide_fileop_buttons
- (of-object "GtkFileSelection")
- (c-name "gtk_file_selection_hide_fileop_buttons")
- (return-type "none")
-)
-
-(define-method get_selections
- (of-object "GtkFileSelection")
- (c-name "gtk_file_selection_get_selections")
- (return-type "gchar**")
-)
-
-(define-method set_select_multiple
- (of-object "GtkFileSelection")
- (c-name "gtk_file_selection_set_select_multiple")
- (return-type "none")
- (parameters
- '("gboolean" "select_multiple")
- )
-)
-
-(define-method get_select_multiple
- (of-object "GtkFileSelection")
- (c-name "gtk_file_selection_get_select_multiple")
- (return-type "gboolean")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkfilesystem.h
-
-(define-function file_system_error_quark
- (c-name "gtk_file_system_error_quark")
- (return-type "GQuark")
-)
-
-(define-function gtk_file_info_get_type
- (c-name "gtk_file_info_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_file_info_new
- (c-name "gtk_file_info_new")
- (is-constructor-of "GtkFileInfo")
- (return-type "GtkFileInfo*")
-)
-
-(define-method copy
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_copy")
- (return-type "GtkFileInfo*")
-)
-
-(define-method free
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_free")
- (return-type "none")
-)
-
-(define-method get_display_name
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_get_display_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_display_key
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_get_display_key")
- (return-type "const-gchar*")
-)
-
-(define-method set_display_name
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_set_display_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "display_name")
- )
-)
-
-(define-method get_is_folder
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_get_is_folder")
- (return-type "gboolean")
-)
-
-(define-method set_is_folder
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_set_is_folder")
- (return-type "none")
- (parameters
- '("gboolean" "is_folder")
- )
-)
-
-(define-method get_is_hidden
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_get_is_hidden")
- (return-type "gboolean")
-)
-
-(define-method set_is_hidden
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_set_is_hidden")
- (return-type "none")
- (parameters
- '("gboolean" "is_hidden")
- )
-)
-
-(define-method get_mime_type
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_get_mime_type")
- (return-type "const-gchar*")
-)
-
-(define-method set_mime_type
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_set_mime_type")
- (return-type "none")
- (parameters
- '("const-gchar*" "mime_type")
- )
-)
-
-(define-method get_modification_time
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_get_modification_time")
- (return-type "GtkFileTime")
-)
-
-(define-method set_modification_time
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_set_modification_time")
- (return-type "none")
- (parameters
- '("GtkFileTime" "modification_time")
- )
-)
-
-(define-method get_size
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_get_size")
- (return-type "gint64")
-)
-
-(define-method set_size
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_set_size")
- (return-type "none")
- (parameters
- '("gint64" "size")
- )
-)
-
-(define-function gtk_file_system_get_type
- (c-name "gtk_file_system_get_type")
- (return-type "GType")
-)
-
-(define-method list_volumes
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_list_volumes")
- (return-type "GSList*")
-)
-
-(define-method get_volume_for_path
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_get_volume_for_path")
- (return-type "GtkFileSystemVolume*")
- (parameters
- '("const-GtkFilePath*" "path")
- )
-)
-
-(define-method volume_free
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_volume_free")
- (return-type "none")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- )
-)
-
-(define-method volume_get_base_path
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_volume_get_base_path")
- (return-type "GtkFilePath*")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- )
-)
-
-(define-method volume_get_is_mounted
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_volume_get_is_mounted")
- (return-type "gboolean")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- )
-)
-
-(define-method volume_mount
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_volume_mount")
- (return-type "gboolean")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- '("GError**" "error")
- )
-)
-
-(define-method volume_get_display_name
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_volume_get_display_name")
- (return-type "char*")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- )
-)
-
-(define-method volume_render_icon
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_volume_render_icon")
- (return-type "GdkPixbuf*")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- '("GtkWidget*" "widget")
- '("gint" "pixel_size")
- '("GError**" "error")
- )
-)
-
-(define-method get_parent
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_get_parent")
- (return-type "gboolean")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GtkFilePath**" "parent")
- '("GError**" "error")
- )
-)
-
-(define-method get_folder
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_get_folder")
- (return-type "GtkFileFolder*")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GtkFileInfoType" "types")
- '("GError**" "error")
- )
-)
-
-(define-method create_folder
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_create_folder")
- (return-type "gboolean")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GError**" "error")
- )
-)
-
-(define-method make_path
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_make_path")
- (return-type "GtkFilePath*")
- (parameters
- '("const-GtkFilePath*" "base_path")
- '("const-gchar*" "display_name")
- '("GError**" "error")
- )
-)
-
-(define-method parse
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_parse")
- (return-type "gboolean")
- (parameters
- '("const-GtkFilePath*" "base_path")
- '("const-gchar*" "str")
- '("GtkFilePath**" "folder")
- '("gchar**" "file_part")
- '("GError**" "error")
- )
-)
-
-(define-method path_to_uri
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_path_to_uri")
- (return-type "gchar*")
- (parameters
- '("const-GtkFilePath*" "path")
- )
-)
-
-(define-method path_to_filename
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_path_to_filename")
- (return-type "gchar*")
- (parameters
- '("const-GtkFilePath*" "path")
- )
-)
-
-(define-method uri_to_path
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_uri_to_path")
- (return-type "GtkFilePath*")
- (parameters
- '("const-gchar*" "uri")
- )
-)
-
-(define-method filename_to_path
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_filename_to_path")
- (return-type "GtkFilePath*")
- (parameters
- '("const-gchar*" "filename")
- )
-)
-
-(define-method render_icon
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_render_icon")
- (return-type "GdkPixbuf*")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GtkWidget*" "widget")
- '("gint" "pixel_size")
- '("GError**" "error")
- )
-)
-
-(define-method insert_bookmark
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_insert_bookmark")
- (return-type "gboolean")
- (parameters
- '("const-GtkFilePath*" "path")
- '("gint" "position")
- '("GError**" "error")
- )
-)
-
-(define-method remove_bookmark
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_remove_bookmark")
- (return-type "gboolean")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GError**" "error")
- )
-)
-
-(define-method list_bookmarks
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_list_bookmarks")
- (return-type "GSList*")
-)
-
-(define-virtual list_volumes
- (of-object "GtkFileSystem")
- (return-type "GSList*")
-)
-
-(define-virtual get_volume_for_path
- (of-object "GtkFileSystem")
- (return-type "GtkFileSystemVolume*")
- (parameters
- '("const-GtkFilePath*" "path")
- )
-)
-
-(define-virtual get_folder
- (of-object "GtkFileSystem")
- (return-type "GtkFileSystemHandle*")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GtkFileInfoType" "types")
- '("GtkFileSystemGetFolderCallback" "callback")
- '("gpointer" "data")
- )
-)
-
-(define-virtual create_folder
- (of-object "GtkFileSystem")
- (return-type "gboolean")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GError**" "error")
- )
-)
-(define-virtual volume_free
- (of-object "GtkFileSystem")
- (return-type "none")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- )
-)
-(define-virtual volume_get_base_path
- (of-object "GtkFileSystem")
- (return-type "GtkFilePath*")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- )
-)
-
-(define-virtual volume_get_is_mounted
- (of-object "GtkFileSystem")
- (return-type "gboolean")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- )
-)
-(define-virtual volume_mount
- (of-object "GtkFileSystem")
- (return-type "gboolean")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- '("GError**" "error")
- )
-)
-(define-virtual volume_get_display_name
- (of-object "GtkFileSystem")
- (return-type "char*")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- )
-)
-
-(define-virtual volume_get_icon_name
- (of-object "GtkFileSystem")
- (return-type "gchar*")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- '("GError**" "error")
- )
-)
-
-(define-virtual get_parent
- (of-object "GtkFileSystem")
- (return-type "gboolean")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GtkFilePath**" "parent")
- '("GError**" "error")
- )
-)
-(define-virtual make_path
- (of-object "GtkFileSystem")
- (return-type "GtkFilePath*")
- (parameters
- '("const-GtkFilePath*" "base_path")
- '("const-gchar*" "display_name")
- '("GError**" "error")
- )
-)
-
-(define-virtual parse
- (of-object "GtkFileSystem")
- (return-type "gboolean")
- (parameters
- '("const-GtkFilePath*" "base_path")
- '("const-gchar*" "str")
- '("GtkFilePath**" "folder")
- '("gchar**" "file_part")
- '("GError**" "error")
- )
-)
-(define-virtual path_to_uri
- (of-object "GtkFileSystem")
- (return-type "gchar*")
- (parameters
- '("const-GtkFilePath*" "path")
- )
-)
-
-(define-virtual path_to_filename
- (of-object "GtkFileSystem")
- (return-type "gchar*")
- (parameters
- '("const-GtkFilePath*" "path")
- )
-)
-
-(define-virtual uri_to_path
- (of-object "GtkFileSystem")
- (return-type "GtkFilePath*")
- (parameters
- '("const-gchar*" "uri")
- )
-)
-
-(define-virtual filename_to_path
- (of-object "GtkFileSystem")
- (return-type "GtkFilePath*")
- (parameters
- '("const-gchar*" "path")
- )
-)
-
-(define-virtual insert_bookmark
- (of-object "GtkFileSystem")
- (return-type "gboolean")
- (parameters
- '("const-GtkFilePath*" "path")
- '("gint" "position")
- '("GError**" "error")
- )
-)
-(define-virtual remove_bookmark
- (of-object "GtkFileSystem")
- (return-type "gboolean")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GError**" "error")
- )
-)
-(define-virtual list_bookmarks
- (of-object "GtkFileSystem")
- (return-type "GSList*")
-)
-
-(define-virtual volumes_changed
- (of-object "GtkFileSystem")
- (return-type "none")
-)
-(define-virtual bookmarks_changed
- (of-object "GtkFileSystem")
- (return-type "none")
-)
-
-(define-virtual get_bookmark_label
- (of-object "GtkFileSystem")
- (return-type "gchar*")
- (parameters
- '("const-GtkFilePath*" "path")
- )
-)
-
-(define-virtual set_bookmark_label
- (of-object "GtkFileSystem")
- (return-type "none")
- (parameters
- '("const-GtkFilePath*" "path")
- '("const-gchar*" "label")
- )
-)
-
-
-(define-function gtk_file_folder_get_type
- (c-name "gtk_file_folder_get_type")
- (return-type "GType")
-)
-
-(define-method list_children
- (of-object "GtkFileFolder")
- (c-name "gtk_file_folder_list_children")
- (return-type "gboolean")
- (parameters
- '("GSList**" "children")
- '("GError**" "error")
- )
-)
-
-(define-method get_info
- (of-object "GtkFileFolder")
- (c-name "gtk_file_folder_get_info")
- (return-type "GtkFileInfo*")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GError**" "error")
- )
-)
-
-(define-function file_paths_sort
- (c-name "gtk_file_paths_sort")
- (return-type "GSList*")
- (parameters
- '("GSList*" "paths")
- )
-)
-
-(define-function file_paths_copy
- (c-name "gtk_file_paths_copy")
- (return-type "GSList*")
- (parameters
- '("GSList*" "paths")
- )
-)
-
-(define-function file_paths_free
- (c-name "gtk_file_paths_free")
- (return-type "none")
- (parameters
- '("GSList*" "paths")
- )
-)
-
-(define-virtual get_info
- (of-object "GtkFileFolder")
- (return-type "GtkFileInfo*")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GError**" "error")
- )
-)
-
-(define-virtual list_children
- (of-object "GtkFileFolder")
- (return-type "gboolean")
- (parameters
- '("GSList**" "children")
- '("GError**" "error")
- )
-)
-(define-virtual deleted
- (of-object "GtkFileFolder")
- (return-type "none")
-)
-(define-virtual files_added
- (of-object "GtkFileFolder")
- (return-type "none")
- (parameters
- '("GSList*" "paths")
- )
-)
-(define-virtual files_changed
- (of-object "GtkFileFolder")
- (return-type "none")
- (parameters
- '("GSList*" "paths")
- )
-)
-(define-virtual files_removed
- (of-object "GtkFileFolder")
- (return-type "none")
- (parameters
- '("GSList*" "paths")
- )
-)
-(define-virtual is_finished_loading
- (of-object "GtkFileFolder")
- (return-type "gboolean")
-)
-(define-virtual finished_loading
- (of-object "GtkFileFolder")
- (return-type "none")
-)
-
-(define-method set_icon_name
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_set_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "con_name")
- )
-)
-
-(define-method get_icon_name
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_get_icon_name")
- (return-type "const-gchar*")
-)
-
-(define-method render_icon
- (of-object "GtkFileInfo")
- (c-name "gtk_file_info_render_icon")
- (return-type "GdkPixbuf*")
- (parameters
- '("GtkWidget*" "widget")
- '("gint" "pixel_size")
- '("GError**" "error")
- )
-)
-
-(define-function file_system_handle_get_type
- (c-name "gtk_file_system_handle_get_type")
- (return-type "GType")
-)
-
-(define-method volume_get_icon_name
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_volume_get_icon_name")
- (return-type "gchar*")
- (parameters
- '("GtkFileSystemVolume*" "volume")
- '("GError**" "error")
- )
-)
-
-(define-method get_info
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_get_info")
- (return-type "GtkFileSystemHandle*")
- (parameters
- '("const-GtkFilePath*" "path")
- '("GtkFileInfoType" "types")
- '("GtkFileSystemGetInfoCallback" "callback")
- '("gpointer" "data")
- )
-)
-
-(define-function file_system_cancel_operation
- (c-name "gtk_file_system_cancel_operation")
- (return-type "none")
- (parameters
- '("GtkFileSystemHandle*" "handle")
- )
-)
-
-(define-method path_is_local
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_path_is_local")
- (return-type "gboolean")
- (parameters
- '("const-GtkFilePath*" "path")
- )
-)
-
-(define-method get_bookmark_label
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_get_bookmark_label")
- (return-type "gchar*")
- (parameters
- '("const-GtkFilePath*" "path")
- )
-)
-
-(define-method set_bookmark_label
- (of-object "GtkFileSystem")
- (c-name "gtk_file_system_set_bookmark_label")
- (return-type "none")
- (parameters
- '("const-GtkFilePath*" "path")
- '("const-gchar*" "label")
- )
-)
-
-(define-method is_finished_loading
- (of-object "GtkFileFolder")
- (c-name "gtk_file_folder_is_finished_loading")
- (return-type "gboolean")
-)
-
-(define-function file_path_get_type
- (c-name "gtk_file_path_get_type")
- (return-type "GType")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkfixed.h
-
-(define-function gtk_fixed_get_type
- (c-name "gtk_fixed_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_fixed_new
- (c-name "gtk_fixed_new")
- (is-constructor-of "GtkFixed")
- (return-type "GtkWidget*")
-)
-
-(define-method put
- (of-object "GtkFixed")
- (c-name "gtk_fixed_put")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method move
- (of-object "GtkFixed")
- (c-name "gtk_fixed_move")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method set_has_window
- (of-object "GtkFixed")
- (c-name "gtk_fixed_set_has_window")
- (return-type "none")
- (parameters
- '("gboolean" "has_window")
- )
-)
-
-(define-method get_has_window
- (of-object "GtkFixed")
- (c-name "gtk_fixed_get_has_window")
- (return-type "gboolean")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkfontbutton.h
-
-(define-function gtk_font_button_get_type
- (c-name "gtk_font_button_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_font_button_new
- (c-name "gtk_font_button_new")
- (is-constructor-of "GtkFontButton")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_font_button_new_with_font
- (c-name "gtk_font_button_new_with_font")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "fontname")
- )
- (caller-owns-return #t)
-)
-
-(define-method get_title
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_get_title")
- (return-type "const-gchar*")
-)
-
-(define-method set_title
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_set_title")
- (return-type "none")
- (parameters
- '("const-gchar*" "title")
- )
-)
-
-(define-method get_use_font
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_get_use_font")
- (return-type "gboolean")
-)
-
-(define-method set_use_font
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_set_use_font")
- (return-type "none")
- (parameters
- '("gboolean" "use_font")
- )
-)
-
-(define-method get_use_size
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_get_use_size")
- (return-type "gboolean")
-)
-
-(define-method set_use_size
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_set_use_size")
- (return-type "none")
- (parameters
- '("gboolean" "use_size")
- )
-)
-
-(define-method get_font_name
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_get_font_name")
- (return-type "const-gchar*")
-)
-
-(define-method set_font_name
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_set_font_name")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "fontname")
- )
-)
-
-(define-method get_show_style
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_get_show_style")
- (return-type "gboolean")
-)
-
-(define-method set_show_style
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_set_show_style")
- (return-type "none")
- (parameters
- '("gboolean" "show_style")
- )
-)
-
-(define-method get_show_size
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_get_show_size")
- (return-type "gboolean")
-)
-
-(define-method set_show_size
- (of-object "GtkFontButton")
- (c-name "gtk_font_button_set_show_size")
- (return-type "none")
- (parameters
- '("gboolean" "show_size")
- )
-)
-
-(define-virtual font_set
- (of-object "GtkFontButton")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkfontsel.h
-
-(define-function gtk_font_selection_get_type
- (c-name "gtk_font_selection_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_font_selection_new
- (c-name "gtk_font_selection_new")
- (is-constructor-of "GtkFontSelection")
- (return-type "GtkWidget*")
-)
-
-(define-method get_font_name
- (of-object "GtkFontSelection")
- (c-name "gtk_font_selection_get_font_name")
- (return-type "gchar*")
-)
-
-(define-method get_font
- (of-object "GtkFontSelection")
- (c-name "gtk_font_selection_get_font")
- (return-type "GdkFont*")
- (deprecated "use GtkFontSelection.get_font_name")
-)
-
-(define-method set_font_name
- (of-object "GtkFontSelection")
- (c-name "gtk_font_selection_set_font_name")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "fontname")
- )
-)
-
-(define-method get_preview_text
- (of-object "GtkFontSelection")
- (c-name "gtk_font_selection_get_preview_text")
- (return-type "const-gchar*")
-)
-
-(define-method set_preview_text
- (of-object "GtkFontSelection")
- (c-name "gtk_font_selection_set_preview_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- )
-)
-
-(define-function gtk_font_selection_dialog_get_type
- (c-name "gtk_font_selection_dialog_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_font_selection_dialog_new
- (c-name "gtk_font_selection_dialog_new")
- (is-constructor-of "GtkFontSelectionDialog")
- (return-type "GtkWidget*")
- (properties
- '("title")
- )
-)
-
-(define-method get_font_name
- (of-object "GtkFontSelectionDialog")
- (c-name "gtk_font_selection_dialog_get_font_name")
- (return-type "gchar*")
-)
-
-(define-method get_font
- (of-object "GtkFontSelectionDialog")
- (c-name "gtk_font_selection_dialog_get_font")
- (return-type "GdkFont*")
- (deprecated "use GtkFontSelectionDialog.get_font_name")
-)
-
-(define-method set_font_name
- (of-object "GtkFontSelectionDialog")
- (c-name "gtk_font_selection_dialog_set_font_name")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "fontname")
- )
-)
-
-(define-method get_preview_text
- (of-object "GtkFontSelectionDialog")
- (c-name "gtk_font_selection_dialog_get_preview_text")
- (return-type "const-gchar*")
-)
-
-(define-method set_preview_text
- (of-object "GtkFontSelectionDialog")
- (c-name "gtk_font_selection_dialog_set_preview_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkframe.h
-
-(define-function gtk_frame_get_type
- (c-name "gtk_frame_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_frame_new
- (c-name "gtk_frame_new")
- (is-constructor-of "GtkFrame")
- (return-type "GtkWidget*")
- (properties
- '("label" (optional))
- )
-)
-
-(define-method set_label
- (of-object "GtkFrame")
- (c-name "gtk_frame_set_label")
- (return-type "none")
- (parameters
- '("const-gchar*" "label" (null-ok))
- )
-)
-
-(define-method get_label
- (of-object "GtkFrame")
- (c-name "gtk_frame_get_label")
- (return-type "const-gchar*")
-)
-
-(define-method set_label_widget
- (of-object "GtkFrame")
- (c-name "gtk_frame_set_label_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "label_widget")
- )
-)
-
-(define-method get_label_widget
- (of-object "GtkFrame")
- (c-name "gtk_frame_get_label_widget")
- (return-type "GtkWidget*")
-)
-
-(define-method set_label_align
- (of-object "GtkFrame")
- (c-name "gtk_frame_set_label_align")
- (return-type "none")
- (parameters
- '("gfloat" "xalign")
- '("gfloat" "yalign")
- )
-)
-
-(define-method get_label_align
- (of-object "GtkFrame")
- (c-name "gtk_frame_get_label_align")
- (return-type "none")
- (parameters
- '("gfloat*" "xalign")
- '("gfloat*" "yalign")
- )
-)
-
-(define-method set_shadow_type
- (of-object "GtkFrame")
- (c-name "gtk_frame_set_shadow_type")
- (return-type "none")
- (parameters
- '("GtkShadowType" "type")
- )
-)
-
-(define-method get_shadow_type
- (of-object "GtkFrame")
- (c-name "gtk_frame_get_shadow_type")
- (return-type "GtkShadowType")
-)
-
-(define-virtual compute_child_allocation
- (of-object "GtkFrame")
- (return-type "none")
- (parameters
- '("GtkAllocation*" "allocation")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkgamma.h
-
-(define-function gtk_gamma_curve_get_type
- (c-name "gtk_gamma_curve_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_gamma_curve_new
- (c-name "gtk_gamma_curve_new")
- (is-constructor-of "GtkGammaCurve")
- (return-type "GtkWidget*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkgc.h
-
-(define-function gc_get
- (c-name "gtk_gc_get")
- (return-type "GdkGC*")
- (parameters
- '("gint" "depth")
- '("GdkColormap*" "colormap")
- '("GdkGCValues*" "values")
- '("GdkGCValuesMask" "values_mask")
- )
-)
-
-(define-function gc_release
- (c-name "gtk_gc_release")
- (return-type "none")
- (parameters
- '("GdkGC*" "gc")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkhandlebox.h
-
-(define-function gtk_handle_box_get_type
- (c-name "gtk_handle_box_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_handle_box_new
- (c-name "gtk_handle_box_new")
- (is-constructor-of "GtkHandleBox")
- (return-type "GtkWidget*")
-)
-
-(define-method set_shadow_type
- (of-object "GtkHandleBox")
- (c-name "gtk_handle_box_set_shadow_type")
- (return-type "none")
- (parameters
- '("GtkShadowType" "type")
- )
-)
-
-(define-method get_shadow_type
- (of-object "GtkHandleBox")
- (c-name "gtk_handle_box_get_shadow_type")
- (return-type "GtkShadowType")
-)
-
-(define-method set_handle_position
- (of-object "GtkHandleBox")
- (c-name "gtk_handle_box_set_handle_position")
- (return-type "none")
- (parameters
- '("GtkPositionType" "position")
- )
-)
-
-(define-method get_handle_position
- (of-object "GtkHandleBox")
- (c-name "gtk_handle_box_get_handle_position")
- (return-type "GtkPositionType")
-)
-
-(define-method set_snap_edge
- (of-object "GtkHandleBox")
- (c-name "gtk_handle_box_set_snap_edge")
- (return-type "none")
- (parameters
- '("GtkPositionType" "edge")
- )
-)
-
-(define-method get_snap_edge
- (of-object "GtkHandleBox")
- (c-name "gtk_handle_box_get_snap_edge")
- (return-type "GtkPositionType")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkhbbox.h
-
-(define-function gtk_hbutton_box_get_type
- (c-name "gtk_hbutton_box_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_hbutton_box_new
- (c-name "gtk_hbutton_box_new")
- (is-constructor-of "GtkHButtonBox")
- (return-type "GtkWidget*")
-)
-
-(define-function hbutton_box_get_spacing_default
- (c-name "gtk_hbutton_box_get_spacing_default")
- (return-type "gint")
- (deprecated "")
-)
-
-(define-function hbutton_box_get_layout_default
- (c-name "gtk_hbutton_box_get_layout_default")
- (return-type "GtkButtonBoxStyle")
- (deprecated "")
-)
-
-(define-function hbutton_box_set_spacing_default
- (c-name "gtk_hbutton_box_set_spacing_default")
- (return-type "none")
- (parameters
- '("gint" "spacing")
- )
- (deprecated "")
-)
-
-(define-function hbutton_box_set_layout_default
- (c-name "gtk_hbutton_box_set_layout_default")
- (return-type "none")
- (parameters
- '("GtkButtonBoxStyle" "layout")
- )
- (deprecated "")
-)
-
-(define-virtual child_attached
- (of-object "GtkHandleBox")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-(define-virtual child_detached
- (of-object "GtkHandleBox")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkhbox.h
-
-(define-function gtk_hbox_get_type
- (c-name "gtk_hbox_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_hbox_new
- (c-name "gtk_hbox_new")
- (is-constructor-of "GtkHBox")
- (return-type "GtkWidget*")
- (properties
- '("homogeneous" (optional))
- '("spacing" (optional))
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkhpaned.h
-
-(define-function gtk_hpaned_get_type
- (c-name "gtk_hpaned_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_hpaned_new
- (c-name "gtk_hpaned_new")
- (is-constructor-of "GtkHPaned")
- (return-type "GtkWidget*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkhruler.h
-
-(define-function gtk_hruler_get_type
- (c-name "gtk_hruler_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_hruler_new
- (c-name "gtk_hruler_new")
- (is-constructor-of "GtkHRuler")
- (return-type "GtkWidget*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkhscale.h
-
-(define-function gtk_hscale_get_type
- (c-name "gtk_hscale_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_hscale_new
- (c-name "gtk_hscale_new")
- (is-constructor-of "GtkHScale")
- (return-type "GtkWidget*")
- (properties
- '("adjustment" (optional))
- )
-)
-
-(define-function gtk_hscale_new_with_range
- (c-name "gtk_hscale_new_with_range")
- (is-constructor-of "GtkHScale")
- (return-type "GtkWidget*")
- (parameters
- '("gdouble" "min")
- '("gdouble" "max")
- '("gdouble" "step")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkhscrollbar.h
-
-(define-function gtk_hscrollbar_get_type
- (c-name "gtk_hscrollbar_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_hscrollbar_new
- (c-name "gtk_hscrollbar_new")
- (is-constructor-of "GtkHScrollbar")
- (return-type "GtkWidget*")
- (properties
- '("adjustment" (optional))
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkhseparator.h
-
-(define-function gtk_hseparator_get_type
- (c-name "gtk_hseparator_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_hseparator_new
- (c-name "gtk_hseparator_new")
- (is-constructor-of "GtkHSeparator")
- (return-type "GtkWidget*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkiconfactory.h
-
-(define-function gtk_icon_factory_get_type
- (c-name "gtk_icon_factory_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_icon_factory_new
- (c-name "gtk_icon_factory_new")
- (is-constructor-of "GtkIconFactory")
- (return-type "GtkIconFactory*")
-)
-
-(define-method add
- (of-object "GtkIconFactory")
- (c-name "gtk_icon_factory_add")
- (return-type "none")
- (parameters
- '("const-gchar*" "stock_id")
- '("GtkIconSet*" "icon_set")
- )
-)
-
-(define-method lookup
- (of-object "GtkIconFactory")
- (c-name "gtk_icon_factory_lookup")
- (return-type "GtkIconSet*")
- (parameters
- '("const-gchar*" "stock_id")
- )
-)
-
-(define-method add_default
- (of-object "GtkIconFactory")
- (c-name "gtk_icon_factory_add_default")
- (return-type "none")
-)
-
-(define-method remove_default
- (of-object "GtkIconFactory")
- (c-name "gtk_icon_factory_remove_default")
- (return-type "none")
-)
-
-(define-function icon_factory_lookup_default
- (c-name "gtk_icon_factory_lookup_default")
- (return-type "GtkIconSet*")
- (parameters
- '("const-gchar*" "stock_id")
- )
-)
-
-(define-function icon_size_lookup
- (c-name "gtk_icon_size_lookup")
- (return-type "gboolean")
- (parameters
- '("GtkIconSize" "size")
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-function icon_size_lookup_for_settings
- (c-name "gtk_icon_size_lookup_for_settings")
- (return-type "gboolean")
- (parameters
- '("GtkSettings*" "settings")
- '("GtkIconSize" "size")
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-function icon_size_register
- (c-name "gtk_icon_size_register")
- (return-type "GtkIconSize")
- (parameters
- '("const-gchar*" "name")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-function icon_size_register_alias
- (c-name "gtk_icon_size_register_alias")
- (return-type "none")
- (parameters
- '("const-gchar*" "alias")
- '("GtkIconSize" "target")
- )
-)
-
-(define-function icon_size_from_name
- (c-name "gtk_icon_size_from_name")
- (return-type "GtkIconSize")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-function icon_size_get_name
- (c-name "gtk_icon_size_get_name")
- (return-type "const-gchar*")
- (parameters
- '("GtkIconSize" "size")
- )
-)
-
-(define-function icon_set_get_type
- (c-name "gtk_icon_set_get_type")
- (return-type "GType")
-)
-
-(define-function icon_set_new
- (c-name "gtk_icon_set_new")
- (return-type "GtkIconSet*")
- (caller-owns-return #t)
-)
-
-(define-function icon_set_new_from_pixbuf
- (c-name "gtk_icon_set_new_from_pixbuf")
- (return-type "GtkIconSet*")
- (is-constructor-of "GtkIconSet")
- (parameters
- '("GdkPixbuf*" "pixbuf")
- )
-)
-
-(define-method ref
- (of-object "GtkIconSet")
- (c-name "gtk_icon_set_ref")
- (return-type "GtkIconSet*")
-)
-
-(define-method unref
- (of-object "GtkIconSet")
- (c-name "gtk_icon_set_unref")
- (return-type "none")
-)
-
-(define-method copy
- (of-object "GtkIconSet")
- (c-name "gtk_icon_set_copy")
- (return-type "GtkIconSet*")
- (caller-owns-return #t)
-)
-
-(define-method render_icon
- (of-object "GtkIconSet")
- (c-name "gtk_icon_set_render_icon")
- (return-type "GdkPixbuf*")
- (parameters
- '("GtkStyle*" "style")
- '("GtkTextDirection" "direction")
- '("GtkStateType" "state")
- '("GtkIconSize" "size")
- '("GtkWidget*" "widget" (null-ok) (default "NULL"))
- '("const-char*" "detail" (null-ok) (default "NULL"))
- )
-)
-
-(define-method add_source
- (of-object "GtkIconSet")
- (c-name "gtk_icon_set_add_source")
- (return-type "none")
- (parameters
- '("const-GtkIconSource*" "source")
- )
-)
-
-(define-method get_sizes
- (of-object "GtkIconSet")
- (c-name "gtk_icon_set_get_sizes")
- (return-type "none")
- (parameters
- '("GtkIconSize**" "sizes")
- '("gint*" "n_sizes")
- )
-)
-
-(define-function gtk_icon_source_get_type
- (c-name "gtk_icon_source_get_type")
- (return-type "GType")
-)
-
-(define-function icon_source_new
- (c-name "gtk_icon_source_new")
- (is-constructor-of "GtkIconSource")
- (return-type "GtkIconSource*")
-)
-
-(define-method copy
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_copy")
- (return-type "GtkIconSource*")
- (caller-owns-return #t)
-)
-
-(define-method free
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_free")
- (return-type "none")
-)
-
-(define-method set_filename
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_set_filename")
- (return-type "none")
- (parameters
- '("const-gchar*" "filename")
- )
-)
-
-(define-method set_icon_name
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_set_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "icon_name" (null-ok))
- )
-)
-
-(define-method set_pixbuf
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_set_pixbuf")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "pixbuf")
- )
-)
-
-(define-method get_filename
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_get_filename")
- (return-type "const-gchar*")
-)
-
-(define-method get_icon_name
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_get_icon_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_pixbuf
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_get_pixbuf")
- (return-type "GdkPixbuf*")
-)
-
-(define-method set_direction_wildcarded
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_set_direction_wildcarded")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method set_state_wildcarded
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_set_state_wildcarded")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method set_size_wildcarded
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_set_size_wildcarded")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_size_wildcarded
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_get_size_wildcarded")
- (return-type "gboolean")
-)
-
-(define-method get_state_wildcarded
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_get_state_wildcarded")
- (return-type "gboolean")
-)
-
-(define-method get_direction_wildcarded
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_get_direction_wildcarded")
- (return-type "gboolean")
-)
-
-(define-method set_direction
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_set_direction")
- (return-type "none")
- (parameters
- '("GtkTextDirection" "direction")
- )
-)
-
-(define-method set_state
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_set_state")
- (return-type "none")
- (parameters
- '("GtkStateType" "state")
- )
-)
-
-(define-method set_size
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_set_size")
- (return-type "none")
- (parameters
- '("GtkIconSize" "size")
- )
-)
-
-(define-method get_direction
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_get_direction")
- (return-type "GtkTextDirection")
-)
-
-(define-method get_state
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_get_state")
- (return-type "GtkStateType")
-)
-
-(define-method get_size
- (of-object "GtkIconSource")
- (c-name "gtk_icon_source_get_size")
- (return-type "GtkIconSize")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkicontheme.h
-
-(define-function icon_theme_error_quark
- (c-name "gtk_icon_theme_error_quark")
- (return-type "GQuark")
-)
-
-(define-function gtk_icon_theme_get_type
- (c-name "gtk_icon_theme_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_icon_theme_new
- (c-name "gtk_icon_theme_new")
- (is-constructor-of "GtkIconTheme")
- (return-type "GtkIconTheme*")
-)
-
-(define-function icon_theme_get_default
- (c-name "gtk_icon_theme_get_default")
- (return-type "GtkIconTheme*")
-)
-
-(define-function icon_theme_get_for_screen
- (c-name "gtk_icon_theme_get_for_screen")
- (return-type "GtkIconTheme*")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-method set_screen
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_set_screen")
- (return-type "none")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-method set_search_path
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_set_search_path")
- (return-type "none")
- (parameters
- '("const-gchar*[]" "path")
- '("gint" "n_elements")
- )
-)
-
-(define-method get_search_path
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_get_search_path")
- (return-type "none")
- (parameters
- '("gchar**[]" "path")
- '("gint*" "n_elements")
- )
-)
-
-(define-method append_search_path
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_append_search_path")
- (return-type "none")
- (parameters
- '("const-gchar*" "path")
- )
-)
-
-(define-method prepend_search_path
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_prepend_search_path")
- (return-type "none")
- (parameters
- '("const-gchar*" "path")
- )
-)
-
-(define-method set_custom_theme
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_set_custom_theme")
- (return-type "none")
- (parameters
- '("const-gchar*" "theme_name")
- )
-)
-
-(define-method has_icon
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_has_icon")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "icon_name")
- )
-)
-
-(define-method lookup_icon
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_lookup_icon")
- (return-type "GtkIconInfo*")
- (parameters
- '("const-gchar*" "icon_name")
- '("gint" "size")
- '("GtkIconLookupFlags" "flags")
- )
- (caller-owns-return #t)
-)
-
-(define-method load_icon
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_load_icon")
- (return-type "GdkPixbuf*")
- (parameters
- '("const-gchar*" "icon_name")
- '("gint" "size")
- '("GtkIconLookupFlags" "flags")
- '("GError**" "error")
- )
- (caller-owns-return #t)
-)
-
-(define-method list_icons
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_list_icons")
- (return-type "GList*")
- (parameters
- '("const-gchar*" "context")
- )
-)
-
-(define-method get_example_icon_name
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_get_example_icon_name")
- (return-type "char*")
-)
-
-(define-method rescan_if_needed
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_rescan_if_needed")
- (return-type "gboolean")
-)
-
-(define-function icon_theme_add_builtin_icon
- (c-name "gtk_icon_theme_add_builtin_icon")
- (return-type "none")
- (parameters
- '("const-gchar*" "icon_name")
- '("gint" "size")
- '("GdkPixbuf*" "pixbuf")
- )
-)
-
-(define-function gtk_icon_info_get_type
- (c-name "gtk_icon_info_get_type")
- (return-type "GType")
-)
-
-(define-method copy
- (of-object "GtkIconInfo")
- (c-name "gtk_icon_info_copy")
- (return-type "GtkIconInfo*")
- (caller-owns-return #t)
-)
-
-(define-method free
- (of-object "GtkIconInfo")
- (c-name "gtk_icon_info_free")
- (return-type "none")
-)
-
-(define-method get_base_size
- (of-object "GtkIconInfo")
- (c-name "gtk_icon_info_get_base_size")
- (return-type "gint")
-)
-
-(define-method get_filename
- (of-object "GtkIconInfo")
- (c-name "gtk_icon_info_get_filename")
- (return-type "const-gchar*")
-)
-
-(define-method get_builtin_pixbuf
- (of-object "GtkIconInfo")
- (c-name "gtk_icon_info_get_builtin_pixbuf")
- (return-type "GdkPixbuf*")
-)
-
-(define-method load_icon
- (of-object "GtkIconInfo")
- (c-name "gtk_icon_info_load_icon")
- (return-type "GdkPixbuf*")
- (parameters
- '("GError**" "error")
- )
-)
-
-(define-method set_raw_coordinates
- (of-object "GtkIconInfo")
- (c-name "gtk_icon_info_set_raw_coordinates")
- (return-type "none")
- (parameters
- '("gboolean" "raw_coordinates")
- )
-)
-
-(define-method get_embedded_rect
- (of-object "GtkIconInfo")
- (c-name "gtk_icon_info_get_embedded_rect")
- (return-type "gboolean")
- (parameters
- '("GdkRectangle*" "rectangle")
- )
-)
-
-(define-method get_attach_points
- (of-object "GtkIconInfo")
- (c-name "gtk_icon_info_get_attach_points")
- (return-type "gboolean")
- (parameters
- '("GdkPoint**" "points")
- '("gint*" "n_points")
- )
-)
-
-(define-method get_display_name
- (of-object "GtkIconInfo")
- (c-name "gtk_icon_info_get_display_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_icon_sizes
- (of-object "GtkIconTheme")
- (c-name "gtk_icon_theme_get_icon_sizes")
- (return-type "gint*")
- (parameters
- '("const-gchar*" "icon_name")
- )
-)
-
-(define-virtual changed
- (of-object "GtkIconTheme")
- (return-type "none")
-)
-
-;; From /opt/gnome-2.10/include/gtk-2.0/gtk/gtkiconview.h
-
-(define-function gtk_icon_view_get_type
- (c-name "gtk_icon_view_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_icon_view_new
- (c-name "gtk_icon_view_new")
- (is-constructor-of "GtkIconView")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_icon_view_new_with_model
- (c-name "gtk_icon_view_new_with_model")
- (return-type "GtkWidget*")
- (parameters
- '("GtkTreeModel*" "model")
- )
- (caller-owns-return #t)
-)
-
-(define-method set_model
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_model")
- (return-type "none")
- (parameters
- '("GtkTreeModel*" "model" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_model
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_model")
- (return-type "GtkTreeModel*")
-)
-
-(define-method set_text_column
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_text_column")
- (return-type "none")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method get_text_column
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_text_column")
- (return-type "gint")
-)
-
-(define-method set_markup_column
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_markup_column")
- (return-type "none")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method get_markup_column
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_markup_column")
- (return-type "gint")
-)
-
-(define-method set_pixbuf_column
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_pixbuf_column")
- (return-type "none")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method get_pixbuf_column
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_pixbuf_column")
- (return-type "gint")
-)
-
-(define-method set_orientation
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_orientation")
- (return-type "none")
- (parameters
- '("GtkOrientation" "orientation")
- )
-)
-
-(define-method get_orientation
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_orientation")
- (return-type "GtkOrientation")
-)
-
-(define-method set_columns
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_columns")
- (return-type "none")
- (parameters
- '("gint" "columns")
- )
-)
-
-(define-method get_columns
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_columns")
- (return-type "gint")
-)
-
-(define-method set_item_width
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_item_width")
- (return-type "none")
- (parameters
- '("gint" "item_width")
- )
-)
-
-(define-method get_item_width
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_item_width")
- (return-type "gint")
-)
-
-(define-method set_spacing
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_spacing")
- (return-type "none")
- (parameters
- '("gint" "spacing")
- )
-)
-
-(define-method get_spacing
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_spacing")
- (return-type "gint")
-)
-
-(define-method set_row_spacing
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_row_spacing")
- (return-type "none")
- (parameters
- '("gint" "row_spacing")
- )
-)
-
-(define-method get_row_spacing
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_row_spacing")
- (return-type "gint")
-)
-
-(define-method set_column_spacing
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_column_spacing")
- (return-type "none")
- (parameters
- '("gint" "column_spacing")
- )
-)
-
-(define-method get_column_spacing
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_column_spacing")
- (return-type "gint")
-)
-
-(define-method set_margin
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_margin")
- (return-type "none")
- (parameters
- '("gint" "margin")
- )
-)
-
-(define-method get_margin
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_margin")
- (return-type "gint")
-)
-
-(define-method get_path_at_pos
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_path_at_pos")
- (return-type "GtkTreePath*")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method get_item_at_pos
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_item_at_pos")
- (return-type "gboolean")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("GtkTreePath**" "path")
- '("GtkCellRenderer**" "cell")
- )
-)
-
-(define-method get_visible_range
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_visible_range")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath**" "start_path")
- '("GtkTreePath**" "end_path")
- )
-)
-
-(define-method selected_foreach
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_selected_foreach")
- (return-type "none")
- (parameters
- '("GtkIconViewForeachFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method set_selection_mode
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_selection_mode")
- (return-type "none")
- (parameters
- '("GtkSelectionMode" "mode")
- )
-)
-
-(define-method get_selection_mode
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_selection_mode")
- (return-type "GtkSelectionMode")
-)
-
-(define-method select_path
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_select_path")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method unselect_path
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_unselect_path")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method path_is_selected
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_path_is_selected")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method get_selected_items
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_selected_items")
- (return-type "GList*")
-)
-
-(define-method select_all
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_select_all")
- (return-type "none")
-)
-
-(define-method unselect_all
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_unselect_all")
- (return-type "none")
-)
-
-(define-method item_activated
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_item_activated")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-virtual set_scroll_adjustments
- (of-object "GtkIconView")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "hadjustment")
- '("GtkAdjustment*" "vadjustment")
- )
-)
-(define-virtual item_activated
- (of-object "GtkIconView")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-(define-virtual selection_changed
- (of-object "GtkIconView")
- (return-type "none")
-)
-(define-virtual select_all
- (of-object "GtkIconView")
- (return-type "none")
-)
-(define-virtual unselect_all
- (of-object "GtkIconView")
- (return-type "none")
-)
-(define-virtual select_cursor_item
- (of-object "GtkIconView")
- (return-type "none")
-)
-(define-virtual toggle_cursor_item
- (of-object "GtkIconView")
- (return-type "none")
-)
-(define-virtual move_cursor
- (of-object "GtkIconView")
- (return-type "gboolean")
- (parameters
- '("GtkMovementStep" "step")
- '("gint" "count")
- )
-)
-(define-virtual activate_cursor_item
- (of-object "GtkIconView")
- (return-type "gboolean")
-)
-
-(define-method set_cursor
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_cursor")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkCellRenderer*" "cell" (null-ok) (default "NULL"))
- '("gboolean" "start_editing" (default "FALSE"))
- )
-)
-
-(define-method get_cursor
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_cursor")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath**" "path")
- '("GtkCellRenderer**" "cell")
- )
-)
-
-(define-method scroll_to_path
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_scroll_to_path")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("gboolean" "use_align")
- '("gfloat" "row_align")
- '("gfloat" "col_align")
- )
-)
-
-(define-method enable_model_drag_source
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_enable_model_drag_source")
- (return-type "none")
- (parameters
- '("GdkModifierType" "start_button_mask")
- '("const-GtkTargetEntry*" "targets")
- '("gint" "n_targets")
- '("GdkDragAction" "actions")
- )
-)
-
-(define-method enable_model_drag_dest
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_enable_model_drag_dest")
- (return-type "none")
- (parameters
- '("const-GtkTargetEntry*" "targets")
- '("gint" "n_targets")
- '("GdkDragAction" "actions")
- )
-)
-
-(define-method unset_model_drag_source
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_unset_model_drag_source")
- (return-type "none")
-)
-
-(define-method unset_model_drag_dest
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_unset_model_drag_dest")
- (return-type "none")
-)
-
-(define-method set_reorderable
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_reorderable")
- (return-type "none")
- (parameters
- '("gboolean" "reorderable")
- )
-)
-
-(define-method get_reorderable
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_reorderable")
- (return-type "gboolean")
-)
-
-(define-method set_drag_dest_item
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_set_drag_dest_item")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path" (null-ok))
- '("GtkIconViewDropPosition" "pos")
- )
-)
-
-(define-method get_drag_dest_item
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_drag_dest_item")
- (return-type "none")
- (parameters
- '("GtkTreePath**" "path")
- '("GtkIconViewDropPosition*" "pos")
- )
-)
-
-(define-method get_dest_item_at_pos
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_get_dest_item_at_pos")
- (return-type "gboolean")
- (parameters
- '("gint" "drag_x")
- '("gint" "drag_y")
- '("GtkTreePath**" "path")
- '("GtkIconViewDropPosition*" "pos")
- )
-)
-
-(define-method create_drag_icon
- (of-object "GtkIconView")
- (c-name "gtk_icon_view_create_drag_icon")
- (return-type "GdkPixmap*")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkimage.h
-
-(define-function gtk_image_get_type
- (c-name "gtk_image_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_image_new
- (c-name "gtk_image_new")
- (is-constructor-of "GtkImage")
- (return-type "GtkWidget*")
-)
-
-(define-function image_new_from_pixmap
- (c-name "gtk_image_new_from_pixmap")
- (is-constructor-of "GtkImage")
- (return-type "GtkWidget*")
- (parameters
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask")
- )
-)
-
-(define-function image_new_from_image
- (c-name "gtk_image_new_from_image")
- (is-constructor-of "GtkImage")
- (return-type "GtkWidget*")
- (parameters
- '("GdkImage*" "image")
- '("GdkBitmap*" "mask")
- )
-)
-
-(define-function image_new_from_file
- (c-name "gtk_image_new_from_file")
- (is-constructor-of "GtkImage")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "filename")
- )
-)
-
-(define-function image_new_from_pixbuf
- (c-name "gtk_image_new_from_pixbuf")
- (is-constructor-of "GtkImage")
- (return-type "GtkWidget*")
- (parameters
- '("GdkPixbuf*" "pixbuf")
- )
-)
-
-(define-function image_new_from_stock
- (c-name "gtk_image_new_from_stock")
- (return-type "GtkWidget*")
- (caller-owns-return #t)
- (parameters
- '("const-gchar*" "stock_id")
- '("GtkIconSize" "size")
- )
-)
-
-(define-function image_new_from_icon_set
- (c-name "gtk_image_new_from_icon_set")
- (return-type "GtkWidget*")
- (caller-owns-return #t)
- (parameters
- '("GtkIconSet*" "icon_set")
- '("GtkIconSize" "size")
- )
-)
-
-(define-function image_new_from_animation
- (c-name "gtk_image_new_from_animation")
- (return-type "GtkWidget*")
- (caller-owns-return #t)
- (parameters
- '("GdkPixbufAnimation*" "animation")
- )
-)
-
-(define-method clear
- (of-object "GtkImage")
- (c-name "gtk_image_clear")
- (return-type "none")
-)
-
-(define-method set_from_pixmap
- (of-object "GtkImage")
- (c-name "gtk_image_set_from_pixmap")
- (return-type "none")
- (parameters
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask" (null-ok))
- )
-)
-
-(define-method set_from_image
- (of-object "GtkImage")
- (c-name "gtk_image_set_from_image")
- (return-type "none")
- (parameters
- '("GdkImage*" "gdk_image" (null-ok))
- '("GdkBitmap*" "mask" (null-ok))
- )
-)
-
-(define-method set_from_file
- (of-object "GtkImage")
- (c-name "gtk_image_set_from_file")
- (return-type "none")
- (parameters
- '("const-gchar*" "filename" (null-ok))
- )
-)
-
-(define-method set_from_pixbuf
- (of-object "GtkImage")
- (c-name "gtk_image_set_from_pixbuf")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "pixbuf" (null-ok))
- )
-)
-
-(define-method set_from_stock
- (of-object "GtkImage")
- (c-name "gtk_image_set_from_stock")
- (return-type "none")
- (parameters
- '("const-gchar*" "stock_id")
- '("GtkIconSize" "size")
- )
-)
-
-(define-method set_from_icon_set
- (of-object "GtkImage")
- (c-name "gtk_image_set_from_icon_set")
- (return-type "none")
- (parameters
- '("GtkIconSet*" "icon_set")
- '("GtkIconSize" "size")
- )
-)
-
-(define-method set_from_animation
- (of-object "GtkImage")
- (c-name "gtk_image_set_from_animation")
- (return-type "none")
- (parameters
- '("GdkPixbufAnimation*" "animation")
- )
-)
-
-(define-method get_storage_type
- (of-object "GtkImage")
- (c-name "gtk_image_get_storage_type")
- (return-type "GtkImageType")
-)
-
-(define-method get_pixmap
- (of-object "GtkImage")
- (c-name "gtk_image_get_pixmap")
- (return-type "none")
- (parameters
- '("GdkPixmap**" "pixmap")
- '("GdkBitmap**" "mask")
- )
-)
-
-(define-method get_image
- (of-object "GtkImage")
- (c-name "gtk_image_get_image")
- (return-type "none")
- (parameters
- '("GdkImage**" "gdk_image")
- '("GdkBitmap**" "mask")
- )
-)
-
-(define-method get_pixbuf
- (of-object "GtkImage")
- (c-name "gtk_image_get_pixbuf")
- (return-type "GdkPixbuf*")
-)
-
-(define-method get_stock
- (of-object "GtkImage")
- (c-name "gtk_image_get_stock")
- (return-type "none")
- (parameters
- '("gchar**" "stock_id")
- '("GtkIconSize*" "size")
- )
-)
-
-(define-method get_icon_set
- (of-object "GtkImage")
- (c-name "gtk_image_get_icon_set")
- (return-type "none")
- (parameters
- '("GtkIconSet**" "icon_set")
- '("GtkIconSize*" "size")
- )
-)
-
-(define-method get_animation
- (of-object "GtkImage")
- (c-name "gtk_image_get_animation")
- (return-type "GdkPixbufAnimation*")
-)
-
-(define-method set
- (of-object "GtkImage")
- (c-name "gtk_image_set")
- (return-type "none")
- (parameters
- '("GdkImage*" "val")
- '("GdkBitmap*" "mask")
- )
- (deprecated "")
-)
-
-(define-method get
- (of-object "GtkImage")
- (c-name "gtk_image_get")
- (return-type "none")
- (parameters
- '("GdkImage**" "val")
- '("GdkBitmap**" "mask")
- )
- (deprecated "")
-)
-
-(define-function image_new_from_icon_name
- (c-name "gtk_image_new_from_icon_name")
- (return-type "GtkWidget*")
- (caller-owns-return #t)
- (parameters
- '("const-gchar*" "icon_name")
- '("GtkIconSize" "size")
- )
-)
-
-
-(define-method set_from_icon_name
- (of-object "GtkImage")
- (c-name "gtk_image_set_from_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "icon_name")
- '("GtkIconSize" "size")
- )
-)
-
-(define-method set_pixel_size
- (of-object "GtkImage")
- (c-name "gtk_image_set_pixel_size")
- (return-type "none")
- (parameters
- '("gint" "pixel_size")
- )
-)
-
-(define-method get_icon_name
- (of-object "GtkImage")
- (c-name "gtk_image_get_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar**" "icon_name")
- '("GtkIconSize*" "size")
- )
-)
-
-(define-method get_pixel_size
- (of-object "GtkImage")
- (c-name "gtk_image_get_pixel_size")
- (return-type "gint")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkimagemenuitem.h
-
-(define-function gtk_image_menu_item_get_type
- (c-name "gtk_image_menu_item_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_image_menu_item_new
- (c-name "gtk_image_menu_item_new")
- (is-constructor-of "GtkImageMenuItem")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_image_menu_item_new_with_label
- (c-name "gtk_image_menu_item_new_with_label")
- (is-constructor-of "GtkImageMenuItem")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-function gtk_image_menu_item_new_with_mnemonic
- (c-name "gtk_image_menu_item_new_with_mnemonic")
- (is-constructor-of "GtkImageMenuItem")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-function gtk_image_menu_item_new_from_stock
- (c-name "gtk_image_menu_item_new_from_stock")
- (is-constructor-of "GtkImageMenuItem")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "stock_id")
- '("GtkAccelGroup*" "accel_group")
- )
-)
-
-(define-method set_image
- (of-object "GtkImageMenuItem")
- (c-name "gtk_image_menu_item_set_image")
- (return-type "none")
- (parameters
- '("GtkWidget*" "image" (null-ok))
- )
-)
-
-(define-method get_image
- (of-object "GtkImageMenuItem")
- (c-name "gtk_image_menu_item_get_image")
- (return-type "GtkWidget*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkimcontext.h
-
-(define-function gtk_im_context_get_type
- (c-name "gtk_im_context_get_type")
- (return-type "GType")
-)
-
-(define-method set_client_window
- (of-object "GtkIMContext")
- (c-name "gtk_im_context_set_client_window")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- )
-)
-
-(define-method get_preedit_string
- (of-object "GtkIMContext")
- (c-name "gtk_im_context_get_preedit_string")
- (return-type "none")
- (parameters
- '("gchar**" "str")
- '("PangoAttrList**" "attrs")
- '("gint*" "cursor_pos")
- )
-)
-
-(define-method filter_keypress
- (of-object "GtkIMContext")
- (c-name "gtk_im_context_filter_keypress")
- (return-type "gboolean")
- (parameters
- '("GdkEventKey*" "event")
- )
-)
-
-(define-method focus_in
- (of-object "GtkIMContext")
- (c-name "gtk_im_context_focus_in")
- (return-type "none")
-)
-
-(define-method focus_out
- (of-object "GtkIMContext")
- (c-name "gtk_im_context_focus_out")
- (return-type "none")
-)
-
-(define-method reset
- (of-object "GtkIMContext")
- (c-name "gtk_im_context_reset")
- (return-type "none")
-)
-
-(define-method set_cursor_location
- (of-object "GtkIMContext")
- (c-name "gtk_im_context_set_cursor_location")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "area")
- )
-)
-
-(define-method set_use_preedit
- (of-object "GtkIMContext")
- (c-name "gtk_im_context_set_use_preedit")
- (return-type "none")
- (parameters
- '("gboolean" "use_preedit")
- )
-)
-
-(define-method set_surrounding
- (of-object "GtkIMContext")
- (c-name "gtk_im_context_set_surrounding")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("gint" "len")
- '("gint" "cursor_index")
- )
-)
-
-(define-method get_surrounding
- (of-object "GtkIMContext")
- (c-name "gtk_im_context_get_surrounding")
- (return-type "gboolean")
- (parameters
- '("gchar**" "text")
- '("gint*" "cursor_index")
- )
-)
-
-(define-method delete_surrounding
- (of-object "GtkIMContext")
- (c-name "gtk_im_context_delete_surrounding")
- (return-type "gboolean")
- (parameters
- '("gint" "offset")
- '("gint" "n_chars")
- )
-)
-
-(define-virtual preedit_start
- (of-object "GtkIMContext")
- (return-type "none")
-)
-(define-virtual preedit_end
- (of-object "GtkIMContext")
- (return-type "none")
-)
-(define-virtual preedit_changed
- (of-object "GtkIMContext")
- (return-type "none")
-)
-(define-virtual commit
- (of-object "GtkIMContext")
- (return-type "none")
- (parameters
- '("const-gchar*" "str")
- )
-)
-(define-virtual retrieve_surrounding
- (of-object "GtkIMContext")
- (return-type "gboolean")
-)
-(define-virtual delete_surrounding
- (of-object "GtkIMContext")
- (return-type "gboolean")
- (parameters
- '("gint" "offset")
- '("gint" "n_chars")
- )
-)
-(define-virtual set_client_window
- (of-object "GtkIMContext")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- )
-)
-(define-virtual get_preedit_string
- (of-object "GtkIMContext")
- (return-type "none")
- (parameters
- '("gchar**" "str")
- '("PangoAttrList**" "attrs")
- '("gint*" "cursor_pos")
- )
-)
-(define-virtual filter_keypress
- (of-object "GtkIMContext")
- (return-type "gboolean")
- (parameters
- '("GdkEventKey*" "event")
- )
-)
-(define-virtual focus_in
- (of-object "GtkIMContext")
- (return-type "none")
-)
-(define-virtual focus_out
- (of-object "GtkIMContext")
- (return-type "none")
-)
-(define-virtual reset
- (of-object "GtkIMContext")
- (return-type "none")
-)
-(define-virtual set_cursor_location
- (of-object "GtkIMContext")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "area")
- )
-)
-(define-virtual set_use_preedit
- (of-object "GtkIMContext")
- (return-type "none")
- (parameters
- '("gboolean" "use_preedit")
- )
-)
-(define-virtual set_surrounding
- (of-object "GtkIMContext")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("gint" "len")
- '("gint" "cursor_index")
- )
-)
-(define-virtual get_surrounding
- (of-object "GtkIMContext")
- (return-type "gboolean")
- (parameters
- '("gchar**" "text")
- '("gint*" "cursor_index")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkimcontextsimple.h
-
-(define-function gtk_im_context_simple_get_type
- (c-name "gtk_im_context_simple_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_im_context_simple_new
- (c-name "gtk_im_context_simple_new")
- (is-constructor-of "GtkIMContextSimple")
- (return-type "GtkIMContext*")
-)
-
-(define-method add_table
- (of-object "GtkIMContextSimple")
- (c-name "gtk_im_context_simple_add_table")
- (return-type "none")
- (parameters
- '("guint16*" "data")
- '("gint" "max_seq_len")
- '("gint" "n_seqs")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkimmodule.h
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkimmulticontext.h
-
-(define-function gtk_im_multicontext_get_type
- (c-name "gtk_im_multicontext_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_im_multicontext_new
- (c-name "gtk_im_multicontext_new")
- (is-constructor-of "GtkIMMulticontext")
- (return-type "GtkIMContext*")
-)
-
-(define-method append_menuitems
- (of-object "GtkIMMulticontext")
- (c-name "gtk_im_multicontext_append_menuitems")
- (return-type "none")
- (parameters
- '("GtkMenuShell*" "menushell")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkinputdialog.h
-
-(define-function gtk_input_dialog_get_type
- (c-name "gtk_input_dialog_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_input_dialog_new
- (c-name "gtk_input_dialog_new")
- (is-constructor-of "GtkInputDialog")
- (return-type "GtkWidget*")
-)
-
-(define-virtual enable_device
- (of-object "GtkInputDialog")
- (return-type "none")
- (parameters
- '("GdkDevice*" "device")
- )
-)
-(define-virtual disable_device
- (of-object "GtkInputDialog")
- (return-type "none")
- (parameters
- '("GdkDevice*" "device")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkinvisible.h
-
-(define-function gtk_invisible_get_type
- (c-name "gtk_invisible_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_invisible_new
- (c-name "gtk_invisible_new")
- (is-constructor-of "GtkInvisible")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_invisible_new_for_screen
- (c-name "gtk_invisible_new_for_screen")
- (is-constructor-of "GtkInvisible")
- (return-type "GtkWidget*")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-method set_screen
- (of-object "GtkInvisible")
- (c-name "gtk_invisible_set_screen")
- (return-type "none")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-method get_screen
- (of-object "GtkInvisible")
- (c-name "gtk_invisible_get_screen")
- (return-type "GdkScreen*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkitem.h
-
-(define-function gtk_item_get_type
- (c-name "gtk_item_get_type")
- (return-type "GType")
-)
-
-(define-method select
- (of-object "GtkItem")
- (c-name "gtk_item_select")
- (return-type "none")
-)
-
-(define-method deselect
- (of-object "GtkItem")
- (c-name "gtk_item_deselect")
- (return-type "none")
-)
-
-(define-method toggle
- (of-object "GtkItem")
- (c-name "gtk_item_toggle")
- (return-type "none")
-)
-
-(define-virtual select
- (of-object "GtkItem")
- (return-type "none")
-)
-(define-virtual deselect
- (of-object "GtkItem")
- (return-type "none")
-)
-(define-virtual toggle
- (of-object "GtkItem")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkitemfactory.h
-
-(define-function gtk_item_factory_get_type
- (c-name "gtk_item_factory_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_item_factory_new
- (c-name "gtk_item_factory_new")
- (is-constructor-of "GtkItemFactory")
- (return-type "GtkItemFactory*")
- (parameters
- '("GType" "container_type")
- '("const-gchar*" "path")
- '("GtkAccelGroup*" "accel_group" (null-ok) (default "NULL"))
- )
- (deprecated "use gtk.UIManager")
-)
-
-(define-method construct
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_construct")
- (return-type "none")
- (parameters
- '("GType" "container_type")
- '("const-gchar*" "path")
- '("GtkAccelGroup*" "accel_group")
- )
-)
-
-(define-function item_factory_add_foreign
- (c-name "gtk_item_factory_add_foreign")
- (return-type "none")
- (parameters
- '("GtkWidget*" "accel_widget")
- '("const-gchar*" "full_path")
- '("GtkAccelGroup*" "accel_group")
- '("guint" "keyval")
- '("GdkModifierType" "modifiers")
- )
-)
-
-(define-function item_factory_from_widget
- (c-name "gtk_item_factory_from_widget")
- (return-type "GtkItemFactory*")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-function item_factory_path_from_widget
- (c-name "gtk_item_factory_path_from_widget")
- (return-type "const-gchar*")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-method get_item
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_get_item")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "path")
- )
-)
-
-(define-method get_widget
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_get_widget")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "path")
- )
-)
-
-(define-method get_widget_by_action
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_get_widget_by_action")
- (return-type "GtkWidget*")
- (parameters
- '("guint" "action")
- )
-)
-
-(define-method get_item_by_action
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_get_item_by_action")
- (return-type "GtkWidget*")
- (parameters
- '("guint" "action")
- )
-)
-
-(define-method create_item
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_create_item")
- (return-type "none")
- (parameters
- '("GtkItemFactoryEntry*" "entry")
- '("gpointer" "callback_data")
- '("guint" "callback_type")
- )
-)
-
-(define-method create_items
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_create_items")
- (return-type "none")
- (parameters
- '("guint" "n_entries")
- '("GtkItemFactoryEntry*" "entries")
- '("gpointer" "callback_data")
- )
-)
-
-(define-method delete_item
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_delete_item")
- (return-type "none")
- (parameters
- '("const-gchar*" "path")
- )
-)
-
-(define-method delete_entry
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_delete_entry")
- (return-type "none")
- (parameters
- '("GtkItemFactoryEntry*" "entry")
- )
-)
-
-(define-method delete_entries
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_delete_entries")
- (return-type "none")
- (parameters
- '("guint" "n_entries")
- '("GtkItemFactoryEntry*" "entries")
- )
-)
-
-(define-method popup
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_popup")
- (return-type "none")
- (parameters
- '("guint" "x")
- '("guint" "y")
- '("guint" "mouse_button")
- '("guint32" "time" (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method popup_with_data
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_popup_with_data")
- (return-type "none")
- (parameters
- '("gpointer" "popup_data")
- '("GtkDestroyNotify" "destroy")
- '("guint" "x")
- '("guint" "y")
- '("guint" "mouse_button")
- '("guint32" "time" (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method popup_data
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_popup_data")
- (return-type "gpointer")
-)
-
-(define-function item_factory_popup_data_from_widget
- (c-name "gtk_item_factory_popup_data_from_widget")
- (return-type "gpointer")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-method set_translate_func
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_set_translate_func")
- (return-type "none")
- (parameters
- '("GtkTranslateFunc" "func")
- '("gpointer" "data")
- '("GtkDestroyNotify" "notify")
- )
-)
-
-(define-function item_factory_from_path
- (c-name "gtk_item_factory_from_path")
- (return-type "GtkItemFactory*")
- (parameters
- '("const-gchar*" "path")
- )
- (deprecated "")
-)
-
-(define-function item_factory_create_menu_entries
- (c-name "gtk_item_factory_create_menu_entries")
- (return-type "none")
- (parameters
- '("guint" "n_entries")
- '("GtkMenuEntry*" "entries")
- )
- (deprecated "")
-)
-
-(define-function item_factories_path_delete
- (c-name "gtk_item_factories_path_delete")
- (return-type "none")
- (parameters
- '("const-gchar*" "ifactory_path")
- '("const-gchar*" "path")
- )
- (deprecated "")
-)
-
-(define-method create_items_ac
- (of-object "GtkItemFactory")
- (c-name "gtk_item_factory_create_items_ac")
- (return-type "none")
- (parameters
- '("guint" "n_entries")
- '("GtkItemFactoryEntry*" "entries")
- '("gpointer" "callback_data")
- '("guint" "callback_type")
- )
- (deprecated "")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtklabel.h
-
-(define-function gtk_label_get_type
- (c-name "gtk_label_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_label_new
- (c-name "gtk_label_new")
- (is-constructor-of "GtkLabel")
- (return-type "GtkWidget*")
- (properties
- '("label" (argname "str") (optional))
- )
-)
-
-(define-function gtk_label_new_with_mnemonic
- (c-name "gtk_label_new_with_mnemonic")
- (is-constructor-of "GtkLabel")
- (return-type "GtkWidget*")
- (properties
- '("label" (argname "str") (optional))
- )
-)
-
-(define-method set_text
- (of-object "GtkLabel")
- (c-name "gtk_label_set_text")
- (return-type "none")
- (parameters
- '("const-char*" "str")
- )
-)
-
-(define-method get_text
- (of-object "GtkLabel")
- (c-name "gtk_label_get_text")
- (return-type "const-gchar*")
-)
-
-(define-method set_attributes
- (of-object "GtkLabel")
- (c-name "gtk_label_set_attributes")
- (return-type "none")
- (parameters
- '("PangoAttrList*" "attrs")
- )
-)
-
-(define-method get_attributes
- (of-object "GtkLabel")
- (c-name "gtk_label_get_attributes")
- (return-type "PangoAttrList*")
-)
-
-(define-method set_label
- (of-object "GtkLabel")
- (c-name "gtk_label_set_label")
- (return-type "none")
- (parameters
- '("const-gchar*" "str")
- )
-)
-
-(define-method get_label
- (of-object "GtkLabel")
- (c-name "gtk_label_get_label")
- (return-type "const-gchar*")
-)
-
-(define-method set_markup
- (of-object "GtkLabel")
- (c-name "gtk_label_set_markup")
- (return-type "none")
- (parameters
- '("const-gchar*" "str")
- )
-)
-
-(define-method set_use_markup
- (of-object "GtkLabel")
- (c-name "gtk_label_set_use_markup")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_use_markup
- (of-object "GtkLabel")
- (c-name "gtk_label_get_use_markup")
- (return-type "gboolean")
-)
-
-(define-method set_use_underline
- (of-object "GtkLabel")
- (c-name "gtk_label_set_use_underline")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_use_underline
- (of-object "GtkLabel")
- (c-name "gtk_label_get_use_underline")
- (return-type "gboolean")
-)
-
-(define-method set_markup_with_mnemonic
- (of-object "GtkLabel")
- (c-name "gtk_label_set_markup_with_mnemonic")
- (return-type "none")
- (parameters
- '("const-gchar*" "str")
- )
-)
-
-(define-method get_mnemonic_keyval
- (of-object "GtkLabel")
- (c-name "gtk_label_get_mnemonic_keyval")
- (return-type "guint")
-)
-
-(define-method set_mnemonic_widget
- (of-object "GtkLabel")
- (c-name "gtk_label_set_mnemonic_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget" (null-ok))
- )
-)
-
-(define-method get_mnemonic_widget
- (of-object "GtkLabel")
- (c-name "gtk_label_get_mnemonic_widget")
- (return-type "GtkWidget*")
-)
-
-(define-method set_text_with_mnemonic
- (of-object "GtkLabel")
- (c-name "gtk_label_set_text_with_mnemonic")
- (return-type "none")
- (parameters
- '("const-gchar*" "str")
- )
-)
-
-(define-method set_justify
- (of-object "GtkLabel")
- (c-name "gtk_label_set_justify")
- (return-type "none")
- (parameters
- '("GtkJustification" "jtype")
- )
-)
-
-(define-method get_justify
- (of-object "GtkLabel")
- (c-name "gtk_label_get_justify")
- (return-type "GtkJustification")
-)
-
-(define-method set_pattern
- (of-object "GtkLabel")
- (c-name "gtk_label_set_pattern")
- (return-type "none")
- (parameters
- '("const-gchar*" "pattern")
- )
-)
-
-(define-method set_line_wrap
- (of-object "GtkLabel")
- (c-name "gtk_label_set_line_wrap")
- (return-type "none")
- (parameters
- '("gboolean" "wrap")
- )
-)
-
-(define-method get_line_wrap
- (of-object "GtkLabel")
- (c-name "gtk_label_get_line_wrap")
- (return-type "gboolean")
-)
-
-(define-method set_selectable
- (of-object "GtkLabel")
- (c-name "gtk_label_set_selectable")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_selectable
- (of-object "GtkLabel")
- (c-name "gtk_label_get_selectable")
- (return-type "gboolean")
-)
-
-(define-method select_region
- (of-object "GtkLabel")
- (c-name "gtk_label_select_region")
- (return-type "none")
- (parameters
- '("gint" "start_offset")
- '("gint" "end_offset")
- )
-)
-
-(define-method get_selection_bounds
- (of-object "GtkLabel")
- (c-name "gtk_label_get_selection_bounds")
- (return-type "gboolean")
- (parameters
- '("gint*" "start")
- '("gint*" "end")
- )
-)
-
-(define-method get_layout
- (of-object "GtkLabel")
- (c-name "gtk_label_get_layout")
- (return-type "PangoLayout*")
-)
-
-(define-method get_layout_offsets
- (of-object "GtkLabel")
- (c-name "gtk_label_get_layout_offsets")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- )
-)
-
-(define-method set
- (of-object "GtkLabel")
- (c-name "gtk_label_set")
- (return-type "none")
- (parameters
- '("const-char*" "str")
- )
- (deprecated "use GtkLabel.set_text")
-)
-
-(define-method get
- (of-object "GtkLabel")
- (c-name "gtk_label_get")
- (return-type "none")
- (parameters
- '("char**" "str")
- )
- (deprecated "use GtkLabel.get_text")
-)
-
-(define-method parse_uline
- (of-object "GtkLabel")
- (c-name "gtk_label_parse_uline")
- (return-type "guint")
- (parameters
- '("const-gchar*" "string")
- )
- (deprecated "")
-)
-
-(define-method set_ellipsize
- (of-object "GtkLabel")
- (c-name "gtk_label_set_ellipsize")
- (return-type "none")
- (parameters
- '("PangoEllipsizeMode" "mode")
- )
-)
-
-(define-method get_ellipsize
- (of-object "GtkLabel")
- (c-name "gtk_label_get_ellipsize")
- (return-type "PangoEllipsizeMode")
-)
-
-(define-method set_angle
- (of-object "GtkLabel")
- (c-name "gtk_label_set_angle")
- (return-type "none")
- (parameters
- '("gint" "angle")
- )
-)
-
-(define-method get_angle
- (of-object "GtkLabel")
- (c-name "gtk_label_get_angle")
- (return-type "gint")
-)
-
-(define-method set_width_chars
- (of-object "GtkLabel")
- (c-name "gtk_label_set_width_chars")
- (return-type "none")
- (parameters
- '("gint" "n_chars")
- )
-)
-
-(define-method get_width_chars
- (of-object "GtkLabel")
- (c-name "gtk_label_get_width_chars")
- (return-type "gint")
-)
-
-(define-method set_max_width_chars
- (of-object "GtkLabel")
- (c-name "gtk_label_set_max_width_chars")
- (return-type "none")
- (parameters
- '("gint" "n_chars")
- )
-)
-
-(define-method get_max_width_chars
- (of-object "GtkLabel")
- (c-name "gtk_label_get_max_width_chars")
- (return-type "gint")
-)
-
-(define-method set_single_line_mode
- (of-object "GtkLabel")
- (c-name "gtk_label_set_single_line_mode")
- (return-type "none")
- (parameters
- '("gboolean" "single_line_mode")
- )
-)
-
-(define-method get_single_line_mode
- (of-object "GtkLabel")
- (c-name "gtk_label_get_single_line_mode")
- (return-type "gboolean")
-)
-
-(define-virtual move_cursor
- (of-object "GtkLabel")
- (return-type "none")
- (parameters
- '("GtkMovementStep" "step")
- '("gint" "count")
- '("gboolean" "extend_selection")
- )
-)
-(define-virtual copy_clipboard
- (of-object "GtkLabel")
- (return-type "none")
-)
-(define-virtual populate_popup
- (of-object "GtkLabel")
- (return-type "none")
- (parameters
- '("GtkMenu*" "menu")
- )
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtklayout.h
-
-(define-function gtk_layout_get_type
- (c-name "gtk_layout_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_layout_new
- (c-name "gtk_layout_new")
- (is-constructor-of "GtkLayout")
- (return-type "GtkWidget*")
- (properties
- '("hadjustment" (optional))
- '("vadjustment" (optional))
- )
-)
-
-(define-method put
- (of-object "GtkLayout")
- (c-name "gtk_layout_put")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child_widget")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method move
- (of-object "GtkLayout")
- (c-name "gtk_layout_move")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child_widget")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method set_size
- (of-object "GtkLayout")
- (c-name "gtk_layout_set_size")
- (return-type "none")
- (parameters
- '("guint" "width")
- '("guint" "height")
- )
-)
-
-(define-method get_size
- (of-object "GtkLayout")
- (c-name "gtk_layout_get_size")
- (return-type "none")
- (parameters
- '("guint*" "width")
- '("guint*" "height")
- )
-)
-
-(define-method get_hadjustment
- (of-object "GtkLayout")
- (c-name "gtk_layout_get_hadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method get_vadjustment
- (of-object "GtkLayout")
- (c-name "gtk_layout_get_vadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method set_hadjustment
- (of-object "GtkLayout")
- (c-name "gtk_layout_set_hadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment" (null-ok))
- )
-)
-
-(define-method set_vadjustment
- (of-object "GtkLayout")
- (c-name "gtk_layout_set_vadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment" (null-ok))
- )
-)
-
-(define-method freeze
- (of-object "GtkLayout")
- (c-name "gtk_layout_freeze")
- (return-type "none")
- (deprecated "")
-)
-
-(define-method thaw
- (of-object "GtkLayout")
- (c-name "gtk_layout_thaw")
- (return-type "none")
- (deprecated "")
-)
-
-(define-virtual set_scroll_adjustments
- (of-object "GtkLayout")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "hadjustment")
- '("GtkAdjustment*" "vadjustment")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtklist.h
-
-(define-function gtk_list_get_type
- (c-name "gtk_list_get_type")
- (return-type "GType")
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-function gtk_list_new
- (c-name "gtk_list_new")
- (is-constructor-of "GtkList")
- (return-type "GtkWidget*")
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method insert_items
- (of-object "GtkList")
- (c-name "gtk_list_insert_items")
- (return-type "none")
- (parameters
- '("GList*" "items")
- '("gint" "position")
- )
-)
-
-(define-method append_items
- (of-object "GtkList")
- (c-name "gtk_list_append_items")
- (return-type "none")
- (parameters
- '("GList*" "items")
- )
-)
-
-(define-method prepend_items
- (of-object "GtkList")
- (c-name "gtk_list_prepend_items")
- (return-type "none")
- (parameters
- '("GList*" "items")
- )
-)
-
-(define-method remove_items
- (of-object "GtkList")
- (c-name "gtk_list_remove_items")
- (return-type "none")
- (parameters
- '("GList*" "items")
- )
-)
-
-(define-method remove_items_no_unref
- (of-object "GtkList")
- (c-name "gtk_list_remove_items_no_unref")
- (return-type "none")
- (parameters
- '("GList*" "items")
- )
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method clear_items
- (of-object "GtkList")
- (c-name "gtk_list_clear_items")
- (return-type "none")
- (parameters
- '("gint" "start")
- '("gint" "end")
- )
-)
-
-(define-method select_item
- (of-object "GtkList")
- (c-name "gtk_list_select_item")
- (return-type "none")
- (parameters
- '("gint" "item")
- )
-)
-
-(define-method unselect_item
- (of-object "GtkList")
- (c-name "gtk_list_unselect_item")
- (return-type "none")
- (parameters
- '("gint" "item")
- )
-)
-
-(define-method select_child
- (of-object "GtkList")
- (c-name "gtk_list_select_child")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method unselect_child
- (of-object "GtkList")
- (c-name "gtk_list_unselect_child")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method child_position
- (of-object "GtkList")
- (c-name "gtk_list_child_position")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method set_selection_mode
- (of-object "GtkList")
- (c-name "gtk_list_set_selection_mode")
- (return-type "none")
- (parameters
- '("GtkSelectionMode" "mode")
- )
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method extend_selection
- (of-object "GtkList")
- (c-name "gtk_list_extend_selection")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll_type")
- '("gfloat" "position")
- '("gboolean" "auto_start_selection")
- )
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method start_selection
- (of-object "GtkList")
- (c-name "gtk_list_start_selection")
- (return-type "none")
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method end_selection
- (of-object "GtkList")
- (c-name "gtk_list_end_selection")
- (return-type "none")
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method select_all
- (of-object "GtkList")
- (c-name "gtk_list_select_all")
- (return-type "none")
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method unselect_all
- (of-object "GtkList")
- (c-name "gtk_list_unselect_all")
- (return-type "none")
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method scroll_horizontal
- (of-object "GtkList")
- (c-name "gtk_list_scroll_horizontal")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll_type")
- '("gfloat" "position")
- )
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method scroll_vertical
- (of-object "GtkList")
- (c-name "gtk_list_scroll_vertical")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll_type")
- '("gfloat" "position")
- )
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method toggle_add_mode
- (of-object "GtkList")
- (c-name "gtk_list_toggle_add_mode")
- (return-type "none")
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method toggle_focus_row
- (of-object "GtkList")
- (c-name "gtk_list_toggle_focus_row")
- (return-type "none")
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method toggle_row
- (of-object "GtkList")
- (c-name "gtk_list_toggle_row")
- (return-type "none")
- (parameters
- '("GtkWidget*" "item")
- )
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method undo_selection
- (of-object "GtkList")
- (c-name "gtk_list_undo_selection")
- (return-type "none")
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-(define-method end_drag_selection
- (of-object "GtkList")
- (c-name "gtk_list_end_drag_selection")
- (return-type "none")
- (deprecated "use GtkListStore/GtkTreeView")
-)
-
-
-(define-virtual selection_changed
- (of-object "GtkList")
- (return-type "none")
-)
-(define-virtual select_child
- (of-object "GtkList")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-(define-virtual unselect_child
- (of-object "GtkList")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-(define-virtual toggle_focus_row
- (of-object "GtkListItem")
- (return-type "none")
-)
-(define-virtual select_all
- (of-object "GtkListItem")
- (return-type "none")
-)
-(define-virtual unselect_all
- (of-object "GtkListItem")
- (return-type "none")
-)
-(define-virtual undo_selection
- (of-object "GtkListItem")
- (return-type "none")
-)
-(define-virtual start_selection
- (of-object "GtkListItem")
- (return-type "none")
-)
-(define-virtual end_selection
- (of-object "GtkListItem")
- (return-type "none")
-)
-(define-virtual extend_selection
- (of-object "GtkListItem")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll_type")
- '("gfloat" "position")
- '("gboolean" "auto_start_selection")
- )
-)
-(define-virtual scroll_horizontal
- (of-object "GtkListItem")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll_type")
- '("gfloat" "position")
- )
-)
-(define-virtual scroll_vertical
- (of-object "GtkListItem")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll_type")
- '("gfloat" "position")
- )
-)
-(define-virtual toggle_add_mode
- (of-object "GtkListItem")
- (return-type "none")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtklistitem.h
-
-(define-function gtk_list_item_get_type
- (c-name "gtk_list_item_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_list_item_new
- (c-name "gtk_list_item_new")
- (is-constructor-of "GtkListItem")
- (return-type "GtkWidget*")
- (deprecated "use gtk.TreeView")
-)
-
-(define-function gtk_list_item_new_with_label
- (c-name "gtk_list_item_new_with_label")
- (is-constructor-of "GtkListItem")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
- (deprecated "use gtk.TreeView")
-)
-
-(define-method select
- (of-object "GtkListItem")
- (c-name "gtk_list_item_select")
- (return-type "none")
-)
-
-(define-method deselect
- (of-object "GtkListItem")
- (c-name "gtk_list_item_deselect")
- (return-type "none")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkliststore.h
-
-(define-function gtk_list_store_get_type
- (c-name "gtk_list_store_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_list_store_new
- (c-name "gtk_list_store_new")
- (is-constructor-of "GtkListStore")
- (return-type "GtkListStore*")
- (parameters
- '("gint" "n_columns")
- )
- (varargs #t)
-)
-
-(define-function gtk_list_store_newv
- (c-name "gtk_list_store_newv")
- (is-constructor-of "GtkListStore")
- (return-type "GtkListStore*")
- (parameters
- '("gint" "n_columns")
- '("GType*" "value")
- )
-)
-
-(define-method set_column_types
- (of-object "GtkListStore")
- (c-name "gtk_list_store_set_column_types")
- (return-type "none")
- (parameters
- '("gint" "n_columns")
- '("GType*" "types")
- )
-)
-
-(define-method set_value
- (of-object "GtkListStore")
- (c-name "gtk_list_store_set_value")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("gint" "column")
- '("GValue*" "value")
- )
-)
-
-(define-method set
- (of-object "GtkListStore")
- (c-name "gtk_list_store_set")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
- (varargs #t)
-)
-
-(define-method set_valist
- (of-object "GtkListStore")
- (c-name "gtk_list_store_set_valist")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("va_list" "var_args")
- )
-)
-
-(define-method remove
- (of-object "GtkListStore")
- (c-name "gtk_list_store_remove")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method insert
- (of-object "GtkListStore")
- (c-name "gtk_list_store_insert")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("gint" "position")
- )
-)
-
-(define-method insert_before
- (of-object "GtkListStore")
- (c-name "gtk_list_store_insert_before")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "sibling")
- )
-)
-
-(define-method insert_after
- (of-object "GtkListStore")
- (c-name "gtk_list_store_insert_after")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "sibling")
- )
-)
-
-(define-method insert_with_values
- (of-object "GtkListStore")
- (c-name "gtk_list_store_insert_with_values")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("gint" "position")
- )
- (varargs #t)
-)
-
-(define-method insert_with_valuesv
- (of-object "GtkListStore")
- (c-name "gtk_list_store_insert_with_valuesv")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("gint" "position")
- '("gint*" "columns")
- '("GValue*" "values")
- '("gint" "n_values")
- )
-)
-
-(define-method prepend
- (of-object "GtkListStore")
- (c-name "gtk_list_store_prepend")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method append
- (of-object "GtkListStore")
- (c-name "gtk_list_store_append")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method clear
- (of-object "GtkListStore")
- (c-name "gtk_list_store_clear")
- (return-type "none")
-)
-
-(define-method iter_is_valid
- (of-object "GtkListStore")
- (c-name "gtk_list_store_iter_is_valid")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method reorder
- (of-object "GtkListStore")
- (c-name "gtk_list_store_reorder")
- (return-type "none")
- (parameters
- '("gint*" "new_order")
- )
-)
-
-(define-method swap
- (of-object "GtkListStore")
- (c-name "gtk_list_store_swap")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "a")
- '("GtkTreeIter*" "b")
- )
-)
-
-(define-method move_after
- (of-object "GtkListStore")
- (c-name "gtk_list_store_move_after")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "position" (null-ok))
- )
-)
-
-(define-method move_before
- (of-object "GtkListStore")
- (c-name "gtk_list_store_move_before")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "position" (null-ok))
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkmain.h
-
-(define-function check_version
- (c-name "gtk_check_version")
- (return-type "gchar*")
- (caller-owns-return #f)
- (parameters
- '("guint" "required_major")
- '("guint" "required_minor")
- '("guint" "required_micro")
- )
-)
-
-(define-function init
- (c-name "gtk_init")
- (return-type "none")
- (parameters
- '("int*" "argc")
- '("char***" "argv")
- )
-)
-
-(define-function init_check
- (c-name "gtk_init_check")
- (return-type "gboolean")
- (parameters
- '("int*" "argc")
- '("char***" "argv")
- )
-)
-
-(define-function init_abi_check
- (c-name "gtk_init_abi_check")
- (return-type "none")
- (parameters
- '("int*" "argc")
- '("char***" "argv")
- '("int" "num_checks")
- '("size_t" "sizeof_GtkWindow")
- )
-)
-
-(define-function init_check_abi_check
- (c-name "gtk_init_check_abi_check")
- (return-type "gboolean")
- (parameters
- '("int*" "argc")
- '("char***" "argv")
- '("int" "num_checks")
- '("size_t" "sizeof_GtkWindow")
- )
-)
-
-(define-function exit
- (c-name "gtk_exit")
- (return-type "none")
- (parameters
- '("gint" "error_code")
- )
- (deprecated "")
-)
-
-(define-function disable_setlocale
- (c-name "gtk_disable_setlocale")
- (return-type "none")
-)
-
-(define-function set_locale
- (c-name "gtk_set_locale")
- (return-type "gchar*")
-)
-
-(define-function get_default_language
- (c-name "gtk_get_default_language")
- (return-type "PangoLanguage*")
-)
-
-(define-function events_pending
- (c-name "gtk_events_pending")
- (return-type "gint")
-)
-
-(define-function main_do_event
- (c-name "gtk_main_do_event")
- (return-type "none")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-
-(define-function main
- (c-name "gtk_main")
- (return-type "none")
-)
-
-(define-function main_level
- (c-name "gtk_main_level")
- (return-type "guint")
-)
-
-(define-function main_quit
- (c-name "gtk_main_quit")
- (return-type "none")
-)
-
-(define-function main_iteration
- (c-name "gtk_main_iteration")
- (return-type "gboolean")
-)
-
-(define-function main_iteration_do
- (c-name "gtk_main_iteration_do")
- (return-type "gboolean")
- (parameters
- '("gboolean" "blocking" (default "TRUE"))
- )
-)
-
-(define-function true
- (c-name "gtk_true")
- (return-type "gboolean")
-)
-
-(define-function false
- (c-name "gtk_false")
- (return-type "gboolean")
-)
-
-(define-method grab_add
- (of-object "GtkWidget")
- (c-name "gtk_grab_add")
- (return-type "none")
-)
-
-(define-function grab_get_current
- (c-name "gtk_grab_get_current")
- (return-type "GtkWidget*")
-)
-
-(define-method grab_remove
- (of-object "GtkWidget")
- (c-name "gtk_grab_remove")
- (return-type "none")
-)
-
-(define-function init_add
- (c-name "gtk_init_add")
- (return-type "none")
- (parameters
- '("GtkFunction" "function")
- '("gpointer" "data")
- )
-)
-
-(define-function quit_add_destroy
- (c-name "gtk_quit_add_destroy")
- (return-type "none")
- (parameters
- '("guint" "main_level")
- '("GtkObject*" "object")
- )
-)
-
-(define-function quit_add
- (c-name "gtk_quit_add")
- (return-type "guint")
- (parameters
- '("guint" "main_level")
- '("GtkFunction" "function")
- '("gpointer" "data")
- )
-)
-
-(define-function quit_add_full
- (c-name "gtk_quit_add_full")
- (return-type "guint")
- (parameters
- '("guint" "main_level")
- '("GtkFunction" "function")
- '("GtkCallbackMarshal" "marshal")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-function quit_remove
- (c-name "gtk_quit_remove")
- (return-type "none")
- (parameters
- '("guint" "quit_handler_id")
- )
-)
-
-(define-function quit_remove_by_data
- (c-name "gtk_quit_remove_by_data")
- (return-type "none")
- (parameters
- '("gpointer" "data")
- )
-)
-
-(define-function timeout_add
- (c-name "gtk_timeout_add")
- (return-type "guint")
- (parameters
- '("guint32" "interval")
- '("GtkFunction" "function")
- '("gpointer" "data")
- )
-)
-
-(define-function timeout_add_full
- (c-name "gtk_timeout_add_full")
- (return-type "guint")
- (parameters
- '("guint32" "interval")
- '("GtkFunction" "function")
- '("GtkCallbackMarshal" "marshal")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-function timeout_remove
- (c-name "gtk_timeout_remove")
- (return-type "none")
- (parameters
- '("guint" "timeout_handler_id")
- )
-)
-
-(define-function idle_add
- (c-name "gtk_idle_add")
- (return-type "guint")
- (parameters
- '("GtkFunction" "function")
- '("gpointer" "data")
- )
-)
-
-(define-function idle_add_priority
- (c-name "gtk_idle_add_priority")
- (return-type "guint")
- (parameters
- '("gint" "priority")
- '("GtkFunction" "function")
- '("gpointer" "data")
- )
-)
-
-(define-function idle_add_full
- (c-name "gtk_idle_add_full")
- (return-type "guint")
- (parameters
- '("gint" "priority")
- '("GtkFunction" "function")
- '("GtkCallbackMarshal" "marshal")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-function idle_remove
- (c-name "gtk_idle_remove")
- (return-type "none")
- (parameters
- '("guint" "idle_handler_id")
- )
-)
-
-(define-function idle_remove_by_data
- (c-name "gtk_idle_remove_by_data")
- (return-type "none")
- (parameters
- '("gpointer" "data")
- )
-)
-
-(define-function input_add_full
- (c-name "gtk_input_add_full")
- (return-type "guint")
- (parameters
- '("gint" "source")
- '("GdkInputCondition" "condition")
- '("GdkInputFunction" "function")
- '("GtkCallbackMarshal" "marshal")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-function input_remove
- (c-name "gtk_input_remove")
- (return-type "none")
- (parameters
- '("guint" "input_handler_id")
- )
-)
-
-(define-function key_snooper_install
- (c-name "gtk_key_snooper_install")
- (return-type "guint")
- (parameters
- '("GtkKeySnoopFunc" "snooper")
- '("gpointer" "func_data")
- )
-)
-
-(define-function key_snooper_remove
- (c-name "gtk_key_snooper_remove")
- (return-type "none")
- (parameters
- '("guint" "snooper_handler_id")
- )
-)
-
-(define-function get_current_event
- (c-name "gtk_get_current_event")
- (return-type "GdkEvent*")
- (caller-owns-return #t)
-)
-
-(define-function get_current_event_time
- (c-name "gtk_get_current_event_time")
- (return-type "guint32")
-)
-
-(define-function get_current_event_state
- (c-name "gtk_get_current_event_state")
- (return-type "gboolean")
- (parameters
- '("GdkModifierType*" "state")
- )
-)
-
-(define-function get_event_widget
- (c-name "gtk_get_event_widget")
- (return-type "GtkWidget*")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-
-(define-method propagate_event
- (of-object "GtkWidget")
- (c-name "gtk_propagate_event")
- (return-type "none")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-
-(define-function parse_args
- (c-name "gtk_parse_args")
- (return-type "gboolean")
- (parameters
- '("int*" "argc")
- '("char***" "argv")
- )
-)
-
-(define-function init_with_args
- (c-name "gtk_init_with_args")
- (return-type "gboolean")
- (parameters
- '("int*" "argc")
- '("char***" "argv")
- '("char*" "parameter_string")
- '("GOptionEntry*" "entries")
- '("char*" "translation_domain")
- '("GError**" "error")
- )
-)
-
-(define-function get_option_group
- (c-name "gtk_get_option_group")
- (return-type "GOptionGroup*")
- (parameters
- '("gboolean" "open_default_display")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkmenu.h
-
-(define-function gtk_menu_get_type
- (c-name "gtk_menu_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_menu_new
- (c-name "gtk_menu_new")
- (is-constructor-of "GtkMenu")
- (return-type "GtkWidget*")
-)
-
-(define-method popup
- (of-object "GtkMenu")
- (c-name "gtk_menu_popup")
- (return-type "none")
- (parameters
- '("GtkWidget*" "parent_menu_shell")
- '("GtkWidget*" "parent_menu_item")
- '("GtkMenuPositionFunc" "func")
- '("gpointer" "data")
- '("guint" "button")
- '("guint32" "activate_time")
- )
-)
-
-(define-method reposition
- (of-object "GtkMenu")
- (c-name "gtk_menu_reposition")
- (return-type "none")
-)
-
-(define-method popdown
- (of-object "GtkMenu")
- (c-name "gtk_menu_popdown")
- (return-type "none")
-)
-
-(define-method get_active
- (of-object "GtkMenu")
- (c-name "gtk_menu_get_active")
- (return-type "GtkWidget*")
-)
-
-(define-method set_active
- (of-object "GtkMenu")
- (c-name "gtk_menu_set_active")
- (return-type "none")
- (parameters
- '("guint" "index")
- )
-)
-
-(define-method set_accel_group
- (of-object "GtkMenu")
- (c-name "gtk_menu_set_accel_group")
- (return-type "none")
- (parameters
- '("GtkAccelGroup*" "accel_group")
- )
-)
-
-(define-method get_accel_group
- (of-object "GtkMenu")
- (c-name "gtk_menu_get_accel_group")
- (return-type "GtkAccelGroup*")
-)
-
-(define-method set_accel_path
- (of-object "GtkMenu")
- (c-name "gtk_menu_set_accel_path")
- (return-type "none")
- (parameters
- '("const-gchar*" "accel_path")
- )
-)
-
-(define-method attach_to_widget
- (of-object "GtkMenu")
- (c-name "gtk_menu_attach_to_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "attach_widget")
- '("GtkMenuDetachFunc" "detacher")
- )
-)
-
-(define-method detach
- (of-object "GtkMenu")
- (c-name "gtk_menu_detach")
- (return-type "none")
-)
-
-(define-method get_attach_widget
- (of-object "GtkMenu")
- (c-name "gtk_menu_get_attach_widget")
- (return-type "GtkWidget*")
-)
-
-(define-method set_tearoff_state
- (of-object "GtkMenu")
- (c-name "gtk_menu_set_tearoff_state")
- (return-type "none")
- (parameters
- '("gboolean" "torn_off")
- )
-)
-
-(define-method get_tearoff_state
- (of-object "GtkMenu")
- (c-name "gtk_menu_get_tearoff_state")
- (return-type "gboolean")
-)
-
-(define-method set_title
- (of-object "GtkMenu")
- (c-name "gtk_menu_set_title")
- (return-type "none")
- (parameters
- '("const-gchar*" "title")
- )
-)
-
-(define-method get_title
- (of-object "GtkMenu")
- (c-name "gtk_menu_get_title")
- (return-type "const-gchar*")
-)
-
-(define-method reorder_child
- (of-object "GtkMenu")
- (c-name "gtk_menu_reorder_child")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gint" "position")
- )
-)
-
-(define-method set_screen
- (of-object "GtkMenu")
- (c-name "gtk_menu_set_screen")
- (return-type "none")
- (parameters
- '("GdkScreen*" "screen" (null-ok))
- )
-)
-
-(define-method attach
- (of-object "GtkMenu")
- (c-name "gtk_menu_attach")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("guint" "left_attach")
- '("guint" "right_attach")
- '("guint" "top_attach")
- '("guint" "bottom_attach")
- )
-)
-
-(define-method set_monitor
- (of-object "GtkMenu")
- (c-name "gtk_menu_set_monitor")
- (return-type "none")
- (parameters
- '("gint" "monitor_num")
- )
-)
-
-(define-method menu_get_for_attach_widget
- (of-object "GtkWidget")
- (c-name "gtk_menu_get_for_attach_widget")
- (return-type "GList*")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkmenubar.h
-
-(define-function gtk_menu_bar_get_type
- (c-name "gtk_menu_bar_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_menu_bar_new
- (c-name "gtk_menu_bar_new")
- (is-constructor-of "GtkMenuBar")
- (return-type "GtkWidget*")
-)
-
-(define-method get_pack_direction
- (of-object "GtkMenuBar")
- (c-name "gtk_menu_bar_get_pack_direction")
- (return-type "GtkPackDirection")
-)
-
-(define-method set_pack_direction
- (of-object "GtkMenuBar")
- (c-name "gtk_menu_bar_set_pack_direction")
- (return-type "none")
- (parameters
- '("GtkPackDirection" "pack_dir")
- )
-)
-
-(define-method get_child_pack_direction
- (of-object "GtkMenuBar")
- (c-name "gtk_menu_bar_get_child_pack_direction")
- (return-type "GtkPackDirection")
-)
-
-(define-method set_child_pack_direction
- (of-object "GtkMenuBar")
- (c-name "gtk_menu_bar_set_child_pack_direction")
- (return-type "none")
- (parameters
- '("GtkPackDirection" "child_pack_dir")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkmenuitem.h
-
-(define-function gtk_menu_item_get_type
- (c-name "gtk_menu_item_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_menu_item_new
- (c-name "gtk_menu_item_new")
- (is-constructor-of "GtkMenuItem")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_menu_item_new_with_label
- (c-name "gtk_menu_item_new_with_label")
- (is-constructor-of "GtkMenuItem")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-function gtk_menu_item_new_with_mnemonic
- (c-name "gtk_menu_item_new_with_mnemonic")
- (is-constructor-of "GtkMenuItem")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-method set_submenu
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_set_submenu")
- (return-type "none")
- (parameters
- '("GtkWidget*" "submenu")
- )
-)
-
-(define-method get_submenu
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_get_submenu")
- (return-type "GtkWidget*")
-)
-
-(define-method remove_submenu
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_remove_submenu")
- (return-type "none")
-)
-
-(define-method select
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_select")
- (return-type "none")
-)
-
-(define-method deselect
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_deselect")
- (return-type "none")
-)
-
-(define-method activate
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_activate")
- (return-type "none")
-)
-
-(define-method toggle_size_request
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_toggle_size_request")
- (return-type "none")
- (parameters
- '("gint*" "requisition")
- )
-)
-
-(define-method toggle_size_allocate
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_toggle_size_allocate")
- (return-type "none")
- (parameters
- '("gint" "allocation")
- )
-)
-
-(define-method set_right_justified
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_set_right_justified")
- (return-type "none")
- (parameters
- '("gboolean" "right_justified")
- )
-)
-
-(define-method get_right_justified
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_get_right_justified")
- (return-type "gboolean")
-)
-
-(define-method set_accel_path
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_set_accel_path")
- (return-type "none")
- (parameters
- '("const-gchar*" "accel_path")
- )
-)
-
-(define-method right_justify
- (of-object "GtkMenuItem")
- (c-name "gtk_menu_item_right_justify")
- (return-type "none")
- (deprecated "use GtkMenuItem.set_right_justified")
-)
-
-(define-virtual activate
- (of-object "GtkMenuItem")
- (return-type "none")
-)
-(define-virtual activate_item
- (of-object "GtkMenuItem")
- (return-type "none")
-)
-(define-virtual toggle_size_request
- (of-object "GtkMenuItem")
- (return-type "none")
- (parameters
- '("gint*" "requisition" (direction "out"))
- )
-)
-(define-virtual toggle_size_allocate
- (of-object "GtkMenuItem")
- (return-type "none")
- (parameters
- '("gint" "allocation")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkmenushell.h
-
-(define-function gtk_menu_shell_get_type
- (c-name "gtk_menu_shell_get_type")
- (return-type "GType")
-)
-
-(define-method append
- (of-object "GtkMenuShell")
- (c-name "gtk_menu_shell_append")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method prepend
- (of-object "GtkMenuShell")
- (c-name "gtk_menu_shell_prepend")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method insert
- (of-object "GtkMenuShell")
- (c-name "gtk_menu_shell_insert")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gint" "position")
- )
-)
-
-(define-method deactivate
- (of-object "GtkMenuShell")
- (c-name "gtk_menu_shell_deactivate")
- (return-type "none")
-)
-
-(define-method select_item
- (of-object "GtkMenuShell")
- (c-name "gtk_menu_shell_select_item")
- (return-type "none")
- (parameters
- '("GtkWidget*" "menu_item")
- )
-)
-
-(define-method deselect
- (of-object "GtkMenuShell")
- (c-name "gtk_menu_shell_deselect")
- (return-type "none")
-)
-
-(define-method activate_item
- (of-object "GtkMenuShell")
- (c-name "gtk_menu_shell_activate_item")
- (return-type "none")
- (parameters
- '("GtkWidget*" "menu_item")
- '("gboolean" "force_deactivate")
- )
-)
-
-(define-method select_first
- (of-object "GtkMenuShell")
- (c-name "gtk_menu_shell_select_first")
- (return-type "none")
- (parameters
- '("gboolean" "search_sensitive")
- )
-)
-
-(define-method cancel
- (of-object "GtkMenuShell")
- (c-name "gtk_menu_shell_cancel")
- (return-type "none")
-)
-(define-virtual deactivate
- (of-object "GtkMenuShell")
- (return-type "none")
-)
-(define-virtual selection_done
- (of-object "GtkMenuShell")
- (return-type "none")
-)
-(define-virtual move_current
- (of-object "GtkMenuShell")
- (return-type "none")
- (parameters
- '("GtkMenuDirectionType" "direction")
- )
-)
-(define-virtual activate_current
- (of-object "GtkMenuShell")
- (return-type "none")
- (parameters
- '("gboolean" "force_hide")
- )
-)
-(define-virtual cancel
- (of-object "GtkMenuShell")
- (return-type "none")
-)
-(define-virtual select_item
- (of-object "GtkMenuShell")
- (return-type "none")
- (parameters
- '("GtkWidget*" "menu_item")
- )
-)
-(define-virtual insert
- (of-object "GtkMenuShell")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gint" "position")
- )
-)
-(define-virtual get_popup_delay
- (of-object "GtkMenuShell")
- (return-type "gint")
-)
-
-(define-method get_take_focus
- (of-object "GtkMenuShell")
- (c-name "gtk_menu_shell_get_take_focus")
- (return-type "gboolean")
-)
-
-(define-method set_take_focus
- (of-object "GtkMenuShell")
- (c-name "gtk_menu_shell_set_take_focus")
- (return-type "none")
- (parameters
- '("gboolean" "take_focus")
- )
-)
-
-
-;; From /opt/gnome-2.10/include/gtk-2.0/gtk/gtkmenutoolbutton.h
-
-(define-function gtk_menu_tool_button_get_type
- (c-name "gtk_menu_tool_button_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_menu_tool_button_new
- (c-name "gtk_menu_tool_button_new")
- (is-constructor-of "GtkMenuToolButton")
- (return-type "GtkToolItem*")
- (parameters
- '("GtkWidget*" "icon_widget")
- '("const-gchar*" "label")
- )
-)
-
-(define-function gtk_menu_tool_button_new_from_stock
- (c-name "gtk_menu_tool_button_new_from_stock")
- (return-type "GtkToolItem*")
- (parameters
- '("const-gchar*" "stock_id")
- )
- (caller-owns-return #t)
-)
-
-(define-method set_menu
- (of-object "GtkMenuToolButton")
- (c-name "gtk_menu_tool_button_set_menu")
- (return-type "none")
- (parameters
- '("GtkWidget*" "menu")
- )
-)
-
-(define-method get_menu
- (of-object "GtkMenuToolButton")
- (c-name "gtk_menu_tool_button_get_menu")
- (return-type "GtkWidget*")
-)
-
-(define-method set_arrow_tooltip
- (of-object "GtkMenuToolButton")
- (c-name "gtk_menu_tool_button_set_arrow_tooltip")
- (return-type "none")
- (parameters
- '("GtkTooltips*" "tooltips")
- '("const-gchar*" "tip_text" (null-ok))
- '("const-gchar*" "tip_private" (null-ok) (default "NULL"))
- )
-)
-
-(define-virtual show_menu
- (of-object "GtkMenuToolButton")
- (return-type "none")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkmessagedialog.h
-
-(define-function gtk_message_dialog_get_type
- (c-name "gtk_message_dialog_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_message_dialog_new
- (c-name "gtk_message_dialog_new")
- (is-constructor-of "GtkMessageDialog")
- (return-type "GtkWidget*")
- (parameters
- '("GtkWindow*" "parent" (null-ok) (default "NULL"))
- '("GtkDialogFlags" "flags" (default "0"))
- '("GtkMessageType" "type" (default "GTK_MESSAGE_INFO"))
- '("GtkButtonsType" "buttons" (default "GTK_BUTTONS_NONE"))
- '("const-gchar*" "message_format" (null-ok) (default "NULL"))
- )
- (varargs #t)
-)
-
-(define-function message_dialog_new_with_markup
- (c-name "gtk_message_dialog_new_with_markup")
- (is-constructor-of "GtkMessageDialog")
- (return-type "GtkWidget*")
- (parameters
- '("GtkWindow*" "parent")
- '("GtkDialogFlags" "flags")
- '("GtkMessageType" "type")
- '("GtkButtonsType" "buttons")
- '("const-gchar*" "message_format")
- )
- (varargs #t)
-)
-
-(define-method set_markup
- (of-object "GtkMessageDialog")
- (c-name "gtk_message_dialog_set_markup")
- (return-type "none")
- (parameters
- '("const-gchar*" "str")
- )
-)
-
-
-(define-method format_secondary_text
- (of-object "GtkMessageDialog")
- (c-name "gtk_message_dialog_format_secondary_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "message_format")
- )
- (varargs #t)
-)
-
-(define-method format_secondary_markup
- (of-object "GtkMessageDialog")
- (c-name "gtk_message_dialog_format_secondary_markup")
- (return-type "none")
- (parameters
- '("const-gchar*" "message_format")
- )
- (varargs #t)
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkmisc.h
-
-(define-function gtk_misc_get_type
- (c-name "gtk_misc_get_type")
- (return-type "GType")
-)
-
-(define-method set_alignment
- (of-object "GtkMisc")
- (c-name "gtk_misc_set_alignment")
- (return-type "none")
- (parameters
- '("gfloat" "xalign")
- '("gfloat" "yalign")
- )
-)
-
-(define-method get_alignment
- (of-object "GtkMisc")
- (c-name "gtk_misc_get_alignment")
- (return-type "none")
- (parameters
- '("gfloat*" "xalign")
- '("gfloat*" "yalign")
- )
-)
-
-(define-method set_padding
- (of-object "GtkMisc")
- (c-name "gtk_misc_set_padding")
- (return-type "none")
- (parameters
- '("gint" "xpad")
- '("gint" "ypad")
- )
-)
-
-(define-method get_padding
- (of-object "GtkMisc")
- (c-name "gtk_misc_get_padding")
- (return-type "none")
- (parameters
- '("gint*" "xpad")
- '("gint*" "ypad")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtknotebook.h
-
-(define-function gtk_notebook_get_type
- (c-name "gtk_notebook_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_notebook_new
- (c-name "gtk_notebook_new")
- (is-constructor-of "GtkNotebook")
- (return-type "GtkWidget*")
-)
-
-(define-method append_page
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_append_page")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "child")
- '("GtkWidget*" "tab_label" (null-ok) (default "NULL"))
- )
-)
-
-(define-method append_page_menu
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_append_page_menu")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "child")
- '("GtkWidget*" "tab_label" (null-ok) (default "NULL"))
- '("GtkWidget*" "menu_label" (null-ok) (default "NULL"))
- )
-)
-
-(define-method prepend_page
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_prepend_page")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "child")
- '("GtkWidget*" "tab_label" (null-ok) (default "NULL"))
- )
-)
-
-(define-method prepend_page_menu
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_prepend_page_menu")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "child")
- '("GtkWidget*" "tab_label" (null-ok) (default "NULL"))
- '("GtkWidget*" "menu_label" (null-ok) (default "NULL"))
- )
-)
-
-(define-method insert_page
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_insert_page")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "child")
- '("GtkWidget*" "tab_label" (null-ok) (default "NULL"))
- '("gint" "position" (default "-1"))
- )
-)
-
-(define-method insert_page_menu
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_insert_page_menu")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "child")
- '("GtkWidget*" "tab_label" (null-ok) (default "NULL"))
- '("GtkWidget*" "menu_label" (null-ok) (default "NULL"))
- '("gint" "position" (default "-1"))
- )
-)
-
-(define-method remove_page
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_remove_page")
- (return-type "none")
- (parameters
- '("gint" "page_num")
- )
-)
-
-(define-method get_current_page
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_current_page")
- (return-type "gint")
-)
-
-(define-method get_nth_page
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_nth_page")
- (return-type "GtkWidget*")
- (parameters
- '("gint" "page_num")
- )
-)
-
-(define-method get_n_pages
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_n_pages")
- (return-type "gint")
-)
-
-(define-method page_num
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_page_num")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method set_current_page
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_current_page")
- (return-type "none")
- (parameters
- '("gint" "page_num")
- )
-)
-
-(define-method next_page
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_next_page")
- (return-type "none")
-)
-
-(define-method prev_page
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_prev_page")
- (return-type "none")
-)
-
-(define-method set_show_border
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_show_border")
- (return-type "none")
- (parameters
- '("gboolean" "show_border")
- )
-)
-
-(define-method get_show_border
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_show_border")
- (return-type "gboolean")
-)
-
-(define-method set_show_tabs
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_show_tabs")
- (return-type "none")
- (parameters
- '("gboolean" "show_tabs")
- )
-)
-
-(define-method get_show_tabs
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_show_tabs")
- (return-type "gboolean")
-)
-
-(define-method set_tab_pos
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_tab_pos")
- (return-type "none")
- (parameters
- '("GtkPositionType" "pos")
- )
-)
-
-(define-method get_tab_pos
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_tab_pos")
- (return-type "GtkPositionType")
-)
-
-(define-method set_homogeneous_tabs
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_homogeneous_tabs")
- (return-type "none")
- (parameters
- '("gboolean" "homogeneous")
- )
- (deprecated "")
-)
-
-(define-method set_tab_border
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_tab_border")
- (return-type "none")
- (parameters
- '("guint" "border_width")
- )
- (deprecated "")
-)
-
-(define-method set_tab_hborder
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_tab_hborder")
- (return-type "none")
- (parameters
- '("guint" "tab_hborder")
- )
- (deprecated "")
-)
-
-(define-method set_tab_vborder
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_tab_vborder")
- (return-type "none")
- (parameters
- '("guint" "tab_vborder")
- )
- (deprecated "")
-)
-
-(define-method set_scrollable
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_scrollable")
- (return-type "none")
- (parameters
- '("gboolean" "scrollable")
- )
-)
-
-(define-method get_scrollable
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_scrollable")
- (return-type "gboolean")
-)
-
-(define-method popup_enable
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_popup_enable")
- (return-type "none")
-)
-
-(define-method popup_disable
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_popup_disable")
- (return-type "none")
-)
-
-(define-method get_tab_label
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_tab_label")
- (return-type "GtkWidget*")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method set_tab_label
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_tab_label")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("GtkWidget*" "tab_label" (null-ok) (default "NULL"))
- )
-)
-
-(define-method set_tab_label_text
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_tab_label_text")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("const-gchar*" "tab_text")
- )
-)
-
-(define-method get_tab_label_text
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_tab_label_text")
- (return-type "const-gchar*")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method get_menu_label
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_menu_label")
- (return-type "GtkWidget*")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method set_menu_label
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_menu_label")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("GtkWidget*" "menu_label" (null-ok) (default "NULL"))
- )
-)
-
-(define-method set_menu_label_text
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_menu_label_text")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("const-gchar*" "menu_text")
- )
-)
-
-(define-method get_menu_label_text
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_get_menu_label_text")
- (return-type "const-gchar*")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method query_tab_label_packing
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_query_tab_label_packing")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gboolean*" "expand")
- '("gboolean*" "fill")
- '("GtkPackType*" "pack_type")
- )
-)
-
-(define-method set_tab_label_packing
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_tab_label_packing")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gboolean" "expand")
- '("gboolean" "fill")
- '("GtkPackType" "pack_type")
- )
-)
-
-(define-method reorder_child
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_reorder_child")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gint" "position")
- )
-)
-
-(define-method current_page
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_current_page")
- (return-type "gint")
- (deprecated "use GtkNotebook.get_current_page")
-)
-
-(define-method set_page
- (of-object "GtkNotebook")
- (c-name "gtk_notebook_set_page")
- (return-type "none")
- (parameters
- '("gint" "page_num")
- )
- (deprecated "use GtkNotebook.set_current_page")
-)
-
-
-(define-virtual switch_page
- (of-object "GtkNotebook")
- (return-type "none")
- (parameters
- '("GtkNotebookPage*" "page")
- '("guint" "page_num")
- )
-)
-(define-virtual select_page
- (of-object "GtkNotebook")
- (return-type "gboolean")
- (parameters
- '("gboolean" "move_focus")
- )
-)
-(define-virtual focus_tab
- (of-object "GtkNotebook")
- (return-type "gboolean")
- (parameters
- '("GtkNotebookTab" "type")
- )
-)
-(define-virtual change_current_page
- (of-object "GtkNotebook")
- (return-type "none")
- (parameters
- '("gint" "offset")
- )
-)
-(define-virtual move_focus_out
- (of-object "GtkNotebook")
- (return-type "none")
- (parameters
- '("GtkDirectionType" "direction")
- )
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkobject.h
-
-(define-function gtk_object_get_type
- (c-name "gtk_object_get_type")
- (return-type "GType")
-)
-
-(define-function object_new
- (c-name "gtk_object_new")
- (return-type "GtkObject*")
- (parameters
- '("GType" "type")
- '("const-gchar*" "first_property_name")
- )
- (varargs #t)
-)
-
-(define-method sink
- (of-object "GtkObject")
- (c-name "gtk_object_sink")
- (return-type "none")
-)
-
-(define-method destroy
- (of-object "GtkObject")
- (c-name "gtk_object_destroy")
- (return-type "none")
-)
-
-(define-virtual set_arg
- (of-object "GtkObject")
- (return-type "none")
- (parameters
- '("GtkArg*" "arg")
- '("guint" "arg_id")
- )
-)
-(define-virtual get_arg
- (of-object "GtkObject")
- (return-type "none")
- (parameters
- '("GtkArg*" "arg")
- '("guint" "arg_id")
- )
-)
-(define-virtual destroy
- (of-object "GtkObject")
- (return-type "none")
-)
-
-(define-method ref
- (of-object "GtkObject")
- (c-name "gtk_object_ref")
- (return-type "GtkObject*")
-)
-
-(define-method unref
- (of-object "GtkObject")
- (c-name "gtk_object_unref")
- (return-type "none")
-)
-
-(define-method weakref
- (of-object "GtkObject")
- (c-name "gtk_object_weakref")
- (return-type "none")
- (parameters
- '("GtkDestroyNotify" "notify")
- '("gpointer" "data")
- )
-)
-
-(define-method weakunref
- (of-object "GtkObject")
- (c-name "gtk_object_weakunref")
- (return-type "none")
- (parameters
- '("GtkDestroyNotify" "notify")
- '("gpointer" "data")
- )
-)
-
-(define-method set_data
- (of-object "GtkObject")
- (c-name "gtk_object_set_data")
- (return-type "none")
- (parameters
- '("const-gchar*" "key")
- '("gpointer" "data")
- )
-)
-
-(define-method set_data_full
- (of-object "GtkObject")
- (c-name "gtk_object_set_data_full")
- (return-type "none")
- (parameters
- '("const-gchar*" "key")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method remove_data
- (of-object "GtkObject")
- (c-name "gtk_object_remove_data")
- (return-type "none")
- (parameters
- '("const-gchar*" "key")
- )
-)
-
-(define-method get_data
- (of-object "GtkObject")
- (c-name "gtk_object_get_data")
- (return-type "gpointer")
- (parameters
- '("const-gchar*" "key")
- )
-)
-
-(define-method remove_no_notify
- (of-object "GtkObject")
- (c-name "gtk_object_remove_no_notify")
- (return-type "none")
- (parameters
- '("const-gchar*" "key")
- )
-)
-(define-method set_user_data
- (of-object "GtkObject")
- (c-name "gtk_object_set_user_data")
- (return-type "none")
- (parameters
- '("gpointer" "data")
- )
-)
-
-(define-method get_user_data
- (of-object "GtkObject")
- (c-name "gtk_object_get_user_data")
- (return-type "gpointer")
-)
-
-(define-method set_data_by_id
- (of-object "GtkObject")
- (c-name "gtk_object_set_data_by_id")
- (return-type "none")
- (parameters
- '("GQuark" "data_id")
- '("gpointer" "data")
- )
-)
-
-(define-method set_data_by_id_full
- (of-object "GtkObject")
- (c-name "gtk_object_set_data_by_id_full")
- (return-type "none")
- (parameters
- '("GQuark" "data_id")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method get_data_by_id
- (of-object "GtkObject")
- (c-name "gtk_object_get_data_by_id")
- (return-type "gpointer")
- (parameters
- '("GQuark" "data_id")
- )
-)
-
-(define-method remove_data_by_id
- (of-object "GtkObject")
- (c-name "gtk_object_remove_data_by_id")
- (return-type "none")
- (parameters
- '("GQuark" "data_id")
- )
-)
-
-(define-method remove_no_notify_by_id
- (of-object "GtkObject")
- (c-name "gtk_object_remove_no_notify_by_id")
- (return-type "none")
- (parameters
- '("GQuark" "key_id")
- )
-)
-
-(define-method get
- (of-object "GtkObject")
- (c-name "gtk_object_get")
- (return-type "none")
- (parameters
- '("const-gchar*" "first_property_name")
- )
- (varargs #t)
-)
-
-(define-method set
- (of-object "GtkObject")
- (c-name "gtk_object_set")
- (return-type "none")
- (parameters
- '("const-gchar*" "first_property_name")
- )
- (varargs #t)
-)
-
-(define-function object_add_arg_type
- (c-name "gtk_object_add_arg_type")
- (return-type "none")
- (parameters
- '("const-gchar*" "arg_name")
- '("GtkType" "arg_type")
- '("guint" "arg_flags")
- '("guint" "arg_id")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkoldeditable.h
-
-(define-function gtk_old_editable_get_type
- (c-name "gtk_old_editable_get_type")
- (return-type "GType")
-)
-
-(define-method claim_selection
- (of-object "GtkOldEditable")
- (c-name "gtk_old_editable_claim_selection")
- (return-type "none")
- (parameters
- '("gboolean" "claim")
- '("guint32" "time" (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method changed
- (of-object "GtkOldEditable")
- (c-name "gtk_old_editable_changed")
- (return-type "none")
-)
-
-(define-virtual activate
- (of-object "GtkOldEditable")
- (return-type "none")
-)
-
-(define-virtual set_editable
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gboolean" "is_editable")
- )
-)
-
-(define-virtual move_cursor
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-virtual move_word
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gint" "n")
- )
-)
-
-(define-virtual move_page
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-virtual move_to_row
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-virtual move_to_column
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gint" "row")
- )
-)
-
-(define-virtual kill_char
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gint" "direction")
- )
-)
-
-(define-virtual kill_word
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gint" "direction")
- )
-)
-
-(define-virtual kill_line
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gint" "direction")
- )
-)
-
-(define-virtual cut_clipboard
- (of-object "GtkOldEditable")
- (return-type "none")
-)
-
-(define-virtual copy_clipboard
- (of-object "GtkOldEditable")
- (return-type "none")
-)
-
-(define-virtual paste_clipboard
- (of-object "GtkOldEditable")
- (return-type "none")
-)
-
-(define-virtual update_text
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-
-(define-virtual get_chars
- (of-object "GtkOldEditable")
- (return-type "gchar*")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-
-(define-virtual set_selection
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gint" "start_pos")
- '("gint" "end_pos")
- )
-)
-
-(define-virtual set_position
- (of-object "GtkOldEditable")
- (return-type "none")
- (parameters
- '("gint" "position")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkoptionmenu.h
-
-(define-function gtk_option_menu_get_type
- (c-name "gtk_option_menu_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_option_menu_new
- (c-name "gtk_option_menu_new")
- (is-constructor-of "GtkOptionMenu")
- (return-type "GtkWidget*")
- (deprecated "use gtk.ComboBox")
-)
-
-(define-method get_menu
- (of-object "GtkOptionMenu")
- (c-name "gtk_option_menu_get_menu")
- (return-type "GtkWidget*")
-)
-
-(define-method set_menu
- (of-object "GtkOptionMenu")
- (c-name "gtk_option_menu_set_menu")
- (return-type "none")
- (parameters
- '("GtkWidget*" "menu")
- )
-)
-
-(define-method remove_menu
- (of-object "GtkOptionMenu")
- (c-name "gtk_option_menu_remove_menu")
- (return-type "none")
-)
-
-(define-method get_history
- (of-object "GtkOptionMenu")
- (c-name "gtk_option_menu_get_history")
- (return-type "gint")
-)
-
-(define-method set_history
- (of-object "GtkOptionMenu")
- (c-name "gtk_option_menu_set_history")
- (return-type "none")
- (parameters
- '("guint" "index")
- )
-)
-
-(define-virtual changed
- (of-object "GtkOptionMenu")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkpaned.h
-
-(define-function gtk_paned_get_type
- (c-name "gtk_paned_get_type")
- (return-type "GType")
-)
-
-(define-method add1
- (of-object "GtkPaned")
- (c-name "gtk_paned_add1")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method add2
- (of-object "GtkPaned")
- (c-name "gtk_paned_add2")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method pack1
- (of-object "GtkPaned")
- (c-name "gtk_paned_pack1")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gboolean" "resize" (default "FALSE"))
- '("gboolean" "shrink" (default "TRUE"))
- )
-)
-
-(define-method pack2
- (of-object "GtkPaned")
- (c-name "gtk_paned_pack2")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gboolean" "resize" (default "TRUE"))
- '("gboolean" "shrink" (default "TRUE"))
- )
-)
-
-(define-method get_position
- (of-object "GtkPaned")
- (c-name "gtk_paned_get_position")
- (return-type "gint")
-)
-
-(define-method set_position
- (of-object "GtkPaned")
- (c-name "gtk_paned_set_position")
- (return-type "none")
- (parameters
- '("gint" "position")
- )
-)
-
-(define-method get_child1
- (of-object "GtkPaned")
- (c-name "gtk_paned_get_child1")
- (return-type "GtkWidget*")
-)
-
-(define-method get_child2
- (of-object "GtkPaned")
- (c-name "gtk_paned_get_child2")
- (return-type "GtkWidget*")
-)
-
-(define-method compute_position
- (of-object "GtkPaned")
- (c-name "gtk_paned_compute_position")
- (return-type "none")
- (parameters
- '("gint" "allocation")
- '("gint" "child1_req")
- '("gint" "child2_req")
- )
-)
-
-(define-virtual cycle_child_focus
- (of-object "GtkPaned")
- (return-type "gboolean")
- (parameters
- '("gboolean" "reverse")
- )
-)
-(define-virtual toggle_handle_focus
- (of-object "GtkPaned")
- (return-type "gboolean")
-)
-(define-virtual move_handle
- (of-object "GtkPaned")
- (return-type "gboolean")
- (parameters
- '("GtkScrollType" "scroll")
- )
-)
-(define-virtual cycle_handle_focus
- (of-object "GtkPaned")
- (return-type "gboolean")
- (parameters
- '("gboolean" "reverse")
- )
-)
-(define-virtual accept_position
- (of-object "GtkPaned")
- (return-type "gboolean")
-)
-(define-virtual cancel_position
- (of-object "GtkPaned")
- (return-type "gboolean")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkpixmap.h
-
-(define-function gtk_pixmap_get_type
- (c-name "gtk_pixmap_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_pixmap_new
- (c-name "gtk_pixmap_new")
- (is-constructor-of "GtkPixmap")
- (return-type "GtkWidget*")
- (parameters
- '("GdkPixmap*" "pixmap")
- '("GdkBitmap*" "mask" (null-ok))
- )
- (deprecated "use GtkImage")
-)
-
-(define-method set
- (of-object "GtkPixmap")
- (c-name "gtk_pixmap_set")
- (return-type "none")
- (parameters
- '("GdkPixmap*" "val")
- '("GdkBitmap*" "mask" (null-ok))
- )
-)
-
-(define-method get
- (of-object "GtkPixmap")
- (c-name "gtk_pixmap_get")
- (return-type "none")
- (parameters
- '("GdkPixmap**" "val")
- '("GdkBitmap**" "mask")
- )
-)
-
-(define-method set_build_insensitive
- (of-object "GtkPixmap")
- (c-name "gtk_pixmap_set_build_insensitive")
- (return-type "none")
- (parameters
- '("gboolean" "build")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkplug.h
-
-(define-function gtk_plug_get_type
- (c-name "gtk_plug_get_type")
- (return-type "GType")
-)
-
-(define-method construct
- (of-object "GtkPlug")
- (c-name "gtk_plug_construct")
- (return-type "none")
- (parameters
- '("GdkNativeWindow" "socket_id")
- )
-)
-
-(define-function gtk_plug_new
- (c-name "gtk_plug_new")
- (is-constructor-of "GtkPlug")
- (return-type "GtkWidget*")
- (parameters
- '("GdkNativeWindow" "socket_id")
- )
-)
-
-(define-method construct_for_display
- (of-object "GtkPlug")
- (c-name "gtk_plug_construct_for_display")
- (return-type "none")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkNativeWindow" "socket_id")
- )
-)
-
-(define-function plug_new_for_display
- (c-name "gtk_plug_new_for_display")
- (return-type "GtkWidget*")
- (parameters
- '("GdkDisplay*" "display")
- '("GdkNativeWindow" "socket_id")
- )
- (deprecated "use gtk.Plug(socket_id, display)")
-)
-
-(define-method get_id
- (of-object "GtkPlug")
- (c-name "gtk_plug_get_id")
- (return-type "GdkNativeWindow")
-)
-
-(define-virtual embedded
- (of-object "GtkPlug")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkpreview.h
-
-(define-function gtk_preview_get_type
- (c-name "gtk_preview_get_type")
- (return-type "GType")
-)
-
-(define-function preview_uninit
- (c-name "gtk_preview_uninit")
- (return-type "none")
- (deprecated "use GtkPixbuf")
-)
-
-(define-function gtk_preview_new
- (c-name "gtk_preview_new")
- (is-constructor-of "GtkPreview")
- (return-type "GtkWidget*")
- (parameters
- '("GtkPreviewType" "type")
- )
- (deprecated "use GtkDrawingArea")
-)
-
-(define-method size
- (of-object "GtkPreview")
- (c-name "gtk_preview_size")
- (return-type "none")
- (parameters
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method put
- (of-object "GtkPreview")
- (c-name "gtk_preview_put")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GdkGC*" "gc")
- '("gint" "srcx")
- '("gint" "srcy")
- '("gint" "destx")
- '("gint" "desty")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method draw_row
- (of-object "GtkPreview")
- (c-name "gtk_preview_draw_row")
- (return-type "none")
- (parameters
- '("guchar*" "data")
- '("gint" "x")
- '("gint" "y")
- '("gint" "w")
- )
-)
-
-(define-method set_expand
- (of-object "GtkPreview")
- (c-name "gtk_preview_set_expand")
- (return-type "none")
- (parameters
- '("gboolean" "expand")
- )
-)
-
-(define-function preview_set_gamma
- (c-name "gtk_preview_set_gamma")
- (return-type "none")
- (parameters
- '("double" "gamma")
- )
- (deprecated "use GtkPixbuf")
-)
-
-(define-function preview_set_color_cube
- (c-name "gtk_preview_set_color_cube")
- (return-type "none")
- (parameters
- '("guint" "nred_shades")
- '("guint" "ngreen_shades")
- '("guint" "nblue_shades")
- '("guint" "ngray_shades")
- )
- (deprecated "use GtkPixbuf")
-)
-
-(define-function preview_set_install_cmap
- (c-name "gtk_preview_set_install_cmap")
- (return-type "none")
- (parameters
- '("gint" "install_cmap")
- )
- (deprecated "use GtkPixbuf")
-)
-
-(define-function preview_set_reserved
- (c-name "gtk_preview_set_reserved")
- (return-type "none")
- (parameters
- '("gint" "nreserved")
- )
- (deprecated "use GtkPixbuf")
-)
-
-(define-method set_dither
- (of-object "GtkPreview")
- (c-name "gtk_preview_set_dither")
- (return-type "none")
- (parameters
- '("GdkRgbDither" "dither")
- )
- (deprecated "use GtkPixbuf")
-)
-
-(define-function preview_get_visual
- (c-name "gtk_preview_get_visual")
- (return-type "GdkVisual*")
- (deprecated "use GtkPixbuf")
-)
-
-(define-function preview_get_cmap
- (c-name "gtk_preview_get_cmap")
- (return-type "GdkColormap*")
- (deprecated "use GtkPixbuf")
-)
-
-(define-function preview_get_info
- (c-name "gtk_preview_get_info")
- (return-type "GtkPreviewInfo*")
- (deprecated "use GtkPixbuf")
-)
-
-(define-function preview_reset
- (c-name "gtk_preview_reset")
- (return-type "none")
- (deprecated "use GtkPixbuf")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkprivate.h
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkprogress.h
-
-(define-function gtk_progress_get_type
- (c-name "gtk_progress_get_type")
- (return-type "GType")
-)
-
-(define-method set_show_text
- (of-object "GtkProgress")
- (c-name "gtk_progress_set_show_text")
- (return-type "none")
- (parameters
- '("gboolean" "show_text")
- )
- (deprecated "gtk.Progress.set_show_text is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method set_text_alignment
- (of-object "GtkProgress")
- (c-name "gtk_progress_set_text_alignment")
- (return-type "none")
- (parameters
- '("gfloat" "x_align")
- '("gfloat" "y_align")
- )
- (deprecated "gtk.Progress.set_text_alignment is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method set_format_string
- (of-object "GtkProgress")
- (c-name "gtk_progress_set_format_string")
- (return-type "none")
- (parameters
- '("const-gchar*" "format")
- )
- (deprecated "gtk.Progress.set_format_string is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method set_adjustment
- (of-object "GtkProgress")
- (c-name "gtk_progress_set_adjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment")
- )
- (deprecated "gtk.Progress.set_adjustment is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method configure
- (of-object "GtkProgress")
- (c-name "gtk_progress_configure")
- (return-type "none")
- (parameters
- '("gdouble" "value")
- '("gdouble" "min")
- '("gdouble" "max")
- )
- (deprecated "gtk.Progress.configure is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method set_percentage
- (of-object "GtkProgress")
- (c-name "gtk_progress_set_percentage")
- (return-type "none")
- (parameters
- '("gdouble" "percentage")
- )
- (deprecated "gtk.Progress.set_percentage is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method set_value
- (of-object "GtkProgress")
- (c-name "gtk_progress_set_value")
- (return-type "none")
- (parameters
- '("gdouble" "value")
- )
- (deprecated "gtk.Progress.set_value is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method get_value
- (of-object "GtkProgress")
- (c-name "gtk_progress_get_value")
- (return-type "gdouble")
- (deprecated "gtk.Progress.get_value is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method set_activity_mode
- (of-object "GtkProgress")
- (c-name "gtk_progress_set_activity_mode")
- (return-type "none")
- (parameters
- '("gboolean" "activity_mode")
- )
- (deprecated "gtk.Progress.set_activity_mode is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method get_current_text
- (of-object "GtkProgress")
- (c-name "gtk_progress_get_current_text")
- (return-type "gchar*")
- (deprecated "gtk.Progress.get_current_text is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method get_text_from_value
- (of-object "GtkProgress")
- (c-name "gtk_progress_get_text_from_value")
- (return-type "gchar*")
- (parameters
- '("gdouble" "value")
- )
- (deprecated "gtk.Progress.get_text_from_value is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method get_current_percentage
- (of-object "GtkProgress")
- (c-name "gtk_progress_get_current_percentage")
- (return-type "gdouble")
- (deprecated "gtk.Progress.get_current_percentage is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-method get_percentage_from_value
- (of-object "GtkProgress")
- (c-name "gtk_progress_get_percentage_from_value")
- (return-type "gdouble")
- (parameters
- '("gdouble" "value")
- )
- (deprecated "gtk.Progress.get_percentage_from_value is deprecated, use gtk.ProgressBar methods")
-)
-
-(define-virtual paint
- (of-object "GtkProgress")
- (return-type "none")
-)
-(define-virtual update
- (of-object "GtkProgress")
- (return-type "none")
-)
-(define-virtual act_mode_enter
- (of-object "GtkProgress")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkprogressbar.h
-
-(define-function gtk_progress_bar_get_type
- (c-name "gtk_progress_bar_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_progress_bar_new
- (c-name "gtk_progress_bar_new")
- (is-constructor-of "GtkProgressBar")
- (return-type "GtkWidget*")
-)
-
-(define-method pulse
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_pulse")
- (return-type "none")
-)
-
-(define-method set_text
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_set_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- )
-)
-
-(define-method set_fraction
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_set_fraction")
- (return-type "none")
- (parameters
- '("gdouble" "fraction")
- )
-)
-
-(define-method set_pulse_step
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_set_pulse_step")
- (return-type "none")
- (parameters
- '("gdouble" "fraction")
- )
-)
-
-(define-method set_orientation
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_set_orientation")
- (return-type "none")
- (parameters
- '("GtkProgressBarOrientation" "orientation")
- )
-)
-
-(define-method get_text
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_get_text")
- (return-type "const-gchar*")
-)
-
-(define-method get_fraction
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_get_fraction")
- (return-type "gdouble")
-)
-
-(define-method get_pulse_step
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_get_pulse_step")
- (return-type "gdouble")
-)
-
-(define-method get_orientation
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_get_orientation")
- (return-type "GtkProgressBarOrientation")
-)
-
-(define-function gtk_progress_bar_new_with_adjustment
- (c-name "gtk_progress_bar_new_with_adjustment")
- (is-constructor-of "GtkProgressBar")
- (return-type "GtkWidget*")
- (parameters
- '("GtkAdjustment*" "adjustment" (null-ok) (default "NULL"))
- )
- (deprecated "")
-)
-
-(define-method set_bar_style
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_set_bar_style")
- (return-type "none")
- (parameters
- '("GtkProgressBarStyle" "style")
- )
- (deprecated "")
-)
-
-(define-method set_discrete_blocks
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_set_discrete_blocks")
- (return-type "none")
- (parameters
- '("guint" "blocks")
- )
- (deprecated "")
-)
-
-(define-method set_activity_step
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_set_activity_step")
- (return-type "none")
- (parameters
- '("guint" "step")
- )
- (deprecated "")
-)
-
-(define-method set_activity_blocks
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_set_activity_blocks")
- (return-type "none")
- (parameters
- '("guint" "blocks")
- )
- (deprecated "")
-)
-
-(define-method update
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_update")
- (return-type "none")
- (parameters
- '("gfloat" "percentage")
- )
- (deprecated "")
-)
-
-(define-method set_ellipsize
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_set_ellipsize")
- (return-type "none")
- (parameters
- '("PangoEllipsizeMode" "mode")
- )
-)
-
-(define-method get_ellipsize
- (of-object "GtkProgressBar")
- (c-name "gtk_progress_bar_get_ellipsize")
- (return-type "PangoEllipsizeMode")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkradioaction.h
-
-(define-function gtk_radio_action_get_type
- (c-name "gtk_radio_action_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_radio_action_new
- (c-name "gtk_radio_action_new")
- (is-constructor-of "GtkRadioAction")
- (return-type "GtkRadioAction*")
- (properties
- '("name")
- '("label")
- '("tooltip")
- '("stock_id")
- '("value")
- )
-)
-
-(define-method set_group
- (of-object "GtkRadioAction")
- (c-name "gtk_radio_action_set_group")
- (return-type "none")
- (parameters
- '("GSList*" "group")
- )
-)
-
-(define-method get_group
- (of-object "GtkRadioAction")
- (c-name "gtk_radio_action_get_group")
- (return-type "GSList*")
-)
-
-(define-method get_current_value
- (of-object "GtkRadioAction")
- (c-name "gtk_radio_action_get_current_value")
- (return-type "gint")
-)
-
-(define-virtual changed
- (of-object "GtkRadioAction")
- (return-type "none")
- (parameters
- '("GtkRadioAction*" "current")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkradiobutton.h
-
-(define-function gtk_radio_button_get_type
- (c-name "gtk_radio_button_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_radio_button_new
- (c-name "gtk_radio_button_new")
- (is-constructor-of "GtkRadioButton")
- (return-type "GtkWidget*")
- (parameters
- '("GSList*" "group")
- )
-)
-
-(define-function radio_button_new_from_widget
- (is-constructor-of "GtkRadioButton")
- (c-name "gtk_radio_button_new_from_widget")
- (return-type "GtkWidget*")
- (parameters
- '("GtkRadioButton*" "group")
- )
-)
-
-(define-function radio_button_new_with_label
- (c-name "gtk_radio_button_new_with_label")
- (is-constructor-of "GtkRadioButton")
- (return-type "GtkWidget*")
- (parameters
- '("GSList*" "group")
- '("const-gchar*" "label")
- )
-)
-
-(define-function radio_button_new_with_label_from_widget
- (c-name "gtk_radio_button_new_with_label_from_widget")
- (is-constructor-of "GtkRadioButton")
- (return-type "GtkWidget*")
- (parameters
- '("GtkRadioButton" "*group")
- '("const-gchar*" "label")
- )
-)
-
-(define-function radio_button_new_with_mnemonic
- (c-name "gtk_radio_button_new_with_mnemonic")
- (is-constructor-of "GtkRadioButton")
- (return-type "GtkWidget*")
- (parameters
- '("GSList*" "group")
- '("const-gchar*" "label")
- )
-)
-
-(define-function radio_button_new_with_mnemonic_from_widget
- (c-name "gtk_radio_button_new_with_mnemonic_from_widget")
- (is-constructor-of "GtkRadioButton")
- (return-type "GtkWidget*")
- (parameters
- '("GtkRadioButton" "*group")
- '("const-gchar*" "label")
- )
-)
-
-(define-method get_group
- (of-object "GtkRadioButton")
- (c-name "gtk_radio_button_get_group")
- (return-type "GSList*")
-)
-
-(define-method set_group
- (of-object "GtkRadioButton")
- (c-name "gtk_radio_button_set_group")
- (return-type "none")
- (parameters
- '("GSList*" "group")
- )
-)
-
-(define-method group
- (of-object "GtkRadioButton")
- (c-name "gtk_radio_button_group")
- (return-type "GSList*")
- (deprecated "use GtkRadioButton.get_group")
-)
-
-(define-virtual group_changed
- (of-object "GtkRadioButton")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkradiomenuitem.h
-
-(define-function gtk_radio_menu_item_get_type
- (c-name "gtk_radio_menu_item_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_radio_menu_item_new
- (c-name "gtk_radio_menu_item_new")
- (is-constructor-of "GtkRadioMenuItem")
- (return-type "GtkWidget*")
- (parameters
- '("GSList*" "group")
- )
-)
-
-(define-function gtk_radio_menu_item_new_with_label
- (c-name "gtk_radio_menu_item_new_with_label")
- (is-constructor-of "GtkRadioMenuItem")
- (return-type "GtkWidget*")
- (parameters
- '("GSList*" "group")
- '("const-gchar*" "label")
- )
-)
-
-(define-function gtk_radio_menu_item_new_with_mnemonic
- (c-name "gtk_radio_menu_item_new_with_mnemonic")
- (is-constructor-of "GtkRadioMenuItem")
- (return-type "GtkWidget*")
- (parameters
- '("GSList*" "group")
- '("const-gchar*" "label")
- )
-)
-
-(define-method new_from_widget
- (of-object "GtkRadioMenuItem")
- (c-name "gtk_radio_menu_item_new_from_widget")
- (caller-owns-return #t)
- (return-type "GtkWidget*")
-)
-
-(define-method new_with_mnemonic_from_widget
- (of-object "GtkRadioMenuItem")
- (c-name "gtk_radio_menu_item_new_with_mnemonic_from_widget")
- (return-type "GtkWidget*")
- (caller-owns-return #t)
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-method new_with_label_from_widget
- (of-object "GtkRadioMenuItem")
- (c-name "gtk_radio_menu_item_new_with_label_from_widget")
- (return-type "GtkWidget*")
- (caller-owns-return #t)
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-method get_group
- (of-object "GtkRadioMenuItem")
- (c-name "gtk_radio_menu_item_get_group")
- (return-type "GSList*")
-)
-
-(define-method set_group
- (of-object "GtkRadioMenuItem")
- (c-name "gtk_radio_menu_item_set_group")
- (return-type "none")
- (parameters
- '("GSList*" "group")
- )
-)
-
-(define-method group
- (of-object "GtkRadioMenuItem")
- (c-name "gtk_radio_menu_item_group")
- (return-type "GSList*")
- (deprecated "use GtkRadioMenuItem.get_group")
-)
-
-(define-virtual group_changed
- (of-object "GtkRadioMenuItem")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkradiotoolbutton.h
-
-(define-function gtk_radio_tool_button_get_type
- (c-name "gtk_radio_tool_button_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_radio_tool_button_new
- (c-name "gtk_radio_tool_button_new")
- (is-constructor-of "GtkRadioToolButton")
- (return-type "GtkToolItem*")
-)
-
-(define-function radio_tool_button_new_from_stock
- (c-name "gtk_radio_tool_button_new_from_stock")
- (is-constructor-of "GtkRadioToolButton")
- (return-type "GtkToolItem*")
- (parameters
- '("const-gchar*" "stock_id")
- )
-)
-
-(define-function radio_tool_button_new_from_widget
- (c-name "gtk_radio_tool_button_new_from_widget")
- (is-constructor-of "GtkRadioToolButton")
- (return-type "GtkToolItem*")
- (parameters
- '("GtkRadioToolButton*" "group")
- )
-)
-
-(define-function radio_tool_button_new_with_stock_from_widget
- (c-name "gtk_radio_tool_button_new_with_stock_from_widget")
- (is-constructor-of "GtkRadioToolButton")
- (return-type "GtkToolItem*")
- (parameters
- '("GtkRadioToolButton*" "group")
- '("const-gchar*" "stock_id")
- )
-)
-
-(define-method set_group
- (of-object "GtkRadioToolButton")
- (c-name "gtk_radio_tool_button_set_group")
- (return-type "none")
- (parameters
- '("GSList*" "group")
- )
-)
-
-(define-method get_group
- (of-object "GtkRadioToolButton")
- (c-name "gtk_radio_tool_button_get_group")
- (return-type "GSList*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkrange.h
-
-(define-function gtk_range_get_type
- (c-name "gtk_range_get_type")
- (return-type "GType")
-)
-
-(define-method set_update_policy
- (of-object "GtkRange")
- (c-name "gtk_range_set_update_policy")
- (return-type "none")
- (parameters
- '("GtkUpdateType" "policy")
- )
-)
-
-(define-method get_update_policy
- (of-object "GtkRange")
- (c-name "gtk_range_get_update_policy")
- (return-type "GtkUpdateType")
-)
-
-(define-method set_adjustment
- (of-object "GtkRange")
- (c-name "gtk_range_set_adjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment")
- )
-)
-
-(define-method get_adjustment
- (of-object "GtkRange")
- (c-name "gtk_range_get_adjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method set_inverted
- (of-object "GtkRange")
- (c-name "gtk_range_set_inverted")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_inverted
- (of-object "GtkRange")
- (c-name "gtk_range_get_inverted")
- (return-type "gboolean")
-)
-
-(define-method set_increments
- (of-object "GtkRange")
- (c-name "gtk_range_set_increments")
- (return-type "none")
- (parameters
- '("gdouble" "step")
- '("gdouble" "page")
- )
-)
-
-(define-method set_range
- (of-object "GtkRange")
- (c-name "gtk_range_set_range")
- (return-type "none")
- (parameters
- '("gdouble" "min")
- '("gdouble" "max")
- )
-)
-
-(define-method set_value
- (of-object "GtkRange")
- (c-name "gtk_range_set_value")
- (return-type "none")
- (parameters
- '("gdouble" "value")
- )
-)
-
-(define-method get_value
- (of-object "GtkRange")
- (c-name "gtk_range_get_value")
- (return-type "gdouble")
-)
-
-
-(define-virtual value_changed
- (of-object "GtkRange")
- (return-type "none")
-)
-(define-virtual adjust_bounds
- (of-object "GtkRange")
- (return-type "none")
- (parameters
- '("gdouble" "new_value")
- )
-)
-(define-virtual move_slider
- (of-object "GtkRange")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll")
- )
-)
-(define-virtual get_range_border
- (of-object "GtkRange")
- (return-type "none")
- (parameters
- '("GtkBorder*" "border_")
- )
-)
-(define-virtual change_value
- (of-object "GtkRange")
- (return-type "gboolean")
- (parameters
- '("GtkScrollType" "scroll")
- '("gdouble" "new_value")
- )
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkrc.h
-
-(define-function rc_add_default_file
- (c-name "gtk_rc_add_default_file")
- (return-type "none")
- (parameters
- '("const-gchar*" "filename")
- )
-)
-
-(define-function rc_set_default_files
- (c-name "gtk_rc_set_default_files")
- (return-type "none")
- (parameters
- '("gchar**" "filenames")
- )
-)
-
-(define-function rc_get_default_files
- (c-name "gtk_rc_get_default_files")
- (return-type "gchar**")
-)
-
-(define-method rc_get_style
- (of-object "GtkWidget")
- (c-name "gtk_rc_get_style")
- (return-type "GtkStyle*")
-)
-
-(define-function rc_get_style_by_paths
- (c-name "gtk_rc_get_style_by_paths")
- (return-type "GtkStyle*")
- (parameters
- '("GtkSettings*" "settings")
- '("const-char*" "widget_path")
- '("const-char*" "class_path")
- '("GType" "type")
- )
-)
-
-(define-function rc_reparse_all_for_settings
- (c-name "gtk_rc_reparse_all_for_settings")
- (return-type "gboolean")
- (parameters
- '("GtkSettings*" "settings")
- '("gboolean" "force_load")
- )
-)
-
-(define-function rc_reset_styles
- (c-name "gtk_rc_reset_styles")
- (return-type "none")
- (parameters
- '("GtkSettings*" "settings")
- )
-)
-
-(define-function rc_find_pixmap_in_path
- (c-name "gtk_rc_find_pixmap_in_path")
- (return-type "gchar*")
- (parameters
- '("GtkSettings*" "settings")
- '("GScanner*" "scanner")
- '("const-gchar*" "pixmap_file")
- )
-)
-
-(define-function rc_parse
- (c-name "gtk_rc_parse")
- (return-type "none")
- (parameters
- '("const-gchar*" "filename")
- )
-)
-
-(define-function rc_parse_string
- (c-name "gtk_rc_parse_string")
- (return-type "none")
- (parameters
- '("const-gchar*" "rc_string")
- )
-)
-
-(define-function rc_reparse_all
- (c-name "gtk_rc_reparse_all")
- (return-type "gboolean")
-)
-
-(define-method rc_add_widget_name_style
- (of-object "GtkRcStyle")
- (c-name "gtk_rc_add_widget_name_style")
- (return-type "none")
- (parameters
- '("const-gchar*" "pattern")
- )
- (deprecated "")
-)
-
-(define-method rc_add_widget_class_style
- (of-object "GtkRcStyle")
- (c-name "gtk_rc_add_widget_class_style")
- (return-type "none")
- (parameters
- '("const-gchar*" "pattern")
- )
- (deprecated "")
-)
-
-(define-method rc_add_class_style
- (of-object "GtkRcStyle")
- (c-name "gtk_rc_add_class_style")
- (return-type "none")
- (parameters
- '("const-gchar*" "pattern")
- )
- (deprecated "")
-)
-
-
-(define-function gtk_rc_style_get_type
- (c-name "gtk_rc_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_rc_style_new
- (c-name "gtk_rc_style_new")
- (is-constructor-of "GtkRCStyle")
- (return-type "GtkRcStyle*")
-)
-
-(define-method copy
- (of-object "GtkRcStyle")
- (c-name "gtk_rc_style_copy")
- (return-type "GtkRcStyle*")
- (caller-owns-return #t)
-)
-
-(define-method ref
- (of-object "GtkRcStyle")
- (c-name "gtk_rc_style_ref")
- (return-type "none")
-)
-
-(define-method unref
- (of-object "GtkRcStyle")
- (c-name "gtk_rc_style_unref")
- (return-type "none")
-)
-
-(define-virtual create_rc_style
- (of-object "GtkRcStyle")
- (return-type "GtkRcStyle*")
-)
-
-(define-virtual parse
- (of-object "GtkRcStyle")
- (return-type "guint")
- (parameters
- '("GtkSettings*" "settings")
- '("GScanner*" "scanner")
- )
-)
-(define-virtual merge
- (of-object "GtkRcStyle")
- (return-type "none")
- (parameters
- '("GtkRcStyle*" "src")
- )
-)
-
-(define-virtual create_style
- (of-object "GtkRcStyle")
- (return-type "GtkStyle*")
-)
-
-(define-function rc_find_module_in_path
- (c-name "gtk_rc_find_module_in_path")
- (return-type "gchar*")
- (parameters
- '("const-gchar*" "module_file")
- )
-)
-
-(define-function rc_get_theme_dir
- (c-name "gtk_rc_get_theme_dir")
- (return-type "gchar*")
-)
-
-(define-function rc_get_module_dir
- (c-name "gtk_rc_get_module_dir")
- (return-type "gchar*")
-)
-
-(define-function rc_get_im_module_path
- (c-name "gtk_rc_get_im_module_path")
- (return-type "gchar*")
-)
-
-(define-function rc_get_im_module_file
- (c-name "gtk_rc_get_im_module_file")
- (return-type "gchar*")
-)
-
-(define-function rc_scanner_new
- (c-name "gtk_rc_scanner_new")
- (is-constructor-of "GtkRcScanner")
- (return-type "GScanner*")
-)
-
-(define-function rc_parse_color
- (c-name "gtk_rc_parse_color")
- (return-type "guint")
- (parameters
- '("GScanner*" "scanner")
- '("GdkColor*" "color")
- )
-)
-
-(define-function rc_parse_state
- (c-name "gtk_rc_parse_state")
- (return-type "guint")
- (parameters
- '("GScanner*" "scanner")
- '("GtkStateType*" "state")
- )
-)
-
-(define-function rc_parse_priority
- (c-name "gtk_rc_parse_priority")
- (return-type "guint")
- (parameters
- '("GScanner*" "scanner")
- '("GtkPathPriorityType*" "priority")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkruler.h
-
-(define-function gtk_ruler_get_type
- (c-name "gtk_ruler_get_type")
- (return-type "GType")
-)
-
-(define-method set_metric
- (of-object "GtkRuler")
- (c-name "gtk_ruler_set_metric")
- (return-type "none")
- (parameters
- '("GtkMetricType" "metric")
- )
-)
-
-(define-method set_range
- (of-object "GtkRuler")
- (c-name "gtk_ruler_set_range")
- (return-type "none")
- (parameters
- '("gdouble" "lower")
- '("gdouble" "upper")
- '("gdouble" "position")
- '("gdouble" "max_size")
- )
-)
-
-(define-method draw_ticks
- (of-object "GtkRuler")
- (c-name "gtk_ruler_draw_ticks")
- (return-type "none")
-)
-
-(define-method draw_pos
- (of-object "GtkRuler")
- (c-name "gtk_ruler_draw_pos")
- (return-type "none")
-)
-
-(define-method get_metric
- (of-object "GtkRuler")
- (c-name "gtk_ruler_get_metric")
- (return-type "GtkMetricType")
-)
-
-(define-method get_range
- (of-object "GtkRuler")
- (c-name "gtk_ruler_get_range")
- (return-type "none")
- (parameters
- '("gdouble*" "lower")
- '("gdouble*" "upper")
- '("gdouble*" "position")
- '("gdouble*" "max_size")
- )
-)
-
-(define-virtual draw_ticks
- (of-object "GtkRuler")
- (return-type "none")
-)
-(define-virtual draw_pos
- (of-object "GtkRuler")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkscale.h
-
-(define-function gtk_scale_get_type
- (c-name "gtk_scale_get_type")
- (return-type "GType")
-)
-
-(define-method set_digits
- (of-object "GtkScale")
- (c-name "gtk_scale_set_digits")
- (return-type "none")
- (parameters
- '("gint" "digits")
- )
-)
-
-(define-method get_digits
- (of-object "GtkScale")
- (c-name "gtk_scale_get_digits")
- (return-type "gint")
-)
-
-(define-method set_draw_value
- (of-object "GtkScale")
- (c-name "gtk_scale_set_draw_value")
- (return-type "none")
- (parameters
- '("gboolean" "draw_value")
- )
-)
-
-(define-method get_draw_value
- (of-object "GtkScale")
- (c-name "gtk_scale_get_draw_value")
- (return-type "gboolean")
-)
-
-(define-method set_value_pos
- (of-object "GtkScale")
- (c-name "gtk_scale_set_value_pos")
- (return-type "none")
- (parameters
- '("GtkPositionType" "pos")
- )
-)
-
-(define-method get_value_pos
- (of-object "GtkScale")
- (c-name "gtk_scale_get_value_pos")
- (return-type "GtkPositionType")
-)
-
-(define-method get_layout
- (of-object "GtkScale")
- (c-name "gtk_scale_get_layout")
- (return-type "PangoLayout*")
-)
-
-(define-method get_layout_offsets
- (of-object "GtkScale")
- (c-name "gtk_scale_get_layout_offsets")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- )
-)
-
-(define-virtual format_value
- (of-object "GtkScale")
- (return-type "gchar*")
- (parameters
- '("gdouble" "value")
- )
-)
-
-(define-virtual draw_value
- (of-object "GtkScale")
- (return-type "none")
-)
-(define-virtual get_layout_offsets
- (of-object "GtkScale")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkscrollbar.h
-
-(define-function gtk_scrollbar_get_type
- (c-name "gtk_scrollbar_get_type")
- (return-type "GType")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkscrolledwindow.h
-
-(define-function gtk_scrolled_window_get_type
- (c-name "gtk_scrolled_window_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_scrolled_window_new
- (c-name "gtk_scrolled_window_new")
- (is-constructor-of "GtkScrolledWindow")
- (return-type "GtkWidget*")
- (properties
- '("hadjustment" (optional))
- '("vadjustment" (optional))
- )
-)
-
-(define-method set_hadjustment
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_set_hadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "hadjustment")
- )
-)
-
-(define-method set_vadjustment
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_set_vadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "hadjustment")
- )
-)
-
-(define-method get_hadjustment
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_get_hadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method get_vadjustment
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_get_vadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method get_hscrollbar
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_get_hscrollbar")
- (return-type "GtkWidget*")
-)
-
-(define-method get_vscrollbar
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_get_vscrollbar")
- (return-type "GtkWidget*")
-)
-
-(define-method set_policy
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_set_policy")
- (return-type "none")
- (parameters
- '("GtkPolicyType" "hscrollbar_policy")
- '("GtkPolicyType" "vscrollbar_policy")
- )
-)
-
-(define-method get_policy
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_get_policy")
- (return-type "none")
- (parameters
- '("GtkPolicyType*" "hscrollbar_policy")
- '("GtkPolicyType*" "vscrollbar_policy")
- )
-)
-
-(define-method set_placement
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_set_placement")
- (return-type "none")
- (parameters
- '("GtkCornerType" "window_placement")
- )
-)
-
-(define-method get_placement
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_get_placement")
- (return-type "GtkCornerType")
-)
-
-(define-method set_shadow_type
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_set_shadow_type")
- (return-type "none")
- (parameters
- '("GtkShadowType" "type")
- )
-)
-
-(define-method get_shadow_type
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_get_shadow_type")
- (return-type "GtkShadowType")
-)
-
-(define-method add_with_viewport
- (of-object "GtkScrolledWindow")
- (c-name "gtk_scrolled_window_add_with_viewport")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-virtual scroll_child
- (of-object "GtkScrolledWindow")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll")
- '("gboolean" "horizontal")
- )
-)
-(define-virtual move_focus_out
- (of-object "GtkScrolledWindow")
- (return-type "none")
- (parameters
- '("GtkDirectionType" "direction")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkselection.h
-
-(define-function gtk_target_list_new
- (c-name "gtk_target_list_new")
- (is-constructor-of "GtkTargetList")
- (return-type "GtkTargetList*")
- (parameters
- '("const-GtkTargetEntry*" "targets")
- '("guint" "ntargets")
- )
-)
-
-(define-method ref
- (of-object "GtkTargetList")
- (c-name "gtk_target_list_ref")
- (return-type "none")
-)
-
-(define-method unref
- (of-object "GtkTargetList")
- (c-name "gtk_target_list_unref")
- (return-type "none")
-)
-
-(define-method add
- (of-object "GtkTargetList")
- (c-name "gtk_target_list_add")
- (return-type "none")
- (parameters
- '("GdkAtom" "target")
- '("guint" "flags")
- '("guint" "info")
- )
-)
-
-(define-method add_table
- (of-object "GtkTargetList")
- (c-name "gtk_target_list_add_table")
- (return-type "none")
- (parameters
- '("const-GtkTargetEntry*" "targets")
- '("guint" "ntargets")
- )
-)
-
-(define-method remove
- (of-object "GtkTargetList")
- (c-name "gtk_target_list_remove")
- (return-type "none")
- (parameters
- '("GdkAtom" "target")
- )
-)
-
-(define-method find
- (of-object "GtkTargetList")
- (c-name "gtk_target_list_find")
- (return-type "gboolean")
- (parameters
- '("GdkAtom" "target")
- '("guint*" "info")
- )
-)
-
-(define-method selection_owner_set
- (of-object "GtkWidget")
- (c-name "gtk_selection_owner_set")
- (return-type "gboolean")
- (parameters
- '("GdkAtom" "selection")
- '("guint32" "time" (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-function selection_owner_set_for_display
- (c-name "gtk_selection_owner_set_for_display")
- (return-type "gboolean")
- (parameters
- '("GdkDisplay*" "display")
- '("GtkWidget*" "widget" (null-ok))
- '("GdkAtom" "selection")
- '("guint32" "time" (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method selection_add_target
- (of-object "GtkWidget")
- (c-name "gtk_selection_add_target")
- (return-type "none")
- (parameters
- '("GdkAtom" "selection")
- '("GdkAtom" "target")
- '("guint" "info")
- )
-)
-
-(define-method selection_add_targets
- (of-object "GtkWidget")
- (c-name "gtk_selection_add_targets")
- (return-type "none")
- (parameters
- '("GdkAtom" "selection")
- '("const-GtkTargetEntry*" "targets")
- '("guint" "ntargets")
- )
-)
-
-(define-method selection_clear_targets
- (of-object "GtkWidget")
- (c-name "gtk_selection_clear_targets")
- (return-type "none")
- (parameters
- '("GdkAtom" "selection")
- )
-)
-
-(define-method selection_convert
- (of-object "GtkWidget")
- (c-name "gtk_selection_convert")
- (return-type "gboolean")
- (parameters
- '("GdkAtom" "selection")
- '("GdkAtom" "target")
- '("guint32" "time" (default "GDK_CURRENT_TIME"))
- )
-)
-
-(define-method set
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_set")
- (return-type "none")
- (parameters
- '("GdkAtom" "type")
- '("gint" "format")
- '("const-guchar*" "data")
- '("gint" "length")
- )
-)
-
-(define-method set_text
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_set_text")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "str")
- '("gint" "len" (default "-1"))
- )
-)
-
-(define-method get_text
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_get_text")
- (return-type "guchar*")
-)
-
-(define-method get_targets
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_get_targets")
- (return-type "gboolean")
- (parameters
- '("GdkAtom**" "targets")
- '("gint*" "n_atoms")
- )
-)
-
-(define-method targets_include_text
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_targets_include_text")
- (return-type "gboolean")
-)
-
-(define-method selection_remove_all
- (of-object "GtkWidget")
- (c-name "gtk_selection_remove_all")
- (return-type "none")
-)
-
-(define-method selection_clear
- (of-object "GtkWidget")
- (c-name "gtk_selection_clear")
- (return-type "gboolean")
- (parameters
- '("GdkEventSelection*" "event")
- )
-)
-
-(define-function gtk_selection_data_get_type
- (c-name "gtk_selection_data_get_type")
- (return-type "GType")
-)
-
-(define-method copy
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_copy")
- (return-type "GtkSelectionData*")
- (caller-owns-return #t)
-)
-
-(define-method free
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_free")
- (return-type "none")
-)
-
-(define-method set_pixbuf
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_set_pixbuf")
- (return-type "gboolean")
- (parameters
- '("GdkPixbuf*" "pixbuf")
- )
-)
-
-(define-method get_pixbuf
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_get_pixbuf")
- (return-type "GdkPixbuf*")
-)
-
-(define-method set_uris
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_set_uris")
- (return-type "gboolean")
- (parameters
- '("gchar**" "uris")
- )
-)
-
-(define-method get_uris
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_get_uris")
- (return-type "gchar**")
-)
-
-
-(define-method targets_include_image
- (of-object "GtkSelectionData")
- (c-name "gtk_selection_data_targets_include_image")
- (return-type "gboolean")
- (parameters
- '("gboolean" "writable")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkseparator.h
-
-(define-function gtk_separator_get_type
- (c-name "gtk_separator_get_type")
- (return-type "GType")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkseparatormenuitem.h
-
-(define-function gtk_separator_menu_item_get_type
- (c-name "gtk_separator_menu_item_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_separator_menu_item_new
- (c-name "gtk_separator_menu_item_new")
- (is-constructor-of "GtkSeparatorMenuItem")
- (return-type "GtkWidget*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkseparatortoolitem.h
-
-(define-function gtk_separator_tool_item_get_type
- (c-name "gtk_separator_tool_item_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_separator_tool_item_new
- (c-name "gtk_separator_tool_item_new")
- (is-constructor-of "GtkSeparatorToolItem")
- (return-type "GtkToolItem*")
-)
-
-(define-method get_draw
- (of-object "GtkSeparatorToolItem")
- (c-name "gtk_separator_tool_item_get_draw")
- (return-type "gboolean")
-)
-
-(define-method set_draw
- (of-object "GtkSeparatorToolItem")
- (c-name "gtk_separator_tool_item_set_draw")
- (return-type "none")
- (parameters
- '("gboolean" "draw")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtksettings.h
-
-(define-function gtk_settings_get_type
- (c-name "gtk_settings_get_type")
- (return-type "GType")
-)
-
-(define-function settings_get_default
- (c-name "gtk_settings_get_default")
- (return-type "GtkSettings*")
-)
-
-(define-function settings_get_for_screen
- (c-name "gtk_settings_get_for_screen")
- (return-type "GtkSettings*")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-function settings_install_property
- (c-name "gtk_settings_install_property")
- (return-type "none")
- (parameters
- '("GParamSpec*" "pspec")
- )
-)
-
-(define-function settings_install_property_parser
- (c-name "gtk_settings_install_property_parser")
- (return-type "none")
- (parameters
- '("GParamSpec*" "pspec")
- '("GtkRcPropertyParser" "parser")
- )
-)
-
-(define-function rc_property_parse_color
- (c-name "gtk_rc_property_parse_color")
- (return-type "gboolean")
- (parameters
- '("const-GParamSpec*" "pspec")
- '("const-GString*" "gstring")
- '("GValue*" "property_value")
- )
-)
-
-(define-function rc_property_parse_enum
- (c-name "gtk_rc_property_parse_enum")
- (return-type "gboolean")
- (parameters
- '("const-GParamSpec*" "pspec")
- '("const-GString*" "gstring")
- '("GValue*" "property_value")
- )
-)
-
-(define-function rc_property_parse_flags
- (c-name "gtk_rc_property_parse_flags")
- (return-type "gboolean")
- (parameters
- '("const-GParamSpec*" "pspec")
- '("const-GString*" "gstring")
- '("GValue*" "property_value")
- )
-)
-
-(define-function rc_property_parse_requisition
- (c-name "gtk_rc_property_parse_requisition")
- (return-type "gboolean")
- (parameters
- '("const-GParamSpec*" "pspec")
- '("const-GString*" "gstring")
- '("GValue*" "property_value")
- )
-)
-
-(define-function rc_property_parse_border
- (c-name "gtk_rc_property_parse_border")
- (return-type "gboolean")
- (parameters
- '("const-GParamSpec*" "pspec")
- '("const-GString*" "gstring")
- '("GValue*" "property_value")
- )
-)
-
-(define-method set_property_value
- (of-object "GtkSettings")
- (c-name "gtk_settings_set_property_value")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- '("const-GtkSettingsValue*" "svalue")
- )
-)
-
-(define-method set_string_property
- (of-object "GtkSettings")
- (c-name "gtk_settings_set_string_property")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- '("const-gchar*" "v_string")
- '("const-gchar*" "origin")
- )
-)
-
-(define-method set_long_property
- (of-object "GtkSettings")
- (c-name "gtk_settings_set_long_property")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- '("glong" "v_long")
- '("const-gchar*" "origin")
- )
-)
-
-(define-method set_double_property
- (of-object "GtkSettings")
- (c-name "gtk_settings_set_double_property")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- '("gdouble" "v_double")
- '("const-gchar*" "origin")
- )
-)
-
-
-;; From /mondo/local/gtk-2.10/include/gtk-2.0/gtk/gtksignal.h
-
-(define-function signal_newv
- (c-name "gtk_signal_newv")
- (return-type "guint")
- (parameters
- '("const-gchar*" "name")
- '("GtkSignalRunType" "signal_flags")
- '("GtkType" "object_type")
- '("guint" "function_offset")
- '("GtkSignalMarshaller" "marshaller")
- '("GtkType" "return_val")
- '("guint" "n_args")
- '("GtkType*" "args")
- )
-)
-
-(define-function signal_new
- (c-name "gtk_signal_new")
- (return-type "guint")
- (parameters
- '("const-gchar*" "name")
- '("GtkSignalRunType" "signal_flags")
- '("GtkType" "object_type")
- '("guint" "function_offset")
- '("GtkSignalMarshaller" "marshaller")
- '("GtkType" "return_val")
- '("guint" "n_args")
- )
- (varargs #t)
-)
-
-(define-function signal_emit_stop_by_name
- (c-name "gtk_signal_emit_stop_by_name")
- (return-type "none")
- (parameters
- '("GtkObject*" "object")
- '("const-gchar*" "name")
- )
-)
-
-(define-function signal_connect_object_while_alive
- (c-name "gtk_signal_connect_object_while_alive")
- (return-type "none")
- (parameters
- '("GtkObject*" "object")
- '("const-gchar*" "name")
- '("GtkSignalFunc" "func")
- '("GtkObject*" "alive_object")
- )
-)
-
-(define-function signal_connect_while_alive
- (c-name "gtk_signal_connect_while_alive")
- (return-type "none")
- (parameters
- '("GtkObject*" "object")
- '("const-gchar*" "name")
- '("GtkSignalFunc" "func")
- '("gpointer" "func_data")
- '("GtkObject*" "alive_object")
- )
-)
-
-(define-function signal_connect_full
- (c-name "gtk_signal_connect_full")
- (return-type "gulong")
- (parameters
- '("GtkObject*" "object")
- '("const-gchar*" "name")
- '("GtkSignalFunc" "func")
- '("GtkCallbackMarshal" "unsupported")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy_func")
- '("gint" "object_signal")
- '("gint" "after")
- )
-)
-
-(define-function signal_emitv
- (c-name "gtk_signal_emitv")
- (return-type "none")
- (parameters
- '("GtkObject*" "object")
- '("guint" "signal_id")
- '("GtkArg*" "args")
- )
-)
-
-(define-function signal_emit
- (c-name "gtk_signal_emit")
- (return-type "none")
- (parameters
- '("GtkObject*" "object")
- '("guint" "signal_id")
- )
- (varargs #t)
-)
-
-(define-function signal_emit_by_name
- (c-name "gtk_signal_emit_by_name")
- (return-type "none")
- (parameters
- '("GtkObject*" "object")
- '("const-gchar*" "name")
- )
- (varargs #t)
-)
-
-(define-function signal_emitv_by_name
- (c-name "gtk_signal_emitv_by_name")
- (return-type "none")
- (parameters
- '("GtkObject*" "object")
- '("const-gchar*" "name")
- '("GtkArg*" "args")
- )
-)
-
-(define-function signal_compat_matched
- (c-name "gtk_signal_compat_matched")
- (return-type "none")
- (parameters
- '("GtkObject*" "object")
- '("GtkSignalFunc" "func")
- '("gpointer" "data")
- '("GSignalMatchType" "match")
- '("guint" "action")
- )
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtksizegroup.h
-
-(define-function gtk_size_group_get_type
- (c-name "gtk_size_group_get_type")
- (return-type "GType")
-)
-
-(define-function size_group_new
- (c-name "gtk_size_group_new")
- (is-constructor-of "GtkSizeGroup")
- (return-type "GtkSizeGroup*")
- (properties
- '("mode")
- )
-)
-
-(define-method set_mode
- (of-object "GtkSizeGroup")
- (c-name "gtk_size_group_set_mode")
- (return-type "none")
- (parameters
- '("GtkSizeGroupMode" "mode")
- )
-)
-
-(define-method get_mode
- (of-object "GtkSizeGroup")
- (c-name "gtk_size_group_get_mode")
- (return-type "GtkSizeGroupMode")
-)
-
-(define-method set_ignore_hidden
- (of-object "GtkSizeGroup")
- (c-name "gtk_size_group_set_ignore_hidden")
- (return-type "none")
- (parameters
- '("gboolean" "ignore_hidden")
- )
-)
-
-(define-method get_ignore_hidden
- (of-object "GtkSizeGroup")
- (c-name "gtk_size_group_get_ignore_hidden")
- (return-type "gboolean")
-)
-
-(define-method add_widget
- (of-object "GtkSizeGroup")
- (c-name "gtk_size_group_add_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-method remove_widget
- (of-object "GtkSizeGroup")
- (c-name "gtk_size_group_remove_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtksocket.h
-
-(define-function gtk_socket_get_type
- (c-name "gtk_socket_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_socket_new
- (c-name "gtk_socket_new")
- (is-constructor-of "GtkSocket")
- (return-type "GtkWidget*")
-)
-
-(define-method add_id
- (of-object "GtkSocket")
- (c-name "gtk_socket_add_id")
- (return-type "none")
- (parameters
- '("GdkNativeWindow" "window_id")
- )
-)
-
-(define-method get_id
- (of-object "GtkSocket")
- (c-name "gtk_socket_get_id")
- (return-type "GdkNativeWindow")
-)
-
-(define-method steal
- (of-object "GtkSocket")
- (c-name "gtk_socket_steal")
- (return-type "none")
- (parameters
- '("GdkNativeWindow" "wid")
- )
- (deprecated "")
-)
-
-(define-virtual plug_added
- (of-object "GtkSocket")
- (return-type "none")
-)
-(define-virtual plug_removed
- (of-object "GtkSocket")
- (return-type "gboolean")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkspinbutton.h
-
-(define-function gtk_spin_button_get_type
- (c-name "gtk_spin_button_get_type")
- (return-type "GType")
-)
-
-(define-method configure
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_configure")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment" (null-ok))
- '("gdouble" "climb_rate")
- '("guint" "digits")
- )
-)
-
-(define-function gtk_spin_button_new
- (c-name "gtk_spin_button_new")
- (is-constructor-of "GtkSpinButton")
- (return-type "GtkWidget*")
- (properties
- '("adjustment" (optional))
- '("climb_rate" (optional))
- '("digits" (optional))
- )
-)
-
-(define-function gtk_spin_button_new_with_range
- (c-name "gtk_spin_button_new_with_range")
- (is-constructor-of "GtkSpinButton")
- (return-type "GtkWidget*")
- (parameters
- '("gdouble" "min")
- '("gdouble" "max")
- '("gdouble" "step")
- )
-)
-
-(define-method set_adjustment
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_set_adjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment")
- )
-)
-
-(define-method get_adjustment
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_get_adjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method set_digits
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_set_digits")
- (return-type "none")
- (parameters
- '("guint" "digits")
- )
-)
-
-(define-method get_digits
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_get_digits")
- (return-type "guint")
-)
-
-(define-method set_increments
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_set_increments")
- (return-type "none")
- (parameters
- '("gdouble" "step")
- '("gdouble" "page")
- )
-)
-
-(define-method get_increments
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_get_increments")
- (return-type "none")
- (parameters
- '("gdouble*" "step")
- '("gdouble*" "page")
- )
-)
-
-(define-method set_range
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_set_range")
- (return-type "none")
- (parameters
- '("gdouble" "min")
- '("gdouble" "max")
- )
-)
-
-(define-method get_range
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_get_range")
- (return-type "none")
- (parameters
- '("gdouble*" "min")
- '("gdouble*" "max")
- )
-)
-
-(define-method get_value
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_get_value")
- (return-type "gdouble")
-)
-
-(define-method get_value_as_int
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_get_value_as_int")
- (return-type "gint")
-)
-
-(define-method set_value
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_set_value")
- (return-type "none")
- (parameters
- '("gdouble" "value")
- )
-)
-
-(define-method set_update_policy
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_set_update_policy")
- (return-type "none")
- (parameters
- '("GtkSpinButtonUpdatePolicy" "policy")
- )
-)
-
-(define-method get_update_policy
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_get_update_policy")
- (return-type "guint")
-)
-
-(define-method set_numeric
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_set_numeric")
- (return-type "none")
- (parameters
- '("gboolean" "numeric")
- )
-)
-
-(define-method get_numeric
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_get_numeric")
- (return-type "gboolean")
-)
-
-(define-method spin
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_spin")
- (return-type "none")
- (parameters
- '("GtkSpinType" "direction")
- '("gdouble" "increment" (default "1"))
- )
-)
-
-(define-method set_wrap
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_set_wrap")
- (return-type "none")
- (parameters
- '("gboolean" "wrap")
- )
-)
-
-(define-method get_wrap
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_get_wrap")
- (return-type "gboolean")
-)
-
-(define-method set_snap_to_ticks
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_set_snap_to_ticks")
- (return-type "none")
- (parameters
- '("gboolean" "snap_to_ticks")
- )
-)
-
-(define-method get_snap_to_ticks
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_get_snap_to_ticks")
- (return-type "gboolean")
-)
-
-(define-method update
- (of-object "GtkSpinButton")
- (c-name "gtk_spin_button_update")
- (return-type "none")
-)
-
-(define-virtual input
- (of-object "GtkSpinButton")
- (return-type "gint")
- (parameters
- '("gdouble*" "new_value" (direction "out"))
- )
-)
-(define-virtual output
- (of-object "GtkSpinButton")
- (return-type "gint")
-)
-(define-virtual value_changed
- (of-object "GtkSpinButton")
- (return-type "none")
-)
-(define-virtual change_value
- (of-object "GtkSpinButton")
- (return-type "none")
- (parameters
- '("GtkScrollType" "scroll")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkstatusbar.h
-
-(define-function gtk_statusbar_get_type
- (c-name "gtk_statusbar_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_statusbar_new
- (c-name "gtk_statusbar_new")
- (is-constructor-of "GtkStatusbar")
- (return-type "GtkWidget*")
-)
-
-(define-method get_context_id
- (of-object "GtkStatusbar")
- (c-name "gtk_statusbar_get_context_id")
- (return-type "guint")
- (parameters
- '("const-gchar*" "context_description")
- )
-)
-
-(define-method push
- (of-object "GtkStatusbar")
- (c-name "gtk_statusbar_push")
- (return-type "guint")
- (parameters
- '("guint" "context_id")
- '("const-gchar*" "text")
- )
-)
-
-(define-method pop
- (of-object "GtkStatusbar")
- (c-name "gtk_statusbar_pop")
- (return-type "none")
- (parameters
- '("guint" "context_id")
- )
-)
-
-(define-method remove
- (of-object "GtkStatusbar")
- (c-name "gtk_statusbar_remove")
- (return-type "none")
- (parameters
- '("guint" "context_id")
- '("guint" "message_id")
- )
-)
-
-(define-method set_has_resize_grip
- (of-object "GtkStatusbar")
- (c-name "gtk_statusbar_set_has_resize_grip")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_has_resize_grip
- (of-object "GtkStatusbar")
- (c-name "gtk_statusbar_get_has_resize_grip")
- (return-type "gboolean")
-)
-
-(define-virtual text_pushed
- (of-object "GtkStatusbar")
- (return-type "none")
- (parameters
- '("guint" "context_id")
- '("const-gchar*" "text")
- )
-)
-(define-virtual text_popped
- (of-object "GtkStatusbar")
- (return-type "none")
- (parameters
- '("guint" "context_id")
- '("const-gchar*" "text")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkstock.h
-
-(define-function stock_add
- (c-name "gtk_stock_add")
- (return-type "none")
- (parameters
- '("const-GtkStockItem*" "items")
- '("guint" "n_items")
- )
-)
-
-(define-function stock_add_static
- (c-name "gtk_stock_add_static")
- (return-type "none")
- (parameters
- '("const-GtkStockItem*" "items")
- '("guint" "n_items")
- )
-)
-
-(define-function stock_lookup
- (c-name "gtk_stock_lookup")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "stock_id")
- '("GtkStockItem*" "item")
- )
-)
-
-(define-function stock_list_ids
- (c-name "gtk_stock_list_ids")
- (return-type "GSList*")
-)
-
-(define-method copy
- (of-object "GtkStockItem")
- (c-name "gtk_stock_item_copy")
- (return-type "GtkStockItem*")
- (caller-owns-return #t)
-)
-
-(define-method free
- (of-object "GtkStockItem")
- (c-name "gtk_stock_item_free")
- (return-type "none")
-)
-
-(define-function stock_set_translate_func
- (c-name "gtk_stock_set_translate_func")
- (return-type "none")
- (parameters
- '("const-gchar*" "domain")
- '("GtkTranslateFunc" "func")
- '("gpointer" "data")
- '("GtkDestroyNotify" "notify")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkstyle.h
-
-(define-function gtk_style_get_type
- (c-name "gtk_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_style_new
- (c-name "gtk_style_new")
- (is-constructor-of "GtkStyle")
- (return-type "GtkStyle*")
-)
-
-(define-method copy
- (of-object "GtkStyle")
- (c-name "gtk_style_copy")
- (return-type "GtkStyle*")
- (caller-owns-return #t)
-)
-
-(define-method attach
- (of-object "GtkStyle")
- (c-name "gtk_style_attach")
- (return-type "GtkStyle*")
- (parameters
- '("GdkWindow*" "window")
- )
-)
-
-(define-method detach
- (of-object "GtkStyle")
- (c-name "gtk_style_detach")
- (return-type "none")
-)
-
-(define-method ref
- (of-object "GtkStyle")
- (c-name "gtk_style_ref")
- (return-type "GtkStyle*")
- (deprecated "")
-)
-
-(define-method unref
- (of-object "GtkStyle")
- (c-name "gtk_style_unref")
- (return-type "none")
- (deprecated "")
-)
-
-(define-method get_font
- (of-object "GtkStyle")
- (c-name "gtk_style_get_font")
- (return-type "GdkFont*")
- (deprecated "")
-)
-
-(define-method set_font
- (of-object "GtkStyle")
- (c-name "gtk_style_set_font")
- (return-type "none")
- (parameters
- '("GdkFont*" "font")
- )
- (deprecated "")
-)
-
-(define-method set_background
- (of-object "GtkStyle")
- (c-name "gtk_style_set_background")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- )
-)
-
-(define-method apply_default_background
- (of-object "GtkStyle")
- (c-name "gtk_style_apply_default_background")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("gboolean" "set_bg")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method lookup_icon_set
- (of-object "GtkStyle")
- (c-name "gtk_style_lookup_icon_set")
- (return-type "GtkIconSet*")
- (parameters
- '("const-gchar*" "stock_id")
- )
-)
-
-(define-method render_icon
- (of-object "GtkStyle")
- (c-name "gtk_style_render_icon")
- (return-type "GdkPixbuf*")
- (parameters
- '("const-GtkIconSource*" "source")
- '("GtkTextDirection" "direction")
- '("GtkStateType" "state")
- '("GtkIconSize" "size")
- '("GtkWidget*" "widget" (null-ok) (default "NULL"))
- '("const-gchar*" "detail" (null-ok) (default "NULL"))
- )
-)
-
-(define-method draw_hline
- (of-object "GtkStyle")
- (c-name "gtk_draw_hline")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("gint" "x1")
- '("gint" "x2")
- '("gint" "y")
- )
- (deprecated "")
-)
-
-(define-method draw_vline
- (of-object "GtkStyle")
- (c-name "gtk_draw_vline")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("gint" "y1")
- '("gint" "y2")
- '("gint" "x")
- )
- (deprecated "")
-)
-
-(define-method draw_shadow
- (of-object "GtkStyle")
- (c-name "gtk_draw_shadow")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "")
-)
-
-(define-method draw_polygon
- (of-object "GtkStyle")
- (c-name "gtk_draw_polygon")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkPoint*" "points")
- '("gint" "npoints")
- '("gboolean" "fill")
- )
- (deprecated "")
-)
-
-(define-method draw_arrow
- (of-object "GtkStyle")
- (c-name "gtk_draw_arrow")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GtkArrowType" "arrow_type")
- '("gboolean" "fill")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "")
-)
-
-(define-method draw_diamond
- (of-object "GtkStyle")
- (c-name "gtk_draw_diamond")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "")
-)
-
-(define-method draw_box
- (of-object "GtkStyle")
- (c-name "gtk_draw_box")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "")
-)
-
-(define-method draw_flat_box
- (of-object "GtkStyle")
- (c-name "gtk_draw_flat_box")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "")
-)
-
-(define-method draw_check
- (of-object "GtkStyle")
- (c-name "gtk_draw_check")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method draw_option
- (of-object "GtkStyle")
- (c-name "gtk_draw_option")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "")
-)
-
-(define-method draw_tab
- (of-object "GtkStyle")
- (c-name "gtk_draw_tab")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "")
-)
-
-(define-method draw_shadow_gap
- (of-object "GtkStyle")
- (c-name "gtk_draw_shadow_gap")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkPositionType" "gap_side")
- '("gint" "gap_x")
- '("gint" "gap_width")
- )
- (deprecated "")
-)
-
-(define-method draw_box_gap
- (of-object "GtkStyle")
- (c-name "gtk_draw_box_gap")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkPositionType" "gap_side")
- '("gint" "gap_x")
- '("gint" "gap_width")
- )
- (deprecated "")
-)
-
-(define-method draw_extension
- (of-object "GtkStyle")
- (c-name "gtk_draw_extension")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkPositionType" "gap_side")
- )
- (deprecated "")
-)
-
-(define-method draw_focus
- (of-object "GtkStyle")
- (c-name "gtk_draw_focus")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "")
-)
-
-(define-method draw_slider
- (of-object "GtkStyle")
- (c-name "gtk_draw_slider")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkOrientation" "orientation")
- )
- (deprecated "")
-)
-
-(define-method draw_handle
- (of-object "GtkStyle")
- (c-name "gtk_draw_handle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkOrientation" "orientation")
- )
- (deprecated "")
-)
-
-(define-method draw_expander
- (of-object "GtkStyle")
- (c-name "gtk_draw_expander")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("gint" "x")
- '("gint" "y")
- '("gboolean" "is_open")
- )
- (deprecated "")
-)
-
-(define-method draw_layout
- (of-object "GtkStyle")
- (c-name "gtk_draw_layout")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("gboolean" "use_text")
- '("gint" "x")
- '("gint" "y")
- '("PangoLayout*" "layout")
- )
- (deprecated "")
-)
-
-(define-method draw_resize_grip
- (of-object "GtkStyle")
- (c-name "gtk_draw_resize_grip")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkWindowEdge" "edge")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "")
-)
-
-(define-method paint_hline
- (of-object "GtkStyle")
- (c-name "gtk_paint_hline")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x1")
- '("gint" "x2")
- '("gint" "y")
- )
-)
-
-(define-method paint_vline
- (of-object "GtkStyle")
- (c-name "gtk_paint_vline")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "y1")
- '("gint" "y2")
- '("gint" "x")
- )
-)
-
-(define-method paint_shadow
- (of-object "GtkStyle")
- (c-name "gtk_paint_shadow")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method paint_polygon
- (of-object "GtkStyle")
- (c-name "gtk_paint_polygon")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("GdkPoint*" "points")
- '("gint" "npoints")
- '("gboolean" "fill")
- )
-)
-
-(define-method paint_arrow
- (of-object "GtkStyle")
- (c-name "gtk_paint_arrow")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("GtkArrowType" "arrow_type")
- '("gboolean" "fill")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method paint_diamond
- (of-object "GtkStyle")
- (c-name "gtk_paint_diamond")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method paint_box
- (of-object "GtkStyle")
- (c-name "gtk_paint_box")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method paint_flat_box
- (of-object "GtkStyle")
- (c-name "gtk_paint_flat_box")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method paint_check
- (of-object "GtkStyle")
- (c-name "gtk_paint_check")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method paint_option
- (of-object "GtkStyle")
- (c-name "gtk_paint_option")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method paint_tab
- (of-object "GtkStyle")
- (c-name "gtk_paint_tab")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method paint_shadow_gap
- (of-object "GtkStyle")
- (c-name "gtk_paint_shadow_gap")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkPositionType" "gap_side")
- '("gint" "gap_x")
- '("gint" "gap_width")
- )
-)
-
-(define-method paint_box_gap
- (of-object "GtkStyle")
- (c-name "gtk_paint_box_gap")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkPositionType" "gap_side")
- '("gint" "gap_x")
- '("gint" "gap_width")
- )
-)
-
-(define-method paint_extension
- (of-object "GtkStyle")
- (c-name "gtk_paint_extension")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkPositionType" "gap_side")
- )
-)
-
-(define-method paint_focus
- (of-object "GtkStyle")
- (c-name "gtk_paint_focus")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method paint_slider
- (of-object "GtkStyle")
- (c-name "gtk_paint_slider")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkOrientation" "orientation")
- )
-)
-
-(define-method paint_handle
- (of-object "GtkStyle")
- (c-name "gtk_paint_handle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkOrientation" "orientation")
- )
-)
-
-(define-method paint_expander
- (of-object "GtkStyle")
- (c-name "gtk_paint_expander")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("GtkExpanderStyle" "expander_style")
- )
-)
-
-(define-method paint_layout
- (of-object "GtkStyle")
- (c-name "gtk_paint_layout")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("gboolean" "use_text")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("PangoLayout*" "layout")
- )
-)
-
-(define-method paint_resize_grip
- (of-object "GtkStyle")
- (c-name "gtk_paint_resize_grip")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("GdkWindowEdge" "edge")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-function gtk_border_get_type
- (c-name "gtk_border_get_type")
- (return-type "GType")
-)
-
-(define-method copy
- (of-object "GtkBorder")
- (c-name "gtk_border_copy")
- (return-type "GtkBorder*")
- (caller-owns-return #t)
-)
-
-(define-method free
- (of-object "GtkBorder")
- (c-name "gtk_border_free")
- (return-type "none")
-)
-
-(define-method apply_default_pixmap
- (of-object "GtkStyle")
- (c-name "gtk_style_apply_default_pixmap")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("gboolean" "set_bg")
- '("GdkRectangle*" "area")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "use GtkStyle.apply_default_background")
-)
-
-(define-method draw_string
- (of-object "GtkStyle")
- (c-name "gtk_draw_string")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("gint" "x")
- '("gint" "y")
- '("const-gchar*" "string")
- )
- (deprecated "")
-)
-
-(define-method paint_string
- (of-object "GtkStyle")
- (c-name "gtk_paint_string")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area" (null-ok))
- '("GtkWidget*" "widget" (null-ok))
- '("const-gchar*" "detail" (null-ok))
- '("gint" "x")
- '("gint" "y")
- '("const-gchar*" "string")
- )
- (deprecated "")
-)
-
-(define-function draw_insertion_cursor
- (c-name "gtk_draw_insertion_cursor")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("GdkDrawable*" "drawable")
- '("GdkRectangle*" "area" (null-ok))
- '("GdkRectangle*" "location")
- '("gboolean" "is_primary")
- '("GtkTextDirection" "direction")
- '("gboolean" "draw_arrow")
- )
-)
-
-(define-virtual realize
- (of-object "GtkStyle")
- (return-type "none")
-)
-(define-virtual unrealize
- (of-object "GtkStyle")
- (return-type "none")
-)
-(define-virtual copy
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GtkStyle*" "src")
- )
-)
-(define-virtual clone
- (of-object "GtkStyle")
- (return-type "GtkStyle*")
-)
-
-(define-virtual init_from_rc
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GtkRcStyle*" "rc_style")
- )
-)
-(define-virtual set_background
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- )
-)
-(define-virtual render_icon
- (of-object "GtkStyle")
- (return-type "GdkPixbuf*")
- (parameters
- '("const-GtkIconSource*" "source")
- '("GtkTextDirection" "direction")
- '("GtkStateType" "state")
- '("GtkIconSize" "size")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- )
-)
-
-(define-virtual draw_hline
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x1")
- '("gint" "x2")
- '("gint" "y")
- )
-)
-(define-virtual draw_vline
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "y1_")
- '("gint" "y2_")
- '("gint" "x")
- )
-)
-(define-virtual draw_shadow
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-(define-virtual draw_polygon
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("GdkPoint*" "point")
- '("gint" "npoints")
- '("gboolean" "fill")
- )
-)
-(define-virtual draw_arrow
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("GtkArrowType" "arrow_type")
- '("gboolean" "fill")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-(define-virtual draw_diamond
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-(define-virtual draw_string
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("const-gchar*" "string")
- )
-)
-(define-virtual draw_box
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-(define-virtual draw_flat_box
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-(define-virtual draw_check
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-(define-virtual draw_option
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-(define-virtual draw_tab
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-(define-virtual draw_shadow_gap
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkPositionType" "gap_side")
- '("gint" "gap_x")
- '("gint" "gap_width")
- )
-)
-(define-virtual draw_box_gap
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkPositionType" "gap_side")
- '("gint" "gap_x")
- '("gint" "gap_width")
- )
-)
-(define-virtual draw_extension
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkPositionType" "gap_side")
- )
-)
-(define-virtual draw_focus
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-(define-virtual draw_slider
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkOrientation" "orientation")
- )
-)
-(define-virtual draw_handle
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GtkShadowType" "shadow_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GtkOrientation" "orientation")
- )
-)
-(define-virtual draw_expander
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("GtkExpanderStyle" "expander_style")
- )
-)
-(define-virtual draw_layout
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("gboolean" "use_text")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("gint" "x")
- '("gint" "y")
- '("PangoLayout*" "layout")
- )
-)
-(define-virtual draw_resize_grip
- (of-object "GtkStyle")
- (return-type "none")
- (parameters
- '("GdkWindow*" "window")
- '("GtkStateType" "state_type")
- '("GdkRectangle*" "area")
- '("GtkWidget*" "widget")
- '("const-gchar*" "detail")
- '("GdkWindowEdge" "edge")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktable.h
-
-(define-function gtk_table_get_type
- (c-name "gtk_table_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_table_new
- (c-name "gtk_table_new")
- (is-constructor-of "GtkTable")
- (return-type "GtkWidget*")
- (properties
- '("n_rows" (argname "rows") (optional))
- '("n_columns" (argname "columns") (optional))
- '("homogeneous" (optional))
- )
-)
-
-(define-method resize
- (of-object "GtkTable")
- (c-name "gtk_table_resize")
- (return-type "none")
- (parameters
- '("guint" "rows")
- '("guint" "columns")
- )
-)
-
-(define-method attach
- (of-object "GtkTable")
- (c-name "gtk_table_attach")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("guint" "left_attach")
- '("guint" "right_attach")
- '("guint" "top_attach")
- '("guint" "bottom_attach")
- '("GtkAttachOptions" "xoptions" (default "GTK_EXPAND|GTK_FILL"))
- '("GtkAttachOptions" "yoptions" (default "GTK_EXPAND|GTK_FILL"))
- '("guint" "xpadding" (default "0"))
- '("guint" "ypadding" (default "0"))
- )
-)
-
-(define-method attach_defaults
- (of-object "GtkTable")
- (c-name "gtk_table_attach_defaults")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("guint" "left_attach")
- '("guint" "right_attach")
- '("guint" "top_attach")
- '("guint" "bottom_attach")
- )
- (deprecated "use attach instead")
-)
-
-(define-method set_row_spacing
- (of-object "GtkTable")
- (c-name "gtk_table_set_row_spacing")
- (return-type "none")
- (parameters
- '("guint" "row")
- '("guint" "spacing")
- )
-)
-
-(define-method get_row_spacing
- (of-object "GtkTable")
- (c-name "gtk_table_get_row_spacing")
- (return-type "guint")
- (parameters
- '("guint" "row")
- )
-)
-
-(define-method set_col_spacing
- (of-object "GtkTable")
- (c-name "gtk_table_set_col_spacing")
- (return-type "none")
- (parameters
- '("guint" "column")
- '("guint" "spacing")
- )
-)
-
-(define-method get_col_spacing
- (of-object "GtkTable")
- (c-name "gtk_table_get_col_spacing")
- (return-type "guint")
- (parameters
- '("guint" "column")
- )
-)
-
-(define-method set_row_spacings
- (of-object "GtkTable")
- (c-name "gtk_table_set_row_spacings")
- (return-type "none")
- (parameters
- '("guint" "spacing")
- )
-)
-
-(define-method get_default_row_spacing
- (of-object "GtkTable")
- (c-name "gtk_table_get_default_row_spacing")
- (return-type "guint")
-)
-
-(define-method set_col_spacings
- (of-object "GtkTable")
- (c-name "gtk_table_set_col_spacings")
- (return-type "none")
- (parameters
- '("guint" "spacing")
- )
-)
-
-(define-method get_default_col_spacing
- (of-object "GtkTable")
- (c-name "gtk_table_get_default_col_spacing")
- (return-type "guint")
-)
-
-(define-method set_homogeneous
- (of-object "GtkTable")
- (c-name "gtk_table_set_homogeneous")
- (return-type "none")
- (parameters
- '("gboolean" "homogeneous")
- )
-)
-
-(define-method get_homogeneous
- (of-object "GtkTable")
- (c-name "gtk_table_get_homogeneous")
- (return-type "gboolean")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktearoffmenuitem.h
-
-(define-function gtk_tearoff_menu_item_get_type
- (c-name "gtk_tearoff_menu_item_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tearoff_menu_item_new
- (c-name "gtk_tearoff_menu_item_new")
- (is-constructor-of "GtkTearoffMenuItem")
- (return-type "GtkWidget*")
-)
-
-
-(define-function text_get_type
- (c-name "gtk_text_get_type")
- (return-type "GtkType")
-)
-
-(define-function text_new
- (c-name "gtk_text_new")
- (is-constructor-of "GtkText")
- (return-type "GtkWidget*")
- (parameters
- '("GtkAdjustment*" "hadj")
- '("GtkAdjustment*" "vadj")
- )
-)
-
-(define-method set_editable
- (of-object "GtkText")
- (c-name "gtk_text_set_editable")
- (return-type "none")
- (parameters
- '("gboolean" "editable")
- )
-)
-
-(define-method set_word_wrap
- (of-object "GtkText")
- (c-name "gtk_text_set_word_wrap")
- (return-type "none")
- (parameters
- '("gboolean" "word_wrap")
- )
-)
-
-(define-method set_line_wrap
- (of-object "GtkText")
- (c-name "gtk_text_set_line_wrap")
- (return-type "none")
- (parameters
- '("gboolean" "line_wrap")
- )
-)
-
-(define-method set_adjustments
- (of-object "GtkText")
- (c-name "gtk_text_set_adjustments")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "hadj")
- '("GtkAdjustment*" "vadj")
- )
-)
-
-(define-method set_point
- (of-object "GtkText")
- (c-name "gtk_text_set_point")
- (return-type "none")
- (parameters
- '("guint" "index")
- )
-)
-
-(define-method get_point
- (of-object "GtkText")
- (c-name "gtk_text_get_point")
- (return-type "guint")
-)
-
-(define-method get_length
- (of-object "GtkText")
- (c-name "gtk_text_get_length")
- (return-type "guint")
-)
-
-(define-method freeze
- (of-object "GtkText")
- (c-name "gtk_text_freeze")
- (return-type "none")
-)
-
-(define-method thaw
- (of-object "GtkText")
- (c-name "gtk_text_thaw")
- (return-type "none")
-)
-
-(define-method insert
- (of-object "GtkText")
- (c-name "gtk_text_insert")
- (return-type "none")
- (parameters
- '("GdkFont*" "font")
- '("const-GdkColor*" "fore")
- '("const-GdkColor*" "back")
- '("const-char*" "chars")
- '("gint" "length")
- )
-)
-
-(define-method backward_delete
- (of-object "GtkText")
- (c-name "gtk_text_backward_delete")
- (return-type "gboolean")
- (parameters
- '("guint" "nchars")
- )
-)
-
-(define-method forward_delete
- (of-object "GtkText")
- (c-name "gtk_text_forward_delete")
- (return-type "gboolean")
- (parameters
- '("guint" "nchars")
- )
-)
-
-(define-virtual set_scroll_adjustments
- (of-object "GtkText")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "hadjustment")
- '("GtkAdjustment*" "vadjustment")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktextbuffer.h
-
-(define-function gtk_text_buffer_get_type
- (c-name "gtk_text_buffer_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_text_buffer_new
- (c-name "gtk_text_buffer_new")
- (is-constructor-of "GtkTextBuffer")
- (return-type "GtkTextBuffer*")
- (properties
- '("tag_table" (argname "table") (optional))
- )
-)
-
-(define-method get_line_count
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_line_count")
- (return-type "gint")
-)
-
-(define-method get_char_count
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_char_count")
- (return-type "gint")
-)
-
-(define-method get_tag_table
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_tag_table")
- (return-type "GtkTextTagTable*")
-)
-
-(define-method set_text
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_set_text")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("gint" "len")
- )
-)
-
-(define-method insert
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_insert")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("const-gchar*" "text")
- '("gint" "len" (default "-1"))
- )
-)
-
-(define-method insert_at_cursor
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_insert_at_cursor")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("gint" "len" (default "-1"))
- )
-)
-
-(define-method insert_interactive
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_insert_interactive")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- '("const-gchar*" "text")
- '("gint" "len")
- '("gboolean" "default_editable")
- )
-)
-
-(define-method insert_interactive_at_cursor
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_insert_interactive_at_cursor")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "text")
- '("gint" "len")
- '("gboolean" "default_editable")
- )
-)
-
-(define-method insert_range
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_insert_range")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method insert_range_interactive
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_insert_range_interactive")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- '("gboolean" "default_editable")
- )
-)
-
-(define-method insert_with_tags
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_insert_with_tags")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("const-gchar*" "text")
- '("gint" "len")
- '("GtkTextTag*" "first_tag")
- )
- (varargs #t)
-)
-
-(define-method insert_with_tags_by_name
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_insert_with_tags_by_name")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("const-gchar*" "text")
- '("gint" "len")
- '("const-gchar*" "first_tag_name")
- )
- (varargs #t)
-)
-
-(define-method delete
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_delete")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "start")
- '("GtkTextIter*" "end")
- )
-)
-
-(define-method delete_interactive
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_delete_interactive")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "start_iter")
- '("GtkTextIter*" "end_iter")
- '("gboolean" "default_editable")
- )
-)
-
-(define-method get_text
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_text")
- (return-type "gchar*")
- (parameters
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- '("gboolean" "include_hidden_chars" (default "TRUE"))
- )
-)
-
-(define-method get_slice
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_slice")
- (return-type "gchar*")
- (parameters
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- '("gboolean" "include_hidden_chars" (default "TRUE"))
- )
-)
-
-(define-method insert_pixbuf
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_insert_pixbuf")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("GdkPixbuf*" "pixbuf")
- )
-)
-
-(define-method insert_child_anchor
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_insert_child_anchor")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("GtkTextChildAnchor*" "anchor")
- )
-)
-
-(define-method create_child_anchor
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_create_child_anchor")
- (return-type "GtkTextChildAnchor*")
- (parameters
- '("GtkTextIter*" "iter")
- )
-)
-
-(define-method create_mark
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_create_mark")
- (return-type "GtkTextMark*")
- (parameters
- '("const-gchar*" "mark_name" (null-ok))
- '("const-GtkTextIter*" "where")
- '("gboolean" "left_gravity" (default "FALSE"))
- )
-)
-
-(define-method move_mark
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_move_mark")
- (return-type "none")
- (parameters
- '("GtkTextMark*" "mark")
- '("const-GtkTextIter*" "where")
- )
-)
-
-(define-method delete_mark
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_delete_mark")
- (return-type "none")
- (parameters
- '("GtkTextMark*" "mark")
- )
-)
-
-(define-method get_mark
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_mark")
- (return-type "GtkTextMark*")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method move_mark_by_name
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_move_mark_by_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- '("const-GtkTextIter*" "where")
- )
-)
-
-(define-method delete_mark_by_name
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_delete_mark_by_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method get_insert
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_insert")
- (return-type "GtkTextMark*")
-)
-
-(define-method get_selection_bound
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_selection_bound")
- (return-type "GtkTextMark*")
-)
-
-(define-method place_cursor
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_place_cursor")
- (return-type "none")
- (parameters
- '("const-GtkTextIter*" "where")
- )
-)
-
-(define-method select_range
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_select_range")
- (return-type "none")
- (parameters
- '("const-GtkTextIter*" "ins")
- '("const-GtkTextIter*" "bound")
- )
-)
-
-(define-method apply_tag
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_apply_tag")
- (return-type "none")
- (parameters
- '("GtkTextTag*" "tag")
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method remove_tag
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_remove_tag")
- (return-type "none")
- (parameters
- '("GtkTextTag*" "tag")
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method apply_tag_by_name
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_apply_tag_by_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method remove_tag_by_name
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_remove_tag_by_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method remove_all_tags
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_remove_all_tags")
- (return-type "none")
- (parameters
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method create_tag
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_create_tag")
- (return-type "GtkTextTag*")
- (parameters
- '("const-gchar*" "tag_name")
- '("const-gchar*" "first_property_name")
- )
- (varargs #t)
-)
-
-(define-method get_iter_at_line_offset
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_iter_at_line_offset")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint" "line_number")
- '("gint" "char_offset")
- )
-)
-
-(define-method get_iter_at_line_index
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_iter_at_line_index")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint" "line_number")
- '("gint" "byte_index")
- )
-)
-
-(define-method get_iter_at_offset
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_iter_at_offset")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint" "char_offset")
- )
-)
-
-(define-method get_iter_at_line
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_iter_at_line")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint" "line_number")
- )
-)
-
-(define-method get_start_iter
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_start_iter")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- )
-)
-
-(define-method get_end_iter
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_end_iter")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- )
-)
-
-(define-method get_bounds
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_bounds")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "start")
- '("GtkTextIter*" "end")
- )
-)
-
-(define-method get_iter_at_mark
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_iter_at_mark")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("GtkTextMark*" "mark")
- )
-)
-
-(define-method get_iter_at_child_anchor
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_iter_at_child_anchor")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("GtkTextChildAnchor*" "anchor")
- )
-)
-
-(define-method get_modified
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_modified")
- (return-type "gboolean")
-)
-
-(define-method set_modified
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_set_modified")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method add_selection_clipboard
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_add_selection_clipboard")
- (return-type "none")
- (parameters
- '("GtkClipboard*" "clipboard")
- )
-)
-
-(define-method remove_selection_clipboard
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_remove_selection_clipboard")
- (return-type "none")
- (parameters
- '("GtkClipboard*" "clipboard")
- )
-)
-
-(define-method cut_clipboard
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_cut_clipboard")
- (return-type "none")
- (parameters
- '("GtkClipboard*" "clipboard")
- '("gboolean" "default_editable")
- )
-)
-
-(define-method copy_clipboard
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_copy_clipboard")
- (return-type "none")
- (parameters
- '("GtkClipboard*" "clipboard")
- )
-)
-
-(define-method paste_clipboard
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_paste_clipboard")
- (return-type "none")
- (parameters
- '("GtkClipboard*" "clipboard")
- '("GtkTextIter*" "override_location" (null-ok))
- '("gboolean" "default_editable")
- )
-)
-
-(define-method get_selection_bounds
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_get_selection_bounds")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "start")
- '("GtkTextIter*" "end")
- )
-)
-
-(define-method delete_selection
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_delete_selection")
- (return-type "gboolean")
- (parameters
- '("gboolean" "interactive")
- '("gboolean" "default_editable")
- )
-)
-
-(define-method begin_user_action
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_begin_user_action")
- (return-type "none")
-)
-
-(define-method end_user_action
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_end_user_action")
- (return-type "none")
-)
-
-(define-virtual insert_text
- (of-object "GtkTextBuffer")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "pos")
- '("const-gchar*" "text")
- '("gint" "length")
- )
-)
-(define-virtual insert_pixbuf
- (of-object "GtkTextBuffer")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "pos")
- '("GdkPixbuf*" "pixbuf")
- )
-)
-(define-virtual insert_child_anchor
- (of-object "GtkTextBuffer")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "pos")
- '("GtkTextChildAnchor*" "anchor")
- )
-)
-(define-virtual delete_range
- (of-object "GtkTextBuffer")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "start")
- '("GtkTextIter*" "end")
- )
-)
-(define-virtual changed
- (of-object "GtkTextBuffer")
- (return-type "none")
-)
-(define-virtual modified_changed
- (of-object "GtkTextBuffer")
- (return-type "none")
-)
-(define-virtual mark_set
- (of-object "GtkTextBuffer")
- (return-type "none")
- (parameters
- '("const-GtkTextIter*" "location")
- '("GtkTextMark*" "mark")
- )
-)
-(define-virtual mark_deleted
- (of-object "GtkTextBuffer")
- (return-type "none")
- (parameters
- '("GtkTextMark*" "mark")
- )
-)
-(define-virtual apply_tag
- (of-object "GtkTextBuffer")
- (return-type "none")
- (parameters
- '("GtkTextTag*" "tag")
- '("const-GtkTextIter*" "start_char")
- '("const-GtkTextIter*" "end_char")
- )
-)
-(define-virtual remove_tag
- (of-object "GtkTextBuffer")
- (return-type "none")
- (parameters
- '("GtkTextTag*" "tag")
- '("const-GtkTextIter*" "start_char")
- '("const-GtkTextIter*" "end_char")
- )
-)
-(define-virtual begin_user_action
- (of-object "GtkTextBuffer")
- (return-type "none")
-)
-(define-virtual end_user_action
- (of-object "GtkTextBuffer")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktextchild.h
-
-(define-function gtk_text_child_anchor_get_type
- (c-name "gtk_text_child_anchor_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_text_child_anchor_new
- (c-name "gtk_text_child_anchor_new")
- (is-constructor-of "GtkTextChildAnchor")
- (return-type "GtkTextChildAnchor*")
-)
-
-(define-method get_widgets
- (of-object "GtkTextChildAnchor")
- (c-name "gtk_text_child_anchor_get_widgets")
- (return-type "GList*")
-)
-
-(define-method get_deleted
- (of-object "GtkTextChildAnchor")
- (c-name "gtk_text_child_anchor_get_deleted")
- (return-type "gboolean")
-)
-
-(define-method backspace
- (of-object "GtkTextBuffer")
- (c-name "gtk_text_buffer_backspace")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- '("gboolean" "interactive")
- '("gboolean" "default_editable")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktextdisplay.h
-
-(define-method draw
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_draw")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("GdkDrawable*" "drawable")
- '("GdkGC*" "cursor_gc")
- '("gint" "x_offset")
- '("gint" "y_offset")
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- '("GList**" "widgets")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktextiter.h
-
-(define-method get_buffer
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_buffer")
- (return-type "GtkTextBuffer*")
-)
-
-(define-method copy
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_copy")
- (return-type "GtkTextIter*")
- (caller-owns-return #t)
-)
-
-(define-method free
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_free")
- (return-type "none")
-)
-
-(define-function gtk_text_iter_get_type
- (c-name "gtk_text_iter_get_type")
- (return-type "GType")
-)
-
-(define-method get_offset
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_offset")
- (return-type "gint")
-)
-
-(define-method get_line
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_line")
- (return-type "gint")
-)
-
-(define-method get_line_offset
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_line_offset")
- (return-type "gint")
-)
-
-(define-method get_line_index
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_line_index")
- (return-type "gint")
-)
-
-(define-method get_visible_line_offset
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_visible_line_offset")
- (return-type "gint")
-)
-
-(define-method get_visible_line_index
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_visible_line_index")
- (return-type "gint")
-)
-
-(define-method get_char
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_char")
- (return-type "gunichar")
-)
-
-(define-method get_slice
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_slice")
- (return-type "gchar*")
- (parameters
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method get_text
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_text")
- (return-type "gchar*")
- (parameters
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method get_visible_slice
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_visible_slice")
- (return-type "gchar*")
- (parameters
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method get_visible_text
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_visible_text")
- (return-type "gchar*")
- (parameters
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method get_pixbuf
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_pixbuf")
- (return-type "GdkPixbuf*")
-)
-
-(define-method get_marks
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_marks")
- (return-type "GSList*")
-)
-
-(define-method get_child_anchor
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_child_anchor")
- (return-type "GtkTextChildAnchor*")
-)
-
-(define-method get_toggled_tags
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_toggled_tags")
- (return-type "GSList*")
- (parameters
- '("gboolean" "toggled_on")
- )
-)
-
-(define-method begins_tag
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_begins_tag")
- (return-type "gboolean")
- (parameters
- '("GtkTextTag*" "tag" (null-ok) (default "NULL"))
- )
-)
-
-(define-method ends_tag
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_ends_tag")
- (return-type "gboolean")
- (parameters
- '("GtkTextTag*" "tag" (null-ok) (default "NULL"))
- )
-)
-
-(define-method toggles_tag
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_toggles_tag")
- (return-type "gboolean")
- (parameters
- '("GtkTextTag*" "tag" (null-ok) (default "NULL"))
- )
-)
-
-(define-method has_tag
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_has_tag")
- (return-type "gboolean")
- (parameters
- '("GtkTextTag*" "tag")
- )
-)
-
-(define-method get_tags
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_tags")
- (return-type "GSList*")
-)
-
-(define-method editable
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_editable")
- (return-type "gboolean")
- (parameters
- '("gboolean" "default_setting")
- )
-)
-
-(define-method can_insert
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_can_insert")
- (return-type "gboolean")
- (parameters
- '("gboolean" "default_editability")
- )
-)
-
-(define-method starts_word
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_starts_word")
- (return-type "gboolean")
-)
-
-(define-method ends_word
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_ends_word")
- (return-type "gboolean")
-)
-
-(define-method inside_word
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_inside_word")
- (return-type "gboolean")
-)
-
-(define-method starts_sentence
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_starts_sentence")
- (return-type "gboolean")
-)
-
-(define-method ends_sentence
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_ends_sentence")
- (return-type "gboolean")
-)
-
-(define-method inside_sentence
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_inside_sentence")
- (return-type "gboolean")
-)
-
-(define-method starts_line
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_starts_line")
- (return-type "gboolean")
-)
-
-(define-method ends_line
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_ends_line")
- (return-type "gboolean")
-)
-
-(define-method is_cursor_position
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_is_cursor_position")
- (return-type "gboolean")
-)
-
-(define-method get_chars_in_line
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_chars_in_line")
- (return-type "gint")
-)
-
-(define-method get_bytes_in_line
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_bytes_in_line")
- (return-type "gint")
-)
-
-(define-method get_attributes
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_attributes")
- (return-type "gboolean")
- (parameters
- '("GtkTextAttributes*" "values")
- )
-)
-
-(define-method get_language
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_get_language")
- (return-type "PangoLanguage*")
-)
-
-(define-method is_end
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_is_end")
- (return-type "gboolean")
-)
-
-(define-method is_start
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_is_start")
- (return-type "gboolean")
-)
-
-(define-method forward_char
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_char")
- (return-type "gboolean")
-)
-
-(define-method backward_char
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_char")
- (return-type "gboolean")
-)
-
-(define-method forward_chars
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_chars")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method backward_chars
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_chars")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method forward_line
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_line")
- (return-type "gboolean")
-)
-
-(define-method backward_line
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_line")
- (return-type "gboolean")
-)
-
-(define-method forward_lines
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_lines")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method backward_lines
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_lines")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method forward_word_end
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_word_end")
- (return-type "gboolean")
-)
-
-(define-method backward_word_start
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_word_start")
- (return-type "gboolean")
-)
-
-(define-method forward_word_ends
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_word_ends")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method backward_word_starts
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_word_starts")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method forward_visible_line
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_visible_line")
- (return-type "gboolean")
-)
-
-(define-method backward_visible_line
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_visible_line")
- (return-type "gboolean")
-)
-
-(define-method forward_visible_lines
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_visible_lines")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method backward_visible_lines
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_visible_lines")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method forward_visible_word_end
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_visible_word_end")
- (return-type "gboolean")
-)
-
-(define-method backward_visible_word_start
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_visible_word_start")
- (return-type "gboolean")
-)
-
-(define-method forward_visible_word_ends
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_visible_word_ends")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method backward_visible_word_starts
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_visible_word_starts")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method forward_sentence_end
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_sentence_end")
- (return-type "gboolean")
-)
-
-(define-method backward_sentence_start
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_sentence_start")
- (return-type "gboolean")
-)
-
-(define-method forward_sentence_ends
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_sentence_ends")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method backward_sentence_starts
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_sentence_starts")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method forward_cursor_position
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_cursor_position")
- (return-type "gboolean")
-)
-
-(define-method backward_cursor_position
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_cursor_position")
- (return-type "gboolean")
-)
-
-(define-method forward_cursor_positions
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_cursor_positions")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method backward_cursor_positions
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_cursor_positions")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method forward_visible_cursor_position
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_visible_cursor_position")
- (return-type "gboolean")
-)
-
-(define-method backward_visible_cursor_position
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_visible_cursor_position")
- (return-type "gboolean")
-)
-
-(define-method forward_visible_cursor_positions
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_visible_cursor_positions")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method backward_visible_cursor_positions
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_visible_cursor_positions")
- (return-type "gboolean")
- (parameters
- '("gint" "count")
- )
-)
-
-(define-method set_offset
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_set_offset")
- (return-type "none")
- (parameters
- '("gint" "char_offset")
- )
-)
-
-(define-method set_line
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_set_line")
- (return-type "none")
- (parameters
- '("gint" "line_number")
- )
-)
-
-(define-method set_line_offset
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_set_line_offset")
- (return-type "none")
- (parameters
- '("gint" "char_on_line")
- )
-)
-
-(define-method set_line_index
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_set_line_index")
- (return-type "none")
- (parameters
- '("gint" "byte_on_line")
- )
-)
-
-(define-method forward_to_end
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_to_end")
- (return-type "none")
-)
-
-(define-method forward_to_line_end
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_to_line_end")
- (return-type "gboolean")
-)
-
-(define-method set_visible_line_offset
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_set_visible_line_offset")
- (return-type "none")
- (parameters
- '("gint" "char_on_line")
- )
-)
-
-(define-method set_visible_line_index
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_set_visible_line_index")
- (return-type "none")
- (parameters
- '("gint" "byte_on_line")
- )
-)
-
-(define-method forward_to_tag_toggle
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_to_tag_toggle")
- (return-type "gboolean")
- (parameters
- '("GtkTextTag*" "tag" (null-ok))
- )
-)
-
-(define-method backward_to_tag_toggle
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_to_tag_toggle")
- (return-type "gboolean")
- (parameters
- '("GtkTextTag*" "tag" (null-ok))
- )
-)
-
-(define-method forward_find_char
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_find_char")
- (return-type "gboolean")
- (parameters
- '("GtkTextCharPredicate" "pred")
- '("gpointer" "user_data")
- '("const-GtkTextIter*" "limit")
- )
-)
-
-(define-method backward_find_char
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_find_char")
- (return-type "gboolean")
- (parameters
- '("GtkTextCharPredicate" "pred")
- '("gpointer" "user_data")
- '("const-GtkTextIter*" "limit")
- )
-)
-
-(define-method forward_search
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_forward_search")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "str")
- '("GtkTextSearchFlags" "flags")
- '("GtkTextIter*" "match_start")
- '("GtkTextIter*" "match_end")
- '("const-GtkTextIter*" "limit" (null-ok))
- )
-)
-
-(define-method backward_search
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_backward_search")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "str")
- '("GtkTextSearchFlags" "flags")
- '("GtkTextIter*" "match_start")
- '("GtkTextIter*" "match_end")
- '("const-GtkTextIter*" "limit" (null-ok))
- )
-)
-
-(define-method equal
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_equal")
- (return-type "gboolean")
- (parameters
- '("const-GtkTextIter*" "rhs")
- )
-)
-
-(define-method compare
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_compare")
- (return-type "gint")
- (parameters
- '("const-GtkTextIter*" "rhs")
- )
-)
-
-(define-method in_range
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_in_range")
- (return-type "gboolean")
- (parameters
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method order
- (of-object "GtkTextIter")
- (c-name "gtk_text_iter_order")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "second")
- )
-)
-
-;; From /usr/include/gtk-2.0/gtk/gtktextlayout.h
-
-(define-function gtk_text_layout_get_type
- (c-name "gtk_text_layout_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_text_layout_new
- (c-name "gtk_text_layout_new")
- (is-constructor-of "GtkTextLayout")
- (return-type "GtkTextLayout*")
-)
-
-(define-method set_buffer
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_set_buffer")
- (return-type "none")
- (parameters
- '("GtkTextBuffer*" "buffer")
- )
-)
-
-(define-method get_buffer
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_buffer")
- (return-type "GtkTextBuffer*")
-)
-
-(define-method set_default_style
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_set_default_style")
- (return-type "none")
- (parameters
- '("GtkTextAttributes*" "values")
- )
-)
-
-(define-method set_contexts
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_set_contexts")
- (return-type "none")
- (parameters
- '("PangoContext*" "ltr_context")
- '("PangoContext*" "rtl_context")
- )
-)
-
-(define-method set_cursor_direction
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_set_cursor_direction")
- (return-type "none")
- (parameters
- '("GtkTextDirection" "direction")
- )
-)
-
-(define-method set_keyboard_direction
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_set_keyboard_direction")
- (return-type "none")
- (parameters
- '("GtkTextDirection" "keyboard_dir")
- )
-)
-
-(define-method default_style_changed
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_default_style_changed")
- (return-type "none")
-)
-
-(define-method set_screen_width
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_set_screen_width")
- (return-type "none")
- (parameters
- '("gint" "width")
- )
-)
-
-(define-method set_preedit_string
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_set_preedit_string")
- (return-type "none")
- (parameters
- '("const-gchar*" "preedit_string")
- '("PangoAttrList*" "preedit_attrs")
- '("gint" "cursor_pos")
- )
-)
-
-(define-method set_cursor_visible
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_set_cursor_visible")
- (return-type "none")
- (parameters
- '("gboolean" "cursor_visible")
- )
-)
-
-(define-method get_cursor_visible
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_cursor_visible")
- (return-type "gboolean")
-)
-
-(define-method get_size
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_size")
- (return-type "none")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-method get_lines
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_lines")
- (return-type "GSList*")
- (parameters
- '("gint" "top_y")
- '("gint" "bottom_y")
- '("gint*" "first_line_y")
- )
-)
-
-(define-method wrap_loop_start
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_wrap_loop_start")
- (return-type "none")
-)
-
-(define-method wrap_loop_end
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_wrap_loop_end")
- (return-type "none")
-)
-
-(define-method get_line_display
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_line_display")
- (return-type "GtkTextLineDisplay*")
- (parameters
- '("GtkTextLine*" "line")
- '("gboolean" "size_only")
- )
-)
-
-(define-method free_line_display
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_free_line_display")
- (return-type "none")
- (parameters
- '("GtkTextLineDisplay*" "display")
- )
-)
-
-(define-method get_line_at_y
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_line_at_y")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "target_iter")
- '("gint" "y")
- '("gint*" "line_top")
- )
-)
-
-(define-method get_iter_at_pixel
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_iter_at_pixel")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method get_iter_at_position
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_iter_at_position")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint*" "trailing")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method invalidate
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_invalidate")
- (return-type "none")
- (parameters
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-method free_line_data
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_free_line_data")
- (return-type "none")
- (parameters
- '("GtkTextLine*" "line")
- '("GtkTextLineData*" "line_data")
- )
-)
-
-(define-method is_valid
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_is_valid")
- (return-type "gboolean")
-)
-
-(define-method validate_yrange
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_validate_yrange")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "anchor_line")
- '("gint" "y0_")
- '("gint" "y1_")
- )
-)
-
-(define-method validate
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_validate")
- (return-type "none")
- (parameters
- '("gint" "max_pixels")
- )
-)
-
-(define-method wrap
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_wrap")
- (return-type "GtkTextLineData*")
- (parameters
- '("GtkTextLine*" "line")
- '("GtkTextLineData*" "line_data")
- )
-)
-
-(define-method changed
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_changed")
- (return-type "none")
- (parameters
- '("gint" "y")
- '("gint" "old_height")
- '("gint" "new_height")
- )
-)
-
-(define-method get_iter_location
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_iter_location")
- (return-type "none")
- (parameters
- '("const-GtkTextIter*" "iter")
- '("GdkRectangle*" "rect")
- )
-)
-
-(define-method get_line_yrange
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_line_yrange")
- (return-type "none")
- (parameters
- '("const-GtkTextIter*" "iter")
- '("gint*" "y")
- '("gint*" "height")
- )
-)
-
-(define-method get_cursor_locations
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_cursor_locations")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("GdkRectangle*" "strong_pos")
- '("GdkRectangle*" "weak_pos")
- )
-)
-
-(define-method clamp_iter_to_vrange
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_clamp_iter_to_vrange")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint" "top")
- '("gint" "bottom")
- )
-)
-
-(define-method move_iter_to_line_end
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_move_iter_to_line_end")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint" "direction")
- )
-)
-
-(define-method move_iter_to_previous_line
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_move_iter_to_previous_line")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- )
-)
-
-(define-method move_iter_to_next_line
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_move_iter_to_next_line")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- )
-)
-
-(define-method move_iter_to_x
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_move_iter_to_x")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint" "x")
- )
-)
-
-(define-method move_iter_visually
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_move_iter_visually")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint" "count")
- )
-)
-
-(define-method iter_starts_line
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_iter_starts_line")
- (return-type "gboolean")
- (parameters
- '("const-GtkTextIter*" "iter")
- )
-)
-
-(define-method get_iter_at_line
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_get_iter_at_line")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("GtkTextLine*" "line")
- '("gint" "byte_offset")
- )
-)
-
-(define-virtual invalidated
- (of-object "GtkTextLayout")
- (return-type "none")
-)
-
-(define-virtual changed
- (of-object "GtkTextLayout")
- (return-type "none")
- (parameters
- '("gint" "y")
- '("gint" "old_height")
- '("gint" "new_height")
- )
-)
-
-(define-virtual wrap
- (of-object "GtkTextLayout")
- (return-type "GtkTextLineData*")
- (parameters
- '("GtkTextLine*" "line")
- '("GtkTextLineData*" "line_data")
- )
-)
-
-(define-virtual get_log_attrs
- (of-object "GtkTextLayout")
- (return-type "none")
- (parameters
- '("GtkTextLine*" "line")
- '("PangoLogAttr**" "attrs")
- '("gint*" "n_attrs")
- )
-)
-
-(define-virtual invalidate
- (of-object "GtkTextLayout")
- (return-type "none")
- (parameters
- '("const-GtkTextIter*" "start")
- '("const-GtkTextIter*" "end")
- )
-)
-
-(define-virtual free_line_data
- (of-object "GtkTextLayout")
- (return-type "none")
- (parameters
- '("GtkTextLine*" "line")
- '("GtkTextLineData*" "line_data")
- )
-)
-
-(define-virtual allocate_child
- (of-object "GtkTextLayout")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method register_child
- (of-object "GtkTextChildAnchor")
- (c-name "gtk_text_child_anchor_register_child")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("GtkTextLayout*" "layout")
- )
-)
-
-(define-method unregister_child
- (of-object "GtkTextChildAnchor")
- (c-name "gtk_text_child_anchor_unregister_child")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method queue_resize
- (of-object "GtkTextChildAnchor")
- (c-name "gtk_text_child_anchor_queue_resize")
- (return-type "none")
- (parameters
- '("GtkTextLayout*" "layout")
- )
-)
-
-(define-function gtk_text_anchored_child_set_layout
- (c-name "gtk_text_anchored_child_set_layout")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("GtkTextLayout*" "layout")
- )
-)
-
-(define-method spew
- (of-object "GtkTextLayout")
- (c-name "gtk_text_layout_spew")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktextmark.h
-
-(define-function gtk_text_mark_get_type
- (c-name "gtk_text_mark_get_type")
- (return-type "GType")
-)
-
-(define-method set_visible
- (of-object "GtkTextMark")
- (c-name "gtk_text_mark_set_visible")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_visible
- (of-object "GtkTextMark")
- (c-name "gtk_text_mark_get_visible")
- (return-type "gboolean")
-)
-
-(define-method get_name
- (of-object "GtkTextMark")
- (c-name "gtk_text_mark_get_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_deleted
- (of-object "GtkTextMark")
- (c-name "gtk_text_mark_get_deleted")
- (return-type "gboolean")
-)
-
-(define-method get_buffer
- (of-object "GtkTextMark")
- (c-name "gtk_text_mark_get_buffer")
- (return-type "GtkTextBuffer*")
-)
-
-(define-method get_left_gravity
- (of-object "GtkTextMark")
- (c-name "gtk_text_mark_get_left_gravity")
- (return-type "gboolean")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktexttag.h
-
-(define-function gtk_text_tag_get_type
- (c-name "gtk_text_tag_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_text_tag_new
- (c-name "gtk_text_tag_new")
- (is-constructor-of "GtkTextTag")
- (return-type "GtkTextTag*")
- (properties
- '("name" (optional))
- )
-)
-
-(define-method get_priority
- (of-object "GtkTextTag")
- (c-name "gtk_text_tag_get_priority")
- (return-type "gint")
-)
-
-(define-method set_priority
- (of-object "GtkTextTag")
- (c-name "gtk_text_tag_set_priority")
- (return-type "none")
- (parameters
- '("gint" "priority")
- )
-)
-
-(define-method event
- (of-object "GtkTextTag")
- (c-name "gtk_text_tag_event")
- (return-type "gboolean")
- (parameters
- '("GObject*" "event_object")
- '("GdkEvent*" "event")
- '("const-GtkTextIter*" "iter")
- )
-)
-
-(define-virtual event
- (of-object "GtkTextTag")
- (return-type "gboolean")
- (parameters
- '("GObject*" "event_object")
- '("GdkEvent*" "event")
- '("const-GtkTextIter*" "iter")
- )
-)
-
-(define-function gtk_text_attributes_new
- (c-name "gtk_text_attributes_new")
- (is-constructor-of "GtkTextAttributes")
- (return-type "GtkTextAttributes*")
-)
-
-(define-method copy
- (of-object "GtkTextAttributes")
- (c-name "gtk_text_attributes_copy")
- (return-type "GtkTextAttributes*")
- (caller-owns-return #t)
-)
-
-(define-method copy_values
- (of-object "GtkTextAttributes")
- (c-name "gtk_text_attributes_copy_values")
- (return-type "none")
- (parameters
- '("GtkTextAttributes*" "dest")
- )
-)
-
-(define-method unref
- (of-object "GtkTextAttributes")
- (c-name "gtk_text_attributes_unref")
- (return-type "none")
-)
-
-(define-method ref
- (of-object "GtkTextAttributes")
- (c-name "gtk_text_attributes_ref")
- (return-type "none")
-)
-
-(define-function gtk_text_attributes_get_type
- (c-name "gtk_text_attributes_get_type")
- (return-type "GType")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktexttagtable.h
-
-(define-function gtk_text_tag_table_get_type
- (c-name "gtk_text_tag_table_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_text_tag_table_new
- (c-name "gtk_text_tag_table_new")
- (is-constructor-of "GtkTextTagTable")
- (return-type "GtkTextTagTable*")
-)
-
-(define-method add
- (of-object "GtkTextTagTable")
- (c-name "gtk_text_tag_table_add")
- (return-type "none")
- (parameters
- '("GtkTextTag*" "tag")
- )
-)
-
-(define-method remove
- (of-object "GtkTextTagTable")
- (c-name "gtk_text_tag_table_remove")
- (return-type "none")
- (parameters
- '("GtkTextTag*" "tag")
- )
-)
-
-(define-method lookup
- (of-object "GtkTextTagTable")
- (c-name "gtk_text_tag_table_lookup")
- (return-type "GtkTextTag*")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method foreach
- (of-object "GtkTextTagTable")
- (c-name "gtk_text_tag_table_foreach")
- (return-type "none")
- (parameters
- '("GtkTextTagTableForeach" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method get_size
- (of-object "GtkTextTagTable")
- (c-name "gtk_text_tag_table_get_size")
- (return-type "gint")
-)
-
-(define-virtual tag_changed
- (of-object "GtkTextTagTable")
- (return-type "none")
- (parameters
- '("GtkTextTag*" "tag")
- '("gboolean" "size_changed")
- )
-)
-(define-virtual tag_added
- (of-object "GtkTextTagTable")
- (return-type "none")
- (parameters
- '("GtkTextTag*" "tag")
- )
-)
-(define-virtual tag_removed
- (of-object "GtkTextTagTable")
- (return-type "none")
- (parameters
- '("GtkTextTag*" "tag")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktextview.h
-
-(define-function gtk_text_view_get_type
- (c-name "gtk_text_view_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_text_view_new
- (c-name "gtk_text_view_new")
- (is-constructor-of "GtkTextView")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_text_view_new_with_buffer
- (c-name "gtk_text_view_new_with_buffer")
- (is-constructor-of "GtkTextView")
- (return-type "GtkWidget*")
- (properties
- '("buffer" (optional))
- )
-)
-
-(define-method set_buffer
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_buffer")
- (return-type "none")
- (parameters
- '("GtkTextBuffer*" "buffer")
- )
-)
-
-(define-method get_buffer
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_buffer")
- (return-type "GtkTextBuffer*")
-)
-
-(define-method scroll_to_iter
- (of-object "GtkTextView")
- (c-name "gtk_text_view_scroll_to_iter")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- '("gdouble" "within_margin")
- '("gboolean" "use_align" (default "FALSE"))
- '("gdouble" "xalign" (default "0.5"))
- '("gdouble" "yalign" (default "0.5"))
- )
-)
-
-(define-method scroll_to_mark
- (of-object "GtkTextView")
- (c-name "gtk_text_view_scroll_to_mark")
- (return-type "none")
- (parameters
- '("GtkTextMark*" "mark")
- '("gdouble" "within_margin")
- '("gboolean" "use_align" (default "FALSE"))
- '("gdouble" "xalign" (default "0.5"))
- '("gdouble" "yalign" (default "0.5"))
- )
-)
-
-(define-method scroll_mark_onscreen
- (of-object "GtkTextView")
- (c-name "gtk_text_view_scroll_mark_onscreen")
- (return-type "none")
- (parameters
- '("GtkTextMark*" "mark")
- )
-)
-
-(define-method move_mark_onscreen
- (of-object "GtkTextView")
- (c-name "gtk_text_view_move_mark_onscreen")
- (return-type "gboolean")
- (parameters
- '("GtkTextMark*" "mark")
- )
-)
-
-(define-method place_cursor_onscreen
- (of-object "GtkTextView")
- (c-name "gtk_text_view_place_cursor_onscreen")
- (return-type "gboolean")
-)
-
-(define-method get_visible_rect
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_visible_rect")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "visible_rect")
- )
-)
-
-(define-method set_cursor_visible
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_cursor_visible")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_cursor_visible
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_cursor_visible")
- (return-type "gboolean")
-)
-
-(define-method get_iter_location
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_iter_location")
- (return-type "none")
- (parameters
- '("const-GtkTextIter*" "iter")
- '("GdkRectangle*" "location")
- )
-)
-
-(define-method get_iter_at_location
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_iter_at_location")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method get_iter_at_position
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_iter_at_position")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint*" "trailing")
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method get_line_yrange
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_line_yrange")
- (return-type "none")
- (parameters
- '("const-GtkTextIter*" "iter")
- '("gint*" "y")
- '("gint*" "height")
- )
-)
-
-(define-method get_line_at_y
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_line_at_y")
- (return-type "none")
- (parameters
- '("GtkTextIter*" "target_iter")
- '("gint" "y")
- '("gint*" "line_top")
- )
-)
-
-(define-method buffer_to_window_coords
- (of-object "GtkTextView")
- (c-name "gtk_text_view_buffer_to_window_coords")
- (return-type "none")
- (parameters
- '("GtkTextWindowType" "win")
- '("gint" "buffer_x")
- '("gint" "buffer_y")
- '("gint*" "window_x")
- '("gint*" "window_y")
- )
-)
-
-(define-method window_to_buffer_coords
- (of-object "GtkTextView")
- (c-name "gtk_text_view_window_to_buffer_coords")
- (return-type "none")
- (parameters
- '("GtkTextWindowType" "win")
- '("gint" "window_x")
- '("gint" "window_y")
- '("gint*" "buffer_x")
- '("gint*" "buffer_y")
- )
-)
-
-(define-method get_window
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_window")
- (return-type "GdkWindow*")
- (parameters
- '("GtkTextWindowType" "win")
- )
-)
-
-(define-method get_window_type
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_window_type")
- (return-type "GtkTextWindowType")
- (parameters
- '("GdkWindow*" "window")
- )
-)
-
-(define-method set_border_window_size
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_border_window_size")
- (return-type "none")
- (parameters
- '("GtkTextWindowType" "type")
- '("gint" "size")
- )
-)
-
-(define-method get_border_window_size
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_border_window_size")
- (return-type "gint")
- (parameters
- '("GtkTextWindowType" "type")
- )
-)
-
-(define-method forward_display_line
- (of-object "GtkTextView")
- (c-name "gtk_text_view_forward_display_line")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- )
-)
-
-(define-method backward_display_line
- (of-object "GtkTextView")
- (c-name "gtk_text_view_backward_display_line")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- )
-)
-
-(define-method forward_display_line_end
- (of-object "GtkTextView")
- (c-name "gtk_text_view_forward_display_line_end")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- )
-)
-
-(define-method backward_display_line_start
- (of-object "GtkTextView")
- (c-name "gtk_text_view_backward_display_line_start")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- )
-)
-
-(define-method starts_display_line
- (of-object "GtkTextView")
- (c-name "gtk_text_view_starts_display_line")
- (return-type "gboolean")
- (parameters
- '("const-GtkTextIter*" "iter")
- )
-)
-
-(define-method move_visually
- (of-object "GtkTextView")
- (c-name "gtk_text_view_move_visually")
- (return-type "gboolean")
- (parameters
- '("GtkTextIter*" "iter")
- '("gint" "count")
- )
-)
-
-(define-method add_child_at_anchor
- (of-object "GtkTextView")
- (c-name "gtk_text_view_add_child_at_anchor")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("GtkTextChildAnchor*" "anchor")
- )
-)
-
-(define-method add_child_in_window
- (of-object "GtkTextView")
- (c-name "gtk_text_view_add_child_in_window")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("GtkTextWindowType" "which_window")
- '("gint" "xpos")
- '("gint" "ypos")
- )
-)
-
-(define-method move_child
- (of-object "GtkTextView")
- (c-name "gtk_text_view_move_child")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("gint" "xpos")
- '("gint" "ypos")
- )
-)
-
-(define-method set_wrap_mode
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_wrap_mode")
- (return-type "none")
- (parameters
- '("GtkWrapMode" "wrap_mode")
- )
-)
-
-(define-method get_wrap_mode
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_wrap_mode")
- (return-type "GtkWrapMode")
-)
-
-(define-method set_editable
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_editable")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_editable
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_editable")
- (return-type "gboolean")
-)
-
-(define-method set_overwrite
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_overwrite")
- (return-type "none")
- (parameters
- '("gboolean" "overwrite")
- )
-)
-
-(define-method get_overwrite
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_overwrite")
- (return-type "gboolean")
-)
-
-(define-method set_accepts_tab
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_accepts_tab")
- (return-type "none")
- (parameters
- '("gboolean" "accepts_tab")
- )
-)
-
-(define-method get_accepts_tab
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_accepts_tab")
- (return-type "gboolean")
-)
-
-(define-method set_pixels_above_lines
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_pixels_above_lines")
- (return-type "none")
- (parameters
- '("gint" "pixels_above_lines")
- )
-)
-
-(define-method get_pixels_above_lines
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_pixels_above_lines")
- (return-type "gint")
-)
-
-(define-method set_pixels_below_lines
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_pixels_below_lines")
- (return-type "none")
- (parameters
- '("gint" "pixels_below_lines")
- )
-)
-
-(define-method get_pixels_below_lines
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_pixels_below_lines")
- (return-type "gint")
-)
-
-(define-method set_pixels_inside_wrap
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_pixels_inside_wrap")
- (return-type "none")
- (parameters
- '("gint" "pixels_inside_wrap")
- )
-)
-
-(define-method get_pixels_inside_wrap
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_pixels_inside_wrap")
- (return-type "gint")
-)
-
-(define-method set_justification
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_justification")
- (return-type "none")
- (parameters
- '("GtkJustification" "justification")
- )
-)
-
-(define-method get_justification
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_justification")
- (return-type "GtkJustification")
-)
-
-(define-method set_left_margin
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_left_margin")
- (return-type "none")
- (parameters
- '("gint" "left_margin")
- )
-)
-
-(define-method get_left_margin
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_left_margin")
- (return-type "gint")
-)
-
-(define-method set_right_margin
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_right_margin")
- (return-type "none")
- (parameters
- '("gint" "right_margin")
- )
-)
-
-(define-method get_right_margin
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_right_margin")
- (return-type "gint")
-)
-
-(define-method set_indent
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_indent")
- (return-type "none")
- (parameters
- '("gint" "indent")
- )
-)
-
-(define-method get_indent
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_indent")
- (return-type "gint")
-)
-
-(define-method set_tabs
- (of-object "GtkTextView")
- (c-name "gtk_text_view_set_tabs")
- (return-type "none")
- (parameters
- '("PangoTabArray*" "tabs")
- )
-)
-
-(define-method get_tabs
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_tabs")
- (return-type "PangoTabArray*")
-)
-
-(define-method get_default_attributes
- (of-object "GtkTextView")
- (c-name "gtk_text_view_get_default_attributes")
- (return-type "GtkTextAttributes*")
-)
-
-(define-virtual set_scroll_adjustments
- (of-object "GtkTextView")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "hadjustment")
- '("GtkAdjustment*" "vadjustment")
- )
-)
-(define-virtual populate_popup
- (of-object "GtkTextView")
- (return-type "none")
- (parameters
- '("GtkMenu*" "menu")
- )
-)
-(define-virtual move_cursor
- (of-object "GtkTextView")
- (return-type "none")
- (parameters
- '("GtkMovementStep" "step")
- '("gint" "count")
- '("gboolean" "extend_selection")
- )
-)
-(define-virtual page_horizontally
- (of-object "GtkTextView")
- (return-type "none")
- (parameters
- '("gint" "count")
- '("gboolean" "extend_selection")
- )
-)
-(define-virtual set_anchor
- (of-object "GtkTextView")
- (return-type "none")
-)
-(define-virtual insert_at_cursor
- (of-object "GtkTextView")
- (return-type "none")
- (parameters
- '("const-gchar*" "str")
- )
-)
-(define-virtual delete_from_cursor
- (of-object "GtkTextView")
- (return-type "none")
- (parameters
- '("GtkDeleteType" "type")
- '("gint" "count")
- )
-)
-(define-virtual backspace
- (of-object "GtkTextView")
- (return-type "none")
-)
-(define-virtual cut_clipboard
- (of-object "GtkTextView")
- (return-type "none")
-)
-(define-virtual copy_clipboard
- (of-object "GtkTextView")
- (return-type "none")
-)
-(define-virtual paste_clipboard
- (of-object "GtkTextView")
- (return-type "none")
-)
-(define-virtual toggle_overwrite
- (of-object "GtkTextView")
- (return-type "none")
-)
-(define-virtual move_focus
- (of-object "GtkTextView")
- (return-type "none")
- (parameters
- '("GtkDirectionType" "direction")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktipsquery.h
-
-(define-function gtk_tips_query_get_type
- (c-name "gtk_tips_query_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tips_query_new
- (c-name "gtk_tips_query_new")
- (is-constructor-of "GtkTipsQuery")
- (return-type "GtkWidget*")
- (deprecated "")
-)
-
-(define-method start_query
- (of-object "GtkTipsQuery")
- (c-name "gtk_tips_query_start_query")
- (return-type "none")
- (deprecated "")
-)
-
-(define-method stop_query
- (of-object "GtkTipsQuery")
- (c-name "gtk_tips_query_stop_query")
- (return-type "none")
- (deprecated "")
-)
-
-(define-method set_caller
- (of-object "GtkTipsQuery")
- (c-name "gtk_tips_query_set_caller")
- (return-type "none")
- (parameters
- '("GtkWidget*" "caller")
- )
- (deprecated "")
-)
-
-(define-method set_labels
- (of-object "GtkTipsQuery")
- (c-name "gtk_tips_query_set_labels")
- (return-type "none")
- (parameters
- '("const-gchar*" "label_inactive")
- '("const-gchar*" "label_no_tip")
- )
- (deprecated "")
-)
-
-(define-virtual start_query
- (of-object "GtkTipsQuery")
- (return-type "none")
-)
-(define-virtual stop_query
- (of-object "GtkTipsQuery")
- (return-type "none")
-)
-(define-virtual widget_entered
- (of-object "GtkTipsQuery")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("const-gchar*" "tip_text")
- '("const-gchar*" "tip_private")
- )
-)
-(define-virtual widget_selected
- (of-object "GtkTipsQuery")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "widget")
- '("const-gchar*" "tip_text")
- '("const-gchar*" "tip_private")
- '("GdkEventButton*" "event")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktoggleaction.h
-
-(define-function gtk_toggle_action_get_type
- (c-name "gtk_toggle_action_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_toggle_action_new
- (c-name "gtk_toggle_action_new")
- (is-constructor-of "GtkToggleAction")
- (return-type "GtkToggleAction*")
- (properties
- '("name")
- '("label")
- '("tooltip")
- '("stock_id")
- )
-)
-
-(define-method toggled
- (of-object "GtkToggleAction")
- (c-name "gtk_toggle_action_toggled")
- (return-type "none")
-)
-
-(define-method set_active
- (of-object "GtkToggleAction")
- (c-name "gtk_toggle_action_set_active")
- (return-type "none")
- (parameters
- '("gboolean" "is_active")
- )
-)
-
-(define-method get_active
- (of-object "GtkToggleAction")
- (c-name "gtk_toggle_action_get_active")
- (return-type "gboolean")
-)
-
-(define-method set_draw_as_radio
- (of-object "GtkToggleAction")
- (c-name "gtk_toggle_action_set_draw_as_radio")
- (return-type "none")
- (parameters
- '("gboolean" "draw_as_radio")
- )
-)
-
-(define-method get_draw_as_radio
- (of-object "GtkToggleAction")
- (c-name "gtk_toggle_action_get_draw_as_radio")
- (return-type "gboolean")
-)
-
-(define-virtual toggled
- (of-object "GtkToggleAction")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktogglebutton.h
-
-(define-function gtk_toggle_button_get_type
- (c-name "gtk_toggle_button_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_toggle_button_new
- (c-name "gtk_toggle_button_new")
- (is-constructor-of "GtkToggleButton")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_toggle_button_new_with_label
- (c-name "gtk_toggle_button_new_with_label")
- (is-constructor-of "GtkToggleButton")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-function gtk_toggle_button_new_with_mnemonic
- (c-name "gtk_toggle_button_new_with_mnemonic")
- (is-constructor-of "GtkToggleButton")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-method set_mode
- (of-object "GtkToggleButton")
- (c-name "gtk_toggle_button_set_mode")
- (return-type "none")
- (parameters
- '("gboolean" "draw_indicator")
- )
-)
-
-(define-method get_mode
- (of-object "GtkToggleButton")
- (c-name "gtk_toggle_button_get_mode")
- (return-type "gboolean")
-)
-
-(define-method set_active
- (of-object "GtkToggleButton")
- (c-name "gtk_toggle_button_set_active")
- (return-type "none")
- (parameters
- '("gboolean" "is_active")
- )
-)
-
-(define-method get_active
- (of-object "GtkToggleButton")
- (c-name "gtk_toggle_button_get_active")
- (return-type "gboolean")
-)
-
-(define-method toggled
- (of-object "GtkToggleButton")
- (c-name "gtk_toggle_button_toggled")
- (return-type "none")
-)
-
-(define-method set_inconsistent
- (of-object "GtkToggleButton")
- (c-name "gtk_toggle_button_set_inconsistent")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_inconsistent
- (of-object "GtkToggleButton")
- (c-name "gtk_toggle_button_get_inconsistent")
- (return-type "gboolean")
-)
-
-(define-method set_state
- (of-object "GtkToggleButton")
- (c-name "gtk_toggle_button_set_state")
- (return-type "none")
- (parameters
- '("gboolean" "is_active")
- )
- (deprecated "use GtkToggleButton.set_active")
-)
-
-(define-virtual toggled
- (of-object "GtkToggleButton")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktoggletoolbutton.h
-
-(define-function gtk_toggle_tool_button_get_type
- (c-name "gtk_toggle_tool_button_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_toggle_tool_button_new
- (c-name "gtk_toggle_tool_button_new")
- (is-constructor-of "GtkToggleToolButton")
- (return-type "GtkToolItem*")
-)
-
-(define-function toggle_tool_button_new_from_stock
- (c-name "gtk_toggle_tool_button_new_from_stock")
- (return-type "GtkToolItem*")
- (parameters
- '("const-gchar*" "stock_id")
- )
- (caller-owns-return #t)
-)
-
-(define-method set_active
- (of-object "GtkToggleToolButton")
- (c-name "gtk_toggle_tool_button_set_active")
- (return-type "none")
- (parameters
- '("gboolean" "is_active")
- )
-)
-
-(define-method get_active
- (of-object "GtkToggleToolButton")
- (c-name "gtk_toggle_tool_button_get_active")
- (return-type "gboolean")
-)
-
-(define-virtual toggled
- (of-object "GtkToggleToolButton")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktoolbar.h
-
-(define-function gtk_toolbar_get_type
- (c-name "gtk_toolbar_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_toolbar_new
- (c-name "gtk_toolbar_new")
- (is-constructor-of "GtkToolbar")
- (return-type "GtkWidget*")
-)
-
-(define-method insert
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_insert")
- (return-type "none")
- (parameters
- '("GtkToolItem*" "item")
- '("gint" "pos")
- )
-)
-
-(define-method get_item_index
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_get_item_index")
- (return-type "gint")
- (parameters
- '("GtkToolItem*" "item")
- )
-)
-
-(define-method get_n_items
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_get_n_items")
- (return-type "gint")
-)
-
-(define-method get_nth_item
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_get_nth_item")
- (return-type "GtkToolItem*")
- (parameters
- '("gint" "n")
- )
-)
-
-(define-method get_drop_index
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_get_drop_index")
- (return-type "gint")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method set_drop_highlight_item
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_set_drop_highlight_item")
- (return-type "none")
- (parameters
- '("GtkToolItem*" "tool_item" (null-ok))
- '("gint" "index")
- )
-)
-
-(define-method set_show_arrow
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_set_show_arrow")
- (return-type "none")
- (parameters
- '("gboolean" "show_arrow")
- )
-)
-
-(define-method get_show_arrow
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_get_show_arrow")
- (return-type "gboolean")
-)
-
-(define-method get_relief_style
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_get_relief_style")
- (return-type "GtkReliefStyle")
-)
-
-(define-method append_item
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_append_item")
- (return-type "GtkWidget*")
- (parameters
- '("const-char*" "text")
- '("const-char*" "tooltip_text")
- '("const-char*" "tooltip_private_text")
- '("GtkWidget*" "icon")
- '("GtkSignalFunc" "callback")
- '("gpointer" "user_data" (null-ok) (default "NULL"))
- )
- (deprecated "")
-)
-
-(define-method prepend_item
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_prepend_item")
- (return-type "GtkWidget*")
- (parameters
- '("const-char*" "text")
- '("const-char*" "tooltip_text")
- '("const-char*" "tooltip_private_text")
- '("GtkWidget*" "icon")
- '("GtkSignalFunc" "callback")
- '("gpointer" "user_data")
- )
- (deprecated "")
-)
-
-(define-method insert_item
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_insert_item")
- (return-type "GtkWidget*")
- (parameters
- '("const-char*" "text")
- '("const-char*" "tooltip_text")
- '("const-char*" "tooltip_private_text")
- '("GtkWidget*" "icon")
- '("GtkSignalFunc" "callback")
- '("gpointer" "user_data")
- '("gint" "position")
- )
- (deprecated "")
-)
-
-(define-method insert_stock
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_insert_stock")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "stock_id")
- '("const-char*" "tooltip_text")
- '("const-char*" "tooltip_private_text")
- '("GtkSignalFunc" "callback")
- '("gpointer" "user_data")
- '("gint" "position")
- )
- (deprecated "")
-)
-
-(define-method append_space
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_append_space")
- (return-type "none")
- (deprecated "")
-)
-
-(define-method prepend_space
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_prepend_space")
- (return-type "none")
- (deprecated "")
-)
-
-(define-method insert_space
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_insert_space")
- (return-type "none")
- (parameters
- '("gint" "position")
- )
- (deprecated "")
-)
-
-(define-method remove_space
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_remove_space")
- (return-type "none")
- (parameters
- '("gint" "position")
- )
- (deprecated "")
-)
-
-(define-method append_element
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_append_element")
- (return-type "GtkWidget*")
- (parameters
- '("GtkToolbarChildType" "type")
- '("GtkWidget*" "widget")
- '("const-char*" "text")
- '("const-char*" "tooltip_text")
- '("const-char*" "tooltip_private_text")
- '("GtkWidget*" "icon")
- '("GtkSignalFunc" "callback")
- '("gpointer" "user_data")
- )
- (deprecated "")
-)
-
-(define-method prepend_element
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_prepend_element")
- (return-type "GtkWidget*")
- (parameters
- '("GtkToolbarChildType" "type")
- '("GtkWidget*" "widget")
- '("const-char*" "text")
- '("const-char*" "tooltip_text")
- '("const-char*" "tooltip_private_text")
- '("GtkWidget*" "icon")
- '("GtkSignalFunc" "callback")
- '("gpointer" "user_data")
- )
- (deprecated "")
-)
-
-(define-method insert_element
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_insert_element")
- (return-type "GtkWidget*")
- (parameters
- '("GtkToolbarChildType" "type")
- '("GtkWidget*" "widget")
- '("const-char*" "text")
- '("const-char*" "tooltip_text")
- '("const-char*" "tooltip_private_text")
- '("GtkWidget*" "icon")
- '("GtkSignalFunc" "callback")
- '("gpointer" "user_data")
- '("gint" "position")
- )
- (deprecated "")
-)
-
-(define-method append_widget
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_append_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("const-char*" "tooltip_text" (null-ok))
- '("const-char*" "tooltip_private_text" (null-ok))
- )
- (deprecated "")
-)
-
-(define-method prepend_widget
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_prepend_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("const-char*" "tooltip_text" (null-ok))
- '("const-char*" "tooltip_private_text" (null-ok))
- )
- (deprecated "")
-)
-
-(define-method insert_widget
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_insert_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("const-char*" "tooltip_text" (null-ok))
- '("const-char*" "tooltip_private_text" (null-ok))
- '("gint" "position")
- )
- (deprecated "")
-)
-
-(define-method set_orientation
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_set_orientation")
- (return-type "none")
- (parameters
- '("GtkOrientation" "orientation")
- )
-)
-
-(define-method set_style
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_set_style")
- (return-type "none")
- (parameters
- '("GtkToolbarStyle" "style")
- )
-)
-
-(define-method set_icon_size
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_set_icon_size")
- (return-type "none")
- (parameters
- '("GtkIconSize" "icon_size")
- )
- (deprecated "")
-)
-
-(define-method set_tooltips
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_set_tooltips")
- (return-type "none")
- (parameters
- '("gboolean" "enable")
- )
-)
-
-(define-method unset_style
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_unset_style")
- (return-type "none")
-)
-
-(define-method unset_icon_size
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_unset_icon_size")
- (return-type "none")
- (deprecated "")
-)
-
-(define-method get_orientation
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_get_orientation")
- (return-type "GtkOrientation")
-)
-
-(define-method get_style
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_get_style")
- (return-type "GtkToolbarStyle")
-)
-
-(define-method get_icon_size
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_get_icon_size")
- (return-type "GtkIconSize")
-)
-
-(define-method get_tooltips
- (of-object "GtkToolbar")
- (c-name "gtk_toolbar_get_tooltips")
- (return-type "gboolean")
-)
-
-(define-virtual orientation_changed
- (of-object "GtkToolbar")
- (return-type "none")
- (parameters
- '("GtkOrientation" "orientation")
- )
-)
-(define-virtual style_changed
- (of-object "GtkToolbar")
- (return-type "none")
- (parameters
- '("GtkToolbarStyle" "style")
- )
-)
-(define-virtual popup_context_menu
- (of-object "GtkToolbar")
- (return-type "gboolean")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "button_number")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktoolbutton.h
-
-(define-function gtk_tool_button_get_type
- (c-name "gtk_tool_button_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tool_button_new
- (c-name "gtk_tool_button_new")
- (is-constructor-of "GtkToolButton")
- (return-type "GtkToolItem*")
- (parameters
- '("GtkWidget*" "icon_widget" (null-ok) (default "NULL"))
- '("const-gchar*" "label" (null-ok) (default "NULL"))
- )
-)
-
-(define-function tool_button_new_from_stock
- (c-name "gtk_tool_button_new_from_stock")
- (return-type "GtkToolItem*")
- (parameters
- '("const-gchar*" "stock_id")
- )
- (caller-owns-return #t)
-)
-
-(define-method set_label
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_set_label")
- (return-type "none")
- (parameters
- '("const-gchar*" "label" (null-ok))
- )
-)
-
-(define-method get_label
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_get_label")
- (return-type "const-gchar*")
-)
-
-(define-method set_use_underline
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_set_use_underline")
- (return-type "none")
- (parameters
- '("gboolean" "use_underline")
- )
-)
-
-(define-method get_use_underline
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_get_use_underline")
- (return-type "gboolean")
-)
-
-(define-method set_stock_id
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_set_stock_id")
- (return-type "none")
- (parameters
- '("const-gchar*" "stock_id" (null-ok))
- )
-)
-
-(define-method set_icon_name
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_set_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "icon_name" (null-ok))
- )
-)
-
-(define-method get_icon_name
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_get_icon_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_stock_id
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_get_stock_id")
- (return-type "const-gchar*")
-)
-
-(define-method set_icon_widget
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_set_icon_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "icon_widget" (null-ok))
- )
-)
-
-(define-method get_icon_widget
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_get_icon_widget")
- (return-type "GtkWidget*")
-)
-
-(define-method set_label_widget
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_set_label_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "label_widget" (null-ok))
- )
-)
-
-(define-method get_label_widget
- (of-object "GtkToolButton")
- (c-name "gtk_tool_button_get_label_widget")
- (return-type "GtkWidget*")
-)
-
-(define-virtual clicked
- (of-object "GtkToolButton")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktoolitem.h
-
-(define-function gtk_tool_item_get_type
- (c-name "gtk_tool_item_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tool_item_new
- (c-name "gtk_tool_item_new")
- (is-constructor-of "GtkToolItem")
- (return-type "GtkToolItem*")
-)
-
-(define-method set_homogeneous
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_set_homogeneous")
- (return-type "none")
- (parameters
- '("gboolean" "homogeneous")
- )
-)
-
-(define-method get_homogeneous
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_get_homogeneous")
- (return-type "gboolean")
-)
-
-(define-method set_expand
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_set_expand")
- (return-type "none")
- (parameters
- '("gboolean" "expand")
- )
-)
-
-(define-method get_expand
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_get_expand")
- (return-type "gboolean")
-)
-
-(define-method set_tooltip
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_set_tooltip")
- (return-type "none")
- (parameters
- ("GtkTooltips*" "tooltips")
- ("const-gchar*" "tip_text" (null-ok) (default "NULL"))
- ("const-gchar*" "tip_private" (null-ok) (default "NULL"))
- )
-)
-
-(define-method set_use_drag_window
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_set_use_drag_window")
- (return-type "none")
- (parameters
- '("gboolean" "use_drag_window")
- )
-)
-
-(define-method get_use_drag_window
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_get_use_drag_window")
- (return-type "gboolean")
-)
-
-(define-method set_visible_horizontal
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_set_visible_horizontal")
- (return-type "none")
- (parameters
- '("gboolean" "visible_horizontal")
- )
-)
-
-(define-method get_visible_horizontal
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_get_visible_horizontal")
- (return-type "gboolean")
-)
-
-(define-method set_visible_vertical
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_set_visible_vertical")
- (return-type "none")
- (parameters
- '("gboolean" "visible_vertical")
- )
-)
-
-(define-method get_visible_vertical
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_get_visible_vertical")
- (return-type "gboolean")
-)
-
-(define-method set_is_important
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_set_is_important")
- (return-type "none")
- (parameters
- '("gboolean" "is_important")
- )
-)
-
-(define-method get_is_important
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_get_is_important")
- (return-type "gboolean")
-)
-
-(define-method get_icon_size
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_get_icon_size")
- (return-type "GtkIconSize")
-)
-
-(define-method get_orientation
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_get_orientation")
- (return-type "GtkOrientation")
-)
-
-(define-method get_toolbar_style
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_get_toolbar_style")
- (return-type "GtkToolbarStyle")
-)
-
-(define-method get_relief_style
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_get_relief_style")
- (return-type "GtkReliefStyle")
-)
-
-(define-method retrieve_proxy_menu_item
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_retrieve_proxy_menu_item")
- (return-type "GtkWidget*")
-)
-
-(define-method set_proxy_menu_item
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_set_proxy_menu_item")
- (return-type "none")
- (parameters
- '("const-gchar*" "menu_item_id")
- '("GtkWidget*" "menu_item" (null-ok))
- )
-)
-
-(define-method get_proxy_menu_item
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_get_proxy_menu_item")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "menu_item_id")
- )
-)
-
-(define-method rebuild_menu
- (of-object "GtkToolItem")
- (c-name "gtk_tool_item_rebuild_menu")
- (return-type "none")
-)
-
-(define-virtual create_menu_proxy
- (of-object "GtkToolItem")
- (return-type "gboolean")
-)
-(define-virtual toolbar_reconfigured
- (of-object "GtkToolItem")
- (return-type "none")
-)
-(define-virtual set_tooltip
- (of-object "GtkToolItem")
- (return-type "gboolean")
- (parameters
- '("GtkTooltips*" "tooltips")
- '("const-gchar*" "tip_text")
- '("const-gchar*" "tip_private")
- )
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktooltips.h
-
-(define-function gtk_tooltips_get_type
- (c-name "gtk_tooltips_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tooltips_new
- (c-name "gtk_tooltips_new")
- (is-constructor-of "GtkTooltips")
- (return-type "GtkTooltips*")
-)
-
-(define-method enable
- (of-object "GtkTooltips")
- (c-name "gtk_tooltips_enable")
- (return-type "none")
-)
-
-(define-method disable
- (of-object "GtkTooltips")
- (c-name "gtk_tooltips_disable")
- (return-type "none")
-)
-
-(define-method set_delay
- (of-object "GtkTooltips")
- (c-name "gtk_tooltips_set_delay")
- (return-type "none")
- (parameters
- '("guint" "delay")
- )
- (deprecated "")
-)
-
-(define-method set_tip
- (of-object "GtkTooltips")
- (c-name "gtk_tooltips_set_tip")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- '("const-gchar*" "tip_text" (null-ok))
- '("const-gchar*" "tip_private" (null-ok) (default "NULL"))
- )
-)
-
-(define-function tooltips_data_get
- (c-name "gtk_tooltips_data_get")
- (return-type "GtkTooltipsData*")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-function gtk_tooltips_data_get
- (c-name "gtk_tooltips_data_get1")
- (return-type "GtkTooltipsData*")
- (parameters
- '("GtkWidget*" "widget")
- )
- (deprecated "use tooltips_data_get")
-)
-
-(define-method force_window
- (of-object "GtkTooltips")
- (c-name "gtk_tooltips_force_window")
- (return-type "none")
-)
-
-(define-method tooltips_get_info_from_tip_window
- (of-object "GtkWindow")
- (c-name "gtk_tooltips_get_info_from_tip_window")
- (return-type "gboolean")
- (parameters
- '("GtkTooltips**" "tooltips")
- '("GtkWidget**" "current_widget")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktreednd.h
-
-(define-function gtk_tree_drag_source_get_type
- (c-name "gtk_tree_drag_source_get_type")
- (return-type "GType")
-)
-
-(define-method row_draggable
- (of-object "GtkTreeDragSource")
- (c-name "gtk_tree_drag_source_row_draggable")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method drag_data_delete
- (of-object "GtkTreeDragSource")
- (c-name "gtk_tree_drag_source_drag_data_delete")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method drag_data_get
- (of-object "GtkTreeDragSource")
- (c-name "gtk_tree_drag_source_drag_data_get")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkSelectionData*" "selection_data")
- )
-)
-
-(define-virtual row_draggable
- (of-object "GtkTreeDragSource")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-(define-virtual drag_data_get
- (of-object "GtkTreeDragSource")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkSelectionData*" "selection_data")
- )
-)
-(define-virtual drag_data_delete
- (of-object "GtkTreeDragSource")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-
-(define-function gtk_tree_drag_dest_get_type
- (c-name "gtk_tree_drag_dest_get_type")
- (return-type "GType")
-)
-
-(define-method drag_data_received
- (of-object "GtkTreeDragDest")
- (c-name "gtk_tree_drag_dest_drag_data_received")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "dest")
- '("GtkSelectionData*" "selection_data")
- )
-)
-
-(define-method row_drop_possible
- (of-object "GtkTreeDragDest")
- (c-name "gtk_tree_drag_dest_row_drop_possible")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "dest_path")
- '("GtkSelectionData*" "selection_data")
- )
-)
-
-(define-method tree_set_row_drag_data
- (of-object "GtkSelectionData")
- (c-name "gtk_tree_set_row_drag_data")
- (return-type "gboolean")
- (parameters
- '("GtkTreeModel*" "tree_model")
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method tree_get_row_drag_data
- (of-object "GtkSelectionData")
- (c-name "gtk_tree_get_row_drag_data")
- (return-type "gboolean")
- (parameters
- '("GtkTreeModel**" "tree_model")
- '("GtkTreePath**" "path")
- )
-)
-
-(define-virtual drag_data_received
- (of-object "GtkTreeDragDest")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "dest")
- '("GtkSelectionData*" "selection_data")
- )
-)
-(define-virtual row_drop_possible
- (of-object "GtkTreeDragDest")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "dest_path")
- '("GtkSelectionData*" "selection_data")
- )
-)
-
-;; From /mondo/local/gtk-2.10/include/gtk-2.0/gtk/gtktree.h
-
-(define-function gtk_tree_get_type
- (c-name "gtk_tree_get_type")
- (return-type "GtkType")
-)
-
-(define-function gtk_tree_new
- (c-name "gtk_tree_new")
- (is-constructor-of "GtkTree")
- (return-type "GtkWidget*")
-)
-
-(define-method append
- (of-object "GtkTree")
- (c-name "gtk_tree_append")
- (return-type "none")
- (parameters
- '("GtkWidget*" "tree_item")
- )
-)
-
-(define-method prepend
- (of-object "GtkTree")
- (c-name "gtk_tree_prepend")
- (return-type "none")
- (parameters
- '("GtkWidget*" "tree_item")
- )
-)
-
-(define-method insert
- (of-object "GtkTree")
- (c-name "gtk_tree_insert")
- (return-type "none")
- (parameters
- '("GtkWidget*" "tree_item")
- '("gint" "position")
- )
-)
-
-(define-method remove_items
- (of-object "GtkTree")
- (c-name "gtk_tree_remove_items")
- (return-type "none")
- (parameters
- '("GList*" "items")
- )
-)
-
-(define-method clear_items
- (of-object "GtkTree")
- (c-name "gtk_tree_clear_items")
- (return-type "none")
- (parameters
- '("gint" "start")
- '("gint" "end")
- )
-)
-
-(define-method select_item
- (of-object "GtkTree")
- (c-name "gtk_tree_select_item")
- (return-type "none")
- (parameters
- '("gint" "item")
- )
-)
-
-(define-method unselect_item
- (of-object "GtkTree")
- (c-name "gtk_tree_unselect_item")
- (return-type "none")
- (parameters
- '("gint" "item")
- )
-)
-
-(define-method select_child
- (of-object "GtkTree")
- (c-name "gtk_tree_select_child")
- (return-type "none")
- (parameters
- '("GtkWidget*" "tree_item")
- )
-)
-
-(define-method unselect_child
- (of-object "GtkTree")
- (c-name "gtk_tree_unselect_child")
- (return-type "none")
- (parameters
- '("GtkWidget*" "tree_item")
- )
-)
-
-(define-method child_position
- (of-object "GtkTree")
- (c-name "gtk_tree_child_position")
- (return-type "gint")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-method set_selection_mode
- (of-object "GtkTree")
- (c-name "gtk_tree_set_selection_mode")
- (return-type "none")
- (parameters
- '("GtkSelectionMode" "mode")
- )
-)
-
-(define-method set_view_mode
- (of-object "GtkTree")
- (c-name "gtk_tree_set_view_mode")
- (return-type "none")
- (parameters
- '("GtkTreeViewMode" "mode")
- )
-)
-
-(define-method set_view_lines
- (of-object "GtkTree")
- (c-name "gtk_tree_set_view_lines")
- (return-type "none")
- (parameters
- '("gboolean" "flag")
- )
-)
-
-(define-method remove_item
- (of-object "GtkTree")
- (c-name "gtk_tree_remove_item")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-virtual selection_changed
- (of-object "GtkTree")
- (return-type "none")
-)
-
-(define-virtual select_child
- (of-object "GtkTree")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-(define-virtual unselect_child
- (of-object "GtkTree")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- )
-)
-
-;; From /mondo/local/gtk-2.10/include/gtk-2.0/gtk/gtktreeitem.h
-
-(define-function gtk_tree_item_get_type
- (c-name "gtk_tree_item_get_type")
- (return-type "GtkType")
-)
-
-(define-function gtk_tree_item_new
- (c-name "gtk_tree_item_new")
- (is-constructor-of "GtkTreeItem")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_tree_item_new_with_label
- (c-name "gtk_tree_item_new_with_label")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "label")
- )
-)
-
-(define-method set_subtree
- (of-object "GtkTreeItem")
- (c-name "gtk_tree_item_set_subtree")
- (return-type "none")
- (parameters
- '("GtkWidget*" "subtree")
- )
-)
-
-(define-method remove_subtree
- (of-object "GtkTreeItem")
- (c-name "gtk_tree_item_remove_subtree")
- (return-type "none")
-)
-
-(define-method select
- (of-object "GtkTreeItem")
- (c-name "gtk_tree_item_select")
- (return-type "none")
-)
-
-(define-method deselect
- (of-object "GtkTreeItem")
- (c-name "gtk_tree_item_deselect")
- (return-type "none")
-)
-
-(define-method expand
- (of-object "GtkTreeItem")
- (c-name "gtk_tree_item_expand")
- (return-type "none")
-)
-
-(define-method collapse
- (of-object "GtkTreeItem")
- (c-name "gtk_tree_item_collapse")
- (return-type "none")
-)
-
-(define-virtual expand
- (of-object "GtkTreeItem")
- (return-type "none")
-)
-
-(define-virtual collapse
- (of-object "GtkTreeItem")
- (return-type "none")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktreemodel.h
-
-(define-function tree_path_get_type
- (c-name "gtk_tree_path_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tree_path_new
- (c-name "gtk_tree_path_new")
- (is-constructor-of "GtkTreePath")
- (return-type "GtkTreePath*")
-)
-
-(define-function tree_path_new_from_string
- (c-name "gtk_tree_path_new_from_string")
- (return-type "GtkTreePath*")
- (parameters
- '("gchar*" "path")
- )
-)
-
-(define-function tree_path_new_from_indices
- (c-name "gtk_tree_path_new_from_indices")
- (return-type "GtkTreePath*")
- (parameters
- '("gint" "first_index")
- )
- (varargs #t)
-)
-
-(define-method to_string
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_to_string")
- (return-type "gchar*")
-)
-
-(define-function tree_path_new_first
- (c-name "gtk_tree_path_new_first")
- (return-type "GtkTreePath*")
-)
-
-(define-method append_index
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_append_index")
- (return-type "none")
- (parameters
- '("gint" "index")
- )
-)
-
-(define-method prepend_index
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_prepend_index")
- (return-type "none")
- (parameters
- '("gint" "index")
- )
-)
-
-(define-method get_depth
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_get_depth")
- (return-type "gint")
-)
-
-(define-method get_indices
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_get_indices")
- (return-type "gint*")
-)
-
-(define-method free
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_free")
- (return-type "none")
-)
-
-(define-method copy
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_copy")
- (return-type "GtkTreePath*")
- (caller-owns-return #t)
-)
-
-(define-method compare
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_compare")
- (return-type "gint")
- (parameters
- '("const-GtkTreePath*" "b")
- )
-)
-
-(define-method next
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_next")
- (return-type "none")
-)
-
-(define-method prev
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_prev")
- (return-type "gint")
-)
-
-(define-method up
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_up")
- (return-type "gint")
-)
-
-(define-method down
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_down")
- (return-type "none")
-)
-
-(define-method is_ancestor
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_is_ancestor")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "descendant")
- )
-)
-
-(define-method is_descendant
- (of-object "GtkTreePath")
- (c-name "gtk_tree_path_is_descendant")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "ancestor")
- )
-)
-
-(define-function gtk_tree_row_reference_get_type
- (c-name "gtk_tree_row_reference_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tree_row_reference_new
- (c-name "gtk_tree_row_reference_new")
- (is-constructor-of "GtkTreeRowReference")
- (return-type "GtkTreeRowReference*")
- (parameters
- '("GtkTreeModel*" "model")
- '("GtkTreePath*" "path")
- )
-)
-
-(define-function gtk_tree_row_reference_new_proxy
- (c-name "gtk_tree_row_reference_new_proxy")
- (is-constructor-of "GtkTreeRowReference")
- (return-type "GtkTreeRowReference*")
- (parameters
- '("GObject*" "proxy")
- '("GtkTreeModel*" "model")
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method get_path
- (of-object "GtkTreeRowReference")
- (c-name "gtk_tree_row_reference_get_path")
- (return-type "GtkTreePath*")
- (caller-owns-return #t)
-)
-
-
-(define-method get_model
- (of-object "GtkTreeRowReference")
- (c-name "gtk_tree_row_reference_get_model")
- (return-type "GtkTreeModel*")
-)
-
-(define-method valid
- (of-object "GtkTreeRowReference")
- (c-name "gtk_tree_row_reference_valid")
- (return-type "gboolean")
-)
-
-(define-method copy
- (of-object "GtkTreeRowReference")
- (c-name "gtk_tree_row_reference_copy")
- (return-type "GtkTreeRowReference*")
-)
-
-(define-method free
- (of-object "GtkTreeRowReference")
- (c-name "gtk_tree_row_reference_free")
- (deprecated "don't call this or Bad Things will happen")
- (return-type "none")
-)
-
-(define-function tree_row_reference_inserted
- (c-name "gtk_tree_row_reference_inserted")
- (return-type "none")
- (parameters
- '("GObject*" "proxy")
- '("GtkTreePath*" "path")
- )
-)
-
-(define-function tree_row_reference_deleted
- (c-name "gtk_tree_row_reference_deleted")
- (return-type "none")
- (parameters
- '("GObject*" "proxy")
- '("GtkTreePath*" "path")
- )
-)
-
-(define-function tree_row_reference_reordered
- (c-name "gtk_tree_row_reference_reordered")
- (return-type "none")
- (parameters
- '("GObject*" "proxy")
- '("GtkTreePath*" "path")
- '("GtkTreeIter*" "iter")
- '("gint*" "new_order")
- )
-)
-
-(define-method copy
- (of-object "GtkTreeIter")
- (c-name "gtk_tree_iter_copy")
- (return-type "GtkTreeIter*")
- (caller-owns-return #t)
-)
-
-(define-method free
- (of-object "GtkTreeIter")
- (c-name "gtk_tree_iter_free")
- (return-type "none")
-)
-
-(define-function gtk_tree_iter_get_type
- (c-name "gtk_tree_iter_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tree_model_get_type
- (c-name "gtk_tree_model_get_type")
- (return-type "GType")
-)
-
-(define-method get_flags
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get_flags")
- (return-type "GtkTreeModelFlags")
-)
-
-(define-method get_n_columns
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get_n_columns")
- (return-type "gint")
-)
-
-(define-method get_column_type
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get_column_type")
- (return-type "GType")
- (parameters
- '("gint" "index")
- )
-)
-
-(define-method get_iter
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get_iter")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method get_iter_from_string
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get_iter_from_string")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("const-gchar*" "path_string")
- )
-)
-
-(define-method get_string_from_iter
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get_string_from_iter")
- (return-type "gchar*")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method get_iter_root
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get_iter_first")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method get_iter_first
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get_iter_first")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method get_path
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get_path")
- (return-type "GtkTreePath*")
- (caller-owns-return #t)
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method get_value
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get_value")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("gint" "column")
- '("GValue*" "value")
- )
-)
-
-(define-method iter_next
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_iter_next")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method iter_children
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_iter_children")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "parent" (null-ok))
- )
-)
-
-(define-method iter_has_child
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_iter_has_child")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method iter_n_children
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_iter_n_children")
- (return-type "gint")
- (parameters
- '("GtkTreeIter*" "iter" (null-ok))
- )
-)
-
-(define-method iter_nth_child
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_iter_nth_child")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "parent" (null-ok))
- '("gint" "n")
- )
-)
-
-(define-method iter_parent
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_iter_parent")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "child")
- )
-)
-
-(define-method ref_node
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_ref_node")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method unref_node
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_unref_node")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method get
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
- (varargs #t)
-)
-
-(define-method get_valist
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_get_valist")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("va_list" "var_args")
- )
-)
-
-(define-method foreach
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_foreach")
- (return-type "none")
- (parameters
- '("GtkTreeModelForeachFunc" "func")
- '("gpointer" "user_data")
- )
-)
-
-(define-method row_changed
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_row_changed")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method row_inserted
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_row_inserted")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method row_has_child_toggled
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_row_has_child_toggled")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method row_deleted
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_row_deleted")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method rows_reordered
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_rows_reordered")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeIter*" "iter")
- '("gint*" "new_order")
- )
-)
-
-(define-virtual row_changed
- (of-object "GtkTreeModel")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeIter*" "iter")
- )
-)
-(define-virtual row_inserted
- (of-object "GtkTreeModel")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeIter*" "iter")
- )
-)
-(define-virtual row_has_child_toggled
- (of-object "GtkTreeModel")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeIter*" "iter")
- )
-)
-(define-virtual row_deleted
- (of-object "GtkTreeModel")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-(define-virtual rows_reordered
- (of-object "GtkTreeModel")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeIter*" "iter")
- '("gint*" "new_order")
- )
-)
-(define-virtual get_flags
- (of-object "GtkTreeModel")
- (return-type "GtkTreeModelFlags")
-)
-(define-virtual get_n_columns
- (of-object "GtkTreeModel")
- (return-type "gint")
-)
-(define-virtual get_column_type
- (of-object "GtkTreeModel")
- (return-type "GType")
- (parameters
- '("gint" "index_")
- )
-)
-(define-virtual get_iter
- (of-object "GtkTreeModel")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreePath*" "path")
- )
-)
-(define-virtual get_path
- (of-object "GtkTreeModel")
- (return-type "GtkTreePath*")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-virtual get_value
- (of-object "GtkTreeModel")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("gint" "column")
- '("GValue*" "value")
- )
-)
-(define-virtual iter_next
- (of-object "GtkTreeModel")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-(define-virtual iter_children
- (of-object "GtkTreeModel")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "parent")
- )
-)
-(define-virtual iter_has_child
- (of-object "GtkTreeModel")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-(define-virtual iter_n_children
- (of-object "GtkTreeModel")
- (return-type "gint")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-(define-virtual iter_nth_child
- (of-object "GtkTreeModel")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "parent")
- '("gint" "n")
- )
-)
-(define-virtual iter_parent
- (of-object "GtkTreeModel")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "child")
- )
-)
-(define-virtual ref_node
- (of-object "GtkTreeModel")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-(define-virtual unref_node
- (of-object "GtkTreeModel")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktreemodelfilter.h
-
-(define-function gtk_tree_model_filter_get_type
- (c-name "gtk_tree_model_filter_get_type")
- (return-type "GType")
-)
-
-(define-method filter_new
- (of-object "GtkTreeModel")
- (c-name "gtk_tree_model_filter_new")
- (return-type "GtkTreeModel*")
- (parameters
- '("GtkTreePath*" "root" (null-ok) (default "NULL"))
- )
-)
-
-(define-method set_visible_func
- (of-object "GtkTreeModelFilter")
- (c-name "gtk_tree_model_filter_set_visible_func")
- (return-type "none")
- (parameters
- '("GtkTreeModelFilterVisibleFunc" "func")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method set_modify_func
- (of-object "GtkTreeModelFilter")
- (c-name "gtk_tree_model_filter_set_modify_func")
- (return-type "none")
- (parameters
- '("gint" "n_columns")
- '("GType*" "types")
- '("GtkTreeModelFilterModifyFunc" "func")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method set_visible_column
- (of-object "GtkTreeModelFilter")
- (c-name "gtk_tree_model_filter_set_visible_column")
- (return-type "none")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method get_model
- (of-object "GtkTreeModelFilter")
- (c-name "gtk_tree_model_filter_get_model")
- (return-type "GtkTreeModel*")
-)
-
-(define-method convert_child_iter_to_iter
- (of-object "GtkTreeModelFilter")
- (c-name "gtk_tree_model_filter_convert_child_iter_to_iter")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "filter_iter")
- '("GtkTreeIter*" "child_iter")
- )
-)
-
-(define-method convert_iter_to_child_iter
- (of-object "GtkTreeModelFilter")
- (c-name "gtk_tree_model_filter_convert_iter_to_child_iter")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "child_iter")
- '("GtkTreeIter*" "filter_iter")
- )
-)
-
-(define-method convert_child_path_to_path
- (of-object "GtkTreeModelFilter")
- (c-name "gtk_tree_model_filter_convert_child_path_to_path")
- (return-type "GtkTreePath*")
- (parameters
- '("GtkTreePath*" "child_path")
- )
-)
-
-(define-method convert_path_to_child_path
- (of-object "GtkTreeModelFilter")
- (c-name "gtk_tree_model_filter_convert_path_to_child_path")
- (return-type "GtkTreePath*")
- (parameters
- '("GtkTreePath*" "filter_path")
- )
-)
-
-(define-method refilter
- (of-object "GtkTreeModelFilter")
- (c-name "gtk_tree_model_filter_refilter")
- (return-type "none")
-)
-
-(define-method clear_cache
- (of-object "GtkTreeModelFilter")
- (c-name "gtk_tree_model_filter_clear_cache")
- (return-type "none")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktreemodelsort.h
-
-(define-function gtk_tree_model_sort_get_type
- (c-name "gtk_tree_model_sort_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tree_model_sort_new_with_model
- (c-name "gtk_tree_model_sort_new_with_model")
- (is-constructor-of "GtkTreeModelSort")
- (return-type "GtkTreeModel*")
- (properties
- '("model" (argname "child_model"))
- )
-)
-
-(define-method get_model
- (of-object "GtkTreeModelSort")
- (c-name "gtk_tree_model_sort_get_model")
- (return-type "GtkTreeModel*")
-)
-
-(define-method convert_child_path_to_path
- (of-object "GtkTreeModelSort")
- (c-name "gtk_tree_model_sort_convert_child_path_to_path")
- (return-type "GtkTreePath*")
- (caller-owns-return #t)
- (parameters
- '("GtkTreePath*" "child_path")
- )
-)
-
-(define-method convert_child_iter_to_iter
- (of-object "GtkTreeModelSort")
- (c-name "gtk_tree_model_sort_convert_child_iter_to_iter")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "sort_iter" (null-ok))
- '("GtkTreeIter*" "child_iter")
- )
-)
-
-(define-method convert_path_to_child_path
- (of-object "GtkTreeModelSort")
- (c-name "gtk_tree_model_sort_convert_path_to_child_path")
- (return-type "GtkTreePath*")
- (caller-owns-return #t)
- (parameters
- '("GtkTreePath*" "sorted_path")
- )
-)
-
-(define-method convert_iter_to_child_iter
- (of-object "GtkTreeModelSort")
- (c-name "gtk_tree_model_sort_convert_iter_to_child_iter")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "child_iter" (null-ok))
- '("GtkTreeIter*" "sorted_iter")
- )
-)
-
-(define-method reset_default_sort_func
- (of-object "GtkTreeModelSort")
- (c-name "gtk_tree_model_sort_reset_default_sort_func")
- (return-type "none")
-)
-
-(define-method clear_cache
- (of-object "GtkTreeModelSort")
- (c-name "gtk_tree_model_sort_clear_cache")
- (return-type "none")
-)
-
-(define-method iter_is_valid
- (of-object "GtkTreeModelSort")
- (c-name "gtk_tree_model_sort_iter_is_valid")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktreeselection.h
-
-(define-function gtk_tree_selection_get_type
- (c-name "gtk_tree_selection_get_type")
- (return-type "GType")
-)
-
-(define-method set_mode
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_set_mode")
- (return-type "none")
- (parameters
- '("GtkSelectionMode" "type")
- )
-)
-
-(define-method get_mode
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_get_mode")
- (return-type "GtkSelectionMode")
-)
-
-(define-method set_select_function
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_set_select_function")
- (return-type "none")
- (parameters
- '("GtkTreeSelectionFunc" "func")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method get_user_data
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_get_user_data")
- (return-type "gpointer")
-)
-
-(define-method get_tree_view
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_get_tree_view")
- (return-type "GtkTreeView*")
-)
-
-(define-method get_selected
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_get_selected")
- (return-type "gboolean")
- (parameters
- '("GtkTreeModel**" "model")
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method get_selected_rows
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_get_selected_rows")
- (return-type "GList*")
- (parameters
- '("GtkTreeModel**" "model")
- )
-)
-
-(define-method count_selected_rows
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_count_selected_rows")
- (return-type "gint")
-)
-
-(define-method selected_foreach
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_selected_foreach")
- (return-type "none")
- (parameters
- '("GtkTreeSelectionForeachFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method select_path
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_select_path")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method unselect_path
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_unselect_path")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method select_iter
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_select_iter")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method unselect_iter
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_unselect_iter")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method path_is_selected
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_path_is_selected")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method iter_is_selected
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_iter_is_selected")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method select_all
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_select_all")
- (return-type "none")
-)
-
-(define-method unselect_all
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_unselect_all")
- (return-type "none")
-)
-
-(define-method select_range
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_select_range")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "start_path")
- '("GtkTreePath*" "end_path")
- )
-)
-
-(define-method unselect_range
- (of-object "GtkTreeSelection")
- (c-name "gtk_tree_selection_unselect_range")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "start_path")
- '("GtkTreePath*" "end_path")
- )
-)
-
-(define-virtual changed
- (of-object "GtkTreeSelection")
- (return-type "none")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktreesortable.h
-
-(define-function gtk_tree_sortable_get_type
- (c-name "gtk_tree_sortable_get_type")
- (return-type "GType")
-)
-
-(define-method sort_column_changed
- (of-object "GtkTreeSortable")
- (c-name "gtk_tree_sortable_sort_column_changed")
- (return-type "none")
-)
-
-(define-method get_sort_column_id
- (of-object "GtkTreeSortable")
- (c-name "gtk_tree_sortable_get_sort_column_id")
- (return-type "gboolean")
- (parameters
- '("gint*" "sort_column_id")
- '("GtkSortType*" "order")
- )
-)
-
-(define-method set_sort_column_id
- (of-object "GtkTreeSortable")
- (c-name "gtk_tree_sortable_set_sort_column_id")
- (return-type "none")
- (parameters
- '("gint" "sort_column_id")
- '("GtkSortType" "order")
- )
-)
-
-(define-method set_sort_func
- (of-object "GtkTreeSortable")
- (c-name "gtk_tree_sortable_set_sort_func")
- (return-type "none")
- (parameters
- '("gint" "sort_column_id")
- '("GtkTreeIterCompareFunc" "sort_func")
- '("gpointer" "user_data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method set_default_sort_func
- (of-object "GtkTreeSortable")
- (c-name "gtk_tree_sortable_set_default_sort_func")
- (return-type "none")
- (parameters
- '("GtkTreeIterCompareFunc" "sort_func")
- '("gpointer" "user_data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method has_default_sort_func
- (of-object "GtkTreeSortable")
- (c-name "gtk_tree_sortable_has_default_sort_func")
- (return-type "gboolean")
-)
-
-(define-virtual sort_column_changed
- (of-object "GtkTreeSortable")
- (return-type "none")
-)
-(define-virtual get_sort_column_id
- (of-object "GtkTreeSortable")
- (return-type "gboolean")
- (parameters
- '("gint*" "sort_column_id")
- '("GtkSortType*" "order")
- )
-)
-(define-virtual set_sort_column_id
- (of-object "GtkTreeSortable")
- (return-type "none")
- (parameters
- '("gint" "sort_column_id")
- '("GtkSortType" "order")
- )
-)
-(define-virtual set_sort_func
- (of-object "GtkTreeSortable")
- (return-type "none")
- (parameters
- '("gint" "sort_column_id")
- '("GtkTreeIterCompareFunc" "func")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-(define-virtual set_default_sort_func
- (of-object "GtkTreeSortable")
- (return-type "none")
- (parameters
- '("GtkTreeIterCompareFunc" "func")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-(define-virtual has_default_sort_func
- (of-object "GtkTreeSortable")
- (return-type "gboolean")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktreestore.h
-
-(define-function gtk_tree_store_get_type
- (c-name "gtk_tree_store_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tree_store_new
- (c-name "gtk_tree_store_new")
- (is-constructor-of "GtkTreeStore")
- (return-type "GtkTreeStore*")
- (parameters
- '("gint" "n_columns")
- )
- (varargs #t)
-)
-
-(define-function gtk_tree_store_newv
- (c-name "gtk_tree_store_newv")
- (is-constructor-of "GtkTreeStore")
- (return-type "GtkTreeStore*")
- (parameters
- '("gint" "n_columns")
- '("GType*" "types")
- )
-)
-
-(define-method set_column_types
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_set_column_types")
- (return-type "none")
- (parameters
- '("gint" "n_columns")
- '("GType*" "types")
- )
-)
-
-(define-method set_value
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_set_value")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("gint" "column")
- '("GValue*" "value")
- )
-)
-
-(define-method set
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_set")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- )
- (varargs #t)
-)
-
-(define-method set_valist
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_set_valist")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("va_list" "var_args")
- )
-)
-
-(define-method remove
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_remove")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method insert
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_insert")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "parent")
- '("gint" "position")
- )
-)
-
-(define-method insert_before
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_insert_before")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "parent")
- '("GtkTreeIter*" "sibling")
- )
-)
-
-(define-method insert_after
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_insert_after")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "parent")
- '("GtkTreeIter*" "sibling")
- )
-)
-
-(define-method prepend
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_prepend")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "parent")
- )
-)
-
-(define-method append
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_append")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "parent")
- )
-)
-
-(define-method is_ancestor
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_is_ancestor")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "descendant")
- )
-)
-
-(define-method iter_depth
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_iter_depth")
- (return-type "gint")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method clear
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_clear")
- (return-type "none")
-)
-
-(define-method iter_is_valid
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_iter_is_valid")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-(define-method reorder
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_reorder")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "parent")
- '("gint*" "new_order")
- )
-)
-
-(define-method swap
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_swap")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "a")
- '("GtkTreeIter*" "b")
- )
-)
-
-(define-method move_after
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_move_after")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "position" (null-ok))
- )
-)
-
-(define-method move_before
- (of-object "GtkTreeStore")
- (c-name "gtk_tree_store_move_before")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreeIter*" "position" (null-ok))
- )
-)
-
-(define-method queue_resize
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_queue_resize")
- (return-type "none")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktreeview.h
-
-(define-function gtk_tree_view_get_type
- (c-name "gtk_tree_view_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tree_view_new
- (c-name "gtk_tree_view_new")
- (is-constructor-of "GtkTreeView")
- (return-type "GtkWidget*")
-)
-
-(define-function gtk_tree_view_new_with_model
- (c-name "gtk_tree_view_new_with_model")
- (is-constructor-of "GtkTreeView")
- (return-type "GtkWidget*")
- (properties
- '("model" (optional))
- )
-)
-
-(define-method get_model
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_model")
- (return-type "GtkTreeModel*")
-)
-
-(define-method set_model
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_model")
- (return-type "none")
- (parameters
- '("GtkTreeModel*" "model" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_selection
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_selection")
- (return-type "GtkTreeSelection*")
-)
-
-(define-method get_hadjustment
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_hadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method set_hadjustment
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_hadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment")
- )
-)
-
-(define-method get_vadjustment
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_vadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method set_vadjustment
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_vadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment")
- )
-)
-
-(define-method get_headers_visible
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_headers_visible")
- (return-type "gboolean")
-)
-
-(define-method set_headers_visible
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_headers_visible")
- (return-type "none")
- (parameters
- '("gboolean" "headers_visible")
- )
-)
-
-(define-method columns_autosize
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_columns_autosize")
- (return-type "none")
-)
-
-(define-method set_headers_clickable
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_headers_clickable")
- (return-type "none")
- (parameters
- '("gboolean" "active")
- )
-)
-
-(define-method set_rules_hint
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_rules_hint")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_rules_hint
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_rules_hint")
- (return-type "gboolean")
-)
-
-(define-method append_column
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_append_column")
- (return-type "gint")
- (parameters
- '("GtkTreeViewColumn*" "column")
- )
-)
-
-(define-method remove_column
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_remove_column")
- (return-type "gint")
- (parameters
- '("GtkTreeViewColumn*" "column")
- )
-)
-
-(define-method insert_column
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_insert_column")
- (return-type "gint")
- (parameters
- '("GtkTreeViewColumn*" "column")
- '("gint" "position")
- )
-)
-
-(define-method insert_column_with_attributes
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_insert_column_with_attributes")
- (return-type "gint")
- (parameters
- '("gint" "position")
- '("const-gchar*" "title")
- '("GtkCellRenderer*" "cell")
- )
- (varargs #t)
-)
-
-(define-method insert_column_with_data_func
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_insert_column_with_data_func")
- (return-type "gint")
- (parameters
- '("gint" "position")
- '("const-gchar*" "title")
- '("GtkCellRenderer*" "cell")
- '("GtkTreeCellDataFunc" "func")
- '("gpointer" "data")
- '("GDestroyNotify" "dnotify")
- )
-)
-
-(define-method get_column
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_column")
- (return-type "GtkTreeViewColumn*")
- (parameters
- '("gint" "n")
- )
-)
-
-(define-method get_columns
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_columns")
- (return-type "GList*")
-)
-
-(define-method move_column_after
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_move_column_after")
- (return-type "none")
- (parameters
- '("GtkTreeViewColumn*" "column")
- '("GtkTreeViewColumn*" "base_column" (null-ok))
- )
-)
-
-(define-method set_expander_column
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_expander_column")
- (return-type "none")
- (parameters
- '("GtkTreeViewColumn*" "column")
- )
-)
-
-(define-method get_expander_column
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_expander_column")
- (return-type "GtkTreeViewColumn*")
-)
-
-(define-method set_column_drag_function
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_column_drag_function")
- (return-type "none")
- (parameters
- '("GtkTreeViewColumnDropFunc" "func")
- '("gpointer" "user_data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method scroll_to_point
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_scroll_to_point")
- (return-type "none")
- (parameters
- '("gint" "tree_x")
- '("gint" "tree_y")
- )
-)
-
-(define-method scroll_to_cell
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_scroll_to_cell")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeViewColumn*" "column" (null-ok) (default "NULL"))
- '("gboolean" "use_align" (default "FALSE"))
- '("gfloat" "row_align" (default "0.0"))
- '("gfloat" "col_align" (default "0.0"))
- )
-)
-
-(define-method row_activated
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_row_activated")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeViewColumn*" "column")
- )
-)
-
-(define-method expand_all
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_expand_all")
- (return-type "none")
-)
-
-(define-method collapse_all
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_collapse_all")
- (return-type "none")
-)
-
-(define-method expand_to_path
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_expand_to_path")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method expand_row
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_expand_row")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "path")
- '("gboolean" "open_all")
- )
-)
-
-(define-method collapse_row
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_collapse_row")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method map_expanded_rows
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_map_expanded_rows")
- (return-type "none")
- (parameters
- '("GtkTreeViewMappingFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method row_expanded
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_row_expanded")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method set_reorderable
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_reorderable")
- (return-type "none")
- (parameters
- '("gboolean" "reorderable")
- )
-)
-
-(define-method get_reorderable
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_reorderable")
- (return-type "gboolean")
-)
-
-(define-method set_cursor
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_cursor")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeViewColumn*" "focus_column" (null-ok) (default "NULL"))
- '("gboolean" "start_editing" (default "FALSE"))
- )
-)
-
-(define-method set_cursor_on_cell
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_cursor_on_cell")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeViewColumn*" "focus_column" (null-ok) (default "NULL"))
- '("GtkCellRenderer*" "focus_cell" (null-ok) (default "NULL"))
- '("gboolean" "start_editing" (default "FALSE"))
- )
-)
-
-(define-method get_cursor
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_cursor")
- (return-type "none")
- (parameters
- '("GtkTreePath**" "path")
- '("GtkTreeViewColumn**" "focus_column")
- )
-)
-
-(define-method get_bin_window
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_bin_window")
- (return-type "GdkWindow*")
-)
-
-(define-method get_path_at_pos
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_path_at_pos")
- (return-type "gboolean")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("GtkTreePath**" "path")
- '("GtkTreeViewColumn**" "column")
- '("gint*" "cell_x")
- '("gint*" "cell_y")
- )
-)
-
-(define-method get_cell_area
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_cell_area")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeViewColumn*" "column")
- '("GdkRectangle*" "rect")
- )
-)
-
-(define-method get_background_area
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_background_area")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeViewColumn*" "column")
- '("GdkRectangle*" "rect")
- )
-)
-
-(define-method get_visible_rect
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_visible_rect")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "visible_rect")
- )
-)
-
-(define-method widget_to_tree_coords
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_widget_to_tree_coords")
- (return-type "none")
- (parameters
- '("gint" "wx")
- '("gint" "wy")
- '("gint*" "tx")
- '("gint*" "ty")
- )
-)
-
-(define-method tree_to_widget_coords
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_tree_to_widget_coords")
- (return-type "none")
- (parameters
- '("gint" "tx")
- '("gint" "ty")
- '("gint*" "wx")
- '("gint*" "wy")
- )
-)
-
-(define-method enable_model_drag_source
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_enable_model_drag_source")
- (return-type "none")
- (parameters
- '("GdkModifierType" "start_button_mask")
- '("const-GtkTargetEntry*" "targets")
- '("gint" "n_targets")
- '("GdkDragAction" "actions")
- )
-)
-
-(define-method enable_model_drag_dest
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_enable_model_drag_dest")
- (return-type "none")
- (parameters
- '("const-GtkTargetEntry*" "targets")
- '("gint" "n_targets")
- '("GdkDragAction" "actions")
- )
-)
-
-(define-method unset_rows_drag_source
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_unset_rows_drag_source")
- (return-type "none")
-)
-
-(define-method unset_rows_drag_dest
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_unset_rows_drag_dest")
- (return-type "none")
-)
-
-(define-method set_drag_dest_row
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_drag_dest_row")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeViewDropPosition" "pos")
- )
-)
-
-(define-method get_drag_dest_row
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_drag_dest_row")
- (return-type "none")
- (parameters
- '("GtkTreePath**" "path")
- '("GtkTreeViewDropPosition*" "pos")
- )
-)
-
-(define-method get_dest_row_at_pos
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_dest_row_at_pos")
- (return-type "gboolean")
- (parameters
- '("gint" "drag_x")
- '("gint" "drag_y")
- '("GtkTreePath**" "path")
- '("GtkTreeViewDropPosition*" "pos")
- )
-)
-
-(define-method create_row_drag_icon
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_create_row_drag_icon")
- (return-type "GdkPixmap*")
- (parameters
- '("GtkTreePath*" "path")
- )
-)
-
-(define-method set_enable_search
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_enable_search")
- (return-type "none")
- (parameters
- '("gboolean" "enable_search")
- )
-)
-
-(define-method get_enable_search
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_enable_search")
- (return-type "gboolean")
-)
-
-(define-method get_search_column
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_search_column")
- (return-type "gint")
-)
-
-(define-method set_search_column
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_search_column")
- (return-type "none")
- (parameters
- '("gint" "column")
- )
-)
-
-(define-method get_search_equal_func
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_search_equal_func")
- (return-type "GtkTreeViewSearchEqualFunc")
-)
-
-(define-method set_search_equal_func
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_search_equal_func")
- (return-type "none")
- (parameters
- '("GtkTreeViewSearchEqualFunc" "search_equal_func")
- '("gpointer" "search_user_data")
- '("GtkDestroyNotify" "search_destroy")
- )
-)
-
-(define-method set_destroy_count_func
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_destroy_count_func")
- (return-type "none")
- (parameters
- '("GtkTreeDestroyCountFunc" "func")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method set_fixed_height_mode
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_fixed_height_mode")
- (return-type "none")
- (parameters
- '("gboolean" "enable")
- )
-)
-
-(define-method get_fixed_height_mode
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_fixed_height_mode")
- (return-type "gboolean")
-)
-
-(define-method set_hover_selection
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_hover_selection")
- (return-type "none")
- (parameters
- '("gboolean" "hover")
- )
-)
-
-(define-method get_hover_selection
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_hover_selection")
- (return-type "gboolean")
-)
-
-(define-method set_hover_expand
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_hover_expand")
- (return-type "none")
- (parameters
- '("gboolean" "expand")
- )
-)
-
-(define-method get_hover_expand
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_hover_expand")
- (return-type "gboolean")
-)
-
-(define-method get_row_separator_func
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_row_separator_func")
- (return-type "GtkTreeViewRowSeparatorFunc")
-)
-
-(define-method set_row_separator_func
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_set_row_separator_func")
- (return-type "none")
- (parameters
- '("GtkTreeViewRowSeparatorFunc" "func")
- '("gpointer" "data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method get_visible_range
- (of-object "GtkTreeView")
- (c-name "gtk_tree_view_get_visible_range")
- (return-type "gboolean")
- (parameters
- '("GtkTreePath**" "start_path")
- '("GtkTreePath**" "end_path")
- )
-)
-
-(define-virtual set_scroll_adjustments
- (of-object "GtkTreeView")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "hadjustment")
- '("GtkAdjustment*" "vadjustment")
- )
-)
-(define-virtual row_activated
- (of-object "GtkTreeView")
- (return-type "none")
- (parameters
- '("GtkTreePath*" "path")
- '("GtkTreeViewColumn*" "column")
- )
-)
-(define-virtual test_expand_row
- (of-object "GtkTreeView")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreePath*" "path")
- )
-)
-(define-virtual test_collapse_row
- (of-object "GtkTreeView")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreePath*" "path")
- )
-)
-(define-virtual row_expanded
- (of-object "GtkTreeView")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreePath*" "path")
- )
-)
-(define-virtual row_collapsed
- (of-object "GtkTreeView")
- (return-type "none")
- (parameters
- '("GtkTreeIter*" "iter")
- '("GtkTreePath*" "path")
- )
-)
-(define-virtual columns_changed
- (of-object "GtkTreeView")
- (return-type "none")
-)
-(define-virtual cursor_changed
- (of-object "GtkTreeView")
- (return-type "none")
-)
-(define-virtual move_cursor
- (of-object "GtkTreeView")
- (return-type "gboolean")
- (parameters
- '("GtkMovementStep" "step")
- '("gint" "count")
- )
-)
-(define-virtual select_all
- (of-object "GtkTreeView")
- (return-type "gboolean")
-)
-(define-virtual unselect_all
- (of-object "GtkTreeView")
- (return-type "gboolean")
-)
-(define-virtual select_cursor_row
- (of-object "GtkTreeView")
- (return-type "gboolean")
- (parameters
- '("gboolean" "start_editing")
- )
-)
-(define-virtual toggle_cursor_row
- (of-object "GtkTreeView")
- (return-type "gboolean")
-)
-(define-virtual expand_collapse_cursor_row
- (of-object "GtkTreeView")
- (return-type "gboolean")
- (parameters
- '("gboolean" "logical")
- '("gboolean" "expand")
- '("gboolean" "open_all")
- )
-)
-(define-virtual select_cursor_parent
- (of-object "GtkTreeView")
- (return-type "gboolean")
-)
-(define-virtual start_interactive_search
- (of-object "GtkTreeView")
- (return-type "gboolean")
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktreeviewcolumn.h
-
-(define-function gtk_tree_view_column_get_type
- (c-name "gtk_tree_view_column_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tree_view_column_new
- (c-name "gtk_tree_view_column_new")
- (is-constructor-of "GtkTreeViewColumn")
- (return-type "GtkObject*")
-)
-
-(define-function gtk_tree_view_column_new_with_attributes
- (c-name "gtk_tree_view_column_new_with_attributes")
- (is-constructor-of "GtkTreeViewColumn")
- (return-type "GtkObject*")
- (parameters
- '("gchar*" "title")
- '("GtkCellRenderer*" "cell")
- )
- (varargs #t)
-)
-
-(define-method pack_start
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_pack_start")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("gboolean" "expand" (default "TRUE"))
- )
-)
-
-(define-method pack_end
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_pack_end")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- '("gboolean" "expand" (default "TRUE"))
- )
-)
-
-(define-method clear
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_clear")
- (return-type "none")
-)
-
-(define-method get_cell_renderers
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_cell_renderers")
- (return-type "GList*")
-)
-
-(define-method add_attribute
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_add_attribute")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell_renderer")
- '("gchar*" "attribute")
- '("gint" "column")
- )
-)
-
-(define-method set_attributes
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_attributes")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell_renderer")
- )
- (varargs #t)
-)
-
-(define-method set_cell_data_func
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_cell_data_func")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell_renderer")
- '("GtkTreeCellDataFunc" "func")
- '("gpointer" "func_data")
- '("GtkDestroyNotify" "destroy")
- )
-)
-
-(define-method clear_attributes
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_clear_attributes")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell_renderer")
- )
-)
-
-(define-method set_spacing
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_spacing")
- (return-type "none")
- (parameters
- '("gint" "spacing")
- )
-)
-
-(define-method get_spacing
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_spacing")
- (return-type "gint")
-)
-
-(define-method set_visible
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_visible")
- (return-type "none")
- (parameters
- '("gboolean" "visible")
- )
-)
-
-(define-method get_visible
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_visible")
- (return-type "gboolean")
-)
-
-(define-method set_resizable
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_resizable")
- (return-type "none")
- (parameters
- '("gboolean" "resizable")
- )
-)
-
-(define-method get_resizable
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_resizable")
- (return-type "gboolean")
-)
-
-(define-method set_sizing
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_sizing")
- (return-type "none")
- (parameters
- '("GtkTreeViewColumnSizing" "type")
- )
-)
-
-(define-method get_sizing
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_sizing")
- (return-type "gint")
-)
-
-(define-method get_width
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_width")
- (return-type "gint")
-)
-
-(define-method get_fixed_width
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_fixed_width")
- (return-type "gint")
-)
-
-(define-method set_fixed_width
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_fixed_width")
- (return-type "none")
- (parameters
- '("gint" "fixed_width")
- )
-)
-
-(define-method set_min_width
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_min_width")
- (return-type "none")
- (parameters
- '("gint" "min_width")
- )
-)
-
-(define-method get_min_width
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_min_width")
- (return-type "gint")
-)
-
-(define-method set_max_width
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_max_width")
- (return-type "none")
- (parameters
- '("gint" "max_width")
- )
-)
-
-(define-method get_max_width
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_max_width")
- (return-type "gint")
-)
-
-(define-method clicked
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_clicked")
- (return-type "none")
-)
-
-(define-method set_title
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_title")
- (return-type "none")
- (parameters
- '("gchar*" "title")
- )
-)
-
-(define-method get_title
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_title")
- (return-type "const-gchar*")
-)
-
-(define-method set_expand
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_expand")
- (return-type "none")
- (parameters
- '("gboolean" "expand")
- )
-)
-
-(define-method get_expand
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_expand")
- (return-type "gboolean")
-)
-
-(define-method set_clickable
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_clickable")
- (return-type "none")
- (parameters
- '("gboolean" "active")
- )
-)
-
-(define-method get_clickable
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_clickable")
- (return-type "gboolean")
-)
-
-(define-method set_widget
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_widget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget" (null-ok))
- )
-)
-
-(define-method get_widget
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_widget")
- (return-type "GtkWidget*")
-)
-
-(define-method set_alignment
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_alignment")
- (return-type "none")
- (parameters
- '("gfloat" "xalign")
- )
-)
-
-(define-method get_alignment
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_alignment")
- (return-type "gfloat")
-)
-
-(define-method set_reorderable
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_reorderable")
- (return-type "none")
- (parameters
- '("gboolean" "reorderable")
- )
-)
-
-(define-method get_reorderable
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_reorderable")
- (return-type "gboolean")
-)
-
-(define-method set_sort_column_id
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_sort_column_id")
- (return-type "none")
- (parameters
- '("gint" "sort_column_id")
- )
-)
-
-(define-method get_sort_column_id
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_sort_column_id")
- (return-type "gint")
-)
-
-(define-method set_sort_indicator
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_sort_indicator")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_sort_indicator
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_sort_indicator")
- (return-type "gboolean")
-)
-
-(define-method set_sort_order
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_set_sort_order")
- (return-type "none")
- (parameters
- '("GtkSortType" "order")
- )
-)
-
-(define-method get_sort_order
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_get_sort_order")
- (return-type "GtkSortType")
-)
-
-(define-method cell_set_cell_data
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_cell_set_cell_data")
- (return-type "none")
- (parameters
- '("GtkTreeModel*" "tree_model")
- '("GtkTreeIter*" "iter")
- '("gboolean" "is_expander")
- '("gboolean" "is_expanded")
- )
-)
-
-(define-method cell_get_size
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_cell_get_size")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "cell_area")
- '("gint*" "x_offset")
- '("gint*" "y_offset")
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-method cell_is_visible
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_cell_is_visible")
- (return-type "gboolean")
-)
-
-(define-method focus_cell
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_focus_cell")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell")
- )
-)
-
-(define-method cell_get_position
- (of-object "GtkTreeViewColumn")
- (c-name "gtk_tree_view_column_cell_get_position")
- (return-type "none")
- (parameters
- '("GtkCellRenderer*" "cell_renderer")
- '("gint*" "start_pos")
- '("gint*" "width")
- )
-)
-
-(define-virtual clicked
- (of-object "GtkTreeViewColumn")
- (return-type "none")
-)
-
-;; From /mondo/local/gtk-2.10/include/gtk-2.0/gtk/gtktypebuiltins.h
-
-(define-function gtk_accel_flags_get_type
- (c-name "gtk_accel_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_calendar_display_options_get_type
- (c-name "gtk_calendar_display_options_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_cell_renderer_state_get_type
- (c-name "gtk_cell_renderer_state_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_cell_renderer_mode_get_type
- (c-name "gtk_cell_renderer_mode_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_cell_type_get_type
- (c-name "gtk_cell_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_clist_drag_pos_get_type
- (c-name "gtk_clist_drag_pos_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_button_action_get_type
- (c-name "gtk_button_action_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_ctree_pos_get_type
- (c-name "gtk_ctree_pos_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_ctree_line_style_get_type
- (c-name "gtk_ctree_line_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_ctree_expander_style_get_type
- (c-name "gtk_ctree_expander_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_ctree_expansion_type_get_type
- (c-name "gtk_ctree_expansion_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_debug_flag_get_type
- (c-name "gtk_debug_flag_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_dialog_flags_get_type
- (c-name "gtk_dialog_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_response_type_get_type
- (c-name "gtk_response_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_dest_defaults_get_type
- (c-name "gtk_dest_defaults_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_target_flags_get_type
- (c-name "gtk_target_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_anchor_type_get_type
- (c-name "gtk_anchor_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_arrow_type_get_type
- (c-name "gtk_arrow_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_attach_options_get_type
- (c-name "gtk_attach_options_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_button_box_style_get_type
- (c-name "gtk_button_box_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_curve_type_get_type
- (c-name "gtk_curve_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_delete_type_get_type
- (c-name "gtk_delete_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_direction_type_get_type
- (c-name "gtk_direction_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_expander_style_get_type
- (c-name "gtk_expander_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_icon_size_get_type
- (c-name "gtk_icon_size_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_side_type_get_type
- (c-name "gtk_side_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_text_direction_get_type
- (c-name "gtk_text_direction_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_justification_get_type
- (c-name "gtk_justification_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_match_type_get_type
- (c-name "gtk_match_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_menu_direction_type_get_type
- (c-name "gtk_menu_direction_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_metric_type_get_type
- (c-name "gtk_metric_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_movement_step_get_type
- (c-name "gtk_movement_step_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_scroll_step_get_type
- (c-name "gtk_scroll_step_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_orientation_get_type
- (c-name "gtk_orientation_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_corner_type_get_type
- (c-name "gtk_corner_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_pack_type_get_type
- (c-name "gtk_pack_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_path_priority_type_get_type
- (c-name "gtk_path_priority_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_path_type_get_type
- (c-name "gtk_path_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_policy_type_get_type
- (c-name "gtk_policy_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_position_type_get_type
- (c-name "gtk_position_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_preview_type_get_type
- (c-name "gtk_preview_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_relief_style_get_type
- (c-name "gtk_relief_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_resize_mode_get_type
- (c-name "gtk_resize_mode_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_signal_run_type_get_type
- (c-name "gtk_signal_run_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_scroll_type_get_type
- (c-name "gtk_scroll_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_selection_mode_get_type
- (c-name "gtk_selection_mode_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_shadow_type_get_type
- (c-name "gtk_shadow_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_state_type_get_type
- (c-name "gtk_state_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_submenu_direction_get_type
- (c-name "gtk_submenu_direction_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_submenu_placement_get_type
- (c-name "gtk_submenu_placement_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_toolbar_style_get_type
- (c-name "gtk_toolbar_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_update_type_get_type
- (c-name "gtk_update_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_visibility_get_type
- (c-name "gtk_visibility_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_window_position_get_type
- (c-name "gtk_window_position_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_window_type_get_type
- (c-name "gtk_window_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_wrap_mode_get_type
- (c-name "gtk_wrap_mode_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_sort_type_get_type
- (c-name "gtk_sort_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_im_preedit_style_get_type
- (c-name "gtk_im_preedit_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_im_status_style_get_type
- (c-name "gtk_im_status_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_pack_direction_get_type
- (c-name "gtk_pack_direction_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_file_chooser_action_get_type
- (c-name "gtk_file_chooser_action_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_file_chooser_confirmation_get_type
- (c-name "gtk_file_chooser_confirmation_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_file_chooser_error_get_type
- (c-name "gtk_file_chooser_error_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_file_filter_flags_get_type
- (c-name "gtk_file_filter_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_icon_lookup_flags_get_type
- (c-name "gtk_icon_lookup_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_icon_theme_error_get_type
- (c-name "gtk_icon_theme_error_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_icon_view_drop_position_get_type
- (c-name "gtk_icon_view_drop_position_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_image_type_get_type
- (c-name "gtk_image_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_message_type_get_type
- (c-name "gtk_message_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_buttons_type_get_type
- (c-name "gtk_buttons_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_notebook_tab_get_type
- (c-name "gtk_notebook_tab_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_object_flags_get_type
- (c-name "gtk_object_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_arg_flags_get_type
- (c-name "gtk_arg_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_print_status_get_type
- (c-name "gtk_print_status_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_print_operation_result_get_type
- (c-name "gtk_print_operation_result_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_print_error_get_type
- (c-name "gtk_print_error_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_private_flags_get_type
- (c-name "gtk_private_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_progress_bar_style_get_type
- (c-name "gtk_progress_bar_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_progress_bar_orientation_get_type
- (c-name "gtk_progress_bar_orientation_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_rc_flags_get_type
- (c-name "gtk_rc_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_rc_token_type_get_type
- (c-name "gtk_rc_token_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_size_group_mode_get_type
- (c-name "gtk_size_group_mode_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_spin_button_update_policy_get_type
- (c-name "gtk_spin_button_update_policy_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_spin_type_get_type
- (c-name "gtk_spin_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_text_search_flags_get_type
- (c-name "gtk_text_search_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_text_window_type_get_type
- (c-name "gtk_text_window_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_toolbar_child_type_get_type
- (c-name "gtk_toolbar_child_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_toolbar_space_style_get_type
- (c-name "gtk_toolbar_space_style_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tree_view_mode_get_type
- (c-name "gtk_tree_view_mode_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tree_model_flags_get_type
- (c-name "gtk_tree_model_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tree_view_drop_position_get_type
- (c-name "gtk_tree_view_drop_position_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_tree_view_column_sizing_get_type
- (c-name "gtk_tree_view_column_sizing_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_ui_manager_item_type_get_type
- (c-name "gtk_ui_manager_item_type_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_widget_flags_get_type
- (c-name "gtk_widget_flags_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_widget_help_type_get_type
- (c-name "gtk_widget_help_type_get_type")
- (return-type "GType")
-)
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtktypeutils.h
-
-(define-function identifier_get_type
- (c-name "gtk_identifier_get_type")
- (return-type "GType")
-)
-
-(define-method class
- (of-object "GtkType")
- (c-name "gtk_type_class")
- (return-type "gpointer")
-)
-
-(define-method unique
- (of-object "GtkType")
- (c-name "gtk_type_unique")
- (return-type "GtkType")
- (parameters
- '("const-GtkTypeInfo*" "gtkinfo")
- )
-)
-
-(define-method new
- (of-object "GtkType")
- (c-name "gtk_type_new")
- (return-type "gpointer")
-)
-
-(define-method enum_get_values
- (of-object "GtkType")
- (c-name "gtk_type_enum_get_values")
- (return-type "GtkEnumValue*")
-)
-
-(define-method flags_get_values
- (of-object "GtkType")
- (c-name "gtk_type_flags_get_values")
- (return-type "GtkFlagValue*")
-)
-
-(define-method enum_find_value
- (of-object "GtkType")
- (c-name "gtk_type_enum_find_value")
- (return-type "GtkEnumValue*")
- (parameters
- '("const-gchar*" "value_name")
- )
-)
-
-(define-method flags_find_value
- (of-object "GtkType")
- (c-name "gtk_type_flags_find_value")
- (return-type "GtkFlagValue*")
- (parameters
- '("const-gchar*" "value_name")
- )
-)
-
-(define-function gtk_type_init
- (c-name "gtk_type_init")
- (return-type "none")
- (parameters
- '("GTypeDebugFlags" "debug_flags")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkuimanager.h
-
-(define-function gtk_ui_manager_get_type
- (c-name "gtk_ui_manager_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_ui_manager_new
- (c-name "gtk_ui_manager_new")
- (is-constructor-of "GtkUIManager")
- (return-type "GtkUIManager*")
-)
-
-(define-method set_add_tearoffs
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_set_add_tearoffs")
- (return-type "none")
- (parameters
- '("gboolean" "add_tearoffs")
- )
-)
-
-(define-method get_add_tearoffs
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_get_add_tearoffs")
- (return-type "gboolean")
-)
-
-(define-method insert_action_group
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_insert_action_group")
- (return-type "none")
- (parameters
- '("GtkActionGroup*" "action_group")
- '("gint" "pos")
- )
-)
-
-(define-method remove_action_group
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_remove_action_group")
- (return-type "none")
- (parameters
- '("GtkActionGroup*" "action_group")
- )
-)
-
-(define-method get_action_groups
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_get_action_groups")
- (return-type "GList*")
-)
-
-(define-method get_accel_group
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_get_accel_group")
- (return-type "GtkAccelGroup*")
-)
-
-(define-method get_widget
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_get_widget")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "path")
- )
-)
-
-(define-method get_toplevels
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_get_toplevels")
- (return-type "GSList*")
- (parameters
- '("GtkUIManagerItemType" "types")
- )
-)
-
-(define-method get_action
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_get_action")
- (return-type "GtkAction*")
- (parameters
- '("const-gchar*" "path")
- )
-)
-
-(define-method add_ui_from_string
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_add_ui_from_string")
- (return-type "guint")
- (parameters
- '("const-gchar*" "buffer")
- '("gssize" "length")
- '("GError**" "error")
- )
-)
-
-(define-method add_ui_from_file
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_add_ui_from_file")
- (return-type "guint")
- (parameters
- '("const-gchar*" "filename")
- '("GError**" "error")
- )
-)
-
-(define-method add_ui
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_add_ui")
- (return-type "none")
- (parameters
- '("guint" "merge_id")
- '("const-gchar*" "path")
- '("const-gchar*" "name")
- '("const-gchar*" "action" (null-ok))
- '("GtkUIManagerItemType" "type")
- '("gboolean" "top")
- )
-)
-
-(define-method remove_ui
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_remove_ui")
- (return-type "none")
- (parameters
- '("guint" "merge_id")
- )
-)
-
-(define-method get_ui
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_get_ui")
- (return-type "gchar*")
-)
-
-(define-method ensure_update
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_ensure_update")
- (return-type "none")
-)
-
-(define-method new_merge_id
- (of-object "GtkUIManager")
- (c-name "gtk_ui_manager_new_merge_id")
- (return-type "guint")
-)
-
-(define-virtual add_widget
- (of-object "GtkUIManager")
- (return-type "none")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-(define-virtual actions_changed
- (of-object "GtkUIManager")
- (return-type "none")
-)
-(define-virtual connect_proxy
- (of-object "GtkUIManager")
- (return-type "none")
- (parameters
- '("GtkAction*" "action")
- '("GtkWidget*" "proxy")
- )
-)
-(define-virtual disconnect_proxy
- (of-object "GtkUIManager")
- (return-type "none")
- (parameters
- '("GtkAction*" "action")
- '("GtkWidget*" "proxy")
- )
-)
-(define-virtual pre_activate
- (of-object "GtkUIManager")
- (return-type "none")
- (parameters
- '("GtkAction*" "action")
- )
-)
-(define-virtual post_activate
- (of-object "GtkUIManager")
- (return-type "none")
- (parameters
- '("GtkAction*" "action")
- )
-)
-
-(define-virtual get_widget
- (of-object "GtkUIManager")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "path")
- )
-)
-
-(define-virtual get_action
- (of-object "GtkUIManager")
- (return-type "GtkAction*")
- (parameters
- '("const-gchar*" "path")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkvbbox.h
-
-(define-function gtk_vbutton_box_get_type
- (c-name "gtk_vbutton_box_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_vbutton_box_new
- (c-name "gtk_vbutton_box_new")
- (is-constructor-of "GtkVButtonBox")
- (return-type "GtkWidget*")
-)
-
-(define-function vbutton_box_get_spacing_default
- (c-name "gtk_vbutton_box_get_spacing_default")
- (return-type "gint")
- (deprecated "")
-)
-
-(define-function vbutton_box_set_spacing_default
- (c-name "gtk_vbutton_box_set_spacing_default")
- (return-type "none")
- (parameters
- '("gint" "spacing")
- )
- (deprecated "")
-)
-
-(define-function vbutton_box_get_layout_default
- (c-name "gtk_vbutton_box_get_layout_default")
- (return-type "GtkButtonBoxStyle")
- (deprecated "")
-)
-
-(define-function vbutton_box_set_layout_default
- (c-name "gtk_vbutton_box_set_layout_default")
- (return-type "none")
- (parameters
- '("GtkButtonBoxStyle" "layout")
- )
- (deprecated "")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkvbox.h
-
-(define-function gtk_vbox_get_type
- (c-name "gtk_vbox_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_vbox_new
- (c-name "gtk_vbox_new")
- (is-constructor-of "GtkVBox")
- (return-type "GtkWidget*")
- (properties
- '("homogeneous" (optional))
- '("spacing" (optional))
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkversion.h
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkviewport.h
-
-(define-function gtk_viewport_get_type
- (c-name "gtk_viewport_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_viewport_new
- (c-name "gtk_viewport_new")
- (is-constructor-of "GtkViewport")
- (return-type "GtkWidget*")
- (properties
- '("hadjustment" (optional))
- '("vadjustment" (optional))
- )
-)
-
-(define-method get_hadjustment
- (of-object "GtkViewport")
- (c-name "gtk_viewport_get_hadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method get_vadjustment
- (of-object "GtkViewport")
- (c-name "gtk_viewport_get_vadjustment")
- (return-type "GtkAdjustment*")
-)
-
-(define-method set_hadjustment
- (of-object "GtkViewport")
- (c-name "gtk_viewport_set_hadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment" (null-ok))
- )
-)
-
-(define-method set_vadjustment
- (of-object "GtkViewport")
- (c-name "gtk_viewport_set_vadjustment")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "adjustment" (null-ok))
- )
-)
-
-(define-method set_shadow_type
- (of-object "GtkViewport")
- (c-name "gtk_viewport_set_shadow_type")
- (return-type "none")
- (parameters
- '("GtkShadowType" "type")
- )
-)
-
-(define-method get_shadow_type
- (of-object "GtkViewport")
- (c-name "gtk_viewport_get_shadow_type")
- (return-type "GtkShadowType")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkvpaned.h
-
-(define-function gtk_vpaned_get_type
- (c-name "gtk_vpaned_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_vpaned_new
- (c-name "gtk_vpaned_new")
- (is-constructor-of "GtkVPaned")
- (return-type "GtkWidget*")
-)
-
-(define-virtual set_scroll_adjustments
- (of-object "GtkViewport")
- (return-type "none")
- (parameters
- '("GtkAdjustment*" "hadjustment")
- '("GtkAdjustment*" "vadjustment")
- )
-)
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkvruler.h
-
-(define-function gtk_vruler_get_type
- (c-name "gtk_vruler_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_vruler_new
- (c-name "gtk_vruler_new")
- (is-constructor-of "GtkVRuler")
- (return-type "GtkWidget*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkvscale.h
-
-(define-function gtk_vscale_get_type
- (c-name "gtk_vscale_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_vscale_new
- (c-name "gtk_vscale_new")
- (is-constructor-of "GtkVScale")
- (return-type "GtkWidget*")
- (properties
- '("adjustment" (optional))
- )
-)
-
-(define-function gtk_vscale_new_with_range
- (c-name "gtk_vscale_new_with_range")
- (is-constructor-of "GtkVScale")
- (return-type "GtkWidget*")
- (parameters
- '("gdouble" "min")
- '("gdouble" "max")
- '("gdouble" "step")
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkvscrollbar.h
-
-(define-function gtk_vscrollbar_get_type
- (c-name "gtk_vscrollbar_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_vscrollbar_new
- (c-name "gtk_vscrollbar_new")
- (is-constructor-of "GtkVScrollbar")
- (return-type "GtkWidget*")
- (properties
- '("adjustment" (optional))
- )
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkvseparator.h
-
-(define-function gtk_vseparator_get_type
- (c-name "gtk_vseparator_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_vseparator_new
- (c-name "gtk_vseparator_new")
- (is-constructor-of "GtkVSeparator")
- (return-type "GtkWidget*")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkwidget.h
-
-(define-function gtk_widget_get_type
- (c-name "gtk_widget_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_widget_new
- (c-name "gtk_widget_new")
- (is-constructor-of "GtkWidget")
- (return-type "GtkWidget*")
- (parameters
- '("GType" "type")
- '("const-gchar*" "first_property_name")
- )
- (varargs #t)
-)
-
-(define-method ref
- (of-object "GtkWidget")
- (c-name "gtk_widget_ref")
- (return-type "GtkWidget*")
-)
-
-(define-method unref
- (of-object "GtkWidget")
- (c-name "gtk_widget_unref")
- (return-type "none")
-)
-
-(define-method destroy
- (of-object "GtkWidget")
- (c-name "gtk_widget_destroy")
- (return-type "none")
-)
-
-(define-method destroyed
- (of-object "GtkWidget")
- (c-name "gtk_widget_destroyed")
- (return-type "none")
- (parameters
- '("GtkWidget**" "widget_pointer")
- )
-)
-
-(define-method set
- (of-object "GtkWidget")
- (c-name "gtk_widget_set")
- (return-type "none")
- (parameters
- '("const-gchar*" "first_property_name")
- )
- (varargs #t)
-)
-
-(define-method unparent
- (of-object "GtkWidget")
- (c-name "gtk_widget_unparent")
- (return-type "none")
-)
-
-(define-method show
- (of-object "GtkWidget")
- (c-name "gtk_widget_show")
- (return-type "none")
-)
-
-(define-method show_now
- (of-object "GtkWidget")
- (c-name "gtk_widget_show_now")
- (return-type "none")
-)
-
-(define-method hide
- (of-object "GtkWidget")
- (c-name "gtk_widget_hide")
- (return-type "none")
-)
-
-(define-method show_all
- (of-object "GtkWidget")
- (c-name "gtk_widget_show_all")
- (return-type "none")
-)
-
-(define-method hide_all
- (of-object "GtkWidget")
- (c-name "gtk_widget_hide_all")
- (return-type "none")
-)
-
-(define-method set_no_show_all
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_no_show_all")
- (return-type "none")
- (parameters
- '("gboolean" "no_show_all")
- )
-)
-
-(define-method get_no_show_all
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_no_show_all")
- (return-type "gboolean")
-)
-
-(define-method map
- (of-object "GtkWidget")
- (c-name "gtk_widget_map")
- (return-type "none")
-)
-
-(define-method unmap
- (of-object "GtkWidget")
- (c-name "gtk_widget_unmap")
- (return-type "none")
-)
-
-(define-method realize
- (of-object "GtkWidget")
- (c-name "gtk_widget_realize")
- (return-type "none")
-)
-
-(define-method unrealize
- (of-object "GtkWidget")
- (c-name "gtk_widget_unrealize")
- (return-type "none")
-)
-
-(define-method queue_draw
- (of-object "GtkWidget")
- (c-name "gtk_widget_queue_draw")
- (return-type "none")
-)
-
-(define-method queue_draw_area
- (of-object "GtkWidget")
- (c-name "gtk_widget_queue_draw_area")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method queue_clear
- (of-object "GtkWidget")
- (c-name "gtk_widget_queue_clear")
- (return-type "none")
- (deprecated "use GtkWidget.queue_draw")
-)
-
-(define-method queue_clear_area
- (of-object "GtkWidget")
- (c-name "gtk_widget_queue_clear_area")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "use GtkWidget.queue_draw_area")
-)
-
-(define-method queue_resize
- (of-object "GtkWidget")
- (c-name "gtk_widget_queue_resize")
- (return-type "none")
-)
-
-(define-method queue_resize_no_redraw
- (of-object "GtkWidget")
- (c-name "gtk_widget_queue_resize_no_redraw")
- (return-type "none")
-)
-
-(define-method draw
- (of-object "GtkWidget")
- (c-name "gtk_widget_draw")
- (return-type "none")
- (parameters
- '("GdkRectangle*" "area")
- )
- (deprecated "use GtkWidget.queue_draw_area")
-)
-
-(define-method size_request
- (of-object "GtkWidget")
- (c-name "gtk_widget_size_request")
- (return-type "none")
- (parameters
- '("GtkRequisition*" "requisition")
- )
-)
-
-(define-method size_allocate
- (of-object "GtkWidget")
- (c-name "gtk_widget_size_allocate")
- (return-type "none")
- (parameters
- '("GtkAllocation*" "allocation")
- )
-)
-
-(define-method get_child_requisition
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_child_requisition")
- (return-type "none")
- (parameters
- '("GtkRequisition*" "requisition")
- )
-)
-
-(define-method add_accelerator
- (of-object "GtkWidget")
- (c-name "gtk_widget_add_accelerator")
- (return-type "none")
- (parameters
- '("const-gchar*" "accel_signal")
- '("GtkAccelGroup*" "accel_group")
- '("guint" "accel_key")
- '("GdkModifierType" "accel_mods")
- '("GtkAccelFlags" "accel_flags")
- )
-)
-
-(define-method remove_accelerator
- (of-object "GtkWidget")
- (c-name "gtk_widget_remove_accelerator")
- (return-type "gboolean")
- (parameters
- '("GtkAccelGroup*" "accel_group")
- '("guint" "accel_key")
- '("GdkModifierType" "accel_mods")
- )
-)
-
-(define-method set_accel_path
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_accel_path")
- (return-type "none")
- (parameters
- '("const-gchar*" "accel_path")
- '("GtkAccelGroup*" "accel_group")
- )
-)
-
-(define-method list_accel_closures
- (of-object "GtkWidget")
- (c-name "gtk_widget_list_accel_closures")
- (return-type "GList*")
-)
-
-(define-method can_activate_accel
- (of-object "GtkWidget")
- (c-name "gtk_widget_can_activate_accel")
- (return-type "gboolean")
- (parameters
- '("guint" "signal_id")
- )
-)
-
-(define-method mnemonic_activate
- (of-object "GtkWidget")
- (c-name "gtk_widget_mnemonic_activate")
- (return-type "gboolean")
- (parameters
- '("gboolean" "group_cycling")
- )
-)
-
-(define-method event
- (of-object "GtkWidget")
- (c-name "gtk_widget_event")
- (return-type "gboolean")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-
-(define-method send_expose
- (of-object "GtkWidget")
- (c-name "gtk_widget_send_expose")
- (return-type "gint")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-
-(define-method activate
- (of-object "GtkWidget")
- (c-name "gtk_widget_activate")
- (return-type "gboolean")
-)
-
-(define-method set_scroll_adjustments
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_scroll_adjustments")
- (return-type "gboolean")
- (parameters
- '("GtkAdjustment*" "hadjustment" (null-ok))
- '("GtkAdjustment*" "vadjustment" (null-ok))
- )
-)
-
-(define-method reparent
- (of-object "GtkWidget")
- (c-name "gtk_widget_reparent")
- (return-type "none")
- (parameters
- '("GtkWidget*" "new_parent")
- )
-)
-
-(define-method intersect
- (of-object "GtkWidget")
- (c-name "gtk_widget_intersect")
- (return-type "gboolean")
- (parameters
- '("GdkRectangle*" "area")
- '("GdkRectangle*" "intersection")
- )
-)
-
-(define-method region_intersect
- (of-object "GtkWidget")
- (c-name "gtk_widget_region_intersect")
- (return-type "GdkRegion*")
- (caller-owns-return #t)
- (parameters
- '("GdkRegion*" "region")
- )
-)
-
-(define-method freeze_child_notify
- (of-object "GtkWidget")
- (c-name "gtk_widget_freeze_child_notify")
- (return-type "none")
-)
-
-(define-method child_notify
- (of-object "GtkWidget")
- (c-name "gtk_widget_child_notify")
- (return-type "none")
- (parameters
- '("const-gchar*" "child_property")
- )
-)
-
-(define-method thaw_child_notify
- (of-object "GtkWidget")
- (c-name "gtk_widget_thaw_child_notify")
- (return-type "none")
-)
-
-(define-method is_focus
- (of-object "GtkWidget")
- (c-name "gtk_widget_is_focus")
- (return-type "gboolean")
-)
-
-(define-method grab_focus
- (of-object "GtkWidget")
- (c-name "gtk_widget_grab_focus")
- (return-type "none")
-)
-
-(define-method grab_default
- (of-object "GtkWidget")
- (c-name "gtk_widget_grab_default")
- (return-type "none")
-)
-
-(define-method set_name
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method get_name
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_name")
- (return-type "const-gchar*")
-)
-
-(define-method set_state
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_state")
- (return-type "none")
- (parameters
- '("GtkStateType" "state")
- )
-)
-
-(define-method set_sensitive
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_sensitive")
- (return-type "none")
- (parameters
- '("gboolean" "sensitive")
- )
-)
-
-(define-method set_app_paintable
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_app_paintable")
- (return-type "none")
- (parameters
- '("gboolean" "app_paintable")
- )
-)
-
-(define-method set_double_buffered
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_double_buffered")
- (return-type "none")
- (parameters
- '("gboolean" "double_buffered")
- )
-)
-
-(define-method set_redraw_on_allocate
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_redraw_on_allocate")
- (return-type "none")
- (parameters
- '("gboolean" "redraw_on_allocate")
- )
-)
-
-(define-method set_parent
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_parent")
- (return-type "none")
- (parameters
- '("GtkWidget*" "parent")
- )
-)
-
-(define-method set_parent_window
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_parent_window")
- (return-type "none")
- (parameters
- '("GdkWindow*" "parent_window")
- )
-)
-
-(define-method set_child_visible
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_child_visible")
- (return-type "none")
- (parameters
- '("gboolean" "is_visible")
- )
-)
-
-(define-method get_child_visible
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_child_visible")
- (return-type "gboolean")
-)
-
-(define-method get_parent
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_parent")
- (return-type "GtkWidget*")
-)
-
-(define-method get_parent_window
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_parent_window")
- (return-type "GdkWindow*")
-)
-
-(define-method child_focus
- (of-object "GtkWidget")
- (c-name "gtk_widget_child_focus")
- (return-type "gboolean")
- (parameters
- '("GtkDirectionType" "direction")
- )
-)
-
-(define-method set_size_request
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_size_request")
- (return-type "none")
- (parameters
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method get_size_request
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_size_request")
- (return-type "none")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-method set_uposition
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_uposition")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
- (deprecated "")
-)
-
-(define-method set_usize
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_usize")
- (return-type "none")
- (parameters
- '("gint" "width")
- '("gint" "height")
- )
- (deprecated "use GtkWidget.set_size_request")
-)
-
-(define-method set_events
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_events")
- (return-type "none")
- (parameters
- '("gint" "events")
- )
-)
-
-(define-method add_events
- (of-object "GtkWidget")
- (c-name "gtk_widget_add_events")
- (return-type "none")
- (parameters
- '("gint" "events")
- )
-)
-
-(define-method set_extension_events
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_extension_events")
- (return-type "none")
- (parameters
- '("GdkExtensionMode" "mode")
- )
-)
-
-(define-method get_extension_events
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_extension_events")
- (return-type "GdkExtensionMode")
-)
-
-(define-method get_toplevel
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_toplevel")
- (return-type "GtkWidget*")
-)
-
-(define-method get_ancestor
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_ancestor")
- (return-type "GtkWidget*")
- (parameters
- '("GType" "widget_type")
- )
-)
-
-(define-method get_colormap
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_colormap")
- (return-type "GdkColormap*")
-)
-
-(define-method get_visual
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_visual")
- (return-type "GdkVisual*")
-)
-
-(define-method get_screen
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_screen")
- (return-type "GdkScreen*")
-)
-
-(define-method has_screen
- (of-object "GtkWidget")
- (c-name "gtk_widget_has_screen")
- (return-type "gboolean")
-)
-
-(define-method get_display
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_display")
- (return-type "GdkDisplay*")
-)
-
-(define-method get_root_window
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_root_window")
- (return-type "GdkWindow*")
-)
-
-(define-method get_settings
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_settings")
- (return-type "GtkSettings*")
-)
-
-(define-method get_clipboard
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_clipboard")
- (return-type "GtkClipboard*")
- (parameters
- '("GdkAtom" "selection")
- )
-)
-
-(define-method get_accessible
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_accessible")
- (return-type "AtkObject*")
-)
-
-(define-method set_colormap
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_colormap")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- )
-)
-
-(define-method get_events
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_events")
- (return-type "gint")
-)
-
-(define-method get_pointer
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_pointer")
- (return-type "none")
- (parameters
- '("gint*" "x")
- '("gint*" "y")
- )
-)
-
-(define-method is_ancestor
- (of-object "GtkWidget")
- (c-name "gtk_widget_is_ancestor")
- (return-type "gboolean")
- (parameters
- '("GtkWidget*" "ancestor")
- )
-)
-
-(define-method translate_coordinates
- (of-object "GtkWidget")
- (c-name "gtk_widget_translate_coordinates")
- (return-type "gboolean")
- (parameters
- '("GtkWidget*" "dest_widget")
- '("gint" "src_x")
- '("gint" "src_y")
- '("gint*" "dest_x")
- '("gint*" "dest_y")
- )
-)
-
-(define-method hide_on_delete
- (of-object "GtkWidget")
- (c-name "gtk_widget_hide_on_delete")
- (return-type "gboolean")
-)
-
-(define-method set_style
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_style")
- (return-type "none")
- (parameters
- '("GtkStyle*" "style" (null-ok))
- )
-)
-
-(define-method ensure_style
- (of-object "GtkWidget")
- (c-name "gtk_widget_ensure_style")
- (return-type "none")
-)
-
-(define-method get_style
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_style")
- (return-type "GtkStyle*")
-)
-
-(define-method modify_style
- (of-object "GtkWidget")
- (c-name "gtk_widget_modify_style")
- (return-type "none")
- (parameters
- '("GtkRcStyle*" "style")
- )
-)
-
-(define-method get_modifier_style
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_modifier_style")
- (return-type "GtkRcStyle*")
-)
-
-(define-method modify_fg
- (of-object "GtkWidget")
- (c-name "gtk_widget_modify_fg")
- (return-type "none")
- (parameters
- '("GtkStateType" "state")
- '("GdkColor*" "color" (null-ok))
- )
-)
-
-(define-method modify_bg
- (of-object "GtkWidget")
- (c-name "gtk_widget_modify_bg")
- (return-type "none")
- (parameters
- '("GtkStateType" "state")
- '("GdkColor*" "color" (null-ok))
- )
-)
-
-(define-method modify_text
- (of-object "GtkWidget")
- (c-name "gtk_widget_modify_text")
- (return-type "none")
- (parameters
- '("GtkStateType" "state")
- '("GdkColor*" "color" (null-ok))
- )
-)
-
-(define-method modify_base
- (of-object "GtkWidget")
- (c-name "gtk_widget_modify_base")
- (return-type "none")
- (parameters
- '("GtkStateType" "state")
- '("GdkColor*" "color" (null-ok))
- )
-)
-
-(define-method modify_font
- (of-object "GtkWidget")
- (c-name "gtk_widget_modify_font")
- (return-type "none")
- (parameters
- '("PangoFontDescription*" "font_desc" (null-ok))
- )
-)
-
-(define-method create_pango_context
- (of-object "GtkWidget")
- (c-name "gtk_widget_create_pango_context")
- (caller-owns-return #t)
- (return-type "PangoContext*")
-)
-
-(define-method get_pango_context
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_pango_context")
- (return-type "PangoContext*")
-)
-
-(define-method create_pango_layout
- (of-object "GtkWidget")
- (c-name "gtk_widget_create_pango_layout")
- (caller-owns-return #t)
- (return-type "PangoLayout*")
- (parameters
- '("const-gchar*" "text")
- )
-)
-
-(define-method render_icon
- (of-object "GtkWidget")
- (c-name "gtk_widget_render_icon")
- (return-type "GdkPixbuf*")
- (caller-owns-return #t)
- (parameters
- '("const-gchar*" "stock_id")
- '("GtkIconSize" "size")
- '("const-gchar*" "detail" (null-ok) (default "NULL"))
- )
-)
-
-(define-method set_composite_name
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_composite_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method get_composite_name
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_composite_name")
- (return-type "gchar*")
-)
-
-(define-method reset_rc_styles
- (of-object "GtkWidget")
- (c-name "gtk_widget_reset_rc_styles")
- (return-type "none")
-)
-
-(define-function widget_push_colormap
- (c-name "gtk_widget_push_colormap")
- (return-type "none")
- (parameters
- '("GdkColormap*" "cmap")
- )
-)
-
-(define-function widget_push_composite_child
- (c-name "gtk_widget_push_composite_child")
- (return-type "none")
-)
-
-(define-function widget_pop_composite_child
- (c-name "gtk_widget_pop_composite_child")
- (return-type "none")
-)
-
-(define-function widget_pop_colormap
- (c-name "gtk_widget_pop_colormap")
- (return-type "none")
-)
-
-(define-function widget_class_install_style_property
- (c-name "gtk_widget_class_install_style_property")
- (return-type "none")
- (parameters
- '("GtkWidgetClass*" "klass")
- '("GParamSpec*" "pspec")
- )
-)
-
-(define-function widget_class_install_style_property_parser
- (c-name "gtk_widget_class_install_style_property_parser")
- (return-type "none")
- (parameters
- '("GtkWidgetClass*" "klass")
- '("GParamSpec*" "pspec")
- '("GtkRcPropertyParser" "parser")
- )
-)
-
-(define-function widget_class_find_style_property
- (c-name "gtk_widget_class_find_style_property")
- (return-type "GParamSpec*")
- (parameters
- '("GtkWidgetClass*" "klass")
- '("const-gchar*" "property_name")
- )
-)
-
-(define-function widget_class_list_style_properties
- (c-name "gtk_widget_class_list_style_properties")
- (return-type "GParamSpec**")
- (parameters
- '("guint*" "n_properties")
- )
-)
-
-(define-method style_get_property
- (of-object "GtkWidget")
- (c-name "gtk_widget_style_get_property")
- (return-type "none")
- (parameters
- '("const-gchar*" "property_name")
- '("GValue*" "value")
- )
-)
-
-(define-method style_get_valist
- (of-object "GtkWidget")
- (c-name "gtk_widget_style_get_valist")
- (return-type "none")
- (parameters
- '("const-gchar*" "first_property_name")
- '("va_list" "var_args")
- )
-)
-
-(define-method style_get
- (of-object "GtkWidget")
- (c-name "gtk_widget_style_get")
- (return-type "none")
- (parameters
- '("const-gchar*" "first_property_name")
- )
- (varargs #t)
-)
-
-(define-function widget_get_default_style
- (c-name "gtk_widget_get_default_style")
- (return-type "GtkStyle*")
-)
-
-(define-function widget_set_default_colormap
- (c-name "gtk_widget_set_default_colormap")
- (return-type "none")
- (parameters
- '("GdkColormap*" "colormap")
- )
-)
-
-(define-function widget_get_default_colormap
- (c-name "gtk_widget_get_default_colormap")
- (return-type "GdkColormap*")
-)
-
-(define-function widget_get_default_visual
- (c-name "gtk_widget_get_default_visual")
- (return-type "GdkVisual*")
-)
-
-(define-method set_direction
- (of-object "GtkWidget")
- (c-name "gtk_widget_set_direction")
- (return-type "none")
- (parameters
- '("GtkTextDirection" "dir")
- )
-)
-
-(define-method get_direction
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_direction")
- (return-type "GtkTextDirection")
-)
-
-(define-function widget_set_default_direction
- (c-name "gtk_widget_set_default_direction")
- (return-type "none")
- (parameters
- '("GtkTextDirection" "dir")
- )
-)
-
-(define-function widget_get_default_direction
- (c-name "gtk_widget_get_default_direction")
- (return-type "GtkTextDirection")
-)
-
-(define-method shape_combine_mask
- (of-object "GtkWidget")
- (c-name "gtk_widget_shape_combine_mask")
- (return-type "none")
- (parameters
- '("GdkBitmap*" "shape_mask")
- '("gint" "offset_x")
- '("gint" "offset_y")
- )
-)
-
-(define-method reset_shapes
- (of-object "GtkWidget")
- (c-name "gtk_widget_reset_shapes")
- (return-type "none")
-)
-
-(define-method path
- (of-object "GtkWidget")
- (c-name "gtk_widget_path")
- (return-type "none")
- (parameters
- '("guint*" "path_length")
- '("gchar**" "path")
- '("gchar**" "path_reversed")
- )
-)
-
-(define-method class_path
- (of-object "GtkWidget")
- (c-name "gtk_widget_class_path")
- (return-type "none")
- (parameters
- '("guint*" "path_length")
- '("gchar**" "path")
- '("gchar**" "path_reversed")
- )
-)
-
-(define-method list_mnemonic_labels
- (of-object "GtkWidget")
- (c-name "gtk_widget_list_mnemonic_labels")
- (return-type "GList*")
-)
-
-(define-method add_mnemonic_label
- (of-object "GtkWidget")
- (c-name "gtk_widget_add_mnemonic_label")
- (return-type "none")
- (parameters
- '("GtkWidget*" "label")
- )
-)
-
-(define-method remove_mnemonic_label
- (of-object "GtkWidget")
- (c-name "gtk_widget_remove_mnemonic_label")
- (return-type "none")
- (parameters
- '("GtkWidget*" "label")
- )
-)
-
-(define-virtual dispatch_child_properties_changed
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("guint" "n_pspecs")
- '("GParamSpec**" "pspecs")
- )
-)
-(define-virtual show
- (of-object "GtkWidget")
- (return-type "none")
-)
-(define-virtual show_all
- (of-object "GtkWidget")
- (return-type "none")
-)
-(define-virtual hide
- (of-object "GtkWidget")
- (return-type "none")
-)
-(define-virtual hide_all
- (of-object "GtkWidget")
- (return-type "none")
-)
-(define-virtual map
- (of-object "GtkWidget")
- (return-type "none")
-)
-(define-virtual unmap
- (of-object "GtkWidget")
- (return-type "none")
-)
-(define-virtual realize
- (of-object "GtkWidget")
- (return-type "none")
-)
-(define-virtual unrealize
- (of-object "GtkWidget")
- (return-type "none")
-)
-(define-virtual size_request
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GtkRequisition*" "requisition")
- )
-)
-(define-virtual size_allocate
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GtkAllocation*" "allocation")
- )
-)
-(define-virtual state_changed
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GtkStateType" "previous_state")
- )
-)
-(define-virtual parent_set
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "previous_parent")
- )
-)
-(define-virtual hierarchy_changed
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GtkWidget*" "previous_toplevel")
- )
-)
-(define-virtual style_set
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GtkStyle*" "previous_style")
- )
-)
-(define-virtual direction_changed
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GtkTextDirection" "previous_direction")
- )
-)
-(define-virtual grab_notify
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("gboolean" "was_grabbed")
- )
-)
-(define-virtual child_notify
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GParamSpec*" "pspec")
- )
-)
-(define-virtual mnemonic_activate
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("gboolean" "group_cycling")
- )
-)
-(define-virtual grab_focus
- (of-object "GtkWidget")
- (return-type "none")
-)
-(define-virtual focus
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GtkDirectionType" "direction")
- )
-)
-(define-virtual event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-(define-virtual button_press_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventButton*" "event")
- )
-)
-(define-virtual button_release_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventButton*" "event")
- )
-)
-(define-virtual scroll_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventScroll*" "event")
- )
-)
-(define-virtual motion_notify_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventMotion*" "event")
- )
-)
-(define-virtual delete_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventAny*" "event")
- )
-)
-(define-virtual destroy_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventAny*" "event")
- )
-)
-(define-virtual expose_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventExpose*" "event")
- )
-)
-(define-virtual key_press_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventKey*" "event")
- )
-)
-(define-virtual key_release_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventKey*" "event")
- )
-)
-(define-virtual enter_notify_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventCrossing*" "event")
- )
-)
-(define-virtual leave_notify_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventCrossing*" "event")
- )
-)
-(define-virtual configure_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventConfigure*" "event")
- )
-)
-(define-virtual focus_in_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventFocus*" "event")
- )
-)
-(define-virtual focus_out_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventFocus*" "event")
- )
-)
-(define-virtual map_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventAny*" "event")
- )
-)
-(define-virtual unmap_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventAny*" "event")
- )
-)
-(define-virtual property_notify_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventProperty*" "event")
- )
-)
-(define-virtual selection_clear_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventSelection*" "event")
- )
-)
-(define-virtual selection_request_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventSelection*" "event")
- )
-)
-(define-virtual selection_notify_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventSelection*" "event")
- )
-)
-(define-virtual proximity_in_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventProximity*" "event")
- )
-)
-(define-virtual proximity_out_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventProximity*" "event")
- )
-)
-(define-virtual visibility_notify_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventVisibility*" "event")
- )
-)
-(define-virtual client_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventClient*" "event")
- )
-)
-(define-virtual no_expose_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventAny*" "event")
- )
-)
-(define-virtual window_state_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventWindowState*" "event")
- )
-)
-(define-virtual selection_get
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GtkSelectionData*" "selection_data")
- '("guint" "info")
- '("guint" "time_")
- )
-)
-(define-virtual selection_received
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GtkSelectionData*" "selection_data")
- '("guint" "time_")
- )
-)
-(define-virtual drag_begin
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- )
-)
-(define-virtual drag_end
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- )
-)
-(define-virtual drag_data_get
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- '("GtkSelectionData*" "selection_data")
- '("guint" "info")
- '("guint" "time_")
- )
-)
-(define-virtual drag_data_delete
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- )
-)
-(define-virtual drag_leave
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- '("guint" "time_")
- )
-)
-(define-virtual drag_motion
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkDragContext*" "context")
- '("gint" "x")
- '("gint" "y")
- '("guint" "time_")
- )
-)
-(define-virtual drag_drop
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkDragContext*" "context")
- '("gint" "x")
- '("gint" "y")
- '("guint" "time_")
- )
-)
-(define-virtual drag_data_received
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GdkDragContext*" "context")
- '("gint" "x")
- '("gint" "y")
- '("GtkSelectionData*" "selection_data")
- '("guint" "info")
- '("guint" "time_")
- )
-)
-(define-virtual popup_menu
- (of-object "GtkWidget")
- (return-type "gboolean")
-)
-(define-virtual show_help
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GtkWidgetHelpType" "help_type")
- )
-)
-(define-virtual get_accessible
- (of-object "GtkWidget")
- (return-type "AtkObject*")
-)
-
-(define-virtual screen_changed
- (of-object "GtkWidget")
- (return-type "none")
- (parameters
- '("GdkScreen*" "previous_screen")
- )
-)
-(define-virtual can_activate_accel
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("guint" "signal_id")
- )
-)
-(define-virtual grab_broken_event
- (of-object "GtkWidget")
- (return-type "gboolean")
- (parameters
- '("GdkEventGrabBroken*" "event")
- )
-)
-
-
-
-(define-function gtk_requisition_get_type
- (c-name "gtk_requisition_get_type")
- (return-type "GType")
-)
-
-(define-method copy
- (of-object "GtkRequisition")
- (c-name "gtk_requisition_copy")
- (return-type "GtkRequisition*")
- (caller-owns-return #t)
-)
-
-(define-method free
- (of-object "GtkRequisition")
- (c-name "gtk_requisition_free")
- (return-type "none")
-)
-
-
-
-;; From /opt/gtk2/include/gtk-2.0/gtk/gtkwindow.h
-
-(define-function gtk_window_get_type
- (c-name "gtk_window_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_window_new
- (c-name "gtk_window_new")
- (is-constructor-of "GtkWindow")
- (return-type "GtkWidget*")
- (properties
- '("type" (optional))
- )
-)
-
-(define-method set_title
- (of-object "GtkWindow")
- (c-name "gtk_window_set_title")
- (return-type "none")
- (parameters
- '("const-gchar*" "title")
- )
-)
-
-(define-method get_title
- (of-object "GtkWindow")
- (c-name "gtk_window_get_title")
- (return-type "const-gchar*")
-)
-
-(define-method set_wmclass
- (of-object "GtkWindow")
- (c-name "gtk_window_set_wmclass")
- (return-type "none")
- (parameters
- '("const-gchar*" "wmclass_name")
- '("const-gchar*" "wmclass_class")
- )
-)
-
-(define-method set_role
- (of-object "GtkWindow")
- (c-name "gtk_window_set_role")
- (return-type "none")
- (parameters
- '("const-gchar*" "role")
- )
-)
-
-(define-method get_role
- (of-object "GtkWindow")
- (c-name "gtk_window_get_role")
- (return-type "const-gchar*")
-)
-
-(define-method add_accel_group
- (of-object "GtkWindow")
- (c-name "gtk_window_add_accel_group")
- (return-type "none")
- (parameters
- '("GtkAccelGroup*" "accel_group")
- )
-)
-
-(define-method remove_accel_group
- (of-object "GtkWindow")
- (c-name "gtk_window_remove_accel_group")
- (return-type "none")
- (parameters
- '("GtkAccelGroup*" "accel_group")
- )
-)
-
-(define-method set_position
- (of-object "GtkWindow")
- (c-name "gtk_window_set_position")
- (return-type "none")
- (parameters
- '("GtkWindowPosition" "position")
- )
-)
-
-(define-method activate_focus
- (of-object "GtkWindow")
- (c-name "gtk_window_activate_focus")
- (return-type "gboolean")
-)
-
-(define-method set_focus
- (of-object "GtkWindow")
- (c-name "gtk_window_set_focus")
- (return-type "none")
- (parameters
- '("GtkWidget*" "focus" (null-ok))
- )
-)
-
-(define-method get_focus
- (of-object "GtkWindow")
- (c-name "gtk_window_get_focus")
- (return-type "GtkWidget*")
-)
-
-(define-method set_default
- (of-object "GtkWindow")
- (c-name "gtk_window_set_default")
- (return-type "none")
- (parameters
- '("GtkWidget*" "default_widget" (null-ok))
- )
-)
-
-(define-method activate_default
- (of-object "GtkWindow")
- (c-name "gtk_window_activate_default")
- (return-type "gboolean")
-)
-
-(define-method set_transient_for
- (of-object "GtkWindow")
- (c-name "gtk_window_set_transient_for")
- (return-type "none")
- (parameters
- '("GtkWindow*" "parent" (null-ok))
- )
-)
-
-(define-method get_transient_for
- (of-object "GtkWindow")
- (c-name "gtk_window_get_transient_for")
- (return-type "GtkWindow*")
-)
-
-(define-method set_type_hint
- (of-object "GtkWindow")
- (c-name "gtk_window_set_type_hint")
- (return-type "none")
- (parameters
- '("GdkWindowTypeHint" "hint")
- )
-)
-
-(define-method get_type_hint
- (of-object "GtkWindow")
- (c-name "gtk_window_get_type_hint")
- (return-type "GdkWindowTypeHint")
-)
-
-(define-method set_skip_taskbar_hint
- (of-object "GtkWindow")
- (c-name "gtk_window_set_skip_taskbar_hint")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_skip_taskbar_hint
- (of-object "GtkWindow")
- (c-name "gtk_window_get_skip_taskbar_hint")
- (return-type "gboolean")
-)
-
-(define-method set_skip_pager_hint
- (of-object "GtkWindow")
- (c-name "gtk_window_set_skip_pager_hint")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_skip_pager_hint
- (of-object "GtkWindow")
- (c-name "gtk_window_get_skip_pager_hint")
- (return-type "gboolean")
-)
-
-
-(define-method set_urgency_hint
- (of-object "GtkWindow")
- (c-name "gtk_window_set_urgency_hint")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_urgency_hint
- (of-object "GtkWindow")
- (c-name "gtk_window_get_urgency_hint")
- (return-type "gboolean")
-)
-
-(define-method set_accept_focus
- (of-object "GtkWindow")
- (c-name "gtk_window_set_accept_focus")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_accept_focus
- (of-object "GtkWindow")
- (c-name "gtk_window_get_accept_focus")
- (return-type "gboolean")
-)
-
-(define-method set_destroy_with_parent
- (of-object "GtkWindow")
- (c-name "gtk_window_set_destroy_with_parent")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_destroy_with_parent
- (of-object "GtkWindow")
- (c-name "gtk_window_get_destroy_with_parent")
- (return-type "gboolean")
-)
-
-(define-method set_resizable
- (of-object "GtkWindow")
- (c-name "gtk_window_set_resizable")
- (return-type "none")
- (parameters
- '("gboolean" "resizable")
- )
-)
-
-(define-method get_resizable
- (of-object "GtkWindow")
- (c-name "gtk_window_get_resizable")
- (return-type "gboolean")
-)
-
-(define-method set_gravity
- (of-object "GtkWindow")
- (c-name "gtk_window_set_gravity")
- (return-type "none")
- (parameters
- '("GdkGravity" "gravity")
- )
-)
-
-(define-method get_gravity
- (of-object "GtkWindow")
- (c-name "gtk_window_get_gravity")
- (return-type "GdkGravity")
-)
-
-(define-method set_geometry_hints
- (of-object "GtkWindow")
- (c-name "gtk_window_set_geometry_hints")
- (return-type "none")
- (parameters
- '("GtkWidget*" "geometry_widget")
- '("GdkGeometry*" "geometry")
- '("GdkWindowHints" "geom_mask")
- )
-)
-
-(define-method set_screen
- (of-object "GtkWindow")
- (c-name "gtk_window_set_screen")
- (return-type "none")
- (parameters
- '("GdkScreen*" "screen")
- )
-)
-
-(define-method get_screen
- (of-object "GtkWindow")
- (c-name "gtk_window_get_screen")
- (return-type "GdkScreen*")
-)
-
-(define-method is_active
- (of-object "GtkWindow")
- (c-name "gtk_window_is_active")
- (return-type "gboolean")
-)
-
-(define-method has_toplevel_focus
- (of-object "GtkWindow")
- (c-name "gtk_window_has_toplevel_focus")
- (return-type "gboolean")
-)
-
-(define-method set_has_frame
- (of-object "GtkWindow")
- (c-name "gtk_window_set_has_frame")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_has_frame
- (of-object "GtkWindow")
- (c-name "gtk_window_get_has_frame")
- (return-type "gboolean")
-)
-
-(define-method set_frame_dimensions
- (of-object "GtkWindow")
- (c-name "gtk_window_set_frame_dimensions")
- (return-type "none")
- (parameters
- '("gint" "left")
- '("gint" "top")
- '("gint" "right")
- '("gint" "bottom")
- )
-)
-
-(define-method get_frame_dimensions
- (of-object "GtkWindow")
- (c-name "gtk_window_get_frame_dimensions")
- (return-type "none")
- (parameters
- '("gint*" "left")
- '("gint*" "top")
- '("gint*" "right")
- '("gint*" "bottom")
- )
-)
-
-(define-method set_decorated
- (of-object "GtkWindow")
- (c-name "gtk_window_set_decorated")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_decorated
- (of-object "GtkWindow")
- (c-name "gtk_window_get_decorated")
- (return-type "gboolean")
-)
-
-(define-method set_icon_list
- (of-object "GtkWindow")
- (c-name "gtk_window_set_icon_list")
- (return-type "none")
- (parameters
- '("GList*" "list")
- )
-)
-
-(define-method get_icon_list
- (of-object "GtkWindow")
- (c-name "gtk_window_get_icon_list")
- (return-type "GList*")
-)
-
-(define-method set_icon
- (of-object "GtkWindow")
- (c-name "gtk_window_set_icon")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "icon" (null-ok))
- )
-)
-
-(define-method set_icon_from_file
- (of-object "GtkWindow")
- (c-name "gtk_window_set_icon_from_file")
- (return-type "none")
- (parameters
- '("const-gchar*" "filename")
- '("GError**" "error")
- )
-)
-
-(define-method get_icon
- (of-object "GtkWindow")
- (c-name "gtk_window_get_icon")
- (return-type "GdkPixbuf*")
-)
-
-(define-function window_set_default_icon_list
- (c-name "gtk_window_set_default_icon_list")
- (return-type "none")
- (parameters
- '("GList*" "list")
- )
-)
-
-(define-function window_get_default_icon_list
- (c-name "gtk_window_get_default_icon_list")
- (return-type "GList*")
-)
-
-(define-function window_set_default_icon
- (c-name "gtk_window_set_default_icon")
- (return-type "none")
- (parameters
- '("GdkPixbuf*" "icon")
- )
-)
-
-(define-function window_set_default_icon_from_file
- (c-name "gtk_window_set_default_icon_from_file")
- (return-type "none")
- (parameters
- '("const-gchar*" "filename")
- '("GError**" "error")
- )
-)
-
-(define-function window_set_auto_startup_notification
- (c-name "gtk_window_set_auto_startup_notification")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method set_modal
- (of-object "GtkWindow")
- (c-name "gtk_window_set_modal")
- (return-type "none")
- (parameters
- '("gboolean" "modal")
- )
-)
-
-(define-method get_modal
- (of-object "GtkWindow")
- (c-name "gtk_window_get_modal")
- (return-type "gboolean")
-)
-
-(define-function window_list_toplevels
- (c-name "gtk_window_list_toplevels")
- (return-type "GList*")
-)
-
-(define-method add_mnemonic
- (of-object "GtkWindow")
- (c-name "gtk_window_add_mnemonic")
- (return-type "none")
- (parameters
- '("guint" "keyval")
- '("GtkWidget*" "target")
- )
-)
-
-(define-method remove_mnemonic
- (of-object "GtkWindow")
- (c-name "gtk_window_remove_mnemonic")
- (return-type "none")
- (parameters
- '("guint" "keyval")
- '("GtkWidget*" "target")
- )
-)
-
-(define-method mnemonic_activate
- (of-object "GtkWindow")
- (c-name "gtk_window_mnemonic_activate")
- (return-type "gboolean")
- (parameters
- '("guint" "keyval")
- '("GdkModifierType" "modifier")
- )
-)
-
-(define-method set_mnemonic_modifier
- (of-object "GtkWindow")
- (c-name "gtk_window_set_mnemonic_modifier")
- (return-type "none")
- (parameters
- '("GdkModifierType" "modifier")
- )
-)
-
-(define-method get_mnemonic_modifier
- (of-object "GtkWindow")
- (c-name "gtk_window_get_mnemonic_modifier")
- (return-type "GdkModifierType")
-)
-
-(define-method activate_key
- (of-object "GtkWindow")
- (c-name "gtk_window_activate_key")
- (return-type "gboolean")
- (parameters
- '("GdkEventKey*" "event")
- )
-)
-
-(define-method propagate_key_event
- (of-object "GtkWindow")
- (c-name "gtk_window_propagate_key_event")
- (return-type "gboolean")
- (parameters
- '("GdkEventKey*" "event")
- )
-)
-
-(define-method present
- (of-object "GtkWindow")
- (c-name "gtk_window_present")
- (return-type "none")
-)
-
-(define-method present_with_time
- (of-object "GtkWindow")
- (c-name "gtk_window_present_with_time")
- (return-type "none")
- (parameters
- '("guint32" "timestamp")
- )
-)
-
-(define-method iconify
- (of-object "GtkWindow")
- (c-name "gtk_window_iconify")
- (return-type "none")
-)
-
-(define-method deiconify
- (of-object "GtkWindow")
- (c-name "gtk_window_deiconify")
- (return-type "none")
-)
-
-(define-method stick
- (of-object "GtkWindow")
- (c-name "gtk_window_stick")
- (return-type "none")
-)
-
-(define-method unstick
- (of-object "GtkWindow")
- (c-name "gtk_window_unstick")
- (return-type "none")
-)
-
-(define-method maximize
- (of-object "GtkWindow")
- (c-name "gtk_window_maximize")
- (return-type "none")
-)
-
-(define-method unmaximize
- (of-object "GtkWindow")
- (c-name "gtk_window_unmaximize")
- (return-type "none")
-)
-
-(define-method fullscreen
- (of-object "GtkWindow")
- (c-name "gtk_window_fullscreen")
- (return-type "none")
-)
-
-(define-method unfullscreen
- (of-object "GtkWindow")
- (c-name "gtk_window_unfullscreen")
- (return-type "none")
-)
-
-(define-method set_keep_above
- (of-object "GtkWindow")
- (c-name "gtk_window_set_keep_above")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method set_keep_below
- (of-object "GtkWindow")
- (c-name "gtk_window_set_keep_below")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method begin_resize_drag
- (of-object "GtkWindow")
- (c-name "gtk_window_begin_resize_drag")
- (return-type "none")
- (parameters
- '("GdkWindowEdge" "edge")
- '("gint" "button")
- '("gint" "root_x")
- '("gint" "root_y")
- '("guint32" "timestamp")
- )
-)
-
-(define-method begin_move_drag
- (of-object "GtkWindow")
- (c-name "gtk_window_begin_move_drag")
- (return-type "none")
- (parameters
- '("gint" "button")
- '("gint" "root_x")
- '("gint" "root_y")
- '("guint32" "timestamp")
- )
-)
-
-(define-method set_policy
- (of-object "GtkWindow")
- (c-name "gtk_window_set_policy")
- (return-type "none")
- (parameters
- '("gint" "allow_shrink")
- '("gint" "allow_grow")
- '("gint" "auto_shrink")
- )
- (deprecated "use GtkWindow.set_resizable")
-)
-
-(define-method set_default_size
- (of-object "GtkWindow")
- (c-name "gtk_window_set_default_size")
- (return-type "none")
- (parameters
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method get_default_size
- (of-object "GtkWindow")
- (c-name "gtk_window_get_default_size")
- (return-type "none")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-method resize
- (of-object "GtkWindow")
- (c-name "gtk_window_resize")
- (return-type "none")
- (parameters
- '("gint" "width")
- '("gint" "height")
- )
-)
-
-(define-method get_size
- (of-object "GtkWindow")
- (c-name "gtk_window_get_size")
- (return-type "none")
- (parameters
- '("gint*" "width")
- '("gint*" "height")
- )
-)
-
-(define-method move
- (of-object "GtkWindow")
- (c-name "gtk_window_move")
- (return-type "none")
- (parameters
- '("gint" "x")
- '("gint" "y")
- )
-)
-
-(define-method get_position
- (of-object "GtkWindow")
- (c-name "gtk_window_get_position")
- (return-type "none")
- (parameters
- '("gint*" "root_x")
- '("gint*" "root_y")
- )
-)
-
-(define-method parse_geometry
- (of-object "GtkWindow")
- (c-name "gtk_window_parse_geometry")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "geometry")
- )
-)
-
-(define-method reshow_with_initial_size
- (of-object "GtkWindow")
- (c-name "gtk_window_reshow_with_initial_size")
- (return-type "none")
-)
-
-(define-function gtk_window_group_get_type
- (c-name "gtk_window_group_get_type")
- (return-type "GType")
-)
-
-(define-function window_group_new
- (c-name "gtk_window_group_new")
- (is-constructor-of "GtkWindowGroup")
- (return-type "GtkWindowGroup*")
-)
-
-(define-method add_window
- (of-object "GtkWindowGroup")
- (c-name "gtk_window_group_add_window")
- (return-type "none")
- (parameters
- '("GtkWindow*" "window")
- )
-)
-
-(define-method remove_window
- (of-object "GtkWindowGroup")
- (c-name "gtk_window_group_remove_window")
- (return-type "none")
- (parameters
- '("GtkWindow*" "window")
- )
-)
-
-(define-method remove_embedded_xid
- (of-object "GtkWindow")
- (c-name "gtk_window_remove_embedded_xid")
- (return-type "none")
- (parameters
- '("guint" "xid")
- )
-)
-
-(define-method add_embedded_xid
- (of-object "GtkWindow")
- (c-name "gtk_window_add_embedded_xid")
- (return-type "none")
- (parameters
- '("guint" "xid")
- )
-)
-
-(define-method set_focus_on_map
- (of-object "GtkWindow")
- (c-name "gtk_window_set_focus_on_map")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_focus_on_map
- (of-object "GtkWindow")
- (c-name "gtk_window_get_focus_on_map")
- (return-type "gboolean")
-)
-
-
-(define-method set_icon_name
- (of-object "GtkWindow")
- (c-name "gtk_window_set_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name" (null-ok))
- )
-)
-
-(define-method get_icon_name
- (of-object "GtkWindow")
- (c-name "gtk_window_get_icon_name")
- (return-type "const-gchar*")
-)
-
-
-(define-function window_set_default_icon_name
- (c-name "gtk_window_set_default_icon_name")
- (return-type "none")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-virtual set_focus
- (of-object "GtkWindow")
- (return-type "none")
- (parameters
- '("GtkWidget*" "focus")
- )
-)
-(define-virtual frame_event
- (of-object "GtkWindow")
- (return-type "gboolean")
- (parameters
- '("GdkEvent*" "event")
- )
-)
-(define-virtual activate_focus
- (of-object "GtkWindow")
- (return-type "none")
-)
-(define-virtual activate_default
- (of-object "GtkWindow")
- (return-type "none")
-)
-(define-virtual move_focus
- (of-object "GtkWindow")
- (return-type "none")
- (parameters
- '("GtkDirectionType" "direction")
- )
-)
-(define-virtual keys_changed
- (of-object "GtkWindow")
- (return-type "none")
-)
diff --git a/gtk/gtk-extrafuncs.defs b/gtk/gtk-extrafuncs.defs
deleted file mode 100644
index af690ef8..00000000
--- a/gtk/gtk-extrafuncs.defs
+++ /dev/null
@@ -1,110 +0,0 @@
-; -*- scheme -*-
-
-(define-method flags
- (of-object "GtkObject")
- (c-name "GTK_OBJECT_FLAGS")
- (return-type "GtkWidgetFlags")
-)
-
-(define-method set_flags
- (of-object "GtkObject")
- (c-name "GTK_OBJECT_SET_FLAGS")
- (return-type "none")
- (parameters
- '("GtkWidgetFlags" "flags")
- )
-)
-
-(define-method unset_flags
- (of-object "GtkObject")
- (c-name "GTK_OBJECT_UNSET_FLAGS")
- (return-type "none")
- (parameters
- '("GtkWidgetFlags" "flags")
- )
-)
-
-(define-method get_allocation
- (of-object "GtkWidget")
- (c-name "gtk_widget_get_allocation")
- (return-type "GtkAllocation")
-)
-
-(define-method get_selection
- (of-object "GtkList")
- (c-name "gtk_list_get_selection")
- (return-type "GList*")
-)
-
-(define-method set_all
- (of-object "GtkAdjustment")
- (c-name "gtk_adjustment_set_all")
- (return-type "none")
- (parameters
- '("gfloat" "value")
- '("gfloat" "lower")
- '("gfloat" "upper")
- '("gfloat" "step_increment")
- '("gfloat" "page_increment")
- '("gfloat" "page_size")
- )
-)
-
-;; PyGtkTreeModel
-
-(define-object GenericTreeModel
- (in-module "PyGtk")
- (parent "GObject")
- (c-name "PyGtkGenericTreeModel")
- (gtype-id "PYGTK_TYPE_GENERIC_TREE_MODEL")
- (implements "GtkTreeModel")
-)
-
-(define-function pygtk_generic_tree_model_get_type
- (c-name "pygtk_generic_tree_model_get_type")
- (return-type "GType")
-)
-
-(define-function pygtk_generic_tree_model_new
- (c-name "pygtk_generic_tree_model_new")
- (is-constructor-of PyGtkGenericTreeModel)
- (return-type "PyGtkGenericTreeModel*")
-)
-
-;; PyGtkGenericTreeModel methods
-
-(define-method invalidate_iters
- (of-object "PyGtkGenericTreeModel")
- (c-name "pygtk_generic_tree_model_invalidate_iters")
- (return-type "none")
-)
-
-(define-method iter_is_valid
- (of-object "PyGtkGenericTreeModel")
- (c-name "pygtk_generic_tree_model_iter_is_valid")
- (return-type "gboolean")
- (parameters
- '("GtkTreeIter*" "iter")
- )
-)
-
-;; PyGtkGenericCellRenderer
-
-(define-object GenericCellRenderer
- (in-module "PyGtk")
- (parent "GtkCellRenderer")
- (c-name "PyGtkGenericCellRenderer")
- (gtype-id "PYGTK_TYPE_GENERIC_CELL_RENDERER")
-)
-
-(define-function pygtk_generic_cell_renderer_get_type
- (c-name "pygtk_generic_cell_renderer_get_type")
- (return-type "GType")
-)
-
-(define-function pygtk_generic_cell_renderer_new
- (c-name "pygtk_generic_cell_renderer_new")
- (is-constructor-of PyGtkGenericCellRenderer)
- (return-type "GtkCellRenderer*")
-)
-
diff --git a/gtk/gtk-types.c b/gtk/gtk-types.c
deleted file mode 100644
index 5286a9df..00000000
--- a/gtk/gtk-types.c
+++ /dev/null
@@ -1,1372 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gtk-types.c: wrappers for some specialised GTK types.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-#define PY_SSIZE_T_CLEAN
-
-#include <gtk/gtk.h>
-#include "pygtk-private.h"
-#include <structmember.h>
-
-#if PY_VERSION_HEX < 0x02050000
-typedef int Py_ssize_t;
-#define PY_SSIZE_T_MAX INT_MAX
-#define PY_SSIZE_T_MIN INT_MIN
-typedef inquiry lenfunc;
-typedef intargfunc ssizeargfunc;
-typedef intobjargproc ssizeobjargproc;
-#endif
-
-#if 0
-PyObject *
-PyGdkWindow_New(GdkWindow *win)
-{
- PyGdkWindow_Object *self;
-
- self = (PyGdkWindow_Object *)PyObject_NEW(PyGdkWindow_Object,
- &PyGdkWindow_Type);
- if (self == NULL)
- return NULL;
- self->obj = win;
- gdk_window_ref(self->obj);
- return (PyObject *)self;
-}
-#endif
-
-PyObject *
-PyGdkAtom_New(GdkAtom atom)
-{
- PyGdkAtom_Object *self;
-
- self = (PyGdkAtom_Object *)PyObject_NEW(PyGdkAtom_Object, &PyGdkAtom_Type);
- if (self == NULL)
- return NULL;
- self->atom = atom;
- self->name = NULL;
- return (PyObject *)self;
-}
-
-
-/* style helper code */
-#define NUM_STATES 5
-staticforward PyTypeObject PyGtkStyleHelper_Type;
-
-PyObject *
-_pygtk_style_helper_new(GtkStyle *style, int type, gpointer array)
-{
- PyGtkStyleHelper_Object *self;
-
- self = (PyGtkStyleHelper_Object *)PyObject_NEW(PyGtkStyleHelper_Object,
- &PyGtkStyleHelper_Type);
- if (self == NULL)
- return NULL;
-
- self->style = g_object_ref(style);
- self->type = type;
- self->array = array;
- return (PyObject *)self;
-}
-
-static void
-pygtk_style_helper_dealloc(PyGtkStyleHelper_Object *self)
-{
- g_object_unref(self->style);
- PyObject_DEL(self);
-}
-
-static Py_ssize_t
-pygtk_style_helper_length(PyGtkStyleHelper_Object *self)
-{
- return NUM_STATES;
-}
-
-static PyObject *
-pygtk_style_helper_getitem(PyGtkStyleHelper_Object *self, Py_ssize_t pos)
-{
- if (pos < 0) pos += NUM_STATES;
- if (pos < 0 || pos >= NUM_STATES) {
- PyErr_SetString(PyExc_IndexError, "index out of range");
- return NULL;
- }
- switch (self->type) {
- case STYLE_COLOUR_ARRAY:
- {
- GdkColor *array = (GdkColor *)self->array;
- return pyg_boxed_new(GDK_TYPE_COLOR, &array[pos], TRUE, TRUE);
- }
- case STYLE_GC_ARRAY:
- {
- GdkGC **array = (GdkGC **)self->array;
- return pygobject_new((GObject *)array[pos]);
- }
- case STYLE_PIXMAP_ARRAY:
- {
- GdkPixmap **array = (GdkPixmap **)self->array;
- if ((long)array[pos] == GDK_PARENT_RELATIVE)
- return PyLong_FromLong(GDK_PARENT_RELATIVE);
- return pygobject_new((GObject *)array[pos]);
- }
- }
- g_assert_not_reached();
- return NULL;
-}
-
-static int
-pygtk_style_helper_setitem(PyGtkStyleHelper_Object *self, Py_ssize_t pos,
- PyObject *value)
-{
- extern PyTypeObject PyGdkGC_Type;
- extern PyTypeObject PyGdkPixmap_Type;
-
- if (pos < 0) pos += NUM_STATES;
- if (pos < 0 || pos >= NUM_STATES) {
- PyErr_SetString(PyExc_IndexError, "index out of range");
- return -1;
- }
- switch (self->type) {
- case STYLE_COLOUR_ARRAY:
- {
- GdkColor *array = (GdkColor *)self->array;
-
- if (!pyg_boxed_check(value, GDK_TYPE_COLOR)) {
- PyErr_SetString(PyExc_TypeError, "can only assign a GdkColor");
- return -1;
- }
- array[pos] = *pyg_boxed_get(value, GdkColor);
- return 0;
- }
- case STYLE_GC_ARRAY:
- {
- GdkGC **array = (GdkGC **)self->array;
-
- if (!pygobject_check(value, &PyGdkGC_Type)) {
- PyErr_SetString(PyExc_TypeError, "can only assign a GdkGC");
- return -1;
- }
- if (array[pos]) {
- g_object_unref(array[pos]);
- }
- array[pos] = GDK_GC(g_object_ref(pygobject_get(value)));
- return 0;
- }
- case STYLE_PIXMAP_ARRAY:
- {
- GdkPixmap **array = (GdkPixmap **)self->array;
- GdkPixmap *cvalue = NULL;
-
- if (pygobject_check(value, &PyGdkPixmap_Type))
- cvalue = GDK_PIXMAP(g_object_ref(pygobject_get(value)));
- else if (PyLong_Check(value)) {
- if (PyLong_AsLong(value) != GDK_PARENT_RELATIVE) {
- PyErr_SetString(PyExc_TypeError,
- "can only assign a GdkPixmap, None or "
- "GDK_PARENT_RELATIVE");
- return -1;
- }
- cvalue = (GdkPixmap*)GDK_PARENT_RELATIVE;
- } else if (value != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "can only assign a GdkPixmap, None or "
- "GDK_PARENT_RELATIVE");
- return -1;
- }
-
- if (array[pos] && (long)array[pos] != GDK_PARENT_RELATIVE) {
- g_object_unref(array[pos]);
- }
- array[pos] = cvalue;
- return 0;
- }
- }
- g_assert_not_reached();
- return -1;
-}
-
-static PySequenceMethods pygtk_style_helper_seqmethods = {
- (lenfunc)pygtk_style_helper_length,
- 0,
- 0,
- (ssizeargfunc)pygtk_style_helper_getitem,
- 0,
- (ssizeobjargproc)pygtk_style_helper_setitem,
- 0,
-};
-static PyTypeObject PyGtkStyleHelper_Type = {
- PyObject_HEAD_INIT(NULL)
- 0,
- "gtk.GtkStyleHelper",
- sizeof(PyGtkStyleHelper_Object),
- 0,
- (destructor)pygtk_style_helper_dealloc,
- (printfunc)0,
- (getattrfunc)0,
- (setattrfunc)0,
- (cmpfunc)0,
- (reprfunc)0,
- 0,
- &pygtk_style_helper_seqmethods,
- 0,
- (hashfunc)0,
- (ternaryfunc)0,
- (reprfunc)0,
- (getattrofunc)0,
- (setattrofunc)0,
- 0,
- Py_TPFLAGS_DEFAULT,
- NULL
-};
-
-#if 0
-static void
-PyGdkWindow_Dealloc(PyGdkWindow_Object *self)
-{
- if (gdk_window_get_type(self->obj) == GDK_WINDOW_PIXMAP)
- gdk_pixmap_unref(self->obj);
- else
- gdk_window_unref(self->obj);
- PyObject_DEL(self);
-}
-
-static int
-PyGdkWindow_Compare(PyGdkWindow_Object *self, PyGdkWindow_Object *v)
-{
- if (self->obj == v->obj) return 0;
- if (self->obj > v->obj) return -1;
- return 1;
-}
-
-static long
-PyGdkWindow_Hash(PyGdkWindow_Object *self)
-{
- return (long)self->obj;
-}
-
-static PyObject *
-PyGdkWindow_Repr(PyGdkWindow_Object *self)
-{
- char buf[100];
- if (gdk_window_get_type(self->obj) == GDK_WINDOW_PIXMAP)
- sprintf(buf, "<GdkPixmap at %lx>", (long)PyGdkWindow_Get(self));
- else
- sprintf(buf, "<GdkWindow at %lx>", (long)PyGdkWindow_Get(self));
- return PyString_FromString(buf);
-}
-
-static PyObject *
-PyGdkWindow_NewGC(PyGdkWindow_Object *self, PyObject *args, PyObject *kws)
-{
- int i = 0;
- PyObject *key, *value;
- char *strkey;
- GdkGCValues values;
- GdkGCValuesMask mask = 0;
- GdkGC *gc;
-
- if (kws != NULL)
- while (PyDict_Next(kws, &i, &key, &value)) {
- strkey = PyString_AsString(key);
- if (!strcmp(strkey, "foreground")) {
- if (!PyGdkColor_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "foreground argument takes a GdkColor");
- return NULL;
- }
- mask |= GDK_GC_FOREGROUND;
- values.foreground.red = PyGdkColor_Get(value)->red;
- values.foreground.green = PyGdkColor_Get(value)->green;
- values.foreground.blue = PyGdkColor_Get(value)->blue;
- values.foreground.pixel = PyGdkColor_Get(value)->pixel;
- } else if (!strcmp(strkey, "background")) {
- if (!PyGdkColor_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "background argument takes a GdkColor");
- return NULL;
- }
- mask |= GDK_GC_BACKGROUND;
- values.background.red = PyGdkColor_Get(value)->red;
- values.background.green = PyGdkColor_Get(value)->green;
- values.background.blue = PyGdkColor_Get(value)->blue;
- values.background.pixel = PyGdkColor_Get(value)->pixel;
- } else if (!strcmp(strkey, "font")) {
- if (!PyGdkFont_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "font argument takes a GdkFont");
- return NULL;
- }
- mask |= GDK_GC_FONT;
- values.font = PyGdkFont_Get(value);
- } else if (!strcmp(strkey, "tile")) {
- if (!PyGdkWindow_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "tile argument takes a GdkPixmap");
- return NULL;
- }
- mask |= GDK_GC_TILE;
- values.tile = PyGdkWindow_Get(value);
- } else if (!strcmp(strkey, "stipple")) {
- if (!PyGdkWindow_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "stipple argument takes a GdkPixmap");
- return NULL;
- }
- mask |= GDK_GC_STIPPLE;
- values.stipple = PyGdkWindow_Get(value);
- } else if (!strcmp(strkey, "clip_mask")) {
- if (!PyGdkWindow_Check(value)) {
- PyErr_SetString(PyExc_TypeError,
- "clip_mask argument takes a GdkPixmap");
- return NULL;
- }
- mask |= GDK_GC_CLIP_MASK;
- values.clip_mask = PyGdkWindow_Get(value);
- } else {
- int i = 0;
-#ifndef offsetof
-#define offsetof(type, member) ( (int) &((type*)0)->member)
-#endif
-#define OFF(x) offsetof(GdkGCValues, x)
- static struct {char *name;GdkGCValuesMask mask;int offs; } others[] = {
- {"function", GDK_GC_FUNCTION, OFF(function)},
- {"fill", GDK_GC_FILL, OFF(fill)},
- {"subwindow_mode", GDK_GC_SUBWINDOW, OFF(subwindow_mode)},
- {"ts_x_origin", GDK_GC_TS_X_ORIGIN, OFF(ts_x_origin)},
- {"ts_y_origin", GDK_GC_TS_Y_ORIGIN, OFF(ts_y_origin)},
- {"clip_x_origin", GDK_GC_CLIP_X_ORIGIN, OFF(clip_x_origin)},
- {"clip_y_origin", GDK_GC_CLIP_Y_ORIGIN, OFF(clip_y_origin)},
- {"graphics_exposures", GDK_GC_EXPOSURES, OFF(graphics_exposures)},
- {"line_width", GDK_GC_LINE_WIDTH, OFF(line_width)},
- {"line_style", GDK_GC_LINE_STYLE, OFF(line_style)},
- {"cap_style", GDK_GC_CAP_STYLE, OFF(cap_style)},
- {"join_style", GDK_GC_JOIN_STYLE, OFF(join_style)},
- {NULL, 0, 0}
- };
-#undef OFF
- while (others[i].name != NULL) {
- if (!strcmp(strkey, others[i].name)) {
- if (!PyInt_Check(value)) {
- char buf[80];
- g_snprintf(buf, sizeof(buf),
- "%s argument expects an integer",
- others[i].name);
- PyErr_SetString(PyExc_TypeError, buf);
- return NULL;
- }
- mask |= others[i].mask;
- *((int *)((char *)&values + others[i].offs)) =
- PyInt_AsLong(value);
- break;
- }
- i++;
- }
- if (others[i].name == NULL) {
- PyErr_SetString(PyExc_TypeError, "unknown argument");
- return NULL;
- }
- }
- }
- if (!PyArg_ParseTuple(args, ":GdkWindow.new_gc"))
- return NULL;
- gc = gdk_gc_new_with_values(PyGdkWindow_Get(self), &values, mask);
- value = PyGdkGC_New(gc);
- gdk_gc_unref(gc);
- return value;
-}
-
-static PyObject *
-PyGdkWindow_SetCursor(PyGdkWindow_Object *self, PyObject *args)
-{
- PyObject *cursor;
-
- if (!PyArg_ParseTuple(args, "O!:GdkWindow.set_cursor", &PyGdkCursor_Type,
- &cursor))
- return NULL;
- gdk_window_set_cursor(self->obj, PyGdkCursor_Get(cursor));
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-PyGdkWindow_PropertyGet(PyGdkWindow_Object *self, PyObject *args)
-{
- PyObject *py_property, py_type = NULL;
- gint pdelete = FALSE;
-
- GdkAtom atype, property, type;
- gint aformat, alength;
- guchar *data;
-
- if (!PyArg_ParseTuple(args, "O|Oi:GdkWindow.property_get", &py_property,
- &py_type, &pdelete)) {
- return NULL;
- }
-
- property = pygdk_atom_from_pyobject(py_property);
- if (Pyerr_Occurred())
- return NULL;
-
- type = pygdk_atom_from_pyobject(py_type);
- if (Pyerr_Occurred())
- return NULL;
-
- if (gdk_property_get(self->obj, property, type, 0, G_MAXLONG,
- pdelete, &atype, &aformat, &alength, &data)) {
- /* success */
- PyObject *pdata = NULL;
- gint i;
- guint16 *data16;
- guint32 *data32;
- switch (aformat) {
- case 8:
- if ((pdata = PyString_FromStringAndSize(data, alength)) == NULL)
- return NULL;
- break;
- case 16:
- data16 = (guint16 *)data;
- if ((pdata = PyTuple_New(alength)) == NULL)
- return NULL;
- for (i = 0; i < alength; i++)
- PyTuple_SetItem(pdata, i, PyInt_FromLong(data16[i]));
- break;
- case 32:
- data32 = (guint32 *)data;
- if ((pdata = PyTuple_New(alength)) == NULL)
- return NULL;
- for (i = 0; i < alength; i++)
- PyTuple_SetItem(pdata, i, PyInt_FromLong(data32[i]));
- break;
- default:
- g_warning("got a property format != 8, 16 or 32");
- g_assert_not_reached();
- }
- g_free(data);
- return Py_BuildValue("(NiN)", PyGdkAtom_New(atype), aformat, pdata);
- } else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-
-static PyObject *
-PyGdkWindow_PropertyChange(PyGdkWindow_Object *self, PyObject *args)
-{
- PyObject *py_property, *py_type;
- GdkAtom property, type;
- gint format;
- PyObject *py_mode, *pdata;
- GdkPropMode mode;
- guchar *data = NULL;
- gint nelements;
-
- if (!PyArg_ParseTuple(args, "OOiOO:GdkWindow.property_change",
- &py_property, &py_type, &format, &py_mode, &pdata)) {
- return NULL;
- }
-
- property = pygdk_atom_from_pyobject(py_property);
- if (Pyerr_Occurred())
- return NULL;
-
- type = pygdk_atom_from_pyobject(py_type);
- if (Pyerr_Occurred())
- return NULL;
-
- if (pygtk_enum_get_value(GDK_TYPE_PROP_MODE, py_mode, (gint *)&mode))
- return NULL;
- switch (format) {
- case 8:
- if (!PyString_Check(pdata)) {
- PyErr_SetString(PyExc_TypeError, "data not a string and format=8");
- return NULL;
- }
- data = PyString_AsString(pdata);
- nelements = PyString_Size(pdata);
- break;
- case 16:
- {
- guint16 *data16;
- gint i;
-
- if (!PySequence_Check(pdata)) {
- PyErr_SetString(PyExc_TypeError,
- "data not a sequence and format=16");
- return NULL;
- }
- nelements = PySequence_Length(pdata);
- data16 = g_new(guint16, nelements);
- data = (guchar *)data16;
- for (i = 0; i < nelements; i++) {
- PyObject *item = PySequence_GetItem(pdata, i);
- Py_DECREF(item);
- item = PyNumber_Int(item);
- if (!item) {
- g_free(data16);
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,"data element not an int");
- return NULL;
- }
- data16[i] = PyInt_AsLong(item);
- Py_DECREF(item);
- }
- }
- break;
- case 32:
- {
- guint32 *data32;
- gint i;
-
- if (!PySequence_Check(pdata)) {
- PyErr_SetString(PyExc_TypeError,
- "data not a sequence and format=32");
- return NULL;
- }
- nelements = PySequence_Length(pdata);
- data32 = g_new(guint32, nelements);
- data = (guchar *)data32;
- for (i = 0; i < nelements; i++) {
- PyObject *item = PySequence_GetItem(pdata, i);
- Py_DECREF(item);
- item = PyNumber_Int(item);
- if (!item) {
- g_free(data32);
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,"data element not an int");
- return NULL;
- }
- data32[i] = PyInt_AsLong(item);
- Py_DECREF(item);
- }
- }
- break;
- default:
- PyErr_SetString(PyExc_TypeError, "format must be 8, 16 or 32");
- return NULL;
- break;
- }
- gdk_property_change(self->obj, property, type, format, mode, data,
- nelements);
- if (format != 8)
- g_free(data);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-PyGdkWindow_PropertyDelete(PyGdkWindow_Object *self, PyObject *args)
-{
- PyObject py_property;
- GdkAtom property;
-
- if (!PyArg_ParseTuple(args, "O:GdkWindow.property_delete", &property)) {
- return NULL;
- }
-
- property = pygdk_atom_from_pyobject(py_property);
- if (Pyerr_Occurred())
- return NULL;
-
- gdk_property_delete(self->obj, property);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-PyGdkWindow_Raise(PyGdkWindow_Object *self, PyObject *args)
-{
- if (!PyArg_ParseTuple(args, ":GdkWindow._raise"))
- return NULL;
- gdk_window_raise(self->obj);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-PyGdkWindow_Lower(PyGdkWindow_Object *self, PyObject *args)
-{
- if (!PyArg_ParseTuple(args, ":GdkWindow.lower"))
- return NULL;
- gdk_window_lower(self->obj);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-PyGdkWindow_InputGetPointer(PyGdkWindow_Object *self, PyObject *args)
-{
- guint32 deviceid;
- gdouble x = 0.0, y = 0.0, pressure = 0.0, xtilt = 0.0, ytilt = 0.0;
- GdkModifierType mask = 0;
-
- if (!PyArg_ParseTuple(args, "i:GdkWindow.input_get_pointer", &deviceid))
- return NULL;
- gdk_input_window_get_pointer(self->obj, deviceid, &x, &y, &pressure,
- &xtilt, &ytilt, &mask);
- return Py_BuildValue("(dddddi)", x, y, pressure, xtilt, ytilt, mask);
-}
-
-static PyMethodDef PyGdkWindow_methods[] = {
- {"new_gc", (PyCFunction)PyGdkWindow_NewGC, METH_VARARGS|METH_KEYWORDS, NULL},
- {"set_cursor", (PyCFunction)PyGdkWindow_SetCursor, METH_VARARGS, NULL},
- {"property_get", (PyCFunction)PyGdkWindow_PropertyGet, METH_VARARGS, NULL},
- {"property_change", (PyCFunction)PyGdkWindow_PropertyChange, METH_VARARGS, NULL},
- {"property_delete", (PyCFunction)PyGdkWindow_PropertyDelete, METH_VARARGS, NULL},
- {"_raise", (PyCFunction)PyGdkWindow_Raise, METH_VARARGS, NULL},
- {"lower", (PyCFunction)PyGdkWindow_Lower, METH_VARARGS, NULL},
- {"input_get_pointer", (PyCFunction)PyGdkWindow_InputGetPointer, METH_VARARGS, NULL},
- {NULL, 0, 0, NULL}
-};
-
-static PyObject *
-PyGdkWindow_GetAttr(PyGdkWindow_Object *self, char *key)
-{
- GdkWindow *win = PyGdkWindow_Get(self);
- gint x, y;
- GdkModifierType p_mask;
-
- if (!strcmp(key, "__members__"))
- return Py_BuildValue("[sssssssssssss]", "children", "colormap", "depth",
- "height", "parent", "pointer", "pointer_state",
- "toplevel", "type", "width", "x", "xid", "y");
- if (!strcmp(key, "width")) {
- gdk_window_get_size(win, &x, NULL);
- return PyInt_FromLong(x);
- }
- if (!strcmp(key, "height")) {
- gdk_window_get_size(win, NULL, &y);
- return PyInt_FromLong(y);
- }
- if (!strcmp(key, "x")) {
- gdk_window_get_position(win, &x, NULL);
- return PyInt_FromLong(x);
- }
- if (!strcmp(key, "y")) {
- gdk_window_get_position(win, NULL, &y);
- return PyInt_FromLong(y);
- }
- if (!strcmp(key, "colormap"))
- return PyGdkColormap_New(gdk_window_get_colormap(win));
- if (!strcmp(key, "pointer")) {
- gdk_window_get_pointer(win, &x, &y, NULL);
- return Py_BuildValue("(ii)", x, y);
- }
- if (!strcmp(key, "pointer_state")) {
- gdk_window_get_pointer(win, NULL, NULL, &p_mask);
- return PyInt_FromLong(p_mask);
- }
- if (!strcmp(key, "parent")) {
- GdkWindow *par = gdk_window_get_parent(win);
- if (par)
- return PyGdkWindow_New(par);
- Py_INCREF(Py_None);
- return Py_None;
- }
- if (!strcmp(key, "toplevel"))
- return PyGdkWindow_New(gdk_window_get_toplevel(win));
- if (!strcmp(key, "children")) {
- GList *children, *tmp;
- PyObject *ret;
- children = gdk_window_get_children(win);
- if ((ret = PyList_New(0)) == NULL)
- return NULL;
- for (tmp = children; tmp != NULL; tmp = tmp->next) {
- PyObject *win = PyGdkWindow_New(tmp->data);
- if (win == NULL) {
- Py_DECREF(ret);
- return NULL;
- }
- PyList_Append(ret, win);
- Py_DECREF(win);
- }
- g_list_free(children);
- return ret;
- }
- if (!strcmp(key, "type"))
- return PyInt_FromLong(gdk_window_get_type(win));
- if (!strcmp(key, "depth")) {
- gdk_window_get_geometry(win, NULL, NULL, NULL, NULL, &x);
- return PyInt_FromLong(x);
- }
-#ifdef WITH_XSTUFF
- if (!strcmp(key, "xid"))
- return PyInt_FromLong(GDK_WINDOW_XWINDOW(win));
-#endif
-
- return Py_FindMethod(PyGdkWindow_methods, (PyObject *)self, key);
-}
-
-PyTypeObject PyGdkWindow_Type = {
- PyObject_HEAD_INIT(NULL)
- 0,
- "GdkWindow",
- sizeof(PyGdkWindow_Object),
- 0,
- (destructor)PyGdkWindow_Dealloc,
- (printfunc)0,
- (getattrfunc)PyGdkWindow_GetAttr,
- (setattrfunc)0,
- (cmpfunc)PyGdkWindow_Compare,
- (reprfunc)PyGdkWindow_Repr,
- 0,
- 0,
- 0,
- (hashfunc)PyGdkWindow_Hash,
- (ternaryfunc)0,
- (reprfunc)0,
- (getattrofunc)0,
- (setattrofunc)0,
- 0,
- Py_TPFLAGS_DEFAULT,
- NULL
-};
-#endif
-
-GdkAtom
-pygdk_atom_from_pyobject(PyObject *object)
-{
- if (object == NULL)
- return NULL;
- if (PyString_Check(object))
- return gdk_atom_intern(PyString_AsString(object), FALSE);
- if (PyGdkAtom_Check(object))
- return PyGdkAtom_Get(object);
- PyErr_SetString(PyExc_TypeError, "unable to convert argument to GdkAtom");
- return NULL;
-}
-
-static void
-pygdk_atom_dealloc(PyGdkAtom_Object *self)
-{
- if (self->name) g_free(self->name);
- PyObject_DEL(self);
-}
-
-static long
-pygdk_atom_hash(PyGdkAtom_Object *self)
-{
- return (long)self->atom;
-}
-
-static PyObject *
-pygdk_atom_repr(PyGdkAtom_Object *self)
-{
- char buf[256];
- if (!self->name) self->name = gdk_atom_name(self->atom);
- g_snprintf(buf, 256, "<GdkAtom 0x%lx = '%s'>", (unsigned long)self->atom,
- self->name?self->name:"(null)");
- return PyString_FromString(buf);
-}
-
-static PyObject *
-pygdk_atom_str(PyGdkAtom_Object *self)
-{
- if (!self->name) self->name = gdk_atom_name(self->atom);
- if (self->name)
- return PyString_FromString(self->name);
- return pygdk_atom_repr(self);
-}
-
-static PyObject *
-pygdk_atom_richcompare(PyGdkAtom_Object *self, PyGdkAtom_Object *v, int op)
-{
- PyObject *result = Py_NotImplemented;
-
- if (PyString_Check(v)) {
- PyObject *str = pygdk_atom_str(self);
- result = PyObject_RichCompare(str, (PyObject *)v, op);
- Py_DECREF(str);
- return result;
- }
- if (PyGdkAtom_Check(v)) {
- switch (op) {
- case Py_LT:
- result = (self->atom < v->atom) ? Py_True : Py_False;
- break;
- case Py_LE:
- result = (self->atom <= v->atom) ? Py_True : Py_False;
- break;
- case Py_EQ:
- result = (self->atom == v->atom) ? Py_True : Py_False;
- break;
- case Py_NE:
- result = (self->atom != v->atom) ? Py_True : Py_False;
- break;
- case Py_GE:
- result = (self->atom >= v->atom) ? Py_True : Py_False;
- break;
- case Py_GT:
- result = (self->atom > v->atom) ? Py_True : Py_False;
- break;
- default:
- break;
- }
- }
- Py_INCREF(result);
- return result;
-}
-
-PyTypeObject PyGdkAtom_Type = {
- PyObject_HEAD_INIT(NULL)
- 0,
- "gtk.gdk.GdkAtom",
- sizeof(PyGdkAtom_Object),
- 0,
- (destructor)pygdk_atom_dealloc,
- (printfunc)0,
- (getattrfunc)0,
- (setattrfunc)0,
- (cmpfunc)0,
- (reprfunc)pygdk_atom_repr,
- 0,
- 0,
- 0,
- (hashfunc)pygdk_atom_hash,
- (ternaryfunc)0,
- (reprfunc)pygdk_atom_str,
- (getattrofunc)0,
- (setattrofunc)0,
- 0,
- Py_TPFLAGS_DEFAULT,
- NULL,
- 0,
- 0,
- (richcmpfunc)pygdk_atom_richcompare,
-};
-
-typedef struct {
- PyObject_HEAD
- GtkTreeModel *model;
- GtkTreeIter iter;
-} PyGtkTreeModelRow;
-staticforward PyTypeObject PyGtkTreeModelRow_Type;
-
-PyObject *
-_pygtk_tree_model_row_new(GtkTreeModel *model, GtkTreeIter *iter)
-{
- PyGtkTreeModelRow *self;
-
- self = (PyGtkTreeModelRow *) PyObject_NEW(PyGtkTreeModelRow,
- &PyGtkTreeModelRow_Type);
- if (self == NULL)
- return NULL;
- self->model = g_object_ref(model);
- self->iter = *iter;
- return (PyObject *)self;
-}
-
-static void
-pygtk_tree_model_row_dealloc(PyGtkTreeModelRow *self)
-{
- g_object_unref(self->model);
- PyObject_DEL(self);
-}
-
-static Py_ssize_t
-pygtk_tree_model_row_length(PyGtkTreeModelRow *self)
-{
- return gtk_tree_model_get_n_columns(self->model);
-}
-
-static PyObject *
-pygtk_tree_model_row_getitem(PyGtkTreeModelRow *self, Py_ssize_t column)
-{
- gint n_columns;
- GValue value = { 0, };
- PyObject *ret;
-
- n_columns = gtk_tree_model_get_n_columns(self->model);
- if (column < 0 || column >= n_columns) {
- PyErr_SetString(PyExc_IndexError, "column index out of range");
- return NULL;
- }
- gtk_tree_model_get_value(self->model, &self->iter, column, &value);
- ret = pyg_value_as_pyobject(&value, TRUE);
- g_value_unset(&value);
- return ret;
-}
-
-static int
-pygtk_tree_model_row_setitem(PyGtkTreeModelRow *self, Py_ssize_t column,
- PyObject *pyvalue)
-{
- gint n_columns;
- GValue value = { 0, };
-
- if (!GTK_IS_LIST_STORE(self->model) && !GTK_IS_TREE_STORE(self->model)) {
- PyErr_SetString(PyExc_TypeError,
- "can not set cells in this tree model");
- return -1;
- }
-
- n_columns = gtk_tree_model_get_n_columns(self->model);
- if (column < 0 || column >= n_columns) {
- PyErr_SetString(PyExc_IndexError, "column index out of range");
- return -1;
- }
- g_value_init(&value, gtk_tree_model_get_column_type(self->model, column));
- if (pyg_value_from_pyobject(&value, pyvalue)) {
- PyErr_SetString(PyExc_TypeError,
- "value is of wrong type for this column");
- return -1;
- }
- if (GTK_IS_LIST_STORE(self->model))
- gtk_list_store_set_value(GTK_LIST_STORE(self->model), &self->iter,
- column, &value);
- else if (GTK_IS_TREE_STORE(self->model))
- gtk_tree_store_set_value(GTK_TREE_STORE(self->model), &self->iter,
- column, &value);
- g_value_unset(&value);
- return 0;
-}
-
-static PySequenceMethods pygtk_tree_model_row_seqmethods = {
- (lenfunc)pygtk_tree_model_row_length,
- 0,
- 0,
- (ssizeargfunc)pygtk_tree_model_row_getitem,
- 0,
- (ssizeobjargproc)pygtk_tree_model_row_setitem,
- 0
-};
-
-static PyObject *
-pygtk_tree_model_row_iterchildren(PyGtkTreeModelRow *self)
-{
- return _pygtk_tree_model_row_iter_new(self->model, &self->iter);
-}
-
-static PyMethodDef pygtk_tree_model_row_methods[] = {
- { "iterchildren", (PyCFunction)pygtk_tree_model_row_iterchildren, METH_NOARGS },
- { NULL, NULL, 0 }
-};
-
-static PyObject *
-pygtk_tree_model_row_get_next(PyGtkTreeModelRow *self, void *closure)
-{
- GtkTreeIter iter;
-
- iter = self->iter;
- if (gtk_tree_model_iter_next(self->model, &iter))
- return _pygtk_tree_model_row_new(self->model, &iter);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-pygtk_tree_model_row_get_parent(PyGtkTreeModelRow *self, void *closure)
-{
- GtkTreeIter parent;
-
- if (gtk_tree_model_iter_parent(self->model, &parent, &self->iter))
- return _pygtk_tree_model_row_new(self->model, &parent);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-pygtk_tree_model_row_get_model(PyGtkTreeModelRow *self, void *closure)
-{
- return pygobject_new((GObject *)self->model);
-}
-
-static PyObject *
-pygtk_tree_model_row_get_path(PyGtkTreeModelRow *self, void *closure)
-{
- GtkTreePath *path;
- PyObject *ret;
-
- path = gtk_tree_model_get_path(self->model, &self->iter);
- if (!path) {
- PyErr_SetString(PyExc_RuntimeError, "could not get tree path");
- return NULL;
- }
- ret = pygtk_tree_path_to_pyobject(path);
- gtk_tree_path_free(path);
- return ret;
-}
-
-static PyObject *
-pygtk_tree_model_row_get_iter(PyGtkTreeModelRow *self, void *closure)
-{
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &self->iter, TRUE, TRUE);
-}
-
-static PyGetSetDef pygtk_tree_model_row_getsets[] = {
- { "next", (getter)pygtk_tree_model_row_get_next, (setter)0 },
- { "parent", (getter)pygtk_tree_model_row_get_parent, (setter)0 },
- { "model", (getter)pygtk_tree_model_row_get_model, (setter)0 },
- { "path", (getter)pygtk_tree_model_row_get_path, (setter)0 },
- { "iter", (getter)pygtk_tree_model_row_get_iter, (setter)0 },
- { NULL, (getter)0, (setter)0 }
-};
-
-static PyTypeObject PyGtkTreeModelRow_Type = {
- PyObject_HEAD_INIT(NULL)
- 0,
- "gtk.TreeModelRow",
- sizeof(PyGtkTreeModelRow),
- 0,
- (destructor)pygtk_tree_model_row_dealloc,
- (printfunc)0,
- (getattrfunc)0,
- (setattrfunc)0,
- (cmpfunc)0,
- (reprfunc)0,
- 0,
- &pygtk_tree_model_row_seqmethods,
- 0,
- (hashfunc)0,
- (ternaryfunc)0,
- (reprfunc)0,
- (getattrofunc)0,
- (setattrofunc)0,
- 0,
- Py_TPFLAGS_DEFAULT,
- NULL,
- (traverseproc)0,
- (inquiry)0,
- (richcmpfunc)0,
- 0,
- (getiterfunc)0,
- (iternextfunc)0,
- pygtk_tree_model_row_methods,
- 0,
- pygtk_tree_model_row_getsets
-};
-
-typedef struct {
- PyObject_HEAD
- GtkTreeModel *model;
- gboolean has_more;
- GtkTreeIter iter;
-} PyGtkTreeModelRowIter;
-staticforward PyTypeObject PyGtkTreeModelRowIter_Type;
-
-PyObject *
-_pygtk_tree_model_row_iter_new(GtkTreeModel *model, GtkTreeIter *parent_iter)
-{
- PyGtkTreeModelRowIter *self;
-
- self = (PyGtkTreeModelRowIter *) PyObject_NEW(PyGtkTreeModelRowIter,
- &PyGtkTreeModelRowIter_Type);
- if (self == NULL)
- return NULL;
- self->model = g_object_ref(model);
- /* iterate through child nodes */
- self->has_more = gtk_tree_model_iter_children(self->model, &self->iter,
- parent_iter);
- return (PyObject *)self;
-}
-
-static void
-pygtk_tree_model_row_iter_dealloc(PyGtkTreeModelRowIter *self)
-{
- g_object_unref(self->model);
- PyObject_DEL(self);
-}
-
-static PyObject *
-pygtk_tree_model_row_iter_getiter(PyGtkTreeModelRowIter *self)
-{
- Py_INCREF(self);
- return (PyObject *)self;
-}
-
-static PyObject *
-pygtk_tree_model_row_iter_next(PyGtkTreeModelRowIter *self)
-{
- PyObject *row;
-
- if (!self->has_more) {
- PyErr_SetNone(PyExc_StopIteration);
- return NULL;
- }
-
- row = _pygtk_tree_model_row_new(self->model, &self->iter);
-
- /* move to next iter */
- self->has_more = gtk_tree_model_iter_next(self->model, &self->iter);
-
- return row;
-}
-
-static PyTypeObject PyGtkTreeModelRowIter_Type = {
- PyObject_HEAD_INIT(NULL)
- 0,
- "gtk.TreeModelRowIter",
- sizeof(PyGtkTreeModelRowIter),
- 0,
- (destructor)pygtk_tree_model_row_iter_dealloc,
- (printfunc)0,
- (getattrfunc)0,
- (setattrfunc)0,
- (cmpfunc)0,
- (reprfunc)0,
- 0,
- 0,
- 0,
- (hashfunc)0,
- (ternaryfunc)0,
- (reprfunc)0,
- (getattrofunc)0,
- (setattrofunc)0,
- 0,
- Py_TPFLAGS_DEFAULT|Py_TPFLAGS_HAVE_ITER,
- NULL,
- (traverseproc)0,
- (inquiry)0,
- (richcmpfunc)0,
- 0,
- (getiterfunc)pygtk_tree_model_row_iter_getiter,
- (iternextfunc)pygtk_tree_model_row_iter_next
-};
-
-int
-_pygtk_tree_model_remove_row(GtkTreeModel *model, GtkTreeIter *iter)
-{
- GtkTreeModel *child;
- GtkTreeIter citer;
-
- if (GTK_IS_LIST_STORE(model)) {
- gtk_list_store_remove(GTK_LIST_STORE(model), iter);
- return 0;
- }
-
- if (GTK_IS_TREE_STORE(model)) {
- gtk_tree_store_remove(GTK_TREE_STORE(model), iter);
- return 0;
- }
-
- if (GTK_IS_TREE_MODEL_SORT(model)) {
- child = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(model));
- gtk_tree_model_sort_convert_iter_to_child_iter(
- GTK_TREE_MODEL_SORT(model), &citer, iter);
- return _pygtk_tree_model_remove_row(child, &citer);
- }
-
- if (GTK_IS_TREE_MODEL_FILTER(model)) {
- child = gtk_tree_model_filter_get_model(GTK_TREE_MODEL_FILTER(model));
- gtk_tree_model_filter_convert_iter_to_child_iter(
- GTK_TREE_MODEL_FILTER(model), &citer, iter);
- return _pygtk_tree_model_remove_row(child, &citer);
- }
-
- PyErr_SetString(PyExc_TypeError,
- "cannot remove rows in this tree model");
- return -1;
-}
-
-int
-_pygtk_tree_model_set_row(GtkTreeModel *model, GtkTreeIter *iter,
- PyObject *items)
-{
- gint n_columns, i;
- GtkTreeModel *child;
- GtkTreeIter citer;
-
- if (!GTK_IS_LIST_STORE(model) && !GTK_IS_TREE_STORE(model) &&
- !GTK_IS_TREE_MODEL_SORT(model) && !GTK_IS_TREE_MODEL_FILTER(model)) {
- PyErr_SetString(PyExc_TypeError,
- "cannot set cells in this tree model");
- return -1;
- }
-
- if (GTK_IS_TREE_MODEL_SORT(model)) {
- child = gtk_tree_model_sort_get_model(GTK_TREE_MODEL_SORT(model));
- gtk_tree_model_sort_convert_iter_to_child_iter(
- GTK_TREE_MODEL_SORT(model), &citer, iter);
- return _pygtk_tree_model_set_row(child, &citer, items);
- }
-
- if (GTK_IS_TREE_MODEL_FILTER(model)) {
- child = gtk_tree_model_filter_get_model(GTK_TREE_MODEL_FILTER(model));
- gtk_tree_model_filter_convert_iter_to_child_iter(
- GTK_TREE_MODEL_FILTER(model), &citer, iter);
- return _pygtk_tree_model_set_row(child, &citer, items);
- }
-
- if (!PySequence_Check(items)) {
- PyErr_SetString(PyExc_TypeError, "expecting a sequence");
- return -1;
- }
- n_columns = gtk_tree_model_get_n_columns(model);
- if (PySequence_Length(items) != n_columns) {
- PyErr_SetString(PyExc_ValueError, "row sequence has wrong length");
- return -1;
- }
- for (i = 0; i < n_columns; i++) {
- GValue value = { 0, };
- PyObject *item;
-
- item = PySequence_GetItem(items, i);
- if (!item)
- return -1;
- g_value_init(&value, gtk_tree_model_get_column_type(model, i));
- if (pyg_value_from_pyobject(&value, item)) {
- Py_DECREF(item);
- PyErr_SetString(PyExc_TypeError,
- "value is of wrong type for this column");
- return -1;
- }
-
- if (GTK_IS_LIST_STORE(model))
- gtk_list_store_set_value(GTK_LIST_STORE(model), iter, i, &value);
- else if (GTK_IS_TREE_STORE(model))
- gtk_tree_store_set_value(GTK_TREE_STORE(model), iter, i, &value);
-
- g_value_unset(&value);
- Py_DECREF(item);
- }
- return 0;
-}
-
-PyObject *
-pygtk_tree_path_to_pyobject(GtkTreePath *path)
-{
- gint len, i, *indices;
- PyObject *ret;
-
- len = gtk_tree_path_get_depth(path);
- indices = gtk_tree_path_get_indices(path);
- ret = PyTuple_New(len);
- for (i = 0; i < len; i++)
- PyTuple_SetItem(ret, i, PyInt_FromLong(indices[i]));
- return ret;
-}
-
-GtkTreePath *
-pygtk_tree_path_from_pyobject(PyObject *object)
-{
- if (PyString_Check(object)) {
- GtkTreePath *path;
-
- path = gtk_tree_path_new_from_string(PyString_AsString(object));
- return path;
- } else if (PyInt_Check(object)) {
- GtkTreePath *path;
-
- path = gtk_tree_path_new();
- gtk_tree_path_append_index(path, PyInt_AsLong(object));
- return path;
- } else if (PyTuple_Check(object)) {
- GtkTreePath *path;
- guint len, i;
-
- len = PyTuple_Size(object);
- if (len < 1)
- return NULL;
- path = gtk_tree_path_new();
- for (i = 0; i < len; i++) {
- PyObject *item = PyTuple_GetItem(object, i);
- gint index = PyInt_AsLong(item);
- if (PyErr_Occurred()) {
- gtk_tree_path_free(path);
- PyErr_Clear();
- return NULL;
- }
- gtk_tree_path_append_index(path, index);
- }
- return path;
- }
- return NULL;
-}
-
-/* marshalers for the boxed types. Uses uppercase notation so that
- * the macro below can automatically install them. */
-static PyObject *
-PyGtkTreePath_from_value(const GValue *value)
-{
- GtkTreePath *path = (GtkTreePath *)g_value_get_boxed(value);
-
- return pygtk_tree_path_to_pyobject(path);
-}
-static int
-PyGtkTreePath_to_value(GValue *value, PyObject *object)
-{
- GtkTreePath *path = pygtk_tree_path_from_pyobject(object);
-
- if (path) {
- g_value_set_boxed(value, path);
- gtk_tree_path_free(path);
- return 0;
- }
- return -1;
-}
-
-gboolean
-pygdk_rectangle_from_pyobject(PyObject *object, GdkRectangle *rectangle)
-{
- g_return_val_if_fail(rectangle != NULL, FALSE);
-
- if (pyg_boxed_check(object, GDK_TYPE_RECTANGLE)) {
- *rectangle = *pyg_boxed_get(object, GdkRectangle);
- return TRUE;
- }
- if (PyArg_ParseTuple(object, "iiii", &rectangle->x, &rectangle->y,
- &rectangle->width, &rectangle->height)) {
- return TRUE;
- }
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError, "could not convert to GdkRectangle");
- return FALSE;
-}
-
-static PyObject *
-PyGdkRectangle_from_value(const GValue *value)
-{
- GdkRectangle *rect = (GdkRectangle *)g_value_get_boxed(value);
-
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, rect, TRUE, TRUE);
-}
-static int
-PyGdkRectangle_to_value(GValue *value, PyObject *object)
-{
- GdkRectangle rect;
-
- if (!pygdk_rectangle_from_pyobject(object, &rect))
- return -1;
-
- g_value_set_boxed(value, &rect);
- return 0;
-}
-
-/* We have to set ob_type here because stupid win32 does not allow you
- * to use variables from another dll in a global variable initialisation.
- */
-void
-_pygtk_register_boxed_types(PyObject *moddict)
-{
- PyGtkStyleHelper_Type.ob_type = &PyType_Type;
- PyGdkAtom_Type.ob_type = &PyType_Type;
- PyGtkTreeModelRow_Type.ob_type = &PyType_Type;
- PyGtkTreeModelRowIter_Type.ob_type = &PyType_Type;
-
- PyType_Ready(&PyGtkStyleHelper_Type);
- PyType_Ready(&PyGdkAtom_Type);
- PyType_Ready(&PyGtkTreeModelRow_Type);
- PyType_Ready(&PyGtkTreeModelRowIter_Type);
-
- PyDict_SetItemString(moddict, "GdkAtomType", (PyObject *)&PyGdkAtom_Type);
-
- pyg_register_boxed_custom(GTK_TYPE_TREE_PATH,
- PyGtkTreePath_from_value,
- PyGtkTreePath_to_value);
- pyg_register_boxed_custom(GDK_TYPE_RECTANGLE,
- PyGdkRectangle_from_value,
- PyGdkRectangle_to_value);
-}
diff --git a/gtk/gtk.override b/gtk/gtk.override
deleted file mode 100644
index b9bcaabb..00000000
--- a/gtk/gtk.override
+++ /dev/null
@@ -1,8293 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gtk.override: overrides for the gtk module.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-headers
-#define NO_IMPORT_PYGOBJECT
-#include "pygobject.h"
-
-#include <locale.h>
-
-#include <gtk/gtk.h>
-#include <gtk/gtktreeitem.h>
-#include <gdk-pixbuf/gdk-pixbuf.h>
-#include <gdk-pixbuf/gdk-pixdata.h>
-
-#include <pycairo.h>
-extern Pycairo_CAPI_t *Pycairo_CAPI;
-extern PyTypeObject PyGdkCairoContext_Type;
-
-#include "pygtk-private.h"
-
-#define PYGTK_CONTAINER_FOREACH 0
-#define PYGTK_CONTAINER_FORALL 1
-#define countof(array) (sizeof(array)/sizeof(array[0]))
-
-/* make GDK_DISPLAY() the case macro */
-#undef GDK_DISPLAY
-#define GDK_DISPLAY(object) (GDK_DISPLAY_OBJECT(object))
-
-/* from the gdk portion ... */
-extern PyTypeObject PyGdkColormap_Type;
-extern PyTypeObject PyGdkGC_Type;
-extern PyTypeObject PyGdkWindow_Type;
-extern PyTypeObject PyGdkPixmap_Type;
-extern PyTypeObject PyGdkImage_Type;
-extern PyTypeObject PyGdkPixbuf_Type;
-extern PyTypeObject PyGdkPixbufAnimation_Type;
-extern PyTypeObject PyGdkDragContext_Type;
-extern PyTypeObject PyGdkDrawable_Type;
-extern PyTypeObject PyGdkDisplay_Type;
-extern PyTypeObject PyGdkScreen_Type;
-extern PyTypeObject PyGdkRectangle_Type;
-extern PyTypeObject PyGdkDevice_Type;
-
-extern PyObject *PyGtkWarning;
-
-#ifndef pyg_add_warning_redirection
-
-static guint _gtk_handler = -1, _gdk_handler = -1, _gdk_pixbuf_handler = -1;
-
-static void
-_pygtk_log_func(const gchar *log_domain,
- GLogLevelFlags log_level,
- const gchar *message,
- gpointer user_data)
- {
- if (G_LIKELY(Py_IsInitialized()))
- {
- PyGILState_STATE state;
-
- state = pyg_gil_state_ensure();
- PyErr_Warn(PyGtkWarning, (char *) message);
- pyg_gil_state_release(state);
- } else
- g_log_default_handler(log_domain, log_level, message, user_data);
-}
-
-#endif /* ifndef pyg_add_warning_redirection */
-
-static gboolean
-pygtk_util_pyobject_as_double(PyObject *obj, gdouble *value, const char *argument_name)
-{
- PyObject *number;
-
- if (!PyNumber_Check(obj)) {
- PyErr_Format(PyExc_TypeError, "'%s' must be a number", argument_name);
- return FALSE;
- }
- number = PyNumber_Float(obj);
- if (!number) {
- PyErr_Format(PyExc_TypeError, "Could not convert '%s' to a float", argument_name);
- return FALSE;
- }
- *value = PyFloat_AsDouble(number);
- Py_DECREF(number);
- return TRUE;
-}
-
-%%
-include
- gtkclist.override
- gtkcontainer.override
- gtkctree.override
- gtkiconview.override
- gtkstyle.override
- gtktextview.override
- gtktoolbar.override
- gtktreeview.override
- gtkwidget.override
- gtkwindow.override
-%%
-modulename gtk
-%%
-import gobject.GObject as PyGObject_Type
-import atk.Object as PyAtkObject_Type
-import pango.Context as PyPangoContext_Type
-import pango.Font as PyPangoFont_Type
-import pango.Layout as PyPangoLayout_Type
-%%
-ignore
- gtk_accel_group_add
- gtk_accel_group_connect
- gtk_accel_group_create_add
- gtk_accel_group_create_remove
- gtk_accel_group_disconnect
- gtk_accel_group_entries_from_object
- gtk_accel_group_get_entry
- gtk_accel_group_handle_add
- gtk_accel_group_handle_remove
- gtk_accel_group_lock_entry
- gtk_accel_group_ref
- gtk_accel_group_remove
- gtk_accel_groups_activate
- gtk_accel_group_unlock_entry
- gtk_accel_group_unref
- gtk_action_group_add_actions_full
- gtk_action_group_add_toggle_actions_full
- gtk_action_group_add_radio_actions_full
- gtk_binding_set_by_class
- gtk_binding_set_clear
- gtk_binding_set_find
- gtk_binding_set_new
- gtk_button_new_from_stock
- gtk_button_new_with_label
- gtk_button_new_with_mnemonic
- gtk_check_button_new_with_label
- gtk_check_button_new_with_mnemonic
- gtk_check_menu_item_new_with_label
- gtk_check_menu_item_new_with_mnemonic
- gtk_clipboard_set_with_owner
- gtk_color_button_new_with_color
- gtk_color_selection_set_color
- gtk_color_selection_get_color
- gtk_combo_box_get_row_separator_func
- gtk_dialog_new
- gtk_dialog_set_alternative_button_order_from_array
- gtk_drag_dest_handle_event
- gtk_drag_source_handle_event
- gtk_drag_finish
- gtk_drag_set_icon_default
- gtk_drag_set_icon_name
- gtk_drag_set_icon_stock
- gtk_drag_set_icon_pixbuf
- gtk_drag_set_icon_pixmap
- gtk_drag_set_icon_widget
- gtk_draw_hline
- gtk_draw_vline
- gtk_draw_shadow
- gtk_draw_polygon
- gtk_draw_arrow
- gtk_draw_diamond
- gtk_draw_box
- gtk_draw_flat_box
- gtk_draw_check
- gtk_draw_option
- gtk_draw_tab
- gtk_draw_shadow_gap
- gtk_draw_box_gap
- gtk_draw_extension
- gtk_draw_focus
- gtk_draw_slider
- gtk_draw_handle
- gtk_draw_expander
- gtk_draw_layout
- gtk_draw_resize_grip
- gtk_draw_string
- gtk_entry_new_with_max_length
- gtk_entry_select_region
- gtk_exit
- gtk_false
- gtk_file_chooser_button_new_with_backend
- gtk_file_chooser_button_new_with_dialog
- gtk_file_chooser_dialog_new_with_backend
- gtk_file_chooser_error_quark
- gtk_file_chooser_dialog_widget_new_with_backend
- gtk_file_system_error_quark
- gtk_file_system_cancel_operation
- gtk_file_paths_copy
- gtk_file_paths_free
- gtk_font_button_new_with_font
- gtk_gc_get
- gtk_gc_release
- gtk_get_event_widget
- gtk_icon_theme_error_quark
- gtk_idle_add
- gtk_idle_add_full
- gtk_idle_add_priority
- gtk_idle_remove
- gtk_idle_remove_by_data
- gtk_image_item_menu_new_with_label
- gtk_image_menu_item_new_from_stock
- gtk_image_menu_item_new_with_mnemonic
- gtk_init
- gtk_init_abi_check
- gtk_init_check_abi_check
- gtk_input_add_full
- gtk_input_remove
- gtk_item_factory_create_item
- gtk_item_factory_create_items_ac
- gtk_item_factory_create_menu_entries
- gtk_item_factory_delete_entries
- gtk_item_factory_delete_entry
- gtk_item_factory_popup_data
- gtk_item_factory_popup_with_data
- gtk_item_factory_set_translate_func
- gtk_key_snooper_install
- gtk_key_snooper_remove
- gtk_list_item_new_with_label
- gtk_list_remove_items_no_unref
- gtk_menu_append
- gtk_menu_bar_append
- gtk_menu_bar_insert
- gtk_menu_bar_prepend
- gtk_menu_insert
- gtk_menu_item_new_with_label
- gtk_menu_item_new_with_mnemonic
- gtk_menu_prepend
- gtk_object_add_arg_type
- gtk_object_arg_get
- gtk_object_arg_get_info
- gtk_object_args_collect
- gtk_object_arg_set
- gtk_object_get
- gtk_object_get_data
- gtk_object_get_data_by_id
- gtk_object_get_user_data
- gtk_object_getv
- gtk_object_new
- gtk_object_newv
- gtk_object_query_args
- gtk_object_ref
- gtk_object_remove_data_by_id
- gtk_object_remove_no_notify_by_id
- gtk_object_set
- gtk_object_set_data
- gtk_object_set_data_by_id
- gtk_object_set_data_by_id_full
- gtk_object_set_data_full
- gtk_object_set_user_data
- gtk_object_setv
- gtk_object_sink
- gtk_object_unref
- gtk_object_weakref
- gtk_object_weakunref
- gtk_paper_size_free
- gtk_plug_construct
- gtk_plug_construct_for_display
- gtk_preview_uninit
- gtk_preview_get_info
- gtk_print_error_quark
- gtk_progress_bar_new
- gtk_propagate_event
- gtk_quit_remove_by_data
- gtk_radio_button_group
- gtk_radio_menu_item_group
- gtk_radio_menu_item_new_with_label
- gtk_radio_menu_item_new_with_mnemonic
- gtk_range_default_htrough_click
- gtk_range_default_vtrough_click
- gtk_range_trough_click
- gtk_recent_chooser_error_quark
- gtk_recent_chooser_dialog_new_for_manager
- gtk_recent_chooser_menu_new
- gtk_recent_chooser_widget_new
- gtk_recent_chooser_set_show_numbers
- gtk_recent_chooser_get_show_numbers
- gtk_recent_manager_error_quark
- gtk_selection_clear
- gtk_selection_data_copy
- gtk_selection_data_free
- gtk_selection_incr_event
- gtk_selection_notify
- gtk_selection_property_notify
- gtk_selection_request
- gtk_set_locale
- gtk_timeout_remove
- gtk_toggle_button_new_with_label
- gtk_toggle_button_new_with_mnemonic
- gtk_text_anchored_child_set_layout
- gtk_text_child_anchor_queue_resize
- gtk_text_child_anchor_register_child
- gtk_text_child_anchor_unregister_child
- gtk_trace_referencing
- gtk_tree_item_new_with_label
- gtk_tree_remove_items
- gtk_true
- gtk_rc_find_pixmap_in_path
- gtk_rc_scanner_new
- gtk_rc_parse_color
- gtk_rc_parse_state
- gtk_rc_parse_priority
- gtk_rc_property_parse_color
- gtk_rc_property_parse_enum
- gtk_rc_property_parse_flags
- gtk_rc_property_parse_requisition
- gtk_rc_property_parse_border
- gtk_target_list_new
- gtk_target_list_ref
- gtk_target_list_unref
- gtk_target_list_add
- gtk_target_list_add_table
- gtk_target_list_remove
- gtk_target_list_find
- gtk_target_table_new_from_list
- gtk_target_table_free
- GtkObject__do_set_arg
- GtkObject__do_get_arg
- GtkObject__proxy_do_set_arg
- GtkObject__proxy_do_get_arg
-%%
-ignore-glob
- _*
- *_get_type
- *_ref
- *_unref
- gtk_arg_*
- gtk_args_*
- gtk_init_add_*
- gtk_marshal_*
- gtk_pattern_*
- gtk_radio_button_new_*
- gtk_quit_add_*
- gtk_signal_*
- gtk_text_layout_*
- gtk_type_*
- gtk_timeout_add*
-%%
-ignore-type
- GtkFileFolder
- GtkFileInfo
- GtkFileInfoType
- GtkFilePath
- GtkFileSystem
- GtkFileSystemError
- GtkFileSystemHandle
- GtkSignalRunType
- GtkTargetList
- GtkTipsQuery
- GtkTree
- GtkTreeItem
- GtkTreePath
- GtkText
- GtkTextLayout
-%%
-override gtk_init_check noargs
-static PyObject *
-_wrap_gtk_init_check(PyGObject *self, PyObject *args)
-{
- PyObject *av;
- int argc, i;
- char **argv;
-
- /* initialise GTK ... */
- av = PySys_GetObject("argv");
- if (av != NULL) {
- if (!PyList_Check(av)) {
- PyErr_Warn(PyExc_Warning, "ignoring sys.argv: it must be a list of strings");
- av = NULL;
- } else {
- argc = PyList_Size(av);
- for (i = 0; i < argc; i++)
- if (!PyString_Check(PyList_GetItem(av, i))) {
- PyErr_Warn(PyExc_Warning, "ignoring sys.argv: it must be a list of strings");
- av = NULL;
- break;
- }
- }
- }
- if (av != NULL) {
- argv = g_new(char *, argc);
- for (i = 0; i < argc; i++)
- argv[i] = g_strdup(PyString_AsString(PyList_GetItem(av, i)));
- } else {
- argc = 0;
- argv = NULL;
- }
-
- if (!gtk_init_check(&argc, &argv)) {
- if (argv != NULL) {
- for (i = 0; i < argc; i++)
- g_free(argv[i]);
- g_free(argv);
- }
- PyErr_SetString(PyExc_RuntimeError, "could not open display");
- /* set the LC_NUMERIC locale back to "C", as Python < 2.4 requires
- * that it be set that way. */
-#if PY_VERSION_HEX < 0x020400F0
- setlocale(LC_NUMERIC, "C");
-#endif
- return NULL;
- }
- /* set the LC_NUMERIC locale back to "C", as Python < 2.4 requires that
- * it be set that way. */
-#if PY_VERSION_HEX < 0x020400F0
- setlocale(LC_NUMERIC, "C");
-#endif
- if (argv != NULL) {
- PySys_SetArgv(argc, argv);
- for (i = 0; i < argc; i++)
- g_free(argv[i]);
- g_free(argv);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-define add_log_handlers
-static PyObject *
-_wrap_add_log_handlers(PyGObject *self, PyObject *args)
-{
- if (!PyArg_ParseTuple(args, ":add_log_handlers"))
- return NULL;
-#ifndef pyg_add_warning_redirection
-
- _gtk_handler = g_log_set_handler("Gtk",
- G_LOG_LEVEL_CRITICAL|G_LOG_LEVEL_WARNING,
- _pygtk_log_func, NULL);
- _gdk_handler = g_log_set_handler("Gdk",
- G_LOG_LEVEL_CRITICAL|G_LOG_LEVEL_WARNING,
- _pygtk_log_func, NULL);
- _gdk_pixbuf_handler = g_log_set_handler("GdkPixbuf",
- G_LOG_LEVEL_CRITICAL|G_LOG_LEVEL_WARNING,
- _pygtk_log_func, NULL);
-#else
-
- pyg_add_warning_redirection("Gtk", PyGtkWarning);
- pyg_add_warning_redirection("Gdk", PyGtkWarning);
- pyg_add_warning_redirection("GdkPixbuf", PyGtkWarning);
-
-#endif /* ifndef pyg_add_warning_redirection */
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-define remove_log_handlers
-static PyObject *
-_wrap_remove_log_handlers(PyGObject *self, PyObject *args)
-{
- if (!PyArg_ParseTuple(args, ":remove_log_handlers"))
- return NULL;
-
-#ifndef pyg_disable_warning_redirections
-
- g_log_remove_handler("Gtk", _gtk_handler);
- _gtk_handler = -1;
- g_log_remove_handler("Gdk", _gdk_handler);
- _gdk_handler = -1;
- g_log_remove_handler("GdkPixbuf", _gdk_pixbuf_handler);
- _gdk_pixbuf_handler = -1;
-
-#else
-
- pyg_disable_warning_redirections();
-
-#endif /* ifndef pyg_disable_warning_redirections */
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-override gtk_paint_polygon kwargs
-static PyObject *
-_wrap_gtk_paint_polygon(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "window", "state_type", "shadow_type", "area", "widget", "detail", "points", "fill", NULL };
- PyObject *window, *py_state_type, *py_shadow_type, *py_area;
- GtkStateType state_type;
- GtkShadowType shadow_type;
- GdkRectangle area;
- PyObject *widget;
- const gchar *detail;
- PyObject *py_points;
- gint npoints, i;
- GdkPoint *points;
- gboolean fill;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!OOOO!zOi:GdkStyle.paint_polygon",
- kwlist, &PyGdkWindow_Type, &window,
- &py_state_type, &py_shadow_type, &py_area,
- &PyGtkWidget_Type, &widget, &detail,
- &py_points, &fill))
- return NULL;
- if (pyg_enum_get_value(GTK_TYPE_STATE_TYPE, py_state_type,
- (gint *)&state_type))
- return NULL;
- if (pyg_enum_get_value(GTK_TYPE_SHADOW_TYPE, py_shadow_type,
- (gint *)&shadow_type))
- return NULL;
- if (!pygdk_rectangle_from_pyobject(py_area, &area))
- return NULL;
- if (!PySequence_Check(py_points)) {
- PyErr_SetString(PyExc_TypeError, "points must be a sequence");
- return NULL;
- }
- npoints = PySequence_Length(py_points);
- points = g_new(GdkPoint, npoints);
- for (i = 0; i < npoints; i++) {
- PyObject *item = PySequence_GetItem(py_points, i);
- Py_DECREF(item);
- if (!PyArg_ParseTuple(item, "hh", &points[i].x, &points[i].y)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "sequence members must be 2-tuples");
- g_free(points);
- return NULL;
- }
- }
- gtk_paint_polygon(GTK_STYLE(self->obj), GDK_WINDOW(pygobject_get(window)),
- state_type, shadow_type, &area,
- GTK_WIDGET(pygobject_get(widget)), detail,
- points, npoints, fill);
- g_free(points);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override-attr GtkSelectionData.data
-static PyObject *
-_wrap_gtk_selection_data__get_data(PyGObject *self, void *closure)
-{
- if (pyg_boxed_get(self, GtkSelectionData)->length >= 0) {
- return PyString_FromStringAndSize(
- (char*)pyg_boxed_get(self, GtkSelectionData)->data,
- pyg_boxed_get(self, GtkSelectionData)->length);
- } else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override gtk_selection_data_set kwargs
-static PyObject *
-_wrap_gtk_selection_data_set(PyGBoxed *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "type", "format", "data", NULL };
- PyObject *py_type;
- GdkAtom type;
- int format;
- Py_ssize_t length;
- guchar *data;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Ois#:GtkSelectionData.set", kwlist,
- &py_type, &format, &data, &length))
- return NULL;
- type = pygdk_atom_from_pyobject(py_type);
- if (PyErr_Occurred())
- return NULL;
-
- gtk_selection_data_set(pyg_boxed_get(self, GtkSelectionData),
- type, format, data, length);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_selection_data_get_text noargs
-static PyObject *
-_wrap_gtk_selection_data_get_text(PyObject *self)
-{
- gchar *ret;
-
- ret = (char*)gtk_selection_data_get_text(pyg_boxed_get(self,
- GtkSelectionData));
- if (ret) {
- PyObject *py_ret = PyUnicode_DecodeUTF8(ret, strlen(ret), "strict");
- g_free(ret);
- return py_ret;
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_selection_data_get_targets noargs
-static PyObject *
-_wrap_gtk_selection_data_get_targets(PyObject *self)
-{
- GdkAtom *targets;
- gint n_atoms;
-
- if (gtk_selection_data_get_targets(pyg_boxed_get(self, GtkSelectionData),
- &targets, &n_atoms)) {
- PyObject *ret;
- gint i;
-
- ret = PyTuple_New(n_atoms);
- for (i = 0; i < n_atoms; i++) {
- gchar *name = gdk_atom_name(targets[i]);
-
- PyTuple_SetItem(ret, i, PyString_FromString(name));
- g_free(name);
- }
- g_free(targets);
- return ret;
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_clipboard_set_with_data kwargs
-static void
-clipboard_get_func(GtkClipboard *clipboard, GtkSelectionData *selection_data,
- guint info, gpointer user_data)
-{
- PyObject *callback, *args, *ret;
- PyGILState_STATE state;
-
- state = pyg_gil_state_ensure();
- callback = PyTuple_GetItem((PyObject *)user_data, 0);
- args = Py_BuildValue("(NNiO)",
- pygobject_new((GObject *)clipboard),
- pyg_boxed_new(GTK_TYPE_SELECTION_DATA,
- selection_data, FALSE, FALSE),
- info, PyTuple_GetItem((PyObject *)user_data, 2));
- ret = PyObject_CallObject(callback, args);
- if (!ret)
- PyErr_Print();
- Py_XDECREF(ret);
- Py_DECREF(args);
- pyg_gil_state_release(state);
-}
-static void
-clipboard_clear_func(GtkClipboard *clipboard, gpointer user_data)
-{
- PyGILState_STATE state;
- PyObject *callback, *args, *ret;
-
- state = pyg_gil_state_ensure();
- callback = PyTuple_GetItem((PyObject *)user_data, 1);
- args = Py_BuildValue("(NO)",
- pygobject_new((GObject *)clipboard),
- PyTuple_GetItem((PyObject *)user_data, 2));
- ret = PyObject_CallObject(callback, args);
- if (!ret)
- PyErr_Print();
- Py_XDECREF(ret);
- Py_DECREF(args);
- Py_DECREF((PyObject *)user_data);
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_clipboard_set_with_data(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "targets", "get_func", "clear_func", "user_data", NULL };
- PyObject *py_targets, *get_func, *clear_func = Py_None, *user_data = Py_None;
- GtkTargetEntry *targets;
- gint n_targets, i;
- gboolean ret;
- PyObject *data;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO|OO:GtkClipboard.set_with_data",kwlist,
- &py_targets, &get_func, &clear_func,
- &user_data))
- return NULL;
- if (!PyCallable_Check(get_func)) {
- PyErr_SetString(PyExc_TypeError, "get_func must be callable");
- return NULL;
- }
- if (clear_func != Py_None && !PyCallable_Check(clear_func)) {
- PyErr_SetString(PyExc_TypeError,"clear_func must be callable or None");
- return NULL;
- }
- if (!(py_targets = PySequence_Fast(py_targets, "targets must be a sequence")))
- return NULL;
- n_targets = PySequence_Fast_GET_SIZE(py_targets);
- targets = g_new(GtkTargetEntry, n_targets);
- for (i = 0; i < n_targets; i++) {
- PyObject *item = PySequence_Fast_GET_ITEM(py_targets, i);
- if (!PyArg_ParseTuple(item, "sii", &targets[i].target,
- &targets[i].flags, &targets[i].info)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "list items should be of form (string,int,int)");
- g_free(targets);
- Py_DECREF(py_targets);
- return NULL;
- }
- }
- data = Py_BuildValue("(OOO)", get_func, clear_func, user_data);
- ret = gtk_clipboard_set_with_data(GTK_CLIPBOARD(self->obj),
- targets, n_targets,
- clipboard_get_func, clipboard_clear_func,
- data);
- g_free(targets);
- Py_DECREF(py_targets);
- if (!ret) {
- Py_DECREF(data);
- }
-
- return PyBool_FromLong(ret);
-}
-%%
-override gtk_label_get noargs
-static PyObject *
-_wrap_gtk_label_get(PyGObject *self)
-{
- gchar *text = NULL;
-
- gtk_label_get(GTK_LABEL(self->obj), &text);
- if (text)
- return PyString_FromString(text);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_label_get_selection_bounds noargs
-static PyObject *
-_wrap_gtk_label_get_selection_bounds(PyGObject *self)
-{
- int start, end;
-
- if (!gtk_label_get_selection_bounds(GTK_LABEL(self->obj), &start, &end)) {
- return Py_BuildValue ("()");
- }
-
- return Py_BuildValue("(ii)", start, end);
-}
-%%
-override gtk_label_get_layout_offsets noargs
-static PyObject *
-_wrap_gtk_label_get_layout_offsets(PyGObject *self)
-{
- gint x;
- gint y;
-
- gtk_label_get_layout_offsets(GTK_LABEL(self->obj), &x, &y);
- return Py_BuildValue("(ii)", x, y);
-}
-%%
-override gtk_spin_button_get_increments noargs
-static PyObject *
-_wrap_gtk_spin_button_get_increments(PyGObject *self)
-{
- gdouble step;
- gdouble page;
-
- gtk_spin_button_get_increments(GTK_SPIN_BUTTON(self->obj), &step, &page);
- return Py_BuildValue("(dd)", step, page);
-}
-%%
-override gtk_spin_button_get_range noargs
-static PyObject *
-_wrap_gtk_spin_button_get_range(PyGObject *self)
-{
- gdouble min;
- gdouble max;
-
- gtk_spin_button_get_range(GTK_SPIN_BUTTON(self->obj), &min, &max);
- return Py_BuildValue("(dd)", min, max);
-}
-%%
-override gtk_box_query_child_packing kwargs
-static PyObject *
-_wrap_gtk_box_query_child_packing(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "child", NULL };
- PyGObject *pychild;
- GtkWidget *child;
- GList *children;
- gboolean expand, fill;
- guint padding;
- GtkPackType pack_type;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!:GtkBox.query_child_packing", kwlist,
- &PyGtkWidget_Type, &pychild)) {
- return NULL;
- }
-
- child = GTK_WIDGET(pychild->obj);
- children = gtk_container_get_children(GTK_CONTAINER(self->obj));
- if (g_list_find(children, child) == NULL) {
- PyErr_SetString(PyExc_TypeError,
- "first argument must be a child");
- return NULL;
- }
- gtk_box_query_child_packing(GTK_BOX(self->obj),
- child, &expand, &fill,
- &padding, &pack_type);
- return Py_BuildValue("(iiiN)", (int)expand, (int)fill, padding,
- pyg_enum_from_gtype(GTK_TYPE_PACK_TYPE, pack_type));
-}
-%%
-override gtk_combo_set_popdown_strings kwargs
-static PyObject *
-_wrap_gtk_combo_set_popdown_strings(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "strings", NULL };
- PyObject *list;
- GList *glist = NULL;
- int len, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkCombo.set_popdown_strings", kwlist,
- &list))
- return NULL;
- if (!PySequence_Check(list)) {
- PyErr_SetString(PyExc_TypeError, "first argument must be a sequence");
- return NULL;
- }
- len = PySequence_Length(list);
- for (i = 0; i < len; i++) {
- PyObject *item = PySequence_GetItem(list, i);
-
- Py_DECREF(item);
- if (!PyString_Check(item) && !PyUnicode_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "sequence item not a string or unicode object");
- g_list_free(glist);
- return NULL;
- }
- glist = g_list_append(glist, PyString_AsString(item));
- }
- gtk_combo_set_popdown_strings(GTK_COMBO(self->obj), glist);
- g_list_free(glist);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_curve_get_vector kwargs
-static PyObject *
-_wrap_gtk_curve_get_vector(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "size", NULL };
- int size = -1, i;
- gfloat *vector;
- PyObject *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|i:GtkCurve.get_vector", kwlist,
- &size))
- return NULL;
- if (size < 0) size = GTK_CURVE(self->obj)->num_points;
- vector = g_new(gfloat, size);
- gtk_curve_get_vector(GTK_CURVE(self->obj), size, vector);
- ret = PyTuple_New(size);
- for (i = 0; i < size; i++)
- PyTuple_SetItem(ret, i, PyFloat_FromDouble(vector[i]));
- g_free(vector);
- return ret;
-}
-%%
-override gtk_curve_set_vector kwargs
-static PyObject *
-_wrap_gtk_curve_set_vector(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "vector", NULL };
- PyObject *seq;
- int size, i;
- gfloat *vector;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GtkCurve.set_vector",
- kwlist, &seq))
- return NULL;
- if (!PySequence_Check(seq)) {
- PyErr_SetString(PyExc_TypeError, "1st argument is not a sequence");
- return NULL;
- }
- size = PySequence_Length(seq);
- vector = g_new(gfloat, size);
- for (i = 0; i < size; i++) {
- PyObject *item = PySequence_GetItem(seq, i);
-
- Py_DECREF(item);
- item = PyNumber_Float(item); /* item has a ref now */
- if (item == NULL) {
- g_free(vector);
- return NULL;
- }
- vector[i] = PyFloat_AsDouble(item);
- Py_DECREF(item);
- }
- gtk_curve_set_vector(GTK_CURVE(self->obj), size, vector);
- g_free(vector);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_binding_entry_add_signal
-static PyObject *
-_wrap_gtk_binding_entry_add_signal(PyGObject *self, PyObject *args)
-{
- PyObject *first;
- gint len, i;
- PyObject *class;
- guint keyval, modifiers;
- gchar *signal_name;
- GType class_type;
- GtkBindingSet *bset = NULL;
- GSList *slist = NULL;
- gchar *errmsg;
-
- len = PyTuple_Size(args);
- if (len < 4) {
- PyErr_SetString(PyExc_TypeError, "binding_entry_add_signal requires at"
- " least 4 arguments");
- return NULL;
- }
- first = PySequence_GetSlice(args, 0, 4);
- if (!PyArg_ParseTuple(first, "Oiis:binding_entry_add_signal", &class,
- &keyval, &modifiers, &signal_name)) {
- Py_DECREF(first);
- return NULL;
- }
- Py_DECREF(first);
-
- class_type = pyg_type_from_object(class);
- if (class_type == 0)
- return NULL;
-
- bset = gtk_binding_set_by_class(gtk_type_class(class_type));
-
- /* extra args */
- if ((len-4)%2) {
- PyErr_SetString(PyExc_ValueError,
- "GtkBindingSet.add_signal requires an even number"
- " of parameter pairs following the first four args");
- return NULL;
- }
- for (i=4; i < len; i+=2) {
- PyObject *item;
- GType arg_type;
- GtkBindingArg *arg = NULL;
-
- item = PyTuple_GET_ITEM(args, i);
- arg_type = pyg_type_from_object(item);
- if (!arg_type) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "GtkBindingSet.add_signal parameter types"
- " must be int");
- goto arg_error;
- }
- arg = g_new0 (GtkBindingArg, 1);
- slist = g_slist_prepend(slist, arg);
-
- arg->arg_type = arg_type;
- switch (GTK_FUNDAMENTAL_TYPE(arg->arg_type)) {
- case GTK_TYPE_CHAR:
- case GTK_TYPE_UCHAR:
- case GTK_TYPE_INT:
- case GTK_TYPE_UINT:
- case GTK_TYPE_BOOL:
- case GTK_TYPE_ENUM:
- case GTK_TYPE_FLAGS:
- case GTK_TYPE_LONG:
- case GTK_TYPE_ULONG:
- arg->arg_type = GTK_TYPE_LONG;
- item = PyTuple_GET_ITEM(args, i+1);
- if (!PyInt_Check(item)) {
- errmsg = g_strdup_printf("GtkBindingSet.add_signal "
- "arg[%u] must be int", i+1);
- PyErr_SetString(PyExc_TypeError, errmsg);
- g_free(errmsg);
- goto arg_error;
- }
- arg->d.long_data = (glong)PyInt_AsLong(item);
- break;
- case GTK_TYPE_FLOAT:
- case GTK_TYPE_DOUBLE:
- arg->arg_type = GTK_TYPE_DOUBLE;
- item = PyTuple_GET_ITEM(args, i+1);
- if (!PyFloat_Check(item)) {
- errmsg = g_strdup_printf("GtkBindingSet.add_signal "
- "arg[%u] must be float", i+1);
- PyErr_SetString(PyExc_TypeError, errmsg);
- g_free(errmsg);
- goto arg_error;
- }
- arg->d.long_data = (gdouble)PyFloat_AsDouble(item);
- break;
- case GTK_TYPE_STRING:
- arg->arg_type = GTK_TYPE_STRING;
- if (arg->arg_type != GTK_TYPE_IDENTIFIER)
- arg->arg_type = GTK_TYPE_STRING;
- item = PyTuple_GET_ITEM(args, i+1);
- if (!PyString_Check(item)) {
- errmsg = g_strdup_printf("GtkBindingSet.add_signal arg[%u] "
- "must be non-empty string", i+1);
- PyErr_SetString(PyExc_TypeError, errmsg);
- g_free(errmsg);
- goto arg_error;
- }
- arg->d.string_data = (gchar*)PyString_AsString(item);
- if (!arg->d.string_data) {
- errmsg = g_strdup_printf("GtkBindingSet.add_signal arg[%u] "
- "must be non-empty string", i+1);
- PyErr_SetString(PyExc_TypeError, errmsg);
- g_free(errmsg);
- goto arg_error;
- }
- break;
- default:
- errmsg = g_strdup_printf("GtkBindingSet.add_signal unsupported "
- "type %10s for arg[%u]",
- gtk_type_name(arg->arg_type), i+1);
- PyErr_SetString(PyExc_TypeError, errmsg);
- g_free(errmsg);
- goto arg_error;
- } /* switch */
- }
-
- slist = g_slist_reverse (slist);
- gtk_binding_entry_add_signall (bset, keyval,modifiers, signal_name, slist);
-
- g_slist_foreach(slist, (GFunc)g_free, NULL);
- g_slist_free(slist);
-
- Py_INCREF(Py_None);
- return Py_None;
-
-arg_error:
- if (slist) {
- g_slist_foreach(slist, (GFunc)g_free, NULL);
- g_slist_free(slist);
- }
- return NULL;
-}
-%%
-override gtk_main noargs
-
- /* This code (pygtk main watch) was copied with minor changes from
- * pygobject/gobject/pygmainloop.c */
-static gboolean
-pygtk_main_watch_prepare(GSource *source,
- int *timeout)
-{
- /* Python only invokes signal handlers from the main thread,
- * so if a thread other than the main thread receives the signal
- * from the kernel, PyErr_CheckSignals() from that thread will
- * do nothing. So, we need to time out and check for signals
- * regularily too.
- * Also, on Windows g_poll() won't be interrupted by a signal
- * (AFAIK), so we need the timeout there too.
- */
-#ifndef PLATFORM_WIN32
- if (pyg_threads_enabled)
-#endif
- *timeout = 100;
-
- return FALSE;
-}
-
-static gboolean
-pygtk_main_watch_check(GSource *source)
-{
- PyGILState_STATE state;
-
- state = pyg_gil_state_ensure();
-
- if (PyErr_CheckSignals() == -1 && gtk_main_level() > 0) {
- PyErr_SetNone(PyExc_KeyboardInterrupt);
- gtk_main_quit();
- }
-
- pyg_gil_state_release(state);
-
- return FALSE;
-}
-
-static gboolean
-pygtk_main_watch_dispatch(GSource *source,
- GSourceFunc callback,
- gpointer user_data)
-{
- /* We should never be dispatched */
- g_assert_not_reached();
- return TRUE;
-}
-
-static GSourceFuncs pygtk_main_watch_funcs =
-{
- pygtk_main_watch_prepare,
- pygtk_main_watch_check,
- pygtk_main_watch_dispatch,
- NULL
-};
-
-static GSource *
-pygtk_main_watch_new(void)
-{
- return g_source_new(&pygtk_main_watch_funcs, sizeof(GSource));
-}
-
-
-static PyObject *
-_wrap_gtk_main(PyObject *self)
-{
- GSource *main_watch;
- // Call enable_threads again to ensure that the thread state is recorded
- if (pyg_threads_enabled)
- pyg_enable_threads();
-
- main_watch = pygtk_main_watch_new();
- pyg_begin_allow_threads;
- g_source_attach(main_watch, NULL);
- gtk_main();
- g_source_destroy(main_watch);
- pyg_end_allow_threads;
- if (PyErr_Occurred())
- return NULL;
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_main_iteration kwargs
-static PyObject *
-_wrap_gtk_main_iteration(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = {"block", NULL};
- int block = 1, ret;
-
- if(!PyArg_ParseTupleAndKeywords(args, kwargs, "|i:main_iteration", kwlist,
- &block))
- return NULL;
- pyg_begin_allow_threads;
- ret = gtk_main_iteration_do(block);
- pyg_end_allow_threads;
-
- return PyBool_FromLong(ret);
-}
-%%
-override gtk_main_quit args
-static PyObject *
-_wrap_gtk_main_quit(PyObject *self, PyObject *args)
-{
- /* args is just ignored, so obj.connect(signal, func) always works */
-
- /* Sanity check to make sure we're in a mainloop */
- if (gtk_main_level() == 0) {
- PyErr_SetString(PyExc_RuntimeError,
- "called outside of a mainloop");
- return NULL;
- }
-
- gtk_main_quit();
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_main_iteration_do kwargs
-static PyObject *
-_wrap_gtk_main_iteration_do(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = {"block", NULL};
- int block = 1, ret;
-
- if(!PyArg_ParseTupleAndKeywords(args, kwargs, "|i:main_iteration_do",
- kwlist, &block))
- return NULL;
-
- pyg_begin_allow_threads;
- ret = gtk_main_iteration_do(block);
- pyg_end_allow_threads;
-
- return PyBool_FromLong(ret);
-}
-%%
-override gtk_quit_add
-static gboolean
-quit_handler_marshal(gpointer user_data)
-{
- PyGILState_STATE state;
- PyObject *tuple, *ret;
- gboolean res;
-
- g_return_val_if_fail(user_data != NULL, FALSE);
-
- state = pyg_gil_state_ensure();
-
- tuple = (PyObject *)user_data;
- ret = PyObject_CallObject(PyTuple_GetItem(tuple, 0),
- PyTuple_GetItem(tuple, 1));
- if (!ret) {
- PyErr_Print();
- res = FALSE;
- } else {
- res = PyObject_IsTrue(ret);
- Py_DECREF(ret);
- }
- pyg_gil_state_release(state);
-
- return res;
-}
-
-static PyObject *
-_wrap_gtk_quit_add(PyObject *self, PyObject *args)
-{
- gint main_level;
- PyObject *first, *callback, *cbargs = NULL, *data;
- gint len;
-
- len = PyTuple_Size(args);
- if (len < 2) {
- PyErr_SetString(PyExc_TypeError,
- "quit_add requires at least 2 args");
- return NULL;
- }
- first = PySequence_GetSlice(args, 0, 2);
- if (!PyArg_ParseTuple(first, "iO:quit_add", &main_level, &callback)) {
- Py_DECREF(first);
- return NULL;
- }
- Py_DECREF(first);
- if (!PyCallable_Check(callback)) {
- PyErr_SetString(PyExc_TypeError, "second argument not callable");
- return NULL;
- }
-
- cbargs = PySequence_GetSlice(args, 2, len);
- if (cbargs == NULL)
- return NULL;
-
- data = Py_BuildValue("(ON)", callback, cbargs);
- if (data == NULL)
- return NULL;
- return PyInt_FromLong(gtk_quit_add_full(main_level, quit_handler_marshal,
- NULL, data, pyg_destroy_notify));
-}
-%%
-override gtk_get_current_event_state noargs
-static PyObject *
-_wrap_gtk_get_current_event_state (PyGObject *self)
-{
- GdkModifierType state = 0;
-
- if (gtk_get_current_event_state (&state)) {
- return pyg_flags_from_gtype (GDK_TYPE_MODIFIER_TYPE, state);
- } else {
- Py_INCREF (Py_None);
- return Py_None;
- }
-}
-%%
-override gtk_editable_insert_text kwargs
-static PyObject *
-_wrap_gtk_editable_insert_text(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "text", "position", NULL };
- char *text;
- Py_ssize_t len;
- int position=0;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s#|i:GtkEditable.insert_text",
- kwlist, &text, &len, &position))
- return NULL;
- gtk_editable_insert_text(GTK_EDITABLE(self->obj), text, len, &position);
- return PyInt_FromLong(position);
-}
-%%
-override gtk_editable_get_selection_bounds noargs
-static PyObject *
-_wrap_gtk_editable_get_selection_bounds(PyGObject *self, PyObject *args)
-{
- int start, end;
-
- if (!gtk_editable_get_selection_bounds(GTK_EDITABLE(self->obj), &start, &end)) {
- return Py_BuildValue ("()");
- }
-
- return Py_BuildValue ("(ii)", start, end);
-}
-%%
-override gtk_entry_get_layout_offsets noargs
-static PyObject *
-_wrap_gtk_entry_get_layout_offsets(PyGObject *self, PyObject *args)
-{
- int x, y;
-
- gtk_entry_get_layout_offsets(GTK_ENTRY(self->obj), &x, &y);
-
- return Py_BuildValue ("(ii)", x, y);
-}
-%%
-override gtk_item_factory_create_items kwargs
-static void
-pygtk_item_factory_cb(PyGtkCustomNotify *cunote,
- guint action, GtkWidget *widget)
-{
- PyGILState_STATE state;
- PyObject *ret;
-
- state = pyg_gil_state_ensure();
- if (cunote->data)
- ret = PyObject_CallFunction(cunote->func, "OiO", cunote->data, action,
- pygobject_new((GObject *)widget));
- else
- ret = PyObject_CallFunction(cunote->func, "iO", action,
- pygobject_new((GObject *)widget));
- if (ret == NULL) {
- PyErr_Print();
- } else
- Py_DECREF(ret);
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_item_factory_create_items(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "entries", "callback_data", NULL };
- PyObject *list, *cb, *cbdata = NULL;
- GtkItemFactoryEntry ent;
- PyObject *extra_data = NULL;
- GtkItemFactory *ifact;
- int i, len;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkItemFactory.create_items", kwlist,
- &list, &cbdata))
- return NULL;
-
- if (!PySequence_Check(list)) {
- PyErr_SetString(PyExc_TypeError, "entries must be a sequence");
- return NULL;
- }
-
- ifact = GTK_ITEM_FACTORY(self->obj);
- len = PySequence_Size(list);
- for (i = 0; i < len; i++) {
- PyGtkCustomNotify *cunote = NULL;
- PyObject *item = PySequence_GetItem(list, i);
- Py_DECREF(item);
-
- memset(&ent, 0, sizeof(ent));
- cb = Py_None;
-
- if (!PyArg_ParseTuple(item, "s|zOizO", &(ent.path), &(ent.accelerator),
- &cb, &(ent.callback_action), &(ent.item_type),
- &extra_data)) {
- return NULL;
- }
-
- if (cb == Py_None) {
- ent.callback = NULL;
- } else {
- ent.callback = (GtkItemFactoryCallback)pygtk_item_factory_cb;
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = cb;
- cunote->data = cbdata;
- Py_XINCREF(cunote->func);
- Py_XINCREF(cunote->data);
- }
-
- if (extra_data != NULL) {
- if (PyString_Check(extra_data)) {
- ent.extra_data = PyString_AsString(extra_data);
- } else if (pygobject_check(extra_data, &PyGdkPixbuf_Type)) {
- /* create_items actually expects inline image data
- * so let's create it for the user from the pixbuf
- * it's not optimal but it's convenient
- */
- GdkPixdata pixdata;
- GdkPixbuf * pixbuf;
- guint8 * serialstr;
- guint len;
-
- pixbuf = GDK_PIXBUF(pygobject_get(extra_data));
- gdk_pixdata_from_pixbuf(&pixdata, pixbuf, FALSE);
- serialstr = gdk_pixdata_serialize(&pixdata, &len);
- ent.extra_data = serialstr;
- } else {
- PyErr_SetString(PyExc_TypeError,
- "last argument must be a GdkPixBuf or a string");
- return NULL;
- }
- }
- if (cunote != NULL) {
- PyGILState_STATE state;
- state = pyg_gil_state_ensure();
- g_object_weak_ref(G_OBJECT(ifact),
- (GWeakNotify) pygtk_custom_destroy_notify,
- cunote);
- pyg_gil_state_release(state);
- }
-
- gtk_item_factory_create_item(ifact, &ent, cunote, 1);
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_menu_popup kwargs
-static void
-pygtk_menu_position(GtkMenu *menu, int *x, int *y, gboolean *push_in,
- gpointer user_data)
-{
- PyGtkCustomNotify *cunote = (PyGtkCustomNotify*)user_data;
- PyObject *ret;
- PyGILState_STATE state;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- if (cunote->data) {
- ret = PyObject_CallFunction(cunote->func, "(NO)",
- pygobject_new((GObject *)menu),
- cunote->data);
- } else {
- ret = PyObject_CallFunction(cunote->func, "(N)",
- pygobject_new((GObject *)menu));
- }
-
- if (ret == NULL || !PyArg_ParseTuple(ret, "iii", x, y, push_in)) {
- PyErr_Print();
- Py_XDECREF(ret);
- } else {
- Py_DECREF(ret);
- }
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_menu_popup(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "parent_menu_shell", "parent_menu_item", "func",
- "button", "activate_time", "data", NULL };
- PyGObject *py_pms, *py_pmi;
- GtkWidget *pms = NULL, *pmi = NULL;
- GtkMenu *menu = GTK_MENU(self->obj);
- PyObject *func, *data = NULL;
- int button;
- guint32 time;
- PyObject *pytime;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OOOiO|O:GtkMenu.popup",
- kwlist, &py_pms, &py_pmi, &func,
- &button, &pytime, &data))
- return NULL;
- if (pygobject_check(py_pms, &PyGtkWidget_Type))
- pms = GTK_WIDGET(py_pms->obj);
- else if ((PyObject *)py_pms != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "parent_menu_shell must be a GtkWidget or None");
- return NULL;
- }
- if (pygobject_check(py_pmi, &PyGtkWidget_Type))
- pmi = GTK_WIDGET(py_pmi->obj);
- else if ((PyObject *)py_pmi != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "parent_menu_item must be a GtkWidget or None");
- return NULL;
- }
- if (!PyCallable_Check(func) && func != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "func must be a callable object or None");
- return NULL;
- }
- if (PyLong_Check(pytime)) {
- time = PyLong_AsUnsignedLong(pytime);
- if (PyErr_Occurred())
- return NULL;
- } else if (PyInt_Check(pytime)) {
- time = PyInt_AsLong(pytime);
- } else {
- PyErr_SetString(PyExc_TypeError,
- "last argument must be int or long");
- return NULL;
- }
-
- /* this is an ugly hack to avoid leaking memory and references
- gtk_menu_popup should use a data destroy function */
- if (menu->position_func == pygtk_menu_position) {
- cunote = menu->position_func_data;
- Py_DECREF(cunote->func);
- Py_XDECREF(cunote->data);
- g_free(cunote);
- }
- if (func != Py_None) {
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = func;
- cunote->data = data;
- Py_INCREF(func);
- Py_XINCREF(data);
- gtk_menu_popup(GTK_MENU(self->obj), pms, pmi,
- (GtkMenuPositionFunc)pygtk_menu_position,
- cunote, button, time);
- } else
- gtk_menu_popup(GTK_MENU(self->obj), pms, pmi, NULL,NULL, button,time);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_pixmap_get noargs
-static PyObject *
-_wrap_gtk_pixmap_get(PyGObject *self)
-{
- GdkPixmap *pixmap;
- GdkBitmap *mask;
-
- gtk_pixmap_get(GTK_PIXMAP(self->obj), &pixmap, &mask);
- return Py_BuildValue("(NN)", pygobject_new((GObject *)pixmap),
- pygobject_new((GObject *)mask));
-}
-
-%%
-override gtk_button_new kwargs
-static int
-_wrap_gtk_button_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "label", "stock", "use_underline", NULL };
- gchar *text = NULL, *stock = NULL;
- PyObject *py_use_underline = Py_True;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|zzO:OGtkButton.__init__",
- kwlist, &text, &stock, &py_use_underline))
- return -1;
- if (stock)
- pygobject_construct(self,
- "label", stock, "use-stock", TRUE,
- "use-underline", TRUE, NULL);
- else if (text)
- pygobject_construct(self,
- "label", text, "use-underline",
- PyObject_IsTrue(py_use_underline), NULL);
- else
- pygobject_construct(self, NULL);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError, "could not create GtkButton object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_BUTTON
-%%
-override gtk_button_get_alignment noargs
-static PyObject *
-_wrap_gtk_button_get_alignment(PyGObject *self)
-{
- gfloat xalign, yalign;
-
- gtk_button_get_alignment(GTK_BUTTON(self->obj), &xalign, &yalign);
- return Py_BuildValue("(ff)", xalign, yalign);
-}
-%%
-override gtk_button_box_get_child_size noargs
-static PyObject *
-_wrap_gtk_button_box_get_child_size(PyGObject *self)
-{
- gint min_width;
- gint min_height;
-
- if (PyErr_Warn(PyExc_DeprecationWarning, "don't use this") < 0)
- return NULL;
- gtk_button_box_get_child_size(GTK_BUTTON_BOX(self->obj), &min_width, &min_height);
- return Py_BuildValue("(ii)", min_width, min_height);
-}
-%%
-override gtk_button_box_get_child_ipadding noargs
-static PyObject *
-_wrap_gtk_button_box_get_child_ipadding(PyGObject *self)
-{
- gint ipad_x;
- gint ipad_y;
-
- if (PyErr_Warn(PyExc_DeprecationWarning, "don't use this") < 0)
- return NULL;
- gtk_button_box_get_child_ipadding(GTK_BUTTON_BOX(self->obj), &ipad_x, &ipad_y);
- return Py_BuildValue("(ii)", ipad_x, ipad_y);
-}
-%%
-override gtk_toggle_button_new kwargs
-static int
-_wrap_gtk_toggle_button_new(PyGObject *self, PyObject*args, PyObject*kwargs)
-{
- static char *kwlist[] = { "label", "use_underline", NULL };
- gchar *text = NULL;
- PyObject *py_use_underline = Py_True;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|zO):GtkToggleButton.__init__", kwlist,
- &text, &py_use_underline))
- return -1;
- if (text)
- pygobject_construct(self,
- "label", text, "use-underline",
- PyObject_IsTrue(py_use_underline), NULL);
- else
- pygobject_construct(self, NULL);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkToggleButton object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_TOGGLE_BUTTON
-%%
-override gtk_check_button_new kwargs
-static int
-_wrap_gtk_check_button_new(PyGObject *self, PyObject *args, PyObject*kwargs)
-{
- static char *kwlist[] = { "label", "use_underline", NULL };
- gchar *text = NULL;
- PyObject *py_use_underline = Py_True;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,"|zO:GtkCheckButton.__init__",
- kwlist, &text, &py_use_underline))
- return -1;
- if (text)
- pygobject_construct(self,
- "label", text, "use-underline",
- PyObject_IsTrue(py_use_underline), NULL);
- else
- pygobject_construct(self, NULL);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkCheckButton object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_CHECK_BUTTON
-%%
-override gtk_radio_button_new kwargs
-static int
-_wrap_gtk_radio_button_new(PyGObject *self, PyObject *args, PyObject*kwargs)
-{
- static char *kwlist[] = { "group", "label", "use_underline", NULL };
- PyObject *py_group = Py_None;
- gchar *label = NULL;
- GtkRadioButton *group;
- PyObject *py_use_underline = Py_True;
-
- if (!PyArg_ParseTupleAndKeywords(args,kwargs,"|OzO:GtkRadioButton.__init__",
- kwlist, &py_group, &label,
- &py_use_underline))
- return -1;
- if (py_group == Py_None)
- group = NULL;
- else if (pygobject_check(py_group, &PyGtkRadioButton_Type))
- group = GTK_RADIO_BUTTON(pygobject_get(py_group));
- else {
- PyErr_SetString(PyExc_TypeError,
- "first argument must be a GtkRadioButton or None");
- return -1;
- }
- /* various configs for create radio buttons ... */
- if (label == NULL) {
- if (group == NULL)
- pygobject_construct(self, NULL);
- else
- pygobject_construct(self, "group", group, NULL);
- } else {
- if (group == NULL)
- pygobject_construct(self,
- "label", label, "use-underline",
- PyObject_IsTrue(py_use_underline), NULL);
- else
- pygobject_construct(self,
- "label", label, "group", group,
- "use-underline",
- PyObject_IsTrue(py_use_underline), NULL);
- }
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError, "could not create GtkRadioButton object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_RADIO_BUTTON
-%%
-override gtk_radio_button_get_group noargs
-static PyObject *
-_wrap_gtk_radio_button_get_group(PyGObject *self) {
- PyObject *py_list;
- GSList *list, *tmp;
- PyObject *gtk_obj;
-
- list = gtk_radio_button_get_group(GTK_RADIO_BUTTON(self->obj));
-
- if ((py_list = PyList_New(0)) == NULL) {
- return NULL;
- }
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- gtk_obj = pygobject_new(G_OBJECT(tmp->data));
- if (gtk_obj == NULL) {
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_Append(py_list, gtk_obj);
- Py_DECREF(gtk_obj);
- }
- return py_list;
-}
-%%
-override gtk_list_item_new kwargs
-static int
-_wrap_gtk_list_item_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "label", NULL };
- gchar *text = NULL;
-
- if (PyErr_Warn(PyExc_DeprecationWarning, "use gtk.TreeView") < 0)
- return -1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|z:GtkListItem.__init__",
- kwlist, &text))
- return -1;
- if (text)
- self->obj = (GObject *)gtk_list_item_new_with_label(text);
- else
- self->obj = (GObject *)gtk_list_item_new();
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError, "could not create GtkListItem object");
- return -1;
- }
- pygobject_register_wrapper((PyObject *)self);
- return 0;
-}
-%%
-override gtk_menu_item_new kwargs
-static int
-_wrap_gtk_menu_item_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "label", "use_underline", NULL };
- gchar *text = NULL;
- PyObject *py_use_underline = Py_True;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|zO:GtkMenuItem.__init__",
- kwlist, &text, &py_use_underline))
- return -1;
- pygobject_construct(self, NULL);
- if (text) {
- GtkWidget *accel_label;
- accel_label = g_object_new(GTK_TYPE_ACCEL_LABEL, NULL);
- gtk_misc_set_alignment(GTK_MISC(accel_label), 0.0, 0.5);
- gtk_container_add(GTK_CONTAINER(self->obj), accel_label);
- if (PyObject_IsTrue(py_use_underline))
- gtk_label_set_text_with_mnemonic(GTK_LABEL(accel_label), text);
- else
- gtk_label_set_text(GTK_LABEL(accel_label), text);
- gtk_accel_label_set_accel_widget(GTK_ACCEL_LABEL(accel_label),
- GTK_WIDGET(self->obj));
- gtk_widget_show(accel_label);
- }
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkMenuItem object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_MENU_ITEM
-%%
-override gtk_menu_attach_to_widget kwargs
-static void
-pygtk_menu_detach (GtkWidget *attach_widget, GtkMenu *menu)
-{
- PyGILState_STATE state;
- PyObject *func;
- PyObject *ret;
-
- func = g_object_get_data (G_OBJECT (menu), "pygtk_menu_detach_func");
-
- if (!func)
- return;
-
- state = pyg_gil_state_ensure();
-
- ret = PyObject_CallFunction (func, "OO",
- pygobject_new ((GObject *) menu),
- pygobject_new ((GObject *) attach_widget));
- if (ret == NULL) {
- PyErr_Print ();
- Py_XDECREF (ret);
- }
- else
- Py_DECREF (ret);
-
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_menu_attach_to_widget (PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "attach_widget", "detach_func", NULL };
- PyGObject *py_attach_widget;
- PyObject *detach_func;
- GtkWidget *attach_widget;
-
- if (!PyArg_ParseTupleAndKeywords (args, kwargs,
- "O!O:GtkMenu.attach_to_widget",
- kwlist, &PyGtkWidget_Type,
- &py_attach_widget, &detach_func))
- return NULL;
-
- attach_widget = GTK_WIDGET (py_attach_widget->obj);
-
- if (!PyCallable_Check (detach_func) && detach_func != Py_None) {
- PyErr_SetString (PyExc_TypeError, "second argument not callable");
- return NULL;
- }
-
- if (detach_func != Py_None) {
- Py_INCREF (detach_func);
- g_object_set_data_full (self->obj,
- "pygtk_menu_detach_func",
- detach_func,
- pyg_destroy_notify);
- }
- else
- g_object_set_data (self->obj, "pygtk_menu_detach_func", NULL);
-
- gtk_menu_attach_to_widget (GTK_MENU (self->obj), attach_widget,
- (GtkMenuDetachFunc) pygtk_menu_detach);
-
- Py_INCREF (Py_None);
- return Py_None;
-}
-%%
-override gtk_check_menu_item_new kwargs
-static int
-_wrap_gtk_check_menu_item_new(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "label", "use_underline", NULL };
- gchar *text = NULL;
- PyObject *py_use_underline = Py_True;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|zO:GtkCheckMenuItem.__init__", kwlist,
- &text, &py_use_underline))
- return -1;
- pygobject_construct(self, NULL);
- if (text) {
- GtkWidget *accel_label;
- accel_label = g_object_new(GTK_TYPE_ACCEL_LABEL, NULL);
- gtk_misc_set_alignment(GTK_MISC(accel_label), 0.0, 0.5);
- gtk_container_add(GTK_CONTAINER(self->obj), accel_label);
- if (PyObject_IsTrue(py_use_underline))
- gtk_label_set_text_with_mnemonic(GTK_LABEL(accel_label), text);
- else
- gtk_label_set_text(GTK_LABEL(accel_label), text);
- gtk_accel_label_set_accel_widget(GTK_ACCEL_LABEL(accel_label),
- GTK_WIDGET(self->obj));
- gtk_widget_show(accel_label);
- }
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkCheckMenuItem object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_CHECK_MENU_ITEM
-%%
-override gtk_radio_menu_item_new kwargs
-static int
-_wrap_gtk_radio_menu_item_new(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "group", "label", "use_underline", NULL };
- gchar *text = NULL;
- PyObject *py_group = Py_None;
- GtkRadioMenuItem *group;
- PyObject *py_use_underline = Py_True;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|OzO:GtkRadioMenuItem.__init__", kwlist,
- &py_group, &text, &py_use_underline))
- return -1;
- if (py_group == Py_None)
- group = NULL;
- else if (pygobject_check(py_group, &PyGtkRadioMenuItem_Type))
- group = GTK_RADIO_MENU_ITEM(pygobject_get(py_group));
- else {
- PyErr_SetString(PyExc_TypeError,
- "first argument must be a GtkRadioMenuItem or None");
- return -1;
- }
-
- pygobject_construct(self, NULL);
-
- if (text) {
- GtkWidget *accel_label;
- accel_label = g_object_new(GTK_TYPE_ACCEL_LABEL, NULL);
- gtk_misc_set_alignment(GTK_MISC(accel_label), 0.0, 0.5);
- gtk_container_add(GTK_CONTAINER(self->obj), accel_label);
- if (PyObject_IsTrue(py_use_underline))
- gtk_label_set_text_with_mnemonic(GTK_LABEL(accel_label), text);
- else
- gtk_label_set_text(GTK_LABEL(accel_label), text);
- gtk_accel_label_set_accel_widget(GTK_ACCEL_LABEL(accel_label),
- GTK_WIDGET(self->obj));
- gtk_widget_show(accel_label);
- }
- if (group)
- gtk_radio_menu_item_set_group(GTK_RADIO_MENU_ITEM(self->obj),
- gtk_radio_menu_item_get_group(group));
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkRadioMenuItem object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_RADIO_MENU_ITEM
-%%
-override gtk_image_menu_item_new kwargs
-static int
-_wrap_gtk_image_menu_item_new(PyGObject *self, PyObject *args,PyObject *kwargs)
-{
- static char *kwlist[] = { "stock_id", "accel_group", NULL };
- gchar *stock_id = NULL;
- PyObject *py_accel_group = Py_None;
- GtkAccelGroup *accel_group= NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|zO:GtkImageMenuItem.__init__",kwlist,
- &stock_id, &py_accel_group))
- return -1;
- if (pygobject_check(py_accel_group, &PyGtkAccelGroup_Type))
- accel_group = GTK_ACCEL_GROUP(pygobject_get(py_accel_group));
-
- if (stock_id)
- self->obj = (GObject *)gtk_image_menu_item_new_from_stock(stock_id,
- accel_group);
- else
- self->obj = (GObject *)gtk_image_menu_item_new();
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError, "could not create GtkImageMenuItem object");
- return -1;
- }
-
- if (pyg_type_from_object((PyObject *) self) != GTK_TYPE_IMAGE_MENU_ITEM) {
- PyErr_SetString(PyExc_RuntimeError, "__gobject_init__ must be used "
- "when subclassing gtk.ImageMenuItem");
- return -1;
- }
-
- pygobject_register_wrapper((PyObject *)self);
- return 0;
-}
-%%
-override-slot GtkRequisition.tp_as_sequence
-static Py_ssize_t
-_wrap_gtk_requisition_length(PyGBoxed *self)
-{
- return 2;
-}
-static PyObject *
-_wrap_gtk_requisition_getitem(PyGBoxed *self, Py_ssize_t pos)
-{
- GtkRequisition *requisition;
-
- if (pos < 0) pos += 2;
- if (pos < 0 || pos >= 2) {
- PyErr_SetString(PyExc_IndexError, "index out of range");
- return NULL;
- }
- requisition = pyg_boxed_get(self, GtkRequisition);
- switch (pos) {
- case 0: return PyInt_FromLong(requisition->width);
- case 1: return PyInt_FromLong(requisition->height);
- default:
- g_assert_not_reached();
- return NULL;
- }
-}
-static int
-_wrap_gtk_requisition_setitem(PyGBoxed *self, Py_ssize_t pos, PyObject *value)
-{
- GtkRequisition *requisition;
- gint val;
-
- if (pos < 0) pos += 2;
- if (pos < 0 || pos >= 2) {
- PyErr_SetString(PyExc_IndexError, "index out of range");
- return -1;
- }
- requisition = pyg_boxed_get(self, GtkRequisition);
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- switch(pos) {
- case 0: requisition->width = val; break;
- case 1: requisition->height = val; break;
- default:
- g_assert_not_reached();
- return -1;
- }
- return 0;
-}
-static PySequenceMethods _wrap_gtk_requisition_tp_as_sequence = {
- (lenfunc)_wrap_gtk_requisition_length,
- 0,
- 0,
- (ssizeargfunc)_wrap_gtk_requisition_getitem,
- 0,
- (ssizeobjargproc)_wrap_gtk_requisition_setitem,
- 0,
-};
-%%
-override-attr GtkRequisition.width
-static int
-_wrap_gtk_requisition__set_width(PyGBoxed *self, PyObject *value, void *closure)
-{
- gint val;
-
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- pyg_boxed_get(self, GtkRequisition)->width = val;
- return 0;
-}
-%%
-override-attr GtkRequisition.height
-static int
-_wrap_gtk_requisition__set_height(PyGBoxed *self, PyObject *value, void *closure)
-{
- gint val;
-
- val = PyInt_AsLong(value);
- if (PyErr_Occurred())
- return -1;
- pyg_boxed_get(self, GtkRequisition)->height = val;
- return 0;
-}
-%%
-override gtk_notebook_query_tab_label_packing kwargs
-static PyObject *
-_wrap_gtk_notebook_query_tab_label_packing(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "child", NULL };
- PyGObject *child;
- gboolean expand, fill;
- GtkPackType pack_type;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkNotebook.query_tab_label_packing",
- kwlist, &child))
- return NULL;
- if (!pygobject_check(child, &PyGtkWidget_Type)) {
- PyErr_SetString(PyExc_TypeError, "child must be a GtkWidget");
- return NULL;
- }
- gtk_notebook_query_tab_label_packing(GTK_NOTEBOOK(self->obj),
- GTK_WIDGET(child->obj),
- &expand, &fill, &pack_type);
- return Py_BuildValue("(iiN)", expand, fill,
- pyg_enum_from_gtype(GTK_TYPE_PACK_TYPE, pack_type));
-}
-%%
-override gtk_list_insert_items kwargs
-static PyObject *
-_wrap_gtk_list_insert_items(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "items", "position", NULL };
- PyObject *py_items;
- GList *items = NULL;
- int position, len, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!i:GtkList.insert_items",
- kwlist, &PyList_Type, &py_items,
- &position))
- return NULL;
- len = PyList_Size(py_items);
- for (i = 0; i < len; i++) {
- PyObject *item = PyList_GetItem(py_items, i);
- if (!pygobject_check(item, &PyGtkListItem_Type)) {
- PyErr_SetString(PyExc_TypeError, "list item not a GtkListItem");
- g_list_free(items);
- return NULL;
- }
- items = g_list_append(items, pygobject_get(item));
- }
- gtk_list_insert_items(GTK_LIST(self->obj), items, position);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_list_append_items kwargs
-static PyObject *
-_wrap_gtk_list_append_items(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "items", NULL };
- PyObject *py_items;
- GList *items = NULL;
- int len, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!:GtkList.append_items",
- kwlist, &PyList_Type, &py_items))
- return NULL;
- len = PyList_Size(py_items);
- for (i = 0; i < len; i++) {
- PyObject *item = PyList_GetItem(py_items, i);
- if (!pygobject_check(item, &PyGtkListItem_Type)) {
- PyErr_SetString(PyExc_TypeError, "list item not a GtkListItem");
- g_list_free(items);
- return NULL;
- }
- items = g_list_append(items, pygobject_get(item));
- }
- gtk_list_append_items(GTK_LIST(self->obj), items);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_list_prepend_items kwargs
-static PyObject *
-_wrap_gtk_list_prepend_items(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "items", NULL };
- PyObject *py_items;
- GList *items = NULL;
- int len, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!:GtkList.preppend_items",
- kwlist, &PyList_Type, &py_items))
- return NULL;
- len = PyList_Size(py_items);
- for (i = 0; i < len; i++) {
- PyObject *item = PyList_GetItem(py_items, i);
- if (!pygobject_check(item, &PyGtkListItem_Type)) {
- PyErr_SetString(PyExc_TypeError, "list item not a GtkListItem");
- g_list_free(items);
- return NULL;
- }
- items = g_list_append(items, pygobject_get(item));
- }
- gtk_list_prepend_items(GTK_LIST(self->obj), items);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_list_remove_items kwargs
-static PyObject *
-_wrap_gtk_list_remove_items(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "items", NULL };
- PyObject *py_items;
- GList *items = NULL;
- int len, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!:GtkList.remove_items",
- kwlist, &PyList_Type, &py_items))
- return NULL;
- len = PyList_Size(py_items);
- for (i = 0; i < len; i++) {
- PyObject *item = PyList_GetItem(py_items, i);
- if (!pygobject_check(item, &PyGtkListItem_Type)) {
- PyErr_SetString(PyExc_TypeError, "list item not a GtkListItem");
- g_list_free(items);
- return NULL;
- }
- items = g_list_append(items, pygobject_get(item));
- }
- gtk_list_remove_items(GTK_LIST(self->obj), items);
- g_list_free(items);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override-attr GtkList.selection
-static PyObject *
-_wrap_gtk_list__get_selection(PyGObject *self, void *closure)
-{
- GList *selection;
- PyObject *item, *ret = PyList_New(0);
-
- if (ret == NULL)
- return NULL;
-
- for (selection = GTK_LIST(self->obj)->selection; selection != NULL;
- selection = selection->next) {
- item = pygobject_new((GObject *) GTK_LIST_ITEM(selection->data));
-
- if (!item) {
- Py_DECREF(ret);
- return NULL;
- }
-
- PyList_Append(ret, item);
- Py_DECREF(item);
- }
- return ret;
-}
-%%
-override gtk_list_get_selection noargs
-static PyObject *
-_wrap_gtk_list__get_selection(PyGObject *self, void *closure);
-static PyObject *
-_wrap_gtk_list_get_selection(PyGObject *self)
-{
- return _wrap_gtk_list__get_selection(self, NULL);
-}
-%%
-override gtk_color_selection_get_current_color noargs
-static PyObject *
-_wrap_gtk_color_selection_get_current_color(PyGObject *self)
-{
- GdkColor colour = { 0, };
-
- gtk_color_selection_get_current_color(GTK_COLOR_SELECTION(self->obj),
- &colour);
- return pyg_boxed_new(GDK_TYPE_COLOR, &colour, TRUE, TRUE);
-}
-%%
-override gtk_color_selection_get_previous_color noargs
-static PyObject *
-_wrap_gtk_color_selection_get_previous_color(PyGObject *self)
-{
- GdkColor colour = { 0, };
-
- gtk_color_selection_get_previous_color(GTK_COLOR_SELECTION(self->obj),
- &colour);
- return pyg_boxed_new(GDK_TYPE_COLOR, &colour, TRUE, TRUE);
-}
-%%
-override gtk_calendar_get_date noargs
-static PyObject *
-_wrap_gtk_calendar_get_date(PyGObject *self)
-{
- guint year, month, day;
-
- gtk_calendar_get_date(GTK_CALENDAR(self->obj), &year, &month, &day);
- return Py_BuildValue("(iii)", year, month, day);
-}
-%%
-override gtk_drag_dest_set kwargs
-static PyObject *
-_wrap_gtk_drag_dest_set(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "flags", "targets", "actions", NULL };
- PyObject *py_flags, *py_targets, *py_actions;
- GtkDestDefaults flags;
- GtkTargetEntry *targets;
- GdkDragAction actions;
- gint n_targets, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOO:GtkWidget.drag_dest_set", kwlist,
- &py_flags, &py_targets, &py_actions))
- return NULL;
- if (pyg_flags_get_value(GTK_TYPE_DEST_DEFAULTS, py_flags, (gint *)&flags))
- return NULL;
- if (pyg_flags_get_value(GDK_TYPE_DRAG_ACTION,
- py_actions, (gint *)&actions))
- return NULL;
- if (!PySequence_Check(py_targets)) {
- PyErr_SetString(PyExc_TypeError, "targets must be a sequence");
- return NULL;
- }
- n_targets = PySequence_Length(py_targets);
- targets = g_new(GtkTargetEntry, n_targets);
- for (i = 0; i < n_targets; i++) {
- PyObject *item = PySequence_GetItem(py_targets, i);
- Py_DECREF(item);
- if (!PyArg_ParseTuple(item, "sii", &targets[i].target,
- &targets[i].flags, &targets[i].info)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "list items should be of form (string,int,int)");
- g_free(targets);
- return NULL;
- }
- }
- gtk_drag_dest_set(GTK_WIDGET(self->obj), flags, targets, n_targets,
- actions);
- g_free(targets);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_drag_dest_find_target kwargs
-static PyObject *
-_wrap_gtk_drag_dest_find_target(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "context", "target_list", NULL };
- PyObject *context, *py_targets;
- GtkTargetList *target_list;
- GdkAtom atom;
- gchar *name;
- PyObject *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!O:GtkWidget.drag_dest_find_target",
- kwlist, &PyGdkDragContext_Type, &context,
- &py_targets))
- return NULL;
-
- if (!(target_list = pygtk_target_list_from_sequence(py_targets)))
- return NULL;
-
- atom = gtk_drag_dest_find_target(GTK_WIDGET(self->obj),
- GDK_DRAG_CONTEXT(pygobject_get(context)),
- target_list);
- gtk_target_list_unref(target_list);
-
- name = gdk_atom_name(atom);
- ret = PyString_FromString(name);
- g_free(name);
- return ret;
-}
-%%
-override gtk_drag_dest_get_target_list noargs
-static PyObject *
-_wrap_gtk_drag_dest_get_target_list(PyGObject *self)
-{
- GtkTargetList *target_list;
-
- target_list = gtk_drag_dest_get_target_list(GTK_WIDGET(self->obj));
-
- if (!target_list) {
- Py_INCREF(Py_None);
- return Py_None;
- }
-
- return pygtk_target_list_to_list(target_list);
-}
-%%
-override gtk_drag_dest_set_target_list kwargs
-static PyObject *
-_wrap_gtk_drag_dest_set_target_list(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "target_list", NULL };
- PyObject *py_targets;
- GtkTargetList *target_list;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkWidget.drag_dest_set_target_list",
- kwlist, &py_targets))
- return NULL;
-
- if (!(target_list = pygtk_target_list_from_sequence(py_targets)))
- return NULL;
-
- gtk_drag_dest_set_target_list(GTK_WIDGET(self->obj), target_list);
- gtk_target_list_unref(target_list);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_drag_source_set kwargs
-static PyObject *
-_wrap_gtk_drag_source_set(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "start_button_mask", "targets", "actions", NULL };
- PyObject *py_sbmask, *py_targets, *py_actions;
- GdkModifierType sbmask;
- GtkTargetEntry *targets;
- GdkDragAction actions;
- gint n_targets, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOO:GtkWidget.drag_source_set", kwlist,
- &py_sbmask, &py_targets, &py_actions))
- return NULL;
- if (pyg_flags_get_value(GDK_TYPE_MODIFIER_TYPE,
- py_sbmask, (gint *)&sbmask))
- return NULL;
- if (pyg_flags_get_value(GDK_TYPE_DRAG_ACTION,
- py_actions, (gint *)&actions))
- return NULL;
- if (!(py_targets = PySequence_Fast(py_targets, "targets must be a sequence")))
- return NULL;
- n_targets = PySequence_Fast_GET_SIZE(py_targets);
- targets = g_new(GtkTargetEntry, n_targets);
- for (i = 0; i < n_targets; i++) {
- PyObject *item = PySequence_Fast_GET_ITEM(py_targets, i);
- if (!PyArg_ParseTuple(item, "sii", &targets[i].target,
- &targets[i].flags, &targets[i].info)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "list items should be of form (string,int,int)");
- g_free(targets);
- Py_DECREF(py_targets);
- return NULL;
- }
- }
- gtk_drag_source_set(GTK_WIDGET(self->obj), sbmask, targets, n_targets,
- actions);
- g_free(targets);
- Py_DECREF(py_targets);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_drag_begin kwargs
-static PyObject *
-_wrap_gtk_drag_begin(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "targets", "actions", "button", "event", NULL };
- PyObject *py_targets, *py_actions, *event;
- GtkTargetList *targets;
- GdkDragAction actions;
- gint button;
- GdkDragContext *context;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOiO:GtkWidget.drag_begin", kwlist,
- &py_targets, &py_actions, &button,
- &event))
- return NULL;
- if (pyg_flags_get_value(GDK_TYPE_DRAG_ACTION,
- py_actions, (gint *)&actions))
- return NULL;
- if (!pyg_boxed_check(event, GDK_TYPE_EVENT)) {
- PyErr_SetString(PyExc_TypeError, "event must be a GdkEvent");
- return NULL;
- }
- if (!(targets = pygtk_target_list_from_sequence(py_targets)))
- return NULL;
-
- context = gtk_drag_begin(GTK_WIDGET(self->obj), targets, actions, button,
- pyg_boxed_get(event, GdkEvent));
- gtk_target_list_unref(targets);
- return pygobject_new((GObject *)context);
-}
-%%
-override gtk_selection_add_targets kwargs
-static PyObject *
-_wrap_gtk_selection_add_targets(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "selection", "targets", NULL };
- PyObject *py_targets, *py_selection;
- GtkTargetEntry *targets;
- GdkAtom selection;
- int n_targets, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO:GtkWidget.selection_add_targets",
- kwlist, &py_selection, &py_targets))
- return NULL;
- selection = pygdk_atom_from_pyobject(py_selection);
- if (PyErr_Occurred())
- return NULL;
-
- if (!(py_targets = PySequence_Fast(py_targets, "targets must be a sequence")))
- return NULL;
- n_targets = PySequence_Fast_GET_SIZE(py_targets);
- targets = g_new(GtkTargetEntry, n_targets);
- for (i = 0; i < n_targets; i++) {
- PyObject *item = PySequence_Fast_GET_ITEM(py_targets, i);
- if (!PyArg_ParseTuple(item, "sii", &targets[i].target,
- &targets[i].flags, &targets[i].info)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "list items should be of form (string,int,int)");
- g_free(targets);
- Py_DECREF(py_targets);
- return NULL;
- }
- }
- gtk_selection_add_targets(GTK_WIDGET(self->obj), selection,
- targets, n_targets);
- g_free(targets);
- Py_DECREF(py_targets);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_text_child_anchor_get_widgets noargs
-static PyObject *
-_wrap_gtk_text_child_anchor_get_widgets(PyGObject *self)
-{
- GList *list, *tmp;
- PyObject *ret;
-
- list = gtk_text_child_anchor_get_widgets(GTK_TEXT_CHILD_ANCHOR(self->obj));
-
- ret = PyList_New(0);
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- GtkWidget *widget = tmp->data;
- PyObject *item = pygobject_new((GObject *)widget);
-
- PyList_Append(ret, item);
- Py_DECREF(item);
- }
- g_list_free(list);
- return ret;
-}
-%%
-override gtk_dialog_new_with_buttons kwargs
-static int
-_wrap_gtk_dialog_new_with_buttons(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- gchar *title = NULL;
- PyGObject *py_window = NULL;
- PyObject *py_flags = NULL, *py_buttons = Py_None;
- GtkDialogFlags flags = 0;
- int len, i;
- GtkWindow *parent;
-
- static char *kwlist[] = { "title", "parent", "flags", "buttons", NULL };
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|zOOO:GtkDialog.__init__", kwlist,
- &title, &py_window, &py_flags,
- &py_buttons))
- return -1;
-
- if (py_window == NULL || (PyObject*)py_window == Py_None)
- parent = NULL;
- else if (pygobject_check(py_window, &PyGtkWindow_Type))
- parent = GTK_WINDOW(py_window->obj);
- else {
- PyErr_SetString(PyExc_TypeError, "parent must be a GtkWindow or None");
- return -1;
- }
-
- if (pyg_flags_get_value(GTK_TYPE_DIALOG_FLAGS, py_flags, (gint *)&flags))
- return -1;
- if (py_buttons == Py_None)
- len = 0;
- else if (PyTuple_Check(py_buttons))
- len = PyTuple_Size(py_buttons);
- else {
- PyErr_SetString(PyExc_TypeError, "buttons must be a tuple containing text/response pairs or None");
- return -1;
- }
-
- if (len % 2) {
- PyErr_SetString(PyExc_RuntimeError,
- "buttons tuple must contain text/response id pairs");
- return -1;
- }
-
- if (pygobject_constructv(self, 0, NULL)) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkDialog object");
- return -1;
- }
-
- if (title)
- gtk_window_set_title (GTK_WINDOW (self->obj), title);
-
- if (parent)
- gtk_window_set_transient_for (GTK_WINDOW (self->obj), parent);
-
- if (flags & GTK_DIALOG_MODAL)
- gtk_window_set_modal (GTK_WINDOW (self->obj), TRUE);
-
- if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
- gtk_window_set_destroy_with_parent (GTK_WINDOW (self->obj), TRUE);
-
- if (flags & GTK_DIALOG_NO_SEPARATOR)
- gtk_dialog_set_has_separator (GTK_DIALOG (self->obj), FALSE);
-
- for (i = 0; i < len; i += 2) {
- PyObject *text = PyTuple_GetItem(py_buttons, i);
- PyObject *id = PyTuple_GetItem(py_buttons, i + 1);
- if (!PyString_Check(text)) {
- gtk_object_destroy(GTK_OBJECT(self->obj));
- self->obj = NULL;
- PyErr_SetString(PyExc_RuntimeError,
- "first member of each text/response id pair "
- "must be a string");
- return -1;
- }
- if (!PyInt_Check(id)) {
- gtk_object_destroy(GTK_OBJECT(self->obj));
- self->obj = NULL;
- PyErr_SetString(PyExc_RuntimeError,
- "second member of each text/response id pair "
- "must be a number");
- return -1;
- }
- gtk_dialog_add_button(GTK_DIALOG(self->obj), PyString_AsString(text),
- PyInt_AsLong(id));
- }
-
- return 0;
-}
-%%
-new-constructor GTK_TYPE_DIALOG
-%%
-override gtk_dialog_run noargs
-static PyObject *
-_wrap_gtk_dialog_run(PyGObject *self)
-{
- gint retval;
-
- pyg_begin_allow_threads;
- retval = gtk_dialog_run(GTK_DIALOG(self->obj));
- pyg_end_allow_threads;
- return PyInt_FromLong(retval);
-}
-%%
-override gtk_dialog_add_buttons
-static PyObject *
-_wrap_gtk_dialog_add_buttons(PyGObject *self, PyObject *args)
-{
- GtkDialog *dialog;
- int i, len;
-
- dialog = GTK_DIALOG(self->obj);
-
- len = PyTuple_Size(args);
- if (len % 2 != 0) {
- PyErr_SetString(PyExc_TypeError,
- "must pass an even number of arguments");
- return NULL;
- }
-
- for (i = 0; i < len; i+= 2) {
- PyObject *curr_args = PyTuple_GetSlice(args, i, i + 2);
- gchar *text;
- gint response_id;
-
- if (!PyArg_ParseTuple(curr_args, "si", &text, &response_id))
- return NULL;
-
- gtk_dialog_add_button(dialog, text, response_id);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-init
-#if GTK_CHECK_VERSION(2, 9, 0)
- pyg_set_object_has_new_constructor(GTK_TYPE_MESSAGE_DIALOG);
-#endif
-%%
-override gtk_message_dialog_new kwargs
-static int
-_wrap_gtk_message_dialog_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- GtkButtonsType buttons = GTK_BUTTONS_NONE;
- static char *kwlist[] = { "parent", "flags", "type", "buttons", "message_format", NULL };
- PyObject *py_flags = NULL, *py_type = NULL, *py_buttons = NULL;
- GtkDialogFlags flags = 0;
- GtkWindow *parent = NULL;
- GtkMessageType type = GTK_MESSAGE_INFO;
- PyGObject *py_parent = NULL;
- char *message_format = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|OOOOz:GtkMessageDialog.__init__", kwlist, &py_parent, &py_flags, &py_type, &py_buttons, &message_format))
- return -1;
- if ((PyObject *)py_parent == Py_None)
- parent = NULL;
- else if (py_parent && pygobject_check(py_parent, &PyGtkWindow_Type))
- parent = GTK_WINDOW(py_parent->obj);
- else if (py_parent) {
- PyErr_SetString(PyExc_TypeError, "parent should be a GtkWindow or None");
- return -1;
- }
- if (pyg_flags_get_value(GTK_TYPE_DIALOG_FLAGS, py_flags, (gint *)&flags))
- return -1;
- if (pyg_enum_get_value(GTK_TYPE_MESSAGE_TYPE, py_type, (gint *)&type))
- return -1;
- if (pyg_enum_get_value(GTK_TYPE_BUTTONS_TYPE, py_buttons, (gint *)&buttons))
- return -1;
-
-#if GTK_CHECK_VERSION(2, 9, 0)
-
- if (flags & GTK_DIALOG_NO_SEPARATOR)
- g_warning("The gtk.DIALOG_NO_SEPARATOR flag cannot be used for gtk.MessageDialog");
-
- pygobject_construct(self, "buttons", buttons,
- "message-type", type,
- (message_format? "text" : NULL), message_format,
- NULL);
- if (parent != NULL)
- gtk_window_set_transient_for(GTK_WINDOW(self->obj), parent);
-
- if (flags & GTK_DIALOG_MODAL)
- gtk_window_set_modal(GTK_WINDOW(self->obj), TRUE);
-
- if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
- gtk_window_set_destroy_with_parent(GTK_WINDOW(self->obj), TRUE);
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkMessageDialog object");
- return -1;
- }
-
- g_object_ref(self->obj); /* we don't own the first reference of windows */
-
-#else
-
- /* Note: with older API (< 2.10), it is impossible to
- * construct a GtkMessageDialog through g_object_new(), because
- * there is no 'message' property and the label field is
- * private */
- if (message_format)
- self->obj = (GObject *)gtk_message_dialog_new(parent, flags, type,
- buttons, "%s",
- message_format);
- else
- self->obj = (GObject *)gtk_message_dialog_new(parent, flags, type,
- buttons, message_format);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkMessageDialog object");
- return -1;
- }
-
- g_object_ref(self->obj); /* we don't own the first reference of windows */
-
- if (pyg_type_from_object((PyObject *) self) != GTK_TYPE_MESSAGE_DIALOG) {
- PyErr_SetString(PyExc_RuntimeError, "__gobject_init__ must be used "
- "when subclassing gtk.MessageDialog");
- return -1;
- }
-
- pygobject_register_wrapper((PyObject *)self);
-
-#endif
- return 0;
-}
-%%
-override gtk_progress_bar_new_with_adjustment kwargs
-static int
-_wrap_gtk_progress_bar_new_with_adjustment(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- GtkAdjustment *adjustment = NULL;
- static char *kwlist[] = { "adjustment", NULL };
- PyGObject *py_adjustment = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O:GtkProgressBar.__init__", kwlist, &py_adjustment))
- return -1;
- if ((PyObject *)py_adjustment == Py_None)
- adjustment = NULL;
- else if (py_adjustment && pygobject_check(py_adjustment, &PyGtkAdjustment_Type))
- adjustment = GTK_ADJUSTMENT(py_adjustment->obj);
- else if (py_adjustment) {
- PyErr_SetString(PyExc_TypeError, "adjustment should be a GtkAdjustment or None");
- return -1;
- }
-
-
- if (adjustment)
- pygobject_construct(self, "adjustment", adjustment, NULL);
- else
- pygobject_construct(self, NULL);
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError, "could not create GtkProgressBar object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_PROGRESS_BAR
-%%
-override gtk_rc_set_default_files kwargs
-static PyObject *
-_wrap_gtk_rc_set_default_files(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- gchar **filenames = NULL;
- static char *kwlist[] = { "filenames", NULL };
- PyObject *py_filenames = NULL;
- int i, n_files;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O:rc_set_default_files",
- kwlist, &py_filenames))
- return NULL;
-
- if (!PySequence_Check(py_filenames)) {
- PyErr_SetString(PyExc_TypeError, "filenames must be a sequence");
- return NULL;
- }
-
- n_files = PySequence_Length(py_filenames);
- filenames = g_new(gchar *, n_files + 1);
- for (i = 0; i < n_files; i++) {
- PyObject *item = PySequence_GetItem(py_filenames, i);
- Py_DECREF(item); /* PySequence_GetItem INCREF's */
- filenames[i] = PyString_AsString(item);
- }
- filenames[n_files] = NULL;
-
- gtk_rc_set_default_files(filenames);
-
- g_free(filenames);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_rc_get_default_files noargs
-static PyObject *
-_wrap_gtk_rc_get_default_files(PyGObject *self)
-{
- gchar **filenames = NULL, **tmp;
- int i = 0, j;
- PyObject *ret;
-
- filenames = gtk_rc_get_default_files();
-
- tmp = filenames;
- while (*tmp)
- tmp++, i++;
-
- ret = PyTuple_New(i);
- for (j = 0; j < i; j++)
- PyTuple_SetItem(ret, j, PyString_FromString(filenames[j]));
-
- return ret;
-}
-%%
-override gtk_icon_set_new_from_pixbuf kwargs
-static int
-_wrap_gtk_icon_set_new_from_pixbuf(PyGBoxed *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "pixbuf", NULL };
- PyGObject *pixbuf = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O:GtkIconSet.__init__", kwlist, &pixbuf))
- return -1;
- if (pixbuf && !pygobject_check(pixbuf, &PyGdkPixbuf_Type)) {
- PyErr_SetString(PyExc_TypeError, "pixbuf should be a GdkPixbuf");
- return -1;
- }
- self->gtype = GTK_TYPE_ICON_SET;
- self->free_on_dealloc = FALSE;
- if (pixbuf)
- self->boxed = gtk_icon_set_new_from_pixbuf(GDK_PIXBUF(pixbuf->obj));
- else
- self->boxed = gtk_icon_set_new();
-
- if (!self->boxed) {
- PyErr_SetString(PyExc_RuntimeError, "could not create GtkIconSet object");
- return -1;
- }
- self->free_on_dealloc = TRUE;
- return 0;
-}
-%%
-override gtk_icon_set_get_sizes noargs
-static PyObject *
-_wrap_gtk_icon_set_get_sizes(PyGObject *self)
-{
- GtkIconSize *sizes;
- int i, n_sizes;
- PyObject *ret;
-
- gtk_icon_set_get_sizes(pyg_boxed_get(self, GtkIconSet), &sizes, &n_sizes);
-
- ret = PyTuple_New(n_sizes);
- for (i = 0; i < n_sizes; i++)
- PyTuple_SetItem(ret, i, PyInt_FromLong(sizes[i]));
- g_free(sizes);
-
- return ret;
-}
-%%
-override gtk_stock_add kwargs
-static PyObject *
-_wrap_gtk_stock_add(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "items", NULL };
- PyObject *py_items;
- PyObject *py_item;
- GtkStockItem *items = NULL;
- int i, len;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:stock_add", kwlist,
- &py_items))
- return NULL;
-
- if (!PySequence_Check(py_items)) {
- PyErr_SetString(PyExc_TypeError,
- "items must be a sequence of five-element tuples");
- return NULL;
- }
-
- len = PySequence_Length(py_items);
- if (len > 0) {
- items = g_new(GtkStockItem, len);
- for (i = 0; i < len; i++) {
- py_item = PySequence_GetItem(py_items, i);
- if (!py_item) goto error;
- if (!PyArg_ParseTuple(py_item, "zziiz",
- &items[i].stock_id, &items[i].label,
- &items[i].modifier, &items[i].keyval,
- &items[i].translation_domain)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError, "items sequence members "
- "must be of form (stock_id, label, modifiers, "
- "keyval, domain)");
- goto error;
- }
- Py_DECREF(py_item);
- }
- gtk_stock_add(items, PySequence_Length(py_items));
- g_free(items);
- }
- Py_INCREF(Py_None);
- return Py_None;
- error:
- g_free(items);
- return NULL;
-}
-%%
-override gtk_stock_list_ids noargs
-static PyObject *
-_wrap_gtk_stock_list_ids(PyGObject *self)
-{
- GSList *ids;
- PyObject *list;
- int i = 0;
-
- ids = gtk_stock_list_ids();
-
- list = PyList_New(g_slist_length(ids));
- for (; ids; ids = ids->next, i++) {
- PyList_SetItem(list, i, PyString_FromString(ids->data));
- g_free(ids->data);
- }
- g_slist_free(ids);
-
- return list;
-}
-%%
-override gtk_stock_lookup args
-static PyObject *
-_wrap_gtk_stock_lookup(PyGObject *self, PyObject *args)
-{
- gchar *stock_id;
- GtkStockItem item;
-
- if (!PyArg_ParseTuple(args, "s:gtk.stock_lookup",
- &stock_id)) {
- return NULL;
- }
-
- if(gtk_stock_lookup(stock_id, &item)) {
- return Py_BuildValue("zzNiz",
- item.stock_id,
- item.label,
- pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE,
- item.modifier),
- item.keyval,
- item.translation_domain);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_layout_get_size noargs
-static PyObject *
-_wrap_gtk_layout_get_size(PyGObject *self)
-{
- guint width, height;
- gtk_layout_get_size(GTK_LAYOUT(self->obj), &width, &height);
-
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override gtk_frame_get_label_align noargs
-static PyObject *
-_wrap_gtk_frame_get_label_align(PyGObject *self)
-{
- gfloat xalign, yalign;
-
- gtk_frame_get_label_align(GTK_FRAME(self->obj), &xalign, &yalign);
- return Py_BuildValue("(ff)", xalign, yalign);
-}
-%%
-override gtk_misc_get_alignment noargs
-static PyObject *
-_wrap_gtk_misc_get_alignment(PyGObject *self)
-{
- gfloat xalign, yalign;
-
- gtk_misc_get_alignment(GTK_MISC(self->obj), &xalign, &yalign);
- return Py_BuildValue("(ff)", xalign, yalign);
-}
-%%
-override gtk_misc_get_padding noargs
-static PyObject *
-_wrap_gtk_misc_get_padding(PyGObject *self)
-{
- gint xpad, ypad;
-
- gtk_misc_get_padding(GTK_MISC(self->obj), &xpad, &ypad);
- return Py_BuildValue("(ii)", xpad, ypad);
-}
-%%
-override gtk_ruler_get_range noargs
-static PyObject *
-_wrap_gtk_ruler_get_range(PyGObject *self)
-{
- gdouble lower, upper, position, max_size;
-
- gtk_ruler_get_range(GTK_RULER(self->obj), &lower, &upper, &position,
- &max_size);
- return Py_BuildValue("(dddd)", lower, upper, position, max_size);
-}
-%%
-override gtk_im_context_get_preedit_string noargs
-static PyObject *
-_wrap_gtk_im_context_get_preedit_string(PyGObject *self)
-{
- gchar *str;
- PangoAttrList *attrs;
- gint cursor_pos;
- PyObject *ret;
-
- gtk_im_context_get_preedit_string(GTK_IM_CONTEXT(self->obj),
- &str, &attrs, &cursor_pos);
-
- ret = Py_BuildValue("(sNi)", str,
- pyg_boxed_new(PANGO_TYPE_ATTR_LIST, attrs, FALSE,TRUE),
- cursor_pos);
- g_free(str);
-
- return ret;
-}
-%%
-override gtk_im_context_filter_keypress kwargs
-static PyObject *
-_wrap_gtk_im_context_filter_keypress(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "key", NULL };
- PyObject *key;
- int ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkIMContext.filter_keypress", kwlist,
- &key))
- return NULL;
-
- if (!pyg_boxed_check(key, GDK_TYPE_EVENT)) {
- PyErr_SetString(PyExc_TypeError, "key must be a GdkEvent");
- return NULL;
- }
-
- ret = gtk_im_context_filter_keypress(GTK_IM_CONTEXT(self->obj),
- pyg_boxed_get(key, GdkEventKey));
- return PyBool_FromLong(ret);
-}
-%%
-override gtk_im_context_get_surrounding noargs
-static PyObject *
-_wrap_gtk_im_context_get_surrounding(PyGObject *self)
-{
- gchar *text;
- gint cursor_index;
-
- if (gtk_im_context_get_surrounding(GTK_IM_CONTEXT(self->obj),
- &text, &cursor_index)) {
- PyObject *ret = Py_BuildValue("(si)", text, cursor_index);
-
- g_free(text);
- return ret;
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override-attr GtkTooltips.active_tips_data
-static PyObject *
-_wrap_gtk_tooltips__get_active_tips_data(PyGObject *self, void *closure)
-{
- GtkTooltips *tips = GTK_TOOLTIPS(self->obj);
- GtkTooltipsData *data = tips->active_tips_data;
-
- if (data == NULL) {
- Py_INCREF(Py_None);
- return Py_None;
- }
-
- return Py_BuildValue("NNss",
- pygobject_new((GObject *)data->tooltips),
- pygobject_new((GObject *)data->widget),
- data->tip_text,
- data->tip_private);
-}
-%%
-override-attr GtkTooltips.tips_data_list
-static PyObject *
-_wrap_gtk_tooltips__get_tips_data_list(PyGObject *self, void *closure)
-{
- GList *list = GTK_TOOLTIPS(self->obj)->tips_data_list;
- gint i, length;
- PyObject *pylist;
- GList *iter;
-
- length = g_list_length(list);
- pylist = PyList_New(length);
-
- i = 0;
- for (iter = list; iter; iter = iter->next) {
- GtkTooltipsData *data = (GtkTooltipsData*)iter->data;
- PyObject *item = Py_BuildValue("NNss",
- pygobject_new((GObject *)data->tooltips),
- pygobject_new((GObject *)data->widget),
- data->tip_text,
- data->tip_private);
- PyList_SetItem(pylist, i, item);
- Py_INCREF(item);
- }
- return pylist;
-}
-%%
-override-attr GtkAdjustment.value
-static int
-_wrap_gtk_adjustment__set_value(PyGObject *self, PyObject *value,
- void *closure)
-{
- GtkAdjustment *adjustment = GTK_ADJUSTMENT(self->obj);
-
- if (!pygtk_util_pyobject_as_double(value, &adjustment->value, "value"))
- return -1;
- gtk_adjustment_value_changed(adjustment);
- return 0;
-}
-%%
-override-attr GtkAdjustment.lower
-static int
-_wrap_gtk_adjustment__set_lower(PyGObject *self, PyObject *value,
- void *closure)
-{
- GtkAdjustment *adjustment = GTK_ADJUSTMENT(self->obj);
-
- if (!pygtk_util_pyobject_as_double(value, &adjustment->lower, "lower"))
- return -1;
- gtk_adjustment_changed(adjustment);
- return 0;
-}
-%%
-override-attr GtkAdjustment.upper
-static int
-_wrap_gtk_adjustment__set_upper(PyGObject *self, PyObject *value,
- void *closure)
-{
- GtkAdjustment *adjustment = GTK_ADJUSTMENT(self->obj);
-
- if (!pygtk_util_pyobject_as_double(value, &adjustment->upper, "upper"))
- return -1;
- gtk_adjustment_changed(adjustment);
- return 0;
-}
-%%
-override-attr GtkAdjustment.step_increment
-static int
-_wrap_gtk_adjustment__set_step_increment(PyGObject *self, PyObject *value,
- void *closure)
-{
- GtkAdjustment *adjustment = GTK_ADJUSTMENT(self->obj);
-
- if (!pygtk_util_pyobject_as_double(value, &adjustment->step_increment,
- "step_increment"))
- return -1;
- gtk_adjustment_changed(adjustment);
- return 0;
-}
-%%
-override-attr GtkAdjustment.page_increment
-static int
-_wrap_gtk_adjustment__set_page_increment(PyGObject *self, PyObject *value,
- void *closure)
-{
- GtkAdjustment *adjustment = GTK_ADJUSTMENT(self->obj);
-
- if (!pygtk_util_pyobject_as_double(value, &adjustment->page_increment,
- "page_increment"))
- return -1;
- gtk_adjustment_changed(adjustment);
- return 0;
-}
-%%
-override-attr GtkAdjustment.page_size
-static int
-_wrap_gtk_adjustment__set_page_size(PyGObject *self, PyObject *value,
- void *closure)
-{
- GtkAdjustment *adjustment = GTK_ADJUSTMENT(self->obj);
-
- if (!pygtk_util_pyobject_as_double(value, &adjustment->page_size, "page_size"))
- return -1;
- gtk_adjustment_changed(adjustment);
- return 0;
-}
-%%
-override gtk_adjustment_set_all kwargs
-static PyObject *
-_wrap_gtk_adjustment_set_all(PyGObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "value", "lower", "upper", "step_increment",
- "page_increment", "page_size", NULL };
- GtkAdjustment *adj = GTK_ADJUSTMENT(self->obj);
- double *value = &adj->value, *lower = &adj->lower, *upper = &adj->upper;
- double *step_increment = &adj->step_increment;
- double *page_increment = &adj->page_increment;
- double *page_size = &adj->page_size;
- double old_value = *value, old_lower = *lower, old_upper = *upper;
- double old_step_increment = *step_increment;
- double old_page_increment = *page_increment;
- double old_page_size = *page_size;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|dddddd:gtk_adjustment_set_all",
- kwlist,
- value, lower, upper, step_increment,
- page_increment, page_size)) {
- adj->value = old_value;
- adj->lower = old_lower;
- adj->upper = old_upper;
- adj->step_increment = old_step_increment;
- adj->page_increment = old_page_increment;
- adj->page_size = old_page_size;
- return NULL;
- }
-
- if (adj->value != old_value)
- gtk_adjustment_value_changed(adj);
- if (adj->lower != old_lower || adj->upper != old_upper
- || adj->step_increment != old_step_increment
- || adj->page_increment != old_page_increment
- || adj->page_size != old_page_size)
- gtk_adjustment_changed(adj);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_file_selection_get_selections noargs
-static PyObject *
-_wrap_gtk_file_selection_get_selections(PyGObject *self)
-{
- gchar **filenames = NULL;
- int size;
- int i;
- PyObject *ret;
-
- filenames = gtk_file_selection_get_selections(
- GTK_FILE_SELECTION(self->obj));
-
- for (i = 0; filenames[i]; i++);
- size = i;
-
- ret = PyTuple_New(size);
- for (i = 0; i < size; i++)
- PyTuple_SetItem(ret, i, PyString_FromString(filenames[i]));
-
- return ret;
-}
-%%
-override gtk_icon_size_lookup kwargs
-static PyObject *
-_wrap_gtk_icon_size_lookup(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "icon_size", NULL };
- PyObject *py_icon_size;
- GtkIconSize icon_size;
- gint width, height;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:icon_size_lookup",
- kwlist, &py_icon_size))
- return NULL;
-
- if (pyg_enum_get_value(GTK_TYPE_ICON_SIZE, py_icon_size,
- (gint *) &icon_size))
- return NULL;
-
- gtk_icon_size_lookup(icon_size, &width, &height);
-
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override gtk_image_get_pixmap noargs
-static PyObject *
-_wrap_gtk_image_get_pixmap(PyGObject *self)
-{
- GdkPixmap *pixmap;
- GdkBitmap *mask;
- GtkImageType type;
-
- type = gtk_image_get_storage_type(GTK_IMAGE(self->obj));
- if (!(type == GTK_IMAGE_PIXMAP || type == GTK_IMAGE_EMPTY)) {
- PyErr_SetString(PyExc_ValueError, "image should be a GdkPixmap or empty");
- return NULL;
- }
- gtk_image_get_pixmap(GTK_IMAGE(self->obj), &pixmap, &mask);
- return Py_BuildValue("(NN)", pygobject_new((GObject *)pixmap),
- pygobject_new((GObject *)mask));
-}
-%%
-override gtk_image_get_image noargs
-static PyObject *
-_wrap_gtk_image_get_image(PyGObject *self)
-{
- GdkImage *image;
- GdkBitmap *mask;
- GtkImageType type;
-
- type = gtk_image_get_storage_type(GTK_IMAGE(self->obj));
- if (!(type == GTK_IMAGE_IMAGE || type == GTK_IMAGE_EMPTY)) {
- PyErr_SetString(PyExc_ValueError, "image should be a GdkImage or empty");
- return NULL;
- }
- gtk_image_get_image(GTK_IMAGE(self->obj), &image, &mask);
- return Py_BuildValue("(NN)", pygobject_new((GObject *)image),
- pygobject_new((GObject *)mask));
-}
-%%
-override gtk_image_get_stock noargs
-static PyObject *
-_wrap_gtk_image_get_stock(PyGObject *self)
-{
- gchar *stock_id;
- GtkIconSize size;
- GtkImageType type;
-
- type = gtk_image_get_storage_type(GTK_IMAGE(self->obj));
- if (!(type == GTK_IMAGE_STOCK || type == GTK_IMAGE_EMPTY)) {
- PyErr_SetString(PyExc_ValueError, "image should be a stock icon or empty");
- return NULL;
- }
- gtk_image_get_stock(GTK_IMAGE(self->obj), &stock_id, &size);
-
- if (stock_id) {
- return Py_BuildValue("(NN)",
- PyString_FromString(stock_id),
- pyg_enum_from_gtype(GTK_TYPE_ICON_SIZE, size));
- } else {
- Py_INCREF(Py_None);
- return Py_BuildValue("(ON)",
- Py_None,
- pyg_enum_from_gtype(GTK_TYPE_ICON_SIZE, size));
- }
-}
-%%
-override gtk_image_get_icon_set noargs
-static PyObject *
-_wrap_gtk_image_get_icon_set(PyGObject *self)
-{
- GtkIconSet *icon_set;
- GtkIconSize size;
- GtkImageType type;
-
- type = gtk_image_get_storage_type(GTK_IMAGE(self->obj));
- if (!(type == GTK_IMAGE_ICON_SET || type == GTK_IMAGE_EMPTY)) {
- PyErr_SetString(PyExc_ValueError, "image should be a GtkIconSet or empty");
- return NULL;
- }
- gtk_image_get_icon_set(GTK_IMAGE(self->obj), &icon_set, &size);
- return Py_BuildValue("(NN)", pygobject_new((GObject *)icon_set),
- pyg_enum_from_gtype(GTK_TYPE_ICON_SIZE, size));
-}
-%%
-override gtk_image_get noargs
-static PyObject *
-_wrap_gtk_image_get(PyGObject *self)
-{
- return _wrap_gtk_image_get_image(self);
-}
-%%
-override gtk_image_get_pixbuf noargs
-static PyObject *
-_wrap_gtk_image_get_pixbuf(PyGObject *self)
-{
- GdkPixbuf *ret;
- GtkImageType type;
-
- type = gtk_image_get_storage_type(GTK_IMAGE(self->obj));
- if (!(type == GTK_IMAGE_PIXBUF || type == GTK_IMAGE_EMPTY)) {
- PyErr_SetString(PyExc_ValueError, "image should be a GdkPixbuf or empty");
- return NULL;
- }
- ret = gtk_image_get_pixbuf(GTK_IMAGE(self->obj));
- /* pygobject_new handles NULL checking */
- return pygobject_new((GObject *)ret);
-}
-%%
-override gtk_image_get_animation noargs
-static PyObject *
-_wrap_gtk_image_get_animation(PyGObject *self)
-{
- GdkPixbufAnimation *ret;
- GtkImageType type;
-
- type = gtk_image_get_storage_type(GTK_IMAGE(self->obj));
- if (!(type == GTK_IMAGE_ANIMATION || type == GTK_IMAGE_EMPTY)) {
- PyErr_SetString(PyExc_ValueError, "image should be a GdkPixbufAnimation or empty");
- return NULL;
- }
-
- ret = gtk_image_get_animation(GTK_IMAGE(self->obj));
- /* pygobject_new handles NULL checking */
- return pygobject_new((GObject *)ret);
-}
-%%
-override gtk_radio_button_set_group kwargs
-static PyObject *
-_wrap_gtk_radio_button_set_group(PyGObject *self, PyObject *args,
- PyObject *kwargs) {
- static char *kwlist[] = { "group", NULL };
- PyObject *py_group;
- GSList *list;
- GtkRadioButton *group;
-
- if (!PyArg_ParseTupleAndKeywords(args,kwargs,"O:GtkRadioButton.set_group",
- kwlist, &py_group))
- return NULL;
-
- if (pygobject_check(py_group, &PyGtkRadioButton_Type)) {
- group = GTK_RADIO_BUTTON(pygobject_get(py_group));
- list = gtk_radio_button_get_group(group);
- if (list == gtk_radio_button_get_group(GTK_RADIO_BUTTON(self->obj))) {
- PyErr_SetString(PyExc_ValueError, "radio button already in group");
- return NULL;
- }
- } else if (py_group == Py_None) {
- list = NULL;
- } else {
- PyErr_SetString(PyExc_TypeError, "group must be a RadioGroup or None");
- return NULL;
- }
-
- gtk_radio_button_set_group(GTK_RADIO_BUTTON(self->obj), list);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_radio_menu_item_get_group noargs
-static PyObject *
-_wrap_gtk_radio_menu_item_get_group(PyGObject *self) {
- PyObject *py_list;
- GSList *list, *tmp;
- PyObject *gtk_obj;
-
- list = gtk_radio_menu_item_get_group(GTK_RADIO_MENU_ITEM(self->obj));
-
- if ((py_list = PyList_New(0)) == NULL) {
- return NULL;
- }
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- gtk_obj = pygobject_new(G_OBJECT(tmp->data));
- if (gtk_obj == NULL) {
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_Append(py_list, gtk_obj);
- Py_DECREF(gtk_obj);
- }
- return py_list;
-}
-%%
-override gtk_radio_menu_item_set_group kwargs
-static PyObject *
-_wrap_gtk_radio_menu_item_set_group(PyGObject *self, PyObject *args,
- PyObject *kwargs) {
- static char *kwlist[] = { "group", NULL };
- PyObject *py_group;
- GSList *list;
- GtkRadioMenuItem *group;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkRadioMenuItem.set_group",
- kwlist, &py_group))
- return NULL;
-
- if (pygobject_check(py_group, &PyGtkRadioMenuItem_Type)) {
- group = GTK_RADIO_MENU_ITEM(pygobject_get(py_group));
- list = gtk_radio_menu_item_get_group(group);
- if (list == gtk_radio_menu_item_get_group(GTK_RADIO_MENU_ITEM(self->obj))) {
- PyErr_SetString(PyExc_ValueError, "radio menu item already in group");
- return NULL;
- }
- } else if (py_group == Py_None) {
- list = NULL;
- } else {
- PyErr_SetString(PyExc_TypeError, "group must be a RadioMenuItem or None");
- return NULL;
- }
-
- gtk_radio_menu_item_set_group(GTK_RADIO_MENU_ITEM(self->obj), list);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_scrolled_window_get_policy noargs
-static PyObject *
-_wrap_gtk_scrolled_window_get_policy(PyGObject *self)
-{
- GtkPolicyType hscrollbar_policy, vscrollbar_policy;
-
- gtk_scrolled_window_get_policy(GTK_SCROLLED_WINDOW(self->obj),
- &hscrollbar_policy, &vscrollbar_policy);
- return Py_BuildValue("(NN)",
- pyg_enum_from_gtype(GTK_TYPE_POLICY_TYPE, hscrollbar_policy),
- pyg_enum_from_gtype(GTK_TYPE_POLICY_TYPE, vscrollbar_policy));
-}
-%%
-override gtk_tooltips_data_get kwargs
-static PyObject *
-_wrap_gtk_tooltips_data_get(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "widget", NULL };
- PyGObject *widget;
- GtkTooltipsData *data;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!:GtkTooltips.data_get",
- kwlist, &PyGtkWidget_Type, &widget))
- return NULL;
-
- data = gtk_tooltips_data_get(GTK_WIDGET(widget->obj));
-
- if (!data) {
- Py_INCREF(Py_None);
- return Py_None;
- }
-
- return Py_BuildValue("NNss",
- pygobject_new((GObject *)data->tooltips),
- pygobject_new((GObject *)data->widget),
- data->tip_text,
- data->tip_private);
-}
-%%
-override gtk_tooltips_data_get1 kwargs
-static PyObject *
-_wrap_gtk_tooltips_data_get1(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- if (PyErr_Warn(PyExc_DeprecationWarning, "use tooltips_data_get") < 0)
- return NULL;
-
- return _wrap_gtk_tooltips_data_get(self, args, kwargs);
-}
-%%
-override gtk_accelerator_parse kwargs
-static PyObject *
-_wrap_gtk_accelerator_parse(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "accelerator", NULL };
- gchar *accel;
- guint keyval;
- GdkModifierType modifier;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s:Gtk.accelerator_parse",
- kwlist, &accel))
- return NULL;
-
- gtk_accelerator_parse((const gchar *)accel, &keyval, &modifier);
-
- return Py_BuildValue("iN", keyval,
- pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE,
- modifier));
-}
-%%
-override gtk_accel_map_lookup_entry kwargs
-static PyObject *
-_wrap_gtk_accel_map_lookup_entry(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "accel_path", NULL };
- gchar *accel_path;
- GtkAccelKey accel_key;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:gtk.accel_map_lookup_entry",
- kwlist, &accel_path))
- return NULL;
-
- if (gtk_accel_map_lookup_entry((const gchar *)accel_path, &accel_key))
- return Py_BuildValue("iN", accel_key.accel_key,
- pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE, accel_key.accel_mods));
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_accel_map_load_fd kwargs
-static PyObject *
-_wrap_gtk_accel_map_load_fd(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "fd", NULL };
- gint fd;
- PyObject *py_fd;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:gtk.accel_map_load_fd",
- kwlist, &py_fd))
- return NULL;
-
- if ((fd = PyObject_AsFileDescriptor(py_fd)) != -1)
- gtk_accel_map_load_fd(fd);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_accel_map_save_fd kwargs
-static PyObject *
-_wrap_gtk_accel_map_save_fd(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "fd", NULL };
- gint fd;
- PyObject *py_fd;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:gtk.accel_map_save_fd",
- kwlist, &py_fd))
- return NULL;
-
- if ((fd = PyObject_AsFileDescriptor(py_fd)) != -1)
- gtk_accel_map_save_fd(fd);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_color_selection_palette_from_string kwargs
-static PyObject *
-_wrap_gtk_color_selection_palette_from_string(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "str", NULL };
- gchar *str;
- GdkColor *colors;
- gint i, n_colors;
- PyObject *py_list;
-
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "s:gtk.color_selection_palette_from_string",
- kwlist, &str))
- return NULL;
-
- if (!gtk_color_selection_palette_from_string(str, &colors, &n_colors)) {
- Py_INCREF(Py_None);
- return Py_None;
- }
-
- if ((py_list = PyList_New(n_colors)) == NULL) {
- g_free(colors);
- return NULL;
- }
-
- for (i = 0; i < n_colors; i++) {
- PyObject *item = pyg_boxed_new(GDK_TYPE_COLOR, &colors[i], TRUE, TRUE);
-
- PyList_SetItem(py_list, i, item);
- }
- g_free(colors);
-
- return py_list;
-}
-%%
-override gtk_color_selection_palette_to_string kwargs
-static PyObject *
-_wrap_gtk_color_selection_palette_to_string(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "colors", NULL };
- gchar *str;
- GdkColor *colors;
- gint i, n_colors;
- PyObject *py_colors, *ret;
-
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "O:gtk.color_selection_palette_to_string",
- kwlist, &py_colors))
- return NULL;
-
- if (!(py_colors = PySequence_Fast(
- py_colors, "colors must be a sequence of gtk.gdk.Colors")))
- return NULL;
-
- n_colors = PySequence_Fast_GET_SIZE(py_colors);
- if ((colors = g_new0(GdkColor, n_colors)) == NULL) {
- Py_DECREF(py_colors);
- return NULL;
- }
- for (i = 0; i < n_colors; i++) {
- PyObject *item = PySequence_Fast_GET_ITEM(py_colors, i);
- if (!pyg_boxed_check(item, GDK_TYPE_COLOR)) {
- PyErr_SetString(PyExc_TypeError,
- "colors must contain gtk.gdk.Colors");
- g_free(colors);
- Py_DECREF(py_colors);
- return NULL;
- }
- colors[i] = *pyg_boxed_get(item, GdkColor);
- }
-
- str = gtk_color_selection_palette_to_string(colors, n_colors);
- ret = PyString_FromString(str);
- g_free(colors);
- g_free(str);
- Py_DECREF(py_colors);
-
- return ret;
-}
-
-%%
-override gtk_binding_entry_remove kwargs
-static PyObject *
-_wrap_gtk_binding_entry_remove(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "class_type", "keyval", "modifiers", NULL };
- int keyval;
- PyObject *py_modifiers = NULL;
- GdkModifierType modifiers;
- PyObject *class;
- GType class_type;
- GtkBindingSet *bset = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OiO:gtk_binding_entry_remove",
- kwlist, &class, &keyval, &py_modifiers))
- return NULL;
- if (pyg_flags_get_value(GDK_TYPE_MODIFIER_TYPE, py_modifiers, (gint *)&modifiers))
- return NULL;
-
- class_type = pyg_type_from_object(class);
- if (class_type == 0)
- return NULL;
-
- bset = gtk_binding_set_by_class(gtk_type_class(class_type));
- gtk_binding_entry_remove(bset, keyval, modifiers);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-define GtkAccelGroup.connect_group kwargs
-static PyObject *
-_wrap_gtk_accel_group_connect_group(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "accel_key", "accel_mods", "accel_flags", "callback", NULL };
- int accel_key;
- PyObject *py_accel_mods = NULL, *py_accel_flags = NULL, *py_callback;
- GdkModifierType accel_mods;
- GtkAccelFlags accel_flags;
- GClosure *closure;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "iOOO:GtkAccelGroup.connect", kwlist,
- &accel_key, &py_accel_mods, &py_accel_flags,
- &py_callback))
- return NULL;
- if (!PyCallable_Check(py_callback)) {
- PyErr_SetString(PyExc_TypeError, "callback argument not callable");
- return NULL;
- }
- if (pyg_flags_get_value(GDK_TYPE_MODIFIER_TYPE, py_accel_mods, (gint *)&accel_mods))
- return NULL;
- if (pyg_flags_get_value(GTK_TYPE_ACCEL_FLAGS, py_accel_flags, (gint *)&accel_flags))
- return NULL;
- closure = pyg_closure_new(py_callback, NULL, NULL);
- pygobject_watch_closure((PyObject *)self, closure);
- gtk_accel_group_connect(GTK_ACCEL_GROUP(self->obj), accel_key,
- accel_mods, accel_flags, closure);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_file_chooser_dialog_new kwargs
-static int
-_wrap_gtk_file_chooser_dialog_new(PyGObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "title", "parent", "action", "buttons", "backend", NULL };
- gchar *title = NULL;
- PyGObject *py_window = NULL;
- PyObject *py_buttons = Py_None;
- PyObject *py_action = NULL;
- GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;
- GtkWindow *parent = NULL;
- gchar *backend = NULL;
- int len, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|zOOOz:GtkFileChooserDialog.__init__", kwlist,
- &title, &py_window, &py_action,
- &py_buttons,
- &backend))
- return -1;
-
- if (py_window == NULL || (PyObject*)py_window == Py_None)
- parent = NULL;
- else if (pygobject_check(py_window, &PyGtkWindow_Type))
- parent = GTK_WINDOW(py_window->obj);
- else {
- PyErr_SetString(PyExc_TypeError, "parent must be a GtkWindow or None");
- return -1;
- }
-
- if (pyg_enum_get_value(GTK_TYPE_FILE_CHOOSER_ACTION, py_action,
- (gint *)&action))
- return -1;
- if (py_buttons == Py_None)
- len = 0;
- else if (PyTuple_Check(py_buttons))
- len = PyTuple_Size(py_buttons);
- else {
- PyErr_SetString(PyExc_TypeError, "buttons must be a tuple containing text/response pairs or None");
- return -1;
- }
-
- if (len % 2) {
- PyErr_SetString(PyExc_RuntimeError,
- "buttons tuple must contain text/response id pairs");
- return -1;
- }
-
- pygobject_construct(self,
- "title", title,
- "action", action,
- "file-system-backend", backend,
- NULL);
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkFileChooserDialog object");
- return -1;
- }
-
- if (parent)
- gtk_window_set_transient_for (GTK_WINDOW (self->obj), parent);
-
- for (i = 0; i < len; i += 2) {
- PyObject *text = PyTuple_GetItem(py_buttons, i);
- PyObject *id = PyTuple_GetItem(py_buttons, i + 1);
- if (!PyString_Check(text)) {
- gtk_object_destroy(GTK_OBJECT(self->obj));
- self->obj = NULL;
- PyErr_SetString(PyExc_RuntimeError,
- "first member of each text/response id pair "
- "must be a string");
- return -1;
- }
- if (!PyInt_Check(id)) {
- gtk_object_destroy(GTK_OBJECT(self->obj));
- self->obj = NULL;
- PyErr_SetString(PyExc_RuntimeError,
- "second member of each text/response id pair "
- "must be a number");
- return -1;
- }
- gtk_dialog_add_button(GTK_DIALOG(self->obj), PyString_AsString(text),
- PyInt_AsLong(id));
- }
- g_object_ref(self->obj); /* we don't own the first reference of windows */
-
- return 0;
-}
-%%
-new-constructor GTK_TYPE_FILE_CHOOSER_DIALOG
-%%
-override gtk_ui_manager_get_action_groups noargs
-static PyObject *
-_wrap_gtk_ui_manager_get_action_groups(PyGObject *self)
-{
- GList *list, *tmp;
- PyObject *ret;
-
- list = gtk_ui_manager_get_action_groups(GTK_UI_MANAGER(self->obj));
-
- ret = PyList_New(0);
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- PyObject *item = pygobject_new(G_OBJECT(tmp->data));
-
- PyList_Append(ret, item);
- Py_DECREF(item);
- }
-
- return ret;
-}
-%%
-override gtk_ui_manager_get_toplevels kwargs
-static PyObject *
-_wrap_gtk_ui_manager_get_toplevels(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "types", NULL };
- GtkUIManagerItemType types;
- PyObject *py_types = NULL;
- GSList *list, *tmp;
- PyObject *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkUIManager.get_toplevels", kwlist,
- &py_types))
- return NULL;
-
- if (pyg_flags_get_value(GTK_TYPE_UI_MANAGER_ITEM_TYPE, py_types, (gint *)&types))
- return NULL;
-
- list = gtk_ui_manager_get_toplevels(GTK_UI_MANAGER(self->obj), types);
-
- ret = PyList_New(0);
- for (tmp = list; tmp; tmp = tmp->next) {
- PyObject *item = pygobject_new(G_OBJECT(tmp->data));
-
- PyList_Append(ret, item);
- Py_DECREF(item);
- }
-
- return ret;
-}
-%%
-override gtk_action_group_add_actions kwargs
-static PyObject *
-_wrap_gtk_action_group_add_actions (PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "entries", "user_data", NULL };
- PyGILState_STATE state;
- PyObject *entries, *extra_args = NULL;
- int len, i;
- PyObject *item;
- GtkActionEntry entry;
- GtkAction *action;
- PyObject *callback, *py_action;
- GClosure *closure;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|O:GtkActionGroup.add_actions",
- kwlist, &entries, &extra_args))
- return NULL;
-
- if (!PySequence_Check(entries)) {
- PyErr_SetString(PyExc_TypeError, "entries must be a sequence");
- return NULL;
- }
-
- state = pyg_gil_state_ensure();
-
- len = PySequence_Size(entries);
- for (i = 0; i < len; i++) {
- item = PySequence_GetItem(entries, i);
- Py_DECREF(item);
-
- memset(&entry, 0, sizeof(entry));
- callback = Py_None;
-
- if (!PyArg_ParseTuple(item, "s|zzzzO", &(entry.name), &(entry.stock_id),
- &(entry.label), &(entry.accelerator), &(entry.tooltip),
- &callback)) {
- return NULL;
- }
-
- action = gtk_action_new(entry.name, entry.label, entry.tooltip,
- entry.stock_id);
- if (action == NULL) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkAction object");
- return NULL;
- }
-
- py_action = pygobject_new((GObject *)action);
- if (callback != Py_None) {
- if (PyCallable_Check(callback)) {
- closure = pyg_closure_new(callback, extra_args, NULL);
- g_signal_connect_closure(action, "activate", closure, FALSE);
- pygobject_watch_closure(py_action, closure);
- } else {
- PyErr_SetString(PyExc_TypeError,
- "One or more entry is missing a callback type");
- g_object_unref (action);
- Py_DECREF (py_action);
- return NULL;
- }
- }
-
- gtk_action_group_add_action_with_accel (GTK_ACTION_GROUP(self->obj),
- GTK_ACTION(action),
- entry.accelerator);
-
- g_object_unref(action);
- Py_DECREF (py_action);
- }
-
- pyg_gil_state_release(state);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_action_group_add_toggle_actions kwargs
-static PyObject *
-_wrap_gtk_action_group_add_toggle_actions (PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "entries", "user_data", NULL };
- PyGILState_STATE state;
- PyObject *entries, *extra_args = NULL;
- int len, i;
- PyObject *item;
- GtkToggleActionEntry entry;
- GtkToggleAction *action;
- PyObject *callback, *py_action;
- GClosure *closure;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|O:GtkActionGroup.add_toggle_actions",
- kwlist, &entries, &extra_args))
- return NULL;
-
- if (!PySequence_Check(entries)) {
- PyErr_SetString(PyExc_TypeError, "entries must be a sequence");
- return NULL;
- }
-
- state = pyg_gil_state_ensure();
-
- len = PySequence_Size(entries);
- for (i = 0; i < len; i++) {
- item = PySequence_GetItem(entries, i);
- Py_DECREF(item);
-
- memset(&entry, 0, sizeof(entry));
- callback = Py_None;
-
- if (!PyArg_ParseTuple(item, "s|zzzzOi", &(entry.name), &(entry.stock_id),
- &(entry.label), &(entry.accelerator), &(entry.tooltip),
- &callback, &(entry.is_active))) {
- return NULL;
- }
-
- action = gtk_toggle_action_new(entry.name, entry.label, entry.tooltip,
- entry.stock_id);
- if (action == NULL) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkToggleAction object");
- return NULL;
- }
-
- gtk_toggle_action_set_active(action, entry.is_active);
- py_action = pygobject_new((GObject *)action);
- if (callback != Py_None && PyCallable_Check(callback)) {
- closure = pyg_closure_new(callback, extra_args, NULL);
- g_signal_connect_closure(action, "activate", closure, FALSE);
- pygobject_watch_closure(py_action, closure);
- }
-
- gtk_action_group_add_action_with_accel (GTK_ACTION_GROUP(self->obj),
- GTK_ACTION(action),
- entry.accelerator);
-
- g_object_unref (action);
- Py_DECREF (py_action);
- }
-
- pyg_gil_state_release(state);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_action_group_add_radio_actions kwargs
-static PyObject *
-_wrap_gtk_action_group_add_radio_actions (PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "entries", "value", "on_change", "user_data", NULL };
- PyGILState_STATE state;
- PyObject *entries, *extra_args = NULL;
- int len, i;
- PyObject *item;
- GtkRadioActionEntry entry;
- GtkRadioAction *action, *first_action = NULL;
- PyObject *callback = Py_None;
- GClosure *closure;
- GSList * group = NULL;
- gint value = 0;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|iOO:GtkActionGroup.add_radio_actions",
- kwlist, &entries, &value, &callback, &extra_args))
- return NULL;
-
- if (!PySequence_Check(entries)) {
- PyErr_SetString(PyExc_TypeError, "entries must be a sequence");
- return NULL;
- }
-
- state = pyg_gil_state_ensure();
-
- len = PySequence_Size(entries);
- for (i = 0; i < len; i++) {
- item = PySequence_GetItem(entries, i);
- Py_DECREF(item);
-
- memset(&entry, 0, sizeof(entry));
-
- if (!PyArg_ParseTuple(item, "s|zzzzi", &(entry.name),
- &(entry.stock_id),
- &(entry.label), &(entry.accelerator),
- &(entry.tooltip),
- &(entry.value))) {
- return NULL;
- }
-
- action = gtk_radio_action_new(entry.name, entry.label, entry.tooltip,
- entry.stock_id, entry.value);
- if (action == NULL) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkRadioAction object");
- return NULL;
- }
-
- gtk_radio_action_set_group(action, group);
- group = gtk_radio_action_get_group(action);
-
- if (value == entry.value)
- gtk_toggle_action_set_active(GTK_TOGGLE_ACTION(action), TRUE);
-
- gtk_action_group_add_action_with_accel (GTK_ACTION_GROUP(self->obj),
- GTK_ACTION(action),
- entry.accelerator);
-
- if (i == 0)
- first_action = action;
- else
- g_object_unref (action);
- }
-
- if (first_action && callback != Py_None && PyCallable_Check(callback)) {
- PyObject *py_action;
-
- closure = pyg_closure_new(callback, extra_args, NULL);
- g_signal_connect_closure(first_action, "changed", closure, FALSE);
- py_action = pygobject_new((GObject *)first_action);
- pygobject_watch_closure(py_action, closure);
- g_object_unref(first_action);
- Py_DECREF (py_action);
- }
-
- pyg_gil_state_release(state);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_ui_manager_add_ui_from_string kwargs
-static PyObject *
-_wrap_gtk_ui_manager_add_ui_from_string(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "buffer", NULL };
- char *buffer;
- Py_ssize_t length;
- int ret;
- GError *error = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s#:GtkUIManager.add_ui_from_string",
- kwlist, &buffer, &length))
- return NULL;
-
- ret = gtk_ui_manager_add_ui_from_string(GTK_UI_MANAGER(self->obj),
- buffer, length, &error);
- if (pyg_error_check(&error))
- return NULL;
- return PyInt_FromLong(ret);
-}
-%%
-override gtk_action_group_list_actions noargs
-static PyObject *
-_wrap_gtk_action_group_list_actions(PyGObject *self)
-{
- GList *l, *actions;
- PyObject *item, *ret;
-
- ret = PyList_New(0);
- if (ret == NULL)
- return NULL;
-
- actions = gtk_action_group_list_actions(GTK_ACTION_GROUP(self->obj));
-
- for (l = actions; l; l = l->next) {
- item = pygobject_new((GObject *) GTK_ACTION(l->data));
-
- if (!item) {
- Py_DECREF(ret);
- return NULL;
- }
-
- PyList_Append(ret, item);
- Py_DECREF(item);
- }
-
- g_list_free(actions);
-
- return ret;
-}
-%%
-override gtk_alignment_get_padding noargs
-static PyObject *
-_wrap_gtk_alignment_get_padding(PyGObject *self)
-{
- guint top, bottom, left, right;
-
- gtk_alignment_get_padding(GTK_ALIGNMENT(self->obj), &top, &bottom, &left,
- &right);
- return Py_BuildValue("(iiii)", top, bottom, left, right);
-}
-%%
-override gtk_accel_group_connect_by_path kwargs
-static PyObject *
-_wrap_gtk_accel_group_connect_by_path(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "accel_path", "callback", NULL };
- gchar *accel_path;
- PyObject *py_callback;
- GClosure *closure;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "sO:GtkAccelGroup.connect_by_path", kwlist,
- &accel_path, &py_callback))
- return NULL;
- if (!PyCallable_Check(py_callback)) {
- PyErr_SetString(PyExc_TypeError, "callback argument not callable");
- return NULL;
- }
- closure = pyg_closure_new(py_callback, NULL, NULL);
- pygobject_watch_closure((PyObject *)self, closure);
- gtk_accel_group_connect_by_path(GTK_ACCEL_GROUP(self->obj), accel_path,
- closure);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_color_button_new kwargs
-static int
-_wrap_gtk_color_button_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "color", NULL };
- GdkColor *color = NULL;
- PyObject *pycolor = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|O:GtkColorButton.__init__",
- kwlist, &pycolor))
- return -1;
- if (pycolor) {
- if (!pyg_boxed_check(pycolor, GDK_TYPE_COLOR)) {
- PyErr_SetString(PyExc_TypeError,
- "color should be a gtk.gdk.Color");
- return -1;
- }
- color = pyg_boxed_get(pycolor, GdkColor);
- pygobject_construct(self, "color", color, NULL);
- } else {
- pygobject_construct(self, NULL);
- }
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError, "could not create GtkColorButton object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_COLOR_BUTTON
-%%
-override gtk_color_button_get_color noargs
-static PyObject *
-_wrap_gtk_color_button_get_color(PyGObject *self)
-{
- GdkColor color = {0, 0, 0, 0};
-
- gtk_color_button_get_color(GTK_COLOR_BUTTON(self->obj), &color);
- return pyg_boxed_new(GDK_TYPE_COLOR, &color, TRUE, TRUE);
-}
-%%
-override gtk_combo_box_new kwargs
-static int
-_wrap_gtk_combo_box_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "model", NULL };
- PyGObject *pymodel = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O:GtkComboBox.__init__",
- kwlist, &pymodel))
- return -1;
- if (pymodel == NULL || (PyObject *)pymodel == Py_None)
- pygobject_construct(self, NULL);
- else if (pygobject_check(pymodel, &PyGtkTreeModel_Type))
- pygobject_construct(self, "model", GTK_TREE_MODEL(pymodel->obj), NULL);
- else {
- PyErr_SetString(PyExc_TypeError,
- "model must be a gtk.TreeModel or None");
- return -1;
- }
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkComboBox object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_COMBO_BOX
-%%
-override gtk_combo_box_get_active_iter noargs
-static PyObject *
-_wrap_gtk_combo_box_get_active_iter(PyGObject *self)
-{
- GtkTreeIter iter;
- gboolean ret;
-
- ret = gtk_combo_box_get_active_iter(GTK_COMBO_BOX(self->obj), &iter);
-
- if (ret)
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_cell_layout_set_attributes kwargs
-static PyObject *
-_wrap_gtk_cell_layout_set_attributes(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- PyObject *py_cell, *key, *item;
- GtkCellRenderer *cell;
- Py_ssize_t i = 0;
-
- if (!PyArg_ParseTuple(args, "O!:GtkCellLayout.set_attributes",
- &PyGtkCellRenderer_Type, &py_cell))
- return NULL;
- cell = GTK_CELL_RENDERER(pygobject_get(py_cell));
- gtk_cell_layout_clear_attributes(GTK_CELL_LAYOUT(self->obj), cell);
- if (kwargs) {
- while (PyDict_Next(kwargs, &i, &key, &item)) {
- gchar *attr = PyString_AsString(key);
-
- if (!PyInt_Check(item)) {
- gchar err[128];
- g_snprintf(err, sizeof(err),
- "%s must be an integer column number", attr);
- PyErr_SetString(PyExc_TypeError, err);
- return NULL;
- }
- gtk_cell_layout_add_attribute(GTK_CELL_LAYOUT(self->obj),
- cell, attr, PyInt_AsLong(item));
- }
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_combo_box_entry_new kwargs
-static int
-_wrap_gtk_combo_box_entry_new(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "model", "column", NULL };
- PyGObject *pymodel = NULL;
- gint column = 0;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|Oi:GtkComboBoxEntry.__init__",
- kwlist, &pymodel, &column))
- return -1;
- if ((PyObject*)pymodel == Py_None || pymodel == NULL)
- pygobject_construct(self, NULL);
- else if (pygobject_check(pymodel, &PyGtkTreeModel_Type)) {
- gint ncol = gtk_tree_model_get_n_columns(GTK_TREE_MODEL(pymodel->obj));
-
- if (column < 0 || column >= ncol) {
- PyErr_SetString(PyExc_ValueError, "column value out of range");
- return -1;
- }
- pygobject_construct(self, "model", GTK_TREE_MODEL(pymodel->obj),
- "text-column", column, NULL);
- } else {
- PyErr_SetString(PyExc_TypeError,
- "model must be a gtk.TreeModel or None");
- return -1;
- }
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkComboBoxEntry object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_COMBO_BOX_ENTRY
-%%
-override gtk_entry_completion_set_match_func args
-static gboolean
-pygtk_entry_completion_match_func_cb(GtkEntryCompletion *completion,
- const gchar *key,
- GtkTreeIter *iter,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *py_completion, *py_iter;
- gboolean ret = FALSE;
- PyObject *retobj;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_completion = pygobject_new((GObject *)completion);
- py_iter = pyg_boxed_new(GTK_TYPE_TREE_ITER, iter, TRUE, TRUE);
-
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(NsNO)", py_completion,
- key, py_iter, cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(NsN)", py_completion,
- key, py_iter);
- }
-
- if (retobj != NULL) {
- ret = PyObject_IsTrue(retobj);
- Py_DECREF(retobj);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_entry_completion_set_match_func(PyGObject *self, PyObject *args)
-{
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTuple(args,
- "O|O:GtkEntryCompletion.set_match_func",
- &pyfunc, &pyarg))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- }
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_entry_completion_set_match_func(GTK_ENTRY_COMPLETION(self->obj),
- pygtk_entry_completion_match_func_cb,
- cunote, pygtk_custom_destroy_notify);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_file_chooser_get_filenames noargs
-static PyObject *
-_wrap_gtk_file_chooser_get_filenames(PyGObject *self)
-{
- PyObject *py_list;
- GSList *slist, *tmp;
- int i, slen;
-
- slist = gtk_file_chooser_get_filenames(GTK_FILE_CHOOSER(self->obj));
- slen = g_slist_length(slist);
- if ((py_list = PyList_New(slen)) == NULL)
- return NULL;
-
- for (i = 0, tmp = slist; i < slen && tmp != NULL; tmp = tmp->next, i++) {
- PyObject *obj = PyString_FromString((char *)tmp->data);
- if (obj == NULL) {
- g_slist_foreach(slist, (GFunc)g_free, NULL);
- g_slist_free(slist);
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_SetItem(py_list, i, obj);
- }
- g_slist_foreach(slist, (GFunc)g_free, NULL);
- g_slist_free(slist);
- return py_list;
-}
-%%
-override gtk_file_chooser_get_uris noargs
-static PyObject *
-_wrap_gtk_file_chooser_get_uris(PyGObject *self)
-{
- PyObject *py_list;
- GSList *slist, *tmp;
- int i, slen;
-
- slist = gtk_file_chooser_get_uris(GTK_FILE_CHOOSER(self->obj));
- slen = g_slist_length(slist);
- if ((py_list = PyList_New(slen)) == NULL)
- return NULL;
-
- for (i = 0, tmp = slist; i < slen && tmp != NULL; tmp = tmp->next, i++) {
- PyObject *obj = PyString_FromString((char *)tmp->data);
- if (obj == NULL) {
- g_slist_foreach(slist, (GFunc)g_free, NULL);
- g_slist_free(slist);
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_SetItem(py_list, i, obj);
- }
- g_slist_foreach(slist, (GFunc)g_free, NULL);
- g_slist_free(slist);
- return py_list;
-}
-%%
-override gtk_file_chooser_list_filters noargs
-static PyObject *
-_wrap_gtk_file_chooser_list_filters(PyGObject *self)
-{
- PyObject *py_list;
- GSList *slist, *tmp;
- int i, slen;
-
- slist = gtk_file_chooser_list_filters(GTK_FILE_CHOOSER(self->obj));
- slen = g_slist_length(slist);
- if ((py_list = PyList_New(slen)) == NULL)
- return NULL;
-
- for (i = 0, tmp = slist; i < slen && tmp != NULL; tmp = tmp->next, i++) {
- PyObject *obj = pygobject_new(G_OBJECT(tmp->data));
- if (obj == NULL) {
- g_slist_free(slist);
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_SetItem(py_list, i, obj);
- }
- g_slist_free(slist);
- return py_list;
-}
-%%
-override gtk_file_chooser_list_shortcut_folder_uris noargs
-static PyObject *
-_wrap_gtk_file_chooser_list_shortcut_folder_uris(PyGObject *self)
-{
- PyObject *py_list;
- GSList *slist, *tmp;
- int i, slen;
-
- slist = gtk_file_chooser_list_shortcut_folder_uris(GTK_FILE_CHOOSER(self->obj));
-
- slen = g_slist_length(slist);
- if ((py_list = PyList_New(slen)) == NULL)
- return NULL;
-
- for (i = 0, tmp = slist; i < slen && tmp != NULL; tmp = tmp->next, i++) {
- PyObject *obj = PyString_FromString((char *)tmp->data);
- if (obj == NULL) {
- g_slist_foreach(slist, (GFunc)g_free, NULL);
- g_slist_free(slist);
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_SetItem(py_list, i, obj);
- }
- g_slist_foreach(slist, (GFunc)g_free, NULL);
- g_slist_free(slist);
- return py_list;
-}
-%%
-override gtk_file_chooser_list_shortcut_folders noargs
-static PyObject *
-_wrap_gtk_file_chooser_list_shortcut_folders(PyGObject *self)
-{
- PyObject *py_list;
- GSList *slist, *tmp;
- int i, slen;
-
- slist = gtk_file_chooser_list_shortcut_folders(GTK_FILE_CHOOSER(self->obj));
- slen = g_slist_length(slist);
- if ((py_list = PyList_New(slen)) == NULL)
- return NULL;
-
- for (i = 0, tmp = slist; i < slen && tmp != NULL; tmp = tmp->next, i++) {
- PyObject *obj = PyString_FromString((char *)tmp->data);
- if (obj == NULL) {
- g_slist_foreach(slist, (GFunc)g_free, NULL);
- g_slist_free(slist);
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_SetItem(py_list, i, obj);
- }
- g_slist_foreach(slist, (GFunc)g_free, NULL);
- g_slist_free(slist);
- return py_list;
-}
-%%
-override gtk_file_chooser_widget_new kwargs
-static int
-_wrap_gtk_file_chooser_widget_new(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "action", "backend", NULL };
- PyObject *py_action = NULL;
- gchar * backend = NULL;
- GtkFileChooserAction action = GTK_FILE_CHOOSER_ACTION_OPEN;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|Oz:GtkFileChooserWidget.__init__",
- kwlist, &py_action, &backend))
- return -1;
- if (py_action && pyg_enum_get_value(GTK_TYPE_FILE_CHOOSER_ACTION,
- py_action, (gint *)&action))
- return -1;
- pygobject_construct(self,
- "action", action, "file-system-backend", backend,
- NULL);
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkFileChooserWidget object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_FILE_CHOOSER_WIDGET
-%%
-override gtk_file_filter_filter kwargs
-static PyObject *
-_wrap_gtk_file_filter_filter(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "filter_info", NULL };
- GtkFileFilterInfo filter_info = { 0, NULL, NULL, NULL, NULL };
- PyObject *py_filter_info, *obj;
- PyObject *pyret = Py_False;
- int size;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!:GtkFileFilter.filter", kwlist,
- &PyTuple_Type, &py_filter_info))
- return NULL;
-
- size = PyTuple_Size(py_filter_info);
- if (size != 4) {
- PyErr_SetString(PyExc_RuntimeError,
- "filter_info tuple must contain 4 items"
- " each of type string or None");
- return NULL;
- }
-
- if ((obj = PyTuple_GetItem(py_filter_info, 0)) != Py_None) {
- if (!PyString_Check(obj))
- goto error;
- filter_info.filename = PyString_AsString(obj);
- filter_info.contains |= GTK_FILE_FILTER_FILENAME;
- }
- if ((obj = PyTuple_GetItem(py_filter_info, 1)) != Py_None) {
- if (!PyString_Check(obj))
- goto error;
- filter_info.uri = PyString_AsString(obj);
- filter_info.contains |= GTK_FILE_FILTER_URI;
- }
- if ((obj = PyTuple_GetItem(py_filter_info, 2)) != Py_None) {
- if (!PyString_Check(obj))
- goto error;
- filter_info.display_name = PyString_AsString(obj);
- filter_info.contains |= GTK_FILE_FILTER_DISPLAY_NAME;
- }
- if ((obj = PyTuple_GetItem(py_filter_info, 3)) != Py_None) {
- if (!PyString_Check(obj))
- goto error;
- filter_info.mime_type = PyString_AsString(obj);
- filter_info.contains |= GTK_FILE_FILTER_MIME_TYPE;
- }
-
- if (gtk_file_filter_filter(GTK_FILE_FILTER(self->obj), &filter_info))
- pyret = Py_True;
- Py_INCREF(pyret);
- return pyret;
-
- error:
- PyErr_SetString(PyExc_TypeError, "filter_info 4-tuple items"
- " must be of type string or None");
- return NULL;
-}
-%%
-override gtk_file_filter_add_custom args
-static gboolean
-pygtk_file_filter_add_custom_cb(const GtkFileFilterInfo *filter_info,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- gboolean ret = FALSE;
- PyObject *retobj, *py_filter_info, *py_obj;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_filter_info = PyTuple_New(4);
-
- if (filter_info->filename
- && (filter_info->contains & GTK_FILE_FILTER_FILENAME)) {
- py_obj = PyString_FromString(filter_info->filename);
- } else {
- Py_INCREF(Py_None);
- py_obj = Py_None;
- }
- PyTuple_SetItem(py_filter_info, 0, py_obj);
- if (filter_info->uri
- && (filter_info->contains & GTK_FILE_FILTER_URI)) {
- py_obj = PyString_FromString(filter_info->uri);
- } else {
- Py_INCREF(Py_None);
- py_obj = Py_None;
- }
- PyTuple_SetItem(py_filter_info, 1, py_obj);
- if (filter_info->display_name
- && (filter_info->contains & GTK_FILE_FILTER_DISPLAY_NAME)) {
- py_obj = PyString_FromString(filter_info->display_name);
- } else {
- Py_INCREF(Py_None);
- py_obj = Py_None;
- }
- PyTuple_SetItem(py_filter_info, 2, py_obj);
- if (filter_info->mime_type
- && (filter_info->contains & GTK_FILE_FILTER_MIME_TYPE)) {
- py_obj = PyString_FromString(filter_info->mime_type);
- } else {
- Py_INCREF(Py_None);
- py_obj = Py_None;
- }
- PyTuple_SetItem(py_filter_info, 3, py_obj);
-
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(NO)", py_filter_info,
- cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(N)", py_filter_info);
- }
-
- if (retobj != NULL) {
- ret = PyObject_IsTrue(retobj);
- Py_DECREF(retobj);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_file_filter_add_custom(PyGObject *self, PyObject *args)
-{
- PyObject *pyfunc, *pyflags, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
- GtkFileFilterFlags flags;
-
- if (!PyArg_ParseTuple(args,
- "OO|O:GtkEntryCompletion.set_match_func",
- &pyflags, &pyfunc, &pyarg))
- return NULL;
-
- if (pyg_flags_get_value(GTK_TYPE_FILE_FILTER_FLAGS, pyflags,
- (gint *)&flags))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- }
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_file_filter_add_custom(GTK_FILE_FILTER(self->obj), flags,
- pygtk_file_filter_add_custom_cb,
- cunote, pygtk_custom_destroy_notify);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_font_button_new kwargs
-static int
-_wrap_gtk_font_button_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "fontname", NULL };
- gchar * fontname = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|z:GtkFontButton.__init__",
- kwlist, &fontname))
- return -1;
-
- if (fontname == NULL)
- pygobject_construct(self, NULL);
- else
- pygobject_construct(self, "font-name", fontname, NULL);
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkFontButton object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_FONT_BUTTON
-%%
-override gtk_action_get_proxies noargs
-static PyObject *
-_wrap_gtk_action_get_proxies(PyGObject *self)
-{
- PyObject *py_list;
- GSList *slist, *tmp;
- int i, slen;
-
- slist = gtk_action_get_proxies(GTK_ACTION(self->obj));
- slen = g_slist_length(slist);
- if ((py_list = PyList_New(slen)) == NULL)
- return NULL;
-
- for (i = 0, tmp = slist; i < slen && tmp != NULL; tmp = tmp->next, i++) {
- PyObject *obj = pygobject_new(G_OBJECT(tmp->data));
- if (obj == NULL) {
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_SetItem(py_list, i, obj);
- }
- return py_list;
-}
-%%
-override gtk_clipboard_wait_for_targets noargs
-static PyObject *
-_wrap_gtk_clipboard_wait_for_targets(PyGObject *self)
-{
- GtkSelectionData *data;
-
- /* have to work around GTK+ bug #139883 */
- data = gtk_clipboard_wait_for_contents(GTK_CLIPBOARD(self->obj),
- gdk_atom_intern("TARGETS", FALSE));
-
- if (data) {
- gint n_targets = 0;
- GdkAtom *targets = NULL;
-
- if (gtk_selection_data_get_targets(data, &targets, &n_targets)) {
- PyObject *ret;
- int i;
-
- ret = PyTuple_New(n_targets);
- for (i = 0; i < n_targets; i++) {
- gchar *name;
-
- name = gdk_atom_name(targets[i]);
- PyTuple_SetItem(ret, i, PyString_FromString(name));
- g_free(name);
- }
- g_free(targets);
- gtk_selection_data_free(data);
- return ret;
- }
- gtk_selection_data_free(data);
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_clipboard_request_contents kwargs
-static void
-clipboard_request_contents_cb(GtkClipboard *clipboard,
- GtkSelectionData *selection_data,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyObject *callback, *args, *ret;
-
- state = pyg_gil_state_ensure();
- callback = PyTuple_GetItem((PyObject *)user_data, 0);
- args = Py_BuildValue("(NNO)",
- pygobject_new((GObject *)clipboard),
- pyg_boxed_new(GTK_TYPE_SELECTION_DATA,
- selection_data, TRUE, TRUE),
- PyTuple_GetItem((PyObject *)user_data, 1));
- ret = PyObject_CallObject(callback, args);
- if (!ret)
- PyErr_Print();
- Py_XDECREF(ret);
- Py_DECREF(args);
- Py_DECREF((PyObject *)user_data);
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_clipboard_request_contents(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "target", "callback", "user_data", NULL };
- PyObject *py_target, *callback, *data, *user_data = Py_None;
- GdkAtom target;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO|O:GtkClipboard.request_contents",
- kwlist, &py_target, &callback,
- &user_data))
- return NULL;
- if (!PyCallable_Check(callback)) {
- PyErr_SetString(PyExc_TypeError, "callback must be callable");
- return NULL;
- }
- target = pygdk_atom_from_pyobject(py_target);
- if (PyErr_Occurred())
- return NULL;
-
- data = Py_BuildValue("(OO)", callback, user_data);
- gtk_clipboard_request_contents(GTK_CLIPBOARD(self->obj), target,
- clipboard_request_contents_cb,
- (gpointer)data);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_clipboard_request_text kwargs
-static void
-clipboard_request_text_cb(GtkClipboard *clipboard,
- const gchar *text,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyObject *callback, *args, *ret, *py_text, *data;
-
- data = (PyObject *) user_data;
-
- if (text) {
- py_text = PyString_FromString(text);
- } else {
- py_text = Py_None;
- Py_INCREF(Py_None);
- }
-
- state = pyg_gil_state_ensure();
- callback = PyTuple_GetItem(data, 0);
- args = Py_BuildValue("(NNO)",
- pygobject_new((GObject *)clipboard),
- py_text,
- PyTuple_GetItem(data, 1));
- ret = PyObject_CallObject(callback, args);
- if (!ret)
- PyErr_Print();
- Py_XDECREF(ret);
- Py_DECREF(data);
- Py_DECREF(args);
- pyg_gil_state_release(state);
-}
-
-static PyObject *
-_wrap_gtk_clipboard_request_text(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "callback", "user_data", NULL };
- PyObject *callback, *data, *user_data = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkClipboard.request_text",
- kwlist, &callback, &user_data))
- return NULL;
- if (!PyCallable_Check(callback)) {
- PyErr_SetString(PyExc_TypeError, "callback must be callable");
- return NULL;
- }
-
- data = Py_BuildValue("(OO)", callback, user_data);
- gtk_clipboard_request_text(GTK_CLIPBOARD(self->obj),
- clipboard_request_text_cb,
- (gpointer)data);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_clipboard_request_targets kwargs
-static void
-clipboard_request_targets_cb(GtkClipboard *clipboard,
- GdkAtom *atoms,
- gint n_atoms,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyObject *callback, *args, *ret, *py_atoms;
- int i;
-
- state = pyg_gil_state_ensure();
- callback = PyTuple_GetItem((PyObject *)user_data, 0);
- if (atoms) {
- py_atoms = PyTuple_New(n_atoms);
- for (i = 0; i < n_atoms; i++) {
- gchar *name;
-
- name = gdk_atom_name(atoms[i]);
- PyTuple_SetItem(py_atoms, i, PyString_FromString(name));
- g_free(name);
- }
- } else
- py_atoms = PyTuple_New(0);
- args = Py_BuildValue("(NNO)",
- pygobject_new((GObject *)clipboard),
- py_atoms,
- PyTuple_GetItem((PyObject *)user_data, 1));
- ret = PyObject_CallObject(callback, args);
- if (!ret)
- PyErr_Print();
- Py_XDECREF(ret);
- Py_DECREF(args);
- Py_DECREF((PyObject *)user_data);
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_clipboard_request_targets(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "callback", "user_data", NULL };
- PyObject *callback, *data, *user_data = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkClipboard.request_targets",
- kwlist, &callback, &user_data))
- return NULL;
- if (!PyCallable_Check(callback)) {
- PyErr_SetString(PyExc_TypeError, "callback must be callable");
- return NULL;
- }
-
- data = Py_BuildValue("(OO)", callback, user_data);
- gtk_clipboard_request_targets(GTK_CLIPBOARD(self->obj),
- clipboard_request_targets_cb,
- (gpointer)data);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_size_lookup_for_settings kwargs
-static PyObject *
-_wrap_gtk_icon_size_lookup_for_settings(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "settings", "icon_size", NULL };
- PyObject *py_settings, *py_icon_size;
- GtkSettings *settings;
- GtkIconSize icon_size;
- gint width, height;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!O:icon_size_lookupfor settings",
- kwlist, &PyGtkSettings_Type,
- &py_settings, &py_icon_size))
- return NULL;
-
- if (pyg_enum_get_value(GTK_TYPE_ICON_SIZE, py_icon_size,
- (gint *) &icon_size))
- return NULL;
-
- settings = GTK_SETTINGS(pygobject_get(py_settings));
- if (gtk_icon_size_lookup_for_settings(settings, icon_size,
- &width, &height))
- return Py_BuildValue("(ii)", width, height);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_theme_set_search_path kwargs
-static PyObject *
-_wrap_gtk_icon_theme_set_search_path(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "path", NULL };
- int i, len;
- PyObject *py_seq;
- gchar **paths;
-
- if (!PyArg_ParseTupleAndKeywords(args,kwargs,
- "O:GtkIconTheme.set_search_path",
- kwlist, &py_seq))
- return NULL;
-
- if (!PySequence_Check(py_seq) || (len = PySequence_Size(py_seq)) < 0) {
- PyErr_SetString(PyExc_ValueError,
- "path should be a sequence of strings");
- return NULL;
- }
-
- paths = g_new(gchar *, len);
- for (i = 0; i < len; i++) {
- PyObject *py_path = PySequence_GetItem(py_seq, i);
- if (!PyString_Check(py_path)) {
- PyErr_SetString(PyExc_ValueError, "path items must be strings");
- Py_DECREF(py_path);
- g_free(paths);
- return NULL;
- }
- paths[i] = PyString_AsString(py_path);
- Py_DECREF(py_path);
- }
-
- gtk_icon_theme_set_search_path(GTK_ICON_THEME(self->obj),
- (const gchar **)paths, len);
-
- g_free(paths);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_theme_get_search_path noargs
-static PyObject *
-_wrap_gtk_icon_theme_get_search_path(PyGObject *self)
-{
- gchar **paths;
- gint n_items;
- PyObject *py_tuple;
- int i;
-
- gtk_icon_theme_get_search_path(GTK_ICON_THEME(self->obj),
- &paths, &n_items);
-
- py_tuple = PyTuple_New(n_items);
- for (i = 0; i < n_items; i++)
- PyTuple_SetItem(py_tuple, i, PyString_FromString(paths[i]));
-
- g_strfreev(paths);
-
- return py_tuple;
-}
-%%
-override gtk_icon_theme_list_icons kwargs
-static PyObject *
-_wrap_gtk_icon_theme_list_icons(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "context", NULL };
- GList *icons;
- gchar *context = NULL;
- int i;
- guint len;
- PyObject *py_icons;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|z:GtkIconTheme.list_icons",
- kwlist, &context))
- return NULL;
-
- icons = gtk_icon_theme_list_icons(GTK_ICON_THEME(self->obj), context);
- len = g_list_length(icons);
-
- py_icons = PyTuple_New(len);
-
- for (i = 0; i < len; i++) {
- char *name = (char *)g_list_nth_data(icons, i);
-
- PyTuple_SetItem(py_icons, i, PyString_FromString(name));
- }
- g_list_foreach(icons, (GFunc)g_free, NULL);
- g_list_free(icons);
-
- return py_icons;
-}
-%%
-override gtk_icon_info_get_embedded_rect noargs
-static PyObject *
-_wrap_gtk_icon_info_get_embedded_rect(PyGObject *self)
-{
- GdkRectangle rect;
- int ret;
-
- ret = gtk_icon_info_get_embedded_rect(pyg_boxed_get(self, GtkIconInfo),
- &rect);
-
- if (ret)
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &rect, TRUE, TRUE);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_info_get_attach_points noargs
-static PyObject *
-_wrap_gtk_icon_info_get_attach_points(PyGObject *self)
-{
- GdkPoint *points;
- gint n_points;
- int ret;
- PyObject *py_points;
-
- ret = gtk_icon_info_get_attach_points(pyg_boxed_get(self, GtkIconInfo),
- &points, &n_points);
- if (ret) {
- int i;
-
- py_points = PyTuple_New(n_points);
- for (i = 0; i < n_points; i++)
- PyTuple_SetItem(py_points, i, Py_BuildValue("(ii)",
- points[i].x,
- points[i].y));
- g_free(points);
- return py_points;
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_radio_action_set_group kwargs
-static PyObject *
-_wrap_gtk_radio_action_set_group(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "group", NULL };
- GSList *list;
- GtkRadioAction *group;
- PyObject *py_group;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkRadioAction.set_group",
- kwlist, &py_group))
- return NULL;
-
- if (pygobject_check(py_group, &PyGtkRadioAction_Type)) {
- group = GTK_RADIO_ACTION(pygobject_get(py_group));
- list = gtk_radio_action_get_group(group);
- if (list == gtk_radio_action_get_group(GTK_RADIO_ACTION(self->obj))) {
- PyErr_SetString(PyExc_ValueError, "radio action already in group");
- return NULL;
- }
- } else if (py_group == Py_None) {
- list = NULL;
- } else {
- PyErr_SetString(PyExc_TypeError, "group must be a RadioAction or None");
- return NULL;
- }
-
- gtk_radio_action_set_group(GTK_RADIO_ACTION(self->obj), list);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_radio_action_get_group noargs
-static PyObject *
-_wrap_gtk_radio_action_get_group(PyGObject *self) {
- PyObject *py_list;
- GSList *list, *tmp;
- PyObject *gtk_obj;
-
- list = gtk_radio_action_get_group(GTK_RADIO_ACTION(self->obj));
-
- if ((py_list = PyList_New(0)) == NULL) {
- return NULL;
- }
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- gtk_obj = pygobject_new(G_OBJECT(tmp->data));
- if (gtk_obj == NULL) {
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_Append(py_list, gtk_obj);
- Py_DECREF(gtk_obj);
- }
- return py_list;
-}
-%%
-override gtk_scale_get_layout_offsets noargs
-static PyObject *
-_wrap_gtk_scale_get_layout_offsets(PyGObject *self)
-{
- gint x = 0, y = 0;
-
- gtk_scale_get_layout_offsets(GTK_SCALE(self->obj), &x, &y);
-
- return Py_BuildValue("(ii)", x, y);
-}
-%%
-override gtk_tooltips_get_info_from_tip_window noargs
-static PyObject *
-_wrap_gtk_tooltips_get_info_from_tip_window(PyGObject *self)
-{
- gboolean ret;
- GtkWidget *widget;
- GtkTooltips *tooltips;
-
- ret = gtk_tooltips_get_info_from_tip_window(GTK_WINDOW(self->obj),
- &tooltips, &widget);
- if (ret)
- return Py_BuildValue("(NN)",
- pygobject_new((GObject *)tooltips),
- pygobject_new((GObject *)widget));
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_menu_item_toggle_size_request noargs
-static PyObject *
-_wrap_gtk_menu_item_toggle_size_request(PyGObject *self)
-{
- gint requisition;
-
- gtk_menu_item_toggle_size_request(GTK_MENU_ITEM(self->obj), &requisition);
-
- return PyInt_FromLong(requisition);
-}
-%%
-override gtk_entry_new kwargs
-static int
-_wrap_gtk_entry_new(PyGObject * self, PyObject * args, PyObject * kwargs)
-{
- static char *kwlist[] = { "max", NULL };
- int max = 0;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|i:GtkEntry.__init__",
- kwlist, &max))
- return -1;
- pygobject_construct(self, "max-length", max, NULL);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkEntry object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_ENTRY
-%%
-override gtk_accel_groups_from_object
-static PyObject *
-_wrap_gtk_accel_groups_from_object(PyGObject *self, PyObject *args)
-{
- PyGObject *obj;
- PyObject *py_list;
- GSList *list, *tmp;
- PyObject *item;
-
- if (!PyArg_ParseTuple(args, "O!:accel_group_from_object",
- &PyGObject_Type, &obj))
- return NULL;
-
- list = gtk_accel_groups_from_object(G_OBJECT(obj->obj));
-
- if ((py_list = PyList_New(0)) == NULL) {
- return NULL;
- }
-
- for (tmp = list; tmp; tmp = tmp->next) {
- item = pygobject_new(G_OBJECT(tmp->data));
- if (item == NULL) {
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_Append(py_list, item);
- Py_DECREF(item);
- }
-
- return py_list;
-}
-%%
-override gtk_table_new kwargs
-static int
-_wrap_gtk_table_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- char *arg_names[] = {"rows", "columns", "homogeneous", NULL };
- int rows = 1, cols = 1;
- PyObject *homogeneous = Py_False;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|iiO:gtk.Table.__init__", arg_names,
- &rows, &cols, &homogeneous))
- return -1;
- pygobject_construct(self, "n_rows", rows, "n_columns", cols,
- "homogeneous", PyObject_IsTrue(homogeneous), NULL);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError, "could not create gtk.Table object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_TABLE
-%%
-override gtk_pixmap_new kwargs
-static int
-_wrap_gtk_pixmap_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "pixmap", "mask", NULL };
- PyGObject *pixmap, *py_mask;
- GdkPixmap *mask = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!O:GtkPixmap.__init__",
- kwlist, &PyGdkPixmap_Type, &pixmap, &py_mask))
- return -1;
- if (PyErr_Warn(PyExc_DeprecationWarning, "use GtkImage") < 0)
- return -1;
- if (py_mask && pygobject_check(py_mask, &PyGdkPixmap_Type))
- mask = GDK_PIXMAP(py_mask->obj);
- else if ((PyObject *)py_mask != Py_None) {
- PyErr_SetString(PyExc_TypeError, "mask should be a GdkPixmap or None");
- return -1;
- }
-
- pygobject_construct(self, NULL);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError, "could not create GtkPixmap object");
- return -1;
- }
-
- gtk_pixmap_set(GTK_PIXMAP(self->obj), GDK_PIXMAP(pixmap->obj), mask);
-
- return 0;
-}
-%%
-new-constructor GTK_TYPE_PIXMAP
-%%
-override gtk_plug_new kwargs
-static int
-_wrap_gtk_plug_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "socket_id", "display", NULL };
- PyObject *py_socket_id = NULL;
- gulong socket_id;
- PyGObject *display = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!|O!:GtkPlug.__init__", kwlist,
- &PyLong_Type, &py_socket_id,
- &PyGdkDisplay_Type, &display))
- return -1;
-
- socket_id = PyLong_AsUnsignedLong(py_socket_id);
-
- pygobject_construct(self, NULL);
-
- if (display)
- gtk_plug_construct_for_display(GTK_PLUG(self->obj),
- GDK_DISPLAY(display->obj), socket_id);
- else
- gtk_plug_construct(GTK_PLUG(self->obj), socket_id);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError, "could not create GtkPlug object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_PLUG
-%%
-override gtk_adjustment_new kwargs
-static int
-_wrap_gtk_adjustment_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- char *kwlist[] = {"value", "lower", "upper", "step_incr",
- "page_incr", "page_size", NULL };
- gdouble value = 0;
- gdouble lower = 0;
- gdouble upper = 0;
- gdouble step_incr = 0;
- gdouble page_incr = 0;
- gdouble page_size = 0;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|dddddd:gtk.Adjustment.__init__" ,
- kwlist, &value, &lower, &upper, &step_incr,
- &page_incr, &page_size))
- return -1;
-
- pygobject_construct(self, "lower", lower, "upper", upper,
- "step_increment", step_incr,
- "page_increment", page_incr,
- "page_size", page_size,
- "value", value, NULL);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create gtk.Adjustment object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_ADJUSTMENT
-%%
-override gtk_alignment_new kwargs
-static int
-_wrap_gtk_alignment_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- char *kwlist[] = {"xalign", "yalign", "xscale", "yscale", NULL };
- gdouble xalign = 0;
- gdouble yalign = 0;
- gdouble xscale = 0;
- gdouble yscale = 0;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|dddd:gtk.Alignment.__init__" ,
- kwlist, &xalign, &yalign, &xscale, &yscale))
- return -1;
-
- pygobject_construct(self, "xalign", xalign, "yalign", yalign,
- "xscale", xscale, "yscale", yscale, NULL);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create gtk.Alignment object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_ALIGNMENT
-%%
-override gtk_about_dialog_set_authors kwargs
-static PyObject *
-_wrap_gtk_about_dialog_set_authors(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- gchar **authors = NULL;
- static char *kwlist[] = { "authors", NULL };
- PyObject *py_authors = NULL;
- int i, n_authors;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkAboutDialog.set_authors",
- kwlist, &py_authors))
- return NULL;
-
- if (!PySequence_Check(py_authors)) {
- PyErr_SetString(PyExc_TypeError, "authors must be a sequence");
- return NULL;
- }
-
- n_authors = PySequence_Length(py_authors);
- authors = g_new(gchar *, n_authors + 1);
- for (i = 0; i < n_authors; i++) {
- PyObject *item = PySequence_GetItem(py_authors, i);
- Py_DECREF(item); /* PySequence_GetItem INCREF's */
- authors[i] = PyString_AsString(item);
- }
- authors[n_authors] = NULL;
-
- gtk_about_dialog_set_authors(GTK_ABOUT_DIALOG(self->obj),
- (const char **)authors);
-
- g_free(authors);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_about_dialog_get_authors noargs
-static PyObject *
-_wrap_gtk_about_dialog_get_authors(PyGObject *self)
-{
- gchar **authors, **tmp;
- int i = 0, j;
- PyObject *ret;
-
- authors = (gchar **)gtk_about_dialog_get_authors(GTK_ABOUT_DIALOG(self->obj));
- if (!authors)
- return PyTuple_New(0);
-
- tmp = authors;
- while (*tmp)
- tmp++, i++;
-
- ret = PyTuple_New(i);
- for (j = 0; j < i; j++)
- PyTuple_SetItem(ret, j, PyString_FromString(authors[j]));
-
- return ret;
-}
-%%
-override gtk_about_dialog_set_documenters kwargs
-static PyObject *
-_wrap_gtk_about_dialog_set_documenters(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- gchar **documenters = NULL;
- static char *kwlist[] = { "documenters", NULL };
- PyObject *py_documenters = NULL;
- int i, n_documenters;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkAboutDialog.set_documenters",
- kwlist, &py_documenters))
- return NULL;
-
- if (!PySequence_Check(py_documenters)) {
- PyErr_SetString(PyExc_TypeError, "documenters must be a sequence");
- return NULL;
- }
-
- n_documenters = PySequence_Length(py_documenters);
- documenters = g_new(gchar *, n_documenters + 1);
- for (i = 0; i < n_documenters; i++) {
- PyObject *item = PySequence_GetItem(py_documenters, i);
- Py_DECREF(item); /* PySequence_GetItem INCREF's */
- documenters[i] = PyString_AsString(item);
- }
- documenters[n_documenters] = NULL;
-
- gtk_about_dialog_set_documenters(GTK_ABOUT_DIALOG(self->obj),
- (const char **)documenters);
-
- g_free(documenters);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_about_dialog_get_documenters noargs
-static PyObject *
-_wrap_gtk_about_dialog_get_documenters(PyGObject *self)
-{
- gchar **documenters, **tmp;
- int i = 0, j;
- PyObject *ret;
-
- documenters = (gchar **)gtk_about_dialog_get_documenters(GTK_ABOUT_DIALOG(self->obj));
- if (!documenters)
- return PyTuple_New(0);
-
- tmp = documenters;
- while (*tmp)
- tmp++, i++;
-
- ret = PyTuple_New(i);
- for (j = 0; j < i; j++)
- PyTuple_SetItem(ret, j, PyString_FromString(documenters[j]));
-
- return ret;
-}
-%%
-override gtk_about_dialog_set_artists kwargs
-static PyObject *
-_wrap_gtk_about_dialog_set_artists(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- gchar **artists = NULL;
- static char *kwlist[] = { "artists", NULL };
- PyObject *py_artists = NULL;
- int i, n_artists;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkAboutDialog.set_artists",
- kwlist, &py_artists))
- return NULL;
-
- if (!PySequence_Check(py_artists)) {
- PyErr_SetString(PyExc_TypeError, "artists must be a sequence");
- return NULL;
- }
-
- n_artists = PySequence_Length(py_artists);
- artists = g_new(gchar *, n_artists + 1);
- for (i = 0; i < n_artists; i++) {
- PyObject *item = PySequence_GetItem(py_artists, i);
- Py_DECREF(item); /* PySequence_GetItem INCREF's */
- artists[i] = PyString_AsString(item);
- }
- artists[n_artists] = NULL;
-
- gtk_about_dialog_set_artists(GTK_ABOUT_DIALOG(self->obj),
- (const char **)artists);
-
- g_free(artists);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_about_dialog_get_artists noargs
-static PyObject *
-_wrap_gtk_about_dialog_get_artists(PyGObject *self)
-{
- gchar **artists, **tmp;
- int i = 0, j;
- PyObject *ret;
-
- artists = (gchar **)gtk_about_dialog_get_artists(GTK_ABOUT_DIALOG(self->obj));
- if (!artists)
- return PyTuple_New(0);
-
- tmp = artists;
- while (*tmp)
- tmp++, i++;
-
- ret = PyTuple_New(i);
- for (j = 0; j < i; j++)
- PyTuple_SetItem(ret, j, PyString_FromString(artists[j]));
-
- return ret;
-}
-%%
-override gtk_selection_data_set_uris kwargs
-static PyObject *
-_wrap_gtk_selection_data_set_uris(PyGBoxed *self, PyObject *args,
- PyObject *kwargs)
-{
- gchar **uris = NULL;
- static char *kwlist[] = { "uris", NULL };
- PyObject *py_uris = NULL;
- int i, n_uris;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkSelectionData.set_uris",
- kwlist, &py_uris))
- return NULL;
-
- if (!PySequence_Check(py_uris)) {
- PyErr_SetString(PyExc_TypeError, "uris must be a sequence");
- return NULL;
- }
-
- n_uris = PySequence_Length(py_uris);
- uris = g_new(gchar *, n_uris + 1);
- for (i = 0; i < n_uris; i++) {
- PyObject *item = PySequence_GetItem(py_uris, i);
- Py_DECREF(item); /* PySequence_GetItem INCREF's */
- uris[i] = PyString_AsString(item);
- }
- uris[n_uris] = NULL;
-
- gtk_selection_data_set_uris(pyg_boxed_get(self, GtkSelectionData), uris);
-
- g_free(uris);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_selection_data_get_uris noargs
-static PyObject *
-_wrap_gtk_selection_data_get_uris(PyGBoxed *self)
-{
- gchar **uris, **tmp;
- int i = 0, j;
- PyObject *ret;
-
- uris = gtk_selection_data_get_uris(pyg_boxed_get(self, GtkSelectionData));
- if (!uris)
- return PyTuple_New(0);
-
- tmp = uris;
- while (*tmp)
- tmp++, i++;
-
- ret = PyTuple_New(i);
- for (j = 0; j < i; j++)
- PyTuple_SetItem(ret, j, PyString_FromString(uris[j]));
-
- return ret;
-}
-%%
-override gtk_drag_source_get_target_list noargs
-static PyObject *
-_wrap_gtk_drag_source_get_target_list(PyGObject *self)
-{
- GtkTargetList *target_list;
-
- target_list = gtk_drag_source_get_target_list(GTK_WIDGET(self->obj));
-
- if (!target_list) {
- Py_INCREF(Py_None);
- return Py_None;
- }
-
- return pygtk_target_list_to_list(target_list);
-}
-%%
-override gtk_drag_source_set_target_list kwargs
-static PyObject *
-_wrap_gtk_drag_source_set_target_list(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "target_list", NULL };
- PyObject *py_targets;
- GtkTargetList *target_list;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkWidget.drag_source_set_target_list",
- kwlist, &py_targets))
- return NULL;
-
- if (!(target_list = pygtk_target_list_from_sequence(py_targets)))
- return NULL;
-
- gtk_drag_source_set_target_list(GTK_WIDGET(self->obj), target_list);
- gtk_target_list_unref(target_list);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_cell_view_set_value kwargs
-static PyObject *
-_wrap_gtk_cell_view_set_value(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "renderer", "property", "value", NULL };
- PyObject *pyrenderer, *pyvalue;
- GtkCellRenderer *renderer;
- gchar *property;
- GParamSpec *pspec;
- GValue value = { 0 };
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!sO:GtkCellView.set_value",
- kwlist,
- &PyGtkCellRenderer_Type, &pyrenderer,
- &property, &pyvalue))
- return NULL;
-
- renderer = GTK_CELL_RENDERER(pygobject_get(pyrenderer));
- pspec = g_object_class_find_property(G_OBJECT_GET_CLASS(renderer),
- property);
- if (!pspec) {
- PyErr_Format(PyExc_TypeError,
- "property %s is not defined for the renderer",
- property);
- return NULL;
- }
- g_value_init(&value, G_PARAM_SPEC_VALUE_TYPE(pspec));
- if (pyg_value_from_pyobject(&value, pyvalue)) {
- PyErr_Format(PyExc_TypeError,
- "value is of the wrong type for property %s",
- property);
- return NULL;
- }
- gtk_cell_view_set_value(GTK_CELL_VIEW(self->obj), renderer,
- property, &value);
- g_value_unset(&value);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_cell_view_set_values kwargs
-static PyObject *
-_wrap_gtk_cell_view_set_values(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- PyObject *pyrenderer, *key, *item;
- GtkCellRenderer *renderer;
- GtkCellView *view;
- gchar *property;
- GParamSpec *pspec;
- GValue value = { 0 };
- gint i = 0;
-
- if (!PyArg_ParseTuple(args, "O!:GtkCellView.set_values",
- &PyGtkCellRenderer_Type, &pyrenderer))
- return NULL;
-
- if (!kwargs) {
- Py_INCREF(Py_None);
- return Py_None;
- }
- view = GTK_CELL_VIEW(self->obj);
- renderer = GTK_CELL_RENDERER(pygobject_get(pyrenderer));
- while (PyDict_Next(kwargs, &i, &key, &item)) {
- property = PyString_AsString(key);
- pspec = g_object_class_find_property(G_OBJECT_GET_CLASS(renderer),
- property);
- if (!pspec) {
- PyErr_Format(PyExc_TypeError,
- "property %s is not defined for the renderer",
- property);
- return NULL;
- }
- g_value_init(&value, G_PARAM_SPEC_VALUE_TYPE(pspec));
- if (pyg_value_from_pyobject(&value, item)) {
- PyErr_Format(PyExc_TypeError,
- "value is of the wrong type for property %s",
- property);
- return NULL;
- }
- gtk_cell_view_set_value(view, renderer, property, &value);
- g_value_unset(&value);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_cell_view_get_cell_renderers noargs
-static PyObject *
-_wrap_gtk_cell_view_get_cell_renderers(PyGObject *self)
-{
- GList *cell_list;
- PyObject *py_cell_list, *py_cell;
- GtkCellRenderer *cell;
- guint len;
- int i;
-
- cell_list = gtk_cell_view_get_cell_renderers(GTK_CELL_VIEW(self->obj));
- len = g_list_length(cell_list);
- py_cell_list = PyList_New(len);
- for (i = 0; i < len; i++) {
- cell = GTK_CELL_RENDERER(g_list_nth_data(cell_list, i));
- if (!cell || !(py_cell = pygobject_new(G_OBJECT(cell)))) {
- g_list_free(cell_list);
- Py_DECREF(py_cell_list);
- return NULL;
- }
- PyList_SetItem(py_cell_list, i, py_cell);
- }
- g_list_free(cell_list);
- return py_cell_list;
-}
-%%
-override gtk_cell_view_get_size_of_row kwargs
-static PyObject *
-_wrap_gtk_cell_view_get_size_of_row(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "path", NULL };
- PyObject *py_path;
- GtkTreePath *path;
- GtkRequisition requisition;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkCellView.get_size_of_row",
- kwlist, &py_path))
- return NULL;
- path = pygtk_tree_path_from_pyobject(py_path);
- if (!path) {
- PyErr_SetString(PyExc_TypeError,
- "could not convert path to a GtkTreePath");
- return NULL;
- }
- gtk_cell_view_get_size_of_row(GTK_CELL_VIEW(self->obj), path,
- &requisition);
- gtk_tree_path_free(path);
- return pyg_boxed_new(GTK_TYPE_REQUISITION, &requisition, TRUE, TRUE);
-}
-%%
-override gtk_clipboard_set_can_store kwargs
-static PyObject *
-_wrap_gtk_clipboard_set_can_store(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "targets", NULL };
- GtkTargetEntry *targets;
- PyObject *py_targets;
- gint n_targets, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkClipboard.set_can_store",
- kwlist, &py_targets))
- return NULL;
- if (py_targets == Py_None) {
- targets = NULL;
- n_targets = 0;
- } else {
- if (!(py_targets = PySequence_Fast(py_targets,
- "targets must be a sequence")))
- return NULL;
- n_targets = PySequence_Fast_GET_SIZE(py_targets);
- targets = g_new(GtkTargetEntry, n_targets);
- for (i = 0; i < n_targets; i++) {
- PyObject *item = PySequence_Fast_GET_ITEM(py_targets, i);
- if (!PyArg_ParseTuple(item, "sii", &targets[i].target,
- &targets[i].flags, &targets[i].info)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "list items should be of form (string,int,int)");
- g_free(targets);
- Py_DECREF(py_targets);
- return NULL;
- }
- }
- Py_DECREF(py_targets);
- }
- gtk_clipboard_set_can_store(GTK_CLIPBOARD(self->obj), targets, n_targets);
- g_free(targets);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_combo_box_set_row_separator_func args
-static gboolean
-pygtk_combo_box_row_separator_func_cb(GtkTreeModel *model,
- GtkTreeIter *iter,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *py_model, *py_iter;
- gboolean ret = FALSE;
- PyObject *retobj;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_model = pygobject_new((GObject *)model);
- py_iter = pyg_boxed_new(GTK_TYPE_TREE_ITER, iter, TRUE, TRUE);
-
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(NNO)", py_model,
- py_iter, cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(NN)", py_model, py_iter);
- }
-
- if (retobj != NULL) {
- ret = PyObject_IsTrue(retobj);
- Py_DECREF(retobj);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_combo_box_set_row_separator_func(PyGObject *self, PyObject *args)
-{
- PyObject *pyfunc = NULL, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTuple(args,
- "|OO:GtkComboBox.set_row_separator_func",
- &pyfunc, &pyarg))
- return NULL;
-
- if (pyfunc == NULL || pyfunc == Py_None) {
- gtk_combo_box_set_row_separator_func(GTK_COMBO_BOX(self->obj),
- NULL, NULL, NULL);
- } else if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- } else {
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_combo_box_set_row_separator_func(
- GTK_COMBO_BOX(self->obj),
- pygtk_combo_box_row_separator_func_cb,
- cunote,
- pygtk_custom_destroy_notify);
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_file_chooser_button_new kwargs
-static int
-_wrap_gtk_file_chooser_button_new(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist1[] = { "title", "backend", NULL };
- static char *kwlist2[] = { "dialog", NULL };
- gchar *title, *backend = NULL;
- PyGObject *dialog;
-
- if (PyArg_ParseTupleAndKeywords(args, kwargs,
- "s|z:GtkFileChooserButton.__init__",
- kwlist1, &title, &backend))
- pygobject_construct(self, "title", title,
- "file-system-backend", backend,
- NULL);
- else {
- PyErr_Clear();
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!:GtkFileChooserButton.__init__",
- kwlist2, &PyGtkFileChooserDialog_Type,
- &dialog)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "Usage: one of:\n"
- " gtk.FileChooserButton(title, backend=None)\n"
- " gtk.FileChooserButton(filechooserdialog)");
- return -1;
- }
- pygobject_construct(self, "dialog", GTK_WIDGET(dialog->obj), NULL);
- }
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkFileChooserBUtton object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_FILE_CHOOSER_BUTTON
-%%
-override gtk_icon_theme_get_icon_sizes kwargs
-static PyObject *
-_wrap_gtk_icon_theme_get_icon_sizes(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "icon_name", NULL };
- const gchar *icon_name;
- gint *sizes;
- int i;
- PyObject *py_sizes;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:GtkIconTheme.get_icon_sizes",
- kwlist, &icon_name))
- return NULL;
-
- sizes = gtk_icon_theme_get_icon_sizes(GTK_ICON_THEME(self->obj),
- icon_name);
-
- for (i = 0; sizes[i] != 0; i++) ;
-
- if ((py_sizes = PyTuple_New(i)) == NULL) {
- g_free(sizes);
- return NULL;
- }
- for (i = 0; sizes[i] != 0; i++)
- PyTuple_SET_ITEM(py_sizes, i, PyInt_FromLong(sizes[i]));
-
- g_free(sizes);
- return py_sizes;
-}
-%%
-override gtk_image_get_icon_name noargs
-static PyObject *
-_wrap_gtk_image_get_icon_name(PyGObject *self)
-{
- gchar *icon_name = NULL;
- GtkIconSize size = GTK_ICON_SIZE_INVALID;
-
- gtk_image_get_icon_name(GTK_IMAGE(self->obj),
- (G_CONST_RETURN gchar **)&icon_name, &size);
-
- return Py_BuildValue("(sN)", icon_name,
- pyg_enum_from_gtype(GTK_TYPE_ICON_SIZE, size));
-}
-%%
-override gtk_message_dialog_format_secondary_text kwargs
-static PyObject *
-_wrap_gtk_message_dialog_format_secondary_text(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "message_format", NULL };
- gchar *message_format = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|z:GtkMessageDialog.format_secondary_text",
- kwlist, &message_format))
- return NULL;
-
- if (message_format)
- gtk_message_dialog_format_secondary_text(GTK_MESSAGE_DIALOG(self->obj),
- "%s", message_format);
- else
- gtk_message_dialog_format_secondary_text(GTK_MESSAGE_DIALOG(self->obj),
- message_format);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_message_dialog_format_secondary_markup kwargs
-static PyObject *
-_wrap_gtk_message_dialog_format_secondary_markup(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "message_format", NULL };
- gchar *message_format = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|z:GtkMessageDialog.format_secondary_markup",
- kwlist, &message_format))
- return NULL;
-
- if (message_format)
- gtk_message_dialog_format_secondary_markup(GTK_MESSAGE_DIALOG(self->obj),
- "%s", message_format);
- else
- gtk_message_dialog_format_secondary_markup(GTK_MESSAGE_DIALOG(self->obj),
- message_format);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_target_list_add_text_targets kwargs
-static PyObject *
-_wrap_gtk_target_list_add_text_targets(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "list", "info", NULL };
- PyObject *list = NULL;
- guint info = 0;
- GtkTargetList *targets;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|Oi:gtk.target_list_add_text_targets",
- kwlist, &list, &info)) {
- return NULL;
- }
- if (!list || list == Py_None) {
- targets = gtk_target_list_new(NULL, 0);
- } else if (!(targets = pygtk_target_list_from_sequence(list)))
- return NULL;
-
- gtk_target_list_add_text_targets(targets, info);
- list = pygtk_target_list_to_list(targets);
- gtk_target_list_unref(targets);
- return list;
-}
-%%
-override gtk_target_list_add_image_targets kwargs
-static PyObject *
-_wrap_gtk_target_list_add_image_targets(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "list", "info", "writable", NULL };
- PyObject *list = NULL;
- guint info = 0;
- gboolean writable = FALSE;
- GtkTargetList *targets;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|Oii:gtk.target_list_add_text_targets",
- kwlist, &list, &info, &writable)) {
- return NULL;
- }
- if (!list || list == Py_None) {
- targets = gtk_target_list_new(NULL, 0);
- } else if (!(targets = pygtk_target_list_from_sequence(list)))
- return NULL;
-
- gtk_target_list_add_image_targets(targets, info, writable);
- list = pygtk_target_list_to_list(targets);
- gtk_target_list_unref(targets);
- return list;
-}
-%%
-override gtk_target_list_add_uri_targets kwargs
-static PyObject *
-_wrap_gtk_target_list_add_uri_targets(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "list", "info", NULL };
- PyObject *list = NULL;
- guint info = 0;
- GtkTargetList *targets;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|Oi:gtk.target_list_add_text_targets",
- kwlist, &list, &info)) {
- return NULL;
- }
- if (!list || list == Py_None) {
- targets = gtk_target_list_new(NULL, 0);
- } else if (!(targets = pygtk_target_list_from_sequence(list)))
- return NULL;
-
- gtk_target_list_add_uri_targets(targets, info);
- list = pygtk_target_list_to_list(targets);
- gtk_target_list_unref(targets);
- return list;
-}
-%%
-override gtk_about_dialog_set_email_hook kwargs
-static void
-pygtk_about_dialog_link_hook_marshal(GtkAboutDialog *about,
- const gchar *link,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *py_about, *retobj;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_about = pygobject_new((GObject *)about);
-
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(NsO)", py_about,
- link, cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(Ns)", py_about, link);
- }
-
- if (!retobj)
- PyErr_Print();
-
- Py_XDECREF(retobj);
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_about_dialog_set_email_hook(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", NULL };
- PyObject *pyfunc = NULL, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|OO:GtkAboutDialog.set_email_hook",
- kwlist, &pyfunc, &pyarg))
- return NULL;
-
- if (pyfunc == NULL || pyfunc == Py_None) {
- gtk_about_dialog_set_email_hook(NULL, NULL, NULL);
- } else if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- } else {
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_about_dialog_set_email_hook(
- pygtk_about_dialog_link_hook_marshal,
- cunote,
- pygtk_custom_destroy_notify);
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_about_dialog_set_url_hook kwargs
-static PyObject *
-_wrap_gtk_about_dialog_set_url_hook(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", NULL};
- PyObject *pyfunc = NULL, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|OO:GtkAboutDialog.set_url_hook",
- kwlist, &pyfunc, &pyarg))
- return NULL;
-
- if (pyfunc == NULL || pyfunc == Py_None) {
- gtk_about_dialog_set_url_hook(NULL, NULL, NULL);
- } else if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- } else {
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_about_dialog_set_url_hook(
- pygtk_about_dialog_link_hook_marshal,
- cunote,
- pygtk_custom_destroy_notify);
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override GtkCellRenderer__proxy_do_get_size
-static void
-_wrap_GtkCellRenderer__proxy_do_get_size (GtkCellRenderer *cell,
- GtkWidget *widget,
- GdkRectangle *cell_area,
- gint *x_offset,
- gint *y_offset,
- gint *width,
- gint *height)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_widget, *py_cell_area;
- gint my_x, my_y, my_width, my_height;
-
- state = pyg_gil_state_ensure();
- self = pygobject_new((GObject *)cell);
- py_widget = pygobject_new((GObject *)widget);
- py_cell_area = pyg_boxed_new(GDK_TYPE_RECTANGLE, cell_area, TRUE, TRUE);
-
- py_ret = PyObject_CallMethod(self, "do_get_size", "OO",
- py_widget, py_cell_area);
- if (!py_ret) {
- PyErr_Print();
- Py_DECREF(self);
- Py_DECREF(py_widget);
- Py_DECREF(py_cell_area);
- pyg_gil_state_release(state);
- return;
- }
- Py_DECREF(self);
- Py_DECREF(py_widget);
- Py_DECREF(py_cell_area);
-
- if (!PyArg_ParseTuple(py_ret, "iiii",
- &my_x, &my_y, &my_width, &my_height)) {
- PyErr_Print();
- Py_DECREF(py_ret);
- pyg_gil_state_release(state);
- return;
- }
- Py_DECREF(py_ret);
-
- pyg_gil_state_release(state);
-
- /* success */
- if (x_offset)
- *x_offset = my_x;
- if (y_offset)
- *y_offset = my_y;
- if (width)
- *width = my_width;
- if (height)
- *height = my_height;
-}
-%%
-override GtkCellRenderer__do_get_size kwargs
-static PyObject *
-_wrap_GtkCellRenderer__do_get_size(PyObject *cls, PyObject *args, PyObject *kwargs)
-{
- gpointer klass;
- static char *kwlist[] = { "self", "widget", "cell_area", NULL };
- PyGObject *self, *widget;
- PyObject *py_cell_area;
- gint x, y, width, height;
- GdkRectangle cell_area;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,"O!O!OO!:GtkContainer.get_child_property", kwlist,
- &PyGtkCellRenderer_Type, &self,
- &PyGtkWidget_Type, &widget,
- &py_cell_area))
- return NULL;
-
- if (!pygdk_rectangle_from_pyobject(py_cell_area, &cell_area))
- return NULL;
-
- klass = g_type_class_ref(pyg_type_from_object(cls));
- if (GTK_CELL_RENDERER_CLASS(klass)->get_size)
- GTK_CELL_RENDERER_CLASS(klass)->get_size(GTK_CELL_RENDERER(self->obj),
- GTK_WIDGET(widget->obj),
- &cell_area,
- &x, &y, &width, &height);
- else {
- PyErr_SetString(PyExc_NotImplementedError, "virtual method GtkContainer.get_child_property not implemented");
- g_type_class_unref(klass);
- return NULL;
- }
- g_type_class_unref(klass);
-
- return Py_BuildValue("(iiii)", x, y, width, height);
-}
-
-
-%%
-override GtkCellLayout__proxy_do_set_cell_data_func
-
-typedef struct {
- GtkCellLayoutDataFunc func;
- gpointer func_data;
- GDestroyNotify destroy;
-} PyGtkCellLayoutDataFuncData;
-
-static void
-_wrap_GtkCellLayoutDataFunc_destroy(void *arg)
-{
- PyGtkCellLayoutDataFuncData *data = arg;
- data->destroy(data->func_data);
- g_free(data);
-}
-
-static PyObject *
-_wrap_GtkCellLayoutDataFunc(PyObject *self, PyObject *args)
-{
- PyObject *py_cell_layout;
- PyObject *py_cell;
- PyObject *py_tree_model;
- PyObject *py_iter;
- PyObject *py_data;
- PyGtkCellLayoutDataFuncData *data;
-
- if (!PyArg_ParseTuple(args, "O!O!O!OO!",
- &PyGtkCellLayout_Type, &py_cell_layout,
- &PyGtkCellRenderer_Type, &py_cell,
- &PyGtkTreeModel_Type, &py_tree_model,
- &py_iter,
- &PyCObject_Type, &py_data))
- return NULL;
- if (!pyg_boxed_check(py_iter, GTK_TYPE_TREE_ITER)) {
- PyErr_SetString(PyExc_TypeError, "4th argument must be a gtk.TreeIter");
- return NULL;
- }
-
- data = PyCObject_AsVoidPtr(py_data);
- data->func(GTK_CELL_LAYOUT(pygobject_get(py_cell_layout)),
- GTK_CELL_RENDERER(pygobject_get(py_cell)),
- GTK_TREE_MODEL(pygobject_get(py_tree_model)),
- pyg_boxed_get(py_iter, GtkTreeIter),
- data->func_data);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static void
-_wrap_GtkCellLayout__proxy_do_set_cell_data_func (
- GtkCellLayout *cell_layout,
- GtkCellRenderer *cell,
- GtkCellLayoutDataFunc func,
- gpointer func_data,
- GDestroyNotify destroy)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_cell, *py_func, *py_func_data;
- PyMethodDef pyfunc_def = { NULL, (PyCFunction)_wrap_GtkCellLayoutDataFunc,
- METH_VARARGS|METH_KEYWORDS };
- PyGtkCellLayoutDataFuncData *data;
-
- state = pyg_gil_state_ensure();
- self = pygobject_new((GObject *)cell);
- py_cell = pygobject_new((GObject *)cell);
- py_func = PyCFunction_NewEx(&pyfunc_def, NULL, NULL);
- data = g_new(PyGtkCellLayoutDataFuncData, 1);
- data->func = func;
- data->func_data = func_data;
- data->destroy = destroy;
- py_func_data = PyCObject_FromVoidPtr(data, _wrap_GtkCellLayoutDataFunc_destroy);
-
- py_ret = PyObject_CallMethod(self, "do_set_cell_data_func", "NNNN",
- self, py_cell, py_func, py_func_data);
- if (!py_ret)
- PyErr_Print();
- Py_DECREF(self);
- Py_XDECREF(py_ret);
- pyg_gil_state_release(state);
-}
-%%
-override gtk_dialog_set_alternative_button_order kwargs
-static PyObject *
-_wrap_gtk_dialog_set_alternative_button_order(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "new_order", NULL };
- gint *new_order, n_params;
- PyObject *py_new_order;
- int i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkDialog.set_alternative_button_order",
- kwlist, &py_new_order))
- return NULL;
-
- n_params = PySequence_Size(py_new_order);
- if (!PySequence_Check(py_new_order) || n_params < 1) {
- PyErr_SetString(PyExc_TypeError,
- "new_order must be a sequence with"
- "at least one response id int");
- return NULL;
- }
- new_order = (gint *)g_new0(gint, n_params);
- for (i = 0; i < n_params; i++) {
- PyObject *item = PySequence_GetItem(py_new_order, i);
-
- if (!PyInt_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "each new_order item must be an integer");
- g_free(new_order);
- Py_XDECREF(item);
- return NULL;
- }
- new_order[i] = PyInt_AsLong(item);
- Py_DECREF(item);
- }
- gtk_dialog_set_alternative_button_order_from_array(GTK_DIALOG(self->obj),
- n_params, new_order);
- g_free(new_order);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_info_free noargs
-static PyObject *
-_wrap_gtk_icon_info_free(PyObject *self)
-{
- if (PyErr_Warn(PyExc_DeprecationWarning, "gtk.IconInfo.free should not be used") < 0)
- return NULL;
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_source_free noargs
-static PyObject *
-_wrap_gtk_icon_source_free(PyObject *self)
-{
- if (PyErr_Warn(PyExc_DeprecationWarning, "gtk.IconSource.free should not be used") < 0)
- return NULL;
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_requisition_free noargs
-static PyObject *
-_wrap_gtk_requisition_free(PyObject *self)
-{
- if (PyErr_Warn(PyExc_DeprecationWarning, "gtk.Requisition.free should not be used") < 0)
- return NULL;
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_iter_free noargs
-static PyObject *
-_wrap_gtk_tree_iter_free(PyObject *self)
-{
- if (PyErr_Warn(PyExc_DeprecationWarning, "gtk.TreeIter.free should not be used") < 0)
- return NULL;
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_row_reference_free noargs
-static PyObject *
-_wrap_gtk_tree_row_reference_free(PyObject *self)
-{
- if (PyErr_Warn(PyExc_DeprecationWarning, "gtk.TreeRowReference.free should not be used") < 0)
- return NULL;
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_border_free noargs
-static PyObject *
-_wrap_gtk_border_free(PyObject *self)
-{
- if (PyErr_Warn(PyExc_DeprecationWarning, "gtk.Border.free should not be used") < 0)
- return NULL;
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_clipboard_request_image kwargs
-static void
-clipboard_request_image_cb(GtkClipboard *clipboard,
- GdkPixbuf *pixbuf,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyObject *callback, *args, *ret, *py_image;
-
- if (pixbuf) {
- py_image = pygobject_new((GObject *)pixbuf);
- } else {
- py_image = Py_None;
- Py_INCREF(Py_None);
- }
-
- state = pyg_gil_state_ensure();
- callback = PyTuple_GetItem((PyObject *)user_data, 0);
- args = Py_BuildValue("(NNO)",
- pygobject_new((GObject *)clipboard),
- py_image,
- PyTuple_GetItem((PyObject *)user_data, 1));
- ret = PyObject_CallObject(callback, args);
- if (!ret)
- PyErr_Print();
- Py_XDECREF(ret);
- Py_DECREF(args);
- Py_DECREF((PyObject *)user_data);
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_clipboard_request_image(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "callback", "user_data", NULL };
- PyObject *callback, *data, *user_data = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkClipboard.request_image",
- kwlist, &callback, &user_data))
- return NULL;
- if (!PyCallable_Check(callback)) {
- PyErr_SetString(PyExc_TypeError, "callback must be callable");
- return NULL;
- }
-
- data = Py_BuildValue("(OO)", callback, user_data);
- gtk_clipboard_request_image(GTK_CLIPBOARD(self->obj),
- clipboard_request_image_cb,
- (gpointer)data);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-override gtk_print_context_get_cairo_context noargs
-static PyObject *
-_wrap_gtk_print_context_get_cairo_context(PyGObject *self)
-{
- cairo_t *ret;
-
- ret = gtk_print_context_get_cairo_context(GTK_PRINT_CONTEXT(self->obj));
-
- cairo_reference(ret);
- return PycairoContext_FromContext(ret, &PyGdkCairoContext_Type, NULL);
-}
-%%
-override gtk_assistant_set_forward_page_func kwargs
-static gint
-pygtk_assistant_set_forward_page_func_cb(gint current_page,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- gint ret = current_page;
- PyObject *retobj;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(iO)",
- current_page, cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(i)", current_page);
- }
-
- if (retobj != NULL) {
- ret = PyInt_AsLong(retobj);
- Py_DECREF(retobj);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_assistant_set_forward_page_func(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "page_func", "data", NULL };
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkAssistant.set_forward_page_func",
- kwlist, &pyfunc, &pyarg))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError,
- "page_func must be a callable object");
- return NULL;
- }
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_assistant_set_forward_page_func(GTK_ASSISTANT(self->obj),
- pygtk_assistant_set_forward_page_func_cb,
- cunote, pygtk_custom_destroy_notify);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_clipboard_request_rich_text kwargs
-static void
-clipboard_request_rich_text_cb(GtkClipboard *clipboard,
- GdkAtom format,
- const guint8 *text,
- gsize length,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyObject *callback, *args, *ret, *py_format, *py_text, *data;
- gchar *name;
-
- data = (PyObject *) user_data;
-
- if (text) {
- py_text = PyString_FromString((char *) text);
- } else {
- py_text = Py_None;
- Py_INCREF(Py_None);
- }
-
- name = gdk_atom_name(format);
- py_format = PyString_FromString(name);
- g_free(name);
-
- state = pyg_gil_state_ensure();
- callback = PyTuple_GetItem(data, 0);
- args = Py_BuildValue("(NNNiO)",
- pygobject_new((GObject *)clipboard),
- py_format, py_text, length,
- PyTuple_GetItem(data, 1));
- ret = PyObject_CallObject(callback, args);
- if (!ret)
- PyErr_Print();
- Py_XDECREF(ret);
- Py_DECREF(args);
- Py_DECREF((PyObject *)user_data);
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_clipboard_request_rich_text(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "buffer", "callback", "user_data", NULL };
- PyObject *callback, *data, *user_data = Py_None;
- GtkTextBuffer *buffer;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!O|O:GtkClipboard.request_rich_text",
- kwlist, &PyGtkTextBuffer_Type, &buffer,
- &callback, &user_data))
- return NULL;
- if (!PyCallable_Check(callback)) {
- PyErr_SetString(PyExc_TypeError, "callback must be callable");
- return NULL;
- }
-
- data = Py_BuildValue("(OO)", callback, user_data);
- gtk_clipboard_request_rich_text(GTK_CLIPBOARD(self->obj), buffer,
- clipboard_request_rich_text_cb,
- (gpointer)data);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_clipboard_wait_for_rich_text kwargs
-static PyObject *
-_wrap_gtk_clipboard_wait_for_rich_text(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "buffer", NULL };
- GtkTextBuffer *buffer;
- GdkAtom format;
- gchar *name;
- gsize length;
- guint8 *ret;
-
-
- if (!PyArg_ParseTupleAndKeywords(args,kwargs,
- "O:GtkClipboard.wait_for_rich_text",
- kwlist, &PyGtkTextBuffer_Type, &buffer))
- return NULL;
-
- ret = gtk_clipboard_wait_for_rich_text(GTK_CLIPBOARD(self->obj),
- buffer, &format, &length);
-
- if (ret) {
- PyObject *py_ret;
- name = gdk_atom_name(format);
- py_ret = Py_BuildValue("(s#s)", ret, (Py_ssize_t) length, name);
- g_free(ret);
- g_free(name);
- return py_ret;
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_link_button_set_uri_hook kwargs
-static void
-pygtk_link_button_set_uri_hook_cb(GtkLinkButton *button,
- const gchar *link,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *retobj;
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(NsO)",
- pygobject_new((GObject *)button),
- link, cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(Ns)",
- pygobject_new((GObject *)button), link);
- }
-
- if (retobj == NULL)
- PyErr_Print();
-
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_link_button_set_uri_hook(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", NULL };
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:gtk.link_button_set_uri_hook",
- kwlist, &pyfunc, &pyarg))
- return NULL;
-
- if (pyfunc != Py_None && !PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object or None");
- return NULL;
- }
-
- if (pyfunc == Py_None) {
- gtk_link_button_set_uri_hook(NULL, NULL, NULL);
- } else {
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_link_button_set_uri_hook(pygtk_link_button_set_uri_hook_cb,
- cunote, pygtk_custom_destroy_notify);
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_print_settings_foreach kwargs
-static void
-pygtk_print_settings_foreach_cb(const gchar *key,
- const gchar *value,
- gpointer data)
-{
- PyGILState_STATE state;
- PyObject *retobj;
- PyGtkCustomNotify *cunote = data;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(ssO)", key, value,
- cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(ss)", key, value);
-
- if (retobj == NULL)
- PyErr_Print();
-
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_print_settings_foreach(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "user_data", NULL };
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:gtk.PrintSettings.foreach",
- kwlist, &pyfunc, &pyarg))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- }
-
- cunote.func = pyfunc;
- cunote.data = pyarg;
-
- gtk_print_settings_foreach(GTK_PRINT_SETTINGS(self->obj),
- pygtk_print_settings_foreach_cb, &cunote);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_print_settings_get_page_ranges noargs
-static PyObject *
-_wrap_gtk_print_settings_get_page_ranges(PyGObject *self)
-{
- GtkPageRange *ranges;
- PyObject *py_ranges;
- gint n_ranges, i;
-
- ranges = gtk_print_settings_get_page_ranges(GTK_PRINT_SETTINGS(self->obj),
- &n_ranges);
-
- py_ranges = PyList_New(n_ranges);
-
- for (i = 0; i < n_ranges; i++)
- PyList_SetItem(py_ranges, i,
- Py_BuildValue("(ii)", ranges[i].start, ranges[i].end));
- g_free(ranges);
- return py_ranges;
-}
-%%
-override gtk_print_settings_set_page_ranges kwargs
-static PyObject *
-_wrap_gtk_print_settings_set_page_ranges(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "page_ranges", NULL };
- PyObject *py_ranges;
- gint n_ranges = 0, i;
- GtkPageRange *ranges = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:gtk.PrintSettings.set_page_ranges",
- kwlist, &py_ranges))
- return NULL;
-
- if (!PySequence_Check(py_ranges)) {
- PyErr_SetString(PyExc_TypeError,
- "page_ranges must be a sequence of 2-tuples");
- return NULL;
- }
-
- n_ranges = PySequence_Size(py_ranges);
- ranges = g_new0(GtkPageRange, n_ranges);
- for (i = 0; i < n_ranges; i++) {
- PyObject *range = PySequence_GetItem(py_ranges, i);
-
- if (!PyTuple_Check(range)) {
- PyErr_SetString(PyExc_TypeError,
- "Each page range must be a 2-tuple of start and end page numbers");
- g_free(ranges);
- return NULL;
- }
- if (!PyArg_ParseTuple(range,
- "ii;Each page range must be a 2-tuple of start and end page numbers",
- &ranges[i].start, &ranges[i].end)) {
- Py_DECREF(range);
- g_free(ranges);
- return NULL;
- }
- Py_DECREF(range);
- }
- gtk_print_settings_set_page_ranges(GTK_PRINT_SETTINGS(self->obj),
- ranges, n_ranges);
- g_free(ranges);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_recent_chooser_get_items noargs
-static PyObject *
-_wrap_gtk_recent_chooser_get_items(PyGObject *self)
-{
- GList *items;
- GtkRecentInfo *info;
- PyObject *py_items;
- guint count, i;
-
- items = gtk_recent_chooser_get_items(GTK_RECENT_CHOOSER(self->obj));
- count = g_list_length(items);
- py_items = PyList_New(count);
- for (i = 0; i < count; i++) {
- info = g_list_nth_data(items, i);
- PyList_SetItem(py_items, i,
- pyg_boxed_new(GTK_TYPE_RECENT_INFO, info, TRUE, TRUE));
- }
- g_list_foreach(items, (GFunc) gtk_recent_info_unref, NULL);
- g_list_free(items);
-
- return py_items;
-}
-%%
-override gtk_recent_chooser_get_uris noargs
-static PyObject *
-_wrap_gtk_recent_chooser_get_uris(PyGObject *self)
-{
- gchar **uris;
- PyObject *py_uris;
- gsize length, i;
-
- uris = gtk_recent_chooser_get_uris(GTK_RECENT_CHOOSER(self->obj),
- &length);
- if (!uris)
- length = 0;
- py_uris = PyList_New(length);
- for (i = 0; i < length; i++)
- PyList_SetItem(py_uris, i, PyString_FromString(uris[i]));
- g_strfreev(uris);
-
- return py_uris;
-}
-%%
-override gtk_recent_chooser_dialog_new kwargs
-static int
-_wrap_gtk_recent_chooser_dialog_new(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- gchar *title = NULL;
- PyGObject *py_window = NULL, *py_manager = NULL;
- PyObject *py_buttons = Py_None;
- int len, i;
- GtkWindow *parent;
- GtkRecentManager *manager;
-
- static char *kwlist[] = { "title", "parent", "manager", "buttons", NULL };
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|zOOO:gtk.RecentChooserDialog", kwlist,
- &title, &py_window, &py_manager,
- &py_buttons))
- return -1;
-
- if (py_window == NULL || (PyObject*)py_window == Py_None)
- parent = NULL;
- else if (pygobject_check(py_window, &PyGtkWindow_Type))
- parent = GTK_WINDOW(py_window->obj);
- else {
- PyErr_SetString(PyExc_TypeError, "parent must be a GtkWindow or None");
- return -1;
- }
-
- if (py_manager == NULL || (PyObject*)py_manager == Py_None)
- manager = NULL;
- else if (pygobject_check(py_manager, &PyGtkRecentManager_Type))
- manager = GTK_RECENT_MANAGER(py_manager->obj);
- else {
- PyErr_SetString(PyExc_TypeError, "manager must be a GtkRecentManager or None");
- return -1;
- }
-
- if (py_buttons == Py_None)
- len = 0;
- else if (PySequence_Check(py_buttons))
- len = PySequence_Size(py_buttons);
- else {
- PyErr_SetString(PyExc_TypeError, "buttons must be a sequence containing text/response pairs or None");
- return -1;
- }
-
- if (len % 2) {
- PyErr_SetString(PyExc_RuntimeError,
- "buttons tuple must contain text/response id pairs");
- return -1;
- }
-
- if (pygobject_construct(self, "recent-manager", manager, NULL)) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkDialog object");
- return -1;
- }
-
- if (title)
- gtk_window_set_title (GTK_WINDOW (self->obj), title);
-
- if (parent)
- gtk_window_set_transient_for (GTK_WINDOW (self->obj), parent);
-
- for (i = 0; i < len; i += 2) {
- PyObject *text = PySequence_GetItem(py_buttons, i);
- PyObject *id = PySequence_GetItem(py_buttons, i + 1);
- if (!PyString_Check(text)) {
- gtk_object_destroy(GTK_OBJECT(self->obj));
- self->obj = NULL;
- PyErr_SetString(PyExc_RuntimeError,
- "first member of each text/response id pair "
- "must be a string");
- Py_DECREF(text);
- Py_DECREF(id);
- return -1;
- }
- if (!PyInt_Check(id)) {
- gtk_object_destroy(GTK_OBJECT(self->obj));
- self->obj = NULL;
- PyErr_SetString(PyExc_RuntimeError,
- "second member of each text/response id pair "
- "must be a number");
- Py_DECREF(text);
- Py_DECREF(id);
- return -1;
- }
- gtk_dialog_add_button(GTK_DIALOG(self->obj), PyString_AsString(text),
- PyInt_AsLong(id));
- Py_DECREF(text);
- Py_DECREF(id);
- }
-
- return 0;
-}
-%%
-new-constructor GTK_TYPE_RECENT_CHOOSER_DIALOG
-%%
-override gtk_recent_chooser_list_filters noargs
-static PyObject *
-_wrap_gtk_recent_chooser_list_filters(PyGObject *self)
-{
- GSList *filters;
- GtkRecentFilter *filter;
- PyObject *py_filters;
- guint count, i;
-
- filters = gtk_recent_chooser_list_filters(GTK_RECENT_CHOOSER(self->obj));
- count = g_slist_length(filters);
- py_filters = PyList_New(count);
- for (i = 0; i < count; i++) {
- filter = g_slist_nth_data(filters, i);
- PyList_SetItem(py_filters, i, pygobject_new((GObject*)filter));
- }
- g_slist_free(filters);
-
- return py_filters;
-}
-%%
-override gtk_recent_chooser_set_sort_func kwargs
-static gint
-pygtk_recent_chooser_set_sort_func_cb(GtkRecentInfo *a,
- GtkRecentInfo *b,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *py_a, *py_b, *retobj;
- gint ret = -1;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_a = pyg_boxed_new(GTK_TYPE_RECENT_INFO, a, TRUE, TRUE);
- py_b = pyg_boxed_new(GTK_TYPE_RECENT_INFO, b, TRUE, TRUE);
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(NNO)",
- py_a, py_b, cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(NN)", py_a, py_b);
- }
-
- if (retobj != NULL) {
- ret = PyInt_AsLong(retobj);
- Py_DECREF(retobj);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_recent_chooser_set_sort_func(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "sort_func", "sort_data", NULL };
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkRecentChooser.set_sort_func",
- kwlist, &pyfunc, &pyarg))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError,
- "sort_func must be a callable object");
- return NULL;
- }
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_recent_chooser_set_sort_func(GTK_RECENT_CHOOSER(self->obj),
- pygtk_recent_chooser_set_sort_func_cb,
- cunote, pygtk_custom_destroy_notify);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_recent_info_get_applications noargs
-static PyObject *
-_wrap_gtk_recent_info_get_applications(PyGObject *self)
-{
- gchar **apps;
- PyObject *py_apps;
- gsize length, i;
-
- apps = gtk_recent_info_get_applications(pyg_boxed_get(self, GtkRecentInfo),
- &length);
- if (!apps)
- length = 0;
- py_apps = PyList_New(length);
- for (i = 0; i < length; i++)
- PyList_SetItem(py_apps, i, PyString_FromString(apps[i]));
- g_strfreev(apps);
-
- return py_apps;
-}
-%%
-override gtk_recent_info_get_groups noargs
-static PyObject *
-_wrap_gtk_recent_info_get_groups(PyGObject *self)
-{
- gchar **groups;
- PyObject *py_groups;
- gsize length, i;
-
- groups = gtk_recent_info_get_groups(pyg_boxed_get(self, GtkRecentInfo),
- &length);
- if (!groups)
- length = 0;
- py_groups = PyList_New(length);
- for (i = 0; i < length; i++)
- PyList_SetItem(py_groups, i, PyString_FromString(groups[i]));
- g_strfreev(groups);
-
- return py_groups;
-}
-%%
-override gtk_recent_info_get_application_info kwargs
-static PyObject *
-_wrap_gtk_recent_info_get_application_info(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "app_name", NULL };
- gchar *app_name, *app_exec = NULL;
- gboolean ret;
- PyObject *py_ret;
- guint count = 0;
- time_t time_;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:GtkRecentInfo.get_application_info",
- kwlist, &app_name))
- return NULL;
-
- ret = gtk_recent_info_get_application_info(pyg_boxed_get(self,
- GtkRecentInfo),
- app_name, &app_exec, &count,
- &time_);
- if (ret) {
- py_ret = Py_BuildValue("(sii)", app_exec, count, time_);
- g_free(app_exec);
- } else {
- py_ret = Py_None;
- }
- return py_ret;
-}
-%%
-override gtk_size_group_get_widgets noargs
-static PyObject *
-_wrap_gtk_size_group_get_widgets(PyGObject *self)
-{
- GSList *widgets;
- GtkWidget *widget;
- PyObject *py_widgets;
- guint count, i;
-
- widgets = gtk_size_group_get_widgets(GTK_SIZE_GROUP(self->obj));
- count = g_slist_length(widgets);
- py_widgets = PyList_New(count);
- for (i = 0; i < count; i++) {
- widget = g_slist_nth_data(widgets, i);
- PyList_SetItem(py_widgets, i, pygobject_new((GObject*)widget));
- }
-
- return py_widgets;
-}
-%%
-override gtk_recent_filter_add_custom kwargs
-static gboolean
-pygtk_recent_filter_add_custom_cb(const GtkRecentFilterInfo *info,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *py_info, *retobj;
- gboolean ret = TRUE;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_info = PyDict_New();
-
- if (info->contains & GTK_RECENT_FILTER_URI)
- PyDict_SetItemString(py_info, "uri", PyString_FromString(info->uri));
-
- if (info->contains & GTK_RECENT_FILTER_DISPLAY_NAME)
- PyDict_SetItemString(py_info, "display_name",
- PyString_FromString(info->display_name));
-
- if (info->contains & GTK_RECENT_FILTER_MIME_TYPE)
- PyDict_SetItemString(py_info, "mime_type",
- PyString_FromString(info->mime_type));
-
- if (info->contains & GTK_RECENT_FILTER_APPLICATION) {
- gchar **apps = (gchar **)info->applications;
- PyObject *applications = PyList_New(0);
- if (apps) {
- while (*apps) {
- PyList_Append(applications, PyString_FromString(*apps));
- apps++;
- }
- }
- PyDict_SetItemString(py_info, "applications", applications);
- }
-
- if (info->contains & GTK_RECENT_FILTER_GROUP) {
- gchar **grps = (gchar **)info->groups;
- PyObject *groups = PyList_New(0);
- if (grps) {
- while (*grps) {
- PyList_Append(groups, PyString_FromString(*grps));
- grps++;
- }
- }
- PyDict_SetItemString(py_info, "groups", groups);
- }
-
- if (info->contains & GTK_RECENT_FILTER_AGE)
- PyDict_SetItemString(py_info, "age", PyInt_FromLong(info->age));
-
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(NO)", py_info,
- cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(N)", py_info);
- }
-
- if (retobj != NULL) {
- ret = PyInt_AsLong(retobj);
- Py_DECREF(retobj);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_recent_filter_add_custom(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "needed", "func", "data", NULL };
- PyObject *pyneeded, *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
- GtkRecentFilterFlags needed;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO|O:GtkRecentFilter.add_custom",
- kwlist, &pyneeded, &pyfunc, &pyarg))
- return NULL;
-
- if (pyg_flags_get_value(GTK_TYPE_RECENT_FILTER_FLAGS, pyneeded,
- (gint *)&needed))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError,
- "func must be a callable object");
- return NULL;
- }
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_recent_filter_add_custom(GTK_RECENT_FILTER(self->obj), needed,
- pygtk_recent_filter_add_custom_cb,
- cunote, pygtk_custom_destroy_notify);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_recent_filter_filter kwargs
-static PyObject*
-_wrap_gtk_recent_filter_filter(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "filter_info", NULL };
- GtkRecentFilterInfo info;
- PyObject *py_info, *py_ret = Py_False, *item;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkRecentFilter.filter", kwlist,
- &py_info))
- return NULL;
-
- if (!PyDict_Check(py_info)) {
- PyErr_SetString(PyExc_TypeError, "filter_info must be a mapping");
- return NULL;
- }
-
- if ((item = PyDict_GetItemString(py_info, "uri"))) {
- if (!PyString_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "filter_info uri must be a string");
- return NULL;
- }
- info.uri = PyString_AsString(item);
- info.contains |= GTK_RECENT_FILTER_URI;
- } else {
- info.uri = NULL;
- }
-
- if ((item = PyDict_GetItemString(py_info, "mime_type"))) {
- if (!PyString_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "filter_info mime_type must be a string");
- return NULL;
- }
- info.mime_type = PyString_AsString(item);
- info.contains |= GTK_RECENT_FILTER_MIME_TYPE;
- } else {
- info.mime_type = NULL;
- }
-
- if ((item = PyDict_GetItemString(py_info, "display_name"))) {
- if (!PyString_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "filter_info display_name must be a string");
- return NULL;
- }
- info.display_name = PyString_AsString(item);
- info.contains |= GTK_RECENT_FILTER_DISPLAY_NAME;
- } else {
- info.display_name = NULL;
- }
-
- if ((item = PyDict_GetItemString(py_info, "applications"))) {
- gint size, i;
- if (!PySequence_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "filter_info applications must be a sequence of strings");
- return NULL;
- }
- size = PySequence_Size(item);
- info.applications = (const gchar**)g_new0(gchar*, size + 1);
- for (i = 0; i < size; i++) {
- PyObject *app = PySequence_GetItem(item, i);
- if (!PyString_Check(app)) {
- PyErr_SetString(PyExc_TypeError,
- "filter_info applications must be a sequence of strings");
- return NULL;
- }
- info.applications[i] = PyString_AsString(app);
- Py_DECREF(app);
- }
- info.contains |= GTK_RECENT_FILTER_APPLICATION;
- } else {
- info.applications = NULL;
- }
-
- if ((item = PyDict_GetItemString(py_info, "groups"))) {
- gint size, i;
- if (!PySequence_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "filter_info groups must be a sequence of strings");
- return NULL;
- }
- size = PySequence_Size(item);
- info.groups = (const gchar**)g_new0(gchar*, size + 1);
- for (i = 0; i < size; i++) {
- PyObject *grp = PySequence_GetItem(item, i);
- if (!PyString_Check(grp)) {
- PyErr_SetString(PyExc_TypeError,
- "filter_info groups must be a sequence of strings");
- return NULL;
- }
- info.groups[i] = PyString_AsString(grp);
- Py_DECREF(grp);
- }
- info.contains |= GTK_RECENT_FILTER_GROUP;
- } else {
- info.groups = NULL;
- }
-
- if ((item = PyDict_GetItemString(py_info, "age"))) {
- if (!PyInt_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "filter_info age must be an int");
- return NULL;
- }
- info.age = PyInt_AsLong(item);
- info.contains |= GTK_RECENT_FILTER_AGE;
- } else {
- info.age = -1;
- }
-
- if (gtk_recent_filter_filter(GTK_RECENT_FILTER(self->obj), &info))
- py_ret = Py_True;
-
- if (info.applications)
- g_free(info.applications);
- if (info.groups)
- g_free(info.groups);
-
- Py_INCREF(py_ret);
- return py_ret;
-}
-%%
-override gtk_recent_manager_add_full kwargs
-static PyObject*
-_wrap_gtk_recent_manager_add_full(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "uri", "recent_data", NULL };
- PyObject *py_data, *item, *py_ret = Py_False;
- gchar *uri;
- GtkRecentData recent_data;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "sO:GtkRecentManager.add_full", kwlist,
- &uri, &py_data))
- return NULL;
-
- if (!PyDict_Check(py_data)) {
- PyErr_SetString(PyExc_TypeError, "recent_data must be a mapping");
- return NULL;
- }
-
- if (!(item = PyDict_GetItemString(py_data, "mime_type"))
- || !PyString_Check(item)) {
- PyErr_SetString(PyExc_RuntimeError,
- "recent_data must reference a 'mime_type' string value");
- return NULL;
- }
- recent_data.mime_type = PyString_AsString(item);
-
- if (!(item = PyDict_GetItemString(py_data, "app_name"))
- || !PyString_Check(item)) {
- PyErr_SetString(PyExc_RuntimeError,
- "recent_data must reference a 'app_name' string value");
- return NULL;
- }
- recent_data.app_name = PyString_AsString(item);
-
- if (!(item = PyDict_GetItemString(py_data, "app_exec"))
- || !PyString_Check(item)) {
- PyErr_SetString(PyExc_RuntimeError,
- "recent_data must reference a 'app_exec' string value");
- return NULL;
- }
- recent_data.app_exec = PyString_AsString(item);
-
- if ((item = PyDict_GetItemString(py_data, "display_name"))) {
- if (!PyString_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "recent_data 'display_name' must reference a string");
- return NULL;
- }
- recent_data.display_name = PyString_AsString(item);
- } else {
- recent_data.display_name = NULL;
- }
-
- if ((item = PyDict_GetItemString(py_data, "description"))) {
- if (!PyString_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "recent_data 'description' must reference a string");
- return NULL;
- }
- recent_data.description = PyString_AsString(item);
- } else {
- recent_data.description = NULL;
- }
-
- if ((item = PyDict_GetItemString(py_data, "is_private"))) {
- if (!PyBool_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "recent_data 'is_private' must reference a boolean");
- return NULL;
- }
- if (item == Py_True)
- recent_data.is_private = TRUE;
- else
- recent_data.is_private = FALSE;
- } else {
- recent_data.is_private = FALSE;
- }
-
- if ((item = PyDict_GetItemString(py_data, "groups"))) {
- gint size, i;
- if (!PySequence_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "recent_data 'groups' must reference a sequence of strings");
- return NULL;
- }
- size = PySequence_Size(item);
- recent_data.groups = (gchar**)g_new0(gchar*, size+1);
- for (i = 0; i < size; i++) {
- PyObject *group = PySequence_GetItem(item, i);
- if (!PyString_Check(group)) {
- PyErr_SetString(PyExc_TypeError,
- "recent_data 'groups' must reference a sequence of strings");
- g_free(recent_data.groups);
- Py_XDECREF(group);
- return NULL;
- }
- recent_data.groups[i] = PyString_AsString(group);
- Py_DECREF(group);
- }
- } else {
- recent_data.groups = NULL;
- }
-
- if (gtk_recent_manager_add_full(GTK_RECENT_MANAGER(self->obj), uri,
- &recent_data))
- py_ret = Py_True;
-
- if (recent_data.groups)
- g_free(recent_data.groups);
-
- Py_INCREF(py_ret);
- return py_ret;
-}
-%%
-override gtk_recent_manager_get_items noargs
-static PyObject *
-_wrap_gtk_recent_manager_get_items(PyGObject *self)
-{
- GtkRecentInfo *info;
- GList *items;
- PyObject *py_items;
- guint count, i;
-
- items = gtk_recent_manager_get_items(GTK_RECENT_MANAGER(self->obj));
- count = g_list_length(items);
- py_items = PyList_New(count);
- for (i = 0; i < count; i++) {
- info = g_list_nth_data(items, i);
- PyList_SetItem(py_items, i,
- pyg_boxed_new(GTK_TYPE_RECENT_INFO, info, TRUE, TRUE));
- }
- g_list_foreach(items, (GFunc) gtk_recent_info_unref, NULL);
- g_list_free(items);
-
- return py_items;
-}
-%%
-override gtk_status_icon_get_geometry noargs
-static PyObject *
-_wrap_gtk_status_icon_get_geometry(PyGObject *self)
-{
- GdkScreen *screen;
- GdkRectangle rect;
- GtkOrientation orientation;
- gboolean ret;
-
- ret = gtk_status_icon_get_geometry(GTK_STATUS_ICON(self->obj),
- &screen, &rect, &orientation);
- if (ret)
- return Py_BuildValue("(NNN)", pygobject_new((GObject*)screen),
- pyg_boxed_new(GDK_TYPE_RECTANGLE, &rect,
- TRUE, TRUE),
- pyg_enum_from_gtype(GTK_TYPE_ORIENTATION,
- orientation));
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_status_icon_position_menu args
-static PyObject *
-_wrap_gtk_status_icon_position_menu(PyGObject *self, PyObject *args)
-{
- PyGObject *menu, *icon;
- gint x, y;
- gboolean push_in;
-
- if (!PyArg_ParseTuple(args,"O!O!:gtk.status_icon_position_menu",
- &PyGtkMenu_Type, &menu,
- &PyGtkStatusIcon_Type, &icon))
- return NULL;
-
- gtk_status_icon_position_menu(GTK_MENU(menu->obj), &x, &y, &push_in,
- (gpointer)icon->obj);
- return Py_BuildValue("(iii)", x, y, push_in);
-}
-%%
-override gtk_targets_include_image kwargs
-static PyObject *
-_wrap_gtk_targets_include_image(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "targets", "writable", NULL };
- GdkAtom *targets;
- gint n_targets;
- gboolean writable;
- PyObject *py_targets, *py_ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oi:gtk.targets_include_image",
- kwlist, &py_targets, &writable))
- return NULL;
-
- if (!(targets = pygdk_atom_vector_from_sequence(py_targets, &n_targets)))
- return NULL;
-
- if (gtk_targets_include_image(targets, n_targets, writable))
- py_ret = Py_True;
- else
- py_ret = Py_False;
- g_free(targets);
- return py_ret;
-}
-%%
-override gtk_targets_include_text kwargs
-static PyObject *
-_wrap_gtk_targets_include_text(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "targets", NULL };
- GdkAtom *targets;
- gint n_targets;
- PyObject *py_targets, *py_ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:gtk.targets_include_text",
- kwlist, &py_targets))
- return NULL;
-
- if (!(targets = pygdk_atom_vector_from_sequence(py_targets, &n_targets)))
- return NULL;
-
- if (gtk_targets_include_text(targets, n_targets))
- py_ret = Py_True;
- else
- py_ret = Py_False;
- g_free(targets);
- return py_ret;
-}
-%%
-override gtk_targets_include_uri kwargs
-static PyObject *
-_wrap_gtk_targets_include_uri(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "targets", NULL };
- GdkAtom *targets;
- gint n_targets;
- PyObject *py_targets, *py_ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:gtk.targets_include_uri",
- kwlist, &py_targets))
- return NULL;
-
- if (!(targets = pygdk_atom_vector_from_sequence(py_targets, &n_targets)))
- return NULL;
-
- if (gtk_targets_include_uri(targets, n_targets))
- py_ret = Py_True;
- else
- py_ret = Py_False;
- g_free(targets);
- return py_ret;
-}
-%%
-override gtk_targets_include_rich_text kwargs
-static PyObject *
-_wrap_gtk_targets_include_rich_text(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "targets", "buffer", NULL };
- GdkAtom *targets;
- PyGObject *buffer;
- gint n_targets;
- PyObject *py_targets, *py_ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO!:gtk.targets_include_rich_text",
- kwlist, &py_targets,
- &PyGtkTextBuffer_Type, &buffer))
- return NULL;
-
- if (!(targets = pygdk_atom_vector_from_sequence(py_targets, &n_targets)))
- return NULL;
-
- if (gtk_targets_include_rich_text(targets, n_targets,
- GTK_TEXT_BUFFER(buffer->obj)))
- py_ret = Py_True;
- else
- py_ret = Py_False;
- g_free(targets);
- return py_ret;
-}
-%%
-override gtk_target_list_add_rich_text_targets kwargs
-static PyObject *
-_wrap_gtk_target_list_add_rich_text_targets(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "list", "info", "deserializable", "buffer", NULL };
- PyObject *list = NULL;
- guint info = 0;
- GtkTargetList *targets;
- gboolean deserializable;
- PyGObject *buffer;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OiiO!:gtk.target_list_add_rich_text_targets",
- kwlist, &list, &info, &deserializable,
- &PyGtkTextBuffer_Type, &buffer)) {
- return NULL;
- }
- if (!list || list == Py_None) {
- targets = gtk_target_list_new(NULL, 0);
- } else if (!(targets = pygtk_target_list_from_sequence(list)))
- return NULL;
-
- gtk_target_list_add_rich_text_targets(targets, info, deserializable,
- GTK_TEXT_BUFFER(buffer->obj));
- list = pygtk_target_list_to_list(targets);
- gtk_target_list_unref(targets);
- return list;
-}
-%%
-override gtk_notebook_set_window_creation_hook kwargs
-static GtkNotebook *
-pygtk_notebook_set_window_creation_hook_cb(GtkNotebook *notebook,
- GtkWidget *page,
- gint x, gint y,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *py_notebook, *py_page, *retobj;
- GtkNotebook *ret = NULL;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_notebook = pygobject_new((GObject*)notebook);
- py_page = pygobject_new((GObject*)page);
-
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(NNiiO)", py_notebook,
- py_page, x, y, cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(NNii)", py_notebook,
- py_page, x, y);
- }
-
- if (retobj) {
- if (!pygobject_check((PyGObject*)retobj, &PyGtkNotebook_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "GtkNotebook window creation hook function return should be a GtkNotebook or None");
- PyErr_Print();
- ret = NULL;
- } else {
- ret = GTK_NOTEBOOK(pygobject_get(retobj));
- }
- Py_DECREF(retobj);
- } else {
- PyErr_Print();
- ret = NULL;
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_notebook_set_window_creation_hook(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", NULL };
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:gtk.notebook_set_window_creation_hook",
- kwlist, &pyfunc, &pyarg))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError,
- "func must be a callable object");
- return NULL;
- }
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_notebook_set_window_creation_hook(
- pygtk_notebook_set_window_creation_hook_cb,
- cunote, pygtk_custom_destroy_notify);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_print_operation_get_error noargs
-static PyObject *
-_wrap_gtk_print_operation_get_error(PyGObject *self)
-{
- GError *error = NULL;
-
- gtk_print_operation_get_error(GTK_PRINT_OPERATION(self->obj), &error);
-
- if (pyg_error_check(&error)) {
- PyObject *type, *value, *traceback;
- PyErr_Fetch(&type, &value, &traceback);
- Py_DECREF(type);
- Py_DECREF(traceback);
- return value;
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-override GtkEditable__do_insert_text kwargs
-static PyObject *
-_wrap_GtkEditable__do_insert_text(PyObject *cls, PyObject *args, PyObject *kwargs)
-{
- gpointer klass;
- static char *kwlist[] = { "self", "text", "position", NULL };
- PyGObject *self;
- Py_ssize_t text_len;
- int position;
- char *text;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,"O!s#i:GtkEditable.do_insert_text", kwlist,
- &PyGtkEditable_Type, &self,
- &text, &text_len, &position))
- return NULL;
-
-
- klass = g_type_class_ref(pyg_type_from_object(cls));
- if (GTK_EDITABLE_CLASS(klass)->insert_text)
- GTK_EDITABLE_CLASS(klass)->insert_text(GTK_EDITABLE(self->obj),
- text, text_len, &position);
- else {
- PyErr_SetString(PyExc_NotImplementedError, "virtual method GtkEditable.do_insert_text not implemented");
- g_type_class_unref(klass);
- return NULL;
- }
- g_type_class_unref(klass);
-
- return PyInt_FromLong(position);
-}
-
-%%
-override GtkEditable__do_do_insert_text kwargs
-static PyObject *
-_wrap_GtkEditable__do_do_insert_text(PyObject *cls, PyObject *args, PyObject *kwargs)
-{
- gpointer klass;
- static char *kwlist[] = { "self", "text", "position", NULL };
- PyGObject *self;
- Py_ssize_t text_len;
- int position;
- char *text;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,"O!s#i:GtkEditable.do_do_insert_text", kwlist,
- &PyGtkEditable_Type, &self,
- &text, &text_len, &position))
- return NULL;
-
-
- klass = g_type_class_ref(pyg_type_from_object(cls));
- if (GTK_EDITABLE_CLASS(klass)->do_insert_text)
- GTK_EDITABLE_CLASS(klass)->do_insert_text(GTK_EDITABLE(self->obj),
- text, text_len, &position);
- else {
- PyErr_SetString(PyExc_NotImplementedError, "virtual method GtkEditable.do_do_insert_text not implemented");
- g_type_class_unref(klass);
- return NULL;
- }
- g_type_class_unref(klass);
-
- return PyInt_FromLong(position);
-}
-
-%%
-override GtkEditable__do_get_selection_bounds kwargs
-static PyObject *
-_wrap_GtkEditable__do_get_selection_bounds(PyObject *cls, PyObject *args, PyObject *kwargs)
-{
- gpointer klass;
- static char *kwlist[] = { "self", NULL };
- PyGObject *self;
- int start_pos, end_pos;;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,"O!:GtkEditable.do_get_selection_bounds", kwlist,
- &PyGtkEditable_Type, &self))
- return NULL;
-
- klass = g_type_class_ref(pyg_type_from_object(cls));
- if (GTK_EDITABLE_CLASS(klass)->get_selection_bounds)
- GTK_EDITABLE_CLASS(klass)->get_selection_bounds(GTK_EDITABLE(self->obj),
- &start_pos, &end_pos);
- else {
- PyErr_SetString(PyExc_NotImplementedError, "virtual method GtkEditable.do_get_selection_bounds not implemented");
- g_type_class_unref(klass);
- return NULL;
- }
- g_type_class_unref(klass);
-
- return Py_BuildValue("ii", start_pos, end_pos);
-}
-
-%%
-define GtkAction.set_menu_item_type kwargs classmethod
-static PyObject *
-_wrap_gtk_action_set_menu_item_type(PyObject *cls,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "menu_item_type", NULL };
- GType gtype, menu_item_type;
- GtkActionClass *klass;
- PyObject *py_menu_item_type;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:gtk.Action.set_menu_item_type", kwlist,
- &py_menu_item_type))
- return NULL;
-
- if ((gtype = pyg_type_from_object(cls)) == 0)
- return NULL;
- if ((menu_item_type = pyg_type_from_object(py_menu_item_type)) == 0)
- return NULL;
- klass = (GtkActionClass *) g_type_class_ref(gtype);
- klass->menu_item_type = menu_item_type;
- g_type_class_unref(klass);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-define GtkAction.set_tool_item_type kwargs classmethod
-static PyObject *
-_wrap_gtk_action_set_tool_item_type(PyObject *cls,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "tool_item_type", NULL };
- GType gtype, tool_item_type;
- GtkActionClass *klass;
- PyObject *py_tool_item_type;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:gtk.Action.set_tool_item_type", kwlist,
- &py_tool_item_type))
- return NULL;
-
- if ((gtype = pyg_type_from_object(cls)) == 0)
- return NULL;
- if ((tool_item_type = pyg_type_from_object(py_tool_item_type)) == 0)
- return NULL;
- klass = (GtkActionClass *) g_type_class_ref(gtype);
- klass->toolbar_item_type = tool_item_type;
- g_type_class_unref(klass);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_accel_map_foreach kwargs
-static void
-pygtk_accel_map_foreach_cb(gpointer data, const gchar *accel_path,
- guint accel_key, GdkModifierType accel_mode,
- gboolean changed)
-{
- PyGILState_STATE state;
- PyObject *retobj, *py_accel_mode;
- PyGtkCustomNotify *cunote = data;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
- py_accel_mode = pyg_flags_from_gtype(GDK_TYPE_MODIFIER_TYPE, accel_mode);
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(siNNO)",
- accel_path, accel_key, py_accel_mode,
- PyBool_FromLong(changed), cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(siNN)", accel_path,
- accel_key, py_accel_mode,
- PyBool_FromLong(changed));
-
- if (retobj == NULL)
- PyErr_Print();
-
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_accel_map_foreach(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "foreach_func", "data", NULL };
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:gtk.accel_map_foreach",
- kwlist, &pyfunc, &pyarg))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError,
- "foreach_func must be a callable object");
- return NULL;
- }
-
- cunote.func = pyfunc;
- cunote.data = pyarg;
-
- gtk_accel_map_foreach(&cunote, pygtk_accel_map_foreach_cb);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_accel_map_foreach_unfiltered kwargs
-static PyObject *
-_wrap_gtk_accel_map_foreach_unfiltered(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "foreach_func", "data", NULL };
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:gtk.accel_map_foreach_unfiltered",
- kwlist, &pyfunc, &pyarg))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError,
- "foreach_func must be a callable object");
- return NULL;
- }
-
- cunote.func = pyfunc;
- cunote.data = pyarg;
-
- gtk_accel_map_foreach_unfiltered(&cunote, pygtk_accel_map_foreach_cb);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
diff --git a/gtk/gtkclist.override b/gtk/gtkclist.override
deleted file mode 100644
index a3e477dc..00000000
--- a/gtk/gtkclist.override
+++ /dev/null
@@ -1,359 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gtkclist.override: overrides for the gtk.CList type.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-ignore
- gtk_clist_new
- gtk_clist_set_row_data_full
- gtk_clist_set_compare_func
-%%
-override gtk_clist_new_with_titles kwargs
-static int
-_wrap_gtk_clist_new_with_titles(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "count", "titles", NULL };
- int count = 1, i;
- PyObject *py_list = NULL;
-
- if (PyErr_Warn(PyExc_DeprecationWarning, "use gtk.TreeView") < 0)
- return -1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|iO:GtkCList.__init__",
- kwlist, &count, &py_list))
- return -1;
- if (py_list) {
- gchar **list;
-
- if (!PySequence_Check(py_list)) {
- PyErr_SetString(PyExc_TypeError,"2nd argument not a sequence");
- return -1;
- }
- if (PySequence_Length(py_list) < count) {
- PyErr_SetString(PyExc_TypeError, "sequence not long enough");
- return -1;
- }
- list = g_new(gchar *, count);
- for (i = 0; i < count; i++) {
- PyObject *item = PySequence_GetItem(py_list, i);
-
- Py_DECREF(item); /* PySequence_GetItem INCREF's */
- if (!PyString_Check(item) && !PyUnicode_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "sequence item not a string or unicode object");
- g_free(list);
- return -1;
- }
- list[i] = PyString_AsString(item);
- }
- self->obj = (GObject *)gtk_clist_new_with_titles(count, list);
- g_free(list);
- } else
- self->obj = (GObject *)gtk_clist_new(count);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,"could not create GtkCList object");
- return -1;
- }
- pygobject_register_wrapper((PyObject *)self);
- return 0;
-}
-%%
-override gtk_clist_get_text kwargs
-static PyObject *
-_wrap_gtk_clist_get_text(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "row", "column", NULL };
- int r, c;
- char *text = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "ii:GtkCList.get_text",
- kwlist, &r, &c))
- return NULL;
- if (!gtk_clist_get_text(GTK_CLIST(self->obj), r, c, &text) || text==NULL) {
- PyErr_SetString(PyExc_ValueError, "can't get text value");
- return NULL;
- }
- return PyString_FromString(text);
-}
-%%
-override gtk_clist_get_pixmap kwargs
-static PyObject *
-_wrap_gtk_clist_get_pixmap(PyGObject *self, PyObject *args, PyObject*kwargs)
-{
- static char *kwlist[] = { "row", "column", NULL };
- int r, c;
- GdkPixmap *pixmap;
- GdkBitmap *mask;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "ii:GtkCList.get_pixmap",
- kwlist, &r, &c))
- return NULL;
- if (!gtk_clist_get_pixmap(GTK_CLIST(self->obj), r, c,
- &pixmap, &mask)) {
- PyErr_SetString(PyExc_ValueError, "can't get pixmap value");
- return NULL;
- }
- return Py_BuildValue("(NN)", pygobject_new((GObject *)pixmap),
- pygobject_new((GObject *)mask));
-}
-%%
-override gtk_clist_get_pixtext kwargs
-static PyObject *
-_wrap_gtk_clist_get_pixtext(PyGObject *self, PyObject *args, PyObject*kwargs)
-{
- static char *kwlist[] = { "row", "column", NULL };
- int r, c;
- gchar *text;
- guint8 spacing;
- GdkPixmap *pixmap;
- GdkBitmap *mask;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "ii:GtkCList.get_pixtext",
- kwlist, &r, &c))
- return NULL;
- if (!gtk_clist_get_pixtext(GTK_CLIST(self->obj), r, c,
- &text, &spacing, &pixmap, &mask)) {
- PyErr_SetString(PyExc_ValueError, "can't get pixtext value");
- return NULL;
- }
- return Py_BuildValue("(ziNN)", text, (gint)spacing,
- pygobject_new((GObject *)pixmap),
- pygobject_new((GObject *)mask));
-}
-%%
-override gtk_clist_prepend kwargs
-static PyObject *
-_wrap_gtk_clist_prepend(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "text", NULL };
- int col, i;
- PyObject *py_list;
- gchar **list;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GtkCList.prepend",
- kwlist, &py_list))
- return NULL;
- if (!PySequence_Check(py_list)) {
- PyErr_SetString(PyExc_TypeError, "argument not a sequence");
- return NULL;
- }
- col = GTK_CLIST(self->obj)->columns;
- if (PySequence_Length(py_list) < col) {
- PyErr_SetString(PyExc_TypeError, "sequence too short");
- return NULL;
- }
- list = g_new(gchar *, col);
- for (i = 0; i < col; i++) {
- PyObject *item = PySequence_GetItem(py_list, i);
-
- Py_DECREF(item);
- if (!PyString_Check(item) && !PyUnicode_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "sequence item not a string or unicode object");
- g_free(list);
- return NULL;
- }
- list[i] = PyString_AsString(item);
- }
- i = gtk_clist_prepend(GTK_CLIST(self->obj), list);
- g_free(list);
- return PyInt_FromLong(i);
-}
-%%
-override gtk_clist_append kwargs
-static PyObject *
-_wrap_gtk_clist_append(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "text", NULL };
- int col, i;
- PyObject *py_list;
- gchar **list;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GtkCList.append",
- kwlist, &py_list))
- return NULL;
- if (!PySequence_Check(py_list)) {
- PyErr_SetString(PyExc_TypeError, "argument not a sequence");
- return NULL;
- }
- col = GTK_CLIST(self->obj)->columns;
- if (PySequence_Length(py_list) < col) {
- PyErr_SetString(PyExc_TypeError, "sequence too short");
- return NULL;
- }
- list = g_new(gchar *, col);
- for (i = 0; i < col; i++) {
- PyObject *item = PySequence_GetItem(py_list, i);
-
- Py_DECREF(item);
- if (!PyString_Check(item) && !PyUnicode_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "sequence item not a string or unicode object");
- g_free(list);
- return NULL;
- }
- list[i] = PyString_AsString(item);
- }
- i = gtk_clist_append(GTK_CLIST(self->obj), list);
- g_free(list);
- return PyInt_FromLong(i);
-}
-%%
-override gtk_clist_insert kwargs
-static PyObject *
-_wrap_gtk_clist_insert(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "row", "text", NULL };
- int col, row, i;
- PyObject *py_list;
- gchar **list;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "iO:GtkCList.insert",
- kwlist, &row, &py_list))
- return NULL;
- if (!PySequence_Check(py_list)) {
- PyErr_SetString(PyExc_TypeError, "argument not a sequence");
- return NULL;
- }
- col = GTK_CLIST(self->obj)->columns;
- if (PySequence_Length(py_list) < col) {
- PyErr_SetString(PyExc_TypeError, "sequence too short");
- return NULL;
- }
- list = g_new(gchar *, col);
- for (i = 0; i < col; i++) {
- PyObject *item = PySequence_GetItem(py_list, i);
-
- Py_DECREF(item);
- if (!PyString_Check(item) && !PyUnicode_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "sequence item not a string or unicode object");
- g_free(list);
- return NULL;
- }
- list[i] = PyString_AsString(item);
- }
- i = gtk_clist_insert(GTK_CLIST(self->obj), row, list);
- g_free(list);
- return PyInt_FromLong(i);
-}
-%%
-override gtk_clist_set_row_data kwargs
-static PyObject *
-_wrap_gtk_clist_set_row_data(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "row", "data", NULL };
- int row;
- PyObject *data;
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "iO:GtkCList.set_row_data",
- kwlist, &row, &data))
- return NULL;
- Py_INCREF(data);
- gtk_clist_set_row_data_full(GTK_CLIST(self->obj), row, data,
- (GtkDestroyNotify)pyg_destroy_notify);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_clist_get_row_data kwargs
-static PyObject *
-_wrap_gtk_clist_get_row_data(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "row", NULL };
- PyObject *ret;
- int row;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i:GtkCList.get_row_data",
- kwlist, &row))
- return NULL;
- ret = gtk_clist_get_row_data(GTK_CLIST(self->obj), row);
- if (!ret) ret = Py_None;
- Py_INCREF(ret);
- return ret;
-}
-%%
-override gtk_clist_find_row_from_data kwargs
-static PyObject *
-_wrap_gtk_clist_find_row_from_data(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "data", NULL };
- PyObject *data;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkCList.find_row_from_data", kwlist,
- &data))
- return NULL;
- return PyInt_FromLong(gtk_clist_find_row_from_data(
- GTK_CLIST(self->obj), data));
-}
-%%
-override gtk_clist_get_selection_info kwargs
-static PyObject *
-_wrap_gtk_clist_get_selection_info(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "x", "y", NULL };
- gint x, y, row, column;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "ii:GtkCList.get_selection_info", kwlist,
- &x, &y))
- return NULL;
- if (gtk_clist_get_selection_info(GTK_CLIST(self->obj), x, y,
- &row, &column))
- return Py_BuildValue("(ii)", row, column);
- else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override-attr GtkCList.selection
-static PyObject *
-_wrap_gtk_clist__get_selection(PyGObject *self, void *closure)
-{
- guint row;
- GList *selection;
- PyObject *py_int, *ret = PyList_New(0);
-
- if (ret == NULL)
- return NULL;
-
- for (selection = GTK_CLIST(self->obj)->selection; selection != NULL;
- selection = selection->next) {
- row = GPOINTER_TO_UINT(selection->data);
-
- py_int = PyInt_FromLong(row);
-
- if (!py_int) {
- Py_DECREF(ret);
- return NULL;
- }
-
- PyList_Append(ret, py_int);
- Py_DECREF(py_int);
- }
- return ret;
-
-}
diff --git a/gtk/gtkcontainer.override b/gtk/gtkcontainer.override
deleted file mode 100644
index 17a2c8a5..00000000
--- a/gtk/gtkcontainer.override
+++ /dev/null
@@ -1,1084 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gtkcontainer.override: overrides for various container widgets.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-ignore
- gtk_container_get_toplevels
- gtk_container_add_child_arg_type
- gtk_container_query_child_args
- gtk_container_child_args_collect
- gtk_container_child_arg_get_info
- gtk_container_foreach_full
- gtk_container_add_with_args
- gtk_container_addv
- gtk_container_child_set_valist
- gtk_container_child_get_valist
- gtk_container_class_find_child_property
-%%
-override gtk_container_children noargs
-static PyObject *
-_wrap_gtk_container_children(PyGObject *self)
-{
- if (PyErr_Warn(PyExc_DeprecationWarning, "use GtkContainer.get_children"))
- return NULL;
- return _wrap_gtk_container_get_children(self);
-}
-%%
-override gtk_container_get_children noargs
-static PyObject *
-_wrap_gtk_container_get_children(PyGObject *self)
-{
- GList *list, *tmp;
- PyObject *py_list;
-
- list = gtk_container_get_children(GTK_CONTAINER(self->obj));
-
- if ((py_list = PyList_New(0)) == NULL) {
- g_list_free(list);
- return NULL;
- }
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- PyObject *gtk_obj = pygobject_new(G_OBJECT(tmp->data));
-
- if (gtk_obj == NULL) {
- g_list_free(list);
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_Append(py_list, gtk_obj);
- Py_DECREF(gtk_obj);
- }
- g_list_free(list);
- return py_list;
-}
-%%
-override gtk_container_set_focus_chain kwargs
-static PyObject *
-_wrap_gtk_container_set_focus_chain(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "focusable_widgets", NULL };
- PyObject *py_focusable_widgets;
- gint len, i;
- GList *focusable_widgets = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkContainer.set_focus_chain", kwlist,
- &py_focusable_widgets))
- return NULL;
- if (!PySequence_Check(py_focusable_widgets)) {
- PyErr_SetString(PyExc_TypeError,
- "focusable_widgets must be a sequence");
- return NULL;
- }
- len = PySequence_Length(py_focusable_widgets);
- for (i = 0; i < len; i++) {
- PyObject *item = PySequence_GetItem(py_focusable_widgets, i);
-
- if (!pygobject_check(item, &PyGtkWidget_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "focusable_widgets members must be GtkWidgets");
- Py_DECREF(item);
- return NULL;
- }
- focusable_widgets = g_list_prepend(focusable_widgets,
- pygobject_get(item));
- Py_DECREF(item);
- }
- focusable_widgets = g_list_reverse(focusable_widgets);
- gtk_container_set_focus_chain(GTK_CONTAINER(self->obj), focusable_widgets);
- g_list_free(focusable_widgets);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_container_get_focus_chain noargs
-static PyObject *
-_wrap_gtk_container_get_focus_chain(PyGObject *self)
-{
- GList *list = NULL;
-
- if (gtk_container_get_focus_chain(GTK_CONTAINER(self->obj), &list)) {
- PyObject *py_list;
- GList *tmp;
-
- if ((py_list = PyList_New(0)) == NULL) {
- g_list_free(list);
- return NULL;
- }
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- PyObject *gtk_obj = pygobject_new(G_OBJECT(tmp->data));
-
- if (gtk_obj == NULL) {
- g_list_free(list);
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_Append(py_list, gtk_obj);
- Py_DECREF(gtk_obj);
- }
- g_list_free(list);
- return py_list;
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_container_child_get_property
-static PyObject *
-_wrap_gtk_container_child_get_property(PyGObject *self, PyObject *args)
-{
- PyGObject *pychild;
- gchar *property_name;
- GtkContainer *container;
- GtkWidget *child;
- GList *children;
- GObjectClass *class;
- GParamSpec *pspec;
- GValue value = { 0, } ;
- PyObject *ret;
-
- if (!PyArg_ParseTuple(args, "O!s:GtkContainer.child_get_property",
- &PyGtkWidget_Type, &pychild,
- &property_name)) {
- return NULL;
- }
-
- container = GTK_CONTAINER(self->obj);
- child = GTK_WIDGET(pychild->obj);
-
- children = gtk_container_get_children(container);
- if (g_list_find(children, child) == NULL) {
- PyErr_SetString(PyExc_TypeError,
- "first argument must be a child");
- return NULL;
- }
-
- class = G_OBJECT_GET_CLASS(container);
- pspec = gtk_container_class_find_child_property(class, property_name);
- if (!pspec) {
- gchar buf[512];
- g_snprintf(buf, sizeof(buf),
- "container does not support property `%s'",
- property_name);
-
- PyErr_SetString(PyExc_TypeError, buf);
- return NULL;
- }
-
- g_value_init(&value, G_PARAM_SPEC_VALUE_TYPE(pspec));
-
- gtk_container_child_get_property(container,
- child,
- property_name,
- &value);
-
- ret = pyg_value_as_pyobject(&value, TRUE);
- g_value_unset(&value);
-
- return ret;
-}
-%%
-override gtk_container_child_set_property
-static PyObject *
-_wrap_gtk_container_child_set_property(PyGObject *self, PyObject *args)
-{
- gchar *property_name;
- PyGObject *pychild;
- GtkContainer *container;
- GtkWidget *child;
- GList *children;
- PyGObject *pyvalue;
- GObjectClass *class;
- GParamSpec *pspec;
- GValue value = { 0, } ;
-
- if (!PyArg_ParseTuple(args, "O!sO:GtkContainer.child_set_property",
- &PyGtkWidget_Type, &pychild,
- &property_name, &pyvalue)) {
- return NULL;
- }
-
- container = GTK_CONTAINER(self->obj);
- child = GTK_WIDGET(pychild->obj);
-
- children = gtk_container_get_children(container);
- if (g_list_find(children, child) == NULL) {
- PyErr_SetString(PyExc_TypeError,
- "first argument must be a child");
- return NULL;
- }
-
- class = G_OBJECT_GET_CLASS(self->obj);
- pspec = gtk_container_class_find_child_property(class, property_name);
- if (!pspec) {
- gchar buf[512];
- g_snprintf(buf, sizeof(buf),
- "container does not support property `%s'",
- property_name);
- PyErr_SetString(PyExc_TypeError, buf);
-
- return NULL;
- }
-
- g_value_init(&value, G_PARAM_SPEC_VALUE_TYPE(pspec));
-
- pyg_value_from_pyobject(&value, (PyObject*)pyvalue);
-
- gtk_container_child_set_property(container,
- child,
- property_name,
- &value);
- g_value_unset(&value);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_container_child_set
-static PyObject *
-_wrap_gtk_container_child_set(PyGObject *self, PyObject *args)
-{
- PyGObject *pychild;
- GtkContainer *container;
- GtkWidget *child;
- GList *children;
- GObjectClass *class;
- int len, i;
-
- if ((len = PyTuple_Size(args)) < 1) {
- PyErr_SetString(PyExc_TypeError, "requires at least one argument");
- return NULL;
- }
- pychild = (PyGObject*)PyTuple_GetItem(args, 0);
- if (!pygobject_check(pychild, &PyGtkWidget_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "first argument should be a GtkWidget");
- return NULL;
- }
-
- container = GTK_CONTAINER(self->obj);
- child = GTK_WIDGET(pychild->obj);
-
- children = gtk_container_get_children(container);
- if (g_list_find(children, child) == NULL) {
- PyErr_SetString(PyExc_TypeError,
- "first argument must be a child");
- return NULL;
- }
-
- if ((len - 1) % 2) {
- PyErr_SetString(PyExc_TypeError,
- "Argument list must be column, value pairs. No -1 "
- "termination is needed.");
- return NULL;
- }
-
- class = G_OBJECT_GET_CLASS(self->obj);
- for (i = 1; i < len; i+=2) {
- PyObject *py_property = PyTuple_GetItem(args, i);
- PyObject *py_value = PyTuple_GetItem(args, i + 1);
- gchar *property_name;
- GParamSpec *pspec;
- GValue value = { 0 };
-
- if (!PyString_Check(py_property)) {
- PyErr_SetString(PyExc_TypeError,
- "Expected string argument for property.");
- return NULL;
- }
-
- property_name = PyString_AsString(py_property);
-
- pspec = gtk_container_class_find_child_property(class, property_name);
- if (!pspec) {
- gchar buf[512];
- g_snprintf(buf, sizeof(buf),
- "container does not support property `%s'",
- property_name);
- PyErr_SetString(PyExc_TypeError, buf);
-
- return NULL;
- }
-
- g_value_init(&value, G_PARAM_SPEC_VALUE_TYPE(pspec));
-
- pyg_value_from_pyobject(&value, (PyObject*)py_value);
-
- gtk_container_child_set_property(container, child, property_name, &value);
-
- g_value_unset(&value);
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_container_child_get
-static PyObject *
-_wrap_gtk_container_child_get(PyGObject *self, PyObject *args)
-{
- PyGObject *pychild;
- GtkContainer *container;
- GtkWidget *child;
- GList *children;
- GObjectClass *class;
- int len, i;
- PyObject *tuple;
-
- if ((len = PyTuple_Size(args)) < 1) {
- PyErr_SetString(PyExc_TypeError, "requires at least one argument");
- return NULL;
- }
- pychild = (PyGObject*)PyTuple_GetItem(args, 0);
- if (!pygobject_check(pychild, &PyGtkWidget_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "first argument should be a GtkWidget");
- return NULL;
- }
-
- container = GTK_CONTAINER(self->obj);
- child = GTK_WIDGET(pychild->obj);
-
- children = gtk_container_get_children(container);
- if (g_list_find(children, child) == NULL) {
- PyErr_SetString(PyExc_TypeError,
- "first argument must be a child");
- return NULL;
- }
-
- tuple = PyTuple_New(len-1);
- class = G_OBJECT_GET_CLASS(self->obj);
- for (i = 1; i < len; i++) {
- PyObject *py_property = PyTuple_GetItem(args, i);
- gchar *property_name;
- GParamSpec *pspec;
- GValue value = { 0 };
- PyObject *item;
-
- if (!PyString_Check(py_property)) {
- PyErr_SetString(PyExc_TypeError,
- "Expected string argument for property.");
- return NULL;
- }
-
- property_name = PyString_AsString(py_property);
-
- pspec = gtk_container_class_find_child_property(class, property_name);
- if (!pspec) {
- gchar buf[512];
- g_snprintf(buf, sizeof(buf),
- "container does not support property `%s'",
- property_name);
- PyErr_SetString(PyExc_TypeError, buf);
-
- return NULL;
- }
-
- g_value_init(&value, G_PARAM_SPEC_VALUE_TYPE(pspec));
-
- gtk_container_child_get_property(container, child, property_name, &value);
-
- item = pyg_value_as_pyobject(&value, TRUE);
- PyTuple_SetItem(tuple, i-1, item);
-
- g_value_unset(&value);
- }
- return tuple;
-}
-%%
-override gtk_container_add_with_properties
-static PyObject *
-_wrap_gtk_container_add_with_properties(PyGObject *self, PyObject *args)
-{
- PyGObject *pychild;
- GtkContainer *container;
- GtkWidget *child;
- GObjectClass *class;
- int len, i;
-
- if ((len = PyTuple_Size(args)) < 1) {
- PyErr_SetString(PyExc_TypeError, "requires at least one argument");
- return NULL;
- }
- pychild = (PyGObject*)PyTuple_GetItem(args, 0);
- if (!pygobject_check(pychild, &PyGtkWidget_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "first argument should be a GtkWidget");
- return NULL;
- }
-
- container = GTK_CONTAINER(self->obj);
- child = GTK_WIDGET(pychild->obj);
-
- if ((len - 1) % 2) {
- PyErr_SetString(PyExc_TypeError,
- "Argument list must be column, value pairs. No -1 "
- "termination is needed.");
- return NULL;
- }
-
- gtk_widget_freeze_child_notify(child);
-
- gtk_container_add(container, child);
-
- class = G_OBJECT_GET_CLASS(self->obj);
- for (i = 1; i < len; i+=2) {
- PyObject *py_property = PyTuple_GetItem(args, i);
- PyObject *py_value = PyTuple_GetItem(args, i + 1);
- gchar *property_name;
- GParamSpec *pspec;
- GValue value = { 0 };
-
- if (!PyString_Check(py_property)) {
- PyErr_SetString(PyExc_TypeError,
- "Expected string argument for property.");
- return NULL;
- }
-
- property_name = PyString_AsString(py_property);
-
- pspec = gtk_container_class_find_child_property(class, property_name);
- if (!pspec) {
- gchar buf[512];
- g_snprintf(buf, sizeof(buf),
- "container does not support property `%s'",
- property_name);
- PyErr_SetString(PyExc_TypeError, buf);
-
- return NULL;
- }
-
- g_value_init(&value, G_PARAM_SPEC_VALUE_TYPE(pspec));
-
- pyg_value_from_pyobject(&value, (PyObject*)py_value);
-
- gtk_container_child_set_property(container, child, property_name, &value);
-
- g_value_unset(&value);
- }
-
- gtk_widget_thaw_child_notify(child);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_container_foreach
-static void
-pygtk_container_for_common_marshal(GtkWidget *widget,
- gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *py_widget, *retobj;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_widget = pygobject_new((GObject*)widget);
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NO)",
- py_widget, cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(N)",
- py_widget);
-
- if (retobj == NULL) {
- PyErr_Print();
- }
-
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
-}
-static PyObject *
-pygtk_container_for_common(PyGObject *self, PyObject *args, unsigned for_index)
-{
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify cunote;
- static struct {
- char *parse_arg;
- void (*for_func)(GtkContainer *container, GtkCallback callback,
- gpointer callback_data);
- } table[] = {
- { "O|O:GtkContainer.foreach", gtk_container_foreach },
- { "O|O:GtkContainer.forall", gtk_container_forall }
- };
-
- if (for_index >= countof(table)) {
- PyErr_SetString(PyExc_TypeError, "for_index > 2");
- return NULL;
- }
-
- if (!PyArg_ParseTuple(args, table[for_index].parse_arg,
- &pyfunc, &pyarg))
- return NULL;
-
- cunote.func = pyfunc;
- cunote.data = pyarg;
- table[for_index].for_func(GTK_CONTAINER(self->obj),
- pygtk_container_for_common_marshal,
- &cunote);
- Py_INCREF(Py_None);
- return Py_None;
-}
-static PyObject *
-_wrap_gtk_container_foreach(PyGObject *self, PyObject *args)
-{
- return pygtk_container_for_common(self, args, PYGTK_CONTAINER_FOREACH);
-}
-%%
-override gtk_container_forall
-static PyObject *
-_wrap_gtk_container_forall(PyGObject *self, PyObject *args)
-{
- return pygtk_container_for_common(self, args, PYGTK_CONTAINER_FORALL);
-}
-%%
-override gtk_container_class_list_child_properties kwargs
-static PyObject *
-_wrap_gtk_container_class_list_child_properties (PyObject *self, PyObject *args,
- PyObject*kwargs)
-{
- static char *kwlist[] = { "klass", NULL };
- GParamSpec **specs;
- PyObject *py_itype, *list;
- GType itype;
- GObjectClass *class;
- guint nprops;
- guint i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:gtk.container_class_list_child_properties", kwlist,
- &py_itype))
- return NULL;
-
- if ((itype = pyg_type_from_object(py_itype)) == 0)
- return NULL;
-
- if (!g_type_is_a(itype, G_TYPE_OBJECT)) {
- PyErr_SetString(PyExc_TypeError, "type must be derived from GObject");
- return NULL;
- }
-
- class = g_type_class_ref(itype);
- if (!class) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not get a reference to type class");
- return NULL;
- }
-
- specs = gtk_container_class_list_child_properties(class, &nprops);
- list = PyTuple_New(nprops);
- if (list == NULL) {
- g_free(specs);
- g_type_class_unref(class);
- return NULL;
- }
-
- for (i = 0; i < nprops; i++) {
- PyTuple_SetItem(list, i, pyg_param_spec_new(specs[i]));
- }
-
- g_free(specs);
- g_type_class_unref(class);
-
- return list;
-}
-%%
-define GtkContainer.list_child_properties noargs classmethod
-static PyObject *
-_wrap_gtk_container_list_child_properties (PyObject *self, PyObject *args,
- PyObject*kwargs)
-{
- GParamSpec **specs;
- PyObject *list;
- GType itype;
- GObjectClass *class;
- guint nprops;
- guint i;
-
- if ((itype = pyg_type_from_object(self)) == 0)
- return NULL;
-
- class = g_type_class_ref(itype);
- if (!class) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not get a reference to type class");
- return NULL;
- }
-
- specs = gtk_container_class_list_child_properties(class, &nprops);
- list = PyList_New(nprops);
- if (list == NULL) {
- g_free(specs);
- g_type_class_unref(class);
- return NULL;
- }
-
- for (i = 0; i < nprops; i++) {
- PyList_SetItem(list, i, pyg_param_spec_new(specs[i]));
- }
-
- g_free(specs);
- g_type_class_unref(class);
-
- return list;
-}
-
-%%
-override gtk_container_class_install_child_property kwargs
-static PyObject *
-_wrap_gtk_container_class_install_child_property (PyObject *self,
- PyObject *args,
- PyObject* kwargs)
-{
- static char *kwlist[] = { "klass", "property_id", "pspec", NULL };
- PyObject *py_itype, *property;
- GType itype;
- GtkContainerClass *class;
- guint property_id;
- GParamSpec *pspec;
-
- if (PyErr_Warn(PyExc_DeprecationWarning, "use the gtk.Container.install_child_property classmethod"))
- return NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OiO:container_class_install_child_property",
- kwlist,
- &py_itype, &property_id, &property))
- return NULL;
-
-
- if ((itype = pyg_type_from_object(py_itype)) == 0)
- return NULL;
-
- if (!g_type_is_a(itype, GTK_TYPE_CONTAINER)) {
- PyErr_SetString(PyExc_TypeError, "type must be derived from GtkContainer");
- return NULL;
- }
-
- class = g_type_class_ref(itype);
- if (!class) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not get a reference to type class");
- return NULL;
- }
-
- pspec = pyg_param_spec_from_object(property);
- if(!pspec) {
- g_type_class_unref(class);
- return NULL;
- }
-
- if (gtk_container_class_find_child_property(G_OBJECT_CLASS(class), pspec->name)) {
- PyErr_Format(PyExc_TypeError,
- "there is already a '%s' property installed", pspec->name);
- g_type_class_unref(class);
- return NULL;
- }
-
- gtk_container_class_install_child_property(class, property_id, pspec);
-
- g_type_class_unref(class);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-define GtkContainer.install_child_property kwargs classmethod
-static PyObject *
-_wrap_gtk_container_install_child_property (PyObject *self,
- PyObject *args,
- PyObject* kwargs)
-{
- static char *kwlist[] = { "property_id", "pspec", NULL };
- PyObject *property;
- GType itype;
- GtkContainerClass *class;
- guint property_id;
- GParamSpec *pspec;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iO:container_class_install_child_property",
- kwlist,
- &property_id, &property))
- return NULL;
-
-
- if ((itype = pyg_type_from_object(self)) == 0)
- return NULL;
-
- class = g_type_class_ref(itype);
- if (!class) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not get a reference to type class");
- return NULL;
- }
-
- pspec = pyg_param_spec_from_object(property);
- if(!pspec) {
- g_type_class_unref(class);
- return NULL;
- }
-
- if (gtk_container_class_find_child_property(G_OBJECT_CLASS(class), pspec->name)) {
- PyErr_Format(PyExc_TypeError,
- "there is already a '%s' property installed", pspec->name);
- g_type_class_unref(class);
- return NULL;
- }
-
- gtk_container_class_install_child_property(class, property_id, pspec);
-
- g_type_class_unref(class);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-override-slot GtkContainer.tp_iter
-
-typedef struct {
- PyObject_HEAD
- GList *list;
-} PyGContainerIter;
-
-static void
-pyg_container_iter_dealloc(PyGContainerIter *self)
-{
- g_list_free(self->list);
- PyObject_Del((PyObject*) self);
-}
-
-static PyObject*
-pygobject_container_iter_next(PyGContainerIter *iter)
-{
- PyObject *child;
-
- if (!iter->list) {
- PyErr_SetNone(PyExc_StopIteration);
- return NULL;
- }
-
- child = pygobject_new((GObject*)iter->list->data);
- iter->list = g_list_next(iter->list);
- return child;
-}
-
-static PyTypeObject PyGContainerIter_Type = {
- PyObject_HEAD_INIT(NULL)
- 0, /* ob_size */
- "gobject.GContainerIter", /* tp_name */
- sizeof(PyGContainerIter), /* tp_basicsize */
- 0, /* tp_itemsize */
- (destructor)pyg_container_iter_dealloc, /* tp_dealloc */
- 0, /* tp_print */
- 0, /* tp_getattr */
- 0, /* tp_setattr */
- 0, /* tp_compare */
- 0, /* tp_repr */
- 0, /* tp_as_number */
- 0, /* tp_as_sequence */
- 0, /* tp_as_mapping */
- 0, /* tp_hash */
- 0, /* tp_call */
- 0, /* tp_str */
- 0, /* tp_getattro */
- 0, /* tp_setattro */
- 0, /* tp_as_buffer */
- Py_TPFLAGS_DEFAULT, /* tp_flags */
- "GtkContainer child iterator", /* tp_doc */
- 0, /* tp_traverse */
- 0, /* tp_clear */
- 0, /* tp_richcompare */
- 0, /* tp_weaklistoffset */
- 0, /* tp_iter */
- (iternextfunc)pygobject_container_iter_next, /* tp_iternext */
-};
-
-static PyObject*
-_wrap_gtk_container_tp_iter(PyGObject *self)
-{
- PyGContainerIter *iter;
- iter = PyObject_NEW(PyGContainerIter, &PyGContainerIter_Type);
- iter->list = gtk_container_get_children(GTK_CONTAINER(self->obj));
- return (PyObject *) iter;
-}
-%%
-override-slot GtkContainer.tp_as_sequence
-static Py_ssize_t
-_wrap_gtk_container_sq_length(PyGObject *self)
-{
- return g_list_length(gtk_container_get_children(GTK_CONTAINER(self->obj)));
-}
-
-static PySequenceMethods _wrap_gtk_container_tp_as_sequence = {
- (lenfunc)_wrap_gtk_container_sq_length,
- 0,
- 0,
- 0,
- 0,
- 0,
- 0,
-};
-%%
-override-slot GtkContainer.tp_as_number
-static int
-_wrap_gtk_container_nb_nonzero(PyGObject *self)
-{
- return 1;
-}
-
-static PyNumberMethods _wrap_gtk_container_tp_as_number = {
- (binaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (ternaryfunc)0,
- (unaryfunc)0,
- (unaryfunc)0,
- (unaryfunc)0,
- (inquiry)_wrap_gtk_container_nb_nonzero
-};
-
-%%
-override GtkContainer__proxy_do_forall
-
-typedef struct {
- GtkCallback func;
- gpointer func_data;
-} PyGtkContainerDataFuncData;
-
-
-static PyObject *
-_wrap_GtkContainerDataFunc(PyObject *self, PyObject *args)
-{
- PyObject *py_widget;
- PyObject *py_data;
- PyGtkContainerDataFuncData *data;
-
- if (!PyArg_ParseTuple(args, "O!O!",
- &PyGtkWidget_Type, &py_widget,
- &PyCObject_Type, &py_data))
- return NULL;
-
- data = PyCObject_AsVoidPtr(py_data);
- data->func(GTK_WIDGET(pygobject_get(py_widget)), data->func_data);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static void
-_wrap_GtkContainer__proxy_do_forall (GtkContainer *container,
- gboolean include_internals,
- GtkCallback callback,
- gpointer callback_data)
-{
- PyGILState_STATE state;
- PyObject *self, *py_func, *py_func_data;
- PyMethodDef pyfunc_def = { "GtkContainer.do_forall callback",
- (PyCFunction)_wrap_GtkContainerDataFunc,
- METH_VARARGS|METH_KEYWORDS };
- PyGtkContainerDataFuncData *data;
-
- state = pyg_gil_state_ensure();
-
- self = pygobject_new((GObject *)container);
- py_func = PyCFunction_NewEx(&pyfunc_def, NULL, NULL);
-
- data = g_new(PyGtkContainerDataFuncData, 1);
- data->func = callback;
- data->func_data = callback_data;
- PyObject_Repr(self);
- PyObject_Repr(py_func);
- py_func_data = PyCObject_FromVoidPtr(data, NULL);
- if (!PyObject_CallMethod(self, "do_forall", "ONN",
- include_internals ? Py_True : Py_False, py_func,
- py_func_data))
- PyErr_Print();
-
- pyg_gil_state_release(state);
-}
-%%
-override GtkContainer__proxy_do_set_child_property
-static void
-_wrap_GtkContainer__proxy_do_set_child_property (GtkContainer *container,
- GtkWidget *child,
- guint property_id,
- const GValue *value,
- GParamSpec *pspec)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret;
-
- state = pyg_gil_state_ensure();
- self = pygobject_new((GObject *) container);
-
- py_ret = PyObject_CallMethod(self, "do_set_child_property", "NNNN",
- pygobject_new((GObject *) child),
- PyLong_FromUnsignedLong(property_id),
- pyg_value_as_pyobject(value, FALSE),
- pyg_param_spec_new(pspec));
- if (!py_ret) {
- PyErr_Print();
- Py_DECREF(self);
- pyg_gil_state_release(state);
- return;
- }
- Py_DECREF(self);
- if (py_ret != Py_None)
- PyErr_Warn(PyExc_Warning, "do_set_child_property must return None");
- Py_DECREF(py_ret);
-
- pyg_gil_state_release(state);
-}
-
-%%
-override GtkContainer__proxy_do_get_child_property
-static void
-_wrap_GtkContainer__proxy_do_get_child_property (GtkContainer *container,
- GtkWidget *child,
- guint property_id,
- GValue *value,
- GParamSpec *pspec)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret;
-
- state = pyg_gil_state_ensure();
-
- self = pygobject_new((GObject*)container);
- py_ret = PyObject_CallMethod(self, "do_get_child_property", "NNN",
- pygobject_new((GObject *) child),
- PyLong_FromUnsignedLong(property_id),
- pyg_param_spec_new(pspec));
- if (!py_ret) {
- PyErr_Print();
- Py_DECREF(self);
- pyg_gil_state_release(state);
- return;
- }
- Py_DECREF(self);
- pyg_value_from_pyobject(value, py_ret);
- Py_DECREF(py_ret);
-
- pyg_gil_state_release(state);
-}
-
-%%
-override GtkContainer__do_set_child_property kwargs
-static PyObject *
-_wrap_GtkContainer__do_set_child_property(PyObject *cls, PyObject *args, PyObject *kwargs)
-{
- gpointer klass;
- static char *kwlist[] = { "self", "child", "property_id", "value", "pspec", NULL };
- PyGObject *self, *child;
- PyObject *py_property_id = NULL, *py_value, *py_pspec;
- guint property_id = 0;
- GValue value = {0, };
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,"O!O!OOO!:GtkContainer.set_child_property",
- kwlist, &PyGtkContainer_Type, &self,
- &PyGtkWidget_Type, &child,
- &py_property_id,
- &py_value,
- &PyGParamSpec_Type, &py_pspec))
- return NULL;
-
- if (pyg_value_from_pyobject(&value, py_value)) {
- PyErr_SetString(PyExc_TypeError, "unable to convert value");
- return NULL;
- }
-
- if (py_property_id) {
- if (PyLong_Check(py_property_id))
- property_id = PyLong_AsUnsignedLong(py_property_id);
- else if (PyInt_Check(py_property_id))
- property_id = PyInt_AsLong(py_property_id);
- else
- PyErr_SetString(PyExc_TypeError, "Parameter 'property_id' must be an int or a long");
- if (PyErr_Occurred())
- return NULL;
- }
- klass = g_type_class_ref(pyg_type_from_object(cls));
- if (GTK_CONTAINER_CLASS(klass)->set_child_property)
- GTK_CONTAINER_CLASS(klass)->set_child_property(GTK_CONTAINER(self->obj), GTK_WIDGET(child->obj), property_id,
- &value, ((PyGParamSpec *)py_pspec)->pspec);
- else {
- PyErr_SetString(PyExc_NotImplementedError, "virtual method GtkContainer.set_child_property not implemented");
- g_type_class_unref(klass);
- return NULL;
- }
- g_type_class_unref(klass);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-override GtkContainer__do_get_child_property kwargs
-static PyObject *
-_wrap_GtkContainer__do_get_child_property(PyObject *cls, PyObject *args, PyObject *kwargs)
-{
- gpointer klass;
- static char *kwlist[] = { "self", "child", "property_id", "pspec", NULL };
- PyGObject *self, *child;
- PyObject *py_property_id = NULL;
- guint property_id = 0;
- GValue value = {0, };
- PyObject *py_value, *py_pspec;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,"O!O!OO!:GtkContainer.get_child_property", kwlist,
- &PyGtkContainer_Type, &self,
- &PyGtkWidget_Type, &child,
- &py_property_id,
- &PyGParamSpec_Type, &py_pspec))
- return NULL;
- if (py_property_id) {
- if (PyLong_Check(py_property_id))
- property_id = PyLong_AsUnsignedLong(py_property_id);
- else if (PyInt_Check(py_property_id))
- property_id = PyInt_AsLong(py_property_id);
- else
- PyErr_SetString(PyExc_TypeError, "Parameter 'property_id' must be an int or a long");
- if (PyErr_Occurred())
- return NULL;
- }
- klass = g_type_class_ref(pyg_type_from_object(cls));
- if (GTK_CONTAINER_CLASS(klass)->get_child_property)
- GTK_CONTAINER_CLASS(klass)->get_child_property(GTK_CONTAINER(self->obj), GTK_WIDGET(child->obj), property_id,
- &value, ((PyGParamSpec *)py_pspec)->pspec);
- else {
- PyErr_SetString(PyExc_NotImplementedError, "virtual method GtkContainer.get_child_property not implemented");
- g_type_class_unref(klass);
- return NULL;
- }
- g_type_class_unref(klass);
-
- py_value = pyg_value_as_pyobject(&value, TRUE);
- g_value_unset(&value);
- return py_value;
-}
diff --git a/gtk/gtkctree.override b/gtk/gtkctree.override
deleted file mode 100644
index 9b962161..00000000
--- a/gtk/gtkctree.override
+++ /dev/null
@@ -1,527 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gtkctree.override: overrides for the gtk.CTree widget.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-ignore gtk_ctree_construct
- gtk_ctree_insert_gnode
- gtk_ctree_export_to_gnode
- gtk_ctree_post_recursive
- gtk_ctree_post_recursive_to_depth
- gtk_ctree_pre_recursive
- gtk_ctree_pre_recursive_to_depth
- gtk_ctree_find_node_ptr
-%%
-ignore gtk_ctree_new
-%%
-override-attr GtkCTree.selection
-static PyObject *
-_wrap_gtk_ctree__get_selection(PyGObject *self, void *closure)
-{
- GList *selection;
- GtkCTreeNode *node;
- PyObject *ret, *py_node;
- if ((ret = PyList_New(0)) == NULL)
- return NULL;
-
- for (selection = GTK_CLIST(self->obj)->selection; selection != NULL;
- selection = selection->next) {
- node = selection->data;
- if ((py_node = pyg_pointer_new(GTK_TYPE_CTREE_NODE, node)) == NULL) {
- Py_DECREF(ret);
- return NULL;
- }
- PyList_Append(ret, py_node);
- Py_DECREF(py_node);
- }
-
- return ret;
-}
-%%
-override gtk_ctree_new_with_titles kwargs
-static int
-_wrap_gtk_ctree_new_with_titles(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "columns", "tree_column", "titles", NULL };
- int columns = 1, tree_column = 0;
- PyObject *py_titles = NULL;
-
- if (PyErr_Warn(PyExc_DeprecationWarning, "use gtk.TreeView") < 0)
- return -1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|iiO:GtkCTree.__init__",
- kwlist, &columns, &tree_column,
- &py_titles))
- return -1;
- if (py_titles) {
- gchar **titles;
- gint i;
-
- if (!PySequence_Check(py_titles)) {
- PyErr_SetString(PyExc_TypeError, "titles must be a sequence");
- return -1;
- }
- if (PySequence_Length(py_titles) < columns) {
- PyErr_SetString(PyExc_TypeError, "titles too short");
- return -1;
- }
- titles = g_new(gchar *, columns);
- for (i = 0; i < columns; i++) {
- PyObject *item = PySequence_GetItem(py_titles, i);
-
- Py_DECREF(item);
- if (!PyString_Check(item) && !PyUnicode_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "sequence item not a string or unicode object");
- g_free(titles);
- return -1;
- }
- titles[i] = PyString_AsString(item);
- }
- self->obj = (GObject *)gtk_ctree_new_with_titles(columns,
- tree_column, titles);
- g_free(titles);
- } else
- self->obj = (GObject *)gtk_ctree_new(columns, tree_column);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,"could not create GtkCTree object");
- return -1;
- }
- pygobject_register_wrapper((PyObject *)self);
- return 0;
-}
-%%
-override gtk_ctree_base_nodes
-static PyObject*
-_wrap_gtk_ctree_base_nodes(PyGObject *self, PyObject *args)
-{
- PyObject *ret;
- GtkCTreeNode *node;
-
- /* the first row is always a base node */
- node = GTK_CTREE_NODE(GTK_CLIST(self->obj)->row_list);
- if ((ret = PyList_New(0)) == NULL)
- return NULL;
- while (node) {
- PyObject *obj = pyg_pointer_new(GTK_TYPE_CTREE_NODE, node);
- if (obj == NULL) {
- Py_DECREF(ret);
- return NULL;
- }
- PyList_Append(ret, obj);
- Py_DECREF(obj);
- node = GTK_CTREE_ROW(node)->sibling;
- }
- return ret;
-}
-%%
-override gtk_ctree_insert_node kwargs
-static PyObject *
-_wrap_gtk_ctree_insert_node(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "parent", "sibling", "text", "spacing",
- "pixmap_closed", "mask_closed", "pixmap_opened",
- "mask_opened", "is_leaf", "expanded", NULL };
- PyObject *py_text;
- PyGPointer *py_parent, *py_sibling;
- PyGObject *py_pixmap_closed = (PyGObject *) Py_None;
- PyGObject *py_mask_closed = (PyGObject *) Py_None;
- PyGObject *py_pixmap_opened = (PyGObject *) Py_None;
- PyGObject *py_mask_opened = (PyGObject *) Py_None;
- GtkCTreeNode *parent = NULL, *sibling = NULL, *ret;
- gchar **text = NULL;
- GdkPixmap *pixmap_closed = NULL, *pixmap_opened = NULL;
- GdkBitmap *mask_closed = NULL, *mask_opened = NULL;
- gint spacing = 5, is_leaf = 1, expanded = 0, columns, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOO|iOOOOii:GtkCTree.insert_node",
- kwlist,
- &py_parent, &py_sibling, &py_text,
- &spacing, &py_pixmap_closed,
- &py_mask_closed, &py_pixmap_opened,
- &py_mask_opened, &is_leaf, &expanded))
- return NULL;
- if (pyg_pointer_check(py_parent, GTK_TYPE_CTREE_NODE))
- parent = pyg_pointer_get(py_parent, GtkCTreeNode);
- else if ((PyObject *)py_parent != Py_None) {
- PyErr_SetString(PyExc_TypeError, "parent must be a CTreeNode or None");
- return NULL;
- }
- if (pyg_pointer_check(py_sibling, GTK_TYPE_CTREE_NODE))
- sibling = pyg_pointer_get(py_sibling, GtkCTreeNode);
- else if ((PyObject *)py_sibling != Py_None) {
- PyErr_SetString(PyExc_TypeError,"sibling must be a CTreeNode or None");
- return NULL;
- }
- if (pygobject_check(py_pixmap_closed, &PyGdkPixmap_Type))
- pixmap_closed = GDK_PIXMAP(py_pixmap_closed->obj);
- else if ((PyObject *)py_pixmap_closed != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "pixmap_closed must be a GdkPixmap or None");
- return NULL;
- }
- if (pygobject_check(py_mask_closed, &PyGdkPixmap_Type))
- mask_closed = GDK_PIXMAP(py_mask_closed->obj);
- else if ((PyObject *)py_mask_closed != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "mask_closed must be a GdkBitmap or None");
- return NULL;
- }
- if (pygobject_check(py_pixmap_opened, &PyGdkPixmap_Type))
- pixmap_opened = GDK_PIXMAP(py_pixmap_opened->obj);
- else if ((PyObject *)py_pixmap_opened != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "pixmap_opened must be a GdkPixmap or None");
- return NULL;
- }
- if (pygobject_check(py_mask_opened, &PyGdkPixmap_Type))
- mask_opened = GDK_PIXMAP(py_mask_opened->obj);
- else if ((PyObject *)py_mask_opened != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "mask_opened must be a GdkBitmap or None");
- return NULL;
- }
- if (!PySequence_Check(py_text)) {
- PyErr_SetString(PyExc_TypeError, "text must be a sequence");
- return NULL;
- }
- columns = GTK_CLIST(self->obj)->columns;
- if (PySequence_Length(py_text) < columns) {
- PyErr_SetString(PyExc_TypeError, "text is too short");
- return NULL;
- }
- text = g_new(gchar *, columns);
- for (i = 0; i < columns; i++) {
- PyObject *item = PySequence_GetItem(py_text, i);
-
- Py_DECREF(item);
- if (!PyString_Check(item) && !PyUnicode_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "sequence item not a string or unicode object");
- g_free(text);
- return NULL;
- }
- text[i] = PyString_AsString(item);
- }
- ret = gtk_ctree_insert_node(GTK_CTREE(self->obj), parent, sibling, text,
- spacing, pixmap_closed, mask_closed,
- pixmap_opened, mask_opened, is_leaf, expanded);
- g_free(text);
- return pyg_pointer_new(GTK_TYPE_CTREE_NODE, ret);
-}
-%%
-ignore gtk_ctree_find_by_row_data_custom gtk_ctree_find_all_by_row_data_custom
-%%
-override gtk_ctree_find_by_row_data kwargs
-static PyObject *
-_wrap_gtk_ctree_find_by_row_data(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "node", "data", NULL };
- PyObject *data;
- PyGPointer *py_node;
- GtkCTreeNode *node = NULL, *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO:GtkCTree.find_by_row_data", kwlist,
- &py_node, &data))
- return NULL;
- if (pyg_pointer_check(py_node, GTK_TYPE_CTREE_NODE))
- node = pyg_pointer_get(py_node, GtkCTreeNode);
- else if ((PyObject *)py_node != Py_None) {
- PyErr_SetString(PyExc_TypeError, "node must be a CTreeNode or None");
- return NULL;
- }
- ret = gtk_ctree_find_by_row_data(GTK_CTREE(self->obj), node, data);
- if (ret)
- return pyg_pointer_new(GTK_TYPE_CTREE_NODE, ret);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_ctree_find_all_by_row_data kwargs
-static PyObject *
-_wrap_gtk_ctree_find_all_by_row_data(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "node", "data", NULL };
- PyGPointer *py_node;
- PyObject *data, *list;
- GtkCTreeNode *node = NULL;
- GList *ret, *tmp;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO:GtkCTree.find_all_by_row_data",kwlist,
- &py_node, &data))
- return NULL;
- if (pyg_pointer_check(py_node, GTK_TYPE_CTREE_NODE))
- node = pyg_pointer_get(py_node, GtkCTreeNode);
- else if ((PyObject *)py_node != Py_None) {
- PyErr_SetString(PyExc_TypeError, "node must be a CTreeNode or None");
- return NULL;
- }
- ret = gtk_ctree_find_all_by_row_data(GTK_CTREE(self->obj), node, data);
- if ((list = PyList_New(0)) == NULL)
- return NULL;
- for (tmp = ret; tmp != NULL; tmp = tmp->next) {
- PyObject *item = pyg_pointer_new(GTK_TYPE_CTREE_NODE,
- (GtkCTreeNode *) tmp->data);
- if (item == NULL) {
- Py_DECREF(list);
- return NULL;
- }
- PyList_Append(list, item);
- Py_DECREF(item);
- }
- g_list_free(ret);
- return list;
-}
-%%
-override gtk_ctree_node_get_text kwargs
-static PyObject *
-_wrap_gtk_ctree_node_get_text(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "node", "column", NULL };
- PyGPointer *node;
- int column;
- char *text = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oi:GtkCTree.node_get_text", kwlist,
- &node, &column))
- return NULL;
-
- if (!pyg_pointer_check(node, GTK_TYPE_CTREE_NODE)) {
- PyErr_SetString(PyExc_TypeError, "node must be a CTreeNode");
- return NULL;
- }
-
- if (!gtk_ctree_node_get_text(GTK_CTREE(self->obj),
- pyg_pointer_get(node, GtkCTreeNode), column,
- &text)) {
- PyErr_SetString(PyExc_ValueError, "can't get text value");
- return NULL;
- }
- return PyString_FromString(text);
-}
-%%
-override gtk_ctree_node_get_pixmap kwargs
-static PyObject *
-_wrap_gtk_ctree_node_get_pixmap(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "node", "column", NULL };
- PyObject *node;
- int column;
- GdkPixmap *pixmap = NULL;
- GdkBitmap *mask = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oi:GtkCTree.node_get_pixmap", kwlist,
- &node, &column))
- return NULL;
-
- if (!pyg_pointer_check(node, GTK_TYPE_CTREE_NODE)) {
- PyErr_SetString(PyExc_TypeError, "node must be a CTreeNode");
- return NULL;
- }
-
- if (!gtk_ctree_node_get_pixmap(GTK_CTREE(self->obj),
- pyg_pointer_get(node, GtkCTreeNode), column,
- &pixmap, &mask)) {
- PyErr_SetString(PyExc_ValueError, "can't get pixmap value");
- return NULL;
- }
- return Py_BuildValue("(NN)", pygobject_new((GObject *)pixmap),
- pygobject_new((GObject *)mask));
-}
-%%
-override gtk_ctree_node_get_pixtext kwargs
-static PyObject *
-_wrap_gtk_ctree_node_get_pixtext(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "node", "column", NULL };
- PyObject *node;
- int column;
- gchar *text = NULL;
- guint8 spacing;
- GdkPixmap *pixmap = NULL;
- GdkBitmap *mask = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oi:GtkCTree.node_get_pixtext", kwlist,
- &node, &column))
- return NULL;
-
- if (!pyg_pointer_check(node, GTK_TYPE_CTREE_NODE)) {
- PyErr_SetString(PyExc_TypeError, "node must be a CTreeNode");
- return NULL;
- }
-
- if (!gtk_ctree_node_get_pixtext(GTK_CTREE(self->obj),
- pyg_pointer_get(node, GtkCTreeNode), column,
- &text, &spacing, &pixmap, &mask)) {
- PyErr_SetString(PyExc_ValueError, "can't get pixtext value");
- return NULL;
- }
- return Py_BuildValue("(siNN)", text, (int)spacing,
- pygobject_new((GObject *)pixmap),
- pygobject_new((GObject *)mask));
-}
-%%
-override gtk_ctree_get_node_info kwargs
-static PyObject *
-_wrap_gtk_ctree_get_node_info(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "node", NULL };
- PyObject *node;
- gchar *text;
- guint8 spacing;
- GdkPixmap *pixmap_closed, *pixmap_opened;
- GdkBitmap *mask_closed, *mask_opened;
- gboolean is_leaf, expanded;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GtkCTree.get_node_info",
- kwlist, &node))
- return NULL;
-
- if (!pyg_pointer_check(node, GTK_TYPE_CTREE_NODE)) {
- PyErr_SetString(PyExc_TypeError, "node must be a CTreeNode");
- return NULL;
- }
-
- if (!gtk_ctree_get_node_info(GTK_CTREE(self->obj), pyg_pointer_get(node, GtkCTreeNode),
- &text, &spacing, &pixmap_closed, &mask_closed,
- &pixmap_opened, &mask_opened,
- &is_leaf, &expanded)) {
- PyErr_SetString(PyExc_ValueError, "can't get node info");
- return NULL;
- }
- return Py_BuildValue("(siNNNNii)", text, (int)spacing,
- pygobject_new((GObject *)pixmap_opened),
- pygobject_new((GObject *)mask_closed),
- pygobject_new((GObject *)pixmap_opened),
- pygobject_new((GObject *)mask_opened),
- (int)is_leaf, (int)expanded);
-}
-%%
-ignore gtk_ctree_node_set_row_data_full
-%%
-override gtk_ctree_node_set_row_data kwargs
-static PyObject *
-_wrap_gtk_ctree_node_set_row_data(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "node", "data", NULL };
- PyObject *node, *data;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO:GtkCTree.node_set_row_data", kwlist,
- &node, &data))
- return NULL;
-
- if (!pyg_pointer_check(node, GTK_TYPE_CTREE_NODE)) {
- PyErr_SetString(PyExc_TypeError, "node must be a CTreeNode");
- return NULL;
- }
-
- Py_INCREF(data);
- gtk_ctree_node_set_row_data_full(GTK_CTREE(self->obj),
- pyg_pointer_get(node, GtkCTreeNode), data,
- (GDestroyNotify)pyg_destroy_notify);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_ctree_node_get_row_data kwargs
-static PyObject *
-_wrap_gtk_ctree_node_get_row_data(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "node", NULL };
- PyObject *node, *data;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkCTree.node_get_row_data", kwlist,
- &node))
- return NULL;
-
- if (!pyg_pointer_check(node, GTK_TYPE_CTREE_NODE)) {
- PyErr_SetString(PyExc_TypeError, "node must be a CTreeNode");
- return NULL;
- }
-
- data = gtk_ctree_node_get_row_data(GTK_CTREE(self->obj),
- pyg_pointer_get(node, GtkCTreeNode));
- if (!data) data = Py_None;
- Py_INCREF(data);
- return data;
-}
-%%
-override-slot GtkCTreeNode.tp_getattr
-static PyObject *
-_wrap_gtk_ctree_node_tp_getattr(PyGPointer *self, char *attr)
-{
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ssssss]", "children", "expanded", "is_leaf",
- "level", "parent", "sibling");
- if (!strcmp(attr, "parent")) {
- GtkCTreeNode *node = GTK_CTREE_ROW(pyg_pointer_get(self, GtkCTreeNode))->parent;
- if (node)
- return pyg_pointer_new(GTK_TYPE_CTREE_NODE, node);
- Py_INCREF(Py_None);
- return Py_None;
- } else if (!strcmp(attr, "sibling")) {
- GtkCTreeNode *node = GTK_CTREE_ROW(pyg_pointer_get(self, GtkCTreeNode))->sibling;
- if (node)
- return pyg_pointer_new(GTK_TYPE_CTREE_NODE, node);
- Py_INCREF(Py_None);
- return Py_None;
- } else if (!strcmp(attr, "children")) {
- GtkCTreeNode *node = GTK_CTREE_ROW(pyg_pointer_get(self, GtkCTreeNode))->children;
- PyObject *ret = PyList_New(0);
- if (ret == NULL)
- return NULL;
- while (node) {
- PyObject *py_node = pyg_pointer_new(GTK_TYPE_CTREE_NODE, node);
- if (py_node == NULL) {
- Py_DECREF(ret);
- return NULL;
- }
- PyList_Append(ret, py_node);
- Py_DECREF(py_node);
- node = GTK_CTREE_ROW(node)->sibling;
- }
- return ret;
- } else if (!strcmp(attr, "level"))
- return PyInt_FromLong(GTK_CTREE_ROW(pyg_pointer_get(self, GtkCTreeNode))->level);
- else if (!strcmp(attr, "is_leaf"))
- return PyInt_FromLong(GTK_CTREE_ROW(pyg_pointer_get(self, GtkCTreeNode))->is_leaf);
- else if (!strcmp(attr, "expanded"))
- return PyInt_FromLong(GTK_CTREE_ROW(pyg_pointer_get(self, GtkCTreeNode))->expanded);
- PyErr_SetString(PyExc_AttributeError, attr);
- return NULL;
-}
diff --git a/gtk/gtkiconview.override b/gtk/gtkiconview.override
deleted file mode 100644
index f309ca3e..00000000
--- a/gtk/gtkiconview.override
+++ /dev/null
@@ -1,336 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 2005 John Finlay, Johan Dahlin
- *
- * gtkiconview.override: overrides for the gtk.IconView object.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-ignore
- gtk_icon_view_new_with_model
-%%
-new-constructor GTK_TYPE_ICON_VIEW
-%%
-override gtk_icon_view_new kwargs
-static int
-_wrap_gtk_icon_view_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "model", NULL };
- PyGObject *pymodel = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O:GtkIconView.__init__",
- kwlist, &pymodel))
- return -1;
- if (pymodel == NULL || (PyObject *)pymodel == Py_None)
- pygobject_construct(self, NULL);
- else if (pygobject_check(pymodel, &PyGtkTreeModel_Type))
- pygobject_construct(self, "model", GTK_TREE_MODEL(pymodel->obj), NULL);
- else {
- PyErr_SetString(PyExc_TypeError,
- "model must be a gtk.TreeModel or None");
- return -1;
- }
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkIconView object");
- return -1;
- }
- return 0;
-}
-%%
-override gtk_icon_view_get_selected_items noargs
-static PyObject *
-_wrap_gtk_icon_view_get_selected_items(PyGObject *self)
-{
- GList *paths;
- PyObject *py_paths;
- int plen, i;
-
- paths = gtk_icon_view_get_selected_items(GTK_ICON_VIEW(self->obj));
-
- plen = g_list_length(paths);
- if ((py_paths = PyList_New(plen)) == NULL)
- return NULL;
- for (i = 0; i < plen; i++) {
- GtkTreePath *path = (GtkTreePath *)g_list_nth_data(paths, i);
- PyObject *pypath = pygtk_tree_path_to_pyobject(path);
- PyList_SET_ITEM(py_paths, i, pypath);
- }
- g_list_foreach(paths, (GFunc)gtk_tree_path_free, NULL);
- g_list_free(paths);
- return py_paths;
-}
-%%
-override gtk_icon_view_selected_foreach kwargs
-static void
-pygtk_icon_view_selected_foreach_cb(GtkIconView *iconview,
- GtkTreePath *path,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyObject *callback, *args, *ret;
-
- state = pyg_gil_state_ensure();
- callback = PyTuple_GetItem((PyObject *)user_data, 0);
- args = Py_BuildValue("(NNO)",
- pygobject_new((GObject *)iconview),
- pygtk_tree_path_to_pyobject(path),
- PyTuple_GetItem((PyObject *)user_data, 1));
- ret = PyObject_CallObject(callback, args);
- if (!ret)
- PyErr_Print();
- Py_XDECREF(ret);
- Py_DECREF(args);
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_icon_view_selected_foreach(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", NULL };
- PyObject *func, *data, *py_data = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkIconView.foreach",
- kwlist, &func, &py_data)) {
- return NULL;
- }
- if (!PyCallable_Check(func)) {
- PyErr_SetString(PyExc_TypeError, "func must be callable");
- return NULL;
- }
-
- data = Py_BuildValue("(OO)", func, py_data);
-
- gtk_icon_view_selected_foreach(GTK_ICON_VIEW(self->obj),
- pygtk_icon_view_selected_foreach_cb,
- (gpointer)data);
- Py_DECREF(data);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_view_get_item_at_pos kwargs
-static PyObject *
-_wrap_gtk_icon_view_get_item_at_pos(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "x", "y", NULL };
- GtkTreePath *path;
- GtkCellRenderer *renderer;
- gint x,y;
- gboolean r;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "ii:GtkIconView.get_item_at_pos",
- kwlist,
- &x, &y))
- return NULL;
-
-
- r = gtk_icon_view_get_item_at_pos(GTK_ICON_VIEW(self->obj), x, y, &path, &renderer);
- if (r && path) {
- PyObject *py_path = pygtk_tree_path_to_pyobject(path);
- gtk_tree_path_free(path);
- return Py_BuildValue("(NN)", py_path, pygobject_new((GObject*)renderer));
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_view_get_visible_range noargs
-static PyObject *
-_wrap_gtk_icon_view_get_visible_range(PyGObject *self)
-{
- GtkTreePath *start_path, *end_path;
- gboolean r;
-
- r = gtk_icon_view_get_visible_range(GTK_ICON_VIEW(self->obj),
- &start_path, &end_path);
- if (r) {
- PyObject *py_start_path = pygtk_tree_path_to_pyobject(start_path);
- PyObject *py_end_path = pygtk_tree_path_to_pyobject(end_path);
- gtk_tree_path_free(start_path);
- gtk_tree_path_free(end_path);
- return Py_BuildValue("(NN)", py_start_path, py_end_path);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_view_get_cursor noargs
-static PyObject *
-_wrap_gtk_icon_view_get_cursor(PyGObject *self)
-{
- GtkTreePath *path;
- GtkCellRenderer *renderer;
- gboolean r;
-
- r = gtk_icon_view_get_cursor(GTK_ICON_VIEW(self->obj), &path, &renderer);
- if (r && path) {
- PyObject *py_path = pygtk_tree_path_to_pyobject(path);
- gtk_tree_path_free(path);
- return Py_BuildValue("(NN)", py_path, pygobject_new((GObject*)renderer));
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_view_get_drag_dest_item noargs
-static PyObject *
-_wrap_gtk_icon_view_get_drag_dest_item(PyGObject *self)
-{
- GtkTreePath *path;
- GtkIconViewDropPosition pos;
-
- gtk_icon_view_get_drag_dest_item(GTK_ICON_VIEW(self->obj), &path, &pos);
- if (path) {
- PyObject *py_path = pygtk_tree_path_to_pyobject(path);
- gtk_tree_path_free(path);
- return Py_BuildValue("(NN)", py_path,
- pyg_enum_from_gtype(GTK_TYPE_ICON_VIEW_DROP_POSITION, (gint)pos));
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_view_get_dest_item_at_pos kwargs
-static PyObject *
-_wrap_gtk_icon_view_get_dest_item_at_pos(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "x", "y", NULL };
- GtkTreePath *path;
- GtkIconViewDropPosition pos;
- gint drag_x, drag_y;
- gboolean r;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "ii:GtkIconView.get_dest_item_at_pos",
- kwlist, &drag_x, &drag_y))
- return NULL;
-
-
- r = gtk_icon_view_get_dest_item_at_pos(GTK_ICON_VIEW(self->obj),
- drag_x, drag_y, &path, &pos);
- if (r && path) {
- PyObject *py_path = pygtk_tree_path_to_pyobject(path);
- gtk_tree_path_free(path);
- return Py_BuildValue("(NN)", py_path,
- pyg_enum_from_gtype(GTK_TYPE_ICON_VIEW_DROP_POSITION, (gint) pos));
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_view_enable_model_drag_source kwargs
-static PyObject *
-_wrap_gtk_icon_view_enable_model_drag_source(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "start_button_mask", "targets", "actions", NULL };
- PyObject *py_sbmask, *py_targets, *py_actions;
- GdkModifierType sbmask;
- GtkTargetEntry *targets;
- GdkDragAction actions;
- gint n_targets, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOO:GtkIconView.enable_model_drag_source",
- kwlist,
- &py_sbmask, &py_targets, &py_actions))
- return NULL;
- if (pyg_flags_get_value(GDK_TYPE_MODIFIER_TYPE,
- py_sbmask, (gint *)&sbmask))
- return NULL;
- if (pyg_flags_get_value(GDK_TYPE_DRAG_ACTION,
- py_actions, (gint *)&actions))
- return NULL;
- if (!PySequence_Check(py_targets)) {
- PyErr_SetString(PyExc_TypeError, "targets must be a sequence");
- return NULL;
- }
- n_targets = PySequence_Length(py_targets);
- targets = g_new(GtkTargetEntry, n_targets);
- for (i = 0; i < n_targets; i++) {
- PyObject *item = PySequence_GetItem(py_targets, i);
- Py_DECREF(item);
- if (!PyArg_ParseTuple(item, "zii", &targets[i].target,
- &targets[i].flags, &targets[i].info)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "list items should be of form (string,int,int)");
- g_free(targets);
- return NULL;
- }
- }
- gtk_icon_view_enable_model_drag_source(GTK_ICON_VIEW(self->obj),
- sbmask, targets, n_targets, actions);
- g_free(targets);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_icon_view_enable_model_drag_dest kwargs
-static PyObject *
-_wrap_gtk_icon_view_enable_model_drag_dest(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "targets", "actions", NULL };
- PyObject *py_targets, *py_actions;
- GtkTargetEntry *targets;
- GdkDragAction actions;
- gint n_targets, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO:GtkIconView.enable_model_drag_dest",
- kwlist,
- &py_targets, &py_actions))
- return NULL;
- if (pyg_flags_get_value(GDK_TYPE_DRAG_ACTION,
- py_actions, (gint *)&actions))
- return NULL;
- if (!PySequence_Check(py_targets)) {
- PyErr_SetString(PyExc_TypeError, "targets must be a sequence");
- return NULL;
- }
- n_targets = PySequence_Length(py_targets);
- targets = g_new(GtkTargetEntry, n_targets);
- for (i = 0; i < n_targets; i++) {
- PyObject *item = PySequence_GetItem(py_targets, i);
- Py_DECREF(item);
- if (!PyArg_ParseTuple(item, "zii", &targets[i].target,
- &targets[i].flags, &targets[i].info)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "list items should be of form (string,int,int)");
- g_free(targets);
- return NULL;
- }
- }
- gtk_icon_view_enable_model_drag_dest(GTK_ICON_VIEW(self->obj),
- targets, n_targets, actions);
- g_free(targets);
- Py_INCREF(Py_None);
- return Py_None;
-}
diff --git a/gtk/gtkmodule.c b/gtk/gtkmodule.c
deleted file mode 100644
index be8ee6c9..00000000
--- a/gtk/gtkmodule.c
+++ /dev/null
@@ -1,249 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gtkmodule.c: module wrapping the GTK library
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
-/* include this first, before NO_IMPORT_PYGOBJECT is defined */
-#include <pygobject.h>
-#include "pygtk-private.h"
-#include <pyerrors.h>
-
-#ifdef HAVE_PYCAIRO
-# include <pycairo.h>
-Pycairo_CAPI_t *Pycairo_CAPI;
-#endif
-
-void _pygtk_register_boxed_types(PyObject *moddict);
-void pygtk_register_classes(PyObject *d);
-void pygdk_register_classes(PyObject *d);
-void pygtk_add_constants(PyObject *module, const gchar *strip_prefix);
-void pygdk_add_constants(PyObject *module, const gchar *strip_prefix);
-
-extern PyMethodDef pygtk_functions[];
-extern PyMethodDef pygdk_functions[];
-
-static PyObject *PyGtkDeprecationWarning;
-PyObject *PyGtkWarning;
-
-static struct _PyGtk_FunctionStruct functions = {
- VERSION,
-
- &PyGdkAtom_Type, PyGdkAtom_New,
- pygdk_rectangle_from_pyobject,
- pygtk_tree_path_to_pyobject,
- pygtk_tree_path_from_pyobject,
-};
-
-static void
-sink_gtkwindow(GObject *object)
-{
- if (object->ref_count == 1
- && GTK_WINDOW(object)->has_user_ref_count) {
- g_object_ref(object);
- }
-}
-
-static void
-sink_gtkinvisible(GObject *object)
-{
- if (object->ref_count == 1
- && GTK_INVISIBLE(object)->has_user_ref_count) {
- g_object_ref(object);
- }
-}
-
-static void
-sink_gtkobject(GObject *object)
-{
- if (GTK_OBJECT_FLOATING(object)) {
- g_object_ref(object);
- gtk_object_sink(GTK_OBJECT(object));
- }
-}
-
-static void
-pygtk_add_stock_items(PyObject *d)
-{
- GSList *stock_ids, *cur;
- char buf[128];
-
- stock_ids = gtk_stock_list_ids();
- strcpy(buf, "STOCK_");
- for (cur = stock_ids; cur; cur = stock_ids) {
- char *ctmp;
- PyObject *obj;
- int i;
-
- ctmp = cur->data;
- if(strncmp(ctmp, "gtk-", 4)) {
- g_free(cur->data);
- stock_ids = cur->next;
- g_slist_free_1(cur);
- continue;
- }
- ctmp += 4;
-
- strcpy(buf + sizeof("STOCK"), ctmp);
- ctmp = buf + sizeof("STOCK");
- for (i = 0; ctmp[i]; i++) {
- if (ctmp[i] == '-')
- ctmp[i] = '_';
- else if (ctmp[i] >= 'a' && ctmp[i] <= 'z')
- ctmp[i] -= 'a'-'A';
- }
-
- obj = PyString_FromString(cur->data);
- PyDict_SetItemString(d, buf, obj);
- Py_DECREF(obj);
- g_free(cur->data);
- stock_ids = cur->next;
- g_slist_free_1(cur);
- }
-
-}
-
-static void
-pygdk_add_extra_constants(PyObject *m)
-{
- gchar * aname;
-
- PyModule_AddObject(m, "PARENT_RELATIVE",
- PyLong_FromLong(GDK_PARENT_RELATIVE));
- /* Add predefined atoms */
-#define add_atom(name) { aname = gdk_atom_name((GDK_##name)); \
-PyModule_AddObject(m, #name, PyString_FromString(aname)); \
-g_free(aname); }
-
- add_atom(SELECTION_PRIMARY);
- add_atom(SELECTION_SECONDARY);
- add_atom(SELECTION_CLIPBOARD);
- add_atom(TARGET_BITMAP);
- add_atom(TARGET_COLORMAP);
- add_atom(TARGET_DRAWABLE);
- add_atom(TARGET_PIXMAP);
- add_atom(TARGET_STRING);
- add_atom(SELECTION_TYPE_ATOM);
- add_atom(SELECTION_TYPE_BITMAP);
- add_atom(SELECTION_TYPE_COLORMAP);
- add_atom(SELECTION_TYPE_DRAWABLE);
- add_atom(SELECTION_TYPE_INTEGER);
- add_atom(SELECTION_TYPE_PIXMAP);
- add_atom(SELECTION_TYPE_WINDOW);
- add_atom(SELECTION_TYPE_STRING);
-#undef add_atom
-}
-
-static void
-pygtk_add_extra_constants(PyObject *m)
-{
-#if GTK_CHECK_VERSION(2, 9, 3)
- PyModule_AddObject(m, "PAPER_NAME_A3",
- PyString_FromString(GTK_PAPER_NAME_A3));
- PyModule_AddObject(m, "PAPER_NAME_A4",
- PyString_FromString(GTK_PAPER_NAME_A4));
- PyModule_AddObject(m, "PAPER_NAME_A5",
- PyString_FromString(GTK_PAPER_NAME_A5));
- PyModule_AddObject(m, "PAPER_NAME_B5",
- PyString_FromString(GTK_PAPER_NAME_B5));
- PyModule_AddObject(m, "PAPER_NAME_LETTER",
- PyString_FromString(GTK_PAPER_NAME_LETTER));
- PyModule_AddObject(m, "PAPER_NAME_EXECUTIVE",
- PyString_FromString(GTK_PAPER_NAME_EXECUTIVE));
- PyModule_AddObject(m, "PAPER_NAME_LEGAL",
- PyString_FromString(GTK_PAPER_NAME_LEGAL));
-#endif
-}
-
-static gboolean
-init_pycairo(void)
-{
-#ifdef HAVE_PYCAIRO
- Pycairo_IMPORT;
- if (Pycairo_CAPI == NULL)
- return FALSE;
-#endif
- return TRUE;
-}
-
-DL_EXPORT(void)
-init_gtk(void)
-{
- PyObject *m, *d, *tuple, *o;
-
- /* initialise pygobject */
- init_pygobject_check(2, 12, 0);
- g_assert(pygobject_register_class != NULL);
-
- /* initialise pycairo */
- if (!init_pycairo())
- return;
-
- /* initialise pygtk */
- gtk_type_init(0);
-
- pygobject_register_sinkfunc(GTK_TYPE_WINDOW, sink_gtkwindow);
- pygobject_register_sinkfunc(GTK_TYPE_INVISIBLE, sink_gtkinvisible);
- pygobject_register_sinkfunc(GTK_TYPE_OBJECT, sink_gtkobject);
-
- m = Py_InitModule("gtk._gtk", pygtk_functions);
- d = PyModule_GetDict(m);
-
- /* gtk+ version */
- tuple = Py_BuildValue("(iii)", gtk_major_version, gtk_minor_version,
- gtk_micro_version);
- PyDict_SetItemString(d, "gtk_version", tuple);
- Py_DECREF(tuple);
-
- /* pygtk version */
- tuple = Py_BuildValue("(iii)", PYGTK_MAJOR_VERSION, PYGTK_MINOR_VERSION,
- PYGTK_MICRO_VERSION);
- PyDict_SetItemString(d, "pygtk_version", tuple);
- Py_DECREF(tuple);
-
- _pygtk_register_boxed_types(d);
- pygtk_register_classes(d);
- pygtk_add_constants(m, "GTK_");
- pygtk_add_extra_constants(m);
- pygtk_add_stock_items(d);
-
- /* extension API */
- PyDict_SetItemString(d, "_PyGtk_API",
- o=PyCObject_FromVoidPtr(&functions, NULL));
- Py_DECREF(o);
-
- PyGtkDeprecationWarning = PyErr_NewException("gtk.GtkDeprecationWarning",
- PyExc_DeprecationWarning, NULL);
- PyDict_SetItemString(d, "DeprecationWarning", PyGtkDeprecationWarning);
-
- PyGtkWarning = PyErr_NewException("gtk.GtkWarning", PyExc_Warning, NULL);
- PyDict_SetItemString(d, "Warning", PyGtkWarning);
-
- /* namespace all the gdk stuff in gtk.gdk ... */
- m = Py_InitModule("gtk.gdk", pygdk_functions);
- d = PyModule_GetDict(m);
-
- pygdk_register_classes(d);
- pygdk_add_constants(m, "GDK_");
- pygdk_add_extra_constants(m);
-}
diff --git a/gtk/gtkobject-support.c b/gtk/gtkobject-support.c
deleted file mode 100644
index 1871ef15..00000000
--- a/gtk/gtkobject-support.c
+++ /dev/null
@@ -1,138 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2006 James Henstridge
- *
- * gtkobject-support.c: some helper routines for the GTK module.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-
-/* this module provides some of the base functionality of the GtkObject
- * wrapper system */
-
-#include "pygtk-private.h"
-
-/* ------------------- object support */
-
-void
-pygtk_custom_destroy_notify(gpointer user_data)
-{
- PyGtkCustomNotify *cunote = user_data;
- PyGILState_STATE state;
-
- g_return_if_fail(user_data);
- state = pyg_gil_state_ensure();
- Py_XDECREF(cunote->func);
- Py_XDECREF(cunote->data);
- pyg_gil_state_release(state);
-
- g_free(cunote);
-}
-
-GdkAtom*
-pygdk_atom_vector_from_sequence(PyObject *py_targets, gint *n_targets)
-{
- gint i;
- GdkAtom *targets;
-
- if (!(py_targets = PySequence_Fast(py_targets,
- "targets must be a sequence")))
- return NULL;
-
- *n_targets = PySequence_Fast_GET_SIZE(py_targets);
- targets = g_new(GdkAtom, *n_targets);
- for (i = 0; i < *n_targets; i++) {
- PyObject *trgt = PySequence_Fast_GET_ITEM(py_targets, i);
- targets[i] = pygdk_atom_from_pyobject(trgt);
- if (PyErr_Occurred()) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "each 'targets' item must be a GdkAtom or string");
- g_free(targets);
- Py_DECREF(py_targets);
- return NULL;
- }
- }
- Py_DECREF(py_targets);
- return targets;
-}
-
-GtkTargetList *
-pygtk_target_list_from_sequence(PyObject *py_targets)
-{
- gint n_targets, i;
- GtkTargetEntry *targets;
- GtkTargetList *target_list;
-
- if (!(py_targets = PySequence_Fast(py_targets,
- "target list must be a sequence")))
- return NULL;
- n_targets = PySequence_Fast_GET_SIZE(py_targets);
- targets = g_new(GtkTargetEntry, n_targets);
- for (i = 0; i < n_targets; i++) {
- PyObject *item = PySequence_Fast_GET_ITEM(py_targets, i);
- if (!PyArg_ParseTuple(item, "sii", &targets[i].target,
- &targets[i].flags, &targets[i].info)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "target list items should be of form (string,int,int)");
- g_free(targets);
- Py_DECREF(py_targets);
- return NULL;
- }
- }
- target_list = gtk_target_list_new(targets, n_targets);
- g_free(targets);
- Py_DECREF(py_targets);
- return target_list;
-}
-
-PyObject *
-pygtk_target_list_to_list(GtkTargetList *targets)
-{
- GList *tmp;
- PyObject *list = PyList_New(0);
-
- for (tmp = targets->list; tmp != NULL; tmp = tmp->next) {
- GtkTargetPair *pair = tmp->data;
- PyObject *item;
- gchar * name = gdk_atom_name(pair->target);
- item = Py_BuildValue("(Nii)",
- PyString_FromString(name),
- pair->flags, pair->info);
- PyList_Append(list, item);
- g_free(name);
- Py_DECREF(item);
- }
- return list;
-}
-
-void
-pygtk_boxed_unref_shared(PyObject *boxed)
-{
- PyGBoxed *pyboxed;
- g_return_if_fail(boxed != NULL && PyObject_TypeCheck(boxed, &PyGBoxed_Type));
- pyboxed = (PyGBoxed *) boxed;
- if (pyboxed->ob_refcnt != 1) {
- if (!pyboxed->free_on_dealloc) {
- pyboxed->boxed = g_boxed_copy(pyboxed->gtype,
- pyboxed->boxed);
- pyboxed->free_on_dealloc = TRUE;
- }
- }
- Py_DECREF(boxed);
-}
-
diff --git a/gtk/gtkstyle.override b/gtk/gtkstyle.override
deleted file mode 100644
index 40dd2f1f..00000000
--- a/gtk/gtkstyle.override
+++ /dev/null
@@ -1,277 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gtkstyle.override: overrides for the gtk.Style object.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-override-attr GtkStyle.fg
-static PyObject *
-_wrap_gtk_style__get_fg(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_COLOUR_ARRAY, style->fg);
-}
-%%
-override-attr GtkStyle.bg
-static PyObject *
-_wrap_gtk_style__get_bg(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_COLOUR_ARRAY, style->bg);
-}
-%%
-override-attr GtkStyle.light
-static PyObject *
-_wrap_gtk_style__get_light(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_COLOUR_ARRAY, style->light);
-}
-%%
-override-attr GtkStyle.dark
-static PyObject *
-_wrap_gtk_style__get_dark(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_COLOUR_ARRAY, style->dark);
-}
-%%
-override-attr GtkStyle.mid
-static PyObject *
-_wrap_gtk_style__get_mid(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_COLOUR_ARRAY, style->mid);
-}
-%%
-override-attr GtkStyle.text
-static PyObject *
-_wrap_gtk_style__get_text(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_COLOUR_ARRAY, style->text);
-}
-%%
-override-attr GtkStyle.base
-static PyObject *
-_wrap_gtk_style__get_base(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_COLOUR_ARRAY, style->base);
-}
-%%
-override-attr GtkStyle.text_aa
-static PyObject *
-_wrap_gtk_style__get_text_aa(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_COLOUR_ARRAY, style->text_aa);
-}
-%%
-override-attr GtkStyle.white
-static PyObject *
-_wrap_gtk_style__get_white(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return pyg_boxed_new(GDK_TYPE_COLOR, &style->white, TRUE, TRUE);
-}
-static int
-_wrap_gtk_style__set_white(PyGObject *self, PyObject *value, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- if (!pyg_boxed_check(value, GDK_TYPE_COLOR)) {
- PyErr_SetString(PyExc_TypeError, "can only assign a GdkColor");
- return -1;
- }
- style->white = *pyg_boxed_get(value, GdkColor);
- return 0;
-}
-%%
-override-attr GtkStyle.black
-static PyObject *
-_wrap_gtk_style__get_black(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return pyg_boxed_new(GDK_TYPE_COLOR, &style->black, TRUE, TRUE);
-}
-static int
-_wrap_gtk_style__set_black(PyGObject *self, PyObject *value, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- if (!pyg_boxed_check(value, GDK_TYPE_COLOR)) {
- PyErr_SetString(PyExc_TypeError, "can only assign a GdkColor");
- return -1;
- }
- style->black = *pyg_boxed_get(value, GdkColor);
- return 0;
-}
-%%
-override-attr GtkStyle.fg_gc
-static PyObject *
-_wrap_gtk_style__get_fg_gc(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_GC_ARRAY, style->fg_gc);
-}
-%%
-override-attr GtkStyle.bg_gc
-static PyObject *
-_wrap_gtk_style__get_bg_gc(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_GC_ARRAY, style->bg_gc);
-}
-%%
-override-attr GtkStyle.light_gc
-static PyObject *
-_wrap_gtk_style__get_light_gc(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_GC_ARRAY, style->light_gc);
-}
-%%
-override-attr GtkStyle.dark_gc
-static PyObject *
-_wrap_gtk_style__get_dark_gc(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_GC_ARRAY, style->dark_gc);
-}
-%%
-override-attr GtkStyle.mid_gc
-static PyObject *
-_wrap_gtk_style__get_mid_gc(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_GC_ARRAY, style->mid_gc);
-}
-%%
-override-attr GtkStyle.text_gc
-static PyObject *
-_wrap_gtk_style__get_text_gc(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_GC_ARRAY, style->text_gc);
-}
-%%
-override-attr GtkStyle.base_gc
-static PyObject *
-_wrap_gtk_style__get_base_gc(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_GC_ARRAY, style->base_gc);
-}
-%%
-override-attr GtkStyle.text_aa_gc
-static PyObject *
-_wrap_gtk_style__get_text_aa_gc(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_GC_ARRAY, style->text_aa_gc);
-}
-%%
-override-attr GtkStyle.white_gc
-static PyObject *
-_wrap_gtk_style__get_white_gc(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return pygobject_new((GObject *)style->white_gc);
-}
-static int
-_wrap_gtk_style__set_white_gc(PyGObject *self, PyObject *value, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- if (!pygobject_check(value, &PyGdkGC_Type)) {
- PyErr_SetString(PyExc_TypeError, "can only assign a GdkGC");
- return -1;
- }
- style->white_gc = GDK_GC(pygobject_get(value));
- return 0;
-}
-%%
-override-attr GtkStyle.black_gc
-static PyObject *
-_wrap_gtk_style__get_black_gc(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return pygobject_new((GObject *)style->black_gc);
-}
-static int
-_wrap_gtk_style__set_black_gc(PyGObject *self, PyObject *value, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- if (!pygobject_check(value, &PyGdkGC_Type)) {
- PyErr_SetString(PyExc_TypeError, "can only assign a GdkGC");
- return -1;
- }
- style->black_gc = GDK_GC(pygobject_get(value));
- return 0;
-}
-%%
-override-attr GtkStyle.bg_pixmap
-static PyObject *
-_wrap_gtk_style__get_bg_pixmap(PyGObject *self, void *closure)
-{
- GtkStyle *style = GTK_STYLE(self->obj);
-
- return _pygtk_style_helper_new(style, STYLE_PIXMAP_ARRAY, style->bg_pixmap);
-}
-%%
-override gtk_style_lookup_color kwargs
-static PyObject *
-_wrap_gtk_style_lookup_color(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "color_name", NULL };
- char *color_name;
- GdkColor color;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s:GtkStyle.lookup_color",
- kwlist, &color_name))
- return NULL;
-
- if (gtk_style_lookup_color(GTK_STYLE(self->obj), color_name, &color))
- return pyg_boxed_new(GDK_TYPE_COLOR, &color, TRUE, TRUE);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
diff --git a/gtk/gtktextview.override b/gtk/gtktextview.override
deleted file mode 100644
index 5cded4c2..00000000
--- a/gtk/gtktextview.override
+++ /dev/null
@@ -1,1600 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2006 James Henstridge
- *
- * gtktextview.override: overrides for the gtk.TextView object.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-ignore-glob
- gtk_text_view_new
-
-%%
-override gtk_text_view_get_visible_rect noargs
-static PyObject *
-_wrap_gtk_text_view_get_visible_rect(PyGObject *self)
-{
- GdkRectangle visible_rect;
-
- gtk_text_view_get_visible_rect(GTK_TEXT_VIEW(self->obj), &visible_rect);
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &visible_rect, TRUE, TRUE);
-}
-%%
-override gtk_text_view_buffer_to_window_coords kwargs
-static PyObject *
-_wrap_gtk_text_view_buffer_to_window_coords(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "win", "buffer_x", "buffer_y", NULL };
- GtkTextWindowType win;
- gint buffer_x, buffer_y, window_x = 0, window_y = 0;
- PyObject *py_win;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oii:GtkTextView.buffer_to_window_coords",
- kwlist, &py_win, &buffer_x, &buffer_y))
- return NULL;
- if (pyg_enum_get_value(GTK_TYPE_TEXT_WINDOW_TYPE, py_win, (gint *)&win))
- return NULL;
- gtk_text_view_buffer_to_window_coords(GTK_TEXT_VIEW(self->obj), win,
- buffer_x, buffer_y,
- &window_x, &window_y);
- return Py_BuildValue("(ii)", window_x, window_y);
-}
-%%
-override gtk_text_view_window_to_buffer_coords kwargs
-static PyObject *
-_wrap_gtk_text_view_window_to_buffer_coords(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "win", "window_x", "window_y", NULL };
- GtkTextWindowType win;
- gint window_x, window_y, buffer_x = 0, buffer_y = 0;
- PyObject *py_win;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oii:GtkTextView.window_to_buffer_coords",
- kwlist, &py_win, &window_x, &window_y))
- return NULL;
- if (pyg_enum_get_value(GTK_TYPE_TEXT_WINDOW_TYPE, py_win, (gint *)&win))
- return NULL;
- gtk_text_view_window_to_buffer_coords(GTK_TEXT_VIEW(self->obj), win,
- window_x, window_y,
- &buffer_x, &buffer_y);
- return Py_BuildValue("(ii)", buffer_x, buffer_y);
-}
-%%
-override gtk_text_view_get_iter_location kwargs
-static PyObject *
-_wrap_gtk_text_view_get_iter_location(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "iter", NULL };
- PyObject *py_iter;
- GdkRectangle location;
- GtkTextIter *iter = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkTextView.get_iter_location",
- kwlist, &py_iter))
- return NULL;
- if (pyg_boxed_check(py_iter, GTK_TYPE_TEXT_ITER))
- iter = pyg_boxed_get(py_iter, GtkTextIter);
- else {
- PyErr_SetString(PyExc_TypeError, "iter should be a GtkTextIter");
- return NULL;
- }
- gtk_text_view_get_iter_location(GTK_TEXT_VIEW(self->obj), iter, &location);
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &location, TRUE, TRUE);
-}
-%%
-override gtk_text_view_get_line_at_y kwargs
-static PyObject *
-_wrap_gtk_text_view_get_line_at_y(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "y", NULL };
- GtkTextIter iter;
- gint y, line_top;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i:GtkTextView.get_line_at_y",
- kwlist, &y))
- return NULL;
- gtk_text_view_get_line_at_y(GTK_TEXT_VIEW(self->obj),
- &iter, y, &line_top);
- return Py_BuildValue("(Ni)",
- pyg_boxed_new(GTK_TYPE_TEXT_ITER, &iter, TRUE, TRUE),
- line_top);
-}
-%%
-override gtk_text_view_get_line_yrange kwargs
-static PyObject *
-_wrap_gtk_text_view_get_line_yrange(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "iter", NULL };
- GtkTextIter *iter = NULL;
- gint y = -1, height = -1;
- PyObject *py_iter;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkTextView.get_line_yrange",
- kwlist, &py_iter))
- return NULL;
- if (pyg_boxed_check(py_iter, GTK_TYPE_TEXT_ITER))
- iter = pyg_boxed_get(py_iter, GtkTextIter);
- else {
- PyErr_SetString(PyExc_TypeError, "iter should be a GtkTextIter");
- return NULL;
- }
- gtk_text_view_get_line_yrange(GTK_TEXT_VIEW(self->obj),
- iter, &y, &height);
- return Py_BuildValue("(ii)", y, height);
-}
-%%
-override gtk_text_view_get_iter_at_location kwargs
-static PyObject *
-_wrap_gtk_text_view_get_iter_at_location(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "x", "y", NULL };
- GtkTextIter iter;
- gint x, y;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "ii:GtkTextView.get_iter_at_location",
- kwlist, &x, &y))
- return NULL;
- gtk_text_view_get_iter_at_location(GTK_TEXT_VIEW(self->obj),
- &iter, x, y);
- return pyg_boxed_new(GTK_TYPE_TEXT_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_text_view_set_border_window_size kwargs
-static PyObject *
-_wrap_gtk_text_view_set_border_window_size(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "type", "size", NULL };
- PyObject *py_type = NULL;
- int size;
- GtkTextWindowType type;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oi:GtkTextView.set_border_window_size",
- kwlist, &py_type, &size))
- return NULL;
-
- if (size < 0) {
- PyErr_SetString(PyExc_ValueError, "size must be >= 0");
- return NULL;
- }
-
- if (pyg_enum_get_value(GTK_TYPE_TEXT_WINDOW_TYPE, py_type, (gint *)&type))
- return NULL;
-
- switch (type)
- {
- case GTK_TEXT_WINDOW_LEFT:
- case GTK_TEXT_WINDOW_RIGHT:
- case GTK_TEXT_WINDOW_TOP:
- case GTK_TEXT_WINDOW_BOTTOM:
- gtk_text_view_set_border_window_size(GTK_TEXT_VIEW(self->obj), type,
- size);
- break;
- default:
- PyErr_SetString(PyExc_ValueError, "type must be one of: "
- "gtk.TEXT_WINDOW_LEFT, gtk.TEXT_WINDOW_RIGHT, "
- "gtk.TEXT_WINDOW_TOP or gtk.TEXT_WINDOW_BOTTOM");
- return NULL;
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-ignore gtk_text_iter_free
-%%
-override gtk_text_iter_copy noargs
-static PyObject *
-_wrap_gtk_text_iter_copy(PyGBoxed *self)
-{
- return pyg_boxed_new(GTK_TYPE_TEXT_ITER, pyg_boxed_get(self, GtkTextIter),
- TRUE, TRUE);
-}
-%%
-override gtk_text_iter_get_slice kwargs
-static PyObject *
-_wrap_gtk_text_iter_get_slice(PyGBoxed *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "end", NULL };
- PyGBoxed *end;
- gchar *text;
- PyObject *pytext;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GtkTextIter.get_slice",
- kwlist, &end))
- return NULL;
- if (!pyg_boxed_check(end, GTK_TYPE_TEXT_ITER)) {
- PyErr_SetString(PyExc_TypeError, "end must be a GtkTextIter");
- return NULL;
- }
- text = gtk_text_iter_get_slice(pyg_boxed_get(self, GtkTextIter),
- pyg_boxed_get(end, GtkTextIter));
- pytext = PyUnicode_DecodeUTF8(text, strlen(text), "strict");
- g_free(text);
- return pytext;
-}
-%%
-override gtk_text_iter_get_text kwargs
-static PyObject *
-_wrap_gtk_text_iter_get_text(PyGBoxed *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "end", NULL };
- PyGBoxed *end;
- gchar *text;
- PyObject *pytext;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GtkTextIter.get_text",
- kwlist, &end))
- return NULL;
- if (!pyg_boxed_check(end, GTK_TYPE_TEXT_ITER)) {
- PyErr_SetString(PyExc_TypeError, "end must be a GtkTextIter");
- return NULL;
- }
- text = gtk_text_iter_get_text(pyg_boxed_get(self, GtkTextIter),
- pyg_boxed_get(end, GtkTextIter));
- pytext = PyUnicode_DecodeUTF8(text, strlen(text), "strict");
- g_free(text);
- return pytext;
-}
-%%
-override gtk_text_iter_get_visible_slice kwargs
-static PyObject *
-_wrap_gtk_text_iter_get_visible_slice(PyGBoxed *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "end", NULL };
- PyGBoxed *end;
- gchar *text;
- PyObject *pytext;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkTextIter.get_visible_slice", kwlist,
- &end))
- return NULL;
- if (!pyg_boxed_check(end, GTK_TYPE_TEXT_ITER)) {
- PyErr_SetString(PyExc_TypeError, "end must be a GtkTextIter");
- return NULL;
- }
- text = gtk_text_iter_get_visible_slice(pyg_boxed_get(self, GtkTextIter),
- pyg_boxed_get(end, GtkTextIter));
- pytext = PyUnicode_DecodeUTF8(text, strlen(text), "strict");
- g_free(text);
- return pytext;
-}
-%%
-override gtk_text_iter_get_visible_text kwargs
-static PyObject *
-_wrap_gtk_text_iter_get_visible_text(PyGBoxed *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "end", NULL };
- PyGBoxed *end;
- gchar *text;
- PyObject *pytext;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkTextIter.get_visible_text", kwlist,
- &end))
- return NULL;
- if (!pyg_boxed_check(end, GTK_TYPE_TEXT_ITER)) {
- PyErr_SetString(PyExc_TypeError, "end must be a GtkTextIter");
- return NULL;
- }
- text = gtk_text_iter_get_visible_text(pyg_boxed_get(self, GtkTextIter),
- pyg_boxed_get(end, GtkTextIter));
- pytext = PyUnicode_DecodeUTF8(text, strlen(text), "strict");
- g_free(text);
- return pytext;
-}
-%%
-override gtk_text_iter_get_marks noargs
-static PyObject *
-_wrap_gtk_text_iter_get_marks(PyGBoxed *self)
-{
- GSList *ret, *tmp;
- PyObject *pyret;
-
- ret = gtk_text_iter_get_marks(pyg_boxed_get(self, GtkTextIter));
- pyret = PyList_New(0);
- for (tmp = ret; tmp != NULL; tmp = tmp->next) {
- PyObject *mark = pygobject_new((GObject *)tmp->data);
- PyList_Append(pyret, mark);
- Py_DECREF(mark);
- }
- g_slist_free(ret);
- return pyret;
-}
-%%
-override gtk_text_iter_get_toggled_tags kwargs
-static PyObject *
-_wrap_gtk_text_iter_get_toggled_tags(PyGBoxed *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "toggled_on", NULL };
- GSList *ret, *tmp;
- int toggled_on;
- PyObject *pyret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i:GtkTextIter.get_toggled_tags", kwlist,
- &toggled_on))
- return NULL;
- ret = gtk_text_iter_get_toggled_tags(pyg_boxed_get(self, GtkTextIter),
- toggled_on);
- pyret = PyList_New(0);
- for (tmp = ret; tmp != NULL; tmp = tmp->next) {
- PyObject *tag = pygobject_new((GObject *)tmp->data);
- PyList_Append(pyret, tag);
- Py_DECREF(tag);
- }
- g_slist_free(ret);
- return pyret;
-}
-%%
-override gtk_text_iter_get_tags noargs
-static PyObject *
-_wrap_gtk_text_iter_get_tags(PyGBoxed *self)
-{
- GSList *ret, *tmp;
- PyObject *pyret;
-
- ret = gtk_text_iter_get_tags(pyg_boxed_get(self, GtkTextIter));
- pyret = PyList_New(0);
- for (tmp = ret; tmp != NULL; tmp = tmp->next) {
- PyObject *tag = pygobject_new((GObject *)tmp->data);
- PyList_Append(pyret, tag);
- Py_DECREF(tag);
- }
- g_slist_free(ret);
- return pyret;
-}
-%%
-override gtk_text_iter_forward_search kwargs
-static PyObject *
-_wrap_gtk_text_iter_forward_search(PyGBoxed *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "str", "flags", "limit", NULL };
- gchar *str;
- PyObject *py_flags, *py_limit = Py_None;
- GtkTextIter match_start, match_end, *limit = NULL;
- GtkTextSearchFlags flags;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "sO|O:GtkTextIter.forward_search",
- kwlist, &str, &py_flags, &py_limit))
- return NULL;
- if (pyg_boxed_check(py_limit, GTK_TYPE_TEXT_ITER))
- limit = pyg_boxed_get(py_limit, GtkTextIter);
- else if (py_limit != Py_None) {
- PyErr_SetString(PyExc_TypeError,"limit must be a GtkTextIter or None");
- return NULL;
- }
- if (pyg_flags_get_value(GTK_TYPE_TEXT_SEARCH_FLAGS, py_flags,
- (gint *)&flags))
- return NULL;
- if (gtk_text_iter_forward_search(pyg_boxed_get(self, GtkTextIter), str,
- flags, &match_start, &match_end, limit))
- return Py_BuildValue("(NN)",
- pyg_boxed_new(GTK_TYPE_TEXT_ITER, &match_start,
- TRUE, TRUE),
- pyg_boxed_new(GTK_TYPE_TEXT_ITER, &match_end,
- TRUE, TRUE));
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_text_iter_backward_search kwargs
-static PyObject *
-_wrap_gtk_text_iter_backward_search(PyGBoxed *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "str", "flags", "limit", NULL };
- gchar *str;
- PyObject *py_flags, *py_limit = Py_None;
- GtkTextIter match_start, match_end, *limit = NULL;
- GtkTextSearchFlags flags;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "sO|O:GtkTextIter.backward_search",
- kwlist, &str, &py_flags, &py_limit))
- return NULL;
- if (pyg_boxed_check(py_limit, GTK_TYPE_TEXT_ITER))
- limit = pyg_boxed_get(py_limit, GtkTextIter);
- else if (py_limit != Py_None) {
- PyErr_SetString(PyExc_TypeError,"limit must be a GtkTextIter or None");
- return NULL;
- }
- if (pyg_flags_get_value(GTK_TYPE_TEXT_SEARCH_FLAGS, py_flags,
- (gint *)&flags))
- return NULL;
- if (gtk_text_iter_backward_search(pyg_boxed_get(self, GtkTextIter), str,
- flags, &match_start, &match_end, limit))
- return Py_BuildValue("(NN)",
- pyg_boxed_new(GTK_TYPE_TEXT_ITER, &match_start,
- TRUE, TRUE),
- pyg_boxed_new(GTK_TYPE_TEXT_ITER, &match_end,
- TRUE, TRUE));
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_text_buffer_insert_with_tags
-static PyObject *
-_wrap_gtk_text_buffer_insert_with_tags(PyGObject *self, PyObject *args)
-{
- PyObject *first, *py_iter;
- gint len, i, start_offset;
- Py_ssize_t text_len;
- gchar *text;
- GtkTextIter *iter, start;
-
- len = PyTuple_Size(args);
- if (len < 2) {
- PyErr_SetString(PyExc_TypeError,
- "GtkTextBuffer.insert_with_tags requires at least 2 arguments");
- return NULL;
- }
- first = PySequence_GetSlice(args, 0, 2);
- if (!PyArg_ParseTuple(first, "Os#:GtkTextBuffer.insert_with_tags",
- &py_iter, &text, &text_len)) {
- Py_DECREF(first);
- return NULL;
- }
- Py_DECREF(first);
- if (!pyg_boxed_check(py_iter, GTK_TYPE_TEXT_ITER)) {
- PyErr_SetString(PyExc_TypeError, "iter must be a GtkTextIter");
- return NULL;
- }
- iter = pyg_boxed_get(py_iter, GtkTextIter);
-
- /* check types */
- for (i = 2; i < len; i++) {
- PyObject *item = PyTuple_GetItem(args, i);
-
- if (!pygobject_check(item, &PyGtkTextTag_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "additional argument must be a GtkTextTag");
- return NULL;
- }
- }
-
- start_offset = gtk_text_iter_get_offset(iter);
- gtk_text_buffer_insert(GTK_TEXT_BUFFER(self->obj), iter, text, text_len);
- gtk_text_buffer_get_iter_at_offset(GTK_TEXT_BUFFER(self->obj),
- &start, start_offset);
-
- for (i = 2; i < len; i++) {
- PyObject *item = PyTuple_GetItem(args, i);
- GtkTextTag *tag = GTK_TEXT_TAG(pygobject_get(item));
-
- gtk_text_buffer_apply_tag(GTK_TEXT_BUFFER(self->obj), tag,&start,iter);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_text_buffer_insert_with_tags_by_name
-static PyObject *
-_wrap_gtk_text_buffer_insert_with_tags_by_name(PyGObject *self, PyObject *args)
-{
- PyObject *first, *py_iter;
- gint len, i, start_offset;
- Py_ssize_t text_len;
- gchar *text;
- GtkTextIter *iter, start;
-
- len = PyTuple_Size(args);
- if (len < 2) {
- PyErr_SetString(PyExc_TypeError,
- "GtkTextBuffer.insert_with_tags_by_name "
- "requires at least 2 arguments");
- return NULL;
- }
- first = PySequence_GetSlice(args, 0, 2);
- if (!PyArg_ParseTuple(first, "Os#:GtkTextBuffer.insert_with_tags_by_name",
- &py_iter, &text, &text_len)) {
- Py_DECREF(first);
- return NULL;
- }
- Py_DECREF(first);
- if (!pyg_boxed_check(py_iter, GTK_TYPE_TEXT_ITER)) {
- PyErr_SetString(PyExc_TypeError, "iter must be a GtkTextIter");
- return NULL;
- }
- iter = pyg_boxed_get(py_iter, GtkTextIter);
-
- /* check types */
- for (i = 2; i < len; i++) {
- PyObject *item = PyTuple_GetItem(args, i);
-
- if (!PyString_Check(item)) {
- PyErr_SetString(PyExc_TypeError,
- "additional argument must be a string");
- return NULL;
- }
- }
-
- start_offset = gtk_text_iter_get_offset(iter);
- gtk_text_buffer_insert(GTK_TEXT_BUFFER(self->obj), iter, text, text_len);
- gtk_text_buffer_get_iter_at_offset(GTK_TEXT_BUFFER(self->obj),
- &start, start_offset);
-
- for (i = 2; i < len; i++) {
- PyObject *item = PyTuple_GetItem(args, i);
- const gchar *tagname = PyString_AsString(item);
-
- gtk_text_buffer_apply_tag_by_name(GTK_TEXT_BUFFER(self->obj),
- tagname, &start, iter);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_text_buffer_create_tag kwargs
-static PyObject *
-_wrap_gtk_text_buffer_create_tag(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- gchar *tag_name = NULL;
- GtkTextTag *tag;
- GtkTextTagTable *table;
-
- if (!PyArg_ParseTuple(args, "|z:GtkTextBuffer.create_tag",
- &tag_name)) {
- return NULL;
- }
-
- table = GTK_TEXT_TAG_TABLE(GTK_TEXT_BUFFER(self->obj)->tag_table);
- if (tag_name && table && g_hash_table_lookup(table->hash, tag_name)) {
- gchar buf[512];
- g_snprintf(buf, sizeof(buf),
- "A tag named '%s' is already in the tag table",
- tag_name);
-
- PyErr_SetString(PyExc_TypeError, buf);
- return NULL;
- }
-
- tag = gtk_text_buffer_create_tag(GTK_TEXT_BUFFER(self->obj),
- tag_name, NULL);
-
- /* set tag properties if any */
- if (kwargs) {
- Py_ssize_t i = 0;
- PyObject *prop, *val;
-
- while (PyDict_Next(kwargs, &i, &prop, &val)) {
- GParamSpec *pspec;
- GValue value = { 0, };
- gchar *prop_str = PyString_AsString(prop);
-
- pspec = g_object_class_find_property (G_OBJECT_GET_CLASS(tag),
- prop_str);
- if (!pspec) {
- PyErr_Format(PyExc_TypeError,
- "unsupported tag property `%s'",
- prop_str);
- /* XXX: Free tag? */
- return NULL;
- }
-
- g_value_init(&value, G_PARAM_SPEC_VALUE_TYPE(pspec));
- if (pyg_value_from_pyobject(&value, val) < 0) {
- PyErr_Format(PyExc_TypeError,
- "could not convert tag property '%s' to correct type",
- prop_str);
- /* XXX: Free tag? */
- return NULL;
- }
- g_object_set_property((GObject *)tag, prop_str, &value);
- g_value_unset(&value);
- }
- }
- return pygobject_new((GObject *)tag);
-}
-%%
-override gtk_text_buffer_get_iter_at_line_offset kwargs
-static PyObject *
-_wrap_gtk_text_buffer_get_iter_at_line_offset(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "line_number", "char_offset", NULL };
- GtkTextIter iter;
- int line_number, char_offset;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "ii:GtkTextBuffer.get_iter_at_line_offset", kwlist, &line_number, &char_offset))
- return NULL;
-
- gtk_text_buffer_get_iter_at_line_offset(GTK_TEXT_BUFFER(self->obj), &iter,
- line_number, char_offset);
- return pyg_boxed_new(GTK_TYPE_TEXT_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_text_buffer_get_iter_at_line_index kwargs
-static PyObject *
-_wrap_gtk_text_buffer_get_iter_at_line_index(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "line_number", "byte_offset", NULL };
- GtkTextIter iter;
- int line_number, byte_offset;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "ii:GtkTextBuffer.get_iter_at_line_index", kwlist, &line_number, &byte_offset))
- return NULL;
-
- gtk_text_buffer_get_iter_at_line_index(GTK_TEXT_BUFFER(self->obj), &iter,
- line_number, byte_offset);
- return pyg_boxed_new(GTK_TYPE_TEXT_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_text_buffer_get_iter_at_offset kwargs
-static PyObject *
-_wrap_gtk_text_buffer_get_iter_at_offset(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- int char_offset;
- static char *kwlist[] = { "char_offset", NULL };
- GtkTextIter iter;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i:GtkTextBuffer.get_iter_at_offset", kwlist, &char_offset))
- return NULL;
-
- gtk_text_buffer_get_iter_at_offset(GTK_TEXT_BUFFER(self->obj),
- &iter, char_offset);
- return pyg_boxed_new(GTK_TYPE_TEXT_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_text_buffer_get_iter_at_line kwargs
-static PyObject *
-_wrap_gtk_text_buffer_get_iter_at_line(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- int line_number;
- static char *kwlist[] = { "line_number", NULL };
- GtkTextIter iter;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i:GtkTextBuffer.get_iter_at_line", kwlist, &line_number))
- return NULL;
-
- gtk_text_buffer_get_iter_at_line(GTK_TEXT_BUFFER(self->obj),
- &iter, line_number);
- return pyg_boxed_new(GTK_TYPE_TEXT_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_text_buffer_get_start_iter noargs
-static PyObject *
-_wrap_gtk_text_buffer_get_start_iter(PyGObject *self)
-{
- GtkTextIter iter;
-
- gtk_text_buffer_get_start_iter(GTK_TEXT_BUFFER(self->obj), &iter);
- return pyg_boxed_new(GTK_TYPE_TEXT_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_text_buffer_get_end_iter noargs
-static PyObject *
-_wrap_gtk_text_buffer_get_end_iter(PyGObject *self)
-{
- GtkTextIter iter;
-
- gtk_text_buffer_get_end_iter(GTK_TEXT_BUFFER(self->obj), &iter);
- return pyg_boxed_new(GTK_TYPE_TEXT_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_text_buffer_get_bounds noargs
-static PyObject *
-_wrap_gtk_text_buffer_get_bounds(PyGObject *self)
-{
- GtkTextIter start, end;
-
- gtk_text_buffer_get_bounds(GTK_TEXT_BUFFER(self->obj), &start, &end);
- return Py_BuildValue("(NN)",
- pyg_boxed_new(GTK_TYPE_TEXT_ITER, &start, TRUE, TRUE),
- pyg_boxed_new(GTK_TYPE_TEXT_ITER, &end, TRUE, TRUE));
-}
-%%
-override gtk_text_buffer_get_iter_at_mark kwargs
-static PyObject *
-_wrap_gtk_text_buffer_get_iter_at_mark(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- PyGObject *mark;
- static char *kwlist[] = { "mark", NULL };
- GtkTextIter iter;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GtkTextBuffer.get_iter_at_mark", kwlist, &mark))
- return NULL;
- if (!pygobject_check(mark, &PyGtkTextMark_Type)) {
- PyErr_SetString(PyExc_TypeError, "mark should be a GtkTextMark");
- return NULL;
- }
-
- gtk_text_buffer_get_iter_at_mark(GTK_TEXT_BUFFER(self->obj), &iter,
- GTK_TEXT_MARK(mark->obj));
- return pyg_boxed_new(GTK_TYPE_TEXT_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_text_buffer_set_text kwargs
-static PyObject *
-_wrap_gtk_text_buffer_set_text(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- char *text;
- static char *kwlist[] = { "text", "len", NULL };
- Py_ssize_t len;
- int oldlen = -1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s#|i:GtkTextBuffer.set_text", kwlist,
- &text, &len, &oldlen)) {
- return NULL;
- }
-
- if (oldlen > 0) {
- if (oldlen > len) {
- PyErr_SetString(PyExc_ValueError, "len greater than text length");
- return NULL;
- }
- len = oldlen;
- }
-
- gtk_text_buffer_set_text(GTK_TEXT_BUFFER(self->obj), text, len);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_text_buffer_get_selection_bounds noargs
-static PyObject *
-_wrap_gtk_text_buffer_get_selection_bounds(PyGObject *self, PyObject *args)
-{
- GtkTextIter start, end;
-
- if (!gtk_text_buffer_get_selection_bounds(GTK_TEXT_BUFFER(self->obj),
- &start, &end)) {
- return Py_BuildValue ("()");
- }
-
- return Py_BuildValue("(NN)",
- pyg_boxed_new(GTK_TYPE_TEXT_ITER, &start, TRUE, TRUE),
- pyg_boxed_new(GTK_TYPE_TEXT_ITER, &end, TRUE, TRUE));
-}
-%%
-override gtk_text_buffer_insert kwargs
-static PyObject *
-_wrap_gtk_text_buffer_insert(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "iter", "text", "len", NULL };
- PyObject *py_iter;
- char *text;
- Py_ssize_t len;
- int oldlen = -1;
- GtkTextIter *iter = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "Os#|i:GtkTextBuffer.insert",
- kwlist, &py_iter, &text, &len, &oldlen)) {
- return NULL;
- }
-
- if (oldlen > 0) {
- if (oldlen > len) {
- PyErr_SetString(PyExc_ValueError, "len greater than text length");
- return NULL;
- }
- len = oldlen;
- }
-
- if (pyg_boxed_check(py_iter, GTK_TYPE_TEXT_ITER)) {
- iter = pyg_boxed_get(py_iter, GtkTextIter);
- } else {
- PyErr_SetString(PyExc_TypeError, "iter should be a GtkTextIter");
- return NULL;
- }
- gtk_text_buffer_insert(GTK_TEXT_BUFFER(self->obj), iter, text, len);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_text_buffer_insert_at_cursor kwargs
-static PyObject *
-_wrap_gtk_text_buffer_insert_at_cursor(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "text", "len", NULL };
- char *text;
- Py_ssize_t len;
- int oldlen = -1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s#|i:GtkTextBuffer.insert_at_cursor",
- kwlist, &text, &len, &oldlen)) {
- return NULL;
- }
-
- if (oldlen > 0) {
- if (oldlen > len) {
- PyErr_SetString(PyExc_ValueError, "len greater than text length");
- return NULL;
- }
- len = oldlen;
- }
-
- gtk_text_buffer_insert_at_cursor(GTK_TEXT_BUFFER(self->obj), text, len);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_text_buffer_insert_interactive kwargs
-static PyObject *
-_wrap_gtk_text_buffer_insert_interactive(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "iter", "text", "default_editable", "len", NULL };
- PyObject *py_iter;
- char *text;
- int default_editable, ret, oldlen = -1;
- Py_ssize_t len;
- GtkTextIter *iter = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Os#i|i:GtkTextBuffer.insert_interactive",
- kwlist, &py_iter, &text, &len,
- &default_editable, &oldlen)) {
- return NULL;
- }
-
- if (oldlen > 0) {
- if (oldlen > len) {
- PyErr_SetString(PyExc_ValueError, "len greater than text length");
- return NULL;
- }
- if (oldlen > len) {
- PyErr_SetString(PyExc_ValueError, "len greater than text length");
- return NULL;
- }
- len = oldlen;
- }
-
- if (pyg_boxed_check(py_iter, GTK_TYPE_TEXT_ITER)) {
- iter = pyg_boxed_get(py_iter, GtkTextIter);
- } else {
- PyErr_SetString(PyExc_TypeError, "iter should be a GtkTextIter");
- return NULL;
- }
- ret = gtk_text_buffer_insert_interactive(GTK_TEXT_BUFFER(self->obj), iter,
- text, len, default_editable);
- return PyBool_FromLong(ret);
-}
-%%
-override gtk_text_buffer_insert_interactive_at_cursor kwargs
-static PyObject *
-_wrap_gtk_text_buffer_insert_interactive_at_cursor(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "text", "default_editable", "len", NULL };
- char *text;
- Py_ssize_t len;
- int default_editable, ret, oldlen = -1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s#i|i:GtkTextBuffer.insert_interactive_at_cursor",
- kwlist, &text, &len, &default_editable, &oldlen)) {
- return NULL;
- }
-
- if (oldlen > 0) {
- len = oldlen;
- }
-
- ret = gtk_text_buffer_insert_interactive_at_cursor(GTK_TEXT_BUFFER(self->obj),
- text, len, default_editable);
- return PyBool_FromLong(ret);
-}
-%%
-override gtk_text_buffer_get_iter_at_child_anchor kwargs
-static PyObject *
-_wrap_gtk_text_buffer_get_iter_at_child_anchor(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "anchor", NULL };
- PyGObject *anchor;
- GtkTextIter iter;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!:GtkTextBuffer.get_iter_at_child_anchor", kwlist, &PyGtkTextChildAnchor_Type, &anchor))
- return NULL;
-
- gtk_text_buffer_get_iter_at_child_anchor(GTK_TEXT_BUFFER(self->obj),
- &iter,
- GTK_TEXT_CHILD_ANCHOR(anchor->obj));
- return pyg_boxed_new(GTK_TYPE_TEXT_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_text_tag_table_add kwargs
-static PyObject *
-_wrap_gtk_text_tag_table_add(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "tag", NULL };
- GtkTextTag *tag;
- GtkTextTagTable *table;
- PyGObject *pytag;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!:GtkTextTagTable.add",
- kwlist, &PyGtkTextTag_Type, &pytag)) {
- return NULL;
- }
-
- tag = GTK_TEXT_TAG(pytag->obj);
- table = GTK_TEXT_TAG_TABLE(self->obj);
-
- if (tag->table) {
- gchar buf[512];
- g_snprintf(buf, sizeof(buf),
- "The tag is already in a tag table");
-
- PyErr_SetString(PyExc_ValueError, buf);
- return NULL;
- }
-
- if (tag->name && table && g_hash_table_lookup(table->hash, tag->name)) {
- gchar buf[512];
- g_snprintf(buf, sizeof(buf),
- "A tag named '%s' is already in the tag table",
- tag->name);
-
- PyErr_SetString(PyExc_ValueError, buf);
- return NULL;
- }
-
- gtk_text_tag_table_add(table, tag);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_text_tag_table_remove kwargs
-static PyObject *
-_wrap_gtk_text_tag_table_remove(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "tag", NULL };
- GtkTextTag *tag;
- GtkTextTagTable *table;
- PyGObject *pytag;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!:GtkTextTagTable.remove",
- kwlist, &PyGtkTextTag_Type, &pytag)) {
- return NULL;
- }
-
- tag = GTK_TEXT_TAG(pytag->obj);
- table = GTK_TEXT_TAG_TABLE(self->obj);
-
- if (tag->table != table) {
- gchar buf[512];
- if (tag->name)
- g_snprintf(buf, sizeof(buf),
- "The tag named '%s' is not in the tag table",
- tag->name);
- else
- g_snprintf(buf, sizeof(buf),
- "The tag is not in the tag table");
-
- PyErr_SetString(PyExc_ValueError, buf);
- return NULL;
- }
-
- gtk_text_tag_table_remove(table, tag);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override-attr GtkTextAttributes.bg_color
-static PyObject *
-_wrap_gtk_text_attributes__get_bg_color(PyObject *self, void *closure)
-{
- GdkColor ret;
-
- ret = pyg_boxed_get(self, GtkTextAttributes)->appearance.bg_color;
- /* pyg_boxed_new handles NULL checking */
- return pyg_boxed_new(GDK_TYPE_COLOR, &ret, TRUE, TRUE);
-}
-%%
-override-attr GtkTextAttributes.fg_color
-static PyObject *
-_wrap_gtk_text_attributes__get_fg_color(PyObject *self, void *closure)
-{
- GdkColor ret;
-
- ret = pyg_boxed_get(self, GtkTextAttributes)->appearance.fg_color;
- /* pyg_boxed_new handles NULL checking */
- return pyg_boxed_new(GDK_TYPE_COLOR, &ret, TRUE, TRUE);
-}
-%%
-override-attr GtkTextAttributes.bg_stipple
-static PyObject *
-_wrap_gtk_text_attributes__get_bg_stipple(PyObject *self, void *closure)
-{
- GdkBitmap *ret;
-
- ret = pyg_boxed_get(self, GtkTextAttributes)->appearance.bg_stipple;
- /* pygobject_new handles NULL checking */
- return pygobject_new((GObject *)ret);
-}
-%%
-override-attr GtkTextAttributes.fg_stipple
-static PyObject *
-_wrap_gtk_text_attributes__get_fg_stipple(PyObject *self, void *closure)
-{
- GdkBitmap *ret;
-
- ret = pyg_boxed_get(self, GtkTextAttributes)->appearance.fg_stipple;
- /* pygobject_new handles NULL checking */
- return pygobject_new((GObject *)ret);
-}
-%%
-override-attr GtkTextAttributes.rise
-static PyObject *
-_wrap_gtk_text_attributes__get_rise(PyObject *self, void *closure)
-{
- int ret;
-
- ret = pyg_boxed_get(self, GtkTextAttributes)->appearance.rise;
- return PyInt_FromLong(ret);
-}
-%%
-override-attr GtkTextAttributes.underline
-static PyObject *
-_wrap_gtk_text_attributes__get_underline(PyObject *self, void *closure)
-{
- int ret;
-
- ret = pyg_boxed_get(self, GtkTextAttributes)->appearance.underline;
- return PyInt_FromLong(ret);
-}
-%%
-override-attr GtkTextAttributes.strikethrough
-static PyObject *
-_wrap_gtk_text_attributes__get_strikethrough(PyObject *self, void *closure)
-{
- return PyBool_FromLong(pyg_boxed_get(self, GtkTextAttributes)->appearance.strikethrough);
-}
-%%
-override-attr GtkTextAttributes.draw_bg
-static PyObject *
-_wrap_gtk_text_attributes__get_draw_bg(PyObject *self, void *closure)
-{
- return PyBool_FromLong(pyg_boxed_get(self, GtkTextAttributes)->appearance.draw_bg);
-}
-%%
-override gtk_text_tag_table_foreach kwargs
-static void
-pygtk_text_tag_table_foreach_cb(GtkTextTag *tag, gpointer user_data)
-{
- PyGILState_STATE state;
- PyObject *callback, *args, *ret;
-
- state = pyg_gil_state_ensure();
- callback = PyTuple_GetItem((PyObject *)user_data, 0);
- args = Py_BuildValue("(NO)",
- pygobject_new((GObject *)tag),
- PyTuple_GetItem((PyObject *)user_data, 1));
- ret = PyObject_CallObject(callback, args);
- if (!ret)
- PyErr_Print();
- Py_DECREF(args);
- Py_XDECREF(ret);
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_text_tag_table_foreach(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", NULL };
- PyObject *func, *data, *py_data = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkTextTagTable.foreach",
- kwlist, &func, &py_data)) {
- return NULL;
- }
- if (!PyCallable_Check(func)) {
- PyErr_SetString(PyExc_TypeError, "func must be callable");
- return NULL;
- }
-
- data = Py_BuildValue("(OO)", func, py_data);
-
- gtk_text_tag_table_foreach(GTK_TEXT_TAG_TABLE(self->obj),
- pygtk_text_tag_table_foreach_cb,
- (gpointer)data);
- Py_DECREF(data);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_text_iter_forward_find_char kwargs
-static gboolean
-pygtk_find_char_pred(gunichar ch, gpointer user_data)
-{
- PyGILState_STATE state;
- PyObject *pred, *args, *pyret = Py_False;
- gboolean ret;
-
- state = pyg_gil_state_ensure();
-
-#if !defined(Py_UNICODE_SIZE) || Py_UNICODE_SIZE == 2
- if (ch > 0xffff) {
- PyErr_SetString(PyExc_RuntimeError,
- "character can not be represented in 16-bit unicode");
- PyErr_Print();
- return FALSE;
- }
-#endif
- pred = PyTuple_GetItem((PyObject *)user_data, 0);
- args = Py_BuildValue("(NO)", PyUnicode_FromUnicode((Py_UNICODE *)&ch, 1),
- PyTuple_GetItem((PyObject *)user_data, 1));
-
- pyret = PyObject_CallObject(pred, args);
- if (!pyret)
- PyErr_Print();
- ret = (pyret == Py_True) ? TRUE : FALSE;
-
- Py_XDECREF(pyret);
- pyg_gil_state_release(state);
-
- return ret;
-}
-static PyObject *
-_wrap_gtk_text_iter_forward_find_char(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "pred", "user_data", "limit", NULL };
- GtkTextIter *iter, *limit = NULL;
- gboolean ret;
- PyObject *pylimit = Py_None, *pred, *data, *pydata = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|OO:gtk.TextIter.forward_find_char",
- kwlist, &pred, &pydata, &pylimit))
- return NULL;
-
- if (pylimit != Py_None) {
- if (pyg_boxed_check(pylimit, GTK_TYPE_TEXT_ITER)) {
- limit = pyg_boxed_get(pylimit, GtkTextIter);
- } else {
- PyErr_SetString(PyExc_TypeError,
- "limit should be a gtk.TextIter or None");
- return NULL;
- }
- }
- if (!PyCallable_Check(pred)) {
- PyErr_SetString(PyExc_TypeError, "pred must be callable");
- return NULL;
- }
-
- data = Py_BuildValue("(OO)", pred, pydata);
- iter = pyg_boxed_get(self, GtkTextIter);
-
- ret = gtk_text_iter_forward_find_char(iter, pygtk_find_char_pred,
- (gpointer)data, limit);
-
- return PyBool_FromLong(ret);
-}
-%%
-override gtk_text_iter_backward_find_char kwargs
-static PyObject *
-_wrap_gtk_text_iter_backward_find_char(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "pred", "user_data", "limit", NULL };
- GtkTextIter *iter, *limit = NULL;
- gboolean ret;
- PyObject *pylimit = Py_None, *pred, *data, *pydata = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|OO:gtk.TextIter.backward_find_char",
- kwlist, &pred, &pydata, &pylimit))
- return NULL;
-
- if (pylimit != Py_None) {
- if (pyg_boxed_check(pylimit, GTK_TYPE_TEXT_ITER)) {
- limit = pyg_boxed_get(pylimit, GtkTextIter);
- } else {
- PyErr_SetString(PyExc_TypeError,
- "limit should be a gtk.TextIter or None");
- return NULL;
- }
- }
- if (!PyCallable_Check(pred)) {
- PyErr_SetString(PyExc_TypeError, "pred must be callable");
- return NULL;
- }
-
- data = Py_BuildValue("(OO)", pred, pydata);
- iter = pyg_boxed_get(self, GtkTextIter);
-
- ret = gtk_text_iter_backward_find_char(iter, pygtk_find_char_pred,
- (gpointer)data, limit);
-
- return PyBool_FromLong(ret);
-}
-%%
-override gtk_text_view_get_default_attributes noargs
-/* Workaround gtk bug #317455; moreover, copy_boxed should have been FALSE
- * in the first place (missing caller-owns-return in the defs) */
-static PyObject *
-_wrap_gtk_text_view_get_default_attributes(PyGObject *self)
-{
- GtkTextAttributes *ret;
-
- ret = gtk_text_view_get_default_attributes(GTK_TEXT_VIEW(self->obj));
- /* pyg_boxed_new handles NULL checking */
- return pyg_boxed_new(GTK_TYPE_TEXT_ATTRIBUTES, ret, FALSE, TRUE);
-}
-%%
-override gtk_text_view_get_iter_at_position kwargs
-static PyObject *
-_wrap_gtk_text_view_get_iter_at_position(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "x", "y", NULL };
- GtkTextIter iter;
- gint x, y, trailing;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "ii:GtkTextView.get_iter_at_position",
- kwlist, &x, &y))
- return NULL;
- gtk_text_view_get_iter_at_position(GTK_TEXT_VIEW(self->obj),
- &iter, &trailing, x, y);
- return Py_BuildValue("Oi",
- pyg_boxed_new(GTK_TYPE_TEXT_ITER, &iter, TRUE, TRUE),
- trailing);
-}
-%%
-override gtk_text_buffer_get_copy_target_list noargs
-static PyObject*
-_wrap_gtk_text_buffer_get_copy_target_list(PyGObject *self)
-{
- GtkTargetList *targets;
- PyObject *py_targets;
-
- targets = gtk_text_buffer_get_copy_target_list(GTK_TEXT_BUFFER(self->obj));
- py_targets = pygtk_target_list_to_list(targets);
- gtk_target_list_unref(targets);
- return py_targets;
-}
-%%
-override gtk_text_buffer_get_paste_target_list noargs
-static PyObject*
-_wrap_gtk_text_buffer_get_paste_target_list(PyGObject *self)
-{
- GtkTargetList *targets;
- PyObject *py_targets;
-
- targets = gtk_text_buffer_get_paste_target_list(GTK_TEXT_BUFFER(self->obj));
- py_targets = pygtk_target_list_to_list(targets);
- gtk_target_list_unref(targets);
- return py_targets;
-}
-%%
-override gtk_text_buffer_deserialize kwargs
-static PyObject *
-_wrap_gtk_text_buffer_deserialize(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "content_buffer", "format", "iter", "data",
- NULL };
- Py_ssize_t length;
- PyObject *py_format = NULL, *py_iter;
- GdkAtom format;
- GError *error = NULL;
- int ret;
- guint8 *data;
- PyGObject *content_buffer;
- GtkTextIter *iter = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!OOs#:GtkTextBuffer.deserialize",
- kwlist, &PyGtkTextBuffer_Type,
- &content_buffer, &py_format, &py_iter,
- &data, &length))
- return NULL;
-
- format = pygdk_atom_from_pyobject(py_format);
- if (PyErr_Occurred())
- return NULL;
-
- if (pyg_boxed_check(py_iter, GTK_TYPE_TEXT_ITER))
- iter = pyg_boxed_get(py_iter, GtkTextIter);
- else {
- PyErr_SetString(PyExc_TypeError, "iter should be a GtkTextIter");
- return NULL;
- }
-
- ret = gtk_text_buffer_deserialize(GTK_TEXT_BUFFER(self->obj),
- GTK_TEXT_BUFFER(content_buffer->obj),
- format, iter, data, length, &error);
- if (pyg_error_check(&error))
- return NULL;
- return PyBool_FromLong(ret);
-}
-%%
-override gtk_text_buffer_serialize kwargs
-static PyObject *
-_wrap_gtk_text_buffer_serialize(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "content_buffer", "format", "start", "end",
- NULL };
- PyObject *py_format = NULL, *py_start, *py_end;
- GdkAtom format;
- gsize length;
- guint8 *ret;
- PyGObject *content_buffer;
- GtkTextIter *start = NULL, *end = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!OOO:GtkTextBuffer.serialize",
- kwlist, &PyGtkTextBuffer_Type,
- &content_buffer, &py_format, &py_start,
- &py_end))
- return NULL;
-
- format = pygdk_atom_from_pyobject(py_format);
- if (PyErr_Occurred())
- return NULL;
-
- if (pyg_boxed_check(py_start, GTK_TYPE_TEXT_ITER))
- start = pyg_boxed_get(py_start, GtkTextIter);
- else {
- PyErr_SetString(PyExc_TypeError, "start should be a GtkTextIter");
- return NULL;
- }
- if (pyg_boxed_check(py_end, GTK_TYPE_TEXT_ITER))
- end = pyg_boxed_get(py_end, GtkTextIter);
- else {
- PyErr_SetString(PyExc_TypeError, "end should be a GtkTextIter");
- return NULL;
- }
-
- ret = gtk_text_buffer_serialize(GTK_TEXT_BUFFER(self->obj),
- GTK_TEXT_BUFFER(content_buffer->obj),
- format, start, end, &length);
- return PyString_FromStringAndSize((char *) ret, (Py_ssize_t) length);
-}
-%%
-override gtk_text_buffer_register_deserialize_format kwargs
-static gint
-pygtk_text_buffer_register_deserialize_format_cb(GtkTextBuffer *register_buf,
- GtkTextBuffer *content_buf,
- GtkTextIter *iter,
- const guint8 *data,
- gsize length,
- gboolean create_tags,
- gpointer user_data,
- GError **error)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *py_register_buf, *py_content_buf, *py_iter, *py_data, *retobj;
- gboolean ret = FALSE;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_register_buf = pygobject_new((GObject*)register_buf);
- py_content_buf = pygobject_new((GObject*)content_buf);
- py_iter = pyg_boxed_new(GTK_TYPE_TEXT_ITER, iter, TRUE, TRUE);
- py_data = PyString_FromStringAndSize((char *) data, length);
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(NNNNiO)",
- py_register_buf, py_content_buf,
- py_iter, py_data, create_tags,
- cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(NNNNi)", py_register_buf,
- py_content_buf, py_iter, py_data,
- create_tags);
- }
-
- if (retobj != NULL) {
- ret = PyInt_AsLong(retobj);
- Py_DECREF(retobj);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_text_buffer_register_deserialize_format(PyGObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "mime_type", "function", "user_data", NULL };
- PyObject *pyfunc, *pyarg = NULL, *ret;
- PyGtkCustomNotify *cunote;
- const gchar *mimetype;
- GdkAtom atom;
- gchar *name;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "sO|O:GtkTextBuffer.register_deserialize_format",
- kwlist, &mimetype, &pyfunc, &pyarg))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError,
- "function must be a callable object");
- return NULL;
- }
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- atom = gtk_text_buffer_register_deserialize_format(
- GTK_TEXT_BUFFER(self->obj), mimetype,
- pygtk_text_buffer_register_deserialize_format_cb, cunote,
- pygtk_custom_destroy_notify);
-
- name = gdk_atom_name(atom);
- ret = PyString_FromString(name);
- g_free(name);
- return ret;
-}
-%%
-override gtk_text_buffer_register_serialize_format kwargs
-static guint8*
-pygtk_text_buffer_register_serialize_format_cb(GtkTextBuffer *register_buf,
- GtkTextBuffer *content_buf,
- const GtkTextIter *start,
- const GtkTextIter *end,
- gsize *length,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *py_register_buf, *py_content_buf, *py_start, *py_end;
- PyObject *retobj;
- guint8 *ret;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_register_buf = pygobject_new((GObject*)register_buf);
- py_content_buf = pygobject_new((GObject*)content_buf);
- py_start = pyg_boxed_new(GTK_TYPE_TEXT_ITER, (gpointer)start, TRUE, TRUE);
- py_end = pyg_boxed_new(GTK_TYPE_TEXT_ITER, (gpointer)end, TRUE, TRUE);
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(NNNNO)",
- py_register_buf, py_content_buf,
- py_start, py_end,
- cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(NNNN)", py_register_buf,
- py_content_buf, py_start, py_end);
- }
-
- if (retobj != NULL) {
- PyString_AsStringAndSize(retobj, (gchar**)&ret, (Py_ssize_t*) length);
- Py_DECREF(retobj);
- } else {
- PyErr_Print();
- ret = NULL;
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_text_buffer_register_serialize_format(PyGObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "mime_type", "function", "user_data",
- NULL };
- PyObject *pyfunc, *pyarg = NULL, *ret;
- PyGtkCustomNotify *cunote;
- const gchar *mimetype;
- GdkAtom atom;
- gchar *name;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "sO|O:GtkTextBuffer.register_serialize_format",
- kwlist, &mimetype, &pyfunc, &pyarg))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError,
- "function must be a callable object");
- return NULL;
- }
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- atom = gtk_text_buffer_register_serialize_format(
- GTK_TEXT_BUFFER(self->obj), mimetype,
- pygtk_text_buffer_register_serialize_format_cb,
- cunote, pygtk_custom_destroy_notify);
-
- name = gdk_atom_name(atom);
- ret = PyString_FromString(name);
- g_free(name);
- return ret;
-}
-%%
-override gtk_text_buffer_get_deserialize_formats noargs
-static PyObject *
-_wrap_gtk_text_buffer_get_deserialize_formats(PyGObject *self)
-{
- GdkAtom *formats;
- gint n_formats, i;
- PyObject *py_formats;
-
- formats = gtk_text_buffer_get_deserialize_formats(
- GTK_TEXT_BUFFER(self->obj), &n_formats);
-
- py_formats = PyList_New(n_formats);
- for (i = 0; i < n_formats; i++) {
- gchar *name = gdk_atom_name(formats[i]);
- PyList_SetItem(py_formats, i, PyString_FromString(name));
- g_free(name);
- }
- g_free(formats);
- return py_formats;
-}
-%%
-override gtk_text_buffer_get_serialize_formats noargs
-static PyObject *
-_wrap_gtk_text_buffer_get_serialize_formats(PyGObject *self)
-{
- GdkAtom *formats;
- gint n_formats, i;
- PyObject *py_formats;
-
- formats = gtk_text_buffer_get_serialize_formats(
- GTK_TEXT_BUFFER(self->obj), &n_formats);
-
- py_formats = PyList_New(n_formats);
- for (i = 0; i < n_formats; i++) {
- gchar *name = gdk_atom_name(formats[i]);
- PyList_SetItem(py_formats, i, PyString_FromString(name));
- g_free(name);
- }
- g_free(formats);
- return py_formats;
-}
diff --git a/gtk/gtktoolbar.override b/gtk/gtktoolbar.override
deleted file mode 100644
index fddab8e2..00000000
--- a/gtk/gtktoolbar.override
+++ /dev/null
@@ -1,578 +0,0 @@
-%%
-ignore
- gtk_tool_button_new_from_stock
- gtk_menu_tool_button_new_from_stock
- gtk_toggle_tool_button_new_from_stock
-%%
-ignore-glob
- gtk_radio_tool_button_new_*
-%%
-override gtk_toolbar_append_item kwargs
-static PyObject *
-_wrap_gtk_toolbar_append_item(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "text", "tooltip_text", "tooltip_private_text",
- "icon", "callback", "user_data", NULL };
- char *text, *tooltip_text, *tooltip_private_text;
- PyGObject *py_icon;
- PyObject *callback, *param = NULL, *py_ret;
- GtkWidget *icon = NULL, *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "zzzOO|O:GtkToolbar.append_item", kwlist,
- &text, &tooltip_text,
- &tooltip_private_text, &py_icon,
- &callback, &param))
- return NULL;
- if (PyErr_Warn(PyExc_DeprecationWarning, "") < 0)
- return NULL;
- if (pygobject_check(py_icon, &PyGtkWidget_Type))
- icon = GTK_WIDGET(py_icon->obj);
- else if ((PyObject *)py_icon != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "forth argument must be a GtkWidget or None");
- return NULL;
- }
- ret = gtk_toolbar_append_item(GTK_TOOLBAR(self->obj), text, tooltip_text,
- tooltip_private_text, icon, NULL, NULL);
- py_ret = pygobject_new((GObject *)ret);
- if (ret && PyCallable_Check(callback)) {
- GClosure *closure;
-
- closure = pyg_closure_new(callback, param, NULL);
- g_signal_connect_closure(ret, "clicked", closure, FALSE);
- pygobject_watch_closure(py_ret, closure);
- }
- return py_ret;
-}
-%%
-override gtk_toolbar_prepend_item kwargs
-static PyObject *
-_wrap_gtk_toolbar_prepend_item(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "text", "tooltip_text", "tooltip_private_text",
- "icon", "callback", "user_data", NULL };
- char *text, *tooltip_text, *tooltip_private_text;
- PyGObject *py_icon;
- PyObject *callback, *param, *py_ret;
- GtkWidget *icon = NULL, *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "zzzOOO:GtkToolbar.prepend_item", kwlist,
- &text, &tooltip_text,
- &tooltip_private_text, &py_icon,
- &callback, &param))
- return NULL;
- if (PyErr_Warn(PyExc_DeprecationWarning, "") < 0)
- return NULL;
- if (pygobject_check(py_icon, &PyGtkWidget_Type))
- icon = GTK_WIDGET(py_icon->obj);
- else if ((PyObject *)py_icon != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "forth argument must be a GtkWidget or None");
- return NULL;
- }
- ret = gtk_toolbar_prepend_item(GTK_TOOLBAR(self->obj), text, tooltip_text,
- tooltip_private_text, icon, NULL, NULL);
- py_ret = pygobject_new((GObject *)ret);
- if (ret && PyCallable_Check(callback)) {
- GClosure *closure;
-
- closure = pyg_closure_new(callback, param, NULL);
- g_signal_connect_closure(ret, "clicked", closure, FALSE);
- pygobject_watch_closure(py_ret, closure);
- }
- return py_ret;
-}
-%%
-override gtk_toolbar_insert_item kwargs
-static PyObject *
-_wrap_gtk_toolbar_insert_item(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "text", "tooltip_text", "tooltip_private_text",
- "icon", "callback", "user_data", "position",
- NULL };
- char *text, *tooltip_text, *tooltip_private_text;
- PyGObject *py_icon;
- PyObject *callback, *param, *py_ret;
- GtkWidget *icon = NULL, *ret;
- int position;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "zzzOOOi:GtkToolbar.insert_item", kwlist,
- &text, &tooltip_text,
- &tooltip_private_text, &py_icon,
- &callback, &param, &position))
- return NULL;
- if (PyErr_Warn(PyExc_DeprecationWarning, "") < 0)
- return NULL;
- if (pygobject_check(py_icon, &PyGtkWidget_Type))
- icon = GTK_WIDGET(py_icon->obj);
- else if ((PyObject *)py_icon != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "forth argument must be a GtkWidget or None");
- return NULL;
- }
- ret = gtk_toolbar_insert_item(GTK_TOOLBAR(self->obj), text, tooltip_text,
- tooltip_private_text, icon, NULL, NULL,
- position);
- py_ret = pygobject_new((GObject *)ret);
- if (ret && PyCallable_Check(callback)) {
- GClosure *closure;
-
- closure = pyg_closure_new(callback, param, NULL);
- g_signal_connect_closure(ret, "clicked", closure, FALSE);
- pygobject_watch_closure(py_ret, closure);
- }
- return py_ret;
-}
-%%
-override gtk_toolbar_insert_stock kwargs
-static PyObject *
-_wrap_gtk_toolbar_insert_stock(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "stock_id", "tooltip_text", "tooltip_private_text",
- "callback", "user_data", "position",
- NULL };
- char *stock_id, *tooltip_text, *tooltip_private_text;
- PyObject *callback, *param, *py_ret;
- GtkWidget *ret;
- int position;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "zzzOOi:GtkToolbar.insert_stock", kwlist,
- &stock_id, &tooltip_text,
- &tooltip_private_text,
- &callback, &param, &position))
- return NULL;
- if (PyErr_Warn(PyExc_DeprecationWarning, "") < 0)
- return NULL;
-
- ret = gtk_toolbar_insert_stock(GTK_TOOLBAR(self->obj), stock_id, tooltip_text,
- tooltip_private_text, NULL, NULL,
- position);
- py_ret = pygobject_new((GObject *)ret);
- if (ret && PyCallable_Check(callback)) {
- GClosure *closure;
-
- closure = pyg_closure_new(callback, param, NULL);
- g_signal_connect_closure(ret, "clicked", closure, FALSE);
- pygobject_watch_closure(py_ret, closure);
- }
- return py_ret;
-}
-%%
-override gtk_toolbar_append_element kwargs
-static PyObject *
-_wrap_gtk_toolbar_append_element(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "type", "widget", "text", "tooltip_text",
- "tooltip_private_text", "icon", "callback",
- "user_data", NULL };
- char *text, *tooltip_text, *tooltip_private_text;
- PyObject *py_type, *callback, *param, *py_ret;
- PyGObject *py_widget, *py_icon;
- GtkWidget *widget = NULL, *icon = NULL, *ret;
- GtkToolbarChildType type;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOzzzOOO:GtkToolbar.append_element",
- kwlist,
- &py_type, &py_widget,
- &text, &tooltip_text,
- &tooltip_private_text, &py_icon,
- &callback, &param))
- return NULL;
- if (PyErr_Warn(PyExc_DeprecationWarning, "") < 0)
- return NULL;
- if (pyg_enum_get_value(GTK_TYPE_TOOLBAR_CHILD_TYPE,
- py_type, (gint *)&type))
- return NULL;
- if (pygobject_check(py_widget, &PyGtkWidget_Type))
- widget = GTK_WIDGET(py_widget->obj);
- else if ((PyObject *)py_widget != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "second argument must be a GtkWidget or None");
- return NULL;
- }
- if (pygobject_check(py_icon, &PyGtkWidget_Type))
- icon = GTK_WIDGET(py_icon->obj);
- else if ((PyObject *)py_icon != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "sixth argument must be a GtkWidget or None");
- return NULL;
- }
- ret = gtk_toolbar_append_element(GTK_TOOLBAR(self->obj), type, widget,
- text, tooltip_text, tooltip_private_text,
- icon, NULL, NULL);
- py_ret = pygobject_new((GObject *)ret);
- if (ret && PyCallable_Check(callback) &&
- (type == GTK_TOOLBAR_CHILD_BUTTON ||
- type == GTK_TOOLBAR_CHILD_TOGGLEBUTTON ||
- type == GTK_TOOLBAR_CHILD_RADIOBUTTON)) {
- GClosure *closure;
-
- closure = pyg_closure_new(callback, param, NULL);
- g_signal_connect_closure(ret, "clicked", closure, FALSE);
- pygobject_watch_closure(py_ret, closure);
- }
- return py_ret;
-}
-%%
-override gtk_toolbar_prepend_element kwargs
-static PyObject *
-_wrap_gtk_toolbar_prepend_element(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "type", "widget", "text", "tooltip_text",
- "tooltip_private_text", "icon", "callback",
- "user_data", NULL };
- char *text, *tooltip_text, *tooltip_private_text;
- PyObject *py_type, *callback, *param, *py_ret;
- PyGObject *py_widget, *py_icon;
- GtkWidget *widget = NULL, *icon = NULL, *ret;
- GtkToolbarChildType type;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOzzzOOO:GtkToolbar.prepend_element",
- kwlist,
- &py_type, &py_widget,
- &text, &tooltip_text,
- &tooltip_private_text, &py_icon,
- &callback, &param))
- return NULL;
- if (PyErr_Warn(PyExc_DeprecationWarning, "") < 0)
- return NULL;
- if (pyg_enum_get_value(GTK_TYPE_TOOLBAR_CHILD_TYPE,
- py_type, (gint *)&type))
- return NULL;
- if (pygobject_check(py_widget, &PyGtkWidget_Type))
- widget = GTK_WIDGET(py_widget->obj);
- else if ((PyObject *)py_widget != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "second argument must be a GtkWidget or None");
- return NULL;
- }
- if (pygobject_check(py_icon, &PyGtkWidget_Type))
- icon = GTK_WIDGET(py_icon->obj);
- else if ((PyObject *)py_icon != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "sixth argument must be a GtkWidget or None");
- return NULL;
- }
- ret = gtk_toolbar_prepend_element(GTK_TOOLBAR(self->obj), type, widget,
- text, tooltip_text, tooltip_private_text,
- icon, NULL, NULL);
- py_ret = pygobject_new((GObject *)ret);
- if (ret && PyCallable_Check(callback) &&
- (type == GTK_TOOLBAR_CHILD_BUTTON ||
- type == GTK_TOOLBAR_CHILD_TOGGLEBUTTON ||
- type == GTK_TOOLBAR_CHILD_RADIOBUTTON)) {
- GClosure *closure;
-
- closure = pyg_closure_new(callback, param, NULL);
- g_signal_connect_closure(ret, "clicked", closure, FALSE);
- pygobject_watch_closure(py_ret, closure);
- }
- return py_ret;
-}
-%%
-override gtk_toolbar_insert_element kwargs
-static PyObject *
-_wrap_gtk_toolbar_insert_element(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "type", "widget", "text", "tooltip_text",
- "tooltip_private_text", "icon", "callback",
- "user_data", "position", NULL };
- char *text, *tooltip_text, *tooltip_private_text;
- PyObject *py_type, *callback, *param, *py_ret;
- PyGObject *py_widget, *py_icon;
- GtkWidget *widget = NULL, *icon = NULL, *ret;
- GtkToolbarChildType type;
- int position;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOzzzOOOi:GtkToolbar.insert_element",
- kwlist,
- &py_type, &py_widget,
- &text, &tooltip_text,
- &tooltip_private_text, &py_icon,
- &callback, &param, &position))
- return NULL;
- if (PyErr_Warn(PyExc_DeprecationWarning, "") < 0)
- return NULL;
- if (pyg_enum_get_value(GTK_TYPE_TOOLBAR_CHILD_TYPE,
- py_type, (gint *)&type))
- return NULL;
- if (pygobject_check(py_widget, &PyGtkWidget_Type))
- widget = GTK_WIDGET(py_widget->obj);
- else if ((PyObject *)py_widget != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "second argument must be a GtkWidget or None");
- return NULL;
- }
- if (pygobject_check(py_icon, &PyGtkWidget_Type))
- icon = GTK_WIDGET(py_icon->obj);
- else if ((PyObject *)py_icon != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "sixth argument must be a GtkWidget or None");
- return NULL;
- }
- ret = gtk_toolbar_insert_element(GTK_TOOLBAR(self->obj), type, widget,
- text, tooltip_text, tooltip_private_text,
- icon, NULL, NULL, position);
- py_ret = pygobject_new((GObject *)ret);
- if (ret && PyCallable_Check(callback) &&
- (type == GTK_TOOLBAR_CHILD_BUTTON ||
- type == GTK_TOOLBAR_CHILD_TOGGLEBUTTON ||
- type == GTK_TOOLBAR_CHILD_RADIOBUTTON)) {
- GClosure *closure;
-
- closure = pyg_closure_new(callback, param, NULL);
- g_signal_connect_closure(ret, "clicked", closure, FALSE);
- pygobject_watch_closure(py_ret, closure);
- }
- return py_ret;
-}
-%%
-override gtk_toggle_tool_button_new kwargs
-static int
-_wrap_gtk_toggle_tool_button_new(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "stock_id", NULL };
- char *stock_id = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|z:GtkToggleToolButton.__init__",
- kwlist, &stock_id))
- return -1;
-
- if (stock_id)
- pygobject_construct(self, "stock-id", stock_id, NULL);
- else
- pygobject_construct(self, NULL);
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkToggleToolButton object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_TOGGLE_TOOL_BUTTON
-%%
-override gtk_tool_button_new kwargs
-static int
-_wrap_gtk_tool_button_new(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist1[] = { "stock_id", NULL };
- static char *kwlist2[] = { "icon_widget", "label", NULL };
- PyGObject *py_icon_widget = NULL;
- GtkWidget *icon_widget = NULL;
- char *label = NULL;
- char *stock_id = NULL;
-
- if (PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:GtkToolButton.__init__", kwlist1,
- &stock_id)) {
- pygobject_construct(self, "stock-id", stock_id, NULL);
- } else {
- PyErr_Clear();
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|Oz:GtkToolButton.__init__", kwlist2,
- &py_icon_widget, &label)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "Usage: one of:\n"
- " gtk.ToolButton(icon_widget=None, label=None)\n"
- " gtk.ToolButton(stock_id)");
- return -1;
- }
-
- if (py_icon_widget && (PyObject *)py_icon_widget != Py_None) {
- if (!pygobject_check(py_icon_widget, &PyGtkWidget_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "Usage: one of:\n"
- " gtk.ToolButton(icon_widget=None, label=None)\n"
- " gtk.ToolButton(stock_id)");
- return -1;
- }
- icon_widget = GTK_WIDGET(py_icon_widget->obj);
- }
- pygobject_construct(self, "icon-widget", icon_widget,
- "label", label, NULL);
- }
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkToolButton object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_TOOL_BUTTON
-%%
-override gtk_radio_tool_button_new kwargs
-static int
-_wrap_gtk_radio_tool_button_new(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "group", "stock_id", NULL };
- gchar *stock = NULL;
- PyObject *py_widget = Py_None;
- GtkRadioToolButton *widget = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|Oz:GtkRadioToolButton.__init__", kwlist,
- &py_widget, &stock))
- return -1;
-
- if (py_widget != Py_None) {
- if (pygobject_check(py_widget, &PyGtkRadioToolButton_Type))
- widget = GTK_RADIO_TOOL_BUTTON(pygobject_get(py_widget));
- else {
- PyErr_SetString(PyExc_TypeError,
- "first argument must be a GtkRadioToolButton or None");
- return -1;
- }
- }
-
- /* various configs for create radio tool buttons ... */
- if (stock == NULL) {
- if (widget == NULL)
- pygobject_construct(self, NULL);
- else
- pygobject_construct(self, "group", widget, NULL);
- } else {
- if (widget == NULL)
- pygobject_construct(self, "stock-id", stock, NULL);
- else
- pygobject_construct(self, "stock-id", stock, "group", widget, NULL);
- }
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkRadioToolButton object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_RADIO_TOOL_BUTTON
-%%
-override gtk_radio_tool_button_set_group kwargs
-static PyObject *
-_wrap_gtk_radio_tool_button_set_group(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "group", NULL };
- GSList *list;
- GtkRadioToolButton *group;
- PyObject *py_group;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkRadioToolButton.set_group",
- kwlist, &py_group))
- return NULL;
-
- if (pygobject_check(py_group, &PyGtkRadioToolButton_Type)) {
- group = GTK_RADIO_TOOL_BUTTON(pygobject_get(py_group));
- list = gtk_radio_tool_button_get_group(group);
- if (list == gtk_radio_tool_button_get_group(GTK_RADIO_TOOL_BUTTON(self->obj))) {
- PyErr_SetString(PyExc_ValueError, "radio tool button already in group");
- return NULL;
- }
- } else if (py_group == Py_None) {
- list = NULL;
- } else {
- PyErr_SetString(PyExc_TypeError, "group must be a RadioToolButton or None");
- return NULL;
- }
-
- gtk_radio_tool_button_set_group(GTK_RADIO_TOOL_BUTTON(self->obj), list);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_radio_tool_button_get_group noargs
-static PyObject *
-_wrap_gtk_radio_tool_button_get_group(PyGObject *self) {
- PyObject *py_list;
- GSList *list, *tmp;
- PyObject *gtk_obj;
-
- list = gtk_radio_tool_button_get_group(GTK_RADIO_TOOL_BUTTON(self->obj));
-
- if ((py_list = PyList_New(0)) == NULL) {
- return NULL;
- }
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- gtk_obj = pygobject_new(G_OBJECT(tmp->data));
- if (gtk_obj == NULL) {
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_Append(py_list, gtk_obj);
- Py_DECREF(gtk_obj);
- }
- return py_list;
-}
-%%
-override gtk_menu_tool_button_new kwargs
-static int
-_wrap_gtk_menu_tool_button_new(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist1[] = { "stock_id", NULL };
- static char *kwlist2[] = { "icon_widget", "label", NULL };
- gchar *stock_id, *label;
- PyObject *py_icon_widget;
- GtkWidget *icon_widget = NULL;
-
- if (PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:GtkMenuToolButton.__init__",
- kwlist1, &stock_id))
- pygobject_construct(self, "stock-id", stock_id, NULL);
- else {
- PyErr_Clear();
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oz:GtkFileChooserButton.__init__",
- kwlist2, &py_icon_widget, &label)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "Usage: one of:\n"
- " gtk.MenuToolButton(stock_id)\n"
- " gtk.MenuToolButton(icon_widget, label)");
- return -1;
- }
- if (py_icon_widget != Py_None) {
- if (pygobject_check(py_icon_widget, &PyGtkWidget_Type)) {
- icon_widget = GTK_WIDGET(pygobject_get(py_icon_widget));
- } else {
- PyErr_SetString(PyExc_TypeError,
- "icon_widget must be a GtkWidget type or None");
- return -1;
- }
- }
- pygobject_construct(self, "icon-widget", icon_widget,
- "label", label, NULL);
- }
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkMenuToolButton object");
- return -1;
- }
- return 0;
-}
-%%
-new-constructor GTK_TYPE_MENU_TOOL_BUTTON
diff --git a/gtk/gtktreeview.override b/gtk/gtktreeview.override
deleted file mode 100644
index 2207c3d4..00000000
--- a/gtk/gtktreeview.override
+++ /dev/null
@@ -1,3322 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gtktreeview.override: overrides for the gtk.TreeView object.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-headers
-#include "pygtktreemodel.h"
-#include "pygtkcellrenderer.h"
-
-static void
-pygtk_cell_data_func_marshal (GtkCellLayout *cell_layout,
- GtkCellRenderer *cell,
- GtkTreeModel *tree_model,
- GtkTreeIter *iter,
- gpointer data);
-
-%%
-init
- PyGtkListStore_Type.tp_as_number = PyGtkTreeModel_Type.tp_as_number;
- PyGtkListStore_Type.tp_as_mapping = PyGtkTreeModel_Type.tp_as_mapping;
- PyGtkListStore_Type.tp_iter = PyGtkTreeModel_Type.tp_iter;
- PyGtkTreeStore_Type.tp_as_number = PyGtkTreeModel_Type.tp_as_number;
- PyGtkTreeStore_Type.tp_as_mapping = PyGtkTreeModel_Type.tp_as_mapping;
- PyGtkTreeStore_Type.tp_iter = PyGtkTreeModel_Type.tp_iter;
- PyPyGtkGenericTreeModel_Type.tp_as_number = PyGtkTreeModel_Type.tp_as_number;
- PyPyGtkGenericTreeModel_Type.tp_as_mapping = PyGtkTreeModel_Type.tp_as_mapping;
- PyPyGtkGenericTreeModel_Type.tp_iter = PyGtkTreeModel_Type.tp_iter;
- PyGtkTreeModelSort_Type.tp_as_number = PyGtkTreeModel_Type.tp_as_number;
- PyGtkTreeModelSort_Type.tp_as_mapping = PyGtkTreeModel_Type.tp_as_mapping;
- PyGtkTreeModelSort_Type.tp_iter = PyGtkTreeModel_Type.tp_iter;
- PyGtkTreeModelFilter_Type.tp_as_number = PyGtkTreeModel_Type.tp_as_number;
- PyGtkTreeModelFilter_Type.tp_as_mapping = PyGtkTreeModel_Type.tp_as_mapping;
- PyGtkTreeModelFilter_Type.tp_iter = PyGtkTreeModel_Type.tp_iter;
-%%
-ignore-glob
- gtk_tree_path_*
-%%
-ignore
- gtk_tree_view_new
- gtk_tree_model_get_valist
- gtk_tree_row_reference_new_proxy
- gtk_tree_row_reference_inserted
- gtk_tree_row_reference_deleted
- gtk_tree_row_reference_reordered
- gtk_tree_view_column_set_cell_data_func
- gtk_tree_view_column_pack_start
- gtk_tree_view_column_pack_end
- gtk_tree_view_column_clear
- gtk_tree_view_column_set_attributes
- gtk_tree_view_get_row_separator_func
- gtk_tree_view_get_search_equal_func
- gtk_tree_view_get_search_position_func
- gtk_list_store_insert_with_values
- gtk_list_store_insert_with_valuesv
- gtk_tree_store_insert_with_values
- gtk_tree_store_insert_with_valuesv
-%%
-override gtk_tree_view_column_new kwargs
-static int
-_wrap_gtk_tree_view_column_new(PyGObject *self, PyObject*args, PyObject*kwargs)
-{
- PyObject *py_cell = NULL, *key, *item;
- GtkTreeViewColumn *tvc;
- gchar *title = NULL;
- GtkCellRenderer *cell = NULL;
- Py_ssize_t i = 0;
-
- if (!PyArg_ParseTuple(args, "|zO:GtkTreeViewColumn.__init__", &title,
- &py_cell))
- return -1;
- if (py_cell != NULL) {
- if (pygobject_check(py_cell, &PyGtkCellRenderer_Type))
- cell = GTK_CELL_RENDERER(pygobject_get(py_cell));
- else if (py_cell != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "cell must be a GtkCellRenderer or None");
- return -1;
- }
- }
- tvc = GTK_TREE_VIEW_COLUMN(
- g_object_new(pyg_type_from_object((PyObject *) self), NULL));
-
- if (title)
- gtk_tree_view_column_set_title(tvc, title);
- if (cell)
- gtk_tree_view_column_pack_start(tvc, cell, TRUE);
- if (kwargs) {
- while (PyDict_Next(kwargs, &i, &key, &item)) {
- gchar *attr = PyString_AsString(key);
-
- if (!PyInt_Check(item)) {
- gchar err[128];
- g_snprintf(err, sizeof(err),
- "%s must be an integer column number", attr);
- PyErr_SetString(PyExc_TypeError, err);
- g_object_unref(tvc);
- return -1;
- }
- gtk_tree_view_column_add_attribute(tvc, cell, attr,
- PyInt_AsLong(item));
- }
- }
- self->obj = (GObject *)tvc;
- pygobject_register_wrapper((PyObject *)self);
- return 0;
-}
-%%
-override gtk_tree_view_column_cell_get_size kwargs
-static PyObject *
-_wrap_gtk_tree_view_column_cell_get_size(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "cell_area", NULL };
- PyObject *py_cell_area = Py_None;
- GdkRectangle cell_area = { 0, 0, 0, 0};
- gint x_offset = 0, y_offset = 0, width, height;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|O:GtkTreeViewColumn.cell_get_size",
- kwlist, &py_cell_area))
- return NULL;
-
- if (py_cell_area != Py_None) {
- if (!pygdk_rectangle_from_pyobject(py_cell_area, &cell_area))
- return NULL;
- }
-
- gtk_tree_view_column_cell_get_size(GTK_TREE_VIEW_COLUMN(self->obj),
- (py_cell_area == Py_None) ? NULL : &cell_area,
- &x_offset, &y_offset, &width, &height);
-
- return Py_BuildValue("(Niiii)",
- pyg_boxed_new(GDK_TYPE_RECTANGLE,
- &cell_area, TRUE, TRUE),
- x_offset, y_offset, width, height);
-}
-%%
-override gtk_tree_view_column_get_cell_renderers noargs
-static PyObject *
-_wrap_gtk_tree_view_column_get_cell_renderers(PyGObject *self)
-{
- GList *list, *tmp;
- PyObject *ret;
-
- list = gtk_tree_view_column_get_cell_renderers(
- GTK_TREE_VIEW_COLUMN(self->obj));
-
- ret = PyList_New(0);
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- GtkWidget *renderer = tmp->data;
- PyObject *item = pygobject_new((GObject *)renderer);
-
- PyList_Append(ret, item);
- Py_DECREF(item);
- }
- g_list_free(list);
- return ret;
-}
-%%
-override gtk_cell_layout_set_cell_data_func kwargs
-static void
-pygtk_cell_data_func_marshal (GtkCellLayout *cell_layout,
- GtkCellRenderer *cell,
- GtkTreeModel *tree_model,
- GtkTreeIter *iter, gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *retobj;
- PyObject *pycelllayout, *pycell, *pytreemodel, *pyiter;
-
- g_assert (cunote->func);
-
- state = pyg_gil_state_ensure();
-
- pycelllayout = pygobject_new((GObject *)cell_layout);
- pycell = pygobject_new((GObject *)cell);
- pytreemodel = pygobject_new((GObject *)tree_model);
- pyiter = pyg_boxed_new(GTK_TYPE_TREE_ITER, iter,
- FALSE, FALSE);
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NNNNO)",
- pycelllayout, pycell,
- pytreemodel, pyiter, cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(NNNN)",
- pycelllayout, pycell,
- pytreemodel, pyiter);
-
- if (retobj == NULL) {
- PyErr_Print();
- } else
- Py_DECREF(retobj);
-
- pyg_gil_state_release(state);
-}
-
-static PyObject *
-_wrap_gtk_cell_layout_set_cell_data_func (PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- PyObject *pycell, *pyfunc, *pyarg = NULL;
- GtkCellRenderer *cell;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTuple(args, "OO|O:GtkCellLayout.set_cell_data_func",
- &pycell, &pyfunc, &pyarg))
- return NULL;
-
- if (pygobject_check(pycell, &PyGtkCellRenderer_Type))
- cell = GTK_CELL_RENDERER(pygobject_get(pycell));
- else {
- PyErr_SetString(PyExc_TypeError,
- "first argument must be a GtkCellRenderer");
- return NULL;
- }
-
- if (pyfunc == Py_None) {
- gtk_cell_layout_set_cell_data_func(GTK_CELL_LAYOUT(self->obj), cell,
- NULL, NULL, NULL);
- } else {
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_cell_layout_set_cell_data_func(GTK_CELL_LAYOUT(self->obj), cell,
- pygtk_cell_data_func_marshal,
- cunote,
- pygtk_custom_destroy_notify);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_view_insert_column_with_data_func kwargs
-static PyObject *
-_wrap_gtk_tree_view_insert_column_with_data_func (PyGObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- int position;
- gchar *title;
- PyObject *pycell,*pyfunc, *pyarg = NULL;
- GtkCellRenderer *cell;
- PyGtkCustomNotify *cunote;
- gint retval;
-
- if (!PyArg_ParseTuple(args,
- "isOO|O:GtkTreeView.insert_column_with_data_func",
- &position, &title, &pycell, &pyfunc, &pyarg))
- return NULL;
-
- if (pygobject_check(pycell, &PyGtkCellRenderer_Type))
- cell = GTK_CELL_RENDERER(pygobject_get(pycell));
- else {
- PyErr_SetString(PyExc_TypeError,
- "first argument must be a GtkCellRenderer");
- return NULL;
- }
-
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- retval = gtk_tree_view_insert_column_with_data_func (
- GTK_TREE_VIEW (self->obj),
- position,
- title,
- cell,
- (GtkTreeCellDataFunc)pygtk_cell_data_func_marshal,
- cunote,
- pygtk_custom_destroy_notify);
- return PyInt_FromLong(retval);
-}
-%%
-override gtk_tree_view_get_path_at_pos kwargs
-static PyObject *
-_wrap_gtk_tree_view_get_path_at_pos(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "x", "y", NULL };
- gint x, y;
- GtkTreePath *path;
- GtkTreeViewColumn *column;
- gint cell_x, cell_y;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "ii:GtkTreeView.get_path_at_pos",
- kwlist, &x, &y))
- return NULL;
- if (gtk_tree_view_get_path_at_pos(GTK_TREE_VIEW(self->obj), x, y,
- &path, &column, &cell_x, &cell_y)) {
- PyObject *ret = PyTuple_New(4);
-
- if (path) {
- PyTuple_SetItem(ret, 0, pygtk_tree_path_to_pyobject(path));
- gtk_tree_path_free(path);
- } else {
- Py_INCREF(Py_None);
- PyTuple_SetItem(ret, 0, Py_None);
- }
- PyTuple_SetItem(ret, 1, pygobject_new((GObject *)column));
- PyTuple_SetItem(ret, 2, PyInt_FromLong(cell_x));
- PyTuple_SetItem(ret, 3, PyInt_FromLong(cell_y));
- return ret;
- } else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override gtk_tree_view_insert_column_with_attributes kwargs
-static PyObject *
-_wrap_gtk_tree_view_insert_column_with_attributes(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- gint position, columns, real_position;
- GtkTreeViewColumn *column;
- GtkCellRenderer *cell;
- PyObject *py_cell, *key, *item;
- const char *title;
- Py_ssize_t i = 0;
-
- if (!PyArg_ParseTuple(args,
- "isO!:GtkTreeView.insert_column_with_attributes",
- &position, &title, &PyGtkCellRenderer_Type, &py_cell))
- return NULL;
-
- cell = GTK_CELL_RENDERER(pygobject_get(py_cell));
-
- columns =
- gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW(self->obj),
- position, title, cell,
- NULL);
- if (position == -1) {
- real_position = columns - 1;
- } else {
- real_position = position;
- }
-
- column = gtk_tree_view_get_column (GTK_TREE_VIEW(self->obj),
- real_position);
-
- if (kwargs) {
- while (PyDict_Next(kwargs, &i, &key, &item)) {
- gchar *attr = PyString_AsString(key);
-
- if (!PyInt_Check(item)) {
- gchar err[128];
- g_snprintf(err, sizeof(err),
- "%s must be an integer column number", attr);
- PyErr_SetString(PyExc_TypeError, err);
- return NULL;
- }
- gtk_tree_view_column_add_attribute(column, cell, attr,
- PyInt_AsLong(item));
- }
- }
- return pygobject_new ((GObject *) column);
-}
-%%
-override gtk_tree_view_get_visible_rect noargs
-static PyObject *
-_wrap_gtk_tree_view_get_visible_rect(PyGObject *self)
-{
- GdkRectangle visible_rect;
-
- gtk_tree_view_get_visible_rect(GTK_TREE_VIEW(self->obj), &visible_rect);
-
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &visible_rect, TRUE, TRUE);
-}
-%%
-override gtk_tree_view_get_cell_area kwargs
-static PyObject *
-_wrap_gtk_tree_view_get_cell_area(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "path", "column", NULL };
- PyObject *py_path;
- PyGObject *column;
- GdkRectangle rect;
- GtkTreePath *path;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OO!:GtkTreeView.get_cell_area", kwlist, &py_path, &PyGtkTreeViewColumn_Type, &column))
- return NULL;
- path = pygtk_tree_path_from_pyobject(py_path);
- if (!path) {
- PyErr_SetString(PyExc_TypeError, "could not convert path to a GtkTreePath");
- return NULL;
- }
- gtk_tree_view_get_cell_area(GTK_TREE_VIEW(self->obj), path, GTK_TREE_VIEW_COLUMN(column->obj), &rect);
- if (path)
- gtk_tree_path_free(path);
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &rect, TRUE, TRUE);
-}
-%%
-override gtk_tree_view_get_background_area kwargs
-static PyObject *
-_wrap_gtk_tree_view_get_background_area(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "path", "column", NULL };
- PyObject *py_path;
- PyGObject *column;
- GdkRectangle rect;
- GtkTreePath *path;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OO!:GtkTreeView.get_background_area", kwlist, &py_path, &PyGtkTreeViewColumn_Type, &column))
- return NULL;
- path = pygtk_tree_path_from_pyobject(py_path);
- if (!path) {
- PyErr_SetString(PyExc_TypeError, "could not convert path to a GtkTreePath");
- return NULL;
- }
- gtk_tree_view_get_background_area(GTK_TREE_VIEW(self->obj), path, GTK_TREE_VIEW_COLUMN(column->obj), &rect);
- if (path)
- gtk_tree_path_free(path);
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &rect, TRUE, TRUE);
-}
-%%
-override gtk_tree_view_widget_to_tree_coords args
-static PyObject *
-_wrap_gtk_tree_view_widget_to_tree_coords(PyGObject *self, PyObject *args)
-{
- gint wx, wy, tx, ty;
-
- if (!PyArg_ParseTuple(args, "ii:GtkTreeView.widget_to_tree_coords",
- &wx, &wy)) {
- return NULL;
- }
-
- gtk_tree_view_widget_to_tree_coords(GTK_TREE_VIEW(self->obj), wx, wy, &tx, &ty);
-
- return Py_BuildValue("(ii)", tx, ty);
-}
-%%
-override gtk_tree_view_tree_to_widget_coords args
-static PyObject *
-_wrap_gtk_tree_view_tree_to_widget_coords(PyGObject *self, PyObject *args)
-{
- gint tx, ty, wx, wy;
-
- if (!PyArg_ParseTuple(args, "ii:GtkTreeView.tree_to_widget_coords",
- &tx, &ty)) {
- return NULL;
- }
-
- gtk_tree_view_tree_to_widget_coords(GTK_TREE_VIEW(self->obj), tx, ty, &wx, &wy);
-
- return Py_BuildValue("(ii)", wx, wy);
-}
-%%
-override gtk_tree_view_get_cursor noargs
-static PyObject *
-_wrap_gtk_tree_view_get_cursor(PyGObject *self)
-{
- PyObject *py_path;
- PyObject *py_column;
- GtkTreePath *path;
- GtkTreeViewColumn *column;
-
- gtk_tree_view_get_cursor(GTK_TREE_VIEW(self->obj),
- &path, &column);
-
- if (path != NULL) {
- py_path = pygtk_tree_path_to_pyobject(path);
- } else {
- Py_INCREF(Py_None);
- py_path = Py_None;
- }
-
- if (column != NULL) {
- py_column = pygobject_new((GObject*)column);
- } else {
- Py_INCREF(Py_None);
- py_column = Py_None;
- }
-
- return Py_BuildValue("(NN)", py_path, py_column);
-}
-%%
-override gtk_tree_view_get_columns noargs
-static PyObject *
-_wrap_gtk_tree_view_get_columns(PyGObject *self)
-{
- GList *list, *tmp;
- PyObject *py_list;
-
- list = gtk_tree_view_get_columns(GTK_TREE_VIEW(self->obj));
-
- if ((py_list = PyList_New(0)) == NULL) {
- g_list_free(list);
- return NULL;
- }
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- PyObject *gtk_obj = pygobject_new(G_OBJECT(tmp->data));
-
- if (gtk_obj == NULL) {
- g_list_free(list);
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_Append(py_list, gtk_obj);
- Py_DECREF(gtk_obj);
- }
- g_list_free(list);
- return py_list;
-}
-%%
-override gtk_tree_selection_get_selected noargs
-static PyObject *
-_wrap_gtk_tree_selection_get_selected(PyGObject *self)
-{
- GtkTreeModel *model;
- GtkTreeIter iter;
- GtkSelectionMode mode;
-
- mode = gtk_tree_selection_get_mode(GTK_TREE_SELECTION(self->obj));
- if (mode == GTK_SELECTION_MULTIPLE) {
- PyErr_SetString(PyExc_TypeError,
- "GtkTreeSelection.get_selected can not be used when"
- " selection mode is gtk.SELECTION_MULTIPLE");
- return NULL;
- }
-
- if (gtk_tree_selection_get_selected(GTK_TREE_SELECTION(self->obj),
- &model, &iter)) {
- return Py_BuildValue("(NN)",
- pygobject_new((GObject *)model),
- pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter,
- TRUE, TRUE));
- } else {
- return Py_BuildValue ("(NO)",
- pygobject_new((GObject *)model),
- Py_None);
- }
-}
-%%
-override gtk_tree_selection_get_selected_rows noargs
-static PyObject *
-_wrap_gtk_tree_selection_get_selected_rows(PyGObject *self)
-{
- GtkTreeModel *model = NULL;
- GList *selected, *tmp;
- PyObject *py_selected;
-
- selected = gtk_tree_selection_get_selected_rows
- (GTK_TREE_SELECTION(self->obj), &model);
- py_selected = PyList_New(0);
- for (tmp = selected; tmp != NULL; tmp = tmp->next) {
- GtkTreePath *path = tmp->data;
- PyObject *item = pygtk_tree_path_to_pyobject(path);
-
- PyList_Append(py_selected, item);
- Py_DECREF(item);
- gtk_tree_path_free(path);
- }
- g_list_free(selected);
- return Py_BuildValue("(NN)", pygobject_new((GObject *)model), py_selected);
-}
-%%
-override gtk_tree_selection_selected_foreach
-
-static void
-pygtk_tree_selection_foreach_marshal(GtkTreeModel *model,
- GtkTreePath *path,
- GtkTreeIter *iter,
- gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *py_model, *py_path, *py_iter, *retobj;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_model = pygobject_new((GObject *)model);
- py_path = pygtk_tree_path_to_pyobject(path);
- py_iter = pyg_boxed_new(GTK_TYPE_TREE_ITER, iter, FALSE, FALSE);
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NNOO)",
- py_model, py_path, py_iter,
- cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(NNO)",
- py_model, py_path, py_iter);
-
- if (retobj == NULL) {
- PyErr_Print();
- }
- pygtk_boxed_unref_shared(py_iter);
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_tree_selection_selected_foreach(PyGObject *self, PyObject *args)
-{
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify cunote;
-
- if(!PyArg_ParseTuple(args, "O|O:GtkTreeSelection.selected_foreach",
- &pyfunc, &pyarg))
- return NULL;
-
- cunote.func = pyfunc;
- cunote.data = pyarg;
- gtk_tree_selection_selected_foreach(GTK_TREE_SELECTION(self->obj),
- pygtk_tree_selection_foreach_marshal,
- &cunote);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_selection_set_select_function kwargs
-static gboolean
-pygtk_tree_selection_marshal(GtkTreeSelection *selection,
- GtkTreeModel *model,
- GtkTreePath *path,
- gboolean path_currently_selected,
- gpointer data)
-{
- PyGILState_STATE state;
- gboolean retval = FALSE;
- PyGtkCustomNotify *cunote = data;
- PyObject *pypath, *retobj;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- pypath = pygtk_tree_path_to_pyobject(path);
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NO)", pypath,
- cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(N)", pypath);
-
- if (retobj == NULL) {
- PyErr_Print();
- }
-
- Py_DECREF(pypath);
- if (retobj) {
- if(retobj == Py_None);
- else if(PyInt_Check(retobj))
- retval = PyInt_AsLong(retobj) && TRUE;
- else if(PyLong_Check(retobj))
- retval = PyLong_AsLongLong(retobj) && TRUE;
- else if(PyString_Check(retobj))
- retval = PyString_GET_SIZE(retobj) && TRUE;
-
- Py_DECREF(retobj);
- }
-
-
- pyg_gil_state_release(state);
-
- return retval;
-}
-static gboolean
-pygtk_tree_selection_marshal_full(GtkTreeSelection *selection,
- GtkTreeModel *model,
- GtkTreePath *path,
- gboolean path_currently_selected,
- gpointer data)
-{
- PyGILState_STATE state;
- gboolean retval = FALSE;
- PyGtkCustomNotify *cunote = data;
- PyObject *pyselection, *pymodel, *pypath, *retobj;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- pyselection = pygobject_new((GObject*)selection);
- pymodel = pygobject_new((GObject*)model);
- pypath = pygtk_tree_path_to_pyobject(path);
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NNNNO)", pyselection,
- pymodel, pypath,
- PyBool_FromLong(path_currently_selected),
- cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(NNNN)", pyselection,
- pymodel, pypath,
- PyBool_FromLong(path_currently_selected));
-
- if (retobj == NULL) {
- PyErr_Print();
- }
-
- Py_DECREF(pypath);
- if (retobj) {
- if(retobj == Py_None);
- else if(PyInt_Check(retobj))
- retval = PyInt_AsLong(retobj) && TRUE;
- else if(PyLong_Check(retobj))
- retval = PyLong_AsLongLong(retobj) && TRUE;
- else if(PyString_Check(retobj))
- retval = PyString_GET_SIZE(retobj) && TRUE;
-
- Py_DECREF(retobj);
- }
-
-
- pyg_gil_state_release(state);
-
- return retval;
-}
-static PyObject *
-_wrap_gtk_tree_selection_set_select_function(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", "full", NULL };
- PyObject *pyfunc, *pyarg = NULL, *pyfull = Py_False;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|OO:GtkTreeSelection.set_select_function",
- kwlist, &pyfunc, &pyarg, &pyfull))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- }
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
- if (PyObject_IsTrue(pyfull))
- gtk_tree_selection_set_select_function(GTK_TREE_SELECTION(self->obj),
- pygtk_tree_selection_marshal_full,
- cunote,
- pygtk_custom_destroy_notify);
- else
- gtk_tree_selection_set_select_function(GTK_TREE_SELECTION(self->obj),
- pygtk_tree_selection_marshal,
- cunote,
- pygtk_custom_destroy_notify);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_get_row_drag_data noargs
-static PyObject *
-_wrap_gtk_tree_get_row_drag_data(PyObject *self)
-{
- GtkTreeModel *tree_model;
- GtkTreePath *path;
-
- if (gtk_tree_get_row_drag_data(pyg_boxed_get(self, GtkSelectionData),
- &tree_model, &path)) {
- PyObject *ret = Py_BuildValue("(NN)",
- pygobject_new((GObject *)tree_model),
- pygtk_tree_path_to_pyobject(path));
-
- gtk_tree_path_free(path);
- return ret;
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_model_get_iter kwargs
-static PyObject *
-_wrap_gtk_tree_model_get_iter(PyGObject *self, PyObject *args,PyObject *kwargs)
-{
- static char *kwlist[] = { "path", NULL };
- PyObject *py_path;
- GtkTreeIter iter;
- GtkTreePath *path;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GtkTreeModel.get_iter",
- kwlist, &py_path))
- return NULL;
-
- path = pygtk_tree_path_from_pyobject(py_path);
- if (!path) {
- PyErr_SetString(PyExc_TypeError, "GtkTreeModel.get_iter requires a tree path as its argument");
- return NULL;
- }
- if (gtk_tree_model_get_iter(GTK_TREE_MODEL(self->obj), &iter, path)) {
- gtk_tree_path_free(path);
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
- } else {
- gtk_tree_path_free(path);
- PyErr_SetString(PyExc_ValueError, "invalid tree path");
- return NULL;
- }
-}
-%%
-override gtk_tree_model_get_iter_from_string kwargs
-static PyObject *
-_wrap_gtk_tree_model_get_iter_from_string(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "path_string", NULL };
- const gchar *path_string;
- GtkTreeIter iter;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:GtkTreeModel.get_iter_from_string",
- kwlist, &path_string))
- return NULL;
-
- if (gtk_tree_model_get_iter_from_string(GTK_TREE_MODEL(self->obj), &iter,
- path_string)) {
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
- } else {
- PyErr_SetString(PyExc_ValueError, "invalid tree path");
- return NULL;
- }
-}
-%%
-override gtk_tree_model_get_value kwargs
-static PyObject *
-_wrap_gtk_tree_model_get_value(PyGObject *self, PyObject*args, PyObject*kwargs)
-{
- static char *kwlist[] = { "iter", "column", NULL };
- PyObject *iter, *ret;
- gint column;
- GValue value = { 0, };
-
- if (!PyArg_ParseTupleAndKeywords(args,kwargs, "Oi:GtkTreeModel.get_value",
- kwlist, &iter, &column))
- return NULL;
- if (column < 0 ||
- column >= gtk_tree_model_get_n_columns(GTK_TREE_MODEL(self->obj))) {
- PyErr_SetString(PyExc_ValueError, "column number is out of range");
- return NULL;
- }
- if (!pyg_boxed_check(iter, GTK_TYPE_TREE_ITER)) {
- PyErr_SetString(PyExc_TypeError, "iter must be a GtkTreeIter");
- return NULL;
- }
- gtk_tree_model_get_value(GTK_TREE_MODEL(self->obj),
- pyg_boxed_get(iter, GtkTreeIter), column, &value);
- ret = pyg_value_as_pyobject(&value, TRUE);
- g_value_unset(&value);
- return ret;
-}
-%%
-override gtk_tree_model_rows_reordered kwargs
-static PyObject *
-_wrap_gtk_tree_model_rows_reordered(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "path", "iter", "new_order", NULL };
- PyObject *py_path, *py_iter, *py_new_order, *sitem;
- GtkTreeIter *iter = NULL;
- GtkTreePath *path;
- gint *new_order;
- gint len_model, len_seq;
- gint i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOO:GtkTreeModel.rows_reordered", kwlist,
- &py_path, &py_iter, &py_new_order))
- return NULL;
-
- if (py_path == Py_None ||
- (PyTuple_Check(py_path) && PyTuple_Size(py_path) == 0) ||
- (PyString_Check(py_path) && PyString_Size(py_path) == 0))
- path = gtk_tree_path_new();
- else
- path = pygtk_tree_path_from_pyobject(py_path);
- if (!path) {
- PyErr_SetString(PyExc_TypeError,
- "could not convert path to a GtkTreePath");
- return NULL;
- }
-
- if (py_iter == Py_None)
- iter = NULL;
- else if (pyg_boxed_check(py_iter, GTK_TYPE_TREE_ITER))
- iter = pyg_boxed_get(py_iter, GtkTreeIter);
- else {
- PyErr_SetString(PyExc_TypeError, "iter should be a GtkTreeIter");
- gtk_tree_path_free(path);
- return NULL;
- }
-
- if (!PySequence_Check(py_new_order)) {
- PyErr_SetString(PyExc_TypeError,
- "new_order must be a sequence of ints");
- gtk_tree_path_free(path);
- return NULL;
- }
-
- len_model = gtk_tree_model_iter_n_children(GTK_TREE_MODEL(self->obj), iter);
- len_seq = PySequence_Size(py_new_order);
- if (len_model != len_seq) {
- PyErr_Format(PyExc_ValueError,
- "new_order should be a sequence with the same size as the "
- "number of children of iter (%d, is %d)", len_model, len_seq);
- gtk_tree_path_free(path);
- return NULL;
- }
-
- // Create on stack: much faster, no free() needed.
- new_order = g_newa(gint, len_seq);
- for (i = 0; i < len_seq; i++) {
- sitem = PySequence_GetItem(py_new_order, i);
- Py_DECREF(sitem);
- sitem = PyNumber_Int(sitem);
- if (sitem)
- new_order[i] = (gint) PyInt_AsLong(sitem);
- else {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "new_order sequence item not an int");
- gtk_tree_path_free(path);
- return NULL;
- }
- Py_DECREF(sitem);
- }
-
- gtk_tree_model_rows_reordered(GTK_TREE_MODEL(self->obj),
- path, iter, new_order);
- gtk_tree_path_free(path);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override-slot GtkTreeModel.tp_as_number
-static int
-_wrap_gtk_tree_model_tp_nonzero(PyGObject *self)
-{
- return TRUE;
-}
-static PyNumberMethods _wrap_gtk_tree_model_tp_as_number = {
- (binaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (ternaryfunc)0,
- (unaryfunc)0,
- (unaryfunc)0,
- (unaryfunc)0,
- (inquiry)_wrap_gtk_tree_model_tp_nonzero,
- (unaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (binaryfunc)0,
- (coercion)0,
- (unaryfunc)0,
- (unaryfunc)0,
- (unaryfunc)0,
- (unaryfunc)0,
- (unaryfunc)0
-};
-%%
-override-slot GtkTreeModel.tp_as_mapping
-static Py_ssize_t
-_wrap_gtk_tree_model_tp_length(PyGObject *self)
-{
- return gtk_tree_model_iter_n_children(GTK_TREE_MODEL(self->obj), NULL);
-}
-static PyObject *
-_wrap_gtk_tree_model_tp_getitem(PyGObject *self, PyObject *item)
-{
- GtkTreePath *path;
- GtkTreeIter iter;
- PyObject *ret = NULL;
-
- if (pyg_boxed_check(item, GTK_TYPE_TREE_ITER)) {
- return _pygtk_tree_model_row_new(GTK_TREE_MODEL(self->obj),
- pyg_boxed_get(item, GtkTreeIter));
- }
-
- if (PyInt_Check(item)) {
- int value = PyInt_AsLong(item);
-
- if (value < 0) {
- /* Since value is always negative at this point,
- * we need to do an invertion.
- */
- value = _wrap_gtk_tree_model_tp_length(self) - -value;
-
- Py_DECREF(item);
- item = PyInt_FromLong(value);
- }
- }
-
- path = pygtk_tree_path_from_pyobject(item);
- if (!path) {
- PyErr_SetString(PyExc_TypeError,
- "could not parse subscript as a tree path");
- return NULL;
- }
- if (gtk_tree_model_get_iter(GTK_TREE_MODEL(self->obj), &iter, path)) {
- ret = _pygtk_tree_model_row_new(GTK_TREE_MODEL(self->obj), &iter);
- } else {
- PyErr_SetString(PyExc_IndexError, "could not find tree path");
- ret = NULL;
- }
- gtk_tree_path_free(path);
- return ret;
-}
-static int
-_wrap_gtk_tree_model_tp_setitem(PyGObject *self, PyObject *item,
- PyObject *value)
-{
- GtkTreeIter *iter, iter2;
-
- if (pyg_boxed_check(item, GTK_TYPE_TREE_ITER)) {
- iter = pyg_boxed_get(item, GtkTreeIter);
- } else {
- GtkTreePath *path;
-
- if (PyInt_Check(item)) {
- int value = PyInt_AsLong(item);
-
- if (value < 0) {
- /* Since value is always negative at this point,
- * we need to do an invertion.
- */
- value = _wrap_gtk_tree_model_tp_length(self) - -value;
-
- Py_DECREF(item);
- item = PyInt_FromLong(value);
- }
- }
-
- path = pygtk_tree_path_from_pyobject(item);
-
- if (!path) {
- PyErr_SetString(PyExc_TypeError,
- "could not parse subscript as a tree path");
- return -1;
- }
- if (!gtk_tree_model_get_iter(GTK_TREE_MODEL(self->obj), &iter2,path)) {
- PyErr_SetString(PyExc_TypeError, "could not find tree path");
- gtk_tree_path_free(path);
- return -1;
- }
- iter = &iter2;
- gtk_tree_path_free(path);
- }
-
- if (value == NULL) {
- return _pygtk_tree_model_remove_row(GTK_TREE_MODEL(self->obj), iter);
- } else {
- return _pygtk_tree_model_set_row(GTK_TREE_MODEL(self->obj),
- iter, value);
- }
-}
-
-static PyMappingMethods _wrap_gtk_tree_model_tp_as_mapping = {
- (lenfunc)_wrap_gtk_tree_model_tp_length,
- (binaryfunc)_wrap_gtk_tree_model_tp_getitem,
- (objobjargproc)_wrap_gtk_tree_model_tp_setitem
-};
-%%
-override-slot GtkTreeModel.tp_iter
-static PyObject *
-_wrap_gtk_tree_model_tp_iter(PyGObject *self)
-{
- return _pygtk_tree_model_row_iter_new(GTK_TREE_MODEL(self->obj), NULL);
-}
-%%
-override gtk_tree_sortable_get_sort_column_id noargs
-static PyObject *
-_wrap_gtk_tree_sortable_get_sort_column_id(PyGObject *self)
-{
- gboolean ret;
- gint sort_column_id;
- GtkSortType order;
-
- ret = gtk_tree_sortable_get_sort_column_id(GTK_TREE_SORTABLE(self->obj),
- &sort_column_id, &order);
-
- /* if we don't have a sort column set, return (None, None) */
- if (ret)
- return Py_BuildValue("(iN)", sort_column_id,
- pyg_enum_from_gtype(GTK_TYPE_SORT_TYPE, order));
- else
- return Py_BuildValue("(OO)", Py_None, Py_None);
-}
-%%
-override gtk_tree_sortable_set_sort_func
-static gint
-pygtk_tree_sortable_sort_cb(GtkTreeModel *model, GtkTreeIter *iter1,
- GtkTreeIter *iter2, gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *py_model, *py_iter2, *py_iter1, *retobj;
- gint ret = 0;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_model = pygobject_new((GObject *)model);
- py_iter1 = pyg_boxed_new(GTK_TYPE_TREE_ITER, iter1, FALSE, FALSE);
- py_iter2 = pyg_boxed_new(GTK_TYPE_TREE_ITER, iter2, FALSE, FALSE);
-
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(OOOO)", py_model,
- py_iter1, py_iter2, cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(OOO)", py_model,
- py_iter1, py_iter2);
- }
- pygtk_boxed_unref_shared(py_iter1);
- pygtk_boxed_unref_shared(py_iter2);
- if (retobj)
- ret = PyInt_AsLong(retobj);
- if (PyErr_Occurred()) {
- PyErr_Print();
- ret = 0;
- }
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_tree_sortable_set_sort_func(PyGObject *self, PyObject *args)
-{
- gint column;
- PyObject *callback, *data = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTuple(args, "iO|O:GtkTreeSortable.set_sort_func",
- &column, &callback, &data))
- return NULL;
-
- if (!PyCallable_Check(callback)) {
- PyErr_SetString(PyExc_TypeError, "callback must be a callable object");
- return NULL;
- }
- cunote = g_new(PyGtkCustomNotify, 1);
- Py_INCREF(callback);
- cunote->func = callback;
- Py_XINCREF(data);
- cunote->data = data;
-
- gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(self->obj), column,
- pygtk_tree_sortable_sort_cb, cunote,
- pygtk_custom_destroy_notify);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_sortable_set_default_sort_func
-static PyObject *
-_wrap_gtk_tree_sortable_set_default_sort_func(PyGObject *self, PyObject *args)
-{
- PyObject *callback, *data = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTuple(args, "O|O:GtkTreeSortable.set_default_sort_func",
- &callback, &data))
- return NULL;
-
- if (callback == Py_None) {
- gtk_tree_sortable_set_default_sort_func(GTK_TREE_SORTABLE(self->obj),
- NULL,
- NULL,
- NULL);
- goto beach;
- }
-
- if (!PyCallable_Check(callback)) {
- PyErr_SetString(PyExc_TypeError, "callback must be a callable object");
- return NULL;
- }
- cunote = g_new(PyGtkCustomNotify, 1);
- Py_INCREF(callback);
- cunote->func = callback;
- Py_XINCREF(data);
- cunote->data = data;
-
- gtk_tree_sortable_set_default_sort_func(GTK_TREE_SORTABLE(self->obj),
- pygtk_tree_sortable_sort_cb,
- cunote,
- pygtk_custom_destroy_notify);
- beach:
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-ignore gtk_list_store_newv
-%%
-override gtk_list_store_new
-static int
-_wrap_gtk_list_store_new(PyGObject *self, PyObject *args)
-{
- guint len, i;
- GType *column_types;
-
- len = PyTuple_Size(args);
- if (len == 0) {
- PyErr_SetString(PyExc_TypeError,
- "GtkListStore requires at least one argument");
- return -1;
- }
-
- column_types = g_new(GType, len);
- for (i = 0; i < len; i++) {
- PyObject *item = PyTuple_GetItem(args, i);
-
- column_types[i] = pyg_type_from_object(item);
- if (column_types[i] == 0) {
- g_free(column_types);
- return -1;
- }
- }
- self->obj = g_object_newv(pyg_type_from_object((PyObject *) self), 0, NULL);
- gtk_list_store_set_column_types(GTK_LIST_STORE(self->obj), len, column_types);
- g_free(column_types);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkListStore object");
- return -1;
- }
- pygobject_register_wrapper((PyObject *)self);
- return 0;
-}
-%%
-override gtk_list_store_set_column_types args
-static PyObject*
-_wrap_gtk_list_store_set_column_types(PyGObject *self, PyObject *args)
-{
- guint len, i;
- GType *column_types;
-
- len = PyTuple_Size(args);
- if (len == 0) {
- PyErr_SetString(PyExc_TypeError,
- "GtkListStore set_column_types requires at least one argument");
- return NULL;
- }
-
- column_types = g_new(GType, len);
- for (i = 0; i < len; i++) {
- PyObject *item = PyTuple_GetItem(args, i);
-
- column_types[i] = pyg_type_from_object(item);
- if (column_types[i] == 0) {
- g_free(column_types);
- return NULL;
- }
- }
-
- gtk_list_store_set_column_types(GTK_LIST_STORE(self->obj), len, column_types);
- g_free(column_types);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-ignore gtk_list_store_set_valist
-%%
-override gtk_list_store_set
-static PyObject *
-_wrap_gtk_list_store_set(PyGObject *self, PyObject *args)
-{
- PyObject *iter;
- int len, i;
-
- len = PyTuple_Size(args);
- if (len == 0) {
- PyErr_SetString(PyExc_TypeError, "GtkListStore.set requires at least three arguments");
- return NULL;
- }
-
- iter = PyTuple_GetItem(args, 0);
- if (!pyg_boxed_check(iter, GTK_TYPE_TREE_ITER)) {
- PyErr_SetString(PyExc_TypeError, "iter must be a GtkTreeIter");
- return NULL;
- }
-
- if ((len - 1) % 2) {
- PyErr_SetString(PyExc_TypeError,
- "Argument list must be column, value pairs. No -1 "
- "termination is needed.");
- return NULL;
- }
- for (i = 1; i < len; i+=2) {
- gint column;
- GValue value = { 0 };
- PyObject *py_column = PyTuple_GetItem(args, i);
- PyObject *py_value = PyTuple_GetItem(args, i + 1);
-
- if (!PyInt_Check(py_column)) {
- PyErr_SetString(PyExc_TypeError,
- "Expected numeric argument for column.");
- return NULL;
- }
- column = PyInt_AsLong(py_column);
- if (column < 0 ||
- column >= gtk_tree_model_get_n_columns(GTK_TREE_MODEL(self->obj))) {
- PyErr_SetString(PyExc_ValueError, "column number is out of range");
- return NULL;
- }
- g_value_init(&value,
- gtk_tree_model_get_column_type(GTK_TREE_MODEL(self->obj),
- column));
- if (pyg_value_from_pyobject(&value, py_value)) {
- PyErr_SetString(PyExc_TypeError,
- "value is of the wrong type for this column");
- return NULL;
- }
- gtk_list_store_set_value(GTK_LIST_STORE(self->obj),
- pyg_boxed_get(iter, GtkTreeIter), column, &value);
- g_value_unset(&value);
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_list_store_set_value kwargs
-static PyObject *
-_wrap_gtk_list_store_set_value(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "iter", "column", "value", NULL };
- PyObject *iter, *pyvalue;
- gint column;
- GValue value = { 0 };
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OiO:GtkListStore.set_value",
- kwlist, &iter, &column, &pyvalue))
- return NULL;
- if (column < 0 ||
- column >= gtk_tree_model_get_n_columns(GTK_TREE_MODEL(self->obj))) {
- PyErr_SetString(PyExc_ValueError, "column number is out of range");
- return NULL;
- }
- if (!pyg_boxed_check(iter, GTK_TYPE_TREE_ITER)) {
- PyErr_SetString(PyExc_TypeError, "iter must be a GtkTreeIter");
- return NULL;
- }
- g_value_init(&value,
- gtk_tree_model_get_column_type(GTK_TREE_MODEL(self->obj),
- column));
- if (pyg_value_from_pyobject(&value, pyvalue)) {
- PyErr_SetString(PyExc_TypeError,
- "value is of the wrong type for this column");
- return NULL;
- }
- gtk_list_store_set_value(GTK_LIST_STORE(self->obj),
- pyg_boxed_get(iter, GtkTreeIter), column, &value);
- g_value_unset(&value);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-ignore
- gtk_list_store_setv
-%%
-override gtk_list_store_insert kwargs
-static PyObject *
-_wrap_gtk_list_store_insert(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "position", "row", NULL };
- GtkTreeIter iter;
- gint position;
- PyObject *items = NULL;
- gint n_columns = 0;
- gint *columns = NULL;
- GValue *values = NULL;
- gint i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|O:GtkListStore.insert",
- kwlist, &position, &items)) {
- return NULL;
- }
-
- if (items) {
- if (!PySequence_Check(items)) {
- PyErr_SetString(PyExc_TypeError, "expecting a sequence");
- return NULL;
- }
-
- n_columns = gtk_tree_model_get_n_columns(GTK_TREE_MODEL(self->obj));
- if (PySequence_Length(items) != n_columns) {
- PyErr_SetString(PyExc_ValueError, "row sequence has wrong length");
- return NULL;
- }
- }
-
- columns = g_new0(gint, n_columns);
- values = g_new0(GValue, n_columns);
- for (i = 0; i < n_columns; i++) {
- PyObject *item;
-
- item = PySequence_GetItem(items, i);
- if (!item)
- return NULL;
-
- g_value_init(&values[i], gtk_tree_model_get_column_type(GTK_TREE_MODEL(self->obj), i));
-
- if (pyg_value_from_pyobject(&values[i], item)) {
- Py_DECREF(item);
- PyErr_SetString(PyExc_TypeError,
- "value is of wrong type for this column");
- return NULL;
- }
-
- columns[i] = i;
-
- Py_DECREF(item);
- }
-
- gtk_list_store_insert_with_valuesv(GTK_LIST_STORE(self->obj), &iter, position,
- columns,
- values,
- n_columns);
-
- for (i = 0; i < n_columns; i++) {
- g_value_unset(&values[i]);
- }
- if (values)
- g_free(values);
- if (columns)
- g_free(columns);
-
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_list_store_insert_before kwargs
-static PyObject *
-_wrap_gtk_list_store_insert_before(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "sibling", "row", NULL };
- PyObject *py_sibling;
- GtkTreeIter iter, *sibling = NULL;
- PyObject *row = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkListStore.insert_before",
- kwlist, &py_sibling, &row)) {
- return NULL;
- }
-
- if (pyg_boxed_check(py_sibling, GTK_TYPE_TREE_ITER))
- sibling = pyg_boxed_get(py_sibling, GtkTreeIter);
- else if (py_sibling != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "sibling must be a GtkTreeIter or None");
- return NULL;
- }
- gtk_list_store_insert_before(GTK_LIST_STORE(self->obj), &iter, sibling);
-
- /* optionally set items in the new row */
- if (row != Py_None &&
- _pygtk_tree_model_set_row(GTK_TREE_MODEL(self->obj), &iter, row) < 0)
- return NULL;
-
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_list_store_insert_after kwargs
-static PyObject *
-_wrap_gtk_list_store_insert_after(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "sibling", "row", NULL };
- PyObject *py_sibling;
- GtkTreeIter iter, *sibling = NULL;
- PyObject *row = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkListStore.insert_after",
- kwlist, &py_sibling, &row))
- return NULL;
- if (pyg_boxed_check(py_sibling, GTK_TYPE_TREE_ITER))
- sibling = pyg_boxed_get(py_sibling, GtkTreeIter);
- else if (py_sibling != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "sibling must be a GtkTreeIter or None");
- return NULL;
- }
- gtk_list_store_insert_after(GTK_LIST_STORE(self->obj), &iter, sibling);
-
- /* optionally set items in the new row */
- if (row != Py_None &&
- _pygtk_tree_model_set_row(GTK_TREE_MODEL(self->obj), &iter, row) < 0)
- return NULL;
-
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_list_store_prepend kwargs
-static PyObject *
-_wrap_gtk_list_store_prepend(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "row", NULL };
- GtkTreeIter iter;
- PyObject *row = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O:GtkListStore.prepend",
- kwlist, &row))
- return NULL;
-
- gtk_list_store_prepend(GTK_LIST_STORE(self->obj), &iter);
-
- /* optionally set items in the new row */
- if (row != Py_None &&
- _pygtk_tree_model_set_row(GTK_TREE_MODEL(self->obj), &iter, row) < 0)
- return NULL;
-
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_list_store_append kwargs
-static PyObject *
-_wrap_gtk_list_store_append(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "row", NULL };
- GtkTreeIter iter;
- PyObject *row = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O:GtkListStore.append",
- kwlist, &row))
- return NULL;
-
- gtk_list_store_append(GTK_LIST_STORE(self->obj), &iter);
-
- /* optionally set items in the new row */
- if (row != Py_None &&
- _pygtk_tree_model_set_row(GTK_TREE_MODEL(self->obj), &iter, row) < 0)
- return NULL;
-
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_list_store_reorder args
-static PyObject *
-_wrap_gtk_list_store_reorder(PyGObject *self, PyObject *args)
-{
- PyObject *list;
- gint *new_order;
- GtkListStore *store;
- int i;
- int length;
-
- if (!PyArg_ParseTuple(args, "O:GtkListStore.reorder", &list))
- return NULL;
-
- if (!PyList_Check(list)) {
- PyErr_SetString(PyExc_TypeError, "first argument should be a list");
- return NULL;
- }
- store = GTK_LIST_STORE(self->obj);
- length = gtk_tree_model_iter_n_children (GTK_TREE_MODEL(store), NULL);
-
- if (PyList_Size(list) < length) {
- PyErr_SetString(PyExc_TypeError, "list must at least have the same size as the number of items in the store");
- return NULL;
- }
-
- new_order = g_new0(gint, length);
- for (i = 0; i < length; i++) {
- PyObject *item = PyList_GetItem(list, i);
- int index;
- if (!PyInt_Check(item)) {
- PyErr_SetString(PyExc_TypeError, "all items must be of type int");
- g_free(new_order);
- return NULL;
- }
- index = PyInt_AsLong(item);
- if (index < 0 || index >= length) {
- PyErr_SetString(PyExc_ValueError, "position index out of range");
- g_free(new_order);
- return NULL;
- }
- new_order[i] = index;
- }
- gtk_list_store_reorder(GTK_LIST_STORE(self->obj), new_order);
-
- g_free(new_order);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-ignore gtk_tree_store_newv
-%%
-override gtk_tree_store_new
-static int
-_wrap_gtk_tree_store_new(PyGObject *self, PyObject *args)
-{
- guint len, i;
- GType *column_types;
-
- len = PyTuple_Size(args);
- if (len == 0) {
- PyErr_SetString(PyExc_TypeError, "GtkTreeStore requires at least one argument");
- return -1;
- }
-
- column_types = g_new(GType, len);
- for (i = 0; i < len; i++) {
- PyObject *item = PyTuple_GetItem(args, i);
-
- column_types[i] = pyg_type_from_object(item);
- if (column_types[i] == 0) {
- g_free(column_types);
- return -1;
- }
- }
-
- self->obj = g_object_newv(pyg_type_from_object((PyObject *) self), 0, NULL);
- gtk_tree_store_set_column_types(GTK_TREE_STORE(self->obj), len, column_types);
-
- g_free(column_types);
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create GtkTreeStore object");
- return -1;
- }
- pygobject_register_wrapper((PyObject *)self);
- return 0;
-}
-%%
-ignore gtk_tree_store_set_valist
-%%
-override gtk_tree_store_set
-static PyObject *
-_wrap_gtk_tree_store_set(PyGObject *self, PyObject *args)
-{
- PyObject *iter;
- int len, i;
-
- len = PyTuple_Size(args);
- if (len == 0) {
- PyErr_SetString(PyExc_TypeError, "GtkTreeStore.set requires at least three arguments");
- return NULL;
- }
-
- iter = PyTuple_GetItem(args, 0);
- if (!pyg_boxed_check(iter, GTK_TYPE_TREE_ITER)) {
- PyErr_SetString(PyExc_TypeError, "iter must be a GtkTreeIter");
- return NULL;
- }
-
- if ((len - 1) % 2) {
- PyErr_SetString(PyExc_TypeError,
- "Argument list must be column, value pairs. No -1 "
- "termination is needed.");
- return NULL;
- }
- for (i = 1; i < len; i+=2) {
- gint column;
- GValue value = { 0 };
- PyObject *py_column = PyTuple_GetItem(args, i);
- PyObject *py_value = PyTuple_GetItem(args, i + 1);
-
- if (!PyInt_Check(py_column)) {
- PyErr_SetString(PyExc_TypeError,
- "Expected numeric argument for column.");
- return NULL;
- }
- column = PyInt_AsLong(py_column);
- if (column < 0 ||
- column >= gtk_tree_model_get_n_columns(GTK_TREE_MODEL(self->obj))) {
- PyErr_SetString(PyExc_ValueError, "column number is out of range");
- return NULL;
- }
- g_value_init(&value,
- gtk_tree_model_get_column_type(GTK_TREE_MODEL(self->obj),
- column));
- if (pyg_value_from_pyobject(&value, py_value)) {
- PyErr_SetString(PyExc_TypeError,
- "value is of the wrong type for this column");
- return NULL;
- }
- gtk_tree_store_set_value(GTK_TREE_STORE(self->obj),
- pyg_boxed_get(iter, GtkTreeIter), column,
- &value);
- g_value_unset(&value);
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_store_set_value kwargs
-static PyObject *
-_wrap_gtk_tree_store_set_value(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "iter", "column", "value", NULL };
- PyObject *iter, *pyvalue;
- gint column;
- GValue value = { 0 };
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OiO:GtkTreeStore.set_value",
- kwlist, &iter, &column, &pyvalue))
- return NULL;
- if (column < 0 ||
- column >= gtk_tree_model_get_n_columns(GTK_TREE_MODEL(self->obj))) {
- PyErr_SetString(PyExc_ValueError, "column number is out of range");
- return NULL;
- }
- if (!pyg_boxed_check(iter, GTK_TYPE_TREE_ITER)) {
- PyErr_SetString(PyExc_TypeError, "iter must be a GtkTreeIter");
- return NULL;
- }
- g_value_init(&value,
- gtk_tree_model_get_column_type(GTK_TREE_MODEL(self->obj),
- column));
- if (pyg_value_from_pyobject(&value, pyvalue)) {
- PyErr_SetString(PyExc_TypeError,
- "value is of the wrong type for this column");
- return NULL;
- }
- gtk_tree_store_set_value(GTK_TREE_STORE(self->obj),
- pyg_boxed_get(iter, GtkTreeIter), column, &value);
- g_value_unset(&value);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-ignore
- gtk_tree_store_setv
-%%
-override gtk_tree_store_insert kwargs
-#if GTK_CHECK_VERSION(2, 10, 0)
-static PyObject *
-_wrap_gtk_tree_store_insert(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "parent", "position", "row", NULL };
- PyObject *py_parent;
- GtkTreeIter iter, *parent = NULL;
- gint position;
- PyObject *items = NULL;
- gint n_columns = 0;
- gint *columns = NULL;
- GValue *values = NULL;
- gint i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "Oi|O:GtkTreeStore.insert",
- kwlist, &py_parent, &position, &items))
- return NULL;
- if (pyg_boxed_check(py_parent, GTK_TYPE_TREE_ITER))
- parent = pyg_boxed_get(py_parent, GtkTreeIter);
- else if (py_parent != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "parent must be a GtkTreeIter or None");
- return NULL;
- }
- if (items) {
- if (!PySequence_Check(items)) {
- PyErr_SetString(PyExc_TypeError, "expecting a sequence");
- return NULL;
- }
-
- n_columns = gtk_tree_model_get_n_columns(GTK_TREE_MODEL(self->obj));
- if (PySequence_Length(items) != n_columns) {
- PyErr_SetString(PyExc_ValueError, "row sequence has wrong length");
- return NULL;
- }
- }
-
- columns = g_new0(gint, n_columns);
- values = g_new0(GValue, n_columns);
- for (i = 0; i < n_columns; i++) {
- PyObject *item;
-
- item = PySequence_GetItem(items, i);
- if (!item)
- return NULL;
-
- g_value_init(&values[i],
- gtk_tree_model_get_column_type(GTK_TREE_MODEL(self->obj),
- i));
-
- if (pyg_value_from_pyobject(&values[i], item)) {
- Py_DECREF(item);
- PyErr_SetString(PyExc_TypeError,
- "value is of wrong type for this column");
- return NULL;
- }
-
- columns[i] = i;
-
- Py_DECREF(item);
- }
-
- gtk_tree_store_insert_with_valuesv(GTK_TREE_STORE(self->obj), &iter,
- parent, position, columns, values,
- n_columns);
-
- for (i = 0; i < n_columns; i++) {
- g_value_unset(&values[i]);
- }
- if (values)
- g_free(values);
- if (columns)
- g_free(columns);
-
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-#else
-static PyObject *
-_wrap_gtk_tree_store_insert(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "parent", "position", "row", NULL };
- PyObject *py_parent;
- GtkTreeIter iter, *parent = NULL;
- gint position;
- PyObject *row = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "Oi|O:GtkTreeStore.insert",
- kwlist, &py_parent, &position, &row))
- return NULL;
- if (pyg_boxed_check(py_parent, GTK_TYPE_TREE_ITER))
- parent = pyg_boxed_get(py_parent, GtkTreeIter);
- else if (py_parent != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "parent must be a GtkTreeIter or None");
- return NULL;
- }
- gtk_tree_store_insert(GTK_TREE_STORE(self->obj), &iter, parent, position);
-
- /* optionally set items in the new row */
- if (row != Py_None &&
- _pygtk_tree_model_set_row(GTK_TREE_MODEL(self->obj), &iter, row) < 0)
- return NULL;
-
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-#endif
-%%
-override gtk_tree_store_insert_before kwargs
-static PyObject *
-_wrap_gtk_tree_store_insert_before(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "parent", "sibling", "row", NULL };
- PyObject *py_parent, *py_sibling;
- GtkTreeIter iter, *parent = NULL, *sibling = NULL;
- PyObject *row = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO|O:GtkTreeStore.insert_before",
- kwlist, &py_parent, &py_sibling, &row))
- return NULL;
- if (pyg_boxed_check(py_parent, GTK_TYPE_TREE_ITER))
- parent = pyg_boxed_get(py_parent, GtkTreeIter);
- else if (py_parent != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "parent must be a GtkTreeIter or None");
- return NULL;
- }
- if (pyg_boxed_check(py_sibling, GTK_TYPE_TREE_ITER))
- sibling = pyg_boxed_get(py_sibling, GtkTreeIter);
- else if (py_sibling != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "sibling must be a GtkTreeIter or None");
- return NULL;
- }
- gtk_tree_store_insert_before(GTK_TREE_STORE(self->obj), &iter, parent,
- sibling);
-
- /* optionally set items in the new row */
- if (row != Py_None &&
- _pygtk_tree_model_set_row(GTK_TREE_MODEL(self->obj), &iter, row) < 0)
- return NULL;
-
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_tree_store_insert_after kwargs
-static PyObject *
-_wrap_gtk_tree_store_insert_after(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "parent", "sibling", "row", NULL };
- PyObject *py_parent, *py_sibling;
- GtkTreeIter iter, *parent = NULL, *sibling = NULL;
- PyObject *row = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO|O:GtkTreeStore.insert_after",
- kwlist, &py_parent, &py_sibling, &row))
- return NULL;
- if (pyg_boxed_check(py_parent, GTK_TYPE_TREE_ITER))
- parent = pyg_boxed_get(py_parent, GtkTreeIter);
- else if (py_parent != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "parent must be a GtkTreeIter or None");
- return NULL;
- }
- if (pyg_boxed_check(py_sibling, GTK_TYPE_TREE_ITER))
- sibling = pyg_boxed_get(py_sibling, GtkTreeIter);
- else if (py_sibling != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "sibling must be a GtkTreeIter or None");
- return NULL;
- }
- gtk_tree_store_insert_after(GTK_TREE_STORE(self->obj), &iter, parent,
- sibling);
-
- /* optionally set items in the new row */
- if (row != Py_None &&
- _pygtk_tree_model_set_row(GTK_TREE_MODEL(self->obj), &iter, row) < 0)
- return NULL;
-
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_tree_store_prepend kwargs
-static PyObject *
-_wrap_gtk_tree_store_prepend(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "parent", "row", NULL };
- PyObject *py_parent;
- GtkTreeIter iter, *parent = NULL;
- PyObject *row = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|O:GtkTreeStore.prepend",
- kwlist, &py_parent, &row))
- return NULL;
- if (pyg_boxed_check(py_parent, GTK_TYPE_TREE_ITER))
- parent = pyg_boxed_get(py_parent, GtkTreeIter);
- else if (py_parent != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "parent must be a GtkTreeIter or None");
- return NULL;
- }
- gtk_tree_store_prepend(GTK_TREE_STORE(self->obj), &iter, parent);
-
- /* optionally set items in the new row */
- if (row != Py_None &&
- _pygtk_tree_model_set_row(GTK_TREE_MODEL(self->obj), &iter, row) < 0)
- return NULL;
-
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_tree_store_append kwargs
-static PyObject *
-_wrap_gtk_tree_store_append(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "parent", "row", NULL };
- PyObject *py_parent;
- GtkTreeIter iter, *parent = NULL;
- PyObject *row = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|O:GtkTreeStore.append",
- kwlist, &py_parent, &row))
- return NULL;
- if (pyg_boxed_check(py_parent, GTK_TYPE_TREE_ITER))
- parent = pyg_boxed_get(py_parent, GtkTreeIter);
- else if (py_parent != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "parent must be a GtkTreeIter or None");
- return NULL;
- }
- gtk_tree_store_append(GTK_TREE_STORE(self->obj), &iter, parent);
-
- /* optionally set items in the new row */
- if (row != Py_None &&
- _pygtk_tree_model_set_row(GTK_TREE_MODEL(self->obj), &iter, row) < 0)
- return NULL;
-
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_tree_model_get_iter_first noargs
-static PyObject *
-_wrap_gtk_tree_model_get_iter_first(PyGObject *self)
-{
- GtkTreeIter iter;
-
- if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(self->obj), &iter))
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
- else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override gtk_tree_model_iter_next kwargs
-static PyObject *
-_wrap_gtk_tree_model_iter_next(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "iter", NULL };
- PyObject *py_iter;
- GtkTreeIter iter;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkTreeModel.iter_next", kwlist,
- &py_iter))
- return NULL;
- if (pyg_boxed_check(py_iter, GTK_TYPE_TREE_ITER))
- iter = *pyg_boxed_get(py_iter, GtkTreeIter);
- else {
- PyErr_SetString(PyExc_TypeError, "iter should be a GtkTreeIter");
- return NULL;
- }
-
- if (gtk_tree_model_iter_next(GTK_TREE_MODEL(self->obj), &iter))
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
- else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override gtk_tree_model_iter_children kwargs
-static PyObject *
-_wrap_gtk_tree_model_iter_children(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "parent", NULL };
- PyObject *py_parent;
- GtkTreeIter iter, *parent = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkTreeModel.iter_children", kwlist,
- &py_parent))
- return NULL;
- if (pyg_boxed_check(py_parent, GTK_TYPE_TREE_ITER))
- parent = pyg_boxed_get(py_parent, GtkTreeIter);
- else if (py_parent == Py_None)
- parent = NULL;
- else {
- PyErr_SetString(PyExc_TypeError, "parent should be a GtkTreeIter or None");
- return NULL;
- }
-
- if (gtk_tree_model_iter_children(GTK_TREE_MODEL(self->obj),
- &iter, parent))
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
- else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override gtk_tree_model_iter_nth_child kwargs
-static PyObject *
-_wrap_gtk_tree_model_iter_nth_child(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "parent", "n", NULL };
- PyObject *py_parent;
- gint n;
- GtkTreeIter iter, *parent = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oi:GtkTreeModel.iter_nth_child", kwlist,
- &py_parent, &n))
- return NULL;
- if (pyg_boxed_check(py_parent, GTK_TYPE_TREE_ITER))
- parent = pyg_boxed_get(py_parent, GtkTreeIter);
- else if (py_parent == Py_None)
- parent = NULL;
- else {
- PyErr_SetString(PyExc_TypeError, "parent should be a GtkTreeIter or None");
- return NULL;
- }
-
- if (gtk_tree_model_iter_nth_child(GTK_TREE_MODEL(self->obj),
- &iter, parent, n))
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
- else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override gtk_tree_model_iter_parent kwargs
-static PyObject *
-_wrap_gtk_tree_model_iter_parent(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "child", NULL };
- PyObject *py_child;
- GtkTreeIter iter, *child = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GtkTreeModel.iter_parent", kwlist,
- &py_child))
- return NULL;
- if (pyg_boxed_check(py_child, GTK_TYPE_TREE_ITER))
- child = pyg_boxed_get(py_child, GtkTreeIter);
- else {
- PyErr_SetString(PyExc_TypeError, "child should be a GtkTreeIter");
- return NULL;
- }
-
- if (gtk_tree_model_iter_parent(GTK_TREE_MODEL(self->obj),
- &iter, child))
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
- else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override gtk_tree_model_foreach
-static gboolean
-pygtk_tree_foreach_marshal(GtkTreeModel *model,
- GtkTreePath *path,
- GtkTreeIter *iter,
- gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *py_model, *py_path, *py_iter, *retobj;
- gboolean ret;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_model = pygobject_new((GObject *)model);
- py_path = pygtk_tree_path_to_pyobject(path);
- py_iter = pyg_boxed_new(GTK_TYPE_TREE_ITER, iter, FALSE, FALSE);
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NNOO)",
- py_model, py_path, py_iter,
- cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(NNO)",
- py_model, py_path, py_iter);
-
- if (retobj != NULL) {
- ret = PyObject_IsTrue(retobj);
- Py_DECREF(retobj);
- } else {
- ret = TRUE;
- }
- pygtk_boxed_unref_shared(py_iter);
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_tree_model_foreach(PyGObject *self, PyObject *args)
-{
- gboolean pygtk_tree_foreach_marshal(GtkTreeModel *model,
- GtkTreePath *path,
- GtkTreeIter *iter,
- gpointer data);
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify cunote;
-
- if(!PyArg_ParseTuple(args, "O|O:GtkTreeModel.foreach",
- &pyfunc, &pyarg))
- return NULL;
-
- cunote.func = pyfunc;
- cunote.data = pyarg;
- gtk_tree_model_foreach(GTK_TREE_MODEL(self->obj),
- pygtk_tree_foreach_marshal, &cunote);
-
- if (PyErr_Occurred())
- return NULL;
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_cell_renderer_get_size kwargs
-static PyObject *
-_wrap_gtk_cell_renderer_get_size(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "widget", "cell_area", NULL };
- gint x_offset = 0, y_offset = 0, width = 0, height = 0;
- GdkRectangle cell_area;
- PyObject *py_widget, *py_cell_area = Py_None;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkCellRenderer.get_size", kwlist,
- &py_widget, &py_cell_area))
- return NULL;
-
- if (!pygobject_check(py_widget, &PyGtkWidget_Type)) {
- PyErr_SetString(PyExc_TypeError, "widget must be a GtkWidget");
- return NULL;
- }
- if (py_cell_area != Py_None) {
- if (!pygdk_rectangle_from_pyobject(py_cell_area, &cell_area))
- return NULL;
- }
-
- gtk_cell_renderer_get_size(GTK_CELL_RENDERER(self->obj),
- GTK_WIDGET(pygobject_get(py_widget)),
- (py_cell_area == Py_None) ? NULL : &cell_area,
- &x_offset, &y_offset, &width, &height);
-
- return Py_BuildValue("(iiii)", x_offset, y_offset, width, height);
-}
-%%
-override gtk_cell_renderer_get_fixed_size noargs
-static PyObject *
-_wrap_gtk_cell_renderer_get_fixed_size(PyGObject *self)
-{
- gint width, height;
-
- gtk_cell_renderer_get_fixed_size(GTK_CELL_RENDERER(self->obj),
- &width, &height);
-
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override gtk_tree_model_sort_convert_child_iter_to_iter kwargs
-static PyObject *
-_wrap_gtk_tree_model_sort_convert_child_iter_to_iter(PyGObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "sort_iter", "child_iter", NULL };
- PyObject *py_sort_iter = Py_None, *py_child_iter;
- GtkTreeIter iter, *sort_iter, *child_iter = NULL;
-
- sort_iter = &iter;
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "OO:GtkTreeModelSort.convert_child_iter_to_iter",
- kwlist, &py_sort_iter, &py_child_iter))
- return NULL;
- if (pyg_boxed_check(py_sort_iter, GTK_TYPE_TREE_ITER))
- sort_iter = pyg_boxed_get(py_sort_iter, GtkTreeIter);
- else if (py_sort_iter != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "sort_iter should be a GtkTreeIter or None");
- return NULL;
- }
- if (pyg_boxed_check(py_child_iter, GTK_TYPE_TREE_ITER))
- child_iter = pyg_boxed_get(py_child_iter, GtkTreeIter);
- else {
- PyErr_SetString(PyExc_TypeError, "child_iter should be a GtkTreeIter");
- return NULL;
- }
- gtk_tree_model_sort_convert_child_iter_to_iter(
- GTK_TREE_MODEL_SORT(self->obj), sort_iter, child_iter);
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, sort_iter, TRUE, TRUE);
-}
-%%
-override gtk_tree_model_sort_convert_iter_to_child_iter kwargs
-static PyObject *
-_wrap_gtk_tree_model_sort_convert_iter_to_child_iter(PyGObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "child_iter", "sorted_iter", NULL };
- PyObject *py_child_iter = Py_None, *py_sorted_iter;
- GtkTreeIter iter, *child_iter, *sorted_iter = NULL;
-
- child_iter = &iter;
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "OO:GtkTreeModelSort.convert_iter_to_child_iter",
- kwlist, &py_child_iter, &py_sorted_iter))
- return NULL;
- if (pyg_boxed_check(py_child_iter, GTK_TYPE_TREE_ITER))
- child_iter = pyg_boxed_get(py_child_iter, GtkTreeIter);
- else if (py_child_iter != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "child_iter should be a GtkTreeIter or None");
- return NULL;
- }
- if (pyg_boxed_check(py_sorted_iter, GTK_TYPE_TREE_ITER))
- sorted_iter = pyg_boxed_get(py_sorted_iter, GtkTreeIter);
- else {
- PyErr_SetString(PyExc_TypeError,
- "sorted_iter should be a GtkTreeIter");
- return NULL;
- }
- gtk_tree_model_sort_convert_iter_to_child_iter(
- GTK_TREE_MODEL_SORT(self->obj), child_iter, sorted_iter);
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, child_iter, TRUE, TRUE);
-}
-%%
-override gtk_tree_view_enable_model_drag_source kwargs
-static PyObject *
-_wrap_gtk_tree_view_enable_model_drag_source(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "start_button_mask", "targets", "actions", NULL };
- PyObject *py_sbmask, *py_targets, *py_actions;
- GdkModifierType sbmask;
- GtkTargetEntry *targets;
- GdkDragAction actions;
- gint n_targets, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OOO:GtkTreeView.enable_model_drag_source",
- kwlist,
- &py_sbmask, &py_targets, &py_actions))
- return NULL;
- if (pyg_flags_get_value(GDK_TYPE_MODIFIER_TYPE,
- py_sbmask, (gint *)&sbmask))
- return NULL;
- if (pyg_flags_get_value(GDK_TYPE_DRAG_ACTION,
- py_actions, (gint *)&actions))
- return NULL;
- if (!PySequence_Check(py_targets)) {
- PyErr_SetString(PyExc_TypeError, "targets must be a sequence");
- return NULL;
- }
- n_targets = PySequence_Length(py_targets);
- targets = g_new(GtkTargetEntry, n_targets);
- for (i = 0; i < n_targets; i++) {
- PyObject *item = PySequence_GetItem(py_targets, i);
- Py_DECREF(item);
- if (!PyArg_ParseTuple(item, "zii", &targets[i].target,
- &targets[i].flags, &targets[i].info)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "list items should be of form (string,int,int)");
- g_free(targets);
- return NULL;
- }
- }
- gtk_tree_view_enable_model_drag_source(GTK_TREE_VIEW(self->obj),
- sbmask, targets, n_targets, actions);
- g_free(targets);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_view_enable_model_drag_dest kwargs
-static PyObject *
-_wrap_gtk_tree_view_enable_model_drag_dest(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "targets", "actions", NULL };
- PyObject *py_targets, *py_actions;
- GtkTargetEntry *targets;
- GdkDragAction actions;
- gint n_targets, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO:GtkTreeView.enable_model_drag_dest",
- kwlist,
- &py_targets, &py_actions))
- return NULL;
- if (pyg_flags_get_value(GDK_TYPE_DRAG_ACTION,
- py_actions, (gint *)&actions))
- return NULL;
- if (!PySequence_Check(py_targets)) {
- PyErr_SetString(PyExc_TypeError, "targets must be a sequence");
- return NULL;
- }
- n_targets = PySequence_Length(py_targets);
- targets = g_new(GtkTargetEntry, n_targets);
- for (i = 0; i < n_targets; i++) {
- PyObject *item = PySequence_GetItem(py_targets, i);
- Py_DECREF(item);
- if (!PyArg_ParseTuple(item, "zii", &targets[i].target,
- &targets[i].flags, &targets[i].info)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "list items should be of form (string,int,int)");
- g_free(targets);
- return NULL;
- }
- }
- gtk_tree_view_enable_model_drag_dest(GTK_TREE_VIEW(self->obj),
- targets, n_targets, actions);
- g_free(targets);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_view_get_drag_dest_row noargs
-static PyObject *
-_wrap_gtk_tree_view_get_drag_dest_row(PyGObject *self)
-{
- GtkTreePath *path;
- GtkTreeViewDropPosition pos;
-
- gtk_tree_view_get_drag_dest_row(GTK_TREE_VIEW(self->obj), &path, &pos);
- if (path) {
- PyObject *py_path = pygtk_tree_path_to_pyobject(path);
- gint py_pos = (gint) pos;
- gtk_tree_path_free(path);
- return Py_BuildValue("(NN)", py_path,
- pyg_enum_from_gtype(GTK_TYPE_TREE_VIEW_DROP_POSITION, py_pos));
- } else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override gtk_tree_view_set_drag_dest_row kwargs
-static PyObject *
-_wrap_gtk_tree_view_set_drag_dest_row(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "path", "pos", NULL };
- PyObject *py_path;
- gint py_pos;
- GtkTreePath *path;
- GtkTreeViewDropPosition pos;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Oi:GtkTreeView.set_drag_dest_row",
- kwlist,
- &py_path, &py_pos))
- return NULL;
-
- path = pygtk_tree_path_from_pyobject(py_path);
- if (!path) {
- PyErr_SetString(PyExc_TypeError,
- "set_drag_dest_row muts be a TreePath");
- return NULL;
- }
- pos = (GtkTreeViewDropPosition) py_pos;
- gtk_tree_view_set_drag_dest_row(GTK_TREE_VIEW(self->obj), path, pos);
- gtk_tree_path_free(path);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_view_get_dest_row_at_pos kwargs
-static PyObject *
-_wrap_gtk_tree_view_get_dest_row_at_pos(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "x", "y", NULL };
- GtkTreePath *path;
- GtkTreeViewDropPosition pos;
-
- gint x,y;
- gboolean r;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "ii:GtkTreeView.get_drag_dest_row_at_pos",
- kwlist,
- &x, &y))
- return NULL;
-
-
- r = gtk_tree_view_get_dest_row_at_pos(GTK_TREE_VIEW(self->obj), x, y, &path, &pos);
- if (r && path) {
- PyObject *py_path = pygtk_tree_path_to_pyobject(path);
- gint py_pos = (gint) pos;
- gtk_tree_path_free(path);
- return Py_BuildValue("(NN)", py_path,
- pyg_enum_from_gtype(GTK_TYPE_TREE_VIEW_DROP_POSITION, py_pos));
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_view_map_expanded_rows kwargs
-
-typedef struct {
- PyObject *func;
- PyObject *user_data;
-} _map_expanded_rows_data_t;
-
-static void map_expanded_rows_cb(GtkTreeView *tree_view, GtkTreePath *path,
- gpointer user_data)
-{
- PyObject *py_path, *py_view, *ret;
- _map_expanded_rows_data_t *data =
- (_map_expanded_rows_data_t *) user_data;
-
- /* If exception is pending, just return */
- if (PyErr_Occurred())
- return;
-
- py_path = pygtk_tree_path_to_pyobject(path);
- if (py_path == NULL)
- return;
- py_view = pygobject_new((GObject *)tree_view);
- if (py_view == NULL) {
- Py_DECREF(py_path);
- return;
- }
- if (data->user_data)
- ret = PyObject_CallFunction(data->func, "NNO", py_view, py_path, data->user_data);
- else
- ret = PyObject_CallFunction(data->func, "NN", py_view, py_path);
- Py_XDECREF(ret);
-}
-
-static PyObject *
-_wrap_gtk_tree_view_map_expanded_rows(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", NULL };
- _map_expanded_rows_data_t data = { NULL, NULL };
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkTreeView.map_expanded_rows",
- kwlist,
- &data.func, &data.user_data))
- return NULL;
-
- if (!PyCallable_Check(data.func)) {
- PyErr_SetString(PyExc_TypeError, "func must be callable");
- return NULL;
- }
-
- gtk_tree_view_map_expanded_rows(GTK_TREE_VIEW(self->obj), map_expanded_rows_cb,
- &data);
-
- /* Return NULL if exception occurred in the callback */
- if (PyErr_Occurred())
- return NULL;
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_model_filter_set_visible_func kwargs
-static gboolean
-pygtk_tree_model_filter_visible_cb(GtkTreeModel *model, GtkTreeIter *iter,
- gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *py_model, *py_iter, *retobj;
- gboolean ret = FALSE;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_model = pygobject_new((GObject *)model);
- py_iter = pyg_boxed_new(GTK_TYPE_TREE_ITER, iter, FALSE, FALSE);
-
- if (cunote->data) {
- retobj = PyEval_CallFunction(cunote->func, "(NNO)", py_model,
- py_iter, cunote->data);
- } else {
- retobj = PyEval_CallFunction(cunote->func, "(NN)", py_model,
- py_iter);
- }
- if (retobj)
- ret = retobj == Py_True ? TRUE : FALSE;
- if (PyErr_Occurred()) {
- PyErr_Print();
- }
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_tree_model_filter_set_visible_func(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", NULL };
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:GtkTreeModelFilter.set_visible_func",
- kwlist, &pyfunc, &pyarg))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- }
- cunote = g_new(PyGtkCustomNotify, 1);
- Py_INCREF(pyfunc);
- cunote->func = pyfunc;
- Py_XINCREF(pyarg);
- cunote->data = pyarg;
-
- gtk_tree_model_filter_set_visible_func(GTK_TREE_MODEL_FILTER(self->obj),
- pygtk_tree_model_filter_visible_cb,
- (gpointer)cunote,
- pygtk_custom_destroy_notify);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_model_filter_convert_child_iter_to_iter kwargs
-static PyObject *
-_wrap_gtk_tree_model_filter_convert_child_iter_to_iter(PyGObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "child_iter", NULL };
- PyObject *py_child_iter;
- GtkTreeIter iter, *child_iter;
- GtkTreePath *child_path, *path;
- GtkTreeModel *child_model;
- GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER(self->obj);
-
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "O:GtkTreeModelFilter.convert_child_iter_to_iter",
- kwlist, &py_child_iter))
- return NULL;
- if (pyg_boxed_check(py_child_iter, GTK_TYPE_TREE_ITER))
- child_iter = pyg_boxed_get(py_child_iter, GtkTreeIter);
- else {
- PyErr_SetString(PyExc_TypeError, "child_iter should be a GtkTreeIter");
- return NULL;
- }
-
- child_model = gtk_tree_model_filter_get_model(filter);
- child_path = gtk_tree_model_get_path(child_model, child_iter);
- if (child_path == NULL) {
- PyErr_SetString(PyExc_ValueError, "child_iter invalid");
- return NULL;
- }
-
- path = gtk_tree_model_filter_convert_child_path_to_path(filter,
- child_path);
- gtk_tree_path_free (child_path);
- if (path == NULL) {
- PyErr_SetString(PyExc_RuntimeError, "couldn't convert child_iter");
- return NULL;
- }
-
- gtk_tree_model_filter_convert_child_iter_to_iter(
- GTK_TREE_MODEL_FILTER(self->obj), &iter, child_iter);
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_tree_model_filter_convert_iter_to_child_iter kwargs
-static PyObject *
-_wrap_gtk_tree_model_filter_convert_iter_to_child_iter(PyGObject *self,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "filter_iter", NULL };
- PyObject *py_filter_iter;
- GtkTreeIter iter, *filter_iter;
-
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "O:GtkTreeModelFilter.convert_iter_to_child_iter",
- kwlist, &py_filter_iter))
- return NULL;
- if (pyg_boxed_check(py_filter_iter, GTK_TYPE_TREE_ITER))
- filter_iter = pyg_boxed_get(py_filter_iter, GtkTreeIter);
- else {
- PyErr_SetString(PyExc_TypeError,
- "filter_iter should be a GtkTreeIter");
- return NULL;
- }
- gtk_tree_model_filter_convert_iter_to_child_iter(
- GTK_TREE_MODEL_FILTER(self->obj), &iter, filter_iter);
- return pyg_boxed_new(GTK_TYPE_TREE_ITER, &iter, TRUE, TRUE);
-}
-%%
-override gtk_tree_view_column_cell_get_position kwargs
-static PyObject *
-_wrap_gtk_tree_view_column_cell_get_position(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "cell_renderer", NULL };
- PyGObject *py_cell;
- gint start, width;
-
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!:GtkTreeViewColumn.cell_get_position",
- kwlist, &PyGtkCellRenderer_Type,
- &py_cell))
- return NULL;
-
- if (gtk_tree_view_column_cell_get_position(GTK_TREE_VIEW_COLUMN(self->obj),
- GTK_CELL_RENDERER(py_cell->obj),
- &start, &width))
- return Py_BuildValue("(ii)", start, width);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_store_reorder kwargs
-static PyObject *
-_wrap_gtk_tree_store_reorder(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "parent", "new_order", NULL };
- PyObject *list, *pyparent;
- gint *new_order;
- GtkTreeStore *store;
- GtkTreeIter *parent = NULL;
- int i, slen;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO!:gtk.TreeStore.reorder", kwlist,
- &pyparent, &PyList_Type, &list))
- return NULL;
-
- if (pyparent != Py_None) {
- if (pyg_boxed_check(pyparent, GTK_TYPE_TREE_ITER)) {
- parent = pyg_boxed_get(pyparent, GtkTreeIter);
- } else {
- PyErr_SetString(PyExc_TypeError,
- "parent must be a valid gtk.TreeIter or None");
- return NULL;
- }
- }
- store = GTK_TREE_STORE(self->obj);
- slen = gtk_tree_model_iter_n_children(GTK_TREE_MODEL(self->obj), parent);
- if (PyList_Size(list) < slen) {
- PyErr_SetString(PyExc_TypeError,
- "list size must be >= the number of "
- "children of parent");
- return NULL;
- }
-
- new_order = g_new0(gint, slen);
- for (i = 0; i < slen; i++) {
- PyObject *item = PyList_GetItem(list, i);
- int index;
- if (!PyInt_Check(item)) {
- PyErr_SetString(PyExc_TypeError, "all items must be of type int");
- g_free(new_order);
- return NULL;
- }
- index = PyInt_AsLong(item);
- if (index < 0 || index >= slen) {
- PyErr_SetString(PyExc_ValueError, "position index out of range");
- g_free(new_order);
- return NULL;
- }
- new_order[i] = index;
- }
- gtk_tree_store_reorder(GTK_TREE_STORE(self->obj), parent, new_order);
-
- g_free(new_order);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_model_get args
-static PyObject *
-_wrap_gtk_tree_model_get(PyGObject *self, PyObject *args)
-{
- PyObject *py_iter, *ret;
- gint len, i, n_columns;
- GtkTreeIter *iter;
-
- len = PyTuple_Size(args) - 1;
-
- if (len < 1) {
- PyErr_SetString(PyExc_TypeError,
- "gtk.TreeModel.get requires at least two arguments");
- return NULL;
- }
-
- py_iter = PyTuple_GetItem(args, 0);
-
- if (!pyg_boxed_check(py_iter, GTK_TYPE_TREE_ITER)) {
- PyErr_SetString(PyExc_TypeError, "iter must be a GtkTreeIter");
- return NULL;
- }
- iter = pyg_boxed_get(py_iter, GtkTreeIter);
-
- ret = PyTuple_New(len);
-
- n_columns = gtk_tree_model_get_n_columns(GTK_TREE_MODEL(self->obj));
- for (i = 0; i < len; i++) {
- GValue value = { 0, };
- gint column;
- PyObject *py_column = PyTuple_GetItem(args, i+1);
-
- if (!PyInt_Check(py_column)) {
- PyErr_SetString(PyExc_TypeError, "column numbers must be ints");
- Py_DECREF(ret);
- return NULL;
- }
- column = PyInt_AsLong(py_column);
- if (column < 0 || column >= n_columns) {
- PyErr_SetString(PyExc_ValueError, "column number is out of range");
- Py_DECREF(ret);
- return NULL;
- }
- gtk_tree_model_get_value(GTK_TREE_MODEL(self->obj), iter,
- column, &value);
- PyTuple_SetItem(ret, i, pyg_value_as_pyobject(&value, TRUE));
- g_value_unset(&value);
- }
- return ret;
-}
-%%
-override gtk_tree_selection_select_all noargs
-static PyObject *
-_wrap_gtk_tree_selection_select_all(PyGObject *self)
-{
- GtkSelectionMode mode;
-
- mode = gtk_tree_selection_get_mode(GTK_TREE_SELECTION(self->obj));
- if (mode != GTK_SELECTION_MULTIPLE) {
- PyErr_SetString(PyExc_TypeError,
- "gtk.TreeSelection.select_all requires that"
- " selection mode is gtk.SELECTION_MULTIPLE");
- return NULL;
- }
-
- gtk_tree_selection_select_all(GTK_TREE_SELECTION(self->obj));
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_selection_select_range kwargs
-static PyObject *
-_wrap_gtk_tree_selection_select_range(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "start_path", "end_path", NULL };
- PyObject *py_start_path, *py_end_path;
- GtkTreePath *start_path, *end_path;
- GtkSelectionMode mode;
-
- mode = gtk_tree_selection_get_mode(GTK_TREE_SELECTION(self->obj));
- if (mode != GTK_SELECTION_MULTIPLE) {
- PyErr_SetString(PyExc_TypeError,
- "gtk.TreeSelection.select_range requires that"
- " selection mode is gtk.SELECTION_MULTIPLE");
- return NULL;
- }
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO:GtkTreeSelection.select_range",
- kwlist, &py_start_path, &py_end_path))
- return NULL;
- start_path = pygtk_tree_path_from_pyobject(py_start_path);
- if (!start_path) {
- PyErr_SetString(PyExc_TypeError,
- "could not convert start_path to a GtkTreePath");
- return NULL;
- }
- end_path = pygtk_tree_path_from_pyobject(py_end_path);
- if (!end_path) {
- gtk_tree_path_free(start_path);
- PyErr_SetString(PyExc_TypeError,
- "could not convert end_path to a GtkTreePath");
- return NULL;
- }
- gtk_tree_selection_select_range(GTK_TREE_SELECTION(self->obj),
- start_path, end_path);
-
- gtk_tree_path_free(start_path);
- gtk_tree_path_free(end_path);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_model_filter_set_modify_func kwargs
-static void
-pygtk_filter_modify_func_marshal(GtkTreeModel *model, GtkTreeIter *iter,
- GValue *value, gint column, gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *py_value, *py_model, *py_iter;
-
- g_assert (cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_model = pygobject_new((GObject *)model);
- py_iter = pyg_boxed_new(GTK_TYPE_TREE_ITER, iter, FALSE, FALSE);
- if (cunote->data)
- py_value = PyEval_CallFunction(cunote->func, "(NNiO)",
- py_model, py_iter, column, cunote->data);
- else
- py_value = PyEval_CallFunction(cunote->func, "(NNi)",
- py_model, py_iter, column);
-
- if (PyErr_Occurred()) {
- PyErr_Print();
- } else if (pyg_value_from_pyobject(value, py_value)) {
- PyErr_Format(PyExc_TypeError,
- "value is of the wrong type for column %i", column);
- PyErr_Print();
- }
-
- Py_XDECREF(py_value);
-
- pyg_gil_state_release(state);
-}
-
-static PyObject *
-_wrap_gtk_tree_model_filter_set_modify_func(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "types", "func", "data", NULL };
- GType *types;
- PyObject *py_types, *py_func, *py_arg = NULL;
- PyGtkCustomNotify *cunote;
- gint tlen, i;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO|O:GtkTreeModelFilter.set_modify_func",
- kwlist, &py_types, &py_func, &py_arg))
- return NULL;
-
- if (!PyCallable_Check(py_func)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- }
- if (!PySequence_Check(py_types) || (tlen = PySequence_Size(py_types)) <= 0) {
- PyErr_SetString(PyExc_TypeError,
- "types must be a tuple containing one or more arguments");
- return NULL;
- }
-
- types = g_new0(GType, tlen);
- for (i = 0; i < tlen; i++) {
- PyObject *item = PySequence_GetItem(py_types, i);
-
- types[i] = pyg_type_from_object(item);
- if (types[i] == 0) {
- Py_DECREF(item);
- g_free(types);
- return NULL;
- }
- Py_DECREF(item);
- }
-
- cunote = g_new(PyGtkCustomNotify, 1);
- Py_INCREF(py_func);
- cunote->func = py_func;
- Py_XINCREF(py_arg);
- cunote->data = py_arg;
-
- gtk_tree_model_filter_set_modify_func(GTK_TREE_MODEL_FILTER(self->obj),
- tlen, types,
- pygtk_filter_modify_func_marshal,
- cunote,
- pygtk_custom_destroy_notify);
-
- g_free(types);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_view_set_column_drag_function kwargs
-static gboolean
-pygtk_column_drag_func_marshal(GtkTreeView *tree_view,
- GtkTreeViewColumn *column,
- GtkTreeViewColumn *prev_column,
- GtkTreeViewColumn *next_column,
- gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *py_tree_view, *py_column, *py_prev_column, *py_next_column;
- PyObject *retobj;
- gboolean ret = FALSE;
-
- g_assert (cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_tree_view = pygobject_new((GObject *)tree_view);
- py_column = pygobject_new((GObject *)column);
- py_prev_column = pygobject_new((GObject *)prev_column);
- /* Workaround for drag part of GTK+ bug #143355 */
- if (prev_column == next_column)
- next_column = NULL;
- py_next_column = pygobject_new((GObject *)next_column);
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NNNNO)",
- py_tree_view, py_column, py_prev_column,
- py_next_column, cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(NNNN)",
- py_tree_view, py_column, py_prev_column,
- py_next_column);
-
- if (retobj)
- ret = retobj == Py_True ? TRUE : FALSE;
- if (PyErr_Occurred()) {
- PyErr_Print();
- }
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_gtk_tree_view_set_column_drag_function(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "user_data", NULL };
- PyObject *py_func = NULL, *py_arg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|OO:GtkTreeView.set_column_drag_func",
- kwlist, &py_func, &py_arg))
- return NULL;
-
- if (!py_func || py_func == Py_None) {
- gtk_tree_view_set_column_drag_function(GTK_TREE_VIEW(self->obj),
- NULL, NULL, NULL);
- Py_INCREF(Py_None);
- return Py_None;
- }
-
- if (!PyCallable_Check(py_func)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- }
-
- cunote = g_new(PyGtkCustomNotify, 1);
- Py_INCREF(py_func);
- cunote->func = py_func;
- Py_XINCREF(py_arg);
- cunote->data = py_arg;
-
- gtk_tree_view_set_column_drag_function(GTK_TREE_VIEW(self->obj),
- pygtk_column_drag_func_marshal,
- cunote,
- pygtk_custom_destroy_notify);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_view_set_search_equal_func kwargs
-static gboolean
-pygtk_set_search_equal_func_marshal(GtkTreeModel *model,
- gint column,
- const gchar *key,
- GtkTreeIter *iter,
- gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *py_model, *py_column, *py_key, *py_iter;
- PyObject *retobj;
- gboolean ret = FALSE;
-
- /* gracefully guard against NULL values */
- g_return_val_if_fail(cunote->func, TRUE);
- g_return_val_if_fail(key, TRUE);
- g_return_val_if_fail(iter, TRUE);
-
- state = pyg_gil_state_ensure();
-
- py_model = pygobject_new((GObject *)model);
- py_column = PyInt_FromLong(column);
- py_key = PyString_FromString(key);
- py_iter = pyg_boxed_new(GTK_TYPE_TREE_ITER, iter, FALSE, FALSE);
-
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NNNNO)",
- py_model, py_column, py_key, py_iter,
- cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(NNNN)",
- py_model, py_column, py_key, py_iter);
-
- if (retobj)
- ret = (PyObject_IsTrue(retobj)? TRUE : FALSE);
- if (PyErr_Occurred()) {
- PyErr_Print();
- }
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
- return ret;
-}
-
-static PyObject *
-_wrap_gtk_tree_view_set_search_equal_func(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "user_data", NULL };
- PyObject *py_func = NULL, *py_arg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|OO:GtkTreeView.set_search_equal_func",
- kwlist, &py_func, &py_arg))
- return NULL;
-
- if (!py_func || py_func == Py_None) {
- gtk_tree_view_set_search_equal_func(GTK_TREE_VIEW(self->obj),
- NULL, NULL, NULL);
- Py_INCREF(Py_None);
- return Py_None;
- }
-
- if (!PyCallable_Check(py_func)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- }
-
- cunote = g_new(PyGtkCustomNotify, 1);
- Py_INCREF(py_func);
- cunote->func = py_func;
- Py_XINCREF(py_arg);
- cunote->data = py_arg;
-
- gtk_tree_view_set_search_equal_func(GTK_TREE_VIEW(self->obj),
- pygtk_set_search_equal_func_marshal,
- cunote,
- pygtk_custom_destroy_notify);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_view_set_row_separator_func kwargs
-static gboolean
-pygtk_set_row_separator_func_marshal(GtkTreeModel *model,
- GtkTreeIter *iter,
- gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *py_model, *py_iter;
- PyObject *retobj;
- gboolean ret = FALSE;
-
- g_assert (cunote->func);
-
- state = pyg_gil_state_ensure();
-
- py_model = pygobject_new((GObject *)model);
- py_iter = pyg_boxed_new(GTK_TYPE_TREE_ITER, iter, FALSE, FALSE);
-
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NNO)",
- py_model, py_iter, cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(NN)",
- py_model, py_iter);
-
- if (retobj)
- ret = retobj == Py_True ? TRUE : FALSE;
- if (PyErr_Occurred()) {
- PyErr_Print();
- }
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
- return ret;
-}
-
-static PyObject *
-_wrap_gtk_tree_view_set_row_separator_func(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "user_data", NULL };
- PyObject *py_func = NULL, *py_arg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|OO:GtkTreeView.set_row_separator_func",
- kwlist, &py_func, &py_arg))
- return NULL;
-
- if (!py_func || py_func == Py_None) {
- gtk_tree_view_set_row_separator_func(GTK_TREE_VIEW(self->obj),
- NULL, NULL, NULL);
- Py_INCREF(Py_None);
- return Py_None;
- }
-
- if (!PyCallable_Check(py_func)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- }
-
- cunote = g_new(PyGtkCustomNotify, 1);
- Py_INCREF(py_func);
- cunote->func = py_func;
- Py_XINCREF(py_arg);
- cunote->data = py_arg;
-
- gtk_tree_view_set_row_separator_func(GTK_TREE_VIEW(self->obj),
- pygtk_set_row_separator_func_marshal,
- cunote,
- pygtk_custom_destroy_notify);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_view_get_visible_range noargs
-static PyObject *
-_wrap_gtk_tree_view_get_visible_range(PyGObject *self)
-{
- GtkTreePath *start_path, *end_path;
- gboolean r;
-
- r = gtk_tree_view_get_visible_range(GTK_TREE_VIEW(self->obj),
- &start_path, &end_path);
- if (r) {
- PyObject *py_start_path = pygtk_tree_path_to_pyobject(start_path);
- PyObject *py_end_path = pygtk_tree_path_to_pyobject(end_path);
- gtk_tree_path_free(start_path);
- gtk_tree_path_free(end_path);
- return Py_BuildValue("(NN)", py_start_path, py_end_path);
- }
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_view_set_search_position_func
-static void
-pygtk_tree_view_set_search_position_func_cb(GtkTreeView *treeview,
- GtkWidget *search_dialog,
- gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *retobj;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NNO)",
- pygobject_new((GObject*)treeview),
- pygobject_new((GObject*)search_dialog),
- cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(NN)",
- pygobject_new((GObject*)treeview),
- pygobject_new((GObject*)search_dialog));
-
- if (retobj == NULL) {
- PyErr_Print();
- }
-
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
-}
-static PyObject *
-_wrap_gtk_tree_view_set_search_position_func(PyGObject *self, PyObject *args)
-{
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if(!PyArg_ParseTuple(args, "O|O:GtkTreeView.set_search_position_func",
- &pyfunc, &pyarg))
- return NULL;
-
- if (pyfunc != Py_None) {
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
- gtk_tree_view_set_search_position_func(
- GTK_TREE_VIEW(self->obj),
- pygtk_tree_view_set_search_position_func_cb, cunote,
- pygtk_custom_destroy_notify);
- } else
- gtk_tree_view_set_search_position_func(GTK_TREE_VIEW(self->obj),
- NULL, NULL, NULL);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_tree_store_set_column_types args
-static PyObject*
-_wrap_gtk_tree_store_set_column_types(PyGObject *self, PyObject *args)
-{
- guint len, i;
- GType *column_types;
-
- len = PyTuple_Size(args);
- if (len == 0) {
- PyErr_SetString(PyExc_TypeError,
- "GtkTreeStore set_column_types requires at least one argument");
- return NULL;
- }
-
- column_types = g_new(GType, len);
- for (i = 0; i < len; i++) {
- PyObject *item = PyTuple_GetItem(args, i);
-
- column_types[i] = pyg_type_from_object(item);
- if (column_types[i] == 0) {
- g_free(column_types);
- return NULL;
- }
- }
-
- gtk_tree_store_set_column_types(GTK_TREE_STORE(self->obj), len,
- column_types);
- g_free(column_types);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
diff --git a/gtk/gtkunixprint.defs b/gtk/gtkunixprint.defs
deleted file mode 100644
index 57581caa..00000000
--- a/gtk/gtkunixprint.defs
+++ /dev/null
@@ -1,408 +0,0 @@
-;; -*- scheme -*-
-; object definitions ...
-(define-object PageSetupUnixDialog
- (in-module "Unixprint")
- (parent "GtkDialog")
- (c-name "GtkPageSetupUnixDialog")
- (gtype-id "GTK_TYPE_PAGE_SETUP_UNIX_DIALOG")
-)
-
-(define-object PrintJob
- (in-module "Unixprint")
- (parent "GObject")
- (c-name "GtkPrintJob")
- (gtype-id "GTK_TYPE_PRINT_JOB")
-)
-
-(define-object PrintUnixDialog
- (in-module "Unixprint")
- (parent "GtkDialog")
- (c-name "GtkPrintUnixDialog")
- (gtype-id "GTK_TYPE_PRINT_UNIX_DIALOG")
-)
-
-(define-object Printer
- (in-module "Unixprint")
- (parent "GObject")
- (c-name "GtkPrinter")
- (gtype-id "GTK_TYPE_PRINTER")
-)
-
-;; Enumerations and flags ...
-
-(define-flags PrintCapabilities
- (in-module "Unixprint")
- (c-name "GtkPrintCapabilities")
- (gtype-id "GTK_TYPE_PRINT_CAPABILITIES")
- (values
- '("page-set" "GTK_PRINT_CAPABILITY_PAGE_SET")
- '("copies" "GTK_PRINT_CAPABILITY_COPIES")
- '("collate" "GTK_PRINT_CAPABILITY_COLLATE")
- '("reverse" "GTK_PRINT_CAPABILITY_REVERSE")
- '("scale" "GTK_PRINT_CAPABILITY_SCALE")
- '("generate-pdf" "GTK_PRINT_CAPABILITY_GENERATE_PDF")
- '("generate-ps" "GTK_PRINT_CAPABILITY_GENERATE_PS")
- '("preview" "GTK_PRINT_CAPABILITY_PREVIEW")
- )
-)
-
-
-;; From gtkpagesetupunixdialog.h
-
-(define-function gtk_page_setup_unix_dialog_get_type
- (c-name "gtk_page_setup_unix_dialog_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_page_setup_unix_dialog_new
- (c-name "gtk_page_setup_unix_dialog_new")
- (is-constructor-of "GtkPageSetupUnixDialog")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "title" (null-ok) (default "NULL"))
- '("GtkWindow*" "parent" (null-ok) (default "NULL"))
- )
-)
-
-(define-method set_page_setup
- (of-object "GtkPageSetupUnixDialog")
- (c-name "gtk_page_setup_unix_dialog_set_page_setup")
- (return-type "none")
- (parameters
- '("GtkPageSetup*" "page_setup")
- )
-)
-
-(define-method get_page_setup
- (of-object "GtkPageSetupUnixDialog")
- (c-name "gtk_page_setup_unix_dialog_get_page_setup")
- (return-type "GtkPageSetup*")
-)
-
-(define-method set_print_settings
- (of-object "GtkPageSetupUnixDialog")
- (c-name "gtk_page_setup_unix_dialog_set_print_settings")
- (return-type "none")
- (parameters
- '("GtkPrintSettings*" "print_settings")
- )
-)
-
-(define-method get_print_settings
- (of-object "GtkPageSetupUnixDialog")
- (c-name "gtk_page_setup_unix_dialog_get_print_settings")
- (return-type "GtkPrintSettings*")
-)
-
-
-;; From gtkprinter.h
-
-(define-function gtk_printer_get_type
- (c-name "gtk_printer_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_printer_new
- (c-name "gtk_printer_new")
- (is-constructor-of "GtkPrinter")
- (return-type "GtkPrinter*")
- (parameters
- '("const-gchar*" "name")
- '("GtkPrintBackend*" "backend")
- '("gboolean" "is_virtual")
- )
-)
-
-(define-method get_backend
- (of-object "GtkPrinter")
- (c-name "gtk_printer_get_backend")
- (return-type "GtkPrintBackend*")
-)
-
-(define-method get_name
- (of-object "GtkPrinter")
- (c-name "gtk_printer_get_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_state_message
- (of-object "GtkPrinter")
- (c-name "gtk_printer_get_state_message")
- (return-type "const-gchar*")
-)
-
-(define-method get_description
- (of-object "GtkPrinter")
- (c-name "gtk_printer_get_description")
- (return-type "const-gchar*")
-)
-
-(define-method get_location
- (of-object "GtkPrinter")
- (c-name "gtk_printer_get_location")
- (return-type "const-gchar*")
-)
-
-(define-method get_icon_name
- (of-object "GtkPrinter")
- (c-name "gtk_printer_get_icon_name")
- (return-type "const-gchar*")
-)
-
-(define-method get_job_count
- (of-object "GtkPrinter")
- (c-name "gtk_printer_get_job_count")
- (return-type "gint")
-)
-
-(define-method is_active
- (of-object "GtkPrinter")
- (c-name "gtk_printer_is_active")
- (return-type "gboolean")
-)
-
-(define-method is_virtual
- (of-object "GtkPrinter")
- (c-name "gtk_printer_is_virtual")
- (return-type "gboolean")
-)
-
-(define-method is_default
- (of-object "GtkPrinter")
- (c-name "gtk_printer_is_default")
- (return-type "gboolean")
-)
-
-(define-method accepts_pdf
- (of-object "GtkPrinter")
- (c-name "gtk_printer_accepts_pdf")
- (return-type "gboolean")
-)
-
-(define-method accepts_ps
- (of-object "GtkPrinter")
- (c-name "gtk_printer_accepts_ps")
- (return-type "gboolean")
-)
-
-(define-method compare
- (of-object "GtkPrinter")
- (c-name "gtk_printer_compare")
- (return-type "gint")
- (parameters
- '("GtkPrinter*" "b")
- )
-)
-
-(define-function enumerate_printers
- (c-name "gtk_enumerate_printers")
- (return-type "none")
- (parameters
- '("GtkPrinterFunc" "func")
- '("gpointer" "data")
- '("GDestroyNotify" "destroy")
- '("gboolean" "wait")
- )
-)
-
-(define-virtual details_acquired
- (of-object "GtkPrinter")
- (return-type "none")
- (parameters
- '("gboolean" "success")
- )
-)
-
-
-
-
-;; From gtkprintjob.h
-
-(define-function gtk_print_job_get_type
- (c-name "gtk_print_job_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_print_job_new
- (c-name "gtk_print_job_new")
- (is-constructor-of "GtkPrintJob")
- (return-type "GtkPrintJob*")
- (parameters
- '("const-gchar*" "title")
- '("GtkPrinter*" "printer")
- '("GtkPrintSettings*" "settings")
- '("GtkPageSetup*" "page_setup")
- )
-)
-
-(define-method get_settings
- (of-object "GtkPrintJob")
- (c-name "gtk_print_job_get_settings")
- (return-type "GtkPrintSettings*")
-)
-
-(define-method get_printer
- (of-object "GtkPrintJob")
- (c-name "gtk_print_job_get_printer")
- (return-type "GtkPrinter*")
-)
-
-(define-method get_title
- (of-object "GtkPrintJob")
- (c-name "gtk_print_job_get_title")
- (return-type "const-gchar*")
-)
-
-(define-method get_status
- (of-object "GtkPrintJob")
- (c-name "gtk_print_job_get_status")
- (return-type "GtkPrintStatus")
-)
-
-(define-method set_source_file
- (of-object "GtkPrintJob")
- (c-name "gtk_print_job_set_source_file")
- (return-type "gboolean")
- (parameters
- '("const-gchar*" "filename")
- '("GError**" "error")
- )
-)
-
-(define-method get_surface
- (of-object "GtkPrintJob")
- (c-name "gtk_print_job_get_surface")
- (return-type "cairo_surface_t*")
- (parameters
- '("GError**" "error")
- )
-)
-
-(define-method set_track_print_status
- (of-object "GtkPrintJob")
- (c-name "gtk_print_job_set_track_print_status")
- (return-type "none")
- (parameters
- '("gboolean" "track_status")
- )
-)
-
-(define-method get_track_print_status
- (of-object "GtkPrintJob")
- (c-name "gtk_print_job_get_track_print_status")
- (return-type "gboolean")
-)
-
-(define-method send
- (of-object "GtkPrintJob")
- (c-name "gtk_print_job_send")
- (return-type "gboolean")
- (parameters
- '("GtkPrintJobCompleteFunc" "callback")
- '("gpointer" "user_data")
- '("GDestroyNotify" "dnotify")
- '("GError**" "error")
- )
-)
-
-(define-function print_capabilities_get_type
- (c-name "gtk_print_capabilities_get_type")
- (return-type "GType")
-)
-
-(define-virtual status_changed
- (of-object "GtkPrintJob")
- (return-type "none")
-)
-
-
-
-;; From gtkprintunixdialog.h
-
-(define-function gtk_print_unix_dialog_get_type
- (c-name "gtk_print_unix_dialog_get_type")
- (return-type "GType")
-)
-
-(define-function gtk_print_unix_dialog_new
- (c-name "gtk_print_unix_dialog_new")
- (is-constructor-of "GtkPrintUnixDialog")
- (return-type "GtkWidget*")
- (parameters
- '("const-gchar*" "title" (null-ok) (default "NULL"))
- '("GtkWindow*" "parent" (null-ok) (default "NULL"))
- )
-)
-
-(define-method set_page_setup
- (of-object "GtkPrintUnixDialog")
- (c-name "gtk_print_unix_dialog_set_page_setup")
- (return-type "none")
- (parameters
- '("GtkPageSetup*" "page_setup")
- )
-)
-
-(define-method get_page_setup
- (of-object "GtkPrintUnixDialog")
- (c-name "gtk_print_unix_dialog_get_page_setup")
- (return-type "GtkPageSetup*")
-)
-
-(define-method set_current_page
- (of-object "GtkPrintUnixDialog")
- (c-name "gtk_print_unix_dialog_set_current_page")
- (return-type "none")
- (parameters
- '("gint" "current_page")
- )
-)
-
-(define-method get_current_page
- (of-object "GtkPrintUnixDialog")
- (c-name "gtk_print_unix_dialog_get_current_page")
- (return-type "gint")
-)
-
-(define-method set_settings
- (of-object "GtkPrintUnixDialog")
- (c-name "gtk_print_unix_dialog_set_settings")
- (return-type "none")
- (parameters
- '("GtkPrintSettings*" "settings" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_settings
- (of-object "GtkPrintUnixDialog")
- (c-name "gtk_print_unix_dialog_get_settings")
- (return-type "GtkPrintSettings*")
-)
-
-(define-method get_selected_printer
- (of-object "GtkPrintUnixDialog")
- (c-name "gtk_print_unix_dialog_get_selected_printer")
- (return-type "GtkPrinter*")
-)
-
-(define-method add_custom_tab
- (of-object "GtkPrintUnixDialog")
- (c-name "gtk_print_unix_dialog_add_custom_tab")
- (return-type "none")
- (parameters
- '("GtkWidget*" "child")
- '("GtkWidget*" "tab_label")
- )
-)
-
-(define-method set_manual_capabilities
- (of-object "GtkPrintUnixDialog")
- (c-name "gtk_print_unix_dialog_set_manual_capabilities")
- (return-type "none")
- (parameters
- '("GtkPrintCapabilities" "capabilities")
- )
-)
-
-
-
diff --git a/gtk/gtkunixprint.override b/gtk/gtkunixprint.override
deleted file mode 100644
index 12b68d90..00000000
--- a/gtk/gtkunixprint.override
+++ /dev/null
@@ -1,236 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 2006 John Finlay
- *
- * gtkunixprint.override: overrides for the gtkunixprint module.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-headers
-#define NO_IMPORT_PYGOBJECT
-#include <pygobject.h>
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-#include <libintl.h>
-
-#include <glib-object.h>
-#include "pygtk-private.h"
-#include <gtk/gtk.h>
-#include <gtk/gtkprinter.h>
-#include <gtk/gtkprintjob.h>
-#include <gtk/gtkpagesetupunixdialog.h>
-#include <gtk/gtkprintunixdialog.h>
-
-#include <pycairo.h>
-extern Pycairo_CAPI_t *Pycairo_CAPI;
-
-#ifndef GTK_TYPE_PRINT_CAPABILITIES
-GType gtk_print_capabilites_get_type (void) G_GNUC_CONST;
-#define GTK_TYPE_PRINT_CAPABILITIES (gtk_print_capabilites_get_type())
-
-GType
-gtk_print_capabilites_get_type (void)
-{
- static GType etype = 0;
- if (etype == 0) {
- static const GFlagsValue values[] = {
- { GTK_PRINT_CAPABILITY_PAGE_SET, "GTK_PRINT_CAPABILITY_PAGE_SET", "page_set" },
- { GTK_PRINT_CAPABILITY_COPIES, "GTK_PRINT_CAPABILITY_COPIES", "copies" },
- { GTK_PRINT_CAPABILITY_COLLATE, "GTK_PRINT_CAPABILITY_COLLATE", "collate" },
- { GTK_PRINT_CAPABILITY_REVERSE, "GTK_PRINT_CAPABILITY_REVERSE", "reverse" },
- { GTK_PRINT_CAPABILITY_SCALE, "GTK_PRINT_CAPABILITY_SCALE", "scale" },
- { 0, NULL, NULL }
- };
- etype = g_flags_register_static (g_intern_static_string ("GtkPrintCapabilites"), values);
- }
- return etype;
-}
-#endif
-
-
-void
-pygtk_custom_destroy_notify(gpointer user_data)
-{
- PyGtkCustomNotify *cunote = user_data;
- PyGILState_STATE state;
-
- g_return_if_fail(user_data);
- state = pyg_gil_state_ensure();
- Py_XDECREF(cunote->func);
- Py_XDECREF(cunote->data);
- pyg_gil_state_release(state);
-
- g_free(cunote);
-}
-
-
-%%
-modulename gtkunixprint
-%%
-import gobject.GObject as PyGObject_Type
-import gtk.Dialog as PyGtkDialog_Type
-import gtk.PageSetup as PyGtkPageSetup_Type
-import gtk.PrintSettings as PyGtkPrintSettings_Type
-import gtk.Widget as PyGtkWidget_Type
-import gtk.Window as PyGtkWindow_Type
-%%
-ignore-glob *_get_type
-%%
-ignore
-%%
-override gtk_print_job_get_surface noargs
-static PyObject*
-_wrap_gtk_print_job_get_surface(PyGObject *self)
-{
- GError *error = NULL;
- cairo_surface_t * surface;
-
- surface = gtk_print_job_get_surface(GTK_PRINT_JOB(self->obj), &error);
-
- if (pyg_error_check(&error))
- return NULL;
-
-#if PYCAIRO_VERSION_HEX >= 0x1010600
- return PycairoSurface_FromSurface(surface, NULL);
-#else
- return PycairoSurface_FromSurface(surface, NULL, NULL);
-#endif
-}
-%%
-override gtk_print_job_send kwargs
-static void
-pygtk_print_job_complete_func_cb(GtkPrintJob *print_job, gpointer user_data,
- GError *error)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *retobj, *data;
- gchar *errorstr = NULL;
-
- g_assert(cunote->func);
-
- state = pyg_gil_state_ensure();
-
- if (cunote->data)
- data = cunote->data;
- else
- data = Py_None;
-
- if (error)
- errorstr = error->message;
-
- retobj = PyEval_CallFunction(cunote->func, "(NOz)",
- pygobject_new((GObject *)print_job),
- data, errorstr);
-
- if (retobj == NULL)
- PyErr_Print();
-
- Py_XDECREF(retobj);
-
- pyg_gil_state_release(state);
-}
-static PyObject*
-_wrap_gtk_print_job_send(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "callback", "user_data", NULL };
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:gtkunixprint.PrintJob.send",
- kwlist, &pyfunc, &pyarg))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError, "callback must be a callable object");
- return NULL;
- }
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_print_job_send(GTK_PRINT_JOB(self->obj),
- pygtk_print_job_complete_func_cb,
- cunote, pygtk_custom_destroy_notify);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_enumerate_printers kwargs
-static gboolean
-pygtk_printer_func_cb(GtkPrinter *printer, gpointer user_data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = user_data;
- PyObject *retobj;
- gboolean ret = TRUE;
-
- g_assert(cunote->func);
- state = pyg_gil_state_ensure();
-
- if (cunote->data)
- retobj = PyEval_CallFunction(cunote->func, "(NO)",
- pygobject_new((GObject *)printer),
- cunote->data);
- else
- retobj = PyEval_CallFunction(cunote->func, "(N)",
- pygobject_new((GObject *)printer));
-
- if (retobj == NULL)
- PyErr_Print();
- else if (retobj == Py_False)
- ret = FALSE;
-
- Py_XDECREF(retobj);
- pyg_gil_state_release(state);
-
- return ret;
-}
-static PyObject*
-_wrap_gtk_enumerate_printers(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", "wait", NULL };
- PyObject *pyfunc, *pyarg = NULL;
- PyGtkCustomNotify *cunote;
- gboolean wait = TRUE;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|Oi:gtkunixprint.enumerate_printers",
- kwlist, &pyfunc, &pyarg, &wait))
- return NULL;
-
- if (!PyCallable_Check(pyfunc)) {
- PyErr_SetString(PyExc_TypeError, "func must be a callable object");
- return NULL;
- }
- cunote = g_new0(PyGtkCustomNotify, 1);
- cunote->func = pyfunc;
- cunote->data = pyarg;
- Py_INCREF(cunote->func);
- Py_XINCREF(cunote->data);
-
- gtk_enumerate_printers(pygtk_printer_func_cb, cunote,
- pygtk_custom_destroy_notify, wait);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
diff --git a/gtk/gtkunixprintmodule.c b/gtk/gtkunixprintmodule.c
deleted file mode 100644
index 55377859..00000000
--- a/gtk/gtkunixprintmodule.c
+++ /dev/null
@@ -1,56 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 2006 John Finlay
- *
- * gtkunixprintmodule.c: wrapper for the gtkunixprint library.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
-#include <Python.h>
-/* include this first, before NO_IMPORT_PYGOBJECT is defined */
-#include <pygobject.h>
-#include <pygtk.h>
-#include <gtk/gtk.h>
-#include <gtk/gtkprinter.h>
-#include <gtk/gtkprintjob.h>
-#include <gtk/gtkpagesetupunixdialog.h>
-#include <gtk/gtkprintunixdialog.h>
-
-# include <pycairo.h>
-Pycairo_CAPI_t *Pycairo_CAPI;
-
-void pygtkunixprint_register_classes(PyObject *d);
-void pygtkunixprint_add_constants(PyObject *module, const gchar *strip_prefix);
-extern PyMethodDef pygtkunixprint_functions[];
-
-DL_EXPORT(void)
-initgtkunixprint(void)
-{
- PyObject *m, *d;
-
- m = Py_InitModule("gtkunixprint", pygtkunixprint_functions);
- d = PyModule_GetDict(m);
-
- init_pygobject();
- Pycairo_IMPORT;
- init_pygtk();
-
- pygtkunixprint_register_classes(d);
- pygtkunixprint_add_constants(m, "GTK_");
-}
diff --git a/gtk/gtkwidget.override b/gtk/gtkwidget.override
deleted file mode 100644
index 7fb080ae..00000000
--- a/gtk/gtkwidget.override
+++ /dev/null
@@ -1,575 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gtkwidget.override: overrides for the gtk.Widget object.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-ignore
- gtk_widget_destroyed
- gtk_widget_get
- gtk_widget_getv
- gtk_widget_newv
- gtk_widget_new
- gtk_widget_set
- gtk_widget_setv
- gtk_widget_style_get_valist
- gtk_widget_class_install_style_property_parser
-%%
-override gtk_widget_translate_coordinates kwargs
-static PyObject *
-_wrap_gtk_widget_translate_coordinates(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "dest_widget", "src_x", "src_y", NULL };
- PyObject *py_dest_widget;
- int src_x, src_y;
- GtkWidget *dest_widget = NULL;
- int dest_x, dest_y;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "Oii:GtkWidget.translate_coordinates",
- kwlist, &py_dest_widget, &src_x, &src_y)) {
- return NULL;
- }
-
- if (pygobject_check(py_dest_widget, &PyGtkWidget_Type)) {
- dest_widget = GTK_WIDGET(pygobject_get(py_dest_widget));
- } else if (py_dest_widget != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "dest_widget must be a GtkWidget or None");
- return NULL;
- }
-
- if (!gtk_widget_translate_coordinates(GTK_WIDGET(self->obj),
- dest_widget,
- src_x,
- src_y,
- &dest_x,
- &dest_y)) {
- return Py_BuildValue ("()");
- }
-
- return Py_BuildValue ("(ii)", dest_x, dest_y);
-}
-%%
-override gtk_widget_size_request noargs
-static PyObject *
-_wrap_gtk_widget_size_request(PyGObject *self)
-{
- GtkRequisition requisition;
-
- gtk_widget_size_request(GTK_WIDGET(self->obj), &requisition);
- return Py_BuildValue("(ii)", requisition.width, requisition.height);
-}
-%%
-override gtk_widget_get_child_requisition noargs
-static PyObject *
-_wrap_gtk_widget_get_child_requisition(PyGObject *self)
-{
- GtkRequisition requisition;
-
- gtk_widget_get_child_requisition(GTK_WIDGET(self->obj), &requisition);
- return Py_BuildValue("(ii)", requisition.width, requisition.height);
-}
-%%
-override gtk_widget_get_allocation noargs
-static PyObject *
-_wrap_gtk_widget_get_allocation(PyGObject *self)
-{
- GtkAllocation allocation;
-
- allocation = GTK_WIDGET(self->obj)->allocation;
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &allocation, TRUE, TRUE);
-}
-%%
-override gtk_widget_intersect kwargs
-static PyObject *
-_wrap_gtk_widget_intersect(PyGObject *self, PyObject *args, PyObject*kwargs)
-{
- static char *kwlist[] = { "area", NULL };
- PyObject *py_area;
- GdkRectangle area, intersect;
-
- if(!PyArg_ParseTupleAndKeywords(args, kwargs, "O:GtkWidget.intersect",
- kwlist, &py_area))
- return NULL;
- if (!pygdk_rectangle_from_pyobject(py_area, &area))
- return NULL;
- if (gtk_widget_intersect(GTK_WIDGET(self->obj), &area, &intersect))
- return pyg_boxed_new(GDK_TYPE_RECTANGLE, &intersect, TRUE, TRUE);
- else {
- Py_INCREF(Py_None);
- return Py_None;
- }
-}
-%%
-override gtk_widget_get_pointer noargs
-static PyObject *
-_wrap_gtk_widget_get_pointer(PyGObject *self)
-{
- int x, y;
-
- gtk_widget_get_pointer(GTK_WIDGET(self->obj), &x, &y);
- return Py_BuildValue("(ii)", x, y);
-}
-%%
-override gtk_widget_path noargs
-static PyObject *
-_wrap_gtk_widget_path(PyGObject *self)
-{
- guint length;
- gchar *path;
- gchar *path_reversed;
- PyObject *result;
-
- gtk_widget_path(GTK_WIDGET(self->obj), &length, &path, &path_reversed);
- result = PyString_FromString(path);
- g_free(path);
- g_free(path_reversed);
-
- return result;
-}
-%%
-override gtk_widget_class_path noargs
-static PyObject *
-_wrap_gtk_widget_class_path(PyGObject *self)
-{
- guint length;
- gchar *path;
- gchar *path_reversed;
- PyObject *result;
-
- gtk_widget_class_path(GTK_WIDGET(self->obj), &length, &path,
- &path_reversed);
- result = PyString_FromString(path);
- g_free(path);
- g_free(path_reversed);
-
- return result;
-}
-%%
-override gtk_widget_class_list_style_properties kwargs
-static PyObject *
-_wrap_gtk_widget_class_list_style_properties (PyObject *self, PyObject *args,
- PyObject*kwargs)
-{
- static char *kwlist[] = { "widget", NULL };
- GParamSpec **specs;
- PyObject *py_itype, *list;
- GType itype;
- GtkWidgetClass *class;
- guint nprops;
- guint i;
-
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "O:gtk.widget_class_list_style_properties", kwlist,
- &py_itype))
- return NULL;
- if ((itype = pyg_type_from_object(py_itype)) == 0)
- return NULL;
-
- if (!g_type_is_a(itype, GTK_TYPE_WIDGET)) {
- PyErr_SetString(PyExc_TypeError, "type must be derived from GtkWidget");
- return NULL;
- }
-
- class = g_type_class_ref(itype);
- if (!class) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not get a reference to type class");
- return NULL;
- }
-
- specs = gtk_widget_class_list_style_properties(class, &nprops);
- list = PyTuple_New(nprops);
- if (list == NULL) {
- g_free(specs);
- g_type_class_unref(class);
- return NULL;
- }
- for (i = 0; i < nprops; i++) {
- PyTuple_SetItem(list, i, pyg_param_spec_new(specs[i]));
- }
- g_free(specs);
- g_type_class_unref(class);
-
- return list;
-}
-%%
-override gtk_widget_class_install_style_property kwargs
-static PyObject *
-_wrap_gtk_widget_class_install_style_property (PyObject *self,
- PyObject *args,
- PyObject* kwargs)
-{
- static char *kwlist[] = { "widget", "pspec", NULL };
- PyObject *py_itype, *property;
- GType itype;
- GtkWidgetClass *class;
- GParamSpec *pspec;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO:widget_class_install_style_property",
- kwlist,
- &py_itype, &property))
- return NULL;
-
-
- if ((itype = pyg_type_from_object(py_itype)) == 0)
- return NULL;
-
- if (!g_type_is_a(itype, GTK_TYPE_WIDGET)) {
- PyErr_SetString(PyExc_TypeError, "type must be derived from GtkWidget");
- return NULL;
- }
-
- class = g_type_class_ref(itype);
- if (!class) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not get a reference to type class");
- return NULL;
- }
-
- pspec = pyg_param_spec_from_object(property);
- if(!pspec) {
- g_type_class_unref(class);
- return NULL;
- }
-
- if (gtk_widget_class_find_style_property(class, pspec->name)) {
- PyErr_Format(PyExc_TypeError,
- "there is already a '%s' property installed", pspec->name);
- g_type_class_unref(class);
- return NULL;
- }
-
- gtk_widget_class_install_style_property(class, pspec);
-
- g_type_class_unref(class);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_widget_style_get_property kwargs
-static PyObject *
-_wrap_gtk_widget_style_get_property(PyGObject *self, PyObject *args,
- PyObject*kwargs)
-{
- static char *kwlist[] = { "property_name", NULL };
- gchar *param_name;
- GParamSpec *pspec;
- GValue value = { 0, };
- PyObject *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:GtkWidget.style_get_property", kwlist,
- &param_name))
- return NULL;
- pspec = gtk_widget_class_find_style_property(GTK_WIDGET_GET_CLASS(self->obj),
- param_name);
- if (!pspec) {
- PyErr_SetString(PyExc_TypeError,
- "the widget does not support the given style parameter");
- return NULL;
- }
- if (!(pspec->flags & G_PARAM_READABLE)) {
- PyErr_Format(PyExc_TypeError, "style property %s is not readable",
- param_name);
- return NULL;
- }
- g_value_init(&value, G_PARAM_SPEC_VALUE_TYPE(pspec));
- gtk_widget_style_get_property(GTK_WIDGET(self->obj), (const gchar*)param_name, &value);
- ret = pyg_value_as_pyobject(&value, TRUE);
- g_value_unset(&value);
- return ret;
-}
-%%
-override gtk_widget_list_mnemonic_labels noargs
-static PyObject *
-_wrap_gtk_widget_list_mnemonic_labels(PyGObject *self)
-{
- GList *labels;
- PyObject *py_labels;
- gint i, len;
-
- labels = gtk_widget_list_mnemonic_labels(GTK_WIDGET(self->obj));
- len = g_list_length(labels);
-
- py_labels = PyList_New(len);
-
- for (i = 0; i < len; i++) {
- PyObject *obj;
-
- obj = pygobject_new((GObject *)g_list_nth_data(labels, i));
- PyList_SetItem(py_labels, i, obj);
- }
-
- g_list_free(labels);
-
- return py_labels;
-}
-%%
-override-attr GtkWidget.window
-static int
-_wrap_gtk_widget__set_window(PyGObject *self, PyGObject *value, void *closure)
-{
- if (!pygobject_check(value, &PyGdkWindow_Type)) {
- PyErr_SetString(PyExc_TypeError, "must be a GdkWindow object");
- return -1;
- }
-
- GTK_WIDGET(self->obj)->window = g_object_ref(GDK_WINDOW(value->obj));
-
- return 0;
-}
-%%
-override-attr GtkWidget.allocation
-static int
-_wrap_gtk_widget__set_allocation(PyGObject *self, PyObject *value, void *closure)
-{
- if (!pygobject_check(value, &PyGdkRectangle_Type)) {
- PyErr_SetString(PyExc_TypeError, "must be a GdkRectangle object");
- return -1;
- }
-
- pygdk_rectangle_from_pyobject(value, &GTK_WIDGET(self->obj)->allocation);
-
- return 0;
-}
-%%
-override gtk_widget_hide_on_delete
-static PyObject *
-_wrap_gtk_widget_hide_on_delete(PyGObject *self, PyObject *args)
-{
- /* args is just ignored, so obj.connect(signal, func) always works */
-
- return PyBool_FromLong(gtk_widget_hide_on_delete(GTK_WIDGET(self->obj)));
-}
-%%
-override gtk_menu_get_for_attach_widget noargs
-static PyObject *
-_wrap_gtk_menu_get_for_attach_widget(PyGObject *self)
-{
- GList *menus;
- gint len, i;
- PyObject *pymenus;
-
- menus = gtk_menu_get_for_attach_widget(GTK_WIDGET(self->obj));
- len = g_list_length(menus);
- if ((pymenus = PyTuple_New(len)) == NULL)
- return NULL;
-
- for (i = 0; i < len; i++) {
- GtkMenu *menu = GTK_MENU(g_list_nth_data(menus, i));
- PyObject *pymenu = pygobject_new((GObject *)menu);
- PyTuple_SET_ITEM(pymenus, i, pymenu);
- }
- return pymenus;
-}
-%%
-define GtkWidget.set_activate_signal kwargs classmethod
-static PyObject *
-_wrap_gtk_widget_set_activate_signal(PyObject *cls,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "signal_name", NULL };
- gchar *signal_name;
- guint signal_id;
- GType gtype;
- GtkWidgetClass *klass;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:gtk.Widget.set_activate_signal",
- kwlist,
- &signal_name))
- return NULL;
-
- if ((gtype = pyg_type_from_object(cls)) == 0)
- return NULL;
- signal_id = g_signal_lookup(signal_name, gtype);
- if (signal_id == 0) {
- PyErr_Format(PyExc_ValueError, "class has no signal named '%s'",
- signal_name);
- return NULL;
- }
- klass = (GtkWidgetClass *) g_type_class_ref(gtype);
- klass->activate_signal = signal_id;
- g_type_class_unref(klass);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-define GtkWidget.set_set_scroll_adjustments_signal kwargs classmethod
-static PyObject *
-_wrap_gtk_widget_set_set_scroll_adjustments_signal(PyObject *cls,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "signal_name", NULL };
- gchar *signal_name;
- guint signal_id;
- GType gtype;
- GtkWidgetClass *klass;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:gtk.Widget.set_set_scroll_adjustments_signal", kwlist,
- &signal_name))
- return NULL;
-
- if ((gtype = pyg_type_from_object(cls)) == 0)
- return NULL;
- signal_id = g_signal_lookup(signal_name, gtype);
- if (signal_id == 0) {
- PyErr_Format(PyExc_ValueError,
- "class has no signal named '%s'", signal_name);
- return NULL;
- }
- klass = (GtkWidgetClass *) g_type_class_ref(gtype);
- klass->set_scroll_adjustments_signal = signal_id;
- g_type_class_unref(klass);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_drag_source_set_icon_name1 kwargs
-static PyObject *
-_wrap_gtk_drag_source_set_icon_name1(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "widget", "icon_name", NULL };
- PyGObject *widget;
- PyObject *icon_name, *ret, *nargs;
-
- if (PyErr_Warn(PyExc_DeprecationWarning, "use gtk.Widget.drag_source_set_icon_name") < 0)
- return NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!s:gtk.drag_source_set_icon_name",
- kwlist, &PyGtkWidget_Type, &widget,
- &icon_name))
- return NULL;
- nargs = Py_BuildValue("(s)", icon_name);
- ret = _wrap_gtk_drag_source_set_icon_name(widget, nargs, NULL);
- Py_DECREF(nargs);
- return ret;
-}
-%%
-override gtk_widget_class_find_style_property kwargs
-static PyObject *
-_wrap_gtk_widget_class_find_style_property (PyObject *self, PyObject *args,
- PyObject*kwargs)
-{
- static char *kwlist[] = { "widget", "property_name", NULL };
- GParamSpec *spec;
- PyObject *py_itype, *pyspec;
- GType itype;
- GtkWidgetClass *class;
- const gchar *property_name;
-
- if (!PyArg_ParseTupleAndKeywords(
- args, kwargs, "Os:gtk.widget_class_find_style_property", kwlist,
- &py_itype, &property_name))
- return NULL;
- if ((itype = pyg_type_from_object(py_itype)) == 0)
- return NULL;
-
- if (!g_type_is_a(itype, GTK_TYPE_WIDGET)) {
- PyErr_SetString(PyExc_TypeError,
- "type must be derived from GtkWidget");
- return NULL;
- }
-
- class = g_type_class_ref(itype);
- if (!class) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not get a reference to type class");
- return NULL;
- }
-
- spec = gtk_widget_class_find_style_property(class, property_name);
- if (spec) {
- pyspec = pyg_param_spec_new(spec);
- } else {
- pyspec = Py_None;
- Py_INCREF(pyspec);
- }
- g_type_class_unref(class);
-
- return pyspec;
-}
-%%
-define GtkWidget.set_activate_signal kwargs classmethod
-static PyObject *
-_wrap_gtk_widget_set_activate_signal(PyObject *cls,
- PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "signal_name", NULL };
- gchar *signal_name;
- guint signal_id;
- GType gtype;
- GtkWidgetClass *klass;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:gtk.Widget.set_activate_signal", kwlist,
- &signal_name))
- return NULL;
-
- if ((gtype = pyg_type_from_object(cls)) == 0)
- return NULL;
- signal_id = g_signal_lookup(signal_name, gtype);
- if (signal_id == 0) {
- PyErr_Format(PyExc_ValueError,
- "class has no signal named '%s'", signal_name);
- return NULL;
- }
- klass = (GtkWidgetClass *) g_type_class_ref(gtype);
- klass->activate_signal = signal_id;
- g_type_class_unref(klass);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-%%
-define GtkWidget.get_activate_signal noargs classmethod
-static PyObject *
-_wrap_gtk_widget_get_activate_signal(PyObject *cls,
- PyObject *args,
- PyObject *kwargs)
-{
- PyObject *signame;
- GType gtype;
- GtkWidgetClass *klass;
- GSignalQuery query;
-
- if ((gtype = pyg_type_from_object(cls)) == 0)
- return NULL;
- klass = (GtkWidgetClass *) g_type_class_ref(gtype);
-
- g_signal_query(klass->activate_signal, &query);
- if (query.signal_id == 0) {
- PyErr_SetString(PyExc_ValueError,
- "class has invalid signal ID");
- signame = NULL;
- goto out;
- }
- signame = PyString_FromString(query.signal_name);
-out:
- g_type_class_unref(klass);
- return signame;
-}
diff --git a/gtk/gtkwindow.override b/gtk/gtkwindow.override
deleted file mode 100644
index 6ace8124..00000000
--- a/gtk/gtkwindow.override
+++ /dev/null
@@ -1,286 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * gtkwindow.override: overrides for the gtk.Window object.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-ignore
- gtk_window_add_embedded_xid
- gtk_window_remove_embedded_xid
-%%
-override gtk_window_list_toplevels noargs
-static PyObject *
-_wrap_gtk_window_list_toplevels(PyGObject *self)
-{
- GList *list, *tmp;
- PyObject *py_list;
- PyObject *gtk_obj;
-
- list = gtk_window_list_toplevels();
-
- if ((py_list = PyList_New(0)) == NULL) {
- g_list_free(list);
- return NULL;
- }
- for (tmp = list; tmp != NULL; tmp = tmp->next) {
- gtk_obj = pygobject_new(G_OBJECT(tmp->data));
- if (gtk_obj == NULL) {
- g_list_free(list);
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_Append(py_list, gtk_obj);
- Py_DECREF(gtk_obj);
- }
- g_list_free(list);
- return py_list;
-}
-%%
-override gtk_window_set_geometry_hints kwargs
-static PyObject *
-_wrap_gtk_window_set_geometry_hints(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "geometry_widget", "min_width", "min_height",
- "max_width", "max_height", "base_width",
- "base_height", "width_inc", "height_inc",
- "min_aspect", "max_aspect", NULL };
- PyObject *py_geometry_widget = Py_None;
- GtkWidget *geometry_widget = NULL;
- gint min_width = -1, min_height = -1, max_width = -1, max_height = -1;
- gint base_width = -1, base_height = -1, width_inc = -1, height_inc = -1;
- gdouble min_aspect = -1.0, max_aspect = -1.0;
- GdkGeometry geometry = { 0 };
- GdkWindowHints geom_mask = 0;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|Oiiiiiiiidd:GtkWindow.set_geometry_hints", kwlist,
- &py_geometry_widget, &min_width,
- &min_height, &max_width, &max_height,
- &base_width, &base_height, &width_inc,
- &height_inc, &min_aspect, &max_aspect))
- return NULL;
- if (pygobject_check(py_geometry_widget, &PyGtkWidget_Type))
- geometry_widget = GTK_WIDGET(pygobject_get(py_geometry_widget));
- else if (py_geometry_widget != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "geometry_widget must be a GtkWidget or None");
- return NULL;
- }
- if (min_width >= 0 || min_height >= 0) {
- geometry.min_width = MAX(min_width, 0);
- geometry.min_height = MAX(min_height, 0);
- geom_mask |= GDK_HINT_MIN_SIZE;
- }
- if (max_width >= 0 || max_height >= 0) {
- geometry.max_width = MAX(max_width, 0);
- geometry.max_height = MAX(max_height, 0);
- geom_mask |= GDK_HINT_MAX_SIZE;
- }
- if (base_width >= 0 || base_height >= 0) {
- geometry.base_width = MAX(base_width, 0);
- geometry.base_height = MAX(base_height, 0);
- geom_mask |= GDK_HINT_BASE_SIZE;
- }
- if (width_inc >= 0 || height_inc >= 0) {
- geometry.width_inc = MAX(width_inc, 0);
- geometry.height_inc = MAX(height_inc, 0);
- geom_mask |= GDK_HINT_RESIZE_INC;
- }
- if (min_aspect >= 0.0 || max_aspect >= 0.0) {
- if (min_aspect <= 0.0 || max_aspect <= 0.0) {
- PyErr_SetString(PyExc_TypeError, "aspect ratios must be positive");
- return NULL;
- }
- geometry.min_aspect = min_aspect;
- geometry.max_aspect = max_aspect;
- geom_mask |= GDK_HINT_ASPECT;
- }
- gtk_window_set_geometry_hints(GTK_WINDOW(self->obj), geometry_widget,
- &geometry, geom_mask);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_window_get_position
-static PyObject *
-_wrap_gtk_window_get_position(PyGObject *self)
-{
- gint root_x, root_y;
-
- gtk_window_get_position(GTK_WINDOW(self->obj), &root_x, &root_y);
- return Py_BuildValue("(ii)", root_x, root_y);
-}
-%%
-override gtk_window_get_size
-static PyObject *
-_wrap_gtk_window_get_size(PyGObject *self)
-{
- gint width, height;
-
- gtk_window_get_size(GTK_WINDOW(self->obj), &width, &height);
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override gtk_window_get_default_size
-static PyObject *
-_wrap_gtk_window_get_default_size(PyGObject *self)
-{
- gint width, height;
-
- gtk_window_get_default_size(GTK_WINDOW(self->obj), &width, &height);
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override gtk_window_get_frame_dimensions noargs
-static PyObject *
-_wrap_gtk_window_get_frame_dimensions(PyGObject *self)
-{
- int left, top, right, bottom;
-
- gtk_window_get_frame_dimensions(GTK_WINDOW(self->obj),
- &left, &top, &right, &bottom);
- return Py_BuildValue("(iiii)", left, top, right, bottom);
-}
-%%
-override gtk_widget_get_size_request noargs
-static PyObject *
-_wrap_gtk_widget_get_size_request(PyGObject *self)
-{
- int width, height;
-
- gtk_widget_get_size_request(GTK_WIDGET(self->obj), &width, &height);
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override gtk_window_set_icon_list args
-static PyObject *
-_wrap_gtk_window_set_icon_list(PyGObject *self, PyObject *args)
-{
- GList *icon_list = NULL;
- PyObject *pyicon;
- gint len, i;
-
- len = PyTuple_Size(args);
- for (i = 0; i < len; i++) {
- pyicon = PyTuple_GetItem(args, i);
- if (!pygobject_check(pyicon, &PyGdkPixbuf_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "icons must be GdkPixbufs");
- g_list_free(icon_list);
- return NULL;
- }
- icon_list = g_list_prepend(icon_list, pygobject_get(pyicon));
- }
- gtk_window_set_icon_list(GTK_WINDOW(self->obj), icon_list);
- g_list_free(icon_list);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_window_get_icon_list noargs
-static PyObject *
-_wrap_gtk_window_get_icon_list(PyGObject *self)
-{
- GList *icon_list = NULL;
- PyObject *pyicon;
-
- if ((icon_list = gtk_window_get_icon_list(GTK_WINDOW(self->obj)))) {
- PyObject *py_list;
- GList *tmp;
-
- if ((py_list = PyList_New(0)) == NULL) {
- g_list_free(icon_list);
- return NULL;
- }
- for (tmp = icon_list; tmp != NULL; tmp = tmp->next) {
- pyicon = pygobject_new(G_OBJECT(tmp->data));
-
- if (pyicon == NULL) {
- g_list_free(icon_list);
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_Append(py_list, pyicon);
- Py_DECREF(pyicon);
- }
- g_list_free(icon_list);
- return py_list;
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_window_set_default_icon_list args
-static PyObject *
-_wrap_gtk_window_set_default_icon_list(PyGObject *self, PyObject *args)
-{
- GList *icon_list = NULL;
- PyObject *pyicon;
- gint len, i;
-
- len = PyTuple_Size(args);
- for (i = 0; i < len; i++) {
- pyicon = PyTuple_GetItem(args, i);
- if (!pygobject_check(pyicon, &PyGdkPixbuf_Type)) {
- PyErr_SetString(PyExc_TypeError,
- "icons must be GdkPixbufs");
- g_list_free(icon_list);
- return NULL;
- }
- icon_list = g_list_prepend(icon_list, pygobject_get(pyicon));
- }
- gtk_window_set_default_icon_list(icon_list);
- g_list_free(icon_list);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override gtk_window_get_default_icon_list noargs
-static PyObject *
-_wrap_gtk_window_get_default_icon_list(PyGObject *self)
-{
- GList *icon_list = NULL;
- PyObject *pyicon;
-
- if ((icon_list = gtk_window_get_default_icon_list())) {
- PyObject *py_list;
- GList *tmp;
-
- if ((py_list = PyList_New(0)) == NULL) {
- g_list_free(icon_list);
- return NULL;
- }
- for (tmp = icon_list; tmp != NULL; tmp = tmp->next) {
- pyicon = pygobject_new(G_OBJECT(tmp->data));
-
- if (pyicon == NULL) {
- g_list_free(icon_list);
- Py_DECREF(py_list);
- return NULL;
- }
- PyList_Append(py_list, pyicon);
- Py_DECREF(pyicon);
- }
- g_list_free(icon_list);
- return py_list;
- }
- Py_INCREF(Py_None);
- return Py_None;
-}
diff --git a/gtk/keysyms.py b/gtk/keysyms.py
deleted file mode 100644
index 55da5c0f..00000000
--- a/gtk/keysyms.py
+++ /dev/null
@@ -1,1499 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-# pygtk - Python bindings for the GTK toolkit.
-# Copyright (C) 1998-2003 James Henstridge
-#
-# gtk/keysyms.py: list of keysyms.
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-# USA
-
-VoidSymbol = 0xFFFFFF
-BackSpace = 0xFF08
-Tab = 0xFF09
-Linefeed = 0xFF0A
-Clear = 0xFF0B
-Return = 0xFF0D
-Pause = 0xFF13
-Scroll_Lock = 0xFF14
-Sys_Req = 0xFF15
-Escape = 0xFF1B
-Delete = 0xFFFF
-Multi_key = 0xFF20
-Codeinput = 0xFF37
-SingleCandidate = 0xFF3C
-MultipleCandidate = 0xFF3D
-PreviousCandidate = 0xFF3E
-Kanji = 0xFF21
-Muhenkan = 0xFF22
-Henkan_Mode = 0xFF23
-Henkan = 0xFF23
-Romaji = 0xFF24
-Hiragana = 0xFF25
-Katakana = 0xFF26
-Hiragana_Katakana = 0xFF27
-Zenkaku = 0xFF28
-Hankaku = 0xFF29
-Zenkaku_Hankaku = 0xFF2A
-Touroku = 0xFF2B
-Massyo = 0xFF2C
-Kana_Lock = 0xFF2D
-Kana_Shift = 0xFF2E
-Eisu_Shift = 0xFF2F
-Eisu_toggle = 0xFF30
-Kanji_Bangou = 0xFF37
-Zen_Koho = 0xFF3D
-Mae_Koho = 0xFF3E
-Home = 0xFF50
-Left = 0xFF51
-Up = 0xFF52
-Right = 0xFF53
-Down = 0xFF54
-Prior = 0xFF55
-Page_Up = 0xFF55
-Next = 0xFF56
-Page_Down = 0xFF56
-End = 0xFF57
-Begin = 0xFF58
-Select = 0xFF60
-Print = 0xFF61
-Execute = 0xFF62
-Insert = 0xFF63
-Undo = 0xFF65
-Redo = 0xFF66
-Menu = 0xFF67
-Find = 0xFF68
-Cancel = 0xFF69
-Help = 0xFF6A
-Break = 0xFF6B
-Mode_switch = 0xFF7E
-script_switch = 0xFF7E
-Num_Lock = 0xFF7F
-KP_Space = 0xFF80
-KP_Tab = 0xFF89
-KP_Enter = 0xFF8D
-KP_F1 = 0xFF91
-KP_F2 = 0xFF92
-KP_F3 = 0xFF93
-KP_F4 = 0xFF94
-KP_Home = 0xFF95
-KP_Left = 0xFF96
-KP_Up = 0xFF97
-KP_Right = 0xFF98
-KP_Down = 0xFF99
-KP_Prior = 0xFF9A
-KP_Page_Up = 0xFF9A
-KP_Next = 0xFF9B
-KP_Page_Down = 0xFF9B
-KP_End = 0xFF9C
-KP_Begin = 0xFF9D
-KP_Insert = 0xFF9E
-KP_Delete = 0xFF9F
-KP_Equal = 0xFFBD
-KP_Multiply = 0xFFAA
-KP_Add = 0xFFAB
-KP_Separator = 0xFFAC
-KP_Subtract = 0xFFAD
-KP_Decimal = 0xFFAE
-KP_Divide = 0xFFAF
-KP_0 = 0xFFB0
-KP_1 = 0xFFB1
-KP_2 = 0xFFB2
-KP_3 = 0xFFB3
-KP_4 = 0xFFB4
-KP_5 = 0xFFB5
-KP_6 = 0xFFB6
-KP_7 = 0xFFB7
-KP_8 = 0xFFB8
-KP_9 = 0xFFB9
-F1 = 0xFFBE
-F2 = 0xFFBF
-F3 = 0xFFC0
-F4 = 0xFFC1
-F5 = 0xFFC2
-F6 = 0xFFC3
-F7 = 0xFFC4
-F8 = 0xFFC5
-F9 = 0xFFC6
-F10 = 0xFFC7
-F11 = 0xFFC8
-L1 = 0xFFC8
-F12 = 0xFFC9
-L2 = 0xFFC9
-F13 = 0xFFCA
-L3 = 0xFFCA
-F14 = 0xFFCB
-L4 = 0xFFCB
-F15 = 0xFFCC
-L5 = 0xFFCC
-F16 = 0xFFCD
-L6 = 0xFFCD
-F17 = 0xFFCE
-L7 = 0xFFCE
-F18 = 0xFFCF
-L8 = 0xFFCF
-F19 = 0xFFD0
-L9 = 0xFFD0
-F20 = 0xFFD1
-L10 = 0xFFD1
-F21 = 0xFFD2
-R1 = 0xFFD2
-F22 = 0xFFD3
-R2 = 0xFFD3
-F23 = 0xFFD4
-R3 = 0xFFD4
-F24 = 0xFFD5
-R4 = 0xFFD5
-F25 = 0xFFD6
-R5 = 0xFFD6
-F26 = 0xFFD7
-R6 = 0xFFD7
-F27 = 0xFFD8
-R7 = 0xFFD8
-F28 = 0xFFD9
-R8 = 0xFFD9
-F29 = 0xFFDA
-R9 = 0xFFDA
-F30 = 0xFFDB
-R10 = 0xFFDB
-F31 = 0xFFDC
-R11 = 0xFFDC
-F32 = 0xFFDD
-R12 = 0xFFDD
-F33 = 0xFFDE
-R13 = 0xFFDE
-F34 = 0xFFDF
-R14 = 0xFFDF
-F35 = 0xFFE0
-R15 = 0xFFE0
-Shift_L = 0xFFE1
-Shift_R = 0xFFE2
-Control_L = 0xFFE3
-Control_R = 0xFFE4
-Caps_Lock = 0xFFE5
-Shift_Lock = 0xFFE6
-Meta_L = 0xFFE7
-Meta_R = 0xFFE8
-Alt_L = 0xFFE9
-Alt_R = 0xFFEA
-Super_L = 0xFFEB
-Super_R = 0xFFEC
-Hyper_L = 0xFFED
-Hyper_R = 0xFFEE
-ISO_Lock = 0xFE01
-ISO_Level2_Latch = 0xFE02
-ISO_Level3_Shift = 0xFE03
-ISO_Level3_Latch = 0xFE04
-ISO_Level3_Lock = 0xFE05
-ISO_Group_Shift = 0xFF7E
-ISO_Group_Latch = 0xFE06
-ISO_Group_Lock = 0xFE07
-ISO_Next_Group = 0xFE08
-ISO_Next_Group_Lock = 0xFE09
-ISO_Prev_Group = 0xFE0A
-ISO_Prev_Group_Lock = 0xFE0B
-ISO_First_Group = 0xFE0C
-ISO_First_Group_Lock = 0xFE0D
-ISO_Last_Group = 0xFE0E
-ISO_Last_Group_Lock = 0xFE0F
-ISO_Left_Tab = 0xFE20
-ISO_Move_Line_Up = 0xFE21
-ISO_Move_Line_Down = 0xFE22
-ISO_Partial_Line_Up = 0xFE23
-ISO_Partial_Line_Down = 0xFE24
-ISO_Partial_Space_Left = 0xFE25
-ISO_Partial_Space_Right = 0xFE26
-ISO_Set_Margin_Left = 0xFE27
-ISO_Set_Margin_Right = 0xFE28
-ISO_Release_Margin_Left = 0xFE29
-ISO_Release_Margin_Right = 0xFE2A
-ISO_Release_Both_Margins = 0xFE2B
-ISO_Fast_Cursor_Left = 0xFE2C
-ISO_Fast_Cursor_Right = 0xFE2D
-ISO_Fast_Cursor_Up = 0xFE2E
-ISO_Fast_Cursor_Down = 0xFE2F
-ISO_Continuous_Underline = 0xFE30
-ISO_Discontinuous_Underline = 0xFE31
-ISO_Emphasize = 0xFE32
-ISO_Center_Object = 0xFE33
-ISO_Enter = 0xFE34
-dead_grave = 0xFE50
-dead_acute = 0xFE51
-dead_circumflex = 0xFE52
-dead_tilde = 0xFE53
-dead_macron = 0xFE54
-dead_breve = 0xFE55
-dead_abovedot = 0xFE56
-dead_diaeresis = 0xFE57
-dead_abovering = 0xFE58
-dead_doubleacute = 0xFE59
-dead_caron = 0xFE5A
-dead_cedilla = 0xFE5B
-dead_ogonek = 0xFE5C
-dead_iota = 0xFE5D
-dead_voiced_sound = 0xFE5E
-dead_semivoiced_sound = 0xFE5F
-dead_belowdot = 0xFE60
-First_Virtual_Screen = 0xFED0
-Prev_Virtual_Screen = 0xFED1
-Next_Virtual_Screen = 0xFED2
-Last_Virtual_Screen = 0xFED4
-Terminate_Server = 0xFED5
-AccessX_Enable = 0xFE70
-AccessX_Feedback_Enable = 0xFE71
-RepeatKeys_Enable = 0xFE72
-SlowKeys_Enable = 0xFE73
-BounceKeys_Enable = 0xFE74
-StickyKeys_Enable = 0xFE75
-MouseKeys_Enable = 0xFE76
-MouseKeys_Accel_Enable = 0xFE77
-Overlay1_Enable = 0xFE78
-Overlay2_Enable = 0xFE79
-AudibleBell_Enable = 0xFE7A
-Pointer_Left = 0xFEE0
-Pointer_Right = 0xFEE1
-Pointer_Up = 0xFEE2
-Pointer_Down = 0xFEE3
-Pointer_UpLeft = 0xFEE4
-Pointer_UpRight = 0xFEE5
-Pointer_DownLeft = 0xFEE6
-Pointer_DownRight = 0xFEE7
-Pointer_Button_Dflt = 0xFEE8
-Pointer_Button1 = 0xFEE9
-Pointer_Button2 = 0xFEEA
-Pointer_Button3 = 0xFEEB
-Pointer_Button4 = 0xFEEC
-Pointer_Button5 = 0xFEED
-Pointer_DblClick_Dflt = 0xFEEE
-Pointer_DblClick1 = 0xFEEF
-Pointer_DblClick2 = 0xFEF0
-Pointer_DblClick3 = 0xFEF1
-Pointer_DblClick4 = 0xFEF2
-Pointer_DblClick5 = 0xFEF3
-Pointer_Drag_Dflt = 0xFEF4
-Pointer_Drag1 = 0xFEF5
-Pointer_Drag2 = 0xFEF6
-Pointer_Drag3 = 0xFEF7
-Pointer_Drag4 = 0xFEF8
-Pointer_Drag5 = 0xFEFD
-Pointer_EnableKeys = 0xFEF9
-Pointer_Accelerate = 0xFEFA
-Pointer_DfltBtnNext = 0xFEFB
-Pointer_DfltBtnPrev = 0xFEFC
-_3270_Duplicate = 0xFD01
-_3270_FieldMark = 0xFD02
-_3270_Right2 = 0xFD03
-_3270_Left2 = 0xFD04
-_3270_BackTab = 0xFD05
-_3270_EraseEOF = 0xFD06
-_3270_EraseInput = 0xFD07
-_3270_Reset = 0xFD08
-_3270_Quit = 0xFD09
-_3270_PA1 = 0xFD0A
-_3270_PA2 = 0xFD0B
-_3270_PA3 = 0xFD0C
-_3270_Test = 0xFD0D
-_3270_Attn = 0xFD0E
-_3270_CursorBlink = 0xFD0F
-_3270_AltCursor = 0xFD10
-_3270_KeyClick = 0xFD11
-_3270_Jump = 0xFD12
-_3270_Ident = 0xFD13
-_3270_Rule = 0xFD14
-_3270_Copy = 0xFD15
-_3270_Play = 0xFD16
-_3270_Setup = 0xFD17
-_3270_Record = 0xFD18
-_3270_ChangeScreen = 0xFD19
-_3270_DeleteWord = 0xFD1A
-_3270_ExSelect = 0xFD1B
-_3270_CursorSelect = 0xFD1C
-_3270_PrintScreen = 0xFD1D
-_3270_Enter = 0xFD1E
-space = 0x020
-exclam = 0x021
-quotedbl = 0x022
-numbersign = 0x023
-dollar = 0x024
-percent = 0x025
-ampersand = 0x026
-apostrophe = 0x027
-quoteright = 0x027
-parenleft = 0x028
-parenright = 0x029
-asterisk = 0x02a
-plus = 0x02b
-comma = 0x02c
-minus = 0x02d
-period = 0x02e
-slash = 0x02f
-_0 = 0x030
-_1 = 0x031
-_2 = 0x032
-_3 = 0x033
-_4 = 0x034
-_5 = 0x035
-_6 = 0x036
-_7 = 0x037
-_8 = 0x038
-_9 = 0x039
-colon = 0x03a
-semicolon = 0x03b
-less = 0x03c
-equal = 0x03d
-greater = 0x03e
-question = 0x03f
-at = 0x040
-A = 0x041
-B = 0x042
-C = 0x043
-D = 0x044
-E = 0x045
-F = 0x046
-G = 0x047
-H = 0x048
-I = 0x049
-J = 0x04a
-K = 0x04b
-L = 0x04c
-M = 0x04d
-N = 0x04e
-O = 0x04f
-P = 0x050
-Q = 0x051
-R = 0x052
-S = 0x053
-T = 0x054
-U = 0x055
-V = 0x056
-W = 0x057
-X = 0x058
-Y = 0x059
-Z = 0x05a
-bracketleft = 0x05b
-backslash = 0x05c
-bracketright = 0x05d
-asciicircum = 0x05e
-underscore = 0x05f
-grave = 0x060
-quoteleft = 0x060
-a = 0x061
-b = 0x062
-c = 0x063
-d = 0x064
-e = 0x065
-f = 0x066
-g = 0x067
-h = 0x068
-i = 0x069
-j = 0x06a
-k = 0x06b
-l = 0x06c
-m = 0x06d
-n = 0x06e
-o = 0x06f
-p = 0x070
-q = 0x071
-r = 0x072
-s = 0x073
-t = 0x074
-u = 0x075
-v = 0x076
-w = 0x077
-x = 0x078
-y = 0x079
-z = 0x07a
-braceleft = 0x07b
-bar = 0x07c
-braceright = 0x07d
-asciitilde = 0x07e
-nobreakspace = 0x0a0
-exclamdown = 0x0a1
-cent = 0x0a2
-sterling = 0x0a3
-currency = 0x0a4
-yen = 0x0a5
-brokenbar = 0x0a6
-section = 0x0a7
-diaeresis = 0x0a8
-copyright = 0x0a9
-ordfeminine = 0x0aa
-guillemotleft = 0x0ab
-notsign = 0x0ac
-hyphen = 0x0ad
-registered = 0x0ae
-macron = 0x0af
-degree = 0x0b0
-plusminus = 0x0b1
-twosuperior = 0x0b2
-threesuperior = 0x0b3
-acute = 0x0b4
-mu = 0x0b5
-paragraph = 0x0b6
-periodcentered = 0x0b7
-cedilla = 0x0b8
-onesuperior = 0x0b9
-masculine = 0x0ba
-guillemotright = 0x0bb
-onequarter = 0x0bc
-onehalf = 0x0bd
-threequarters = 0x0be
-questiondown = 0x0bf
-Agrave = 0x0c0
-Aacute = 0x0c1
-Acircumflex = 0x0c2
-Atilde = 0x0c3
-Adiaeresis = 0x0c4
-Aring = 0x0c5
-AE = 0x0c6
-Ccedilla = 0x0c7
-Egrave = 0x0c8
-Eacute = 0x0c9
-Ecircumflex = 0x0ca
-Ediaeresis = 0x0cb
-Igrave = 0x0cc
-Iacute = 0x0cd
-Icircumflex = 0x0ce
-Idiaeresis = 0x0cf
-ETH = 0x0d0
-Eth = 0x0d0
-Ntilde = 0x0d1
-Ograve = 0x0d2
-Oacute = 0x0d3
-Ocircumflex = 0x0d4
-Otilde = 0x0d5
-Odiaeresis = 0x0d6
-multiply = 0x0d7
-Ooblique = 0x0d8
-Ugrave = 0x0d9
-Uacute = 0x0da
-Ucircumflex = 0x0db
-Udiaeresis = 0x0dc
-Yacute = 0x0dd
-THORN = 0x0de
-Thorn = 0x0de
-ssharp = 0x0df
-agrave = 0x0e0
-aacute = 0x0e1
-acircumflex = 0x0e2
-atilde = 0x0e3
-adiaeresis = 0x0e4
-aring = 0x0e5
-ae = 0x0e6
-ccedilla = 0x0e7
-egrave = 0x0e8
-eacute = 0x0e9
-ecircumflex = 0x0ea
-ediaeresis = 0x0eb
-igrave = 0x0ec
-iacute = 0x0ed
-icircumflex = 0x0ee
-idiaeresis = 0x0ef
-eth = 0x0f0
-ntilde = 0x0f1
-ograve = 0x0f2
-oacute = 0x0f3
-ocircumflex = 0x0f4
-otilde = 0x0f5
-odiaeresis = 0x0f6
-division = 0x0f7
-oslash = 0x0f8
-ugrave = 0x0f9
-uacute = 0x0fa
-ucircumflex = 0x0fb
-udiaeresis = 0x0fc
-yacute = 0x0fd
-thorn = 0x0fe
-ydiaeresis = 0x0ff
-Aogonek = 0x1a1
-breve = 0x1a2
-Lstroke = 0x1a3
-Lcaron = 0x1a5
-Sacute = 0x1a6
-Scaron = 0x1a9
-Scedilla = 0x1aa
-Tcaron = 0x1ab
-Zacute = 0x1ac
-Zcaron = 0x1ae
-Zabovedot = 0x1af
-aogonek = 0x1b1
-ogonek = 0x1b2
-lstroke = 0x1b3
-lcaron = 0x1b5
-sacute = 0x1b6
-caron = 0x1b7
-scaron = 0x1b9
-scedilla = 0x1ba
-tcaron = 0x1bb
-zacute = 0x1bc
-doubleacute = 0x1bd
-zcaron = 0x1be
-zabovedot = 0x1bf
-Racute = 0x1c0
-Abreve = 0x1c3
-Lacute = 0x1c5
-Cacute = 0x1c6
-Ccaron = 0x1c8
-Eogonek = 0x1ca
-Ecaron = 0x1cc
-Dcaron = 0x1cf
-Dstroke = 0x1d0
-Nacute = 0x1d1
-Ncaron = 0x1d2
-Odoubleacute = 0x1d5
-Rcaron = 0x1d8
-Uring = 0x1d9
-Udoubleacute = 0x1db
-Tcedilla = 0x1de
-racute = 0x1e0
-abreve = 0x1e3
-lacute = 0x1e5
-cacute = 0x1e6
-ccaron = 0x1e8
-eogonek = 0x1ea
-ecaron = 0x1ec
-dcaron = 0x1ef
-dstroke = 0x1f0
-nacute = 0x1f1
-ncaron = 0x1f2
-odoubleacute = 0x1f5
-udoubleacute = 0x1fb
-rcaron = 0x1f8
-uring = 0x1f9
-tcedilla = 0x1fe
-abovedot = 0x1ff
-Hstroke = 0x2a1
-Hcircumflex = 0x2a6
-Iabovedot = 0x2a9
-Gbreve = 0x2ab
-Jcircumflex = 0x2ac
-hstroke = 0x2b1
-hcircumflex = 0x2b6
-idotless = 0x2b9
-gbreve = 0x2bb
-jcircumflex = 0x2bc
-Cabovedot = 0x2c5
-Ccircumflex = 0x2c6
-Gabovedot = 0x2d5
-Gcircumflex = 0x2d8
-Ubreve = 0x2dd
-Scircumflex = 0x2de
-cabovedot = 0x2e5
-ccircumflex = 0x2e6
-gabovedot = 0x2f5
-gcircumflex = 0x2f8
-ubreve = 0x2fd
-scircumflex = 0x2fe
-kra = 0x3a2
-kappa = 0x3a2
-Rcedilla = 0x3a3
-Itilde = 0x3a5
-Lcedilla = 0x3a6
-Emacron = 0x3aa
-Gcedilla = 0x3ab
-Tslash = 0x3ac
-rcedilla = 0x3b3
-itilde = 0x3b5
-lcedilla = 0x3b6
-emacron = 0x3ba
-gcedilla = 0x3bb
-tslash = 0x3bc
-ENG = 0x3bd
-eng = 0x3bf
-Amacron = 0x3c0
-Iogonek = 0x3c7
-Eabovedot = 0x3cc
-Imacron = 0x3cf
-Ncedilla = 0x3d1
-Omacron = 0x3d2
-Kcedilla = 0x3d3
-Uogonek = 0x3d9
-Utilde = 0x3dd
-Umacron = 0x3de
-amacron = 0x3e0
-iogonek = 0x3e7
-eabovedot = 0x3ec
-imacron = 0x3ef
-ncedilla = 0x3f1
-omacron = 0x3f2
-kcedilla = 0x3f3
-uogonek = 0x3f9
-utilde = 0x3fd
-umacron = 0x3fe
-OE = 0x13bc
-oe = 0x13bd
-Ydiaeresis = 0x13be
-overline = 0x47e
-kana_fullstop = 0x4a1
-kana_openingbracket = 0x4a2
-kana_closingbracket = 0x4a3
-kana_comma = 0x4a4
-kana_conjunctive = 0x4a5
-kana_middledot = 0x4a5
-kana_WO = 0x4a6
-kana_a = 0x4a7
-kana_i = 0x4a8
-kana_u = 0x4a9
-kana_e = 0x4aa
-kana_o = 0x4ab
-kana_ya = 0x4ac
-kana_yu = 0x4ad
-kana_yo = 0x4ae
-kana_tsu = 0x4af
-kana_tu = 0x4af
-prolongedsound = 0x4b0
-kana_A = 0x4b1
-kana_I = 0x4b2
-kana_U = 0x4b3
-kana_E = 0x4b4
-kana_O = 0x4b5
-kana_KA = 0x4b6
-kana_KI = 0x4b7
-kana_KU = 0x4b8
-kana_KE = 0x4b9
-kana_KO = 0x4ba
-kana_SA = 0x4bb
-kana_SHI = 0x4bc
-kana_SU = 0x4bd
-kana_SE = 0x4be
-kana_SO = 0x4bf
-kana_TA = 0x4c0
-kana_CHI = 0x4c1
-kana_TI = 0x4c1
-kana_TSU = 0x4c2
-kana_TU = 0x4c2
-kana_TE = 0x4c3
-kana_TO = 0x4c4
-kana_NA = 0x4c5
-kana_NI = 0x4c6
-kana_NU = 0x4c7
-kana_NE = 0x4c8
-kana_NO = 0x4c9
-kana_HA = 0x4ca
-kana_HI = 0x4cb
-kana_FU = 0x4cc
-kana_HU = 0x4cc
-kana_HE = 0x4cd
-kana_HO = 0x4ce
-kana_MA = 0x4cf
-kana_MI = 0x4d0
-kana_MU = 0x4d1
-kana_ME = 0x4d2
-kana_MO = 0x4d3
-kana_YA = 0x4d4
-kana_YU = 0x4d5
-kana_YO = 0x4d6
-kana_RA = 0x4d7
-kana_RI = 0x4d8
-kana_RU = 0x4d9
-kana_RE = 0x4da
-kana_RO = 0x4db
-kana_WA = 0x4dc
-kana_N = 0x4dd
-voicedsound = 0x4de
-semivoicedsound = 0x4df
-kana_switch = 0xFF7E
-Arabic_comma = 0x5ac
-Arabic_semicolon = 0x5bb
-Arabic_question_mark = 0x5bf
-Arabic_hamza = 0x5c1
-Arabic_maddaonalef = 0x5c2
-Arabic_hamzaonalef = 0x5c3
-Arabic_hamzaonwaw = 0x5c4
-Arabic_hamzaunderalef = 0x5c5
-Arabic_hamzaonyeh = 0x5c6
-Arabic_alef = 0x5c7
-Arabic_beh = 0x5c8
-Arabic_tehmarbuta = 0x5c9
-Arabic_teh = 0x5ca
-Arabic_theh = 0x5cb
-Arabic_jeem = 0x5cc
-Arabic_hah = 0x5cd
-Arabic_khah = 0x5ce
-Arabic_dal = 0x5cf
-Arabic_thal = 0x5d0
-Arabic_ra = 0x5d1
-Arabic_zain = 0x5d2
-Arabic_seen = 0x5d3
-Arabic_sheen = 0x5d4
-Arabic_sad = 0x5d5
-Arabic_dad = 0x5d6
-Arabic_tah = 0x5d7
-Arabic_zah = 0x5d8
-Arabic_ain = 0x5d9
-Arabic_ghain = 0x5da
-Arabic_tatweel = 0x5e0
-Arabic_feh = 0x5e1
-Arabic_qaf = 0x5e2
-Arabic_kaf = 0x5e3
-Arabic_lam = 0x5e4
-Arabic_meem = 0x5e5
-Arabic_noon = 0x5e6
-Arabic_ha = 0x5e7
-Arabic_heh = 0x5e7
-Arabic_waw = 0x5e8
-Arabic_alefmaksura = 0x5e9
-Arabic_yeh = 0x5ea
-Arabic_fathatan = 0x5eb
-Arabic_dammatan = 0x5ec
-Arabic_kasratan = 0x5ed
-Arabic_fatha = 0x5ee
-Arabic_damma = 0x5ef
-Arabic_kasra = 0x5f0
-Arabic_shadda = 0x5f1
-Arabic_sukun = 0x5f2
-Arabic_switch = 0xFF7E
-Serbian_dje = 0x6a1
-Macedonia_gje = 0x6a2
-Cyrillic_io = 0x6a3
-Ukrainian_ie = 0x6a4
-Ukranian_je = 0x6a4
-Macedonia_dse = 0x6a5
-Ukrainian_i = 0x6a6
-Ukranian_i = 0x6a6
-Ukrainian_yi = 0x6a7
-Ukranian_yi = 0x6a7
-Cyrillic_je = 0x6a8
-Serbian_je = 0x6a8
-Cyrillic_lje = 0x6a9
-Serbian_lje = 0x6a9
-Cyrillic_nje = 0x6aa
-Serbian_nje = 0x6aa
-Serbian_tshe = 0x6ab
-Macedonia_kje = 0x6ac
-Ukrainian_ghe_with_upturn = 0x6ad
-Byelorussian_shortu = 0x6ae
-Cyrillic_dzhe = 0x6af
-Serbian_dze = 0x6af
-numerosign = 0x6b0
-Serbian_DJE = 0x6b1
-Macedonia_GJE = 0x6b2
-Cyrillic_IO = 0x6b3
-Ukrainian_IE = 0x6b4
-Ukranian_JE = 0x6b4
-Macedonia_DSE = 0x6b5
-Ukrainian_I = 0x6b6
-Ukranian_I = 0x6b6
-Ukrainian_YI = 0x6b7
-Ukranian_YI = 0x6b7
-Cyrillic_JE = 0x6b8
-Serbian_JE = 0x6b8
-Cyrillic_LJE = 0x6b9
-Serbian_LJE = 0x6b9
-Cyrillic_NJE = 0x6ba
-Serbian_NJE = 0x6ba
-Serbian_TSHE = 0x6bb
-Macedonia_KJE = 0x6bc
-Ukrainian_GHE_WITH_UPTURN = 0x6bd
-Byelorussian_SHORTU = 0x6be
-Cyrillic_DZHE = 0x6bf
-Serbian_DZE = 0x6bf
-Cyrillic_yu = 0x6c0
-Cyrillic_a = 0x6c1
-Cyrillic_be = 0x6c2
-Cyrillic_tse = 0x6c3
-Cyrillic_de = 0x6c4
-Cyrillic_ie = 0x6c5
-Cyrillic_ef = 0x6c6
-Cyrillic_ghe = 0x6c7
-Cyrillic_ha = 0x6c8
-Cyrillic_i = 0x6c9
-Cyrillic_shorti = 0x6ca
-Cyrillic_ka = 0x6cb
-Cyrillic_el = 0x6cc
-Cyrillic_em = 0x6cd
-Cyrillic_en = 0x6ce
-Cyrillic_o = 0x6cf
-Cyrillic_pe = 0x6d0
-Cyrillic_ya = 0x6d1
-Cyrillic_er = 0x6d2
-Cyrillic_es = 0x6d3
-Cyrillic_te = 0x6d4
-Cyrillic_u = 0x6d5
-Cyrillic_zhe = 0x6d6
-Cyrillic_ve = 0x6d7
-Cyrillic_softsign = 0x6d8
-Cyrillic_yeru = 0x6d9
-Cyrillic_ze = 0x6da
-Cyrillic_sha = 0x6db
-Cyrillic_e = 0x6dc
-Cyrillic_shcha = 0x6dd
-Cyrillic_che = 0x6de
-Cyrillic_hardsign = 0x6df
-Cyrillic_YU = 0x6e0
-Cyrillic_A = 0x6e1
-Cyrillic_BE = 0x6e2
-Cyrillic_TSE = 0x6e3
-Cyrillic_DE = 0x6e4
-Cyrillic_IE = 0x6e5
-Cyrillic_EF = 0x6e6
-Cyrillic_GHE = 0x6e7
-Cyrillic_HA = 0x6e8
-Cyrillic_I = 0x6e9
-Cyrillic_SHORTI = 0x6ea
-Cyrillic_KA = 0x6eb
-Cyrillic_EL = 0x6ec
-Cyrillic_EM = 0x6ed
-Cyrillic_EN = 0x6ee
-Cyrillic_O = 0x6ef
-Cyrillic_PE = 0x6f0
-Cyrillic_YA = 0x6f1
-Cyrillic_ER = 0x6f2
-Cyrillic_ES = 0x6f3
-Cyrillic_TE = 0x6f4
-Cyrillic_U = 0x6f5
-Cyrillic_ZHE = 0x6f6
-Cyrillic_VE = 0x6f7
-Cyrillic_SOFTSIGN = 0x6f8
-Cyrillic_YERU = 0x6f9
-Cyrillic_ZE = 0x6fa
-Cyrillic_SHA = 0x6fb
-Cyrillic_E = 0x6fc
-Cyrillic_SHCHA = 0x6fd
-Cyrillic_CHE = 0x6fe
-Cyrillic_HARDSIGN = 0x6ff
-Greek_ALPHAaccent = 0x7a1
-Greek_EPSILONaccent = 0x7a2
-Greek_ETAaccent = 0x7a3
-Greek_IOTAaccent = 0x7a4
-Greek_IOTAdiaeresis = 0x7a5
-Greek_OMICRONaccent = 0x7a7
-Greek_UPSILONaccent = 0x7a8
-Greek_UPSILONdieresis = 0x7a9
-Greek_OMEGAaccent = 0x7ab
-Greek_accentdieresis = 0x7ae
-Greek_horizbar = 0x7af
-Greek_alphaaccent = 0x7b1
-Greek_epsilonaccent = 0x7b2
-Greek_etaaccent = 0x7b3
-Greek_iotaaccent = 0x7b4
-Greek_iotadieresis = 0x7b5
-Greek_iotaaccentdieresis = 0x7b6
-Greek_omicronaccent = 0x7b7
-Greek_upsilonaccent = 0x7b8
-Greek_upsilondieresis = 0x7b9
-Greek_upsilonaccentdieresis = 0x7ba
-Greek_omegaaccent = 0x7bb
-Greek_ALPHA = 0x7c1
-Greek_BETA = 0x7c2
-Greek_GAMMA = 0x7c3
-Greek_DELTA = 0x7c4
-Greek_EPSILON = 0x7c5
-Greek_ZETA = 0x7c6
-Greek_ETA = 0x7c7
-Greek_THETA = 0x7c8
-Greek_IOTA = 0x7c9
-Greek_KAPPA = 0x7ca
-Greek_LAMDA = 0x7cb
-Greek_LAMBDA = 0x7cb
-Greek_MU = 0x7cc
-Greek_NU = 0x7cd
-Greek_XI = 0x7ce
-Greek_OMICRON = 0x7cf
-Greek_PI = 0x7d0
-Greek_RHO = 0x7d1
-Greek_SIGMA = 0x7d2
-Greek_TAU = 0x7d4
-Greek_UPSILON = 0x7d5
-Greek_PHI = 0x7d6
-Greek_CHI = 0x7d7
-Greek_PSI = 0x7d8
-Greek_OMEGA = 0x7d9
-Greek_alpha = 0x7e1
-Greek_beta = 0x7e2
-Greek_gamma = 0x7e3
-Greek_delta = 0x7e4
-Greek_epsilon = 0x7e5
-Greek_zeta = 0x7e6
-Greek_eta = 0x7e7
-Greek_theta = 0x7e8
-Greek_iota = 0x7e9
-Greek_kappa = 0x7ea
-Greek_lamda = 0x7eb
-Greek_lambda = 0x7eb
-Greek_mu = 0x7ec
-Greek_nu = 0x7ed
-Greek_xi = 0x7ee
-Greek_omicron = 0x7ef
-Greek_pi = 0x7f0
-Greek_rho = 0x7f1
-Greek_sigma = 0x7f2
-Greek_finalsmallsigma = 0x7f3
-Greek_tau = 0x7f4
-Greek_upsilon = 0x7f5
-Greek_phi = 0x7f6
-Greek_chi = 0x7f7
-Greek_psi = 0x7f8
-Greek_omega = 0x7f9
-Greek_switch = 0xFF7E
-leftradical = 0x8a1
-topleftradical = 0x8a2
-horizconnector = 0x8a3
-topintegral = 0x8a4
-botintegral = 0x8a5
-vertconnector = 0x8a6
-topleftsqbracket = 0x8a7
-botleftsqbracket = 0x8a8
-toprightsqbracket = 0x8a9
-botrightsqbracket = 0x8aa
-topleftparens = 0x8ab
-botleftparens = 0x8ac
-toprightparens = 0x8ad
-botrightparens = 0x8ae
-leftmiddlecurlybrace = 0x8af
-rightmiddlecurlybrace = 0x8b0
-topleftsummation = 0x8b1
-botleftsummation = 0x8b2
-topvertsummationconnector = 0x8b3
-botvertsummationconnector = 0x8b4
-toprightsummation = 0x8b5
-botrightsummation = 0x8b6
-rightmiddlesummation = 0x8b7
-lessthanequal = 0x8bc
-notequal = 0x8bd
-greaterthanequal = 0x8be
-integral = 0x8bf
-therefore = 0x8c0
-variation = 0x8c1
-infinity = 0x8c2
-nabla = 0x8c5
-approximate = 0x8c8
-similarequal = 0x8c9
-ifonlyif = 0x8cd
-implies = 0x8ce
-identical = 0x8cf
-radical = 0x8d6
-includedin = 0x8da
-includes = 0x8db
-intersection = 0x8dc
-union = 0x8dd
-logicaland = 0x8de
-logicalor = 0x8df
-partialderivative = 0x8ef
-function = 0x8f6
-leftarrow = 0x8fb
-uparrow = 0x8fc
-rightarrow = 0x8fd
-downarrow = 0x8fe
-blank = 0x9df
-soliddiamond = 0x9e0
-checkerboard = 0x9e1
-ht = 0x9e2
-ff = 0x9e3
-cr = 0x9e4
-lf = 0x9e5
-nl = 0x9e8
-vt = 0x9e9
-lowrightcorner = 0x9ea
-uprightcorner = 0x9eb
-upleftcorner = 0x9ec
-lowleftcorner = 0x9ed
-crossinglines = 0x9ee
-horizlinescan1 = 0x9ef
-horizlinescan3 = 0x9f0
-horizlinescan5 = 0x9f1
-horizlinescan7 = 0x9f2
-horizlinescan9 = 0x9f3
-leftt = 0x9f4
-rightt = 0x9f5
-bott = 0x9f6
-topt = 0x9f7
-vertbar = 0x9f8
-emspace = 0xaa1
-enspace = 0xaa2
-em3space = 0xaa3
-em4space = 0xaa4
-digitspace = 0xaa5
-punctspace = 0xaa6
-thinspace = 0xaa7
-hairspace = 0xaa8
-emdash = 0xaa9
-endash = 0xaaa
-signifblank = 0xaac
-ellipsis = 0xaae
-doubbaselinedot = 0xaaf
-onethird = 0xab0
-twothirds = 0xab1
-onefifth = 0xab2
-twofifths = 0xab3
-threefifths = 0xab4
-fourfifths = 0xab5
-onesixth = 0xab6
-fivesixths = 0xab7
-careof = 0xab8
-figdash = 0xabb
-leftanglebracket = 0xabc
-decimalpoint = 0xabd
-rightanglebracket = 0xabe
-marker = 0xabf
-oneeighth = 0xac3
-threeeighths = 0xac4
-fiveeighths = 0xac5
-seveneighths = 0xac6
-trademark = 0xac9
-signaturemark = 0xaca
-trademarkincircle = 0xacb
-leftopentriangle = 0xacc
-rightopentriangle = 0xacd
-emopencircle = 0xace
-emopenrectangle = 0xacf
-leftsinglequotemark = 0xad0
-rightsinglequotemark = 0xad1
-leftdoublequotemark = 0xad2
-rightdoublequotemark = 0xad3
-prescription = 0xad4
-minutes = 0xad6
-seconds = 0xad7
-latincross = 0xad9
-hexagram = 0xada
-filledrectbullet = 0xadb
-filledlefttribullet = 0xadc
-filledrighttribullet = 0xadd
-emfilledcircle = 0xade
-emfilledrect = 0xadf
-enopencircbullet = 0xae0
-enopensquarebullet = 0xae1
-openrectbullet = 0xae2
-opentribulletup = 0xae3
-opentribulletdown = 0xae4
-openstar = 0xae5
-enfilledcircbullet = 0xae6
-enfilledsqbullet = 0xae7
-filledtribulletup = 0xae8
-filledtribulletdown = 0xae9
-leftpointer = 0xaea
-rightpointer = 0xaeb
-club = 0xaec
-diamond = 0xaed
-heart = 0xaee
-maltesecross = 0xaf0
-dagger = 0xaf1
-doubledagger = 0xaf2
-checkmark = 0xaf3
-ballotcross = 0xaf4
-musicalsharp = 0xaf5
-musicalflat = 0xaf6
-malesymbol = 0xaf7
-femalesymbol = 0xaf8
-telephone = 0xaf9
-telephonerecorder = 0xafa
-phonographcopyright = 0xafb
-caret = 0xafc
-singlelowquotemark = 0xafd
-doublelowquotemark = 0xafe
-cursor = 0xaff
-leftcaret = 0xba3
-rightcaret = 0xba6
-downcaret = 0xba8
-upcaret = 0xba9
-overbar = 0xbc0
-downtack = 0xbc2
-upshoe = 0xbc3
-downstile = 0xbc4
-underbar = 0xbc6
-jot = 0xbca
-quad = 0xbcc
-uptack = 0xbce
-circle = 0xbcf
-upstile = 0xbd3
-downshoe = 0xbd6
-rightshoe = 0xbd8
-leftshoe = 0xbda
-lefttack = 0xbdc
-righttack = 0xbfc
-hebrew_doublelowline = 0xcdf
-hebrew_aleph = 0xce0
-hebrew_bet = 0xce1
-hebrew_beth = 0xce1
-hebrew_gimel = 0xce2
-hebrew_gimmel = 0xce2
-hebrew_dalet = 0xce3
-hebrew_daleth = 0xce3
-hebrew_he = 0xce4
-hebrew_waw = 0xce5
-hebrew_zain = 0xce6
-hebrew_zayin = 0xce6
-hebrew_chet = 0xce7
-hebrew_het = 0xce7
-hebrew_tet = 0xce8
-hebrew_teth = 0xce8
-hebrew_yod = 0xce9
-hebrew_finalkaph = 0xcea
-hebrew_kaph = 0xceb
-hebrew_lamed = 0xcec
-hebrew_finalmem = 0xced
-hebrew_mem = 0xcee
-hebrew_finalnun = 0xcef
-hebrew_nun = 0xcf0
-hebrew_samech = 0xcf1
-hebrew_samekh = 0xcf1
-hebrew_ayin = 0xcf2
-hebrew_finalpe = 0xcf3
-hebrew_pe = 0xcf4
-hebrew_finalzade = 0xcf5
-hebrew_finalzadi = 0xcf5
-hebrew_zade = 0xcf6
-hebrew_zadi = 0xcf6
-hebrew_qoph = 0xcf7
-hebrew_kuf = 0xcf7
-hebrew_resh = 0xcf8
-hebrew_shin = 0xcf9
-hebrew_taw = 0xcfa
-hebrew_taf = 0xcfa
-Hebrew_switch = 0xFF7E
-Thai_kokai = 0xda1
-Thai_khokhai = 0xda2
-Thai_khokhuat = 0xda3
-Thai_khokhwai = 0xda4
-Thai_khokhon = 0xda5
-Thai_khorakhang = 0xda6
-Thai_ngongu = 0xda7
-Thai_chochan = 0xda8
-Thai_choching = 0xda9
-Thai_chochang = 0xdaa
-Thai_soso = 0xdab
-Thai_chochoe = 0xdac
-Thai_yoying = 0xdad
-Thai_dochada = 0xdae
-Thai_topatak = 0xdaf
-Thai_thothan = 0xdb0
-Thai_thonangmontho = 0xdb1
-Thai_thophuthao = 0xdb2
-Thai_nonen = 0xdb3
-Thai_dodek = 0xdb4
-Thai_totao = 0xdb5
-Thai_thothung = 0xdb6
-Thai_thothahan = 0xdb7
-Thai_thothong = 0xdb8
-Thai_nonu = 0xdb9
-Thai_bobaimai = 0xdba
-Thai_popla = 0xdbb
-Thai_phophung = 0xdbc
-Thai_fofa = 0xdbd
-Thai_phophan = 0xdbe
-Thai_fofan = 0xdbf
-Thai_phosamphao = 0xdc0
-Thai_moma = 0xdc1
-Thai_yoyak = 0xdc2
-Thai_rorua = 0xdc3
-Thai_ru = 0xdc4
-Thai_loling = 0xdc5
-Thai_lu = 0xdc6
-Thai_wowaen = 0xdc7
-Thai_sosala = 0xdc8
-Thai_sorusi = 0xdc9
-Thai_sosua = 0xdca
-Thai_hohip = 0xdcb
-Thai_lochula = 0xdcc
-Thai_oang = 0xdcd
-Thai_honokhuk = 0xdce
-Thai_paiyannoi = 0xdcf
-Thai_saraa = 0xdd0
-Thai_maihanakat = 0xdd1
-Thai_saraaa = 0xdd2
-Thai_saraam = 0xdd3
-Thai_sarai = 0xdd4
-Thai_saraii = 0xdd5
-Thai_saraue = 0xdd6
-Thai_sarauee = 0xdd7
-Thai_sarau = 0xdd8
-Thai_sarauu = 0xdd9
-Thai_phinthu = 0xdda
-Thai_maihanakat_maitho = 0xdde
-Thai_baht = 0xddf
-Thai_sarae = 0xde0
-Thai_saraae = 0xde1
-Thai_sarao = 0xde2
-Thai_saraaimaimuan = 0xde3
-Thai_saraaimaimalai = 0xde4
-Thai_lakkhangyao = 0xde5
-Thai_maiyamok = 0xde6
-Thai_maitaikhu = 0xde7
-Thai_maiek = 0xde8
-Thai_maitho = 0xde9
-Thai_maitri = 0xdea
-Thai_maichattawa = 0xdeb
-Thai_thanthakhat = 0xdec
-Thai_nikhahit = 0xded
-Thai_leksun = 0xdf0
-Thai_leknung = 0xdf1
-Thai_leksong = 0xdf2
-Thai_leksam = 0xdf3
-Thai_leksi = 0xdf4
-Thai_lekha = 0xdf5
-Thai_lekhok = 0xdf6
-Thai_lekchet = 0xdf7
-Thai_lekpaet = 0xdf8
-Thai_lekkao = 0xdf9
-Hangul = 0xff31
-Hangul_Start = 0xff32
-Hangul_End = 0xff33
-Hangul_Hanja = 0xff34
-Hangul_Jamo = 0xff35
-Hangul_Romaja = 0xff36
-Hangul_Codeinput = 0xff37
-Hangul_Jeonja = 0xff38
-Hangul_Banja = 0xff39
-Hangul_PreHanja = 0xff3a
-Hangul_PostHanja = 0xff3b
-Hangul_SingleCandidate = 0xff3c
-Hangul_MultipleCandidate = 0xff3d
-Hangul_PreviousCandidate = 0xff3e
-Hangul_Special = 0xff3f
-Hangul_switch = 0xFF7E
-Hangul_Kiyeog = 0xea1
-Hangul_SsangKiyeog = 0xea2
-Hangul_KiyeogSios = 0xea3
-Hangul_Nieun = 0xea4
-Hangul_NieunJieuj = 0xea5
-Hangul_NieunHieuh = 0xea6
-Hangul_Dikeud = 0xea7
-Hangul_SsangDikeud = 0xea8
-Hangul_Rieul = 0xea9
-Hangul_RieulKiyeog = 0xeaa
-Hangul_RieulMieum = 0xeab
-Hangul_RieulPieub = 0xeac
-Hangul_RieulSios = 0xead
-Hangul_RieulTieut = 0xeae
-Hangul_RieulPhieuf = 0xeaf
-Hangul_RieulHieuh = 0xeb0
-Hangul_Mieum = 0xeb1
-Hangul_Pieub = 0xeb2
-Hangul_SsangPieub = 0xeb3
-Hangul_PieubSios = 0xeb4
-Hangul_Sios = 0xeb5
-Hangul_SsangSios = 0xeb6
-Hangul_Ieung = 0xeb7
-Hangul_Jieuj = 0xeb8
-Hangul_SsangJieuj = 0xeb9
-Hangul_Cieuc = 0xeba
-Hangul_Khieuq = 0xebb
-Hangul_Tieut = 0xebc
-Hangul_Phieuf = 0xebd
-Hangul_Hieuh = 0xebe
-Hangul_A = 0xebf
-Hangul_AE = 0xec0
-Hangul_YA = 0xec1
-Hangul_YAE = 0xec2
-Hangul_EO = 0xec3
-Hangul_E = 0xec4
-Hangul_YEO = 0xec5
-Hangul_YE = 0xec6
-Hangul_O = 0xec7
-Hangul_WA = 0xec8
-Hangul_WAE = 0xec9
-Hangul_OE = 0xeca
-Hangul_YO = 0xecb
-Hangul_U = 0xecc
-Hangul_WEO = 0xecd
-Hangul_WE = 0xece
-Hangul_WI = 0xecf
-Hangul_YU = 0xed0
-Hangul_EU = 0xed1
-Hangul_YI = 0xed2
-Hangul_I = 0xed3
-Hangul_J_Kiyeog = 0xed4
-Hangul_J_SsangKiyeog = 0xed5
-Hangul_J_KiyeogSios = 0xed6
-Hangul_J_Nieun = 0xed7
-Hangul_J_NieunJieuj = 0xed8
-Hangul_J_NieunHieuh = 0xed9
-Hangul_J_Dikeud = 0xeda
-Hangul_J_Rieul = 0xedb
-Hangul_J_RieulKiyeog = 0xedc
-Hangul_J_RieulMieum = 0xedd
-Hangul_J_RieulPieub = 0xede
-Hangul_J_RieulSios = 0xedf
-Hangul_J_RieulTieut = 0xee0
-Hangul_J_RieulPhieuf = 0xee1
-Hangul_J_RieulHieuh = 0xee2
-Hangul_J_Mieum = 0xee3
-Hangul_J_Pieub = 0xee4
-Hangul_J_PieubSios = 0xee5
-Hangul_J_Sios = 0xee6
-Hangul_J_SsangSios = 0xee7
-Hangul_J_Ieung = 0xee8
-Hangul_J_Jieuj = 0xee9
-Hangul_J_Cieuc = 0xeea
-Hangul_J_Khieuq = 0xeeb
-Hangul_J_Tieut = 0xeec
-Hangul_J_Phieuf = 0xeed
-Hangul_J_Hieuh = 0xeee
-Hangul_RieulYeorinHieuh = 0xeef
-Hangul_SunkyeongeumMieum = 0xef0
-Hangul_SunkyeongeumPieub = 0xef1
-Hangul_PanSios = 0xef2
-Hangul_KkogjiDalrinIeung = 0xef3
-Hangul_SunkyeongeumPhieuf = 0xef4
-Hangul_YeorinHieuh = 0xef5
-Hangul_AraeA = 0xef6
-Hangul_AraeAE = 0xef7
-Hangul_J_PanSios = 0xef8
-Hangul_J_KkogjiDalrinIeung = 0xef9
-Hangul_J_YeorinHieuh = 0xefa
-Korean_Won = 0xeff
-Armenian_eternity = 0x14a1
-Armenian_section_sign = 0x14a2
-Armenian_full_stop = 0x14a3
-Armenian_verjaket = 0x14a3
-Armenian_parenright = 0x14a4
-Armenian_parenleft = 0x14a5
-Armenian_guillemotright = 0x14a6
-Armenian_guillemotleft = 0x14a7
-Armenian_em_dash = 0x14a8
-Armenian_dot = 0x14a9
-Armenian_mijaket = 0x14a9
-Armenian_separation_mark = 0x14aa
-Armenian_but = 0x14aa
-Armenian_comma = 0x14ab
-Armenian_en_dash = 0x14ac
-Armenian_hyphen = 0x14ad
-Armenian_yentamna = 0x14ad
-Armenian_ellipsis = 0x14ae
-Armenian_exclam = 0x14af
-Armenian_amanak = 0x14af
-Armenian_accent = 0x14b0
-Armenian_shesht = 0x14b0
-Armenian_question = 0x14b1
-Armenian_paruyk = 0x14b1
-Armenian_AYB = 0x14b2
-Armenian_ayb = 0x14b3
-Armenian_BEN = 0x14b4
-Armenian_ben = 0x14b5
-Armenian_GIM = 0x14b6
-Armenian_gim = 0x14b7
-Armenian_DA = 0x14b8
-Armenian_da = 0x14b9
-Armenian_YECH = 0x14ba
-Armenian_yech = 0x14bb
-Armenian_ZA = 0x14bc
-Armenian_za = 0x14bd
-Armenian_E = 0x14be
-Armenian_e = 0x14bf
-Armenian_AT = 0x14c0
-Armenian_at = 0x14c1
-Armenian_TO = 0x14c2
-Armenian_to = 0x14c3
-Armenian_ZHE = 0x14c4
-Armenian_zhe = 0x14c5
-Armenian_INI = 0x14c6
-Armenian_ini = 0x14c7
-Armenian_LYUN = 0x14c8
-Armenian_lyun = 0x14c9
-Armenian_KHE = 0x14ca
-Armenian_khe = 0x14cb
-Armenian_TSA = 0x14cc
-Armenian_tsa = 0x14cd
-Armenian_KEN = 0x14ce
-Armenian_ken = 0x14cf
-Armenian_HO = 0x14d0
-Armenian_ho = 0x14d1
-Armenian_DZA = 0x14d2
-Armenian_dza = 0x14d3
-Armenian_GHAT = 0x14d4
-Armenian_ghat = 0x14d5
-Armenian_TCHE = 0x14d6
-Armenian_tche = 0x14d7
-Armenian_MEN = 0x14d8
-Armenian_men = 0x14d9
-Armenian_HI = 0x14da
-Armenian_hi = 0x14db
-Armenian_NU = 0x14dc
-Armenian_nu = 0x14dd
-Armenian_SHA = 0x14de
-Armenian_sha = 0x14df
-Armenian_VO = 0x14e0
-Armenian_vo = 0x14e1
-Armenian_CHA = 0x14e2
-Armenian_cha = 0x14e3
-Armenian_PE = 0x14e4
-Armenian_pe = 0x14e5
-Armenian_JE = 0x14e6
-Armenian_je = 0x14e7
-Armenian_RA = 0x14e8
-Armenian_ra = 0x14e9
-Armenian_SE = 0x14ea
-Armenian_se = 0x14eb
-Armenian_VEV = 0x14ec
-Armenian_vev = 0x14ed
-Armenian_TYUN = 0x14ee
-Armenian_tyun = 0x14ef
-Armenian_RE = 0x14f0
-Armenian_re = 0x14f1
-Armenian_TSO = 0x14f2
-Armenian_tso = 0x14f3
-Armenian_VYUN = 0x14f4
-Armenian_vyun = 0x14f5
-Armenian_PYUR = 0x14f6
-Armenian_pyur = 0x14f7
-Armenian_KE = 0x14f8
-Armenian_ke = 0x14f9
-Armenian_O = 0x14fa
-Armenian_o = 0x14fb
-Armenian_FE = 0x14fc
-Armenian_fe = 0x14fd
-Armenian_apostrophe = 0x14fe
-Armenian_ligature_ew = 0x14ff
-Georgian_an = 0x15d0
-Georgian_ban = 0x15d1
-Georgian_gan = 0x15d2
-Georgian_don = 0x15d3
-Georgian_en = 0x15d4
-Georgian_vin = 0x15d5
-Georgian_zen = 0x15d6
-Georgian_tan = 0x15d7
-Georgian_in = 0x15d8
-Georgian_kan = 0x15d9
-Georgian_las = 0x15da
-Georgian_man = 0x15db
-Georgian_nar = 0x15dc
-Georgian_on = 0x15dd
-Georgian_par = 0x15de
-Georgian_zhar = 0x15df
-Georgian_rae = 0x15e0
-Georgian_san = 0x15e1
-Georgian_tar = 0x15e2
-Georgian_un = 0x15e3
-Georgian_phar = 0x15e4
-Georgian_khar = 0x15e5
-Georgian_ghan = 0x15e6
-Georgian_qar = 0x15e7
-Georgian_shin = 0x15e8
-Georgian_chin = 0x15e9
-Georgian_can = 0x15ea
-Georgian_jil = 0x15eb
-Georgian_cil = 0x15ec
-Georgian_char = 0x15ed
-Georgian_xan = 0x15ee
-Georgian_jhan = 0x15ef
-Georgian_hae = 0x15f0
-Georgian_he = 0x15f1
-Georgian_hie = 0x15f2
-Georgian_we = 0x15f3
-Georgian_har = 0x15f4
-Georgian_hoe = 0x15f5
-Georgian_fi = 0x15f6
-EcuSign = 0x20a0
-ColonSign = 0x20a1
-CruzeiroSign = 0x20a2
-FFrancSign = 0x20a3
-LiraSign = 0x20a4
-MillSign = 0x20a5
-NairaSign = 0x20a6
-PesetaSign = 0x20a7
-RupeeSign = 0x20a8
-WonSign = 0x20a9
-NewSheqelSign = 0x20aa
-DongSign = 0x20ab
-EuroSign = 0x20ac
diff --git a/gtk/libglade.defs b/gtk/libglade.defs
deleted file mode 100644
index c7bb0789..00000000
--- a/gtk/libglade.defs
+++ /dev/null
@@ -1,196 +0,0 @@
-;; -*- scheme -*-
-; object definitions ...
-(define-object XML
- (in-module "Glade")
- (parent "GObject")
- (c-name "GladeXML")
- (gtype-id "GLADE_TYPE_XML")
-)
-
-;; Enumerations and flags ...
-
-
-;; From /opt/gtk2/include/glade-2.0/glade/glade-init.h
-
-(define-function require
- (c-name "glade_require")
- (return-type "none")
- (parameters
- '("const-gchar*" "library")
- )
-)
-
-(define-function provide
- (c-name "glade_provide")
- (return-type "none")
- (parameters
- '("const-gchar*" "library")
- )
-)
-
-
-
-;; From /opt/gtk2/include/glade-2.0/glade/glade-xml.h
-
-(define-function glade_xml_get_type
- (c-name "glade_xml_get_type")
- (return-type "GType")
-)
-
-(define-function glade_xml_new
- (c-name "glade_xml_new")
- (is-constructor-of "GladeXML")
- (return-type "GladeXML*")
- (parameters
- '("const-char*" "fname")
- '("const-char*" "root" (null-ok) (default "NULL"))
- '("const-char*" "domain" (null-ok) (default "NULL"))
- )
-)
-
-(define-function xml_new_from_buffer
- (c-name "glade_xml_new_from_buffer")
- (return-type "GladeXML*")
- (parameters
- '("const-char*" "buffer")
- '("int" "size")
- '("const-char*" "root" (null-ok) (default "NULL"))
- '("const-char*" "domain" (null-ok) (default "NULL"))
- )
-)
-
-(define-method construct
- (of-object "GladeXML")
- (c-name "glade_xml_construct")
- (return-type "gboolean")
- (parameters
- '("const-char*" "fname")
- '("const-char*" "root" (null-ok) (default "NULL"))
- '("const-char*" "domain" (null-ok) (default "NULL"))
- )
-)
-
-(define-method signal_connect
- (of-object "GladeXML")
- (c-name "glade_xml_signal_connect")
- (return-type "none")
- (parameters
- '("const-char*" "handlername")
- '("GtkSignalFunc" "func")
- )
-)
-
-(define-method signal_connect_data
- (of-object "GladeXML")
- (c-name "glade_xml_signal_connect_data")
- (return-type "none")
- (parameters
- '("const-char*" "handlername")
- '("GtkSignalFunc" "func")
- '("gpointer" "user_data")
- )
-)
-
-(define-method signal_autoconnect
- (of-object "GladeXML")
- (c-name "glade_xml_signal_autoconnect")
- (return-type "none")
-)
-
-(define-method signal_connect_full
- (of-object "GladeXML")
- (c-name "glade_xml_signal_connect_full")
- (return-type "none")
- (parameters
- '("const-gchar*" "handler_name")
- '("GladeXMLConnectFunc" "func")
- '("gpointer" "user_data")
- )
-)
-
-(define-method signal_autoconnect_full
- (of-object "GladeXML")
- (c-name "glade_xml_signal_autoconnect_full")
- (return-type "none")
- (parameters
- '("GladeXMLConnectFunc" "func")
- '("gpointer" "user_data")
- )
-)
-
-(define-method get_widget
- (of-object "GladeXML")
- (c-name "glade_xml_get_widget")
- (return-type "GtkWidget*")
- (parameters
- '("const-char*" "name")
- )
-)
-
-(define-method get_widget_prefix
- (of-object "GladeXML")
- (c-name "glade_xml_get_widget_prefix")
- (return-type "GList*")
- (parameters
- '("const-char*" "name")
- )
-)
-
-(define-method relative_file
- (of-object "GladeXML")
- (c-name "glade_xml_relative_file")
- (return-type "gchar*")
- (parameters
- '("const-gchar*" "filename")
- )
-)
-
-(define-function get_widget_name
- (c-name "glade_get_widget_name")
- (return-type "const-char*")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-function get_widget_tree
- (c-name "glade_get_widget_tree")
- (return-type "GladeXML*")
- (parameters
- '("GtkWidget*" "widget")
- )
-)
-
-(define-function set_custom_handler
- (c-name "glade_set_custom_handler")
- (return-type "none")
- (parameters
- '("GladeXMLCustomWidgetHandler" "handler")
- '("gpointer" "user_data")
- )
-)
-
-
-;; pylibglade2 extras
-
-(define-function bindtextdomain
- (c-name "glade_bindtextdomain")
- (return-type "char*")
- (parameters
- '("const-char*" "domainname")
- '("const-char*" "dirname" (null-ok) (default "NULL"))
- )
-)
-
-(define-function textdomain
- (c-name "glade_textdomain")
- (return-type "char*")
- (parameters
- '("const-char*" "domainname")
- )
-)
-
-(define-function set_custom_widget_callbacks
- (c-name "glade_set_custom_widget_callbacks")
- (return-type "none")
-)
diff --git a/gtk/libglade.override b/gtk/libglade.override
deleted file mode 100644
index 45ddb7b6..00000000
--- a/gtk/libglade.override
+++ /dev/null
@@ -1,549 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * libglade.override: overrides for the gtk.glade module.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-headers
-#define NO_IMPORT_PYGOBJECT
-#include <pygobject.h>
-#include <glade/glade.h>
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-#include <libintl.h>
-
-#include <glib-object.h>
-
-typedef struct {
- GladeXML parent;
- PyObject *typedict;
-} PyGladeXML;
-
-typedef struct {
- GladeXMLClass parent_class;
-} PyGladeXMLClass;
-
-static void pyglade_xml_init (PyGladeXML *self);
-static void pyglade_xml_class_init (PyGladeXMLClass *class);
-static GType pyglade_xml_get_type (void);
-static GType pyglade_xml_lookup_type (GladeXML*self, const char *gtypename);
-
-#define PYGLADE_TYPE_XML (pyglade_xml_get_type())
-#define PYGLADE_XML(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PYGLADE_TYPE_XML, PyGladeXML))
-#define PYGLADE_XML_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PYGLADE_TYPE_XML, PyGladeXMLClass))
-#define PYGLADE_IS_XML(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PYGLADE_TYPE_XML))
-#define PYGLADE_IS_XML_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), PYGLADE_TYPE_XML))
-#define PYGLADE_XML_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PYGLADE_TYPE_XML, PygladeXMLClass))
-
-static GType
-pyglade_xml_get_type (void)
-{
- static GType xml_type = 0;
-
- if (!xml_type) {
- static const GTypeInfo xml_info = {
- sizeof(PyGladeXMLClass),
- (GBaseInitFunc) NULL,
- (GBaseFinalizeFunc) NULL,
- (GClassInitFunc) pyglade_xml_class_init,
- (GClassFinalizeFunc) NULL,
- NULL,
-
- sizeof (PyGladeXML),
- 0, /* n_preallocs */
- (GInstanceInitFunc) pyglade_xml_init,
- };
-
- xml_type = g_type_register_static(GLADE_TYPE_XML, "PyGladeXML",
- &xml_info, 0);
- }
- return xml_type;
-
-}
-
-static void
-pyglade_xml_init (PyGladeXML *self)
-{
- self->typedict = PyDict_New();
-}
-
-static void
-pyglade_xml_class_init (PyGladeXMLClass *class)
-{
- GladeXMLClass *xml_class = (GladeXMLClass*)class;
- xml_class->lookup_type = pyglade_xml_lookup_type;
-}
-
-static GType
-pyglade_xml_lookup_type(GladeXML *glade, const char *gtypename)
-{
- PyGladeXML *self;
- PyObject *item;
-
- g_return_val_if_fail (PYGLADE_IS_XML (glade), G_TYPE_INVALID);
-
- self = PYGLADE_XML(glade);
- if (self->typedict) {
- item = PyMapping_GetItemString(self->typedict, (char *) gtypename);
- if (!item) {
- PyErr_Clear();
- item = NULL;
- }
- } else
- item = NULL;
-
- if (item != NULL) {
- GType type;
-
- if ((type = pyg_type_from_object(item)) == 0)
- type = G_TYPE_INVALID;
-
- Py_DECREF(item);
- return type;
- }
-
- return g_type_from_name(gtypename);
-}
-
-static PyGladeXML *
-pyglade_xml_new (char * fname, char * root, char *domain, PyObject *dict)
-{
- PyGladeXML *self = g_object_new(PYGLADE_TYPE_XML, NULL);
-
- /* This must be done before, since it's used inside of
- * glade_xml_construct
- */
- self->typedict = dict;
- if (!glade_xml_construct(GLADE_XML(self), fname, root, domain)) {
- g_object_unref(self);
- return NULL;
- }
- /* the reference is borrowed, and we don't need anymore */
- self->typedict = NULL;
-
- return self;
-}
-
-%%
-modulename glade
-%%
-import gobject.GObject as PyGObject_Type
-import gtk.Widget as PyGtkWidget_Type
-%%
-ignore-glob *_get_type
-%%
-ignore
- glade_init
- glade_provide
- glade_require
- glade_xml_construct
- glade_xml_signal_connect_data
- glade_xml_signal_connect_full
- glade_xml_signal_autoconnect_full
-%%
-override glade_xml_signal_connect
-static void
-connect_one(const gchar *handler_name, GObject *obj,
- const gchar *signal_name, const gchar *signal_data,
- GObject *connect_object, gboolean after, gpointer user_data)
-{
- GClosure *closure = NULL;
- PyObject *callback = PyTuple_GetItem((PyObject *)user_data, 0);
- PyObject *extra = PyTuple_GetItem((PyObject *)user_data, 1);
- PyObject *self;
-
- if (connect_object) {
- PyObject *other;
-
- other = pygobject_new(connect_object);
- closure = pyg_closure_new(callback, extra, other);
- } else {
- closure = pyg_closure_new(callback, extra, NULL);
- }
-
- self = pygobject_new(obj);
- g_signal_connect_closure(obj, signal_name, closure, after);
- pygobject_watch_closure(self, closure);
- Py_DECREF(self);
-}
-
-static PyObject *
-_wrap_glade_xml_signal_connect(PyGObject *self, PyObject *args)
-{
- guint len;
- PyObject *first, *callback, *extra_args = NULL, *data;
- gchar *handler_name;
-
- len = PyTuple_Size(args);
- if (len < 2) {
- PyErr_SetString(PyExc_TypeError,
- "GladeXML.signal_connect requires at least 2 arguments");
- return NULL;
- }
- first = PySequence_GetSlice(args, 0, 2);
- if (!PyArg_ParseTuple(first, "sO:GladeXML.signal_connect", &handler_name,
- &callback)) {
- Py_DECREF(first);
- return NULL;
- }
- Py_DECREF(first);
- if (!PyCallable_Check(callback)) {
- PyErr_SetString(PyExc_TypeError, "second argument must be callable");
- return NULL;
- }
- extra_args = PySequence_GetSlice(args, 2, len);
- if (extra_args == NULL)
- return NULL;
- data = Py_BuildValue("(ON)", callback, extra_args);
- glade_xml_signal_connect_full(GLADE_XML(self->obj), handler_name,
- connect_one, data);
- Py_DECREF(data);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override glade_xml_signal_autoconnect kwargs
-static void
-connect_many(const gchar *handler_name, GObject *obj,
- const gchar *signal_name, const gchar *signal_data,
- GObject *connect_object, gboolean after, gpointer user_data)
-{
- PyObject *handler_dict = user_data;
- PyObject *tuple, *self;
- GClosure *closure = NULL;
-
- tuple = PyMapping_GetItemString(handler_dict, (gchar *)handler_name);
- if (!tuple) {
- PyErr_Clear();
- tuple = PyObject_GetAttrString(handler_dict, (gchar *)handler_name);
- if (!tuple) {
- PyErr_Clear();
- return;
- }
- }
-
- if (PyTuple_Check(tuple)) {
- PyObject *callback = PyTuple_GetItem(tuple, 0);
- PyObject *extra = PySequence_GetSlice(tuple, 1, PyTuple_Size(tuple));
- PyObject *other = NULL;
-
- if (connect_object)
- other = pygobject_new((GObject *)connect_object);
-
- closure = pyg_closure_new(callback, extra, other);
- Py_DECREF(extra);
- } else if (PyCallable_Check(tuple)) {
- PyObject *other = NULL;
-
- if (connect_object)
- other = pygobject_new((GObject *)connect_object);
-
- closure = pyg_closure_new(tuple, NULL, other);
- } else {
- g_warning("handler for `%s' not callable or a tuple", handler_name);
- Py_DECREF(tuple);
- return;
- }
- Py_DECREF(tuple);
- self = pygobject_new(obj);
- g_signal_connect_closure(obj, signal_name, closure, after);
- pygobject_watch_closure(self, closure);
- Py_DECREF(self);
-}
-
-static PyObject *
-_wrap_glade_xml_signal_autoconnect(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "dict", NULL };
- PyObject *object;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GladeXML.signal_autoconnect", kwlist,
- &object))
- return NULL;
-
- glade_xml_signal_autoconnect_full(GLADE_XML(self->obj),
- connect_many,
- object);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override glade_xml_get_widget_prefix kwargs
-static PyObject *
-_wrap_glade_xml_get_widget_prefix(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "name", NULL };
- char *name;
- GList *ret, *tmp;
- PyObject *py_ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:GladeXML.get_widget_prefix", kwlist,
- &name))
- return NULL;
- ret = glade_xml_get_widget_prefix(GLADE_XML(self->obj), name);
- py_ret = PyList_New(0);
- for (tmp = ret; tmp != NULL; tmp = tmp->next) {
- GtkWidget *widget = tmp->data;
- PyObject *py_widget = pygobject_new((GObject *)widget);
-
- if (!py_widget) {
- g_list_free(ret);
- Py_DECREF(py_ret);
- return NULL;
- }
- PyList_Append(py_ret, py_widget);
- Py_DECREF(py_widget);
- }
- g_list_free(ret);
- return py_ret;
-}
-%%
-override glade_bindtextdomain kwargs
-static PyObject *
-_wrap_glade_bindtextdomain(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "domainname", "dirname", NULL };
- char *domainname, *dirname = NULL, *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s|s:glade.bindtextdomain", kwlist,
- &domainname, &dirname))
- return NULL;
- ret = bindtextdomain(domainname, dirname);
- if (!ret) {
- PyErr_SetString(PyExc_MemoryError, "Not enough memory available.");
- return NULL;
- }
-#ifdef HAVE_BIND_TEXTDOMAIN_CODESET
- bind_textdomain_codeset(domainname, "UTF-8");
-#endif
- return PyString_FromString(ret);
-}
-%%
-override glade_textdomain kwargs
-static PyObject *
-_wrap_glade_textdomain(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "domainname", NULL };
- char *domainname = NULL, *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|s:glade.textdomain", kwlist,
- &domainname))
- return NULL;
- ret = textdomain(domainname);
- if (!ret) {
- PyErr_SetString(PyExc_MemoryError, "Not enough memory available.");
- return NULL;
- }
- return PyString_FromString(ret);
-}
-%%
-override glade_set_custom_handler
-
-/* stores the handler set by set_custom_handler */
-static PyObject *pyglade_handler = NULL;
-static PyObject *pyglade_user_data = NULL;
-
-static GtkWidget *
-pyglade_custom_widget_handler(GladeXML *xml,
- gchar *func_name,
- gchar *name,
- gchar *string1,
- gchar *string2,
- gint int1,
- gint int2,
- gpointer user_data)
-{
- PyObject *firstargs, *args;
- PyObject *widget;
- GtkWidget *ret;
-
- g_return_val_if_fail(pyglade_handler != NULL, NULL);
- g_return_val_if_fail(pyglade_user_data != NULL, NULL);
-
- firstargs = Py_BuildValue("Nssssii", pygobject_new((GObject *)xml),
- func_name, name, string1, string2,
- int1, int2);
- args = PySequence_Concat(firstargs, pyglade_user_data);
- Py_DECREF(firstargs);
-
- widget = PyObject_CallObject(pyglade_handler, args);
- Py_DECREF(args);
- if (!widget) {
- PyErr_Print();
- ret = NULL;
- } else if (pygobject_check(widget, &PyGtkWidget_Type)) {
- /* this leaks a reference :( */
- ret = GTK_WIDGET(pygobject_get(widget));
- } else {
- Py_DECREF(widget);
- g_warning("return value of custom widget handler was not a GtkWidget");
- ret = NULL;
- }
-
- return ret;
-}
-
-static PyObject *
-_wrap_glade_set_custom_handler(PyObject *self, PyObject *args)
-{
- PyObject *first, *handler, *user_data;
- gint len;
-
- len = PyTuple_Size(args);
- if (len < 1) {
- PyErr_SetString(PyExc_TypeError, "set_custom_handler requires at least 1 argument");
- return NULL;
- }
- first = PySequence_GetSlice(args, 0, 1);
- if (!PyArg_ParseTuple(first, "O:set_custom_handler", &handler)) {
- Py_DECREF(first);
- return NULL;
- }
- Py_DECREF(first);
- if (!PyCallable_Check(handler)) {
- PyErr_SetString(PyExc_TypeError, "handler must be callable");
- return NULL;
- }
- user_data = PySequence_GetSlice(args, 1, len);
-
- /* clear saved data */
- Py_XDECREF(pyglade_handler);
- pyglade_handler = NULL;
- Py_XDECREF(pyglade_user_data);
- pyglade_user_data = NULL;
-
- /* store new handlers */
- Py_INCREF(handler);
- pyglade_handler = handler;
- pyglade_user_data = user_data;
-
- /* set handler */
- glade_set_custom_handler(pyglade_custom_widget_handler, NULL);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override glade_set_custom_widget_callbacks kwargs
-static GtkWidget *
-pyglade_custom_widget_callbacks_handler(GladeXML *xml,
- gchar *func_name,
- gchar *name,
- gchar *string1,
- gchar *string2,
- gint int1,
- gint int2,
- gpointer user_data)
-{
- PyObject *handler, *widget;
- GtkWidget *ret;
-
- handler = PyMapping_GetItemString(pyglade_user_data, func_name);
- if (!handler) {
- PyErr_Clear();
- handler = PyObject_GetAttrString(pyglade_user_data, func_name);
- if (!handler) {
- PyErr_Clear();
- g_warning("could not find handler %s", func_name);
- return NULL;
- }
- }
- if (!PyCallable_Check(handler)) {
- g_warning("object is not callable");
- return NULL;
- }
-
- widget = PyObject_CallFunction(handler, NULL);
- if (pygobject_check(widget, &PyGtkWidget_Type)) {
- /* this leaks a reference :( */
- ret = GTK_WIDGET(pygobject_get(widget));
- } else {
- Py_DECREF(widget);
- g_warning("return value of custom widget handler was not a GtkWidget");
- ret = NULL;
- }
- return ret;
-}
-static PyObject *
-_wrap_glade_set_custom_widget_callbacks(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "dict", NULL };
- PyObject *object;
-
- if (PyErr_Warn(PyExc_DeprecationWarning, "use set_custom_handler instead") < 0)
- return NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:GladeXML.set_custom_widget_callbacks",
- kwlist, &object))
- return NULL;
-
- /* clear saved data */
- Py_XDECREF(pyglade_handler);
- pyglade_handler = NULL;
- Py_XDECREF(pyglade_user_data);
- pyglade_user_data = NULL;
-
- /* store new handlers */
- Py_INCREF(object);
- pyglade_user_data = object;
-
- glade_set_custom_handler(pyglade_custom_widget_callbacks_handler, NULL);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override glade_xml_new kwargs
-static int
-_wrap_glade_xml_new(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "fname", "root", "domain", "typedict", NULL };
- char *fname, *root = NULL, *domain = NULL;
- PyObject *pydict = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s|zzO:GladeXML.__init__",
- kwlist, &fname, &root, &domain,
- &pydict))
- return -1;
-
- if (pydict && !PyMapping_Check(pydict)) {
- PyErr_SetString(PyExc_TypeError,
- "typedict must be a mapping");
- return -1;
- }
-
- self->obj = (GObject *) pyglade_xml_new(fname, root, domain, pydict);
-
- if (!self->obj) {
- PyErr_SetString(PyExc_RuntimeError, "could not create GladeXML object");
- return -1;
- }
- pygobject_register_wrapper((PyObject *)self);
- return 0;
-}
diff --git a/gtk/libglademodule.c b/gtk/libglademodule.c
deleted file mode 100644
index 0fc20c7a..00000000
--- a/gtk/libglademodule.c
+++ /dev/null
@@ -1,48 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * libglademodule.c: wrapper for the libglade library.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
-
-#include <Python.h>
-#include <pygobject.h>
-#include "pygtk.h"
-#include <glade/glade.h>
-
-void pylibglade_register_classes(PyObject *d);
-extern PyMethodDef pylibglade_functions[];
-
-DL_EXPORT(void)
-initglade(void)
-{
- PyObject *m, *d;
-
- m = Py_InitModule("gtk.glade", pylibglade_functions);
- d = PyModule_GetDict(m);
-
- init_pygobject();
- init_pygtk();
-
- glade_init();
-
- pylibglade_register_classes(d);
-}
diff --git a/gtk/pygtk-private.h b/gtk/pygtk-private.h
deleted file mode 100644
index aab41e1f..00000000
--- a/gtk/pygtk-private.h
+++ /dev/null
@@ -1,75 +0,0 @@
-#ifndef _PYGTK_PRIVATE_H_
-#define _PYGTK_PRIVATE_H_
-
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
-#define PYCAIRO_VERSION_HEX ((PYCAIRO_MAJOR_VERSION<<24)|(PYCAIRO_MINOR_VERSION<<16)|(PYCAIRO_MICRO_VERSION<<8))
-
-#ifdef _PYGTK_H_
-#error "don't include pygtk.h and pygtk-private.h together"
-#endif
-
-#define _INSIDE_PYGTK_
-#include "pygtk.h"
-#undef WITH_THREAD
-
-/* type objects */
-extern PyTypeObject PyGdkAtom_Type;
-
-/* check the type of a PyObject */
-#define PyGdkAtom_Check(v) ((v)->ob_type == &PyGdkAtom_Type)
-
-/* constructors for PyObject wrappers ... */
-PyObject *PyGdkAtom_New(GdkAtom atom);
-
-void pygtk_handler_marshal(gpointer a, PyObject *func, int nargs,GtkArg *args);
-void pygtk_input_marshal(gpointer a, PyObject *func, int nargs, GtkArg *args);
-
-/* private */
-PyObject *pygtk_tree_path_to_pyobject(GtkTreePath *path);
-GtkTreePath *pygtk_tree_path_from_pyobject(PyObject *object);
-gboolean pygdk_rectangle_from_pyobject(PyObject *object,
- GdkRectangle *rectangle);
-
-GdkAtom pygdk_atom_from_pyobject(PyObject *object);
-GdkAtom *pygdk_atom_vector_from_sequence(PyObject *sequence, gint *num);
-PyObject *pygtk_target_list_to_list(GtkTargetList *targets);
-GtkTargetList *pygtk_target_list_from_sequence(PyObject *py_targets);
-
-typedef struct {
- PyObject *func, *data;
-} PyGtkCustomNotify;
-
-void pygtk_custom_destroy_notify(gpointer user_data);
-
-/* helper object for the style helper */
-typedef struct {
- PyObject_HEAD
- GtkStyle *style; /* parent style */
- enum {STYLE_COLOUR_ARRAY, STYLE_GC_ARRAY, STYLE_PIXMAP_ARRAY} type;
- gpointer array;
-} PyGtkStyleHelper_Object;
-
-PyObject *_pygtk_style_helper_new(GtkStyle *style, int type, gpointer array);
-
-PyObject *_pygtk_tree_model_row_new(GtkTreeModel *model, GtkTreeIter *iter);
-PyObject *_pygtk_tree_model_row_iter_new(GtkTreeModel *model,
- GtkTreeIter *parent_iter);
-int _pygtk_tree_model_set_row(GtkTreeModel *model, GtkTreeIter *iter,
- PyObject *items);
-int _pygtk_tree_model_remove_row(GtkTreeModel *model, GtkTreeIter *iter);
-
-/* A boxed type for GdkRegion until one gets into gtk+ itself. */
-#ifdef GDK_TYPE_REGION
-#define PYGDK_TYPE_REGION GDK_TYPE_REGION
-#else
-GType pygdk_region_get_type (void) G_GNUC_CONST;
-
-#define PYGDK_TYPE_REGION (pygdk_region_get_type ())
-#endif /* GDK_TYPE_REGION */
-
-void pygtk_boxed_unref_shared(PyObject *boxed);
-
-#endif
diff --git a/gtk/pygtk.h b/gtk/pygtk.h
deleted file mode 100644
index 573c3b9e..00000000
--- a/gtk/pygtk.h
+++ /dev/null
@@ -1,85 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*- */
-#ifndef _PYGTK_H_
-#define _PYGTK_H_
-
-#define NO_IMPORT_PYGOBJECT
-#include <pygobject.h>
-#include <Python.h>
-#include <gtk/gtk.h>
-
-struct _PyGtk_FunctionStruct {
- char *pygtkVersion;
-
- PyTypeObject *gdkAtom_type;
- PyObject *(* gdkAtom_new)(GdkAtom atom);
- gboolean (* rectangle_from_pyobject)(PyObject *object,
- GdkRectangle *rectangle);
- PyObject * (*tree_path_to_pyobject) (GtkTreePath *path);
- GtkTreePath * (*tree_path_from_pyobject) (PyObject *object);
-};
-
-/* structure definitions for the various object types in PyGTK */
-typedef struct {
- PyObject_HEAD
- gchar *name;
- GdkAtom atom;
-} PyGdkAtom_Object;
-
-/* routines to get the C object value out of the PyObject wrapper */
-#define PyGdkAtom_Get(v) (((PyGdkAtom_Object *)(v))->atom)
-
-/* this section is dependent on whether we are being included from gtkmodule.c
- * or not. A similar source level interface should be provided in both
- * instances. */
-#ifndef _INSIDE_PYGTK_
-
-/* for multi file extensions, define one of these in all but the main file
- * of the module */
-#if defined(NO_IMPORT) || defined(NO_IMPORT_PYGTK)
-extern struct _PyGtk_FunctionStruct *_PyGtk_API;
-#else
-struct _PyGtk_FunctionStruct *_PyGtk_API;
-#endif
-
-/* type objects */
-#define PyGdkAtom_Type *(_PyGtk_API->gdkAtom_type)
-
-/* type checking routines */
-#define PyGdkAtom_Check(v) ((v)->ob_type == _PyGtk_API->gdkAtom_type)
-
-/* type objects */
-#define PyGdkAtom_New (_PyGtk_API->gdkAtom_new)
-
-/* some variables */
-#define PYGTK_VERSION (_PyGtk_API->pygtkVersion)
-
-/* public functions */
-#define pygdk_rectangle_from_pyobject (_PyGtk_API->rectangle_from_pyobject)
-#define pygtk_tree_path_to_pyobject (_PyGtk_API->tree_path_to_pyobject)
-#define pygtk_tree_path_from_pyobject (_PyGtk_API->tree_path_from_pyobject)
-
-
-/* a function to initialise the pygtk functions */
-#define init_pygtk() G_STMT_START { \
- PyObject *pygtk = PyImport_ImportModule("gtk"); \
- if (pygtk != NULL) { \
- PyObject *module_dict = PyModule_GetDict(pygtk); \
- PyObject *cobject = PyDict_GetItemString(module_dict, "_PyGtk_API"); \
- if (PyCObject_Check(cobject)) \
- _PyGtk_API = (struct _PyGtk_FunctionStruct*) \
- PyCObject_AsVoidPtr(cobject); \
- else { \
- PyErr_SetString(PyExc_RuntimeError, \
- "could not find _PyGtk_API object"); \
- return; \
- } \
- } else { \
- PyErr_SetString(PyExc_ImportError, \
- "could not import gtk"); \
- return; \
- } \
-} G_STMT_END
-
-#endif
-
-#endif /* !_PYGTK_H_ */
diff --git a/gtk/pygtkcellrenderer.c b/gtk/pygtkcellrenderer.c
deleted file mode 100644
index 627d0422..00000000
--- a/gtk/pygtkcellrenderer.c
+++ /dev/null
@@ -1,328 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * pygtkcellrenderer.c: stub class to help implement cell renderers.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
-
-#include "pygtkcellrenderer.h"
-#include <Python.h>
-#include "pygtk-private.h"
-
-/* define this to print out debug messages */
-#undef DEBUG_CELL_RENDERER
-
-#ifndef _
-# define _(s) (s)
-#endif
-
-static void pygtk_generic_cell_renderer_class_init (PyGtkGenericCellRendererClass *klass);
-static void pygtk_generic_cell_renderer_get_size (GtkCellRenderer *cell,
- GtkWidget *widget,
- GdkRectangle *cell_area,
- gint *x_offset,
- gint *y_offset,
- gint *width,
- gint *height);
-static void pygtk_generic_cell_renderer_render (GtkCellRenderer *cell,
- GdkWindow *window,
- GtkWidget *widget,
- GdkRectangle *background_area,
- GdkRectangle *cell_area,
- GdkRectangle *expose_area,
- GtkCellRendererState flags);
-static gboolean pygtk_generic_cell_renderer_activate (GtkCellRenderer *cell,
- GdkEvent *event,
- GtkWidget *widget,
- const gchar *path,
- GdkRectangle *background_area,
- GdkRectangle *cell_area,
- GtkCellRendererState flags);
-static GtkCellEditable *pygtk_generic_cell_renderer_start_editing (GtkCellRenderer *cell,
- GdkEvent *event,
- GtkWidget *widget,
- const gchar *path,
- GdkRectangle *background_area,
- GdkRectangle *cell_area,
- GtkCellRendererState flags);
-
-
-
-GType
-pygtk_generic_cell_renderer_get_type(void)
-{
- static GType object_type = 0;
-
- if (!object_type) {
- static const GTypeInfo object_info = {
- sizeof(PyGtkGenericCellRendererClass),
- (GBaseInitFunc) NULL,
- (GBaseFinalizeFunc) NULL,
- (GClassInitFunc) pygtk_generic_cell_renderer_class_init,
- NULL, /* class_finalize */
- NULL, /* class_data */
- sizeof(PyGtkGenericCellRenderer),
- 0, /* n_preallocs */
- (GInstanceInitFunc) NULL,
- };
- object_type = g_type_register_static(GTK_TYPE_CELL_RENDERER,
- "PyGtkGenericCellRenderer",
- &object_info, 0);
- }
-
- return object_type;
-}
-
-static void
-pygtk_generic_cell_renderer_class_init(PyGtkGenericCellRendererClass *klass)
-{
- GtkCellRendererClass *cell_renderer_class = (GtkCellRendererClass*) klass;
- cell_renderer_class->get_size = pygtk_generic_cell_renderer_get_size;
- cell_renderer_class->render = pygtk_generic_cell_renderer_render;
- cell_renderer_class->activate = pygtk_generic_cell_renderer_activate;
- cell_renderer_class->start_editing = pygtk_generic_cell_renderer_start_editing;
-}
-
-#define METHOD_PREFIX "on_"
-
-static void
-pygtk_generic_cell_renderer_get_size (GtkCellRenderer *cell,
- GtkWidget *widget,
- GdkRectangle *cell_area,
- gint *x_offset,
- gint *y_offset,
- gint *width,
- gint *height)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_widget, *py_cell_area;
- gint my_x, my_y, my_width, my_height;
-
- g_return_if_fail(PYGTK_IS_GENERIC_CELL_RENDERER (cell));
-
- state = pyg_gil_state_ensure();
-
- self = pygobject_new((GObject *)cell);
-
-#ifdef DEBUG_CELL_RENDERER
- g_message ("get_size()");
-#endif
- py_widget = pygobject_new((GObject *)widget);
- py_cell_area = pyg_boxed_new(GDK_TYPE_RECTANGLE, cell_area, TRUE, TRUE);
-
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "get_size", "OO",
- py_widget, py_cell_area);
- if (!py_ret) {
- PyErr_Print();
- Py_DECREF(py_widget);
- Py_DECREF(py_cell_area);
- pyg_gil_state_release(state);
- return;
- }
- Py_DECREF(py_widget);
- Py_DECREF(py_cell_area);
-
- if (!PyArg_ParseTuple(py_ret, "iiii",
- &my_x, &my_y, &my_width, &my_height)) {
- PyErr_Clear();
- Py_DECREF(py_ret);
- pyg_gil_state_release(state);
- g_warning("could not parse return value of get_size() method. "
- "Should be of form (x_offset, y_offset, width, height)");
- return;
- }
-
- pyg_gil_state_release(state);
-
- /* success */
- if (x_offset)
- *x_offset = my_x;
-
- if (y_offset)
- *y_offset = my_y;
-
- if (width)
- *width = my_width;
-
- if (height)
- *height = my_height;
-
-}
-
-static void
-pygtk_generic_cell_renderer_render (GtkCellRenderer *cell,
- GdkWindow *window,
- GtkWidget *widget,
- GdkRectangle *background_area,
- GdkRectangle *cell_area,
- GdkRectangle *expose_area,
- GtkCellRendererState flags)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_window, *py_widget;
- PyObject *py_background_area, *py_cell_area, *py_expose_area;
-
- g_return_if_fail(PYGTK_IS_GENERIC_CELL_RENDERER (cell));
-
- state = pyg_gil_state_ensure();
-
- self = pygobject_new((GObject *)cell);
-
-#ifdef DEBUG_CELL_RENDERER
- g_message ("render()");
-#endif
- py_window = pygobject_new((GObject *)window);
- py_widget = pygobject_new((GObject *)widget);
- py_background_area = pyg_boxed_new(GDK_TYPE_RECTANGLE, background_area, TRUE, TRUE);
- py_cell_area = pyg_boxed_new(GDK_TYPE_RECTANGLE, cell_area, TRUE, TRUE);
- py_expose_area = pyg_boxed_new(GDK_TYPE_RECTANGLE, expose_area, TRUE, TRUE);
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "render", "OOOOOi",
- py_window, py_widget, py_background_area,
- py_cell_area, py_expose_area, flags);
- if (!py_ret) {
- PyErr_Print();
- }
-
- Py_DECREF(py_window);
- Py_DECREF(py_widget);
- Py_DECREF(py_background_area);
- Py_DECREF(py_cell_area);
- Py_DECREF(py_expose_area);
-
- pyg_gil_state_release(state);
-}
-
-static gboolean
-pygtk_generic_cell_renderer_activate (GtkCellRenderer *cell,
- GdkEvent *event,
- GtkWidget *widget,
- const gchar *path,
- GdkRectangle *background_area,
- GdkRectangle *cell_area,
- GtkCellRendererState flags)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_event, *py_widget;
- PyObject *py_background_area, *py_cell_area;
- gboolean ret = FALSE;
-
- g_return_val_if_fail(PYGTK_IS_GENERIC_CELL_RENDERER (cell), FALSE);
-
- state = pyg_gil_state_ensure();
-
- self = pygobject_new((GObject *)cell);
-
-#ifdef DEBUG_CELL_RENDERER
- g_message ("activate()");
-#endif
- py_event = pyg_boxed_new(GDK_TYPE_EVENT, event, FALSE, FALSE);
- py_widget = pygobject_new((GObject *)widget);
- py_background_area = pyg_boxed_new(GDK_TYPE_RECTANGLE, background_area, TRUE, TRUE);
- py_cell_area = pyg_boxed_new(GDK_TYPE_RECTANGLE, cell_area, TRUE, TRUE);
-
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "activate", "OOzOOi",
- py_event, py_widget, path, py_background_area,
- py_cell_area, flags);
- if (!py_ret) {
- PyErr_Print();
- goto out;
- }
-
- ret = PyObject_IsTrue(py_ret);
- Py_DECREF(py_ret);
-
-out:
- pygtk_boxed_unref_shared(py_event);
- Py_DECREF(py_widget);
- Py_DECREF(py_background_area);
- Py_DECREF(py_cell_area);
- pyg_gil_state_release(state);
- return ret;
-}
-
-static GtkCellEditable *
-pygtk_generic_cell_renderer_start_editing (GtkCellRenderer *cell,
- GdkEvent *event,
- GtkWidget *widget,
- const gchar *path,
- GdkRectangle *background_area,
- GdkRectangle *cell_area,
- GtkCellRendererState flags)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_event, *py_widget;
- PyObject *py_background_area, *py_cell_area;
- GtkCellEditable *ret = NULL;
- extern PyTypeObject PyGtkCellEditable_Type;
-
- g_return_val_if_fail(PYGTK_IS_GENERIC_CELL_RENDERER (cell), NULL);
-
- state = pyg_gil_state_ensure();
-
- self = pygobject_new((GObject *)cell);
-
-#ifdef DEBUG_CELL_RENDERER
- g_message ("start_editing()");
-#endif
- py_event = pyg_boxed_new(GDK_TYPE_EVENT, event, FALSE, FALSE);
- py_widget = pygobject_new((GObject *)widget);
- py_background_area = pyg_boxed_new(GDK_TYPE_RECTANGLE, background_area, TRUE, TRUE);
- py_cell_area = pyg_boxed_new(GDK_TYPE_RECTANGLE, cell_area, TRUE, TRUE);
-
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "start_editing", "OOzOOi",
- py_event, py_widget, path, py_background_area,
- py_cell_area, flags);
- if (!py_ret) {
- PyErr_Print();
- Py_DECREF(py_event);
- Py_DECREF(py_widget);
- Py_DECREF(py_background_area);
- Py_DECREF(py_cell_area);
- pyg_gil_state_release(state);
- return NULL;
- }
- Py_DECREF(py_event);
- Py_DECREF(py_widget);
- Py_DECREF(py_background_area);
- Py_DECREF(py_cell_area);
- if (py_ret == Py_None) {
- ret = NULL;
- }
- else if (pygobject_check(py_ret, &PyGtkCellEditable_Type)) {
- ret = GTK_CELL_EDITABLE(g_object_ref(pygobject_get(py_ret)));
- }
- else {
- g_warning("return of start_editing() was not a GtkCellEditable");
- }
- Py_DECREF(py_ret);
- pyg_gil_state_release(state);
- return ret;
-}
-
-GtkCellRenderer *
-pygtk_generic_cell_renderer_new(void)
-{
- if (PyErr_Warn(PyExc_DeprecationWarning,
- "subclass gtk.CellRenderer and override do_xxx methods") < 0)
- return NULL;
- return GTK_CELL_RENDERER(
- g_object_new(PYGTK_TYPE_GENERIC_CELL_RENDERER, NULL));
-}
diff --git a/gtk/pygtkcellrenderer.h b/gtk/pygtkcellrenderer.h
deleted file mode 100644
index 5c71069b..00000000
--- a/gtk/pygtkcellrenderer.h
+++ /dev/null
@@ -1,44 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * pygtkcellrenderer.h: stub class to help implement cell renderers.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-
-#include <gtk/gtkcellrenderer.h>
-
-#define PYGTK_TYPE_GENERIC_CELL_RENDERER (pygtk_generic_cell_renderer_get_type())
-#define PYGTK_GENERIC_CELL_RENDERER(object) (G_TYPE_CHECK_INSTANCE_CAST((object), PYGTK_TYPE_GENERIC_CELL_RENDERER, PyGtkGenericCellRenderer))
-#define PYGTK_GENERIC_CELL_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PYGTK_TYPE_GENERIC_CELL_RENDERER, PyGtkGenericCellRendererClass))
-#define PYGTK_IS_GENERIC_CELL_RENDERER(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), PYGTK_TYPE_GENERIC_CELL_RENDERER))
-#define PYGTK_IS_GENERIC_CELL_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PYGTK_TYPE_GENERIC_CELL_RENDERER))
-#define PYGTK_GENERIC_CELL_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PYGTK_TYPE_GENERIC_CELL_RENDERER, PyGtkGenericCellRendererClass))
-
-typedef struct _PyGtkGenericCellRenderer PyGtkGenericCellRenderer;
-typedef struct _PyGtkGenericCellRendererClass PyGtkGenericCellRendererClass;
-
-struct _PyGtkGenericCellRenderer {
- GtkCellRenderer parent_instance;
-};
-
-struct _PyGtkGenericCellRendererClass {
- GtkCellRendererClass parent_class;
-};
-
-GType pygtk_generic_cell_renderer_get_type (void);
-GtkCellRenderer *pygtk_generic_cell_renderer_new (void);
diff --git a/gtk/pygtktreemodel.c b/gtk/pygtktreemodel.c
deleted file mode 100644
index a3f85805..00000000
--- a/gtk/pygtktreemodel.c
+++ /dev/null
@@ -1,803 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * pygtktreemodel.c: stub class to help implement tree models.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
-
-#include "pygtktreemodel.h"
-#include <Python.h>
-#include "pygtk-private.h"
-
-/* define this to print out debug messages */
-#undef DEBUG_TREE_MODEL
-
-#ifndef _
-# define _(s) (s)
-#endif
-
-#define VALID_ITER(iter, tree_model) \
- (iter != NULL && iter->stamp == PYGTK_GENERIC_TREE_MODEL(tree_model)->stamp)
-
-enum {
- PROP_LEAK_REFERENCES = 1
-};
-
-static void pygtk_generic_tree_model_class_init(PyGtkGenericTreeModelClass *klass);
-static void pygtk_generic_tree_model_init(PyGtkGenericTreeModel *self);
-static void pygtk_generic_tree_model_iface_init(GtkTreeModelIface *iface);
-static void pygtk_generic_tree_model_set_property (GObject *object,
- guint property_id,
- const GValue *value,
- GParamSpec *pspec);
-static void pygtk_generic_tree_model_get_property (GObject *object,
- guint property_id,
- GValue *value,
- GParamSpec *pspec);
-
-
-GType
-pygtk_generic_tree_model_get_type(void)
-{
- static GType object_type = 0;
-
- if (!object_type) {
- static const GTypeInfo object_info = {
- sizeof(PyGtkGenericTreeModelClass),
- (GBaseInitFunc) NULL,
- (GBaseFinalizeFunc) NULL,
- (GClassInitFunc) pygtk_generic_tree_model_class_init,
- NULL, /* class_finalize */
- NULL, /* class_data */
- sizeof(PyGtkGenericTreeModel),
- 0, /* n_preallocs */
- (GInstanceInitFunc) pygtk_generic_tree_model_init,
- };
- static const GInterfaceInfo tree_model_info = {
- (GInterfaceInitFunc) pygtk_generic_tree_model_iface_init,
- NULL,
- NULL,
- };
-
- object_type = g_type_register_static(G_TYPE_OBJECT,
- "PyGtkGenericTreeModel",
- &object_info, 0);
- g_type_add_interface_static(object_type,
- GTK_TYPE_TREE_MODEL,
- &tree_model_info);
- }
- return object_type;
-}
-
-static void
-pygtk_generic_tree_model_class_init(PyGtkGenericTreeModelClass *klass)
-{
- GObjectClass *object_class = (GObjectClass*) klass;
-
- object_class->get_property = pygtk_generic_tree_model_get_property;
- object_class->set_property = pygtk_generic_tree_model_set_property;
-
- g_object_class_install_property (object_class,
- PROP_LEAK_REFERENCES,
- g_param_spec_boolean ("leak_references",
- _("Leak references"),
- _("Enable referencing iterator "
- "objects (this will cause a memory leak or at least a reference "
- "counting leak). You might need it though, if you return newly "
- "created objects."),
- TRUE,
- G_PARAM_READWRITE));
-}
-
-static guint pygtk_generic_tree_model_get_flags(GtkTreeModel *tree_model);
-static gint pygtk_generic_tree_model_get_n_columns(GtkTreeModel *tree_model);
-static GType pygtk_generic_tree_model_get_column_type(GtkTreeModel *tree_model,
- gint index);
-static gboolean pygtk_generic_tree_model_get_iter(GtkTreeModel *tree_model,
- GtkTreeIter *iter,
- GtkTreePath *path);
-static GtkTreePath *pygtk_generic_tree_model_get_path(GtkTreeModel *tree_model,
- GtkTreeIter *iter);
-static void pygtk_generic_tree_model_get_value(GtkTreeModel*tree_model,
- GtkTreeIter *iter,
- gint column, GValue *value);
-static gboolean pygtk_generic_tree_model_iter_next(GtkTreeModel *tree_model,
- GtkTreeIter *iter);
-static gboolean pygtk_generic_tree_model_iter_children(GtkTreeModel *tree_model,
- GtkTreeIter *iter,
- GtkTreeIter *parent);
-static gboolean pygtk_generic_tree_model_iter_has_child(GtkTreeModel *tree_model,
- GtkTreeIter *iter);
-static gint pygtk_generic_tree_model_iter_n_children(GtkTreeModel *tree_model,
- GtkTreeIter *iter);
-static gboolean pygtk_generic_tree_model_iter_nth_child(GtkTreeModel *tree_model,
- GtkTreeIter *iter,
- GtkTreeIter *parent,
- gint n);
-static gboolean pygtk_generic_tree_model_iter_parent(GtkTreeModel *tree_model,
- GtkTreeIter *iter,
- GtkTreeIter *child);
-static void pygtk_generic_tree_model_unref_node(GtkTreeModel *tree_model,
- GtkTreeIter *iter);
-static void pygtk_generic_tree_model_ref_node(GtkTreeModel *tree_model,
- GtkTreeIter *iter);
-
-static void
-pygtk_generic_tree_model_iface_init(GtkTreeModelIface *iface)
-{
- iface->get_flags = pygtk_generic_tree_model_get_flags;
- iface->get_n_columns = pygtk_generic_tree_model_get_n_columns;
- iface->get_column_type = pygtk_generic_tree_model_get_column_type;
- iface->get_iter = pygtk_generic_tree_model_get_iter;
- iface->get_path = pygtk_generic_tree_model_get_path;
- iface->get_value = pygtk_generic_tree_model_get_value;
- iface->iter_next = pygtk_generic_tree_model_iter_next;
- iface->iter_children = pygtk_generic_tree_model_iter_children;
- iface->iter_has_child = pygtk_generic_tree_model_iter_has_child;
- iface->iter_n_children = pygtk_generic_tree_model_iter_n_children;
- iface->iter_nth_child = pygtk_generic_tree_model_iter_nth_child;
- iface->iter_parent = pygtk_generic_tree_model_iter_parent;
- iface->ref_node = pygtk_generic_tree_model_ref_node;
- iface->unref_node = pygtk_generic_tree_model_unref_node;
-
-}
-
-static void
-pygtk_generic_tree_model_init(PyGtkGenericTreeModel *self)
-{
- self->leak_references = TRUE;
- do {
- self->stamp = g_random_int();
- } while (self->stamp == 0);
-}
-
-static void
-pygtk_generic_tree_model_set_property (GObject *object, guint property_id,
- const GValue *value, GParamSpec *pspec)
-{
- switch (property_id) {
- case PROP_LEAK_REFERENCES:
- PYGTK_GENERIC_TREE_MODEL (object)->leak_references = g_value_get_boolean (value);
- break;
- default:
- G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
- break;
- }
- }
-
-static void
-pygtk_generic_tree_model_get_property (GObject *object, guint property_id,
- GValue *value, GParamSpec *pspec)
-{
- switch (property_id) {
- case PROP_LEAK_REFERENCES:
- g_value_set_boolean (value,
- PYGTK_GENERIC_TREE_MODEL (object)->leak_references);
- break;
- default:
- G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
- break;
- }
-}
-
-
-PyGtkGenericTreeModel *
-pygtk_generic_tree_model_new(void)
-{
- return PYGTK_GENERIC_TREE_MODEL(
- g_object_new(PYGTK_TYPE_GENERIC_TREE_MODEL, NULL));
-}
-
-
-/* format of GtkTreeIter's for PyGtkGenericTreeModel:
- * user_data == python object
- * user_data2 == floating reference?
- *
- * I haven't worked out how everything should work. For now I will
- * leak references.
- */
-
-#define METHOD_PREFIX "on_"
-
-static guint
-pygtk_generic_tree_model_get_flags(GtkTreeModel *tree_model)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret;
- guint ret = 0;
- g_return_val_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model), 0);
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("get_flags()");
-#endif
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "get_flags", "");
- Py_DECREF(self);
- if (py_ret) {
- ret = PyInt_AsLong(py_ret);
- Py_DECREF(py_ret);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-
-static gint
-pygtk_generic_tree_model_get_n_columns(GtkTreeModel *tree_model)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret;
- gint ret = 0;
-
- g_return_val_if_fail(tree_model != NULL, 0);
- g_return_val_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model), 0);
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("get_n_columns()");
-#endif
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "get_n_columns", "");
- Py_DECREF(self);
- if (py_ret) {
- ret = PyInt_AsLong(py_ret);
- Py_DECREF(py_ret);
- } else {
- PyErr_Print();
- }
- pyg_gil_state_release(state);
- return ret;
-}
-
-static GType
-pygtk_generic_tree_model_get_column_type(GtkTreeModel *tree_model, gint index)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret;
- GType ret = G_TYPE_INVALID;
-
- g_return_val_if_fail(tree_model != NULL, G_TYPE_INVALID);
- g_return_val_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model), G_TYPE_INVALID);
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("get_column_type(%d)", index);
-#endif
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "get_column_type",
- "(i)", index);
- Py_DECREF(self);
- if (py_ret) {
- ret = pyg_type_from_object(py_ret);
- Py_DECREF(py_ret);
- } else {
- PyErr_Print();
- }
- pyg_gil_state_release(state);
- return ret;
-}
-
-static gboolean
-pygtk_generic_tree_model_get_iter(GtkTreeModel *tree_model,
- GtkTreeIter *iter, GtkTreePath *path)
-{
- PyGILState_STATE state;
- PyObject *self, *py_path, *py_ret;
- gboolean ret = FALSE;
-
- g_return_val_if_fail(tree_model != NULL, FALSE);
- g_return_val_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model), FALSE);
- g_return_val_if_fail(iter != NULL, FALSE);
- g_return_val_if_fail(path != NULL, FALSE);
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("get_iter(%p)", path);
-#endif
- py_path = pygtk_tree_path_to_pyobject(path);
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "get_iter",
- "(O)", py_path);
- Py_DECREF(self);
- Py_DECREF(py_path);
-
- if (py_ret) {
- if (py_ret != Py_None) {
- iter->user_data = py_ret;
- iter->stamp = PYGTK_GENERIC_TREE_MODEL(tree_model)->stamp;
- if (!PYGTK_GENERIC_TREE_MODEL(tree_model)->leak_references) {
- Py_DECREF((PyObject *)iter->user_data);
- }
- ret = TRUE;
- } else {
- iter->user_data = NULL;
- Py_DECREF(py_ret);
- }
- } else {
- PyErr_Print();
- iter->user_data = NULL;
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-
-static GtkTreePath *
-pygtk_generic_tree_model_get_path(GtkTreeModel *tree_model, GtkTreeIter *iter)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_iter;
- GtkTreePath *path = NULL;
-
- g_return_val_if_fail(tree_model != NULL, NULL);
- g_return_val_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model), NULL);
- g_return_val_if_fail(VALID_ITER(iter, tree_model), NULL);
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("get_path(%p)", iter);
-#endif
- py_iter = (PyObject *)iter->user_data;
- if (py_iter == NULL)
- py_iter = Py_None;
-
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "get_path", "(O)",
- py_iter);
- Py_DECREF(self);
- if (py_ret) {
- path = pygtk_tree_path_from_pyobject(py_ret);
-
- if (!path)
- g_warning("could not convert return value of get_path() to "
- "a GtkTreePath");
- Py_DECREF(py_ret);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return path;
-}
-
-static void
-pygtk_generic_tree_model_get_value(GtkTreeModel*tree_model, GtkTreeIter *iter,
- gint column, GValue *value)
-{
- PyGILState_STATE state;
- PyObject *self, *py_value, *py_iter;
-
- g_return_if_fail(tree_model != NULL);
- g_return_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model));
- g_return_if_fail(VALID_ITER(iter, tree_model));
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("get_value(%p, %d)", iter, column);
- _PyObject_Dump (iter->user_data);
-#endif
- /* init value to column type */
- g_value_init(value, pygtk_generic_tree_model_get_column_type(tree_model,
- column));
-
- py_iter = (PyObject *)iter->user_data;
- if (py_iter == NULL)
- py_iter = Py_None;
- py_value = PyObject_CallMethod(self, METHOD_PREFIX "get_value",
- "(Oi)", py_iter,column);
- Py_DECREF(self);
-
- if (py_value) {
- if (py_value != Py_None)
- pyg_value_from_pyobject(value, py_value);
- Py_DECREF(py_value);
- } else {
- PyErr_Print();
- }
- pyg_gil_state_release(state);
-}
-
-static gboolean
-pygtk_generic_tree_model_iter_next(GtkTreeModel *tree_model, GtkTreeIter *iter)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_iter;
- gboolean ret = FALSE;
-
- g_return_val_if_fail(tree_model != NULL, FALSE);
- g_return_val_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model), FALSE);
- g_return_val_if_fail(VALID_ITER(iter, tree_model), FALSE);
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("iter_next(%p)", iter);
-#endif
- py_iter = (PyObject *)iter->user_data;
- if (py_iter == NULL)
- py_iter = Py_None;
-
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "iter_next", "(O)",
- py_iter);
- Py_DECREF(self);
- if (py_ret) {
- if (py_ret != Py_None) {
- /* XXXX handle reference counting here */
- iter->user_data = py_ret;
- if (!PYGTK_GENERIC_TREE_MODEL(tree_model)->leak_references) {
- Py_DECREF((PyObject *)iter->user_data);
- }
- ret = TRUE;
- } else {
- iter->user_data = NULL;
- Py_DECREF(py_ret);
- }
- } else {
- iter->user_data = NULL;
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-
-static gboolean
-pygtk_generic_tree_model_iter_children(GtkTreeModel *tree_model,
- GtkTreeIter *iter,
- GtkTreeIter *parent)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_parent = Py_None;
- gboolean ret = FALSE;
-
- g_return_val_if_fail(tree_model != NULL, FALSE);
- g_return_val_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model), FALSE);
- g_return_val_if_fail(iter != NULL, FALSE);
- g_return_val_if_fail(parent == NULL || parent->stamp == PYGTK_GENERIC_TREE_MODEL(tree_model)->stamp, FALSE);
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("iter_children(%p, %p)", iter, parent);
-#endif
- if (parent && parent->user_data != NULL)
- py_parent = (PyObject *)parent->user_data;
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "iter_children",
- "(O)", py_parent);
- Py_DECREF(self);
- if (py_ret) {
- if (py_ret != Py_None) {
- /* XXXX handle reference counting here */
- iter->user_data = py_ret;
- iter->stamp = PYGTK_GENERIC_TREE_MODEL(tree_model)->stamp;
- if (!PYGTK_GENERIC_TREE_MODEL(tree_model)->leak_references) {
- Py_DECREF((PyObject *)iter->user_data);
- }
- ret = TRUE;
- } else {
- iter->user_data = NULL;
- Py_DECREF(py_ret);
- }
- } else {
- iter->user_data = NULL;
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-
-static gboolean
-pygtk_generic_tree_model_iter_has_child(GtkTreeModel *tree_model,
- GtkTreeIter *iter)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_iter;
- gboolean ret = FALSE;
-
- g_return_val_if_fail(tree_model != NULL, FALSE);
- g_return_val_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model), FALSE);
- g_return_val_if_fail(VALID_ITER(iter, tree_model), FALSE);
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("iter_has_child(%p)", iter);
-#endif
- py_iter = (PyObject *)iter->user_data;
- if (py_iter == NULL)
- py_iter = Py_None;
-
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "iter_has_child",
- "(O)", py_iter);
- Py_DECREF(self);
- if (py_ret) {
- ret = PyObject_IsTrue(py_ret);
-
- Py_DECREF(py_ret);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-
-static gint
-pygtk_generic_tree_model_iter_n_children(GtkTreeModel *tree_model,
- GtkTreeIter *iter)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_iter;
- guint ret = FALSE;
-
- g_return_val_if_fail(tree_model != NULL, 0);
- g_return_val_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model), 0);
- g_return_val_if_fail(iter == NULL || iter->stamp == PYGTK_GENERIC_TREE_MODEL(tree_model)->stamp, 0);
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("iter_n_children(%p)", iter);
-#endif
-
- py_iter = iter != NULL ? (PyObject *)iter->user_data : Py_None;
-
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "iter_n_children",
- "(O)", py_iter);
- Py_DECREF(self);
- if (py_ret) {
- ret = PyInt_AsLong(py_ret);
-
- Py_DECREF(py_ret);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-
-static gboolean
-pygtk_generic_tree_model_iter_nth_child(GtkTreeModel *tree_model,
- GtkTreeIter *iter,
- GtkTreeIter *parent, gint n)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_parent = Py_None;
- gboolean ret = FALSE;
-
- g_return_val_if_fail(tree_model != NULL, FALSE);
- g_return_val_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model), FALSE);
- g_return_val_if_fail(iter != NULL, FALSE);
- g_return_val_if_fail(parent == NULL || parent->stamp == PYGTK_GENERIC_TREE_MODEL(tree_model)->stamp, FALSE);
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("iter_nth_child(%p, %p, %d)", iter, parent, n);
-#endif
- if (parent && parent->user_data != NULL)
- py_parent = (PyObject *)parent->user_data;
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "iter_nth_child",
- "(Oi)", py_parent, n);
- Py_DECREF(self);
- if (py_ret) {
- if (py_ret != Py_None) {
- /* XXXX handle reference counting here */
- iter->user_data = py_ret;
- iter->stamp = PYGTK_GENERIC_TREE_MODEL(tree_model)->stamp;
- if (!PYGTK_GENERIC_TREE_MODEL(tree_model)->leak_references) {
- Py_DECREF((PyObject *)iter->user_data);
- }
- ret = TRUE;
- } else {
- iter->user_data = NULL;
- Py_DECREF(py_ret);
- }
- } else {
- iter->user_data = NULL;
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-
-static gboolean
-pygtk_generic_tree_model_iter_parent(GtkTreeModel *tree_model,
- GtkTreeIter *iter,
- GtkTreeIter *child)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_child = Py_None;
- gboolean ret = FALSE;
-
- g_return_val_if_fail(tree_model != NULL, FALSE);
- g_return_val_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model), FALSE);
- g_return_val_if_fail(iter != NULL, FALSE);
- g_return_val_if_fail(VALID_ITER(child, tree_model), FALSE);
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("iter_parent(%p, %p)", iter, child);
-#endif
- if (child && child->user_data != NULL)
- py_child = (PyObject *)child->user_data;
- py_ret = PyObject_CallMethod(self, METHOD_PREFIX "iter_parent",
- "(O)", py_child);
- Py_DECREF(self);
- if (py_ret) {
- if (py_ret != Py_None) {
- /* XXXX handle reference counting here */
- iter->user_data = py_ret;
- iter->stamp = PYGTK_GENERIC_TREE_MODEL(tree_model)->stamp;
- if (!PYGTK_GENERIC_TREE_MODEL(tree_model)->leak_references) {
- Py_DECREF((PyObject *)iter->user_data);
- }
- ret = TRUE;
- } else {
- iter->user_data = NULL;
- Py_DECREF(py_ret);
- }
- } else {
- iter->user_data = NULL;
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-
-static void
-pygtk_generic_tree_model_unref_node(GtkTreeModel *tree_model, GtkTreeIter *iter)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_iter, *method;
-
- g_return_if_fail(tree_model != NULL);
- g_return_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model));
- g_return_if_fail(VALID_ITER(iter, tree_model));
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("unref_node(%p)", iter);
-#endif
- py_iter = (PyObject *)iter->user_data;
- if (py_iter == NULL)
- py_iter = Py_None;
-
- method = PyObject_GetAttrString(self, METHOD_PREFIX "unref_node");
- if (method == NULL)
- PyErr_Clear();
- else {
- py_ret = PyObject_CallFunction(method, "(O)", py_iter);
- if (py_ret) {
- Py_DECREF(py_ret);
- } else {
- PyErr_Print();
- }
- }
- Py_DECREF(self);
-
- pyg_gil_state_release(state);
-}
-
-static void
-pygtk_generic_tree_model_ref_node(GtkTreeModel *tree_model, GtkTreeIter *iter)
-{
- PyGILState_STATE state;
- PyObject *self, *py_ret, *py_iter, *method;
-
- g_return_if_fail(tree_model != NULL);
- g_return_if_fail(PYGTK_IS_GENERIC_TREE_MODEL(tree_model));
- g_return_if_fail(VALID_ITER(iter, tree_model));
-
- state = pyg_gil_state_ensure();
-
- /* this call finds the wrapper for this GObject */
- self = pygobject_new((GObject *)tree_model);
-
-#ifdef DEBUG_TREE_MODEL
- g_message("ref_node(%p)", iter);
-#endif
- py_iter = (PyObject *)iter->user_data;
- if (py_iter == NULL)
- py_iter = Py_None;
-
- method = PyObject_GetAttrString(self, METHOD_PREFIX "ref_node");
- if (method == NULL)
- PyErr_Clear();
- else {
- py_ret = PyObject_CallFunction(method, "(O)", py_iter);
- if (py_ret) {
- Py_DECREF(py_ret);
- } else {
- PyErr_Print();
- }
- }
- Py_DECREF(self);
-
- pyg_gil_state_release(state);
-}
-
-void
-pygtk_generic_tree_model_invalidate_iters(PyGtkGenericTreeModel *tree_model)
-{
- g_return_if_fail(tree_model != NULL);
-
- do {
- tree_model->stamp++;
- } while (tree_model->stamp == 0);
-}
-
-gboolean
-pygtk_generic_tree_model_iter_is_valid(PyGtkGenericTreeModel *tree_model,
- GtkTreeIter *iter)
-{
- g_return_val_if_fail(tree_model != NULL, FALSE);
-
- return VALID_ITER(iter, tree_model);
-}
diff --git a/gtk/pygtktreemodel.h b/gtk/pygtktreemodel.h
deleted file mode 100644
index 703eefb0..00000000
--- a/gtk/pygtktreemodel.h
+++ /dev/null
@@ -1,50 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * pygtktreemodel.h: stub class to help implement tree models.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-
-#include <gtk/gtktreemodel.h>
-
-#define PYGTK_TYPE_GENERIC_TREE_MODEL (pygtk_generic_tree_model_get_type())
-#define PYGTK_GENERIC_TREE_MODEL(object) (G_TYPE_CHECK_INSTANCE_CAST((object), PYGTK_TYPE_GENERIC_TREE_MODEL, PyGtkGenericTreeModel))
-#define PYGTK_GENERIC_TREE_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PYGTK_TYPE_GENERIC_TREE_MODEL, PyGtkGenericTreeModelClass))
-#define PYGTK_IS_GENERIC_TREE_MODEL(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), PYGTK_TYPE_GENERIC_TREE_MODEL))
-#define PYGTK_IS_GENERIC_TREE_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PYGTK_TYPE_GENERIC_TREE_MODEL))
-#define PYGTK_GENERIC_TREE_MODEL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PYGTK_TYPE_GENERIC_TREE_MODEL, PyGtkGenericTreeModelClass))
-
-typedef struct _PyGtkGenericTreeModel PyGtkGenericTreeModel;
-typedef struct _PyGtkGenericTreeModelClass PyGtkGenericTreeModelClass;
-
-struct _PyGtkGenericTreeModel {
- GObject parent_instance;
-
- gboolean leak_references;
- gint stamp;
-};
-
-struct _PyGtkGenericTreeModelClass {
- GObjectClass parent_class;
-};
-
-GType pygtk_generic_tree_model_get_type (void);
-PyGtkGenericTreeModel * pygtk_generic_tree_model_new (void);
-void pygtk_generic_tree_model_invalidate_iters(PyGtkGenericTreeModel *);
-gboolean pygtk_generic_tree_model_iter_is_valid(PyGtkGenericTreeModel *,
- GtkTreeIter *);
diff --git a/ltihooks.py b/ltihooks.py
deleted file mode 100644
index ae1d6040..00000000
--- a/ltihooks.py
+++ /dev/null
@@ -1,60 +0,0 @@
-# -*- Mode: Python; py-indent-offset: 4 -*-
-# ltihooks.py: python import hooks that understand libtool libraries.
-# Copyright (C) 2000 James Henstridge.
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-
-import os, ihooks
-
-class LibtoolHooks(ihooks.Hooks):
- def get_suffixes(self):
- """Like normal get_suffixes, but adds .la suffixes to list"""
- ret = ihooks.Hooks.get_suffixes(self)
- ret.insert(0, ('module.la', 'rb', 3))
- ret.insert(0, ('.la', 'rb', 3))
- return ret
-
- def load_dynamic(self, name, filename, file=None):
- """Like normal load_dynamic, but treat .la files specially"""
- if len(filename) > 3 and filename[-3:] == '.la':
- fp = open(filename, 'r')
- dlname = ''
- installed = 1
- line = fp.readline()
- while line:
- if len(line) > 7 and line[:7] == 'dlname=':
- dlname = line[8:-2]
- elif len(line) > 10 and line[:10] == 'installed=':
- installed = line[10:-1] == 'yes'
- line = fp.readline()
- fp.close()
- if dlname:
- if installed:
- filename = os.path.join(os.path.dirname(filename),
- dlname)
- else:
- filename = os.path.join(os.path.dirname(filename),
- '.libs', dlname)
- return ihooks.Hooks.load_dynamic(self, name, filename, file)
-
-importer = ihooks.ModuleImporter()
-importer.set_hooks(LibtoolHooks())
-
-def install():
- importer.install()
-def uninstall():
- importer.uninstall()
-
-install()
diff --git a/m4/jhflags.m4 b/m4/jhflags.m4
deleted file mode 100644
index 222e4b09..00000000
--- a/m4/jhflags.m4
+++ /dev/null
@@ -1,21 +0,0 @@
-dnl
-dnl JH_ADD_CFLAG(FLAG)
-dnl checks whether the C compiler supports the given flag, and if so, adds
-dnl it to $CFLAGS. If the flag is already present in the list, then the
-dnl check is not performed.
-AC_DEFUN([JH_ADD_CFLAG],
-[
-case " $CFLAGS " in
-*@<:@\ \ @:>@$1@<:@\ \ @:>@*)
- ;;
-*)
- save_CFLAGS="$CFLAGS"
- CFLAGS="$CFLAGS $1"
- AC_MSG_CHECKING([whether [$]CC understands $1])
- AC_TRY_COMPILE([], [], [jh_has_option=yes], [jh_has_option=no])
- AC_MSG_RESULT($jh_has_option)
- if test $jh_has_option = no; then
- CFLAGS="$save_CFLAGS"
- fi
- ;;
-esac])
diff --git a/m4/python.m4 b/m4/python.m4
deleted file mode 100644
index e1c5266d..00000000
--- a/m4/python.m4
+++ /dev/null
@@ -1,62 +0,0 @@
-## this one is commonly used with AM_PATH_PYTHONDIR ...
-dnl AM_CHECK_PYMOD(MODNAME [,SYMBOL [,ACTION-IF-FOUND [,ACTION-IF-NOT-FOUND]]])
-dnl Check if a module containing a given symbol is visible to python.
-AC_DEFUN([AM_CHECK_PYMOD],
-[AC_REQUIRE([AM_PATH_PYTHON])
-py_mod_var=`echo $1['_']$2 | sed 'y%./+-%__p_%'`
-AC_MSG_CHECKING(for ifelse([$2],[],,[$2 in ])python module $1)
-AC_CACHE_VAL(py_cv_mod_$py_mod_var, [
-ifelse([$2],[], [prog="
-import sys
-try:
- import $1
-except ImportError:
- sys.exit(1)
-except:
- sys.exit(0)
-sys.exit(0)"], [prog="
-import $1
-$1.$2"])
-if $PYTHON -c "$prog" 1>&AC_FD_CC 2>&AC_FD_CC
- then
- eval "py_cv_mod_$py_mod_var=yes"
- else
- eval "py_cv_mod_$py_mod_var=no"
- fi
-])
-py_val=`eval "echo \`echo '$py_cv_mod_'$py_mod_var\`"`
-if test "x$py_val" != xno; then
- AC_MSG_RESULT(yes)
- ifelse([$3], [],, [$3
-])dnl
-else
- AC_MSG_RESULT(no)
- ifelse([$4], [],, [$4
-])dnl
-fi
-])
-
-dnl a macro to check for ability to create python extensions
-dnl AM_CHECK_PYTHON_HEADERS([ACTION-IF-POSSIBLE], [ACTION-IF-NOT-POSSIBLE])
-dnl function also defines PYTHON_INCLUDES
-AC_DEFUN([AM_CHECK_PYTHON_HEADERS],
-[AC_REQUIRE([AM_PATH_PYTHON])
-AC_MSG_CHECKING(for headers required to compile python extensions)
-dnl deduce PYTHON_INCLUDES
-py_prefix=`$PYTHON -c "import sys; print sys.prefix"`
-py_exec_prefix=`$PYTHON -c "import sys; print sys.exec_prefix"`
-PYTHON_INCLUDES="-I${py_prefix}/include/python${PYTHON_VERSION}"
-if test "$py_prefix" != "$py_exec_prefix"; then
- PYTHON_INCLUDES="$PYTHON_INCLUDES -I${py_exec_prefix}/include/python${PYTHON_VERSION}"
-fi
-AC_SUBST(PYTHON_INCLUDES)
-dnl check if the headers exist:
-save_CPPFLAGS="$CPPFLAGS"
-CPPFLAGS="$CPPFLAGS $PYTHON_INCLUDES"
-AC_TRY_CPP([#include <Python.h>],dnl
-[AC_MSG_RESULT(found)
-$1],dnl
-[AC_MSG_RESULT(not found)
-$2])
-CPPFLAGS="$save_CPPFLAGS"
-])
diff --git a/pango-types.defs b/pango-types.defs
deleted file mode 100644
index 2f9e734a..00000000
--- a/pango-types.defs
+++ /dev/null
@@ -1,463 +0,0 @@
-;; -*- scheme -*-
-;; boxed definitions ...
-
-(define-boxed AttrList
- (in-module "Pango")
- (c-name "PangoAttrList")
- (gtype-id "PANGO_TYPE_ATTR_LIST")
- (copy-func "pango_attr_list_ref")
- (release-func "pango_attr_list_unref")
-)
-
-(define-boxed Color
- (in-module "Pango")
- (c-name "PangoColor")
- (gtype-id "PANGO_TYPE_COLOR")
- (copy-func "pango_color_copy")
- (release-func "pango_color_free")
- (fields
- '("guint16" "red")
- '("guint16" "green")
- '("guint16" "blue")
- )
-)
-
-(define-boxed FontDescription
- (in-module "Pango")
- (c-name "PangoFontDescription")
- (gtype-id "PANGO_TYPE_FONT_DESCRIPTION")
- (copy-func "pango_font_description_copy")
- (release-func "pango_font_description_free")
-)
-
-(define-boxed FontMetrics
- (in-module "Pango")
- (c-name "PangoFontMetrics")
- (gtype-id "PANGO_TYPE_FONT_METRICS")
- (copy-func "pango_font_metrics_ref")
- (release-func "pango_font_metrics_unref")
-)
-
-(define-boxed GlyphString
- (in-module "Pango")
- (c-name "PangoGlyphString")
- (gtype-id "PANGO_TYPE_GLYPH_STRING")
- (copy-func "pango_glyph_string_copy")
- (release-func "pango_glyph_string_free")
- (fields
- '("gint" "num_glyphs")
- '("PangoGlyphInfo*" "glyphs")
- '("gint*" "log_clusters")
- )
-)
-
-(define-boxed Item
- (in-module "Pango")
- (c-name "PangoItem")
- (fields
- '("gint" "offset")
- '("gint" "length")
- '("gint" "num_chars")
- '("PangoEngineShape*" "analysis.shape_engine")
- '("PangoEngineLang*" "analysis.lang_engine")
- '("PangoFont*" "analysis.font")
- '("guint8" "analysis.level")
- '("PangoLanguage*" "analysis.language")
- '("GSList*" "analysis.extra_attrs")
- )
- (gtype-id "PANGO_TYPE_ITEM")
-)
-
-(define-boxed Language
- (in-module "Pango")
- (c-name "PangoLanguage")
- (gtype-id "PANGO_TYPE_LANGUAGE")
-)
-
-(define-boxed LayoutIter
- (in-module "Pango")
- (c-name "PangoLayoutIter")
- (gtype-id "PANGO_TYPE_LAYOUT_ITER")
- (release-func "pango_layout_iter_free")
-)
-
-
-(define-boxed LayoutLine
- (in-module "Pango")
- (c-name "PangoLayoutLine")
- (gtype-id "PANGO_TYPE_LAYOUT_LINE")
- (fields
- ; '("PangoLayout*" "layout") ;; omitted for fear of creating reference cycles
- '("gint" "start_index")
- '("gint" "length")
- '("GSList*" "runs")
- '("guint" "is_paragraph_start")
- '("guint" "resolved_dir")
- )
-)
-
-(define-boxed Matrix
- (in-module "Pango")
- (c-name "PangoMatrix")
- (gtype-id "PANGO_TYPE_MATRIX")
-)
-
-(define-boxed TabArray
- (in-module "Pango")
- (c-name "PangoTabArray")
- (gtype-id "PANGO_TYPE_TAB_ARRAY")
- (copy-func "pango_tab_array_copy")
- (release-func "pango_tab_array_free")
-)
-
-
-; object definitions ...
-
-(define-object Context
- (in-module "Pango")
- (parent "GObject")
- (c-name "PangoContext")
- (gtype-id "PANGO_TYPE_CONTEXT")
-)
-
-(define-object Engine
- (in-module "Pango")
- (parent "GObject")
- (c-name "PangoEngine")
- (gtype-id "PANGO_TYPE_ENGINE")
-)
-
-(define-object EngineLang
- (in-module "Pango")
- (parent "PangoEngine")
- (c-name "PangoEngineLang")
- (gtype-id "PANGO_TYPE_ENGINE_LANG")
-)
-
-(define-object EngineShape
- (in-module "Pango")
- (parent "PangoEngine")
- (c-name "PangoEngineShape")
- (gtype-id "PANGO_TYPE_ENGINE_SHAPE")
-)
-
-(define-object Font
- (in-module "Pango")
- (parent "GObject")
- (c-name "PangoFont")
- (gtype-id "PANGO_TYPE_FONT")
-)
-
-(define-object FontFace
- (in-module "Pango")
- (parent "GObject")
- (c-name "PangoFontFace")
- (gtype-id "PANGO_TYPE_FONT_FACE")
-)
-
-(define-object FontFamily
- (in-module "Pango")
- (parent "GObject")
- (c-name "PangoFontFamily")
- (gtype-id "PANGO_TYPE_FONT_FAMILY")
-)
-
-(define-object FontMap
- (in-module "Pango")
- (parent "GObject")
- (c-name "PangoFontMap")
- (gtype-id "PANGO_TYPE_FONT_MAP")
-)
-
-(define-object Fontset
- (in-module "Pango")
- (parent "GObject")
- (c-name "PangoFontset")
- (gtype-id "PANGO_TYPE_FONTSET")
-)
-
-(define-object FontsetSimple
- (in-module "Pango")
- (parent "PangoFontset")
- (c-name "PangoFontsetSimple")
- (gtype-id "PANGO_TYPE_FONTSET_SIMPLE")
-)
-
-(define-object Layout
- (in-module "Pango")
- (parent "GObject")
- (c-name "PangoLayout")
- (gtype-id "PANGO_TYPE_LAYOUT")
-)
-
-(define-object Renderer
- (in-module "Pango")
- (parent "GObject")
- (c-name "PangoRenderer")
- (gtype-id "PANGO_TYPE_RENDERER")
-)
-
-
-;; Enumerations and flags ...
-
-(define-enum Alignment
- (in-module "Pango")
- (c-name "PangoAlignment")
- (gtype-id "PANGO_TYPE_ALIGNMENT")
- (values
- '("left" "PANGO_ALIGN_LEFT")
- '("center" "PANGO_ALIGN_CENTER")
- '("right" "PANGO_ALIGN_RIGHT")
- )
-)
-
-(define-enum AttrType
- (in-module "Pango")
- (c-name "PangoAttrType")
- (gtype-id "PANGO_TYPE_ATTR_TYPE")
- (values
- '("invalid" "PANGO_ATTR_INVALID")
- '("language" "PANGO_ATTR_LANGUAGE")
- '("family" "PANGO_ATTR_FAMILY")
- '("style" "PANGO_ATTR_STYLE")
- '("weight" "PANGO_ATTR_WEIGHT")
- '("variant" "PANGO_ATTR_VARIANT")
- '("stretch" "PANGO_ATTR_STRETCH")
- '("size" "PANGO_ATTR_SIZE")
- '("font-desc" "PANGO_ATTR_FONT_DESC")
- '("foreground" "PANGO_ATTR_FOREGROUND")
- '("background" "PANGO_ATTR_BACKGROUND")
- '("underline" "PANGO_ATTR_UNDERLINE")
- '("strikethrough" "PANGO_ATTR_STRIKETHROUGH")
- '("rise" "PANGO_ATTR_RISE")
- '("shape" "PANGO_ATTR_SHAPE")
- '("scale" "PANGO_ATTR_SCALE")
- '("fallback" "PANGO_ATTR_FALLBACK")
- '("letter-spacing" "PANGO_ATTR_LETTER_SPACING")
- '("underline-color" "PANGO_ATTR_UNDERLINE_COLOR")
- '("strikethrough-color" "PANGO_ATTR_STRIKETHROUGH_COLOR")
- '("absolute-size" "PANGO_ATTR_ABSOLUTE_SIZE")
- )
-)
-
-(define-enum CoverageLevel
- (in-module "Pango")
- (c-name "PangoCoverageLevel")
- (gtype-id "PANGO_TYPE_COVERAGE_LEVEL")
- (values
- '("none" "PANGO_COVERAGE_NONE")
- '("fallback" "PANGO_COVERAGE_FALLBACK")
- '("approximate" "PANGO_COVERAGE_APPROXIMATE")
- '("exact" "PANGO_COVERAGE_EXACT")
- )
-)
-
-(define-enum Direction
- (in-module "Pango")
- (c-name "PangoDirection")
- (gtype-id "PANGO_TYPE_DIRECTION")
- (values
- '("ltr" "PANGO_DIRECTION_LTR")
- '("rtl" "PANGO_DIRECTION_RTL")
- '("ttb-ltr" "PANGO_DIRECTION_TTB_LTR")
- '("ttb-rtl" "PANGO_DIRECTION_TTB_RTL")
- '("weak-ltr" "PANGO_DIRECTION_WEAK_LTR")
- '("weak-rtl" "PANGO_DIRECTION_WEAK_RTL")
- '("neutral" "PANGO_DIRECTION_NEUTRAL")
- )
-)
-
-(define-enum EllipsizeMode
- (in-module "Pango")
- (c-name "PangoEllipsizeMode")
- (gtype-id "PANGO_TYPE_ELLIPSIZE_MODE")
- (values
- '("none" "PANGO_ELLIPSIZE_NONE")
- '("start" "PANGO_ELLIPSIZE_START")
- '("middle" "PANGO_ELLIPSIZE_MIDDLE")
- '("end" "PANGO_ELLIPSIZE_END")
- )
-)
-
-(define-enum RenderPart
- (in-module "Pango")
- (c-name "PangoRenderPart")
- (gtype-id "PANGO_TYPE_RENDER_PART")
- (values
- '("foreground" "PANGO_RENDER_PART_FOREGROUND")
- '("background" "PANGO_RENDER_PART_BACKGROUND")
- '("underline" "PANGO_RENDER_PART_UNDERLINE")
- '("strikethrough" "PANGO_RENDER_PART_STRIKETHROUGH")
- )
-)
-
-(define-enum Script
- (in-module "Pango")
- (c-name "PangoScript")
- (gtype-id "PANGO_TYPE_SCRIPT")
- (values
- '("invalid-code" "PANGO_SCRIPT_INVALID_CODE")
- '("common" "PANGO_SCRIPT_COMMON")
- '("inherited" "PANGO_SCRIPT_INHERITED")
- '("arabic" "PANGO_SCRIPT_ARABIC")
- '("armenian" "PANGO_SCRIPT_ARMENIAN")
- '("bengali" "PANGO_SCRIPT_BENGALI")
- '("bopomofo" "PANGO_SCRIPT_BOPOMOFO")
- '("cherokee" "PANGO_SCRIPT_CHEROKEE")
- '("coptic" "PANGO_SCRIPT_COPTIC")
- '("cyrillic" "PANGO_SCRIPT_CYRILLIC")
- '("deseret" "PANGO_SCRIPT_DESERET")
- '("devanagari" "PANGO_SCRIPT_DEVANAGARI")
- '("ethiopic" "PANGO_SCRIPT_ETHIOPIC")
- '("georgian" "PANGO_SCRIPT_GEORGIAN")
- '("gothic" "PANGO_SCRIPT_GOTHIC")
- '("greek" "PANGO_SCRIPT_GREEK")
- '("gujarati" "PANGO_SCRIPT_GUJARATI")
- '("gurmukhi" "PANGO_SCRIPT_GURMUKHI")
- '("han" "PANGO_SCRIPT_HAN")
- '("hangul" "PANGO_SCRIPT_HANGUL")
- '("hebrew" "PANGO_SCRIPT_HEBREW")
- '("hiragana" "PANGO_SCRIPT_HIRAGANA")
- '("kannada" "PANGO_SCRIPT_KANNADA")
- '("katakana" "PANGO_SCRIPT_KATAKANA")
- '("khmer" "PANGO_SCRIPT_KHMER")
- '("lao" "PANGO_SCRIPT_LAO")
- '("latin" "PANGO_SCRIPT_LATIN")
- '("malayalam" "PANGO_SCRIPT_MALAYALAM")
- '("mongolian" "PANGO_SCRIPT_MONGOLIAN")
- '("myanmar" "PANGO_SCRIPT_MYANMAR")
- '("ogham" "PANGO_SCRIPT_OGHAM")
- '("old-italic" "PANGO_SCRIPT_OLD_ITALIC")
- '("oriya" "PANGO_SCRIPT_ORIYA")
- '("runic" "PANGO_SCRIPT_RUNIC")
- '("sinhala" "PANGO_SCRIPT_SINHALA")
- '("syriac" "PANGO_SCRIPT_SYRIAC")
- '("tamil" "PANGO_SCRIPT_TAMIL")
- '("telugu" "PANGO_SCRIPT_TELUGU")
- '("thaana" "PANGO_SCRIPT_THAANA")
- '("thai" "PANGO_SCRIPT_THAI")
- '("tibetan" "PANGO_SCRIPT_TIBETAN")
- '("canadian-aboriginal" "PANGO_SCRIPT_CANADIAN_ABORIGINAL")
- '("yi" "PANGO_SCRIPT_YI")
- '("tagalog" "PANGO_SCRIPT_TAGALOG")
- '("hanunoo" "PANGO_SCRIPT_HANUNOO")
- '("buhid" "PANGO_SCRIPT_BUHID")
- '("tagbanwa" "PANGO_SCRIPT_TAGBANWA")
- '("braille" "PANGO_SCRIPT_BRAILLE")
- '("cypriot" "PANGO_SCRIPT_CYPRIOT")
- '("limbu" "PANGO_SCRIPT_LIMBU")
- '("osmanya" "PANGO_SCRIPT_OSMANYA")
- '("shavian" "PANGO_SCRIPT_SHAVIAN")
- '("linear-b" "PANGO_SCRIPT_LINEAR_B")
- '("tai-le" "PANGO_SCRIPT_TAI_LE")
- '("ugaritic" "PANGO_SCRIPT_UGARITIC")
- '("new-tai-lue" "PANGO_SCRIPT_NEW_TAI_LUE")
- '("buginese" "PANGO_SCRIPT_BUGINESE")
- '("glagolitic" "PANGO_SCRIPT_GLAGOLITIC")
- '("tifinagh" "PANGO_SCRIPT_TIFINAGH")
- '("syloti-nagri" "PANGO_SCRIPT_SYLOTI_NAGRI")
- '("old-persian" "PANGO_SCRIPT_OLD_PERSIAN")
- '("kharoshthi" "PANGO_SCRIPT_KHAROSHTHI")
- )
-)
-
-(define-enum Stretch
- (in-module "Pango")
- (c-name "PangoStretch")
- (gtype-id "PANGO_TYPE_STRETCH")
- (values
- '("ultra-condensed" "PANGO_STRETCH_ULTRA_CONDENSED")
- '("extra-condensed" "PANGO_STRETCH_EXTRA_CONDENSED")
- '("condensed" "PANGO_STRETCH_CONDENSED")
- '("semi-condensed" "PANGO_STRETCH_SEMI_CONDENSED")
- '("normal" "PANGO_STRETCH_NORMAL")
- '("semi-expanded" "PANGO_STRETCH_SEMI_EXPANDED")
- '("expanded" "PANGO_STRETCH_EXPANDED")
- '("extra-expanded" "PANGO_STRETCH_EXTRA_EXPANDED")
- '("ultra-expanded" "PANGO_STRETCH_ULTRA_EXPANDED")
- )
-)
-
-(define-enum Style
- (in-module "Pango")
- (c-name "PangoStyle")
- (gtype-id "PANGO_TYPE_STYLE")
- (values
- '("normal" "PANGO_STYLE_NORMAL")
- '("oblique" "PANGO_STYLE_OBLIQUE")
- '("italic" "PANGO_STYLE_ITALIC")
- )
-)
-
-(define-enum TabAlign
- (in-module "Pango")
- (c-name "PangoTabAlign")
- (gtype-id "PANGO_TYPE_TAB_ALIGN")
- (values
- '("left" "PANGO_TAB_LEFT")
- )
-)
-
-(define-enum Underline
- (in-module "Pango")
- (c-name "PangoUnderline")
- (gtype-id "PANGO_TYPE_UNDERLINE")
- (values
- '("none" "PANGO_UNDERLINE_NONE")
- '("single" "PANGO_UNDERLINE_SINGLE")
- '("double" "PANGO_UNDERLINE_DOUBLE")
- '("low" "PANGO_UNDERLINE_LOW")
- '("error" "PANGO_UNDERLINE_ERROR")
- )
-)
-
-(define-enum Variant
- (in-module "Pango")
- (c-name "PangoVariant")
- (gtype-id "PANGO_TYPE_VARIANT")
- (values
- '("normal" "PANGO_VARIANT_NORMAL")
- '("small-caps" "PANGO_VARIANT_SMALL_CAPS")
- )
-)
-
-(define-enum Weight
- (in-module "Pango")
- (c-name "PangoWeight")
- (gtype-id "PANGO_TYPE_WEIGHT")
- (values
- '("ultralight" "PANGO_WEIGHT_ULTRALIGHT")
- '("light" "PANGO_WEIGHT_LIGHT")
- '("normal" "PANGO_WEIGHT_NORMAL")
- '("semibold" "PANGO_WEIGHT_SEMIBOLD")
- '("bold" "PANGO_WEIGHT_BOLD")
- '("ultrabold" "PANGO_WEIGHT_ULTRABOLD")
- '("heavy" "PANGO_WEIGHT_HEAVY")
- )
-)
-
-(define-enum WrapMode
- (in-module "Pango")
- (c-name "PangoWrapMode")
- (gtype-id "PANGO_TYPE_WRAP_MODE")
- (values
- '("word" "PANGO_WRAP_WORD")
- '("char" "PANGO_WRAP_CHAR")
- '("word-char" "PANGO_WRAP_WORD_CHAR")
- )
-)
-
-(define-flags FontMask
- (in-module "Pango")
- (c-name "PangoFontMask")
- (gtype-id "PANGO_TYPE_FONT_MASK")
- (values
- '("family" "PANGO_FONT_MASK_FAMILY")
- '("style" "PANGO_FONT_MASK_STYLE")
- '("variant" "PANGO_FONT_MASK_VARIANT")
- '("weight" "PANGO_FONT_MASK_WEIGHT")
- '("stretch" "PANGO_FONT_MASK_STRETCH")
- '("size" "PANGO_FONT_MASK_SIZE")
- )
-)
-
diff --git a/pango.defs b/pango.defs
deleted file mode 100644
index 1b91550d..00000000
--- a/pango.defs
+++ /dev/null
@@ -1,3053 +0,0 @@
-;; -*- scheme -*-
-
-(include "pango-types.defs")
-
-;; From /opt/gtk2/include/pango-1.0/pango/pango-attributes.h
-
-(define-function pango_color_get_type
- (c-name "pango_color_get_type")
- (return-type "GType")
-)
-
-(define-method copy
- (of-object "PangoColor")
- (c-name "pango_color_copy")
- (return-type "PangoColor*")
-)
-
-(define-method free
- (of-object "PangoColor")
- (c-name "pango_color_free")
- (return-type "none")
-)
-
-(define-function color_parse
- (c-name "pango_color_parse")
- (is-constructor-of "PangoColor")
- (return-type "gboolean")
- (parameters
- '("const-char*" "spec")
- )
-)
-
-(define-function pango_attr_type_register
- (c-name "pango_attr_type_register")
- (return-type "PangoAttrType")
- (parameters
- '("const-gchar*" "name")
- )
-)
-
-(define-method copy
- (of-object "PangoAttribute")
- (c-name "pango_attribute_copy")
- (return-type "PangoAttribute*")
-)
-
-(define-method destroy
- (of-object "PangoAttribute")
- (c-name "pango_attribute_destroy")
- (return-type "none")
-)
-
-(define-method equal
- (of-object "PangoAttribute")
- (c-name "pango_attribute_equal")
- (return-type "gboolean")
- (parameters
- '("const-PangoAttribute*" "attr2")
- )
-)
-
-(define-function AttrLanguage
- (c-name "pango_attr_language_new")
- (return-type "PangoAttribute*")
- (parameters
- '("PangoLanguage*" "language")
- )
-)
-
-(define-function AttrFamily
- (c-name "pango_attr_family_new")
- (return-type "PangoAttribute*")
- (parameters
- '("const-char*" "family")
- )
-)
-
-(define-function AttrForeground
- (c-name "pango_attr_foreground_new")
- (return-type "PangoAttribute*")
- (parameters
- '("guint16" "red")
- '("guint16" "green")
- '("guint16" "blue")
- )
-)
-
-(define-function AttrBackground
- (c-name "pango_attr_background_new")
- (return-type "PangoAttribute*")
- (parameters
- '("guint16" "red")
- '("guint16" "green")
- '("guint16" "blue")
- )
-)
-
-(define-function AttrSize
- (c-name "pango_attr_size_new")
- (return-type "PangoAttribute*")
- (parameters
- '("int" "size")
- )
-)
-
-(define-function AttrSizeAbsolute
- (c-name "pango_attr_size_new_absolute")
- (return-type "PangoAttribute*")
- (parameters
- '("int" "size")
- )
-)
-
-(define-function AttrStyle
- (c-name "pango_attr_style_new")
- (return-type "PangoAttribute*")
- (parameters
- '("PangoStyle" "style")
- )
-)
-
-(define-function AttrWeight
- (c-name "pango_attr_weight_new")
- (return-type "PangoAttribute*")
- (parameters
- '("PangoWeight" "weight")
- )
-)
-
-(define-function AttrVariant
- (c-name "pango_attr_variant_new")
- (return-type "PangoAttribute*")
- (parameters
- '("PangoVariant" "variant")
- )
-)
-
-(define-function AttrStretch
- (c-name "pango_attr_stretch_new")
- (return-type "PangoAttribute*")
- (parameters
- '("PangoStretch" "stretch")
- )
-)
-
-(define-function AttrFontDesc
- (c-name "pango_attr_font_desc_new")
- (return-type "PangoAttribute*")
- (parameters
- '("const-PangoFontDescription*" "desc")
- )
-)
-
-(define-function AttrUnderline
- (c-name "pango_attr_underline_new")
- (return-type "PangoAttribute*")
- (parameters
- '("PangoUnderline" "underline")
- )
-)
-
-(define-function AttrUnderlineColor
- (c-name "pango_attr_underline_color_new")
- (return-type "PangoAttribute*")
- (parameters
- '("guint16" "red")
- '("guint16" "green")
- '("guint16" "blue")
- )
-)
-
-(define-function AttrStrikethrough
- (c-name "pango_attr_strikethrough_new")
- (return-type "PangoAttribute*")
- (parameters
- '("gboolean" "strikethrough")
- )
-)
-
-(define-function AttrStrikethroughColor
- (c-name "pango_attr_strikethrough_color_new")
- (return-type "PangoAttribute*")
- (parameters
- '("guint16" "red")
- '("guint16" "green")
- '("guint16" "blue")
- )
-)
-
-(define-function AttrRise
- (c-name "pango_attr_rise_new")
- (return-type "PangoAttribute*")
- (parameters
- '("int" "rise")
- )
-)
-
-(define-function AttrScale
- (c-name "pango_attr_scale_new")
- (return-type "PangoAttribute*")
- (parameters
- '("double" "scale_factor")
- )
-)
-
-(define-function AttrFallback
- (c-name "pango_attr_fallback_new")
- (return-type "PangoAttribute*")
- (parameters
- '("gboolean" "fallback")
- )
-)
-
-(define-function AttrLetterSpacing
- (c-name "pango_attr_letter_spacing_new")
- (return-type "PangoAttribute*")
- (parameters
- '("int" "letter_spacing")
- )
-)
-
-(define-function AttrShape
- (c-name "pango_attr_shape_new")
- (return-type "PangoAttribute*")
- (parameters
- '("const-PangoRectangle*" "ink_rect")
- '("const-PangoRectangle*" "logical_rect")
- )
-)
-
-(define-function attr_shape_new_with_data
- (c-name "pango_attr_shape_new_with_data")
- (return-type "PangoAttribute*")
- (parameters
- '("const-PangoRectangle*" "ink_rect")
- '("const-PangoRectangle*" "logical_rect")
- '("gpointer" "data")
- '("PangoAttrDataCopyFunc" "copy_func")
- '("GDestroyNotify" "destroy_func")
- )
-)
-
-(define-function pango_attr_list_get_type
- (c-name "pango_attr_list_get_type")
- (return-type "GType")
-)
-
-(define-function pango_attr_list_new
- (c-name "pango_attr_list_new")
- (return-type "PangoAttrList*")
- (is-constructor-of "PangoAttrList")
-)
-
-(define-method ref
- (of-object "PangoAttrList")
- (c-name "pango_attr_list_ref")
- (return-type "none")
-)
-
-(define-method unref
- (of-object "PangoAttrList")
- (c-name "pango_attr_list_unref")
- (return-type "none")
-)
-
-(define-method copy
- (of-object "PangoAttrList")
- (c-name "pango_attr_list_copy")
- (return-type "PangoAttrList*")
-)
-
-(define-method insert
- (of-object "PangoAttrList")
- (c-name "pango_attr_list_insert")
- (return-type "none")
- (parameters
- '("PangoAttribute*" "attr")
- )
-)
-
-(define-method insert_before
- (of-object "PangoAttrList")
- (c-name "pango_attr_list_insert_before")
- (return-type "none")
- (parameters
- '("PangoAttribute*" "attr")
- )
-)
-
-(define-method change
- (of-object "PangoAttrList")
- (c-name "pango_attr_list_change")
- (return-type "none")
- (parameters
- '("PangoAttribute*" "attr")
- )
-)
-
-(define-method splice
- (of-object "PangoAttrList")
- (c-name "pango_attr_list_splice")
- (return-type "none")
- (parameters
- '("PangoAttrList*" "other")
- '("gint" "pos")
- '("gint" "len")
- )
-)
-
-(define-method filter
- (of-object "PangoAttrList")
- (c-name "pango_attr_list_filter")
- (return-type "PangoAttrList*")
- (parameters
- '("PangoAttrFilterFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-method get_iterator
- (of-object "PangoAttrList")
- (c-name "pango_attr_list_get_iterator")
- (return-type "PangoAttrIterator*")
-)
-
-(define-method range
- (of-object "PangoAttrIterator")
- (c-name "pango_attr_iterator_range")
- (return-type "none")
- (parameters
- '("gint*" "start")
- '("gint*" "end")
- )
-)
-
-(define-method next
- (of-object "PangoAttrIterator")
- (c-name "pango_attr_iterator_next")
- (return-type "gboolean")
-)
-
-(define-method copy
- (of-object "PangoAttrIterator")
- (c-name "pango_attr_iterator_copy")
- (return-type "PangoAttrIterator*")
-)
-
-(define-method destroy
- (of-object "PangoAttrIterator")
- (c-name "pango_attr_iterator_destroy")
- (return-type "none")
-)
-
-(define-method get
- (of-object "PangoAttrIterator")
- (c-name "pango_attr_iterator_get")
- (return-type "PangoAttribute*")
- (parameters
- '("PangoAttrType" "type")
- )
-)
-
-(define-method get_font
- (of-object "PangoAttrIterator")
- (c-name "pango_attr_iterator_get_font")
- (return-type "none")
- (parameters
- '("PangoFontDescription*" "desc")
- '("PangoLanguage**" "language")
- '("GSList**" "extra_attrs")
- )
-)
-
-(define-method get_attrs
- (of-object "PangoAttrIterator")
- (c-name "pango_attr_iterator_get_attrs")
- (return-type "GSList*")
-)
-
-(define-function parse_markup
- (c-name "pango_parse_markup")
- (return-type "gboolean")
- (parameters
- '("const-char*" "markup_text")
- '("int" "length")
- '("gunichar" "accel_marker")
- '("PangoAttrList**" "attr_list")
- '("char**" "text")
- '("gunichar*" "accel_char")
- '("GError**" "error")
- )
-)
-
-(define-virtual copy
- (of-object "PangoAttr")
- (return-type "PangoAttribute*")
-)
-
-(define-virtual destroy
- (of-object "PangoAttr")
- (return-type "none")
-)
-
-(define-virtual equal
- (of-object "PangoAttr")
- (return-type "gboolean")
- (parameters
- '("const-PangoAttribute*" "attr2")
- )
-)
-
-
-
-;; From /opt/gtk2/include/pango-1.0/pango/pango-break.h
-
-(define-function break
- (c-name "pango_break")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("gint" "length")
- '("PangoAnalysis*" "analysis")
- '("PangoLogAttr*" "attrs")
- )
-)
-
-(define-function find_paragraph_boundary
- (c-name "pango_find_paragraph_boundary")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("gint" "length")
- '("gint*" "paragraph_delimiter_index")
- '("gint*" "next_paragraph_start")
- )
-)
-
-(define-function get_log_attrs
- (c-name "pango_get_log_attrs")
- (return-type "none")
- (parameters
- '("const-char*" "text")
- '("int" "length")
- '("int" "level")
- '("PangoLanguage*" "language")
- '("PangoLogAttr*" "log_attrs")
- )
-)
-
-(define-function default_break
- (c-name "pango_default_break")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("int" "length")
- '("PangoAnalysis*" "analysis")
- '("PangoLogAttr*" "attrs")
- '("int" "attrs_len")
- )
-)
-
-
-
-;; From /opt/gtk2/include/pango-1.0/pango/pango-context.h
-
-(define-function context_get_type
- (c-name "pango_context_get_type")
- (return-type "GType")
-)
-
-(define-function pango_context_new
- (c-name "pango_context_new")
- (return-type "PangoContext*")
- (is-constructor-of "PangoContext")
-)
-
-(define-method add_font_map
- (of-object "PangoContext")
- (c-name "pango_context_set_font_map")
- (return-type "none")
- (parameters
- '("PangoFontMap*" "font_map")
- )
-)
-
-(define-method get_font_map
- (of-object "PangoContext")
- (c-name "pango_context_get_font_map")
- (return-type "PangoFontMap*")
-)
-
-(define-method list_families
- (of-object "PangoContext")
- (c-name "pango_context_list_families")
- (return-type "none")
- (parameters
- '("PangoFontFamily***" "families")
- '("int*" "n_families")
- )
-)
-
-(define-method load_font
- (of-object "PangoContext")
- (c-name "pango_context_load_font")
- (return-type "PangoFont*")
- (parameters
- '("const-PangoFontDescription*" "desc")
- )
-)
-
-(define-method load_fontset
- (of-object "PangoContext")
- (c-name "pango_context_load_fontset")
- (return-type "PangoFontset*")
- (parameters
- '("const-PangoFontDescription*" "desc")
- '("PangoLanguage*" "language")
- )
-)
-
-(define-method get_metrics
- (of-object "PangoContext")
- (c-name "pango_context_get_metrics")
- (return-type "PangoFontMetrics*")
- (caller-owns-return #t)
- (parameters
- '("const-PangoFontDescription*" "desc")
- '("PangoLanguage*" "language" (null-ok) (default "NULL"))
- )
-)
-
-(define-method set_font_description
- (of-object "PangoContext")
- (c-name "pango_context_set_font_description")
- (return-type "none")
- (parameters
- '("const-PangoFontDescription*" "desc")
- )
-)
-
-(define-method get_font_description
- (of-object "PangoContext")
- (c-name "pango_context_get_font_description")
- (return-type "PangoFontDescription*")
-)
-
-(define-method get_language
- (of-object "PangoContext")
- (c-name "pango_context_get_language")
- (return-type "PangoLanguage*")
-)
-
-(define-method set_language
- (of-object "PangoContext")
- (c-name "pango_context_set_language")
- (return-type "none")
- (parameters
- '("PangoLanguage*" "language")
- )
-)
-
-(define-method set_base_dir
- (of-object "PangoContext")
- (c-name "pango_context_set_base_dir")
- (return-type "none")
- (parameters
- '("PangoDirection" "direction")
- )
-)
-
-(define-method get_base_dir
- (of-object "PangoContext")
- (c-name "pango_context_get_base_dir")
- (return-type "PangoDirection")
-)
-
-(define-method set_matrix
- (of-object "PangoContext")
- (c-name "pango_context_set_matrix")
- (return-type "none")
- (parameters
- '("const-PangoMatrix*" "matrix")
- )
-)
-
-(define-method get_matrix
- (of-object "PangoContext")
- (c-name "pango_context_get_matrix")
- (return-type "const-PangoMatrix*")
-)
-
-(define-function itemize
- (c-name "pango_itemize")
- (return-type "GList*")
- (parameters
- '("PangoContext*" "context")
- '("const-char*" "text")
- '("int" "start_index")
- '("int" "length")
- '("PangoAttrList*" "attrs")
- '("PangoAttrIterator*" "cached_iter" (null-ok) (default "NULL"))
- )
-)
-
-(define-function itemize_with_base_dir
- (c-name "pango_itemize_with_base_dir")
- (return-type "GList*")
- (parameters
- '("PangoContext*" "context")
- '("PangoDirection" "base_dir")
- '("const-char*" "text")
- '("int" "start_index")
- '("int" "length")
- '("PangoAttrList*" "attrs")
- '("PangoAttrIterator*" "cached_iter")
- )
-)
-
-
-
-;; From /opt/gtk2/include/pango-1.0/pango/pango-coverage.h
-
-(define-function coverage_new
- (c-name "pango_coverage_new")
- (is-constructor-of "PangoCoverage")
- (return-type "PangoCoverage*")
-)
-
-(define-method ref
- (of-object "PangoCoverage")
- (c-name "pango_coverage_ref")
- (return-type "PangoCoverage*")
-)
-
-(define-method unref
- (of-object "PangoCoverage")
- (c-name "pango_coverage_unref")
- (return-type "none")
-)
-
-(define-method copy
- (of-object "PangoCoverage")
- (c-name "pango_coverage_copy")
- (return-type "PangoCoverage*")
-)
-
-(define-method get
- (of-object "PangoCoverage")
- (c-name "pango_coverage_get")
- (return-type "PangoCoverageLevel")
- (parameters
- '("int" "index")
- )
-)
-
-(define-method set
- (of-object "PangoCoverage")
- (c-name "pango_coverage_set")
- (return-type "none")
- (parameters
- '("int" "index")
- '("PangoCoverageLevel" "level")
- )
-)
-
-(define-method max
- (of-object "PangoCoverage")
- (c-name "pango_coverage_max")
- (return-type "none")
- (parameters
- '("PangoCoverage*" "other")
- )
-)
-
-(define-method to_bytes
- (of-object "PangoCoverage")
- (c-name "pango_coverage_to_bytes")
- (return-type "none")
- (parameters
- '("guchar**" "bytes")
- '("int*" "n_bytes")
- )
-)
-
-(define-function coverage_from_bytes
- (c-name "pango_coverage_from_bytes")
- (is-constructor-of "PangoCoverage")
- (return-type "PangoCoverage*")
- (parameters
- '("guchar*" "bytes")
- '("int" "n_bytes")
- )
-)
-
-
-
-;; From pango-engine.h
-
-(ifdef PANGO_ENABLE_ENGINE
-
-(define-function engine_get_type
- (c-name "pango_engine_get_type")
- (return-type "GType")
-)
-
-(define-function engine_lang_get_type
- (c-name "pango_engine_lang_get_type")
- (return-type "GType")
-)
-
-(define-function engine_shape_get_type
- (c-name "pango_engine_shape_get_type")
- (return-type "GType")
-)
-
-(define-virtual script_break
- (of-object "PangoEngineLang")
- (return-type "none")
- (parameters
- '("const-char*" "text")
- '("int" "len")
- '("PangoAnalysis*" "analysis")
- '("PangoLogAttr*" "attrs")
- '("int" "attrs_len")
- )
-)
-
-(define-virtual script_shape
- (of-object "PangoEngineShape")
- (return-type "none")
- (parameters
- '("PangoFont*" "font")
- '("const-char*" "text")
- '("int" "length")
- '("PangoAnalysis*" "analysis")
- '("PangoGlyphString*" "glyphs")
- )
-)
-
-(define-virtual covers
- (of-object "PangoEngineShape")
- (return-type "PangoCoverageLevel")
- (parameters
- '("PangoFont*" "font")
- '("PangoLanguage*" "language")
- '("gunichar" "wc")
- )
-)
-) ;; PANGO_ENABLE_ENGINE
-
-
-;; From pango-enum-types.h
-
-(define-function attr_type_get_type
- (c-name "pango_attr_type_get_type")
- (return-type "GType")
-)
-
-(define-function underline_get_type
- (c-name "pango_underline_get_type")
- (return-type "GType")
-)
-
-(define-function coverage_level_get_type
- (c-name "pango_coverage_level_get_type")
- (return-type "GType")
-)
-
-(define-function style_get_type
- (c-name "pango_style_get_type")
- (return-type "GType")
-)
-
-(define-function variant_get_type
- (c-name "pango_variant_get_type")
- (return-type "GType")
-)
-
-(define-function weight_get_type
- (c-name "pango_weight_get_type")
- (return-type "GType")
-)
-
-(define-function stretch_get_type
- (c-name "pango_stretch_get_type")
- (return-type "GType")
-)
-
-(define-function font_mask_get_type
- (c-name "pango_font_mask_get_type")
- (return-type "GType")
-)
-
-(define-function alignment_get_type
- (c-name "pango_alignment_get_type")
- (return-type "GType")
-)
-
-(define-function wrap_mode_get_type
- (c-name "pango_wrap_mode_get_type")
- (return-type "GType")
-)
-
-(define-function ellipsize_mode_get_type
- (c-name "pango_ellipsize_mode_get_type")
- (return-type "GType")
-)
-
-(define-function render_part_get_type
- (c-name "pango_render_part_get_type")
- (return-type "GType")
-)
-
-(define-function script_get_type
- (c-name "pango_script_get_type")
- (return-type "GType")
-)
-
-(define-function tab_align_get_type
- (c-name "pango_tab_align_get_type")
- (return-type "GType")
-)
-
-(define-function direction_get_type
- (c-name "pango_direction_get_type")
- (return-type "GType")
-)
-
-
-
-;; From /opt/gtk2/include/pango-1.0/pango/pango-font.h
-
-
-(define-function font_description_get_type
- (c-name "pango_font_description_get_type")
- (return-type "GType")
-)
-
-(define-function pango_font_description_new
- (c-name "pango_font_description_new")
- (is-constructor-of "PangoFontDescription")
- (return-type "PangoFontDescription*")
-)
-
-(define-method copy
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_copy")
- (return-type "PangoFontDescription*")
-)
-
-(define-method copy_static
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_copy_static")
- (return-type "PangoFontDescription*")
-)
-
-(define-method hash
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_hash")
- (return-type "guint")
-)
-
-(define-method equal
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_equal")
- (return-type "gboolean")
- (parameters
- '("const-PangoFontDescription*" "desc2")
- )
-)
-
-(define-method free
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_free")
- (return-type "none")
-)
-
-(define-function pango_font_descriptions_free
- (c-name "pango_font_descriptions_free")
- (return-type "none")
- (parameters
- '("PangoFontDescription**" "descs")
- '("int" "n_descs")
- )
-)
-
-(define-method set_family
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_set_family")
- (return-type "none")
- (parameters
- '("const-char*" "family")
- )
-)
-
-(define-method set_family_static
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_set_family_static")
- (return-type "none")
- (parameters
- '("const-char*" "family")
- )
-)
-
-(define-method get_family
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_get_family")
- (return-type "const-char*")
-)
-
-(define-method set_style
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_set_style")
- (return-type "none")
- (parameters
- '("PangoStyle" "style")
- )
-)
-
-(define-method get_style
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_get_style")
- (return-type "PangoStyle")
-)
-
-(define-method set_variant
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_set_variant")
- (return-type "none")
- (parameters
- '("PangoVariant" "variant")
- )
-)
-
-(define-method get_variant
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_get_variant")
- (return-type "PangoVariant")
-)
-
-(define-method set_weight
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_set_weight")
- (return-type "none")
- (parameters
- '("PangoWeight" "weight")
- )
-)
-
-(define-method get_weight
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_get_weight")
- (return-type "PangoWeight")
-)
-
-(define-method set_stretch
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_set_stretch")
- (return-type "none")
- (parameters
- '("PangoStretch" "stretch")
- )
-)
-
-(define-method get_stretch
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_get_stretch")
- (return-type "PangoStretch")
-)
-
-(define-method set_size
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_set_size")
- (return-type "none")
- (parameters
- '("gint" "size")
- )
-)
-
-(define-method get_size
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_get_size")
- (return-type "gint")
-)
-
-(define-method set_absolute_size
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_set_absolute_size")
- (return-type "none")
- (parameters
- '("double" "size")
- )
-)
-
-(define-method get_size_is_absolute
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_get_size_is_absolute")
- (return-type "gboolean")
-)
-
-(define-method get_set_fields
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_get_set_fields")
- (return-type "PangoFontMask")
-)
-
-(define-method unset_fields
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_unset_fields")
- (return-type "none")
- (parameters
- '("PangoFontMask" "to_unset")
- )
-)
-
-(define-method merge
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_merge")
- (return-type "none")
- (parameters
- '("const-PangoFontDescription*" "desc_to_merge")
- '("gboolean" "replace_existing")
- )
-)
-
-(define-method merge_static
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_merge_static")
- (return-type "none")
- (parameters
- '("const-PangoFontDescription*" "desc_to_merge")
- '("gboolean" "replace_existing")
- )
-)
-
-(define-method better_match
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_better_match")
- (return-type "gboolean")
- (parameters
- '("const-PangoFontDescription*" "old_match" (null-ok) (default "NULL"))
- '("const-PangoFontDescription*" "new_match")
- )
-)
-
-(define-function pango_font_description_from_string
- (c-name "pango_font_description_from_string")
- (is-constructor-of "PangoFontDescription")
- (return-type "PangoFontDescription*")
- (parameters
- '("const-char*" "str")
- )
-)
-
-(define-method to_string
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_to_string")
- (return-type "char*")
-)
-
-(define-method to_filename
- (of-object "PangoFontDescription")
- (c-name "pango_font_description_to_filename")
- (return-type "char*")
-)
-
-(define-function pango_font_metrics_get_type
- (c-name "pango_font_metrics_get_type")
- (return-type "GType")
-)
-
-(define-method ref
- (of-object "PangoFontMetrics")
- (c-name "pango_font_metrics_ref")
- (return-type "PangoFontMetrics*")
-)
-
-(define-method unref
- (of-object "PangoFontMetrics")
- (c-name "pango_font_metrics_unref")
- (return-type "none")
-)
-
-(define-method get_ascent
- (of-object "PangoFontMetrics")
- (c-name "pango_font_metrics_get_ascent")
- (return-type "int")
-)
-
-(define-method get_descent
- (of-object "PangoFontMetrics")
- (c-name "pango_font_metrics_get_descent")
- (return-type "int")
-)
-
-(define-method get_approximate_char_width
- (of-object "PangoFontMetrics")
- (c-name "pango_font_metrics_get_approximate_char_width")
- (return-type "int")
-)
-
-(define-method get_approximate_digit_width
- (of-object "PangoFontMetrics")
- (c-name "pango_font_metrics_get_approximate_digit_width")
- (return-type "int")
-)
-
-(define-method get_underline_position
- (of-object "PangoFontMetrics")
- (c-name "pango_font_metrics_get_underline_position")
- (return-type "int")
-)
-
-(define-method get_underline_thickness
- (of-object "PangoFontMetrics")
- (c-name "pango_font_metrics_get_underline_thickness")
- (return-type "int")
-)
-
-(define-method get_strikethrough_position
- (of-object "PangoFontMetrics")
- (c-name "pango_font_metrics_get_strikethrough_position")
- (return-type "int")
-)
-
-(define-method get_strikethrough_thickness
- (of-object "PangoFontMetrics")
- (c-name "pango_font_metrics_get_strikethrough_thickness")
- (return-type "int")
-)
-
-(ifdef PANGO_ENABLE_BACKEND
-
-(define-function font_metrics_new
- (c-name "pango_font_metrics_new")
- (is-constructor-of "PangoFontMetrics")
- (return-type "PangoFontMetrics*")
-)
-) ;; PANGO_ENABLE_BACKEND
-
-(define-function pango_font_family_get_type
- (c-name "pango_font_family_get_type")
- (return-type "GType")
-)
-
-(define-method list_faces
- (of-object "PangoFontFamily")
- (c-name "pango_font_family_list_faces")
- (return-type "none")
- (parameters
- '("PangoFontFace***" "faces")
- '("int*" "n_faces")
- )
-)
-
-(define-method get_name
- (of-object "PangoFontFamily")
- (c-name "pango_font_family_get_name")
- (return-type "const-char*")
-)
-
-(define-method is_monospace
- (of-object "PangoFontFamily")
- (c-name "pango_font_family_is_monospace")
- (return-type "gboolean")
-)
-
-(define-function pango_font_face_get_type
- (c-name "pango_font_face_get_type")
- (return-type "GType")
-)
-
-(define-method describe
- (of-object "PangoFontFace")
- (c-name "pango_font_face_describe")
- (return-type "PangoFontDescription*")
-)
-
-(define-method get_face_name
- (of-object "PangoFontFace")
- (c-name "pango_font_face_get_face_name")
- (return-type "const-char*")
-)
-
-(define-method list_sizes
- (of-object "PangoFontFace")
- (c-name "pango_font_face_list_sizes")
- (return-type "none")
- (parameters
- '("int**" "sizes")
- '("int*" "n_sizes")
- )
-)
-
-(define-function pango_font_get_type
- (c-name "pango_font_get_type")
- (return-type "GType")
-)
-
-(define-method describe
- (of-object "PangoFont")
- (c-name "pango_font_describe")
- (return-type "PangoFontDescription*")
-)
-
-(define-method get_coverage
- (of-object "PangoFont")
- (c-name "pango_font_get_coverage")
- (return-type "PangoCoverage*")
- (parameters
- '("PangoLanguage*" "language")
- )
-)
-
-(define-method find_shaper
- (of-object "PangoFont")
- (c-name "pango_font_find_shaper")
- (return-type "PangoEngineShape*")
- (parameters
- '("PangoLanguage*" "language")
- '("guint32" "ch")
- )
-)
-
-(define-method get_metrics
- (of-object "PangoFont")
- (c-name "pango_font_get_metrics")
- (return-type "PangoFontMetrics*")
- (parameters
- '("PangoLanguage*" "language" (null-ok) (default "NULL"))
- )
-)
-
-(define-method get_glyph_extents
- (of-object "PangoFont")
- (c-name "pango_font_get_glyph_extents")
- (return-type "none")
- (parameters
- '("PangoGlyph" "glyph")
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-method get_font_map
- (of-object "PangoFont")
- (c-name "pango_font_get_font_map")
- (return-type "PangoFontMap*")
-)
-
-(define-virtual list_faces
- (of-object "PangoFontFamily")
- (return-type "none")
- (parameters
- '("PangoFontFace***" "faces")
- '("int*" "n_faces")
- )
-)
-
-(define-virtual get_name
- (of-object "PangoFontFamily")
- (return-type "const-char*")
-)
-
-(define-virtual is_monospace
- (of-object "PangoFontFamily")
- (return-type "gboolean")
-)
-
-(define-virtual get_face_name
- (of-object "PangoFontFace")
- (return-type "const-char*")
-)
-
-(define-virtual describe
- (of-object "PangoFontFace")
- (return-type "PangoFontDescription*")
-)
-
-(define-virtual list_sizes
- (of-object "PangoFontFace")
- (return-type "none")
- (parameters
- '("int**" "sizes")
- '("int*" "n_sizes")
- )
-)
-
-(define-virtual describe
- (of-object "PangoFont")
- (return-type "PangoFontDescription*")
-)
-
-(define-virtual get_coverage
- (of-object "PangoFont")
- (return-type "PangoCoverage*")
- (parameters
- '("PangoLanguage*" "lang")
- )
-)
-
-(define-virtual find_shaper
- (of-object "PangoFont")
- (return-type "PangoEngineShape*")
- (parameters
- '("PangoLanguage*" "lang")
- '("guint32" "ch")
- )
-)
-
-(define-virtual get_glyph_extents
- (of-object "PangoFont")
- (return-type "none")
- (parameters
- '("PangoGlyph" "glyph")
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-virtual get_metrics
- (of-object "PangoFont")
- (return-type "PangoFontMetrics*")
- (parameters
- '("PangoLanguage*" "language")
- )
-)
-
-(define-virtual get_font_map
- (of-object "PangoFont")
- (return-type "PangoFontMap*")
-)
-
-
-
-
-
-;; From /opt/gtk2/include/pango-1.0/pango/pango-fontmap.h
-
-(define-function font_map_get_type
- (c-name "pango_font_map_get_type")
- (return-type "GType")
-)
-
-(define-method load_font
- (of-object "PangoFontMap")
- (c-name "pango_font_map_load_font")
- (return-type "PangoFont*")
- (parameters
- '("PangoContext*" "context")
- '("const-PangoFontDescription*" "desc")
- )
-)
-
-(define-method load_fontset
- (of-object "PangoFontMap")
- (c-name "pango_font_map_load_fontset")
- (return-type "PangoFontset*")
- (parameters
- '("PangoContext*" "context")
- '("const-PangoFontDescription*" "desc")
- '("PangoLanguage*" "language")
- )
-)
-
-(define-method list_families
- (of-object "PangoFontMap")
- (c-name "pango_font_map_list_families")
- (return-type "none")
- (parameters
- '("PangoFontFamily***" "families")
- '("int*" "n_families")
- )
-)
-
-(define-method get_shape_engine_type
- (of-object "PangoFontMap")
- (c-name "pango_font_map_get_shape_engine_type")
- (return-type "const-char*")
-)
-
-(define-virtual load_font
- (of-object "PangoFontMap")
- (return-type "PangoFont*")
- (parameters
- '("PangoContext*" "context")
- '("const-PangoFontDescription*" "desc")
- )
-)
-
-(define-virtual list_families
- (of-object "PangoFontMap")
- (return-type "none")
- (parameters
- '("PangoFontFamily***" "families")
- '("int*" "n_families")
- )
-)
-
-(define-virtual load_fontset
- (of-object "PangoFontMap")
- (return-type "PangoFontset*")
- (parameters
- '("PangoContext*" "context")
- '("const-PangoFontDescription*" "desc")
- '("PangoLanguage*" "language")
- )
-)
-
-
-
-;; From /opt/gtk2/include/pango-1.0/pango/pango-fontset.h
-
-(define-function fontset_get_type
- (c-name "pango_fontset_get_type")
- (return-type "GType")
-)
-
-(define-method get_font
- (of-object "PangoFontset")
- (c-name "pango_fontset_get_font")
- (return-type "PangoFont*")
- (parameters
- '("guint" "wc")
- )
-)
-
-(define-method get_metrics
- (of-object "PangoFontset")
- (c-name "pango_fontset_get_metrics")
- (return-type "PangoFontMetrics*")
-)
-
-(define-method foreach
- (of-object "PangoFontset")
- (c-name "pango_fontset_foreach")
- (return-type "none")
- (parameters
- '("PangoFontsetForeachFunc" "func")
- '("gpointer" "data")
- )
-)
-
-(define-function fontset_simple_get_type
- (c-name "pango_fontset_simple_get_type")
- (return-type "GType")
-)
-
-(define-function pango_fontset_simple_new
- (c-name "pango_fontset_simple_new")
- (is-constructor-of "PangoFontsetSimple")
- (return-type "PangoFontsetSimple*")
- (parameters
- '("PangoLanguage*" "language")
- )
-)
-
-(define-method append
- (of-object "PangoFontsetSimple")
- (c-name "pango_fontset_simple_append")
- (return-type "none")
- (parameters
- '("PangoFont*" "font")
- )
-)
-
-(define-method size
- (of-object "PangoFontsetSimple")
- (c-name "pango_fontset_simple_size")
- (return-type "int")
-)
-
-(define-virtual get_font
- (of-object "PangoFontset")
- (return-type "PangoFont*")
- (parameters
- '("guint" "wc")
- )
-)
-
-(define-virtual get_metrics
- (of-object "PangoFontset")
- (return-type "PangoFontMetrics*")
-)
-
-(define-virtual get_language
- (of-object "PangoFontset")
- (return-type "PangoLanguage*")
-)
-
-(define-virtual foreach
- (of-object "PangoFontset")
- (return-type "none")
- (parameters
- '("PangoFontsetForeachFunc" "func")
- '("gpointer" "data")
- )
-)
-
-
-
-;; From pango-glyph-item.h
-
-(define-method split
- (of-object "PangoGlyphItem")
- (c-name "pango_glyph_item_split")
- (return-type "PangoGlyphItem*")
- (parameters
- '("const-char*" "text")
- '("int" "split_index")
- )
-)
-
-(define-method free
- (of-object "PangoGlyphItem")
- (c-name "pango_glyph_item_free")
- (return-type "none")
-)
-
-(define-method apply_attrs
- (of-object "PangoGlyphItem")
- (c-name "pango_glyph_item_apply_attrs")
- (return-type "GSList*")
- (parameters
- '("const-char*" "text")
- '("PangoAttrList*" "list")
- )
-)
-
-(define-method letter_space
- (of-object "PangoGlyphItem")
- (c-name "pango_glyph_item_letter_space")
- (return-type "none")
- (parameters
- '("const-char*" "text")
- '("PangoLogAttr*" "log_attrs")
- '("int" "letter_spacing")
- )
-)
-
-
-
-;; From /opt/gtk2/include/pango-1.0/pango/pango-glyph.h
-
-(define-function pango_glyph_string_new
- (c-name "pango_glyph_string_new")
- (is-constructor-of "PangoGlyphString")
- (return-type "PangoGlyphString*")
-)
-
-(define-method set_size
- (of-object "PangoGlyphString")
- (c-name "pango_glyph_string_set_size")
- (return-type "none")
- (parameters
- '("gint" "new_len")
- )
-)
-
-(define-function pango_glyph_string_get_type
- (c-name "pango_glyph_string_get_type")
- (return-type "GType")
-)
-
-(define-method copy
- (of-object "PangoGlyphString")
- (c-name "pango_glyph_string_copy")
- (return-type "PangoGlyphString*")
-)
-
-(define-method free
- (of-object "PangoGlyphString")
- (c-name "pango_glyph_string_free")
- (return-type "none")
-)
-
-(define-method extents
- (of-object "PangoGlyphString")
- (c-name "pango_glyph_string_extents")
- (return-type "none")
- (parameters
- '("PangoFont*" "font")
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-method extents_range
- (of-object "PangoGlyphString")
- (c-name "pango_glyph_string_extents_range")
- (return-type "none")
- (parameters
- '("int" "start")
- '("int" "end")
- '("PangoFont*" "font")
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-method get_logical_widths
- (of-object "PangoGlyphString")
- (c-name "pango_glyph_string_get_logical_widths")
- (return-type "none")
- (parameters
- '("const-char*" "text")
- '("int" "length")
- '("int" "embedding_level")
- '("int*" "logical_widths")
- )
-)
-
-(define-method index_to_x
- (of-object "PangoGlyphString")
- (c-name "pango_glyph_string_index_to_x")
- (return-type "none")
- (parameters
- '("char*" "text")
- '("int" "length")
- '("PangoAnalysis*" "analysis")
- '("int" "index")
- '("gboolean" "trailing")
- '("int*" "x_pos")
- )
-)
-
-(define-method x_to_index
- (of-object "PangoGlyphString")
- (c-name "pango_glyph_string_x_to_index")
- (return-type "none")
- (parameters
- '("char*" "text")
- '("int" "length")
- '("PangoAnalysis*" "analysis")
- '("int" "x_pos")
- '("int*" "index")
- '("int*" "trailing")
- )
-)
-
-(define-function shape
- (c-name "pango_shape")
- (return-type "none")
- (parameters
- '("const-gchar*" "text")
- '("gint" "length")
- '("PangoAnalysis*" "analysis")
- '("PangoGlyphString*" "glyphs")
- )
-)
-
-(define-function reorder_items
- (c-name "pango_reorder_items")
- (return-type "GList*")
- (parameters
- '("GList*" "logical_items")
- )
-)
-
-
-
-;; From pango-item.h
-
-(define-function item_get_type
- (c-name "pango_item_get_type")
- (return-type "GType")
-)
-
-(define-function item_new
- (c-name "pango_item_new")
- (is-constructor-of "PangoItem")
- (return-type "PangoItem*")
-)
-
-(define-method copy
- (of-object "PangoItem")
- (c-name "pango_item_copy")
- (return-type "PangoItem*")
-)
-
-(define-method free
- (of-object "PangoItem")
- (c-name "pango_item_free")
- (return-type "none")
-)
-
-(define-method split
- (of-object "PangoItem")
- (c-name "pango_item_split")
- (return-type "PangoItem*")
- (parameters
- '("int" "split_index")
- '("int" "split_offset")
- )
-)
-
-
-
-;; From /opt/gtk2/include/pango-1.0/pango/pango-layout.h
-
-(define-function pango_layout_get_type
- (c-name "pango_layout_get_type")
- (return-type "GType")
-)
-
-(define-function pango_layout_new
- (c-name "pango_layout_new")
- (is-constructor-of "PangoLayout")
- (return-type "PangoLayout*")
- (parameters
- '("PangoContext*" "context")
- )
-)
-
-(define-method copy
- (of-object "PangoLayout")
- (c-name "pango_layout_copy")
- (return-type "PangoLayout*")
-)
-
-(define-method get_context
- (of-object "PangoLayout")
- (c-name "pango_layout_get_context")
- (return-type "PangoContext*")
-)
-
-(define-method set_attributes
- (of-object "PangoLayout")
- (c-name "pango_layout_set_attributes")
- (return-type "none")
- (parameters
- '("PangoAttrList*" "attrs")
- )
-)
-
-(define-method get_attributes
- (of-object "PangoLayout")
- (c-name "pango_layout_get_attributes")
- (return-type "PangoAttrList*")
-)
-
-(define-method set_text
- (of-object "PangoLayout")
- (c-name "pango_layout_set_text")
- (return-type "none")
- (parameters
- '("const-char*" "text")
- '("int" "length")
- )
-)
-
-(define-method get_text
- (of-object "PangoLayout")
- (c-name "pango_layout_get_text")
- (return-type "const-char*")
-)
-
-(define-method set_markup
- (of-object "PangoLayout")
- (c-name "pango_layout_set_markup")
- (return-type "none")
- (parameters
- '("const-char*" "markup")
- '("int" "length")
- )
-)
-
-(define-method set_markup_with_accel
- (of-object "PangoLayout")
- (c-name "pango_layout_set_markup_with_accel")
- (return-type "none")
- (parameters
- '("const-char*" "markup")
- '("int" "length")
- '("gunichar" "accel_marker")
- '("gunichar*" "accel_char")
- )
-)
-
-(define-method set_font_description
- (of-object "PangoLayout")
- (c-name "pango_layout_set_font_description")
- (return-type "none")
- (parameters
- '("const-PangoFontDescription*" "desc" (null-ok))
- )
-)
-
-(define-method get_font_description
- (of-object "PangoLayout")
- (c-name "pango_layout_get_font_description")
- (return-type "const-PangoFontDescription*")
-)
-
-(define-method set_width
- (of-object "PangoLayout")
- (c-name "pango_layout_set_width")
- (return-type "none")
- (parameters
- '("int" "width")
- )
-)
-
-(define-method get_width
- (of-object "PangoLayout")
- (c-name "pango_layout_get_width")
- (return-type "int")
-)
-
-(define-method set_wrap
- (of-object "PangoLayout")
- (c-name "pango_layout_set_wrap")
- (return-type "none")
- (parameters
- '("PangoWrapMode" "wrap")
- )
-)
-
-(define-method get_wrap
- (of-object "PangoLayout")
- (c-name "pango_layout_get_wrap")
- (return-type "PangoWrapMode")
-)
-
-(define-method set_indent
- (of-object "PangoLayout")
- (c-name "pango_layout_set_indent")
- (return-type "none")
- (parameters
- '("int" "indent")
- )
-)
-
-(define-method get_indent
- (of-object "PangoLayout")
- (c-name "pango_layout_get_indent")
- (return-type "int")
-)
-
-(define-method set_spacing
- (of-object "PangoLayout")
- (c-name "pango_layout_set_spacing")
- (return-type "none")
- (parameters
- '("int" "spacing")
- )
-)
-
-(define-method get_spacing
- (of-object "PangoLayout")
- (c-name "pango_layout_get_spacing")
- (return-type "int")
-)
-
-(define-method set_justify
- (of-object "PangoLayout")
- (c-name "pango_layout_set_justify")
- (return-type "none")
- (parameters
- '("gboolean" "justify")
- )
-)
-
-(define-method get_justify
- (of-object "PangoLayout")
- (c-name "pango_layout_get_justify")
- (return-type "gboolean")
-)
-
-(define-method set_auto_dir
- (of-object "PangoLayout")
- (c-name "pango_layout_set_auto_dir")
- (return-type "none")
- (parameters
- '("gboolean" "auto_dir")
- )
-)
-
-(define-method get_auto_dir
- (of-object "PangoLayout")
- (c-name "pango_layout_get_auto_dir")
- (return-type "gboolean")
-)
-
-(define-method set_alignment
- (of-object "PangoLayout")
- (c-name "pango_layout_set_alignment")
- (return-type "none")
- (parameters
- '("PangoAlignment" "alignment")
- )
-)
-
-(define-method get_alignment
- (of-object "PangoLayout")
- (c-name "pango_layout_get_alignment")
- (return-type "PangoAlignment")
-)
-
-(define-method set_tabs
- (of-object "PangoLayout")
- (c-name "pango_layout_set_tabs")
- (return-type "none")
- (parameters
- '("PangoTabArray*" "tabs" (null-ok))
- )
-)
-
-(define-method get_tabs
- (of-object "PangoLayout")
- (c-name "pango_layout_get_tabs")
- (return-type "PangoTabArray*")
-)
-
-(define-method set_single_paragraph_mode
- (of-object "PangoLayout")
- (c-name "pango_layout_set_single_paragraph_mode")
- (return-type "none")
- (parameters
- '("gboolean" "setting")
- )
-)
-
-(define-method get_single_paragraph_mode
- (of-object "PangoLayout")
- (c-name "pango_layout_get_single_paragraph_mode")
- (return-type "gboolean")
-)
-
-(define-method set_ellipsize
- (of-object "PangoLayout")
- (c-name "pango_layout_set_ellipsize")
- (return-type "none")
- (parameters
- '("PangoEllipsizeMode" "ellipsize")
- )
-)
-
-(define-method get_ellipsize
- (of-object "PangoLayout")
- (c-name "pango_layout_get_ellipsize")
- (return-type "PangoEllipsizeMode")
-)
-
-(define-method context_changed
- (of-object "PangoLayout")
- (c-name "pango_layout_context_changed")
- (return-type "none")
-)
-
-(define-method get_log_attrs
- (of-object "PangoLayout")
- (c-name "pango_layout_get_log_attrs")
- (return-type "none")
- (parameters
- '("PangoLogAttr**" "attrs")
- '("gint*" "n_attrs")
- )
-)
-
-(define-method index_to_pos
- (of-object "PangoLayout")
- (c-name "pango_layout_index_to_pos")
- (return-type "none")
- (parameters
- '("int" "index")
- '("PangoRectangle*" "pos")
- )
-)
-
-(define-method get_cursor_pos
- (of-object "PangoLayout")
- (c-name "pango_layout_get_cursor_pos")
- (return-type "none")
- (parameters
- '("int" "index")
- '("PangoRectangle*" "strong_pos")
- '("PangoRectangle*" "weak_pos")
- )
-)
-
-(define-method move_cursor_visually
- (of-object "PangoLayout")
- (c-name "pango_layout_move_cursor_visually")
- (return-type "none")
- (parameters
- '("gboolean" "strong")
- '("int" "old_index")
- '("int" "old_trailing")
- '("int" "direction")
- '("int*" "new_index")
- '("int*" "new_trailing")
- )
-)
-
-(define-method xy_to_index
- (of-object "PangoLayout")
- (c-name "pango_layout_xy_to_index")
- (return-type "gboolean")
- (parameters
- '("int" "x")
- '("int" "y")
- '("int*" "index")
- '("int*" "trailing")
- )
-)
-
-(define-method get_extents
- (of-object "PangoLayout")
- (c-name "pango_layout_get_extents")
- (return-type "none")
- (parameters
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-method get_pixel_extents
- (of-object "PangoLayout")
- (c-name "pango_layout_get_pixel_extents")
- (return-type "none")
- (parameters
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-method get_size
- (of-object "PangoLayout")
- (c-name "pango_layout_get_size")
- (return-type "none")
- (parameters
- '("int*" "width")
- '("int*" "height")
- )
-)
-
-(define-method get_pixel_size
- (of-object "PangoLayout")
- (c-name "pango_layout_get_pixel_size")
- (return-type "none")
- (parameters
- '("int*" "width")
- '("int*" "height")
- )
-)
-
-(define-method get_line_count
- (of-object "PangoLayout")
- (c-name "pango_layout_get_line_count")
- (return-type "int")
-)
-
-(define-method get_line
- (of-object "PangoLayout")
- (c-name "pango_layout_get_line")
- (return-type "PangoLayoutLine*")
- (parameters
- '("int" "line")
- )
-)
-
-(define-method get_lines
- (of-object "PangoLayout")
- (c-name "pango_layout_get_lines")
- (return-type "GSList*")
-)
-
-(define-function layout_line_get_type
- (c-name "pango_layout_line_get_type")
- (return-type "GType")
-)
-
-(define-method ref
- (of-object "PangoLayoutLine")
- (c-name "pango_layout_line_ref")
- (return-type "PangoLayoutLine*")
-)
-
-(define-method unref
- (of-object "PangoLayoutLine")
- (c-name "pango_layout_line_unref")
- (return-type "none")
-)
-
-(define-method x_to_index
- (of-object "PangoLayoutLine")
- (c-name "pango_layout_line_x_to_index")
- (return-type "gboolean")
- (parameters
- '("int" "x_pos")
- '("int*" "index")
- '("int*" "trailing")
- )
-)
-
-(define-method index_to_x
- (of-object "PangoLayoutLine")
- (c-name "pango_layout_line_index_to_x")
- (return-type "none")
- (parameters
- '("int" "index")
- '("gboolean" "trailing")
- '("int*" "x_pos")
- )
-)
-
-(define-method get_x_ranges
- (of-object "PangoLayoutLine")
- (c-name "pango_layout_line_get_x_ranges")
- (return-type "none")
- (parameters
- '("int" "start_index")
- '("int" "end_index")
- '("int**" "ranges")
- '("int*" "n_ranges")
- )
-)
-
-(define-method get_extents
- (of-object "PangoLayoutLine")
- (c-name "pango_layout_line_get_extents")
- (return-type "none")
- (parameters
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-method get_pixel_extents
- (of-object "PangoLayoutLine")
- (c-name "pango_layout_line_get_pixel_extents")
- (return-type "none")
- (parameters
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-function pango_layout_iter_get_type
- (c-name "pango_layout_iter_get_type")
- (return-type "GType")
-)
-
-(define-method get_iter
- (of-object "PangoLayout")
- (c-name "pango_layout_get_iter")
- (return-type "PangoLayoutIter*")
-)
-
-(define-method free
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_free")
- (return-type "none")
-)
-
-(define-method get_index
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_get_index")
- (return-type "int")
-)
-
-(define-method get_run
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_get_run")
- (return-type "PangoLayoutRun*")
-)
-
-(define-method get_line
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_get_line")
- (return-type "PangoLayoutLine*")
-)
-
-(define-method at_last_line
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_at_last_line")
- (return-type "gboolean")
-)
-
-(define-method next_char
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_next_char")
- (return-type "gboolean")
-)
-
-(define-method next_cluster
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_next_cluster")
- (return-type "gboolean")
-)
-
-(define-method next_run
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_next_run")
- (return-type "gboolean")
-)
-
-(define-method next_line
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_next_line")
- (return-type "gboolean")
-)
-
-(define-method get_char_extents
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_get_char_extents")
- (return-type "none")
- (parameters
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-method get_cluster_extents
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_get_cluster_extents")
- (return-type "none")
- (parameters
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-method get_run_extents
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_get_run_extents")
- (return-type "none")
- (parameters
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-method get_line_extents
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_get_line_extents")
- (return-type "none")
- (parameters
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-method get_line_yrange
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_get_line_yrange")
- (return-type "none")
- (parameters
- '("int*" "y0")
- '("int*" "y1")
- )
-)
-
-(define-method get_layout_extents
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_get_layout_extents")
- (return-type "none")
- (parameters
- '("PangoRectangle*" "ink_rect")
- '("PangoRectangle*" "logical_rect")
- )
-)
-
-(define-method get_baseline
- (of-object "PangoLayoutIter")
- (c-name "pango_layout_iter_get_baseline")
- (return-type "int")
-)
-
-
-
-;; From pango-modules.h
-
-(ifdef PANGO_ENABLE_BACKEND
-
-(define-function find_map
- (c-name "pango_find_map")
- (return-type "PangoMap*")
- (parameters
- '("PangoLanguage*" "language")
- '("guint" "engine_type_id")
- '("guint" "render_type_id")
- )
-)
-
-(define-method get_engine
- (of-object "PangoMap")
- (c-name "pango_map_get_engine")
- (return-type "PangoEngine*")
- (parameters
- '("PangoScript" "script")
- )
-)
-
-(define-method get_engines
- (of-object "PangoMap")
- (c-name "pango_map_get_engines")
- (return-type "none")
- (parameters
- '("PangoScript" "script")
- '("GSList**" "exact_engines")
- '("GSList**" "fallback_engines")
- )
-)
-
-(define-function module_register
- (c-name "pango_module_register")
- (return-type "none")
- (parameters
- '("PangoIncludedModule*" "module")
- )
-)
-) ;; PANGO_ENABLE_BACKEND
-
-
-;; From /home/jdahlin/dev/gtk-2.8/pango/pango/pango-renderer.h
-
-(define-function pango_renderer_get_type
- (c-name "pango_renderer_get_type")
- (return-type "GType")
-)
-
-(define-method draw_layout
- (of-object "PangoRenderer")
- (c-name "pango_renderer_draw_layout")
- (return-type "none")
- (parameters
- '("PangoLayout*" "layout")
- '("int" "x")
- '("int" "y")
- )
-)
-
-(define-method draw_layout_line
- (of-object "PangoRenderer")
- (c-name "pango_renderer_draw_layout_line")
- (return-type "none")
- (parameters
- '("PangoLayoutLine*" "line")
- '("int" "x")
- '("int" "y")
- )
-)
-
-(define-method draw_glyphs
- (of-object "PangoRenderer")
- (c-name "pango_renderer_draw_glyphs")
- (return-type "none")
- (parameters
- '("PangoFont*" "font")
- '("PangoGlyphString*" "glyphs")
- '("int" "x")
- '("int" "y")
- )
-)
-
-(define-method draw_rectangle
- (of-object "PangoRenderer")
- (c-name "pango_renderer_draw_rectangle")
- (return-type "none")
- (parameters
- '("PangoRenderPart" "part")
- '("int" "x")
- '("int" "y")
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-method draw_error_underline
- (of-object "PangoRenderer")
- (c-name "pango_renderer_draw_error_underline")
- (return-type "none")
- (parameters
- '("int" "x")
- '("int" "y")
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-method draw_trapezoid
- (of-object "PangoRenderer")
- (c-name "pango_renderer_draw_trapezoid")
- (return-type "none")
- (parameters
- '("PangoRenderPart" "part")
- '("double" "y1_")
- '("double" "x11")
- '("double" "x21")
- '("double" "y2")
- '("double" "x12")
- '("double" "x22")
- )
-)
-
-(define-method draw_glyph
- (of-object "PangoRenderer")
- (c-name "pango_renderer_draw_glyph")
- (return-type "none")
- (parameters
- '("PangoFont*" "font")
- '("PangoGlyph" "glyph")
- '("double" "x")
- '("double" "y")
- )
-)
-
-(define-method activate
- (of-object "PangoRenderer")
- (c-name "pango_renderer_activate")
- (return-type "none")
-)
-
-(define-method deactivate
- (of-object "PangoRenderer")
- (c-name "pango_renderer_deactivate")
- (return-type "none")
-)
-
-(define-method part_changed
- (of-object "PangoRenderer")
- (c-name "pango_renderer_part_changed")
- (return-type "none")
- (parameters
- '("PangoRenderPart" "part")
- )
-)
-
-(define-method set_color
- (of-object "PangoRenderer")
- (c-name "pango_renderer_set_color")
- (return-type "none")
- (parameters
- '("PangoRenderPart" "part")
- '("const-PangoColor*" "color")
- )
-)
-
-(define-method get_color
- (of-object "PangoRenderer")
- (c-name "pango_renderer_get_color")
- (return-type "PangoColor*")
- (parameters
- '("PangoRenderPart" "part")
- )
-)
-
-(define-method set_matrix
- (of-object "PangoRenderer")
- (c-name "pango_renderer_set_matrix")
- (return-type "none")
- (parameters
- '("const-PangoMatrix*" "matrix")
- )
-)
-
-(define-method get_matrix
- (of-object "PangoRenderer")
- (c-name "pango_renderer_get_matrix")
- (return-type "const-PangoMatrix*")
-)
-
-(define-virtual draw_glyphs
- (of-object "PangoRenderer")
- (return-type "none")
- (parameters
- '("PangoFont*" "font")
- '("PangoGlyphString*" "glyphs")
- '("int" "x")
- '("int" "y")
- )
-)
-
-(define-virtual draw_rectangle
- (of-object "PangoRenderer")
- (return-type "none")
- (parameters
- '("PangoRenderPart" "part")
- '("int" "x")
- '("int" "y")
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-virtual draw_error_underline
- (of-object "PangoRenderer")
- (return-type "none")
- (parameters
- '("int" "x")
- '("int" "y")
- '("int" "width")
- '("int" "height")
- )
-)
-
-(define-virtual draw_shape
- (of-object "PangoRenderer")
- (return-type "none")
- (parameters
- '("PangoAttrShape*" "attr")
- '("int" "x")
- '("int" "y")
- )
-)
-
-(define-virtual draw_trapezoid
- (of-object "PangoRenderer")
- (return-type "none")
- (parameters
- '("PangoRenderPart" "part")
- '("double" "y1_")
- '("double" "x11")
- '("double" "x21")
- '("double" "y2")
- '("double" "x12")
- '("double" "x22")
- )
-)
-
-(define-virtual draw_glyph
- (of-object "PangoRenderer")
- (return-type "none")
- (parameters
- '("PangoFont*" "font")
- '("PangoGlyph" "glyph")
- '("double" "x")
- '("double" "y")
- )
-)
-
-(define-virtual part_changed
- (of-object "PangoRenderer")
- (return-type "none")
- (parameters
- '("PangoRenderPart" "part")
- )
-)
-
-(define-virtual begin
- (of-object "PangoRenderer")
- (return-type "none")
-)
-
-(define-virtual end
- (of-object "PangoRenderer")
- (return-type "none")
-)
-
-(define-virtual prepare_run
- (of-object "PangoRenderer")
- (return-type "none")
- (parameters
- '("PangoLayoutRun*" "run")
- )
-)
-
-;; From pango-script.h
-
-(define-function script_for_unichar
- (c-name "pango_script_for_unichar")
- (return-type "PangoScript")
- (parameters
- '("gunichar" "ch")
- )
-)
-
-(define-function script_iter_new
- (c-name "pango_script_iter_new")
- (is-constructor-of "PangoScriptIter")
- (return-type "PangoScriptIter*")
- (parameters
- '("const-char*" "text")
- '("int" "length")
- )
-)
-
-(define-method get_range
- (of-object "PangoScriptIter")
- (c-name "pango_script_iter_get_range")
- (return-type "none")
- (parameters
- '("const-char**" "start")
- '("const-char**" "end")
- '("PangoScript*" "script")
- )
-)
-
-(define-method next
- (of-object "PangoScriptIter")
- (c-name "pango_script_iter_next")
- (return-type "gboolean")
-)
-
-(define-method free
- (of-object "PangoScriptIter")
- (c-name "pango_script_iter_free")
- (return-type "none")
-)
-
-(define-function get_sample_language
- (c-name "pango_script_get_sample_language")
- (return-type "PangoLanguage*")
- (parameters
- '("PangoScript" "script")
- )
-)
-
-(define-method includes_script
- (of-object "PangoLanguage")
- (c-name "pango_language_includes_script")
- (return-type "gboolean")
- (parameters
- '("PangoScript" "script")
- )
-)
-
-
-
-;; From /opt/gtk2/include/pango-1.0/pango/pango-tabs.h
-
-(define-function pango_tab_array_new
- (c-name "pango_tab_array_new")
- (is-constructor-of "PangoTabArray")
- (return-type "PangoTabArray*")
- (parameters
- '("gint" "initial_size")
- '("gboolean" "positions_in_pixels")
- )
-)
-
-(define-function pango_tab_array_new_with_positions
- (c-name "pango_tab_array_new_with_positions")
- (is-constructor-of "PangoTabArray")
- (return-type "PangoTabArray*")
- (parameters
- '("gint" "size")
- '("gboolean" "positions_in_pixels")
- '("PangoTabAlign" "first_alignment")
- '("gint" "first_position")
- )
- (varargs #t)
-)
-
-(define-function pango_tab_array_get_type
- (c-name "pango_tab_array_get_type")
- (return-type "GType")
-)
-
-(define-method copy
- (of-object "PangoTabArray")
- (c-name "pango_tab_array_copy")
- (return-type "PangoTabArray*")
-)
-
-(define-method free
- (of-object "PangoTabArray")
- (c-name "pango_tab_array_free")
- (return-type "none")
-)
-
-(define-method get_size
- (of-object "PangoTabArray")
- (c-name "pango_tab_array_get_size")
- (return-type "gint")
-)
-
-(define-method resize
- (of-object "PangoTabArray")
- (c-name "pango_tab_array_resize")
- (return-type "none")
- (parameters
- '("gint" "new_size")
- )
-)
-
-(define-method set_tab
- (of-object "PangoTabArray")
- (c-name "pango_tab_array_set_tab")
- (return-type "none")
- (parameters
- '("gint" "tab_index")
- '("PangoTabAlign" "alignment")
- '("gint" "location")
- )
-)
-
-(define-method get_tab
- (of-object "PangoTabArray")
- (c-name "pango_tab_array_get_tab")
- (return-type "none")
- (parameters
- '("gint" "tab_index")
- '("PangoTabAlign*" "alignment")
- '("gint*" "location")
- )
-)
-
-(define-method get_tabs
- (of-object "PangoTabArray")
- (c-name "pango_tab_array_get_tabs")
- (return-type "none")
- (parameters
- '("PangoTabAlign**" "alignments")
- '("gint**" "locations")
- )
-)
-
-(define-method get_positions_in_pixels
- (of-object "PangoTabArray")
- (c-name "pango_tab_array_get_positions_in_pixels")
- (return-type "gboolean")
-)
-
-
-
-;; From /opt/gtk2/include/pango-1.0/pango/pango-types.h
-
-(define-function matrix_get_type
- (c-name "pango_matrix_get_type")
- (return-type "GType")
-)
-
-(define-method copy
- (of-object "PangoMatrix")
- (c-name "pango_matrix_copy")
- (return-type "PangoMatrix*")
-)
-
-(define-method free
- (of-object "PangoMatrix")
- (c-name "pango_matrix_free")
- (return-type "none")
-)
-
-(define-method translate
- (of-object "PangoMatrix")
- (c-name "pango_matrix_translate")
- (return-type "none")
- (parameters
- '("double" "tx")
- '("double" "ty")
- )
-)
-
-(define-method scale
- (of-object "PangoMatrix")
- (c-name "pango_matrix_scale")
- (return-type "none")
- (parameters
- '("double" "scale_x")
- '("double" "scale_y")
- )
-)
-
-(define-method rotate
- (of-object "PangoMatrix")
- (c-name "pango_matrix_rotate")
- (return-type "none")
- (parameters
- '("double" "degrees")
- )
-)
-
-(define-method concat
- (of-object "PangoMatrix")
- (c-name "pango_matrix_concat")
- (return-type "none")
- (parameters
- '("const-PangoMatrix*" "new_matrix")
- )
-)
-
-(define-function language_get_type
- (c-name "pango_language_get_type")
- (return-type "GType")
-)
-
-(define-function pango_language_from_string
- (is-constructor-of "PangoLanguage")
- (c-name "pango_language_from_string")
- (return-type "PangoLanguage*")
- (parameters
- '("const-char*" "language")
- )
-)
-
-(define-function pango_language_from_string
- (c-name "pango_language_from_string1")
- (return-type "PangoLanguage*")
- (parameters
- '("const-char*" "language")
- )
- (deprecated "use pango.Language instead")
-)
-
-(define-function pango_language_matches
- (c-name "pango_language_matches1")
- (return-type "gboolean")
- (parameters
- '("PangoLanguage*" "language" (null-ok))
- '("const-char*" "range_list")
- )
- (deprecated "use pango.Language.matches instead")
-)
-
-(define-method matches
- (of-object "PangoLanguage")
- (c-name "pango_language_matches")
- (return-type "gboolean")
- (parameters
- '("const-char*" "range_list")
- )
-)
-
-(define-method to_string
- (of-object "PangoLanguage")
- (c-name "pango_language_to_string")
- (return-type "const-char*")
-)
-
-(define-function get_mirror_char
- (c-name "pango_get_mirror_char")
- (return-type "gboolean")
- (parameters
- '("gunichar" "ch")
- '("gunichar*" "mirrored_ch")
- )
- (deprecated "deprecated")
-)
-
-(define-function unichar_direction
- (c-name "pango_unichar_direction")
- (return-type "PangoDirection")
- (parameters
- '("gunichar" "ch")
- )
-)
-
-(define-function find_base_dir
- (c-name "pango_find_base_dir")
- (return-type "PangoDirection")
- (parameters
- '("const-gchar*" "text")
- '("gint" "length")
- )
-)
-
-
-;;
-
-(define-function PIXELS
- (c-name "PANGO_PIXELS")
- (return-type "gint")
- (parameters
- '("gint" "size")
- )
- )
-
-(define-function ASCENT
- (c-name "PANGO_ASCENT")
- (return-type "gint")
- (parameters
- '("PangoRectangle" "rect")
- )
- )
-
-(define-function DESCENT
- (c-name "PANGO_DESCENT")
- (return-type "gint")
- (parameters
- '("PangoRectangle" "rect")
- )
- )
-
-(define-function LBEARING
- (c-name "PANGO_LBEARING")
- (return-type "gint")
- (parameters
- '("PangoRectangle" "rect")
- )
- )
-
-(define-function RBEARING
- (c-name "PANGO_RBEARING")
- (return-type "gint")
- (parameters
- '("PangoRectangle" "rect")
- )
- )
-
-
-
-;; From pango-utils.h
-
-(ifdef USE_PANGO_UTILS
-
-(define-function split_file_list
- (c-name "pango_split_file_list")
- (return-type "char**")
- (parameters
- '("const-char*" "str")
- )
-)
-
-(define-function trim_string
- (c-name "pango_trim_string")
- (return-type "char*")
- (parameters
- '("const-char*" "str")
- )
-)
-
-(define-function read_line
- (c-name "pango_read_line")
- (return-type "gint")
- (parameters
- '("FILE*" "stream")
- '("GString*" "str")
- )
-)
-
-(define-function skip_space
- (c-name "pango_skip_space")
- (return-type "gboolean")
- (parameters
- '("const-char**" "pos")
- )
-)
-
-(define-function scan_word
- (c-name "pango_scan_word")
- (return-type "gboolean")
- (parameters
- '("const-char**" "pos")
- '("GString*" "out")
- )
-)
-
-(define-function scan_string
- (c-name "pango_scan_string")
- (return-type "gboolean")
- (parameters
- '("const-char**" "pos")
- '("GString*" "out")
- )
-)
-
-(define-function scan_int
- (c-name "pango_scan_int")
- (return-type "gboolean")
- (parameters
- '("const-char**" "pos")
- '("int*" "out")
- )
-)
-
-(define-function config_key_get
- (c-name "pango_config_key_get")
- (return-type "char*")
- (parameters
- '("const-char*" "key")
- )
-)
-
-(define-function lookup_aliases
- (c-name "pango_lookup_aliases")
- (return-type "none")
- (parameters
- '("const-char*" "fontname")
- '("char***" "families")
- '("int*" "n_families")
- )
-)
-
-(define-function parse_style
- (c-name "pango_parse_style")
- (return-type "gboolean")
- (parameters
- '("const-char*" "str")
- '("PangoStyle*" "style")
- '("gboolean" "warn")
- )
-)
-
-(define-function parse_variant
- (c-name "pango_parse_variant")
- (return-type "gboolean")
- (parameters
- '("const-char*" "str")
- '("PangoVariant*" "variant")
- '("gboolean" "warn")
- )
-)
-
-(define-function parse_weight
- (c-name "pango_parse_weight")
- (return-type "gboolean")
- (parameters
- '("const-char*" "str")
- '("PangoWeight*" "weight")
- '("gboolean" "warn")
- )
-)
-
-(define-function parse_stretch
- (c-name "pango_parse_stretch")
- (return-type "gboolean")
- (parameters
- '("const-char*" "str")
- '("PangoStretch*" "stretch")
- '("gboolean" "warn")
- )
-)
-
-(define-function get_sysconf_subdirectory
- (c-name "pango_get_sysconf_subdirectory")
- (return-type "const-char*")
-)
-
-(define-function get_lib_subdirectory
- (c-name "pango_get_lib_subdirectory")
- (return-type "const-char*")
-)
-
-(define-function log2vis_get_embedding_levels
- (c-name "pango_log2vis_get_embedding_levels")
- (return-type "guint8*")
- (parameters
- '("const-gchar*" "text")
- '("int" "length")
- '("PangoDirection*" "pbase_dir")
- )
-)
-
-(define-method get_sample_string
- (of-object "PangoLanguage")
- (c-name "pango_language_get_sample_string")
- (return-type "const-char*")
-)
-
-(define-function is_zero_width
- (c-name "pango_is_zero_width")
- (return-type "gboolean")
- (parameters
- '("gunichar" "ch")
- )
-)
-) ;; USE_PANGO_UTILS
-
-
-
diff --git a/pango.override b/pango.override
deleted file mode 100644
index 043c3199..00000000
--- a/pango.override
+++ /dev/null
@@ -1,2023 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * pango.override: overrides for the Pango library
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-%%
-headers
-#define NO_IMPORT_PYGOBJECT
-#define PANGO_ENABLE_BACKEND
-#define PANGO_ENABLE_ENGINE
-#include <pygobject.h>
-#include <pango/pango.h>
-
-typedef struct {
- PyObject *func, *data;
-} PyGtkCustomNotify;
-
-#ifndef PANGO_TYPE_LAYOUT_LINE
-# define PANGO_TYPE_LAYOUT_LINE pypango_layout_line_get_type()
-
-static PangoLayoutLine *
-_layout_line_boxed_copy(PangoLayoutLine *line)
-{
- pango_layout_line_ref(line);
- return line;
-}
-
-static GType
-pypango_layout_line_get_type(void)
-{
- static GType our_type = 0;
-
- if (our_type == 0)
- our_type = g_boxed_type_register_static("PangoLayoutLine",
- (GBoxedCopyFunc)_layout_line_boxed_copy,
- (GBoxedFreeFunc)pango_layout_line_unref);
- return our_type;
-}
-#endif /* #ifndef PANGO_TYPE_LAYOUT_LINE */
-
-#ifndef PANGO_TYPE_ITEM
-# define PANGO_TYPE_ITEM (pypango_item_get_type ())
-
-static GType
-pypango_item_get_type (void)
-{
- static GType our_type = 0;
-
- if (our_type == 0)
- our_type = g_boxed_type_register_static ("PangoItem",
- (GBoxedCopyFunc) pango_item_copy,
- (GBoxedFreeFunc) pango_item_free);
- return our_type;
-}
-#endif /* #ifndef PANGO_TYPE_ITEM */
-
-/* ------------- PangoAttribute ------------- */
-
-typedef struct {
- PyObject_HEAD
- PangoAttribute *attr;
-} PyPangoAttribute;
-staticforward PyTypeObject PyPangoAttribute_Type;
-
-static PyObject *
-pypango_attr_new(PangoAttribute *attr, guint start, guint end)
-{
- PyPangoAttribute *self;
-
- self = (PyPangoAttribute *)PyObject_NEW(PyPangoAttribute,
- &PyPangoAttribute_Type);
- if (self == NULL)
- return NULL;
- self->attr = attr;
- attr->start_index = start;
- attr->end_index = end;
-
- return (PyObject *)self;
-}
-
-static void
-pypango_attr_dealloc(PyPangoAttribute *self)
-{
- pango_attribute_destroy(self->attr);
- PyObject_DEL(self);
-}
-
-static int
-pypango_attr_compare(PyPangoAttribute *self, PyPangoAttribute *v)
-{
- if (pango_attribute_equal(self->attr, v->attr))
- return 0;
- if (self->attr > v->attr)
- return -1;
- return 1;
-}
-
-static long
-pypango_attr_hash(PyPangoAttribute *self)
-{
- return (long)self->attr;
-}
-
-static PyObject *
-pypango_attr_copy(PyPangoAttribute *self)
-{
- return pypango_attr_new(pango_attribute_copy(self->attr),
- self->attr->start_index, self->attr->end_index);
-}
-
-static PyMethodDef pypango_attr_methods[] = {
- { "copy", (PyCFunction)pypango_attr_copy, METH_NOARGS },
- { NULL, NULL, 0 }
-};
-
-static PyObject *
-pypango_attr_get_index(PyPangoAttribute *self, void *closure)
-{
- gboolean is_end = GPOINTER_TO_INT(closure) != 0;
-
- if (is_end)
- return PyInt_FromLong(self->attr->end_index);
- else
- return PyInt_FromLong(self->attr->start_index);
-}
-
-static int
-pypango_attr_set_index(PyPangoAttribute *self, PyObject *value, void *closure)
-{
- gboolean is_end = GPOINTER_TO_INT(closure) != 0;
- gint val;
-
- val = PyInt_AsLong(value);
- if (PyErr_Occurred()) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError, "index must be an integer");
- return -1;
- }
- if (is_end)
- self->attr->end_index = val;
- else
- self->attr->start_index = val;
- return 0;
-}
-
-static PyObject *
-pypango_attr_get_type(PyPangoAttribute *self, void *closure)
-{
- return PyInt_FromLong(self->attr->klass->type);
-}
-
-static PyGetSetDef pypango_attr_getsets[] = {
- { "start_index", (getter)pypango_attr_get_index,
- (setter)pypango_attr_set_index, NULL, GINT_TO_POINTER(0) },
- { "end_index", (getter)pypango_attr_get_index,
- (setter)pypango_attr_set_index, NULL, GINT_TO_POINTER(1) },
- { "type", (getter)pypango_attr_get_type, (setter)0, NULL, NULL },
- { NULL, (getter)0, (setter)0, NULL, NULL }
-};
-
-static PyObject *
-pypango_attr_tp_getattr(PyPangoAttribute *self, char *attr)
-{
- PangoAttribute *attribute = self->attr;
- PyObject *name, *ret;
-
- switch (attribute->klass->type) {
- case PANGO_ATTR_LANGUAGE:
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[s]", "value");
- if (!strcmp(attr, "value"))
- return pyg_boxed_new(PANGO_TYPE_LANGUAGE,
- ((PangoAttrLanguage *)attribute)->value,
- TRUE, TRUE);
- break;
- case PANGO_ATTR_FAMILY:
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[s]", "value");
- if (!strcmp(attr, "value"))
- return PyString_FromString(((PangoAttrString *)attribute)->value);
- break;
- case PANGO_ATTR_STYLE:
- case PANGO_ATTR_WEIGHT:
- case PANGO_ATTR_VARIANT:
- case PANGO_ATTR_STRETCH:
- case PANGO_ATTR_SIZE:
- case PANGO_ATTR_UNDERLINE:
- case PANGO_ATTR_STRIKETHROUGH:
- case PANGO_ATTR_RISE:
- case PANGO_ATTR_FALLBACK:
- case PANGO_ATTR_LETTER_SPACING:
- case PANGO_ATTR_ABSOLUTE_SIZE:
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[s]", "value");
- if (!strcmp(attr, "value"))
- return PyInt_FromLong(((PangoAttrInt *)attribute)->value);
- break;
- case PANGO_ATTR_FONT_DESC:
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[s]", "desc");
- if (!strcmp(attr, "desc"))
- return pyg_boxed_new(PANGO_TYPE_FONT_DESCRIPTION,
- ((PangoAttrFontDesc *)attribute)->desc,
- TRUE, TRUE);
- break;
- case PANGO_ATTR_FOREGROUND:
- case PANGO_ATTR_BACKGROUND:
- case PANGO_ATTR_UNDERLINE_COLOR:
- case PANGO_ATTR_STRIKETHROUGH_COLOR:
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[s]", "color");
- if (!strcmp(attr, "color"))
- return pyg_boxed_new(PANGO_TYPE_COLOR,
- &((PangoAttrColor *)attribute)->color,
- TRUE, TRUE);
- break;
- case PANGO_ATTR_SHAPE:
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[ss]", "ink_rect", "logical_rect");
- if (!strcmp(attr, "ink_rect")) {
- PangoRectangle rect = ((PangoAttrShape *)attribute)->ink_rect;
-
- return Py_BuildValue("iiii", rect.x, rect.y,
- rect.width, rect.height);
- }
- if (!strcmp(attr, "logical_rect")) {
- PangoRectangle rect = ((PangoAttrShape *)attribute)->logical_rect;
-
- return Py_BuildValue("iiii", rect.x, rect.y,
- rect.width, rect.height);
- }
- break;
- case PANGO_ATTR_SCALE:
- if (!strcmp(attr, "__members__"))
- return Py_BuildValue("[s]", "value");
- if (!strcmp(attr, "value"))
- return PyFloat_FromDouble(((PangoAttrFloat *)attribute)->value);
- break;
- default:
- break;
- }
-
- name = PyString_FromString(attr);
- ret = PyObject_GenericGetAttr((PyObject *)self, name);
- Py_DECREF(name);
- return ret;
-}
-
-static PyTypeObject PyPangoAttribute_Type = {
- PyObject_HEAD_INIT(NULL)
- 0, /* ob_size */
- "pango.Attribute", /* tp_name */
- sizeof(PyPangoAttribute), /* tp_basicsize */
- 0, /* tp_itemsize */
- /* methods */
- (destructor)pypango_attr_dealloc, /* tp_dealloc */
- (printfunc)0, /* tp_print */
- (getattrfunc)pypango_attr_tp_getattr, /* tp_getattr */
- (setattrfunc)0, /* tp_setattr */
- (cmpfunc)pypango_attr_compare, /* tp_compare */
- (reprfunc)0, /* tp_repr */
- 0, /* tp_as_number */
- 0, /* tp_as_sequence */
- 0, /* tp_as_mapping */
- (hashfunc)pypango_attr_hash, /* tp_hash */
- (ternaryfunc)0, /* tp_call */
- (reprfunc)0, /* tp_str */
- (getattrofunc)0, /* tp_getattro */
- (setattrofunc)0, /* tp_setattro */
- 0, /* tp_as_buffer */
- Py_TPFLAGS_DEFAULT, /* tp_flags */
- NULL, /* Documentation string */
- (traverseproc)0, /* tp_traverse */
- (inquiry)0, /* tp_clear */
- (richcmpfunc)0, /* tp_richcompare */
- 0, /* tp_weaklistoffset */
- (getiterfunc)0, /* tp_iter */
- (iternextfunc)0, /* tp_iternext */
- pypango_attr_methods, /* tp_methods */
- 0, /* tp_members */
- pypango_attr_getsets, /* tp_getset */
- (PyTypeObject *)0, /* tp_base */
- (PyObject *)0, /* tp_dict */
- 0, /* tp_descr_get */
- 0, /* tp_descr_set */
- 0, /* tp_dictoffset */
- (initproc)0, /* tp_init */
- (allocfunc)0, /* tp_alloc */
- (newfunc)0, /* tp_new */
- 0, /* tp_free */
- (inquiry)0, /* tp_is_gc */
- (PyObject *)0, /* tp_bases */
-};
-
-/* ------------- PangoAttrIterator ------------- */
-
-typedef struct {
- PyObject_HEAD
- PangoAttrIterator *iter;
-} PyPangoAttrIterator;
-staticforward PyTypeObject PyPangoAttrIterator_Type;
-
-static PyObject *
-pypango_attr_iterator_new(PangoAttrIterator *iter)
-{
- PyPangoAttrIterator *self;
-
- self = (PyPangoAttrIterator *)PyObject_NEW(PyPangoAttrIterator,
- &PyPangoAttrIterator_Type);
- if (self == NULL)
- return NULL;
- self->iter = iter;
-
- return (PyObject *)self;
-}
-
-static void
-pypango_attr_iterator_dealloc(PyPangoAttrIterator *self)
-{
- pango_attr_iterator_destroy(self->iter);
- PyObject_DEL(self);
-}
-
-static int
-pypango_attr_iterator_compare(PyPangoAttrIterator *self,
- PyPangoAttrIterator *v)
-{
- if (self->iter == v->iter)
- return 0;
- if (self->iter > v->iter)
- return -1;
- return 1;
-}
-
-static long
-pypango_attr_iterator_hash(PyPangoAttrIterator *self)
-{
- return (long)self->iter;
-}
-
-static PyObject *
-pypango_attr_iterator_copy(PyPangoAttrIterator *self)
-{
- return pypango_attr_iterator_new(pango_attr_iterator_copy(self->iter));
-}
-
-static PyObject *
-pypango_attr_iterator_range(PyPangoAttrIterator *self)
-{
- gint start, end;
-
- pango_attr_iterator_range(self->iter, &start, &end);
- return Py_BuildValue("ii", start, end);
-}
-
-static PyObject *
-pypango_attr_iterator_next(PyPangoAttrIterator *self)
-{
- return PyBool_FromLong(pango_attr_iterator_next(self->iter));
-}
-
-static PyObject *
-pypango_attr_iterator_get(PyPangoAttrIterator *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "type", NULL };
- PyObject *py_type;
- PangoAttrType type;
- PangoAttribute *attr;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:pango.AttrIterator.get",
- kwlist, &py_type))
- return NULL;
-
- if (pyg_enum_get_value(PANGO_TYPE_ATTR_TYPE, py_type, (gint*)&type))
- return NULL;
-
- if (!(attr = pango_attr_iterator_get(self->iter, type))) {
- Py_INCREF(Py_None);
- return Py_None;
- }
-
- return pypango_attr_new(attr, attr->start_index, attr->end_index);
-}
-
-static PyObject *
-pypango_attr_iterator_get_font(PyPangoAttrIterator *self)
-{
- PangoFontDescription *desc;
- PangoLanguage *language;
- GSList *extra_attrs, *tmp;
- PyObject *py_desc, *py_language, *py_extra_attrs;
-
- if (!(desc = pango_font_description_new())) {
- PyErr_SetString(PyExc_RuntimeError, "can't get font info");
- return NULL;
- }
- pango_attr_iterator_get_font(self->iter, desc, &language, &extra_attrs);
- py_desc = pyg_boxed_new(PANGO_TYPE_FONT_DESCRIPTION, desc, TRUE, TRUE);
- py_language = pyg_boxed_new(PANGO_TYPE_LANGUAGE, language, TRUE, TRUE);
-
- py_extra_attrs = PyList_New(0);
- for (tmp = extra_attrs; tmp != NULL; tmp = tmp->next) {
- PangoAttribute *attr = (PangoAttribute *)tmp->data;
- PyObject *py_attr = pypango_attr_new(attr, attr->start_index,
- attr->end_index);
- PyList_Append(py_extra_attrs, py_attr);
- Py_DECREF(py_attr);
- }
- g_slist_free(extra_attrs);
-
- return Py_BuildValue("NNN", py_desc, py_language, py_extra_attrs);
-}
-
-static PyObject *
-pypango_attr_iterator_get_attrs(PyPangoAttrIterator *self)
-{
- GSList *alist;
- PyObject *py_list;
- guint i, len;
-
- alist = pango_attr_iterator_get_attrs(self->iter);
-
- len = g_slist_length(alist);
- py_list = PyTuple_New(len);
- for (i = 0; i < len; i++) {
- PangoAttribute *attr = (PangoAttribute *)g_slist_nth_data(alist, i);
-
- PyTuple_SetItem(py_list, i, pypango_attr_new(attr, attr->start_index,
- attr->end_index));
- }
- /* don't have to destroy attributes since we use them */
- g_slist_free(alist);
- return py_list;
-}
-
-static PyMethodDef pypango_attr_iterator_methods[] = {
- { "copy", (PyCFunction)pypango_attr_iterator_copy, METH_NOARGS },
- { "range", (PyCFunction)pypango_attr_iterator_range, METH_NOARGS },
- { "next", (PyCFunction)pypango_attr_iterator_next, METH_NOARGS },
- { "get", (PyCFunction)pypango_attr_iterator_get, METH_VARARGS|METH_KEYWORDS },
- { "get_font", (PyCFunction)pypango_attr_iterator_get_font, METH_NOARGS },
- { "get_attrs", (PyCFunction)pypango_attr_iterator_get_attrs, METH_NOARGS },
- { NULL, NULL, 0 }
-};
-
-static PyTypeObject PyPangoAttrIterator_Type = {
- PyObject_HEAD_INIT(NULL)
- 0, /* ob_size */
- "pango.AttrIterator", /* tp_name */
- sizeof(PyPangoAttrIterator), /* tp_basicsize */
- 0, /* tp_itemsize */
- /* methods */
- (destructor)pypango_attr_iterator_dealloc, /* tp_dealloc */
- (printfunc)0, /* tp_print */
- (getattrfunc)0, /* tp_getattr */
- (setattrfunc)0, /* tp_setattr */
- (cmpfunc)pypango_attr_iterator_compare, /* tp_compare */
- (reprfunc)0, /* tp_repr */
- 0, /* tp_as_number */
- 0, /* tp_as_sequence */
- 0, /* tp_as_mapping */
- (hashfunc)pypango_attr_iterator_hash, /* tp_hash */
- (ternaryfunc)0, /* tp_call */
- (reprfunc)0, /* tp_str */
- (getattrofunc)0, /* tp_getattro */
- (setattrofunc)0, /* tp_setattro */
- 0, /* tp_as_buffer */
- Py_TPFLAGS_DEFAULT, /* tp_flags */
- NULL, /* Documentation string */
- (traverseproc)0, /* tp_traverse */
- (inquiry)0, /* tp_clear */
- (richcmpfunc)0, /* tp_richcompare */
- 0, /* tp_weaklistoffset */
- (getiterfunc)0, /* tp_iter */
- (iternextfunc)0, /* tp_iternext */
- pypango_attr_iterator_methods, /* tp_methods */
- 0, /* tp_members */
- 0, /* tp_getset */
- (PyTypeObject *)0, /* tp_base */
- (PyObject *)0, /* tp_dict */
- 0, /* tp_descr_get */
- 0, /* tp_descr_set */
- 0, /* tp_dictoffset */
- (initproc)0, /* tp_init */
- (allocfunc)0, /* tp_alloc */
- (newfunc)0, /* tp_new */
- 0, /* tp_free */
- (inquiry)0, /* tp_is_gc */
- (PyObject *)0, /* tp_bases */
-};
-
-%%
-init
- PyPangoAttribute_Type.tp_alloc = PyType_GenericAlloc;
- PyPangoAttribute_Type.tp_new = PyType_GenericNew;
- if (PyType_Ready(&PyPangoAttribute_Type) < 0)
- return;
-
- PyPangoAttrIterator_Type.tp_alloc = PyType_GenericAlloc;
- PyPangoAttrIterator_Type.tp_new = PyType_GenericNew;
- if (PyType_Ready(&PyPangoAttrIterator_Type) < 0)
- return;
-%%
-modulename pango
-%%
-import gobject.GObject as PyGObject_Type
-%%
-ignore-glob
- *_get_type
- *_ref
- *_unref
- *_free
-%%
-ignore
- pango_color_copy
- pango_attribute_copy
- pango_attribute_destroy
- pango_attribute_equal
- pango_font_description_equal
- pango_font_map_free_families
- pango_font_get_coverage
- pango_font_find_shaper
- pango_layout_get_log_attrs
-%%
-ignore
- pango_context_new
- pango_context_set_font_map
- pango_glyph_string_index_to_x
- pango_glyph_string_x_to_index
- pango_break
- pango_default_break
- pango_shape
-%%
-override pango_attr_language_new kwargs
-static PyObject *
-_wrap_pango_attr_language_new(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "language", "start_index", "end_index", NULL };
- char *slanguage;
- PangoLanguage *language;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|ii:PangoAttrLanguage",
- kwlist, &slanguage, &start, &end))
- return NULL;
-
- language = pango_language_from_string(slanguage);
-
- return pypango_attr_new(pango_attr_language_new(language), start, end);
-}
-%%
-override pango_attr_family_new kwargs
-static PyObject *
-_wrap_pango_attr_family_new(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "family", "start_index", "end_index", NULL };
- char *family;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|ii:PangoAttrFamily",
- kwlist, &family, &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_family_new(family), start, end);
-}
-%%
-override pango_attr_foreground_new kwargs
-static PyObject *
-_wrap_pango_attr_foreground_new(PyObject *self,PyObject *args,PyObject *kwargs)
-{
- static char *kwlist[] = { "red", "green", "blue", "start_index",
- "end_index", NULL };
- guint16 red, green, blue;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "HHH|ii:PangoAttrForeground",
- kwlist, &red, &green, &blue,
- &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_foreground_new(red, green, blue),
- start, end);
-}
-%%
-override pango_attr_background_new kwargs
-static PyObject *
-_wrap_pango_attr_background_new(PyObject *self,PyObject *args,PyObject *kwargs)
-{
- static char *kwlist[] = { "red", "green", "blue", "start_index",
- "end_index", NULL };
- guint16 red, green, blue;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "HHH|ii:PangoAttrBackground",
- kwlist, &red, &green, &blue,
- &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_background_new(red, green, blue),
- start, end);
-}
-%%
-override pango_attr_size_new kwargs
-static PyObject *
-_wrap_pango_attr_size_new(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "size", "start_index", "end_index", NULL };
- int size;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|ii:PangoAttrSize",
- kwlist, &size, &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_size_new(size), start, end);
-}
-%%
-override pango_attr_style_new kwargs
-static PyObject *
-_wrap_pango_attr_style_new(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "style", "start_index", "end_index", NULL };
- PyObject *py_style;
- PangoStyle style;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|ii:PangoAttrStyle",
- kwlist, &py_style, &start, &end))
- return NULL;
- if (pyg_enum_get_value(PANGO_TYPE_STYLE, py_style, (gint *)&style))
- return NULL;
-
- return pypango_attr_new(pango_attr_style_new(style), start, end);
-}
-%%
-override pango_attr_weight_new kwargs
-static PyObject *
-_wrap_pango_attr_weight_new(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "weight", "start_index", "end_index", NULL };
- PyObject *py_weight;
- PangoWeight weight;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|ii:PangoAttrWeight",
- kwlist, &py_weight, &start, &end))
- return NULL;
- if (pyg_enum_get_value(PANGO_TYPE_WEIGHT, py_weight, (gint *)&weight))
- return NULL;
-
- return pypango_attr_new(pango_attr_weight_new(weight), start, end);
-}
-%%
-override pango_attr_variant_new kwargs
-static PyObject *
-_wrap_pango_attr_variant_new(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "variant", "start_index", "end_index", NULL };
- PyObject *py_variant;
- PangoVariant variant;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|ii:PangoAttrVariant",
- kwlist, &py_variant, &start, &end))
- return NULL;
- if (pyg_enum_get_value(PANGO_TYPE_VARIANT, py_variant, (gint *)&variant))
- return NULL;
-
- return pypango_attr_new(pango_attr_variant_new(variant), start, end);
-}
-%%
-override pango_attr_stretch_new kwargs
-static PyObject *
-_wrap_pango_attr_stretch_new(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "stretch", "start_index", "end_index", NULL };
- PyObject *py_stretch;
- PangoStretch stretch;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|ii:PangoAttrStretch",
- kwlist, &py_stretch, &start, &end))
- return NULL;
- if (pyg_enum_get_value(PANGO_TYPE_STRETCH, py_stretch, (gint *)&stretch))
- return NULL;
-
- return pypango_attr_new(pango_attr_stretch_new(stretch), start, end);
-}
-%%
-override pango_attr_font_desc_new kwargs
-static PyObject *
-_wrap_pango_attr_font_desc_new(PyObject *self, PyObject *args,PyObject *kwargs)
-{
- static char *kwlist[] = { "desc", "start_index", "end_index", NULL };
- PyObject *font_desc;
- PangoFontDescription *desc;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|ii:PangoAttrFontDesc",
- kwlist, &font_desc, &start, &end))
- return NULL;
- if (!pyg_boxed_check(font_desc, PANGO_TYPE_FONT_DESCRIPTION)) {
- PyErr_SetString(PyExc_TypeError,"desc must be a PangoFontDescription");
- return NULL;
- }
- desc = pyg_boxed_get(font_desc, PangoFontDescription);
- return pypango_attr_new(pango_attr_font_desc_new(desc), start, end);
-}
-%%
-override pango_attr_underline_new kwargs
-static PyObject *
-_wrap_pango_attr_underline_new(PyObject *self, PyObject *args,PyObject *kwargs)
-{
- static char *kwlist[] = { "underline", "start_index", "end_index", NULL };
- PyObject *py_underline;
- PangoUnderline underline;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|ii:PangoAttrUnderline",
- kwlist, &py_underline, &start, &end))
- return NULL;
- if (pyg_enum_get_value(PANGO_TYPE_UNDERLINE, py_underline,
- (gint *)&underline))
- return NULL;
-
- return pypango_attr_new(pango_attr_underline_new(underline), start, end);
-}
-%%
-override pango_attr_strikethrough_new kwargs
-static PyObject *
-_wrap_pango_attr_strikethrough_new(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "strikethrough", "start_index",
- "end_index", NULL };
- gboolean strikethrough;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i|ii:PangoAttrStrikethrough",
- kwlist, &strikethrough, &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_strikethrough_new(strikethrough),
- start, end);
-}
-%%
-override pango_attr_rise_new kwargs
-static PyObject *
-_wrap_pango_attr_rise_new(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "rise", "start_index", "end_index", NULL };
- gint rise;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|ii:PangoAttrRise",
- kwlist, &rise, &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_rise_new(rise), start, end);
-}
-%%
-override pango_attr_shape_new kwargs
-static PyObject *
-_wrap_pango_attr_shape_new(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "ink_rect", "logical_rect", "start_index",
- "end_index", NULL };
- PangoRectangle ink_rect, logical_rect;
- PyObject *py_ink_rect, *py_logical_rect;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "OO|ii:PangoAttrShape", kwlist,
- &py_ink_rect, &py_logical_rect,
- &start, &end))
- return NULL;
-
- if (!PyTuple_Check(py_ink_rect)
- || !PyArg_ParseTuple(py_ink_rect, "iiii",
- &ink_rect.x, &ink_rect.y,
- &ink_rect.width, &ink_rect.height)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "ink_rect must be a 4-tuple of integers");
- return NULL;
- }
-
- if (!PyTuple_Check(py_logical_rect)
- || !PyArg_ParseTuple(py_logical_rect, "iiii",
- &logical_rect.x, &logical_rect.y,
- &logical_rect.width,&logical_rect.height)) {
- PyErr_Clear();
- PyErr_SetString(PyExc_TypeError,
- "logical_rect must be a 4-tuple of integers");
- return NULL;
- }
-
- return pypango_attr_new(pango_attr_shape_new(&ink_rect, &logical_rect),
- start, end);
-}
-%%
-override pango_attr_scale_new kwargs
-static PyObject *
-_wrap_pango_attr_scale_new(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "scale", "start_index", "end_index", NULL };
- double scale;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "d|ii:PangoAttrScale",
- kwlist, &scale, &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_scale_new(scale), start, end);
-}
-%%
-override pango_attr_list_insert kwargs
-static PyObject *
-_wrap_pango_attr_list_insert(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "attr", NULL };
- PyPangoAttribute *py_attr;
- PangoAttribute *attr;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!:PangoAttrList.insert", kwlist,
- &PyPangoAttribute_Type, &py_attr))
- return NULL;
- attr = pango_attribute_copy(py_attr->attr);
-
- pango_attr_list_insert(pyg_boxed_get(self, PangoAttrList), attr);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override pango_attr_list_insert_before kwargs
-static PyObject *
-_wrap_pango_attr_list_insert_before(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "attr", NULL };
- PyPangoAttribute *py_attr;
- PangoAttribute *attr;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!:PangoAttrList.insert_before", kwlist,
- &PyPangoAttribute_Type, &py_attr))
- return NULL;
- attr = pango_attribute_copy(py_attr->attr);
-
- pango_attr_list_insert_before(pyg_boxed_get(self, PangoAttrList), attr);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override pango_attr_list_change kwargs
-static PyObject *
-_wrap_pango_attr_list_change(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "attr", NULL };
- PyPangoAttribute *py_attr;
- PangoAttribute *attr;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O!:PangoAttrList.change", kwlist,
- &PyPangoAttribute_Type, &py_attr))
- return NULL;
- attr = pango_attribute_copy(py_attr->attr);
-
- pango_attr_list_change(pyg_boxed_get(self, PangoAttrList), attr);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-ignore pango_font_description_from_string
-%%
-override pango_font_description_new kwargs
-static int
-_wrap_pango_font_description_new(PyGBoxed *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "str", NULL };
- char *str = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "|z:PangoFontDescription.__init__",
- kwlist, &str))
- return -1;
-
- self->gtype = PANGO_TYPE_FONT_DESCRIPTION;
- self->free_on_dealloc = FALSE;
- if (str)
- self->boxed = pango_font_description_from_string(str);
- else
- self->boxed = pango_font_description_new();
- if (!self->boxed) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create PangoFontDescription object");
- return -1;
- }
- self->free_on_dealloc = TRUE;
- return 0;
-}
-%%
-override-slot PangoFontDescription.tp_compare
-static int
-_wrap_pango_font_description_tp_compare(PyGBoxed *self, PyGBoxed *other)
-{
- if (self->boxed == other->boxed ||
- pango_font_description_equal(pyg_boxed_get(self, PangoFontDescription),
- pyg_boxed_get(other, PangoFontDescription)))
- return 0;
- if (self->boxed > other->boxed)
- return -1;
- return 1;
-}
-%%
-override-slot PangoFontDescription.tp_hash
-static long
-_wrap_pango_font_description_tp_hash(PyGBoxed *self)
-{
- return (long)pango_font_description_hash(
- pyg_boxed_get(self, PangoFontDescription));
-}
-%%
-override pango_font_description_copy noargs
-static PyObject *
-_wrap_pango_font_description_copy(PyObject *self)
-{
- return pyg_boxed_new(PANGO_TYPE_FONT_DESCRIPTION,
- pyg_boxed_get(self, PangoFontDescription),
- TRUE, TRUE);
-}
-%%
-override pango_context_list_families noargs
-static PyObject *
-_wrap_pango_context_list_families(PyGObject *self)
-{
- PangoFontFamily **families;
- gint n_families, i;
- PyObject *ret;
-
- pango_context_list_families(PANGO_CONTEXT(self->obj), &families,
- &n_families);
- ret = PyTuple_New(n_families);
- for (i = 0; i < n_families; i++) {
- PyObject *family;
-
- family = pygobject_new((GObject *)families[i]);
- PyTuple_SetItem(ret, i, family);
- }
- g_free(families);
- return ret;
-}
-%%
-override pango_font_get_glyph_extents kwargs
-static PyObject *
-_wrap_pango_font_get_glyph_extents(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "glyph", NULL };
- gint glyph;
- PangoRectangle ink_rect, logical_rect;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i:PangoFont.get_glyph_extents", kwlist,
- &glyph))
- return NULL;
- pango_font_get_glyph_extents(PANGO_FONT(self->obj), (PangoGlyph)glyph,
- &ink_rect, &logical_rect);
- return Py_BuildValue("((iiii)(iiii))",
- ink_rect.x, ink_rect.y,
- ink_rect.width, ink_rect.height,
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-%%
-override pango_font_family_list_faces noargs
-static PyObject *
-_wrap_pango_font_family_list_faces(PyGObject *self)
-{
- PangoFontFace **faces;
- gint n_faces, i;
- PyObject *ret;
-
- pango_font_family_list_faces(PANGO_FONT_FAMILY(self->obj),
- &faces, &n_faces);
- ret = PyTuple_New(n_faces);
- for (i = 0; i < n_faces; i++) {
- PyObject *face;
-
- face = pygobject_new((GObject *)faces[i]);
- PyTuple_SetItem(ret, i, face);
- }
- g_free(faces);
- return ret;
-}
-%%
-override pango_font_map_list_families noargs
-static PyObject *
-_wrap_pango_font_map_list_families(PyGObject *self)
-{
- PangoFontFamily **families;
- gint n_families, i;
- PyObject *ret;
-
- pango_font_map_list_families(PANGO_FONT_MAP(self->obj), &families,
- &n_families);
- ret = PyTuple_New(n_families);
- for (i = 0; i < n_families; i++) {
- PyObject *family;
-
- family = pygobject_new((GObject *)families[i]);
- PyTuple_SetItem(ret, i, family);
- }
- g_free(families);
- return ret;
-}
-%%
-override pango_glyph_string_extents kwargs
-static PyObject *
-_wrap_pango_glyph_string_extents(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "font", NULL };
- PyObject *font;
- PangoRectangle ink_rect, logical_rect;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O:PangoGlyphString.extents", kwlist,
- &font))
- return NULL;
- if (!pygobject_check(font, &PyPangoFont_Type)) {
- PyErr_SetString(PyExc_TypeError, "font must be a PangoFont");
- return NULL;
- }
-
- pango_glyph_string_extents(pyg_boxed_get(self, PangoGlyphString),
- PANGO_FONT(pygobject_get(font)),
- &ink_rect, &logical_rect);
-
- return Py_BuildValue("((iiii)(iiii))",
- ink_rect.x, ink_rect.y,
- ink_rect.width, ink_rect.height,
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-%%
-override pango_glyph_string_extents_range kwargs
-static PyObject *
-_wrap_pango_glyph_string_extents_range(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "start", "end", "font", NULL };
- gint start, end;
- PyObject *font;
- PangoRectangle ink_rect, logical_rect;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iiO:PangoGlyphString.extents_range",
- kwlist, &start, &end, &font))
- return NULL;
- if (!pygobject_check(font, &PyPangoFont_Type)) {
- PyErr_SetString(PyExc_TypeError, "font must be a PangoFont");
- return NULL;
- }
-
- pango_glyph_string_extents_range(pyg_boxed_get(self, PangoGlyphString),
- start, end,
- PANGO_FONT(pygobject_get(font)),
- &ink_rect, &logical_rect);
-
- return Py_BuildValue("((iiii)(iiii))",
- ink_rect.x, ink_rect.y,
- ink_rect.width, ink_rect.height,
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-%%
-override pango_glyph_string_get_logical_widths kwargs
-static PyObject *
-_wrap_pango_glyph_string_get_logical_widths(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "text", "embedding_level", NULL };
- const char *text;
- gint length, embedding_level, *logical_widths;
- Py_ssize_t i, slen;
- PyObject *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s#i:PangoGlyphString.get_logical_widths",
- kwlist, &text, &length, &embedding_level))
- return NULL;
- slen = g_utf8_strlen(text, length);
- logical_widths = g_new(int, slen);
- pango_glyph_string_get_logical_widths(pyg_boxed_get(self,PangoGlyphString),
- text, length, embedding_level,
- logical_widths);
- ret = PyTuple_New(slen);
- for (i = 0; i < slen; i++) {
- PyObject *item = PyInt_FromLong(logical_widths[i]);
-
- PyTuple_SetItem(ret, i, item);
- }
- g_free(logical_widths);
- return ret;
-}
-%%
-override pango_layout_set_markup kwargs
-static PyObject *
-_wrap_pango_layout_set_markup(PyGObject *self, PyObject *args,PyObject *kwargs)
-{
- static char *kwlist[] = { "markup", NULL };
- char *markup;
- Py_ssize_t length;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s#:PangoLayout.set_markup",
- kwlist, &markup, &length))
- return NULL;
-
- pango_layout_set_markup(PANGO_LAYOUT(self->obj), markup, length);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override pango_layout_set_markup_with_accel kwargs
-static PyObject *
-_wrap_pango_layout_set_markup_with_accel(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "markup", "accel_marker", NULL };
- char *markup;
- Py_ssize_t length, accel_length;
- Py_UNICODE *accel_marker, pychr;
- gunichar accel_char;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s#u#:PangoLayout.set_markup_with_accel",
- kwlist, &markup, &length,
- &accel_marker, &accel_length))
- return NULL;
- if (accel_length != 1) {
- PyErr_SetString(PyExc_TypeError, "accel_marker must be a unicode string of length 1");
- return NULL;
- }
- pango_layout_set_markup_with_accel(PANGO_LAYOUT(self->obj), markup, length,
- (gunichar)accel_marker[0], &accel_char);
-
-#if !defined(Py_UNICODE_SIZE) || Py_UNICODE_SIZE == 2
- if (accel_char >= 0xffff) {
- PyErr_SetString(PyExc_ValueError, "unicode character is too big to fit in a 16-bit unicode character");
- return NULL;
- }
-#endif
- pychr = (Py_UNICODE)accel_char;
- return PyUnicode_FromUnicode(&pychr, 1);
-}
-%%
-override pango_layout_index_to_pos kwargs
-static PyObject *
-_wrap_pango_layout_index_to_pos(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "index", NULL };
- gint index;
- PangoRectangle pos;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i:PangoLayout.index_to_pos", kwlist,
- &index))
- return NULL;
-
- pango_layout_index_to_pos(PANGO_LAYOUT(self->obj), index, &pos);
- return Py_BuildValue("(iiii)", pos.x, pos.y, pos.width, pos.height);
-}
-%%
-override pango_layout_get_cursor_pos kwargs
-static PyObject *
-_wrap_pango_layout_get_cursor_pos(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "index", NULL };
- gint index;
- PangoRectangle strong_pos, weak_pos;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i:PangoLayout.get_cursor_pos", kwlist,
- &index))
- return NULL;
-
- pango_layout_get_cursor_pos(PANGO_LAYOUT(self->obj), index,
- &strong_pos, &weak_pos);
- return Py_BuildValue("((iiii)(iiii))",
- strong_pos.x, strong_pos.y,
- strong_pos.width, strong_pos.height,
- weak_pos.x, weak_pos.y,
- weak_pos.width, weak_pos.height);
-}
-%%
-override pango_layout_move_cursor_visually kwargs
-static PyObject *
-_wrap_pango_layout_move_cursor_visually(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "strong", "old_index", "old_trailing", "direction", NULL };
- gboolean strong;
- gint old_index, old_trailing, direction, new_index = 0, new_trailing = 0;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iiii:PangoLayout.move_cursor_visually",
- kwlist, &strong, &old_index,
- &old_trailing, &direction))
- return NULL;
-
- pango_layout_move_cursor_visually(PANGO_LAYOUT(self->obj), strong,
- old_index, old_trailing, direction,
- &new_index, &new_trailing);
- return Py_BuildValue("(ii)", new_index, new_trailing);
-}
-%%
-override pango_layout_xy_to_index kwargs
-static PyObject *
-_wrap_pango_layout_xy_to_index(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "x", "y", NULL };
- gint x, y, index, trailing;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "ii:PangoLayout.xy_to_index", kwlist,
- &x, &y))
- return NULL;
-
- pango_layout_xy_to_index(PANGO_LAYOUT(self->obj), x, y, &index, &trailing);
-
- return Py_BuildValue("(ii)", index, trailing);
-}
-%%
-override pango_layout_get_extents noargs
-static PyObject *
-_wrap_pango_layout_get_extents(PyGObject *self)
-{
- PangoRectangle ink_rect, logical_rect;
-
- pango_layout_get_extents(PANGO_LAYOUT(self->obj),
- &ink_rect, &logical_rect);
-
- return Py_BuildValue("((iiii)(iiii))",
- ink_rect.x, ink_rect.y,
- ink_rect.width, ink_rect.height,
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-%%
-override pango_layout_get_pixel_extents noargs
-static PyObject *
-_wrap_pango_layout_get_pixel_extents(PyGObject *self)
-{
- PangoRectangle ink_rect, logical_rect;
-
- pango_layout_get_pixel_extents(PANGO_LAYOUT(self->obj),
- &ink_rect, &logical_rect);
-
- return Py_BuildValue("((iiii)(iiii))",
- ink_rect.x, ink_rect.y,
- ink_rect.width, ink_rect.height,
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-%%
-override pango_layout_get_size noargs
-static PyObject *
-_wrap_pango_layout_get_size(PyGObject *self)
-{
- gint width, height;
-
- pango_layout_get_size(PANGO_LAYOUT(self->obj), &width, &height);
-
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override pango_layout_get_pixel_size noargs
-static PyObject *
-_wrap_pango_layout_get_pixel_size(PyGObject *self)
-{
- gint width, height;
-
- pango_layout_get_pixel_size(PANGO_LAYOUT(self->obj), &width, &height);
-
- return Py_BuildValue("(ii)", width, height);
-}
-%%
-override pango_parse_markup kwargs
-static PyObject *
-_wrap_pango_parse_markup(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "markup_text", "accel_marker", NULL };
- char *markup_text, *text = NULL;
- Py_ssize_t length;
- Py_UNICODE *py_accel_marker = NULL, py_accel_char;
- Py_ssize_t py_accel_marker_len;
- gunichar accel_marker, accel_char = 0;
- PangoAttrList *attr_list = NULL;
- GError *error = NULL;
- gboolean ret;
- PyObject *py_ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s#|u#:pango.parse_markup",
- kwlist, &markup_text, &length,
- &py_accel_marker, &py_accel_marker_len))
- return NULL;
- if (py_accel_marker != NULL) {
- if (py_accel_marker_len != 1) {
- PyErr_SetString(PyExc_TypeError, "accel_mark must be one character");
- return NULL;
- }
- accel_marker = py_accel_marker[0];
- } else
- accel_marker = 0;
-
- ret = pango_parse_markup(markup_text, length, accel_marker,
- &attr_list, &text, &accel_char, &error);
- if (pyg_error_check(&error))
- return NULL;
-
-#if !defined(Py_UNICODE_SIZE) || Py_UNICODE_SIZE == 2
- if (accel_char >= 0xffff) {
- PyErr_SetString(PyExc_ValueError, "unicode character is too big to fit in a 16-bit unicode character");
- return NULL;
- }
-#endif
- py_accel_char = (Py_UNICODE)accel_char;
-
- py_ret = Py_BuildValue("(Nsu#)", pyg_boxed_new(PANGO_TYPE_ATTR_LIST,
- attr_list, FALSE, TRUE),
- text, &py_accel_char, (Py_ssize_t) 1);
- g_free(text);
- return py_ret;
-}
-%%
-override pango_tab_array_get_tab kwargs
-static PyObject *
-_wrap_pango_tab_array_get_tab(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "tab_index", NULL };
- gint tab_index, location;
- PangoTabAlign alignment;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i:PangoTabArray.get_tab",
- kwlist, &tab_index))
- return NULL;
-
- pango_tab_array_get_tab(pyg_boxed_get(self, PangoTabArray),
- tab_index, &alignment, &location);
- return Py_BuildValue("(ii)", (int)alignment, location);
-}
-%%
-override pango_tab_array_get_tabs noargs
-static PyObject *
-_wrap_pango_tab_array_get_tabs(PyObject *self)
-{
- PangoTabAlign *alignments;
- gint *locations, length, i;
- PyObject *ret;
-
- length = pango_tab_array_get_size(pyg_boxed_get(self, PangoTabArray));
- pango_tab_array_get_tabs(pyg_boxed_get(self, PangoTabArray),
- &alignments, &locations);
- ret = PyTuple_New(length);
- for (i = 0; i < length; i++) {
- PyObject *item;
-
- item = Py_BuildValue("(ii)", (int)alignments[i], locations[i]);
- PyTuple_SetItem(ret, i, item);
- }
- g_free(alignments);
- g_free(locations);
- return ret;
-}
-%%
-override pango_layout_set_text kwargs
-static PyObject *
-_wrap_pango_layout_set_text(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "text", NULL };
- char *text;
- Py_ssize_t length;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s#:PangoLayout.set_text",
- kwlist, &text, &length))
- return NULL;
- pango_layout_set_text(PANGO_LAYOUT(self->obj), text, length);
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override pango_color_parse kwargs
-static int
-_wrap_pango_color_parse(PyGBoxed *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "spec", NULL };
- char *spec;
- PangoColor color;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s:PangoColor.__init__",
- kwlist, &spec))
- return -1;
-
- self->gtype = PANGO_TYPE_COLOR;
- self->free_on_dealloc = FALSE;
-
- if (pango_color_parse(&color, spec) != TRUE
- || !(self->boxed = pango_color_copy(&color))) {
- PyErr_SetString(PyExc_RuntimeError,
- "could not create PangoColor object");
- return -1;
- }
-
- self->free_on_dealloc = TRUE;
-
- return 0;
-}
-%%
-override pango_attr_list_get_iterator noargs
-static PyObject *
-_wrap_pango_attr_list_get_iterator(PyGBoxed *self)
-{
- PangoAttrList *list = pyg_boxed_get(self, PangoAttrList);
- PangoAttrIterator *iter = pango_attr_list_get_iterator(list);
-
- return pypango_attr_iterator_new(iter);
-}
-%%
-override PANGO_ASCENT kwargs
-static PyObject *
-_wrap_PANGO_ASCENT(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "rect", NULL };
- int ret;
- PangoRectangle rect;
- PyObject *py_rect;
-
- if (PyArg_ParseTupleAndKeywords(args, kwargs, "O!:ASCENT",
- kwlist, &PyTuple_Type, &py_rect)
- && PyArg_ParseTuple(py_rect, "iiii:ASCENT", &rect.x, &rect.y,
- &rect.width, &rect.height)) {
- ret = PANGO_ASCENT(rect);
- return PyInt_FromLong(ret);
- }
- PyErr_Clear();
- PyErr_SetString(PyExc_ValueError, "rect must be a 4-tuple of integers");
- return NULL;
-}
-%%
-override PANGO_DESCENT kwargs
-static PyObject *
-_wrap_PANGO_DESCENT(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "rect", NULL };
- int ret;
- PangoRectangle rect;
- PyObject *py_rect;
-
- if (PyArg_ParseTupleAndKeywords(args, kwargs, "O!:DESCENT",
- kwlist, &PyTuple_Type, &py_rect)
- && PyArg_ParseTuple(py_rect, "iiii:DESCENT", &rect.x, &rect.y,
- &rect.width, &rect.height)) {
- ret = PANGO_DESCENT(rect);
- return PyInt_FromLong(ret);
- }
- PyErr_Clear();
- PyErr_SetString(PyExc_ValueError, "rect must be a 4-tuple of integers");
- return NULL;
-}
-%%
-override PANGO_LBEARING kwargs
-static PyObject *
-_wrap_PANGO_LBEARING(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "rect", NULL };
- int ret;
- PangoRectangle rect;
- PyObject *py_rect;
-
- if (PyArg_ParseTupleAndKeywords(args, kwargs, "O!:LBEARING",
- kwlist, &PyTuple_Type, &py_rect)
- && PyArg_ParseTuple(py_rect, "iiii:LBEARING", &rect.x, &rect.y,
- &rect.width, &rect.height)) {
- ret = PANGO_LBEARING(rect);
- return PyInt_FromLong(ret);
- }
- PyErr_Clear();
- PyErr_SetString(PyExc_ValueError, "rect must be a 4-tuple of integers");
- return NULL;
-}
-%%
-override PANGO_RBEARING kwargs
-static PyObject *
-_wrap_PANGO_RBEARING(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "rect", NULL };
- int ret;
- PangoRectangle rect;
- PyObject *py_rect;
-
- if (PyArg_ParseTupleAndKeywords(args, kwargs, "O!:RBEARING",
- kwlist, &PyTuple_Type, &py_rect)
- && PyArg_ParseTuple(py_rect, "iiii:RBEARING", &rect.x, &rect.y,
- &rect.width, &rect.height)) {
- ret = PANGO_RBEARING(rect);
- return PyInt_FromLong(ret);
- }
- PyErr_Clear();
- PyErr_SetString(PyExc_ValueError, "rect must be a 4-tuple of integers");
- return NULL;
-}
-%%
-override pango_attr_fallback_new kwargs
-static PyObject *
-_wrap_pango_attr_fallback_new(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "fallback", "start_index", "end_index", NULL };
- gboolean fallback;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|ii:PangoAttrFallback",
- kwlist, &fallback, &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_fallback_new(fallback),
- start, end);
-}
-%%
-override pango_attr_list_filter kwargs
-static gboolean
-pypango_attr_list_filter_cb(PangoAttribute *attr, gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *retobj, *py_attr;
- gboolean ret = FALSE;
-
- state = pyg_gil_state_ensure();
-
- py_attr = pypango_attr_new(pango_attribute_copy(attr),
- attr->start_index, attr->end_index);
-
- if (cunote->data)
- retobj = PyObject_CallFunction(cunote->func, "NO", py_attr,
- cunote->data);
- else
- retobj = PyObject_CallFunction(cunote->func, "N", py_attr);
-
- if (retobj != NULL) {
- ret = PyObject_IsTrue(retobj);
- Py_DECREF(retobj);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_pango_attr_list_filter(PyGBoxed *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", NULL };
- PyObject *py_func, *py_data = NULL;
- PangoAttrList *attr_list, *filtered_list;
- PyGtkCustomNotify cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:pango.AttrList.filter",
- kwlist, &py_func, &py_data))
- return NULL;
-
- if (!PyCallable_Check(py_func)) {
- PyErr_SetString(PyExc_TypeError, "func must be callable");
- return NULL;
- }
-
- cunote.func = py_func;
- cunote.data = py_data;
- Py_INCREF(cunote.func);
- Py_XINCREF(cunote.data);
-
- attr_list = (PangoAttrList *)pyg_boxed_get(self, PangoAttrList);
- filtered_list = pango_attr_list_filter(attr_list,
- pypango_attr_list_filter_cb,
- (gpointer)&cunote);
-
- Py_DECREF(cunote.func);
- Py_XDECREF(cunote.data);
-
- if (filtered_list)
- return pyg_boxed_new(PANGO_TYPE_ATTR_LIST, filtered_list, FALSE, TRUE);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override pango_font_face_list_sizes noargs
-static PyObject *
-_wrap_pango_font_face_list_sizes(PyGObject *self)
-{
- PyObject *py_sizes;
- int *sizes, n_sizes, i;
-
- pango_font_face_list_sizes(PANGO_FONT_FACE(self->obj), &sizes, &n_sizes);
-
-
- if (!sizes) {
- Py_INCREF(Py_None);
- return Py_None;
- }
-
- py_sizes = PyTuple_New(n_sizes);
-
- for (i = 0; i < n_sizes; i++)
- PyTuple_SetItem(py_sizes, i, PyInt_FromLong(sizes[i]));
-
- g_free(sizes);
-
- return py_sizes;
-}
-%%
-override pango_fontset_foreach kwargs
-static gboolean
-pypango_fontset_foreach_cb(PangoFontset *fontset, PangoFont *font,
- gpointer data)
-{
- PyGILState_STATE state;
- PyGtkCustomNotify *cunote = data;
- PyObject *retobj, *py_font, *py_fontset;
- gboolean ret = FALSE;
-
- state = pyg_gil_state_ensure();
-
- py_fontset = pygobject_new((GObject *)fontset);
- py_font = pygobject_new((GObject *)font);
-
- if (cunote->data)
- retobj = PyObject_CallFunction(cunote->func, "NNO", py_fontset,
- py_font, cunote->data);
- else
- retobj = PyObject_CallFunction(cunote->func, "NN", py_fontset,
- py_font);
-
- if (retobj != NULL) {
- ret = PyObject_IsTrue(retobj);
- Py_DECREF(retobj);
- } else {
- PyErr_Print();
- }
-
- pyg_gil_state_release(state);
- return ret;
-}
-static PyObject *
-_wrap_pango_fontset_foreach(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "func", "data", NULL };
- PyObject *py_func, *py_data = NULL;
- PyGtkCustomNotify cunote;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "O|O:pango.Fontset.fforeach",
- kwlist, &py_func, &py_data))
- return NULL;
-
- if (!PyCallable_Check(py_func)) {
- PyErr_SetString(PyExc_TypeError, "func must be callable");
- return NULL;
- }
-
- cunote.func = py_func;
- cunote.data = py_data;
- Py_INCREF(cunote.func);
- Py_XINCREF(cunote.data);
-
- pango_fontset_foreach(PANGO_FONTSET(self->obj),
- pypango_fontset_foreach_cb,
- (gpointer)&cunote);
-
- Py_DECREF(cunote.func);
- Py_XDECREF(cunote.data);
-
- Py_INCREF(Py_None);
- return Py_None;
-}
-%%
-override pango_language_from_string1 kwargs
-static PyObject *
-_wrap_pango_language_from_string1(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "language", NULL };
- char *language;
- PangoLanguage *ret;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "s:pango_language_from_string",
- kwlist, &language))
- return NULL;
- if (PyErr_Warn(PyExc_DeprecationWarning,
- "use pango.Language instead") < 0)
- return NULL;
-
- ret = pango_language_from_string(language);
- /* pyg_boxed_new handles NULL checking */
- return pyg_boxed_new(PANGO_TYPE_LANGUAGE, ret, TRUE, TRUE);
-}
-
-%%
-override pango_language_matches1 kwargs
-static PyObject *
-_wrap_pango_language_matches1(PyGObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "language", "range_list", NULL };
- PyObject *py_language = Py_None;
- char *range_list;
- PangoLanguage *language = NULL;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "Os:pango_language_matches",
- kwlist, &py_language, &range_list))
- return NULL;
- if (PyErr_Warn(PyExc_DeprecationWarning,
- "use pango.Language.matches instead") < 0)
- return NULL;
-
- if (pyg_boxed_check(py_language, PANGO_TYPE_LANGUAGE))
- language = pyg_boxed_get(py_language, PangoLanguage);
- else if (py_language != Py_None) {
- PyErr_SetString(PyExc_TypeError,
- "language should be a PangoLanguage or None");
- return NULL;
- }
-
- return PyBool_FromLong(pango_language_matches(language, range_list));
-}
-%%
-override pango_layout_iter_get_char_extents noargs
-static PyObject *
-_wrap_pango_layout_iter_get_char_extents(PyGObject *self)
-{
- PangoRectangle logical_rect;
-
- pango_layout_iter_get_char_extents(pyg_boxed_get(self, PangoLayoutIter),
- &logical_rect);
- return Py_BuildValue("(iiii)",
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-%%
-override pango_layout_iter_get_cluster_extents noargs
-static PyObject *
-_wrap_pango_layout_iter_get_cluster_extents(PyGObject *self)
-{
- PangoRectangle ink_rect, logical_rect;
-
- pango_layout_iter_get_cluster_extents(pyg_boxed_get(self, PangoLayoutIter),
- &ink_rect, &logical_rect);
- return Py_BuildValue("((iiii)(iiii))",
- ink_rect.x, ink_rect.y,
- ink_rect.width, ink_rect.height,
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-%%
-override pango_layout_iter_get_line_extents noargs
-static PyObject *
-_wrap_pango_layout_iter_get_line_extents(PyGObject *self)
-{
- PangoRectangle ink_rect, logical_rect;
-
- pango_layout_iter_get_line_extents(pyg_boxed_get(self, PangoLayoutIter),
- &ink_rect, &logical_rect);
- return Py_BuildValue("((iiii)(iiii))",
- ink_rect.x, ink_rect.y,
- ink_rect.width, ink_rect.height,
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-%%
-override pango_layout_iter_get_run_extents noargs
-static PyObject *
-_wrap_pango_layout_iter_get_run_extents(PyGObject *self)
-{
- PangoRectangle ink_rect, logical_rect;
-
- pango_layout_iter_get_run_extents(pyg_boxed_get(self, PangoLayoutIter),
- &ink_rect, &logical_rect);
- return Py_BuildValue("((iiii)(iiii))",
- ink_rect.x, ink_rect.y,
- ink_rect.width, ink_rect.height,
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-%%
-override pango_layout_iter_get_layout_extents noargs
-static PyObject *
-_wrap_pango_layout_iter_get_layout_extents(PyGObject *self)
-{
- PangoRectangle ink_rect, logical_rect;
-
- pango_layout_iter_get_layout_extents(pyg_boxed_get(self, PangoLayoutIter),
- &ink_rect, &logical_rect);
- return Py_BuildValue("((iiii)(iiii))",
- ink_rect.x, ink_rect.y,
- ink_rect.width, ink_rect.height,
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-%%
-override pango_layout_iter_get_line_yrange noargs
-static PyObject *
-_wrap_pango_layout_iter_get_line_yrange(PyGObject *self)
-{
- int start, end;
-
- pango_layout_iter_get_line_yrange(pyg_boxed_get(self, PangoLayoutIter),
- &start, &end);
- return Py_BuildValue("(ii)", start, end);
-}
-%%
-override pango_layout_line_x_to_index kwargs
-static PyObject *
-_wrap_pango_layout_line_x_to_index(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "x_pos", NULL };
- gboolean inside;
- int x_pos, index, trailing;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i:PangoLayoutLine.x_to_index",
- kwlist, &x_pos))
- return NULL;
-
- inside = pango_layout_line_x_to_index(pyg_boxed_get(self, PangoLayoutLine),
- x_pos, &index, &trailing);
- return Py_BuildValue("Nii", PyBool_FromLong(inside), index, trailing);
-}
-%%
-override pango_layout_line_index_to_x kwargs
-static PyObject *
-_wrap_pango_layout_line_index_to_x(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "index", "trailing", NULL };
- int x_pos, index;
- PyObject *trailing;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "iO:PangoLayoutLine.index_to_x",
- kwlist, &index, &trailing))
- return NULL;
- pango_layout_line_index_to_x(pyg_boxed_get(self, PangoLayoutLine),
- index, PyObject_IsTrue(trailing),
- &x_pos);
- return PyInt_FromLong(x_pos);
-}
-%%
-override pango_layout_line_get_extents noargs
-static PyObject *
-_wrap_pango_layout_line_get_extents(PyGObject *self)
-{
- PangoRectangle ink_rect, logical_rect;
-
- pango_layout_line_get_extents(pyg_boxed_get(self, PangoLayoutLine),
- &ink_rect, &logical_rect);
-
- return Py_BuildValue("((iiii)(iiii))",
- ink_rect.x, ink_rect.y,
- ink_rect.width, ink_rect.height,
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-%%
-override pango_layout_line_get_pixel_extents noargs
-static PyObject *
-_wrap_pango_layout_line_get_pixel_extents(PyGObject *self)
-{
- PangoRectangle ink_rect, logical_rect;
-
- pango_layout_line_get_pixel_extents(pyg_boxed_get(self, PangoLayoutLine),
- &ink_rect, &logical_rect);
-
- return Py_BuildValue("((iiii)(iiii))",
- ink_rect.x, ink_rect.y,
- ink_rect.width, ink_rect.height,
- logical_rect.x, logical_rect.y,
- logical_rect.width, logical_rect.height);
-}
-
-%%
-override-attr PangoLayoutLine.runs
-
-static inline PyObject *
-pypango_glyph_item_new(PangoGlyphItem *gitem)
-{
- return Py_BuildValue("NN", pyg_boxed_new(PANGO_TYPE_ITEM, gitem->item, TRUE, TRUE),
- pyg_boxed_new(PANGO_TYPE_GLYPH_STRING, gitem->glyphs, TRUE, TRUE));
-}
-
-static PyObject *
-_wrap_pango_layout_line__get_runs(PyGObject *self, void *closure)
-{
- PangoLayoutLine *line = pyg_boxed_get(self, PangoLayoutLine);
- PyObject *list, *item;
- GSList *l;
-
- list = PyList_New(0);
- for (l = line->runs; l; l = l->next) {
- item = pypango_glyph_item_new((PangoGlyphItem *) l->data);
- PyList_Append(list, item);
- Py_DECREF(item);
- }
- return list;
-}
-%%
-override pango_attr_underline_color_new kwargs
-static PyObject *
-_wrap_pango_attr_underline_color_new(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "red", "green", "blue", "start_index",
- "end_index", NULL };
- guint16 red, green, blue;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "HHH|ii:PangoAttrUnderlineColor",
- kwlist, &red, &green, &blue,
- &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_underline_color_new(red, green, blue),
- start, end);
-}
-%%
-override pango_attr_strikethrough_color_new kwargs
-static PyObject *
-_wrap_pango_attr_strikethrough_color_new(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "red", "green", "blue", "start_index",
- "end_index", NULL };
- guint16 red, green, blue;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "HHH|ii:PangoAttrStrikethroughColor",
- kwlist, &red, &green, &blue,
- &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_strikethrough_color_new(red, green, blue),
- start, end);
-}
-%%
-override pango_attr_size_new_absolute kwargs
-static PyObject *
-_wrap_pango_attr_size_new_absolute(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "size", "start_index", "end_index", NULL };
- int size;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i|ii:PangoAttrSizeAbsolute",
- kwlist, &size, &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_size_new_absolute(size), start, end);
-}
-%%
-override pango_attr_letter_spacing_new kwargs
-static PyObject *
-_wrap_pango_attr_letter_spacing_new(PyObject *self, PyObject *args,
- PyObject *kwargs)
-{
- static char *kwlist[] = { "letter_spacing", "start_index", "end_index",
- NULL };
- int spacing;
- guint start = 0, end = 1;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs,
- "i|ii:PangoAttrLetterSpacing",
- kwlist, &spacing, &start, &end))
- return NULL;
-
- return pypango_attr_new(pango_attr_letter_spacing_new(spacing),
- start, end);
-}
diff --git a/pangocairo.defs b/pangocairo.defs
deleted file mode 100644
index 207ef8a1..00000000
--- a/pangocairo.defs
+++ /dev/null
@@ -1,162 +0,0 @@
-;; From /opt/gnome-devel/include/pango-1.0/pango/pangocairo.h
-
-(define-interface CairoFontMap
- (in-module "Pango")
- (c-name "PangoCairoFontMap")
- (gtype-id "PANGO_TYPE_CAIRO_FONT_MAP")
- (prerequisite "PangoFontMap")
-)
-
-(define-function font_map_get_type
- (c-name "pango_cairo_font_map_get_type")
- (return-type "GType")
-)
-
-(define-function cairo_font_map_new
- (c-name "pango_cairo_font_map_new")
- (return-type "PangoFontMap*")
-)
-
-(define-function cairo_font_map_get_default
- (c-name "pango_cairo_font_map_get_default")
- (return-type "PangoFontMap*")
-)
-
-(define-method set_resolution
- (of-object "PangoCairoFontMap")
- (c-name "pango_cairo_font_map_set_resolution")
- (return-type "none")
- (parameters
- '("double" "dpi")
- )
-)
-
-(define-method get_resolution
- (of-object "PangoCairoFontMap")
- (c-name "pango_cairo_font_map_get_resolution")
- (return-type "double")
-)
-
-(define-method create_context
- (of-object "PangoCairoFontMap")
- (c-name "pango_cairo_font_map_create_context")
- (return-type "PangoContext*")
-)
-
-(define-function update_context
- (c-name "pango_cairo_update_context")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("PangoContext*" "context")
- )
-)
-
-(define-function context_set_font_options
- (c-name "pango_cairo_context_set_font_options")
- (return-type "none")
- (parameters
- '("PangoContext*" "context")
- '("const-cairo_font_options_t*" "options")
- )
-)
-
-(define-function context_get_font_options
- (c-name "pango_cairo_context_get_font_options")
- (return-type "const-cairo_font_options_t*")
- (parameters
- '("PangoContext*" "context")
- )
-)
-
-(define-function context_set_resolution
- (c-name "pango_cairo_context_set_resolution")
- (return-type "none")
- (parameters
- '("PangoContext*" "context")
- '("double" "dpi")
- )
-)
-
-(define-function context_get_resolution
- (c-name "pango_cairo_context_get_resolution")
- (return-type "double")
- (parameters
- '("PangoContext*" "context")
- )
-)
-
-(define-function create_layout
- (c-name "pango_cairo_create_layout")
- (return-type "PangoLayout*")
- (parameters
- '("cairo_t*" "cr")
- )
-)
-
-(define-function update_layout
- (c-name "pango_cairo_update_layout")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("PangoLayout*" "layout")
- )
-)
-
-(define-function show_glyph_string
- (c-name "pango_cairo_show_glyph_string")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("PangoFont*" "font")
- '("PangoGlyphString*" "glyphs")
- )
-)
-
-(define-function show_layout_line
- (c-name "pango_cairo_show_layout_line")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("PangoLayoutLine*" "line")
- )
-)
-
-(define-function show_layout
- (c-name "pango_cairo_show_layout")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("PangoLayout*" "layout")
- )
-)
-
-(define-function glyph_string_path
- (c-name "pango_cairo_glyph_string_path")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("PangoFont*" "font")
- '("PangoGlyphString*" "glyphs")
- )
-)
-
-(define-function layout_line_path
- (c-name "pango_cairo_layout_line_path")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("PangoLayoutLine*" "line")
- )
-)
-
-(define-function layout_path
- (c-name "pango_cairo_layout_path")
- (return-type "none")
- (parameters
- '("cairo_t*" "cr")
- '("PangoLayout*" "layout")
- )
-)
-
-
diff --git a/pangocairo.override b/pangocairo.override
deleted file mode 100644
index bb923e63..00000000
--- a/pangocairo.override
+++ /dev/null
@@ -1,315 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*- */
-%%
-headers
-#define NO_IMPORT_PYGOBJECT
-#include <pygobject.h>
-#include <pango/pangocairo.h>
-#include <pycairo.h>
-
-
-extern Pycairo_CAPI_t *Pycairo_CAPI;
-
-GType pypango_layout_line_type; /* See bug 305975 */
-
-#ifndef PANGO_TYPE_LAYOUT_LINE
-# define PANGO_TYPE_LAYOUT_LINE pypango_layout_line_type
-#endif
-
-%%
-import pango.FontMap as PyPangoFontMap_Type
-import pango.Context as PyPangoContext_Type
-import pango.Layout as PyPangoLayout_Type
-import pango.Font as PyPangoFont_Type
-
-%%
-ignore
- pango_cairo_update_context
- pango_cairo_create_layout
- pango_cairo_update_layout
- pango_cairo_show_glyph_string
- pango_cairo_show_layout_line
- pango_cairo_show_layout
- pango_cairo_glyph_string_path
- pango_cairo_layout_line_path
- pango_cairo_layout_path
-%%
-ignore-glob
- *_get_type
-%%
-define context_get_font_options kwargs
-static PyObject *
-_wrap_context_get_font_options(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "context", NULL };
- PyGObject *context;
- const cairo_font_options_t *font_options;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!:pangocairo.context_get_font_options",
- kwlist, &PyPangoContext_Type, &context))
- return NULL;
- font_options = pango_cairo_context_get_font_options(PANGO_CONTEXT(context->obj));
- if (!font_options) {
- Py_INCREF(Py_None);
- return Py_None;
- }
- return PycairoFontOptions_FromFontOptions(cairo_font_options_copy(font_options));
-}
-
-%%
-define context_set_font_options kwargs
-static PyObject *
-_wrap_context_set_font_options(PyObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "context", "font_options", NULL };
- PyGObject *context;
- PyGObject *py_options;
- const cairo_font_options_t *options;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!O:pangocairo.context_set_font_options",
- kwlist, &PyPangoContext_Type, &context,
- &py_options))
- return NULL;
- if ((PyObject*)py_options == Py_None)
- options = NULL;
- else if (pygobject_check(py_options, &PycairoFontOptions_Type))
- options = ((PycairoFontOptions *)py_options)->font_options;
- else {
- PyErr_SetString(PyExc_TypeError, "font_options must be a cairo.FontOptions or None");
- return NULL;
- }
- pango_cairo_context_set_font_options(PANGO_CONTEXT(context->obj), options);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-
-%%
-body
-
-static PyObject *
-pypango_cairo_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
-{
- PyObject *o;
- PycairoContext *ctx;
-
- if (!PyArg_ParseTuple(args, "O!:CairoContext.__new__",
- &PycairoContext_Type, &ctx))
- return NULL;
-
- cairo_reference(ctx->ctx);
- o = PycairoContext_FromContext(ctx->ctx, type, NULL);
- return o;
-}
-
-static PyObject *
-_wrap_pango_cairo_update_context(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "context", NULL };
- PyGObject *context;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!:CairoContext.update_context", kwlist,
- &PyPangoContext_Type, &context))
- return NULL;
- pango_cairo_update_context(PycairoContext_GET(self), PANGO_CONTEXT(context->obj));
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-_wrap_pango_cairo_create_layout(PyGObject *self)
-{
- PangoLayout *ret;
-
- ret = pango_cairo_create_layout(PycairoContext_GET(self));
- /* pygobject_new handles NULL checking */
- return pygobject_new((GObject *)ret);
-}
-
-static PyObject *
-_wrap_pango_cairo_update_layout(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "layout", NULL };
- PyGObject *layout;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!:CairoContext.update_layout",
- kwlist, &PyPangoLayout_Type, &layout))
- return NULL;
- pango_cairo_update_layout(PycairoContext_GET(self), PANGO_LAYOUT(layout->obj));
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-_wrap_pango_cairo_show_glyph_string(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "font", "glyphs", NULL };
- PyGObject *font;
- PangoGlyphString *glyphs = NULL;
- PyObject *py_glyphs;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!O:CairoContext.show_glyph_string",
- kwlist, &PyPangoFont_Type, &font, &py_glyphs))
- return NULL;
- if (pyg_boxed_check(py_glyphs, PANGO_TYPE_GLYPH_STRING))
- glyphs = pyg_boxed_get(py_glyphs, PangoGlyphString);
- else {
- PyErr_SetString(PyExc_TypeError, "glyphs should be a PangoGlyphString");
- return NULL;
- }
- pango_cairo_show_glyph_string(PycairoContext_GET(self), PANGO_FONT(font->obj), glyphs);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-_wrap_pango_cairo_show_layout_line(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "line", NULL };
- PangoLayoutLine *line = NULL;
- PyObject *py_line;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:CairoContext.show_layout_line",
- kwlist, &py_line))
- return NULL;
- if (pyg_boxed_check(py_line, PANGO_TYPE_LAYOUT_LINE))
- line = pyg_boxed_get(py_line, PangoLayoutLine);
- else {
- PyErr_SetString(PyExc_TypeError, "line should be a PangoLayoutLine");
- return NULL;
- }
- pango_cairo_show_layout_line(PycairoContext_GET(self), line);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-_wrap_pango_cairo_show_layout(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "layout", NULL };
- PyGObject *layout;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!:CairoContext.show_layout",
- kwlist, &PyPangoLayout_Type, &layout))
- return NULL;
- pango_cairo_show_layout(PycairoContext_GET(self), PANGO_LAYOUT(layout->obj));
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-_wrap_pango_cairo_glyph_string_path(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "font", "glyphs", NULL };
- PyGObject *font;
- PangoGlyphString *glyphs = NULL;
- PyObject *py_glyphs;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!O:CairoContext.glyph_string_path",
- kwlist, &PyPangoFont_Type, &font, &py_glyphs))
- return NULL;
- if (pyg_boxed_check(py_glyphs, PANGO_TYPE_GLYPH_STRING))
- glyphs = pyg_boxed_get(py_glyphs, PangoGlyphString);
- else {
- PyErr_SetString(PyExc_TypeError, "glyphs should be a PangoGlyphString");
- return NULL;
- }
- pango_cairo_glyph_string_path(PycairoContext_GET(self), PANGO_FONT(font->obj), glyphs);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-_wrap_pango_cairo_layout_line_path(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "line", NULL };
- PangoLayoutLine *line = NULL;
- PyObject *py_line;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:CairoContext.layout_line_path",
- kwlist, &py_line))
- return NULL;
- if (pyg_boxed_check(py_line, PANGO_TYPE_LAYOUT_LINE))
- line = pyg_boxed_get(py_line, PangoLayoutLine);
- else {
- PyErr_SetString(PyExc_TypeError, "line should be a PangoLayoutLine");
- return NULL;
- }
- pango_cairo_layout_line_path(PycairoContext_GET(self), line);
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyObject *
-_wrap_pango_cairo_layout_path(PyGObject *self, PyObject *args, PyObject *kwargs)
-{
- static char *kwlist[] = { "layout", NULL };
- PyGObject *layout;
-
- if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O!:CairoContext.layout_path",
- kwlist, &PyPangoLayout_Type, &layout))
- return NULL;
- pango_cairo_layout_path(PycairoContext_GET(self), PANGO_LAYOUT(layout->obj));
- Py_INCREF(Py_None);
- return Py_None;
-}
-
-static PyMethodDef _PyCairoContext_methods[] = {
- { "update_context", (PyCFunction)_wrap_pango_cairo_update_context, METH_VARARGS|METH_KEYWORDS },
- { "create_layout", (PyCFunction)_wrap_pango_cairo_create_layout, METH_NOARGS },
- { "update_layout", (PyCFunction)_wrap_pango_cairo_update_layout, METH_VARARGS|METH_KEYWORDS },
- { "show_glyph_string", (PyCFunction)_wrap_pango_cairo_show_glyph_string, METH_VARARGS|METH_KEYWORDS },
- { "show_layout_line", (PyCFunction)_wrap_pango_cairo_show_layout_line, METH_VARARGS|METH_KEYWORDS },
- { "show_layout", (PyCFunction)_wrap_pango_cairo_show_layout, METH_VARARGS|METH_KEYWORDS },
- { "glyph_string_path", (PyCFunction)_wrap_pango_cairo_glyph_string_path, METH_VARARGS|METH_KEYWORDS },
- { "layout_line_path", (PyCFunction)_wrap_pango_cairo_layout_line_path, METH_VARARGS|METH_KEYWORDS },
- { "layout_path", (PyCFunction)_wrap_pango_cairo_layout_path, METH_VARARGS|METH_KEYWORDS },
- { NULL, NULL, 0 }
-};
-
-
-PyTypeObject PyPangoCairoContext_Type = {
- PyObject_HEAD_INIT(NULL)
- 0, /* ob_size */
- "pangocairo.CairoContext", /* tp_name */
- 0, /* tp_basicsize */
- 0, /* tp_itemsize */
- /* methods */
- (destructor)0, /* tp_dealloc */
- (printfunc)0, /* tp_print */
- (getattrfunc)0, /* tp_getattr */
- (setattrfunc)0, /* tp_setattr */
- (cmpfunc)0, /* tp_compare */
- (reprfunc)0, /* tp_repr */
- 0, /* tp_as_number */
- 0, /* tp_as_sequence */
- 0, /* tp_as_mapping */
- (hashfunc)0, /* tp_hash */
- (ternaryfunc)0, /* tp_call */
- (reprfunc)0, /* tp_str */
- (getattrofunc)0, /* tp_getattro */
- (setattrofunc)0, /* tp_setattro */
- 0, /* tp_as_buffer */
- Py_TPFLAGS_DEFAULT, /* tp_flags */
- "A cairo.Context enhanced with some additional pango methods", /* Documentation string */
- (traverseproc)0, /* tp_traverse */
- (inquiry)0, /* tp_clear */
- (richcmpfunc)0, /* tp_richcompare */
- 0, /* tp_weaklistoffset */
- (getiterfunc)0, /* tp_iter */
- (iternextfunc)0, /* tp_iternext */
- _PyCairoContext_methods, /* tp_methods */
- 0, /* tp_members */
- 0, /* tp_getset */
- (PyTypeObject *)0, /* tp_base */
- (PyObject *)0, /* tp_dict */
- 0, /* tp_descr_get */
- 0, /* tp_descr_set */
- 0, /* tp_dictoffset */
- (initproc)0, /* tp_init */
- 0, /* tp_alloc */
- pypango_cairo_new, /* tp_new */
- 0, /* tp_free */
- (inquiry)0, /* tp_is_gc */
- (PyObject *)0, /* tp_bases */
-};
-
diff --git a/pangocairomodule.c b/pangocairomodule.c
deleted file mode 100644
index f9db189f..00000000
--- a/pangocairomodule.c
+++ /dev/null
@@ -1,70 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * pangomodule.c: module wrapping the Pango library
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
-#include <Python.h>
-#include <pygobject.h>
-
-#include <pango/pangocairo.h>
-#include <pycairo.h>
-
-/* include any extra headers needed here */
-
-void pypangocairo_register_classes(PyObject *d);
-void pypangocairo_add_constants(PyObject *module, const gchar *strip_prefix);
-
-extern PyMethodDef pypangocairo_functions[];
-extern PyTypeObject PyPangoCairoContext_Type;
-extern GType pypango_layout_line_type;
-
-Pycairo_CAPI_t *Pycairo_CAPI;
-
-
-DL_EXPORT(void)
-initpangocairo(void)
-{
- PyObject *m, *d;
-
- /* perform any initialisation required by the library here */
-
- m = Py_InitModule("pangocairo", pypangocairo_functions);
- d = PyModule_GetDict(m);
-
- Pycairo_IMPORT;
- if (Pycairo_CAPI == NULL)
- return;
-
- PyPangoCairoContext_Type.tp_base = &PycairoContext_Type;
- if (PyType_Ready(&PyPangoCairoContext_Type) < 0) {
- g_return_if_reached();
- }
- init_pygobject();
-
- pypangocairo_register_classes(d);
-
- Py_INCREF(&PyPangoCairoContext_Type);
- PyModule_AddObject(m, "CairoContext", (PyObject *)&PyPangoCairoContext_Type);
-
- pypango_layout_line_type = g_type_from_name("PangoLayoutLine");
-}
-
diff --git a/pangomodule.c b/pangomodule.c
deleted file mode 100644
index 439a86b9..00000000
--- a/pangomodule.c
+++ /dev/null
@@ -1,100 +0,0 @@
-/* -*- Mode: C; c-basic-offset: 4 -*-
- * pygtk- Python bindings for the GTK toolkit.
- * Copyright (C) 1998-2003 James Henstridge
- *
- * pangomodule.c: module wrapping the Pango library
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
- */
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
-#include <Python.h>
-#include <pygobject.h>
-
-#include <pango/pango-font.h>
-
-/* include any extra headers needed here */
-
-void pypango_register_classes(PyObject *d);
-void pypango_add_constants(PyObject *module, const gchar *strip_prefix);
-extern PyMethodDef pypango_functions[];
-
-#ifndef pyg_add_warning_redirection
-
-static void
-_log_func(const gchar *log_domain,
- GLogLevelFlags log_level,
- const gchar *message,
- gpointer user_data)
-{
- PyGILState_STATE state;
- PyObject* warning = user_data;
-
- state = pyg_gil_state_ensure();
- PyErr_Warn(warning, (char *) message);
- pyg_gil_state_release(state);
-}
-
-#endif
-
-
-DL_EXPORT(void)
-initpango(void)
-{
- PyObject *m, *d;
- PyObject *warning;
-
- /* perform any initialisation required by the library here */
-
- m = Py_InitModule("pango", pypango_functions);
- d = PyModule_GetDict(m);
-
- init_pygobject_check(2, 11, 1);
-
- /* set the default python encoding to utf-8 */
- PyUnicode_SetDefaultEncoding("utf-8");
-
- pypango_register_classes(d);
- pypango_add_constants(m, "PANGO_");
-
- PyModule_AddObject(m, "SCALE_XX_SMALL",
- PyFloat_FromDouble(PANGO_SCALE_XX_SMALL));
- PyModule_AddObject(m, "SCALE_X_SMALL",
- PyFloat_FromDouble(PANGO_SCALE_X_SMALL));
- PyModule_AddObject(m, "SCALE_SMALL",
- PyFloat_FromDouble(PANGO_SCALE_SMALL));
- PyModule_AddObject(m, "SCALE_MEDIUM",
- PyFloat_FromDouble(PANGO_SCALE_MEDIUM));
- PyModule_AddObject(m, "SCALE_LARGE",
- PyFloat_FromDouble(PANGO_SCALE_LARGE));
- PyModule_AddObject(m, "SCALE_X_LARGE",
- PyFloat_FromDouble(PANGO_SCALE_X_LARGE));
- PyModule_AddObject(m, "SCALE_XX_LARGE",
- PyFloat_FromDouble(PANGO_SCALE_XX_LARGE));
- PyModule_AddObject(m, "SCALE",
- PyInt_FromLong(PANGO_SCALE));
-
- /* add anything else to the module dictionary (such as constants) */
- warning = PyErr_NewException("pango.PangoWarning", PyExc_Warning, NULL);
- PyDict_SetItemString(d, "Warning", warning);
-#ifdef pyg_add_warning_redirection
- pyg_add_warning_redirection("Pango", warning);
-#else
- g_log_set_handler("Pango", G_LOG_LEVEL_CRITICAL|G_LOG_LEVEL_WARNING,
- _log_func, warning);
-#endif
-}
diff --git a/pygobject-2.0.pc.in b/pygobject-2.0.pc.in
deleted file mode 100644
index cb04d333..00000000
--- a/pygobject-2.0.pc.in
+++ /dev/null
@@ -1,20 +0,0 @@
-prefix=@prefix@
-exec_prefix=@exec_prefix@
-includedir=@includedir@
-datarootdir=@datarootdir@
-datadir=@datadir@
-
-# you can use the --variable=pygtkincludedir argument to
-# pkg-config to get this value. You might want to use this to
-# install additional headers.
-pygtkincludedir=${includedir}/pygtk-2.0
-
-# same here. Useful when calling the code generator in addon packages.
-defsdir=${datadir}/pygtk/2.0/defs
-codegendir=${datadir}/pygtk/2.0/codegen
-
-Name: PyGObject
-Description: Python bindings for GObject
-Requires: gobject-2.0
-Version: @VERSION@
-Cflags: -I${pygtkincludedir}
diff --git a/pygtk-2.0.pc.in b/pygtk-2.0.pc.in
deleted file mode 100644
index f5734c8b..00000000
--- a/pygtk-2.0.pc.in
+++ /dev/null
@@ -1,21 +0,0 @@
-prefix=@prefix@
-exec_prefix=@exec_prefix@
-includedir=@includedir@
-datarootdir=@datarootdir@
-datadir=@datadir@
-pyexecdir=@pyexecdir@
-
-# you can use the --variable=pygtkincludedir argument to
-# pkg-config to get this value. You might want to use this to
-# install additional headers.
-pygtkincludedir=${includedir}/pygtk-2.0
-
-# same here. Useful when calling the code generator in addon packages.
-defsdir=${datadir}/pygtk/2.0/defs
-codegendir=${datadir}/pygtk/2.0/codegen
-
-Name: PyGTK
-Description: Python bindings for GTK+ and related libraries
-Requires: pygobject-2.0
-Version: @VERSION@
-Cflags: -I${pygtkincludedir} @THREADING_CFLAGS@
diff --git a/pygtk.spec.in b/pygtk.spec.in
deleted file mode 100644
index b4a4356b..00000000
--- a/pygtk.spec.in
+++ /dev/null
@@ -1,127 +0,0 @@
-# -*- mode: rpm-spec -*-
-%define buildglade %(pkg-config libglade-2.0 && echo 1 || echo 0)
-%define python python2
-
-Summary: Python bindings for the GTK+ widget set.
-Name: pygtk2
-Version: @VERSION@
-Release: 1
-Copyright: LGPL
-Group: Development/Languages
-Source: ftp://ftp.gtk.org/pub/gtk/python/pygtk-%{version}.tar.gz
-BuildRoot: /var/tmp/pygtk-root
-Packager: James Henstridge <james@daa.com.au>
-Requires: gtk2 >= 2.0.0
-Requires: %{python} >= 2.2
-Buildrequires: %{python}-devel >= 2.2
-Buildrequires: libglade2-devel
-
-%description
-PyGTK is an extension module for python that gives you access to the GTK+
-widget set. Just about anything you can write in C with GTK+ you can write
-in python with PyGTK (within reason), but with all the benefits of python.
-
-%package libglade
-Summary: A wrapper for the libglade library for use with PyGTK
-Group: Development/Languages
-Requires: pygtk2 = %{version}
-
-%description libglade
-This module contains a wrapper for the libglade library. Libglade allows
-a program to construct its user interface from an XML description, which
-allows the programmer to keep the UI and program logic separate.
-
-%package devel
-Summary: files needed to build wrappers for GTK+ addon libraries
-Group: Development/Languages
-Requires: pygtk2 = %{version}
-
-%description devel
-This package contains files required to build wrappers for GTK+ addon
-libraries so that they interoperate with pygtk.
-
-%changelog
-* Thu Oct 31 2002 Matt Wilson <msw@redhat.com>
-- use libdir for .pc files
-
-* Wed Feb 27 2002 Matt Wilson <msw@redhat.com>
-- 1.99.8
-
-* Mon Jan 28 2002 Matt Wilson <msw@redhat.com>
-- added atkmodule.so to file list
-
-* Thu Oct 18 2001 Matt Wilson <msw@redhat.com>
-- fix devel filelist to match new header location
-
-* Mon Oct 15 2001 Matt Wilson <msw@redhat.com>
-- get the headers from their new version-specific location
-
-* Thu Oct 11 2001 Matt Wilson <msw@redhat.com>
-- fixed typo in devel filelist
-- added macro that tests to see if we have libglade2, make the
- filelist a condition of that
-- changed name to 'pygtk2' to avoid name conflict with pygtk
-
-%prep
-%setup -q -n pygtk-%{version}
-[ -x /usr/bin/python2.2 ] && export PYTHON=/usr/bin/python2.2
-./configure --prefix=%{_prefix}
-
-%build
-make
-
-%install
-rm -rf $RPM_BUILD_ROOT
-make DESTDIR=$RPM_BUILD_ROOT install
-find $RPM_BUILD_ROOT -type f -name "*.la" -exec rm -f {} ';'
-
-%files
-%defattr(644, root, root, 755)
-%{_prefix}/lib/python?.?/site-packages/pygtk.pth
-%{_prefix}/lib/python?.?/site-packages/pygtk.py*
-%dir %{_prefix}/lib/python?.?/site-packages/gtk-2.0
-%dir %{_prefix}/lib/python?.?/site-packages/gtk-2.0/gtk
-%{_prefix}/lib/python?.?/site-packages/gtk-2.0/gtk/__init__.py*
-%{_prefix}/lib/python?.?/site-packages/gtk-2.0/gtk/compat.*
-%{_prefix}/lib/python?.?/site-packages/gtk-2.0/gtk/keysyms.py*
-%{_prefix}/lib/python?.?/site-packages/gtk-2.0/dsextras*
-
-%defattr(755, root, root, 755)
-%{_prefix}/lib/python?.?/site-packages/gtk-2.0/atk.so
-%{_prefix}/lib/python?.?/site-packages/gtk-2.0/gobject.so
-%{_prefix}/lib/python?.?/site-packages/gtk-2.0/pango.so
-%{_prefix}/lib/python?.?/site-packages/gtk-2.0/gtk/_gtk.so
-
-%doc AUTHORS NEWS README MAPPING ChangeLog
-%doc examples
-
-%if %{buildglade}
-%files libglade
-%defattr(755, root, root, 755)
-%{_prefix}/lib/python?.?/site-packages/gtk-2.0/gtk/glade.so
-%endif
-
-%files devel
-%defattr(755, root, root, 755)
-%{_prefix}/bin/pygtk-codegen-2.0
-%defattr(644, root, root, 755)
-%dir %{_prefix}/include/pygtk-2.0
-%{_prefix}/include/pygtk-2.0/*.h
-%dir %{_prefix}/include/pygtk-2.0/pygtk
-%{_prefix}/include/pygtk-2.0/pygtk/*.h
-%{_libdir}/pkgconfig/pygtk-2.0.pc
-%dir %{_prefix}/share/pygtk
-%dir %{_prefix}/share/pygtk/2.0
-%dir %{_prefix}/share/pygtk/2.0/codegen
-%dir %{_prefix}/share/pygtk/2.0/defs
-%{_prefix}/share/pygtk/2.0/codegen/*
-%{_prefix}/share/pygtk/2.0/defs/atk.defs
-%{_prefix}/share/pygtk/2.0/defs/atk-types.defs
-%{_prefix}/share/pygtk/2.0/defs/pango.defs
-%{_prefix}/share/pygtk/2.0/defs/pango-types.defs
-%{_prefix}/share/pygtk/2.0/defs/gdk.defs
-%{_prefix}/share/pygtk/2.0/defs/gdk-types.defs
-%{_prefix}/share/pygtk/2.0/defs/gtk.defs
-%{_prefix}/share/pygtk/2.0/defs/gtk-types.defs
-%{_prefix}/share/pygtk/2.0/defs/gtk-extrafuncs.defs
-%{_prefix}/share/pygtk/2.0/defs/libglade.defs
diff --git a/pygtk_postinstall.py b/pygtk_postinstall.py
deleted file mode 100644
index 627bc12b..00000000
--- a/pygtk_postinstall.py
+++ /dev/null
@@ -1,108 +0,0 @@
-
-"""pygtk is now installed on your machine.
-
-Local configuration files were successfully updated."""
-
-import os, os.path, re, sys
-import distutils.sysconfig
-import distutils.file_util
-import distutils.errors
-
-PYGOBJECT_XSL_DIR = os.path.join('share', 'pygobject','xsl')
-PYGOBJECT_HTML_DIR = os.path.join('share', 'gtk-doc', 'html', 'pygobject')
-HTML_DIR = os.path.join('share', 'gtk-doc', 'html', 'pygtk')
-
-prefix_pattern=re.compile("^prefix=.*")
-exec_pattern=re.compile("^exec\s.*")
-codegendir_pattern=re.compile("^codegendir=.*")
-
-def replace_prefix(s):
- if prefix_pattern.match(s):
- s='prefix='+sys.prefix.replace("\\","/")+'\n'
- if exec_pattern.match(s):
- s=('exec '+sys.prefix+'\\python.exe '+
- '$codegendir/codegen.py \"$@\"\n').replace("\\","/")
- if codegendir_pattern.match(s):
- s=('codegendir='
- +distutils.sysconfig.get_python_lib().replace("\\","/")+
- '/gtk-2.0/codegen' + '\n')
- return s
-
-def copy_pygobject_css():
- # Copy style.css from pygobject docs to pygtk docs
- try:
- distutils.file_util.copy_file(
- os.path.normpath(os.path.join(sys.prefix, PYGOBJECT_HTML_DIR,
- 'style.css')),
- os.path.normpath(os.path.join(sys.prefix,HTML_DIR)))
- except distutils.errors.DistutilsFileError:
- # probably pygobject has not been installed yet
- pass
-
-
-
-def html_fixxref():
- sys.path.insert(0, os.path.normpath(os.path.join(sys.prefix,
- PYGOBJECT_XSL_DIR)))
- try:
- import fixxref
- fixxref.scan_index_dir(fixxref.DOCDIR)
- fixxref.fix_xrefs(os.path.normpath(os.path.join(sys.prefix,
- HTML_DIR)))
- except ImportError, e:
- pass
-
-# TODO : Check that shortcuts are created system-wide when the user
-# has admin rights (hint: see pywin32 postinstall)
-def create_shortcuts():
- progs_folder= get_special_folder_path("CSIDL_COMMON_PROGRAMS")
- site_packages_dir = os.path.join(sys.prefix , 'lib','site-packages')
-
- pygtk_shortcuts = os.path.join(progs_folder, 'PyGTK')
- if not os.path.isdir(pygtk_shortcuts):
- os.mkdir(pygtk_shortcuts)
-
- pygtk_doc_link=os.path.join(pygtk_shortcuts,
- 'PyGTK Documentation.lnk')
- if os.path.isfile(pygtk_doc_link):
- os.remove(pygtk_doc_link)
-
- create_shortcut(os.path.join(sys.prefix,'share','gtk-doc','html',
- 'pygtk','index.html'),
- 'PyGTK Documentation', pygtk_doc_link)
-
- homepage_link = os.path.join(pygtk_shortcuts,
- "PyGTK Home.lnk")
- if os.path.isfile(homepage_link):
- os.remove(homepage_link)
- create_shortcut("http://www.pygtk.org",'PyGTK Homepage', homepage_link)
-
-def remove_shortcuts():
- pygtk_shortcuts = os.path.join(
- get_special_folder_path('CSIDL_COMMON_PROGRAMS'), 'PyGTK')
- os.remove(os.path.join(pygtk_shortcuts,'PyGTK Documentation.lnk'))
- os.remove(os.path.join(pygtk_shortcuts,'PyGTK Home.lnk'))
- try:
- os.rmdir(pygtk_shortcuts)
- except OSError, e:
- # Directory is not empty, so leave it like that !
- pass
-
-if len(sys.argv) == 2:
- if sys.argv[1] == "-install":
- filenames=['lib/pkgconfig/pygtk-2.0.pc','bin/pygtk-codegen-2.0']
- for filename in filenames:
- pkgconfig_file = os.path.normpath(
- os.path.join(sys.prefix,filename))
-
- lines=open(pkgconfig_file).readlines()
- open(pkgconfig_file, 'w').writelines(map(replace_prefix,lines))
- copy_pygobject_css()
- html_fixxref()
- # TODO: Add an installer option for shortcut creation
- # create_shortcuts()
- print __doc__
- elif sys.argv[1] == "-remove":
- # remove_shortcuts()
- os.remove(os.path.normpath(
- os.path.join(sys.prefix,HTML_DIR,'style.css')))
diff --git a/setup.py b/setup.py
deleted file mode 100755
index 3c075c24..00000000
--- a/setup.py
+++ /dev/null
@@ -1,320 +0,0 @@
-#!/usr/bin/env python
-#
-# setup.py - distutils configuration for pygtk
-#
-# TODO:
-# pygtk.spec(.in)
-# install *.pyc for codegen
-#
-"""Python Bindings for the GTK Widget Set.
-
-PyGTK is a set of bindings for the GTK widget set. It provides an object
-oriented interface that is slightly higher level than the C one. It
-automatically does all the type casting and reference counting that you
-would have to do normally with the C API. You can find out more on the
-official homepage, http://www.daa.com.au/~james/pygtk/"""
-
-from distutils.command.build import build
-from distutils.core import setup
-import glob
-import os
-import sys
-
-from dsextras import get_m4_define, getoutput, have_pkgconfig, \
- pkgc_version_check, \
- GLOBAL_INC, GLOBAL_MACROS, InstallLib, InstallData, BuildExt, \
- PkgConfigExtension, Template, TemplateExtension
-
-
-if '--yes-i-know-its-not-supported' in sys.argv:
- sys.argv.remove('--yes-i-know-its-not-supported')
-else:
- print '*'*70
- print 'Building PyGTK using distutils is NOT SUPPORTED.'
- print "It's mainly included to be able to easily build win32 installers"
- print "You may continue, but only if you agree to not ask any questions"
- print "To build PyGTK in a supported way, read the INSTALL file"
- print
- print "Build fixes are of course welcome and should be filed in bugzilla"
- print '*'*70
- input = raw_input('Not supported, ok [y/N]? ')
- if not input.startswith('y'):
- raise SystemExit
-
- if sys.version_info[:3] < (2, 3, 5):
- raise SystemExit, \
- "Python 2.3.5 or higher is required, %d.%d.%d found" % sys.version_info[:3]
-
-MAJOR_VERSION = int(get_m4_define('pygtk_major_version'))
-MINOR_VERSION = int(get_m4_define('pygtk_minor_version'))
-MICRO_VERSION = int(get_m4_define('pygtk_micro_version'))
-
-VERSION = "%d.%d.%d" % (MAJOR_VERSION, MINOR_VERSION, MICRO_VERSION)
-
-GOBJECT_REQUIRED = get_m4_define('glib_required_version')
-ATK_REQUIRED = get_m4_define('atk_required_version')
-PANGO_REQUIRED = get_m4_define('pango_required_version')
-GTK_REQUIRED = get_m4_define('gtk_required_version')
-LIBGLADE_REQUIRED = get_m4_define('libglade_required_version')
-PYCAIRO_REQUIRED = get_m4_define('pycairo_required_version')
-
-PYGTK_SUFFIX = '2.0'
-PYGTK_SUFFIX_LONG = 'gtk-' + PYGTK_SUFFIX
-
-GLOBAL_INC += ['.', 'gtk']
-GLOBAL_MACROS += [('PYGTK_MAJOR_VERSION', MAJOR_VERSION),
- ('PYGTK_MINOR_VERSION', MINOR_VERSION),
- ('PYGTK_MICRO_VERSION', MICRO_VERSION)]
-
-if sys.platform == 'win32':
- GLOBAL_MACROS.append(('VERSION', '"""%s"""' % VERSION))
- GLOBAL_MACROS.append(('PLATFORM_WIN32',1))
- GLOBAL_MACROS.append(('HAVE_BIND_TEXTDOMAIN_CODESET',1))
-else:
- GLOBAL_MACROS.append(('VERSION', '"%s"' % VERSION))
-
-DEFS_DIR = os.path.join('share', 'pygtk', PYGTK_SUFFIX, 'defs')
-CODEGEN_DIR = os.path.join('share', 'pygtk', PYGTK_SUFFIX, 'codegen')
-INCLUDE_DIR = os.path.join('include', 'pygtk-%s' % PYGTK_SUFFIX)
-HTML_DIR = os.path.join('share', 'gtk-doc', 'html', 'pygtk')
-
-class PyGtkInstallLib(InstallLib):
- def run(self):
-
- # Install pygtk.pth, pygtk.py[c] and templates
- self.install_pth()
-
- # Modify the base installation dir
- install_dir = os.path.join(self.install_dir, PYGTK_SUFFIX_LONG)
- self.set_install_dir(install_dir)
-
- InstallLib.run(self)
-
- def install_pth(self):
- """Write the pygtk.pth file"""
- file = os.path.join(self.install_dir, 'pygtk.pth')
- self.mkpath(self.install_dir)
- open(file, 'w').write(PYGTK_SUFFIX_LONG)
- self.local_outputs.append(file)
- self.local_inputs.append('pygtk.pth')
-
-class PyGtkInstallData(InstallData):
- def run(self):
- self.add_template_option('VERSION', VERSION)
- self.prepare()
-
- # Install templates
- self.install_templates()
-
- InstallData.run(self)
-
- def install_templates(self):
- file = self.install_template('codegen/pygtk-codegen-2.0.in',
- os.path.join(self.install_dir, 'bin'))
- os.chmod(file, 0755)
- self.install_template('pygtk-2.0.pc.in',
- os.path.join(self.install_dir,
- 'lib','pkgconfig'))
-
-class PyGtkBuild(build):
- enable_threading = 1
-PyGtkBuild.user_options.append(('enable-threading', None,
- 'enable threading support'))
-
-# Atk
-atk = TemplateExtension(name='atk', pkc_name='atk',
- pkc_version=ATK_REQUIRED,
- sources=['atkmodule.c', 'atk.c'],
- register=['atk-types.defs'],
- override='atk.override',
- defs='atk.defs',
- py_ssize_t_clean=True)
-# Pango
-pango = TemplateExtension(name='pango', pkc_name='pango',
- pkc_version=PANGO_REQUIRED,
- sources=['pango.c', 'pangomodule.c'],
- register=['pango-types.defs'],
- override='pango.override',
- defs='pango.defs',
- py_ssize_t_clean=True)
-# Pangocairo
-pangocairo = TemplateExtension(name='pangocairo',
- pkc_name=('pycairo', 'pangocairo'),
- pkc_version=(PYCAIRO_REQUIRED,
- PANGO_REQUIRED),
- sources=['pangocairo.c', 'pangocairomodule.c'],
- register=['pango-types.defs'],
- override='pangocairo.override',
- defs='pangocairo.defs',
- py_ssize_t_clean=True)
-
-# Gdk (template only)
-gdk_template = Template('gtk/gdk.override', 'gtk/gdk.c',
- defs=('gtk/gdk.defs',
- ['gtk/gdk-2.10.defs','gtk/gdk-base.defs']),
- prefix='pygdk',
- register=['atk-types.defs',
- 'pango-types.defs',
- ('gtk/gdk-types.defs',
- ['gtk/gdk-base-types.defs'])],
- py_ssize_t_clean=True)
-# Gtk+
-if pangocairo.can_build():
- gtk_pkc_name=('gtk+-2.0','pycairo')
- gtk_pkc_version=(GTK_REQUIRED,PYCAIRO_REQUIRED)
-else:
- gtk_pkc_name='gtk+-2.0'
- gtk_pkc_version=GTK_REQUIRED
-
-if pkgc_version_check('gtk+-2.0', '2.10.0'):
- gtk_pkc_defs=('gtk/gtk.defs',['gtk/gtk-2.10.defs','gtk/gtk-base.defs'])
- gtk_pkc_register=['pango-types.defs',
- ('gtk/gdk-types.defs',['gtk/gdk-base-types.defs']),
- ('gtk/gtk-types.defs',['gtk/gtk-base-types.defs',
- 'gtk/gtk-2.10-types.defs'])]
- libglade_pkc_register=[('gtk/gtk-types.defs',
- ['gtk/gtk-base-types.defs',
- 'gtk/gtk-2.10-types.defs']),
- 'gtk/libglade.defs']
-else:
- gtk_pkc_defs=('gtk/gtk.defs',['gtk/gtk-base.defs'])
- gtk_pkc_register=['pango-types.defs',
- ('gtk/gdk-types.defs',['gtk/gdk-base-types.defs']),
- ('gtk/gtk-types.defs',['gtk/gtk-base-types.defs'])]
- libglade_pkc_register=[('gtk/gtk-types.defs',['gtk/gtk-base-types.defs']),
- 'gtk/libglade.defs']
-
-gtk = TemplateExtension(name='gtk', pkc_name=gtk_pkc_name,
- pkc_version=gtk_pkc_version,
- output='gtk._gtk',
- sources=['gtk/gtkmodule.c',
- 'gtk/gtkobject-support.c',
- 'gtk/gtk-types.c',
- 'gtk/pygtktreemodel.c',
- 'gtk/pygtkcellrenderer.c',
- 'gtk/gdk.c',
- 'gtk/gtk.c'],
- register=gtk_pkc_register,
- override='gtk/gtk.override',
- defs=gtk_pkc_defs,
- py_ssize_t_clean=True)
-gtk.templates.append(gdk_template)
-
-# Libglade
-libglade = TemplateExtension(name='libglade', pkc_name='libglade-2.0',
- pkc_version=LIBGLADE_REQUIRED,
- output='gtk.glade',
- defs='gtk/libglade.defs',
- sources=['gtk/libglademodule.c',
- 'gtk/libglade.c'],
- register=libglade_pkc_register,
- override='gtk/libglade.override',
- py_ssize_t_clean=True)
-
-data_files = []
-ext_modules = []
-py_modules = []
-packages = ['codegen']
-
-if not have_pkgconfig():
- print "Error, could not find pkg-config"
- raise SystemExit
-
-if atk.can_build():
- ext_modules.append(atk)
- data_files.append((DEFS_DIR, ('atk.defs', 'atk-types.defs')))
-if pango.can_build():
- ext_modules.append(pango)
- data_files.append((DEFS_DIR, ('pango.defs', 'pango-types.defs')))
- if pangocairo.can_build():
- ext_modules.append(pangocairo)
- data_files.append((DEFS_DIR, ('pangocairo.defs',)))
- GLOBAL_MACROS.append(('HAVE_PYCAIRO',1))
-if gtk.can_build():
- if '--disable-numeric' in sys.argv:
- sys.argv.remove('--disable-numeric')
- else:
- try:
- import Numeric
- Numeric # pyflakes
- GLOBAL_MACROS.append(('HAVE_NUMPY', 1))
- except ImportError:
- print ('* Numeric module could not be found, '
- 'will build without Numeric support.')
- ext_modules.append(gtk)
- data_files.append((os.path.join(INCLUDE_DIR, 'pygtk'), ('gtk/pygtk.h',)))
- data_files.append((DEFS_DIR, ('gtk/gdk.defs', 'gtk/gdk-types.defs',
- 'gtk/gdk-base.defs',
- 'gtk/gdk-base-types.defs',
- 'gtk/gtk.defs', 'gtk/gtk-types.defs',
- 'gtk/gtk-2.10.defs',
- 'gtk/gtk-2.10-types.defs',
- 'gtk/gtk-base.defs',
- 'gtk/gtk-base-types.defs',
- 'gtk/gtk-extrafuncs.defs')))
- data_files.append((HTML_DIR, glob.glob('docs/html/*.html')))
- py_modules += ['gtk.compat', 'gtk.deprecation', 'gtk.keysyms',
- 'gtk._lazyutils']
-
-if libglade.can_build():
- ext_modules.append(libglade)
- data_files.append((DEFS_DIR, ('gtk/libglade.defs',)))
-
-# Threading support
-if '--disable-threading' in sys.argv:
- sys.argv.remove('--disable-threading')
- enable_threading = False
-else:
- if '--enable-threading' in sys.argv:
- sys.argv.remove('--enable-threading')
- try:
- import thread
- thread # pyflakes
- except ImportError:
- print "Warning: Could not import thread module, disabling threading"
- enable_threading = False
- else:
- enable_threading = True
-
-if enable_threading:
- name = 'gthread-2.0'
- for module in ext_modules:
- raw = getoutput('pkg-config --libs-only-l %s' % name)
- for arg in raw.split():
- if arg.startswith('-l'):
- module.libraries.append(arg[2:])
- else:
- module.extra_link_args.append(arg)
- raw = getoutput('pkg-config --cflags-only-I %s' % name)
- for arg in raw.split():
- if arg.startswith('-I'):
- module.include_dirs.append(arg[2:])
- else:
- module.extra_compile_args.append(arg)
-else:
- GLOBAL_MACROS.append(('DISABLE_THREADING', 1))
-
-
-doclines = __doc__.split("\n")
-
-options = {"bdist_wininst": {"install_script": "pygtk_postinstall.py"}}
-
-setup(name="pygtk",
- url='http://www.daa.com.au/~james/pygtk/',
- version=VERSION,
- license='LGPL',
- platforms=['yes'],
- maintainer="James Henstridge",
- maintainer_email="james@daa.com.au",
- description = doclines[0],
- long_description = "\n".join(doclines[2:]),
- py_modules=py_modules,
- packages=packages,
- ext_modules=ext_modules,
- data_files=data_files,
- scripts = ["pygtk_postinstall.py"],
- options=options,
- cmdclass={'install_lib': PyGtkInstallLib,
- 'install_data': PyGtkInstallData,
- 'build_ext': BuildExt,
- 'build': PyGtkBuild})
diff --git a/tests/Makefile.am b/tests/Makefile.am
deleted file mode 100644
index 5c259064..00000000
--- a/tests/Makefile.am
+++ /dev/null
@@ -1,33 +0,0 @@
-EXTRA_DIST = $(tests) common.py runtests.py testmodule.py leak.glade
-
-tests = \
- test_actiongroup.py \
- test_api.py \
- test_container.py
- test_conversion.py \
- test_dialog.py \
- test_enum.py \
- test_gdk.py \
- test_glade.py \
- test_liststore.py
- test_pango.py \
- test_radiobutton.py \
- test_style.py \
- test_textview.py \
- test_treeview.py
-
-GTK_PY_FILES = __init__.py _lazyutils.py compat.py deprecation.py keysyms.py
-
-check-local: $(top_srcdir)/gtk/__init__.py
- @if test "$(top_builddir)" != "$(top_srcdir)"; then \
- for gtk_py in $(GTK_PY_FILES) ; do \
- cp $(top_srcdir)/gtk/$${gtk_py} $(top_builddir)/gtk/; \
- done \
- fi
- @$(PYTHON) $(srcdir)/runtests.py $(top_builddir) $(top_srcdir)
- @if test "$(top_builddir)" != "$(top_srcdir)"; then \
- for gtk_py in $(GTK_PY_FILES) ; do \
- rm -f $(top_builddir)/gtk/$${gtk_py}*; \
- done \
- fi
- @rm -fr *.pyc
diff --git a/tests/common.py b/tests/common.py
deleted file mode 100644
index dfc34012..00000000
--- a/tests/common.py
+++ /dev/null
@@ -1,68 +0,0 @@
-import os
-import sys
-
-import gobject
-
-def importModules(buildDir, srcDir):
- # Be very careful when you change this code, it's
- # fragile and the order is really significant
-
- # ltihooks
- sys.path.insert(0, srcDir)
- # atk, pango
- sys.path.insert(0, buildDir)
- # _gtk, keysyms, glade
- sys.path.insert(0, os.path.join(buildDir, 'gtk'))
- sys.argv.append('--g-fatal-warnings')
- import ltihooks
-
- atk = importModule('atk', buildDir)
- pango = importModule('pango', buildDir)
- gtk = importModule('gtk', buildDir, 'gtk')
- gdk = importModule('gtk.gdk', buildDir, '_gdk.la')
-
- # gtk/__init__.py removes the ltihooks, readd them
- import gtk
-
- ltihooks.install()
- glade = importModule('gtk.glade', buildDir)
-
- ltihooks.uninstall()
- del ltihooks
-
- globals().update(locals())
-
- os.environ['PYGTK_USE_GIL_STATE_API'] = ''
- gobject.threads_init()
-
-def importModule(module, directory, name=None):
- global isDistCheck
-
- origName = module
- if '.' in module:
- fromlist = '.'.join(module.split('.')[:-1])
- else:
- fromlist = None
-
- if not name:
- name = module + '.la'
-
- try:
- obj = __import__(module, {}, {}, fromlist)
- except ImportError:
- raise
-
- if hasattr(obj, '__file__'):
- location = obj.__file__
- else:
- package = __import__(fromlist)
- location = os.path.join(package.__file__, name)
-
- current = os.getcwd()
- expected = os.path.abspath(os.path.join(current, location))
- current = os.path.abspath(location)
- if current != expected:
- raise AssertionError('module %s imported from wrong location. Expected %s, got %s' % (
- module, expected, current))
-
- return obj
diff --git a/tests/leak.glade b/tests/leak.glade
deleted file mode 100644
index 50161c0a..00000000
--- a/tests/leak.glade
+++ /dev/null
@@ -1,29 +0,0 @@
-<?xml version="1.0" standalone="no"?> <!--*- mode: xml -*-->
-<!DOCTYPE glade-interface SYSTEM "http://glade.gnome.org/glade-2.0.dtd">
-
-<glade-interface>
-
-<widget class="GtkWindow" id="window1">
- <property name="border_width">25</property>
- <property name="visible">True</property>
- <property name="title" translatable="yes">window1</property>
- <property name="type">GTK_WINDOW_TOPLEVEL</property>
- <property name="window_position">GTK_WIN_POS_NONE</property>
- <property name="modal">False</property>
- <property name="resizable">True</property>
- <property name="destroy_with_parent">False</property>
- <property name="decorated">True</property>
- <property name="skip_taskbar_hint">False</property>
- <property name="skip_pager_hint">False</property>
- <property name="type_hint">GDK_WINDOW_TYPE_HINT_NORMAL</property>
- <property name="gravity">GDK_GRAVITY_NORTH_WEST</property>
- <property name="focus_on_map">True</property>
- <property name="urgency_hint">False</property>
- <signal name="destroy" handler="on_window1_destroy" last_modification_time="Sun, 25 Sep 2005 14:22:00 GMT"/>
-
- <child>
- <placeholder/>
- </child>
-</widget>
-
-</glade-interface>
diff --git a/tests/runtests.py b/tests/runtests.py
deleted file mode 100644
index 7c5a3086..00000000
--- a/tests/runtests.py
+++ /dev/null
@@ -1,44 +0,0 @@
-#!/usr/bin/env python
-import glob
-import os
-import sys
-import unittest
-
-import common
-
-program = None
-if len(sys.argv) == 3:
- buildDir = sys.argv[1]
- srcDir = sys.argv[2]
-else:
- if len(sys.argv) == 2:
- program = sys.argv[1]
- if program.endswith('.py'):
- program = program[:-3]
- buildDir = '..'
- srcDir = '.'
-
-common.importModules(buildDir=buildDir,
- srcDir=srcDir)
-
-SKIP_FILES = ['common', 'runtests', 'testmodule']
-
-dir = os.path.split(os.path.abspath(__file__))[0]
-os.chdir(dir)
-
-def gettestnames():
- files = glob.glob('*.py')
- names = map(lambda x: x[:-3], files)
- map(names.remove, SKIP_FILES)
- return names
-
-suite = unittest.TestSuite()
-loader = unittest.TestLoader()
-
-for name in gettestnames():
- if program and program not in name:
- continue
- suite.addTest(loader.loadTestsFromName(name))
-
-testRunner = unittest.TextTestRunner()
-testRunner.run(suite)
diff --git a/tests/test_actiongroup.py b/tests/test_actiongroup.py
deleted file mode 100644
index a4fb97d8..00000000
--- a/tests/test_actiongroup.py
+++ /dev/null
@@ -1,129 +0,0 @@
-# Test for Bug #162874
-
-import gc
-import unittest
-
-from common import gtk, gobject
-
-
-class ActionGroupTest(unittest.TestCase):
- ui0 = '''<ui>
- <menubar name="MenuBar">
- <menu action="File">
- <menuitem action="Quit"/>
- </menu>
- <menu action="Sound">
- <menuitem action="Mute"/>
- </menu>
- <menu action="RadioBand">
- <menuitem action="AM"/>
- <menuitem action="FM"/>
- <menuitem action="SSB"/>
- </menu>
- </menubar>
- <toolbar name="Toolbar">
- <toolitem action="Quit"/>
- <separator/>
- <toolitem action="Mute"/>
- <separator name="sep1"/>
- <placeholder name="RadioBandItems">
- <toolitem action="AM"/>
- <toolitem action="FM"/>
- <toolitem action="SSB"/>
- </placeholder>
- </toolbar>
- </ui>'''
-
- def build_gui(self):
- # Create the toplevel window
- window = gtk.Window()
- vbox = gtk.VBox()
- window.add(vbox)
-
- # Create a UIManager instance
- uimanager = gtk.UIManager()
- self.uimanager = uimanager
-
- # Create the base ActionGroup
- actiongroup = gtk.ActionGroup('UIMergeExampleBase')
-
- actiongroup.add_actions([('File', None, '_File'),
- ('Sound', None, '_Sound'),
- ('RadioBand', None, '_Radio Band')])
- uimanager.insert_action_group(actiongroup, 0)
-
- # Create an ActionGroup
- actiongroup0 = gtk.ActionGroup('UIMergeExample0')
-
- # Create a ToggleAction, etc.
- actiongroup0.add_toggle_actions([('Mute', None, '_Mute', '<Control>m',
- 'Mute the volume', self.cb)])
-
- # Create actions
- actiongroup0.add_actions([('Quit', gtk.STOCK_QUIT, '_Quit me!', None,
- 'Quit the Program', self.cb)])
-
- # Create some RadioActions
- actiongroup0.add_radio_actions([('AM', None, '_AM', '<Control>a',
- 'AM Radio', 0),
- ('FM', None, '_FM', '<Control>f',
- 'FM Radio', 1),
- ('SSB', None, '_SSB', '<Control>b',
- 'SSB Radio', 2),
- ], 0, self.cb)
-
- # Add the actiongroup to the uimanager
- uimanager.insert_action_group(actiongroup0, 1)
-
- self.ag0 = actiongroup0
- del actiongroup0
-
- # Add a UI description
- self.merge_id0 = uimanager.add_ui_from_string(self.ui0)
-
- # Create a MenuBar
- menubar = uimanager.get_widget('/MenuBar')
- vbox.pack_start(menubar, False)
-
- # Create a Toolbar
- toolbar = uimanager.get_widget('/Toolbar')
- vbox.pack_start(toolbar, False)
-
- gobject.timeout_add(50, self.timeout_cb)
-
- gtk.main()
- return
-
- def timeout_cb(self):
- ag0 = self.ag0
- uimanager = self.uimanager
- del self.ag0, self.uimanager
-
- uimanager.remove_ui(self.merge_id0)
- uimanager.remove_action_group(ag0)
-
- gc.collect() # Clean out unreachable objects
-
- del ag0
- self.assertEqual(gc.collect(), 1) # Collect just the ActionGroup
-
- uimanager.ensure_update()
- self.assertEqual(gc.collect(), 6) # Now the GtkActions have lost their last
- # GObject reference; they should be collected.
- # We have a ToggleAction, an Action and a
- # RadioAction, plus self.cb is bound in three
- # closures.
-
- gtk.main_quit()
-
- def setUp(self):
- gc.collect()
-
- def testActionGroups(self):
- self.build_gui()
-
- def cb(self, action):
- return
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/tests/test_api.py b/tests/test_api.py
deleted file mode 100644
index 77984a9e..00000000
--- a/tests/test_api.py
+++ /dev/null
@@ -1,36 +0,0 @@
-import os
-import sys
-import unittest
-
-from common import gobject, gtk, glade
-
-class APITest(unittest.TestCase):
- def testKeysyms(self):
- self.failUnless('Escape' in dir(gtk.keysyms))
- self.failUnless(hasattr(gtk.keysyms, 'Escape'))
- self.assertEqual(gtk.keysyms.Escape, 0xFF1B)
-
- def testWindow(self):
- self.failUnless(hasattr(gtk, 'Window'))
- self.failUnless(issubclass(gtk.Window, gobject.GObject))
- self.failUnless(issubclass(gtk.Window, gtk.Object))
- self.failUnless(issubclass(gtk.Window, gtk.Widget))
- self.failUnless(issubclass(gtk.Window, gtk.Container))
- self.failUnless(issubclass(gtk.Window, gtk.Bin))
- w = gtk.Window()
- self.failUnless(isinstance(w, gtk.Window))
-
- def testAccelLabel(self):
- ra = gtk.RadioMenuItem(None, 'label')
- self.failUnless(hasattr(ra.get_child(), 'get_text'))
- self.assertEqual(ra.get_child().get_text(), 'label')
-
- def testGlade(self):
- self.failUnless(hasattr(glade, 'XML'))
- self.failUnless(issubclass(glade.XML, gobject.GObject))
-
- def testReload(self):
- # test for #349026
- del sys.modules['gtk']
- import gtk
- reload(gtk)
diff --git a/tests/test_container.py b/tests/test_container.py
deleted file mode 100644
index a970fa44..00000000
--- a/tests/test_container.py
+++ /dev/null
@@ -1,56 +0,0 @@
-import unittest
-
-from common import gtk, gobject
-
-class MyContainer(gtk.Container):
- __gtype_name__ = 'MyContainer'
- def __init__(self):
- gtk.Container.__init__(self)
- self.children = []
- self.props = {}
-
- def do_add(self, child):
- child.set_parent(self)
- self.children.append(child)
- self.props[child] = '' # we just have one child property
-
- def do_remove(self, child):
- widget_was_visible = child.flags() & gtk.VISIBLE
- child.unparent()
- self.children.remove(child)
- del self.props[child]
-
- if widget_was_visible:
- self.queue_resize()
-
- def do_forall(self, internal, callback, data):
- for child in self.children:
- callback(child, data)
-
- def do_set_child_property(self, child, property_id, value, pspec):
- if pspec.name == 'dumb-prop':
- self.props[child] = value
-
- def do_get_child_property(self, child, property_id, pspec):
- if pspec.name == 'dumb-prop':
- return self.props[child]
-
-MyContainer.install_child_property(1,
- ('dumb_prop',
- gobject.TYPE_STRING,
- 'Dumb Prop',
- 'Dumb Property for testing purposes',
- '', gobject.PARAM_READWRITE))
-
-class ContainerTest(unittest.TestCase):
-
- def testChildProperties(self):
- obj = MyContainer()
- label = gtk.Label()
- obj.add(label)
- v = 'dumb value'
- obj.child_set_property(label, 'dumb_prop', v)
- self.assertEqual(v, obj.child_get_property(label, 'dumb_prop'))
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/tests/test_conversion.py b/tests/test_conversion.py
deleted file mode 100644
index 30d29df8..00000000
--- a/tests/test_conversion.py
+++ /dev/null
@@ -1,83 +0,0 @@
-# -*- Mode: Python -*-
-
-import unittest
-
-from common import gtk, gobject
-
-class Tests(unittest.TestCase):
-
- def testUnicharArg(self):
- """ Test unichar values when used as arguments. """
-
- entry = gtk.Entry()
- for valid_value in ['a', u'b', u'\ufff0', u'\ufff0'.encode()]:
- entry.set_invisible_char(valid_value)
- self.assertEqual(entry.get_invisible_char(),
- unicode(valid_value),
- valid_value)
-
- for invalid_value in ('12', None, 1, ''):
- try:
- entry.set_invisible_char(invalid_value)
- except:
- pass
- else:
- raise AssertionError(
- 'exception not raised on invalid value w/ '
- 'set_invisible_char: %s' % invalid_value)
-
-
- def testUnicharProperty(self):
- """ Test unichar values when used as properties. """
-
- entry = gtk.Entry()
- for valid_value in ['a', u'b', u'\ufff0', u'\ufff0'.encode()]:
- entry.set_property('invisible_char', valid_value)
- self.assertEqual(entry.get_property('invisible_char'),
- valid_value, valid_value)
-
- for invalid_value in ('12', None, 1, ''):
- try:
- entry.set_property('invisible_char', invalid_value)
- except TypeError:
- pass
- else:
- raise AssertionError(
- 'exception not raised on invalid value w/ '
- 'set_invisible_char: %s' % invalid_value)
-
- def testUnicharConstructor(self):
- for valid_value in ['a', u'b', u'\ufff0', u'\ufff0'.encode()]:
- entry = gobject.new(gtk.Entry, invisible_char=valid_value)
- self.assertEqual(entry.get_property('invisible_char'),
- valid_value, valid_value)
-
- def testColorCreation(self):
- """ Test GdkColor creation """
-
- c = gtk.gdk.Color(1, 2, 3)
- self.assertEqual(c.red, 1)
- self.assertEqual(c.green, 2)
- self.assertEqual(c.blue, 3)
-
- c = gtk.gdk.Color(pixel=0xffff)
- self.assertEqual(c.pixel, 0xffff)
-
- c = gtk.gdk.Color(pixel=0xffffL)
- self.assertEqual(c.pixel, 0xffff)
-
- c = gtk.gdk.Color(pixel=0xffffffffL)
- self.assertEqual(c.pixel, 0xffffffffL)
-
- def testUIntArg(self):
- child = gtk.DrawingArea()
- table = gtk.Table(2, 2, False)
- table.attach(child, 1, 2, 0, 1, ypadding=2)
- self.assertEqual(table.child_get_property(child, 'y-padding'), 2)
-
- child = gtk.DrawingArea()
- table.attach(child, 1, 2, 0, 1, ypadding=2L)
- self.assertEqual(table.child_get_property(child, 'y-padding'), 2)
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/tests/test_dialog.py b/tests/test_dialog.py
deleted file mode 100644
index 9102af65..00000000
--- a/tests/test_dialog.py
+++ /dev/null
@@ -1,35 +0,0 @@
-import sys
-import unittest
-import gc
-import weakref
-
-from common import gtk
-
-class MessageDialogTest(unittest.TestCase):
- def testDialogAdd(self):
- dialog = gtk.MessageDialog()
-
- response_id = sys.maxint + 1
- self.assertRaises(OverflowError, dialog.add_button, "Foo", response_id)
- self.assertRaises(OverflowError, dialog.add_buttons, "Foo", response_id)
-
- def testSubclass(self):
- # Normal subclassing should not register a type
- sub = type('sub', (gtk.MessageDialog,), {})
- self.assertEqual(sub.__gtype__.name, 'GtkMessageDialog')
-
- # This depends on 311254
- #type('Sub', (gtk.MessageDialog,), {'__gtype_name__': 'SubDialog'})
- #self.assertEqual(sub.__gtype__.name, 'SubDialog')
-
- def testDialogLeak(self):
- dlg = gtk.Dialog()
- dlg.destroy()
- ref = weakref.ref(dlg)
- del dlg
- while gc.collect():
- pass
- self.assertEqual(ref(), None)
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/tests/test_enum.py b/tests/test_enum.py
deleted file mode 100644
index 8f02250a..00000000
--- a/tests/test_enum.py
+++ /dev/null
@@ -1,229 +0,0 @@
-import unittest
-import warnings
-
-from gobject import GEnum, GFlags, GObject, GType, PARAM_READWRITE
-from common import gobject, atk, gtk, gdk
-
-class PObject(GObject):
- __gproperties__ = {
- 'enum': (gtk.WindowType, 'blurb', 'description',
- gtk.WINDOW_TOPLEVEL, PARAM_READWRITE),
- 'enum2': (gtk.WindowType, 'blurb', 'description',
- int(gtk.WINDOW_TOPLEVEL), PARAM_READWRITE),
- 'flags': (gtk.AttachOptions, 'blurb', 'description',
- gtk.EXPAND, PARAM_READWRITE),
- 'flags2': (gtk.AttachOptions, 'blurb', 'description',
- int(gtk.EXPAND), PARAM_READWRITE),
- }
-
-class EnumTest(unittest.TestCase):
- def testEnums(self):
- self.failUnless(issubclass(GEnum, int))
- self.failUnless(isinstance(atk.LAYER_OVERLAY, atk.Layer))
- self.failUnless(isinstance(atk.LAYER_OVERLAY, int))
- self.failUnless('LAYER_OVERLAY' in repr(atk.LAYER_OVERLAY))
- self.failUnless(int(atk.LAYER_OVERLAY))
- self.assertEquals(atk.LAYER_INVALID, 0)
- self.assertNotEquals(atk.LAYER_INVALID, 1)
- self.assertNotEquals(atk.LAYER_INVALID, -1)
- self.assertNotEquals(atk.LAYER_INVALID, atk.LAYER_BACKGROUND)
-
- def testComparisionWarning(self):
- warnings.filterwarnings("error", "", Warning, "", 0)
- try:
- self.assertNotEquals(atk.LAYER_INVALID, atk.RELATION_NULL)
- except Warning:
- pass
- else:
- raise AssertionError
- warnings.resetwarnings()
-
- def testWindowGetState(self):
- win = gtk.Window()
- win.realize()
-
- state = win.window.get_state()
- self.assertEquals(state, gdk.WINDOW_STATE_WITHDRAWN)
- self.failUnless(isinstance(state, gdk.WindowState))
- self.failUnless('WINDOW_STATE_WITHDRAWN' in repr(state))
-
- def testProperty(self):
- win = gtk.Window()
-
- wtype = win.get_property('type')
- self.assertEquals(wtype, gtk.WINDOW_TOPLEVEL)
- self.failUnless(isinstance(wtype, gtk.WindowType))
- self.failUnless('WINDOW_TOPLEVEL' in repr(wtype))
-
- def testAtkObj(self):
- obj = atk.NoOpObject(GObject())
- self.assertEquals(obj.get_role(), atk.ROLE_INVALID)
-
- def testGParam(self):
- win = gtk.Window()
- enums = filter(lambda x: GType.is_a(x.value_type, GEnum),
- gobject.list_properties(win))
- self.failUnless(enums)
- enum = enums[0]
- self.failUnless(hasattr(enum, 'enum_class'))
- self.failUnless(issubclass(enum.enum_class, GEnum))
-
- def testWeirdEnumValues(self):
- self.assertEquals(int(gdk.NOTHING), -1)
- self.assertEquals(int(gdk.BUTTON_PRESS), 4)
-
- def testParamSpec(self):
- props = filter(lambda prop: GType.is_a(prop.value_type, GEnum),
- gobject.list_properties(gtk.Window))
- self.failUnless(len(props)>= 6)
- props = filter(lambda prop: prop.name == 'type', props)
- self.failUnless(props)
- pspec = props[0]
- klass = pspec.enum_class
- self.assertEquals(klass, gtk.WindowType)
- self.failUnless(hasattr(klass, '__enum_values__'))
- self.failUnless(isinstance(klass.__enum_values__, dict))
- self.failUnless(len(klass.__enum_values__) >= 2)
- self.failUnless(isinstance(pspec.default_value, gtk.WindowType))
-
- def testOutofBounds(self):
- val = gtk.icon_size_register('fake', 24, 24)
- self.failUnless(isinstance(val, gobject.GEnum))
- self.assertEquals(int(val), 7)
- self.failUnless('7' in repr(val))
- self.failUnless('GtkIconSize' in repr(val))
-
- def testEnumProperty(self):
- default = PObject.props.enum.default_value
- self.failUnless(isinstance(default, gtk.WindowType))
- self.assertEqual(default, gtk.WINDOW_TOPLEVEL)
- default = PObject.props.enum2.default_value
- self.failUnless(isinstance(default, gtk.WindowType))
- self.assertEqual(default, gtk.WINDOW_TOPLEVEL)
-
-class FlagsTest(unittest.TestCase):
- def testFlags(self):
- self.failUnless(issubclass(GFlags, int))
- self.failUnless(isinstance(gdk.BUTTON_PRESS_MASK, gdk.EventMask))
- self.failUnless(isinstance(gdk.BUTTON_PRESS_MASK, int))
- self.assertEquals(gdk.BUTTON_PRESS_MASK, 256)
- self.assertNotEquals(gdk.BUTTON_PRESS_MASK, 0)
- self.assertNotEquals(gdk.BUTTON_PRESS_MASK, -256)
- self.assertNotEquals(gdk.BUTTON_PRESS_MASK, gdk.BUTTON_RELEASE_MASK)
-
- self.assertEquals(gdk.EventMask.__bases__[0], GFlags)
- self.assertEquals(len(gdk.EventMask.__flags_values__), 22)
-
- def testComparisionWarning(self):
- warnings.filterwarnings("error", "", Warning, "", 0)
- try:
- self.assertNotEquals(gtk.ACCEL_VISIBLE, gtk.EXPAND)
- except Warning:
- pass
- else:
- raise AssertionError
- warnings.resetwarnings()
-
- def testFlagOperations(self):
- a = gdk.BUTTON_PRESS_MASK
- self.failUnless(isinstance(a, GFlags))
- self.assertEquals(a.first_value_name, 'GDK_BUTTON_PRESS_MASK')
- self.assertEquals(a.first_value_nick, 'button-press-mask')
- self.assertEquals(a.value_names, ['GDK_BUTTON_PRESS_MASK'],
- a.value_names)
- self.assertEquals(a.value_nicks, ['button-press-mask'],
- a.value_names)
- b = gdk.BUTTON_PRESS_MASK | gdk.BUTTON_RELEASE_MASK
- self.failUnless(isinstance(b, GFlags))
- self.assertEquals(b.first_value_name, 'GDK_BUTTON_PRESS_MASK')
- self.assertEquals(b.first_value_nick, 'button-press-mask')
- self.assertEquals(b.value_names, ['GDK_BUTTON_PRESS_MASK',
- 'GDK_BUTTON_RELEASE_MASK'])
- self.assertEquals(b.value_nicks, ['button-press-mask',
- 'button-release-mask'])
- c = (gdk.BUTTON_PRESS_MASK |
- gdk.BUTTON_RELEASE_MASK |
- gdk.ENTER_NOTIFY_MASK)
- self.failUnless(isinstance(c, GFlags))
- self.assertEquals(c.first_value_name, 'GDK_BUTTON_PRESS_MASK')
- self.assertEquals(c.first_value_nick, 'button-press-mask')
- self.assertEquals(c.value_names,
- ['GDK_BUTTON_PRESS_MASK',
- 'GDK_BUTTON_RELEASE_MASK',
- 'GDK_ENTER_NOTIFY_MASK'])
- self.assertEquals(c.value_nicks,
- ['button-press-mask',
- 'button-release-mask',
- 'enter-notify-mask'])
- self.failUnless(int(a))
- self.assertEquals(int(a), int(gdk.BUTTON_PRESS_MASK))
- self.failUnless(int(b))
- self.assertEquals(int(b), (int(gdk.BUTTON_PRESS_MASK) |
- int(gdk.BUTTON_RELEASE_MASK)))
- self.failUnless(int(c))
- self.assertEquals(int(c), (int(gdk.BUTTON_PRESS_MASK) |
- int(gdk.BUTTON_RELEASE_MASK) |
- int(gdk.ENTER_NOTIFY_MASK)))
-
- def testUnsupportedOpertionWarning(self):
- warnings.filterwarnings("error", "", Warning, "", 0)
- try:
- value = gdk.BUTTON_PRESS_MASK + gdk.BUTTON_RELEASE_MASK
- except Warning:
- pass
- else:
- raise AssertionError
- warnings.resetwarnings()
-
- def testParamSpec(self):
- props = filter(lambda x: GType.is_a(x.value_type, GFlags),
- gtk.Table.list_child_properties())
- self.failUnless(len(props) >= 2)
- pspec = props[0]
- klass = pspec.flags_class
- self.assertEquals(klass, gtk.AttachOptions)
- self.failUnless(hasattr(klass, '__flags_values__'))
- self.failUnless(isinstance(klass.__flags_values__, dict))
- self.failUnless(len(klass.__flags_values__) >= 3)
- self.failUnless(isinstance(pspec.default_value, gtk.AttachOptions))
-
- def testEnumComparision(self):
- enum = gtk.TREE_VIEW_DROP_BEFORE
- self.assertEquals(enum, 0)
- self.failUnless(not enum == 10)
- self.failUnless(not enum != 0)
- self.assertNotEquals(enum, 10)
- self.failUnless(not enum < 0)
- self.failUnless(enum < 10)
- self.failUnless(not enum > 0)
- self.failUnless(not enum > 10)
- self.failUnless(enum >= 0)
- self.failUnless(not enum >= 10)
- self.failUnless(enum <= 0)
- self.failUnless(enum <= 10)
-
- def testFlagComparision(self):
- flag = gdk.EXPOSURE_MASK
- self.assertEquals(flag, 2)
- self.failUnless(not flag == 10)
- self.failUnless(not flag != 2)
- self.assertNotEquals(flag, 10)
- self.failUnless(not flag < 2)
- self.failUnless(flag < 10)
- self.failUnless(not flag > 2)
- self.failUnless(not flag > 10)
- self.failUnless(flag >= 2)
- self.failUnless(not flag >= 10)
- self.failUnless(flag <= 2)
- self.failUnless(flag <= 10)
-
- def testFlagsProperty(self):
- default = PObject.props.flags.default_value
- self.failUnless(isinstance(default, gtk.AttachOptions))
- self.assertEqual(default, gtk.EXPAND)
- default = PObject.props.flags2.default_value
- self.failUnless(isinstance(default, gtk.AttachOptions))
- self.assertEqual(default, gtk.EXPAND)
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/tests/test_gdk.py b/tests/test_gdk.py
deleted file mode 100644
index e23c4583..00000000
--- a/tests/test_gdk.py
+++ /dev/null
@@ -1,73 +0,0 @@
-import unittest
-import gc
-
-from common import gtk
-
-class CallOnDel:
- def __init__(self, callback):
- self.callback = callback
- def __del__(self):
- self.callback()
-
-class GdkTest(unittest.TestCase):
- def testBitmapCreateFromData(self):
- gtk.gdk.bitmap_create_from_data(None, '\x00', 1, 1)
-
- def testPixmapCreateFromData(self):
- black = gtk.gdk.color_parse('black')
- gtk.gdk.pixmap_create_from_data(None, '\x00', 1, 1, 1,
- black, black)
-
- def _testWindow(self):
- common = {'finalized': False}
- def on_finalize():
- common['finalized'] = True
- w = gtk.gdk.Window(None, 200, 200, gtk.gdk.WINDOW_TEMP, 0, 0)
- w.set_data('foo', CallOnDel(on_finalize))
- w.destroy()
- while gtk.events_pending():
- gtk.main_iteration(block=False)
- del w
-
- # Note that this depends on the mainloop processing an X event so
- # if might fail if the timing is off
- while gc.collect():
- pass
- assert common['finalized']
-
-
- def testDrawIndexedImage(self):
- w = gtk.Window()
- w.realize()
- w.window.draw_indexed_image(gtk.gdk.GC(w.window),
- 0, 0,
- 1, 2,
- gtk.gdk.RGB_DITHER_NONE,
- '\x00\x01',
- 1,
- [0xdeadbe, 0xbebabe])
-
- def _collect(self):
- cnt = 0
- while True:
- x = gc.collect()
- cnt += x
- if x:
- break
- return cnt
-
- def testDisplay(self):
- while gc.collect():
- pass
-
- display = gtk.gdk.Display(None)
- del display
-
- self.assertEquals(self._collect(), 1)
-
- display = gtk.gdk.Display(None)
- self.assertEquals(display.__grefcount__, 1)
- display.close()
- self.assertEquals(display.__grefcount__, 1)
- del display
- self.assertEquals(self._collect(), 1)
diff --git a/tests/test_gdkevent.py b/tests/test_gdkevent.py
deleted file mode 100644
index 1721a9e4..00000000
--- a/tests/test_gdkevent.py
+++ /dev/null
@@ -1,22 +0,0 @@
-# -*- Mode: Python -*-
-
-import unittest
-
-from common import gtk
-
-class TestGdkEvent(unittest.TestCase):
- def testWindowSetter(self):
- event = gtk.gdk.Event(gtk.gdk.BUTTON_PRESS)
-
- win1 = gtk.Window()
- win1.realize()
- event.window = win1.window
- self.assertEqual(event.window, win1.window)
-
- win2 = gtk.Window()
- win2.realize()
- event.window = win2.window
- self.assertEqual(event.window, win2.window)
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/tests/test_glade.py b/tests/test_glade.py
deleted file mode 100644
index ce9b99e8..00000000
--- a/tests/test_glade.py
+++ /dev/null
@@ -1,33 +0,0 @@
-import unittest
-
-from common import gtk, gobject
-import weakref
-import gc
-
-class TestGlade(unittest.TestCase):
-
- class SimpleTest:
- def __init__(self, test):
- xml = gtk.glade.XML('leak.glade')
- xml.signal_autoconnect(self)
- self.test = test
- self.window = xml.get_widget("window1")
- self.window.destroy()
- def on_window1_destroy(self, window):
- gobject.idle_add(self.test.leak_check, weakref.ref(self), weakref.ref(self.window))
-
- def leak_check(self, objref, windowref):
- while gc.collect():
- pass
- gtk.main_quit()
- self.assertEqual(objref(), None)
- self.windowref = windowref
-
- def testAutoconnectLeak(self):
- self.SimpleTest(self)
- gtk.main()
- self.assertEqual(self.windowref(), None)
-
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/tests/test_liststore.py b/tests/test_liststore.py
deleted file mode 100644
index da53a07e..00000000
--- a/tests/test_liststore.py
+++ /dev/null
@@ -1,36 +0,0 @@
-import unittest
-
-from common import gtk
-
-class ListStoreTest(unittest.TestCase):
- def testConstructor(self):
- self.assertRaises(TypeError, gtk.ListStore)
-
- def testInsert(self):
- store = gtk.ListStore(int)
-
- # Old way, with iters
- store.set_value(store.insert(0), 0, 2)
- self.assertEqual(len(store), 1)
- self.assertEqual(store[0][0], 2)
-
- # New way
- store.insert(0, (1,))
- self.assertEqual(len(store), 2)
- self.assertEqual(store[0][0], 1)
- self.assertEqual(store[1][0], 2)
-
- # TreeSortable, but...
-
- def testSetDefaultSortFunc(self):
- store = gtk.ListStore(int)
- self.failIf(store.has_default_sort_func())
- store.set_default_sort_func(lambda x: None)
- store.set_sort_column_id(0, gtk.SORT_ASCENDING)
-
- self.failUnless(store.has_default_sort_func())
- store.set_default_sort_func(None)
- self.failIf(store.has_default_sort_func())
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/tests/test_pango.py b/tests/test_pango.py
deleted file mode 100644
index 6d48dd52..00000000
--- a/tests/test_pango.py
+++ /dev/null
@@ -1,9 +0,0 @@
-import unittest
-
-from common import pango
-
-class MarkupTest(unittest.TestCase):
- def testMarkupAccelMarker(self):
- self.assertRaises(TypeError, pango.parse_markup, 'test', 0)
- self.assertEqual(pango.parse_markup('test')[2], u'\x00')
- self.assertEqual(pango.parse_markup('test', u't')[2], u'e')
diff --git a/tests/test_radiobutton.py b/tests/test_radiobutton.py
deleted file mode 100644
index 43a1c4f6..00000000
--- a/tests/test_radiobutton.py
+++ /dev/null
@@ -1,98 +0,0 @@
-import unittest
-
-from common import gtk
-
-class RadioTest(unittest.TestCase):
- widget_type = None
- constructor_args = ()
-
- def new(self):
- return self.widget_type(*self.constructor_args)
-
- def newLabel(self, label):
- return self.widget_type(None, label)
-
- def newGroup(self, group):
- return self.widget_type(group)
-
- def getLabel(self, obj):
- return obj.get_property('label')
-
- def compareGroups(self, group1, group2):
- return self.assertEqual(group1, group2)
-
- def testCreate(self):
- if self.widget_type is None:
- return
- radio = self.new()
- self.assert_(isinstance(radio, self.widget_type))
-
- def testLabel(self):
- if self.widget_type is None:
- return
- radio = self.newLabel('test-radio')
- self.assertEqual(self.getLabel(radio), 'test-radio')
-
- def testGroup(self):
- if self.widget_type is None:
- return
- radio = self.new()
- radio2 = self.newGroup(radio)
- self.compareGroups(radio.get_group(), radio2.get_group())
- self.compareGroups(radio2.get_group(), radio.get_group())
-
- def testEmptyGroup(self):
- if self.widget_type is None:
- return
- radio = self.new()
- radio2 = self.new()
- self.compareGroups(radio.get_group(), [radio])
- self.compareGroups(radio2.get_group(), [radio2])
- radio2.set_group(radio)
- self.compareGroups(radio.get_group(), radio2.get_group())
- self.compareGroups(radio2.get_group(), radio.get_group())
- radio2.set_group(None)
- self.compareGroups(radio.get_group(), [radio])
- self.compareGroups(radio2.get_group(), [radio2])
-
-class RadioButtonTest(RadioTest):
- widget_type = gtk.RadioButton
-
-class RadioActionTest(RadioTest):
- widget_type = gtk.RadioAction
- constructor_args = ('RadioAction', 'test-radio-action', '', '', 0)
-
- def newGroup(self, radio):
- # No constructor, so set it manually
- obj = self.new()
- obj.set_group(radio)
- return obj
-
- def newLabel(self, label):
- return gtk.RadioAction('RadioAction', label, '', '', 0)
-
-class RadioToolButtonTest(RadioTest):
- widget_type = gtk.RadioToolButton
-
- def compareGroups(self, group1, group2):
- # GtkRadioToolButton.set/get_groups return GtkRadioButtons,
- # so instead of doing a normal cmp, compare ids
- return cmp(map(id, group1), map(id, group2))
-
- def newLabel(self, label):
- # We don't have a constructor for which we can pass in a label
- # for, so just call set_label instead
- radio = gtk.RadioToolButton(None)
- radio.set_label(label)
- return radio
-
-class RadioMenuItem(RadioTest):
- widget_type = gtk.RadioMenuItem
-
- def getLabel(self, obj):
- # The label is stored in a gtk.AccelLabel, which is the only
- # child of the RadioMenuItem.
- return obj.get_child().get_text()
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/tests/test_style.py b/tests/test_style.py
deleted file mode 100644
index e55f1028..00000000
--- a/tests/test_style.py
+++ /dev/null
@@ -1,29 +0,0 @@
-import unittest
-
-from common import gtk
-
-class StylePixmapTest(unittest.TestCase):
- def setUp(self):
- win = gtk.Window()
- win.realize()
- self.window = win.window
- self.bg_pixmap = win.style.bg_pixmap
-
- def _test(self, pixmap):
- self.bg_pixmap[gtk.STATE_NORMAL] = pixmap
- self.assertEqual(self.bg_pixmap[gtk.STATE_NORMAL], pixmap)
-
- def testNormal(self):
- self._test(gtk.gdk.Pixmap(self.window, 1, 1))
-
- def testNone(self):
- self._test(None)
-
- def testParentRelative(self):
- self._test(gtk.gdk.PARENT_RELATIVE)
-
- def testInvalid(self):
- func = self.bg_pixmap.__setitem__
- self.assertRaises(TypeError, func, gtk.STATE_NORMAL, True)
- self.assertRaises(TypeError, func, gtk.STATE_NORMAL, 0L)
- self.assertRaises(TypeError, func, gtk.STATE_NORMAL, object())
diff --git a/tests/test_textview.py b/tests/test_textview.py
deleted file mode 100644
index 7df602ad..00000000
--- a/tests/test_textview.py
+++ /dev/null
@@ -1,13 +0,0 @@
-import unittest
-
-from common import gtk
-
-class TextViewTest(unittest.TestCase):
- def test_default_attributes(self):
- textview = gtk.TextView()
- attrs = textview.get_default_attributes()
- textview.destroy()
- self.assertEqual(attrs.font_scale, 1.0)
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/tests/test_treeview.py b/tests/test_treeview.py
deleted file mode 100644
index e026d84f..00000000
--- a/tests/test_treeview.py
+++ /dev/null
@@ -1,27 +0,0 @@
-import unittest
-
-from common import gtk
-
-class TreeViewTest(unittest.TestCase):
- # Check for #350252
- def test_default_attributes(self):
- model = gtk.ListStore(str)
- treeview = gtk.TreeView(model)
- treeview.set_cursor(1)
-
- # Bug #347273
- def testTreeSelectionForeach(self):
- model = gtk.ListStore(str)
- treeview = gtk.TreeView(model)
- sel = treeview.get_selection()
- iter_ = model.append()
- model.set_value(iter_, 0, "foo")
- sel.select_path((0,))
- list_ = []
- sel.selected_foreach(lambda model, path, iter: list_.append(iter))
- list_ = [model.get_value(iter_, 0) for iter_ in list_]
- self.assertEqual(list_, ["foo"])
-
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/tests/testmodule.py b/tests/testmodule.py
deleted file mode 100644
index 3cff2f28..00000000
--- a/tests/testmodule.py
+++ /dev/null
@@ -1,7 +0,0 @@
-import gtk
-
-class PyLabel(gtk.Label):
- __gtype_name__ = 'PyLabel'
-
- def __init__(self):
- gtk.Label.__init__(self, "hello")